babylon.module.d.ts 6.6 MB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488148914901491149214931494149514961497149814991500150115021503150415051506150715081509151015111512151315141515151615171518151915201521152215231524152515261527152815291530153115321533153415351536153715381539154015411542154315441545154615471548154915501551155215531554155515561557155815591560156115621563156415651566156715681569157015711572157315741575157615771578157915801581158215831584158515861587158815891590159115921593159415951596159715981599160016011602160316041605160616071608160916101611161216131614161516161617161816191620162116221623162416251626162716281629163016311632163316341635163616371638163916401641164216431644164516461647164816491650165116521653165416551656165716581659166016611662166316641665166616671668166916701671167216731674167516761677167816791680168116821683168416851686168716881689169016911692169316941695169616971698169917001701170217031704170517061707170817091710171117121713171417151716171717181719172017211722172317241725172617271728172917301731173217331734173517361737173817391740174117421743174417451746174717481749175017511752175317541755175617571758175917601761176217631764176517661767176817691770177117721773177417751776177717781779178017811782178317841785178617871788178917901791179217931794179517961797179817991800180118021803180418051806180718081809181018111812181318141815181618171818181918201821182218231824182518261827182818291830183118321833183418351836183718381839184018411842184318441845184618471848184918501851185218531854185518561857185818591860186118621863186418651866186718681869187018711872187318741875187618771878187918801881188218831884188518861887188818891890189118921893189418951896189718981899190019011902190319041905190619071908190919101911191219131914191519161917191819191920192119221923192419251926192719281929193019311932193319341935193619371938193919401941194219431944194519461947194819491950195119521953195419551956195719581959196019611962196319641965196619671968196919701971197219731974197519761977197819791980198119821983198419851986198719881989199019911992199319941995199619971998199920002001200220032004200520062007200820092010201120122013201420152016201720182019202020212022202320242025202620272028202920302031203220332034203520362037203820392040204120422043204420452046204720482049205020512052205320542055205620572058205920602061206220632064206520662067206820692070207120722073207420752076207720782079208020812082208320842085208620872088208920902091209220932094209520962097209820992100210121022103210421052106210721082109211021112112211321142115211621172118211921202121212221232124212521262127212821292130213121322133213421352136213721382139214021412142214321442145214621472148214921502151215221532154215521562157215821592160216121622163216421652166216721682169217021712172217321742175217621772178217921802181218221832184218521862187218821892190219121922193219421952196219721982199220022012202220322042205220622072208220922102211221222132214221522162217221822192220222122222223222422252226222722282229223022312232223322342235223622372238223922402241224222432244224522462247224822492250225122522253225422552256225722582259226022612262226322642265226622672268226922702271227222732274227522762277227822792280228122822283228422852286228722882289229022912292229322942295229622972298229923002301230223032304230523062307230823092310231123122313231423152316231723182319232023212322232323242325232623272328232923302331233223332334233523362337233823392340234123422343234423452346234723482349235023512352235323542355235623572358235923602361236223632364236523662367236823692370237123722373237423752376237723782379238023812382238323842385238623872388238923902391239223932394239523962397239823992400240124022403240424052406240724082409241024112412241324142415241624172418241924202421242224232424242524262427242824292430243124322433243424352436243724382439244024412442244324442445244624472448244924502451245224532454245524562457245824592460246124622463246424652466246724682469247024712472247324742475247624772478247924802481248224832484248524862487248824892490249124922493249424952496249724982499250025012502250325042505250625072508250925102511251225132514251525162517251825192520252125222523252425252526252725282529253025312532253325342535253625372538253925402541254225432544254525462547254825492550255125522553255425552556255725582559256025612562256325642565256625672568256925702571257225732574257525762577257825792580258125822583258425852586258725882589259025912592259325942595259625972598259926002601260226032604260526062607260826092610261126122613261426152616261726182619262026212622262326242625262626272628262926302631263226332634263526362637263826392640264126422643264426452646264726482649265026512652265326542655265626572658265926602661266226632664266526662667266826692670267126722673267426752676267726782679268026812682268326842685268626872688268926902691269226932694269526962697269826992700270127022703270427052706270727082709271027112712271327142715271627172718271927202721272227232724272527262727272827292730273127322733273427352736273727382739274027412742274327442745274627472748274927502751275227532754275527562757275827592760276127622763276427652766276727682769277027712772277327742775277627772778277927802781278227832784278527862787278827892790279127922793279427952796279727982799280028012802280328042805280628072808280928102811281228132814281528162817281828192820282128222823282428252826282728282829283028312832283328342835283628372838283928402841284228432844284528462847284828492850285128522853285428552856285728582859286028612862286328642865286628672868286928702871287228732874287528762877287828792880288128822883288428852886288728882889289028912892289328942895289628972898289929002901290229032904290529062907290829092910291129122913291429152916291729182919292029212922292329242925292629272928292929302931293229332934293529362937293829392940294129422943294429452946294729482949295029512952295329542955295629572958295929602961296229632964296529662967296829692970297129722973297429752976297729782979298029812982298329842985298629872988298929902991299229932994299529962997299829993000300130023003300430053006300730083009301030113012301330143015301630173018301930203021302230233024302530263027302830293030303130323033303430353036303730383039304030413042304330443045304630473048304930503051305230533054305530563057305830593060306130623063306430653066306730683069307030713072307330743075307630773078307930803081308230833084308530863087308830893090309130923093309430953096309730983099310031013102310331043105310631073108310931103111311231133114311531163117311831193120312131223123312431253126312731283129313031313132313331343135313631373138313931403141314231433144314531463147314831493150315131523153315431553156315731583159316031613162316331643165316631673168316931703171317231733174317531763177317831793180318131823183318431853186318731883189319031913192319331943195319631973198319932003201320232033204320532063207320832093210321132123213321432153216321732183219322032213222322332243225322632273228322932303231323232333234323532363237323832393240324132423243324432453246324732483249325032513252325332543255325632573258325932603261326232633264326532663267326832693270327132723273327432753276327732783279328032813282328332843285328632873288328932903291329232933294329532963297329832993300330133023303330433053306330733083309331033113312331333143315331633173318331933203321332233233324332533263327332833293330333133323333333433353336333733383339334033413342334333443345334633473348334933503351335233533354335533563357335833593360336133623363336433653366336733683369337033713372337333743375337633773378337933803381338233833384338533863387338833893390339133923393339433953396339733983399340034013402340334043405340634073408340934103411341234133414341534163417341834193420342134223423342434253426342734283429343034313432343334343435343634373438343934403441344234433444344534463447344834493450345134523453345434553456345734583459346034613462346334643465346634673468346934703471347234733474347534763477347834793480348134823483348434853486348734883489349034913492349334943495349634973498349935003501350235033504350535063507350835093510351135123513351435153516351735183519352035213522352335243525352635273528352935303531353235333534353535363537353835393540354135423543354435453546354735483549355035513552355335543555355635573558355935603561356235633564356535663567356835693570357135723573357435753576357735783579358035813582358335843585358635873588358935903591359235933594359535963597359835993600360136023603360436053606360736083609361036113612361336143615361636173618361936203621362236233624362536263627362836293630363136323633363436353636363736383639364036413642364336443645364636473648364936503651365236533654365536563657365836593660366136623663366436653666366736683669367036713672367336743675367636773678367936803681368236833684368536863687368836893690369136923693369436953696369736983699370037013702370337043705370637073708370937103711371237133714371537163717371837193720372137223723372437253726372737283729373037313732373337343735373637373738373937403741374237433744374537463747374837493750375137523753375437553756375737583759376037613762376337643765376637673768376937703771377237733774377537763777377837793780378137823783378437853786378737883789379037913792379337943795379637973798379938003801380238033804380538063807380838093810381138123813381438153816381738183819382038213822382338243825382638273828382938303831383238333834383538363837383838393840384138423843384438453846384738483849385038513852385338543855385638573858385938603861386238633864386538663867386838693870387138723873387438753876387738783879388038813882388338843885388638873888388938903891389238933894389538963897389838993900390139023903390439053906390739083909391039113912391339143915391639173918391939203921392239233924392539263927392839293930393139323933393439353936393739383939394039413942394339443945394639473948394939503951395239533954395539563957395839593960396139623963396439653966396739683969397039713972397339743975397639773978397939803981398239833984398539863987398839893990399139923993399439953996399739983999400040014002400340044005400640074008400940104011401240134014401540164017401840194020402140224023402440254026402740284029403040314032403340344035403640374038403940404041404240434044404540464047404840494050405140524053405440554056405740584059406040614062406340644065406640674068406940704071407240734074407540764077407840794080408140824083408440854086408740884089409040914092409340944095409640974098409941004101410241034104410541064107410841094110411141124113411441154116411741184119412041214122412341244125412641274128412941304131413241334134413541364137413841394140414141424143414441454146414741484149415041514152415341544155415641574158415941604161416241634164416541664167416841694170417141724173417441754176417741784179418041814182418341844185418641874188418941904191419241934194419541964197419841994200420142024203420442054206420742084209421042114212421342144215421642174218421942204221422242234224422542264227422842294230423142324233423442354236423742384239424042414242424342444245424642474248424942504251425242534254425542564257425842594260426142624263426442654266426742684269427042714272427342744275427642774278427942804281428242834284428542864287428842894290429142924293429442954296429742984299430043014302430343044305430643074308430943104311431243134314431543164317431843194320432143224323432443254326432743284329433043314332433343344335433643374338433943404341434243434344434543464347434843494350435143524353435443554356435743584359436043614362436343644365436643674368436943704371437243734374437543764377437843794380438143824383438443854386438743884389439043914392439343944395439643974398439944004401440244034404440544064407440844094410441144124413441444154416441744184419442044214422442344244425442644274428442944304431443244334434443544364437443844394440444144424443444444454446444744484449445044514452445344544455445644574458445944604461446244634464446544664467446844694470447144724473447444754476447744784479448044814482448344844485448644874488448944904491449244934494449544964497449844994500450145024503450445054506450745084509451045114512451345144515451645174518451945204521452245234524452545264527452845294530453145324533453445354536453745384539454045414542454345444545454645474548454945504551455245534554455545564557455845594560456145624563456445654566456745684569457045714572457345744575457645774578457945804581458245834584458545864587458845894590459145924593459445954596459745984599460046014602460346044605460646074608460946104611461246134614461546164617461846194620462146224623462446254626462746284629463046314632463346344635463646374638463946404641464246434644464546464647464846494650465146524653465446554656465746584659466046614662466346644665466646674668466946704671467246734674467546764677467846794680468146824683468446854686468746884689469046914692469346944695469646974698469947004701470247034704470547064707470847094710471147124713471447154716471747184719472047214722472347244725472647274728472947304731473247334734473547364737473847394740474147424743474447454746474747484749475047514752475347544755475647574758475947604761476247634764476547664767476847694770477147724773477447754776477747784779478047814782478347844785478647874788478947904791479247934794479547964797479847994800480148024803480448054806480748084809481048114812481348144815481648174818481948204821482248234824482548264827482848294830483148324833483448354836483748384839484048414842484348444845484648474848484948504851485248534854485548564857485848594860486148624863486448654866486748684869487048714872487348744875487648774878487948804881488248834884488548864887488848894890489148924893489448954896489748984899490049014902490349044905490649074908490949104911491249134914491549164917491849194920492149224923492449254926492749284929493049314932493349344935493649374938493949404941494249434944494549464947494849494950495149524953495449554956495749584959496049614962496349644965496649674968496949704971497249734974497549764977497849794980498149824983498449854986498749884989499049914992499349944995499649974998499950005001500250035004500550065007500850095010501150125013501450155016501750185019502050215022502350245025502650275028502950305031503250335034503550365037503850395040504150425043504450455046504750485049505050515052505350545055505650575058505950605061506250635064506550665067506850695070507150725073507450755076507750785079508050815082508350845085508650875088508950905091509250935094509550965097509850995100510151025103510451055106510751085109511051115112511351145115511651175118511951205121512251235124512551265127512851295130513151325133513451355136513751385139514051415142514351445145514651475148514951505151515251535154515551565157515851595160516151625163516451655166516751685169517051715172517351745175517651775178517951805181518251835184518551865187518851895190519151925193519451955196519751985199520052015202520352045205520652075208520952105211521252135214521552165217521852195220522152225223522452255226522752285229523052315232523352345235523652375238523952405241524252435244524552465247524852495250525152525253525452555256525752585259526052615262526352645265526652675268526952705271527252735274527552765277527852795280528152825283528452855286528752885289529052915292529352945295529652975298529953005301530253035304530553065307530853095310531153125313531453155316531753185319532053215322532353245325532653275328532953305331533253335334533553365337533853395340534153425343534453455346534753485349535053515352535353545355535653575358535953605361536253635364536553665367536853695370537153725373537453755376537753785379538053815382538353845385538653875388538953905391539253935394539553965397539853995400540154025403540454055406540754085409541054115412541354145415541654175418541954205421542254235424542554265427542854295430543154325433543454355436543754385439544054415442544354445445544654475448544954505451545254535454545554565457545854595460546154625463546454655466546754685469547054715472547354745475547654775478547954805481548254835484548554865487548854895490549154925493549454955496549754985499550055015502550355045505550655075508550955105511551255135514551555165517551855195520552155225523552455255526552755285529553055315532553355345535553655375538553955405541554255435544554555465547554855495550555155525553555455555556555755585559556055615562556355645565556655675568556955705571557255735574557555765577557855795580558155825583558455855586558755885589559055915592559355945595559655975598559956005601560256035604560556065607560856095610561156125613561456155616561756185619562056215622562356245625562656275628562956305631563256335634563556365637563856395640564156425643564456455646564756485649565056515652565356545655565656575658565956605661566256635664566556665667566856695670567156725673567456755676567756785679568056815682568356845685568656875688568956905691569256935694569556965697569856995700570157025703570457055706570757085709571057115712571357145715571657175718571957205721572257235724572557265727572857295730573157325733573457355736573757385739574057415742574357445745574657475748574957505751575257535754575557565757575857595760576157625763576457655766576757685769577057715772577357745775577657775778577957805781578257835784578557865787578857895790579157925793579457955796579757985799580058015802580358045805580658075808580958105811581258135814581558165817581858195820582158225823582458255826582758285829583058315832583358345835583658375838583958405841584258435844584558465847584858495850585158525853585458555856585758585859586058615862586358645865586658675868586958705871587258735874587558765877587858795880588158825883588458855886588758885889589058915892589358945895589658975898589959005901590259035904590559065907590859095910591159125913591459155916591759185919592059215922592359245925592659275928592959305931593259335934593559365937593859395940594159425943594459455946594759485949595059515952595359545955595659575958595959605961596259635964596559665967596859695970597159725973597459755976597759785979598059815982598359845985598659875988598959905991599259935994599559965997599859996000600160026003600460056006600760086009601060116012601360146015601660176018601960206021602260236024602560266027602860296030603160326033603460356036603760386039604060416042604360446045604660476048604960506051605260536054605560566057605860596060606160626063606460656066606760686069607060716072607360746075607660776078607960806081608260836084608560866087608860896090609160926093609460956096609760986099610061016102610361046105610661076108610961106111611261136114611561166117611861196120612161226123612461256126612761286129613061316132613361346135613661376138613961406141614261436144614561466147614861496150615161526153615461556156615761586159616061616162616361646165616661676168616961706171617261736174617561766177617861796180618161826183618461856186618761886189619061916192619361946195619661976198619962006201620262036204620562066207620862096210621162126213621462156216621762186219622062216222622362246225622662276228622962306231623262336234623562366237623862396240624162426243624462456246624762486249625062516252625362546255625662576258625962606261626262636264626562666267626862696270627162726273627462756276627762786279628062816282628362846285628662876288628962906291629262936294629562966297629862996300630163026303630463056306630763086309631063116312631363146315631663176318631963206321632263236324632563266327632863296330633163326333633463356336633763386339634063416342634363446345634663476348634963506351635263536354635563566357635863596360636163626363636463656366636763686369637063716372637363746375637663776378637963806381638263836384638563866387638863896390639163926393639463956396639763986399640064016402640364046405640664076408640964106411641264136414641564166417641864196420642164226423642464256426642764286429643064316432643364346435643664376438643964406441644264436444644564466447644864496450645164526453645464556456645764586459646064616462646364646465646664676468646964706471647264736474647564766477647864796480648164826483648464856486648764886489649064916492649364946495649664976498649965006501650265036504650565066507650865096510651165126513651465156516651765186519652065216522652365246525652665276528652965306531653265336534653565366537653865396540654165426543654465456546654765486549655065516552655365546555655665576558655965606561656265636564656565666567656865696570657165726573657465756576657765786579658065816582658365846585658665876588658965906591659265936594659565966597659865996600660166026603660466056606660766086609661066116612661366146615661666176618661966206621662266236624662566266627662866296630663166326633663466356636663766386639664066416642664366446645664666476648664966506651665266536654665566566657665866596660666166626663666466656666666766686669667066716672667366746675667666776678667966806681668266836684668566866687668866896690669166926693669466956696669766986699670067016702670367046705670667076708670967106711671267136714671567166717671867196720672167226723672467256726672767286729673067316732673367346735673667376738673967406741674267436744674567466747674867496750675167526753675467556756675767586759676067616762676367646765676667676768676967706771677267736774677567766777677867796780678167826783678467856786678767886789679067916792679367946795679667976798679968006801680268036804680568066807680868096810681168126813681468156816681768186819682068216822682368246825682668276828682968306831683268336834683568366837683868396840684168426843684468456846684768486849685068516852685368546855685668576858685968606861686268636864686568666867686868696870687168726873687468756876687768786879688068816882688368846885688668876888688968906891689268936894689568966897689868996900690169026903690469056906690769086909691069116912691369146915691669176918691969206921692269236924692569266927692869296930693169326933693469356936693769386939694069416942694369446945694669476948694969506951695269536954695569566957695869596960696169626963696469656966696769686969697069716972697369746975697669776978697969806981698269836984698569866987698869896990699169926993699469956996699769986999700070017002700370047005700670077008700970107011701270137014701570167017701870197020702170227023702470257026702770287029703070317032703370347035703670377038703970407041704270437044704570467047704870497050705170527053705470557056705770587059706070617062706370647065706670677068706970707071707270737074707570767077707870797080708170827083708470857086708770887089709070917092709370947095709670977098709971007101710271037104710571067107710871097110711171127113711471157116711771187119712071217122712371247125712671277128712971307131713271337134713571367137713871397140714171427143714471457146714771487149715071517152715371547155715671577158715971607161716271637164716571667167716871697170717171727173717471757176717771787179718071817182718371847185718671877188718971907191719271937194719571967197719871997200720172027203720472057206720772087209721072117212721372147215721672177218721972207221722272237224722572267227722872297230723172327233723472357236723772387239724072417242724372447245724672477248724972507251725272537254725572567257725872597260726172627263726472657266726772687269727072717272727372747275727672777278727972807281728272837284728572867287728872897290729172927293729472957296729772987299730073017302730373047305730673077308730973107311731273137314731573167317731873197320732173227323732473257326732773287329733073317332733373347335733673377338733973407341734273437344734573467347734873497350735173527353735473557356735773587359736073617362736373647365736673677368736973707371737273737374737573767377737873797380738173827383738473857386738773887389739073917392739373947395739673977398739974007401740274037404740574067407740874097410741174127413741474157416741774187419742074217422742374247425742674277428742974307431743274337434743574367437743874397440744174427443744474457446744774487449745074517452745374547455745674577458745974607461746274637464746574667467746874697470747174727473747474757476747774787479748074817482748374847485748674877488748974907491749274937494749574967497749874997500750175027503750475057506750775087509751075117512751375147515751675177518751975207521752275237524752575267527752875297530753175327533753475357536753775387539754075417542754375447545754675477548754975507551755275537554755575567557755875597560756175627563756475657566756775687569757075717572757375747575757675777578757975807581758275837584758575867587758875897590759175927593759475957596759775987599760076017602760376047605760676077608760976107611761276137614761576167617761876197620762176227623762476257626762776287629763076317632763376347635763676377638763976407641764276437644764576467647764876497650765176527653765476557656765776587659766076617662766376647665766676677668766976707671767276737674767576767677767876797680768176827683768476857686768776887689769076917692769376947695769676977698769977007701770277037704770577067707770877097710771177127713771477157716771777187719772077217722772377247725772677277728772977307731773277337734773577367737773877397740774177427743774477457746774777487749775077517752775377547755775677577758775977607761776277637764776577667767776877697770777177727773777477757776777777787779778077817782778377847785778677877788778977907791779277937794779577967797779877997800780178027803780478057806780778087809781078117812781378147815781678177818781978207821782278237824782578267827782878297830783178327833783478357836783778387839784078417842784378447845784678477848784978507851785278537854785578567857785878597860786178627863786478657866786778687869787078717872787378747875787678777878787978807881788278837884788578867887788878897890789178927893789478957896789778987899790079017902790379047905790679077908790979107911791279137914791579167917791879197920792179227923792479257926792779287929793079317932793379347935793679377938793979407941794279437944794579467947794879497950795179527953795479557956795779587959796079617962796379647965796679677968796979707971797279737974797579767977797879797980798179827983798479857986798779887989799079917992799379947995799679977998799980008001800280038004800580068007800880098010801180128013801480158016801780188019802080218022802380248025802680278028802980308031803280338034803580368037803880398040804180428043804480458046804780488049805080518052805380548055805680578058805980608061806280638064806580668067806880698070807180728073807480758076807780788079808080818082808380848085808680878088808980908091809280938094809580968097809880998100810181028103810481058106810781088109811081118112811381148115811681178118811981208121812281238124812581268127812881298130813181328133813481358136813781388139814081418142814381448145814681478148814981508151815281538154815581568157815881598160816181628163816481658166816781688169817081718172817381748175817681778178817981808181818281838184818581868187818881898190819181928193819481958196819781988199820082018202820382048205820682078208820982108211821282138214821582168217821882198220822182228223822482258226822782288229823082318232823382348235823682378238823982408241824282438244824582468247824882498250825182528253825482558256825782588259826082618262826382648265826682678268826982708271827282738274827582768277827882798280828182828283828482858286828782888289829082918292829382948295829682978298829983008301830283038304830583068307830883098310831183128313831483158316831783188319832083218322832383248325832683278328832983308331833283338334833583368337833883398340834183428343834483458346834783488349835083518352835383548355835683578358835983608361836283638364836583668367836883698370837183728373837483758376837783788379838083818382838383848385838683878388838983908391839283938394839583968397839883998400840184028403840484058406840784088409841084118412841384148415841684178418841984208421842284238424842584268427842884298430843184328433843484358436843784388439844084418442844384448445844684478448844984508451845284538454845584568457845884598460846184628463846484658466846784688469847084718472847384748475847684778478847984808481848284838484848584868487848884898490849184928493849484958496849784988499850085018502850385048505850685078508850985108511851285138514851585168517851885198520852185228523852485258526852785288529853085318532853385348535853685378538853985408541854285438544854585468547854885498550855185528553855485558556855785588559856085618562856385648565856685678568856985708571857285738574857585768577857885798580858185828583858485858586858785888589859085918592859385948595859685978598859986008601860286038604860586068607860886098610861186128613861486158616861786188619862086218622862386248625862686278628862986308631863286338634863586368637863886398640864186428643864486458646864786488649865086518652865386548655865686578658865986608661866286638664866586668667866886698670867186728673867486758676867786788679868086818682868386848685868686878688868986908691869286938694869586968697869886998700870187028703870487058706870787088709871087118712871387148715871687178718871987208721872287238724872587268727872887298730873187328733873487358736873787388739874087418742874387448745874687478748874987508751875287538754875587568757875887598760876187628763876487658766876787688769877087718772877387748775877687778778877987808781878287838784878587868787878887898790879187928793879487958796879787988799880088018802880388048805880688078808880988108811881288138814881588168817881888198820882188228823882488258826882788288829883088318832883388348835883688378838883988408841884288438844884588468847884888498850885188528853885488558856885788588859886088618862886388648865886688678868886988708871887288738874887588768877887888798880888188828883888488858886888788888889889088918892889388948895889688978898889989008901890289038904890589068907890889098910891189128913891489158916891789188919892089218922892389248925892689278928892989308931893289338934893589368937893889398940894189428943894489458946894789488949895089518952895389548955895689578958895989608961896289638964896589668967896889698970897189728973897489758976897789788979898089818982898389848985898689878988898989908991899289938994899589968997899889999000900190029003900490059006900790089009901090119012901390149015901690179018901990209021902290239024902590269027902890299030903190329033903490359036903790389039904090419042904390449045904690479048904990509051905290539054905590569057905890599060906190629063906490659066906790689069907090719072907390749075907690779078907990809081908290839084908590869087908890899090909190929093909490959096909790989099910091019102910391049105910691079108910991109111911291139114911591169117911891199120912191229123912491259126912791289129913091319132913391349135913691379138913991409141914291439144914591469147914891499150915191529153915491559156915791589159916091619162916391649165916691679168916991709171917291739174917591769177917891799180918191829183918491859186918791889189919091919192919391949195919691979198919992009201920292039204920592069207920892099210921192129213921492159216921792189219922092219222922392249225922692279228922992309231923292339234923592369237923892399240924192429243924492459246924792489249925092519252925392549255925692579258925992609261926292639264926592669267926892699270927192729273927492759276927792789279928092819282928392849285928692879288928992909291929292939294929592969297929892999300930193029303930493059306930793089309931093119312931393149315931693179318931993209321932293239324932593269327932893299330933193329333933493359336933793389339934093419342934393449345934693479348934993509351935293539354935593569357935893599360936193629363936493659366936793689369937093719372937393749375937693779378937993809381938293839384938593869387938893899390939193929393939493959396939793989399940094019402940394049405940694079408940994109411941294139414941594169417941894199420942194229423942494259426942794289429943094319432943394349435943694379438943994409441944294439444944594469447944894499450945194529453945494559456945794589459946094619462946394649465946694679468946994709471947294739474947594769477947894799480948194829483948494859486948794889489949094919492949394949495949694979498949995009501950295039504950595069507950895099510951195129513951495159516951795189519952095219522952395249525952695279528952995309531953295339534953595369537953895399540954195429543954495459546954795489549955095519552955395549555955695579558955995609561956295639564956595669567956895699570957195729573957495759576957795789579958095819582958395849585958695879588958995909591959295939594959595969597959895999600960196029603960496059606960796089609961096119612961396149615961696179618961996209621962296239624962596269627962896299630963196329633963496359636963796389639964096419642964396449645964696479648964996509651965296539654965596569657965896599660966196629663966496659666966796689669967096719672967396749675967696779678967996809681968296839684968596869687968896899690969196929693969496959696969796989699970097019702970397049705970697079708970997109711971297139714971597169717971897199720972197229723972497259726972797289729973097319732973397349735973697379738973997409741974297439744974597469747974897499750975197529753975497559756975797589759976097619762976397649765976697679768976997709771977297739774977597769777977897799780978197829783978497859786978797889789979097919792979397949795979697979798979998009801980298039804980598069807980898099810981198129813981498159816981798189819982098219822982398249825982698279828982998309831983298339834983598369837983898399840984198429843984498459846984798489849985098519852985398549855985698579858985998609861986298639864986598669867986898699870987198729873987498759876987798789879988098819882988398849885988698879888988998909891989298939894989598969897989898999900990199029903990499059906990799089909991099119912991399149915991699179918991999209921992299239924992599269927992899299930993199329933993499359936993799389939994099419942994399449945994699479948994999509951995299539954995599569957995899599960996199629963996499659966996799689969997099719972997399749975997699779978997999809981998299839984998599869987998899899990999199929993999499959996999799989999100001000110002100031000410005100061000710008100091001010011100121001310014100151001610017100181001910020100211002210023100241002510026100271002810029100301003110032100331003410035100361003710038100391004010041100421004310044100451004610047100481004910050100511005210053100541005510056100571005810059100601006110062100631006410065100661006710068100691007010071100721007310074100751007610077100781007910080100811008210083100841008510086100871008810089100901009110092100931009410095100961009710098100991010010101101021010310104101051010610107101081010910110101111011210113101141011510116101171011810119101201012110122101231012410125101261012710128101291013010131101321013310134101351013610137101381013910140101411014210143101441014510146101471014810149101501015110152101531015410155101561015710158101591016010161101621016310164101651016610167101681016910170101711017210173101741017510176101771017810179101801018110182101831018410185101861018710188101891019010191101921019310194101951019610197101981019910200102011020210203102041020510206102071020810209102101021110212102131021410215102161021710218102191022010221102221022310224102251022610227102281022910230102311023210233102341023510236102371023810239102401024110242102431024410245102461024710248102491025010251102521025310254102551025610257102581025910260102611026210263102641026510266102671026810269102701027110272102731027410275102761027710278102791028010281102821028310284102851028610287102881028910290102911029210293102941029510296102971029810299103001030110302103031030410305103061030710308103091031010311103121031310314103151031610317103181031910320103211032210323103241032510326103271032810329103301033110332103331033410335103361033710338103391034010341103421034310344103451034610347103481034910350103511035210353103541035510356103571035810359103601036110362103631036410365103661036710368103691037010371103721037310374103751037610377103781037910380103811038210383103841038510386103871038810389103901039110392103931039410395103961039710398103991040010401104021040310404104051040610407104081040910410104111041210413104141041510416104171041810419104201042110422104231042410425104261042710428104291043010431104321043310434104351043610437104381043910440104411044210443104441044510446104471044810449104501045110452104531045410455104561045710458104591046010461104621046310464104651046610467104681046910470104711047210473104741047510476104771047810479104801048110482104831048410485104861048710488104891049010491104921049310494104951049610497104981049910500105011050210503105041050510506105071050810509105101051110512105131051410515105161051710518105191052010521105221052310524105251052610527105281052910530105311053210533105341053510536105371053810539105401054110542105431054410545105461054710548105491055010551105521055310554105551055610557105581055910560105611056210563105641056510566105671056810569105701057110572105731057410575105761057710578105791058010581105821058310584105851058610587105881058910590105911059210593105941059510596105971059810599106001060110602106031060410605106061060710608106091061010611106121061310614106151061610617106181061910620106211062210623106241062510626106271062810629106301063110632106331063410635106361063710638106391064010641106421064310644106451064610647106481064910650106511065210653106541065510656106571065810659106601066110662106631066410665106661066710668106691067010671106721067310674106751067610677106781067910680106811068210683106841068510686106871068810689106901069110692106931069410695106961069710698106991070010701107021070310704107051070610707107081070910710107111071210713107141071510716107171071810719107201072110722107231072410725107261072710728107291073010731107321073310734107351073610737107381073910740107411074210743107441074510746107471074810749107501075110752107531075410755107561075710758107591076010761107621076310764107651076610767107681076910770107711077210773107741077510776107771077810779107801078110782107831078410785107861078710788107891079010791107921079310794107951079610797107981079910800108011080210803108041080510806108071080810809108101081110812108131081410815108161081710818108191082010821108221082310824108251082610827108281082910830108311083210833108341083510836108371083810839108401084110842108431084410845108461084710848108491085010851108521085310854108551085610857108581085910860108611086210863108641086510866108671086810869108701087110872108731087410875108761087710878108791088010881108821088310884108851088610887108881088910890108911089210893108941089510896108971089810899109001090110902109031090410905109061090710908109091091010911109121091310914109151091610917109181091910920109211092210923109241092510926109271092810929109301093110932109331093410935109361093710938109391094010941109421094310944109451094610947109481094910950109511095210953109541095510956109571095810959109601096110962109631096410965109661096710968109691097010971109721097310974109751097610977109781097910980109811098210983109841098510986109871098810989109901099110992109931099410995109961099710998109991100011001110021100311004110051100611007110081100911010110111101211013110141101511016110171101811019110201102111022110231102411025110261102711028110291103011031110321103311034110351103611037110381103911040110411104211043110441104511046110471104811049110501105111052110531105411055110561105711058110591106011061110621106311064110651106611067110681106911070110711107211073110741107511076110771107811079110801108111082110831108411085110861108711088110891109011091110921109311094110951109611097110981109911100111011110211103111041110511106111071110811109111101111111112111131111411115111161111711118111191112011121111221112311124111251112611127111281112911130111311113211133111341113511136111371113811139111401114111142111431114411145111461114711148111491115011151111521115311154111551115611157111581115911160111611116211163111641116511166111671116811169111701117111172111731117411175111761117711178111791118011181111821118311184111851118611187111881118911190111911119211193111941119511196111971119811199112001120111202112031120411205112061120711208112091121011211112121121311214112151121611217112181121911220112211122211223112241122511226112271122811229112301123111232112331123411235112361123711238112391124011241112421124311244112451124611247112481124911250112511125211253112541125511256112571125811259112601126111262112631126411265112661126711268112691127011271112721127311274112751127611277112781127911280112811128211283112841128511286112871128811289112901129111292112931129411295112961129711298112991130011301113021130311304113051130611307113081130911310113111131211313113141131511316113171131811319113201132111322113231132411325113261132711328113291133011331113321133311334113351133611337113381133911340113411134211343113441134511346113471134811349113501135111352113531135411355113561135711358113591136011361113621136311364113651136611367113681136911370113711137211373113741137511376113771137811379113801138111382113831138411385113861138711388113891139011391113921139311394113951139611397113981139911400114011140211403114041140511406114071140811409114101141111412114131141411415114161141711418114191142011421114221142311424114251142611427114281142911430114311143211433114341143511436114371143811439114401144111442114431144411445114461144711448114491145011451114521145311454114551145611457114581145911460114611146211463114641146511466114671146811469114701147111472114731147411475114761147711478114791148011481114821148311484114851148611487114881148911490114911149211493114941149511496114971149811499115001150111502115031150411505115061150711508115091151011511115121151311514115151151611517115181151911520115211152211523115241152511526115271152811529115301153111532115331153411535115361153711538115391154011541115421154311544115451154611547115481154911550115511155211553115541155511556115571155811559115601156111562115631156411565115661156711568115691157011571115721157311574115751157611577115781157911580115811158211583115841158511586115871158811589115901159111592115931159411595115961159711598115991160011601116021160311604116051160611607116081160911610116111161211613116141161511616116171161811619116201162111622116231162411625116261162711628116291163011631116321163311634116351163611637116381163911640116411164211643116441164511646116471164811649116501165111652116531165411655116561165711658116591166011661116621166311664116651166611667116681166911670116711167211673116741167511676116771167811679116801168111682116831168411685116861168711688116891169011691116921169311694116951169611697116981169911700117011170211703117041170511706117071170811709117101171111712117131171411715117161171711718117191172011721117221172311724117251172611727117281172911730117311173211733117341173511736117371173811739117401174111742117431174411745117461174711748117491175011751117521175311754117551175611757117581175911760117611176211763117641176511766117671176811769117701177111772117731177411775117761177711778117791178011781117821178311784117851178611787117881178911790117911179211793117941179511796117971179811799118001180111802118031180411805118061180711808118091181011811118121181311814118151181611817118181181911820118211182211823118241182511826118271182811829118301183111832118331183411835118361183711838118391184011841118421184311844118451184611847118481184911850118511185211853118541185511856118571185811859118601186111862118631186411865118661186711868118691187011871118721187311874118751187611877118781187911880118811188211883118841188511886118871188811889118901189111892118931189411895118961189711898118991190011901119021190311904119051190611907119081190911910119111191211913119141191511916119171191811919119201192111922119231192411925119261192711928119291193011931119321193311934119351193611937119381193911940119411194211943119441194511946119471194811949119501195111952119531195411955119561195711958119591196011961119621196311964119651196611967119681196911970119711197211973119741197511976119771197811979119801198111982119831198411985119861198711988119891199011991119921199311994119951199611997119981199912000120011200212003120041200512006120071200812009120101201112012120131201412015120161201712018120191202012021120221202312024120251202612027120281202912030120311203212033120341203512036120371203812039120401204112042120431204412045120461204712048120491205012051120521205312054120551205612057120581205912060120611206212063120641206512066120671206812069120701207112072120731207412075120761207712078120791208012081120821208312084120851208612087120881208912090120911209212093120941209512096120971209812099121001210112102121031210412105121061210712108121091211012111121121211312114121151211612117121181211912120121211212212123121241212512126121271212812129121301213112132121331213412135121361213712138121391214012141121421214312144121451214612147121481214912150121511215212153121541215512156121571215812159121601216112162121631216412165121661216712168121691217012171121721217312174121751217612177121781217912180121811218212183121841218512186121871218812189121901219112192121931219412195121961219712198121991220012201122021220312204122051220612207122081220912210122111221212213122141221512216122171221812219122201222112222122231222412225122261222712228122291223012231122321223312234122351223612237122381223912240122411224212243122441224512246122471224812249122501225112252122531225412255122561225712258122591226012261122621226312264122651226612267122681226912270122711227212273122741227512276122771227812279122801228112282122831228412285122861228712288122891229012291122921229312294122951229612297122981229912300123011230212303123041230512306123071230812309123101231112312123131231412315123161231712318123191232012321123221232312324123251232612327123281232912330123311233212333123341233512336123371233812339123401234112342123431234412345123461234712348123491235012351123521235312354123551235612357123581235912360123611236212363123641236512366123671236812369123701237112372123731237412375123761237712378123791238012381123821238312384123851238612387123881238912390123911239212393123941239512396123971239812399124001240112402124031240412405124061240712408124091241012411124121241312414124151241612417124181241912420124211242212423124241242512426124271242812429124301243112432124331243412435124361243712438124391244012441124421244312444124451244612447124481244912450124511245212453124541245512456124571245812459124601246112462124631246412465124661246712468124691247012471124721247312474124751247612477124781247912480124811248212483124841248512486124871248812489124901249112492124931249412495124961249712498124991250012501125021250312504125051250612507125081250912510125111251212513125141251512516125171251812519125201252112522125231252412525125261252712528125291253012531125321253312534125351253612537125381253912540125411254212543125441254512546125471254812549125501255112552125531255412555125561255712558125591256012561125621256312564125651256612567125681256912570125711257212573125741257512576125771257812579125801258112582125831258412585125861258712588125891259012591125921259312594125951259612597125981259912600126011260212603126041260512606126071260812609126101261112612126131261412615126161261712618126191262012621126221262312624126251262612627126281262912630126311263212633126341263512636126371263812639126401264112642126431264412645126461264712648126491265012651126521265312654126551265612657126581265912660126611266212663126641266512666126671266812669126701267112672126731267412675126761267712678126791268012681126821268312684126851268612687126881268912690126911269212693126941269512696126971269812699127001270112702127031270412705127061270712708127091271012711127121271312714127151271612717127181271912720127211272212723127241272512726127271272812729127301273112732127331273412735127361273712738127391274012741127421274312744127451274612747127481274912750127511275212753127541275512756127571275812759127601276112762127631276412765127661276712768127691277012771127721277312774127751277612777127781277912780127811278212783127841278512786127871278812789127901279112792127931279412795127961279712798127991280012801128021280312804128051280612807128081280912810128111281212813128141281512816128171281812819128201282112822128231282412825128261282712828128291283012831128321283312834128351283612837128381283912840128411284212843128441284512846128471284812849128501285112852128531285412855128561285712858128591286012861128621286312864128651286612867128681286912870128711287212873128741287512876128771287812879128801288112882128831288412885128861288712888128891289012891128921289312894128951289612897128981289912900129011290212903129041290512906129071290812909129101291112912129131291412915129161291712918129191292012921129221292312924129251292612927129281292912930129311293212933129341293512936129371293812939129401294112942129431294412945129461294712948129491295012951129521295312954129551295612957129581295912960129611296212963129641296512966129671296812969129701297112972129731297412975129761297712978129791298012981129821298312984129851298612987129881298912990129911299212993129941299512996129971299812999130001300113002130031300413005130061300713008130091301013011130121301313014130151301613017130181301913020130211302213023130241302513026130271302813029130301303113032130331303413035130361303713038130391304013041130421304313044130451304613047130481304913050130511305213053130541305513056130571305813059130601306113062130631306413065130661306713068130691307013071130721307313074130751307613077130781307913080130811308213083130841308513086130871308813089130901309113092130931309413095130961309713098130991310013101131021310313104131051310613107131081310913110131111311213113131141311513116131171311813119131201312113122131231312413125131261312713128131291313013131131321313313134131351313613137131381313913140131411314213143131441314513146131471314813149131501315113152131531315413155131561315713158131591316013161131621316313164131651316613167131681316913170131711317213173131741317513176131771317813179131801318113182131831318413185131861318713188131891319013191131921319313194131951319613197131981319913200132011320213203132041320513206132071320813209132101321113212132131321413215132161321713218132191322013221132221322313224132251322613227132281322913230132311323213233132341323513236132371323813239132401324113242132431324413245132461324713248132491325013251132521325313254132551325613257132581325913260132611326213263132641326513266132671326813269132701327113272132731327413275132761327713278132791328013281132821328313284132851328613287132881328913290132911329213293132941329513296132971329813299133001330113302133031330413305133061330713308133091331013311133121331313314133151331613317133181331913320133211332213323133241332513326133271332813329133301333113332133331333413335133361333713338133391334013341133421334313344133451334613347133481334913350133511335213353133541335513356133571335813359133601336113362133631336413365133661336713368133691337013371133721337313374133751337613377133781337913380133811338213383133841338513386133871338813389133901339113392133931339413395133961339713398133991340013401134021340313404134051340613407134081340913410134111341213413134141341513416134171341813419134201342113422134231342413425134261342713428134291343013431134321343313434134351343613437134381343913440134411344213443134441344513446134471344813449134501345113452134531345413455134561345713458134591346013461134621346313464134651346613467134681346913470134711347213473134741347513476134771347813479134801348113482134831348413485134861348713488134891349013491134921349313494134951349613497134981349913500135011350213503135041350513506135071350813509135101351113512135131351413515135161351713518135191352013521135221352313524135251352613527135281352913530135311353213533135341353513536135371353813539135401354113542135431354413545135461354713548135491355013551135521355313554135551355613557135581355913560135611356213563135641356513566135671356813569135701357113572135731357413575135761357713578135791358013581135821358313584135851358613587135881358913590135911359213593135941359513596135971359813599136001360113602136031360413605136061360713608136091361013611136121361313614136151361613617136181361913620136211362213623136241362513626136271362813629136301363113632136331363413635136361363713638136391364013641136421364313644136451364613647136481364913650136511365213653136541365513656136571365813659136601366113662136631366413665136661366713668136691367013671136721367313674136751367613677136781367913680136811368213683136841368513686136871368813689136901369113692136931369413695136961369713698136991370013701137021370313704137051370613707137081370913710137111371213713137141371513716137171371813719137201372113722137231372413725137261372713728137291373013731137321373313734137351373613737137381373913740137411374213743137441374513746137471374813749137501375113752137531375413755137561375713758137591376013761137621376313764137651376613767137681376913770137711377213773137741377513776137771377813779137801378113782137831378413785137861378713788137891379013791137921379313794137951379613797137981379913800138011380213803138041380513806138071380813809138101381113812138131381413815138161381713818138191382013821138221382313824138251382613827138281382913830138311383213833138341383513836138371383813839138401384113842138431384413845138461384713848138491385013851138521385313854138551385613857138581385913860138611386213863138641386513866138671386813869138701387113872138731387413875138761387713878138791388013881138821388313884138851388613887138881388913890138911389213893138941389513896138971389813899139001390113902139031390413905139061390713908139091391013911139121391313914139151391613917139181391913920139211392213923139241392513926139271392813929139301393113932139331393413935139361393713938139391394013941139421394313944139451394613947139481394913950139511395213953139541395513956139571395813959139601396113962139631396413965139661396713968139691397013971139721397313974139751397613977139781397913980139811398213983139841398513986139871398813989139901399113992139931399413995139961399713998139991400014001140021400314004140051400614007140081400914010140111401214013140141401514016140171401814019140201402114022140231402414025140261402714028140291403014031140321403314034140351403614037140381403914040140411404214043140441404514046140471404814049140501405114052140531405414055140561405714058140591406014061140621406314064140651406614067140681406914070140711407214073140741407514076140771407814079140801408114082140831408414085140861408714088140891409014091140921409314094140951409614097140981409914100141011410214103141041410514106141071410814109141101411114112141131411414115141161411714118141191412014121141221412314124141251412614127141281412914130141311413214133141341413514136141371413814139141401414114142141431414414145141461414714148141491415014151141521415314154141551415614157141581415914160141611416214163141641416514166141671416814169141701417114172141731417414175141761417714178141791418014181141821418314184141851418614187141881418914190141911419214193141941419514196141971419814199142001420114202142031420414205142061420714208142091421014211142121421314214142151421614217142181421914220142211422214223142241422514226142271422814229142301423114232142331423414235142361423714238142391424014241142421424314244142451424614247142481424914250142511425214253142541425514256142571425814259142601426114262142631426414265142661426714268142691427014271142721427314274142751427614277142781427914280142811428214283142841428514286142871428814289142901429114292142931429414295142961429714298142991430014301143021430314304143051430614307143081430914310143111431214313143141431514316143171431814319143201432114322143231432414325143261432714328143291433014331143321433314334143351433614337143381433914340143411434214343143441434514346143471434814349143501435114352143531435414355143561435714358143591436014361143621436314364143651436614367143681436914370143711437214373143741437514376143771437814379143801438114382143831438414385143861438714388143891439014391143921439314394143951439614397143981439914400144011440214403144041440514406144071440814409144101441114412144131441414415144161441714418144191442014421144221442314424144251442614427144281442914430144311443214433144341443514436144371443814439144401444114442144431444414445144461444714448144491445014451144521445314454144551445614457144581445914460144611446214463144641446514466144671446814469144701447114472144731447414475144761447714478144791448014481144821448314484144851448614487144881448914490144911449214493144941449514496144971449814499145001450114502145031450414505145061450714508145091451014511145121451314514145151451614517145181451914520145211452214523145241452514526145271452814529145301453114532145331453414535145361453714538145391454014541145421454314544145451454614547145481454914550145511455214553145541455514556145571455814559145601456114562145631456414565145661456714568145691457014571145721457314574145751457614577145781457914580145811458214583145841458514586145871458814589145901459114592145931459414595145961459714598145991460014601146021460314604146051460614607146081460914610146111461214613146141461514616146171461814619146201462114622146231462414625146261462714628146291463014631146321463314634146351463614637146381463914640146411464214643146441464514646146471464814649146501465114652146531465414655146561465714658146591466014661146621466314664146651466614667146681466914670146711467214673146741467514676146771467814679146801468114682146831468414685146861468714688146891469014691146921469314694146951469614697146981469914700147011470214703147041470514706147071470814709147101471114712147131471414715147161471714718147191472014721147221472314724147251472614727147281472914730147311473214733147341473514736147371473814739147401474114742147431474414745147461474714748147491475014751147521475314754147551475614757147581475914760147611476214763147641476514766147671476814769147701477114772147731477414775147761477714778147791478014781147821478314784147851478614787147881478914790147911479214793147941479514796147971479814799148001480114802148031480414805148061480714808148091481014811148121481314814148151481614817148181481914820148211482214823148241482514826148271482814829148301483114832148331483414835148361483714838148391484014841148421484314844148451484614847148481484914850148511485214853148541485514856148571485814859148601486114862148631486414865148661486714868148691487014871148721487314874148751487614877148781487914880148811488214883148841488514886148871488814889148901489114892148931489414895148961489714898148991490014901149021490314904149051490614907149081490914910149111491214913149141491514916149171491814919149201492114922149231492414925149261492714928149291493014931149321493314934149351493614937149381493914940149411494214943149441494514946149471494814949149501495114952149531495414955149561495714958149591496014961149621496314964149651496614967149681496914970149711497214973149741497514976149771497814979149801498114982149831498414985149861498714988149891499014991149921499314994149951499614997149981499915000150011500215003150041500515006150071500815009150101501115012150131501415015150161501715018150191502015021150221502315024150251502615027150281502915030150311503215033150341503515036150371503815039150401504115042150431504415045150461504715048150491505015051150521505315054150551505615057150581505915060150611506215063150641506515066150671506815069150701507115072150731507415075150761507715078150791508015081150821508315084150851508615087150881508915090150911509215093150941509515096150971509815099151001510115102151031510415105151061510715108151091511015111151121511315114151151511615117151181511915120151211512215123151241512515126151271512815129151301513115132151331513415135151361513715138151391514015141151421514315144151451514615147151481514915150151511515215153151541515515156151571515815159151601516115162151631516415165151661516715168151691517015171151721517315174151751517615177151781517915180151811518215183151841518515186151871518815189151901519115192151931519415195151961519715198151991520015201152021520315204152051520615207152081520915210152111521215213152141521515216152171521815219152201522115222152231522415225152261522715228152291523015231152321523315234152351523615237152381523915240152411524215243152441524515246152471524815249152501525115252152531525415255152561525715258152591526015261152621526315264152651526615267152681526915270152711527215273152741527515276152771527815279152801528115282152831528415285152861528715288152891529015291152921529315294152951529615297152981529915300153011530215303153041530515306153071530815309153101531115312153131531415315153161531715318153191532015321153221532315324153251532615327153281532915330153311533215333153341533515336153371533815339153401534115342153431534415345153461534715348153491535015351153521535315354153551535615357153581535915360153611536215363153641536515366153671536815369153701537115372153731537415375153761537715378153791538015381153821538315384153851538615387153881538915390153911539215393153941539515396153971539815399154001540115402154031540415405154061540715408154091541015411154121541315414154151541615417154181541915420154211542215423154241542515426154271542815429154301543115432154331543415435154361543715438154391544015441154421544315444154451544615447154481544915450154511545215453154541545515456154571545815459154601546115462154631546415465154661546715468154691547015471154721547315474154751547615477154781547915480154811548215483154841548515486154871548815489154901549115492154931549415495154961549715498154991550015501155021550315504155051550615507155081550915510155111551215513155141551515516155171551815519155201552115522155231552415525155261552715528155291553015531155321553315534155351553615537155381553915540155411554215543155441554515546155471554815549155501555115552155531555415555155561555715558155591556015561155621556315564155651556615567155681556915570155711557215573155741557515576155771557815579155801558115582155831558415585155861558715588155891559015591155921559315594155951559615597155981559915600156011560215603156041560515606156071560815609156101561115612156131561415615156161561715618156191562015621156221562315624156251562615627156281562915630156311563215633156341563515636156371563815639156401564115642156431564415645156461564715648156491565015651156521565315654156551565615657156581565915660156611566215663156641566515666156671566815669156701567115672156731567415675156761567715678156791568015681156821568315684156851568615687156881568915690156911569215693156941569515696156971569815699157001570115702157031570415705157061570715708157091571015711157121571315714157151571615717157181571915720157211572215723157241572515726157271572815729157301573115732157331573415735157361573715738157391574015741157421574315744157451574615747157481574915750157511575215753157541575515756157571575815759157601576115762157631576415765157661576715768157691577015771157721577315774157751577615777157781577915780157811578215783157841578515786157871578815789157901579115792157931579415795157961579715798157991580015801158021580315804158051580615807158081580915810158111581215813158141581515816158171581815819158201582115822158231582415825158261582715828158291583015831158321583315834158351583615837158381583915840158411584215843158441584515846158471584815849158501585115852158531585415855158561585715858158591586015861158621586315864158651586615867158681586915870158711587215873158741587515876158771587815879158801588115882158831588415885158861588715888158891589015891158921589315894158951589615897158981589915900159011590215903159041590515906159071590815909159101591115912159131591415915159161591715918159191592015921159221592315924159251592615927159281592915930159311593215933159341593515936159371593815939159401594115942159431594415945159461594715948159491595015951159521595315954159551595615957159581595915960159611596215963159641596515966159671596815969159701597115972159731597415975159761597715978159791598015981159821598315984159851598615987159881598915990159911599215993159941599515996159971599815999160001600116002160031600416005160061600716008160091601016011160121601316014160151601616017160181601916020160211602216023160241602516026160271602816029160301603116032160331603416035160361603716038160391604016041160421604316044160451604616047160481604916050160511605216053160541605516056160571605816059160601606116062160631606416065160661606716068160691607016071160721607316074160751607616077160781607916080160811608216083160841608516086160871608816089160901609116092160931609416095160961609716098160991610016101161021610316104161051610616107161081610916110161111611216113161141611516116161171611816119161201612116122161231612416125161261612716128161291613016131161321613316134161351613616137161381613916140161411614216143161441614516146161471614816149161501615116152161531615416155161561615716158161591616016161161621616316164161651616616167161681616916170161711617216173161741617516176161771617816179161801618116182161831618416185161861618716188161891619016191161921619316194161951619616197161981619916200162011620216203162041620516206162071620816209162101621116212162131621416215162161621716218162191622016221162221622316224162251622616227162281622916230162311623216233162341623516236162371623816239162401624116242162431624416245162461624716248162491625016251162521625316254162551625616257162581625916260162611626216263162641626516266162671626816269162701627116272162731627416275162761627716278162791628016281162821628316284162851628616287162881628916290162911629216293162941629516296162971629816299163001630116302163031630416305163061630716308163091631016311163121631316314163151631616317163181631916320163211632216323163241632516326163271632816329163301633116332163331633416335163361633716338163391634016341163421634316344163451634616347163481634916350163511635216353163541635516356163571635816359163601636116362163631636416365163661636716368163691637016371163721637316374163751637616377163781637916380163811638216383163841638516386163871638816389163901639116392163931639416395163961639716398163991640016401164021640316404164051640616407164081640916410164111641216413164141641516416164171641816419164201642116422164231642416425164261642716428164291643016431164321643316434164351643616437164381643916440164411644216443164441644516446164471644816449164501645116452164531645416455164561645716458164591646016461164621646316464164651646616467164681646916470164711647216473164741647516476164771647816479164801648116482164831648416485164861648716488164891649016491164921649316494164951649616497164981649916500165011650216503165041650516506165071650816509165101651116512165131651416515165161651716518165191652016521165221652316524165251652616527165281652916530165311653216533165341653516536165371653816539165401654116542165431654416545165461654716548165491655016551165521655316554165551655616557165581655916560165611656216563165641656516566165671656816569165701657116572165731657416575165761657716578165791658016581165821658316584165851658616587165881658916590165911659216593165941659516596165971659816599166001660116602166031660416605166061660716608166091661016611166121661316614166151661616617166181661916620166211662216623166241662516626166271662816629166301663116632166331663416635166361663716638166391664016641166421664316644166451664616647166481664916650166511665216653166541665516656166571665816659166601666116662166631666416665166661666716668166691667016671166721667316674166751667616677166781667916680166811668216683166841668516686166871668816689166901669116692166931669416695166961669716698166991670016701167021670316704167051670616707167081670916710167111671216713167141671516716167171671816719167201672116722167231672416725167261672716728167291673016731167321673316734167351673616737167381673916740167411674216743167441674516746167471674816749167501675116752167531675416755167561675716758167591676016761167621676316764167651676616767167681676916770167711677216773167741677516776167771677816779167801678116782167831678416785167861678716788167891679016791167921679316794167951679616797167981679916800168011680216803168041680516806168071680816809168101681116812168131681416815168161681716818168191682016821168221682316824168251682616827168281682916830168311683216833168341683516836168371683816839168401684116842168431684416845168461684716848168491685016851168521685316854168551685616857168581685916860168611686216863168641686516866168671686816869168701687116872168731687416875168761687716878168791688016881168821688316884168851688616887168881688916890168911689216893168941689516896168971689816899169001690116902169031690416905169061690716908169091691016911169121691316914169151691616917169181691916920169211692216923169241692516926169271692816929169301693116932169331693416935169361693716938169391694016941169421694316944169451694616947169481694916950169511695216953169541695516956169571695816959169601696116962169631696416965169661696716968169691697016971169721697316974169751697616977169781697916980169811698216983169841698516986169871698816989169901699116992169931699416995169961699716998169991700017001170021700317004170051700617007170081700917010170111701217013170141701517016170171701817019170201702117022170231702417025170261702717028170291703017031170321703317034170351703617037170381703917040170411704217043170441704517046170471704817049170501705117052170531705417055170561705717058170591706017061170621706317064170651706617067170681706917070170711707217073170741707517076170771707817079170801708117082170831708417085170861708717088170891709017091170921709317094170951709617097170981709917100171011710217103171041710517106171071710817109171101711117112171131711417115171161711717118171191712017121171221712317124171251712617127171281712917130171311713217133171341713517136171371713817139171401714117142171431714417145171461714717148171491715017151171521715317154171551715617157171581715917160171611716217163171641716517166171671716817169171701717117172171731717417175171761717717178171791718017181171821718317184171851718617187171881718917190171911719217193171941719517196171971719817199172001720117202172031720417205172061720717208172091721017211172121721317214172151721617217172181721917220172211722217223172241722517226172271722817229172301723117232172331723417235172361723717238172391724017241172421724317244172451724617247172481724917250172511725217253172541725517256172571725817259172601726117262172631726417265172661726717268172691727017271172721727317274172751727617277172781727917280172811728217283172841728517286172871728817289172901729117292172931729417295172961729717298172991730017301173021730317304173051730617307173081730917310173111731217313173141731517316173171731817319173201732117322173231732417325173261732717328173291733017331173321733317334173351733617337173381733917340173411734217343173441734517346173471734817349173501735117352173531735417355173561735717358173591736017361173621736317364173651736617367173681736917370173711737217373173741737517376173771737817379173801738117382173831738417385173861738717388173891739017391173921739317394173951739617397173981739917400174011740217403174041740517406174071740817409174101741117412174131741417415174161741717418174191742017421174221742317424174251742617427174281742917430174311743217433174341743517436174371743817439174401744117442174431744417445174461744717448174491745017451174521745317454174551745617457174581745917460174611746217463174641746517466174671746817469174701747117472174731747417475174761747717478174791748017481174821748317484174851748617487174881748917490174911749217493174941749517496174971749817499175001750117502175031750417505175061750717508175091751017511175121751317514175151751617517175181751917520175211752217523175241752517526175271752817529175301753117532175331753417535175361753717538175391754017541175421754317544175451754617547175481754917550175511755217553175541755517556175571755817559175601756117562175631756417565175661756717568175691757017571175721757317574175751757617577175781757917580175811758217583175841758517586175871758817589175901759117592175931759417595175961759717598175991760017601176021760317604176051760617607176081760917610176111761217613176141761517616176171761817619176201762117622176231762417625176261762717628176291763017631176321763317634176351763617637176381763917640176411764217643176441764517646176471764817649176501765117652176531765417655176561765717658176591766017661176621766317664176651766617667176681766917670176711767217673176741767517676176771767817679176801768117682176831768417685176861768717688176891769017691176921769317694176951769617697176981769917700177011770217703177041770517706177071770817709177101771117712177131771417715177161771717718177191772017721177221772317724177251772617727177281772917730177311773217733177341773517736177371773817739177401774117742177431774417745177461774717748177491775017751177521775317754177551775617757177581775917760177611776217763177641776517766177671776817769177701777117772177731777417775177761777717778177791778017781177821778317784177851778617787177881778917790177911779217793177941779517796177971779817799178001780117802178031780417805178061780717808178091781017811178121781317814178151781617817178181781917820178211782217823178241782517826178271782817829178301783117832178331783417835178361783717838178391784017841178421784317844178451784617847178481784917850178511785217853178541785517856178571785817859178601786117862178631786417865178661786717868178691787017871178721787317874178751787617877178781787917880178811788217883178841788517886178871788817889178901789117892178931789417895178961789717898178991790017901179021790317904179051790617907179081790917910179111791217913179141791517916179171791817919179201792117922179231792417925179261792717928179291793017931179321793317934179351793617937179381793917940179411794217943179441794517946179471794817949179501795117952179531795417955179561795717958179591796017961179621796317964179651796617967179681796917970179711797217973179741797517976179771797817979179801798117982179831798417985179861798717988179891799017991179921799317994179951799617997179981799918000180011800218003180041800518006180071800818009180101801118012180131801418015180161801718018180191802018021180221802318024180251802618027180281802918030180311803218033180341803518036180371803818039180401804118042180431804418045180461804718048180491805018051180521805318054180551805618057180581805918060180611806218063180641806518066180671806818069180701807118072180731807418075180761807718078180791808018081180821808318084180851808618087180881808918090180911809218093180941809518096180971809818099181001810118102181031810418105181061810718108181091811018111181121811318114181151811618117181181811918120181211812218123181241812518126181271812818129181301813118132181331813418135181361813718138181391814018141181421814318144181451814618147181481814918150181511815218153181541815518156181571815818159181601816118162181631816418165181661816718168181691817018171181721817318174181751817618177181781817918180181811818218183181841818518186181871818818189181901819118192181931819418195181961819718198181991820018201182021820318204182051820618207182081820918210182111821218213182141821518216182171821818219182201822118222182231822418225182261822718228182291823018231182321823318234182351823618237182381823918240182411824218243182441824518246182471824818249182501825118252182531825418255182561825718258182591826018261182621826318264182651826618267182681826918270182711827218273182741827518276182771827818279182801828118282182831828418285182861828718288182891829018291182921829318294182951829618297182981829918300183011830218303183041830518306183071830818309183101831118312183131831418315183161831718318183191832018321183221832318324183251832618327183281832918330183311833218333183341833518336183371833818339183401834118342183431834418345183461834718348183491835018351183521835318354183551835618357183581835918360183611836218363183641836518366183671836818369183701837118372183731837418375183761837718378183791838018381183821838318384183851838618387183881838918390183911839218393183941839518396183971839818399184001840118402184031840418405184061840718408184091841018411184121841318414184151841618417184181841918420184211842218423184241842518426184271842818429184301843118432184331843418435184361843718438184391844018441184421844318444184451844618447184481844918450184511845218453184541845518456184571845818459184601846118462184631846418465184661846718468184691847018471184721847318474184751847618477184781847918480184811848218483184841848518486184871848818489184901849118492184931849418495184961849718498184991850018501185021850318504185051850618507185081850918510185111851218513185141851518516185171851818519185201852118522185231852418525185261852718528185291853018531185321853318534185351853618537185381853918540185411854218543185441854518546185471854818549185501855118552185531855418555185561855718558185591856018561185621856318564185651856618567185681856918570185711857218573185741857518576185771857818579185801858118582185831858418585185861858718588185891859018591185921859318594185951859618597185981859918600186011860218603186041860518606186071860818609186101861118612186131861418615186161861718618186191862018621186221862318624186251862618627186281862918630186311863218633186341863518636186371863818639186401864118642186431864418645186461864718648186491865018651186521865318654186551865618657186581865918660186611866218663186641866518666186671866818669186701867118672186731867418675186761867718678186791868018681186821868318684186851868618687186881868918690186911869218693186941869518696186971869818699187001870118702187031870418705187061870718708187091871018711187121871318714187151871618717187181871918720187211872218723187241872518726187271872818729187301873118732187331873418735187361873718738187391874018741187421874318744187451874618747187481874918750187511875218753187541875518756187571875818759187601876118762187631876418765187661876718768187691877018771187721877318774187751877618777187781877918780187811878218783187841878518786187871878818789187901879118792187931879418795187961879718798187991880018801188021880318804188051880618807188081880918810188111881218813188141881518816188171881818819188201882118822188231882418825188261882718828188291883018831188321883318834188351883618837188381883918840188411884218843188441884518846188471884818849188501885118852188531885418855188561885718858188591886018861188621886318864188651886618867188681886918870188711887218873188741887518876188771887818879188801888118882188831888418885188861888718888188891889018891188921889318894188951889618897188981889918900189011890218903189041890518906189071890818909189101891118912189131891418915189161891718918189191892018921189221892318924189251892618927189281892918930189311893218933189341893518936189371893818939189401894118942189431894418945189461894718948189491895018951189521895318954189551895618957189581895918960189611896218963189641896518966189671896818969189701897118972189731897418975189761897718978189791898018981189821898318984189851898618987189881898918990189911899218993189941899518996189971899818999190001900119002190031900419005190061900719008190091901019011190121901319014190151901619017190181901919020190211902219023190241902519026190271902819029190301903119032190331903419035190361903719038190391904019041190421904319044190451904619047190481904919050190511905219053190541905519056190571905819059190601906119062190631906419065190661906719068190691907019071190721907319074190751907619077190781907919080190811908219083190841908519086190871908819089190901909119092190931909419095190961909719098190991910019101191021910319104191051910619107191081910919110191111911219113191141911519116191171911819119191201912119122191231912419125191261912719128191291913019131191321913319134191351913619137191381913919140191411914219143191441914519146191471914819149191501915119152191531915419155191561915719158191591916019161191621916319164191651916619167191681916919170191711917219173191741917519176191771917819179191801918119182191831918419185191861918719188191891919019191191921919319194191951919619197191981919919200192011920219203192041920519206192071920819209192101921119212192131921419215192161921719218192191922019221192221922319224192251922619227192281922919230192311923219233192341923519236192371923819239192401924119242192431924419245192461924719248192491925019251192521925319254192551925619257192581925919260192611926219263192641926519266192671926819269192701927119272192731927419275192761927719278192791928019281192821928319284192851928619287192881928919290192911929219293192941929519296192971929819299193001930119302193031930419305193061930719308193091931019311193121931319314193151931619317193181931919320193211932219323193241932519326193271932819329193301933119332193331933419335193361933719338193391934019341193421934319344193451934619347193481934919350193511935219353193541935519356193571935819359193601936119362193631936419365193661936719368193691937019371193721937319374193751937619377193781937919380193811938219383193841938519386193871938819389193901939119392193931939419395193961939719398193991940019401194021940319404194051940619407194081940919410194111941219413194141941519416194171941819419194201942119422194231942419425194261942719428194291943019431194321943319434194351943619437194381943919440194411944219443194441944519446194471944819449194501945119452194531945419455194561945719458194591946019461194621946319464194651946619467194681946919470194711947219473194741947519476194771947819479194801948119482194831948419485194861948719488194891949019491194921949319494194951949619497194981949919500195011950219503195041950519506195071950819509195101951119512195131951419515195161951719518195191952019521195221952319524195251952619527195281952919530195311953219533195341953519536195371953819539195401954119542195431954419545195461954719548195491955019551195521955319554195551955619557195581955919560195611956219563195641956519566195671956819569195701957119572195731957419575195761957719578195791958019581195821958319584195851958619587195881958919590195911959219593195941959519596195971959819599196001960119602196031960419605196061960719608196091961019611196121961319614196151961619617196181961919620196211962219623196241962519626196271962819629196301963119632196331963419635196361963719638196391964019641196421964319644196451964619647196481964919650196511965219653196541965519656196571965819659196601966119662196631966419665196661966719668196691967019671196721967319674196751967619677196781967919680196811968219683196841968519686196871968819689196901969119692196931969419695196961969719698196991970019701197021970319704197051970619707197081970919710197111971219713197141971519716197171971819719197201972119722197231972419725197261972719728197291973019731197321973319734197351973619737197381973919740197411974219743197441974519746197471974819749197501975119752197531975419755197561975719758197591976019761197621976319764197651976619767197681976919770197711977219773197741977519776197771977819779197801978119782197831978419785197861978719788197891979019791197921979319794197951979619797197981979919800198011980219803198041980519806198071980819809198101981119812198131981419815198161981719818198191982019821198221982319824198251982619827198281982919830198311983219833198341983519836198371983819839198401984119842198431984419845198461984719848198491985019851198521985319854198551985619857198581985919860198611986219863198641986519866198671986819869198701987119872198731987419875198761987719878198791988019881198821988319884198851988619887198881988919890198911989219893198941989519896198971989819899199001990119902199031990419905199061990719908199091991019911199121991319914199151991619917199181991919920199211992219923199241992519926199271992819929199301993119932199331993419935199361993719938199391994019941199421994319944199451994619947199481994919950199511995219953199541995519956199571995819959199601996119962199631996419965199661996719968199691997019971199721997319974199751997619977199781997919980199811998219983199841998519986199871998819989199901999119992199931999419995199961999719998199992000020001200022000320004200052000620007200082000920010200112001220013200142001520016200172001820019200202002120022200232002420025200262002720028200292003020031200322003320034200352003620037200382003920040200412004220043200442004520046200472004820049200502005120052200532005420055200562005720058200592006020061200622006320064200652006620067200682006920070200712007220073200742007520076200772007820079200802008120082200832008420085200862008720088200892009020091200922009320094200952009620097200982009920100201012010220103201042010520106201072010820109201102011120112201132011420115201162011720118201192012020121201222012320124201252012620127201282012920130201312013220133201342013520136201372013820139201402014120142201432014420145201462014720148201492015020151201522015320154201552015620157201582015920160201612016220163201642016520166201672016820169201702017120172201732017420175201762017720178201792018020181201822018320184201852018620187201882018920190201912019220193201942019520196201972019820199202002020120202202032020420205202062020720208202092021020211202122021320214202152021620217202182021920220202212022220223202242022520226202272022820229202302023120232202332023420235202362023720238202392024020241202422024320244202452024620247202482024920250202512025220253202542025520256202572025820259202602026120262202632026420265202662026720268202692027020271202722027320274202752027620277202782027920280202812028220283202842028520286202872028820289202902029120292202932029420295202962029720298202992030020301203022030320304203052030620307203082030920310203112031220313203142031520316203172031820319203202032120322203232032420325203262032720328203292033020331203322033320334203352033620337203382033920340203412034220343203442034520346203472034820349203502035120352203532035420355203562035720358203592036020361203622036320364203652036620367203682036920370203712037220373203742037520376203772037820379203802038120382203832038420385203862038720388203892039020391203922039320394203952039620397203982039920400204012040220403204042040520406204072040820409204102041120412204132041420415204162041720418204192042020421204222042320424204252042620427204282042920430204312043220433204342043520436204372043820439204402044120442204432044420445204462044720448204492045020451204522045320454204552045620457204582045920460204612046220463204642046520466204672046820469204702047120472204732047420475204762047720478204792048020481204822048320484204852048620487204882048920490204912049220493204942049520496204972049820499205002050120502205032050420505205062050720508205092051020511205122051320514205152051620517205182051920520205212052220523205242052520526205272052820529205302053120532205332053420535205362053720538205392054020541205422054320544205452054620547205482054920550205512055220553205542055520556205572055820559205602056120562205632056420565205662056720568205692057020571205722057320574205752057620577205782057920580205812058220583205842058520586205872058820589205902059120592205932059420595205962059720598205992060020601206022060320604206052060620607206082060920610206112061220613206142061520616206172061820619206202062120622206232062420625206262062720628206292063020631206322063320634206352063620637206382063920640206412064220643206442064520646206472064820649206502065120652206532065420655206562065720658206592066020661206622066320664206652066620667206682066920670206712067220673206742067520676206772067820679206802068120682206832068420685206862068720688206892069020691206922069320694206952069620697206982069920700207012070220703207042070520706207072070820709207102071120712207132071420715207162071720718207192072020721207222072320724207252072620727207282072920730207312073220733207342073520736207372073820739207402074120742207432074420745207462074720748207492075020751207522075320754207552075620757207582075920760207612076220763207642076520766207672076820769207702077120772207732077420775207762077720778207792078020781207822078320784207852078620787207882078920790207912079220793207942079520796207972079820799208002080120802208032080420805208062080720808208092081020811208122081320814208152081620817208182081920820208212082220823208242082520826208272082820829208302083120832208332083420835208362083720838208392084020841208422084320844208452084620847208482084920850208512085220853208542085520856208572085820859208602086120862208632086420865208662086720868208692087020871208722087320874208752087620877208782087920880208812088220883208842088520886208872088820889208902089120892208932089420895208962089720898208992090020901209022090320904209052090620907209082090920910209112091220913209142091520916209172091820919209202092120922209232092420925209262092720928209292093020931209322093320934209352093620937209382093920940209412094220943209442094520946209472094820949209502095120952209532095420955209562095720958209592096020961209622096320964209652096620967209682096920970209712097220973209742097520976209772097820979209802098120982209832098420985209862098720988209892099020991209922099320994209952099620997209982099921000210012100221003210042100521006210072100821009210102101121012210132101421015210162101721018210192102021021210222102321024210252102621027210282102921030210312103221033210342103521036210372103821039210402104121042210432104421045210462104721048210492105021051210522105321054210552105621057210582105921060210612106221063210642106521066210672106821069210702107121072210732107421075210762107721078210792108021081210822108321084210852108621087210882108921090210912109221093210942109521096210972109821099211002110121102211032110421105211062110721108211092111021111211122111321114211152111621117211182111921120211212112221123211242112521126211272112821129211302113121132211332113421135211362113721138211392114021141211422114321144211452114621147211482114921150211512115221153211542115521156211572115821159211602116121162211632116421165211662116721168211692117021171211722117321174211752117621177211782117921180211812118221183211842118521186211872118821189211902119121192211932119421195211962119721198211992120021201212022120321204212052120621207212082120921210212112121221213212142121521216212172121821219212202122121222212232122421225212262122721228212292123021231212322123321234212352123621237212382123921240212412124221243212442124521246212472124821249212502125121252212532125421255212562125721258212592126021261212622126321264212652126621267212682126921270212712127221273212742127521276212772127821279212802128121282212832128421285212862128721288212892129021291212922129321294212952129621297212982129921300213012130221303213042130521306213072130821309213102131121312213132131421315213162131721318213192132021321213222132321324213252132621327213282132921330213312133221333213342133521336213372133821339213402134121342213432134421345213462134721348213492135021351213522135321354213552135621357213582135921360213612136221363213642136521366213672136821369213702137121372213732137421375213762137721378213792138021381213822138321384213852138621387213882138921390213912139221393213942139521396213972139821399214002140121402214032140421405214062140721408214092141021411214122141321414214152141621417214182141921420214212142221423214242142521426214272142821429214302143121432214332143421435214362143721438214392144021441214422144321444214452144621447214482144921450214512145221453214542145521456214572145821459214602146121462214632146421465214662146721468214692147021471214722147321474214752147621477214782147921480214812148221483214842148521486214872148821489214902149121492214932149421495214962149721498214992150021501215022150321504215052150621507215082150921510215112151221513215142151521516215172151821519215202152121522215232152421525215262152721528215292153021531215322153321534215352153621537215382153921540215412154221543215442154521546215472154821549215502155121552215532155421555215562155721558215592156021561215622156321564215652156621567215682156921570215712157221573215742157521576215772157821579215802158121582215832158421585215862158721588215892159021591215922159321594215952159621597215982159921600216012160221603216042160521606216072160821609216102161121612216132161421615216162161721618216192162021621216222162321624216252162621627216282162921630216312163221633216342163521636216372163821639216402164121642216432164421645216462164721648216492165021651216522165321654216552165621657216582165921660216612166221663216642166521666216672166821669216702167121672216732167421675216762167721678216792168021681216822168321684216852168621687216882168921690216912169221693216942169521696216972169821699217002170121702217032170421705217062170721708217092171021711217122171321714217152171621717217182171921720217212172221723217242172521726217272172821729217302173121732217332173421735217362173721738217392174021741217422174321744217452174621747217482174921750217512175221753217542175521756217572175821759217602176121762217632176421765217662176721768217692177021771217722177321774217752177621777217782177921780217812178221783217842178521786217872178821789217902179121792217932179421795217962179721798217992180021801218022180321804218052180621807218082180921810218112181221813218142181521816218172181821819218202182121822218232182421825218262182721828218292183021831218322183321834218352183621837218382183921840218412184221843218442184521846218472184821849218502185121852218532185421855218562185721858218592186021861218622186321864218652186621867218682186921870218712187221873218742187521876218772187821879218802188121882218832188421885218862188721888218892189021891218922189321894218952189621897218982189921900219012190221903219042190521906219072190821909219102191121912219132191421915219162191721918219192192021921219222192321924219252192621927219282192921930219312193221933219342193521936219372193821939219402194121942219432194421945219462194721948219492195021951219522195321954219552195621957219582195921960219612196221963219642196521966219672196821969219702197121972219732197421975219762197721978219792198021981219822198321984219852198621987219882198921990219912199221993219942199521996219972199821999220002200122002220032200422005220062200722008220092201022011220122201322014220152201622017220182201922020220212202222023220242202522026220272202822029220302203122032220332203422035220362203722038220392204022041220422204322044220452204622047220482204922050220512205222053220542205522056220572205822059220602206122062220632206422065220662206722068220692207022071220722207322074220752207622077220782207922080220812208222083220842208522086220872208822089220902209122092220932209422095220962209722098220992210022101221022210322104221052210622107221082210922110221112211222113221142211522116221172211822119221202212122122221232212422125221262212722128221292213022131221322213322134221352213622137221382213922140221412214222143221442214522146221472214822149221502215122152221532215422155221562215722158221592216022161221622216322164221652216622167221682216922170221712217222173221742217522176221772217822179221802218122182221832218422185221862218722188221892219022191221922219322194221952219622197221982219922200222012220222203222042220522206222072220822209222102221122212222132221422215222162221722218222192222022221222222222322224222252222622227222282222922230222312223222233222342223522236222372223822239222402224122242222432224422245222462224722248222492225022251222522225322254222552225622257222582225922260222612226222263222642226522266222672226822269222702227122272222732227422275222762227722278222792228022281222822228322284222852228622287222882228922290222912229222293222942229522296222972229822299223002230122302223032230422305223062230722308223092231022311223122231322314223152231622317223182231922320223212232222323223242232522326223272232822329223302233122332223332233422335223362233722338223392234022341223422234322344223452234622347223482234922350223512235222353223542235522356223572235822359223602236122362223632236422365223662236722368223692237022371223722237322374223752237622377223782237922380223812238222383223842238522386223872238822389223902239122392223932239422395223962239722398223992240022401224022240322404224052240622407224082240922410224112241222413224142241522416224172241822419224202242122422224232242422425224262242722428224292243022431224322243322434224352243622437224382243922440224412244222443224442244522446224472244822449224502245122452224532245422455224562245722458224592246022461224622246322464224652246622467224682246922470224712247222473224742247522476224772247822479224802248122482224832248422485224862248722488224892249022491224922249322494224952249622497224982249922500225012250222503225042250522506225072250822509225102251122512225132251422515225162251722518225192252022521225222252322524225252252622527225282252922530225312253222533225342253522536225372253822539225402254122542225432254422545225462254722548225492255022551225522255322554225552255622557225582255922560225612256222563225642256522566225672256822569225702257122572225732257422575225762257722578225792258022581225822258322584225852258622587225882258922590225912259222593225942259522596225972259822599226002260122602226032260422605226062260722608226092261022611226122261322614226152261622617226182261922620226212262222623226242262522626226272262822629226302263122632226332263422635226362263722638226392264022641226422264322644226452264622647226482264922650226512265222653226542265522656226572265822659226602266122662226632266422665226662266722668226692267022671226722267322674226752267622677226782267922680226812268222683226842268522686226872268822689226902269122692226932269422695226962269722698226992270022701227022270322704227052270622707227082270922710227112271222713227142271522716227172271822719227202272122722227232272422725227262272722728227292273022731227322273322734227352273622737227382273922740227412274222743227442274522746227472274822749227502275122752227532275422755227562275722758227592276022761227622276322764227652276622767227682276922770227712277222773227742277522776227772277822779227802278122782227832278422785227862278722788227892279022791227922279322794227952279622797227982279922800228012280222803228042280522806228072280822809228102281122812228132281422815228162281722818228192282022821228222282322824228252282622827228282282922830228312283222833228342283522836228372283822839228402284122842228432284422845228462284722848228492285022851228522285322854228552285622857228582285922860228612286222863228642286522866228672286822869228702287122872228732287422875228762287722878228792288022881228822288322884228852288622887228882288922890228912289222893228942289522896228972289822899229002290122902229032290422905229062290722908229092291022911229122291322914229152291622917229182291922920229212292222923229242292522926229272292822929229302293122932229332293422935229362293722938229392294022941229422294322944229452294622947229482294922950229512295222953229542295522956229572295822959229602296122962229632296422965229662296722968229692297022971229722297322974229752297622977229782297922980229812298222983229842298522986229872298822989229902299122992229932299422995229962299722998229992300023001230022300323004230052300623007230082300923010230112301223013230142301523016230172301823019230202302123022230232302423025230262302723028230292303023031230322303323034230352303623037230382303923040230412304223043230442304523046230472304823049230502305123052230532305423055230562305723058230592306023061230622306323064230652306623067230682306923070230712307223073230742307523076230772307823079230802308123082230832308423085230862308723088230892309023091230922309323094230952309623097230982309923100231012310223103231042310523106231072310823109231102311123112231132311423115231162311723118231192312023121231222312323124231252312623127231282312923130231312313223133231342313523136231372313823139231402314123142231432314423145231462314723148231492315023151231522315323154231552315623157231582315923160231612316223163231642316523166231672316823169231702317123172231732317423175231762317723178231792318023181231822318323184231852318623187231882318923190231912319223193231942319523196231972319823199232002320123202232032320423205232062320723208232092321023211232122321323214232152321623217232182321923220232212322223223232242322523226232272322823229232302323123232232332323423235232362323723238232392324023241232422324323244232452324623247232482324923250232512325223253232542325523256232572325823259232602326123262232632326423265232662326723268232692327023271232722327323274232752327623277232782327923280232812328223283232842328523286232872328823289232902329123292232932329423295232962329723298232992330023301233022330323304233052330623307233082330923310233112331223313233142331523316233172331823319233202332123322233232332423325233262332723328233292333023331233322333323334233352333623337233382333923340233412334223343233442334523346233472334823349233502335123352233532335423355233562335723358233592336023361233622336323364233652336623367233682336923370233712337223373233742337523376233772337823379233802338123382233832338423385233862338723388233892339023391233922339323394233952339623397233982339923400234012340223403234042340523406234072340823409234102341123412234132341423415234162341723418234192342023421234222342323424234252342623427234282342923430234312343223433234342343523436234372343823439234402344123442234432344423445234462344723448234492345023451234522345323454234552345623457234582345923460234612346223463234642346523466234672346823469234702347123472234732347423475234762347723478234792348023481234822348323484234852348623487234882348923490234912349223493234942349523496234972349823499235002350123502235032350423505235062350723508235092351023511235122351323514235152351623517235182351923520235212352223523235242352523526235272352823529235302353123532235332353423535235362353723538235392354023541235422354323544235452354623547235482354923550235512355223553235542355523556235572355823559235602356123562235632356423565235662356723568235692357023571235722357323574235752357623577235782357923580235812358223583235842358523586235872358823589235902359123592235932359423595235962359723598235992360023601236022360323604236052360623607236082360923610236112361223613236142361523616236172361823619236202362123622236232362423625236262362723628236292363023631236322363323634236352363623637236382363923640236412364223643236442364523646236472364823649236502365123652236532365423655236562365723658236592366023661236622366323664236652366623667236682366923670236712367223673236742367523676236772367823679236802368123682236832368423685236862368723688236892369023691236922369323694236952369623697236982369923700237012370223703237042370523706237072370823709237102371123712237132371423715237162371723718237192372023721237222372323724237252372623727237282372923730237312373223733237342373523736237372373823739237402374123742237432374423745237462374723748237492375023751237522375323754237552375623757237582375923760237612376223763237642376523766237672376823769237702377123772237732377423775237762377723778237792378023781237822378323784237852378623787237882378923790237912379223793237942379523796237972379823799238002380123802238032380423805238062380723808238092381023811238122381323814238152381623817238182381923820238212382223823238242382523826238272382823829238302383123832238332383423835238362383723838238392384023841238422384323844238452384623847238482384923850238512385223853238542385523856238572385823859238602386123862238632386423865238662386723868238692387023871238722387323874238752387623877238782387923880238812388223883238842388523886238872388823889238902389123892238932389423895238962389723898238992390023901239022390323904239052390623907239082390923910239112391223913239142391523916239172391823919239202392123922239232392423925239262392723928239292393023931239322393323934239352393623937239382393923940239412394223943239442394523946239472394823949239502395123952239532395423955239562395723958239592396023961239622396323964239652396623967239682396923970239712397223973239742397523976239772397823979239802398123982239832398423985239862398723988239892399023991239922399323994239952399623997239982399924000240012400224003240042400524006240072400824009240102401124012240132401424015240162401724018240192402024021240222402324024240252402624027240282402924030240312403224033240342403524036240372403824039240402404124042240432404424045240462404724048240492405024051240522405324054240552405624057240582405924060240612406224063240642406524066240672406824069240702407124072240732407424075240762407724078240792408024081240822408324084240852408624087240882408924090240912409224093240942409524096240972409824099241002410124102241032410424105241062410724108241092411024111241122411324114241152411624117241182411924120241212412224123241242412524126241272412824129241302413124132241332413424135241362413724138241392414024141241422414324144241452414624147241482414924150241512415224153241542415524156241572415824159241602416124162241632416424165241662416724168241692417024171241722417324174241752417624177241782417924180241812418224183241842418524186241872418824189241902419124192241932419424195241962419724198241992420024201242022420324204242052420624207242082420924210242112421224213242142421524216242172421824219242202422124222242232422424225242262422724228242292423024231242322423324234242352423624237242382423924240242412424224243242442424524246242472424824249242502425124252242532425424255242562425724258242592426024261242622426324264242652426624267242682426924270242712427224273242742427524276242772427824279242802428124282242832428424285242862428724288242892429024291242922429324294242952429624297242982429924300243012430224303243042430524306243072430824309243102431124312243132431424315243162431724318243192432024321243222432324324243252432624327243282432924330243312433224333243342433524336243372433824339243402434124342243432434424345243462434724348243492435024351243522435324354243552435624357243582435924360243612436224363243642436524366243672436824369243702437124372243732437424375243762437724378243792438024381243822438324384243852438624387243882438924390243912439224393243942439524396243972439824399244002440124402244032440424405244062440724408244092441024411244122441324414244152441624417244182441924420244212442224423244242442524426244272442824429244302443124432244332443424435244362443724438244392444024441244422444324444244452444624447244482444924450244512445224453244542445524456244572445824459244602446124462244632446424465244662446724468244692447024471244722447324474244752447624477244782447924480244812448224483244842448524486244872448824489244902449124492244932449424495244962449724498244992450024501245022450324504245052450624507245082450924510245112451224513245142451524516245172451824519245202452124522245232452424525245262452724528245292453024531245322453324534245352453624537245382453924540245412454224543245442454524546245472454824549245502455124552245532455424555245562455724558245592456024561245622456324564245652456624567245682456924570245712457224573245742457524576245772457824579245802458124582245832458424585245862458724588245892459024591245922459324594245952459624597245982459924600246012460224603246042460524606246072460824609246102461124612246132461424615246162461724618246192462024621246222462324624246252462624627246282462924630246312463224633246342463524636246372463824639246402464124642246432464424645246462464724648246492465024651246522465324654246552465624657246582465924660246612466224663246642466524666246672466824669246702467124672246732467424675246762467724678246792468024681246822468324684246852468624687246882468924690246912469224693246942469524696246972469824699247002470124702247032470424705247062470724708247092471024711247122471324714247152471624717247182471924720247212472224723247242472524726247272472824729247302473124732247332473424735247362473724738247392474024741247422474324744247452474624747247482474924750247512475224753247542475524756247572475824759247602476124762247632476424765247662476724768247692477024771247722477324774247752477624777247782477924780247812478224783247842478524786247872478824789247902479124792247932479424795247962479724798247992480024801248022480324804248052480624807248082480924810248112481224813248142481524816248172481824819248202482124822248232482424825248262482724828248292483024831248322483324834248352483624837248382483924840248412484224843248442484524846248472484824849248502485124852248532485424855248562485724858248592486024861248622486324864248652486624867248682486924870248712487224873248742487524876248772487824879248802488124882248832488424885248862488724888248892489024891248922489324894248952489624897248982489924900249012490224903249042490524906249072490824909249102491124912249132491424915249162491724918249192492024921249222492324924249252492624927249282492924930249312493224933249342493524936249372493824939249402494124942249432494424945249462494724948249492495024951249522495324954249552495624957249582495924960249612496224963249642496524966249672496824969249702497124972249732497424975249762497724978249792498024981249822498324984249852498624987249882498924990249912499224993249942499524996249972499824999250002500125002250032500425005250062500725008250092501025011250122501325014250152501625017250182501925020250212502225023250242502525026250272502825029250302503125032250332503425035250362503725038250392504025041250422504325044250452504625047250482504925050250512505225053250542505525056250572505825059250602506125062250632506425065250662506725068250692507025071250722507325074250752507625077250782507925080250812508225083250842508525086250872508825089250902509125092250932509425095250962509725098250992510025101251022510325104251052510625107251082510925110251112511225113251142511525116251172511825119251202512125122251232512425125251262512725128251292513025131251322513325134251352513625137251382513925140251412514225143251442514525146251472514825149251502515125152251532515425155251562515725158251592516025161251622516325164251652516625167251682516925170251712517225173251742517525176251772517825179251802518125182251832518425185251862518725188251892519025191251922519325194251952519625197251982519925200252012520225203252042520525206252072520825209252102521125212252132521425215252162521725218252192522025221252222522325224252252522625227252282522925230252312523225233252342523525236252372523825239252402524125242252432524425245252462524725248252492525025251252522525325254252552525625257252582525925260252612526225263252642526525266252672526825269252702527125272252732527425275252762527725278252792528025281252822528325284252852528625287252882528925290252912529225293252942529525296252972529825299253002530125302253032530425305253062530725308253092531025311253122531325314253152531625317253182531925320253212532225323253242532525326253272532825329253302533125332253332533425335253362533725338253392534025341253422534325344253452534625347253482534925350253512535225353253542535525356253572535825359253602536125362253632536425365253662536725368253692537025371253722537325374253752537625377253782537925380253812538225383253842538525386253872538825389253902539125392253932539425395253962539725398253992540025401254022540325404254052540625407254082540925410254112541225413254142541525416254172541825419254202542125422254232542425425254262542725428254292543025431254322543325434254352543625437254382543925440254412544225443254442544525446254472544825449254502545125452254532545425455254562545725458254592546025461254622546325464254652546625467254682546925470254712547225473254742547525476254772547825479254802548125482254832548425485254862548725488254892549025491254922549325494254952549625497254982549925500255012550225503255042550525506255072550825509255102551125512255132551425515255162551725518255192552025521255222552325524255252552625527255282552925530255312553225533255342553525536255372553825539255402554125542255432554425545255462554725548255492555025551255522555325554255552555625557255582555925560255612556225563255642556525566255672556825569255702557125572255732557425575255762557725578255792558025581255822558325584255852558625587255882558925590255912559225593255942559525596255972559825599256002560125602256032560425605256062560725608256092561025611256122561325614256152561625617256182561925620256212562225623256242562525626256272562825629256302563125632256332563425635256362563725638256392564025641256422564325644256452564625647256482564925650256512565225653256542565525656256572565825659256602566125662256632566425665256662566725668256692567025671256722567325674256752567625677256782567925680256812568225683256842568525686256872568825689256902569125692256932569425695256962569725698256992570025701257022570325704257052570625707257082570925710257112571225713257142571525716257172571825719257202572125722257232572425725257262572725728257292573025731257322573325734257352573625737257382573925740257412574225743257442574525746257472574825749257502575125752257532575425755257562575725758257592576025761257622576325764257652576625767257682576925770257712577225773257742577525776257772577825779257802578125782257832578425785257862578725788257892579025791257922579325794257952579625797257982579925800258012580225803258042580525806258072580825809258102581125812258132581425815258162581725818258192582025821258222582325824258252582625827258282582925830258312583225833258342583525836258372583825839258402584125842258432584425845258462584725848258492585025851258522585325854258552585625857258582585925860258612586225863258642586525866258672586825869258702587125872258732587425875258762587725878258792588025881258822588325884258852588625887258882588925890258912589225893258942589525896258972589825899259002590125902259032590425905259062590725908259092591025911259122591325914259152591625917259182591925920259212592225923259242592525926259272592825929259302593125932259332593425935259362593725938259392594025941259422594325944259452594625947259482594925950259512595225953259542595525956259572595825959259602596125962259632596425965259662596725968259692597025971259722597325974259752597625977259782597925980259812598225983259842598525986259872598825989259902599125992259932599425995259962599725998259992600026001260022600326004260052600626007260082600926010260112601226013260142601526016260172601826019260202602126022260232602426025260262602726028260292603026031260322603326034260352603626037260382603926040260412604226043260442604526046260472604826049260502605126052260532605426055260562605726058260592606026061260622606326064260652606626067260682606926070260712607226073260742607526076260772607826079260802608126082260832608426085260862608726088260892609026091260922609326094260952609626097260982609926100261012610226103261042610526106261072610826109261102611126112261132611426115261162611726118261192612026121261222612326124261252612626127261282612926130261312613226133261342613526136261372613826139261402614126142261432614426145261462614726148261492615026151261522615326154261552615626157261582615926160261612616226163261642616526166261672616826169261702617126172261732617426175261762617726178261792618026181261822618326184261852618626187261882618926190261912619226193261942619526196261972619826199262002620126202262032620426205262062620726208262092621026211262122621326214262152621626217262182621926220262212622226223262242622526226262272622826229262302623126232262332623426235262362623726238262392624026241262422624326244262452624626247262482624926250262512625226253262542625526256262572625826259262602626126262262632626426265262662626726268262692627026271262722627326274262752627626277262782627926280262812628226283262842628526286262872628826289262902629126292262932629426295262962629726298262992630026301263022630326304263052630626307263082630926310263112631226313263142631526316263172631826319263202632126322263232632426325263262632726328263292633026331263322633326334263352633626337263382633926340263412634226343263442634526346263472634826349263502635126352263532635426355263562635726358263592636026361263622636326364263652636626367263682636926370263712637226373263742637526376263772637826379263802638126382263832638426385263862638726388263892639026391263922639326394263952639626397263982639926400264012640226403264042640526406264072640826409264102641126412264132641426415264162641726418264192642026421264222642326424264252642626427264282642926430264312643226433264342643526436264372643826439264402644126442264432644426445264462644726448264492645026451264522645326454264552645626457264582645926460264612646226463264642646526466264672646826469264702647126472264732647426475264762647726478264792648026481264822648326484264852648626487264882648926490264912649226493264942649526496264972649826499265002650126502265032650426505265062650726508265092651026511265122651326514265152651626517265182651926520265212652226523265242652526526265272652826529265302653126532265332653426535265362653726538265392654026541265422654326544265452654626547265482654926550265512655226553265542655526556265572655826559265602656126562265632656426565265662656726568265692657026571265722657326574265752657626577265782657926580265812658226583265842658526586265872658826589265902659126592265932659426595265962659726598265992660026601266022660326604266052660626607266082660926610266112661226613266142661526616266172661826619266202662126622266232662426625266262662726628266292663026631266322663326634266352663626637266382663926640266412664226643266442664526646266472664826649266502665126652266532665426655266562665726658266592666026661266622666326664266652666626667266682666926670266712667226673266742667526676266772667826679266802668126682266832668426685266862668726688266892669026691266922669326694266952669626697266982669926700267012670226703267042670526706267072670826709267102671126712267132671426715267162671726718267192672026721267222672326724267252672626727267282672926730267312673226733267342673526736267372673826739267402674126742267432674426745267462674726748267492675026751267522675326754267552675626757267582675926760267612676226763267642676526766267672676826769267702677126772267732677426775267762677726778267792678026781267822678326784267852678626787267882678926790267912679226793267942679526796267972679826799268002680126802268032680426805268062680726808268092681026811268122681326814268152681626817268182681926820268212682226823268242682526826268272682826829268302683126832268332683426835268362683726838268392684026841268422684326844268452684626847268482684926850268512685226853268542685526856268572685826859268602686126862268632686426865268662686726868268692687026871268722687326874268752687626877268782687926880268812688226883268842688526886268872688826889268902689126892268932689426895268962689726898268992690026901269022690326904269052690626907269082690926910269112691226913269142691526916269172691826919269202692126922269232692426925269262692726928269292693026931269322693326934269352693626937269382693926940269412694226943269442694526946269472694826949269502695126952269532695426955269562695726958269592696026961269622696326964269652696626967269682696926970269712697226973269742697526976269772697826979269802698126982269832698426985269862698726988269892699026991269922699326994269952699626997269982699927000270012700227003270042700527006270072700827009270102701127012270132701427015270162701727018270192702027021270222702327024270252702627027270282702927030270312703227033270342703527036270372703827039270402704127042270432704427045270462704727048270492705027051270522705327054270552705627057270582705927060270612706227063270642706527066270672706827069270702707127072270732707427075270762707727078270792708027081270822708327084270852708627087270882708927090270912709227093270942709527096270972709827099271002710127102271032710427105271062710727108271092711027111271122711327114271152711627117271182711927120271212712227123271242712527126271272712827129271302713127132271332713427135271362713727138271392714027141271422714327144271452714627147271482714927150271512715227153271542715527156271572715827159271602716127162271632716427165271662716727168271692717027171271722717327174271752717627177271782717927180271812718227183271842718527186271872718827189271902719127192271932719427195271962719727198271992720027201272022720327204272052720627207272082720927210272112721227213272142721527216272172721827219272202722127222272232722427225272262722727228272292723027231272322723327234272352723627237272382723927240272412724227243272442724527246272472724827249272502725127252272532725427255272562725727258272592726027261272622726327264272652726627267272682726927270272712727227273272742727527276272772727827279272802728127282272832728427285272862728727288272892729027291272922729327294272952729627297272982729927300273012730227303273042730527306273072730827309273102731127312273132731427315273162731727318273192732027321273222732327324273252732627327273282732927330273312733227333273342733527336273372733827339273402734127342273432734427345273462734727348273492735027351273522735327354273552735627357273582735927360273612736227363273642736527366273672736827369273702737127372273732737427375273762737727378273792738027381273822738327384273852738627387273882738927390273912739227393273942739527396273972739827399274002740127402274032740427405274062740727408274092741027411274122741327414274152741627417274182741927420274212742227423274242742527426274272742827429274302743127432274332743427435274362743727438274392744027441274422744327444274452744627447274482744927450274512745227453274542745527456274572745827459274602746127462274632746427465274662746727468274692747027471274722747327474274752747627477274782747927480274812748227483274842748527486274872748827489274902749127492274932749427495274962749727498274992750027501275022750327504275052750627507275082750927510275112751227513275142751527516275172751827519275202752127522275232752427525275262752727528275292753027531275322753327534275352753627537275382753927540275412754227543275442754527546275472754827549275502755127552275532755427555275562755727558275592756027561275622756327564275652756627567275682756927570275712757227573275742757527576275772757827579275802758127582275832758427585275862758727588275892759027591275922759327594275952759627597275982759927600276012760227603276042760527606276072760827609276102761127612276132761427615276162761727618276192762027621276222762327624276252762627627276282762927630276312763227633276342763527636276372763827639276402764127642276432764427645276462764727648276492765027651276522765327654276552765627657276582765927660276612766227663276642766527666276672766827669276702767127672276732767427675276762767727678276792768027681276822768327684276852768627687276882768927690276912769227693276942769527696276972769827699277002770127702277032770427705277062770727708277092771027711277122771327714277152771627717277182771927720277212772227723277242772527726277272772827729277302773127732277332773427735277362773727738277392774027741277422774327744277452774627747277482774927750277512775227753277542775527756277572775827759277602776127762277632776427765277662776727768277692777027771277722777327774277752777627777277782777927780277812778227783277842778527786277872778827789277902779127792277932779427795277962779727798277992780027801278022780327804278052780627807278082780927810278112781227813278142781527816278172781827819278202782127822278232782427825278262782727828278292783027831278322783327834278352783627837278382783927840278412784227843278442784527846278472784827849278502785127852278532785427855278562785727858278592786027861278622786327864278652786627867278682786927870278712787227873278742787527876278772787827879278802788127882278832788427885278862788727888278892789027891278922789327894278952789627897278982789927900279012790227903279042790527906279072790827909279102791127912279132791427915279162791727918279192792027921279222792327924279252792627927279282792927930279312793227933279342793527936279372793827939279402794127942279432794427945279462794727948279492795027951279522795327954279552795627957279582795927960279612796227963279642796527966279672796827969279702797127972279732797427975279762797727978279792798027981279822798327984279852798627987279882798927990279912799227993279942799527996279972799827999280002800128002280032800428005280062800728008280092801028011280122801328014280152801628017280182801928020280212802228023280242802528026280272802828029280302803128032280332803428035280362803728038280392804028041280422804328044280452804628047280482804928050280512805228053280542805528056280572805828059280602806128062280632806428065280662806728068280692807028071280722807328074280752807628077280782807928080280812808228083280842808528086280872808828089280902809128092280932809428095280962809728098280992810028101281022810328104281052810628107281082810928110281112811228113281142811528116281172811828119281202812128122281232812428125281262812728128281292813028131281322813328134281352813628137281382813928140281412814228143281442814528146281472814828149281502815128152281532815428155281562815728158281592816028161281622816328164281652816628167281682816928170281712817228173281742817528176281772817828179281802818128182281832818428185281862818728188281892819028191281922819328194281952819628197281982819928200282012820228203282042820528206282072820828209282102821128212282132821428215282162821728218282192822028221282222822328224282252822628227282282822928230282312823228233282342823528236282372823828239282402824128242282432824428245282462824728248282492825028251282522825328254282552825628257282582825928260282612826228263282642826528266282672826828269282702827128272282732827428275282762827728278282792828028281282822828328284282852828628287282882828928290282912829228293282942829528296282972829828299283002830128302283032830428305283062830728308283092831028311283122831328314283152831628317283182831928320283212832228323283242832528326283272832828329283302833128332283332833428335283362833728338283392834028341283422834328344283452834628347283482834928350283512835228353283542835528356283572835828359283602836128362283632836428365283662836728368283692837028371283722837328374283752837628377283782837928380283812838228383283842838528386283872838828389283902839128392283932839428395283962839728398283992840028401284022840328404284052840628407284082840928410284112841228413284142841528416284172841828419284202842128422284232842428425284262842728428284292843028431284322843328434284352843628437284382843928440284412844228443284442844528446284472844828449284502845128452284532845428455284562845728458284592846028461284622846328464284652846628467284682846928470284712847228473284742847528476284772847828479284802848128482284832848428485284862848728488284892849028491284922849328494284952849628497284982849928500285012850228503285042850528506285072850828509285102851128512285132851428515285162851728518285192852028521285222852328524285252852628527285282852928530285312853228533285342853528536285372853828539285402854128542285432854428545285462854728548285492855028551285522855328554285552855628557285582855928560285612856228563285642856528566285672856828569285702857128572285732857428575285762857728578285792858028581285822858328584285852858628587285882858928590285912859228593285942859528596285972859828599286002860128602286032860428605286062860728608286092861028611286122861328614286152861628617286182861928620286212862228623286242862528626286272862828629286302863128632286332863428635286362863728638286392864028641286422864328644286452864628647286482864928650286512865228653286542865528656286572865828659286602866128662286632866428665286662866728668286692867028671286722867328674286752867628677286782867928680286812868228683286842868528686286872868828689286902869128692286932869428695286962869728698286992870028701287022870328704287052870628707287082870928710287112871228713287142871528716287172871828719287202872128722287232872428725287262872728728287292873028731287322873328734287352873628737287382873928740287412874228743287442874528746287472874828749287502875128752287532875428755287562875728758287592876028761287622876328764287652876628767287682876928770287712877228773287742877528776287772877828779287802878128782287832878428785287862878728788287892879028791287922879328794287952879628797287982879928800288012880228803288042880528806288072880828809288102881128812288132881428815288162881728818288192882028821288222882328824288252882628827288282882928830288312883228833288342883528836288372883828839288402884128842288432884428845288462884728848288492885028851288522885328854288552885628857288582885928860288612886228863288642886528866288672886828869288702887128872288732887428875288762887728878288792888028881288822888328884288852888628887288882888928890288912889228893288942889528896288972889828899289002890128902289032890428905289062890728908289092891028911289122891328914289152891628917289182891928920289212892228923289242892528926289272892828929289302893128932289332893428935289362893728938289392894028941289422894328944289452894628947289482894928950289512895228953289542895528956289572895828959289602896128962289632896428965289662896728968289692897028971289722897328974289752897628977289782897928980289812898228983289842898528986289872898828989289902899128992289932899428995289962899728998289992900029001290022900329004290052900629007290082900929010290112901229013290142901529016290172901829019290202902129022290232902429025290262902729028290292903029031290322903329034290352903629037290382903929040290412904229043290442904529046290472904829049290502905129052290532905429055290562905729058290592906029061290622906329064290652906629067290682906929070290712907229073290742907529076290772907829079290802908129082290832908429085290862908729088290892909029091290922909329094290952909629097290982909929100291012910229103291042910529106291072910829109291102911129112291132911429115291162911729118291192912029121291222912329124291252912629127291282912929130291312913229133291342913529136291372913829139291402914129142291432914429145291462914729148291492915029151291522915329154291552915629157291582915929160291612916229163291642916529166291672916829169291702917129172291732917429175291762917729178291792918029181291822918329184291852918629187291882918929190291912919229193291942919529196291972919829199292002920129202292032920429205292062920729208292092921029211292122921329214292152921629217292182921929220292212922229223292242922529226292272922829229292302923129232292332923429235292362923729238292392924029241292422924329244292452924629247292482924929250292512925229253292542925529256292572925829259292602926129262292632926429265292662926729268292692927029271292722927329274292752927629277292782927929280292812928229283292842928529286292872928829289292902929129292292932929429295292962929729298292992930029301293022930329304293052930629307293082930929310293112931229313293142931529316293172931829319293202932129322293232932429325293262932729328293292933029331293322933329334293352933629337293382933929340293412934229343293442934529346293472934829349293502935129352293532935429355293562935729358293592936029361293622936329364293652936629367293682936929370293712937229373293742937529376293772937829379293802938129382293832938429385293862938729388293892939029391293922939329394293952939629397293982939929400294012940229403294042940529406294072940829409294102941129412294132941429415294162941729418294192942029421294222942329424294252942629427294282942929430294312943229433294342943529436294372943829439294402944129442294432944429445294462944729448294492945029451294522945329454294552945629457294582945929460294612946229463294642946529466294672946829469294702947129472294732947429475294762947729478294792948029481294822948329484294852948629487294882948929490294912949229493294942949529496294972949829499295002950129502295032950429505295062950729508295092951029511295122951329514295152951629517295182951929520295212952229523295242952529526295272952829529295302953129532295332953429535295362953729538295392954029541295422954329544295452954629547295482954929550295512955229553295542955529556295572955829559295602956129562295632956429565295662956729568295692957029571295722957329574295752957629577295782957929580295812958229583295842958529586295872958829589295902959129592295932959429595295962959729598295992960029601296022960329604296052960629607296082960929610296112961229613296142961529616296172961829619296202962129622296232962429625296262962729628296292963029631296322963329634296352963629637296382963929640296412964229643296442964529646296472964829649296502965129652296532965429655296562965729658296592966029661296622966329664296652966629667296682966929670296712967229673296742967529676296772967829679296802968129682296832968429685296862968729688296892969029691296922969329694296952969629697296982969929700297012970229703297042970529706297072970829709297102971129712297132971429715297162971729718297192972029721297222972329724297252972629727297282972929730297312973229733297342973529736297372973829739297402974129742297432974429745297462974729748297492975029751297522975329754297552975629757297582975929760297612976229763297642976529766297672976829769297702977129772297732977429775297762977729778297792978029781297822978329784297852978629787297882978929790297912979229793297942979529796297972979829799298002980129802298032980429805298062980729808298092981029811298122981329814298152981629817298182981929820298212982229823298242982529826298272982829829298302983129832298332983429835298362983729838298392984029841298422984329844298452984629847298482984929850298512985229853298542985529856298572985829859298602986129862298632986429865298662986729868298692987029871298722987329874298752987629877298782987929880298812988229883298842988529886298872988829889298902989129892298932989429895298962989729898298992990029901299022990329904299052990629907299082990929910299112991229913299142991529916299172991829919299202992129922299232992429925299262992729928299292993029931299322993329934299352993629937299382993929940299412994229943299442994529946299472994829949299502995129952299532995429955299562995729958299592996029961299622996329964299652996629967299682996929970299712997229973299742997529976299772997829979299802998129982299832998429985299862998729988299892999029991299922999329994299952999629997299982999930000300013000230003300043000530006300073000830009300103001130012300133001430015300163001730018300193002030021300223002330024300253002630027300283002930030300313003230033300343003530036300373003830039300403004130042300433004430045300463004730048300493005030051300523005330054300553005630057300583005930060300613006230063300643006530066300673006830069300703007130072300733007430075300763007730078300793008030081300823008330084300853008630087300883008930090300913009230093300943009530096300973009830099301003010130102301033010430105301063010730108301093011030111301123011330114301153011630117301183011930120301213012230123301243012530126301273012830129301303013130132301333013430135301363013730138301393014030141301423014330144301453014630147301483014930150301513015230153301543015530156301573015830159301603016130162301633016430165301663016730168301693017030171301723017330174301753017630177301783017930180301813018230183301843018530186301873018830189301903019130192301933019430195301963019730198301993020030201302023020330204302053020630207302083020930210302113021230213302143021530216302173021830219302203022130222302233022430225302263022730228302293023030231302323023330234302353023630237302383023930240302413024230243302443024530246302473024830249302503025130252302533025430255302563025730258302593026030261302623026330264302653026630267302683026930270302713027230273302743027530276302773027830279302803028130282302833028430285302863028730288302893029030291302923029330294302953029630297302983029930300303013030230303303043030530306303073030830309303103031130312303133031430315303163031730318303193032030321303223032330324303253032630327303283032930330303313033230333303343033530336303373033830339303403034130342303433034430345303463034730348303493035030351303523035330354303553035630357303583035930360303613036230363303643036530366303673036830369303703037130372303733037430375303763037730378303793038030381303823038330384303853038630387303883038930390303913039230393303943039530396303973039830399304003040130402304033040430405304063040730408304093041030411304123041330414304153041630417304183041930420304213042230423304243042530426304273042830429304303043130432304333043430435304363043730438304393044030441304423044330444304453044630447304483044930450304513045230453304543045530456304573045830459304603046130462304633046430465304663046730468304693047030471304723047330474304753047630477304783047930480304813048230483304843048530486304873048830489304903049130492304933049430495304963049730498304993050030501305023050330504305053050630507305083050930510305113051230513305143051530516305173051830519305203052130522305233052430525305263052730528305293053030531305323053330534305353053630537305383053930540305413054230543305443054530546305473054830549305503055130552305533055430555305563055730558305593056030561305623056330564305653056630567305683056930570305713057230573305743057530576305773057830579305803058130582305833058430585305863058730588305893059030591305923059330594305953059630597305983059930600306013060230603306043060530606306073060830609306103061130612306133061430615306163061730618306193062030621306223062330624306253062630627306283062930630306313063230633306343063530636306373063830639306403064130642306433064430645306463064730648306493065030651306523065330654306553065630657306583065930660306613066230663306643066530666306673066830669306703067130672306733067430675306763067730678306793068030681306823068330684306853068630687306883068930690306913069230693306943069530696306973069830699307003070130702307033070430705307063070730708307093071030711307123071330714307153071630717307183071930720307213072230723307243072530726307273072830729307303073130732307333073430735307363073730738307393074030741307423074330744307453074630747307483074930750307513075230753307543075530756307573075830759307603076130762307633076430765307663076730768307693077030771307723077330774307753077630777307783077930780307813078230783307843078530786307873078830789307903079130792307933079430795307963079730798307993080030801308023080330804308053080630807308083080930810308113081230813308143081530816308173081830819308203082130822308233082430825308263082730828308293083030831308323083330834308353083630837308383083930840308413084230843308443084530846308473084830849308503085130852308533085430855308563085730858308593086030861308623086330864308653086630867308683086930870308713087230873308743087530876308773087830879308803088130882308833088430885308863088730888308893089030891308923089330894308953089630897308983089930900309013090230903309043090530906309073090830909309103091130912309133091430915309163091730918309193092030921309223092330924309253092630927309283092930930309313093230933309343093530936309373093830939309403094130942309433094430945309463094730948309493095030951309523095330954309553095630957309583095930960309613096230963309643096530966309673096830969309703097130972309733097430975309763097730978309793098030981309823098330984309853098630987309883098930990309913099230993309943099530996309973099830999310003100131002310033100431005310063100731008310093101031011310123101331014310153101631017310183101931020310213102231023310243102531026310273102831029310303103131032310333103431035310363103731038310393104031041310423104331044310453104631047310483104931050310513105231053310543105531056310573105831059310603106131062310633106431065310663106731068310693107031071310723107331074310753107631077310783107931080310813108231083310843108531086310873108831089310903109131092310933109431095310963109731098310993110031101311023110331104311053110631107311083110931110311113111231113311143111531116311173111831119311203112131122311233112431125311263112731128311293113031131311323113331134311353113631137311383113931140311413114231143311443114531146311473114831149311503115131152311533115431155311563115731158311593116031161311623116331164311653116631167311683116931170311713117231173311743117531176311773117831179311803118131182311833118431185311863118731188311893119031191311923119331194311953119631197311983119931200312013120231203312043120531206312073120831209312103121131212312133121431215312163121731218312193122031221312223122331224312253122631227312283122931230312313123231233312343123531236312373123831239312403124131242312433124431245312463124731248312493125031251312523125331254312553125631257312583125931260312613126231263312643126531266312673126831269312703127131272312733127431275312763127731278312793128031281312823128331284312853128631287312883128931290312913129231293312943129531296312973129831299313003130131302313033130431305313063130731308313093131031311313123131331314313153131631317313183131931320313213132231323313243132531326313273132831329313303133131332313333133431335313363133731338313393134031341313423134331344313453134631347313483134931350313513135231353313543135531356313573135831359313603136131362313633136431365313663136731368313693137031371313723137331374313753137631377313783137931380313813138231383313843138531386313873138831389313903139131392313933139431395313963139731398313993140031401314023140331404314053140631407314083140931410314113141231413314143141531416314173141831419314203142131422314233142431425314263142731428314293143031431314323143331434314353143631437314383143931440314413144231443314443144531446314473144831449314503145131452314533145431455314563145731458314593146031461314623146331464314653146631467314683146931470314713147231473314743147531476314773147831479314803148131482314833148431485314863148731488314893149031491314923149331494314953149631497314983149931500315013150231503315043150531506315073150831509315103151131512315133151431515315163151731518315193152031521315223152331524315253152631527315283152931530315313153231533315343153531536315373153831539315403154131542315433154431545315463154731548315493155031551315523155331554315553155631557315583155931560315613156231563315643156531566315673156831569315703157131572315733157431575315763157731578315793158031581315823158331584315853158631587315883158931590315913159231593315943159531596315973159831599316003160131602316033160431605316063160731608316093161031611316123161331614316153161631617316183161931620316213162231623316243162531626316273162831629316303163131632316333163431635316363163731638316393164031641316423164331644316453164631647316483164931650316513165231653316543165531656316573165831659316603166131662316633166431665316663166731668316693167031671316723167331674316753167631677316783167931680316813168231683316843168531686316873168831689316903169131692316933169431695316963169731698316993170031701317023170331704317053170631707317083170931710317113171231713317143171531716317173171831719317203172131722317233172431725317263172731728317293173031731317323173331734317353173631737317383173931740317413174231743317443174531746317473174831749317503175131752317533175431755317563175731758317593176031761317623176331764317653176631767317683176931770317713177231773317743177531776317773177831779317803178131782317833178431785317863178731788317893179031791317923179331794317953179631797317983179931800318013180231803318043180531806318073180831809318103181131812318133181431815318163181731818318193182031821318223182331824318253182631827318283182931830318313183231833318343183531836318373183831839318403184131842318433184431845318463184731848318493185031851318523185331854318553185631857318583185931860318613186231863318643186531866318673186831869318703187131872318733187431875318763187731878318793188031881318823188331884318853188631887318883188931890318913189231893318943189531896318973189831899319003190131902319033190431905319063190731908319093191031911319123191331914319153191631917319183191931920319213192231923319243192531926319273192831929319303193131932319333193431935319363193731938319393194031941319423194331944319453194631947319483194931950319513195231953319543195531956319573195831959319603196131962319633196431965319663196731968319693197031971319723197331974319753197631977319783197931980319813198231983319843198531986319873198831989319903199131992319933199431995319963199731998319993200032001320023200332004320053200632007320083200932010320113201232013320143201532016320173201832019320203202132022320233202432025320263202732028320293203032031320323203332034320353203632037320383203932040320413204232043320443204532046320473204832049320503205132052320533205432055320563205732058320593206032061320623206332064320653206632067320683206932070320713207232073320743207532076320773207832079320803208132082320833208432085320863208732088320893209032091320923209332094320953209632097320983209932100321013210232103321043210532106321073210832109321103211132112321133211432115321163211732118321193212032121321223212332124321253212632127321283212932130321313213232133321343213532136321373213832139321403214132142321433214432145321463214732148321493215032151321523215332154321553215632157321583215932160321613216232163321643216532166321673216832169321703217132172321733217432175321763217732178321793218032181321823218332184321853218632187321883218932190321913219232193321943219532196321973219832199322003220132202322033220432205322063220732208322093221032211322123221332214322153221632217322183221932220322213222232223322243222532226322273222832229322303223132232322333223432235322363223732238322393224032241322423224332244322453224632247322483224932250322513225232253322543225532256322573225832259322603226132262322633226432265322663226732268322693227032271322723227332274322753227632277322783227932280322813228232283322843228532286322873228832289322903229132292322933229432295322963229732298322993230032301323023230332304323053230632307323083230932310323113231232313323143231532316323173231832319323203232132322323233232432325323263232732328323293233032331323323233332334323353233632337323383233932340323413234232343323443234532346323473234832349323503235132352323533235432355323563235732358323593236032361323623236332364323653236632367323683236932370323713237232373323743237532376323773237832379323803238132382323833238432385323863238732388323893239032391323923239332394323953239632397323983239932400324013240232403324043240532406324073240832409324103241132412324133241432415324163241732418324193242032421324223242332424324253242632427324283242932430324313243232433324343243532436324373243832439324403244132442324433244432445324463244732448324493245032451324523245332454324553245632457324583245932460324613246232463324643246532466324673246832469324703247132472324733247432475324763247732478324793248032481324823248332484324853248632487324883248932490324913249232493324943249532496324973249832499325003250132502325033250432505325063250732508325093251032511325123251332514325153251632517325183251932520325213252232523325243252532526325273252832529325303253132532325333253432535325363253732538325393254032541325423254332544325453254632547325483254932550325513255232553325543255532556325573255832559325603256132562325633256432565325663256732568325693257032571325723257332574325753257632577325783257932580325813258232583325843258532586325873258832589325903259132592325933259432595325963259732598325993260032601326023260332604326053260632607326083260932610326113261232613326143261532616326173261832619326203262132622326233262432625326263262732628326293263032631326323263332634326353263632637326383263932640326413264232643326443264532646326473264832649326503265132652326533265432655326563265732658326593266032661326623266332664326653266632667326683266932670326713267232673326743267532676326773267832679326803268132682326833268432685326863268732688326893269032691326923269332694326953269632697326983269932700327013270232703327043270532706327073270832709327103271132712327133271432715327163271732718327193272032721327223272332724327253272632727327283272932730327313273232733327343273532736327373273832739327403274132742327433274432745327463274732748327493275032751327523275332754327553275632757327583275932760327613276232763327643276532766327673276832769327703277132772327733277432775327763277732778327793278032781327823278332784327853278632787327883278932790327913279232793327943279532796327973279832799328003280132802328033280432805328063280732808328093281032811328123281332814328153281632817328183281932820328213282232823328243282532826328273282832829328303283132832328333283432835328363283732838328393284032841328423284332844328453284632847328483284932850328513285232853328543285532856328573285832859328603286132862328633286432865328663286732868328693287032871328723287332874328753287632877328783287932880328813288232883328843288532886328873288832889328903289132892328933289432895328963289732898328993290032901329023290332904329053290632907329083290932910329113291232913329143291532916329173291832919329203292132922329233292432925329263292732928329293293032931329323293332934329353293632937329383293932940329413294232943329443294532946329473294832949329503295132952329533295432955329563295732958329593296032961329623296332964329653296632967329683296932970329713297232973329743297532976329773297832979329803298132982329833298432985329863298732988329893299032991329923299332994329953299632997329983299933000330013300233003330043300533006330073300833009330103301133012330133301433015330163301733018330193302033021330223302333024330253302633027330283302933030330313303233033330343303533036330373303833039330403304133042330433304433045330463304733048330493305033051330523305333054330553305633057330583305933060330613306233063330643306533066330673306833069330703307133072330733307433075330763307733078330793308033081330823308333084330853308633087330883308933090330913309233093330943309533096330973309833099331003310133102331033310433105331063310733108331093311033111331123311333114331153311633117331183311933120331213312233123331243312533126331273312833129331303313133132331333313433135331363313733138331393314033141331423314333144331453314633147331483314933150331513315233153331543315533156331573315833159331603316133162331633316433165331663316733168331693317033171331723317333174331753317633177331783317933180331813318233183331843318533186331873318833189331903319133192331933319433195331963319733198331993320033201332023320333204332053320633207332083320933210332113321233213332143321533216332173321833219332203322133222332233322433225332263322733228332293323033231332323323333234332353323633237332383323933240332413324233243332443324533246332473324833249332503325133252332533325433255332563325733258332593326033261332623326333264332653326633267332683326933270332713327233273332743327533276332773327833279332803328133282332833328433285332863328733288332893329033291332923329333294332953329633297332983329933300333013330233303333043330533306333073330833309333103331133312333133331433315333163331733318333193332033321333223332333324333253332633327333283332933330333313333233333333343333533336333373333833339333403334133342333433334433345333463334733348333493335033351333523335333354333553335633357333583335933360333613336233363333643336533366333673336833369333703337133372333733337433375333763337733378333793338033381333823338333384333853338633387333883338933390333913339233393333943339533396333973339833399334003340133402334033340433405334063340733408334093341033411334123341333414334153341633417334183341933420334213342233423334243342533426334273342833429334303343133432334333343433435334363343733438334393344033441334423344333444334453344633447334483344933450334513345233453334543345533456334573345833459334603346133462334633346433465334663346733468334693347033471334723347333474334753347633477334783347933480334813348233483334843348533486334873348833489334903349133492334933349433495334963349733498334993350033501335023350333504335053350633507335083350933510335113351233513335143351533516335173351833519335203352133522335233352433525335263352733528335293353033531335323353333534335353353633537335383353933540335413354233543335443354533546335473354833549335503355133552335533355433555335563355733558335593356033561335623356333564335653356633567335683356933570335713357233573335743357533576335773357833579335803358133582335833358433585335863358733588335893359033591335923359333594335953359633597335983359933600336013360233603336043360533606336073360833609336103361133612336133361433615336163361733618336193362033621336223362333624336253362633627336283362933630336313363233633336343363533636336373363833639336403364133642336433364433645336463364733648336493365033651336523365333654336553365633657336583365933660336613366233663336643366533666336673366833669336703367133672336733367433675336763367733678336793368033681336823368333684336853368633687336883368933690336913369233693336943369533696336973369833699337003370133702337033370433705337063370733708337093371033711337123371333714337153371633717337183371933720337213372233723337243372533726337273372833729337303373133732337333373433735337363373733738337393374033741337423374333744337453374633747337483374933750337513375233753337543375533756337573375833759337603376133762337633376433765337663376733768337693377033771337723377333774337753377633777337783377933780337813378233783337843378533786337873378833789337903379133792337933379433795337963379733798337993380033801338023380333804338053380633807338083380933810338113381233813338143381533816338173381833819338203382133822338233382433825338263382733828338293383033831338323383333834338353383633837338383383933840338413384233843338443384533846338473384833849338503385133852338533385433855338563385733858338593386033861338623386333864338653386633867338683386933870338713387233873338743387533876338773387833879338803388133882338833388433885338863388733888338893389033891338923389333894338953389633897338983389933900339013390233903339043390533906339073390833909339103391133912339133391433915339163391733918339193392033921339223392333924339253392633927339283392933930339313393233933339343393533936339373393833939339403394133942339433394433945339463394733948339493395033951339523395333954339553395633957339583395933960339613396233963339643396533966339673396833969339703397133972339733397433975339763397733978339793398033981339823398333984339853398633987339883398933990339913399233993339943399533996339973399833999340003400134002340033400434005340063400734008340093401034011340123401334014340153401634017340183401934020340213402234023340243402534026340273402834029340303403134032340333403434035340363403734038340393404034041340423404334044340453404634047340483404934050340513405234053340543405534056340573405834059340603406134062340633406434065340663406734068340693407034071340723407334074340753407634077340783407934080340813408234083340843408534086340873408834089340903409134092340933409434095340963409734098340993410034101341023410334104341053410634107341083410934110341113411234113341143411534116341173411834119341203412134122341233412434125341263412734128341293413034131341323413334134341353413634137341383413934140341413414234143341443414534146341473414834149341503415134152341533415434155341563415734158341593416034161341623416334164341653416634167341683416934170341713417234173341743417534176341773417834179341803418134182341833418434185341863418734188341893419034191341923419334194341953419634197341983419934200342013420234203342043420534206342073420834209342103421134212342133421434215342163421734218342193422034221342223422334224342253422634227342283422934230342313423234233342343423534236342373423834239342403424134242342433424434245342463424734248342493425034251342523425334254342553425634257342583425934260342613426234263342643426534266342673426834269342703427134272342733427434275342763427734278342793428034281342823428334284342853428634287342883428934290342913429234293342943429534296342973429834299343003430134302343033430434305343063430734308343093431034311343123431334314343153431634317343183431934320343213432234323343243432534326343273432834329343303433134332343333433434335343363433734338343393434034341343423434334344343453434634347343483434934350343513435234353343543435534356343573435834359343603436134362343633436434365343663436734368343693437034371343723437334374343753437634377343783437934380343813438234383343843438534386343873438834389343903439134392343933439434395343963439734398343993440034401344023440334404344053440634407344083440934410344113441234413344143441534416344173441834419344203442134422344233442434425344263442734428344293443034431344323443334434344353443634437344383443934440344413444234443344443444534446344473444834449344503445134452344533445434455344563445734458344593446034461344623446334464344653446634467344683446934470344713447234473344743447534476344773447834479344803448134482344833448434485344863448734488344893449034491344923449334494344953449634497344983449934500345013450234503345043450534506345073450834509345103451134512345133451434515345163451734518345193452034521345223452334524345253452634527345283452934530345313453234533345343453534536345373453834539345403454134542345433454434545345463454734548345493455034551345523455334554345553455634557345583455934560345613456234563345643456534566345673456834569345703457134572345733457434575345763457734578345793458034581345823458334584345853458634587345883458934590345913459234593345943459534596345973459834599346003460134602346033460434605346063460734608346093461034611346123461334614346153461634617346183461934620346213462234623346243462534626346273462834629346303463134632346333463434635346363463734638346393464034641346423464334644346453464634647346483464934650346513465234653346543465534656346573465834659346603466134662346633466434665346663466734668346693467034671346723467334674346753467634677346783467934680346813468234683346843468534686346873468834689346903469134692346933469434695346963469734698346993470034701347023470334704347053470634707347083470934710347113471234713347143471534716347173471834719347203472134722347233472434725347263472734728347293473034731347323473334734347353473634737347383473934740347413474234743347443474534746347473474834749347503475134752347533475434755347563475734758347593476034761347623476334764347653476634767347683476934770347713477234773347743477534776347773477834779347803478134782347833478434785347863478734788347893479034791347923479334794347953479634797347983479934800348013480234803348043480534806348073480834809348103481134812348133481434815348163481734818348193482034821348223482334824348253482634827348283482934830348313483234833348343483534836348373483834839348403484134842348433484434845348463484734848348493485034851348523485334854348553485634857348583485934860348613486234863348643486534866348673486834869348703487134872348733487434875348763487734878348793488034881348823488334884348853488634887348883488934890348913489234893348943489534896348973489834899349003490134902349033490434905349063490734908349093491034911349123491334914349153491634917349183491934920349213492234923349243492534926349273492834929349303493134932349333493434935349363493734938349393494034941349423494334944349453494634947349483494934950349513495234953349543495534956349573495834959349603496134962349633496434965349663496734968349693497034971349723497334974349753497634977349783497934980349813498234983349843498534986349873498834989349903499134992349933499434995349963499734998349993500035001350023500335004350053500635007350083500935010350113501235013350143501535016350173501835019350203502135022350233502435025350263502735028350293503035031350323503335034350353503635037350383503935040350413504235043350443504535046350473504835049350503505135052350533505435055350563505735058350593506035061350623506335064350653506635067350683506935070350713507235073350743507535076350773507835079350803508135082350833508435085350863508735088350893509035091350923509335094350953509635097350983509935100351013510235103351043510535106351073510835109351103511135112351133511435115351163511735118351193512035121351223512335124351253512635127351283512935130351313513235133351343513535136351373513835139351403514135142351433514435145351463514735148351493515035151351523515335154351553515635157351583515935160351613516235163351643516535166351673516835169351703517135172351733517435175351763517735178351793518035181351823518335184351853518635187351883518935190351913519235193351943519535196351973519835199352003520135202352033520435205352063520735208352093521035211352123521335214352153521635217352183521935220352213522235223352243522535226352273522835229352303523135232352333523435235352363523735238352393524035241352423524335244352453524635247352483524935250352513525235253352543525535256352573525835259352603526135262352633526435265352663526735268352693527035271352723527335274352753527635277352783527935280352813528235283352843528535286352873528835289352903529135292352933529435295352963529735298352993530035301353023530335304353053530635307353083530935310353113531235313353143531535316353173531835319353203532135322353233532435325353263532735328353293533035331353323533335334353353533635337353383533935340353413534235343353443534535346353473534835349353503535135352353533535435355353563535735358353593536035361353623536335364353653536635367353683536935370353713537235373353743537535376353773537835379353803538135382353833538435385353863538735388353893539035391353923539335394353953539635397353983539935400354013540235403354043540535406354073540835409354103541135412354133541435415354163541735418354193542035421354223542335424354253542635427354283542935430354313543235433354343543535436354373543835439354403544135442354433544435445354463544735448354493545035451354523545335454354553545635457354583545935460354613546235463354643546535466354673546835469354703547135472354733547435475354763547735478354793548035481354823548335484354853548635487354883548935490354913549235493354943549535496354973549835499355003550135502355033550435505355063550735508355093551035511355123551335514355153551635517355183551935520355213552235523355243552535526355273552835529355303553135532355333553435535355363553735538355393554035541355423554335544355453554635547355483554935550355513555235553355543555535556355573555835559355603556135562355633556435565355663556735568355693557035571355723557335574355753557635577355783557935580355813558235583355843558535586355873558835589355903559135592355933559435595355963559735598355993560035601356023560335604356053560635607356083560935610356113561235613356143561535616356173561835619356203562135622356233562435625356263562735628356293563035631356323563335634356353563635637356383563935640356413564235643356443564535646356473564835649356503565135652356533565435655356563565735658356593566035661356623566335664356653566635667356683566935670356713567235673356743567535676356773567835679356803568135682356833568435685356863568735688356893569035691356923569335694356953569635697356983569935700357013570235703357043570535706357073570835709357103571135712357133571435715357163571735718357193572035721357223572335724357253572635727357283572935730357313573235733357343573535736357373573835739357403574135742357433574435745357463574735748357493575035751357523575335754357553575635757357583575935760357613576235763357643576535766357673576835769357703577135772357733577435775357763577735778357793578035781357823578335784357853578635787357883578935790357913579235793357943579535796357973579835799358003580135802358033580435805358063580735808358093581035811358123581335814358153581635817358183581935820358213582235823358243582535826358273582835829358303583135832358333583435835358363583735838358393584035841358423584335844358453584635847358483584935850358513585235853358543585535856358573585835859358603586135862358633586435865358663586735868358693587035871358723587335874358753587635877358783587935880358813588235883358843588535886358873588835889358903589135892358933589435895358963589735898358993590035901359023590335904359053590635907359083590935910359113591235913359143591535916359173591835919359203592135922359233592435925359263592735928359293593035931359323593335934359353593635937359383593935940359413594235943359443594535946359473594835949359503595135952359533595435955359563595735958359593596035961359623596335964359653596635967359683596935970359713597235973359743597535976359773597835979359803598135982359833598435985359863598735988359893599035991359923599335994359953599635997359983599936000360013600236003360043600536006360073600836009360103601136012360133601436015360163601736018360193602036021360223602336024360253602636027360283602936030360313603236033360343603536036360373603836039360403604136042360433604436045360463604736048360493605036051360523605336054360553605636057360583605936060360613606236063360643606536066360673606836069360703607136072360733607436075360763607736078360793608036081360823608336084360853608636087360883608936090360913609236093360943609536096360973609836099361003610136102361033610436105361063610736108361093611036111361123611336114361153611636117361183611936120361213612236123361243612536126361273612836129361303613136132361333613436135361363613736138361393614036141361423614336144361453614636147361483614936150361513615236153361543615536156361573615836159361603616136162361633616436165361663616736168361693617036171361723617336174361753617636177361783617936180361813618236183361843618536186361873618836189361903619136192361933619436195361963619736198361993620036201362023620336204362053620636207362083620936210362113621236213362143621536216362173621836219362203622136222362233622436225362263622736228362293623036231362323623336234362353623636237362383623936240362413624236243362443624536246362473624836249362503625136252362533625436255362563625736258362593626036261362623626336264362653626636267362683626936270362713627236273362743627536276362773627836279362803628136282362833628436285362863628736288362893629036291362923629336294362953629636297362983629936300363013630236303363043630536306363073630836309363103631136312363133631436315363163631736318363193632036321363223632336324363253632636327363283632936330363313633236333363343633536336363373633836339363403634136342363433634436345363463634736348363493635036351363523635336354363553635636357363583635936360363613636236363363643636536366363673636836369363703637136372363733637436375363763637736378363793638036381363823638336384363853638636387363883638936390363913639236393363943639536396363973639836399364003640136402364033640436405364063640736408364093641036411364123641336414364153641636417364183641936420364213642236423364243642536426364273642836429364303643136432364333643436435364363643736438364393644036441364423644336444364453644636447364483644936450364513645236453364543645536456364573645836459364603646136462364633646436465364663646736468364693647036471364723647336474364753647636477364783647936480364813648236483364843648536486364873648836489364903649136492364933649436495364963649736498364993650036501365023650336504365053650636507365083650936510365113651236513365143651536516365173651836519365203652136522365233652436525365263652736528365293653036531365323653336534365353653636537365383653936540365413654236543365443654536546365473654836549365503655136552365533655436555365563655736558365593656036561365623656336564365653656636567365683656936570365713657236573365743657536576365773657836579365803658136582365833658436585365863658736588365893659036591365923659336594365953659636597365983659936600366013660236603366043660536606366073660836609366103661136612366133661436615366163661736618366193662036621366223662336624366253662636627366283662936630366313663236633366343663536636366373663836639366403664136642366433664436645366463664736648366493665036651366523665336654366553665636657366583665936660366613666236663366643666536666366673666836669366703667136672366733667436675366763667736678366793668036681366823668336684366853668636687366883668936690366913669236693366943669536696366973669836699367003670136702367033670436705367063670736708367093671036711367123671336714367153671636717367183671936720367213672236723367243672536726367273672836729367303673136732367333673436735367363673736738367393674036741367423674336744367453674636747367483674936750367513675236753367543675536756367573675836759367603676136762367633676436765367663676736768367693677036771367723677336774367753677636777367783677936780367813678236783367843678536786367873678836789367903679136792367933679436795367963679736798367993680036801368023680336804368053680636807368083680936810368113681236813368143681536816368173681836819368203682136822368233682436825368263682736828368293683036831368323683336834368353683636837368383683936840368413684236843368443684536846368473684836849368503685136852368533685436855368563685736858368593686036861368623686336864368653686636867368683686936870368713687236873368743687536876368773687836879368803688136882368833688436885368863688736888368893689036891368923689336894368953689636897368983689936900369013690236903369043690536906369073690836909369103691136912369133691436915369163691736918369193692036921369223692336924369253692636927369283692936930369313693236933369343693536936369373693836939369403694136942369433694436945369463694736948369493695036951369523695336954369553695636957369583695936960369613696236963369643696536966369673696836969369703697136972369733697436975369763697736978369793698036981369823698336984369853698636987369883698936990369913699236993369943699536996369973699836999370003700137002370033700437005370063700737008370093701037011370123701337014370153701637017370183701937020370213702237023370243702537026370273702837029370303703137032370333703437035370363703737038370393704037041370423704337044370453704637047370483704937050370513705237053370543705537056370573705837059370603706137062370633706437065370663706737068370693707037071370723707337074370753707637077370783707937080370813708237083370843708537086370873708837089370903709137092370933709437095370963709737098370993710037101371023710337104371053710637107371083710937110371113711237113371143711537116371173711837119371203712137122371233712437125371263712737128371293713037131371323713337134371353713637137371383713937140371413714237143371443714537146371473714837149371503715137152371533715437155371563715737158371593716037161371623716337164371653716637167371683716937170371713717237173371743717537176371773717837179371803718137182371833718437185371863718737188371893719037191371923719337194371953719637197371983719937200372013720237203372043720537206372073720837209372103721137212372133721437215372163721737218372193722037221372223722337224372253722637227372283722937230372313723237233372343723537236372373723837239372403724137242372433724437245372463724737248372493725037251372523725337254372553725637257372583725937260372613726237263372643726537266372673726837269372703727137272372733727437275372763727737278372793728037281372823728337284372853728637287372883728937290372913729237293372943729537296372973729837299373003730137302373033730437305373063730737308373093731037311373123731337314373153731637317373183731937320373213732237323373243732537326373273732837329373303733137332373333733437335373363733737338373393734037341373423734337344373453734637347373483734937350373513735237353373543735537356373573735837359373603736137362373633736437365373663736737368373693737037371373723737337374373753737637377373783737937380373813738237383373843738537386373873738837389373903739137392373933739437395373963739737398373993740037401374023740337404374053740637407374083740937410374113741237413374143741537416374173741837419374203742137422374233742437425374263742737428374293743037431374323743337434374353743637437374383743937440374413744237443374443744537446374473744837449374503745137452374533745437455374563745737458374593746037461374623746337464374653746637467374683746937470374713747237473374743747537476374773747837479374803748137482374833748437485374863748737488374893749037491374923749337494374953749637497374983749937500375013750237503375043750537506375073750837509375103751137512375133751437515375163751737518375193752037521375223752337524375253752637527375283752937530375313753237533375343753537536375373753837539375403754137542375433754437545375463754737548375493755037551375523755337554375553755637557375583755937560375613756237563375643756537566375673756837569375703757137572375733757437575375763757737578375793758037581375823758337584375853758637587375883758937590375913759237593375943759537596375973759837599376003760137602376033760437605376063760737608376093761037611376123761337614376153761637617376183761937620376213762237623376243762537626376273762837629376303763137632376333763437635376363763737638376393764037641376423764337644376453764637647376483764937650376513765237653376543765537656376573765837659376603766137662376633766437665376663766737668376693767037671376723767337674376753767637677376783767937680376813768237683376843768537686376873768837689376903769137692376933769437695376963769737698376993770037701377023770337704377053770637707377083770937710377113771237713377143771537716377173771837719377203772137722377233772437725377263772737728377293773037731377323773337734377353773637737377383773937740377413774237743377443774537746377473774837749377503775137752377533775437755377563775737758377593776037761377623776337764377653776637767377683776937770377713777237773377743777537776377773777837779377803778137782377833778437785377863778737788377893779037791377923779337794377953779637797377983779937800378013780237803378043780537806378073780837809378103781137812378133781437815378163781737818378193782037821378223782337824378253782637827378283782937830378313783237833378343783537836378373783837839378403784137842378433784437845378463784737848378493785037851378523785337854378553785637857378583785937860378613786237863378643786537866378673786837869378703787137872378733787437875378763787737878378793788037881378823788337884378853788637887378883788937890378913789237893378943789537896378973789837899379003790137902379033790437905379063790737908379093791037911379123791337914379153791637917379183791937920379213792237923379243792537926379273792837929379303793137932379333793437935379363793737938379393794037941379423794337944379453794637947379483794937950379513795237953379543795537956379573795837959379603796137962379633796437965379663796737968379693797037971379723797337974379753797637977379783797937980379813798237983379843798537986379873798837989379903799137992379933799437995379963799737998379993800038001380023800338004380053800638007380083800938010380113801238013380143801538016380173801838019380203802138022380233802438025380263802738028380293803038031380323803338034380353803638037380383803938040380413804238043380443804538046380473804838049380503805138052380533805438055380563805738058380593806038061380623806338064380653806638067380683806938070380713807238073380743807538076380773807838079380803808138082380833808438085380863808738088380893809038091380923809338094380953809638097380983809938100381013810238103381043810538106381073810838109381103811138112381133811438115381163811738118381193812038121381223812338124381253812638127381283812938130381313813238133381343813538136381373813838139381403814138142381433814438145381463814738148381493815038151381523815338154381553815638157381583815938160381613816238163381643816538166381673816838169381703817138172381733817438175381763817738178381793818038181381823818338184381853818638187381883818938190381913819238193381943819538196381973819838199382003820138202382033820438205382063820738208382093821038211382123821338214382153821638217382183821938220382213822238223382243822538226382273822838229382303823138232382333823438235382363823738238382393824038241382423824338244382453824638247382483824938250382513825238253382543825538256382573825838259382603826138262382633826438265382663826738268382693827038271382723827338274382753827638277382783827938280382813828238283382843828538286382873828838289382903829138292382933829438295382963829738298382993830038301383023830338304383053830638307383083830938310383113831238313383143831538316383173831838319383203832138322383233832438325383263832738328383293833038331383323833338334383353833638337383383833938340383413834238343383443834538346383473834838349383503835138352383533835438355383563835738358383593836038361383623836338364383653836638367383683836938370383713837238373383743837538376383773837838379383803838138382383833838438385383863838738388383893839038391383923839338394383953839638397383983839938400384013840238403384043840538406384073840838409384103841138412384133841438415384163841738418384193842038421384223842338424384253842638427384283842938430384313843238433384343843538436384373843838439384403844138442384433844438445384463844738448384493845038451384523845338454384553845638457384583845938460384613846238463384643846538466384673846838469384703847138472384733847438475384763847738478384793848038481384823848338484384853848638487384883848938490384913849238493384943849538496384973849838499385003850138502385033850438505385063850738508385093851038511385123851338514385153851638517385183851938520385213852238523385243852538526385273852838529385303853138532385333853438535385363853738538385393854038541385423854338544385453854638547385483854938550385513855238553385543855538556385573855838559385603856138562385633856438565385663856738568385693857038571385723857338574385753857638577385783857938580385813858238583385843858538586385873858838589385903859138592385933859438595385963859738598385993860038601386023860338604386053860638607386083860938610386113861238613386143861538616386173861838619386203862138622386233862438625386263862738628386293863038631386323863338634386353863638637386383863938640386413864238643386443864538646386473864838649386503865138652386533865438655386563865738658386593866038661386623866338664386653866638667386683866938670386713867238673386743867538676386773867838679386803868138682386833868438685386863868738688386893869038691386923869338694386953869638697386983869938700387013870238703387043870538706387073870838709387103871138712387133871438715387163871738718387193872038721387223872338724387253872638727387283872938730387313873238733387343873538736387373873838739387403874138742387433874438745387463874738748387493875038751387523875338754387553875638757387583875938760387613876238763387643876538766387673876838769387703877138772387733877438775387763877738778387793878038781387823878338784387853878638787387883878938790387913879238793387943879538796387973879838799388003880138802388033880438805388063880738808388093881038811388123881338814388153881638817388183881938820388213882238823388243882538826388273882838829388303883138832388333883438835388363883738838388393884038841388423884338844388453884638847388483884938850388513885238853388543885538856388573885838859388603886138862388633886438865388663886738868388693887038871388723887338874388753887638877388783887938880388813888238883388843888538886388873888838889388903889138892388933889438895388963889738898388993890038901389023890338904389053890638907389083890938910389113891238913389143891538916389173891838919389203892138922389233892438925389263892738928389293893038931389323893338934389353893638937389383893938940389413894238943389443894538946389473894838949389503895138952389533895438955389563895738958389593896038961389623896338964389653896638967389683896938970389713897238973389743897538976389773897838979389803898138982389833898438985389863898738988389893899038991389923899338994389953899638997389983899939000390013900239003390043900539006390073900839009390103901139012390133901439015390163901739018390193902039021390223902339024390253902639027390283902939030390313903239033390343903539036390373903839039390403904139042390433904439045390463904739048390493905039051390523905339054390553905639057390583905939060390613906239063390643906539066390673906839069390703907139072390733907439075390763907739078390793908039081390823908339084390853908639087390883908939090390913909239093390943909539096390973909839099391003910139102391033910439105391063910739108391093911039111391123911339114391153911639117391183911939120391213912239123391243912539126391273912839129391303913139132391333913439135391363913739138391393914039141391423914339144391453914639147391483914939150391513915239153391543915539156391573915839159391603916139162391633916439165391663916739168391693917039171391723917339174391753917639177391783917939180391813918239183391843918539186391873918839189391903919139192391933919439195391963919739198391993920039201392023920339204392053920639207392083920939210392113921239213392143921539216392173921839219392203922139222392233922439225392263922739228392293923039231392323923339234392353923639237392383923939240392413924239243392443924539246392473924839249392503925139252392533925439255392563925739258392593926039261392623926339264392653926639267392683926939270392713927239273392743927539276392773927839279392803928139282392833928439285392863928739288392893929039291392923929339294392953929639297392983929939300393013930239303393043930539306393073930839309393103931139312393133931439315393163931739318393193932039321393223932339324393253932639327393283932939330393313933239333393343933539336393373933839339393403934139342393433934439345393463934739348393493935039351393523935339354393553935639357393583935939360393613936239363393643936539366393673936839369393703937139372393733937439375393763937739378393793938039381393823938339384393853938639387393883938939390393913939239393393943939539396393973939839399394003940139402394033940439405394063940739408394093941039411394123941339414394153941639417394183941939420394213942239423394243942539426394273942839429394303943139432394333943439435394363943739438394393944039441394423944339444394453944639447394483944939450394513945239453394543945539456394573945839459394603946139462394633946439465394663946739468394693947039471394723947339474394753947639477394783947939480394813948239483394843948539486394873948839489394903949139492394933949439495394963949739498394993950039501395023950339504395053950639507395083950939510395113951239513395143951539516395173951839519395203952139522395233952439525395263952739528395293953039531395323953339534395353953639537395383953939540395413954239543395443954539546395473954839549395503955139552395533955439555395563955739558395593956039561395623956339564395653956639567395683956939570395713957239573395743957539576395773957839579395803958139582395833958439585395863958739588395893959039591395923959339594395953959639597395983959939600396013960239603396043960539606396073960839609396103961139612396133961439615396163961739618396193962039621396223962339624396253962639627396283962939630396313963239633396343963539636396373963839639396403964139642396433964439645396463964739648396493965039651396523965339654396553965639657396583965939660396613966239663396643966539666396673966839669396703967139672396733967439675396763967739678396793968039681396823968339684396853968639687396883968939690396913969239693396943969539696396973969839699397003970139702397033970439705397063970739708397093971039711397123971339714397153971639717397183971939720397213972239723397243972539726397273972839729397303973139732397333973439735397363973739738397393974039741397423974339744397453974639747397483974939750397513975239753397543975539756397573975839759397603976139762397633976439765397663976739768397693977039771397723977339774397753977639777397783977939780397813978239783397843978539786397873978839789397903979139792397933979439795397963979739798397993980039801398023980339804398053980639807398083980939810398113981239813398143981539816398173981839819398203982139822398233982439825398263982739828398293983039831398323983339834398353983639837398383983939840398413984239843398443984539846398473984839849398503985139852398533985439855398563985739858398593986039861398623986339864398653986639867398683986939870398713987239873398743987539876398773987839879398803988139882398833988439885398863988739888398893989039891398923989339894398953989639897398983989939900399013990239903399043990539906399073990839909399103991139912399133991439915399163991739918399193992039921399223992339924399253992639927399283992939930399313993239933399343993539936399373993839939399403994139942399433994439945399463994739948399493995039951399523995339954399553995639957399583995939960399613996239963399643996539966399673996839969399703997139972399733997439975399763997739978399793998039981399823998339984399853998639987399883998939990399913999239993399943999539996399973999839999400004000140002400034000440005400064000740008400094001040011400124001340014400154001640017400184001940020400214002240023400244002540026400274002840029400304003140032400334003440035400364003740038400394004040041400424004340044400454004640047400484004940050400514005240053400544005540056400574005840059400604006140062400634006440065400664006740068400694007040071400724007340074400754007640077400784007940080400814008240083400844008540086400874008840089400904009140092400934009440095400964009740098400994010040101401024010340104401054010640107401084010940110401114011240113401144011540116401174011840119401204012140122401234012440125401264012740128401294013040131401324013340134401354013640137401384013940140401414014240143401444014540146401474014840149401504015140152401534015440155401564015740158401594016040161401624016340164401654016640167401684016940170401714017240173401744017540176401774017840179401804018140182401834018440185401864018740188401894019040191401924019340194401954019640197401984019940200402014020240203402044020540206402074020840209402104021140212402134021440215402164021740218402194022040221402224022340224402254022640227402284022940230402314023240233402344023540236402374023840239402404024140242402434024440245402464024740248402494025040251402524025340254402554025640257402584025940260402614026240263402644026540266402674026840269402704027140272402734027440275402764027740278402794028040281402824028340284402854028640287402884028940290402914029240293402944029540296402974029840299403004030140302403034030440305403064030740308403094031040311403124031340314403154031640317403184031940320403214032240323403244032540326403274032840329403304033140332403334033440335403364033740338403394034040341403424034340344403454034640347403484034940350403514035240353403544035540356403574035840359403604036140362403634036440365403664036740368403694037040371403724037340374403754037640377403784037940380403814038240383403844038540386403874038840389403904039140392403934039440395403964039740398403994040040401404024040340404404054040640407404084040940410404114041240413404144041540416404174041840419404204042140422404234042440425404264042740428404294043040431404324043340434404354043640437404384043940440404414044240443404444044540446404474044840449404504045140452404534045440455404564045740458404594046040461404624046340464404654046640467404684046940470404714047240473404744047540476404774047840479404804048140482404834048440485404864048740488404894049040491404924049340494404954049640497404984049940500405014050240503405044050540506405074050840509405104051140512405134051440515405164051740518405194052040521405224052340524405254052640527405284052940530405314053240533405344053540536405374053840539405404054140542405434054440545405464054740548405494055040551405524055340554405554055640557405584055940560405614056240563405644056540566405674056840569405704057140572405734057440575405764057740578405794058040581405824058340584405854058640587405884058940590405914059240593405944059540596405974059840599406004060140602406034060440605406064060740608406094061040611406124061340614406154061640617406184061940620406214062240623406244062540626406274062840629406304063140632406334063440635406364063740638406394064040641406424064340644406454064640647406484064940650406514065240653406544065540656406574065840659406604066140662406634066440665406664066740668406694067040671406724067340674406754067640677406784067940680406814068240683406844068540686406874068840689406904069140692406934069440695406964069740698406994070040701407024070340704407054070640707407084070940710407114071240713407144071540716407174071840719407204072140722407234072440725407264072740728407294073040731407324073340734407354073640737407384073940740407414074240743407444074540746407474074840749407504075140752407534075440755407564075740758407594076040761407624076340764407654076640767407684076940770407714077240773407744077540776407774077840779407804078140782407834078440785407864078740788407894079040791407924079340794407954079640797407984079940800408014080240803408044080540806408074080840809408104081140812408134081440815408164081740818408194082040821408224082340824408254082640827408284082940830408314083240833408344083540836408374083840839408404084140842408434084440845408464084740848408494085040851408524085340854408554085640857408584085940860408614086240863408644086540866408674086840869408704087140872408734087440875408764087740878408794088040881408824088340884408854088640887408884088940890408914089240893408944089540896408974089840899409004090140902409034090440905409064090740908409094091040911409124091340914409154091640917409184091940920409214092240923409244092540926409274092840929409304093140932409334093440935409364093740938409394094040941409424094340944409454094640947409484094940950409514095240953409544095540956409574095840959409604096140962409634096440965409664096740968409694097040971409724097340974409754097640977409784097940980409814098240983409844098540986409874098840989409904099140992409934099440995409964099740998409994100041001410024100341004410054100641007410084100941010410114101241013410144101541016410174101841019410204102141022410234102441025410264102741028410294103041031410324103341034410354103641037410384103941040410414104241043410444104541046410474104841049410504105141052410534105441055410564105741058410594106041061410624106341064410654106641067410684106941070410714107241073410744107541076410774107841079410804108141082410834108441085410864108741088410894109041091410924109341094410954109641097410984109941100411014110241103411044110541106411074110841109411104111141112411134111441115411164111741118411194112041121411224112341124411254112641127411284112941130411314113241133411344113541136411374113841139411404114141142411434114441145411464114741148411494115041151411524115341154411554115641157411584115941160411614116241163411644116541166411674116841169411704117141172411734117441175411764117741178411794118041181411824118341184411854118641187411884118941190411914119241193411944119541196411974119841199412004120141202412034120441205412064120741208412094121041211412124121341214412154121641217412184121941220412214122241223412244122541226412274122841229412304123141232412334123441235412364123741238412394124041241412424124341244412454124641247412484124941250412514125241253412544125541256412574125841259412604126141262412634126441265412664126741268412694127041271412724127341274412754127641277412784127941280412814128241283412844128541286412874128841289412904129141292412934129441295412964129741298412994130041301413024130341304413054130641307413084130941310413114131241313413144131541316413174131841319413204132141322413234132441325413264132741328413294133041331413324133341334413354133641337413384133941340413414134241343413444134541346413474134841349413504135141352413534135441355413564135741358413594136041361413624136341364413654136641367413684136941370413714137241373413744137541376413774137841379413804138141382413834138441385413864138741388413894139041391413924139341394413954139641397413984139941400414014140241403414044140541406414074140841409414104141141412414134141441415414164141741418414194142041421414224142341424414254142641427414284142941430414314143241433414344143541436414374143841439414404144141442414434144441445414464144741448414494145041451414524145341454414554145641457414584145941460414614146241463414644146541466414674146841469414704147141472414734147441475414764147741478414794148041481414824148341484414854148641487414884148941490414914149241493414944149541496414974149841499415004150141502415034150441505415064150741508415094151041511415124151341514415154151641517415184151941520415214152241523415244152541526415274152841529415304153141532415334153441535415364153741538415394154041541415424154341544415454154641547415484154941550415514155241553415544155541556415574155841559415604156141562415634156441565415664156741568415694157041571415724157341574415754157641577415784157941580415814158241583415844158541586415874158841589415904159141592415934159441595415964159741598415994160041601416024160341604416054160641607416084160941610416114161241613416144161541616416174161841619416204162141622416234162441625416264162741628416294163041631416324163341634416354163641637416384163941640416414164241643416444164541646416474164841649416504165141652416534165441655416564165741658416594166041661416624166341664416654166641667416684166941670416714167241673416744167541676416774167841679416804168141682416834168441685416864168741688416894169041691416924169341694416954169641697416984169941700417014170241703417044170541706417074170841709417104171141712417134171441715417164171741718417194172041721417224172341724417254172641727417284172941730417314173241733417344173541736417374173841739417404174141742417434174441745417464174741748417494175041751417524175341754417554175641757417584175941760417614176241763417644176541766417674176841769417704177141772417734177441775417764177741778417794178041781417824178341784417854178641787417884178941790417914179241793417944179541796417974179841799418004180141802418034180441805418064180741808418094181041811418124181341814418154181641817418184181941820418214182241823418244182541826418274182841829418304183141832418334183441835418364183741838418394184041841418424184341844418454184641847418484184941850418514185241853418544185541856418574185841859418604186141862418634186441865418664186741868418694187041871418724187341874418754187641877418784187941880418814188241883418844188541886418874188841889418904189141892418934189441895418964189741898418994190041901419024190341904419054190641907419084190941910419114191241913419144191541916419174191841919419204192141922419234192441925419264192741928419294193041931419324193341934419354193641937419384193941940419414194241943419444194541946419474194841949419504195141952419534195441955419564195741958419594196041961419624196341964419654196641967419684196941970419714197241973419744197541976419774197841979419804198141982419834198441985419864198741988419894199041991419924199341994419954199641997419984199942000420014200242003420044200542006420074200842009420104201142012420134201442015420164201742018420194202042021420224202342024420254202642027420284202942030420314203242033420344203542036420374203842039420404204142042420434204442045420464204742048420494205042051420524205342054420554205642057420584205942060420614206242063420644206542066420674206842069420704207142072420734207442075420764207742078420794208042081420824208342084420854208642087420884208942090420914209242093420944209542096420974209842099421004210142102421034210442105421064210742108421094211042111421124211342114421154211642117421184211942120421214212242123421244212542126421274212842129421304213142132421334213442135421364213742138421394214042141421424214342144421454214642147421484214942150421514215242153421544215542156421574215842159421604216142162421634216442165421664216742168421694217042171421724217342174421754217642177421784217942180421814218242183421844218542186421874218842189421904219142192421934219442195421964219742198421994220042201422024220342204422054220642207422084220942210422114221242213422144221542216422174221842219422204222142222422234222442225422264222742228422294223042231422324223342234422354223642237422384223942240422414224242243422444224542246422474224842249422504225142252422534225442255422564225742258422594226042261422624226342264422654226642267422684226942270422714227242273422744227542276422774227842279422804228142282422834228442285422864228742288422894229042291422924229342294422954229642297422984229942300423014230242303423044230542306423074230842309423104231142312423134231442315423164231742318423194232042321423224232342324423254232642327423284232942330423314233242333423344233542336423374233842339423404234142342423434234442345423464234742348423494235042351423524235342354423554235642357423584235942360423614236242363423644236542366423674236842369423704237142372423734237442375423764237742378423794238042381423824238342384423854238642387423884238942390423914239242393423944239542396423974239842399424004240142402424034240442405424064240742408424094241042411424124241342414424154241642417424184241942420424214242242423424244242542426424274242842429424304243142432424334243442435424364243742438424394244042441424424244342444424454244642447424484244942450424514245242453424544245542456424574245842459424604246142462424634246442465424664246742468424694247042471424724247342474424754247642477424784247942480424814248242483424844248542486424874248842489424904249142492424934249442495424964249742498424994250042501425024250342504425054250642507425084250942510425114251242513425144251542516425174251842519425204252142522425234252442525425264252742528425294253042531425324253342534425354253642537425384253942540425414254242543425444254542546425474254842549425504255142552425534255442555425564255742558425594256042561425624256342564425654256642567425684256942570425714257242573425744257542576425774257842579425804258142582425834258442585425864258742588425894259042591425924259342594425954259642597425984259942600426014260242603426044260542606426074260842609426104261142612426134261442615426164261742618426194262042621426224262342624426254262642627426284262942630426314263242633426344263542636426374263842639426404264142642426434264442645426464264742648426494265042651426524265342654426554265642657426584265942660426614266242663426644266542666426674266842669426704267142672426734267442675426764267742678426794268042681426824268342684426854268642687426884268942690426914269242693426944269542696426974269842699427004270142702427034270442705427064270742708427094271042711427124271342714427154271642717427184271942720427214272242723427244272542726427274272842729427304273142732427334273442735427364273742738427394274042741427424274342744427454274642747427484274942750427514275242753427544275542756427574275842759427604276142762427634276442765427664276742768427694277042771427724277342774427754277642777427784277942780427814278242783427844278542786427874278842789427904279142792427934279442795427964279742798427994280042801428024280342804428054280642807428084280942810428114281242813428144281542816428174281842819428204282142822428234282442825428264282742828428294283042831428324283342834428354283642837428384283942840428414284242843428444284542846428474284842849428504285142852428534285442855428564285742858428594286042861428624286342864428654286642867428684286942870428714287242873428744287542876428774287842879428804288142882428834288442885428864288742888428894289042891428924289342894428954289642897428984289942900429014290242903429044290542906429074290842909429104291142912429134291442915429164291742918429194292042921429224292342924429254292642927429284292942930429314293242933429344293542936429374293842939429404294142942429434294442945429464294742948429494295042951429524295342954429554295642957429584295942960429614296242963429644296542966429674296842969429704297142972429734297442975429764297742978429794298042981429824298342984429854298642987429884298942990429914299242993429944299542996429974299842999430004300143002430034300443005430064300743008430094301043011430124301343014430154301643017430184301943020430214302243023430244302543026430274302843029430304303143032430334303443035430364303743038430394304043041430424304343044430454304643047430484304943050430514305243053430544305543056430574305843059430604306143062430634306443065430664306743068430694307043071430724307343074430754307643077430784307943080430814308243083430844308543086430874308843089430904309143092430934309443095430964309743098430994310043101431024310343104431054310643107431084310943110431114311243113431144311543116431174311843119431204312143122431234312443125431264312743128431294313043131431324313343134431354313643137431384313943140431414314243143431444314543146431474314843149431504315143152431534315443155431564315743158431594316043161431624316343164431654316643167431684316943170431714317243173431744317543176431774317843179431804318143182431834318443185431864318743188431894319043191431924319343194431954319643197431984319943200432014320243203432044320543206432074320843209432104321143212432134321443215432164321743218432194322043221432224322343224432254322643227432284322943230432314323243233432344323543236432374323843239432404324143242432434324443245432464324743248432494325043251432524325343254432554325643257432584325943260432614326243263432644326543266432674326843269432704327143272432734327443275432764327743278432794328043281432824328343284432854328643287432884328943290432914329243293432944329543296432974329843299433004330143302433034330443305433064330743308433094331043311433124331343314433154331643317433184331943320433214332243323433244332543326433274332843329433304333143332433334333443335433364333743338433394334043341433424334343344433454334643347433484334943350433514335243353433544335543356433574335843359433604336143362433634336443365433664336743368433694337043371433724337343374433754337643377433784337943380433814338243383433844338543386433874338843389433904339143392433934339443395433964339743398433994340043401434024340343404434054340643407434084340943410434114341243413434144341543416434174341843419434204342143422434234342443425434264342743428434294343043431434324343343434434354343643437434384343943440434414344243443434444344543446434474344843449434504345143452434534345443455434564345743458434594346043461434624346343464434654346643467434684346943470434714347243473434744347543476434774347843479434804348143482434834348443485434864348743488434894349043491434924349343494434954349643497434984349943500435014350243503435044350543506435074350843509435104351143512435134351443515435164351743518435194352043521435224352343524435254352643527435284352943530435314353243533435344353543536435374353843539435404354143542435434354443545435464354743548435494355043551435524355343554435554355643557435584355943560435614356243563435644356543566435674356843569435704357143572435734357443575435764357743578435794358043581435824358343584435854358643587435884358943590435914359243593435944359543596435974359843599436004360143602436034360443605436064360743608436094361043611436124361343614436154361643617436184361943620436214362243623436244362543626436274362843629436304363143632436334363443635436364363743638436394364043641436424364343644436454364643647436484364943650436514365243653436544365543656436574365843659436604366143662436634366443665436664366743668436694367043671436724367343674436754367643677436784367943680436814368243683436844368543686436874368843689436904369143692436934369443695436964369743698436994370043701437024370343704437054370643707437084370943710437114371243713437144371543716437174371843719437204372143722437234372443725437264372743728437294373043731437324373343734437354373643737437384373943740437414374243743437444374543746437474374843749437504375143752437534375443755437564375743758437594376043761437624376343764437654376643767437684376943770437714377243773437744377543776437774377843779437804378143782437834378443785437864378743788437894379043791437924379343794437954379643797437984379943800438014380243803438044380543806438074380843809438104381143812438134381443815438164381743818438194382043821438224382343824438254382643827438284382943830438314383243833438344383543836438374383843839438404384143842438434384443845438464384743848438494385043851438524385343854438554385643857438584385943860438614386243863438644386543866438674386843869438704387143872438734387443875438764387743878438794388043881438824388343884438854388643887438884388943890438914389243893438944389543896438974389843899439004390143902439034390443905439064390743908439094391043911439124391343914439154391643917439184391943920439214392243923439244392543926439274392843929439304393143932439334393443935439364393743938439394394043941439424394343944439454394643947439484394943950439514395243953439544395543956439574395843959439604396143962439634396443965439664396743968439694397043971439724397343974439754397643977439784397943980439814398243983439844398543986439874398843989439904399143992439934399443995439964399743998439994400044001440024400344004440054400644007440084400944010440114401244013440144401544016440174401844019440204402144022440234402444025440264402744028440294403044031440324403344034440354403644037440384403944040440414404244043440444404544046440474404844049440504405144052440534405444055440564405744058440594406044061440624406344064440654406644067440684406944070440714407244073440744407544076440774407844079440804408144082440834408444085440864408744088440894409044091440924409344094440954409644097440984409944100441014410244103441044410544106441074410844109441104411144112441134411444115441164411744118441194412044121441224412344124441254412644127441284412944130441314413244133441344413544136441374413844139441404414144142441434414444145441464414744148441494415044151441524415344154441554415644157441584415944160441614416244163441644416544166441674416844169441704417144172441734417444175441764417744178441794418044181441824418344184441854418644187441884418944190441914419244193441944419544196441974419844199442004420144202442034420444205442064420744208442094421044211442124421344214442154421644217442184421944220442214422244223442244422544226442274422844229442304423144232442334423444235442364423744238442394424044241442424424344244442454424644247442484424944250442514425244253442544425544256442574425844259442604426144262442634426444265442664426744268442694427044271442724427344274442754427644277442784427944280442814428244283442844428544286442874428844289442904429144292442934429444295442964429744298442994430044301443024430344304443054430644307443084430944310443114431244313443144431544316443174431844319443204432144322443234432444325443264432744328443294433044331443324433344334443354433644337443384433944340443414434244343443444434544346443474434844349443504435144352443534435444355443564435744358443594436044361443624436344364443654436644367443684436944370443714437244373443744437544376443774437844379443804438144382443834438444385443864438744388443894439044391443924439344394443954439644397443984439944400444014440244403444044440544406444074440844409444104441144412444134441444415444164441744418444194442044421444224442344424444254442644427444284442944430444314443244433444344443544436444374443844439444404444144442444434444444445444464444744448444494445044451444524445344454444554445644457444584445944460444614446244463444644446544466444674446844469444704447144472444734447444475444764447744478444794448044481444824448344484444854448644487444884448944490444914449244493444944449544496444974449844499445004450144502445034450444505445064450744508445094451044511445124451344514445154451644517445184451944520445214452244523445244452544526445274452844529445304453144532445334453444535445364453744538445394454044541445424454344544445454454644547445484454944550445514455244553445544455544556445574455844559445604456144562445634456444565445664456744568445694457044571445724457344574445754457644577445784457944580445814458244583445844458544586445874458844589445904459144592445934459444595445964459744598445994460044601446024460344604446054460644607446084460944610446114461244613446144461544616446174461844619446204462144622446234462444625446264462744628446294463044631446324463344634446354463644637446384463944640446414464244643446444464544646446474464844649446504465144652446534465444655446564465744658446594466044661446624466344664446654466644667446684466944670446714467244673446744467544676446774467844679446804468144682446834468444685446864468744688446894469044691446924469344694446954469644697446984469944700447014470244703447044470544706447074470844709447104471144712447134471444715447164471744718447194472044721447224472344724447254472644727447284472944730447314473244733447344473544736447374473844739447404474144742447434474444745447464474744748447494475044751447524475344754447554475644757447584475944760447614476244763447644476544766447674476844769447704477144772447734477444775447764477744778447794478044781447824478344784447854478644787447884478944790447914479244793447944479544796447974479844799448004480144802448034480444805448064480744808448094481044811448124481344814448154481644817448184481944820448214482244823448244482544826448274482844829448304483144832448334483444835448364483744838448394484044841448424484344844448454484644847448484484944850448514485244853448544485544856448574485844859448604486144862448634486444865448664486744868448694487044871448724487344874448754487644877448784487944880448814488244883448844488544886448874488844889448904489144892448934489444895448964489744898448994490044901449024490344904449054490644907449084490944910449114491244913449144491544916449174491844919449204492144922449234492444925449264492744928449294493044931449324493344934449354493644937449384493944940449414494244943449444494544946449474494844949449504495144952449534495444955449564495744958449594496044961449624496344964449654496644967449684496944970449714497244973449744497544976449774497844979449804498144982449834498444985449864498744988449894499044991449924499344994449954499644997449984499945000450014500245003450044500545006450074500845009450104501145012450134501445015450164501745018450194502045021450224502345024450254502645027450284502945030450314503245033450344503545036450374503845039450404504145042450434504445045450464504745048450494505045051450524505345054450554505645057450584505945060450614506245063450644506545066450674506845069450704507145072450734507445075450764507745078450794508045081450824508345084450854508645087450884508945090450914509245093450944509545096450974509845099451004510145102451034510445105451064510745108451094511045111451124511345114451154511645117451184511945120451214512245123451244512545126451274512845129451304513145132451334513445135451364513745138451394514045141451424514345144451454514645147451484514945150451514515245153451544515545156451574515845159451604516145162451634516445165451664516745168451694517045171451724517345174451754517645177451784517945180451814518245183451844518545186451874518845189451904519145192451934519445195451964519745198451994520045201452024520345204452054520645207452084520945210452114521245213452144521545216452174521845219452204522145222452234522445225452264522745228452294523045231452324523345234452354523645237452384523945240452414524245243452444524545246452474524845249452504525145252452534525445255452564525745258452594526045261452624526345264452654526645267452684526945270452714527245273452744527545276452774527845279452804528145282452834528445285452864528745288452894529045291452924529345294452954529645297452984529945300453014530245303453044530545306453074530845309453104531145312453134531445315453164531745318453194532045321453224532345324453254532645327453284532945330453314533245333453344533545336453374533845339453404534145342453434534445345453464534745348453494535045351453524535345354453554535645357453584535945360453614536245363453644536545366453674536845369453704537145372453734537445375453764537745378453794538045381453824538345384453854538645387453884538945390453914539245393453944539545396453974539845399454004540145402454034540445405454064540745408454094541045411454124541345414454154541645417454184541945420454214542245423454244542545426454274542845429454304543145432454334543445435454364543745438454394544045441454424544345444454454544645447454484544945450454514545245453454544545545456454574545845459454604546145462454634546445465454664546745468454694547045471454724547345474454754547645477454784547945480454814548245483454844548545486454874548845489454904549145492454934549445495454964549745498454994550045501455024550345504455054550645507455084550945510455114551245513455144551545516455174551845519455204552145522455234552445525455264552745528455294553045531455324553345534455354553645537455384553945540455414554245543455444554545546455474554845549455504555145552455534555445555455564555745558455594556045561455624556345564455654556645567455684556945570455714557245573455744557545576455774557845579455804558145582455834558445585455864558745588455894559045591455924559345594455954559645597455984559945600456014560245603456044560545606456074560845609456104561145612456134561445615456164561745618456194562045621456224562345624456254562645627456284562945630456314563245633456344563545636456374563845639456404564145642456434564445645456464564745648456494565045651456524565345654456554565645657456584565945660456614566245663456644566545666456674566845669456704567145672456734567445675456764567745678456794568045681456824568345684456854568645687456884568945690456914569245693456944569545696456974569845699457004570145702457034570445705457064570745708457094571045711457124571345714457154571645717457184571945720457214572245723457244572545726457274572845729457304573145732457334573445735457364573745738457394574045741457424574345744457454574645747457484574945750457514575245753457544575545756457574575845759457604576145762457634576445765457664576745768457694577045771457724577345774457754577645777457784577945780457814578245783457844578545786457874578845789457904579145792457934579445795457964579745798457994580045801458024580345804458054580645807458084580945810458114581245813458144581545816458174581845819458204582145822458234582445825458264582745828458294583045831458324583345834458354583645837458384583945840458414584245843458444584545846458474584845849458504585145852458534585445855458564585745858458594586045861458624586345864458654586645867458684586945870458714587245873458744587545876458774587845879458804588145882458834588445885458864588745888458894589045891458924589345894458954589645897458984589945900459014590245903459044590545906459074590845909459104591145912459134591445915459164591745918459194592045921459224592345924459254592645927459284592945930459314593245933459344593545936459374593845939459404594145942459434594445945459464594745948459494595045951459524595345954459554595645957459584595945960459614596245963459644596545966459674596845969459704597145972459734597445975459764597745978459794598045981459824598345984459854598645987459884598945990459914599245993459944599545996459974599845999460004600146002460034600446005460064600746008460094601046011460124601346014460154601646017460184601946020460214602246023460244602546026460274602846029460304603146032460334603446035460364603746038460394604046041460424604346044460454604646047460484604946050460514605246053460544605546056460574605846059460604606146062460634606446065460664606746068460694607046071460724607346074460754607646077460784607946080460814608246083460844608546086460874608846089460904609146092460934609446095460964609746098460994610046101461024610346104461054610646107461084610946110461114611246113461144611546116461174611846119461204612146122461234612446125461264612746128461294613046131461324613346134461354613646137461384613946140461414614246143461444614546146461474614846149461504615146152461534615446155461564615746158461594616046161461624616346164461654616646167461684616946170461714617246173461744617546176461774617846179461804618146182461834618446185461864618746188461894619046191461924619346194461954619646197461984619946200462014620246203462044620546206462074620846209462104621146212462134621446215462164621746218462194622046221462224622346224462254622646227462284622946230462314623246233462344623546236462374623846239462404624146242462434624446245462464624746248462494625046251462524625346254462554625646257462584625946260462614626246263462644626546266462674626846269462704627146272462734627446275462764627746278462794628046281462824628346284462854628646287462884628946290462914629246293462944629546296462974629846299463004630146302463034630446305463064630746308463094631046311463124631346314463154631646317463184631946320463214632246323463244632546326463274632846329463304633146332463334633446335463364633746338463394634046341463424634346344463454634646347463484634946350463514635246353463544635546356463574635846359463604636146362463634636446365463664636746368463694637046371463724637346374463754637646377463784637946380463814638246383463844638546386463874638846389463904639146392463934639446395463964639746398463994640046401464024640346404464054640646407464084640946410464114641246413464144641546416464174641846419464204642146422464234642446425464264642746428464294643046431464324643346434464354643646437464384643946440464414644246443464444644546446464474644846449464504645146452464534645446455464564645746458464594646046461464624646346464464654646646467464684646946470464714647246473464744647546476464774647846479464804648146482464834648446485464864648746488464894649046491464924649346494464954649646497464984649946500465014650246503465044650546506465074650846509465104651146512465134651446515465164651746518465194652046521465224652346524465254652646527465284652946530465314653246533465344653546536465374653846539465404654146542465434654446545465464654746548465494655046551465524655346554465554655646557465584655946560465614656246563465644656546566465674656846569465704657146572465734657446575465764657746578465794658046581465824658346584465854658646587465884658946590465914659246593465944659546596465974659846599466004660146602466034660446605466064660746608466094661046611466124661346614466154661646617466184661946620466214662246623466244662546626466274662846629466304663146632466334663446635466364663746638466394664046641466424664346644466454664646647466484664946650466514665246653466544665546656466574665846659466604666146662466634666446665466664666746668466694667046671466724667346674466754667646677466784667946680466814668246683466844668546686466874668846689466904669146692466934669446695466964669746698466994670046701467024670346704467054670646707467084670946710467114671246713467144671546716467174671846719467204672146722467234672446725467264672746728467294673046731467324673346734467354673646737467384673946740467414674246743467444674546746467474674846749467504675146752467534675446755467564675746758467594676046761467624676346764467654676646767467684676946770467714677246773467744677546776467774677846779467804678146782467834678446785467864678746788467894679046791467924679346794467954679646797467984679946800468014680246803468044680546806468074680846809468104681146812468134681446815468164681746818468194682046821468224682346824468254682646827468284682946830468314683246833468344683546836468374683846839468404684146842468434684446845468464684746848468494685046851468524685346854468554685646857468584685946860468614686246863468644686546866468674686846869468704687146872468734687446875468764687746878468794688046881468824688346884468854688646887468884688946890468914689246893468944689546896468974689846899469004690146902469034690446905469064690746908469094691046911469124691346914469154691646917469184691946920469214692246923469244692546926469274692846929469304693146932469334693446935469364693746938469394694046941469424694346944469454694646947469484694946950469514695246953469544695546956469574695846959469604696146962469634696446965469664696746968469694697046971469724697346974469754697646977469784697946980469814698246983469844698546986469874698846989469904699146992469934699446995469964699746998469994700047001470024700347004470054700647007470084700947010470114701247013470144701547016470174701847019470204702147022470234702447025470264702747028470294703047031470324703347034470354703647037470384703947040470414704247043470444704547046470474704847049470504705147052470534705447055470564705747058470594706047061470624706347064470654706647067470684706947070470714707247073470744707547076470774707847079470804708147082470834708447085470864708747088470894709047091470924709347094470954709647097470984709947100471014710247103471044710547106471074710847109471104711147112471134711447115471164711747118471194712047121471224712347124471254712647127471284712947130471314713247133471344713547136471374713847139471404714147142471434714447145471464714747148471494715047151471524715347154471554715647157471584715947160471614716247163471644716547166471674716847169471704717147172471734717447175471764717747178471794718047181471824718347184471854718647187471884718947190471914719247193471944719547196471974719847199472004720147202472034720447205472064720747208472094721047211472124721347214472154721647217472184721947220472214722247223472244722547226472274722847229472304723147232472334723447235472364723747238472394724047241472424724347244472454724647247472484724947250472514725247253472544725547256472574725847259472604726147262472634726447265472664726747268472694727047271472724727347274472754727647277472784727947280472814728247283472844728547286472874728847289472904729147292472934729447295472964729747298472994730047301473024730347304473054730647307473084730947310473114731247313473144731547316473174731847319473204732147322473234732447325473264732747328473294733047331473324733347334473354733647337473384733947340473414734247343473444734547346473474734847349473504735147352473534735447355473564735747358473594736047361473624736347364473654736647367473684736947370473714737247373473744737547376473774737847379473804738147382473834738447385473864738747388473894739047391473924739347394473954739647397473984739947400474014740247403474044740547406474074740847409474104741147412474134741447415474164741747418474194742047421474224742347424474254742647427474284742947430474314743247433474344743547436474374743847439474404744147442474434744447445474464744747448474494745047451474524745347454474554745647457474584745947460474614746247463474644746547466474674746847469474704747147472474734747447475474764747747478474794748047481474824748347484474854748647487474884748947490474914749247493474944749547496474974749847499475004750147502475034750447505475064750747508475094751047511475124751347514475154751647517475184751947520475214752247523475244752547526475274752847529475304753147532475334753447535475364753747538475394754047541475424754347544475454754647547475484754947550475514755247553475544755547556475574755847559475604756147562475634756447565475664756747568475694757047571475724757347574475754757647577475784757947580475814758247583475844758547586475874758847589475904759147592475934759447595475964759747598475994760047601476024760347604476054760647607476084760947610476114761247613476144761547616476174761847619476204762147622476234762447625476264762747628476294763047631476324763347634476354763647637476384763947640476414764247643476444764547646476474764847649476504765147652476534765447655476564765747658476594766047661476624766347664476654766647667476684766947670476714767247673476744767547676476774767847679476804768147682476834768447685476864768747688476894769047691476924769347694476954769647697476984769947700477014770247703477044770547706477074770847709477104771147712477134771447715477164771747718477194772047721477224772347724477254772647727477284772947730477314773247733477344773547736477374773847739477404774147742477434774447745477464774747748477494775047751477524775347754477554775647757477584775947760477614776247763477644776547766477674776847769477704777147772477734777447775477764777747778477794778047781477824778347784477854778647787477884778947790477914779247793477944779547796477974779847799478004780147802478034780447805478064780747808478094781047811478124781347814478154781647817478184781947820478214782247823478244782547826478274782847829478304783147832478334783447835478364783747838478394784047841478424784347844478454784647847478484784947850478514785247853478544785547856478574785847859478604786147862478634786447865478664786747868478694787047871478724787347874478754787647877478784787947880478814788247883478844788547886478874788847889478904789147892478934789447895478964789747898478994790047901479024790347904479054790647907479084790947910479114791247913479144791547916479174791847919479204792147922479234792447925479264792747928479294793047931479324793347934479354793647937479384793947940479414794247943479444794547946479474794847949479504795147952479534795447955479564795747958479594796047961479624796347964479654796647967479684796947970479714797247973479744797547976479774797847979479804798147982479834798447985479864798747988479894799047991479924799347994479954799647997479984799948000480014800248003480044800548006480074800848009480104801148012480134801448015480164801748018480194802048021480224802348024480254802648027480284802948030480314803248033480344803548036480374803848039480404804148042480434804448045480464804748048480494805048051480524805348054480554805648057480584805948060480614806248063480644806548066480674806848069480704807148072480734807448075480764807748078480794808048081480824808348084480854808648087480884808948090480914809248093480944809548096480974809848099481004810148102481034810448105481064810748108481094811048111481124811348114481154811648117481184811948120481214812248123481244812548126481274812848129481304813148132481334813448135481364813748138481394814048141481424814348144481454814648147481484814948150481514815248153481544815548156481574815848159481604816148162481634816448165481664816748168481694817048171481724817348174481754817648177481784817948180481814818248183481844818548186481874818848189481904819148192481934819448195481964819748198481994820048201482024820348204482054820648207482084820948210482114821248213482144821548216482174821848219482204822148222482234822448225482264822748228482294823048231482324823348234482354823648237482384823948240482414824248243482444824548246482474824848249482504825148252482534825448255482564825748258482594826048261482624826348264482654826648267482684826948270482714827248273482744827548276482774827848279482804828148282482834828448285482864828748288482894829048291482924829348294482954829648297482984829948300483014830248303483044830548306483074830848309483104831148312483134831448315483164831748318483194832048321483224832348324483254832648327483284832948330483314833248333483344833548336483374833848339483404834148342483434834448345483464834748348483494835048351483524835348354483554835648357483584835948360483614836248363483644836548366483674836848369483704837148372483734837448375483764837748378483794838048381483824838348384483854838648387483884838948390483914839248393483944839548396483974839848399484004840148402484034840448405484064840748408484094841048411484124841348414484154841648417484184841948420484214842248423484244842548426484274842848429484304843148432484334843448435484364843748438484394844048441484424844348444484454844648447484484844948450484514845248453484544845548456484574845848459484604846148462484634846448465484664846748468484694847048471484724847348474484754847648477484784847948480484814848248483484844848548486484874848848489484904849148492484934849448495484964849748498484994850048501485024850348504485054850648507485084850948510485114851248513485144851548516485174851848519485204852148522485234852448525485264852748528485294853048531485324853348534485354853648537485384853948540485414854248543485444854548546485474854848549485504855148552485534855448555485564855748558485594856048561485624856348564485654856648567485684856948570485714857248573485744857548576485774857848579485804858148582485834858448585485864858748588485894859048591485924859348594485954859648597485984859948600486014860248603486044860548606486074860848609486104861148612486134861448615486164861748618486194862048621486224862348624486254862648627486284862948630486314863248633486344863548636486374863848639486404864148642486434864448645486464864748648486494865048651486524865348654486554865648657486584865948660486614866248663486644866548666486674866848669486704867148672486734867448675486764867748678486794868048681486824868348684486854868648687486884868948690486914869248693486944869548696486974869848699487004870148702487034870448705487064870748708487094871048711487124871348714487154871648717487184871948720487214872248723487244872548726487274872848729487304873148732487334873448735487364873748738487394874048741487424874348744487454874648747487484874948750487514875248753487544875548756487574875848759487604876148762487634876448765487664876748768487694877048771487724877348774487754877648777487784877948780487814878248783487844878548786487874878848789487904879148792487934879448795487964879748798487994880048801488024880348804488054880648807488084880948810488114881248813488144881548816488174881848819488204882148822488234882448825488264882748828488294883048831488324883348834488354883648837488384883948840488414884248843488444884548846488474884848849488504885148852488534885448855488564885748858488594886048861488624886348864488654886648867488684886948870488714887248873488744887548876488774887848879488804888148882488834888448885488864888748888488894889048891488924889348894488954889648897488984889948900489014890248903489044890548906489074890848909489104891148912489134891448915489164891748918489194892048921489224892348924489254892648927489284892948930489314893248933489344893548936489374893848939489404894148942489434894448945489464894748948489494895048951489524895348954489554895648957489584895948960489614896248963489644896548966489674896848969489704897148972489734897448975489764897748978489794898048981489824898348984489854898648987489884898948990489914899248993489944899548996489974899848999490004900149002490034900449005490064900749008490094901049011490124901349014490154901649017490184901949020490214902249023490244902549026490274902849029490304903149032490334903449035490364903749038490394904049041490424904349044490454904649047490484904949050490514905249053490544905549056490574905849059490604906149062490634906449065490664906749068490694907049071490724907349074490754907649077490784907949080490814908249083490844908549086490874908849089490904909149092490934909449095490964909749098490994910049101491024910349104491054910649107491084910949110491114911249113491144911549116491174911849119491204912149122491234912449125491264912749128491294913049131491324913349134491354913649137491384913949140491414914249143491444914549146491474914849149491504915149152491534915449155491564915749158491594916049161491624916349164491654916649167491684916949170491714917249173491744917549176491774917849179491804918149182491834918449185491864918749188491894919049191491924919349194491954919649197491984919949200492014920249203492044920549206492074920849209492104921149212492134921449215492164921749218492194922049221492224922349224492254922649227492284922949230492314923249233492344923549236492374923849239492404924149242492434924449245492464924749248492494925049251492524925349254492554925649257492584925949260492614926249263492644926549266492674926849269492704927149272492734927449275492764927749278492794928049281492824928349284492854928649287492884928949290492914929249293492944929549296492974929849299493004930149302493034930449305493064930749308493094931049311493124931349314493154931649317493184931949320493214932249323493244932549326493274932849329493304933149332493334933449335493364933749338493394934049341493424934349344493454934649347493484934949350493514935249353493544935549356493574935849359493604936149362493634936449365493664936749368493694937049371493724937349374493754937649377493784937949380493814938249383493844938549386493874938849389493904939149392493934939449395493964939749398493994940049401494024940349404494054940649407494084940949410494114941249413494144941549416494174941849419494204942149422494234942449425494264942749428494294943049431494324943349434494354943649437494384943949440494414944249443494444944549446494474944849449494504945149452494534945449455494564945749458494594946049461494624946349464494654946649467494684946949470494714947249473494744947549476494774947849479494804948149482494834948449485494864948749488494894949049491494924949349494494954949649497494984949949500495014950249503495044950549506495074950849509495104951149512495134951449515495164951749518495194952049521495224952349524495254952649527495284952949530495314953249533495344953549536495374953849539495404954149542495434954449545495464954749548495494955049551495524955349554495554955649557495584955949560495614956249563495644956549566495674956849569495704957149572495734957449575495764957749578495794958049581495824958349584495854958649587495884958949590495914959249593495944959549596495974959849599496004960149602496034960449605496064960749608496094961049611496124961349614496154961649617496184961949620496214962249623496244962549626496274962849629496304963149632496334963449635496364963749638496394964049641496424964349644496454964649647496484964949650496514965249653496544965549656496574965849659496604966149662496634966449665496664966749668496694967049671496724967349674496754967649677496784967949680496814968249683496844968549686496874968849689496904969149692496934969449695496964969749698496994970049701497024970349704497054970649707497084970949710497114971249713497144971549716497174971849719497204972149722497234972449725497264972749728497294973049731497324973349734497354973649737497384973949740497414974249743497444974549746497474974849749497504975149752497534975449755497564975749758497594976049761497624976349764497654976649767497684976949770497714977249773497744977549776497774977849779497804978149782497834978449785497864978749788497894979049791497924979349794497954979649797497984979949800498014980249803498044980549806498074980849809498104981149812498134981449815498164981749818498194982049821498224982349824498254982649827498284982949830498314983249833498344983549836498374983849839498404984149842498434984449845498464984749848498494985049851498524985349854498554985649857498584985949860498614986249863498644986549866498674986849869498704987149872498734987449875498764987749878498794988049881498824988349884498854988649887498884988949890498914989249893498944989549896498974989849899499004990149902499034990449905499064990749908499094991049911499124991349914499154991649917499184991949920499214992249923499244992549926499274992849929499304993149932499334993449935499364993749938499394994049941499424994349944499454994649947499484994949950499514995249953499544995549956499574995849959499604996149962499634996449965499664996749968499694997049971499724997349974499754997649977499784997949980499814998249983499844998549986499874998849989499904999149992499934999449995499964999749998499995000050001500025000350004500055000650007500085000950010500115001250013500145001550016500175001850019500205002150022500235002450025500265002750028500295003050031500325003350034500355003650037500385003950040500415004250043500445004550046500475004850049500505005150052500535005450055500565005750058500595006050061500625006350064500655006650067500685006950070500715007250073500745007550076500775007850079500805008150082500835008450085500865008750088500895009050091500925009350094500955009650097500985009950100501015010250103501045010550106501075010850109501105011150112501135011450115501165011750118501195012050121501225012350124501255012650127501285012950130501315013250133501345013550136501375013850139501405014150142501435014450145501465014750148501495015050151501525015350154501555015650157501585015950160501615016250163501645016550166501675016850169501705017150172501735017450175501765017750178501795018050181501825018350184501855018650187501885018950190501915019250193501945019550196501975019850199502005020150202502035020450205502065020750208502095021050211502125021350214502155021650217502185021950220502215022250223502245022550226502275022850229502305023150232502335023450235502365023750238502395024050241502425024350244502455024650247502485024950250502515025250253502545025550256502575025850259502605026150262502635026450265502665026750268502695027050271502725027350274502755027650277502785027950280502815028250283502845028550286502875028850289502905029150292502935029450295502965029750298502995030050301503025030350304503055030650307503085030950310503115031250313503145031550316503175031850319503205032150322503235032450325503265032750328503295033050331503325033350334503355033650337503385033950340503415034250343503445034550346503475034850349503505035150352503535035450355503565035750358503595036050361503625036350364503655036650367503685036950370503715037250373503745037550376503775037850379503805038150382503835038450385503865038750388503895039050391503925039350394503955039650397503985039950400504015040250403504045040550406504075040850409504105041150412504135041450415504165041750418504195042050421504225042350424504255042650427504285042950430504315043250433504345043550436504375043850439504405044150442504435044450445504465044750448504495045050451504525045350454504555045650457504585045950460504615046250463504645046550466504675046850469504705047150472504735047450475504765047750478504795048050481504825048350484504855048650487504885048950490504915049250493504945049550496504975049850499505005050150502505035050450505505065050750508505095051050511505125051350514505155051650517505185051950520505215052250523505245052550526505275052850529505305053150532505335053450535505365053750538505395054050541505425054350544505455054650547505485054950550505515055250553505545055550556505575055850559505605056150562505635056450565505665056750568505695057050571505725057350574505755057650577505785057950580505815058250583505845058550586505875058850589505905059150592505935059450595505965059750598505995060050601506025060350604506055060650607506085060950610506115061250613506145061550616506175061850619506205062150622506235062450625506265062750628506295063050631506325063350634506355063650637506385063950640506415064250643506445064550646506475064850649506505065150652506535065450655506565065750658506595066050661506625066350664506655066650667506685066950670506715067250673506745067550676506775067850679506805068150682506835068450685506865068750688506895069050691506925069350694506955069650697506985069950700507015070250703507045070550706507075070850709507105071150712507135071450715507165071750718507195072050721507225072350724507255072650727507285072950730507315073250733507345073550736507375073850739507405074150742507435074450745507465074750748507495075050751507525075350754507555075650757507585075950760507615076250763507645076550766507675076850769507705077150772507735077450775507765077750778507795078050781507825078350784507855078650787507885078950790507915079250793507945079550796507975079850799508005080150802508035080450805508065080750808508095081050811508125081350814508155081650817508185081950820508215082250823508245082550826508275082850829508305083150832508335083450835508365083750838508395084050841508425084350844508455084650847508485084950850508515085250853508545085550856508575085850859508605086150862508635086450865508665086750868508695087050871508725087350874508755087650877508785087950880508815088250883508845088550886508875088850889508905089150892508935089450895508965089750898508995090050901509025090350904509055090650907509085090950910509115091250913509145091550916509175091850919509205092150922509235092450925509265092750928509295093050931509325093350934509355093650937509385093950940509415094250943509445094550946509475094850949509505095150952509535095450955509565095750958509595096050961509625096350964509655096650967509685096950970509715097250973509745097550976509775097850979509805098150982509835098450985509865098750988509895099050991509925099350994509955099650997509985099951000510015100251003510045100551006510075100851009510105101151012510135101451015510165101751018510195102051021510225102351024510255102651027510285102951030510315103251033510345103551036510375103851039510405104151042510435104451045510465104751048510495105051051510525105351054510555105651057510585105951060510615106251063510645106551066510675106851069510705107151072510735107451075510765107751078510795108051081510825108351084510855108651087510885108951090510915109251093510945109551096510975109851099511005110151102511035110451105511065110751108511095111051111511125111351114511155111651117511185111951120511215112251123511245112551126511275112851129511305113151132511335113451135511365113751138511395114051141511425114351144511455114651147511485114951150511515115251153511545115551156511575115851159511605116151162511635116451165511665116751168511695117051171511725117351174511755117651177511785117951180511815118251183511845118551186511875118851189511905119151192511935119451195511965119751198511995120051201512025120351204512055120651207512085120951210512115121251213512145121551216512175121851219512205122151222512235122451225512265122751228512295123051231512325123351234512355123651237512385123951240512415124251243512445124551246512475124851249512505125151252512535125451255512565125751258512595126051261512625126351264512655126651267512685126951270512715127251273512745127551276512775127851279512805128151282512835128451285512865128751288512895129051291512925129351294512955129651297512985129951300513015130251303513045130551306513075130851309513105131151312513135131451315513165131751318513195132051321513225132351324513255132651327513285132951330513315133251333513345133551336513375133851339513405134151342513435134451345513465134751348513495135051351513525135351354513555135651357513585135951360513615136251363513645136551366513675136851369513705137151372513735137451375513765137751378513795138051381513825138351384513855138651387513885138951390513915139251393513945139551396513975139851399514005140151402514035140451405514065140751408514095141051411514125141351414514155141651417514185141951420514215142251423514245142551426514275142851429514305143151432514335143451435514365143751438514395144051441514425144351444514455144651447514485144951450514515145251453514545145551456514575145851459514605146151462514635146451465514665146751468514695147051471514725147351474514755147651477514785147951480514815148251483514845148551486514875148851489514905149151492514935149451495514965149751498514995150051501515025150351504515055150651507515085150951510515115151251513515145151551516515175151851519515205152151522515235152451525515265152751528515295153051531515325153351534515355153651537515385153951540515415154251543515445154551546515475154851549515505155151552515535155451555515565155751558515595156051561515625156351564515655156651567515685156951570515715157251573515745157551576515775157851579515805158151582515835158451585515865158751588515895159051591515925159351594515955159651597515985159951600516015160251603516045160551606516075160851609516105161151612516135161451615516165161751618516195162051621516225162351624516255162651627516285162951630516315163251633516345163551636516375163851639516405164151642516435164451645516465164751648516495165051651516525165351654516555165651657516585165951660516615166251663516645166551666516675166851669516705167151672516735167451675516765167751678516795168051681516825168351684516855168651687516885168951690516915169251693516945169551696516975169851699517005170151702517035170451705517065170751708517095171051711517125171351714517155171651717517185171951720517215172251723517245172551726517275172851729517305173151732517335173451735517365173751738517395174051741517425174351744517455174651747517485174951750517515175251753517545175551756517575175851759517605176151762517635176451765517665176751768517695177051771517725177351774517755177651777517785177951780517815178251783517845178551786517875178851789517905179151792517935179451795517965179751798517995180051801518025180351804518055180651807518085180951810518115181251813518145181551816518175181851819518205182151822518235182451825518265182751828518295183051831518325183351834518355183651837518385183951840518415184251843518445184551846518475184851849518505185151852518535185451855518565185751858518595186051861518625186351864518655186651867518685186951870518715187251873518745187551876518775187851879518805188151882518835188451885518865188751888518895189051891518925189351894518955189651897518985189951900519015190251903519045190551906519075190851909519105191151912519135191451915519165191751918519195192051921519225192351924519255192651927519285192951930519315193251933519345193551936519375193851939519405194151942519435194451945519465194751948519495195051951519525195351954519555195651957519585195951960519615196251963519645196551966519675196851969519705197151972519735197451975519765197751978519795198051981519825198351984519855198651987519885198951990519915199251993519945199551996519975199851999520005200152002520035200452005520065200752008520095201052011520125201352014520155201652017520185201952020520215202252023520245202552026520275202852029520305203152032520335203452035520365203752038520395204052041520425204352044520455204652047520485204952050520515205252053520545205552056520575205852059520605206152062520635206452065520665206752068520695207052071520725207352074520755207652077520785207952080520815208252083520845208552086520875208852089520905209152092520935209452095520965209752098520995210052101521025210352104521055210652107521085210952110521115211252113521145211552116521175211852119521205212152122521235212452125521265212752128521295213052131521325213352134521355213652137521385213952140521415214252143521445214552146521475214852149521505215152152521535215452155521565215752158521595216052161521625216352164521655216652167521685216952170521715217252173521745217552176521775217852179521805218152182521835218452185521865218752188521895219052191521925219352194521955219652197521985219952200522015220252203522045220552206522075220852209522105221152212522135221452215522165221752218522195222052221522225222352224522255222652227522285222952230522315223252233522345223552236522375223852239522405224152242522435224452245522465224752248522495225052251522525225352254522555225652257522585225952260522615226252263522645226552266522675226852269522705227152272522735227452275522765227752278522795228052281522825228352284522855228652287522885228952290522915229252293522945229552296522975229852299523005230152302523035230452305523065230752308523095231052311523125231352314523155231652317523185231952320523215232252323523245232552326523275232852329523305233152332523335233452335523365233752338523395234052341523425234352344523455234652347523485234952350523515235252353523545235552356523575235852359523605236152362523635236452365523665236752368523695237052371523725237352374523755237652377523785237952380523815238252383523845238552386523875238852389523905239152392523935239452395523965239752398523995240052401524025240352404524055240652407524085240952410524115241252413524145241552416524175241852419524205242152422524235242452425524265242752428524295243052431524325243352434524355243652437524385243952440524415244252443524445244552446524475244852449524505245152452524535245452455524565245752458524595246052461524625246352464524655246652467524685246952470524715247252473524745247552476524775247852479524805248152482524835248452485524865248752488524895249052491524925249352494524955249652497524985249952500525015250252503525045250552506525075250852509525105251152512525135251452515525165251752518525195252052521525225252352524525255252652527525285252952530525315253252533525345253552536525375253852539525405254152542525435254452545525465254752548525495255052551525525255352554525555255652557525585255952560525615256252563525645256552566525675256852569525705257152572525735257452575525765257752578525795258052581525825258352584525855258652587525885258952590525915259252593525945259552596525975259852599526005260152602526035260452605526065260752608526095261052611526125261352614526155261652617526185261952620526215262252623526245262552626526275262852629526305263152632526335263452635526365263752638526395264052641526425264352644526455264652647526485264952650526515265252653526545265552656526575265852659526605266152662526635266452665526665266752668526695267052671526725267352674526755267652677526785267952680526815268252683526845268552686526875268852689526905269152692526935269452695526965269752698526995270052701527025270352704527055270652707527085270952710527115271252713527145271552716527175271852719527205272152722527235272452725527265272752728527295273052731527325273352734527355273652737527385273952740527415274252743527445274552746527475274852749527505275152752527535275452755527565275752758527595276052761527625276352764527655276652767527685276952770527715277252773527745277552776527775277852779527805278152782527835278452785527865278752788527895279052791527925279352794527955279652797527985279952800528015280252803528045280552806528075280852809528105281152812528135281452815528165281752818528195282052821528225282352824528255282652827528285282952830528315283252833528345283552836528375283852839528405284152842528435284452845528465284752848528495285052851528525285352854528555285652857528585285952860528615286252863528645286552866528675286852869528705287152872528735287452875528765287752878528795288052881528825288352884528855288652887528885288952890528915289252893528945289552896528975289852899529005290152902529035290452905529065290752908529095291052911529125291352914529155291652917529185291952920529215292252923529245292552926529275292852929529305293152932529335293452935529365293752938529395294052941529425294352944529455294652947529485294952950529515295252953529545295552956529575295852959529605296152962529635296452965529665296752968529695297052971529725297352974529755297652977529785297952980529815298252983529845298552986529875298852989529905299152992529935299452995529965299752998529995300053001530025300353004530055300653007530085300953010530115301253013530145301553016530175301853019530205302153022530235302453025530265302753028530295303053031530325303353034530355303653037530385303953040530415304253043530445304553046530475304853049530505305153052530535305453055530565305753058530595306053061530625306353064530655306653067530685306953070530715307253073530745307553076530775307853079530805308153082530835308453085530865308753088530895309053091530925309353094530955309653097530985309953100531015310253103531045310553106531075310853109531105311153112531135311453115531165311753118531195312053121531225312353124531255312653127531285312953130531315313253133531345313553136531375313853139531405314153142531435314453145531465314753148531495315053151531525315353154531555315653157531585315953160531615316253163531645316553166531675316853169531705317153172531735317453175531765317753178531795318053181531825318353184531855318653187531885318953190531915319253193531945319553196531975319853199532005320153202532035320453205532065320753208532095321053211532125321353214532155321653217532185321953220532215322253223532245322553226532275322853229532305323153232532335323453235532365323753238532395324053241532425324353244532455324653247532485324953250532515325253253532545325553256532575325853259532605326153262532635326453265532665326753268532695327053271532725327353274532755327653277532785327953280532815328253283532845328553286532875328853289532905329153292532935329453295532965329753298532995330053301533025330353304533055330653307533085330953310533115331253313533145331553316533175331853319533205332153322533235332453325533265332753328533295333053331533325333353334533355333653337533385333953340533415334253343533445334553346533475334853349533505335153352533535335453355533565335753358533595336053361533625336353364533655336653367533685336953370533715337253373533745337553376533775337853379533805338153382533835338453385533865338753388533895339053391533925339353394533955339653397533985339953400534015340253403534045340553406534075340853409534105341153412534135341453415534165341753418534195342053421534225342353424534255342653427534285342953430534315343253433534345343553436534375343853439534405344153442534435344453445534465344753448534495345053451534525345353454534555345653457534585345953460534615346253463534645346553466534675346853469534705347153472534735347453475534765347753478534795348053481534825348353484534855348653487534885348953490534915349253493534945349553496534975349853499535005350153502535035350453505535065350753508535095351053511535125351353514535155351653517535185351953520535215352253523535245352553526535275352853529535305353153532535335353453535535365353753538535395354053541535425354353544535455354653547535485354953550535515355253553535545355553556535575355853559535605356153562535635356453565535665356753568535695357053571535725357353574535755357653577535785357953580535815358253583535845358553586535875358853589535905359153592535935359453595535965359753598535995360053601536025360353604536055360653607536085360953610536115361253613536145361553616536175361853619536205362153622536235362453625536265362753628536295363053631536325363353634536355363653637536385363953640536415364253643536445364553646536475364853649536505365153652536535365453655536565365753658536595366053661536625366353664536655366653667536685366953670536715367253673536745367553676536775367853679536805368153682536835368453685536865368753688536895369053691536925369353694536955369653697536985369953700537015370253703537045370553706537075370853709537105371153712537135371453715537165371753718537195372053721537225372353724537255372653727537285372953730537315373253733537345373553736537375373853739537405374153742537435374453745537465374753748537495375053751537525375353754537555375653757537585375953760537615376253763537645376553766537675376853769537705377153772537735377453775537765377753778537795378053781537825378353784537855378653787537885378953790537915379253793537945379553796537975379853799538005380153802538035380453805538065380753808538095381053811538125381353814538155381653817538185381953820538215382253823538245382553826538275382853829538305383153832538335383453835538365383753838538395384053841538425384353844538455384653847538485384953850538515385253853538545385553856538575385853859538605386153862538635386453865538665386753868538695387053871538725387353874538755387653877538785387953880538815388253883538845388553886538875388853889538905389153892538935389453895538965389753898538995390053901539025390353904539055390653907539085390953910539115391253913539145391553916539175391853919539205392153922539235392453925539265392753928539295393053931539325393353934539355393653937539385393953940539415394253943539445394553946539475394853949539505395153952539535395453955539565395753958539595396053961539625396353964539655396653967539685396953970539715397253973539745397553976539775397853979539805398153982539835398453985539865398753988539895399053991539925399353994539955399653997539985399954000540015400254003540045400554006540075400854009540105401154012540135401454015540165401754018540195402054021540225402354024540255402654027540285402954030540315403254033540345403554036540375403854039540405404154042540435404454045540465404754048540495405054051540525405354054540555405654057540585405954060540615406254063540645406554066540675406854069540705407154072540735407454075540765407754078540795408054081540825408354084540855408654087540885408954090540915409254093540945409554096540975409854099541005410154102541035410454105541065410754108541095411054111541125411354114541155411654117541185411954120541215412254123541245412554126541275412854129541305413154132541335413454135541365413754138541395414054141541425414354144541455414654147541485414954150541515415254153541545415554156541575415854159541605416154162541635416454165541665416754168541695417054171541725417354174541755417654177541785417954180541815418254183541845418554186541875418854189541905419154192541935419454195541965419754198541995420054201542025420354204542055420654207542085420954210542115421254213542145421554216542175421854219542205422154222542235422454225542265422754228542295423054231542325423354234542355423654237542385423954240542415424254243542445424554246542475424854249542505425154252542535425454255542565425754258542595426054261542625426354264542655426654267542685426954270542715427254273542745427554276542775427854279542805428154282542835428454285542865428754288542895429054291542925429354294542955429654297542985429954300543015430254303543045430554306543075430854309543105431154312543135431454315543165431754318543195432054321543225432354324543255432654327543285432954330543315433254333543345433554336543375433854339543405434154342543435434454345543465434754348543495435054351543525435354354543555435654357543585435954360543615436254363543645436554366543675436854369543705437154372543735437454375543765437754378543795438054381543825438354384543855438654387543885438954390543915439254393543945439554396543975439854399544005440154402544035440454405544065440754408544095441054411544125441354414544155441654417544185441954420544215442254423544245442554426544275442854429544305443154432544335443454435544365443754438544395444054441544425444354444544455444654447544485444954450544515445254453544545445554456544575445854459544605446154462544635446454465544665446754468544695447054471544725447354474544755447654477544785447954480544815448254483544845448554486544875448854489544905449154492544935449454495544965449754498544995450054501545025450354504545055450654507545085450954510545115451254513545145451554516545175451854519545205452154522545235452454525545265452754528545295453054531545325453354534545355453654537545385453954540545415454254543545445454554546545475454854549545505455154552545535455454555545565455754558545595456054561545625456354564545655456654567545685456954570545715457254573545745457554576545775457854579545805458154582545835458454585545865458754588545895459054591545925459354594545955459654597545985459954600546015460254603546045460554606546075460854609546105461154612546135461454615546165461754618546195462054621546225462354624546255462654627546285462954630546315463254633546345463554636546375463854639546405464154642546435464454645546465464754648546495465054651546525465354654546555465654657546585465954660546615466254663546645466554666546675466854669546705467154672546735467454675546765467754678546795468054681546825468354684546855468654687546885468954690546915469254693546945469554696546975469854699547005470154702547035470454705547065470754708547095471054711547125471354714547155471654717547185471954720547215472254723547245472554726547275472854729547305473154732547335473454735547365473754738547395474054741547425474354744547455474654747547485474954750547515475254753547545475554756547575475854759547605476154762547635476454765547665476754768547695477054771547725477354774547755477654777547785477954780547815478254783547845478554786547875478854789547905479154792547935479454795547965479754798547995480054801548025480354804548055480654807548085480954810548115481254813548145481554816548175481854819548205482154822548235482454825548265482754828548295483054831548325483354834548355483654837548385483954840548415484254843548445484554846548475484854849548505485154852548535485454855548565485754858548595486054861548625486354864548655486654867548685486954870548715487254873548745487554876548775487854879548805488154882548835488454885548865488754888548895489054891548925489354894548955489654897548985489954900549015490254903549045490554906549075490854909549105491154912549135491454915549165491754918549195492054921549225492354924549255492654927549285492954930549315493254933549345493554936549375493854939549405494154942549435494454945549465494754948549495495054951549525495354954549555495654957549585495954960549615496254963549645496554966549675496854969549705497154972549735497454975549765497754978549795498054981549825498354984549855498654987549885498954990549915499254993549945499554996549975499854999550005500155002550035500455005550065500755008550095501055011550125501355014550155501655017550185501955020550215502255023550245502555026550275502855029550305503155032550335503455035550365503755038550395504055041550425504355044550455504655047550485504955050550515505255053550545505555056550575505855059550605506155062550635506455065550665506755068550695507055071550725507355074550755507655077550785507955080550815508255083550845508555086550875508855089550905509155092550935509455095550965509755098550995510055101551025510355104551055510655107551085510955110551115511255113551145511555116551175511855119551205512155122551235512455125551265512755128551295513055131551325513355134551355513655137551385513955140551415514255143551445514555146551475514855149551505515155152551535515455155551565515755158551595516055161551625516355164551655516655167551685516955170551715517255173551745517555176551775517855179551805518155182551835518455185551865518755188551895519055191551925519355194551955519655197551985519955200552015520255203552045520555206552075520855209552105521155212552135521455215552165521755218552195522055221552225522355224552255522655227552285522955230552315523255233552345523555236552375523855239552405524155242552435524455245552465524755248552495525055251552525525355254552555525655257552585525955260552615526255263552645526555266552675526855269552705527155272552735527455275552765527755278552795528055281552825528355284552855528655287552885528955290552915529255293552945529555296552975529855299553005530155302553035530455305553065530755308553095531055311553125531355314553155531655317553185531955320553215532255323553245532555326553275532855329553305533155332553335533455335553365533755338553395534055341553425534355344553455534655347553485534955350553515535255353553545535555356553575535855359553605536155362553635536455365553665536755368553695537055371553725537355374553755537655377553785537955380553815538255383553845538555386553875538855389553905539155392553935539455395553965539755398553995540055401554025540355404554055540655407554085540955410554115541255413554145541555416554175541855419554205542155422554235542455425554265542755428554295543055431554325543355434554355543655437554385543955440554415544255443554445544555446554475544855449554505545155452554535545455455554565545755458554595546055461554625546355464554655546655467554685546955470554715547255473554745547555476554775547855479554805548155482554835548455485554865548755488554895549055491554925549355494554955549655497554985549955500555015550255503555045550555506555075550855509555105551155512555135551455515555165551755518555195552055521555225552355524555255552655527555285552955530555315553255533555345553555536555375553855539555405554155542555435554455545555465554755548555495555055551555525555355554555555555655557555585555955560555615556255563555645556555566555675556855569555705557155572555735557455575555765557755578555795558055581555825558355584555855558655587555885558955590555915559255593555945559555596555975559855599556005560155602556035560455605556065560755608556095561055611556125561355614556155561655617556185561955620556215562255623556245562555626556275562855629556305563155632556335563455635556365563755638556395564055641556425564355644556455564655647556485564955650556515565255653556545565555656556575565855659556605566155662556635566455665556665566755668556695567055671556725567355674556755567655677556785567955680556815568255683556845568555686556875568855689556905569155692556935569455695556965569755698556995570055701557025570355704557055570655707557085570955710557115571255713557145571555716557175571855719557205572155722557235572455725557265572755728557295573055731557325573355734557355573655737557385573955740557415574255743557445574555746557475574855749557505575155752557535575455755557565575755758557595576055761557625576355764557655576655767557685576955770557715577255773557745577555776557775577855779557805578155782557835578455785557865578755788557895579055791557925579355794557955579655797557985579955800558015580255803558045580555806558075580855809558105581155812558135581455815558165581755818558195582055821558225582355824558255582655827558285582955830558315583255833558345583555836558375583855839558405584155842558435584455845558465584755848558495585055851558525585355854558555585655857558585585955860558615586255863558645586555866558675586855869558705587155872558735587455875558765587755878558795588055881558825588355884558855588655887558885588955890558915589255893558945589555896558975589855899559005590155902559035590455905559065590755908559095591055911559125591355914559155591655917559185591955920559215592255923559245592555926559275592855929559305593155932559335593455935559365593755938559395594055941559425594355944559455594655947559485594955950559515595255953559545595555956559575595855959559605596155962559635596455965559665596755968559695597055971559725597355974559755597655977559785597955980559815598255983559845598555986559875598855989559905599155992559935599455995559965599755998559995600056001560025600356004560055600656007560085600956010560115601256013560145601556016560175601856019560205602156022560235602456025560265602756028560295603056031560325603356034560355603656037560385603956040560415604256043560445604556046560475604856049560505605156052560535605456055560565605756058560595606056061560625606356064560655606656067560685606956070560715607256073560745607556076560775607856079560805608156082560835608456085560865608756088560895609056091560925609356094560955609656097560985609956100561015610256103561045610556106561075610856109561105611156112561135611456115561165611756118561195612056121561225612356124561255612656127561285612956130561315613256133561345613556136561375613856139561405614156142561435614456145561465614756148561495615056151561525615356154561555615656157561585615956160561615616256163561645616556166561675616856169561705617156172561735617456175561765617756178561795618056181561825618356184561855618656187561885618956190561915619256193561945619556196561975619856199562005620156202562035620456205562065620756208562095621056211562125621356214562155621656217562185621956220562215622256223562245622556226562275622856229562305623156232562335623456235562365623756238562395624056241562425624356244562455624656247562485624956250562515625256253562545625556256562575625856259562605626156262562635626456265562665626756268562695627056271562725627356274562755627656277562785627956280562815628256283562845628556286562875628856289562905629156292562935629456295562965629756298562995630056301563025630356304563055630656307563085630956310563115631256313563145631556316563175631856319563205632156322563235632456325563265632756328563295633056331563325633356334563355633656337563385633956340563415634256343563445634556346563475634856349563505635156352563535635456355563565635756358563595636056361563625636356364563655636656367563685636956370563715637256373563745637556376563775637856379563805638156382563835638456385563865638756388563895639056391563925639356394563955639656397563985639956400564015640256403564045640556406564075640856409564105641156412564135641456415564165641756418564195642056421564225642356424564255642656427564285642956430564315643256433564345643556436564375643856439564405644156442564435644456445564465644756448564495645056451564525645356454564555645656457564585645956460564615646256463564645646556466564675646856469564705647156472564735647456475564765647756478564795648056481564825648356484564855648656487564885648956490564915649256493564945649556496564975649856499565005650156502565035650456505565065650756508565095651056511565125651356514565155651656517565185651956520565215652256523565245652556526565275652856529565305653156532565335653456535565365653756538565395654056541565425654356544565455654656547565485654956550565515655256553565545655556556565575655856559565605656156562565635656456565565665656756568565695657056571565725657356574565755657656577565785657956580565815658256583565845658556586565875658856589565905659156592565935659456595565965659756598565995660056601566025660356604566055660656607566085660956610566115661256613566145661556616566175661856619566205662156622566235662456625566265662756628566295663056631566325663356634566355663656637566385663956640566415664256643566445664556646566475664856649566505665156652566535665456655566565665756658566595666056661566625666356664566655666656667566685666956670566715667256673566745667556676566775667856679566805668156682566835668456685566865668756688566895669056691566925669356694566955669656697566985669956700567015670256703567045670556706567075670856709567105671156712567135671456715567165671756718567195672056721567225672356724567255672656727567285672956730567315673256733567345673556736567375673856739567405674156742567435674456745567465674756748567495675056751567525675356754567555675656757567585675956760567615676256763567645676556766567675676856769567705677156772567735677456775567765677756778567795678056781567825678356784567855678656787567885678956790567915679256793567945679556796567975679856799568005680156802568035680456805568065680756808568095681056811568125681356814568155681656817568185681956820568215682256823568245682556826568275682856829568305683156832568335683456835568365683756838568395684056841568425684356844568455684656847568485684956850568515685256853568545685556856568575685856859568605686156862568635686456865568665686756868568695687056871568725687356874568755687656877568785687956880568815688256883568845688556886568875688856889568905689156892568935689456895568965689756898568995690056901569025690356904569055690656907569085690956910569115691256913569145691556916569175691856919569205692156922569235692456925569265692756928569295693056931569325693356934569355693656937569385693956940569415694256943569445694556946569475694856949569505695156952569535695456955569565695756958569595696056961569625696356964569655696656967569685696956970569715697256973569745697556976569775697856979569805698156982569835698456985569865698756988569895699056991569925699356994569955699656997569985699957000570015700257003570045700557006570075700857009570105701157012570135701457015570165701757018570195702057021570225702357024570255702657027570285702957030570315703257033570345703557036570375703857039570405704157042570435704457045570465704757048570495705057051570525705357054570555705657057570585705957060570615706257063570645706557066570675706857069570705707157072570735707457075570765707757078570795708057081570825708357084570855708657087570885708957090570915709257093570945709557096570975709857099571005710157102571035710457105571065710757108571095711057111571125711357114571155711657117571185711957120571215712257123571245712557126571275712857129571305713157132571335713457135571365713757138571395714057141571425714357144571455714657147571485714957150571515715257153571545715557156571575715857159571605716157162571635716457165571665716757168571695717057171571725717357174571755717657177571785717957180571815718257183571845718557186571875718857189571905719157192571935719457195571965719757198571995720057201572025720357204572055720657207572085720957210572115721257213572145721557216572175721857219572205722157222572235722457225572265722757228572295723057231572325723357234572355723657237572385723957240572415724257243572445724557246572475724857249572505725157252572535725457255572565725757258572595726057261572625726357264572655726657267572685726957270572715727257273572745727557276572775727857279572805728157282572835728457285572865728757288572895729057291572925729357294572955729657297572985729957300573015730257303573045730557306573075730857309573105731157312573135731457315573165731757318573195732057321573225732357324573255732657327573285732957330573315733257333573345733557336573375733857339573405734157342573435734457345573465734757348573495735057351573525735357354573555735657357573585735957360573615736257363573645736557366573675736857369573705737157372573735737457375573765737757378573795738057381573825738357384573855738657387573885738957390573915739257393573945739557396573975739857399574005740157402574035740457405574065740757408574095741057411574125741357414574155741657417574185741957420574215742257423574245742557426574275742857429574305743157432574335743457435574365743757438574395744057441574425744357444574455744657447574485744957450574515745257453574545745557456574575745857459574605746157462574635746457465574665746757468574695747057471574725747357474574755747657477574785747957480574815748257483574845748557486574875748857489574905749157492574935749457495574965749757498574995750057501575025750357504575055750657507575085750957510575115751257513575145751557516575175751857519575205752157522575235752457525575265752757528575295753057531575325753357534575355753657537575385753957540575415754257543575445754557546575475754857549575505755157552575535755457555575565755757558575595756057561575625756357564575655756657567575685756957570575715757257573575745757557576575775757857579575805758157582575835758457585575865758757588575895759057591575925759357594575955759657597575985759957600576015760257603576045760557606576075760857609576105761157612576135761457615576165761757618576195762057621576225762357624576255762657627576285762957630576315763257633576345763557636576375763857639576405764157642576435764457645576465764757648576495765057651576525765357654576555765657657576585765957660576615766257663576645766557666576675766857669576705767157672576735767457675576765767757678576795768057681576825768357684576855768657687576885768957690576915769257693576945769557696576975769857699577005770157702577035770457705577065770757708577095771057711577125771357714577155771657717577185771957720577215772257723577245772557726577275772857729577305773157732577335773457735577365773757738577395774057741577425774357744577455774657747577485774957750577515775257753577545775557756577575775857759577605776157762577635776457765577665776757768577695777057771577725777357774577755777657777577785777957780577815778257783577845778557786577875778857789577905779157792577935779457795577965779757798577995780057801578025780357804578055780657807578085780957810578115781257813578145781557816578175781857819578205782157822578235782457825578265782757828578295783057831578325783357834578355783657837578385783957840578415784257843578445784557846578475784857849578505785157852578535785457855578565785757858578595786057861578625786357864578655786657867578685786957870578715787257873578745787557876578775787857879578805788157882578835788457885578865788757888578895789057891578925789357894578955789657897578985789957900579015790257903579045790557906579075790857909579105791157912579135791457915579165791757918579195792057921579225792357924579255792657927579285792957930579315793257933579345793557936579375793857939579405794157942579435794457945579465794757948579495795057951579525795357954579555795657957579585795957960579615796257963579645796557966579675796857969579705797157972579735797457975579765797757978579795798057981579825798357984579855798657987579885798957990579915799257993579945799557996579975799857999580005800158002580035800458005580065800758008580095801058011580125801358014580155801658017580185801958020580215802258023580245802558026580275802858029580305803158032580335803458035580365803758038580395804058041580425804358044580455804658047580485804958050580515805258053580545805558056580575805858059580605806158062580635806458065580665806758068580695807058071580725807358074580755807658077580785807958080580815808258083580845808558086580875808858089580905809158092580935809458095580965809758098580995810058101581025810358104581055810658107581085810958110581115811258113581145811558116581175811858119581205812158122581235812458125581265812758128581295813058131581325813358134581355813658137581385813958140581415814258143581445814558146581475814858149581505815158152581535815458155581565815758158581595816058161581625816358164581655816658167581685816958170581715817258173581745817558176581775817858179581805818158182581835818458185581865818758188581895819058191581925819358194581955819658197581985819958200582015820258203582045820558206582075820858209582105821158212582135821458215582165821758218582195822058221582225822358224582255822658227582285822958230582315823258233582345823558236582375823858239582405824158242582435824458245582465824758248582495825058251582525825358254582555825658257582585825958260582615826258263582645826558266582675826858269582705827158272582735827458275582765827758278582795828058281582825828358284582855828658287582885828958290582915829258293582945829558296582975829858299583005830158302583035830458305583065830758308583095831058311583125831358314583155831658317583185831958320583215832258323583245832558326583275832858329583305833158332583335833458335583365833758338583395834058341583425834358344583455834658347583485834958350583515835258353583545835558356583575835858359583605836158362583635836458365583665836758368583695837058371583725837358374583755837658377583785837958380583815838258383583845838558386583875838858389583905839158392583935839458395583965839758398583995840058401584025840358404584055840658407584085840958410584115841258413584145841558416584175841858419584205842158422584235842458425584265842758428584295843058431584325843358434584355843658437584385843958440584415844258443584445844558446584475844858449584505845158452584535845458455584565845758458584595846058461584625846358464584655846658467584685846958470584715847258473584745847558476584775847858479584805848158482584835848458485584865848758488584895849058491584925849358494584955849658497584985849958500585015850258503585045850558506585075850858509585105851158512585135851458515585165851758518585195852058521585225852358524585255852658527585285852958530585315853258533585345853558536585375853858539585405854158542585435854458545585465854758548585495855058551585525855358554585555855658557585585855958560585615856258563585645856558566585675856858569585705857158572585735857458575585765857758578585795858058581585825858358584585855858658587585885858958590585915859258593585945859558596585975859858599586005860158602586035860458605586065860758608586095861058611586125861358614586155861658617586185861958620586215862258623586245862558626586275862858629586305863158632586335863458635586365863758638586395864058641586425864358644586455864658647586485864958650586515865258653586545865558656586575865858659586605866158662586635866458665586665866758668586695867058671586725867358674586755867658677586785867958680586815868258683586845868558686586875868858689586905869158692586935869458695586965869758698586995870058701587025870358704587055870658707587085870958710587115871258713587145871558716587175871858719587205872158722587235872458725587265872758728587295873058731587325873358734587355873658737587385873958740587415874258743587445874558746587475874858749587505875158752587535875458755587565875758758587595876058761587625876358764587655876658767587685876958770587715877258773587745877558776587775877858779587805878158782587835878458785587865878758788587895879058791587925879358794587955879658797587985879958800588015880258803588045880558806588075880858809588105881158812588135881458815588165881758818588195882058821588225882358824588255882658827588285882958830588315883258833588345883558836588375883858839588405884158842588435884458845588465884758848588495885058851588525885358854588555885658857588585885958860588615886258863588645886558866588675886858869588705887158872588735887458875588765887758878588795888058881588825888358884588855888658887588885888958890588915889258893588945889558896588975889858899589005890158902589035890458905589065890758908589095891058911589125891358914589155891658917589185891958920589215892258923589245892558926589275892858929589305893158932589335893458935589365893758938589395894058941589425894358944589455894658947589485894958950589515895258953589545895558956589575895858959589605896158962589635896458965589665896758968589695897058971589725897358974589755897658977589785897958980589815898258983589845898558986589875898858989589905899158992589935899458995589965899758998589995900059001590025900359004590055900659007590085900959010590115901259013590145901559016590175901859019590205902159022590235902459025590265902759028590295903059031590325903359034590355903659037590385903959040590415904259043590445904559046590475904859049590505905159052590535905459055590565905759058590595906059061590625906359064590655906659067590685906959070590715907259073590745907559076590775907859079590805908159082590835908459085590865908759088590895909059091590925909359094590955909659097590985909959100591015910259103591045910559106591075910859109591105911159112591135911459115591165911759118591195912059121591225912359124591255912659127591285912959130591315913259133591345913559136591375913859139591405914159142591435914459145591465914759148591495915059151591525915359154591555915659157591585915959160591615916259163591645916559166591675916859169591705917159172591735917459175591765917759178591795918059181591825918359184591855918659187591885918959190591915919259193591945919559196591975919859199592005920159202592035920459205592065920759208592095921059211592125921359214592155921659217592185921959220592215922259223592245922559226592275922859229592305923159232592335923459235592365923759238592395924059241592425924359244592455924659247592485924959250592515925259253592545925559256592575925859259592605926159262592635926459265592665926759268592695927059271592725927359274592755927659277592785927959280592815928259283592845928559286592875928859289592905929159292592935929459295592965929759298592995930059301593025930359304593055930659307593085930959310593115931259313593145931559316593175931859319593205932159322593235932459325593265932759328593295933059331593325933359334593355933659337593385933959340593415934259343593445934559346593475934859349593505935159352593535935459355593565935759358593595936059361593625936359364593655936659367593685936959370593715937259373593745937559376593775937859379593805938159382593835938459385593865938759388593895939059391593925939359394593955939659397593985939959400594015940259403594045940559406594075940859409594105941159412594135941459415594165941759418594195942059421594225942359424594255942659427594285942959430594315943259433594345943559436594375943859439594405944159442594435944459445594465944759448594495945059451594525945359454594555945659457594585945959460594615946259463594645946559466594675946859469594705947159472594735947459475594765947759478594795948059481594825948359484594855948659487594885948959490594915949259493594945949559496594975949859499595005950159502595035950459505595065950759508595095951059511595125951359514595155951659517595185951959520595215952259523595245952559526595275952859529595305953159532595335953459535595365953759538595395954059541595425954359544595455954659547595485954959550595515955259553595545955559556595575955859559595605956159562595635956459565595665956759568595695957059571595725957359574595755957659577595785957959580595815958259583595845958559586595875958859589595905959159592595935959459595595965959759598595995960059601596025960359604596055960659607596085960959610596115961259613596145961559616596175961859619596205962159622596235962459625596265962759628596295963059631596325963359634596355963659637596385963959640596415964259643596445964559646596475964859649596505965159652596535965459655596565965759658596595966059661596625966359664596655966659667596685966959670596715967259673596745967559676596775967859679596805968159682596835968459685596865968759688596895969059691596925969359694596955969659697596985969959700597015970259703597045970559706597075970859709597105971159712597135971459715597165971759718597195972059721597225972359724597255972659727597285972959730597315973259733597345973559736597375973859739597405974159742597435974459745597465974759748597495975059751597525975359754597555975659757597585975959760597615976259763597645976559766597675976859769597705977159772597735977459775597765977759778597795978059781597825978359784597855978659787597885978959790597915979259793597945979559796597975979859799598005980159802598035980459805598065980759808598095981059811598125981359814598155981659817598185981959820598215982259823598245982559826598275982859829598305983159832598335983459835598365983759838598395984059841598425984359844598455984659847598485984959850598515985259853598545985559856598575985859859598605986159862598635986459865598665986759868598695987059871598725987359874598755987659877598785987959880598815988259883598845988559886598875988859889598905989159892598935989459895598965989759898598995990059901599025990359904599055990659907599085990959910599115991259913599145991559916599175991859919599205992159922599235992459925599265992759928599295993059931599325993359934599355993659937599385993959940599415994259943599445994559946599475994859949599505995159952599535995459955599565995759958599595996059961599625996359964599655996659967599685996959970599715997259973599745997559976599775997859979599805998159982599835998459985599865998759988599895999059991599925999359994599955999659997599985999960000600016000260003600046000560006600076000860009600106001160012600136001460015600166001760018600196002060021600226002360024600256002660027600286002960030600316003260033600346003560036600376003860039600406004160042600436004460045600466004760048600496005060051600526005360054600556005660057600586005960060600616006260063600646006560066600676006860069600706007160072600736007460075600766007760078600796008060081600826008360084600856008660087600886008960090600916009260093600946009560096600976009860099601006010160102601036010460105601066010760108601096011060111601126011360114601156011660117601186011960120601216012260123601246012560126601276012860129601306013160132601336013460135601366013760138601396014060141601426014360144601456014660147601486014960150601516015260153601546015560156601576015860159601606016160162601636016460165601666016760168601696017060171601726017360174601756017660177601786017960180601816018260183601846018560186601876018860189601906019160192601936019460195601966019760198601996020060201602026020360204602056020660207602086020960210602116021260213602146021560216602176021860219602206022160222602236022460225602266022760228602296023060231602326023360234602356023660237602386023960240602416024260243602446024560246602476024860249602506025160252602536025460255602566025760258602596026060261602626026360264602656026660267602686026960270602716027260273602746027560276602776027860279602806028160282602836028460285602866028760288602896029060291602926029360294602956029660297602986029960300603016030260303603046030560306603076030860309603106031160312603136031460315603166031760318603196032060321603226032360324603256032660327603286032960330603316033260333603346033560336603376033860339603406034160342603436034460345603466034760348603496035060351603526035360354603556035660357603586035960360603616036260363603646036560366603676036860369603706037160372603736037460375603766037760378603796038060381603826038360384603856038660387603886038960390603916039260393603946039560396603976039860399604006040160402604036040460405604066040760408604096041060411604126041360414604156041660417604186041960420604216042260423604246042560426604276042860429604306043160432604336043460435604366043760438604396044060441604426044360444604456044660447604486044960450604516045260453604546045560456604576045860459604606046160462604636046460465604666046760468604696047060471604726047360474604756047660477604786047960480604816048260483604846048560486604876048860489604906049160492604936049460495604966049760498604996050060501605026050360504605056050660507605086050960510605116051260513605146051560516605176051860519605206052160522605236052460525605266052760528605296053060531605326053360534605356053660537605386053960540605416054260543605446054560546605476054860549605506055160552605536055460555605566055760558605596056060561605626056360564605656056660567605686056960570605716057260573605746057560576605776057860579605806058160582605836058460585605866058760588605896059060591605926059360594605956059660597605986059960600606016060260603606046060560606606076060860609606106061160612606136061460615606166061760618606196062060621606226062360624606256062660627606286062960630606316063260633606346063560636606376063860639606406064160642606436064460645606466064760648606496065060651606526065360654606556065660657606586065960660606616066260663606646066560666606676066860669606706067160672606736067460675606766067760678606796068060681606826068360684606856068660687606886068960690606916069260693606946069560696606976069860699607006070160702607036070460705607066070760708607096071060711607126071360714607156071660717607186071960720607216072260723607246072560726607276072860729607306073160732607336073460735607366073760738607396074060741607426074360744607456074660747607486074960750607516075260753607546075560756607576075860759607606076160762607636076460765607666076760768607696077060771607726077360774607756077660777607786077960780607816078260783607846078560786607876078860789607906079160792607936079460795607966079760798607996080060801608026080360804608056080660807608086080960810608116081260813608146081560816608176081860819608206082160822608236082460825608266082760828608296083060831608326083360834608356083660837608386083960840608416084260843608446084560846608476084860849608506085160852608536085460855608566085760858608596086060861608626086360864608656086660867608686086960870608716087260873608746087560876608776087860879608806088160882608836088460885608866088760888608896089060891608926089360894608956089660897608986089960900609016090260903609046090560906609076090860909609106091160912609136091460915609166091760918609196092060921609226092360924609256092660927609286092960930609316093260933609346093560936609376093860939609406094160942609436094460945609466094760948609496095060951609526095360954609556095660957609586095960960609616096260963609646096560966609676096860969609706097160972609736097460975609766097760978609796098060981609826098360984609856098660987609886098960990609916099260993609946099560996609976099860999610006100161002610036100461005610066100761008610096101061011610126101361014610156101661017610186101961020610216102261023610246102561026610276102861029610306103161032610336103461035610366103761038610396104061041610426104361044610456104661047610486104961050610516105261053610546105561056610576105861059610606106161062610636106461065610666106761068610696107061071610726107361074610756107661077610786107961080610816108261083610846108561086610876108861089610906109161092610936109461095610966109761098610996110061101611026110361104611056110661107611086110961110611116111261113611146111561116611176111861119611206112161122611236112461125611266112761128611296113061131611326113361134611356113661137611386113961140611416114261143611446114561146611476114861149611506115161152611536115461155611566115761158611596116061161611626116361164611656116661167611686116961170611716117261173611746117561176611776117861179611806118161182611836118461185611866118761188611896119061191611926119361194611956119661197611986119961200612016120261203612046120561206612076120861209612106121161212612136121461215612166121761218612196122061221612226122361224612256122661227612286122961230612316123261233612346123561236612376123861239612406124161242612436124461245612466124761248612496125061251612526125361254612556125661257612586125961260612616126261263612646126561266612676126861269612706127161272612736127461275612766127761278612796128061281612826128361284612856128661287612886128961290612916129261293612946129561296612976129861299613006130161302613036130461305613066130761308613096131061311613126131361314613156131661317613186131961320613216132261323613246132561326613276132861329613306133161332613336133461335613366133761338613396134061341613426134361344613456134661347613486134961350613516135261353613546135561356613576135861359613606136161362613636136461365613666136761368613696137061371613726137361374613756137661377613786137961380613816138261383613846138561386613876138861389613906139161392613936139461395613966139761398613996140061401614026140361404614056140661407614086140961410614116141261413614146141561416614176141861419614206142161422614236142461425614266142761428614296143061431614326143361434614356143661437614386143961440614416144261443614446144561446614476144861449614506145161452614536145461455614566145761458614596146061461614626146361464614656146661467614686146961470614716147261473614746147561476614776147861479614806148161482614836148461485614866148761488614896149061491614926149361494614956149661497614986149961500615016150261503615046150561506615076150861509615106151161512615136151461515615166151761518615196152061521615226152361524615256152661527615286152961530615316153261533615346153561536615376153861539615406154161542615436154461545615466154761548615496155061551615526155361554615556155661557615586155961560615616156261563615646156561566615676156861569615706157161572615736157461575615766157761578615796158061581615826158361584615856158661587615886158961590615916159261593615946159561596615976159861599616006160161602616036160461605616066160761608616096161061611616126161361614616156161661617616186161961620616216162261623616246162561626616276162861629616306163161632616336163461635616366163761638616396164061641616426164361644616456164661647616486164961650616516165261653616546165561656616576165861659616606166161662616636166461665616666166761668616696167061671616726167361674616756167661677616786167961680616816168261683616846168561686616876168861689616906169161692616936169461695616966169761698616996170061701617026170361704617056170661707617086170961710617116171261713617146171561716617176171861719617206172161722617236172461725617266172761728617296173061731617326173361734617356173661737617386173961740617416174261743617446174561746617476174861749617506175161752617536175461755617566175761758617596176061761617626176361764617656176661767617686176961770617716177261773617746177561776617776177861779617806178161782617836178461785617866178761788617896179061791617926179361794617956179661797617986179961800618016180261803618046180561806618076180861809618106181161812618136181461815618166181761818618196182061821618226182361824618256182661827618286182961830618316183261833618346183561836618376183861839618406184161842618436184461845618466184761848618496185061851618526185361854618556185661857618586185961860618616186261863618646186561866618676186861869618706187161872618736187461875618766187761878618796188061881618826188361884618856188661887618886188961890618916189261893618946189561896618976189861899619006190161902619036190461905619066190761908619096191061911619126191361914619156191661917619186191961920619216192261923619246192561926619276192861929619306193161932619336193461935619366193761938619396194061941619426194361944619456194661947619486194961950619516195261953619546195561956619576195861959619606196161962619636196461965619666196761968619696197061971619726197361974619756197661977619786197961980619816198261983619846198561986619876198861989619906199161992619936199461995619966199761998619996200062001620026200362004620056200662007620086200962010620116201262013620146201562016620176201862019620206202162022620236202462025620266202762028620296203062031620326203362034620356203662037620386203962040620416204262043620446204562046620476204862049620506205162052620536205462055620566205762058620596206062061620626206362064620656206662067620686206962070620716207262073620746207562076620776207862079620806208162082620836208462085620866208762088620896209062091620926209362094620956209662097620986209962100621016210262103621046210562106621076210862109621106211162112621136211462115621166211762118621196212062121621226212362124621256212662127621286212962130621316213262133621346213562136621376213862139621406214162142621436214462145621466214762148621496215062151621526215362154621556215662157621586215962160621616216262163621646216562166621676216862169621706217162172621736217462175621766217762178621796218062181621826218362184621856218662187621886218962190621916219262193621946219562196621976219862199622006220162202622036220462205622066220762208622096221062211622126221362214622156221662217622186221962220622216222262223622246222562226622276222862229622306223162232622336223462235622366223762238622396224062241622426224362244622456224662247622486224962250622516225262253622546225562256622576225862259622606226162262622636226462265622666226762268622696227062271622726227362274622756227662277622786227962280622816228262283622846228562286622876228862289622906229162292622936229462295622966229762298622996230062301623026230362304623056230662307623086230962310623116231262313623146231562316623176231862319623206232162322623236232462325623266232762328623296233062331623326233362334623356233662337623386233962340623416234262343623446234562346623476234862349623506235162352623536235462355623566235762358623596236062361623626236362364623656236662367623686236962370623716237262373623746237562376623776237862379623806238162382623836238462385623866238762388623896239062391623926239362394623956239662397623986239962400624016240262403624046240562406624076240862409624106241162412624136241462415624166241762418624196242062421624226242362424624256242662427624286242962430624316243262433624346243562436624376243862439624406244162442624436244462445624466244762448624496245062451624526245362454624556245662457624586245962460624616246262463624646246562466624676246862469624706247162472624736247462475624766247762478624796248062481624826248362484624856248662487624886248962490624916249262493624946249562496624976249862499625006250162502625036250462505625066250762508625096251062511625126251362514625156251662517625186251962520625216252262523625246252562526625276252862529625306253162532625336253462535625366253762538625396254062541625426254362544625456254662547625486254962550625516255262553625546255562556625576255862559625606256162562625636256462565625666256762568625696257062571625726257362574625756257662577625786257962580625816258262583625846258562586625876258862589625906259162592625936259462595625966259762598625996260062601626026260362604626056260662607626086260962610626116261262613626146261562616626176261862619626206262162622626236262462625626266262762628626296263062631626326263362634626356263662637626386263962640626416264262643626446264562646626476264862649626506265162652626536265462655626566265762658626596266062661626626266362664626656266662667626686266962670626716267262673626746267562676626776267862679626806268162682626836268462685626866268762688626896269062691626926269362694626956269662697626986269962700627016270262703627046270562706627076270862709627106271162712627136271462715627166271762718627196272062721627226272362724627256272662727627286272962730627316273262733627346273562736627376273862739627406274162742627436274462745627466274762748627496275062751627526275362754627556275662757627586275962760627616276262763627646276562766627676276862769627706277162772627736277462775627766277762778627796278062781627826278362784627856278662787627886278962790627916279262793627946279562796627976279862799628006280162802628036280462805628066280762808628096281062811628126281362814628156281662817628186281962820628216282262823628246282562826628276282862829628306283162832628336283462835628366283762838628396284062841628426284362844628456284662847628486284962850628516285262853628546285562856628576285862859628606286162862628636286462865628666286762868628696287062871628726287362874628756287662877628786287962880628816288262883628846288562886628876288862889628906289162892628936289462895628966289762898628996290062901629026290362904629056290662907629086290962910629116291262913629146291562916629176291862919629206292162922629236292462925629266292762928629296293062931629326293362934629356293662937629386293962940629416294262943629446294562946629476294862949629506295162952629536295462955629566295762958629596296062961629626296362964629656296662967629686296962970629716297262973629746297562976629776297862979629806298162982629836298462985629866298762988629896299062991629926299362994629956299662997629986299963000630016300263003630046300563006630076300863009630106301163012630136301463015630166301763018630196302063021630226302363024630256302663027630286302963030630316303263033630346303563036630376303863039630406304163042630436304463045630466304763048630496305063051630526305363054630556305663057630586305963060630616306263063630646306563066630676306863069630706307163072630736307463075630766307763078630796308063081630826308363084630856308663087630886308963090630916309263093630946309563096630976309863099631006310163102631036310463105631066310763108631096311063111631126311363114631156311663117631186311963120631216312263123631246312563126631276312863129631306313163132631336313463135631366313763138631396314063141631426314363144631456314663147631486314963150631516315263153631546315563156631576315863159631606316163162631636316463165631666316763168631696317063171631726317363174631756317663177631786317963180631816318263183631846318563186631876318863189631906319163192631936319463195631966319763198631996320063201632026320363204632056320663207632086320963210632116321263213632146321563216632176321863219632206322163222632236322463225632266322763228632296323063231632326323363234632356323663237632386323963240632416324263243632446324563246632476324863249632506325163252632536325463255632566325763258632596326063261632626326363264632656326663267632686326963270632716327263273632746327563276632776327863279632806328163282632836328463285632866328763288632896329063291632926329363294632956329663297632986329963300633016330263303633046330563306633076330863309633106331163312633136331463315633166331763318633196332063321633226332363324633256332663327633286332963330633316333263333633346333563336633376333863339633406334163342633436334463345633466334763348633496335063351633526335363354633556335663357633586335963360633616336263363633646336563366633676336863369633706337163372633736337463375633766337763378633796338063381633826338363384633856338663387633886338963390633916339263393633946339563396633976339863399634006340163402634036340463405634066340763408634096341063411634126341363414634156341663417634186341963420634216342263423634246342563426634276342863429634306343163432634336343463435634366343763438634396344063441634426344363444634456344663447634486344963450634516345263453634546345563456634576345863459634606346163462634636346463465634666346763468634696347063471634726347363474634756347663477634786347963480634816348263483634846348563486634876348863489634906349163492634936349463495634966349763498634996350063501635026350363504635056350663507635086350963510635116351263513635146351563516635176351863519635206352163522635236352463525635266352763528635296353063531635326353363534635356353663537635386353963540635416354263543635446354563546635476354863549635506355163552635536355463555635566355763558635596356063561635626356363564635656356663567635686356963570635716357263573635746357563576635776357863579635806358163582635836358463585635866358763588635896359063591635926359363594635956359663597635986359963600636016360263603636046360563606636076360863609636106361163612636136361463615636166361763618636196362063621636226362363624636256362663627636286362963630636316363263633636346363563636636376363863639636406364163642636436364463645636466364763648636496365063651636526365363654636556365663657636586365963660636616366263663636646366563666636676366863669636706367163672636736367463675636766367763678636796368063681636826368363684636856368663687636886368963690636916369263693636946369563696636976369863699637006370163702637036370463705637066370763708637096371063711637126371363714637156371663717637186371963720637216372263723637246372563726637276372863729637306373163732637336373463735637366373763738637396374063741637426374363744637456374663747637486374963750637516375263753637546375563756637576375863759637606376163762637636376463765637666376763768637696377063771637726377363774637756377663777637786377963780637816378263783637846378563786637876378863789637906379163792637936379463795637966379763798637996380063801638026380363804638056380663807638086380963810638116381263813638146381563816638176381863819638206382163822638236382463825638266382763828638296383063831638326383363834638356383663837638386383963840638416384263843638446384563846638476384863849638506385163852638536385463855638566385763858638596386063861638626386363864638656386663867638686386963870638716387263873638746387563876638776387863879638806388163882638836388463885638866388763888638896389063891638926389363894638956389663897638986389963900639016390263903639046390563906639076390863909639106391163912639136391463915639166391763918639196392063921639226392363924639256392663927639286392963930639316393263933639346393563936639376393863939639406394163942639436394463945639466394763948639496395063951639526395363954639556395663957639586395963960639616396263963639646396563966639676396863969639706397163972639736397463975639766397763978639796398063981639826398363984639856398663987639886398963990639916399263993639946399563996639976399863999640006400164002640036400464005640066400764008640096401064011640126401364014640156401664017640186401964020640216402264023640246402564026640276402864029640306403164032640336403464035640366403764038640396404064041640426404364044640456404664047640486404964050640516405264053640546405564056640576405864059640606406164062640636406464065640666406764068640696407064071640726407364074640756407664077640786407964080640816408264083640846408564086640876408864089640906409164092640936409464095640966409764098640996410064101641026410364104641056410664107641086410964110641116411264113641146411564116641176411864119641206412164122641236412464125641266412764128641296413064131641326413364134641356413664137641386413964140641416414264143641446414564146641476414864149641506415164152641536415464155641566415764158641596416064161641626416364164641656416664167641686416964170641716417264173641746417564176641776417864179641806418164182641836418464185641866418764188641896419064191641926419364194641956419664197641986419964200642016420264203642046420564206642076420864209642106421164212642136421464215642166421764218642196422064221642226422364224642256422664227642286422964230642316423264233642346423564236642376423864239642406424164242642436424464245642466424764248642496425064251642526425364254642556425664257642586425964260642616426264263642646426564266642676426864269642706427164272642736427464275642766427764278642796428064281642826428364284642856428664287642886428964290642916429264293642946429564296642976429864299643006430164302643036430464305643066430764308643096431064311643126431364314643156431664317643186431964320643216432264323643246432564326643276432864329643306433164332643336433464335643366433764338643396434064341643426434364344643456434664347643486434964350643516435264353643546435564356643576435864359643606436164362643636436464365643666436764368643696437064371643726437364374643756437664377643786437964380643816438264383643846438564386643876438864389643906439164392643936439464395643966439764398643996440064401644026440364404644056440664407644086440964410644116441264413644146441564416644176441864419644206442164422644236442464425644266442764428644296443064431644326443364434644356443664437644386443964440644416444264443644446444564446644476444864449644506445164452644536445464455644566445764458644596446064461644626446364464644656446664467644686446964470644716447264473644746447564476644776447864479644806448164482644836448464485644866448764488644896449064491644926449364494644956449664497644986449964500645016450264503645046450564506645076450864509645106451164512645136451464515645166451764518645196452064521645226452364524645256452664527645286452964530645316453264533645346453564536645376453864539645406454164542645436454464545645466454764548645496455064551645526455364554645556455664557645586455964560645616456264563645646456564566645676456864569645706457164572645736457464575645766457764578645796458064581645826458364584645856458664587645886458964590645916459264593645946459564596645976459864599646006460164602646036460464605646066460764608646096461064611646126461364614646156461664617646186461964620646216462264623646246462564626646276462864629646306463164632646336463464635646366463764638646396464064641646426464364644646456464664647646486464964650646516465264653646546465564656646576465864659646606466164662646636466464665646666466764668646696467064671646726467364674646756467664677646786467964680646816468264683646846468564686646876468864689646906469164692646936469464695646966469764698646996470064701647026470364704647056470664707647086470964710647116471264713647146471564716647176471864719647206472164722647236472464725647266472764728647296473064731647326473364734647356473664737647386473964740647416474264743647446474564746647476474864749647506475164752647536475464755647566475764758647596476064761647626476364764647656476664767647686476964770647716477264773647746477564776647776477864779647806478164782647836478464785647866478764788647896479064791647926479364794647956479664797647986479964800648016480264803648046480564806648076480864809648106481164812648136481464815648166481764818648196482064821648226482364824648256482664827648286482964830648316483264833648346483564836648376483864839648406484164842648436484464845648466484764848648496485064851648526485364854648556485664857648586485964860648616486264863648646486564866648676486864869648706487164872648736487464875648766487764878648796488064881648826488364884648856488664887648886488964890648916489264893648946489564896648976489864899649006490164902649036490464905649066490764908649096491064911649126491364914649156491664917649186491964920649216492264923649246492564926649276492864929649306493164932649336493464935649366493764938649396494064941649426494364944649456494664947649486494964950649516495264953649546495564956649576495864959649606496164962649636496464965649666496764968649696497064971649726497364974649756497664977649786497964980649816498264983649846498564986649876498864989649906499164992649936499464995649966499764998649996500065001650026500365004650056500665007650086500965010650116501265013650146501565016650176501865019650206502165022650236502465025650266502765028650296503065031650326503365034650356503665037650386503965040650416504265043650446504565046650476504865049650506505165052650536505465055650566505765058650596506065061650626506365064650656506665067650686506965070650716507265073650746507565076650776507865079650806508165082650836508465085650866508765088650896509065091650926509365094650956509665097650986509965100651016510265103651046510565106651076510865109651106511165112651136511465115651166511765118651196512065121651226512365124651256512665127651286512965130651316513265133651346513565136651376513865139651406514165142651436514465145651466514765148651496515065151651526515365154651556515665157651586515965160651616516265163651646516565166651676516865169651706517165172651736517465175651766517765178651796518065181651826518365184651856518665187651886518965190651916519265193651946519565196651976519865199652006520165202652036520465205652066520765208652096521065211652126521365214652156521665217652186521965220652216522265223652246522565226652276522865229652306523165232652336523465235652366523765238652396524065241652426524365244652456524665247652486524965250652516525265253652546525565256652576525865259652606526165262652636526465265652666526765268652696527065271652726527365274652756527665277652786527965280652816528265283652846528565286652876528865289652906529165292652936529465295652966529765298652996530065301653026530365304653056530665307653086530965310653116531265313653146531565316653176531865319653206532165322653236532465325653266532765328653296533065331653326533365334653356533665337653386533965340653416534265343653446534565346653476534865349653506535165352653536535465355653566535765358653596536065361653626536365364653656536665367653686536965370653716537265373653746537565376653776537865379653806538165382653836538465385653866538765388653896539065391653926539365394653956539665397653986539965400654016540265403654046540565406654076540865409654106541165412654136541465415654166541765418654196542065421654226542365424654256542665427654286542965430654316543265433654346543565436654376543865439654406544165442654436544465445654466544765448654496545065451654526545365454654556545665457654586545965460654616546265463654646546565466654676546865469654706547165472654736547465475654766547765478654796548065481654826548365484654856548665487654886548965490654916549265493654946549565496654976549865499655006550165502655036550465505655066550765508655096551065511655126551365514655156551665517655186551965520655216552265523655246552565526655276552865529655306553165532655336553465535655366553765538655396554065541655426554365544655456554665547655486554965550655516555265553655546555565556655576555865559655606556165562655636556465565655666556765568655696557065571655726557365574655756557665577655786557965580655816558265583655846558565586655876558865589655906559165592655936559465595655966559765598655996560065601656026560365604656056560665607656086560965610656116561265613656146561565616656176561865619656206562165622656236562465625656266562765628656296563065631656326563365634656356563665637656386563965640656416564265643656446564565646656476564865649656506565165652656536565465655656566565765658656596566065661656626566365664656656566665667656686566965670656716567265673656746567565676656776567865679656806568165682656836568465685656866568765688656896569065691656926569365694656956569665697656986569965700657016570265703657046570565706657076570865709657106571165712657136571465715657166571765718657196572065721657226572365724657256572665727657286572965730657316573265733657346573565736657376573865739657406574165742657436574465745657466574765748657496575065751657526575365754657556575665757657586575965760657616576265763657646576565766657676576865769657706577165772657736577465775657766577765778657796578065781657826578365784657856578665787657886578965790657916579265793657946579565796657976579865799658006580165802658036580465805658066580765808658096581065811658126581365814658156581665817658186581965820658216582265823658246582565826658276582865829658306583165832658336583465835658366583765838658396584065841658426584365844658456584665847658486584965850658516585265853658546585565856658576585865859658606586165862658636586465865658666586765868658696587065871658726587365874658756587665877658786587965880658816588265883658846588565886658876588865889658906589165892658936589465895658966589765898658996590065901659026590365904659056590665907659086590965910659116591265913659146591565916659176591865919659206592165922659236592465925659266592765928659296593065931659326593365934659356593665937659386593965940659416594265943659446594565946659476594865949659506595165952659536595465955659566595765958659596596065961659626596365964659656596665967659686596965970659716597265973659746597565976659776597865979659806598165982659836598465985659866598765988659896599065991659926599365994659956599665997659986599966000660016600266003660046600566006660076600866009660106601166012660136601466015660166601766018660196602066021660226602366024660256602666027660286602966030660316603266033660346603566036660376603866039660406604166042660436604466045660466604766048660496605066051660526605366054660556605666057660586605966060660616606266063660646606566066660676606866069660706607166072660736607466075660766607766078660796608066081660826608366084660856608666087660886608966090660916609266093660946609566096660976609866099661006610166102661036610466105661066610766108661096611066111661126611366114661156611666117661186611966120661216612266123661246612566126661276612866129661306613166132661336613466135661366613766138661396614066141661426614366144661456614666147661486614966150661516615266153661546615566156661576615866159661606616166162661636616466165661666616766168661696617066171661726617366174661756617666177661786617966180661816618266183661846618566186661876618866189661906619166192661936619466195661966619766198661996620066201662026620366204662056620666207662086620966210662116621266213662146621566216662176621866219662206622166222662236622466225662266622766228662296623066231662326623366234662356623666237662386623966240662416624266243662446624566246662476624866249662506625166252662536625466255662566625766258662596626066261662626626366264662656626666267662686626966270662716627266273662746627566276662776627866279662806628166282662836628466285662866628766288662896629066291662926629366294662956629666297662986629966300663016630266303663046630566306663076630866309663106631166312663136631466315663166631766318663196632066321663226632366324663256632666327663286632966330663316633266333663346633566336663376633866339663406634166342663436634466345663466634766348663496635066351663526635366354663556635666357663586635966360663616636266363663646636566366663676636866369663706637166372663736637466375663766637766378663796638066381663826638366384663856638666387663886638966390663916639266393663946639566396663976639866399664006640166402664036640466405664066640766408664096641066411664126641366414664156641666417664186641966420664216642266423664246642566426664276642866429664306643166432664336643466435664366643766438664396644066441664426644366444664456644666447664486644966450664516645266453664546645566456664576645866459664606646166462664636646466465664666646766468664696647066471664726647366474664756647666477664786647966480664816648266483664846648566486664876648866489664906649166492664936649466495664966649766498664996650066501665026650366504665056650666507665086650966510665116651266513665146651566516665176651866519665206652166522665236652466525665266652766528665296653066531665326653366534665356653666537665386653966540665416654266543665446654566546665476654866549665506655166552665536655466555665566655766558665596656066561665626656366564665656656666567665686656966570665716657266573665746657566576665776657866579665806658166582665836658466585665866658766588665896659066591665926659366594665956659666597665986659966600666016660266603666046660566606666076660866609666106661166612666136661466615666166661766618666196662066621666226662366624666256662666627666286662966630666316663266633666346663566636666376663866639666406664166642666436664466645666466664766648666496665066651666526665366654666556665666657666586665966660666616666266663666646666566666666676666866669666706667166672666736667466675666766667766678666796668066681666826668366684666856668666687666886668966690666916669266693666946669566696666976669866699667006670166702667036670466705667066670766708667096671066711667126671366714667156671666717667186671966720667216672266723667246672566726667276672866729667306673166732667336673466735667366673766738667396674066741667426674366744667456674666747667486674966750667516675266753667546675566756667576675866759667606676166762667636676466765667666676766768667696677066771667726677366774667756677666777667786677966780667816678266783667846678566786667876678866789667906679166792667936679466795667966679766798667996680066801668026680366804668056680666807668086680966810668116681266813668146681566816668176681866819668206682166822668236682466825668266682766828668296683066831668326683366834668356683666837668386683966840668416684266843668446684566846668476684866849668506685166852668536685466855668566685766858668596686066861668626686366864668656686666867668686686966870668716687266873668746687566876668776687866879668806688166882668836688466885668866688766888668896689066891668926689366894668956689666897668986689966900669016690266903669046690566906669076690866909669106691166912669136691466915669166691766918669196692066921669226692366924669256692666927669286692966930669316693266933669346693566936669376693866939669406694166942669436694466945669466694766948669496695066951669526695366954669556695666957669586695966960669616696266963669646696566966669676696866969669706697166972669736697466975669766697766978669796698066981669826698366984669856698666987669886698966990669916699266993669946699566996669976699866999670006700167002670036700467005670066700767008670096701067011670126701367014670156701667017670186701967020670216702267023670246702567026670276702867029670306703167032670336703467035670366703767038670396704067041670426704367044670456704667047670486704967050670516705267053670546705567056670576705867059670606706167062670636706467065670666706767068670696707067071670726707367074670756707667077670786707967080670816708267083670846708567086670876708867089670906709167092670936709467095670966709767098670996710067101671026710367104671056710667107671086710967110671116711267113671146711567116671176711867119671206712167122671236712467125671266712767128671296713067131671326713367134671356713667137671386713967140671416714267143671446714567146671476714867149671506715167152671536715467155671566715767158671596716067161671626716367164671656716667167671686716967170671716717267173671746717567176671776717867179671806718167182671836718467185671866718767188671896719067191671926719367194671956719667197671986719967200672016720267203672046720567206672076720867209672106721167212672136721467215672166721767218672196722067221672226722367224672256722667227672286722967230672316723267233672346723567236672376723867239672406724167242672436724467245672466724767248672496725067251672526725367254672556725667257672586725967260672616726267263672646726567266672676726867269672706727167272672736727467275672766727767278672796728067281672826728367284672856728667287672886728967290672916729267293672946729567296672976729867299673006730167302673036730467305673066730767308673096731067311673126731367314673156731667317673186731967320673216732267323673246732567326673276732867329673306733167332673336733467335673366733767338673396734067341673426734367344673456734667347673486734967350673516735267353673546735567356673576735867359673606736167362673636736467365673666736767368673696737067371673726737367374673756737667377673786737967380673816738267383673846738567386673876738867389673906739167392673936739467395673966739767398673996740067401674026740367404674056740667407674086740967410674116741267413674146741567416674176741867419674206742167422674236742467425674266742767428674296743067431674326743367434674356743667437674386743967440674416744267443674446744567446674476744867449674506745167452674536745467455674566745767458674596746067461674626746367464674656746667467674686746967470674716747267473674746747567476674776747867479674806748167482674836748467485674866748767488674896749067491674926749367494674956749667497674986749967500675016750267503675046750567506675076750867509675106751167512675136751467515675166751767518675196752067521675226752367524675256752667527675286752967530675316753267533675346753567536675376753867539675406754167542675436754467545675466754767548675496755067551675526755367554675556755667557675586755967560675616756267563675646756567566675676756867569675706757167572675736757467575675766757767578675796758067581675826758367584675856758667587675886758967590675916759267593675946759567596675976759867599676006760167602676036760467605676066760767608676096761067611676126761367614676156761667617676186761967620676216762267623676246762567626676276762867629676306763167632676336763467635676366763767638676396764067641676426764367644676456764667647676486764967650676516765267653676546765567656676576765867659676606766167662676636766467665676666766767668676696767067671676726767367674676756767667677676786767967680676816768267683676846768567686676876768867689676906769167692676936769467695676966769767698676996770067701677026770367704677056770667707677086770967710677116771267713677146771567716677176771867719677206772167722677236772467725677266772767728677296773067731677326773367734677356773667737677386773967740677416774267743677446774567746677476774867749677506775167752677536775467755677566775767758677596776067761677626776367764677656776667767677686776967770677716777267773677746777567776677776777867779677806778167782677836778467785677866778767788677896779067791677926779367794677956779667797677986779967800678016780267803678046780567806678076780867809678106781167812678136781467815678166781767818678196782067821678226782367824678256782667827678286782967830678316783267833678346783567836678376783867839678406784167842678436784467845678466784767848678496785067851678526785367854678556785667857678586785967860678616786267863678646786567866678676786867869678706787167872678736787467875678766787767878678796788067881678826788367884678856788667887678886788967890678916789267893678946789567896678976789867899679006790167902679036790467905679066790767908679096791067911679126791367914679156791667917679186791967920679216792267923679246792567926679276792867929679306793167932679336793467935679366793767938679396794067941679426794367944679456794667947679486794967950679516795267953679546795567956679576795867959679606796167962679636796467965679666796767968679696797067971679726797367974679756797667977679786797967980679816798267983679846798567986679876798867989679906799167992679936799467995679966799767998679996800068001680026800368004680056800668007680086800968010680116801268013680146801568016680176801868019680206802168022680236802468025680266802768028680296803068031680326803368034680356803668037680386803968040680416804268043680446804568046680476804868049680506805168052680536805468055680566805768058680596806068061680626806368064680656806668067680686806968070680716807268073680746807568076680776807868079680806808168082680836808468085680866808768088680896809068091680926809368094680956809668097680986809968100681016810268103681046810568106681076810868109681106811168112681136811468115681166811768118681196812068121681226812368124681256812668127681286812968130681316813268133681346813568136681376813868139681406814168142681436814468145681466814768148681496815068151681526815368154681556815668157681586815968160681616816268163681646816568166681676816868169681706817168172681736817468175681766817768178681796818068181681826818368184681856818668187681886818968190681916819268193681946819568196681976819868199682006820168202682036820468205682066820768208682096821068211682126821368214682156821668217682186821968220682216822268223682246822568226682276822868229682306823168232682336823468235682366823768238682396824068241682426824368244682456824668247682486824968250682516825268253682546825568256682576825868259682606826168262682636826468265682666826768268682696827068271682726827368274682756827668277682786827968280682816828268283682846828568286682876828868289682906829168292682936829468295682966829768298682996830068301683026830368304683056830668307683086830968310683116831268313683146831568316683176831868319683206832168322683236832468325683266832768328683296833068331683326833368334683356833668337683386833968340683416834268343683446834568346683476834868349683506835168352683536835468355683566835768358683596836068361683626836368364683656836668367683686836968370683716837268373683746837568376683776837868379683806838168382683836838468385683866838768388683896839068391683926839368394683956839668397683986839968400684016840268403684046840568406684076840868409684106841168412684136841468415684166841768418684196842068421684226842368424684256842668427684286842968430684316843268433684346843568436684376843868439684406844168442684436844468445684466844768448684496845068451684526845368454684556845668457684586845968460684616846268463684646846568466684676846868469684706847168472684736847468475684766847768478684796848068481684826848368484684856848668487684886848968490684916849268493684946849568496684976849868499685006850168502685036850468505685066850768508685096851068511685126851368514685156851668517685186851968520685216852268523685246852568526685276852868529685306853168532685336853468535685366853768538685396854068541685426854368544685456854668547685486854968550685516855268553685546855568556685576855868559685606856168562685636856468565685666856768568685696857068571685726857368574685756857668577685786857968580685816858268583685846858568586685876858868589685906859168592685936859468595685966859768598685996860068601686026860368604686056860668607686086860968610686116861268613686146861568616686176861868619686206862168622686236862468625686266862768628686296863068631686326863368634686356863668637686386863968640686416864268643686446864568646686476864868649686506865168652686536865468655686566865768658686596866068661686626866368664686656866668667686686866968670686716867268673686746867568676686776867868679686806868168682686836868468685686866868768688686896869068691686926869368694686956869668697686986869968700687016870268703687046870568706687076870868709687106871168712687136871468715687166871768718687196872068721687226872368724687256872668727687286872968730687316873268733687346873568736687376873868739687406874168742687436874468745687466874768748687496875068751687526875368754687556875668757687586875968760687616876268763687646876568766687676876868769687706877168772687736877468775687766877768778687796878068781687826878368784687856878668787687886878968790687916879268793687946879568796687976879868799688006880168802688036880468805688066880768808688096881068811688126881368814688156881668817688186881968820688216882268823688246882568826688276882868829688306883168832688336883468835688366883768838688396884068841688426884368844688456884668847688486884968850688516885268853688546885568856688576885868859688606886168862688636886468865688666886768868688696887068871688726887368874688756887668877688786887968880688816888268883688846888568886688876888868889688906889168892688936889468895688966889768898688996890068901689026890368904689056890668907689086890968910689116891268913689146891568916689176891868919689206892168922689236892468925689266892768928689296893068931689326893368934689356893668937689386893968940689416894268943689446894568946689476894868949689506895168952689536895468955689566895768958689596896068961689626896368964689656896668967689686896968970689716897268973689746897568976689776897868979689806898168982689836898468985689866898768988689896899068991689926899368994689956899668997689986899969000690016900269003690046900569006690076900869009690106901169012690136901469015690166901769018690196902069021690226902369024690256902669027690286902969030690316903269033690346903569036690376903869039690406904169042690436904469045690466904769048690496905069051690526905369054690556905669057690586905969060690616906269063690646906569066690676906869069690706907169072690736907469075690766907769078690796908069081690826908369084690856908669087690886908969090690916909269093690946909569096690976909869099691006910169102691036910469105691066910769108691096911069111691126911369114691156911669117691186911969120691216912269123691246912569126691276912869129691306913169132691336913469135691366913769138691396914069141691426914369144691456914669147691486914969150691516915269153691546915569156691576915869159691606916169162691636916469165691666916769168691696917069171691726917369174691756917669177691786917969180691816918269183691846918569186691876918869189691906919169192691936919469195691966919769198691996920069201692026920369204692056920669207692086920969210692116921269213692146921569216692176921869219692206922169222692236922469225692266922769228692296923069231692326923369234692356923669237692386923969240692416924269243692446924569246692476924869249692506925169252692536925469255692566925769258692596926069261692626926369264692656926669267692686926969270692716927269273692746927569276692776927869279692806928169282692836928469285692866928769288692896929069291692926929369294692956929669297692986929969300693016930269303693046930569306693076930869309693106931169312693136931469315693166931769318693196932069321693226932369324693256932669327693286932969330693316933269333693346933569336693376933869339693406934169342693436934469345693466934769348693496935069351693526935369354693556935669357693586935969360693616936269363693646936569366693676936869369693706937169372693736937469375693766937769378693796938069381693826938369384693856938669387693886938969390693916939269393693946939569396693976939869399694006940169402694036940469405694066940769408694096941069411694126941369414694156941669417694186941969420694216942269423694246942569426694276942869429694306943169432694336943469435694366943769438694396944069441694426944369444694456944669447694486944969450694516945269453694546945569456694576945869459694606946169462694636946469465694666946769468694696947069471694726947369474694756947669477694786947969480694816948269483694846948569486694876948869489694906949169492694936949469495694966949769498694996950069501695026950369504695056950669507695086950969510695116951269513695146951569516695176951869519695206952169522695236952469525695266952769528695296953069531695326953369534695356953669537695386953969540695416954269543695446954569546695476954869549695506955169552695536955469555695566955769558695596956069561695626956369564695656956669567695686956969570695716957269573695746957569576695776957869579695806958169582695836958469585695866958769588695896959069591695926959369594695956959669597695986959969600696016960269603696046960569606696076960869609696106961169612696136961469615696166961769618696196962069621696226962369624696256962669627696286962969630696316963269633696346963569636696376963869639696406964169642696436964469645696466964769648696496965069651696526965369654696556965669657696586965969660696616966269663696646966569666696676966869669696706967169672696736967469675696766967769678696796968069681696826968369684696856968669687696886968969690696916969269693696946969569696696976969869699697006970169702697036970469705697066970769708697096971069711697126971369714697156971669717697186971969720697216972269723697246972569726697276972869729697306973169732697336973469735697366973769738697396974069741697426974369744697456974669747697486974969750697516975269753697546975569756697576975869759697606976169762697636976469765697666976769768697696977069771697726977369774697756977669777697786977969780697816978269783697846978569786697876978869789697906979169792697936979469795697966979769798697996980069801698026980369804698056980669807698086980969810698116981269813698146981569816698176981869819698206982169822698236982469825698266982769828698296983069831698326983369834698356983669837698386983969840698416984269843698446984569846698476984869849698506985169852698536985469855698566985769858698596986069861698626986369864698656986669867698686986969870698716987269873698746987569876698776987869879698806988169882698836988469885698866988769888698896989069891698926989369894698956989669897698986989969900699016990269903699046990569906699076990869909699106991169912699136991469915699166991769918699196992069921699226992369924699256992669927699286992969930699316993269933699346993569936699376993869939699406994169942699436994469945699466994769948699496995069951699526995369954699556995669957699586995969960699616996269963699646996569966699676996869969699706997169972699736997469975699766997769978699796998069981699826998369984699856998669987699886998969990699916999269993699946999569996699976999869999700007000170002700037000470005700067000770008700097001070011700127001370014700157001670017700187001970020700217002270023700247002570026700277002870029700307003170032700337003470035700367003770038700397004070041700427004370044700457004670047700487004970050700517005270053700547005570056700577005870059700607006170062700637006470065700667006770068700697007070071700727007370074700757007670077700787007970080700817008270083700847008570086700877008870089700907009170092700937009470095700967009770098700997010070101701027010370104701057010670107701087010970110701117011270113701147011570116701177011870119701207012170122701237012470125701267012770128701297013070131701327013370134701357013670137701387013970140701417014270143701447014570146701477014870149701507015170152701537015470155701567015770158701597016070161701627016370164701657016670167701687016970170701717017270173701747017570176701777017870179701807018170182701837018470185701867018770188701897019070191701927019370194701957019670197701987019970200702017020270203702047020570206702077020870209702107021170212702137021470215702167021770218702197022070221702227022370224702257022670227702287022970230702317023270233702347023570236702377023870239702407024170242702437024470245702467024770248702497025070251702527025370254702557025670257702587025970260702617026270263702647026570266702677026870269702707027170272702737027470275702767027770278702797028070281702827028370284702857028670287702887028970290702917029270293702947029570296702977029870299703007030170302703037030470305703067030770308703097031070311703127031370314703157031670317703187031970320703217032270323703247032570326703277032870329703307033170332703337033470335703367033770338703397034070341703427034370344703457034670347703487034970350703517035270353703547035570356703577035870359703607036170362703637036470365703667036770368703697037070371703727037370374703757037670377703787037970380703817038270383703847038570386703877038870389703907039170392703937039470395703967039770398703997040070401704027040370404704057040670407704087040970410704117041270413704147041570416704177041870419704207042170422704237042470425704267042770428704297043070431704327043370434704357043670437704387043970440704417044270443704447044570446704477044870449704507045170452704537045470455704567045770458704597046070461704627046370464704657046670467704687046970470704717047270473704747047570476704777047870479704807048170482704837048470485704867048770488704897049070491704927049370494704957049670497704987049970500705017050270503705047050570506705077050870509705107051170512705137051470515705167051770518705197052070521705227052370524705257052670527705287052970530705317053270533705347053570536705377053870539705407054170542705437054470545705467054770548705497055070551705527055370554705557055670557705587055970560705617056270563705647056570566705677056870569705707057170572705737057470575705767057770578705797058070581705827058370584705857058670587705887058970590705917059270593705947059570596705977059870599706007060170602706037060470605706067060770608706097061070611706127061370614706157061670617706187061970620706217062270623706247062570626706277062870629706307063170632706337063470635706367063770638706397064070641706427064370644706457064670647706487064970650706517065270653706547065570656706577065870659706607066170662706637066470665706667066770668706697067070671706727067370674706757067670677706787067970680706817068270683706847068570686706877068870689706907069170692706937069470695706967069770698706997070070701707027070370704707057070670707707087070970710707117071270713707147071570716707177071870719707207072170722707237072470725707267072770728707297073070731707327073370734707357073670737707387073970740707417074270743707447074570746707477074870749707507075170752707537075470755707567075770758707597076070761707627076370764707657076670767707687076970770707717077270773707747077570776707777077870779707807078170782707837078470785707867078770788707897079070791707927079370794707957079670797707987079970800708017080270803708047080570806708077080870809708107081170812708137081470815708167081770818708197082070821708227082370824708257082670827708287082970830708317083270833708347083570836708377083870839708407084170842708437084470845708467084770848708497085070851708527085370854708557085670857708587085970860708617086270863708647086570866708677086870869708707087170872708737087470875708767087770878708797088070881708827088370884708857088670887708887088970890708917089270893708947089570896708977089870899709007090170902709037090470905709067090770908709097091070911709127091370914709157091670917709187091970920709217092270923709247092570926709277092870929709307093170932709337093470935709367093770938709397094070941709427094370944709457094670947709487094970950709517095270953709547095570956709577095870959709607096170962709637096470965709667096770968709697097070971709727097370974709757097670977709787097970980709817098270983709847098570986709877098870989709907099170992709937099470995709967099770998709997100071001710027100371004710057100671007710087100971010710117101271013710147101571016710177101871019710207102171022710237102471025710267102771028710297103071031710327103371034710357103671037710387103971040710417104271043710447104571046710477104871049710507105171052710537105471055710567105771058710597106071061710627106371064710657106671067710687106971070710717107271073710747107571076710777107871079710807108171082710837108471085710867108771088710897109071091710927109371094710957109671097710987109971100711017110271103711047110571106711077110871109711107111171112711137111471115711167111771118711197112071121711227112371124711257112671127711287112971130711317113271133711347113571136711377113871139711407114171142711437114471145711467114771148711497115071151711527115371154711557115671157711587115971160711617116271163711647116571166711677116871169711707117171172711737117471175711767117771178711797118071181711827118371184711857118671187711887118971190711917119271193711947119571196711977119871199712007120171202712037120471205712067120771208712097121071211712127121371214712157121671217712187121971220712217122271223712247122571226712277122871229712307123171232712337123471235712367123771238712397124071241712427124371244712457124671247712487124971250712517125271253712547125571256712577125871259712607126171262712637126471265712667126771268712697127071271712727127371274712757127671277712787127971280712817128271283712847128571286712877128871289712907129171292712937129471295712967129771298712997130071301713027130371304713057130671307713087130971310713117131271313713147131571316713177131871319713207132171322713237132471325713267132771328713297133071331713327133371334713357133671337713387133971340713417134271343713447134571346713477134871349713507135171352713537135471355713567135771358713597136071361713627136371364713657136671367713687136971370713717137271373713747137571376713777137871379713807138171382713837138471385713867138771388713897139071391713927139371394713957139671397713987139971400714017140271403714047140571406714077140871409714107141171412714137141471415714167141771418714197142071421714227142371424714257142671427714287142971430714317143271433714347143571436714377143871439714407144171442714437144471445714467144771448714497145071451714527145371454714557145671457714587145971460714617146271463714647146571466714677146871469714707147171472714737147471475714767147771478714797148071481714827148371484714857148671487714887148971490714917149271493714947149571496714977149871499715007150171502715037150471505715067150771508715097151071511715127151371514715157151671517715187151971520715217152271523715247152571526715277152871529715307153171532715337153471535715367153771538715397154071541715427154371544715457154671547715487154971550715517155271553715547155571556715577155871559715607156171562715637156471565715667156771568715697157071571715727157371574715757157671577715787157971580715817158271583715847158571586715877158871589715907159171592715937159471595715967159771598715997160071601716027160371604716057160671607716087160971610716117161271613716147161571616716177161871619716207162171622716237162471625716267162771628716297163071631716327163371634716357163671637716387163971640716417164271643716447164571646716477164871649716507165171652716537165471655716567165771658716597166071661716627166371664716657166671667716687166971670716717167271673716747167571676716777167871679716807168171682716837168471685716867168771688716897169071691716927169371694716957169671697716987169971700717017170271703717047170571706717077170871709717107171171712717137171471715717167171771718717197172071721717227172371724717257172671727717287172971730717317173271733717347173571736717377173871739717407174171742717437174471745717467174771748717497175071751717527175371754717557175671757717587175971760717617176271763717647176571766717677176871769717707177171772717737177471775717767177771778717797178071781717827178371784717857178671787717887178971790717917179271793717947179571796717977179871799718007180171802718037180471805718067180771808718097181071811718127181371814718157181671817718187181971820718217182271823718247182571826718277182871829718307183171832718337183471835718367183771838718397184071841718427184371844718457184671847718487184971850718517185271853718547185571856718577185871859718607186171862718637186471865718667186771868718697187071871718727187371874718757187671877718787187971880718817188271883718847188571886718877188871889718907189171892718937189471895718967189771898718997190071901719027190371904719057190671907719087190971910719117191271913719147191571916719177191871919719207192171922719237192471925719267192771928719297193071931719327193371934719357193671937719387193971940719417194271943719447194571946719477194871949719507195171952719537195471955719567195771958719597196071961719627196371964719657196671967719687196971970719717197271973719747197571976719777197871979719807198171982719837198471985719867198771988719897199071991719927199371994719957199671997719987199972000720017200272003720047200572006720077200872009720107201172012720137201472015720167201772018720197202072021720227202372024720257202672027720287202972030720317203272033720347203572036720377203872039720407204172042720437204472045720467204772048720497205072051720527205372054720557205672057720587205972060720617206272063720647206572066720677206872069720707207172072720737207472075720767207772078720797208072081720827208372084720857208672087720887208972090720917209272093720947209572096720977209872099721007210172102721037210472105721067210772108721097211072111721127211372114721157211672117721187211972120721217212272123721247212572126721277212872129721307213172132721337213472135721367213772138721397214072141721427214372144721457214672147721487214972150721517215272153721547215572156721577215872159721607216172162721637216472165721667216772168721697217072171721727217372174721757217672177721787217972180721817218272183721847218572186721877218872189721907219172192721937219472195721967219772198721997220072201722027220372204722057220672207722087220972210722117221272213722147221572216722177221872219722207222172222722237222472225722267222772228722297223072231722327223372234722357223672237722387223972240722417224272243722447224572246722477224872249722507225172252722537225472255722567225772258722597226072261722627226372264722657226672267722687226972270722717227272273722747227572276722777227872279722807228172282722837228472285722867228772288722897229072291722927229372294722957229672297722987229972300723017230272303723047230572306723077230872309723107231172312723137231472315723167231772318723197232072321723227232372324723257232672327723287232972330723317233272333723347233572336723377233872339723407234172342723437234472345723467234772348723497235072351723527235372354723557235672357723587235972360723617236272363723647236572366723677236872369723707237172372723737237472375723767237772378723797238072381723827238372384723857238672387723887238972390723917239272393723947239572396723977239872399724007240172402724037240472405724067240772408724097241072411724127241372414724157241672417724187241972420724217242272423724247242572426724277242872429724307243172432724337243472435724367243772438724397244072441724427244372444724457244672447724487244972450724517245272453724547245572456724577245872459724607246172462724637246472465724667246772468724697247072471724727247372474724757247672477724787247972480724817248272483724847248572486724877248872489724907249172492724937249472495724967249772498724997250072501725027250372504725057250672507725087250972510725117251272513725147251572516725177251872519725207252172522725237252472525725267252772528725297253072531725327253372534725357253672537725387253972540725417254272543725447254572546725477254872549725507255172552725537255472555725567255772558725597256072561725627256372564725657256672567725687256972570725717257272573725747257572576725777257872579725807258172582725837258472585725867258772588725897259072591725927259372594725957259672597725987259972600726017260272603726047260572606726077260872609726107261172612726137261472615726167261772618726197262072621726227262372624726257262672627726287262972630726317263272633726347263572636726377263872639726407264172642726437264472645726467264772648726497265072651726527265372654726557265672657726587265972660726617266272663726647266572666726677266872669726707267172672726737267472675726767267772678726797268072681726827268372684726857268672687726887268972690726917269272693726947269572696726977269872699727007270172702727037270472705727067270772708727097271072711727127271372714727157271672717727187271972720727217272272723727247272572726727277272872729727307273172732727337273472735727367273772738727397274072741727427274372744727457274672747727487274972750727517275272753727547275572756727577275872759727607276172762727637276472765727667276772768727697277072771727727277372774727757277672777727787277972780727817278272783727847278572786727877278872789727907279172792727937279472795727967279772798727997280072801728027280372804728057280672807728087280972810728117281272813728147281572816728177281872819728207282172822728237282472825728267282772828728297283072831728327283372834728357283672837728387283972840728417284272843728447284572846728477284872849728507285172852728537285472855728567285772858728597286072861728627286372864728657286672867728687286972870728717287272873728747287572876728777287872879728807288172882728837288472885728867288772888728897289072891728927289372894728957289672897728987289972900729017290272903729047290572906729077290872909729107291172912729137291472915729167291772918729197292072921729227292372924729257292672927729287292972930729317293272933729347293572936729377293872939729407294172942729437294472945729467294772948729497295072951729527295372954729557295672957729587295972960729617296272963729647296572966729677296872969729707297172972729737297472975729767297772978729797298072981729827298372984729857298672987729887298972990729917299272993729947299572996729977299872999730007300173002730037300473005730067300773008730097301073011730127301373014730157301673017730187301973020730217302273023730247302573026730277302873029730307303173032730337303473035730367303773038730397304073041730427304373044730457304673047730487304973050730517305273053730547305573056730577305873059730607306173062730637306473065730667306773068730697307073071730727307373074730757307673077730787307973080730817308273083730847308573086730877308873089730907309173092730937309473095730967309773098730997310073101731027310373104731057310673107731087310973110731117311273113731147311573116731177311873119731207312173122731237312473125731267312773128731297313073131731327313373134731357313673137731387313973140731417314273143731447314573146731477314873149731507315173152731537315473155731567315773158731597316073161731627316373164731657316673167731687316973170731717317273173731747317573176731777317873179731807318173182731837318473185731867318773188731897319073191731927319373194731957319673197731987319973200732017320273203732047320573206732077320873209732107321173212732137321473215732167321773218732197322073221732227322373224732257322673227732287322973230732317323273233732347323573236732377323873239732407324173242732437324473245732467324773248732497325073251732527325373254732557325673257732587325973260732617326273263732647326573266732677326873269732707327173272732737327473275732767327773278732797328073281732827328373284732857328673287732887328973290732917329273293732947329573296732977329873299733007330173302733037330473305733067330773308733097331073311733127331373314733157331673317733187331973320733217332273323733247332573326733277332873329733307333173332733337333473335733367333773338733397334073341733427334373344733457334673347733487334973350733517335273353733547335573356733577335873359733607336173362733637336473365733667336773368733697337073371733727337373374733757337673377733787337973380733817338273383733847338573386733877338873389733907339173392733937339473395733967339773398733997340073401734027340373404734057340673407734087340973410734117341273413734147341573416734177341873419734207342173422734237342473425734267342773428734297343073431734327343373434734357343673437734387343973440734417344273443734447344573446734477344873449734507345173452734537345473455734567345773458734597346073461734627346373464734657346673467734687346973470734717347273473734747347573476734777347873479734807348173482734837348473485734867348773488734897349073491734927349373494734957349673497734987349973500735017350273503735047350573506735077350873509735107351173512735137351473515735167351773518735197352073521735227352373524735257352673527735287352973530735317353273533735347353573536735377353873539735407354173542735437354473545735467354773548735497355073551735527355373554735557355673557735587355973560735617356273563735647356573566735677356873569735707357173572735737357473575735767357773578735797358073581735827358373584735857358673587735887358973590735917359273593735947359573596735977359873599736007360173602736037360473605736067360773608736097361073611736127361373614736157361673617736187361973620736217362273623736247362573626736277362873629736307363173632736337363473635736367363773638736397364073641736427364373644736457364673647736487364973650736517365273653736547365573656736577365873659736607366173662736637366473665736667366773668736697367073671736727367373674736757367673677736787367973680736817368273683736847368573686736877368873689736907369173692736937369473695736967369773698736997370073701737027370373704737057370673707737087370973710737117371273713737147371573716737177371873719737207372173722737237372473725737267372773728737297373073731737327373373734737357373673737737387373973740737417374273743737447374573746737477374873749737507375173752737537375473755737567375773758737597376073761737627376373764737657376673767737687376973770737717377273773737747377573776737777377873779737807378173782737837378473785737867378773788737897379073791737927379373794737957379673797737987379973800738017380273803738047380573806738077380873809738107381173812738137381473815738167381773818738197382073821738227382373824738257382673827738287382973830738317383273833738347383573836738377383873839738407384173842738437384473845738467384773848738497385073851738527385373854738557385673857738587385973860738617386273863738647386573866738677386873869738707387173872738737387473875738767387773878738797388073881738827388373884738857388673887738887388973890738917389273893738947389573896738977389873899739007390173902739037390473905739067390773908739097391073911739127391373914739157391673917739187391973920739217392273923739247392573926739277392873929739307393173932739337393473935739367393773938739397394073941739427394373944739457394673947739487394973950739517395273953739547395573956739577395873959739607396173962739637396473965739667396773968739697397073971739727397373974739757397673977739787397973980739817398273983739847398573986739877398873989739907399173992739937399473995739967399773998739997400074001740027400374004740057400674007740087400974010740117401274013740147401574016740177401874019740207402174022740237402474025740267402774028740297403074031740327403374034740357403674037740387403974040740417404274043740447404574046740477404874049740507405174052740537405474055740567405774058740597406074061740627406374064740657406674067740687406974070740717407274073740747407574076740777407874079740807408174082740837408474085740867408774088740897409074091740927409374094740957409674097740987409974100741017410274103741047410574106741077410874109741107411174112741137411474115741167411774118741197412074121741227412374124741257412674127741287412974130741317413274133741347413574136741377413874139741407414174142741437414474145741467414774148741497415074151741527415374154741557415674157741587415974160741617416274163741647416574166741677416874169741707417174172741737417474175741767417774178741797418074181741827418374184741857418674187741887418974190741917419274193741947419574196741977419874199742007420174202742037420474205742067420774208742097421074211742127421374214742157421674217742187421974220742217422274223742247422574226742277422874229742307423174232742337423474235742367423774238742397424074241742427424374244742457424674247742487424974250742517425274253742547425574256742577425874259742607426174262742637426474265742667426774268742697427074271742727427374274742757427674277742787427974280742817428274283742847428574286742877428874289742907429174292742937429474295742967429774298742997430074301743027430374304743057430674307743087430974310743117431274313743147431574316743177431874319743207432174322743237432474325743267432774328743297433074331743327433374334743357433674337743387433974340743417434274343743447434574346743477434874349743507435174352743537435474355743567435774358743597436074361743627436374364743657436674367743687436974370743717437274373743747437574376743777437874379743807438174382743837438474385743867438774388743897439074391743927439374394743957439674397743987439974400744017440274403744047440574406744077440874409744107441174412744137441474415744167441774418744197442074421744227442374424744257442674427744287442974430744317443274433744347443574436744377443874439744407444174442744437444474445744467444774448744497445074451744527445374454744557445674457744587445974460744617446274463744647446574466744677446874469744707447174472744737447474475744767447774478744797448074481744827448374484744857448674487744887448974490744917449274493744947449574496744977449874499745007450174502745037450474505745067450774508745097451074511745127451374514745157451674517745187451974520745217452274523745247452574526745277452874529745307453174532745337453474535745367453774538745397454074541745427454374544745457454674547745487454974550745517455274553745547455574556745577455874559745607456174562745637456474565745667456774568745697457074571745727457374574745757457674577745787457974580745817458274583745847458574586745877458874589745907459174592745937459474595745967459774598745997460074601746027460374604746057460674607746087460974610746117461274613746147461574616746177461874619746207462174622746237462474625746267462774628746297463074631746327463374634746357463674637746387463974640746417464274643746447464574646746477464874649746507465174652746537465474655746567465774658746597466074661746627466374664746657466674667746687466974670746717467274673746747467574676746777467874679746807468174682746837468474685746867468774688746897469074691746927469374694746957469674697746987469974700747017470274703747047470574706747077470874709747107471174712747137471474715747167471774718747197472074721747227472374724747257472674727747287472974730747317473274733747347473574736747377473874739747407474174742747437474474745747467474774748747497475074751747527475374754747557475674757747587475974760747617476274763747647476574766747677476874769747707477174772747737477474775747767477774778747797478074781747827478374784747857478674787747887478974790747917479274793747947479574796747977479874799748007480174802748037480474805748067480774808748097481074811748127481374814748157481674817748187481974820748217482274823748247482574826748277482874829748307483174832748337483474835748367483774838748397484074841748427484374844748457484674847748487484974850748517485274853748547485574856748577485874859748607486174862748637486474865748667486774868748697487074871748727487374874748757487674877748787487974880748817488274883748847488574886748877488874889748907489174892748937489474895748967489774898748997490074901749027490374904749057490674907749087490974910749117491274913749147491574916749177491874919749207492174922749237492474925749267492774928749297493074931749327493374934749357493674937749387493974940749417494274943749447494574946749477494874949749507495174952749537495474955749567495774958749597496074961749627496374964749657496674967749687496974970749717497274973749747497574976749777497874979749807498174982749837498474985749867498774988749897499074991749927499374994749957499674997749987499975000750017500275003750047500575006750077500875009750107501175012750137501475015750167501775018750197502075021750227502375024750257502675027750287502975030750317503275033750347503575036750377503875039750407504175042750437504475045750467504775048750497505075051750527505375054750557505675057750587505975060750617506275063750647506575066750677506875069750707507175072750737507475075750767507775078750797508075081750827508375084750857508675087750887508975090750917509275093750947509575096750977509875099751007510175102751037510475105751067510775108751097511075111751127511375114751157511675117751187511975120751217512275123751247512575126751277512875129751307513175132751337513475135751367513775138751397514075141751427514375144751457514675147751487514975150751517515275153751547515575156751577515875159751607516175162751637516475165751667516775168751697517075171751727517375174751757517675177751787517975180751817518275183751847518575186751877518875189751907519175192751937519475195751967519775198751997520075201752027520375204752057520675207752087520975210752117521275213752147521575216752177521875219752207522175222752237522475225752267522775228752297523075231752327523375234752357523675237752387523975240752417524275243752447524575246752477524875249752507525175252752537525475255752567525775258752597526075261752627526375264752657526675267752687526975270752717527275273752747527575276752777527875279752807528175282752837528475285752867528775288752897529075291752927529375294752957529675297752987529975300753017530275303753047530575306753077530875309753107531175312753137531475315753167531775318753197532075321753227532375324753257532675327753287532975330753317533275333753347533575336753377533875339753407534175342753437534475345753467534775348753497535075351753527535375354753557535675357753587535975360753617536275363753647536575366753677536875369753707537175372753737537475375753767537775378753797538075381753827538375384753857538675387753887538975390753917539275393753947539575396753977539875399754007540175402754037540475405754067540775408754097541075411754127541375414754157541675417754187541975420754217542275423754247542575426754277542875429754307543175432754337543475435754367543775438754397544075441754427544375444754457544675447754487544975450754517545275453754547545575456754577545875459754607546175462754637546475465754667546775468754697547075471754727547375474754757547675477754787547975480754817548275483754847548575486754877548875489754907549175492754937549475495754967549775498754997550075501755027550375504755057550675507755087550975510755117551275513755147551575516755177551875519755207552175522755237552475525755267552775528755297553075531755327553375534755357553675537755387553975540755417554275543755447554575546755477554875549755507555175552755537555475555755567555775558755597556075561755627556375564755657556675567755687556975570755717557275573755747557575576755777557875579755807558175582755837558475585755867558775588755897559075591755927559375594755957559675597755987559975600756017560275603756047560575606756077560875609756107561175612756137561475615756167561775618756197562075621756227562375624756257562675627756287562975630756317563275633756347563575636756377563875639756407564175642756437564475645756467564775648756497565075651756527565375654756557565675657756587565975660756617566275663756647566575666756677566875669756707567175672756737567475675756767567775678756797568075681756827568375684756857568675687756887568975690756917569275693756947569575696756977569875699757007570175702757037570475705757067570775708757097571075711757127571375714757157571675717757187571975720757217572275723757247572575726757277572875729757307573175732757337573475735757367573775738757397574075741757427574375744757457574675747757487574975750757517575275753757547575575756757577575875759757607576175762757637576475765757667576775768757697577075771757727577375774757757577675777757787577975780757817578275783757847578575786757877578875789757907579175792757937579475795757967579775798757997580075801758027580375804758057580675807758087580975810758117581275813758147581575816758177581875819758207582175822758237582475825758267582775828758297583075831758327583375834758357583675837758387583975840758417584275843758447584575846758477584875849758507585175852758537585475855758567585775858758597586075861758627586375864758657586675867758687586975870758717587275873758747587575876758777587875879758807588175882758837588475885758867588775888758897589075891758927589375894758957589675897758987589975900759017590275903759047590575906759077590875909759107591175912759137591475915759167591775918759197592075921759227592375924759257592675927759287592975930759317593275933759347593575936759377593875939759407594175942759437594475945759467594775948759497595075951759527595375954759557595675957759587595975960759617596275963759647596575966759677596875969759707597175972759737597475975759767597775978759797598075981759827598375984759857598675987759887598975990759917599275993759947599575996759977599875999760007600176002760037600476005760067600776008760097601076011760127601376014760157601676017760187601976020760217602276023760247602576026760277602876029760307603176032760337603476035760367603776038760397604076041760427604376044760457604676047760487604976050760517605276053760547605576056760577605876059760607606176062760637606476065760667606776068760697607076071760727607376074760757607676077760787607976080760817608276083760847608576086760877608876089760907609176092760937609476095760967609776098760997610076101761027610376104761057610676107761087610976110761117611276113761147611576116761177611876119761207612176122761237612476125761267612776128761297613076131761327613376134761357613676137761387613976140761417614276143761447614576146761477614876149761507615176152761537615476155761567615776158761597616076161761627616376164761657616676167761687616976170761717617276173761747617576176761777617876179761807618176182761837618476185761867618776188761897619076191761927619376194761957619676197761987619976200762017620276203762047620576206762077620876209762107621176212762137621476215762167621776218762197622076221762227622376224762257622676227762287622976230762317623276233762347623576236762377623876239762407624176242762437624476245762467624776248762497625076251762527625376254762557625676257762587625976260762617626276263762647626576266762677626876269762707627176272762737627476275762767627776278762797628076281762827628376284762857628676287762887628976290762917629276293762947629576296762977629876299763007630176302763037630476305763067630776308763097631076311763127631376314763157631676317763187631976320763217632276323763247632576326763277632876329763307633176332763337633476335763367633776338763397634076341763427634376344763457634676347763487634976350763517635276353763547635576356763577635876359763607636176362763637636476365763667636776368763697637076371763727637376374763757637676377763787637976380763817638276383763847638576386763877638876389763907639176392763937639476395763967639776398763997640076401764027640376404764057640676407764087640976410764117641276413764147641576416764177641876419764207642176422764237642476425764267642776428764297643076431764327643376434764357643676437764387643976440764417644276443764447644576446764477644876449764507645176452764537645476455764567645776458764597646076461764627646376464764657646676467764687646976470764717647276473764747647576476764777647876479764807648176482764837648476485764867648776488764897649076491764927649376494764957649676497764987649976500765017650276503765047650576506765077650876509765107651176512765137651476515765167651776518765197652076521765227652376524765257652676527765287652976530765317653276533765347653576536765377653876539765407654176542765437654476545765467654776548765497655076551765527655376554765557655676557765587655976560765617656276563765647656576566765677656876569765707657176572765737657476575765767657776578765797658076581765827658376584765857658676587765887658976590765917659276593765947659576596765977659876599766007660176602766037660476605766067660776608766097661076611766127661376614766157661676617766187661976620766217662276623766247662576626766277662876629766307663176632766337663476635766367663776638766397664076641766427664376644766457664676647766487664976650766517665276653766547665576656766577665876659766607666176662766637666476665766667666776668766697667076671766727667376674766757667676677766787667976680766817668276683766847668576686766877668876689766907669176692766937669476695766967669776698766997670076701767027670376704767057670676707767087670976710767117671276713767147671576716767177671876719767207672176722767237672476725767267672776728767297673076731767327673376734767357673676737767387673976740767417674276743767447674576746767477674876749767507675176752767537675476755767567675776758767597676076761767627676376764767657676676767767687676976770767717677276773767747677576776767777677876779767807678176782767837678476785767867678776788767897679076791767927679376794767957679676797767987679976800768017680276803768047680576806768077680876809768107681176812768137681476815768167681776818768197682076821768227682376824768257682676827768287682976830768317683276833768347683576836768377683876839768407684176842768437684476845768467684776848768497685076851768527685376854768557685676857768587685976860768617686276863768647686576866768677686876869768707687176872768737687476875768767687776878768797688076881768827688376884768857688676887768887688976890768917689276893768947689576896768977689876899769007690176902769037690476905769067690776908769097691076911769127691376914769157691676917769187691976920769217692276923769247692576926769277692876929769307693176932769337693476935769367693776938769397694076941769427694376944769457694676947769487694976950769517695276953769547695576956769577695876959769607696176962769637696476965769667696776968769697697076971769727697376974769757697676977769787697976980769817698276983769847698576986769877698876989769907699176992769937699476995769967699776998769997700077001770027700377004770057700677007770087700977010770117701277013770147701577016770177701877019770207702177022770237702477025770267702777028770297703077031770327703377034770357703677037770387703977040770417704277043770447704577046770477704877049770507705177052770537705477055770567705777058770597706077061770627706377064770657706677067770687706977070770717707277073770747707577076770777707877079770807708177082770837708477085770867708777088770897709077091770927709377094770957709677097770987709977100771017710277103771047710577106771077710877109771107711177112771137711477115771167711777118771197712077121771227712377124771257712677127771287712977130771317713277133771347713577136771377713877139771407714177142771437714477145771467714777148771497715077151771527715377154771557715677157771587715977160771617716277163771647716577166771677716877169771707717177172771737717477175771767717777178771797718077181771827718377184771857718677187771887718977190771917719277193771947719577196771977719877199772007720177202772037720477205772067720777208772097721077211772127721377214772157721677217772187721977220772217722277223772247722577226772277722877229772307723177232772337723477235772367723777238772397724077241772427724377244772457724677247772487724977250772517725277253772547725577256772577725877259772607726177262772637726477265772667726777268772697727077271772727727377274772757727677277772787727977280772817728277283772847728577286772877728877289772907729177292772937729477295772967729777298772997730077301773027730377304773057730677307773087730977310773117731277313773147731577316773177731877319773207732177322773237732477325773267732777328773297733077331773327733377334773357733677337773387733977340773417734277343773447734577346773477734877349773507735177352773537735477355773567735777358773597736077361773627736377364773657736677367773687736977370773717737277373773747737577376773777737877379773807738177382773837738477385773867738777388773897739077391773927739377394773957739677397773987739977400774017740277403774047740577406774077740877409774107741177412774137741477415774167741777418774197742077421774227742377424774257742677427774287742977430774317743277433774347743577436774377743877439774407744177442774437744477445774467744777448774497745077451774527745377454774557745677457774587745977460774617746277463774647746577466774677746877469774707747177472774737747477475774767747777478774797748077481774827748377484774857748677487774887748977490774917749277493774947749577496774977749877499775007750177502775037750477505775067750777508775097751077511775127751377514775157751677517775187751977520775217752277523775247752577526775277752877529775307753177532775337753477535775367753777538775397754077541775427754377544775457754677547775487754977550775517755277553775547755577556775577755877559775607756177562775637756477565775667756777568775697757077571775727757377574775757757677577775787757977580775817758277583775847758577586775877758877589775907759177592775937759477595775967759777598775997760077601776027760377604776057760677607776087760977610776117761277613776147761577616776177761877619776207762177622776237762477625776267762777628776297763077631776327763377634776357763677637776387763977640776417764277643776447764577646776477764877649776507765177652776537765477655776567765777658776597766077661776627766377664776657766677667776687766977670776717767277673776747767577676776777767877679776807768177682776837768477685776867768777688776897769077691776927769377694776957769677697776987769977700777017770277703777047770577706777077770877709777107771177712777137771477715777167771777718777197772077721777227772377724777257772677727777287772977730777317773277733777347773577736777377773877739777407774177742777437774477745777467774777748777497775077751777527775377754777557775677757777587775977760777617776277763777647776577766777677776877769777707777177772777737777477775777767777777778777797778077781777827778377784777857778677787777887778977790777917779277793777947779577796777977779877799778007780177802778037780477805778067780777808778097781077811778127781377814778157781677817778187781977820778217782277823778247782577826778277782877829778307783177832778337783477835778367783777838778397784077841778427784377844778457784677847778487784977850778517785277853778547785577856778577785877859778607786177862778637786477865778667786777868778697787077871778727787377874778757787677877778787787977880778817788277883778847788577886778877788877889778907789177892778937789477895778967789777898778997790077901779027790377904779057790677907779087790977910779117791277913779147791577916779177791877919779207792177922779237792477925779267792777928779297793077931779327793377934779357793677937779387793977940779417794277943779447794577946779477794877949779507795177952779537795477955779567795777958779597796077961779627796377964779657796677967779687796977970779717797277973779747797577976779777797877979779807798177982779837798477985779867798777988779897799077991779927799377994779957799677997779987799978000780017800278003780047800578006780077800878009780107801178012780137801478015780167801778018780197802078021780227802378024780257802678027780287802978030780317803278033780347803578036780377803878039780407804178042780437804478045780467804778048780497805078051780527805378054780557805678057780587805978060780617806278063780647806578066780677806878069780707807178072780737807478075780767807778078780797808078081780827808378084780857808678087780887808978090780917809278093780947809578096780977809878099781007810178102781037810478105781067810778108781097811078111781127811378114781157811678117781187811978120781217812278123781247812578126781277812878129781307813178132781337813478135781367813778138781397814078141781427814378144781457814678147781487814978150781517815278153781547815578156781577815878159781607816178162781637816478165781667816778168781697817078171781727817378174781757817678177781787817978180781817818278183781847818578186781877818878189781907819178192781937819478195781967819778198781997820078201782027820378204782057820678207782087820978210782117821278213782147821578216782177821878219782207822178222782237822478225782267822778228782297823078231782327823378234782357823678237782387823978240782417824278243782447824578246782477824878249782507825178252782537825478255782567825778258782597826078261782627826378264782657826678267782687826978270782717827278273782747827578276782777827878279782807828178282782837828478285782867828778288782897829078291782927829378294782957829678297782987829978300783017830278303783047830578306783077830878309783107831178312783137831478315783167831778318783197832078321783227832378324783257832678327783287832978330783317833278333783347833578336783377833878339783407834178342783437834478345783467834778348783497835078351783527835378354783557835678357783587835978360783617836278363783647836578366783677836878369783707837178372783737837478375783767837778378783797838078381783827838378384783857838678387783887838978390783917839278393783947839578396783977839878399784007840178402784037840478405784067840778408784097841078411784127841378414784157841678417784187841978420784217842278423784247842578426784277842878429784307843178432784337843478435784367843778438784397844078441784427844378444784457844678447784487844978450784517845278453784547845578456784577845878459784607846178462784637846478465784667846778468784697847078471784727847378474784757847678477784787847978480784817848278483784847848578486784877848878489784907849178492784937849478495784967849778498784997850078501785027850378504785057850678507785087850978510785117851278513785147851578516785177851878519785207852178522785237852478525785267852778528785297853078531785327853378534785357853678537785387853978540785417854278543785447854578546785477854878549785507855178552785537855478555785567855778558785597856078561785627856378564785657856678567785687856978570785717857278573785747857578576785777857878579785807858178582785837858478585785867858778588785897859078591785927859378594785957859678597785987859978600786017860278603786047860578606786077860878609786107861178612786137861478615786167861778618786197862078621786227862378624786257862678627786287862978630786317863278633786347863578636786377863878639786407864178642786437864478645786467864778648786497865078651786527865378654786557865678657786587865978660786617866278663786647866578666786677866878669786707867178672786737867478675786767867778678786797868078681786827868378684786857868678687786887868978690786917869278693786947869578696786977869878699787007870178702787037870478705787067870778708787097871078711787127871378714787157871678717787187871978720787217872278723787247872578726787277872878729787307873178732787337873478735787367873778738787397874078741787427874378744787457874678747787487874978750787517875278753787547875578756787577875878759787607876178762787637876478765787667876778768787697877078771787727877378774787757877678777787787877978780787817878278783787847878578786787877878878789787907879178792787937879478795787967879778798787997880078801788027880378804788057880678807788087880978810788117881278813788147881578816788177881878819788207882178822788237882478825788267882778828788297883078831788327883378834788357883678837788387883978840788417884278843788447884578846788477884878849788507885178852788537885478855788567885778858788597886078861788627886378864788657886678867788687886978870788717887278873788747887578876788777887878879788807888178882788837888478885788867888778888788897889078891788927889378894788957889678897788987889978900789017890278903789047890578906789077890878909789107891178912789137891478915789167891778918789197892078921789227892378924789257892678927789287892978930789317893278933789347893578936789377893878939789407894178942789437894478945789467894778948789497895078951789527895378954789557895678957789587895978960789617896278963789647896578966789677896878969789707897178972789737897478975789767897778978789797898078981789827898378984789857898678987789887898978990789917899278993789947899578996789977899878999790007900179002790037900479005790067900779008790097901079011790127901379014790157901679017790187901979020790217902279023790247902579026790277902879029790307903179032790337903479035790367903779038790397904079041790427904379044790457904679047790487904979050790517905279053790547905579056790577905879059790607906179062790637906479065790667906779068790697907079071790727907379074790757907679077790787907979080790817908279083790847908579086790877908879089790907909179092790937909479095790967909779098790997910079101791027910379104791057910679107791087910979110791117911279113791147911579116791177911879119791207912179122791237912479125791267912779128791297913079131791327913379134791357913679137791387913979140791417914279143791447914579146791477914879149791507915179152791537915479155791567915779158791597916079161791627916379164791657916679167791687916979170791717917279173791747917579176791777917879179791807918179182791837918479185791867918779188791897919079191791927919379194791957919679197791987919979200792017920279203792047920579206792077920879209792107921179212792137921479215792167921779218792197922079221792227922379224792257922679227792287922979230792317923279233792347923579236792377923879239792407924179242792437924479245792467924779248792497925079251792527925379254792557925679257792587925979260792617926279263792647926579266792677926879269792707927179272792737927479275792767927779278792797928079281792827928379284792857928679287792887928979290792917929279293792947929579296792977929879299793007930179302793037930479305793067930779308793097931079311793127931379314793157931679317793187931979320793217932279323793247932579326793277932879329793307933179332793337933479335793367933779338793397934079341793427934379344793457934679347793487934979350793517935279353793547935579356793577935879359793607936179362793637936479365793667936779368793697937079371793727937379374793757937679377793787937979380793817938279383793847938579386793877938879389793907939179392793937939479395793967939779398793997940079401794027940379404794057940679407794087940979410794117941279413794147941579416794177941879419794207942179422794237942479425794267942779428794297943079431794327943379434794357943679437794387943979440794417944279443794447944579446794477944879449794507945179452794537945479455794567945779458794597946079461794627946379464794657946679467794687946979470794717947279473794747947579476794777947879479794807948179482794837948479485794867948779488794897949079491794927949379494794957949679497794987949979500795017950279503795047950579506795077950879509795107951179512795137951479515795167951779518795197952079521795227952379524795257952679527795287952979530795317953279533795347953579536795377953879539795407954179542795437954479545795467954779548795497955079551795527955379554795557955679557795587955979560795617956279563795647956579566795677956879569795707957179572795737957479575795767957779578795797958079581795827958379584795857958679587795887958979590795917959279593795947959579596795977959879599796007960179602796037960479605796067960779608796097961079611796127961379614796157961679617796187961979620796217962279623796247962579626796277962879629796307963179632796337963479635796367963779638796397964079641796427964379644796457964679647796487964979650796517965279653796547965579656796577965879659796607966179662796637966479665796667966779668796697967079671796727967379674796757967679677796787967979680796817968279683796847968579686796877968879689796907969179692796937969479695796967969779698796997970079701797027970379704797057970679707797087970979710797117971279713797147971579716797177971879719797207972179722797237972479725797267972779728797297973079731797327973379734797357973679737797387973979740797417974279743797447974579746797477974879749797507975179752797537975479755797567975779758797597976079761797627976379764797657976679767797687976979770797717977279773797747977579776797777977879779797807978179782797837978479785797867978779788797897979079791797927979379794797957979679797797987979979800798017980279803798047980579806798077980879809798107981179812798137981479815798167981779818798197982079821798227982379824798257982679827798287982979830798317983279833798347983579836798377983879839798407984179842798437984479845798467984779848798497985079851798527985379854798557985679857798587985979860798617986279863798647986579866798677986879869798707987179872798737987479875798767987779878798797988079881798827988379884798857988679887798887988979890798917989279893798947989579896798977989879899799007990179902799037990479905799067990779908799097991079911799127991379914799157991679917799187991979920799217992279923799247992579926799277992879929799307993179932799337993479935799367993779938799397994079941799427994379944799457994679947799487994979950799517995279953799547995579956799577995879959799607996179962799637996479965799667996779968799697997079971799727997379974799757997679977799787997979980799817998279983799847998579986799877998879989799907999179992799937999479995799967999779998799998000080001800028000380004800058000680007800088000980010800118001280013800148001580016800178001880019800208002180022800238002480025800268002780028800298003080031800328003380034800358003680037800388003980040800418004280043800448004580046800478004880049800508005180052800538005480055800568005780058800598006080061800628006380064800658006680067800688006980070800718007280073800748007580076800778007880079800808008180082800838008480085800868008780088800898009080091800928009380094800958009680097800988009980100801018010280103801048010580106801078010880109801108011180112801138011480115801168011780118801198012080121801228012380124801258012680127801288012980130801318013280133801348013580136801378013880139801408014180142801438014480145801468014780148801498015080151801528015380154801558015680157801588015980160801618016280163801648016580166801678016880169801708017180172801738017480175801768017780178801798018080181801828018380184801858018680187801888018980190801918019280193801948019580196801978019880199802008020180202802038020480205802068020780208802098021080211802128021380214802158021680217802188021980220802218022280223802248022580226802278022880229802308023180232802338023480235802368023780238802398024080241802428024380244802458024680247802488024980250802518025280253802548025580256802578025880259802608026180262802638026480265802668026780268802698027080271802728027380274802758027680277802788027980280802818028280283802848028580286802878028880289802908029180292802938029480295802968029780298802998030080301803028030380304803058030680307803088030980310803118031280313803148031580316803178031880319803208032180322803238032480325803268032780328803298033080331803328033380334803358033680337803388033980340803418034280343803448034580346803478034880349803508035180352803538035480355803568035780358803598036080361803628036380364803658036680367803688036980370803718037280373803748037580376803778037880379803808038180382803838038480385803868038780388803898039080391803928039380394803958039680397803988039980400804018040280403804048040580406804078040880409804108041180412804138041480415804168041780418804198042080421804228042380424804258042680427804288042980430804318043280433804348043580436804378043880439804408044180442804438044480445804468044780448804498045080451804528045380454804558045680457804588045980460804618046280463804648046580466804678046880469804708047180472804738047480475804768047780478804798048080481804828048380484804858048680487804888048980490804918049280493804948049580496804978049880499805008050180502805038050480505805068050780508805098051080511805128051380514805158051680517805188051980520805218052280523805248052580526805278052880529805308053180532805338053480535805368053780538805398054080541805428054380544805458054680547805488054980550805518055280553805548055580556805578055880559805608056180562805638056480565805668056780568805698057080571805728057380574805758057680577805788057980580805818058280583805848058580586805878058880589805908059180592805938059480595805968059780598805998060080601806028060380604806058060680607806088060980610806118061280613806148061580616806178061880619806208062180622806238062480625806268062780628806298063080631806328063380634806358063680637806388063980640806418064280643806448064580646806478064880649806508065180652806538065480655806568065780658806598066080661806628066380664806658066680667806688066980670806718067280673806748067580676806778067880679806808068180682806838068480685806868068780688806898069080691806928069380694806958069680697806988069980700807018070280703807048070580706807078070880709807108071180712807138071480715807168071780718807198072080721807228072380724807258072680727807288072980730807318073280733807348073580736807378073880739807408074180742807438074480745807468074780748807498075080751807528075380754807558075680757807588075980760807618076280763807648076580766807678076880769807708077180772807738077480775807768077780778807798078080781807828078380784807858078680787807888078980790807918079280793807948079580796807978079880799808008080180802808038080480805808068080780808808098081080811808128081380814808158081680817808188081980820808218082280823808248082580826808278082880829808308083180832808338083480835808368083780838808398084080841808428084380844808458084680847808488084980850808518085280853808548085580856808578085880859808608086180862808638086480865808668086780868808698087080871808728087380874808758087680877808788087980880808818088280883808848088580886808878088880889808908089180892808938089480895808968089780898808998090080901809028090380904809058090680907809088090980910809118091280913809148091580916809178091880919809208092180922809238092480925809268092780928809298093080931809328093380934809358093680937809388093980940809418094280943809448094580946809478094880949809508095180952809538095480955809568095780958809598096080961809628096380964809658096680967809688096980970809718097280973809748097580976809778097880979809808098180982809838098480985809868098780988809898099080991809928099380994809958099680997809988099981000810018100281003810048100581006810078100881009810108101181012810138101481015810168101781018810198102081021810228102381024810258102681027810288102981030810318103281033810348103581036810378103881039810408104181042810438104481045810468104781048810498105081051810528105381054810558105681057810588105981060810618106281063810648106581066810678106881069810708107181072810738107481075810768107781078810798108081081810828108381084810858108681087810888108981090810918109281093810948109581096810978109881099811008110181102811038110481105811068110781108811098111081111811128111381114811158111681117811188111981120811218112281123811248112581126811278112881129811308113181132811338113481135811368113781138811398114081141811428114381144811458114681147811488114981150811518115281153811548115581156811578115881159811608116181162811638116481165811668116781168811698117081171811728117381174811758117681177811788117981180811818118281183811848118581186811878118881189811908119181192811938119481195811968119781198811998120081201812028120381204812058120681207812088120981210812118121281213812148121581216812178121881219812208122181222812238122481225812268122781228812298123081231812328123381234812358123681237812388123981240812418124281243812448124581246812478124881249812508125181252812538125481255812568125781258812598126081261812628126381264812658126681267812688126981270812718127281273812748127581276812778127881279812808128181282812838128481285812868128781288812898129081291812928129381294812958129681297812988129981300813018130281303813048130581306813078130881309813108131181312813138131481315813168131781318813198132081321813228132381324813258132681327813288132981330813318133281333813348133581336813378133881339813408134181342813438134481345813468134781348813498135081351813528135381354813558135681357813588135981360813618136281363813648136581366813678136881369813708137181372813738137481375813768137781378813798138081381813828138381384813858138681387813888138981390813918139281393813948139581396813978139881399814008140181402814038140481405814068140781408814098141081411814128141381414814158141681417814188141981420814218142281423814248142581426814278142881429814308143181432814338143481435814368143781438814398144081441814428144381444814458144681447814488144981450814518145281453814548145581456814578145881459814608146181462814638146481465814668146781468814698147081471814728147381474814758147681477814788147981480814818148281483814848148581486814878148881489814908149181492814938149481495814968149781498814998150081501815028150381504815058150681507815088150981510815118151281513815148151581516815178151881519815208152181522815238152481525815268152781528815298153081531815328153381534815358153681537815388153981540815418154281543815448154581546815478154881549815508155181552815538155481555815568155781558815598156081561815628156381564815658156681567815688156981570815718157281573815748157581576815778157881579815808158181582815838158481585815868158781588815898159081591815928159381594815958159681597815988159981600816018160281603816048160581606816078160881609816108161181612816138161481615816168161781618816198162081621816228162381624816258162681627816288162981630816318163281633816348163581636816378163881639816408164181642816438164481645816468164781648816498165081651816528165381654816558165681657816588165981660816618166281663816648166581666816678166881669816708167181672816738167481675816768167781678816798168081681816828168381684816858168681687816888168981690816918169281693816948169581696816978169881699817008170181702817038170481705817068170781708817098171081711817128171381714817158171681717817188171981720817218172281723817248172581726817278172881729817308173181732817338173481735817368173781738817398174081741817428174381744817458174681747817488174981750817518175281753817548175581756817578175881759817608176181762817638176481765817668176781768817698177081771817728177381774817758177681777817788177981780817818178281783817848178581786817878178881789817908179181792817938179481795817968179781798817998180081801818028180381804818058180681807818088180981810818118181281813818148181581816818178181881819818208182181822818238182481825818268182781828818298183081831818328183381834818358183681837818388183981840818418184281843818448184581846818478184881849818508185181852818538185481855818568185781858818598186081861818628186381864818658186681867818688186981870818718187281873818748187581876818778187881879818808188181882818838188481885818868188781888818898189081891818928189381894818958189681897818988189981900819018190281903819048190581906819078190881909819108191181912819138191481915819168191781918819198192081921819228192381924819258192681927819288192981930819318193281933819348193581936819378193881939819408194181942819438194481945819468194781948819498195081951819528195381954819558195681957819588195981960819618196281963819648196581966819678196881969819708197181972819738197481975819768197781978819798198081981819828198381984819858198681987819888198981990819918199281993819948199581996819978199881999820008200182002820038200482005820068200782008820098201082011820128201382014820158201682017820188201982020820218202282023820248202582026820278202882029820308203182032820338203482035820368203782038820398204082041820428204382044820458204682047820488204982050820518205282053820548205582056820578205882059820608206182062820638206482065820668206782068820698207082071820728207382074820758207682077820788207982080820818208282083820848208582086820878208882089820908209182092820938209482095820968209782098820998210082101821028210382104821058210682107821088210982110821118211282113821148211582116821178211882119821208212182122821238212482125821268212782128821298213082131821328213382134821358213682137821388213982140821418214282143821448214582146821478214882149821508215182152821538215482155821568215782158821598216082161821628216382164821658216682167821688216982170821718217282173821748217582176821778217882179821808218182182821838218482185821868218782188821898219082191821928219382194821958219682197821988219982200822018220282203822048220582206822078220882209822108221182212822138221482215822168221782218822198222082221822228222382224822258222682227822288222982230822318223282233822348223582236822378223882239822408224182242822438224482245822468224782248822498225082251822528225382254822558225682257822588225982260822618226282263822648226582266822678226882269822708227182272822738227482275822768227782278822798228082281822828228382284822858228682287822888228982290822918229282293822948229582296822978229882299823008230182302823038230482305823068230782308823098231082311823128231382314823158231682317823188231982320823218232282323823248232582326823278232882329823308233182332823338233482335823368233782338823398234082341823428234382344823458234682347823488234982350823518235282353823548235582356823578235882359823608236182362823638236482365823668236782368823698237082371823728237382374823758237682377823788237982380823818238282383823848238582386823878238882389823908239182392823938239482395823968239782398823998240082401824028240382404824058240682407824088240982410824118241282413824148241582416824178241882419824208242182422824238242482425824268242782428824298243082431824328243382434824358243682437824388243982440824418244282443824448244582446824478244882449824508245182452824538245482455824568245782458824598246082461824628246382464824658246682467824688246982470824718247282473824748247582476824778247882479824808248182482824838248482485824868248782488824898249082491824928249382494824958249682497824988249982500825018250282503825048250582506825078250882509825108251182512825138251482515825168251782518825198252082521825228252382524825258252682527825288252982530825318253282533825348253582536825378253882539825408254182542825438254482545825468254782548825498255082551825528255382554825558255682557825588255982560825618256282563825648256582566825678256882569825708257182572825738257482575825768257782578825798258082581825828258382584825858258682587825888258982590825918259282593825948259582596825978259882599826008260182602826038260482605826068260782608826098261082611826128261382614826158261682617826188261982620826218262282623826248262582626826278262882629826308263182632826338263482635826368263782638826398264082641826428264382644826458264682647826488264982650826518265282653826548265582656826578265882659826608266182662826638266482665826668266782668826698267082671826728267382674826758267682677826788267982680826818268282683826848268582686826878268882689826908269182692826938269482695826968269782698826998270082701827028270382704827058270682707827088270982710827118271282713827148271582716827178271882719827208272182722827238272482725827268272782728827298273082731827328273382734827358273682737827388273982740827418274282743827448274582746827478274882749827508275182752827538275482755827568275782758827598276082761827628276382764827658276682767827688276982770827718277282773827748277582776827778277882779827808278182782827838278482785827868278782788827898279082791827928279382794827958279682797827988279982800828018280282803828048280582806828078280882809828108281182812828138281482815828168281782818828198282082821828228282382824828258282682827828288282982830828318283282833828348283582836828378283882839828408284182842828438284482845828468284782848828498285082851828528285382854828558285682857828588285982860828618286282863828648286582866828678286882869828708287182872828738287482875828768287782878828798288082881828828288382884828858288682887828888288982890828918289282893828948289582896828978289882899829008290182902829038290482905829068290782908829098291082911829128291382914829158291682917829188291982920829218292282923829248292582926829278292882929829308293182932829338293482935829368293782938829398294082941829428294382944829458294682947829488294982950829518295282953829548295582956829578295882959829608296182962829638296482965829668296782968829698297082971829728297382974829758297682977829788297982980829818298282983829848298582986829878298882989829908299182992829938299482995829968299782998829998300083001830028300383004830058300683007830088300983010830118301283013830148301583016830178301883019830208302183022830238302483025830268302783028830298303083031830328303383034830358303683037830388303983040830418304283043830448304583046830478304883049830508305183052830538305483055830568305783058830598306083061830628306383064830658306683067830688306983070830718307283073830748307583076830778307883079830808308183082830838308483085830868308783088830898309083091830928309383094830958309683097830988309983100831018310283103831048310583106831078310883109831108311183112831138311483115831168311783118831198312083121831228312383124831258312683127831288312983130831318313283133831348313583136831378313883139831408314183142831438314483145831468314783148831498315083151831528315383154831558315683157831588315983160831618316283163831648316583166831678316883169831708317183172831738317483175831768317783178831798318083181831828318383184831858318683187831888318983190831918319283193831948319583196831978319883199832008320183202832038320483205832068320783208832098321083211832128321383214832158321683217832188321983220832218322283223832248322583226832278322883229832308323183232832338323483235832368323783238832398324083241832428324383244832458324683247832488324983250832518325283253832548325583256832578325883259832608326183262832638326483265832668326783268832698327083271832728327383274832758327683277832788327983280832818328283283832848328583286832878328883289832908329183292832938329483295832968329783298832998330083301833028330383304833058330683307833088330983310833118331283313833148331583316833178331883319833208332183322833238332483325833268332783328833298333083331833328333383334833358333683337833388333983340833418334283343833448334583346833478334883349833508335183352833538335483355833568335783358833598336083361833628336383364833658336683367833688336983370833718337283373833748337583376833778337883379833808338183382833838338483385833868338783388833898339083391833928339383394833958339683397833988339983400834018340283403834048340583406834078340883409834108341183412834138341483415834168341783418834198342083421834228342383424834258342683427834288342983430834318343283433834348343583436834378343883439834408344183442834438344483445834468344783448834498345083451834528345383454834558345683457834588345983460834618346283463834648346583466834678346883469834708347183472834738347483475834768347783478834798348083481834828348383484834858348683487834888348983490834918349283493834948349583496834978349883499835008350183502835038350483505835068350783508835098351083511835128351383514835158351683517835188351983520835218352283523835248352583526835278352883529835308353183532835338353483535835368353783538835398354083541835428354383544835458354683547835488354983550835518355283553835548355583556835578355883559835608356183562835638356483565835668356783568835698357083571835728357383574835758357683577835788357983580835818358283583835848358583586835878358883589835908359183592835938359483595835968359783598835998360083601836028360383604836058360683607836088360983610836118361283613836148361583616836178361883619836208362183622836238362483625836268362783628836298363083631836328363383634836358363683637836388363983640836418364283643836448364583646836478364883649836508365183652836538365483655836568365783658836598366083661836628366383664836658366683667836688366983670836718367283673836748367583676836778367883679836808368183682836838368483685836868368783688836898369083691836928369383694836958369683697836988369983700837018370283703837048370583706837078370883709837108371183712837138371483715837168371783718837198372083721837228372383724837258372683727837288372983730837318373283733837348373583736837378373883739837408374183742837438374483745837468374783748837498375083751837528375383754837558375683757837588375983760837618376283763837648376583766837678376883769837708377183772837738377483775837768377783778837798378083781837828378383784837858378683787837888378983790837918379283793837948379583796837978379883799838008380183802838038380483805838068380783808838098381083811838128381383814838158381683817838188381983820838218382283823838248382583826838278382883829838308383183832838338383483835838368383783838838398384083841838428384383844838458384683847838488384983850838518385283853838548385583856838578385883859838608386183862838638386483865838668386783868838698387083871838728387383874838758387683877838788387983880838818388283883838848388583886838878388883889838908389183892838938389483895838968389783898838998390083901839028390383904839058390683907839088390983910839118391283913839148391583916839178391883919839208392183922839238392483925839268392783928839298393083931839328393383934839358393683937839388393983940839418394283943839448394583946839478394883949839508395183952839538395483955839568395783958839598396083961839628396383964839658396683967839688396983970839718397283973839748397583976839778397883979839808398183982839838398483985839868398783988839898399083991839928399383994839958399683997839988399984000840018400284003840048400584006840078400884009840108401184012840138401484015840168401784018840198402084021840228402384024840258402684027840288402984030840318403284033840348403584036840378403884039840408404184042840438404484045840468404784048840498405084051840528405384054840558405684057840588405984060840618406284063840648406584066840678406884069840708407184072840738407484075840768407784078840798408084081840828408384084840858408684087840888408984090840918409284093840948409584096840978409884099841008410184102841038410484105841068410784108841098411084111841128411384114841158411684117841188411984120841218412284123841248412584126841278412884129841308413184132841338413484135841368413784138841398414084141841428414384144841458414684147841488414984150841518415284153841548415584156841578415884159841608416184162841638416484165841668416784168841698417084171841728417384174841758417684177841788417984180841818418284183841848418584186841878418884189841908419184192841938419484195841968419784198841998420084201842028420384204842058420684207842088420984210842118421284213842148421584216842178421884219842208422184222842238422484225842268422784228842298423084231842328423384234842358423684237842388423984240842418424284243842448424584246842478424884249842508425184252842538425484255842568425784258842598426084261842628426384264842658426684267842688426984270842718427284273842748427584276842778427884279842808428184282842838428484285842868428784288842898429084291842928429384294842958429684297842988429984300843018430284303843048430584306843078430884309843108431184312843138431484315843168431784318843198432084321843228432384324843258432684327843288432984330843318433284333843348433584336843378433884339843408434184342843438434484345843468434784348843498435084351843528435384354843558435684357843588435984360843618436284363843648436584366843678436884369843708437184372843738437484375843768437784378843798438084381843828438384384843858438684387843888438984390843918439284393843948439584396843978439884399844008440184402844038440484405844068440784408844098441084411844128441384414844158441684417844188441984420844218442284423844248442584426844278442884429844308443184432844338443484435844368443784438844398444084441844428444384444844458444684447844488444984450844518445284453844548445584456844578445884459844608446184462844638446484465844668446784468844698447084471844728447384474844758447684477844788447984480844818448284483844848448584486844878448884489844908449184492844938449484495844968449784498844998450084501845028450384504845058450684507845088450984510845118451284513845148451584516845178451884519845208452184522845238452484525845268452784528845298453084531845328453384534845358453684537845388453984540845418454284543845448454584546845478454884549845508455184552845538455484555845568455784558845598456084561845628456384564845658456684567845688456984570845718457284573845748457584576845778457884579845808458184582845838458484585845868458784588845898459084591845928459384594845958459684597845988459984600846018460284603846048460584606846078460884609846108461184612846138461484615846168461784618846198462084621846228462384624846258462684627846288462984630846318463284633846348463584636846378463884639846408464184642846438464484645846468464784648846498465084651846528465384654846558465684657846588465984660846618466284663846648466584666846678466884669846708467184672846738467484675846768467784678846798468084681846828468384684846858468684687846888468984690846918469284693846948469584696846978469884699847008470184702847038470484705847068470784708847098471084711847128471384714847158471684717847188471984720847218472284723847248472584726847278472884729847308473184732847338473484735847368473784738847398474084741847428474384744847458474684747847488474984750847518475284753847548475584756847578475884759847608476184762847638476484765847668476784768847698477084771847728477384774847758477684777847788477984780847818478284783847848478584786847878478884789847908479184792847938479484795847968479784798847998480084801848028480384804848058480684807848088480984810848118481284813848148481584816848178481884819848208482184822848238482484825848268482784828848298483084831848328483384834848358483684837848388483984840848418484284843848448484584846848478484884849848508485184852848538485484855848568485784858848598486084861848628486384864848658486684867848688486984870848718487284873848748487584876848778487884879848808488184882848838488484885848868488784888848898489084891848928489384894848958489684897848988489984900849018490284903849048490584906849078490884909849108491184912849138491484915849168491784918849198492084921849228492384924849258492684927849288492984930849318493284933849348493584936849378493884939849408494184942849438494484945849468494784948849498495084951849528495384954849558495684957849588495984960849618496284963849648496584966849678496884969849708497184972849738497484975849768497784978849798498084981849828498384984849858498684987849888498984990849918499284993849948499584996849978499884999850008500185002850038500485005850068500785008850098501085011850128501385014850158501685017850188501985020850218502285023850248502585026850278502885029850308503185032850338503485035850368503785038850398504085041850428504385044850458504685047850488504985050850518505285053850548505585056850578505885059850608506185062850638506485065850668506785068850698507085071850728507385074850758507685077850788507985080850818508285083850848508585086850878508885089850908509185092850938509485095850968509785098850998510085101851028510385104851058510685107851088510985110851118511285113851148511585116851178511885119851208512185122851238512485125851268512785128851298513085131851328513385134851358513685137851388513985140851418514285143851448514585146851478514885149851508515185152851538515485155851568515785158851598516085161851628516385164851658516685167851688516985170851718517285173851748517585176851778517885179851808518185182851838518485185851868518785188851898519085191851928519385194851958519685197851988519985200852018520285203852048520585206852078520885209852108521185212852138521485215852168521785218852198522085221852228522385224852258522685227852288522985230852318523285233852348523585236852378523885239852408524185242852438524485245852468524785248852498525085251852528525385254852558525685257852588525985260852618526285263852648526585266852678526885269852708527185272852738527485275852768527785278852798528085281852828528385284852858528685287852888528985290852918529285293852948529585296852978529885299853008530185302853038530485305853068530785308853098531085311853128531385314853158531685317853188531985320853218532285323853248532585326853278532885329853308533185332853338533485335853368533785338853398534085341853428534385344853458534685347853488534985350853518535285353853548535585356853578535885359853608536185362853638536485365853668536785368853698537085371853728537385374853758537685377853788537985380853818538285383853848538585386853878538885389853908539185392853938539485395853968539785398853998540085401854028540385404854058540685407854088540985410854118541285413854148541585416854178541885419854208542185422854238542485425854268542785428854298543085431854328543385434854358543685437854388543985440854418544285443854448544585446854478544885449854508545185452854538545485455854568545785458854598546085461854628546385464854658546685467854688546985470854718547285473854748547585476854778547885479854808548185482854838548485485854868548785488854898549085491854928549385494854958549685497854988549985500855018550285503855048550585506855078550885509855108551185512855138551485515855168551785518855198552085521855228552385524855258552685527855288552985530855318553285533855348553585536855378553885539855408554185542855438554485545855468554785548855498555085551855528555385554855558555685557855588555985560855618556285563855648556585566855678556885569855708557185572855738557485575855768557785578855798558085581855828558385584855858558685587855888558985590855918559285593855948559585596855978559885599856008560185602856038560485605856068560785608856098561085611856128561385614856158561685617856188561985620856218562285623856248562585626856278562885629856308563185632856338563485635856368563785638856398564085641856428564385644856458564685647856488564985650856518565285653856548565585656856578565885659856608566185662856638566485665856668566785668856698567085671856728567385674856758567685677856788567985680856818568285683856848568585686856878568885689856908569185692856938569485695856968569785698856998570085701857028570385704857058570685707857088570985710857118571285713857148571585716857178571885719857208572185722857238572485725857268572785728857298573085731857328573385734857358573685737857388573985740857418574285743857448574585746857478574885749857508575185752857538575485755857568575785758857598576085761857628576385764857658576685767857688576985770857718577285773857748577585776857778577885779857808578185782857838578485785857868578785788857898579085791857928579385794857958579685797857988579985800858018580285803858048580585806858078580885809858108581185812858138581485815858168581785818858198582085821858228582385824858258582685827858288582985830858318583285833858348583585836858378583885839858408584185842858438584485845858468584785848858498585085851858528585385854858558585685857858588585985860858618586285863858648586585866858678586885869858708587185872858738587485875858768587785878858798588085881858828588385884858858588685887858888588985890858918589285893858948589585896858978589885899859008590185902859038590485905859068590785908859098591085911859128591385914859158591685917859188591985920859218592285923859248592585926859278592885929859308593185932859338593485935859368593785938859398594085941859428594385944859458594685947859488594985950859518595285953859548595585956859578595885959859608596185962859638596485965859668596785968859698597085971859728597385974859758597685977859788597985980859818598285983859848598585986859878598885989859908599185992859938599485995859968599785998859998600086001860028600386004860058600686007860088600986010860118601286013860148601586016860178601886019860208602186022860238602486025860268602786028860298603086031860328603386034860358603686037860388603986040860418604286043860448604586046860478604886049860508605186052860538605486055860568605786058860598606086061860628606386064860658606686067860688606986070860718607286073860748607586076860778607886079860808608186082860838608486085860868608786088860898609086091860928609386094860958609686097860988609986100861018610286103861048610586106861078610886109861108611186112861138611486115861168611786118861198612086121861228612386124861258612686127861288612986130861318613286133861348613586136861378613886139861408614186142861438614486145861468614786148861498615086151861528615386154861558615686157861588615986160861618616286163861648616586166861678616886169861708617186172861738617486175861768617786178861798618086181861828618386184861858618686187861888618986190861918619286193861948619586196861978619886199862008620186202862038620486205862068620786208862098621086211862128621386214862158621686217862188621986220862218622286223862248622586226862278622886229862308623186232862338623486235862368623786238862398624086241862428624386244862458624686247862488624986250862518625286253862548625586256862578625886259862608626186262862638626486265862668626786268862698627086271862728627386274862758627686277862788627986280862818628286283862848628586286862878628886289862908629186292862938629486295862968629786298862998630086301863028630386304863058630686307863088630986310863118631286313863148631586316863178631886319863208632186322863238632486325863268632786328863298633086331863328633386334863358633686337863388633986340863418634286343863448634586346863478634886349863508635186352863538635486355863568635786358863598636086361863628636386364863658636686367863688636986370863718637286373863748637586376863778637886379863808638186382863838638486385863868638786388863898639086391863928639386394863958639686397863988639986400864018640286403864048640586406864078640886409864108641186412864138641486415864168641786418864198642086421864228642386424864258642686427864288642986430864318643286433864348643586436864378643886439864408644186442864438644486445864468644786448864498645086451864528645386454864558645686457864588645986460864618646286463864648646586466864678646886469864708647186472864738647486475864768647786478864798648086481864828648386484864858648686487864888648986490864918649286493864948649586496864978649886499865008650186502865038650486505865068650786508865098651086511865128651386514865158651686517865188651986520865218652286523865248652586526865278652886529865308653186532865338653486535865368653786538865398654086541865428654386544865458654686547865488654986550865518655286553865548655586556865578655886559865608656186562865638656486565865668656786568865698657086571865728657386574865758657686577865788657986580865818658286583865848658586586865878658886589865908659186592865938659486595865968659786598865998660086601866028660386604866058660686607866088660986610866118661286613866148661586616866178661886619866208662186622866238662486625866268662786628866298663086631866328663386634866358663686637866388663986640866418664286643866448664586646866478664886649866508665186652866538665486655866568665786658866598666086661866628666386664866658666686667866688666986670866718667286673866748667586676866778667886679866808668186682866838668486685866868668786688866898669086691866928669386694866958669686697866988669986700867018670286703867048670586706867078670886709867108671186712867138671486715867168671786718867198672086721867228672386724867258672686727867288672986730867318673286733867348673586736867378673886739867408674186742867438674486745867468674786748867498675086751867528675386754867558675686757867588675986760867618676286763867648676586766867678676886769867708677186772867738677486775867768677786778867798678086781867828678386784867858678686787867888678986790867918679286793867948679586796867978679886799868008680186802868038680486805868068680786808868098681086811868128681386814868158681686817868188681986820868218682286823868248682586826868278682886829868308683186832868338683486835868368683786838868398684086841868428684386844868458684686847868488684986850868518685286853868548685586856868578685886859868608686186862868638686486865868668686786868868698687086871868728687386874868758687686877868788687986880868818688286883868848688586886868878688886889868908689186892868938689486895868968689786898868998690086901869028690386904869058690686907869088690986910869118691286913869148691586916869178691886919869208692186922869238692486925869268692786928869298693086931869328693386934869358693686937869388693986940869418694286943869448694586946869478694886949869508695186952869538695486955869568695786958869598696086961869628696386964869658696686967869688696986970869718697286973869748697586976869778697886979869808698186982869838698486985869868698786988869898699086991869928699386994869958699686997869988699987000870018700287003870048700587006870078700887009870108701187012870138701487015870168701787018870198702087021870228702387024870258702687027870288702987030870318703287033870348703587036870378703887039870408704187042870438704487045870468704787048870498705087051870528705387054870558705687057870588705987060870618706287063870648706587066870678706887069870708707187072870738707487075870768707787078870798708087081870828708387084870858708687087870888708987090870918709287093870948709587096870978709887099871008710187102871038710487105871068710787108871098711087111871128711387114871158711687117871188711987120871218712287123871248712587126871278712887129871308713187132871338713487135871368713787138871398714087141871428714387144871458714687147871488714987150871518715287153871548715587156871578715887159871608716187162871638716487165871668716787168871698717087171871728717387174871758717687177871788717987180871818718287183871848718587186871878718887189871908719187192871938719487195871968719787198871998720087201872028720387204872058720687207872088720987210872118721287213872148721587216872178721887219872208722187222872238722487225872268722787228872298723087231872328723387234872358723687237872388723987240872418724287243872448724587246872478724887249872508725187252872538725487255872568725787258872598726087261872628726387264872658726687267872688726987270872718727287273872748727587276872778727887279872808728187282872838728487285872868728787288872898729087291872928729387294872958729687297872988729987300873018730287303873048730587306873078730887309873108731187312873138731487315873168731787318873198732087321873228732387324873258732687327873288732987330873318733287333873348733587336873378733887339873408734187342873438734487345873468734787348873498735087351873528735387354873558735687357873588735987360873618736287363873648736587366873678736887369873708737187372873738737487375873768737787378873798738087381873828738387384873858738687387873888738987390873918739287393873948739587396873978739887399874008740187402874038740487405874068740787408874098741087411874128741387414874158741687417874188741987420874218742287423874248742587426874278742887429874308743187432874338743487435874368743787438874398744087441874428744387444874458744687447874488744987450874518745287453874548745587456874578745887459874608746187462874638746487465874668746787468874698747087471874728747387474874758747687477874788747987480874818748287483874848748587486874878748887489874908749187492874938749487495874968749787498874998750087501875028750387504875058750687507875088750987510875118751287513875148751587516875178751887519875208752187522875238752487525875268752787528875298753087531875328753387534875358753687537875388753987540875418754287543875448754587546875478754887549875508755187552875538755487555875568755787558875598756087561875628756387564875658756687567875688756987570875718757287573875748757587576875778757887579875808758187582875838758487585875868758787588875898759087591875928759387594875958759687597875988759987600876018760287603876048760587606876078760887609876108761187612876138761487615876168761787618876198762087621876228762387624876258762687627876288762987630876318763287633876348763587636876378763887639876408764187642876438764487645876468764787648876498765087651876528765387654876558765687657876588765987660876618766287663876648766587666876678766887669876708767187672876738767487675876768767787678876798768087681876828768387684876858768687687876888768987690876918769287693876948769587696876978769887699877008770187702877038770487705877068770787708877098771087711877128771387714877158771687717877188771987720877218772287723877248772587726877278772887729877308773187732877338773487735877368773787738877398774087741877428774387744877458774687747877488774987750877518775287753877548775587756877578775887759877608776187762877638776487765877668776787768877698777087771877728777387774877758777687777877788777987780877818778287783877848778587786877878778887789877908779187792877938779487795877968779787798877998780087801878028780387804878058780687807878088780987810878118781287813878148781587816878178781887819878208782187822878238782487825878268782787828878298783087831878328783387834878358783687837878388783987840878418784287843878448784587846878478784887849878508785187852878538785487855878568785787858878598786087861878628786387864878658786687867878688786987870878718787287873878748787587876878778787887879878808788187882878838788487885878868788787888878898789087891878928789387894878958789687897878988789987900879018790287903879048790587906879078790887909879108791187912879138791487915879168791787918879198792087921879228792387924879258792687927879288792987930879318793287933879348793587936879378793887939879408794187942879438794487945879468794787948879498795087951879528795387954879558795687957879588795987960879618796287963879648796587966879678796887969879708797187972879738797487975879768797787978879798798087981879828798387984879858798687987879888798987990879918799287993879948799587996879978799887999880008800188002880038800488005880068800788008880098801088011880128801388014880158801688017880188801988020880218802288023880248802588026880278802888029880308803188032880338803488035880368803788038880398804088041880428804388044880458804688047880488804988050880518805288053880548805588056880578805888059880608806188062880638806488065880668806788068880698807088071880728807388074880758807688077880788807988080880818808288083880848808588086880878808888089880908809188092880938809488095880968809788098880998810088101881028810388104881058810688107881088810988110881118811288113881148811588116881178811888119881208812188122881238812488125881268812788128881298813088131881328813388134881358813688137881388813988140881418814288143881448814588146881478814888149881508815188152881538815488155881568815788158881598816088161881628816388164881658816688167881688816988170881718817288173881748817588176881778817888179881808818188182881838818488185881868818788188881898819088191881928819388194881958819688197881988819988200882018820288203882048820588206882078820888209882108821188212882138821488215882168821788218882198822088221882228822388224882258822688227882288822988230882318823288233882348823588236882378823888239882408824188242882438824488245882468824788248882498825088251882528825388254882558825688257882588825988260882618826288263882648826588266882678826888269882708827188272882738827488275882768827788278882798828088281882828828388284882858828688287882888828988290882918829288293882948829588296882978829888299883008830188302883038830488305883068830788308883098831088311883128831388314883158831688317883188831988320883218832288323883248832588326883278832888329883308833188332883338833488335883368833788338883398834088341883428834388344883458834688347883488834988350883518835288353883548835588356883578835888359883608836188362883638836488365883668836788368883698837088371883728837388374883758837688377883788837988380883818838288383883848838588386883878838888389883908839188392883938839488395883968839788398883998840088401884028840388404884058840688407884088840988410884118841288413884148841588416884178841888419884208842188422884238842488425884268842788428884298843088431884328843388434884358843688437884388843988440884418844288443884448844588446884478844888449884508845188452884538845488455884568845788458884598846088461884628846388464884658846688467884688846988470884718847288473884748847588476884778847888479884808848188482884838848488485884868848788488884898849088491884928849388494884958849688497884988849988500885018850288503885048850588506885078850888509885108851188512885138851488515885168851788518885198852088521885228852388524885258852688527885288852988530885318853288533885348853588536885378853888539885408854188542885438854488545885468854788548885498855088551885528855388554885558855688557885588855988560885618856288563885648856588566885678856888569885708857188572885738857488575885768857788578885798858088581885828858388584885858858688587885888858988590885918859288593885948859588596885978859888599886008860188602886038860488605886068860788608886098861088611886128861388614886158861688617886188861988620886218862288623886248862588626886278862888629886308863188632886338863488635886368863788638886398864088641886428864388644886458864688647886488864988650886518865288653886548865588656886578865888659886608866188662886638866488665886668866788668886698867088671886728867388674886758867688677886788867988680886818868288683886848868588686886878868888689886908869188692886938869488695886968869788698886998870088701887028870388704887058870688707887088870988710887118871288713887148871588716887178871888719887208872188722887238872488725887268872788728887298873088731887328873388734887358873688737887388873988740887418874288743887448874588746887478874888749887508875188752887538875488755887568875788758887598876088761887628876388764887658876688767887688876988770887718877288773887748877588776887778877888779887808878188782887838878488785887868878788788887898879088791887928879388794887958879688797887988879988800888018880288803888048880588806888078880888809888108881188812888138881488815888168881788818888198882088821888228882388824888258882688827888288882988830888318883288833888348883588836888378883888839888408884188842888438884488845888468884788848888498885088851888528885388854888558885688857888588885988860888618886288863888648886588866888678886888869888708887188872888738887488875888768887788878888798888088881888828888388884888858888688887888888888988890888918889288893888948889588896888978889888899889008890188902889038890488905889068890788908889098891088911889128891388914889158891688917889188891988920889218892288923889248892588926889278892888929889308893188932889338893488935889368893788938889398894088941889428894388944889458894688947889488894988950889518895288953889548895588956889578895888959889608896188962889638896488965889668896788968889698897088971889728897388974889758897688977889788897988980889818898288983889848898588986889878898888989889908899188992889938899488995889968899788998889998900089001890028900389004890058900689007890088900989010890118901289013890148901589016890178901889019890208902189022890238902489025890268902789028890298903089031890328903389034890358903689037890388903989040890418904289043890448904589046890478904889049890508905189052890538905489055890568905789058890598906089061890628906389064890658906689067890688906989070890718907289073890748907589076890778907889079890808908189082890838908489085890868908789088890898909089091890928909389094890958909689097890988909989100891018910289103891048910589106891078910889109891108911189112891138911489115891168911789118891198912089121891228912389124891258912689127891288912989130891318913289133891348913589136891378913889139891408914189142891438914489145891468914789148891498915089151891528915389154891558915689157891588915989160891618916289163891648916589166891678916889169891708917189172891738917489175891768917789178891798918089181891828918389184891858918689187891888918989190891918919289193891948919589196891978919889199892008920189202892038920489205892068920789208892098921089211892128921389214892158921689217892188921989220892218922289223892248922589226892278922889229892308923189232892338923489235892368923789238892398924089241892428924389244892458924689247892488924989250892518925289253892548925589256892578925889259892608926189262892638926489265892668926789268892698927089271892728927389274892758927689277892788927989280892818928289283892848928589286892878928889289892908929189292892938929489295892968929789298892998930089301893028930389304893058930689307893088930989310893118931289313893148931589316893178931889319893208932189322893238932489325893268932789328893298933089331893328933389334893358933689337893388933989340893418934289343893448934589346893478934889349893508935189352893538935489355893568935789358893598936089361893628936389364893658936689367893688936989370893718937289373893748937589376893778937889379893808938189382893838938489385893868938789388893898939089391893928939389394893958939689397893988939989400894018940289403894048940589406894078940889409894108941189412894138941489415894168941789418894198942089421894228942389424894258942689427894288942989430894318943289433894348943589436894378943889439894408944189442894438944489445894468944789448894498945089451894528945389454894558945689457894588945989460894618946289463894648946589466894678946889469894708947189472894738947489475894768947789478894798948089481894828948389484894858948689487894888948989490894918949289493894948949589496894978949889499895008950189502895038950489505895068950789508895098951089511895128951389514895158951689517895188951989520895218952289523895248952589526895278952889529895308953189532895338953489535895368953789538895398954089541895428954389544895458954689547895488954989550895518955289553895548955589556895578955889559895608956189562895638956489565895668956789568895698957089571895728957389574895758957689577895788957989580895818958289583895848958589586895878958889589895908959189592895938959489595895968959789598895998960089601896028960389604896058960689607896088960989610896118961289613896148961589616896178961889619896208962189622896238962489625896268962789628896298963089631896328963389634896358963689637896388963989640896418964289643896448964589646896478964889649896508965189652896538965489655896568965789658896598966089661896628966389664896658966689667896688966989670896718967289673896748967589676896778967889679896808968189682896838968489685896868968789688896898969089691896928969389694896958969689697896988969989700897018970289703897048970589706897078970889709897108971189712897138971489715897168971789718897198972089721897228972389724897258972689727897288972989730897318973289733897348973589736897378973889739897408974189742897438974489745897468974789748897498975089751897528975389754897558975689757897588975989760897618976289763897648976589766897678976889769897708977189772897738977489775897768977789778897798978089781897828978389784897858978689787897888978989790897918979289793897948979589796897978979889799898008980189802898038980489805898068980789808898098981089811898128981389814898158981689817898188981989820898218982289823898248982589826898278982889829898308983189832898338983489835898368983789838898398984089841898428984389844898458984689847898488984989850898518985289853898548985589856898578985889859898608986189862898638986489865898668986789868898698987089871898728987389874898758987689877898788987989880898818988289883898848988589886898878988889889898908989189892898938989489895898968989789898898998990089901899028990389904899058990689907899088990989910899118991289913899148991589916899178991889919899208992189922899238992489925899268992789928899298993089931899328993389934899358993689937899388993989940899418994289943899448994589946899478994889949899508995189952899538995489955899568995789958899598996089961899628996389964899658996689967899688996989970899718997289973899748997589976899778997889979899808998189982899838998489985899868998789988899898999089991899928999389994899958999689997899988999990000900019000290003900049000590006900079000890009900109001190012900139001490015900169001790018900199002090021900229002390024900259002690027900289002990030900319003290033900349003590036900379003890039900409004190042900439004490045900469004790048900499005090051900529005390054900559005690057900589005990060900619006290063900649006590066900679006890069900709007190072900739007490075900769007790078900799008090081900829008390084900859008690087900889008990090900919009290093900949009590096900979009890099901009010190102901039010490105901069010790108901099011090111901129011390114901159011690117901189011990120901219012290123901249012590126901279012890129901309013190132901339013490135901369013790138901399014090141901429014390144901459014690147901489014990150901519015290153901549015590156901579015890159901609016190162901639016490165901669016790168901699017090171901729017390174901759017690177901789017990180901819018290183901849018590186901879018890189901909019190192901939019490195901969019790198901999020090201902029020390204902059020690207902089020990210902119021290213902149021590216902179021890219902209022190222902239022490225902269022790228902299023090231902329023390234902359023690237902389023990240902419024290243902449024590246902479024890249902509025190252902539025490255902569025790258902599026090261902629026390264902659026690267902689026990270902719027290273902749027590276902779027890279902809028190282902839028490285902869028790288902899029090291902929029390294902959029690297902989029990300903019030290303903049030590306903079030890309903109031190312903139031490315903169031790318903199032090321903229032390324903259032690327903289032990330903319033290333903349033590336903379033890339903409034190342903439034490345903469034790348903499035090351903529035390354903559035690357903589035990360903619036290363903649036590366903679036890369903709037190372903739037490375903769037790378903799038090381903829038390384903859038690387903889038990390903919039290393903949039590396903979039890399904009040190402904039040490405904069040790408904099041090411904129041390414904159041690417904189041990420904219042290423904249042590426904279042890429904309043190432904339043490435904369043790438904399044090441904429044390444904459044690447904489044990450904519045290453904549045590456904579045890459904609046190462904639046490465904669046790468904699047090471904729047390474904759047690477904789047990480904819048290483904849048590486904879048890489904909049190492904939049490495904969049790498904999050090501905029050390504905059050690507905089050990510905119051290513905149051590516905179051890519905209052190522905239052490525905269052790528905299053090531905329053390534905359053690537905389053990540905419054290543905449054590546905479054890549905509055190552905539055490555905569055790558905599056090561905629056390564905659056690567905689056990570905719057290573905749057590576905779057890579905809058190582905839058490585905869058790588905899059090591905929059390594905959059690597905989059990600906019060290603906049060590606906079060890609906109061190612906139061490615906169061790618906199062090621906229062390624906259062690627906289062990630906319063290633906349063590636906379063890639906409064190642906439064490645906469064790648906499065090651906529065390654906559065690657906589065990660906619066290663906649066590666906679066890669906709067190672906739067490675906769067790678906799068090681906829068390684906859068690687906889068990690906919069290693906949069590696906979069890699907009070190702907039070490705907069070790708907099071090711907129071390714907159071690717907189071990720907219072290723907249072590726907279072890729907309073190732907339073490735907369073790738907399074090741907429074390744907459074690747907489074990750907519075290753907549075590756907579075890759907609076190762907639076490765907669076790768907699077090771907729077390774907759077690777907789077990780907819078290783907849078590786907879078890789907909079190792907939079490795907969079790798907999080090801908029080390804908059080690807908089080990810908119081290813908149081590816908179081890819908209082190822908239082490825908269082790828908299083090831908329083390834908359083690837908389083990840908419084290843908449084590846908479084890849908509085190852908539085490855908569085790858908599086090861908629086390864908659086690867908689086990870908719087290873908749087590876908779087890879908809088190882908839088490885908869088790888908899089090891908929089390894908959089690897908989089990900909019090290903909049090590906909079090890909909109091190912909139091490915909169091790918909199092090921909229092390924909259092690927909289092990930909319093290933909349093590936909379093890939909409094190942909439094490945909469094790948909499095090951909529095390954909559095690957909589095990960909619096290963909649096590966909679096890969909709097190972909739097490975909769097790978909799098090981909829098390984909859098690987909889098990990909919099290993909949099590996909979099890999910009100191002910039100491005910069100791008910099101091011910129101391014910159101691017910189101991020910219102291023910249102591026910279102891029910309103191032910339103491035910369103791038910399104091041910429104391044910459104691047910489104991050910519105291053910549105591056910579105891059910609106191062910639106491065910669106791068910699107091071910729107391074910759107691077910789107991080910819108291083910849108591086910879108891089910909109191092910939109491095910969109791098910999110091101911029110391104911059110691107911089110991110911119111291113911149111591116911179111891119911209112191122911239112491125911269112791128911299113091131911329113391134911359113691137911389113991140911419114291143911449114591146911479114891149911509115191152911539115491155911569115791158911599116091161911629116391164911659116691167911689116991170911719117291173911749117591176911779117891179911809118191182911839118491185911869118791188911899119091191911929119391194911959119691197911989119991200912019120291203912049120591206912079120891209912109121191212912139121491215912169121791218912199122091221912229122391224912259122691227912289122991230912319123291233912349123591236912379123891239912409124191242912439124491245912469124791248912499125091251912529125391254912559125691257912589125991260912619126291263912649126591266912679126891269912709127191272912739127491275912769127791278912799128091281912829128391284912859128691287912889128991290912919129291293912949129591296912979129891299913009130191302913039130491305913069130791308913099131091311913129131391314913159131691317913189131991320913219132291323913249132591326913279132891329913309133191332913339133491335913369133791338913399134091341913429134391344913459134691347913489134991350913519135291353913549135591356913579135891359913609136191362913639136491365913669136791368913699137091371913729137391374913759137691377913789137991380913819138291383913849138591386913879138891389913909139191392913939139491395913969139791398913999140091401914029140391404914059140691407914089140991410914119141291413914149141591416914179141891419914209142191422914239142491425914269142791428914299143091431914329143391434914359143691437914389143991440914419144291443914449144591446914479144891449914509145191452914539145491455914569145791458914599146091461914629146391464914659146691467914689146991470914719147291473914749147591476914779147891479914809148191482914839148491485914869148791488914899149091491914929149391494914959149691497914989149991500915019150291503915049150591506915079150891509915109151191512915139151491515915169151791518915199152091521915229152391524915259152691527915289152991530915319153291533915349153591536915379153891539915409154191542915439154491545915469154791548915499155091551915529155391554915559155691557915589155991560915619156291563915649156591566915679156891569915709157191572915739157491575915769157791578915799158091581915829158391584915859158691587915889158991590915919159291593915949159591596915979159891599916009160191602916039160491605916069160791608916099161091611916129161391614916159161691617916189161991620916219162291623916249162591626916279162891629916309163191632916339163491635916369163791638916399164091641916429164391644916459164691647916489164991650916519165291653916549165591656916579165891659916609166191662916639166491665916669166791668916699167091671916729167391674916759167691677916789167991680916819168291683916849168591686916879168891689916909169191692916939169491695916969169791698916999170091701917029170391704917059170691707917089170991710917119171291713917149171591716917179171891719917209172191722917239172491725917269172791728917299173091731917329173391734917359173691737917389173991740917419174291743917449174591746917479174891749917509175191752917539175491755917569175791758917599176091761917629176391764917659176691767917689176991770917719177291773917749177591776917779177891779917809178191782917839178491785917869178791788917899179091791917929179391794917959179691797917989179991800918019180291803918049180591806918079180891809918109181191812918139181491815918169181791818918199182091821918229182391824918259182691827918289182991830918319183291833918349183591836918379183891839918409184191842918439184491845918469184791848918499185091851918529185391854918559185691857918589185991860918619186291863918649186591866918679186891869918709187191872918739187491875918769187791878918799188091881918829188391884918859188691887918889188991890918919189291893918949189591896918979189891899919009190191902919039190491905919069190791908919099191091911919129191391914919159191691917919189191991920919219192291923919249192591926919279192891929919309193191932919339193491935919369193791938919399194091941919429194391944919459194691947919489194991950919519195291953919549195591956919579195891959919609196191962919639196491965919669196791968919699197091971919729197391974919759197691977919789197991980919819198291983919849198591986919879198891989919909199191992919939199491995919969199791998919999200092001920029200392004920059200692007920089200992010920119201292013920149201592016920179201892019920209202192022920239202492025920269202792028920299203092031920329203392034920359203692037920389203992040920419204292043920449204592046920479204892049920509205192052920539205492055920569205792058920599206092061920629206392064920659206692067920689206992070920719207292073920749207592076920779207892079920809208192082920839208492085920869208792088920899209092091920929209392094920959209692097920989209992100921019210292103921049210592106921079210892109921109211192112921139211492115921169211792118921199212092121921229212392124921259212692127921289212992130921319213292133921349213592136921379213892139921409214192142921439214492145921469214792148921499215092151921529215392154921559215692157921589215992160921619216292163921649216592166921679216892169921709217192172921739217492175921769217792178921799218092181921829218392184921859218692187921889218992190921919219292193921949219592196921979219892199922009220192202922039220492205922069220792208922099221092211922129221392214922159221692217922189221992220922219222292223922249222592226922279222892229922309223192232922339223492235922369223792238922399224092241922429224392244922459224692247922489224992250922519225292253922549225592256922579225892259922609226192262922639226492265922669226792268922699227092271922729227392274922759227692277922789227992280922819228292283922849228592286922879228892289922909229192292922939229492295922969229792298922999230092301923029230392304923059230692307923089230992310923119231292313923149231592316923179231892319923209232192322923239232492325923269232792328923299233092331923329233392334923359233692337923389233992340923419234292343923449234592346923479234892349923509235192352923539235492355923569235792358923599236092361923629236392364923659236692367923689236992370923719237292373923749237592376923779237892379923809238192382923839238492385923869238792388923899239092391923929239392394923959239692397923989239992400924019240292403924049240592406924079240892409924109241192412924139241492415924169241792418924199242092421924229242392424924259242692427924289242992430924319243292433924349243592436924379243892439924409244192442924439244492445924469244792448924499245092451924529245392454924559245692457924589245992460924619246292463924649246592466924679246892469924709247192472924739247492475924769247792478924799248092481924829248392484924859248692487924889248992490924919249292493924949249592496924979249892499925009250192502925039250492505925069250792508925099251092511925129251392514925159251692517925189251992520925219252292523925249252592526925279252892529925309253192532925339253492535925369253792538925399254092541925429254392544925459254692547925489254992550925519255292553925549255592556925579255892559925609256192562925639256492565925669256792568925699257092571925729257392574925759257692577925789257992580925819258292583925849258592586925879258892589925909259192592925939259492595925969259792598925999260092601926029260392604926059260692607926089260992610926119261292613926149261592616926179261892619926209262192622926239262492625926269262792628926299263092631926329263392634926359263692637926389263992640926419264292643926449264592646926479264892649926509265192652926539265492655926569265792658926599266092661926629266392664926659266692667926689266992670926719267292673926749267592676926779267892679926809268192682926839268492685926869268792688926899269092691926929269392694926959269692697926989269992700927019270292703927049270592706927079270892709927109271192712927139271492715927169271792718927199272092721927229272392724927259272692727927289272992730927319273292733927349273592736927379273892739927409274192742927439274492745927469274792748927499275092751927529275392754927559275692757927589275992760927619276292763927649276592766927679276892769927709277192772927739277492775927769277792778927799278092781927829278392784927859278692787927889278992790927919279292793927949279592796927979279892799928009280192802928039280492805928069280792808928099281092811928129281392814928159281692817928189281992820928219282292823928249282592826928279282892829928309283192832928339283492835928369283792838928399284092841928429284392844928459284692847928489284992850928519285292853928549285592856928579285892859928609286192862928639286492865928669286792868928699287092871928729287392874928759287692877928789287992880928819288292883928849288592886928879288892889928909289192892928939289492895928969289792898928999290092901929029290392904929059290692907929089290992910929119291292913929149291592916929179291892919929209292192922929239292492925929269292792928929299293092931929329293392934929359293692937929389293992940929419294292943929449294592946929479294892949929509295192952929539295492955929569295792958929599296092961929629296392964929659296692967929689296992970929719297292973929749297592976929779297892979929809298192982929839298492985929869298792988929899299092991929929299392994929959299692997929989299993000930019300293003930049300593006930079300893009930109301193012930139301493015930169301793018930199302093021930229302393024930259302693027930289302993030930319303293033930349303593036930379303893039930409304193042930439304493045930469304793048930499305093051930529305393054930559305693057930589305993060930619306293063930649306593066930679306893069930709307193072930739307493075930769307793078930799308093081930829308393084930859308693087930889308993090930919309293093930949309593096930979309893099931009310193102931039310493105931069310793108931099311093111931129311393114931159311693117931189311993120931219312293123931249312593126931279312893129931309313193132931339313493135931369313793138931399314093141931429314393144931459314693147931489314993150931519315293153931549315593156931579315893159931609316193162931639316493165931669316793168931699317093171931729317393174931759317693177931789317993180931819318293183931849318593186931879318893189931909319193192931939319493195931969319793198931999320093201932029320393204932059320693207932089320993210932119321293213932149321593216932179321893219932209322193222932239322493225932269322793228932299323093231932329323393234932359323693237932389323993240932419324293243932449324593246932479324893249932509325193252932539325493255932569325793258932599326093261932629326393264932659326693267932689326993270932719327293273932749327593276932779327893279932809328193282932839328493285932869328793288932899329093291932929329393294932959329693297932989329993300933019330293303933049330593306933079330893309933109331193312933139331493315933169331793318933199332093321933229332393324933259332693327933289332993330933319333293333933349333593336933379333893339933409334193342933439334493345933469334793348933499335093351933529335393354933559335693357933589335993360933619336293363933649336593366933679336893369933709337193372933739337493375933769337793378933799338093381933829338393384933859338693387933889338993390933919339293393933949339593396933979339893399934009340193402934039340493405934069340793408934099341093411934129341393414934159341693417934189341993420934219342293423934249342593426934279342893429934309343193432934339343493435934369343793438934399344093441934429344393444934459344693447934489344993450934519345293453934549345593456934579345893459934609346193462934639346493465934669346793468934699347093471934729347393474934759347693477934789347993480934819348293483934849348593486934879348893489934909349193492934939349493495934969349793498934999350093501935029350393504935059350693507935089350993510935119351293513935149351593516935179351893519935209352193522935239352493525935269352793528935299353093531935329353393534935359353693537935389353993540935419354293543935449354593546935479354893549935509355193552935539355493555935569355793558935599356093561935629356393564935659356693567935689356993570935719357293573935749357593576935779357893579935809358193582935839358493585935869358793588935899359093591935929359393594935959359693597935989359993600936019360293603936049360593606936079360893609936109361193612936139361493615936169361793618936199362093621936229362393624936259362693627936289362993630936319363293633936349363593636936379363893639936409364193642936439364493645936469364793648936499365093651936529365393654936559365693657936589365993660936619366293663936649366593666936679366893669936709367193672936739367493675936769367793678936799368093681936829368393684936859368693687936889368993690936919369293693936949369593696936979369893699937009370193702937039370493705937069370793708937099371093711937129371393714937159371693717937189371993720937219372293723937249372593726937279372893729937309373193732937339373493735937369373793738937399374093741937429374393744937459374693747937489374993750937519375293753937549375593756937579375893759937609376193762937639376493765937669376793768937699377093771937729377393774937759377693777937789377993780937819378293783937849378593786937879378893789937909379193792937939379493795937969379793798937999380093801938029380393804938059380693807938089380993810938119381293813938149381593816938179381893819938209382193822938239382493825938269382793828938299383093831938329383393834938359383693837938389383993840938419384293843938449384593846938479384893849938509385193852938539385493855938569385793858938599386093861938629386393864938659386693867938689386993870938719387293873938749387593876938779387893879938809388193882938839388493885938869388793888938899389093891938929389393894938959389693897938989389993900939019390293903939049390593906939079390893909939109391193912939139391493915939169391793918939199392093921939229392393924939259392693927939289392993930939319393293933939349393593936939379393893939939409394193942939439394493945939469394793948939499395093951939529395393954939559395693957939589395993960939619396293963939649396593966939679396893969939709397193972939739397493975939769397793978939799398093981939829398393984939859398693987939889398993990939919399293993939949399593996939979399893999940009400194002940039400494005940069400794008940099401094011940129401394014940159401694017940189401994020940219402294023940249402594026940279402894029940309403194032940339403494035940369403794038940399404094041940429404394044940459404694047940489404994050940519405294053940549405594056940579405894059940609406194062940639406494065940669406794068940699407094071940729407394074940759407694077940789407994080940819408294083940849408594086940879408894089940909409194092940939409494095940969409794098940999410094101941029410394104941059410694107941089410994110941119411294113941149411594116941179411894119941209412194122941239412494125941269412794128941299413094131941329413394134941359413694137941389413994140941419414294143941449414594146941479414894149941509415194152941539415494155941569415794158941599416094161941629416394164941659416694167941689416994170941719417294173941749417594176941779417894179941809418194182941839418494185941869418794188941899419094191941929419394194941959419694197941989419994200942019420294203942049420594206942079420894209942109421194212942139421494215942169421794218942199422094221942229422394224942259422694227942289422994230942319423294233942349423594236942379423894239942409424194242942439424494245942469424794248942499425094251942529425394254942559425694257942589425994260942619426294263942649426594266942679426894269942709427194272942739427494275942769427794278942799428094281942829428394284942859428694287942889428994290942919429294293942949429594296942979429894299943009430194302943039430494305943069430794308943099431094311943129431394314943159431694317943189431994320943219432294323943249432594326943279432894329943309433194332943339433494335943369433794338943399434094341943429434394344943459434694347943489434994350943519435294353943549435594356943579435894359943609436194362943639436494365943669436794368943699437094371943729437394374943759437694377943789437994380943819438294383943849438594386943879438894389943909439194392943939439494395943969439794398943999440094401944029440394404944059440694407944089440994410944119441294413944149441594416944179441894419944209442194422944239442494425944269442794428944299443094431944329443394434944359443694437944389443994440944419444294443944449444594446944479444894449944509445194452944539445494455944569445794458944599446094461944629446394464944659446694467944689446994470944719447294473944749447594476944779447894479944809448194482944839448494485944869448794488944899449094491944929449394494944959449694497944989449994500945019450294503945049450594506945079450894509945109451194512945139451494515945169451794518945199452094521945229452394524945259452694527945289452994530945319453294533945349453594536945379453894539945409454194542945439454494545945469454794548945499455094551945529455394554945559455694557945589455994560945619456294563945649456594566945679456894569945709457194572945739457494575945769457794578945799458094581945829458394584945859458694587945889458994590945919459294593945949459594596945979459894599946009460194602946039460494605946069460794608946099461094611946129461394614946159461694617946189461994620946219462294623946249462594626946279462894629946309463194632946339463494635946369463794638946399464094641946429464394644946459464694647946489464994650946519465294653946549465594656946579465894659946609466194662946639466494665946669466794668946699467094671946729467394674946759467694677946789467994680946819468294683946849468594686946879468894689946909469194692946939469494695946969469794698946999470094701947029470394704947059470694707947089470994710947119471294713947149471594716947179471894719947209472194722947239472494725947269472794728947299473094731947329473394734947359473694737947389473994740947419474294743947449474594746947479474894749947509475194752947539475494755947569475794758947599476094761947629476394764947659476694767947689476994770947719477294773947749477594776947779477894779947809478194782947839478494785947869478794788947899479094791947929479394794947959479694797947989479994800948019480294803948049480594806948079480894809948109481194812948139481494815948169481794818948199482094821948229482394824948259482694827948289482994830948319483294833948349483594836948379483894839948409484194842948439484494845948469484794848948499485094851948529485394854948559485694857948589485994860948619486294863948649486594866948679486894869948709487194872948739487494875948769487794878948799488094881948829488394884948859488694887948889488994890948919489294893948949489594896948979489894899949009490194902949039490494905949069490794908949099491094911949129491394914949159491694917949189491994920949219492294923949249492594926949279492894929949309493194932949339493494935949369493794938949399494094941949429494394944949459494694947949489494994950949519495294953949549495594956949579495894959949609496194962949639496494965949669496794968949699497094971949729497394974949759497694977949789497994980949819498294983949849498594986949879498894989949909499194992949939499494995949969499794998949999500095001950029500395004950059500695007950089500995010950119501295013950149501595016950179501895019950209502195022950239502495025950269502795028950299503095031950329503395034950359503695037950389503995040950419504295043950449504595046950479504895049950509505195052950539505495055950569505795058950599506095061950629506395064950659506695067950689506995070950719507295073950749507595076950779507895079950809508195082950839508495085950869508795088950899509095091950929509395094950959509695097950989509995100951019510295103951049510595106951079510895109951109511195112951139511495115951169511795118951199512095121951229512395124951259512695127951289512995130951319513295133951349513595136951379513895139951409514195142951439514495145951469514795148951499515095151951529515395154951559515695157951589515995160951619516295163951649516595166951679516895169951709517195172951739517495175951769517795178951799518095181951829518395184951859518695187951889518995190951919519295193951949519595196951979519895199952009520195202952039520495205952069520795208952099521095211952129521395214952159521695217952189521995220952219522295223952249522595226952279522895229952309523195232952339523495235952369523795238952399524095241952429524395244952459524695247952489524995250952519525295253952549525595256952579525895259952609526195262952639526495265952669526795268952699527095271952729527395274952759527695277952789527995280952819528295283952849528595286952879528895289952909529195292952939529495295952969529795298952999530095301953029530395304953059530695307953089530995310953119531295313953149531595316953179531895319953209532195322953239532495325953269532795328953299533095331953329533395334953359533695337953389533995340953419534295343953449534595346953479534895349953509535195352953539535495355953569535795358953599536095361953629536395364953659536695367953689536995370953719537295373953749537595376953779537895379953809538195382953839538495385953869538795388953899539095391953929539395394953959539695397953989539995400954019540295403954049540595406954079540895409954109541195412954139541495415954169541795418954199542095421954229542395424954259542695427954289542995430954319543295433954349543595436954379543895439954409544195442954439544495445954469544795448954499545095451954529545395454954559545695457954589545995460954619546295463954649546595466954679546895469954709547195472954739547495475954769547795478954799548095481954829548395484954859548695487954889548995490954919549295493954949549595496954979549895499955009550195502955039550495505955069550795508955099551095511955129551395514955159551695517955189551995520955219552295523955249552595526955279552895529955309553195532955339553495535955369553795538955399554095541955429554395544955459554695547955489554995550955519555295553955549555595556955579555895559955609556195562955639556495565955669556795568955699557095571955729557395574955759557695577955789557995580955819558295583955849558595586955879558895589955909559195592955939559495595955969559795598955999560095601956029560395604956059560695607956089560995610956119561295613956149561595616956179561895619956209562195622956239562495625956269562795628956299563095631956329563395634956359563695637956389563995640956419564295643956449564595646956479564895649956509565195652956539565495655956569565795658956599566095661956629566395664956659566695667956689566995670956719567295673956749567595676956779567895679956809568195682956839568495685956869568795688956899569095691956929569395694956959569695697956989569995700957019570295703957049570595706957079570895709957109571195712957139571495715957169571795718957199572095721957229572395724957259572695727957289572995730957319573295733957349573595736957379573895739957409574195742957439574495745957469574795748957499575095751957529575395754957559575695757957589575995760957619576295763957649576595766957679576895769957709577195772957739577495775957769577795778957799578095781957829578395784957859578695787957889578995790957919579295793957949579595796957979579895799958009580195802958039580495805958069580795808958099581095811958129581395814958159581695817958189581995820958219582295823958249582595826958279582895829958309583195832958339583495835958369583795838958399584095841958429584395844958459584695847958489584995850958519585295853958549585595856958579585895859958609586195862958639586495865958669586795868958699587095871958729587395874958759587695877958789587995880958819588295883958849588595886958879588895889958909589195892958939589495895958969589795898958999590095901959029590395904959059590695907959089590995910959119591295913959149591595916959179591895919959209592195922959239592495925959269592795928959299593095931959329593395934959359593695937959389593995940959419594295943959449594595946959479594895949959509595195952959539595495955959569595795958959599596095961959629596395964959659596695967959689596995970959719597295973959749597595976959779597895979959809598195982959839598495985959869598795988959899599095991959929599395994959959599695997959989599996000960019600296003960049600596006960079600896009960109601196012960139601496015960169601796018960199602096021960229602396024960259602696027960289602996030960319603296033960349603596036960379603896039960409604196042960439604496045960469604796048960499605096051960529605396054960559605696057960589605996060960619606296063960649606596066960679606896069960709607196072960739607496075960769607796078960799608096081960829608396084960859608696087960889608996090960919609296093960949609596096960979609896099961009610196102961039610496105961069610796108961099611096111961129611396114961159611696117961189611996120961219612296123961249612596126961279612896129961309613196132961339613496135961369613796138961399614096141961429614396144961459614696147961489614996150961519615296153961549615596156961579615896159961609616196162961639616496165961669616796168961699617096171961729617396174961759617696177961789617996180961819618296183961849618596186961879618896189961909619196192961939619496195961969619796198961999620096201962029620396204962059620696207962089620996210962119621296213962149621596216962179621896219962209622196222962239622496225962269622796228962299623096231962329623396234962359623696237962389623996240962419624296243962449624596246962479624896249962509625196252962539625496255962569625796258962599626096261962629626396264962659626696267962689626996270962719627296273962749627596276962779627896279962809628196282962839628496285962869628796288962899629096291962929629396294962959629696297962989629996300963019630296303963049630596306963079630896309963109631196312963139631496315963169631796318963199632096321963229632396324963259632696327963289632996330963319633296333963349633596336963379633896339963409634196342963439634496345963469634796348963499635096351963529635396354963559635696357963589635996360963619636296363963649636596366963679636896369963709637196372963739637496375963769637796378963799638096381963829638396384963859638696387963889638996390963919639296393963949639596396963979639896399964009640196402964039640496405964069640796408964099641096411964129641396414964159641696417964189641996420964219642296423964249642596426964279642896429964309643196432964339643496435964369643796438964399644096441964429644396444964459644696447964489644996450964519645296453964549645596456964579645896459964609646196462964639646496465964669646796468964699647096471964729647396474964759647696477964789647996480964819648296483964849648596486964879648896489964909649196492964939649496495964969649796498964999650096501965029650396504965059650696507965089650996510965119651296513965149651596516965179651896519965209652196522965239652496525965269652796528965299653096531965329653396534965359653696537965389653996540965419654296543965449654596546965479654896549965509655196552965539655496555965569655796558965599656096561965629656396564965659656696567965689656996570965719657296573965749657596576965779657896579965809658196582965839658496585965869658796588965899659096591965929659396594965959659696597965989659996600966019660296603966049660596606966079660896609966109661196612966139661496615966169661796618966199662096621966229662396624966259662696627966289662996630966319663296633966349663596636966379663896639966409664196642966439664496645966469664796648966499665096651966529665396654966559665696657966589665996660966619666296663966649666596666966679666896669966709667196672966739667496675966769667796678966799668096681966829668396684966859668696687966889668996690966919669296693966949669596696966979669896699967009670196702967039670496705967069670796708967099671096711967129671396714967159671696717967189671996720967219672296723967249672596726967279672896729967309673196732967339673496735967369673796738967399674096741967429674396744967459674696747967489674996750967519675296753967549675596756967579675896759967609676196762967639676496765967669676796768967699677096771967729677396774967759677696777967789677996780967819678296783967849678596786967879678896789967909679196792967939679496795967969679796798967999680096801968029680396804968059680696807968089680996810968119681296813968149681596816968179681896819968209682196822968239682496825968269682796828968299683096831968329683396834968359683696837968389683996840968419684296843968449684596846968479684896849968509685196852968539685496855968569685796858968599686096861968629686396864968659686696867968689686996870968719687296873968749687596876968779687896879968809688196882968839688496885968869688796888968899689096891968929689396894968959689696897968989689996900969019690296903969049690596906969079690896909969109691196912969139691496915969169691796918969199692096921969229692396924969259692696927969289692996930969319693296933969349693596936969379693896939969409694196942969439694496945969469694796948969499695096951969529695396954969559695696957969589695996960969619696296963969649696596966969679696896969969709697196972969739697496975969769697796978969799698096981969829698396984969859698696987969889698996990969919699296993969949699596996969979699896999970009700197002970039700497005970069700797008970099701097011970129701397014970159701697017970189701997020970219702297023970249702597026970279702897029970309703197032970339703497035970369703797038970399704097041970429704397044970459704697047970489704997050970519705297053970549705597056970579705897059970609706197062970639706497065970669706797068970699707097071970729707397074970759707697077970789707997080970819708297083970849708597086970879708897089970909709197092970939709497095970969709797098970999710097101971029710397104971059710697107971089710997110971119711297113971149711597116971179711897119971209712197122971239712497125971269712797128971299713097131971329713397134971359713697137971389713997140971419714297143971449714597146971479714897149971509715197152971539715497155971569715797158971599716097161971629716397164971659716697167971689716997170971719717297173971749717597176971779717897179971809718197182971839718497185971869718797188971899719097191971929719397194971959719697197971989719997200972019720297203972049720597206972079720897209972109721197212972139721497215972169721797218972199722097221972229722397224972259722697227972289722997230972319723297233972349723597236972379723897239972409724197242972439724497245972469724797248972499725097251972529725397254972559725697257972589725997260972619726297263972649726597266972679726897269972709727197272972739727497275972769727797278972799728097281972829728397284972859728697287972889728997290972919729297293972949729597296972979729897299973009730197302973039730497305973069730797308973099731097311973129731397314973159731697317973189731997320973219732297323973249732597326973279732897329973309733197332973339733497335973369733797338973399734097341973429734397344973459734697347973489734997350973519735297353973549735597356973579735897359973609736197362973639736497365973669736797368973699737097371973729737397374973759737697377973789737997380973819738297383973849738597386973879738897389973909739197392973939739497395973969739797398973999740097401974029740397404974059740697407974089740997410974119741297413974149741597416974179741897419974209742197422974239742497425974269742797428974299743097431974329743397434974359743697437974389743997440974419744297443974449744597446974479744897449974509745197452974539745497455974569745797458974599746097461974629746397464974659746697467974689746997470974719747297473974749747597476974779747897479974809748197482974839748497485974869748797488974899749097491974929749397494974959749697497974989749997500975019750297503975049750597506975079750897509975109751197512975139751497515975169751797518975199752097521975229752397524975259752697527975289752997530975319753297533975349753597536975379753897539975409754197542975439754497545975469754797548975499755097551975529755397554975559755697557975589755997560975619756297563975649756597566975679756897569975709757197572975739757497575975769757797578975799758097581975829758397584975859758697587975889758997590975919759297593975949759597596975979759897599976009760197602976039760497605976069760797608976099761097611976129761397614976159761697617976189761997620976219762297623976249762597626976279762897629976309763197632976339763497635976369763797638976399764097641976429764397644976459764697647976489764997650976519765297653976549765597656976579765897659976609766197662976639766497665976669766797668976699767097671976729767397674976759767697677976789767997680976819768297683976849768597686976879768897689976909769197692976939769497695976969769797698976999770097701977029770397704977059770697707977089770997710977119771297713977149771597716977179771897719977209772197722977239772497725977269772797728977299773097731977329773397734977359773697737977389773997740977419774297743977449774597746977479774897749977509775197752977539775497755977569775797758977599776097761977629776397764977659776697767977689776997770977719777297773977749777597776977779777897779977809778197782977839778497785977869778797788977899779097791977929779397794977959779697797977989779997800978019780297803978049780597806978079780897809978109781197812978139781497815978169781797818978199782097821978229782397824978259782697827978289782997830978319783297833978349783597836978379783897839978409784197842978439784497845978469784797848978499785097851978529785397854978559785697857978589785997860978619786297863978649786597866978679786897869978709787197872978739787497875978769787797878978799788097881978829788397884978859788697887978889788997890978919789297893978949789597896978979789897899979009790197902979039790497905979069790797908979099791097911979129791397914979159791697917979189791997920979219792297923979249792597926979279792897929979309793197932979339793497935979369793797938979399794097941979429794397944979459794697947979489794997950979519795297953979549795597956979579795897959979609796197962979639796497965979669796797968979699797097971979729797397974979759797697977979789797997980979819798297983979849798597986979879798897989979909799197992979939799497995979969799797998979999800098001980029800398004980059800698007980089800998010980119801298013980149801598016980179801898019980209802198022980239802498025980269802798028980299803098031980329803398034980359803698037980389803998040980419804298043980449804598046980479804898049980509805198052980539805498055980569805798058980599806098061980629806398064980659806698067980689806998070980719807298073980749807598076980779807898079980809808198082980839808498085980869808798088980899809098091980929809398094980959809698097980989809998100981019810298103981049810598106981079810898109981109811198112981139811498115981169811798118981199812098121981229812398124981259812698127981289812998130981319813298133981349813598136981379813898139981409814198142981439814498145981469814798148981499815098151981529815398154981559815698157981589815998160981619816298163981649816598166981679816898169981709817198172981739817498175981769817798178981799818098181981829818398184981859818698187981889818998190981919819298193981949819598196981979819898199982009820198202982039820498205982069820798208982099821098211982129821398214982159821698217982189821998220982219822298223982249822598226982279822898229982309823198232982339823498235982369823798238982399824098241982429824398244982459824698247982489824998250982519825298253982549825598256982579825898259982609826198262982639826498265982669826798268982699827098271982729827398274982759827698277982789827998280982819828298283982849828598286982879828898289982909829198292982939829498295982969829798298982999830098301983029830398304983059830698307983089830998310983119831298313983149831598316983179831898319983209832198322983239832498325983269832798328983299833098331983329833398334983359833698337983389833998340983419834298343983449834598346983479834898349983509835198352983539835498355983569835798358983599836098361983629836398364983659836698367983689836998370983719837298373983749837598376983779837898379983809838198382983839838498385983869838798388983899839098391983929839398394983959839698397983989839998400984019840298403984049840598406984079840898409984109841198412984139841498415984169841798418984199842098421984229842398424984259842698427984289842998430984319843298433984349843598436984379843898439984409844198442984439844498445984469844798448984499845098451984529845398454984559845698457984589845998460984619846298463984649846598466984679846898469984709847198472984739847498475984769847798478984799848098481984829848398484984859848698487984889848998490984919849298493984949849598496984979849898499985009850198502985039850498505985069850798508985099851098511985129851398514985159851698517985189851998520985219852298523985249852598526985279852898529985309853198532985339853498535985369853798538985399854098541985429854398544985459854698547985489854998550985519855298553985549855598556985579855898559985609856198562985639856498565985669856798568985699857098571985729857398574985759857698577985789857998580985819858298583985849858598586985879858898589985909859198592985939859498595985969859798598985999860098601986029860398604986059860698607986089860998610986119861298613986149861598616986179861898619986209862198622986239862498625986269862798628986299863098631986329863398634986359863698637986389863998640986419864298643986449864598646986479864898649986509865198652986539865498655986569865798658986599866098661986629866398664986659866698667986689866998670986719867298673986749867598676986779867898679986809868198682986839868498685986869868798688986899869098691986929869398694986959869698697986989869998700987019870298703987049870598706987079870898709987109871198712987139871498715987169871798718987199872098721987229872398724987259872698727987289872998730987319873298733987349873598736987379873898739987409874198742987439874498745987469874798748987499875098751987529875398754987559875698757987589875998760987619876298763987649876598766987679876898769987709877198772987739877498775987769877798778987799878098781987829878398784987859878698787987889878998790987919879298793987949879598796987979879898799988009880198802988039880498805988069880798808988099881098811988129881398814988159881698817988189881998820988219882298823988249882598826988279882898829988309883198832988339883498835988369883798838988399884098841988429884398844988459884698847988489884998850988519885298853988549885598856988579885898859988609886198862988639886498865988669886798868988699887098871988729887398874988759887698877988789887998880988819888298883988849888598886988879888898889988909889198892988939889498895988969889798898988999890098901989029890398904989059890698907989089890998910989119891298913989149891598916989179891898919989209892198922989239892498925989269892798928989299893098931989329893398934989359893698937989389893998940989419894298943989449894598946989479894898949989509895198952989539895498955989569895798958989599896098961989629896398964989659896698967989689896998970989719897298973989749897598976989779897898979989809898198982989839898498985989869898798988989899899098991989929899398994989959899698997989989899999000990019900299003990049900599006990079900899009990109901199012990139901499015990169901799018990199902099021990229902399024990259902699027990289902999030990319903299033990349903599036990379903899039990409904199042990439904499045990469904799048990499905099051990529905399054990559905699057990589905999060990619906299063990649906599066990679906899069990709907199072990739907499075990769907799078990799908099081990829908399084990859908699087990889908999090990919909299093990949909599096990979909899099991009910199102991039910499105991069910799108991099911099111991129911399114991159911699117991189911999120991219912299123991249912599126991279912899129991309913199132991339913499135991369913799138991399914099141991429914399144991459914699147991489914999150991519915299153991549915599156991579915899159991609916199162991639916499165991669916799168991699917099171991729917399174991759917699177991789917999180991819918299183991849918599186991879918899189991909919199192991939919499195991969919799198991999920099201992029920399204992059920699207992089920999210992119921299213992149921599216992179921899219992209922199222992239922499225992269922799228992299923099231992329923399234992359923699237992389923999240992419924299243992449924599246992479924899249992509925199252992539925499255992569925799258992599926099261992629926399264992659926699267992689926999270992719927299273992749927599276992779927899279992809928199282992839928499285992869928799288992899929099291992929929399294992959929699297992989929999300993019930299303993049930599306993079930899309993109931199312993139931499315993169931799318993199932099321993229932399324993259932699327993289932999330993319933299333993349933599336993379933899339993409934199342993439934499345993469934799348993499935099351993529935399354993559935699357993589935999360993619936299363993649936599366993679936899369993709937199372993739937499375993769937799378993799938099381993829938399384993859938699387993889938999390993919939299393993949939599396993979939899399994009940199402994039940499405994069940799408994099941099411994129941399414994159941699417994189941999420994219942299423994249942599426994279942899429994309943199432994339943499435994369943799438994399944099441994429944399444994459944699447994489944999450994519945299453994549945599456994579945899459994609946199462994639946499465994669946799468994699947099471994729947399474994759947699477994789947999480994819948299483994849948599486994879948899489994909949199492994939949499495994969949799498994999950099501995029950399504995059950699507995089950999510995119951299513995149951599516995179951899519995209952199522995239952499525995269952799528995299953099531995329953399534995359953699537995389953999540995419954299543995449954599546995479954899549995509955199552995539955499555995569955799558995599956099561995629956399564995659956699567995689956999570995719957299573995749957599576995779957899579995809958199582995839958499585995869958799588995899959099591995929959399594995959959699597995989959999600996019960299603996049960599606996079960899609996109961199612996139961499615996169961799618996199962099621996229962399624996259962699627996289962999630996319963299633996349963599636996379963899639996409964199642996439964499645996469964799648996499965099651996529965399654996559965699657996589965999660996619966299663996649966599666996679966899669996709967199672996739967499675996769967799678996799968099681996829968399684996859968699687996889968999690996919969299693996949969599696996979969899699997009970199702997039970499705997069970799708997099971099711997129971399714997159971699717997189971999720997219972299723997249972599726997279972899729997309973199732997339973499735997369973799738997399974099741997429974399744997459974699747997489974999750997519975299753997549975599756997579975899759997609976199762997639976499765997669976799768997699977099771997729977399774997759977699777997789977999780997819978299783997849978599786997879978899789997909979199792997939979499795997969979799798997999980099801998029980399804998059980699807998089980999810998119981299813998149981599816998179981899819998209982199822998239982499825998269982799828998299983099831998329983399834998359983699837998389983999840998419984299843998449984599846998479984899849998509985199852998539985499855998569985799858998599986099861998629986399864998659986699867998689986999870998719987299873998749987599876998779987899879998809988199882998839988499885998869988799888998899989099891998929989399894998959989699897998989989999900999019990299903999049990599906999079990899909999109991199912999139991499915999169991799918999199992099921999229992399924999259992699927999289992999930999319993299933999349993599936999379993899939999409994199942999439994499945999469994799948999499995099951999529995399954999559995699957999589995999960999619996299963999649996599966999679996899969999709997199972999739997499975999769997799978999799998099981999829998399984999859998699987999889998999990999919999299993999949999599996999979999899999100000100001100002100003100004100005100006100007100008100009100010100011100012100013100014100015100016100017100018100019100020100021100022100023100024100025100026100027100028100029100030100031100032100033100034100035100036100037100038100039100040100041100042100043100044100045100046100047100048100049100050100051100052100053100054100055100056100057100058100059100060100061100062100063100064100065100066100067100068100069100070100071100072100073100074100075100076100077100078100079100080100081100082100083100084100085100086100087100088100089100090100091100092100093100094100095100096100097100098100099100100100101100102100103100104100105100106100107100108100109100110100111100112100113100114100115100116100117100118100119100120100121100122100123100124100125100126100127100128100129100130100131100132100133100134100135100136100137100138100139100140100141100142100143100144100145100146100147100148100149100150100151100152100153100154100155100156100157100158100159100160100161100162100163100164100165100166100167100168100169100170100171100172100173100174100175100176100177100178100179100180100181100182100183100184100185100186100187100188100189100190100191100192100193100194100195100196100197100198100199100200100201100202100203100204100205100206100207100208100209100210100211100212100213100214100215100216100217100218100219100220100221100222100223100224100225100226100227100228100229100230100231100232100233100234100235100236100237100238100239100240100241100242100243100244100245100246100247100248100249100250100251100252100253100254100255100256100257100258100259100260100261100262100263100264100265100266100267100268100269100270100271100272100273100274100275100276100277100278100279100280100281100282100283100284100285100286100287100288100289100290100291100292100293100294100295100296100297100298100299100300100301100302100303100304100305100306100307100308100309100310100311100312100313100314100315100316100317100318100319100320100321100322100323100324100325100326100327100328100329100330100331100332100333100334100335100336100337100338100339100340100341100342100343100344100345100346100347100348100349100350100351100352100353100354100355100356100357100358100359100360100361100362100363100364100365100366100367100368100369100370100371100372100373100374100375100376100377100378100379100380100381100382100383100384100385100386100387100388100389100390100391100392100393100394100395100396100397100398100399100400100401100402100403100404100405100406100407100408100409100410100411100412100413100414100415100416100417100418100419100420100421100422100423100424100425100426100427100428100429100430100431100432100433100434100435100436100437100438100439100440100441100442100443100444100445100446100447100448100449100450100451100452100453100454100455100456100457100458100459100460100461100462100463100464100465100466100467100468100469100470100471100472100473100474100475100476100477100478100479100480100481100482100483100484100485100486100487100488100489100490100491100492100493100494100495100496100497100498100499100500100501100502100503100504100505100506100507100508100509100510100511100512100513100514100515100516100517100518100519100520100521100522100523100524100525100526100527100528100529100530100531100532100533100534100535100536100537100538100539100540100541100542100543100544100545100546100547100548100549100550100551100552100553100554100555100556100557100558100559100560100561100562100563100564100565100566100567100568100569100570100571100572100573100574100575100576100577100578100579100580100581100582100583100584100585100586100587100588100589100590100591100592100593100594100595100596100597100598100599100600100601100602100603100604100605100606100607100608100609100610100611100612100613100614100615100616100617100618100619100620100621100622100623100624100625100626100627100628100629100630100631100632100633100634100635100636100637100638100639100640100641100642100643100644100645100646100647100648100649100650100651100652100653100654100655100656100657100658100659100660100661100662100663100664100665100666100667100668100669100670100671100672100673100674100675100676100677100678100679100680100681100682100683100684100685100686100687100688100689100690100691100692100693100694100695100696100697100698100699100700100701100702100703100704100705100706100707100708100709100710100711100712100713100714100715100716100717100718100719100720100721100722100723100724100725100726100727100728100729100730100731100732100733100734100735100736100737100738100739100740100741100742100743100744100745100746100747100748100749100750100751100752100753100754100755100756100757100758100759100760100761100762100763100764100765100766100767100768100769100770100771100772100773100774100775100776100777100778100779100780100781100782100783100784100785100786100787100788100789100790100791100792100793100794100795100796100797100798100799100800100801100802100803100804100805100806100807100808100809100810100811100812100813100814100815100816100817100818100819100820100821100822100823100824100825100826100827100828100829100830100831100832100833100834100835100836100837100838100839100840100841100842100843100844100845100846100847100848100849100850100851100852100853100854100855100856100857100858100859100860100861100862100863100864100865100866100867100868100869100870100871100872100873100874100875100876100877100878100879100880100881100882100883100884100885100886100887100888100889100890100891100892100893100894100895100896100897100898100899100900100901100902100903100904100905100906100907100908100909100910100911100912100913100914100915100916100917100918100919100920100921100922100923100924100925100926100927100928100929100930100931100932100933100934100935100936100937100938100939100940100941100942100943100944100945100946100947100948100949100950100951100952100953100954100955100956100957100958100959100960100961100962100963100964100965100966100967100968100969100970100971100972100973100974100975100976100977100978100979100980100981100982100983100984100985100986100987100988100989100990100991100992100993100994100995100996100997100998100999101000101001101002101003101004101005101006101007101008101009101010101011101012101013101014101015101016101017101018101019101020101021101022101023101024101025101026101027101028101029101030101031101032101033101034101035101036101037101038101039101040101041101042101043101044101045101046101047101048101049101050101051101052101053101054101055101056101057101058101059101060101061101062101063101064101065101066101067101068101069101070101071101072101073101074101075101076101077101078101079101080101081101082101083101084101085101086101087101088101089101090101091101092101093101094101095101096101097101098101099101100101101101102101103101104101105101106101107101108101109101110101111101112101113101114101115101116101117101118101119101120101121101122101123101124101125101126101127101128101129101130101131101132101133101134101135101136101137101138101139101140101141101142101143101144101145101146101147101148101149101150101151101152101153101154101155101156101157101158101159101160101161101162101163101164101165101166101167101168101169101170101171101172101173101174101175101176101177101178101179101180101181101182101183101184101185101186101187101188101189101190101191101192101193101194101195101196101197101198101199101200101201101202101203101204101205101206101207101208101209101210101211101212101213101214101215101216101217101218101219101220101221101222101223101224101225101226101227101228101229101230101231101232101233101234101235101236101237101238101239101240101241101242101243101244101245101246101247101248101249101250101251101252101253101254101255101256101257101258101259101260101261101262101263101264101265101266101267101268101269101270101271101272101273101274101275101276101277101278101279101280101281101282101283101284101285101286101287101288101289101290101291101292101293101294101295101296101297101298101299101300101301101302101303101304101305101306101307101308101309101310101311101312101313101314101315101316101317101318101319101320101321101322101323101324101325101326101327101328101329101330101331101332101333101334101335101336101337101338101339101340101341101342101343101344101345101346101347101348101349101350101351101352101353101354101355101356101357101358101359101360101361101362101363101364101365101366101367101368101369101370101371101372101373101374101375101376101377101378101379101380101381101382101383101384101385101386101387101388101389101390101391101392101393101394101395101396101397101398101399101400101401101402101403101404101405101406101407101408101409101410101411101412101413101414101415101416101417101418101419101420101421101422101423101424101425101426101427101428101429101430101431101432101433101434101435101436101437101438101439101440101441101442101443101444101445101446101447101448101449101450101451101452101453101454101455101456101457101458101459101460101461101462101463101464101465101466101467101468101469101470101471101472101473101474101475101476101477101478101479101480101481101482101483101484101485101486101487101488101489101490101491101492101493101494101495101496101497101498101499101500101501101502101503101504101505101506101507101508101509101510101511101512101513101514101515101516101517101518101519101520101521101522101523101524101525101526101527101528101529101530101531101532101533101534101535101536101537101538101539101540101541101542101543101544101545101546101547101548101549101550101551101552101553101554101555101556101557101558101559101560101561101562101563101564101565101566101567101568101569101570101571101572101573101574101575101576101577101578101579101580101581101582101583101584101585101586101587101588101589101590101591101592101593101594101595101596101597101598101599101600101601101602101603101604101605101606101607101608101609101610101611101612101613101614101615101616101617101618101619101620101621101622101623101624101625101626101627101628101629101630101631101632101633101634101635101636101637101638101639101640101641101642101643101644101645101646101647101648101649101650101651101652101653101654101655101656101657101658101659101660101661101662101663101664101665101666101667101668101669101670101671101672101673101674101675101676101677101678101679101680101681101682101683101684101685101686101687101688101689101690101691101692101693101694101695101696101697101698101699101700101701101702101703101704101705101706101707101708101709101710101711101712101713101714101715101716101717101718101719101720101721101722101723101724101725101726101727101728101729101730101731101732101733101734101735101736101737101738101739101740101741101742101743101744101745101746101747101748101749101750101751101752101753101754101755101756101757101758101759101760101761101762101763101764101765101766101767101768101769101770101771101772101773101774101775101776101777101778101779101780101781101782101783101784101785101786101787101788101789101790101791101792101793101794101795101796101797101798101799101800101801101802101803101804101805101806101807101808101809101810101811101812101813101814101815101816101817101818101819101820101821101822101823101824101825101826101827101828101829101830101831101832101833101834101835101836101837101838101839101840101841101842101843101844101845101846101847101848101849101850101851101852101853101854101855101856101857101858101859101860101861101862101863101864101865101866101867101868101869101870101871101872101873101874101875101876101877101878101879101880101881101882101883101884101885101886101887101888101889101890101891101892101893101894101895101896101897101898101899101900101901101902101903101904101905101906101907101908101909101910101911101912101913101914101915101916101917101918101919101920101921101922101923101924101925101926101927101928101929101930101931101932101933101934101935101936101937101938101939101940101941101942101943101944101945101946101947101948101949101950101951101952101953101954101955101956101957101958101959101960101961101962101963101964101965101966101967101968101969101970101971101972101973101974101975101976101977101978101979101980101981101982101983101984101985101986101987101988101989101990101991101992101993101994101995101996101997101998101999102000102001102002102003102004102005102006102007102008102009102010102011102012102013102014102015102016102017102018102019102020102021102022102023102024102025102026102027102028102029102030102031102032102033102034102035102036102037102038102039102040102041102042102043102044102045102046102047102048102049102050102051102052102053102054102055102056102057102058102059102060102061102062102063102064102065102066102067102068102069102070102071102072102073102074102075102076102077102078102079102080102081102082102083102084102085102086102087102088102089102090102091102092102093102094102095102096102097102098102099102100102101102102102103102104102105102106102107102108102109102110102111102112102113102114102115102116102117102118102119102120102121102122102123102124102125102126102127102128102129102130102131102132102133102134102135102136102137102138102139102140102141102142102143102144102145102146102147102148102149102150102151102152102153102154102155102156102157102158102159102160102161102162102163102164102165102166102167102168102169102170102171102172102173102174102175102176102177102178102179102180102181102182102183102184102185102186102187102188102189102190102191102192102193102194102195102196102197102198102199102200102201102202102203102204102205102206102207102208102209102210102211102212102213102214102215102216102217102218102219102220102221102222102223102224102225102226102227102228102229102230102231102232102233102234102235102236102237102238102239102240102241102242102243102244102245102246102247102248102249102250102251102252102253102254102255102256102257102258102259102260102261102262102263102264102265102266102267102268102269102270102271102272102273102274102275102276102277102278102279102280102281102282102283102284102285102286102287102288102289102290102291102292102293102294102295102296102297102298102299102300102301102302102303102304102305102306102307102308102309102310102311102312102313102314102315102316102317102318102319102320102321102322102323102324102325102326102327102328102329102330102331102332102333102334102335102336102337102338102339102340102341102342102343102344102345102346102347102348102349102350102351102352102353102354102355102356102357102358102359102360102361102362102363102364102365102366102367102368102369102370102371102372102373102374102375102376102377102378102379102380102381102382102383102384102385102386102387102388102389102390102391102392102393102394102395102396102397102398102399102400102401102402102403102404102405102406102407102408102409102410102411102412102413102414102415102416102417102418102419102420102421102422102423102424102425102426102427102428102429102430102431102432102433102434102435102436102437102438102439102440102441102442102443102444102445102446102447102448102449102450102451102452102453102454102455102456102457102458102459102460102461102462102463102464102465102466102467102468102469102470102471102472102473102474102475102476102477102478102479102480102481102482102483102484102485102486102487102488102489102490102491102492102493102494102495102496102497102498102499102500102501102502102503102504102505102506102507102508102509102510102511102512102513102514102515102516102517102518102519102520102521102522102523102524102525102526102527102528102529102530102531102532102533102534102535102536102537102538102539102540102541102542102543102544102545102546102547102548102549102550102551102552102553102554102555102556102557102558102559102560102561102562102563102564102565102566102567102568102569102570102571102572102573102574102575102576102577102578102579102580102581102582102583102584102585102586102587102588102589102590102591102592102593102594102595102596102597102598102599102600102601102602102603102604102605102606102607102608102609102610102611102612102613102614102615102616102617102618102619102620102621102622102623102624102625102626102627102628102629102630102631102632102633102634102635102636102637102638102639102640102641102642102643102644102645102646102647102648102649102650102651102652102653102654102655102656102657102658102659102660102661102662102663102664102665102666102667102668102669102670102671102672102673102674102675102676102677102678102679102680102681102682102683102684102685102686102687102688102689102690102691102692102693102694102695102696102697102698102699102700102701102702102703102704102705102706102707102708102709102710102711102712102713102714102715102716102717102718102719102720102721102722102723102724102725102726102727102728102729102730102731102732102733102734102735102736102737102738102739102740102741102742102743102744102745102746102747102748102749102750102751102752102753102754102755102756102757102758102759102760102761102762102763102764102765102766102767102768102769102770102771102772102773102774102775102776102777102778102779102780102781102782102783102784102785102786102787102788102789102790102791102792102793102794102795102796102797102798102799102800102801102802102803102804102805102806102807102808102809102810102811102812102813102814102815102816102817102818102819102820102821102822102823102824102825102826102827102828102829102830102831102832102833102834102835102836102837102838102839102840102841102842102843102844102845102846102847102848102849102850102851102852102853102854102855102856102857102858102859102860102861102862102863102864102865102866102867102868102869102870102871102872102873102874102875102876102877102878102879102880102881102882102883102884102885102886102887102888102889102890102891102892102893102894102895102896102897102898102899102900102901102902102903102904102905102906102907102908102909102910102911102912102913102914102915102916102917102918102919102920102921102922102923102924102925102926102927102928102929102930102931102932102933102934102935102936102937102938102939102940102941102942102943102944102945102946102947102948102949102950102951102952102953102954102955102956102957102958102959102960102961102962102963102964102965102966102967102968102969102970102971102972102973102974102975102976102977102978102979102980102981102982102983102984102985102986102987102988102989102990102991102992102993102994102995102996102997102998102999103000103001103002103003103004103005103006103007103008103009103010103011103012103013103014103015103016103017103018103019103020103021103022103023103024103025103026103027103028103029103030103031103032103033103034103035103036103037103038103039103040103041103042103043103044103045103046103047103048103049103050103051103052103053103054103055103056103057103058103059103060103061103062103063103064103065103066103067103068103069103070103071103072103073103074103075103076103077103078103079103080103081103082103083103084103085103086103087103088103089103090103091103092103093103094103095103096103097103098103099103100103101103102103103103104103105103106103107103108103109103110103111103112103113103114103115103116103117103118103119103120103121103122103123103124103125103126103127103128103129103130103131103132103133103134103135103136103137103138103139103140103141103142103143103144103145103146103147103148103149103150103151103152103153103154103155103156103157103158103159103160103161103162103163103164103165103166103167103168103169103170103171103172103173103174103175103176103177103178103179103180103181103182103183103184103185103186103187103188103189103190103191103192103193103194103195103196103197103198103199103200103201103202103203103204103205103206103207103208103209103210103211103212103213103214103215103216103217103218103219103220103221103222103223103224103225103226103227103228103229103230103231103232103233103234103235103236103237103238103239103240103241103242103243103244103245103246103247103248103249103250103251103252103253103254103255103256103257103258103259103260103261103262103263103264103265103266103267103268103269103270103271103272103273103274103275103276103277103278103279103280103281103282103283103284103285103286103287103288103289103290103291103292103293103294103295103296103297103298103299103300103301103302103303103304103305103306103307103308103309103310103311103312103313103314103315103316103317103318103319103320103321103322103323103324103325103326103327103328103329103330103331103332103333103334103335103336103337103338103339103340103341103342103343103344103345103346103347103348103349103350103351103352103353103354103355103356103357103358103359103360103361103362103363103364103365103366103367103368103369103370103371103372103373103374103375103376103377103378103379103380103381103382103383103384103385103386103387103388103389103390103391103392103393103394103395103396103397103398103399103400103401103402103403103404103405103406103407103408103409103410103411103412103413103414103415103416103417103418103419103420103421103422103423103424103425103426103427103428103429103430103431103432103433103434103435103436103437103438103439103440103441103442103443103444103445103446103447103448103449103450103451103452103453103454103455103456103457103458103459103460103461103462103463103464103465103466103467103468103469103470103471103472103473103474103475103476103477103478103479103480103481103482103483103484103485103486103487103488103489103490103491103492103493103494103495103496103497103498103499103500103501103502103503103504103505103506103507103508103509103510103511103512103513103514103515103516103517103518103519103520103521103522103523103524103525103526103527103528103529103530103531103532103533103534103535103536103537103538103539103540103541103542103543103544103545103546103547103548103549103550103551103552103553103554103555103556103557103558103559103560103561103562103563103564103565103566103567103568103569103570103571103572103573103574103575103576103577103578103579103580103581103582103583103584103585103586103587103588103589103590103591103592103593103594103595103596103597103598103599103600103601103602103603103604103605103606103607103608103609103610103611103612103613103614103615103616103617103618103619103620103621103622103623103624103625103626103627103628103629103630103631103632103633103634103635103636103637103638103639103640103641103642103643103644103645103646103647103648103649103650103651103652103653103654103655103656103657103658103659103660103661103662103663103664103665103666103667103668103669103670103671103672103673103674103675103676103677103678103679103680103681103682103683103684103685103686103687103688103689103690103691103692103693103694103695103696103697103698103699103700103701103702103703103704103705103706103707103708103709103710103711103712103713103714103715103716103717103718103719103720103721103722103723103724103725103726103727103728103729103730103731103732103733103734103735103736103737103738103739103740103741103742103743103744103745103746103747103748103749103750103751103752103753103754103755103756103757103758103759103760103761103762103763103764103765103766103767103768103769103770103771103772103773103774103775103776103777103778103779103780103781103782103783103784103785103786103787103788103789103790103791103792103793103794103795103796103797103798103799103800103801103802103803103804103805103806103807103808103809103810103811103812103813103814103815103816103817103818103819103820103821103822103823103824103825103826103827103828103829103830103831103832103833103834103835103836103837103838103839103840103841103842103843103844103845103846103847103848103849103850103851103852103853103854103855103856103857103858103859103860103861103862103863103864103865103866103867103868103869103870103871103872103873103874103875103876103877103878103879103880103881103882103883103884103885103886103887103888103889103890103891103892103893103894103895103896103897103898103899103900103901103902103903103904103905103906103907103908103909103910103911103912103913103914103915103916103917103918103919103920103921103922103923103924103925103926103927103928103929103930103931103932103933103934103935103936103937103938103939103940103941103942103943103944103945103946103947103948103949103950103951103952103953103954103955103956103957103958103959103960103961103962103963103964103965103966103967103968103969103970103971103972103973103974103975103976103977103978103979103980103981103982103983103984103985103986103987103988103989103990103991103992103993103994103995103996103997103998103999104000104001104002104003104004104005104006104007104008104009104010104011104012104013104014104015104016104017104018104019104020104021104022104023104024104025104026104027104028104029104030104031104032104033104034104035104036104037104038104039104040104041104042104043104044104045104046104047104048104049104050104051104052104053104054104055104056104057104058104059104060104061104062104063104064104065104066104067104068104069104070104071104072104073104074104075104076104077104078104079104080104081104082104083104084104085104086104087104088104089104090104091104092104093104094104095104096104097104098104099104100104101104102104103104104104105104106104107104108104109104110104111104112104113104114104115104116104117104118104119104120104121104122104123104124104125104126104127104128104129104130104131104132104133104134104135104136104137104138104139104140104141104142104143104144104145104146104147104148104149104150104151104152104153104154104155104156104157104158104159104160104161104162104163104164104165104166104167104168104169104170104171104172104173104174104175104176104177104178104179104180104181104182104183104184104185104186104187104188104189104190104191104192104193104194104195104196104197104198104199104200104201104202104203104204104205104206104207104208104209104210104211104212104213104214104215104216104217104218104219104220104221104222104223104224104225104226104227104228104229104230104231104232104233104234104235104236104237104238104239104240104241104242104243104244104245104246104247104248104249104250104251104252104253104254104255104256104257104258104259104260104261104262104263104264104265104266104267104268104269104270104271104272104273104274104275104276104277104278104279104280104281104282104283104284104285104286104287104288104289104290104291104292104293104294104295104296104297104298104299104300104301104302104303104304104305104306104307104308104309104310104311104312104313104314104315104316104317104318104319104320104321104322104323104324104325104326104327104328104329104330104331104332104333104334104335104336104337104338104339104340104341104342104343104344104345104346104347104348104349104350104351104352104353104354104355104356104357104358104359104360104361104362104363104364104365104366104367104368104369104370104371104372104373104374104375104376104377104378104379104380104381104382104383104384104385104386104387104388104389104390104391104392104393104394104395104396104397104398104399104400104401104402104403104404104405104406104407104408104409104410104411104412104413104414104415104416104417104418104419104420104421104422104423104424104425104426104427104428104429104430104431104432104433104434104435104436104437104438104439104440104441104442104443104444104445104446104447104448104449104450104451104452104453104454104455104456104457104458104459104460104461104462104463104464104465104466104467104468104469104470104471104472104473104474104475104476104477104478104479104480104481104482104483104484104485104486104487104488104489104490104491104492104493104494104495104496104497104498104499104500104501104502104503104504104505104506104507104508104509104510104511104512104513104514104515104516104517104518104519104520104521104522104523104524104525104526104527104528104529104530104531104532104533104534104535104536104537104538104539104540104541104542104543104544104545104546104547104548104549104550104551104552104553104554104555104556104557104558104559104560104561104562104563104564104565104566104567104568104569104570104571104572104573104574104575104576104577104578104579104580104581104582104583104584104585104586104587104588104589104590104591104592104593104594104595104596104597104598104599104600104601104602104603104604104605104606104607104608104609104610104611104612104613104614104615104616104617104618104619104620104621104622104623104624104625104626104627104628104629104630104631104632104633104634104635104636104637104638104639104640104641104642104643104644104645104646104647104648104649104650104651104652104653104654104655104656104657104658104659104660104661104662104663104664104665104666104667104668104669104670104671104672104673104674104675104676104677104678104679104680104681104682104683104684104685104686104687104688104689104690104691104692104693104694104695104696104697104698104699104700104701104702104703104704104705104706104707104708104709104710104711104712104713104714104715104716104717104718104719104720104721104722104723104724104725104726104727104728104729104730104731104732104733104734104735104736104737104738104739104740104741104742104743104744104745104746104747104748104749104750104751104752104753104754104755104756104757104758104759104760104761104762104763104764104765104766104767104768104769104770104771104772104773104774104775104776104777104778104779104780104781104782104783104784104785104786104787104788104789104790104791104792104793104794104795104796104797104798104799104800104801104802104803104804104805104806104807104808104809104810104811104812104813104814104815104816104817104818104819104820104821104822104823104824104825104826104827104828104829104830104831104832104833104834104835104836104837104838104839104840104841104842104843104844104845104846104847104848104849104850104851104852104853104854104855104856104857104858104859104860104861104862104863104864104865104866104867104868104869104870104871104872104873104874104875104876104877104878104879104880104881104882104883104884104885104886104887104888104889104890104891104892104893104894104895104896104897104898104899104900104901104902104903104904104905104906104907104908104909104910104911104912104913104914104915104916104917104918104919104920104921104922104923104924104925104926104927104928104929104930104931104932104933104934104935104936104937104938104939104940104941104942104943104944104945104946104947104948104949104950104951104952104953104954104955104956104957104958104959104960104961104962104963104964104965104966104967104968104969104970104971104972104973104974104975104976104977104978104979104980104981104982104983104984104985104986104987104988104989104990104991104992104993104994104995104996104997104998104999105000105001105002105003105004105005105006105007105008105009105010105011105012105013105014105015105016105017105018105019105020105021105022105023105024105025105026105027105028105029105030105031105032105033105034105035105036105037105038105039105040105041105042105043105044105045105046105047105048105049105050105051105052105053105054105055105056105057105058105059105060105061105062105063105064105065105066105067105068105069105070105071105072105073105074105075105076105077105078105079105080105081105082105083105084105085105086105087105088105089105090105091105092105093105094105095105096105097105098105099105100105101105102105103105104105105105106105107105108105109105110105111105112105113105114105115105116105117105118105119105120105121105122105123105124105125105126105127105128105129105130105131105132105133105134105135105136105137105138105139105140105141105142105143105144105145105146105147105148105149105150105151105152105153105154105155105156105157105158105159105160105161105162105163105164105165105166105167105168105169105170105171105172105173105174105175105176105177105178105179105180105181105182105183105184105185105186105187105188105189105190105191105192105193105194105195105196105197105198105199105200105201105202105203105204105205105206105207105208105209105210105211105212105213105214105215105216105217105218105219105220105221105222105223105224105225105226105227105228105229105230105231105232105233105234105235105236105237105238105239105240105241105242105243105244105245105246105247105248105249105250105251105252105253105254105255105256105257105258105259105260105261105262105263105264105265105266105267105268105269105270105271105272105273105274105275105276105277105278105279105280105281105282105283105284105285105286105287105288105289105290105291105292105293105294105295105296105297105298105299105300105301105302105303105304105305105306105307105308105309105310105311105312105313105314105315105316105317105318105319105320105321105322105323105324105325105326105327105328105329105330105331105332105333105334105335105336105337105338105339105340105341105342105343105344105345105346105347105348105349105350105351105352105353105354105355105356105357105358105359105360105361105362105363105364105365105366105367105368105369105370105371105372105373105374105375105376105377105378105379105380105381105382105383105384105385105386105387105388105389105390105391105392105393105394105395105396105397105398105399105400105401105402105403105404105405105406105407105408105409105410105411105412105413105414105415105416105417105418105419105420105421105422105423105424105425105426105427105428105429105430105431105432105433105434105435105436105437105438105439105440105441105442105443105444105445105446105447105448105449105450105451105452105453105454105455105456105457105458105459105460105461105462105463105464105465105466105467105468105469105470105471105472105473105474105475105476105477105478105479105480105481105482105483105484105485105486105487105488105489105490105491105492105493105494105495105496105497105498105499105500105501105502105503105504105505105506105507105508105509105510105511105512105513105514105515105516105517105518105519105520105521105522105523105524105525105526105527105528105529105530105531105532105533105534105535105536105537105538105539105540105541105542105543105544105545105546105547105548105549105550105551105552105553105554105555105556105557105558105559105560105561105562105563105564105565105566105567105568105569105570105571105572105573105574105575105576105577105578105579105580105581105582105583105584105585105586105587105588105589105590105591105592105593105594105595105596105597105598105599105600105601105602105603105604105605105606105607105608105609105610105611105612105613105614105615105616105617105618105619105620105621105622105623105624105625105626105627105628105629105630105631105632105633105634105635105636105637105638105639105640105641105642105643105644105645105646105647105648105649105650105651105652105653105654105655105656105657105658105659105660105661105662105663105664105665105666105667105668105669105670105671105672105673105674105675105676105677105678105679105680105681105682105683105684105685105686105687105688105689105690105691105692105693105694105695105696105697105698105699105700105701105702105703105704105705105706105707105708105709105710105711105712105713105714105715105716105717105718105719105720105721105722105723105724105725105726105727105728105729105730105731105732105733105734105735105736105737105738105739105740105741105742105743105744105745105746105747105748105749105750105751105752105753105754105755105756105757105758105759105760105761105762105763105764105765105766105767105768105769105770105771105772105773105774105775105776105777105778105779105780105781105782105783105784105785105786105787105788105789105790105791105792105793105794105795105796105797105798105799105800105801105802105803105804105805105806105807105808105809105810105811105812105813105814105815105816105817105818105819105820105821105822105823105824105825105826105827105828105829105830105831105832105833105834105835105836105837105838105839105840105841105842105843105844105845105846105847105848105849105850105851105852105853105854105855105856105857105858105859105860105861105862105863105864105865105866105867105868105869105870105871105872105873105874105875105876105877105878105879105880105881105882105883105884105885105886105887105888105889105890105891105892105893105894105895105896105897105898105899105900105901105902105903105904105905105906105907105908105909105910105911105912105913105914105915105916105917105918105919105920105921105922105923105924105925105926105927105928105929105930105931105932105933105934105935105936105937105938105939105940105941105942105943105944105945105946105947105948105949105950105951105952105953105954105955105956105957105958105959105960105961105962105963105964105965105966105967105968105969105970105971105972105973105974105975105976105977105978105979105980105981105982105983105984105985105986105987105988105989105990105991105992105993105994105995105996105997105998105999106000106001106002106003106004106005106006106007106008106009106010106011106012106013106014106015106016106017106018106019106020106021106022106023106024106025106026106027106028106029106030106031106032106033106034106035106036106037106038106039106040106041106042106043106044106045106046106047106048106049106050106051106052106053106054106055106056106057106058106059106060106061106062106063106064106065106066106067106068106069106070106071106072106073106074106075106076106077106078106079106080106081106082106083106084106085106086106087106088106089106090106091106092106093106094106095106096106097106098106099106100106101106102106103106104106105106106106107106108106109106110106111106112106113106114106115106116106117106118106119106120106121106122106123106124106125106126106127106128106129106130106131106132106133106134106135106136106137106138106139106140106141106142106143106144106145106146106147106148106149106150106151106152106153106154106155106156106157106158106159106160106161106162106163106164106165106166106167106168106169106170106171106172106173106174106175106176106177106178106179106180106181106182106183106184106185106186106187106188106189106190106191106192106193106194106195106196106197106198106199106200106201106202106203106204106205106206106207106208106209106210106211106212106213106214106215106216106217106218106219106220106221106222106223106224106225106226106227106228106229106230106231106232106233106234106235106236106237106238106239106240106241106242106243106244106245106246106247106248106249106250106251106252106253106254106255106256106257106258106259106260106261106262106263106264106265106266106267106268106269106270106271106272106273106274106275106276106277106278106279106280106281106282106283106284106285106286106287106288106289106290106291106292106293106294106295106296106297106298106299106300106301106302106303106304106305106306106307106308106309106310106311106312106313106314106315106316106317106318106319106320106321106322106323106324106325106326106327106328106329106330106331106332106333106334106335106336106337106338106339106340106341106342106343106344106345106346106347106348106349106350106351106352106353106354106355106356106357106358106359106360106361106362106363106364106365106366106367106368106369106370106371106372106373106374106375106376106377106378106379106380106381106382106383106384106385106386106387106388106389106390106391106392106393106394106395106396106397106398106399106400106401106402106403106404106405106406106407106408106409106410106411106412106413106414106415106416106417106418106419106420106421106422106423106424106425106426106427106428106429106430106431106432106433106434106435106436106437106438106439106440106441106442106443106444106445106446106447106448106449106450106451106452106453106454106455106456106457106458106459106460106461106462106463106464106465106466106467106468106469106470106471106472106473106474106475106476106477106478106479106480106481106482106483106484106485106486106487106488106489106490106491106492106493106494106495106496106497106498106499106500106501106502106503106504106505106506106507106508106509106510106511106512106513106514106515106516106517106518106519106520106521106522106523106524106525106526106527106528106529106530106531106532106533106534106535106536106537106538106539106540106541106542106543106544106545106546106547106548106549106550106551106552106553106554106555106556106557106558106559106560106561106562106563106564106565106566106567106568106569106570106571106572106573106574106575106576106577106578106579106580106581106582106583106584106585106586106587106588106589106590106591106592106593106594106595106596106597106598106599106600106601106602106603106604106605106606106607106608106609106610106611106612106613106614106615106616106617106618106619106620106621106622106623106624106625106626106627106628106629106630106631106632106633106634106635106636106637106638106639106640106641106642106643106644106645106646106647106648106649106650106651106652106653106654106655106656106657106658106659106660106661106662106663106664106665106666106667106668106669106670106671106672106673106674106675106676106677106678106679106680106681106682106683106684106685106686106687106688106689106690106691106692106693106694106695106696106697106698106699106700106701106702106703106704106705106706106707106708106709106710106711106712106713106714106715106716106717106718106719106720106721106722106723106724106725106726106727106728106729106730106731106732106733106734106735106736106737106738106739106740106741106742106743106744106745106746106747106748106749106750106751106752106753106754106755106756106757106758106759106760106761106762106763106764106765106766106767106768106769106770106771106772106773106774106775106776106777106778106779106780106781106782106783106784106785106786106787106788106789106790106791106792106793106794106795106796106797106798106799106800106801106802106803106804106805106806106807106808106809106810106811106812106813106814106815106816106817106818106819106820106821106822106823106824106825106826106827106828106829106830106831106832106833106834106835106836106837106838106839106840106841106842106843106844106845106846106847106848106849106850106851106852106853106854106855106856106857106858106859106860106861106862106863106864106865106866106867106868106869106870106871106872106873106874106875106876106877106878106879106880106881106882106883106884106885106886106887106888106889106890106891106892106893106894106895106896106897106898106899106900106901106902106903106904106905106906106907106908106909106910106911106912106913106914106915106916106917106918106919106920106921106922106923106924106925106926106927106928106929106930106931106932106933106934106935106936106937106938106939106940106941106942106943106944106945106946106947106948106949106950106951106952106953106954106955106956106957106958106959106960106961106962106963106964106965106966106967106968106969106970106971106972106973106974106975106976106977106978106979106980106981106982106983106984106985106986106987106988106989106990106991106992106993106994106995106996106997106998106999107000107001107002107003107004107005107006107007107008107009107010107011107012107013107014107015107016107017107018107019107020107021107022107023107024107025107026107027107028107029107030107031107032107033107034107035107036107037107038107039107040107041107042107043107044107045107046107047107048107049107050107051107052107053107054107055107056107057107058107059107060107061107062107063107064107065107066107067107068107069107070107071107072107073107074107075107076107077107078107079107080107081107082107083107084107085107086107087107088107089107090107091107092107093107094107095107096107097107098107099107100107101107102107103107104107105107106107107107108107109107110107111107112107113107114107115107116107117107118107119107120107121107122107123107124107125107126107127107128107129107130107131107132107133107134107135107136107137107138107139107140107141107142107143107144107145107146107147107148107149107150107151107152107153107154107155107156107157107158107159107160107161107162107163107164107165107166107167107168107169107170107171107172107173107174107175107176107177107178107179107180107181107182107183107184107185107186107187107188107189107190107191107192107193107194107195107196107197107198107199107200107201107202107203107204107205107206107207107208107209107210107211107212107213107214107215107216107217107218107219107220107221107222107223107224107225107226107227107228107229107230107231107232107233107234107235107236107237107238107239107240107241107242107243107244107245107246107247107248107249107250107251107252107253107254107255107256107257107258107259107260107261107262107263107264107265107266107267107268107269107270107271107272107273107274107275107276107277107278107279107280107281107282107283107284107285107286107287107288107289107290107291107292107293107294107295107296107297107298107299107300107301107302107303107304107305107306107307107308107309107310107311107312107313107314107315107316107317107318107319107320107321107322107323107324107325107326107327107328107329107330107331107332107333107334107335107336107337107338107339107340107341107342107343107344107345107346107347107348107349107350107351107352107353107354107355107356107357107358107359107360107361107362107363107364107365107366107367107368107369107370107371107372107373107374107375107376107377107378107379107380107381107382107383107384107385107386107387107388107389107390107391107392107393107394107395107396107397107398107399107400107401107402107403107404107405107406107407107408107409107410107411107412107413107414107415107416107417107418107419107420107421107422107423107424107425107426107427107428107429107430107431107432107433107434107435107436107437107438107439107440107441107442107443107444107445107446107447107448107449107450107451107452107453107454107455107456107457107458107459107460107461107462107463107464107465107466107467107468107469107470107471107472107473107474107475107476107477107478107479107480107481107482107483107484107485107486107487107488107489107490107491107492107493107494107495107496107497107498107499107500107501107502107503107504107505107506107507107508107509107510107511107512107513107514107515107516107517107518107519107520107521107522107523107524107525107526107527107528107529107530107531107532107533107534107535107536107537107538107539107540107541107542107543107544107545107546107547107548107549107550107551107552107553107554107555107556107557107558107559107560107561107562107563107564107565107566107567107568107569107570107571107572107573107574107575107576107577107578107579107580107581107582107583107584107585107586107587107588107589107590107591107592107593107594107595107596107597107598107599107600107601107602107603107604107605107606107607107608107609107610107611107612107613107614107615107616107617107618107619107620107621107622107623107624107625107626107627107628107629107630107631107632107633107634107635107636107637107638107639107640107641107642107643107644107645107646107647107648107649107650107651107652107653107654107655107656107657107658107659107660107661107662107663107664107665107666107667107668107669107670107671107672107673107674107675107676107677107678107679107680107681107682107683107684107685107686107687107688107689107690107691107692107693107694107695107696107697107698107699107700107701107702107703107704107705107706107707107708107709107710107711107712107713107714107715107716107717107718107719107720107721107722107723107724107725107726107727107728107729107730107731107732107733107734107735107736107737107738107739107740107741107742107743107744107745107746107747107748107749107750107751107752107753107754107755107756107757107758107759107760107761107762107763107764107765107766107767107768107769107770107771107772107773107774107775107776107777107778107779107780107781107782107783107784107785107786107787107788107789107790107791107792107793107794107795107796107797107798107799107800107801107802107803107804107805107806107807107808107809107810107811107812107813107814107815107816107817107818107819107820107821107822107823107824107825107826107827107828107829107830107831107832107833107834107835107836107837107838107839107840107841107842107843107844107845107846107847107848107849107850107851107852107853107854107855107856107857107858107859107860107861107862107863107864107865107866107867107868107869107870107871107872107873107874107875107876107877107878107879107880107881107882107883107884107885107886107887107888107889107890107891107892107893107894107895107896107897107898107899107900107901107902107903107904107905107906107907107908107909107910107911107912107913107914107915107916107917107918107919107920107921107922107923107924107925107926107927107928107929107930107931107932107933107934107935107936107937107938107939107940107941107942107943107944107945107946107947107948107949107950107951107952107953107954107955107956107957107958107959107960107961107962107963107964107965107966107967107968107969107970107971107972107973107974107975107976107977107978107979107980107981107982107983107984107985107986107987107988107989107990107991107992107993107994107995107996107997107998107999108000108001108002108003108004108005108006108007108008108009108010108011108012108013108014108015108016108017108018108019108020108021108022108023108024108025108026108027108028108029108030108031108032108033108034108035108036108037108038108039108040108041108042108043108044108045108046108047108048108049108050108051108052108053108054108055108056108057108058108059108060108061108062108063108064108065108066108067108068108069108070108071108072108073108074108075108076108077108078108079108080108081108082108083108084108085108086108087108088108089108090108091108092108093108094108095108096108097108098108099108100108101108102108103108104108105108106108107108108108109108110108111108112108113108114108115108116108117108118108119108120108121108122108123108124108125108126108127108128108129108130108131108132108133108134108135108136108137108138108139108140108141108142108143108144108145108146108147108148108149108150108151108152108153108154108155108156108157108158108159108160108161108162108163108164108165108166108167108168108169108170108171108172108173108174108175108176108177108178108179108180108181108182108183108184108185108186108187108188108189108190108191108192108193108194108195108196108197108198108199108200108201108202108203108204108205108206108207108208108209108210108211108212108213108214108215108216108217108218108219108220108221108222108223108224108225108226108227108228108229108230108231108232108233108234108235108236108237108238108239108240108241108242108243108244108245108246108247108248108249108250108251108252108253108254108255108256108257108258108259108260108261108262108263108264108265108266108267108268108269108270108271108272108273108274108275108276108277108278108279108280108281108282108283108284108285108286108287108288108289108290108291108292108293108294108295108296108297108298108299108300108301108302108303108304108305108306108307108308108309108310108311108312108313108314108315108316108317108318108319108320108321108322108323108324108325108326108327108328108329108330108331108332108333108334108335108336108337108338108339108340108341108342108343108344108345108346108347108348108349108350108351108352108353108354108355108356108357108358108359108360108361108362108363108364108365108366108367108368108369108370108371108372108373108374108375108376108377108378108379108380108381108382108383108384108385108386108387108388108389108390108391108392108393108394108395108396108397108398108399108400108401108402108403108404108405108406108407108408108409108410108411108412108413108414108415108416108417108418108419108420108421108422108423108424108425108426108427108428108429108430108431108432108433108434108435108436108437108438108439108440108441108442108443108444108445108446108447108448108449108450108451108452108453108454108455108456108457108458108459108460108461108462108463108464108465108466108467108468108469108470108471108472108473108474108475108476108477108478108479108480108481108482108483108484108485108486108487108488108489108490108491108492108493108494108495108496108497108498108499108500108501108502108503108504108505108506108507108508108509108510108511108512108513108514108515108516108517108518108519108520108521108522108523108524108525108526108527108528108529108530108531108532108533108534108535108536108537108538108539108540108541108542108543108544108545108546108547108548108549108550108551108552108553108554108555108556108557108558108559108560108561108562108563108564108565108566108567108568108569108570108571108572108573108574108575108576108577108578108579108580108581108582108583108584108585108586108587108588108589108590108591108592108593108594108595108596108597108598108599108600108601108602108603108604108605108606108607108608108609108610108611108612108613108614108615108616108617108618108619108620108621108622108623108624108625108626108627108628108629108630108631108632108633108634108635108636108637108638108639108640108641108642108643108644108645108646108647108648108649108650108651108652108653108654108655108656108657108658108659108660108661108662108663108664108665108666108667108668108669108670108671108672108673108674108675108676108677108678108679108680108681108682108683108684108685108686108687108688108689108690108691108692108693108694108695108696108697108698108699108700108701108702108703108704108705108706108707108708108709108710108711108712108713108714108715108716108717108718108719108720108721108722108723108724108725108726108727108728108729108730108731108732108733108734108735108736108737108738108739108740108741108742108743108744108745108746108747108748108749108750108751108752108753108754108755108756108757108758108759108760108761108762108763108764108765108766108767108768108769108770108771108772108773108774108775108776108777108778108779108780108781108782108783108784108785108786108787108788108789108790108791108792108793108794108795108796108797108798108799108800108801108802108803108804108805108806108807108808108809108810108811108812108813108814108815108816108817108818108819108820108821108822108823108824108825108826108827108828108829108830108831108832108833108834108835108836108837108838108839108840108841108842108843108844108845108846108847108848108849108850108851108852108853108854108855108856108857108858108859108860108861108862108863108864108865108866108867108868108869108870108871108872108873108874108875108876108877108878108879108880108881108882108883108884108885108886108887108888108889108890108891108892108893108894108895108896108897108898108899108900108901108902108903108904108905108906108907108908108909108910108911108912108913108914108915108916108917108918108919108920108921108922108923108924108925108926108927108928108929108930108931108932108933108934108935108936108937108938108939108940108941108942108943108944108945108946108947108948108949108950108951108952108953108954108955108956108957108958108959108960108961108962108963108964108965108966108967108968108969108970108971108972108973108974108975108976108977108978108979108980108981108982108983108984108985108986108987108988108989108990108991108992108993108994108995108996108997108998108999109000109001109002109003109004109005109006109007109008109009109010109011109012109013109014109015109016109017109018109019109020109021109022109023109024109025109026109027109028109029109030109031109032109033109034109035109036109037109038109039109040109041109042109043109044109045109046109047109048109049109050109051109052109053109054109055109056109057109058109059109060109061109062109063109064109065109066109067109068109069109070109071109072109073109074109075109076109077109078109079109080109081109082109083109084109085109086109087109088109089109090109091109092109093109094109095109096109097109098109099109100109101109102109103109104109105109106109107109108109109109110109111109112109113109114109115109116109117109118109119109120109121109122109123109124109125109126109127109128109129109130109131109132109133109134109135109136109137109138109139109140109141109142109143109144109145109146109147109148109149109150109151109152109153109154109155109156109157109158109159109160109161109162109163109164109165109166109167109168109169109170109171109172109173109174109175109176109177109178109179109180109181109182109183109184109185109186109187109188109189109190109191109192109193109194109195109196109197109198109199109200109201109202109203109204109205109206109207109208109209109210109211109212109213109214109215109216109217109218109219109220109221109222109223109224109225109226109227109228109229109230109231109232109233109234109235109236109237109238109239109240109241109242109243109244109245109246109247109248109249109250109251109252109253109254109255109256109257109258109259109260109261109262109263109264109265109266109267109268109269109270109271109272109273109274109275109276109277109278109279109280109281109282109283109284109285109286109287109288109289109290109291109292109293109294109295109296109297109298109299109300109301109302109303109304109305109306109307109308109309109310109311109312109313109314109315109316109317109318109319109320109321109322109323109324109325109326109327109328109329109330109331109332109333109334109335109336109337109338109339109340109341109342109343109344109345109346109347109348109349109350109351109352109353109354109355109356109357109358109359109360109361109362109363109364109365109366109367109368109369109370109371109372109373109374109375109376109377109378109379109380109381109382109383109384109385109386109387109388109389109390109391109392109393109394109395109396109397109398109399109400109401109402109403109404109405109406109407109408109409109410109411109412109413109414109415109416109417109418109419109420109421109422109423109424109425109426109427109428109429109430109431109432109433109434109435109436109437109438109439109440109441109442109443109444109445109446109447109448109449109450109451109452109453109454109455109456109457109458109459109460109461109462109463109464109465109466109467109468109469109470109471109472109473109474109475109476109477109478109479109480109481109482109483109484109485109486109487109488109489109490109491109492109493109494109495109496109497109498109499109500109501109502109503109504109505109506109507109508109509109510109511109512109513109514109515109516109517109518109519109520109521109522109523109524109525109526109527109528109529109530109531109532109533109534109535109536109537109538109539109540109541109542109543109544109545109546109547109548109549109550109551109552109553109554109555109556109557109558109559109560109561109562109563109564109565109566109567109568109569109570109571109572109573109574109575109576109577109578109579109580109581109582109583109584109585109586109587109588109589109590109591109592109593109594109595109596109597109598109599109600109601109602109603109604109605109606109607109608109609109610109611109612109613109614109615109616109617109618109619109620109621109622109623109624109625109626109627109628109629109630109631109632109633109634109635109636109637109638109639109640109641109642109643109644109645109646109647109648109649109650109651109652109653109654109655109656109657109658109659109660109661109662109663109664109665109666109667109668109669109670109671109672109673109674109675109676109677109678109679109680109681109682109683109684109685109686109687109688109689109690109691109692109693109694109695109696109697109698109699109700109701109702109703109704109705109706109707109708109709109710109711109712109713109714109715109716109717109718109719109720109721109722109723109724109725109726109727109728109729109730109731109732109733109734109735109736109737109738109739109740109741109742109743109744109745109746109747109748109749109750109751109752109753109754109755109756109757109758109759109760109761109762109763109764109765109766109767109768109769109770109771109772109773109774109775109776109777109778109779109780109781109782109783109784109785109786109787109788109789109790109791109792109793109794109795109796109797109798109799109800109801109802109803109804109805109806109807109808109809109810109811109812109813109814109815109816109817109818109819109820109821109822109823109824109825109826109827109828109829109830109831109832109833109834109835109836109837109838109839109840109841109842109843109844109845109846109847109848109849109850109851109852109853109854109855109856109857109858109859109860109861109862109863109864109865109866109867109868109869109870109871109872109873109874109875109876109877109878109879109880109881109882109883109884109885109886109887109888109889109890109891109892109893109894109895109896109897109898109899109900109901109902109903109904109905109906109907109908109909109910109911109912109913109914109915109916109917109918109919109920109921109922109923109924109925109926109927109928109929109930109931109932109933109934109935109936109937109938109939109940109941109942109943109944109945109946109947109948109949109950109951109952109953109954109955109956109957109958109959109960109961109962109963109964109965109966109967109968109969109970109971109972109973109974109975109976109977109978109979109980109981109982109983109984109985109986109987109988109989109990109991109992109993109994109995109996109997109998109999110000110001110002110003110004110005110006110007110008110009110010110011110012110013110014110015110016110017110018110019110020110021110022110023110024110025110026110027110028110029110030110031110032110033110034110035110036110037110038110039110040110041110042110043110044110045110046110047110048110049110050110051110052110053110054110055110056110057110058110059110060110061110062110063110064110065110066110067110068110069110070110071110072110073110074110075110076110077110078110079110080110081110082110083110084110085110086110087110088110089110090110091110092110093110094110095110096110097110098110099110100110101110102110103110104110105110106110107110108110109110110110111110112110113110114110115110116110117110118110119110120110121110122110123110124110125110126110127110128110129110130110131110132110133110134110135110136110137110138110139110140110141110142110143110144110145110146110147110148110149110150110151110152110153110154110155110156110157110158110159110160110161110162110163110164110165110166110167110168110169110170110171110172110173110174110175110176110177110178110179110180110181110182110183110184110185110186110187110188110189110190110191110192110193110194110195110196110197110198110199110200110201110202110203110204110205110206110207110208110209110210110211110212110213110214110215110216110217110218110219110220110221110222110223110224110225110226110227110228110229110230110231110232110233110234110235110236110237110238110239110240110241110242110243110244110245110246110247110248110249110250110251110252110253110254110255110256110257110258110259110260110261110262110263110264110265110266110267110268110269110270110271110272110273110274110275110276110277110278110279110280110281110282110283110284110285110286110287110288110289110290110291110292110293110294110295110296110297110298110299110300110301110302110303110304110305110306110307110308110309110310110311110312110313110314110315110316110317110318110319110320110321110322110323110324110325110326110327110328110329110330110331110332110333110334110335110336110337110338110339110340110341110342110343110344110345110346110347110348110349110350110351110352110353110354110355110356110357110358110359110360110361110362110363110364110365110366110367110368110369110370110371110372110373110374110375110376110377110378110379110380110381110382110383110384110385110386110387110388110389110390110391110392110393110394110395110396110397110398110399110400110401110402110403110404110405110406110407110408110409110410110411110412110413110414110415110416110417110418110419110420110421110422110423110424110425110426110427110428110429110430110431110432110433110434110435110436110437110438110439110440110441110442110443110444110445110446110447110448110449110450110451110452110453110454110455110456110457110458110459110460110461110462110463110464110465110466110467110468110469110470110471110472110473110474110475110476110477110478110479110480110481110482110483110484110485110486110487110488110489110490110491110492110493110494110495110496110497110498110499110500110501110502110503110504110505110506110507110508110509110510110511110512110513110514110515110516110517110518110519110520110521110522110523110524110525110526110527110528110529110530110531110532110533110534110535110536110537110538110539110540110541110542110543110544110545110546110547110548110549110550110551110552110553110554110555110556110557110558110559110560110561110562110563110564110565110566110567110568110569110570110571110572110573110574110575110576110577110578110579110580110581110582110583110584110585110586110587110588110589110590110591110592110593110594110595110596110597110598110599110600110601110602110603110604110605110606110607110608110609110610110611110612110613110614110615110616110617110618110619110620110621110622110623110624110625110626110627110628110629110630110631110632110633110634110635110636110637110638110639110640110641110642110643110644110645110646110647110648110649110650110651110652110653110654110655110656110657110658110659110660110661110662110663110664110665110666110667110668110669110670110671110672110673110674110675110676110677110678110679110680110681110682110683110684110685110686110687110688110689110690110691110692110693110694110695110696110697110698110699110700110701110702110703110704110705110706110707110708110709110710110711110712110713110714110715110716110717110718110719110720110721110722110723110724110725110726110727110728110729110730110731110732110733110734110735110736110737110738110739110740110741110742110743110744110745110746110747110748110749110750110751110752110753110754110755110756110757110758110759110760110761110762110763110764110765110766110767110768110769110770110771110772110773110774110775110776110777110778110779110780110781110782110783110784110785110786110787110788110789110790110791110792110793110794110795110796110797110798110799110800110801110802110803110804110805110806110807110808110809110810110811110812110813110814110815110816110817110818110819110820110821110822110823110824110825110826110827110828110829110830110831110832110833110834110835110836110837110838110839110840110841110842110843110844110845110846110847110848110849110850110851110852110853110854110855110856110857110858110859110860110861110862110863110864110865110866110867110868110869110870110871110872110873110874110875110876110877110878110879110880110881110882110883110884110885110886110887110888110889110890110891110892110893110894110895110896110897110898110899110900110901110902110903110904110905110906110907110908110909110910110911110912110913110914110915110916110917110918110919110920110921110922110923110924110925110926110927110928110929110930110931110932110933110934110935110936110937110938110939110940110941110942110943110944110945110946110947110948110949110950110951110952110953110954110955110956110957110958110959110960110961110962110963110964110965110966110967110968110969110970110971110972110973110974110975110976110977110978110979110980110981110982110983110984110985110986110987110988110989110990110991110992110993110994110995110996110997110998110999111000111001111002111003111004111005111006111007111008111009111010111011111012111013111014111015111016111017111018111019111020111021111022111023111024111025111026111027111028111029111030111031111032111033111034111035111036111037111038111039111040111041111042111043111044111045111046111047111048111049111050111051111052111053111054111055111056111057111058111059111060111061111062111063111064111065111066111067111068111069111070111071111072111073111074111075111076111077111078111079111080111081111082111083111084111085111086111087111088111089111090111091111092111093111094111095111096111097111098111099111100111101111102111103111104111105111106111107111108111109111110111111111112111113111114111115111116111117111118111119111120111121111122111123111124111125111126111127111128111129111130111131111132111133111134111135111136111137111138111139111140111141111142111143111144111145111146111147111148111149111150111151111152111153111154111155111156111157111158111159111160111161111162111163111164111165111166111167111168111169111170111171111172111173111174111175111176111177111178111179111180111181111182111183111184111185111186111187111188111189111190111191111192111193111194111195111196111197111198111199111200111201111202111203111204111205111206111207111208111209111210111211111212111213111214111215111216111217111218111219111220111221111222111223111224111225111226111227111228111229111230111231111232111233111234111235111236111237111238111239111240111241111242111243111244111245111246111247111248111249111250111251111252111253111254111255111256111257111258111259111260111261111262111263111264111265111266111267111268111269111270111271111272111273111274111275111276111277111278111279111280111281111282111283111284111285111286111287111288111289111290111291111292111293111294111295111296111297111298111299111300111301111302111303111304111305111306111307111308111309111310111311111312111313111314111315111316111317111318111319111320111321111322111323111324111325111326111327111328111329111330111331111332111333111334111335111336111337111338111339111340111341111342111343111344111345111346111347111348111349111350111351111352111353111354111355111356111357111358111359111360111361111362111363111364111365111366111367111368111369111370111371111372111373111374111375111376111377111378111379111380111381111382111383111384111385111386111387111388111389111390111391111392111393111394111395111396111397111398111399111400111401111402111403111404111405111406111407111408111409111410111411111412111413111414111415111416111417111418111419111420111421111422111423111424111425111426111427111428111429111430111431111432111433111434111435111436111437111438111439111440111441111442111443111444111445111446111447111448111449111450111451111452111453111454111455111456111457111458111459111460111461111462111463111464111465111466111467111468111469111470111471111472111473111474111475111476111477111478111479111480111481111482111483111484111485111486111487111488111489111490111491111492111493111494111495111496111497111498111499111500111501111502111503111504111505111506111507111508111509111510111511111512111513111514111515111516111517111518111519111520111521111522111523111524111525111526111527111528111529111530111531111532111533111534111535111536111537111538111539111540111541111542111543111544111545111546111547111548111549111550111551111552111553111554111555111556111557111558111559111560111561111562111563111564111565111566111567111568111569111570111571111572111573111574111575111576111577111578111579111580111581111582111583111584111585111586111587111588111589111590111591111592111593111594111595111596111597111598111599111600111601111602111603111604111605111606111607111608111609111610111611111612111613111614111615111616111617111618111619111620111621111622111623111624111625111626111627111628111629111630111631111632111633111634111635111636111637111638111639111640111641111642111643111644111645111646111647111648111649111650111651111652111653111654111655111656111657111658111659111660111661111662111663111664111665111666111667111668111669111670111671111672111673111674111675111676111677111678111679111680111681111682111683111684111685111686111687111688111689111690111691111692111693111694111695111696111697111698111699111700111701111702111703111704111705111706111707111708111709111710111711111712111713111714111715111716111717111718111719111720111721111722111723111724111725111726111727111728111729111730111731111732111733111734111735111736111737111738111739111740111741111742111743111744111745111746111747111748111749111750111751111752111753111754111755111756111757111758111759111760111761111762111763111764111765111766111767111768111769111770111771111772111773111774111775111776111777111778111779111780111781111782111783111784111785111786111787111788111789111790111791111792111793111794111795111796111797111798111799111800111801111802111803111804111805111806111807111808111809111810111811111812111813111814111815111816111817111818111819111820111821111822111823111824111825111826111827111828111829111830111831111832111833111834111835111836111837111838111839111840111841111842111843111844111845111846111847111848111849111850111851111852111853111854111855111856111857111858111859111860111861111862111863111864111865111866111867111868111869111870111871111872111873111874111875111876111877111878111879111880111881111882111883111884111885111886111887111888111889111890111891111892111893111894111895111896111897111898111899111900111901111902111903111904111905111906111907111908111909111910111911111912111913111914111915111916111917111918111919111920111921111922111923111924111925111926111927111928111929111930111931111932111933111934111935111936111937111938111939111940111941111942111943111944111945111946111947111948111949111950111951111952111953111954111955111956111957111958111959111960111961111962111963111964111965111966111967111968111969111970111971111972111973111974111975111976111977111978111979111980111981111982111983111984111985111986111987111988111989111990111991111992111993111994111995111996111997111998111999112000112001112002112003112004112005112006112007112008112009112010112011112012112013112014112015112016112017112018112019112020112021112022112023112024112025112026112027112028112029112030112031112032112033112034112035112036112037112038112039112040112041112042112043112044112045112046112047112048112049112050112051112052112053112054112055112056112057112058112059112060112061112062112063112064112065112066112067112068112069112070112071112072112073112074112075112076112077112078112079112080112081112082112083112084112085112086112087112088112089112090112091112092112093112094112095112096112097112098112099112100112101112102112103112104112105112106112107112108112109112110112111112112112113112114112115112116112117112118112119112120112121112122112123112124112125112126112127112128112129112130112131112132112133112134112135112136112137112138112139112140112141112142112143112144112145112146112147112148112149112150112151112152112153112154112155112156112157112158112159112160112161112162112163112164112165112166112167112168112169112170112171112172112173112174112175112176112177112178112179112180112181112182112183112184112185112186112187112188112189112190112191112192112193112194112195112196112197112198112199112200112201112202112203112204112205112206112207112208112209112210112211112212112213112214112215112216112217112218112219112220112221112222112223112224112225112226112227112228112229112230112231112232112233112234112235112236112237112238112239112240112241112242112243112244112245112246112247112248112249112250112251112252112253112254112255112256112257112258112259112260112261112262112263112264112265112266112267112268112269112270112271112272112273112274112275112276112277112278112279112280112281112282112283112284112285112286112287112288112289112290112291112292112293112294112295112296112297112298112299112300112301112302112303112304112305112306112307112308112309112310112311112312112313112314112315112316112317112318112319112320112321112322112323112324112325112326112327112328112329112330112331112332112333112334112335112336112337112338112339112340112341112342112343112344112345112346112347112348112349112350112351112352112353112354112355112356112357112358112359112360112361112362112363112364112365112366112367112368112369112370112371112372112373112374112375112376112377112378112379112380112381112382112383112384112385112386112387112388112389112390112391112392112393112394112395112396112397112398112399112400112401112402112403112404112405112406112407112408112409112410112411112412112413112414112415112416112417112418112419112420112421112422112423112424112425112426112427112428112429112430112431112432112433112434112435112436112437112438112439112440112441112442112443112444112445112446112447112448112449112450112451112452112453112454112455112456112457112458112459112460112461112462112463112464112465112466112467112468112469112470112471112472112473112474112475112476112477112478112479112480112481112482112483112484112485112486112487112488112489112490112491112492112493112494112495112496112497112498112499112500112501112502112503112504112505112506112507112508112509112510112511112512112513112514112515112516112517112518112519112520112521112522112523112524112525112526112527112528112529112530112531112532112533112534112535112536112537112538112539112540112541112542112543112544112545112546112547112548112549112550112551112552112553112554112555112556112557112558112559112560112561112562112563112564112565112566112567112568112569112570112571112572112573112574112575112576112577112578112579112580112581112582112583112584112585112586112587112588112589112590112591112592112593112594112595112596112597112598112599112600112601112602112603112604112605112606112607112608112609112610112611112612112613112614112615112616112617112618112619112620112621112622112623112624112625112626112627112628112629112630112631112632112633112634112635112636112637112638112639112640112641112642112643112644112645112646112647112648112649112650112651112652112653112654112655112656112657112658112659112660112661112662112663112664112665112666112667112668112669112670112671112672112673112674112675112676112677112678112679112680112681112682112683112684112685112686112687112688112689112690112691112692112693112694112695112696112697112698112699112700112701112702112703112704112705112706112707112708112709112710112711112712112713112714112715112716112717112718112719112720112721112722112723112724112725112726112727112728112729112730112731112732112733112734112735112736112737112738112739112740112741112742112743112744112745112746112747112748112749112750112751112752112753112754112755112756112757112758112759112760112761112762112763112764112765112766112767112768112769112770112771112772112773112774112775112776112777112778112779112780112781112782112783112784112785112786112787112788112789112790112791112792112793112794112795112796112797112798112799112800112801112802112803112804112805112806112807112808112809112810112811112812112813112814112815112816112817112818112819112820112821112822112823112824112825112826112827112828112829112830112831112832112833112834112835112836112837112838112839112840112841112842112843112844112845112846112847112848112849112850112851112852112853112854112855112856112857112858112859112860112861112862112863112864112865112866112867112868112869112870112871112872112873112874112875112876112877112878112879112880112881112882112883112884112885112886112887112888112889112890112891112892112893112894112895112896112897112898112899112900112901112902112903112904112905112906112907112908112909112910112911112912112913112914112915112916112917112918112919112920112921112922112923112924112925112926112927112928112929112930112931112932112933112934112935112936112937112938112939112940112941112942112943112944112945112946112947112948112949112950112951112952112953112954112955112956112957112958112959112960112961112962112963112964112965112966112967112968112969112970112971112972112973112974112975112976112977112978112979112980112981112982112983112984112985112986112987112988112989112990112991112992112993112994112995112996112997112998112999113000113001113002113003113004113005113006113007113008113009113010113011113012113013113014113015113016113017113018113019113020113021113022113023113024113025113026113027113028113029113030113031113032113033113034113035113036113037113038113039113040113041113042113043113044113045113046113047113048113049113050113051113052113053113054113055113056113057113058113059113060113061113062113063113064113065113066113067113068113069113070113071113072113073113074113075113076113077113078113079113080113081113082113083113084113085113086113087113088113089113090113091113092113093113094113095113096113097113098113099113100113101113102113103113104113105113106113107113108113109113110113111113112113113113114113115113116113117113118113119113120113121113122113123113124113125113126113127113128113129113130113131113132113133113134113135113136113137113138113139113140113141113142113143113144113145113146113147113148113149113150113151113152113153113154113155113156113157113158113159113160113161113162113163113164113165113166113167113168113169113170113171113172113173113174113175113176113177113178113179113180113181113182113183113184113185113186113187113188113189113190113191113192113193113194113195113196113197113198113199113200113201113202113203113204113205113206113207113208113209113210113211113212113213113214113215113216113217113218113219113220113221113222113223113224113225113226113227113228113229113230113231113232113233113234113235113236113237113238113239113240113241113242113243113244113245113246113247113248113249113250113251113252113253113254113255113256113257113258113259113260113261113262113263113264113265113266113267113268113269113270113271113272113273113274113275113276113277113278113279113280113281113282113283113284113285113286113287113288113289113290113291113292113293113294113295113296113297113298113299113300113301113302113303113304113305113306113307113308113309113310113311113312113313113314113315113316113317113318113319113320113321113322113323113324113325113326113327113328113329113330113331113332113333113334113335113336113337113338113339113340113341113342113343113344113345113346113347113348113349113350113351113352113353113354113355113356113357113358113359113360113361113362113363113364113365113366113367113368113369113370113371113372113373113374113375113376113377113378113379113380113381113382113383113384113385113386113387113388113389113390113391113392113393113394113395113396113397113398113399113400113401113402113403113404113405113406113407113408113409113410113411113412113413113414113415113416113417113418113419113420113421113422113423113424113425113426113427113428113429113430113431113432113433113434113435113436113437113438113439113440113441113442113443113444113445113446113447113448113449113450113451113452113453113454113455113456113457113458113459113460113461113462113463113464113465113466113467113468113469113470113471113472113473113474113475113476113477113478113479113480113481113482113483113484113485113486113487113488113489113490113491113492113493113494113495113496113497113498113499113500113501113502113503113504113505113506113507113508113509113510113511113512113513113514113515113516113517113518113519113520113521113522113523113524113525113526113527113528113529113530113531113532113533113534113535113536113537113538113539113540113541113542113543113544113545113546113547113548113549113550113551113552113553113554113555113556113557113558113559113560113561113562113563113564113565113566113567113568113569113570113571113572113573113574113575113576113577113578113579113580113581113582113583113584113585113586113587113588113589113590113591113592113593113594113595113596113597113598113599113600113601113602113603113604113605113606113607113608113609113610113611113612113613113614113615113616113617113618113619113620113621113622113623113624113625113626113627113628113629113630113631113632113633113634113635113636113637113638113639113640113641113642113643113644113645113646113647113648113649113650113651113652113653113654113655113656113657113658113659113660113661113662113663113664113665113666113667113668113669113670113671113672113673113674113675113676113677113678113679113680113681113682113683113684113685113686113687113688113689113690113691113692113693113694113695113696113697113698113699113700113701113702113703113704113705113706113707113708113709113710113711113712113713113714113715113716113717113718113719113720113721113722113723113724113725113726113727113728113729113730113731113732113733113734113735113736113737113738113739113740113741113742113743113744113745113746113747113748113749113750113751113752113753113754113755113756113757113758113759113760113761113762113763113764113765113766113767113768113769113770113771113772113773113774113775113776113777113778113779113780113781113782113783113784113785113786113787113788113789113790113791113792113793113794113795113796113797113798113799113800113801113802113803113804113805113806113807113808113809113810113811113812113813113814113815113816113817113818113819113820113821113822113823113824113825113826113827113828113829113830113831113832113833113834113835113836113837113838113839113840113841113842113843113844113845113846113847113848113849113850113851113852113853113854113855113856113857113858113859113860113861113862113863113864113865113866113867113868113869113870113871113872113873113874113875113876113877113878113879113880113881113882113883113884113885113886113887113888113889113890113891113892113893113894113895113896113897113898113899113900113901113902113903113904113905113906113907113908113909113910113911113912113913113914113915113916113917113918113919113920113921113922113923113924113925113926113927113928113929113930113931113932113933113934113935113936113937113938113939113940113941113942113943113944113945113946113947113948113949113950113951113952113953113954113955113956113957113958113959113960113961113962113963113964113965113966113967113968113969113970113971113972113973113974113975113976113977113978113979113980113981113982113983113984113985113986113987113988113989113990113991113992113993113994113995113996113997113998113999114000114001114002114003114004114005114006114007114008114009114010114011114012114013114014114015114016114017114018114019114020114021114022114023114024114025114026114027114028114029114030114031114032114033114034114035114036114037114038114039114040114041114042114043114044114045114046114047114048114049114050114051114052114053114054114055114056114057114058114059114060114061114062114063114064114065114066114067114068114069114070114071114072114073114074114075114076114077114078114079114080114081114082114083114084114085114086114087114088114089114090114091114092114093114094114095114096114097114098114099114100114101114102114103114104114105114106114107114108114109114110114111114112114113114114114115114116114117114118114119114120114121114122114123114124114125114126114127114128114129114130114131114132114133114134114135114136114137114138114139114140114141114142114143114144114145114146114147114148114149114150114151114152114153114154114155114156114157114158114159114160114161114162114163114164114165114166114167114168114169114170114171114172114173114174114175114176114177114178114179114180114181114182114183114184114185114186114187114188114189114190114191114192114193114194114195114196114197114198114199114200114201114202114203114204114205114206114207114208114209114210114211114212114213114214114215114216114217114218114219114220114221114222114223114224114225114226114227114228114229114230114231114232114233114234114235114236114237114238114239114240114241114242114243114244114245114246114247114248114249114250114251114252114253114254114255114256114257114258114259114260114261114262114263114264114265114266114267114268114269114270114271114272114273114274114275114276114277114278114279114280114281114282114283114284114285114286114287114288114289114290114291114292114293114294114295114296114297114298114299114300114301114302114303114304114305114306114307114308114309114310114311114312114313114314114315114316114317114318114319114320114321114322114323114324114325114326114327114328114329114330114331114332114333114334114335114336114337114338114339114340114341114342114343114344114345114346114347114348114349114350114351114352114353114354114355114356114357114358114359114360114361114362114363114364114365114366114367114368114369114370114371114372114373114374114375114376114377114378114379114380114381114382114383114384114385114386114387114388114389114390114391114392114393114394114395114396114397114398114399114400114401114402114403114404114405114406114407114408114409114410114411114412114413114414114415114416114417114418114419114420114421114422114423114424114425114426114427114428114429114430114431114432114433114434114435114436114437114438114439114440114441114442114443114444114445114446114447114448114449114450114451114452114453114454114455114456114457114458114459114460114461114462114463114464114465114466114467114468114469114470114471114472114473114474114475114476114477114478114479114480114481114482114483114484114485114486114487114488114489114490114491114492114493114494114495114496114497114498114499114500114501114502114503114504114505114506114507114508114509114510114511114512114513114514114515114516114517114518114519114520114521114522114523114524114525114526114527114528114529114530114531114532114533114534114535114536114537114538114539114540114541114542114543114544114545114546114547114548114549114550114551114552114553114554114555114556114557114558114559114560114561114562114563114564114565114566114567114568114569114570114571114572114573114574114575114576114577114578114579114580114581114582114583114584114585114586114587114588114589114590114591114592114593114594114595114596114597114598114599114600114601114602114603114604114605114606114607114608114609114610114611114612114613114614114615114616114617114618114619114620114621114622114623114624114625114626114627114628114629114630114631114632114633114634114635114636114637114638114639114640114641114642114643114644114645114646114647114648114649114650114651114652114653114654114655114656114657114658114659114660114661114662114663114664114665114666114667114668114669114670114671114672114673114674114675114676114677114678114679114680114681114682114683114684114685114686114687114688114689114690114691114692114693114694114695114696114697114698114699114700114701114702114703114704114705114706114707114708114709114710114711114712114713114714114715114716114717114718114719114720114721114722114723114724114725114726114727114728114729114730114731114732114733114734114735114736114737114738114739114740114741114742114743114744114745114746114747114748114749114750114751114752114753114754114755114756114757114758114759114760114761114762114763114764114765114766114767114768114769114770114771114772114773114774114775114776114777114778114779114780114781114782114783114784114785114786114787114788114789114790114791114792114793114794114795114796114797114798114799114800114801114802114803114804114805114806114807114808114809114810114811114812114813114814114815114816114817114818114819114820114821114822114823114824114825114826114827114828114829114830114831114832114833114834114835114836114837114838114839114840114841114842114843114844114845114846114847114848114849114850114851114852114853114854114855114856114857114858114859114860114861114862114863114864114865114866114867114868114869114870114871114872114873114874114875114876114877114878114879114880114881114882114883114884114885114886114887114888114889114890114891114892114893114894114895114896114897114898114899114900114901114902114903114904114905114906114907114908114909114910114911114912114913114914114915114916114917114918114919114920114921114922114923114924114925114926114927114928114929114930114931114932114933114934114935114936114937114938114939114940114941114942114943114944114945114946114947114948114949114950114951114952114953114954114955114956114957114958114959114960114961114962114963114964114965114966114967114968114969114970114971114972114973114974114975114976114977114978114979114980114981114982114983114984114985114986114987114988114989114990114991114992114993114994114995114996114997114998114999115000115001115002115003115004115005115006115007115008115009115010115011115012115013115014115015115016115017115018115019115020115021115022115023115024115025115026115027115028115029115030115031115032115033115034115035115036115037115038115039115040115041115042115043115044115045115046115047115048115049115050115051115052115053115054115055115056115057115058115059115060115061115062115063115064115065115066115067115068115069115070115071115072115073115074115075115076115077115078115079115080115081115082115083115084115085115086115087115088115089115090115091115092115093115094115095115096115097115098115099115100115101115102115103115104115105115106115107115108115109115110115111115112115113115114115115115116115117115118115119115120115121115122115123115124115125115126115127115128115129115130115131115132115133115134115135115136115137115138115139115140115141115142115143115144115145115146115147115148115149115150115151115152115153115154115155115156115157115158115159115160115161115162115163115164115165115166115167115168115169115170115171115172115173115174115175115176115177115178115179115180115181115182115183115184115185115186115187115188115189115190115191115192115193115194115195115196115197115198115199115200115201115202115203115204115205115206115207115208115209115210115211115212115213115214115215115216115217115218115219115220115221115222115223115224115225115226115227115228115229115230115231115232115233115234115235115236115237115238115239115240115241115242115243115244115245115246115247115248115249115250115251115252115253115254115255115256115257115258115259115260115261115262115263115264115265115266115267115268115269115270115271115272115273115274115275115276115277115278115279115280115281115282115283115284115285115286115287115288115289115290115291115292115293115294115295115296115297115298115299115300115301115302115303115304115305115306115307115308115309115310115311115312115313115314115315115316115317115318115319115320115321115322115323115324115325115326115327115328115329115330115331115332115333115334115335115336115337115338115339115340115341115342115343115344115345115346115347115348115349115350115351115352115353115354115355115356115357115358115359115360115361115362115363115364115365115366115367115368115369115370115371115372115373115374115375115376115377115378115379115380115381115382115383115384115385115386115387115388115389115390115391115392115393115394115395115396115397115398115399115400115401115402115403115404115405115406115407115408115409115410115411115412115413115414115415115416115417115418115419115420115421115422115423115424115425115426115427115428115429115430115431115432115433115434115435115436115437115438115439115440115441115442115443115444115445115446115447115448115449115450115451115452115453115454115455115456115457115458115459115460115461115462115463115464115465115466115467115468115469115470115471115472115473115474115475115476115477115478115479115480115481115482115483115484115485115486115487115488115489115490115491115492115493115494115495115496115497115498115499115500115501115502115503115504115505115506115507115508115509115510115511115512115513115514115515115516115517115518115519115520115521115522115523115524115525115526115527115528115529115530115531115532115533115534115535115536115537115538115539115540115541115542115543115544115545115546115547115548115549115550115551115552115553115554115555115556115557115558115559115560115561115562115563115564115565115566115567115568115569115570115571115572115573115574115575115576115577115578115579115580115581115582115583115584115585115586115587115588115589115590115591115592115593115594115595115596115597115598115599115600115601115602115603115604115605115606115607115608115609115610115611115612115613115614115615115616115617115618115619115620115621115622115623115624115625115626115627115628115629115630115631115632115633115634115635115636115637115638115639115640115641115642115643115644115645115646115647115648115649115650115651115652115653115654115655115656115657115658115659115660115661115662115663115664115665115666115667115668115669115670115671115672115673115674115675115676115677115678115679115680115681115682115683115684115685115686115687115688115689115690115691115692115693115694115695115696115697115698115699115700115701115702115703115704115705115706115707115708115709115710115711115712115713115714115715115716115717115718115719115720115721115722115723115724115725115726115727115728115729115730115731115732115733115734115735115736115737115738115739115740115741115742115743115744115745115746115747115748115749115750115751115752115753115754115755115756115757115758115759115760115761115762115763115764115765115766115767115768115769115770115771115772115773115774115775115776115777115778115779115780115781115782115783115784115785115786115787115788115789115790115791115792115793115794115795115796115797115798115799115800115801115802115803115804115805115806115807115808115809115810115811115812115813115814115815115816115817115818115819115820115821115822115823115824115825115826115827115828115829115830115831115832115833115834115835115836115837115838115839115840115841115842115843115844115845115846115847115848115849115850115851115852115853115854115855115856115857115858115859115860115861115862115863115864115865115866115867115868115869115870115871115872115873115874115875115876115877115878115879115880115881115882115883115884115885115886115887115888115889115890115891115892115893115894115895115896115897115898115899115900115901115902115903115904115905115906115907115908115909115910115911115912115913115914115915115916115917115918115919115920115921115922115923115924115925115926115927115928115929115930115931115932115933115934115935115936115937115938115939115940115941115942115943115944115945115946115947115948115949115950115951115952115953115954115955115956115957115958115959115960115961115962115963115964115965115966115967115968115969115970115971115972115973115974115975115976115977115978115979115980115981115982115983115984115985115986115987115988115989115990115991115992115993115994115995115996115997115998115999116000116001116002116003116004116005116006116007116008116009116010116011116012116013116014116015116016116017116018116019116020116021116022116023116024116025116026116027116028116029116030116031116032116033116034116035116036116037116038116039116040116041116042116043116044116045116046116047116048116049116050116051116052116053116054116055116056116057116058116059116060116061116062116063116064116065116066116067116068116069116070116071116072116073116074116075116076116077116078116079116080116081116082116083116084116085116086116087116088116089116090116091116092116093116094116095116096116097116098116099116100116101116102116103116104116105116106116107116108116109116110116111116112116113116114116115116116116117116118116119116120116121116122116123116124116125116126116127116128116129116130116131116132116133116134116135116136116137116138116139116140116141116142116143116144116145116146116147116148116149116150116151116152116153116154116155116156116157116158116159116160116161116162116163116164116165116166116167116168116169116170116171116172116173116174116175116176116177116178116179116180116181116182116183116184116185116186116187116188116189116190116191116192116193116194116195116196116197116198116199116200116201116202116203116204116205116206116207116208116209116210116211116212116213116214116215116216116217116218116219116220116221116222116223116224116225116226116227116228116229116230116231116232116233116234116235116236116237116238116239116240116241116242116243116244116245116246116247116248116249116250116251116252116253116254116255116256116257116258116259116260116261116262116263116264116265116266116267116268116269116270116271116272116273116274116275116276116277116278116279116280116281116282116283116284116285116286116287116288116289116290116291116292116293116294116295116296116297116298116299116300116301116302116303116304116305116306116307116308116309116310116311116312116313116314116315116316116317116318116319116320116321116322116323116324116325116326116327116328116329116330116331116332116333116334116335116336116337116338116339116340116341116342116343116344116345116346116347116348116349116350116351116352116353116354116355116356116357116358116359116360116361116362116363116364116365116366116367116368116369116370116371116372116373116374116375116376116377116378116379116380116381116382116383116384116385116386116387116388116389116390116391116392116393116394116395116396116397116398116399116400116401116402116403116404116405116406116407116408116409116410116411116412116413116414116415116416116417116418116419116420116421116422116423116424116425116426116427116428116429116430116431116432116433116434116435116436116437116438116439116440116441116442116443116444116445116446116447116448116449116450116451116452116453116454116455116456116457116458116459116460116461116462116463116464116465116466116467116468116469116470116471116472116473116474116475116476116477116478116479116480116481116482116483116484116485116486116487116488116489116490116491116492116493116494116495116496116497116498116499116500116501116502116503116504116505116506116507116508116509116510116511116512116513116514116515116516116517116518116519116520116521116522116523116524116525116526116527116528116529116530116531116532116533116534116535116536116537116538116539116540116541116542116543116544116545116546116547116548116549116550116551116552116553116554116555116556116557116558116559116560116561116562116563116564116565116566116567116568116569116570116571116572116573116574116575116576116577116578116579116580116581116582116583116584116585116586116587116588116589116590116591116592116593116594116595116596116597116598116599116600116601116602116603116604116605116606116607116608116609116610116611116612116613116614116615116616116617116618116619116620116621116622116623116624116625116626116627116628116629116630116631116632116633116634116635116636116637116638116639116640116641116642116643116644116645116646116647116648116649116650116651116652116653116654116655116656116657116658116659116660116661116662116663116664116665116666116667116668116669116670116671116672116673116674116675116676116677116678116679116680116681116682116683116684116685116686116687116688116689116690116691116692116693116694116695116696116697116698116699116700116701116702116703116704116705116706116707116708116709116710116711116712116713116714116715116716116717116718116719116720116721116722116723116724116725116726116727116728116729116730116731116732116733116734116735116736116737116738116739116740116741116742116743116744116745116746116747116748116749116750116751116752116753116754116755116756116757116758116759116760116761116762116763116764116765116766116767116768116769116770116771116772116773116774116775116776116777116778116779116780116781116782116783116784116785116786116787116788116789116790116791116792116793116794116795116796116797116798116799116800116801116802116803116804116805116806116807116808116809116810116811116812116813116814116815116816116817116818116819116820116821116822116823116824116825116826116827116828116829116830116831116832116833116834116835116836116837116838116839116840116841116842116843116844116845116846116847116848116849116850116851116852116853116854116855116856116857116858116859116860116861116862116863116864116865116866116867116868116869116870116871116872116873116874116875116876116877116878116879116880116881116882116883116884116885116886116887116888116889116890116891116892116893116894116895116896116897116898116899116900116901116902116903116904116905116906116907116908116909116910116911116912116913116914116915116916116917116918116919116920116921116922116923116924116925116926116927116928116929116930116931116932116933116934116935116936116937116938116939116940116941116942116943116944116945116946116947116948116949116950116951116952116953116954116955116956116957116958116959116960116961116962116963116964116965116966116967116968116969116970116971116972116973116974116975116976116977116978116979116980116981116982116983116984116985116986116987116988116989116990116991116992116993116994116995116996116997116998116999117000117001117002117003117004117005117006117007117008117009117010117011117012117013117014117015117016117017117018117019117020117021117022117023117024117025117026117027117028117029117030117031117032117033117034117035117036117037117038117039117040117041117042117043117044117045117046117047117048117049117050117051117052117053117054117055117056117057117058117059117060117061117062117063117064117065117066117067117068117069117070117071117072117073117074117075117076117077117078117079117080117081117082117083117084117085117086117087117088117089117090117091117092117093117094117095117096117097117098117099117100117101117102117103117104117105117106117107117108117109117110117111117112117113117114117115117116117117117118117119117120117121117122117123117124117125117126117127117128117129117130117131117132117133117134117135117136117137117138117139117140117141117142117143117144117145117146117147117148117149117150117151117152117153117154117155117156117157117158117159117160117161117162117163117164117165117166117167117168117169117170117171117172117173117174117175117176117177117178117179117180117181117182117183117184117185117186117187117188117189117190117191117192117193117194117195117196117197117198117199117200117201117202117203117204117205117206117207117208117209117210117211117212117213117214117215117216117217117218117219117220117221117222117223117224117225117226117227117228117229117230117231117232117233117234117235117236117237117238117239117240117241117242117243117244117245117246117247117248117249117250117251117252117253117254117255117256117257117258117259117260117261117262117263117264117265117266117267117268117269117270117271117272117273117274117275117276117277117278117279117280117281117282117283117284117285117286117287117288117289117290117291117292117293117294117295117296117297117298117299117300117301117302117303117304117305117306117307117308117309117310117311117312117313117314117315117316117317117318117319117320117321117322117323117324117325117326117327117328117329117330117331117332117333117334117335117336117337117338117339117340117341117342117343117344117345117346117347117348117349117350117351117352117353117354117355117356117357117358117359117360117361117362117363117364117365117366117367117368117369117370117371117372117373117374117375117376117377117378117379117380117381117382117383117384117385117386117387117388117389117390117391117392117393117394117395117396117397117398117399117400117401117402117403117404117405117406117407117408117409117410117411117412117413117414117415117416117417117418117419117420117421117422117423117424117425117426117427117428117429117430117431117432117433117434117435117436117437117438117439117440117441117442117443117444117445117446117447117448117449117450117451117452117453117454117455117456117457117458117459117460117461117462117463117464117465117466117467117468117469117470117471117472117473117474117475117476117477117478117479117480117481117482117483117484117485117486117487117488117489117490117491117492117493117494117495117496117497117498117499117500117501117502117503117504117505117506117507117508117509117510117511117512117513117514117515117516117517117518117519117520117521117522117523117524117525117526117527117528117529117530117531117532117533117534117535117536117537117538117539117540117541117542117543117544117545117546117547117548117549117550117551117552117553117554117555117556117557117558117559117560117561117562117563117564117565117566117567117568117569117570117571117572117573117574117575117576117577117578117579117580117581117582117583117584117585117586117587117588117589117590117591117592117593117594117595117596117597117598117599117600117601117602117603117604117605117606117607117608117609117610117611117612117613117614117615117616117617117618117619117620117621117622117623117624117625117626117627117628117629117630117631117632117633117634117635117636117637117638117639117640117641117642117643117644117645117646117647117648117649117650117651117652117653117654117655117656117657117658117659117660117661117662117663117664117665117666117667117668117669117670117671117672117673117674117675117676117677117678117679117680117681117682117683117684117685117686117687117688117689117690117691117692117693117694117695117696117697117698117699117700117701117702117703117704117705117706117707117708117709117710117711117712117713117714117715117716117717117718117719117720117721117722117723117724117725117726117727117728117729117730117731117732117733117734117735117736117737117738117739117740117741117742117743117744117745117746117747117748117749117750117751117752117753117754117755117756117757117758117759117760117761117762117763117764117765117766117767117768117769117770117771117772117773117774117775117776117777117778117779117780117781117782117783117784117785117786117787117788117789117790117791117792117793117794117795117796117797117798117799117800117801117802117803117804117805117806117807117808117809117810117811117812117813117814117815117816117817117818117819117820117821117822117823117824117825117826117827117828117829117830117831117832117833117834117835117836117837117838117839117840117841117842117843117844117845117846117847117848117849117850117851117852117853117854117855117856117857117858117859117860117861117862117863117864117865117866117867117868117869117870117871117872117873117874117875117876117877117878117879117880117881117882117883117884117885117886117887117888117889117890117891117892117893117894117895117896117897117898117899117900117901117902117903117904117905117906117907117908117909117910117911117912117913117914117915117916117917117918117919117920117921117922117923117924117925117926117927117928117929117930117931117932117933117934117935117936117937117938117939117940117941117942117943117944117945117946117947117948117949117950117951117952117953117954117955117956117957117958117959117960117961117962117963117964117965117966117967117968117969117970117971117972117973117974117975117976117977117978117979117980117981117982117983117984117985117986117987117988117989117990117991117992117993117994117995117996117997117998117999118000118001118002118003118004118005118006118007118008118009118010118011118012118013118014118015118016118017118018118019118020118021118022118023118024118025118026118027118028118029118030118031118032118033118034118035118036118037118038118039118040118041118042118043118044118045118046118047118048118049118050118051118052118053118054118055118056118057118058118059118060118061118062118063118064118065118066118067118068118069118070118071118072118073118074118075118076118077118078118079118080118081118082118083118084118085118086118087118088118089118090118091118092118093118094118095118096118097118098118099118100118101118102118103118104118105118106118107118108118109118110118111118112118113118114118115118116118117118118118119118120118121118122118123118124118125118126118127118128118129118130118131118132118133118134118135118136118137118138118139118140118141118142118143118144118145118146118147118148118149118150118151118152118153118154118155118156118157118158118159118160118161118162118163118164118165118166118167118168118169118170118171118172118173118174118175118176118177118178118179118180118181118182118183118184118185118186118187118188118189118190118191118192118193118194118195118196118197118198118199118200118201118202118203118204118205118206118207118208118209118210118211118212118213118214118215118216118217118218118219118220118221118222118223118224118225118226118227118228118229118230118231118232118233118234118235118236118237118238118239118240118241118242118243118244118245118246118247118248118249118250118251118252118253118254118255118256118257118258118259118260118261118262118263118264118265118266118267118268118269118270118271118272118273118274118275118276118277118278118279118280118281118282118283118284118285118286118287118288118289118290118291118292118293118294118295118296118297118298118299118300118301118302118303118304118305118306118307118308118309118310118311118312118313118314118315118316118317118318118319118320118321118322118323118324118325118326118327118328118329118330118331118332118333118334118335118336118337118338118339118340118341118342118343118344118345118346118347118348118349118350118351118352118353118354118355118356118357118358118359118360118361118362118363118364118365118366118367118368118369118370118371118372118373118374118375118376118377118378118379118380118381118382118383118384118385118386118387118388118389118390118391118392118393118394118395118396118397118398118399118400118401118402118403118404118405118406118407118408118409118410118411118412118413118414118415118416118417118418118419118420118421118422118423118424118425118426118427118428118429118430118431118432118433118434118435118436118437118438118439118440118441118442118443118444118445118446118447118448118449118450118451118452118453118454118455118456118457118458118459118460118461118462118463118464118465118466118467118468118469118470118471118472118473118474118475118476118477118478118479118480118481118482118483118484118485118486118487118488118489118490118491118492118493118494118495118496118497118498118499118500118501118502118503118504118505118506118507118508118509118510118511118512118513118514118515118516118517118518118519118520118521118522118523118524118525118526118527118528118529118530118531118532118533118534118535118536118537118538118539118540118541118542118543118544118545118546118547118548118549118550118551118552118553118554118555118556118557118558118559118560118561118562118563118564118565118566118567118568118569118570118571118572118573118574118575118576118577118578118579118580118581118582118583118584118585118586118587118588118589118590118591118592118593118594118595118596118597118598118599118600118601118602118603118604118605118606118607118608118609118610118611118612118613118614118615118616118617118618118619118620118621118622118623118624118625118626118627118628118629118630118631118632118633118634118635118636118637118638118639118640118641118642118643118644118645118646118647118648118649118650118651118652118653118654118655118656118657118658118659118660118661118662118663118664118665118666118667118668118669118670118671118672118673118674118675118676118677118678118679118680118681118682118683118684118685118686118687118688118689118690118691118692118693118694118695118696118697118698118699118700118701118702118703118704118705118706118707118708118709118710118711118712118713118714118715118716118717118718118719118720118721118722118723118724118725118726118727118728118729118730118731118732118733118734118735118736118737118738118739118740118741118742118743118744118745118746118747118748118749118750118751118752118753118754118755118756118757118758118759118760118761118762118763118764118765118766118767118768118769118770118771118772118773118774118775118776118777118778118779118780118781118782118783118784118785118786118787118788118789118790118791118792118793118794118795118796118797118798118799118800118801118802118803118804118805118806118807118808118809118810118811118812118813118814118815118816118817118818118819118820118821118822118823118824118825118826118827118828118829118830118831118832118833118834118835118836118837118838118839118840118841118842118843118844118845118846118847118848118849118850118851118852118853118854118855118856118857118858118859118860118861118862118863118864118865118866118867118868118869118870118871118872118873118874118875118876118877118878118879118880118881118882118883118884118885118886118887118888118889118890118891118892118893118894118895118896118897118898118899118900118901118902118903118904118905118906118907118908118909118910118911118912118913118914118915118916118917118918118919118920118921118922118923118924118925118926118927118928118929118930118931118932118933118934118935118936118937118938118939118940118941118942118943118944118945118946118947118948118949118950118951118952118953118954118955118956118957118958118959118960118961118962118963118964118965118966118967118968118969118970118971118972118973118974118975118976118977118978118979118980118981118982118983118984118985118986118987118988118989118990118991118992118993118994118995118996118997118998118999119000119001119002119003119004119005119006119007119008119009119010119011119012119013119014119015119016119017119018119019119020119021119022119023119024119025119026119027119028119029119030119031119032119033119034119035119036119037119038119039119040119041119042119043119044119045119046119047119048119049119050119051119052119053119054119055119056119057119058119059119060119061119062119063119064119065119066119067119068119069119070119071119072119073119074119075119076119077119078119079119080119081119082119083119084119085119086119087119088119089119090119091119092119093119094119095119096119097119098119099119100119101119102119103119104119105119106119107119108119109119110119111119112119113119114119115119116119117119118119119119120119121119122119123119124119125119126119127119128119129119130119131119132119133119134119135119136119137119138119139119140119141119142119143119144119145119146119147119148119149119150119151119152119153119154119155119156119157119158119159119160119161119162119163119164119165119166119167119168119169119170119171119172119173119174119175119176119177119178119179119180119181119182119183119184119185119186119187119188119189119190119191119192119193119194119195119196119197119198119199119200119201119202119203119204119205119206119207119208119209119210119211119212119213119214119215119216119217119218119219119220119221119222119223119224119225119226119227119228119229119230119231119232119233119234119235119236119237119238119239119240119241119242119243119244119245119246119247119248119249119250119251119252119253119254119255119256119257119258119259119260119261119262119263119264119265119266119267119268119269119270119271119272119273119274119275119276119277119278119279119280119281119282119283119284119285119286119287119288119289119290119291119292119293119294119295119296119297119298119299119300119301119302119303119304119305119306119307119308119309119310119311119312119313119314119315119316119317119318119319119320119321119322119323119324119325119326119327119328119329119330119331119332119333119334119335119336119337119338119339119340119341119342119343119344119345119346119347119348119349119350119351119352119353119354119355119356119357119358119359119360119361119362119363119364119365119366119367119368119369119370119371119372119373119374119375119376119377119378119379119380119381119382119383119384119385119386119387119388119389119390119391119392119393119394119395119396119397119398119399119400119401119402119403119404119405119406119407119408119409119410119411119412119413119414119415119416119417119418119419119420119421119422119423119424119425119426119427119428119429119430119431119432119433119434119435119436119437119438119439119440119441119442119443119444119445119446119447119448119449119450119451119452119453119454119455119456119457119458119459119460119461119462119463119464119465119466119467119468119469119470119471119472119473119474119475119476119477119478119479119480119481119482119483119484119485119486119487119488119489119490119491119492119493119494119495119496119497119498119499119500119501119502119503119504119505119506119507119508119509119510119511119512119513119514119515119516119517119518119519119520119521119522119523119524119525119526119527119528119529119530119531119532119533119534119535119536119537119538119539119540119541119542119543119544119545119546119547119548119549119550119551119552119553119554119555119556119557119558119559119560119561119562119563119564119565119566119567119568119569119570119571119572119573119574119575119576119577119578119579119580119581119582119583119584119585119586119587119588119589119590119591119592119593119594119595119596119597119598119599119600119601119602119603119604119605119606119607119608119609119610119611119612119613119614119615119616119617119618119619119620119621119622119623119624119625119626119627119628119629119630119631119632119633119634119635119636119637119638119639119640119641119642119643119644119645119646119647119648119649119650119651119652119653119654119655119656119657119658119659119660119661119662119663119664119665119666119667119668119669119670119671119672119673119674119675119676119677119678119679119680119681119682119683119684119685119686119687119688119689119690119691119692119693119694119695119696119697119698119699119700119701119702119703119704119705119706119707119708119709119710119711119712119713119714119715119716119717119718119719119720119721119722119723119724119725119726119727119728119729119730119731119732119733119734119735119736119737119738119739119740119741119742119743119744119745119746119747119748119749119750119751119752119753119754119755119756119757119758119759119760119761119762119763119764119765119766119767119768119769119770119771119772119773119774119775119776119777119778119779119780119781119782119783119784119785119786119787119788119789119790119791119792119793119794119795119796119797119798119799119800119801119802119803119804119805119806119807119808119809119810119811119812119813119814119815119816119817119818119819119820119821119822119823119824119825119826119827119828119829119830119831119832119833119834119835119836119837119838119839119840119841119842119843119844119845119846119847119848119849119850119851119852119853119854119855119856119857119858119859119860119861119862119863119864119865119866119867119868119869119870119871119872119873119874119875119876119877119878119879119880119881119882119883119884119885119886119887119888119889119890119891119892119893119894119895119896119897119898119899119900119901119902119903119904119905119906119907119908119909119910119911119912119913119914119915119916119917119918119919119920119921119922119923119924119925119926119927119928119929119930119931119932119933119934119935119936119937119938119939119940119941119942119943119944119945119946119947119948119949119950119951119952119953119954119955119956119957119958119959119960119961119962119963119964119965119966119967119968119969119970119971119972119973119974119975119976119977119978119979119980119981119982119983119984119985119986119987119988119989119990119991119992119993119994119995119996119997119998119999120000120001120002120003120004120005120006120007120008120009120010120011120012120013120014120015120016120017120018120019120020120021120022120023120024120025120026120027120028120029120030120031120032120033120034120035120036120037120038120039120040120041120042120043120044120045120046120047120048120049120050120051120052120053120054120055120056120057120058120059120060120061120062120063120064120065120066120067120068120069120070120071120072120073120074120075120076120077120078120079120080120081120082120083120084120085120086120087120088120089120090120091120092120093120094120095120096120097120098120099120100120101120102120103120104120105120106120107120108120109120110120111120112120113120114120115120116120117120118120119120120120121120122120123120124120125120126120127120128120129120130120131120132120133120134120135120136120137120138120139120140120141120142120143120144120145120146120147120148120149120150120151120152120153120154120155120156120157120158120159120160120161120162120163120164120165120166120167120168120169120170120171120172120173120174120175120176120177120178120179120180120181120182120183120184120185120186120187120188120189120190120191120192120193120194120195120196120197120198120199120200120201120202120203120204120205120206120207120208120209120210120211120212120213120214120215120216120217120218120219120220120221120222120223120224120225120226120227120228120229120230120231120232120233120234120235120236120237120238120239120240120241120242120243120244120245120246120247120248120249120250120251120252120253120254120255120256120257120258120259120260120261120262120263120264120265120266120267120268120269120270120271120272120273120274120275120276120277120278120279120280120281120282120283120284120285120286120287120288120289120290120291120292120293120294120295120296120297120298120299120300120301120302120303120304120305120306120307120308120309120310120311120312120313120314120315120316120317120318120319120320120321120322120323120324120325120326120327120328120329120330120331120332120333120334120335120336120337120338120339120340120341120342120343120344120345120346120347120348120349120350120351120352120353120354120355120356120357120358120359120360120361120362120363120364120365120366120367120368120369120370120371120372120373120374120375120376120377120378120379120380120381120382120383120384120385120386120387120388120389120390120391120392120393120394120395120396120397120398120399120400120401120402120403120404120405120406120407120408120409120410120411120412120413120414120415120416120417120418120419120420120421120422120423120424120425120426120427120428120429120430120431120432120433120434120435120436120437120438120439120440120441120442120443120444120445120446120447120448120449120450120451120452120453120454120455120456120457120458120459120460120461120462120463120464120465120466120467120468120469120470120471120472120473120474120475120476120477120478120479120480120481120482120483120484120485120486120487120488120489120490120491120492120493120494120495120496120497120498120499120500120501120502120503120504120505120506120507120508120509120510120511120512120513120514120515120516120517120518120519120520120521120522120523120524120525120526120527120528120529120530120531120532120533120534120535120536120537120538120539120540120541120542120543120544120545120546120547120548120549120550120551120552120553120554120555120556120557120558120559120560120561120562120563120564120565120566120567120568120569120570120571120572120573120574120575120576120577120578120579120580120581120582120583120584120585120586120587120588120589120590120591120592120593120594120595120596120597120598120599120600120601120602120603120604120605120606120607120608120609120610120611120612120613120614120615120616120617120618120619120620120621120622120623120624120625120626120627120628120629120630120631120632120633120634120635120636120637120638120639120640120641120642120643120644120645120646120647120648120649120650120651120652120653120654120655120656120657120658120659120660120661120662120663120664120665120666120667120668120669120670120671120672120673120674120675120676120677120678120679120680120681120682120683120684120685120686120687120688120689120690120691120692120693120694120695120696120697120698120699120700120701120702120703120704120705120706120707120708120709120710120711120712120713120714120715120716120717120718120719120720120721120722120723120724120725120726120727120728120729120730120731120732120733120734120735120736120737120738120739120740120741120742120743120744120745120746120747120748120749120750120751120752120753120754120755120756120757120758120759120760120761120762120763120764120765120766120767120768120769120770120771120772120773120774120775120776120777120778120779120780120781120782120783120784120785120786120787120788120789120790120791120792120793120794120795120796120797120798120799120800120801120802120803120804120805120806120807120808120809120810120811120812120813120814120815120816120817120818120819120820120821120822120823120824120825120826120827120828120829120830120831120832120833120834120835120836120837120838120839120840120841120842120843120844120845120846120847120848120849120850120851120852120853120854120855120856120857120858120859120860120861120862120863120864120865120866120867120868120869120870120871120872120873120874120875120876120877120878120879120880120881120882120883120884120885120886120887120888120889120890120891120892120893120894120895120896120897120898120899120900120901120902120903120904120905120906120907120908120909120910120911120912120913120914120915120916120917120918120919120920120921120922120923120924120925120926120927120928120929120930120931120932120933120934120935120936120937120938120939120940120941120942120943120944120945120946120947120948120949120950120951120952120953120954120955120956120957120958120959120960120961120962120963120964120965120966120967120968120969120970120971120972120973120974120975120976120977120978120979120980120981120982120983120984120985120986120987120988120989120990120991120992120993120994120995120996120997120998120999121000121001121002121003121004121005121006121007121008121009121010121011121012121013121014121015121016121017121018121019121020121021121022121023121024121025121026121027121028121029121030121031121032121033121034121035121036121037121038121039121040121041121042121043121044121045121046121047121048121049121050121051121052121053121054121055121056121057121058121059121060121061121062121063121064121065121066121067121068121069121070121071121072121073121074121075121076121077121078121079121080121081121082121083121084121085121086121087121088121089121090121091121092121093121094121095121096121097121098121099121100121101121102121103121104121105121106121107121108121109121110121111121112121113121114121115121116121117121118121119121120121121121122121123121124121125121126121127121128121129121130121131121132121133121134121135121136121137121138121139121140121141121142121143121144121145121146121147121148121149121150121151121152121153121154121155121156121157121158121159121160121161121162121163121164121165121166121167121168121169121170121171121172121173121174121175121176121177121178121179121180121181121182121183121184121185121186121187121188121189121190121191121192121193121194121195121196121197121198121199121200121201121202121203121204121205121206121207121208121209121210121211121212121213121214121215121216121217121218121219121220121221121222121223121224121225121226121227121228121229121230121231121232121233121234121235121236121237121238121239121240121241121242121243121244121245121246121247121248121249121250121251121252121253121254121255121256121257121258121259121260121261121262121263121264121265121266121267121268121269121270121271121272121273121274121275121276121277121278121279121280121281121282121283121284121285121286121287121288121289121290121291121292121293121294121295121296121297121298121299121300121301121302121303121304121305121306121307121308121309121310121311121312121313121314121315121316121317121318121319121320121321121322121323121324121325121326121327121328121329121330121331121332121333121334121335121336121337121338121339121340121341121342121343121344121345121346121347121348121349121350121351121352121353121354121355121356121357121358121359121360121361121362121363121364121365121366121367121368121369121370121371121372121373121374121375121376121377121378121379121380121381121382121383121384121385121386121387121388121389121390121391121392121393121394121395121396121397121398121399121400121401121402121403121404121405121406121407121408121409121410121411121412121413121414121415121416121417121418121419121420121421121422121423121424121425121426121427121428121429121430121431121432121433121434121435121436121437121438121439121440121441121442121443121444121445121446121447121448121449121450121451121452121453121454121455121456121457121458121459121460121461121462121463121464121465121466121467121468121469121470121471121472121473121474121475121476121477121478121479121480121481121482121483121484121485121486121487121488121489121490121491121492121493121494121495121496121497121498121499121500121501121502121503121504121505121506121507121508121509121510121511121512121513121514121515121516121517121518121519121520121521121522121523121524121525121526121527121528121529121530121531121532121533121534121535121536121537121538121539121540121541121542121543121544121545121546121547121548121549121550121551121552121553121554121555121556121557121558121559121560121561121562121563121564121565121566121567121568121569121570121571121572121573121574121575121576121577121578121579121580121581121582121583121584121585121586121587121588121589121590121591121592121593121594121595121596121597121598121599121600121601121602121603121604121605121606121607121608121609121610121611121612121613121614121615121616121617121618121619121620121621121622121623121624121625121626121627121628121629121630121631121632121633121634121635121636121637121638121639121640121641121642121643121644121645121646121647121648121649121650121651121652121653121654121655121656121657121658121659121660121661121662121663121664121665121666121667121668121669121670121671121672121673121674121675121676121677121678121679121680121681121682121683121684121685121686121687121688121689121690121691121692121693121694121695121696121697121698121699121700121701121702121703121704121705121706121707121708121709121710121711121712121713121714121715121716121717121718121719121720121721121722121723121724121725121726121727121728121729121730121731121732121733121734121735121736121737121738121739121740121741121742121743121744121745121746121747121748121749121750121751121752121753121754121755121756121757121758121759121760121761121762121763121764121765121766121767121768121769121770121771121772121773121774121775121776121777121778121779121780121781121782121783121784121785121786121787121788121789121790121791121792121793121794121795121796121797121798121799121800121801121802121803121804121805121806121807121808121809121810121811121812121813121814121815121816121817121818121819121820121821121822121823121824121825121826121827121828121829121830121831121832121833121834121835121836121837121838121839121840121841121842121843121844121845121846121847121848121849121850121851121852121853121854121855121856121857121858121859121860121861121862121863121864121865121866121867121868121869121870121871121872121873121874121875121876121877121878121879121880121881121882121883121884121885121886121887121888121889121890121891121892121893121894121895121896121897121898121899121900121901121902121903121904121905121906121907121908121909121910121911121912121913121914121915121916121917121918121919121920121921121922121923121924121925121926121927121928121929121930121931121932121933121934121935121936121937121938121939121940121941121942121943121944121945121946121947121948121949121950121951121952121953121954121955121956121957121958121959121960121961121962121963121964121965121966121967121968121969121970121971121972121973121974121975121976121977121978121979121980121981121982121983121984121985121986121987121988121989121990121991121992121993121994121995121996121997121998121999122000122001122002122003122004122005122006122007122008122009122010122011122012122013122014122015122016122017122018122019122020122021122022122023122024122025122026122027122028122029122030122031122032122033122034122035122036122037122038122039122040122041122042122043122044122045122046122047122048122049122050122051122052122053122054122055122056122057122058122059122060122061122062122063122064122065122066122067122068122069122070122071122072122073122074122075122076122077122078122079122080122081122082122083122084122085122086122087122088122089122090122091122092122093122094122095122096122097122098122099122100122101122102122103122104122105122106122107122108122109122110122111122112122113122114122115122116122117122118122119122120122121122122122123122124122125122126122127122128122129122130122131122132122133122134122135122136122137122138122139122140122141122142122143122144122145122146122147122148122149122150122151122152122153122154122155122156122157122158122159122160122161122162122163122164122165122166122167122168122169122170122171122172122173122174122175122176122177122178122179122180122181122182122183122184122185122186122187122188122189122190122191122192122193122194122195122196122197122198122199122200122201122202122203122204122205122206122207122208122209122210122211122212122213122214122215122216122217122218122219122220122221122222122223122224122225122226122227122228122229122230122231122232122233122234122235122236122237122238122239122240122241122242122243122244122245122246122247122248122249122250122251122252122253122254122255122256122257122258122259122260122261122262122263122264122265122266122267122268122269122270122271122272122273122274122275122276122277122278122279122280122281122282122283122284122285122286122287122288122289122290122291122292122293122294122295122296122297122298122299122300122301122302122303122304122305122306122307122308122309122310122311122312122313122314122315122316122317122318122319122320122321122322122323122324122325122326122327122328122329122330122331122332122333122334122335122336122337122338122339122340122341122342122343122344122345122346122347122348122349122350122351122352122353122354122355122356122357122358122359122360122361122362122363122364122365122366122367122368122369122370122371122372122373122374122375122376122377122378122379122380122381122382122383122384122385122386122387122388122389122390122391122392122393122394122395122396122397122398122399122400122401122402122403122404122405122406122407122408122409122410122411122412122413122414122415122416122417122418122419122420122421122422122423122424122425122426122427122428122429122430122431122432122433122434122435122436122437122438122439122440122441122442122443122444122445122446122447122448122449122450122451122452122453122454122455122456122457122458122459122460122461122462122463122464122465122466122467122468122469122470122471122472122473122474122475122476122477122478122479122480122481122482122483122484122485122486122487122488122489122490122491122492122493122494122495122496122497122498122499122500122501122502122503122504122505122506122507122508122509122510122511122512122513122514122515122516122517122518122519122520122521122522122523122524122525122526122527122528122529122530122531122532122533122534122535122536122537122538122539122540122541122542122543122544122545122546122547122548122549122550122551122552122553122554122555122556122557122558122559122560122561122562122563122564122565122566122567122568122569122570122571122572122573122574122575122576122577122578122579122580122581122582122583122584122585122586122587122588122589122590122591122592122593122594122595122596122597122598122599122600122601122602122603122604122605122606122607122608122609122610122611122612122613122614122615122616122617122618122619122620122621122622122623122624122625122626122627122628122629122630122631122632122633122634122635122636122637122638122639122640122641122642122643122644122645122646122647122648122649122650122651122652122653122654122655122656122657122658122659122660122661122662122663122664122665122666122667122668122669122670122671122672122673122674122675122676122677122678122679122680122681122682122683122684122685122686122687122688122689122690122691122692122693122694122695122696122697122698122699122700122701122702122703122704122705122706122707122708122709122710122711122712122713122714122715122716122717122718122719122720122721122722122723122724122725122726122727122728122729122730122731122732122733122734122735122736122737122738122739122740122741122742122743122744122745122746122747122748122749122750122751122752122753122754122755122756122757122758122759122760122761122762122763122764122765122766122767122768122769122770122771122772122773122774122775122776122777122778122779122780122781122782122783122784122785122786122787122788122789122790122791122792122793122794122795122796122797122798122799122800122801122802122803122804122805122806122807122808122809122810122811122812122813122814122815122816122817122818122819122820122821122822122823122824122825122826122827122828122829122830122831122832122833122834122835122836122837122838122839122840122841122842122843122844122845122846122847122848122849122850122851122852122853122854122855122856122857122858122859122860122861122862122863122864122865122866122867122868122869122870122871122872122873122874122875122876122877122878122879122880122881122882122883122884122885122886122887122888122889122890122891122892122893122894122895122896122897122898122899122900122901122902122903122904122905122906122907122908122909122910122911122912122913122914122915122916122917122918122919122920122921122922122923122924122925122926122927122928122929122930122931122932122933122934122935122936122937122938122939122940122941122942122943122944122945122946122947122948122949122950122951122952122953122954122955122956122957122958122959122960122961122962122963122964122965122966122967122968122969122970122971122972122973122974122975122976122977122978122979122980122981122982122983122984122985122986122987122988122989122990122991122992122993122994122995122996122997122998122999123000123001123002123003123004123005123006123007123008123009123010123011123012123013123014123015123016123017123018123019123020123021123022123023123024123025123026123027123028123029123030123031123032123033123034123035123036123037123038123039123040123041123042123043123044123045123046123047123048123049123050123051123052123053123054123055123056123057123058123059123060123061123062123063123064123065123066123067123068123069123070123071123072123073123074123075123076123077123078123079123080123081123082123083123084123085123086123087123088123089123090123091123092123093123094123095123096123097123098123099123100123101123102123103123104123105123106123107123108123109123110123111123112123113123114123115123116123117123118123119123120123121123122123123123124123125123126123127123128123129123130123131123132123133123134123135123136123137123138123139123140123141123142123143123144123145123146123147123148123149123150123151123152123153123154123155123156123157123158123159123160123161123162123163123164123165123166123167123168123169123170123171123172123173123174123175123176123177123178123179123180123181123182123183123184123185123186123187123188123189123190123191123192123193123194123195123196123197123198123199123200123201123202123203123204123205123206123207123208123209123210123211123212123213123214123215123216123217123218123219123220123221123222123223123224123225123226123227123228123229123230123231123232123233123234123235123236123237123238123239123240123241123242123243123244123245123246123247123248123249123250123251123252123253123254123255123256123257123258123259123260123261123262123263123264123265123266123267123268123269123270123271123272123273123274123275123276123277123278123279123280123281123282123283123284123285123286123287123288123289123290123291123292123293123294123295123296123297123298123299123300123301123302123303123304123305123306123307123308123309123310123311123312123313123314123315123316123317123318123319123320123321123322123323123324123325123326123327123328123329123330123331123332123333123334123335123336123337123338123339123340123341123342123343123344123345123346123347123348123349123350123351123352123353123354123355123356123357123358123359123360123361123362123363123364123365123366123367123368123369123370123371123372123373123374123375123376123377123378123379123380123381123382123383123384123385123386123387123388123389123390123391123392123393123394123395123396123397123398123399123400123401123402123403123404123405123406123407123408123409123410123411123412123413123414123415123416123417123418123419123420123421123422123423123424123425123426123427123428123429123430123431123432123433123434123435123436123437123438123439123440123441123442123443123444123445123446123447123448123449123450123451123452123453123454123455123456123457123458123459123460123461123462123463123464123465123466123467123468123469123470123471123472123473123474123475123476123477123478123479123480123481123482123483123484123485123486123487123488123489123490123491123492123493123494123495123496123497123498123499123500123501123502123503123504123505123506123507123508123509123510123511123512123513123514123515123516123517123518123519123520123521123522123523123524123525123526123527123528123529123530123531123532123533123534123535123536123537123538123539123540123541123542123543123544123545123546123547123548123549123550123551123552123553123554123555123556123557123558123559123560123561123562123563123564123565123566123567123568123569123570123571123572123573123574123575123576123577123578123579123580123581123582123583123584123585123586123587123588123589123590123591123592123593123594123595123596123597123598123599123600123601123602123603123604123605123606123607123608123609123610123611123612123613123614123615123616123617123618123619123620123621123622123623123624123625123626123627123628123629123630123631123632123633123634123635123636123637123638123639123640123641123642123643123644123645123646123647123648123649123650123651123652123653123654123655123656123657123658123659123660123661123662123663123664123665123666123667123668123669123670123671123672123673123674123675123676123677123678123679123680123681123682123683123684123685123686123687123688123689123690123691123692123693123694123695123696123697123698123699123700123701123702123703123704123705123706123707123708123709123710123711123712123713123714123715123716123717123718123719123720123721123722123723123724123725123726123727123728123729123730123731123732123733123734123735123736123737123738123739123740123741123742123743123744123745123746123747123748123749123750123751123752123753123754123755123756123757123758123759123760123761123762123763123764123765123766123767123768123769123770123771123772123773123774123775123776123777123778123779123780123781123782123783123784123785123786123787123788123789123790123791123792123793123794123795123796123797123798123799123800123801123802123803123804123805123806123807123808123809123810123811123812123813123814123815123816123817123818123819123820123821123822123823123824123825123826123827123828123829123830123831123832123833123834123835123836123837123838123839123840123841123842123843123844123845123846123847123848123849123850123851123852123853123854123855123856123857123858123859123860123861123862123863123864123865123866123867123868123869123870123871123872123873123874123875123876123877123878123879123880123881123882123883123884123885123886123887123888123889123890123891123892123893123894123895123896123897123898123899123900123901123902123903123904123905123906123907123908123909123910123911123912123913123914123915123916123917123918123919123920123921123922123923123924123925123926123927123928123929123930123931123932123933123934123935123936123937123938123939123940123941123942123943123944123945123946123947123948123949123950123951123952123953123954123955123956123957123958123959123960123961123962123963123964123965123966123967123968123969123970123971123972123973123974123975123976123977123978123979123980123981123982123983123984123985123986123987123988123989123990123991123992123993123994123995123996123997123998123999124000124001124002124003124004124005124006124007124008124009124010124011124012124013124014124015124016124017124018124019124020124021124022124023124024124025124026124027124028124029124030124031124032124033124034124035124036124037124038124039124040124041124042124043124044124045124046124047124048124049124050124051124052124053124054124055124056124057124058124059124060124061124062124063124064124065124066124067124068124069124070124071124072124073124074124075124076124077124078124079124080124081124082124083124084124085124086124087124088124089124090124091124092124093124094124095124096124097124098124099124100124101124102124103124104124105124106124107124108124109124110124111124112124113124114124115124116124117124118124119124120124121124122124123124124124125124126124127124128124129124130124131124132124133124134124135124136124137124138124139124140124141124142124143124144124145124146124147124148124149124150124151124152124153124154124155124156124157124158124159124160124161124162124163124164124165124166124167124168124169124170124171124172124173124174124175124176124177124178124179124180124181124182124183124184124185124186124187124188124189124190124191124192124193124194124195124196124197124198124199124200124201124202124203124204124205124206124207124208124209124210124211124212124213124214124215124216124217124218124219124220124221124222124223124224124225124226124227124228124229124230124231124232124233124234124235124236124237124238124239124240124241124242124243124244124245124246124247124248124249124250124251124252124253124254124255124256124257124258124259124260124261124262124263124264124265124266124267124268124269124270124271124272124273124274124275124276124277124278124279124280124281124282124283124284124285124286124287124288124289124290124291124292124293124294124295124296124297124298124299124300124301124302124303124304124305124306124307124308124309124310124311124312124313124314124315124316124317124318124319124320124321124322124323124324124325124326124327124328124329124330124331124332124333124334124335124336124337124338124339124340124341124342124343124344124345124346124347124348124349124350124351124352124353124354124355124356124357124358124359124360124361124362124363124364124365124366124367124368124369124370124371124372124373124374124375124376124377124378124379124380124381124382124383124384124385124386124387124388124389124390124391124392124393124394124395124396124397124398124399124400124401124402124403124404124405124406124407124408124409124410124411124412124413124414124415124416124417124418124419124420124421124422124423124424124425124426124427124428124429124430124431124432124433124434124435124436124437124438124439124440124441124442124443124444124445124446124447124448124449124450124451124452124453124454124455124456124457124458124459124460124461124462124463124464124465124466124467124468124469124470124471124472124473124474124475124476124477124478124479124480124481124482124483124484124485124486124487124488124489124490124491124492124493124494124495124496124497124498124499124500124501124502124503124504124505124506124507124508124509124510124511124512124513124514124515124516124517124518124519124520124521124522124523124524124525124526124527124528124529124530124531124532124533124534124535124536124537124538124539124540124541124542124543124544124545124546124547124548124549124550124551124552124553124554124555124556124557124558124559124560124561124562124563124564124565124566124567124568124569124570124571124572124573124574124575124576124577124578124579124580124581124582124583124584124585124586124587124588124589124590124591124592124593124594124595124596124597124598124599124600124601124602124603124604124605124606124607124608124609124610124611124612124613124614124615124616124617124618124619124620124621124622124623124624124625124626124627124628124629124630124631124632124633124634124635124636124637124638124639124640124641124642124643124644124645124646124647124648124649124650124651124652124653124654124655124656124657124658124659124660124661124662124663124664124665124666124667124668124669124670124671124672124673124674124675124676124677124678124679124680124681124682124683124684124685124686124687124688124689124690124691124692124693124694124695124696124697124698124699124700124701124702124703124704124705124706124707124708124709124710124711124712124713124714124715124716124717124718124719124720124721124722124723124724124725124726124727124728124729124730124731124732124733124734124735124736124737124738124739124740124741124742124743124744124745124746124747124748124749124750124751124752124753124754124755124756124757124758124759124760124761124762124763124764124765124766124767124768124769124770124771124772124773124774124775124776124777124778124779124780124781124782124783124784124785124786124787124788124789124790124791124792124793124794124795124796124797124798124799124800124801124802124803124804124805124806124807124808124809124810124811124812124813124814124815124816124817124818124819124820124821124822124823124824124825124826124827124828124829124830124831124832124833124834124835124836124837124838124839124840124841124842124843124844124845124846124847124848124849124850124851124852124853124854124855124856124857124858124859124860124861124862124863124864124865124866124867124868124869124870124871124872124873124874124875124876124877124878124879124880124881124882124883124884124885124886124887124888124889124890124891124892124893124894124895124896124897124898124899124900124901124902124903124904124905124906124907124908124909124910124911124912124913124914124915124916124917124918124919124920124921124922124923124924124925124926124927124928124929124930124931124932124933124934124935124936124937124938124939124940124941124942124943124944124945124946124947124948124949124950124951124952124953124954124955124956124957124958124959124960124961124962124963124964124965124966124967124968124969124970124971124972124973124974124975124976124977124978124979124980124981124982124983124984124985124986124987124988124989124990124991124992124993124994124995124996124997124998124999125000125001125002125003125004125005125006125007125008125009125010125011125012125013125014125015125016125017125018125019125020125021125022125023125024125025125026125027125028125029125030125031125032125033125034125035125036125037125038125039125040125041125042125043125044125045125046125047125048125049125050125051125052125053125054125055125056125057125058125059125060125061125062125063125064125065125066125067125068125069125070125071125072125073125074125075125076125077125078125079125080125081125082125083125084125085125086125087125088125089125090125091125092125093125094125095125096125097125098125099125100125101125102125103125104125105125106125107125108125109125110125111125112125113125114125115125116125117125118125119125120125121125122125123125124125125125126125127125128125129125130125131125132125133125134125135125136125137125138125139125140125141125142125143125144125145125146125147125148125149125150125151125152125153125154125155125156125157125158125159125160125161125162125163125164125165125166125167125168125169125170125171125172125173125174125175125176125177125178125179125180125181125182125183125184125185125186125187125188125189125190125191125192125193125194125195125196125197125198125199125200125201125202125203125204125205125206125207125208125209125210125211125212125213125214125215125216125217125218125219125220125221125222125223125224125225125226125227125228125229125230125231125232125233125234125235125236125237125238125239125240125241125242125243125244125245125246125247125248125249125250125251125252125253125254125255125256125257125258125259125260125261125262125263125264125265125266125267125268125269125270125271125272125273125274125275125276125277125278125279125280125281125282125283125284125285125286125287125288125289125290125291125292125293125294125295125296125297125298125299125300125301125302125303125304125305125306125307125308125309125310125311125312125313125314125315125316125317125318125319125320125321125322125323125324125325125326125327125328125329125330125331125332125333125334125335125336125337125338125339125340125341125342125343125344125345125346125347125348125349125350125351125352125353125354125355125356125357125358125359125360125361125362125363125364125365125366125367125368125369125370125371125372125373125374125375125376125377125378125379125380125381125382125383125384125385125386125387125388125389125390125391125392125393125394125395125396125397125398125399125400125401125402125403125404125405125406125407125408125409125410125411125412125413125414125415125416125417125418125419125420125421125422125423125424125425125426125427125428125429125430125431125432125433125434125435125436125437125438125439125440125441125442125443125444125445125446125447125448125449125450125451125452125453125454125455125456125457125458125459125460125461125462125463125464125465125466125467125468125469125470125471125472125473125474125475125476125477125478125479125480125481125482125483125484125485125486125487125488125489125490125491125492125493125494125495125496125497125498125499125500125501125502125503125504125505125506125507125508125509125510125511125512125513125514125515125516125517125518125519125520125521125522125523125524125525125526125527125528125529125530125531125532125533125534125535125536125537125538125539125540125541125542125543125544125545125546125547125548125549125550125551125552125553125554125555125556125557125558125559125560125561125562125563125564125565125566125567125568125569125570125571125572125573125574125575125576125577125578125579125580125581125582125583125584125585125586125587125588125589125590125591125592125593125594125595125596125597125598125599125600125601125602125603125604125605125606125607125608125609125610125611125612125613125614125615125616125617125618125619125620125621125622125623125624125625125626125627125628125629125630125631125632125633125634125635125636125637125638125639125640125641125642125643125644125645125646125647125648125649125650125651125652125653125654125655125656125657125658125659125660125661125662125663125664125665125666125667125668125669125670125671125672125673125674125675125676125677125678125679125680125681125682125683125684125685125686125687125688125689125690125691125692125693125694125695125696125697125698125699125700125701125702125703125704125705125706125707125708125709125710125711125712125713125714125715125716125717125718125719125720125721125722125723125724125725125726125727125728125729125730125731125732125733125734125735125736125737125738125739125740125741125742125743125744125745125746125747125748125749125750125751125752125753125754125755125756125757125758125759125760125761125762125763125764125765125766125767125768125769125770125771125772125773125774125775125776125777125778125779125780125781125782125783125784125785125786125787125788125789125790125791125792125793125794125795125796125797125798125799125800125801125802125803125804125805125806125807125808125809125810125811125812125813125814125815125816125817125818125819125820125821125822125823125824125825125826125827125828125829125830125831125832125833125834125835125836125837125838125839125840125841125842125843125844125845125846125847125848125849125850125851125852125853125854125855125856125857125858125859125860125861125862125863125864125865125866125867125868125869125870125871125872125873125874125875125876125877125878125879125880125881125882125883125884125885125886125887125888125889125890125891125892125893125894125895125896125897125898125899125900125901125902125903125904125905125906125907125908125909125910125911125912125913125914125915125916125917125918125919125920125921125922125923125924125925125926125927125928125929125930125931125932125933125934125935125936125937125938125939125940125941125942125943125944125945125946125947125948125949125950125951125952125953125954125955125956125957125958125959125960125961125962125963125964125965125966125967125968125969125970125971125972125973125974125975125976125977125978125979125980125981125982125983125984125985125986125987125988125989125990125991125992125993125994125995125996125997125998125999126000126001126002126003126004126005126006126007126008126009126010126011126012126013126014126015126016126017126018126019126020126021126022126023126024126025126026126027126028126029126030126031126032126033126034126035126036126037126038126039126040126041126042126043126044126045126046126047126048126049126050126051126052126053126054126055126056126057126058126059126060126061126062126063126064126065126066126067126068126069126070126071126072126073126074126075126076126077126078126079126080126081126082126083126084126085126086126087126088126089126090126091126092126093126094126095126096126097126098126099126100126101126102126103126104126105126106126107126108126109126110126111126112126113126114126115126116126117126118126119126120126121126122126123126124126125126126126127126128126129126130126131126132126133126134126135126136126137126138126139126140126141126142126143126144126145126146126147126148126149126150126151126152126153126154126155126156126157126158126159126160126161126162126163126164126165126166126167126168126169126170126171126172126173126174126175126176126177126178126179126180126181126182126183126184126185126186126187126188126189126190126191126192126193126194126195126196126197126198126199126200126201126202126203126204126205126206126207126208126209126210126211126212126213126214126215126216126217126218126219126220126221126222126223126224126225126226126227126228126229126230126231126232126233126234126235126236126237126238126239126240126241126242126243126244126245126246126247126248126249126250126251126252126253126254126255126256126257126258126259126260126261126262126263126264126265126266126267126268126269126270126271126272126273126274126275126276126277126278126279126280126281126282126283126284126285126286126287126288126289126290126291126292126293126294126295126296126297126298126299126300126301126302126303126304126305126306126307126308126309126310126311126312126313126314126315126316126317126318126319126320126321126322126323126324126325126326126327126328126329126330126331126332126333126334126335126336126337126338126339126340126341126342126343126344126345126346126347126348126349126350126351126352126353126354126355126356126357126358126359126360126361126362126363126364126365126366126367126368126369126370126371126372126373126374126375126376126377126378126379126380126381126382126383126384126385126386126387126388126389126390126391126392126393126394126395126396126397126398126399126400126401126402126403126404126405126406126407126408126409126410126411126412126413126414126415126416126417126418126419126420126421126422126423126424126425126426126427126428126429126430126431126432126433126434126435126436126437126438126439126440126441126442126443126444126445126446126447126448126449126450126451126452126453126454126455126456126457126458126459126460126461126462126463126464126465126466126467126468126469126470126471126472126473126474126475126476126477126478126479126480126481126482126483126484126485126486126487126488126489126490126491126492126493126494126495126496126497126498126499126500126501126502126503126504126505126506126507126508126509126510126511126512126513126514126515126516126517126518126519126520126521126522126523126524126525126526126527126528126529126530126531126532126533126534126535126536126537126538126539126540126541126542126543126544126545126546126547126548126549126550126551126552126553126554126555126556126557126558126559126560126561126562126563126564126565126566126567126568126569126570126571126572126573126574126575126576126577126578126579126580126581126582126583126584126585126586126587126588126589126590126591126592126593126594126595126596126597126598126599126600126601126602126603126604126605126606126607126608126609126610126611126612126613126614126615126616126617126618126619126620126621126622126623126624126625126626126627126628126629126630126631126632126633126634126635126636126637126638126639126640126641126642126643126644126645126646126647126648126649126650126651126652126653126654126655126656126657126658126659126660126661126662126663126664126665126666126667126668126669126670126671126672126673126674126675126676126677126678126679126680126681126682126683126684126685126686126687126688126689126690126691126692126693126694126695126696126697126698126699126700126701126702126703126704126705126706126707126708126709126710126711126712126713126714126715126716126717126718126719126720126721126722126723126724126725126726126727126728126729126730126731126732126733126734126735126736126737126738126739126740126741126742126743126744126745126746126747126748126749126750126751126752126753126754126755126756126757126758126759126760126761126762126763126764126765126766126767126768126769126770126771126772126773126774126775126776126777126778126779126780126781126782126783126784126785126786126787126788126789126790126791126792126793126794126795126796126797126798126799126800126801126802126803126804126805126806126807126808126809126810126811126812126813126814126815126816126817126818126819126820126821126822126823126824126825126826126827126828126829126830126831126832126833126834126835126836126837126838126839126840126841126842126843126844126845126846126847126848126849126850126851126852126853126854126855126856126857126858126859126860126861126862126863126864126865126866126867126868126869126870126871126872126873126874126875126876126877126878126879126880126881126882126883126884126885126886126887126888126889126890126891126892126893126894126895126896126897126898126899126900126901126902126903126904126905126906126907126908126909126910126911126912126913126914126915126916126917126918126919126920126921126922126923126924126925126926126927126928126929126930126931126932126933126934126935126936126937126938126939126940126941126942126943126944126945126946126947126948126949126950126951126952126953126954126955126956126957126958126959126960126961126962126963126964126965126966126967126968126969126970126971126972126973126974126975126976126977126978126979126980126981126982126983126984126985126986126987126988126989126990126991126992126993126994126995126996126997126998126999127000127001127002127003127004127005127006127007127008127009127010127011127012127013127014127015127016127017127018127019127020127021127022127023127024127025127026127027127028127029127030127031127032127033127034127035127036127037127038127039127040127041127042127043127044127045127046127047127048127049127050127051127052127053127054127055127056127057127058127059127060127061127062127063127064127065127066127067127068127069127070127071127072127073127074127075127076127077127078127079127080127081127082127083127084127085127086127087127088127089127090127091127092127093127094127095127096127097127098127099127100127101127102127103127104127105127106127107127108127109127110127111127112127113127114127115127116127117127118127119127120127121127122127123127124127125127126127127127128127129127130127131127132127133127134127135127136127137127138127139127140127141127142127143127144127145127146127147127148127149127150127151127152127153127154127155127156127157127158127159127160127161127162127163127164127165127166127167127168127169127170127171127172127173127174127175127176127177127178127179127180127181127182127183127184127185127186127187127188127189127190127191127192127193127194127195127196127197127198127199127200127201127202127203127204127205127206127207127208127209127210127211127212127213127214127215127216127217127218127219127220127221127222127223127224127225127226127227127228127229127230127231127232127233127234127235127236127237127238127239127240127241127242127243127244127245127246127247127248127249127250127251127252127253127254127255127256127257127258127259127260127261127262127263127264127265127266127267127268127269127270127271127272127273127274127275127276127277127278127279127280127281127282127283127284127285127286127287127288127289127290127291127292127293127294127295127296127297127298127299127300127301127302127303127304127305127306127307127308127309127310127311127312127313127314127315127316127317127318127319127320127321127322127323127324127325127326127327127328127329127330127331127332127333127334127335127336127337127338127339127340127341127342127343127344127345127346127347127348127349127350127351127352127353127354127355127356127357127358127359127360127361127362127363127364127365127366127367127368127369127370127371127372127373127374127375127376127377127378127379127380127381127382127383127384127385127386127387127388127389127390127391127392127393127394127395127396127397127398127399127400127401127402127403127404127405127406127407127408127409127410127411127412127413127414127415127416127417127418127419127420127421127422127423127424127425127426127427127428127429127430127431127432127433127434127435127436127437127438127439127440127441127442127443127444127445127446127447127448127449127450127451127452127453127454127455127456127457127458127459127460127461127462127463127464127465127466127467127468127469127470127471127472127473127474127475127476127477127478127479127480127481127482127483127484127485127486127487127488127489127490127491127492127493127494127495127496127497127498127499127500127501127502127503127504127505127506127507127508127509127510127511127512127513127514127515127516127517127518127519127520127521127522127523127524127525127526127527127528127529127530127531127532127533127534127535127536127537127538127539127540127541127542127543127544127545127546127547127548127549127550127551127552127553127554127555127556127557127558127559127560127561127562127563127564127565127566127567127568127569127570127571127572127573127574127575127576127577127578127579127580127581127582127583127584127585127586127587127588127589127590127591127592127593127594127595127596127597127598127599127600127601127602127603127604127605127606127607127608127609127610127611127612127613127614127615127616127617127618127619127620127621127622127623127624127625127626127627127628127629127630127631127632127633127634127635127636127637127638127639127640127641127642127643127644127645127646127647127648127649127650127651127652127653127654127655127656127657127658127659127660127661127662127663127664127665127666127667127668127669127670127671127672127673127674127675127676127677127678127679127680127681127682127683127684127685127686127687127688127689127690127691127692127693127694127695127696127697127698127699127700127701127702127703127704127705127706127707127708127709127710127711127712127713127714127715127716127717127718127719127720127721127722127723127724127725127726127727127728127729127730127731127732127733127734127735127736127737127738127739127740127741127742127743127744127745127746127747127748127749127750127751127752127753127754127755127756127757127758127759127760127761127762127763127764127765127766127767127768127769127770127771127772127773127774127775127776127777127778127779127780127781127782127783127784127785127786127787127788127789127790127791127792127793127794127795127796127797127798127799127800127801127802127803127804127805127806127807127808127809127810127811127812127813127814127815127816127817127818127819127820127821127822127823127824127825127826127827127828127829127830127831127832127833127834127835127836127837127838127839127840127841127842127843127844127845127846127847127848127849127850127851127852127853127854127855127856127857127858127859127860127861127862127863127864127865127866127867127868127869127870127871127872127873127874127875127876127877127878127879127880127881127882127883127884127885127886127887127888127889127890127891127892127893127894127895127896127897127898127899127900127901127902127903127904127905127906127907127908127909127910127911127912127913127914127915127916127917127918127919127920127921127922127923127924127925127926127927127928127929127930127931127932127933127934127935127936127937127938127939127940127941127942127943127944127945127946127947127948127949127950127951127952127953127954127955127956127957127958127959127960127961127962127963127964127965127966127967127968127969127970127971127972127973127974127975127976127977127978127979127980127981127982127983127984127985127986127987127988127989127990127991127992127993127994127995127996127997127998127999128000128001128002128003128004128005128006128007128008128009128010128011128012128013128014128015128016128017128018128019128020128021128022128023128024128025128026128027128028128029128030128031128032128033128034128035128036128037128038128039128040128041128042128043128044128045128046128047128048128049128050128051128052128053128054128055128056128057128058128059128060128061128062128063128064128065128066128067128068128069128070128071128072128073128074128075128076128077128078128079128080128081128082128083128084128085128086128087128088128089128090128091128092128093128094128095128096128097128098128099128100128101128102128103128104128105128106128107128108128109128110128111128112128113128114128115128116128117128118128119128120128121128122128123128124128125128126128127128128128129128130128131128132128133128134128135128136128137128138128139128140128141128142128143128144128145128146128147128148128149128150128151128152128153128154128155128156128157128158128159128160128161128162128163128164128165128166128167128168128169128170128171128172128173128174128175128176128177128178128179128180128181128182128183128184128185128186128187128188128189128190128191128192128193128194128195128196128197128198128199128200128201128202128203128204128205128206128207128208128209128210128211128212128213128214128215128216128217128218128219128220128221128222128223128224128225128226128227128228128229128230128231128232128233128234128235128236128237128238128239128240128241128242128243128244128245128246128247128248128249128250128251128252128253128254128255128256128257128258128259128260128261128262128263128264128265128266128267128268128269128270128271128272128273128274128275128276128277128278128279128280128281128282128283128284128285128286128287128288128289128290128291128292128293128294128295128296128297128298128299128300128301128302128303128304128305128306128307128308128309128310128311128312128313128314128315128316128317128318128319128320128321128322128323128324128325128326128327128328128329128330128331128332128333128334128335128336128337128338128339128340128341128342128343128344128345128346128347128348128349128350128351128352128353128354128355128356128357128358128359128360128361128362128363128364128365128366128367128368128369128370128371128372128373128374128375128376128377128378128379128380128381128382128383128384128385128386128387128388128389128390128391128392128393128394128395128396128397128398128399128400128401128402128403128404128405128406128407128408128409128410128411128412128413128414128415128416128417128418128419128420128421128422128423128424128425128426128427128428128429128430128431128432128433128434128435128436128437128438128439128440128441128442128443128444128445128446128447128448128449128450128451128452128453128454128455128456128457128458128459128460128461128462128463128464128465128466128467128468128469128470128471128472128473128474128475128476128477128478128479128480128481128482128483128484128485128486128487128488128489128490128491128492128493128494128495128496128497128498128499128500128501128502128503128504128505128506128507128508128509128510128511128512128513128514128515128516128517128518128519128520128521128522128523128524128525128526128527128528128529128530128531128532128533128534128535128536128537128538128539128540128541128542128543128544128545128546128547128548128549128550128551128552128553128554128555128556128557128558128559128560128561128562128563128564128565128566128567128568128569128570128571128572128573128574128575128576128577128578128579128580128581128582128583128584128585128586128587128588128589128590128591128592128593128594128595128596128597128598128599128600128601128602128603128604128605128606128607128608128609128610128611128612128613128614128615128616128617128618128619128620128621128622128623128624128625128626128627128628128629128630128631128632128633128634128635128636128637128638128639128640128641128642128643128644128645128646128647128648128649128650128651128652128653128654128655128656128657128658128659128660128661128662128663128664128665128666128667128668128669128670128671128672128673128674128675128676128677128678128679128680128681128682128683128684128685128686128687128688128689128690128691128692128693128694128695128696128697128698128699128700128701128702128703128704128705128706128707128708128709128710128711128712128713128714128715128716128717128718128719128720128721128722128723128724128725128726128727128728128729128730128731128732128733128734128735128736128737128738128739128740128741128742128743128744128745128746128747128748128749128750128751128752128753128754128755128756128757128758128759128760128761128762128763128764128765128766128767128768128769128770128771128772128773128774128775128776128777128778128779128780128781128782128783128784128785128786128787128788128789128790128791128792128793128794128795128796128797128798128799128800128801128802128803128804128805128806128807128808128809128810128811128812128813128814128815128816128817128818128819128820128821128822128823128824128825128826128827128828128829128830128831128832128833128834128835128836128837128838128839128840128841128842128843128844128845128846128847128848128849128850128851128852128853128854128855128856128857128858128859128860128861128862128863128864128865128866128867128868128869128870128871128872128873128874128875128876128877128878128879128880128881128882128883128884128885128886128887128888128889128890128891128892128893128894128895128896128897128898128899128900128901128902128903128904128905128906128907128908128909128910128911128912128913128914128915128916128917128918128919128920128921128922128923128924128925128926128927128928128929128930128931128932128933128934128935128936128937128938128939128940128941128942128943128944128945128946128947128948128949128950128951128952128953128954128955128956128957128958128959128960128961128962128963128964128965128966128967128968128969128970128971128972128973128974128975128976128977128978128979128980128981128982128983128984128985128986128987128988128989128990128991128992128993128994128995128996128997128998128999129000129001129002129003129004129005129006129007129008129009129010129011129012129013129014129015129016129017129018129019129020129021129022129023129024129025129026129027129028129029129030129031129032129033129034129035129036129037129038129039129040129041129042129043129044129045129046129047129048129049129050129051129052129053129054129055129056129057129058129059129060129061129062129063129064129065129066129067129068129069129070129071129072129073129074129075129076129077129078129079129080129081129082129083129084129085129086129087129088129089129090129091129092129093129094129095129096129097129098129099129100129101129102129103129104129105129106129107129108129109129110129111129112129113129114129115129116129117129118129119129120129121129122129123129124129125129126129127129128129129129130129131129132129133129134129135129136129137129138129139129140129141129142129143129144129145129146129147129148129149129150129151129152129153129154129155129156129157129158129159129160129161129162129163129164129165129166129167129168129169129170129171129172129173129174129175129176129177129178129179129180129181129182129183129184129185129186129187129188129189129190129191129192129193129194129195129196129197129198129199129200129201129202129203129204129205129206129207129208129209129210129211129212129213129214129215129216129217129218129219129220129221129222129223129224129225129226129227129228129229129230129231129232129233129234129235129236129237129238129239129240129241129242129243129244129245129246129247129248129249129250129251129252129253129254129255129256129257129258129259129260129261129262129263129264129265129266129267129268129269129270129271129272129273129274129275129276129277129278129279129280129281129282129283129284129285129286129287129288129289129290129291129292129293129294129295129296129297129298129299129300129301129302129303129304129305129306129307129308129309129310129311129312129313129314129315129316129317129318129319129320129321129322129323129324129325129326129327129328129329129330129331129332129333129334129335129336129337129338129339129340129341129342129343129344129345129346129347129348129349129350129351129352129353129354129355129356129357129358129359129360129361129362129363129364129365129366129367129368129369129370129371129372129373129374129375129376129377129378129379129380129381129382129383129384129385129386129387129388129389129390129391129392129393129394129395129396129397129398129399129400129401129402129403129404129405129406129407129408129409129410129411129412129413129414129415129416129417129418129419129420129421129422129423129424129425129426129427129428129429129430129431129432129433129434129435129436129437129438129439129440129441129442129443129444129445129446129447129448129449129450129451129452129453129454129455129456129457129458129459129460129461129462129463129464129465129466129467129468129469129470129471129472129473129474129475129476129477129478129479129480129481129482129483129484129485129486129487129488129489129490129491129492129493129494129495129496129497129498129499129500129501129502129503129504129505129506129507129508129509129510129511129512129513129514129515129516129517129518129519129520129521129522129523129524129525129526129527129528129529129530129531129532129533129534129535129536129537129538129539129540129541129542129543129544129545129546129547129548129549129550129551129552129553129554129555129556129557129558129559129560129561129562129563129564129565129566129567129568129569129570129571129572129573129574129575129576129577129578129579129580129581129582129583129584129585129586129587129588129589129590129591129592129593129594129595129596129597129598129599129600129601129602129603129604129605129606129607129608129609129610129611129612129613129614129615129616129617129618129619129620129621129622129623129624129625129626129627129628129629129630129631129632129633129634129635129636129637129638129639129640129641129642129643129644129645129646129647129648129649129650129651129652129653129654129655129656129657129658129659129660129661129662129663129664129665129666129667129668129669129670129671129672129673129674129675129676129677129678129679129680129681129682129683129684129685129686129687129688129689129690129691129692129693129694129695129696129697129698129699129700129701129702129703129704129705129706129707129708129709129710129711129712129713129714129715129716129717129718129719129720129721129722129723129724129725129726129727129728129729129730129731129732129733129734129735129736129737129738129739129740129741129742129743129744129745129746129747129748129749129750129751129752129753129754129755129756129757129758129759129760129761129762129763129764129765129766129767129768129769129770129771129772129773129774129775129776129777129778129779129780129781129782129783129784129785129786129787129788129789129790129791129792129793129794129795129796129797129798129799129800129801129802129803129804129805129806129807129808129809129810129811129812129813129814129815129816129817129818129819129820129821129822129823129824129825129826129827129828129829129830129831129832129833129834129835129836129837129838129839129840129841129842129843129844129845129846129847129848129849129850129851129852129853129854129855129856129857129858129859129860129861129862129863129864129865129866129867129868129869129870129871129872129873129874129875129876129877129878129879129880129881129882129883129884129885129886129887129888129889129890129891129892129893129894129895129896129897129898129899129900129901129902129903129904129905129906129907129908129909129910129911129912129913129914129915129916129917129918129919129920129921129922129923129924129925129926129927129928129929129930129931129932129933129934129935129936129937129938129939129940129941129942129943129944129945129946129947129948129949129950129951129952129953129954129955129956129957129958129959129960129961129962129963129964129965129966129967129968129969129970129971129972129973129974129975129976129977129978129979129980129981129982129983129984129985129986129987129988129989129990129991129992129993129994129995129996129997129998129999130000130001130002130003130004130005130006130007130008130009130010130011130012130013130014130015130016130017130018130019130020130021130022130023130024130025130026130027130028130029130030130031130032130033130034130035130036130037130038130039130040130041130042130043130044130045130046130047130048130049130050130051130052130053130054130055130056130057130058130059130060130061130062130063130064130065130066130067130068130069130070130071130072130073130074130075130076130077130078130079130080130081130082130083130084130085130086130087130088130089130090130091130092130093130094130095130096130097130098130099130100130101130102130103130104130105130106130107130108130109130110130111130112130113130114130115130116130117130118130119130120130121130122130123130124130125130126130127130128130129130130130131130132130133130134130135130136130137130138130139130140130141130142130143130144130145130146130147130148130149130150130151130152130153130154130155130156130157130158130159130160130161130162130163130164130165130166130167130168130169130170130171130172130173130174130175130176130177130178130179130180130181130182130183130184130185130186130187130188130189130190130191130192130193130194130195130196130197130198130199130200130201130202130203130204130205130206130207130208130209130210130211130212130213130214130215130216130217130218130219130220130221130222130223130224130225130226130227130228130229130230130231130232130233130234130235130236130237130238130239130240130241130242130243130244130245130246130247130248130249130250130251130252130253130254130255130256130257130258130259130260130261130262130263130264130265130266130267130268130269130270130271130272130273130274130275130276130277130278130279130280130281130282130283130284130285130286130287130288130289130290130291130292130293130294130295130296130297130298130299130300130301130302130303130304130305130306130307130308130309130310130311130312130313130314130315130316130317130318130319130320130321130322130323130324130325130326130327130328130329130330130331130332130333130334130335130336130337130338130339130340130341130342130343130344130345130346130347130348130349130350130351130352130353130354130355130356130357130358130359130360130361130362130363130364130365130366130367130368130369130370130371130372130373130374130375130376130377130378130379130380130381130382130383130384130385130386130387130388130389130390130391130392130393130394130395130396130397130398130399130400130401130402130403130404130405130406130407130408130409130410130411130412130413130414130415130416130417130418130419130420130421130422130423130424130425130426130427130428130429130430130431130432130433130434130435130436130437130438130439130440130441130442130443130444130445130446130447130448130449130450130451130452130453130454130455130456130457130458130459130460130461130462130463130464130465130466130467130468130469130470130471130472130473130474130475130476130477130478130479130480130481130482130483130484130485130486130487130488130489130490130491130492130493130494130495130496130497130498130499130500130501130502130503130504130505130506130507130508130509130510130511130512130513130514130515130516130517130518130519130520130521130522130523130524130525130526130527130528130529130530130531130532130533130534130535130536130537130538130539130540130541130542130543130544130545130546130547130548130549130550130551130552130553130554130555130556130557130558130559130560130561130562130563130564130565130566130567130568130569130570130571130572130573130574130575130576130577130578130579130580130581130582130583130584130585130586130587130588130589130590130591130592130593130594130595130596130597130598130599130600130601130602130603130604130605130606130607130608130609130610130611130612130613130614130615130616130617130618130619130620130621130622130623130624130625130626130627130628130629130630130631130632130633130634130635130636130637130638130639130640130641130642130643130644130645130646130647130648130649130650130651130652130653130654130655130656130657130658130659130660130661130662130663130664130665130666130667130668130669130670130671130672130673130674130675130676130677130678130679130680130681130682130683130684130685130686130687130688130689130690130691130692130693130694130695130696130697130698130699130700130701130702130703130704130705130706130707130708130709130710130711130712130713130714130715130716130717130718130719130720130721130722130723130724130725130726130727130728130729130730130731130732130733130734130735130736130737130738130739130740130741130742130743130744130745130746130747130748130749130750130751130752130753130754130755130756130757130758130759130760130761130762130763130764130765130766130767130768130769130770130771130772130773130774130775130776130777130778130779130780130781130782130783130784130785130786130787130788130789130790130791130792130793130794130795130796130797130798130799130800130801130802130803130804130805130806130807130808130809130810130811130812130813130814130815130816130817130818130819130820130821130822130823130824130825130826130827130828130829130830130831130832130833130834130835130836130837130838130839130840130841130842130843130844130845130846130847130848130849130850130851130852130853130854130855130856130857130858130859130860130861130862130863130864130865130866130867130868130869130870130871130872130873130874130875130876130877130878130879130880130881130882130883130884130885130886130887130888130889130890130891130892130893130894130895130896130897130898130899130900130901130902130903130904130905130906130907130908130909130910130911130912130913130914130915130916130917130918130919130920130921130922130923130924130925130926130927130928130929130930130931130932130933130934130935130936130937130938130939130940130941130942130943130944130945130946130947130948130949130950130951130952130953130954130955130956130957130958130959130960130961130962130963130964130965130966130967130968130969130970130971130972130973130974130975130976130977130978130979130980130981130982130983130984130985130986130987130988130989130990130991130992130993130994130995130996130997130998130999131000131001131002131003131004131005131006131007131008131009131010131011131012131013131014131015131016131017131018131019131020131021131022131023131024131025131026131027131028131029131030131031131032131033131034131035131036131037131038131039131040131041131042131043131044131045131046131047131048131049131050131051131052131053131054131055131056131057131058131059131060131061131062131063131064131065131066131067131068131069131070131071131072131073131074131075131076131077131078131079131080131081131082131083131084131085131086131087131088131089131090131091131092131093131094131095131096131097131098131099131100131101131102131103131104131105131106131107131108131109131110131111131112131113131114131115131116131117131118131119131120131121131122131123131124131125131126131127131128131129131130131131131132131133131134131135131136131137131138131139131140131141131142131143131144131145131146131147131148131149131150131151131152131153131154131155131156131157131158131159131160131161131162131163131164131165131166131167131168131169131170131171131172131173131174131175131176131177131178131179131180131181131182131183131184131185131186131187131188131189131190131191131192131193131194131195131196131197131198131199131200131201131202131203131204131205131206131207131208131209131210131211131212131213131214131215131216131217131218131219131220131221131222131223131224131225131226131227131228131229131230131231131232131233131234131235131236131237131238131239131240131241131242131243131244131245131246131247131248131249131250131251131252131253131254131255131256131257131258131259131260131261131262131263131264131265131266131267131268131269131270131271131272131273131274131275131276131277131278131279131280131281131282131283131284131285131286131287131288131289131290131291131292131293131294131295131296131297131298131299131300131301131302131303131304131305131306131307131308131309131310131311131312131313131314131315131316131317131318131319131320131321131322131323131324131325131326131327131328131329131330131331131332131333131334131335131336131337131338131339131340131341131342131343131344131345131346131347131348131349131350131351131352131353131354131355131356131357131358131359131360131361131362131363131364131365131366131367131368131369131370131371131372131373131374131375131376131377131378131379131380131381131382131383131384131385131386131387131388131389131390131391131392131393131394131395131396131397131398131399131400131401131402131403131404131405131406131407131408131409131410131411131412131413131414131415131416131417131418131419131420131421131422131423131424131425131426131427131428131429131430131431131432131433131434131435131436131437131438131439131440131441131442131443131444131445131446131447131448131449131450131451131452131453131454131455131456131457131458131459131460131461131462131463131464131465131466131467131468131469131470131471131472131473131474131475131476131477131478131479131480131481131482131483131484131485131486131487131488131489131490131491131492131493131494131495131496131497131498131499131500131501131502131503131504131505131506131507131508131509131510131511131512131513131514131515131516131517131518131519131520131521131522131523131524131525131526131527131528131529131530131531131532131533131534131535131536131537131538131539131540131541131542131543131544131545131546131547131548131549131550131551131552131553131554131555131556131557131558131559131560131561131562131563131564131565131566131567131568131569131570131571131572131573131574131575131576131577131578131579131580131581131582131583131584131585131586131587131588131589131590131591131592131593131594131595131596131597131598131599131600131601131602131603131604131605131606131607131608131609131610131611131612131613131614131615131616131617131618131619131620131621131622131623131624131625131626131627131628131629131630131631131632131633131634131635131636131637131638131639131640131641131642131643131644131645131646131647131648131649131650131651131652131653131654131655131656131657131658131659131660131661131662131663131664131665131666131667131668131669131670131671131672131673131674131675131676131677131678131679131680131681131682131683131684131685131686131687131688131689131690131691131692131693131694131695131696131697131698131699131700131701131702131703131704131705131706131707131708131709131710131711131712131713131714131715131716131717131718131719131720131721131722131723131724131725131726131727131728131729131730131731131732131733131734131735131736131737131738131739131740131741131742131743131744131745131746131747131748131749131750131751131752131753131754131755131756131757131758131759131760131761131762131763131764131765131766131767131768131769131770131771131772131773131774131775131776131777131778131779131780131781131782131783131784131785131786131787131788131789131790131791131792131793131794131795131796131797131798131799131800131801131802131803131804131805131806131807131808131809131810131811131812131813131814131815131816131817131818131819131820131821131822131823131824131825131826131827131828131829131830131831131832131833131834131835131836131837131838131839131840131841131842131843131844131845131846131847131848131849131850131851131852131853131854131855131856131857131858131859131860131861131862131863131864131865131866131867131868131869131870131871131872131873131874131875131876131877131878131879131880131881131882131883131884131885131886131887131888131889131890131891131892131893131894131895131896131897131898131899131900131901131902131903131904131905131906131907131908131909131910131911131912131913131914131915131916131917131918131919131920131921131922131923131924131925131926131927131928131929131930131931131932131933131934131935131936131937131938131939131940131941131942131943131944131945131946131947131948131949131950131951131952131953131954131955131956131957131958131959131960131961131962131963131964131965131966131967131968131969131970131971131972131973131974131975131976131977131978131979131980131981131982131983131984131985131986131987131988131989131990131991131992131993131994131995131996131997131998131999132000132001132002132003132004132005132006132007132008132009132010132011132012132013132014132015132016132017132018132019132020132021132022132023132024132025132026132027132028132029132030132031132032132033132034132035132036132037132038132039132040132041132042132043132044132045132046132047132048132049132050132051132052132053132054132055132056132057132058132059132060132061132062132063132064132065132066132067132068132069132070132071132072132073132074132075132076132077132078132079132080132081132082132083132084132085132086132087132088132089132090132091132092132093132094132095132096132097132098132099132100132101132102132103132104132105132106132107132108132109132110132111132112132113132114132115132116132117132118132119132120132121132122132123132124132125132126132127132128132129132130132131132132132133132134132135132136132137132138132139132140132141132142132143132144132145132146132147132148132149132150132151132152132153132154132155132156132157132158132159132160132161132162132163132164132165132166132167132168132169132170132171132172132173132174132175132176132177132178132179132180132181132182132183132184132185132186132187132188132189132190132191132192132193132194132195132196132197132198132199132200132201132202132203132204132205132206132207132208132209132210132211132212132213132214132215132216132217132218132219132220132221132222132223132224132225132226132227132228132229132230132231132232132233132234132235132236132237132238132239132240132241132242132243132244132245132246132247132248132249132250132251132252132253132254132255132256132257132258132259132260132261132262132263132264132265132266132267132268132269132270132271132272132273132274132275132276132277132278132279132280132281132282132283132284132285132286132287132288132289132290132291132292132293132294132295132296132297132298132299132300132301132302132303132304132305132306132307132308132309132310132311132312132313132314132315132316132317132318132319132320132321132322132323132324132325132326132327132328132329132330132331132332132333132334132335132336132337132338132339132340132341132342132343132344132345132346132347132348132349132350132351132352132353132354132355132356132357132358132359132360132361132362132363132364132365132366132367132368132369132370132371132372132373132374132375132376132377132378132379132380132381132382132383132384132385132386132387132388132389132390132391132392132393132394132395132396132397132398132399132400132401132402132403132404132405132406132407132408132409132410132411132412132413132414132415132416132417132418132419132420132421132422132423132424132425132426132427132428132429132430132431132432132433132434132435132436132437132438132439132440132441132442132443132444132445132446132447132448132449132450132451132452132453132454132455132456132457132458132459132460132461132462132463132464132465132466132467132468132469132470132471132472132473132474132475132476132477132478132479132480132481132482132483132484132485132486132487132488132489132490132491132492132493132494132495132496132497132498132499132500132501132502132503132504132505132506132507132508132509132510132511132512132513132514132515132516132517132518132519132520132521132522132523132524132525132526132527132528132529132530132531132532132533132534132535132536132537132538132539132540132541132542132543132544132545132546132547132548132549132550132551132552132553132554132555132556132557132558132559132560132561132562132563132564132565132566132567132568132569132570132571132572132573132574132575132576132577132578132579132580132581132582132583132584132585132586132587132588132589132590132591132592132593132594132595132596132597132598132599132600132601132602132603132604132605132606132607132608132609132610132611132612132613132614132615132616132617132618132619132620132621132622132623132624132625132626132627132628132629132630132631132632132633132634132635132636132637132638132639132640132641132642132643132644132645132646132647132648132649132650132651132652132653132654132655132656132657132658132659132660132661132662132663132664132665132666132667132668132669132670132671132672132673132674132675132676132677132678132679132680132681132682132683132684132685132686132687132688132689132690132691132692132693132694132695132696132697132698132699132700132701132702132703132704132705132706132707132708132709132710132711132712132713132714132715132716132717132718132719132720132721132722132723132724132725132726132727132728132729132730132731132732132733132734132735132736132737132738132739132740132741132742132743132744132745132746132747132748132749132750132751132752132753132754132755132756132757132758132759132760132761132762132763132764132765132766132767132768132769132770132771132772132773132774132775132776132777132778132779132780132781132782132783132784132785132786132787132788132789132790132791132792132793132794132795132796132797132798132799132800132801132802132803132804132805132806132807132808132809132810132811132812132813132814132815132816132817132818132819132820132821132822132823132824132825132826132827132828132829132830132831132832132833132834132835132836132837132838132839132840132841132842132843132844132845132846132847132848132849132850132851132852132853132854132855132856132857132858132859132860132861132862132863132864132865132866132867132868132869132870132871132872132873132874132875132876132877132878132879132880132881132882132883132884132885132886132887132888132889132890132891132892132893132894132895132896132897132898132899132900132901132902132903132904132905132906132907132908132909132910132911132912132913132914132915132916132917132918132919132920132921132922132923132924132925132926132927132928132929132930132931132932132933132934132935132936132937132938132939132940132941132942132943132944132945132946132947132948132949132950132951132952132953132954132955132956132957132958132959132960132961132962132963132964132965132966132967132968132969132970132971132972132973132974132975132976132977132978132979132980132981132982132983132984132985132986132987132988132989132990132991132992132993132994132995132996132997132998132999133000133001133002133003133004133005133006133007133008133009133010133011133012133013133014133015133016133017133018133019133020133021133022133023133024133025133026133027133028133029133030133031133032133033133034133035133036133037133038133039133040133041133042133043133044133045133046133047133048133049133050133051133052133053133054133055133056133057133058133059133060133061133062133063133064133065133066133067133068133069133070133071133072133073133074133075133076133077133078133079133080133081133082133083133084133085133086133087133088133089133090133091133092133093133094133095133096133097133098133099133100133101133102133103133104133105133106133107133108133109133110133111133112133113133114133115133116133117133118133119133120133121133122133123133124133125133126133127133128133129133130133131133132133133133134133135133136133137133138133139133140133141133142133143133144133145133146133147133148133149133150133151133152133153133154133155133156133157133158133159133160133161133162133163133164133165133166133167133168133169133170133171133172133173133174133175133176133177133178133179133180133181133182133183133184133185133186133187133188133189133190133191133192133193133194133195133196133197133198133199133200133201133202133203133204133205133206133207133208133209133210133211133212133213133214133215133216133217133218133219133220133221133222133223133224133225133226133227133228133229133230133231133232133233133234133235133236133237133238133239133240133241133242133243133244133245133246133247133248133249133250133251133252133253133254133255133256133257133258133259133260133261133262133263133264133265133266133267133268133269133270133271133272133273133274133275133276133277133278133279133280133281133282133283133284133285133286133287133288133289133290133291133292133293133294133295133296133297133298133299133300133301133302133303133304133305133306133307133308133309133310133311133312133313133314133315133316133317133318133319133320133321133322133323133324133325133326133327133328133329133330133331133332133333133334133335133336133337133338133339133340133341133342133343133344133345133346133347133348133349133350133351133352133353133354133355133356133357133358133359133360133361133362133363133364133365133366133367133368133369133370133371133372133373133374133375133376133377133378133379133380133381133382133383133384133385133386133387133388133389133390133391133392133393133394133395133396133397133398133399133400133401133402133403133404133405133406133407133408133409133410133411133412133413133414133415133416133417133418133419133420133421133422133423133424133425133426133427133428133429133430133431133432133433133434133435133436133437133438133439133440133441133442133443133444133445133446133447133448133449133450133451133452133453133454133455133456133457133458133459133460133461133462133463133464133465133466133467133468133469133470133471133472133473133474133475133476133477133478133479133480133481133482133483133484133485133486133487133488133489133490133491133492133493133494133495133496133497133498133499133500133501133502133503133504133505133506133507133508133509133510133511133512133513133514133515133516133517133518133519133520133521133522133523133524133525133526133527133528133529133530133531133532133533133534133535133536133537133538133539133540133541133542133543133544133545133546133547133548133549133550133551133552133553133554133555133556133557133558133559133560133561133562133563133564133565133566133567133568133569133570133571133572133573133574133575133576133577133578133579133580133581133582133583133584133585133586133587133588133589133590133591133592133593133594133595133596133597133598133599133600133601133602133603133604133605133606133607133608133609133610133611133612133613133614133615133616133617133618133619133620133621133622133623133624133625133626133627133628133629133630133631133632133633133634133635133636133637133638133639133640133641133642133643133644133645133646133647133648133649133650133651133652133653133654133655133656133657133658133659133660133661133662133663133664133665133666133667133668133669133670133671133672133673133674133675133676133677133678133679133680133681133682133683133684133685133686133687133688133689133690133691133692133693133694133695133696133697133698133699133700133701133702133703133704133705133706133707133708133709133710133711133712133713133714133715133716133717133718133719133720133721133722133723133724133725133726133727133728133729133730133731133732133733133734133735133736133737133738133739133740133741133742133743133744133745133746133747133748133749133750133751133752133753133754133755133756133757133758133759133760133761133762133763133764133765133766133767133768133769133770133771133772133773133774133775133776133777133778133779133780133781133782133783133784133785133786133787133788133789133790133791133792133793133794133795133796133797133798133799133800133801133802133803133804133805133806133807133808133809133810133811133812133813133814133815133816133817133818133819133820133821133822133823133824133825133826133827133828133829133830133831133832133833133834133835133836133837133838133839133840133841133842133843133844133845133846133847133848133849133850133851133852133853133854133855133856133857133858133859133860133861133862133863133864133865133866133867133868133869133870133871133872133873133874133875133876133877133878133879133880133881133882133883133884133885133886133887133888133889133890133891133892133893133894133895133896133897133898133899133900133901133902133903133904133905133906133907133908133909133910133911133912133913133914133915133916133917133918133919133920133921133922133923133924133925133926133927133928133929133930133931133932133933133934133935133936133937133938133939133940133941133942133943133944133945133946133947133948133949133950133951133952133953133954133955133956133957133958133959133960133961133962133963133964133965133966133967133968133969133970133971133972133973133974133975133976133977133978133979133980133981133982133983133984133985133986133987133988133989133990133991133992133993133994133995133996133997133998133999134000134001134002134003134004134005134006134007134008134009134010134011134012134013134014134015134016134017134018134019134020134021134022134023134024134025134026134027134028134029134030134031134032134033134034134035134036134037134038134039134040134041134042134043134044134045134046134047134048134049134050134051134052134053134054134055134056134057134058134059134060134061134062134063134064134065134066134067134068134069134070134071134072134073134074134075134076134077134078134079134080134081134082134083134084134085134086134087134088134089134090134091134092134093134094134095134096134097134098134099134100134101134102134103134104134105134106134107134108134109134110134111134112134113134114134115134116134117134118134119134120134121134122134123134124134125134126134127134128134129134130134131134132134133134134134135134136134137134138134139134140134141134142134143134144134145134146134147134148134149134150134151134152134153134154134155134156134157134158134159134160134161134162134163134164134165134166134167134168134169134170134171134172134173134174134175134176134177134178134179134180134181134182134183134184134185134186134187134188134189134190134191134192134193134194134195134196134197134198134199134200134201134202134203134204134205134206134207134208134209134210134211134212134213134214134215134216134217134218134219134220134221134222134223134224134225134226134227134228134229134230134231134232134233134234134235134236134237134238134239134240134241134242134243134244134245134246134247134248134249134250134251134252134253134254134255134256134257134258134259134260134261134262134263134264134265134266134267134268134269134270134271134272134273134274134275134276134277134278134279134280134281134282134283134284134285134286134287134288134289134290134291134292134293134294134295134296134297134298134299134300134301134302134303134304134305134306134307134308134309134310134311134312134313134314134315134316134317134318134319134320134321134322134323134324134325134326134327134328134329134330134331134332134333134334134335134336134337134338134339134340134341134342134343134344134345134346134347134348134349134350134351134352134353134354134355134356134357134358134359134360134361134362134363134364134365134366134367134368134369134370134371134372134373134374134375134376134377134378134379134380134381134382134383134384134385134386134387134388134389134390134391134392134393134394134395134396134397134398134399134400134401134402134403134404134405134406134407134408134409134410134411134412134413134414134415134416134417134418134419134420134421134422134423134424134425134426134427134428134429134430134431134432134433134434134435134436134437134438134439134440134441134442134443134444134445134446134447134448134449134450134451134452134453134454134455134456134457134458134459134460134461134462134463134464134465134466134467134468134469134470134471134472134473134474134475134476134477134478134479134480134481134482134483134484134485134486134487134488134489134490134491134492134493134494134495134496134497134498134499134500134501134502134503134504134505134506134507134508134509134510134511134512134513134514134515134516134517134518134519134520134521134522134523134524134525134526134527134528134529134530134531134532134533134534134535134536134537134538134539134540134541134542134543134544134545134546134547134548134549134550134551134552134553134554134555134556134557134558134559134560134561134562134563134564134565134566134567134568134569134570134571134572134573134574134575134576134577134578134579134580134581134582134583134584134585134586134587134588134589134590134591134592134593134594134595134596134597134598134599134600134601134602134603134604134605134606134607134608134609134610134611134612134613134614134615134616134617134618134619134620134621134622134623134624134625134626134627134628134629134630134631134632134633134634134635134636134637134638134639134640134641134642134643134644134645134646134647134648134649134650134651134652134653134654134655134656134657134658134659134660134661134662134663134664134665134666134667134668134669134670134671134672134673134674134675134676134677134678134679134680134681134682134683134684134685134686134687134688134689134690134691134692134693134694134695134696134697134698134699134700134701134702134703134704134705134706134707134708134709134710134711134712134713134714134715134716134717134718134719134720134721134722134723134724134725134726134727134728134729134730134731134732134733134734134735134736134737134738134739134740134741134742134743134744134745134746134747134748134749134750134751134752134753134754134755134756134757134758134759134760134761134762134763134764134765134766134767134768134769134770134771134772134773134774134775134776134777134778134779134780134781134782134783134784134785134786134787134788134789134790134791134792134793134794134795134796134797134798134799134800134801134802134803134804134805134806134807134808134809134810134811134812134813134814134815134816134817134818134819134820134821134822134823134824134825134826134827134828134829134830134831134832134833134834134835134836134837134838134839134840134841134842134843134844134845134846134847134848134849134850134851134852134853134854134855134856134857134858134859134860134861134862134863134864134865134866134867134868134869134870134871134872134873134874134875134876134877134878134879134880134881134882134883134884134885134886134887134888134889134890134891134892134893134894134895134896134897134898134899134900134901134902134903134904134905134906134907134908134909134910134911134912134913134914134915134916134917134918134919134920134921134922134923134924134925134926134927134928134929134930134931134932134933134934134935134936134937134938134939134940134941134942134943134944134945134946134947134948134949134950134951134952134953134954134955134956134957134958134959134960134961134962134963134964134965134966134967134968134969134970134971134972134973134974134975134976134977134978134979134980134981134982134983134984134985134986134987134988134989134990134991134992134993134994134995134996134997134998134999135000135001135002135003135004135005135006135007135008135009135010135011135012135013135014135015135016135017135018135019135020135021135022135023135024135025135026135027135028135029135030135031135032135033135034135035135036135037135038135039135040135041135042135043135044135045135046135047135048135049135050135051135052135053135054135055135056135057135058135059135060135061135062135063135064135065135066135067135068135069135070135071135072135073135074135075135076135077135078135079135080135081135082135083135084135085135086135087135088135089135090135091135092135093135094135095135096135097135098135099135100135101135102135103135104135105135106135107135108135109135110135111135112135113135114135115135116135117135118135119135120135121135122135123135124135125135126135127135128135129135130135131135132135133135134135135135136135137135138135139135140135141135142135143135144135145135146135147135148135149135150135151135152135153135154135155135156135157135158135159135160135161135162135163135164135165135166135167135168135169135170135171135172135173135174135175135176135177135178135179135180135181135182135183135184135185135186135187135188135189135190135191135192135193135194135195135196135197135198135199135200135201135202135203135204135205135206135207135208135209135210135211135212135213135214135215135216135217135218135219135220135221135222135223135224135225135226135227135228135229135230135231135232135233135234135235135236135237135238135239135240135241135242135243135244135245135246135247135248135249135250135251135252135253135254135255135256135257135258135259135260135261135262135263135264135265135266135267135268135269135270135271135272135273135274135275135276135277135278135279135280135281135282135283135284135285135286135287135288135289135290135291135292135293135294135295135296135297135298135299135300135301135302135303135304135305135306135307135308135309135310135311135312135313135314135315135316135317135318135319135320135321135322135323135324135325135326135327135328135329135330135331135332135333135334135335135336135337135338135339135340135341135342135343135344135345135346135347135348135349135350135351135352135353135354135355135356135357135358135359135360135361135362135363135364135365135366135367135368135369135370135371135372135373135374135375135376135377135378135379135380135381135382135383135384135385135386135387135388135389135390135391135392135393135394135395135396135397135398135399135400135401135402135403135404135405135406135407135408135409135410135411135412135413135414135415135416135417135418135419135420135421135422135423135424135425135426135427135428135429135430135431135432135433135434135435135436135437135438135439135440135441135442135443135444135445135446135447135448135449135450135451135452135453135454135455135456135457135458135459135460135461135462135463135464135465135466135467135468135469135470135471135472135473135474135475135476135477135478135479135480135481135482135483135484135485135486135487135488135489135490135491135492135493135494135495135496135497135498135499135500135501135502135503135504135505135506135507135508135509135510135511135512135513135514135515135516135517135518135519135520135521135522135523135524135525135526135527135528135529135530135531135532135533135534135535135536135537135538135539135540135541135542135543135544135545135546135547135548135549135550135551135552135553135554135555135556135557135558135559135560135561135562135563135564135565135566135567135568135569135570135571135572135573135574135575135576135577135578135579135580135581135582135583135584135585135586135587135588135589135590135591135592135593135594135595135596135597135598135599135600135601135602135603135604135605135606135607135608135609135610135611135612135613135614135615135616135617135618135619135620135621135622135623135624135625135626135627135628135629135630135631135632135633135634135635135636135637135638135639135640135641135642135643135644135645135646135647135648135649135650135651135652135653135654135655135656135657135658135659135660135661135662135663135664135665135666135667135668135669135670135671135672135673135674135675135676135677135678135679135680135681135682135683135684135685135686135687135688135689135690135691135692135693135694135695135696135697135698135699135700135701135702135703135704135705135706135707135708135709135710135711135712135713135714135715135716135717135718135719135720135721135722135723135724135725135726135727135728135729135730135731135732135733135734135735135736135737135738135739135740135741135742135743135744135745135746135747135748135749135750135751135752135753135754135755135756135757135758135759135760135761135762135763135764135765135766135767135768135769135770135771135772135773135774135775135776135777135778135779135780135781135782135783135784135785135786135787135788135789135790135791135792135793135794135795135796135797135798135799135800135801135802135803135804135805135806135807135808135809135810135811135812135813135814135815135816135817135818135819135820135821135822135823135824135825135826135827135828135829135830135831135832135833135834135835135836135837135838135839135840135841135842135843135844135845135846135847135848135849135850135851135852135853135854135855135856135857135858135859135860135861135862135863135864135865135866135867135868135869135870135871135872135873135874135875135876135877135878135879135880135881135882135883135884135885135886135887135888135889135890135891135892135893135894135895135896135897135898135899135900135901135902135903135904135905135906135907135908135909135910135911135912135913135914135915135916135917135918135919135920135921135922135923135924135925135926135927135928135929135930135931135932135933135934135935135936135937135938135939135940135941135942135943135944135945135946135947135948135949135950135951135952135953135954135955135956135957135958135959135960135961135962135963135964135965135966135967135968135969135970135971135972135973135974135975135976135977135978135979135980135981135982135983135984135985135986135987135988135989135990135991135992135993135994135995135996135997135998135999136000136001136002136003136004136005136006136007136008136009136010136011136012136013136014136015136016136017136018136019136020136021136022136023136024136025136026136027136028136029136030136031136032136033136034136035136036136037136038136039136040136041136042136043136044136045136046136047136048136049136050136051136052136053136054136055136056136057136058136059136060136061136062136063136064136065136066136067136068136069136070136071136072136073136074136075136076136077136078136079136080136081136082136083136084136085136086136087136088136089136090136091136092136093136094136095136096136097136098136099136100136101136102136103136104136105136106136107136108136109136110136111136112136113136114136115136116136117136118136119136120136121136122136123136124136125136126136127136128136129136130136131136132136133136134136135136136136137136138136139136140136141136142136143136144136145136146136147136148136149136150136151136152136153136154136155136156136157136158136159136160136161136162136163136164136165136166136167136168136169136170136171136172136173136174136175136176136177136178136179136180136181136182136183136184136185136186136187136188136189136190136191136192136193136194136195136196136197136198136199136200136201136202136203136204136205136206136207136208136209136210136211136212136213136214136215136216136217136218136219136220136221136222136223136224136225136226136227136228136229136230136231136232136233136234136235136236136237136238136239136240136241136242136243136244136245136246136247136248136249136250136251136252136253136254136255136256136257136258136259136260136261136262136263136264136265136266136267136268136269136270136271136272136273136274136275136276136277136278136279136280136281136282136283136284136285136286136287136288136289136290136291136292136293136294136295136296136297136298136299136300136301136302136303136304136305136306136307136308136309136310136311136312136313136314136315136316136317136318136319136320136321136322136323136324136325136326136327136328136329136330136331136332136333136334136335136336136337136338136339136340136341136342136343136344136345136346136347136348136349136350136351136352136353136354136355136356136357136358136359136360136361136362136363136364136365136366136367136368136369136370136371136372136373136374136375136376136377136378136379136380136381136382136383136384136385136386136387136388136389136390136391136392136393136394136395136396136397136398136399136400136401136402136403136404136405136406136407136408136409136410136411136412136413136414136415136416136417136418136419136420136421136422136423136424136425136426136427136428136429136430136431136432136433136434136435136436136437136438136439136440136441136442136443136444136445136446136447136448136449136450136451136452136453136454136455136456136457136458136459136460136461136462136463136464136465136466136467136468136469136470136471136472136473136474136475136476136477136478136479136480136481136482136483136484136485136486136487136488136489136490136491136492136493136494136495136496136497136498136499136500136501136502136503136504136505136506136507136508136509136510136511136512136513136514136515136516136517136518136519136520136521136522136523136524136525136526136527136528136529136530136531136532136533136534136535136536136537136538136539136540136541136542136543136544136545136546136547136548136549136550136551136552136553136554136555136556136557136558136559136560136561136562136563136564136565136566136567136568136569136570136571136572136573136574136575136576136577136578136579136580136581136582136583136584136585136586136587136588136589136590136591136592136593136594136595136596136597136598136599136600136601136602136603136604136605136606136607136608136609136610136611136612136613136614136615136616136617136618136619136620136621136622136623136624136625136626136627136628136629136630136631136632136633136634136635136636136637136638136639136640136641136642136643136644136645136646136647136648136649136650136651136652136653136654136655136656136657136658136659136660136661136662136663136664136665136666136667136668136669136670136671136672136673136674136675136676136677136678136679136680136681136682136683136684136685136686136687136688136689136690136691136692136693136694136695136696136697136698136699136700136701136702136703136704136705136706136707136708136709136710136711136712136713136714136715136716136717136718136719136720136721136722136723136724136725136726136727136728136729136730136731136732136733136734136735136736136737136738136739136740136741136742136743136744136745136746136747136748136749136750136751136752136753136754136755136756136757136758136759136760136761136762136763136764136765136766136767136768136769136770136771136772136773136774136775136776136777136778136779136780136781136782136783136784136785136786136787136788136789136790136791136792136793136794136795136796136797136798136799136800136801136802136803136804136805136806136807136808136809136810136811136812136813136814136815136816136817136818136819136820136821136822136823136824136825136826136827136828136829136830136831136832136833136834136835136836136837136838136839136840136841136842136843136844136845136846136847136848136849136850136851136852136853136854136855136856136857136858136859136860136861136862136863136864136865136866136867136868136869136870136871136872136873136874136875136876136877136878136879136880136881136882136883136884136885136886136887136888136889136890136891136892136893136894136895136896136897136898136899136900136901136902136903136904136905136906136907136908136909136910136911136912136913136914136915136916136917136918136919136920136921136922136923136924136925136926136927136928136929136930136931136932136933136934136935136936136937136938136939136940136941136942136943136944136945136946136947136948136949136950136951136952136953136954136955136956136957136958136959136960136961136962136963136964136965136966136967136968136969136970136971136972136973136974136975136976136977136978136979136980136981136982136983136984136985136986136987136988136989136990136991136992136993136994136995136996136997136998136999137000137001137002137003137004137005137006137007137008137009137010137011137012137013137014137015137016137017137018137019137020137021137022137023137024137025137026137027137028137029137030137031137032137033137034137035137036137037137038137039137040137041137042137043137044137045137046137047137048137049137050137051137052137053137054137055137056137057137058137059137060137061137062137063137064137065137066137067137068137069137070137071137072137073137074137075137076137077137078137079137080137081137082137083137084137085137086137087137088137089137090137091137092137093137094137095137096137097137098137099137100137101137102137103137104137105137106137107137108137109137110137111137112137113137114137115137116137117137118137119137120137121137122137123137124137125137126137127137128137129137130137131137132137133137134137135137136137137137138137139137140137141137142137143137144137145137146137147137148137149137150137151137152137153137154137155137156137157137158137159137160137161137162137163137164137165137166137167137168137169137170137171137172137173137174137175137176137177137178137179137180137181137182137183137184137185137186137187137188137189137190137191137192137193137194137195137196137197137198137199137200137201137202137203137204137205137206137207137208137209137210137211137212137213137214137215137216137217137218137219137220137221137222137223137224137225137226137227137228137229137230137231137232137233137234137235137236137237137238137239137240137241137242137243137244137245137246137247137248137249137250137251137252137253137254137255137256137257137258137259137260137261137262137263137264137265137266137267137268137269137270137271137272137273137274137275137276137277137278137279137280137281137282137283137284137285137286137287137288137289137290137291137292137293137294137295137296137297137298137299137300137301137302137303137304137305137306137307137308137309137310137311137312137313137314137315137316137317137318137319137320137321137322137323137324137325137326137327137328137329137330137331137332137333137334137335137336137337137338137339137340137341137342137343137344137345137346137347137348137349137350137351137352137353137354137355137356137357137358137359137360137361137362137363137364137365137366137367137368137369137370137371137372137373137374137375137376137377137378137379137380137381137382137383137384137385137386137387137388137389137390137391137392137393137394137395137396137397137398137399137400137401137402137403137404137405137406137407137408137409137410137411137412137413137414137415137416137417137418137419137420137421137422137423137424137425137426137427137428137429137430137431137432137433137434137435137436137437137438137439137440137441137442137443137444137445137446137447137448137449137450137451137452137453137454137455137456137457137458137459137460137461137462137463137464137465137466137467137468137469137470137471137472137473137474137475137476137477137478137479137480137481137482137483137484137485137486137487137488137489137490137491137492137493137494137495137496137497137498137499137500137501137502137503137504137505137506137507137508137509137510137511137512137513137514137515137516137517137518137519137520137521137522137523137524137525137526137527137528137529137530137531137532137533137534137535137536137537137538137539137540137541137542137543137544137545137546137547137548137549137550137551137552137553137554137555137556137557137558137559137560137561137562137563137564137565137566137567137568137569137570137571137572137573137574137575137576137577137578137579137580137581137582137583137584137585137586137587137588137589137590137591137592137593137594137595137596137597137598137599137600137601137602137603137604137605137606137607137608137609137610137611137612137613137614137615137616137617137618137619137620137621137622137623137624137625137626137627137628137629137630137631137632137633137634137635137636137637137638137639137640137641137642137643137644137645137646137647137648137649137650137651137652137653137654137655137656137657137658137659137660137661137662137663137664137665137666137667137668137669137670137671137672137673137674137675137676137677137678137679137680137681137682137683137684137685137686137687137688137689137690137691137692137693137694137695137696137697137698137699137700137701137702137703137704137705137706137707137708137709137710137711137712137713137714137715137716137717137718137719137720137721137722137723137724137725137726137727137728137729137730137731137732137733137734137735137736137737137738137739137740137741137742137743137744137745137746137747137748137749137750137751137752137753137754137755137756137757137758137759137760137761137762137763137764137765137766137767137768137769137770137771137772137773137774137775137776137777137778137779137780137781137782137783137784137785137786137787137788137789137790137791137792137793137794137795137796137797137798137799137800137801137802137803137804137805137806137807137808137809137810137811137812137813137814137815137816137817137818137819137820137821137822137823137824137825137826137827137828137829137830137831137832137833137834137835137836137837137838137839137840137841137842137843137844137845137846137847137848137849137850137851137852137853137854137855137856137857137858137859137860137861137862137863137864137865137866137867137868137869137870137871137872137873137874137875137876137877137878137879137880137881137882137883137884137885137886137887137888137889137890137891137892137893137894137895137896137897137898137899137900137901137902137903137904137905137906137907137908137909137910137911137912137913137914137915137916137917137918137919137920137921137922137923137924137925137926137927137928137929137930137931137932137933137934137935137936137937137938137939137940137941137942137943137944137945137946137947137948137949137950137951137952137953137954137955137956137957137958137959137960137961137962137963137964137965137966137967137968137969137970137971137972137973137974137975137976137977137978137979137980137981137982137983137984137985137986137987137988137989137990137991137992137993137994137995137996137997137998137999138000138001138002138003138004138005138006138007138008138009138010138011138012138013138014138015138016138017138018138019138020138021138022138023138024138025138026138027138028138029138030138031138032138033138034138035138036138037138038138039138040138041138042138043138044138045138046138047138048138049138050138051138052138053138054138055138056138057138058138059138060138061138062138063138064138065138066138067138068138069138070138071138072138073138074138075138076138077138078138079138080138081138082138083138084138085138086138087138088138089138090138091138092138093138094138095138096138097138098138099138100138101138102138103138104138105138106138107138108138109138110138111138112138113138114138115138116138117138118138119138120138121138122138123138124138125138126138127138128138129138130138131138132138133138134138135138136138137138138138139138140138141138142138143138144138145138146138147138148138149138150138151138152138153138154138155138156138157138158138159138160138161138162138163138164138165138166138167138168138169138170138171138172138173138174138175138176138177138178138179138180138181138182138183138184138185138186138187138188138189138190138191138192138193138194138195138196138197138198138199138200138201138202138203138204138205138206138207138208138209138210138211138212138213138214138215138216138217138218138219138220138221138222138223138224138225138226138227138228138229138230138231138232138233138234138235138236138237138238138239138240138241138242138243138244138245138246138247138248138249138250138251138252138253138254138255138256138257138258138259138260138261138262138263138264138265138266138267138268138269138270138271138272138273138274138275138276138277138278138279138280138281138282138283138284138285138286138287138288138289138290138291138292138293138294138295138296138297138298138299138300138301138302138303138304138305138306138307138308138309138310138311138312138313138314138315138316138317138318138319138320138321138322138323138324138325138326138327138328138329138330138331138332138333138334138335138336138337138338138339138340138341138342138343138344138345138346138347138348138349138350138351138352138353138354138355138356138357138358138359138360138361138362138363138364138365138366138367138368138369138370138371138372138373138374138375138376138377138378138379138380138381138382138383138384138385138386138387138388138389138390138391138392138393138394138395138396138397138398138399138400138401138402138403138404138405138406138407138408138409138410138411138412138413138414138415138416138417138418138419138420138421138422138423138424138425138426138427138428138429138430138431138432138433138434138435138436138437138438138439138440138441138442138443138444138445138446138447138448138449138450138451138452138453138454138455138456138457138458138459138460138461138462138463138464138465138466138467138468138469138470138471138472138473138474138475138476138477138478138479138480138481138482138483138484138485138486138487138488138489138490138491138492138493138494138495138496138497138498138499138500138501138502138503138504138505138506138507138508138509138510138511138512138513138514138515138516138517138518138519138520138521138522138523138524138525138526138527138528138529138530138531138532138533138534138535138536138537138538138539138540138541138542138543138544138545138546138547138548138549138550138551138552138553138554138555138556138557138558138559138560138561138562138563138564138565138566138567138568138569138570138571138572138573138574138575138576138577138578138579138580138581138582138583138584138585138586138587138588138589138590138591138592138593138594138595138596138597138598138599138600138601138602138603138604138605138606138607138608138609138610138611138612138613138614138615138616138617138618138619138620138621138622138623138624138625138626138627138628138629138630138631138632138633138634138635138636138637138638138639138640138641138642138643138644138645138646138647138648138649138650138651138652138653138654138655138656138657138658138659138660138661138662138663138664138665138666138667138668138669138670138671138672138673138674138675138676138677138678138679138680138681138682138683138684138685138686138687138688138689138690138691138692138693138694138695138696138697138698138699138700138701138702138703138704138705138706138707138708138709138710138711138712138713138714138715138716138717138718138719138720138721138722138723138724138725138726138727138728138729138730138731138732138733138734138735138736138737138738138739138740138741138742138743138744138745138746138747138748138749138750138751138752138753138754138755138756138757138758138759138760138761138762138763138764138765138766138767138768138769138770138771138772138773138774138775138776138777138778138779138780138781138782138783138784138785138786138787138788138789138790138791138792138793138794138795138796138797138798138799138800138801138802138803138804138805138806138807138808138809138810138811138812138813138814138815138816138817138818138819138820138821138822138823138824138825138826138827138828138829138830138831138832138833138834138835138836138837138838138839138840138841138842138843138844138845138846138847138848138849138850138851138852138853138854138855138856138857138858138859138860138861138862138863138864138865138866138867138868138869138870138871138872138873138874138875138876138877138878138879138880138881138882138883138884138885138886138887138888138889138890138891138892138893138894138895138896138897138898138899138900138901138902138903138904138905138906138907138908138909138910138911138912138913138914138915138916138917138918138919138920138921138922138923138924138925138926138927138928138929138930138931138932138933138934138935138936138937138938138939138940138941138942138943138944138945138946138947138948138949138950138951138952138953138954138955138956138957138958138959138960138961138962138963138964138965138966138967138968138969138970138971138972138973138974138975138976138977138978138979138980138981138982138983138984138985138986138987138988138989138990138991138992138993138994138995138996138997138998138999139000139001139002139003139004139005139006139007139008139009139010139011139012139013139014139015139016139017139018139019139020139021139022139023139024139025139026139027139028139029139030139031139032139033139034139035139036139037139038139039139040139041139042139043139044139045139046139047139048139049139050139051139052139053139054139055139056139057139058139059139060139061139062139063139064139065139066139067139068139069139070139071139072139073139074139075139076139077139078139079139080139081139082139083139084139085139086139087139088139089139090139091139092139093139094139095139096139097139098139099139100139101139102139103139104139105139106139107139108139109139110139111139112139113139114139115139116139117139118139119139120139121139122139123139124139125139126139127139128139129139130139131139132139133139134139135139136139137139138139139139140139141139142139143139144139145139146139147139148139149139150139151139152139153139154139155139156139157139158139159139160139161139162139163139164139165139166139167139168139169139170139171139172139173139174139175139176139177139178139179139180139181139182139183139184139185139186139187139188139189139190139191139192139193139194139195139196139197139198139199139200139201139202139203139204139205139206139207139208139209139210139211139212139213139214139215139216139217139218139219139220139221139222139223139224139225139226139227139228139229139230139231139232139233139234139235139236139237139238139239139240139241139242139243139244139245139246139247139248139249139250139251139252139253139254139255139256139257139258139259139260139261139262139263139264139265139266139267139268139269139270139271139272139273139274139275139276139277139278139279139280139281139282139283139284139285139286139287139288139289139290139291139292139293139294139295139296139297139298139299139300139301139302139303139304139305139306139307139308139309139310139311139312139313139314139315139316139317139318139319139320139321139322139323139324139325139326139327139328139329139330139331139332139333139334139335139336139337139338139339139340139341139342139343139344139345139346139347139348139349139350139351139352139353139354139355139356139357139358139359139360139361139362139363139364139365139366139367139368139369139370139371139372139373139374139375139376139377139378139379139380139381139382139383139384139385139386139387139388139389139390139391139392139393139394139395139396139397139398139399139400139401139402139403139404139405139406139407139408139409139410139411139412139413139414139415139416139417139418139419139420139421139422139423139424139425139426139427139428139429139430139431139432139433139434139435139436139437139438139439139440139441139442139443139444139445139446139447139448139449139450139451139452139453139454139455139456139457139458139459139460139461139462139463139464139465139466139467139468139469139470139471139472139473139474139475139476139477139478139479139480139481139482139483139484139485139486139487139488139489139490139491139492139493139494139495139496139497139498139499139500139501139502139503139504139505139506139507139508139509139510139511139512139513139514139515139516139517139518139519139520139521139522139523139524139525139526139527139528139529139530139531139532139533139534139535139536139537139538139539139540139541139542139543139544139545139546139547139548139549139550139551139552139553139554139555139556139557139558139559139560139561139562139563139564139565139566139567139568139569139570139571139572139573139574139575139576139577139578139579139580139581139582139583139584139585139586139587139588139589139590139591139592139593139594139595139596139597139598139599139600139601139602139603139604139605139606139607139608139609139610139611139612139613139614139615139616139617139618139619139620139621139622139623139624139625139626139627139628139629139630139631139632139633139634139635139636139637139638139639139640139641139642139643139644139645139646139647139648139649139650139651139652139653139654139655139656139657139658139659139660139661139662139663139664139665139666139667139668139669139670139671139672139673139674139675139676139677139678139679139680139681139682139683139684139685139686139687139688139689139690139691139692139693139694139695139696139697139698139699139700139701139702139703139704139705139706139707139708139709139710139711139712139713139714139715139716139717139718139719139720139721139722139723139724139725139726139727139728139729139730139731139732139733139734139735139736139737139738139739139740139741139742139743139744139745139746139747139748139749139750139751139752139753139754139755139756139757139758139759139760139761139762139763139764139765139766139767139768139769139770139771139772139773139774139775139776139777139778139779139780139781139782139783139784139785139786139787139788139789139790139791139792139793139794139795139796139797139798139799139800139801139802139803139804139805139806139807139808139809139810139811139812139813139814139815139816139817139818139819139820139821139822139823139824139825139826139827139828139829139830139831139832139833139834139835139836139837139838139839139840139841139842139843139844139845139846139847139848139849139850139851139852139853139854139855139856139857139858139859139860139861139862139863139864139865139866139867139868139869139870139871139872139873139874139875139876139877139878139879139880139881139882139883139884139885139886139887139888139889139890139891139892139893139894139895139896139897139898139899139900139901139902139903139904139905139906139907139908139909139910139911139912139913139914139915139916139917139918139919139920139921139922139923139924139925139926139927139928139929139930139931139932139933139934139935139936139937139938139939139940139941139942139943139944139945139946139947139948139949139950139951139952139953139954139955139956139957139958139959139960139961139962139963139964139965139966139967139968139969139970139971139972139973139974139975139976139977139978139979139980139981139982139983139984139985139986139987139988139989139990139991139992139993139994139995139996139997139998139999140000140001140002140003140004140005140006140007140008140009140010140011140012140013140014140015140016140017140018140019140020140021140022140023140024140025140026140027140028140029140030140031140032140033140034140035140036140037140038140039140040140041140042140043140044140045140046140047140048140049140050140051140052140053140054140055140056140057140058140059140060140061140062140063140064140065140066140067140068140069140070140071140072140073140074140075140076140077140078140079140080140081140082140083140084140085140086140087140088140089140090140091140092140093140094140095140096140097140098140099140100140101140102140103140104140105140106140107140108140109140110140111140112140113140114140115140116140117140118140119140120140121140122140123140124140125140126140127140128140129140130140131140132140133140134140135140136140137140138140139140140140141140142140143140144140145140146140147140148140149140150140151140152140153140154140155140156140157140158140159140160140161140162140163140164140165140166140167140168140169140170140171140172140173140174140175140176140177140178140179140180140181140182140183140184140185140186140187140188140189140190140191140192140193140194140195140196140197140198140199140200140201140202140203140204140205140206140207140208140209140210140211140212140213140214140215140216140217140218140219140220140221140222140223140224140225140226140227140228140229140230140231140232140233140234140235140236140237140238140239140240140241140242140243140244140245140246140247140248140249140250140251140252140253140254140255140256140257140258140259140260140261140262140263140264140265140266140267140268140269140270140271140272140273140274140275140276140277140278140279140280140281140282140283140284140285140286140287140288140289140290140291140292140293140294140295140296140297140298140299140300140301140302140303140304140305140306140307140308140309140310140311140312140313140314140315140316140317140318140319140320140321140322140323140324140325140326140327140328140329140330140331140332140333140334140335140336140337140338140339140340140341140342140343140344140345140346140347140348140349140350140351140352140353140354140355140356140357140358140359140360140361140362140363140364140365140366140367140368140369140370140371140372140373140374140375140376140377140378140379140380140381140382140383140384140385140386140387140388140389140390140391140392140393140394140395140396140397140398140399140400140401140402140403140404140405140406140407140408140409140410140411140412140413140414140415140416140417140418140419140420140421140422140423140424140425140426140427140428140429140430140431140432140433140434140435140436140437140438140439140440140441140442140443140444140445140446140447140448140449140450140451140452140453140454140455140456140457140458140459140460140461140462140463140464140465140466140467140468140469140470140471140472140473140474140475140476140477140478140479140480140481140482140483140484140485140486140487140488140489140490140491140492140493140494140495140496140497140498140499140500140501140502140503140504140505140506140507140508140509140510140511140512140513140514140515140516140517140518140519140520140521140522140523140524140525140526140527140528140529140530140531140532140533140534140535140536140537140538140539140540140541140542140543140544140545140546140547140548140549140550140551140552140553140554140555140556140557140558140559140560140561140562140563140564140565140566140567140568140569140570140571140572140573140574140575140576140577140578140579140580140581140582140583140584140585140586140587140588140589140590140591140592140593140594140595140596140597140598140599140600140601140602140603140604140605140606140607140608140609140610140611140612140613140614140615140616140617140618140619140620140621140622140623140624140625140626140627140628140629140630140631140632140633140634140635140636140637140638140639140640140641140642140643140644140645140646140647140648140649140650140651140652140653140654140655140656140657140658140659140660140661140662140663140664140665140666140667140668140669140670140671140672140673140674140675140676140677140678140679140680140681140682140683140684140685140686140687140688140689140690140691140692140693140694140695140696140697140698140699140700140701140702140703140704140705140706140707140708140709140710140711140712140713140714140715140716140717140718140719140720140721140722140723140724140725140726140727140728140729140730140731140732140733140734140735140736140737140738140739140740140741140742140743140744140745140746140747140748140749140750140751140752140753140754140755140756140757140758140759140760140761140762140763140764140765140766140767140768140769140770140771140772140773140774140775140776140777140778140779140780140781140782140783140784140785140786140787140788140789140790140791140792140793140794140795140796140797140798140799140800140801140802140803140804140805140806140807140808140809140810140811140812140813140814140815140816140817140818140819140820140821140822140823140824140825140826140827140828140829140830140831140832140833140834140835140836140837140838140839140840140841140842140843140844140845140846140847140848140849140850140851140852140853140854140855140856140857140858140859140860140861140862140863140864140865140866140867140868140869140870140871140872140873140874140875140876140877140878140879140880140881140882140883140884140885140886140887140888140889140890140891140892140893140894140895140896140897140898140899140900140901140902140903140904140905140906140907140908140909140910140911140912140913140914140915140916140917140918140919140920140921140922140923140924140925140926140927140928140929140930140931140932140933140934140935140936140937140938140939140940140941140942140943140944140945140946140947140948140949140950140951140952140953140954140955140956140957140958140959140960140961140962140963140964140965140966140967140968140969140970140971140972140973140974140975140976140977140978140979140980140981140982140983140984140985140986140987140988140989140990140991140992140993140994140995140996140997140998140999141000141001141002141003141004141005141006141007141008141009141010141011141012141013141014141015141016141017141018141019141020141021141022141023141024141025141026141027141028141029141030141031141032141033141034141035141036141037141038141039141040141041141042141043141044141045141046141047141048141049141050141051141052141053141054141055141056141057141058141059141060141061141062141063141064141065141066141067141068141069141070141071141072141073141074141075141076141077141078141079141080141081141082141083141084141085141086141087141088141089141090141091141092141093141094141095141096141097141098141099141100141101141102141103141104141105141106141107141108141109141110141111141112141113141114141115141116141117141118141119141120141121141122141123141124141125141126141127141128141129141130141131141132141133141134141135141136141137141138141139141140141141141142141143141144141145141146141147141148141149141150141151141152141153141154141155141156141157141158141159141160141161141162141163141164141165141166141167141168141169141170141171141172141173141174141175141176141177141178141179141180141181141182141183141184141185141186141187141188141189141190141191141192141193141194141195141196141197141198141199141200141201141202141203141204141205141206141207141208141209141210141211141212141213141214141215141216141217141218141219141220141221141222141223141224141225141226141227141228141229141230141231141232141233141234141235141236141237141238141239141240141241141242141243141244141245141246141247141248141249141250141251141252141253141254141255141256141257141258141259141260141261141262141263141264141265141266141267141268141269141270141271141272141273141274141275141276141277141278141279141280141281141282141283141284141285141286141287141288141289141290141291141292141293141294141295141296141297141298141299141300141301141302141303141304141305141306141307141308141309141310141311141312141313141314141315141316141317141318141319141320141321141322141323141324141325141326141327141328141329141330141331141332141333141334141335141336141337141338141339141340141341141342141343141344141345141346141347141348141349141350141351141352141353141354141355141356141357141358141359141360141361141362141363141364141365141366141367141368141369141370141371141372141373141374141375141376141377141378141379141380141381141382141383141384141385141386141387141388141389141390141391141392141393141394141395141396141397141398141399141400141401141402141403141404141405141406141407141408141409141410141411141412141413141414141415141416141417141418141419141420141421141422141423141424141425141426141427141428141429141430141431141432141433141434141435141436141437141438141439141440141441141442141443141444141445141446141447141448141449141450141451141452141453141454141455141456141457141458141459141460141461141462141463141464141465141466141467141468141469141470141471141472141473141474141475141476141477141478141479141480141481141482141483141484141485141486141487141488141489141490141491141492141493141494141495141496141497141498141499141500141501141502141503141504141505141506141507141508141509141510141511141512141513141514141515141516141517141518141519141520141521141522141523141524141525141526141527141528141529141530141531141532141533141534141535141536141537141538141539141540141541141542141543141544141545141546141547141548141549141550141551141552141553141554141555141556141557141558141559141560141561141562141563141564141565141566141567141568141569141570141571141572141573141574141575141576141577141578141579141580141581141582141583141584141585141586141587141588141589141590141591141592141593141594141595141596141597141598141599141600141601141602141603141604141605141606141607141608141609141610141611141612141613141614141615141616141617141618141619141620141621141622141623141624141625141626141627141628141629141630141631141632141633141634141635141636141637141638141639141640141641141642141643141644141645141646141647141648141649141650141651141652141653141654141655141656141657141658141659141660141661141662141663141664141665141666141667141668141669141670141671141672141673141674141675141676141677141678141679141680141681141682141683141684141685141686141687141688141689141690141691141692141693141694141695141696141697141698141699141700141701141702141703141704141705141706141707141708141709141710141711141712141713141714141715141716141717141718141719141720141721141722141723141724141725141726141727141728141729141730141731141732141733141734141735141736141737141738141739141740141741141742141743141744141745141746141747141748141749141750141751141752141753141754141755141756141757141758141759141760141761141762141763141764141765141766141767141768141769141770141771141772141773141774141775141776141777141778141779141780141781141782141783141784141785141786141787141788141789141790141791141792141793141794141795141796141797141798141799141800141801141802141803141804141805141806141807141808141809141810141811141812141813141814141815141816141817141818141819141820141821141822141823141824141825141826141827141828141829141830141831141832141833141834141835141836141837141838141839141840141841141842141843141844141845141846141847141848141849141850141851141852141853141854141855141856141857141858141859141860141861141862141863141864141865141866141867141868141869141870141871141872141873141874141875141876141877141878141879141880141881141882141883141884141885141886141887141888141889141890141891141892141893141894141895141896141897141898141899141900141901141902141903141904141905141906141907141908141909141910141911141912141913141914141915141916141917141918141919141920141921141922141923141924141925141926141927141928141929141930141931141932141933141934141935141936141937141938141939141940141941141942141943141944141945141946141947141948141949141950141951141952141953141954141955141956141957141958141959141960141961141962141963141964141965141966141967141968141969141970141971141972141973141974141975141976141977141978141979141980141981141982141983141984141985141986141987141988141989141990141991141992141993141994141995141996141997141998141999142000142001142002142003142004142005142006142007142008142009142010142011142012142013142014142015142016142017142018142019142020142021142022142023142024142025142026142027142028142029142030142031142032142033142034142035142036142037142038142039142040142041142042142043142044142045142046142047142048142049142050142051142052142053142054142055142056142057142058142059142060142061142062142063142064142065142066142067142068142069142070142071142072142073142074142075142076142077142078142079142080142081142082142083142084142085142086142087142088142089142090142091142092142093142094142095142096142097142098142099142100142101142102142103142104142105142106142107142108142109142110142111142112142113142114142115142116142117142118142119142120142121142122142123142124142125142126142127142128142129142130142131142132142133142134142135142136142137142138142139142140142141142142142143142144142145142146142147142148142149142150142151142152142153142154142155142156142157142158142159142160142161142162142163142164142165142166142167142168142169142170142171142172142173142174142175142176142177142178142179142180142181142182142183142184142185142186142187142188142189142190142191142192142193142194142195142196142197142198142199142200142201142202142203142204142205142206142207142208142209142210142211142212142213142214142215142216142217142218142219142220142221142222142223142224142225142226142227142228142229142230142231142232142233142234142235142236142237142238142239142240142241142242142243142244142245142246142247142248142249142250142251142252142253142254142255142256142257142258142259142260142261142262142263142264142265142266142267142268142269142270142271142272142273142274142275142276142277142278142279142280142281142282142283142284142285142286142287142288142289142290142291142292142293142294142295142296142297142298142299142300142301142302142303142304142305142306142307142308142309142310142311142312142313142314142315142316142317142318142319142320142321142322142323142324142325142326142327142328142329142330142331142332142333142334142335142336142337142338142339142340142341142342142343142344142345142346142347142348142349142350142351142352142353142354142355142356142357142358142359142360142361142362142363142364142365142366142367142368142369142370142371142372142373142374142375142376142377142378142379142380142381142382142383142384142385142386142387142388142389142390142391142392142393142394142395142396142397142398142399142400142401142402142403142404142405142406142407142408142409142410142411142412142413142414142415142416142417142418142419142420142421142422142423142424142425142426142427142428142429142430142431142432142433142434142435142436142437142438142439142440142441142442142443142444142445142446142447142448142449142450142451142452142453142454142455142456142457142458142459142460142461142462142463142464142465142466142467142468142469142470142471142472142473142474142475142476142477142478142479142480142481142482142483142484142485142486142487142488142489142490142491142492142493142494142495142496142497142498142499142500142501142502142503142504142505142506142507142508142509142510142511142512142513142514142515142516142517142518142519142520142521142522142523142524142525142526142527142528142529142530142531142532142533142534142535142536142537142538142539142540142541142542142543142544142545142546142547142548142549142550142551142552142553142554142555142556142557142558142559142560142561142562142563142564142565142566142567142568142569142570142571142572142573142574142575142576142577142578142579142580142581142582142583142584142585142586142587142588142589142590142591142592142593142594142595142596142597142598142599142600142601142602142603142604142605142606142607142608142609142610142611142612142613142614142615142616142617142618142619142620142621142622142623142624142625142626142627142628142629142630142631142632142633142634142635142636142637142638142639142640142641142642142643142644142645142646142647142648142649142650142651142652142653142654142655142656142657142658142659142660142661142662142663142664142665142666142667142668142669142670142671142672142673142674142675142676142677142678142679142680142681142682142683142684142685142686142687142688142689142690142691142692142693142694142695142696142697142698142699142700142701142702142703142704142705142706142707142708142709142710142711142712142713142714142715142716142717142718142719142720142721142722142723142724142725142726142727142728142729142730142731142732142733142734142735142736142737142738142739142740142741142742142743142744142745142746142747142748142749142750142751142752142753142754142755142756142757142758142759142760142761142762142763142764142765142766142767142768142769142770142771142772142773142774142775142776142777142778142779142780142781142782142783142784142785142786142787142788142789142790142791142792142793142794142795142796142797142798142799142800142801142802142803142804142805142806142807142808142809142810142811142812142813142814142815142816142817142818142819142820142821142822142823142824142825142826142827142828142829142830142831142832142833142834142835142836142837142838142839142840142841142842142843142844142845142846142847142848142849142850142851142852142853142854142855142856142857142858142859142860142861142862142863142864142865142866142867142868142869142870142871142872142873142874142875142876142877142878142879142880142881142882142883142884142885142886142887142888142889142890142891142892142893142894142895142896142897142898142899142900142901142902142903142904142905142906142907142908142909142910142911142912142913142914142915142916142917142918142919142920142921142922142923142924142925142926142927142928142929142930142931142932142933142934142935142936142937142938142939142940142941142942142943142944142945142946142947142948142949142950142951142952142953142954142955142956142957142958142959142960142961142962142963142964142965142966142967142968142969142970142971142972142973142974142975142976142977142978142979142980142981142982142983142984142985142986142987142988142989142990142991142992142993142994142995142996142997142998142999143000143001143002143003143004143005143006143007143008143009143010143011143012143013143014143015143016143017143018143019143020143021143022143023143024143025143026143027143028143029143030143031143032143033143034143035143036143037143038143039143040143041143042143043143044143045143046143047143048143049143050143051143052143053143054143055143056143057143058143059143060143061143062143063143064143065143066143067143068143069143070143071143072143073143074143075143076143077143078143079143080143081143082143083143084143085143086143087143088143089143090143091143092143093143094143095143096143097143098143099143100143101143102143103143104143105143106143107143108143109143110143111143112143113143114143115143116143117143118143119143120143121143122143123143124143125143126143127143128143129143130143131143132143133143134143135143136143137143138143139143140143141143142143143143144143145143146143147143148143149143150143151143152143153143154143155143156143157143158143159143160143161143162143163143164143165143166143167143168143169143170143171143172143173143174143175143176143177143178143179143180143181143182143183143184143185143186143187143188143189143190143191143192143193143194143195143196143197143198143199143200143201143202143203143204143205143206143207143208143209143210143211143212143213143214143215143216143217143218143219143220143221143222143223143224143225143226143227143228143229143230143231143232143233143234143235143236143237143238143239143240143241143242143243143244143245143246143247143248143249143250143251143252143253143254143255143256143257143258143259143260143261143262143263143264143265143266143267143268143269143270143271143272143273143274143275143276143277143278143279143280143281143282143283143284143285143286143287143288143289143290143291143292143293143294143295143296143297143298143299143300143301143302143303143304143305143306143307143308143309143310143311143312143313143314143315143316143317143318143319143320143321143322143323143324143325143326143327143328143329143330143331143332143333143334143335143336143337143338143339143340143341143342143343143344143345143346143347143348143349143350143351143352143353143354143355143356143357143358143359143360143361143362143363143364143365143366143367143368143369143370143371143372143373143374143375143376143377143378143379143380143381143382143383143384143385143386143387143388143389143390143391143392143393143394143395143396143397143398143399143400143401143402143403143404143405143406143407143408143409143410143411143412143413143414143415143416143417143418143419143420143421143422143423143424143425143426143427143428143429143430143431143432143433143434143435143436143437143438143439143440143441143442143443143444143445143446143447143448143449143450143451143452143453143454143455143456143457143458143459143460143461143462143463143464143465143466143467143468143469143470143471143472143473143474143475143476143477143478143479143480143481143482143483143484143485143486143487143488143489143490143491143492143493143494143495143496143497143498143499143500143501143502143503143504143505143506143507143508143509143510143511143512143513143514143515143516143517143518143519143520143521143522143523143524143525143526143527143528143529143530143531143532143533143534143535143536143537143538143539143540143541143542143543143544143545143546143547143548143549143550143551143552143553143554143555143556143557143558143559143560143561143562143563143564143565143566143567143568143569143570143571143572143573143574143575143576143577143578143579143580143581143582143583143584143585143586143587143588143589143590143591143592143593143594143595143596143597143598143599143600143601143602143603143604143605143606143607143608143609143610143611143612143613143614143615143616143617143618143619143620143621143622143623143624143625143626143627143628143629143630143631143632143633143634143635143636143637143638143639143640143641143642143643143644143645143646143647143648143649143650143651143652143653143654143655143656143657143658143659143660143661143662143663143664143665143666143667143668143669143670143671143672143673143674143675143676143677143678143679143680143681143682143683143684143685143686143687143688143689143690143691143692143693143694143695143696143697143698143699143700143701143702143703143704143705143706143707143708143709143710143711143712143713143714143715143716143717143718143719143720143721143722143723143724143725143726143727143728143729143730143731143732143733143734143735143736143737143738143739143740143741143742143743143744143745143746143747143748143749143750143751143752143753143754143755143756143757143758143759143760143761143762143763143764143765143766143767143768143769143770143771143772143773143774143775143776143777143778143779143780143781143782143783143784143785143786143787143788143789143790143791143792143793143794143795143796143797143798143799143800143801143802143803143804143805143806143807143808143809143810143811143812143813143814143815143816143817143818143819143820143821143822143823143824143825143826143827143828143829143830143831143832143833143834143835143836143837143838143839143840143841143842143843143844143845143846143847143848143849143850143851143852143853143854143855143856143857143858143859143860143861143862143863143864143865143866143867143868143869143870143871143872143873143874143875143876143877143878143879143880143881143882143883143884143885143886143887143888143889143890143891143892143893143894143895143896143897143898143899143900143901143902143903143904143905143906143907143908143909143910143911143912143913143914143915143916143917143918143919143920143921143922143923143924143925143926143927143928143929143930143931143932143933143934143935143936143937143938143939143940143941143942143943143944143945143946143947143948143949143950143951143952143953143954143955143956143957143958143959143960143961143962143963143964143965143966143967143968143969143970143971143972143973143974143975143976143977143978143979143980143981143982143983143984143985143986143987143988143989143990143991143992143993143994143995143996143997143998143999144000144001144002144003144004144005144006144007144008144009144010144011144012144013144014144015144016144017144018144019144020144021144022144023144024144025144026144027144028144029144030144031144032144033144034144035144036144037144038144039144040144041144042144043144044144045144046144047144048144049144050144051144052144053144054144055144056144057144058144059144060144061144062144063144064144065144066144067144068144069144070144071144072144073144074144075144076144077144078144079144080144081144082144083144084144085144086144087144088144089144090144091144092144093144094144095144096144097144098144099144100144101144102144103144104144105144106144107144108144109144110144111144112144113144114144115144116144117144118144119144120144121144122144123144124144125144126144127144128144129144130144131144132144133144134144135144136144137144138144139144140144141144142144143144144144145144146144147144148144149144150144151144152144153144154144155144156144157144158144159144160144161144162144163144164144165144166144167144168144169144170144171144172144173144174144175144176144177144178144179144180144181144182144183144184144185144186144187144188144189144190144191144192144193144194144195144196144197144198144199144200144201144202144203144204144205144206144207144208144209144210144211144212144213144214144215144216144217144218144219144220144221144222144223144224144225144226144227144228144229144230144231144232144233144234144235144236144237144238144239144240144241144242144243144244144245144246144247144248144249144250144251144252144253144254144255144256144257144258144259144260144261144262144263144264144265144266144267144268144269144270144271144272144273144274144275144276144277144278144279144280144281144282144283144284144285144286144287144288144289144290144291144292144293144294144295144296144297144298144299144300144301144302144303144304144305144306144307144308144309144310144311144312144313144314144315144316144317144318144319144320144321144322144323144324144325144326144327144328144329144330144331144332144333144334144335144336144337144338144339144340144341144342144343144344144345144346144347144348144349144350144351144352144353144354144355144356144357144358144359144360144361144362144363144364144365144366144367144368144369144370144371144372144373144374144375144376144377144378144379144380144381144382144383144384144385144386144387144388144389144390144391144392144393144394144395144396144397144398144399144400144401144402144403144404144405144406144407144408144409144410144411144412144413144414144415144416144417144418144419144420144421144422144423144424144425144426144427144428144429144430144431144432144433144434144435144436144437144438144439144440144441144442144443144444144445144446144447144448144449144450144451144452144453144454144455144456144457144458144459144460144461144462144463144464144465144466144467144468144469144470144471144472144473144474144475144476144477144478144479144480144481144482144483144484144485144486144487144488144489144490144491144492144493144494144495144496144497144498144499144500144501144502144503144504144505144506144507144508144509144510144511144512144513144514144515144516144517144518144519144520144521144522144523144524144525144526144527144528144529144530144531144532144533144534144535144536144537144538144539144540144541144542144543144544144545144546144547144548144549144550144551144552144553144554144555144556144557144558144559144560144561144562144563144564144565144566144567144568144569144570144571144572144573144574144575144576144577144578144579144580144581144582144583144584144585144586144587144588144589144590144591144592144593144594144595144596144597144598144599144600144601144602144603144604144605144606144607144608144609144610144611144612144613144614144615144616144617144618144619144620144621144622144623144624144625144626144627144628144629144630144631144632144633144634144635144636144637144638144639144640144641144642144643144644144645144646144647144648144649144650144651144652144653144654144655144656144657144658144659144660144661144662144663144664144665144666144667144668144669144670144671144672144673144674144675144676144677144678144679144680144681144682144683144684144685144686144687144688144689144690144691144692144693144694144695144696144697144698144699144700144701144702144703144704144705144706144707144708144709144710144711144712144713144714144715144716144717144718144719144720144721144722144723144724144725144726144727144728144729144730144731144732144733144734144735144736144737144738144739144740144741144742144743144744144745144746144747144748144749144750144751144752144753144754144755144756144757144758144759144760144761144762144763144764144765144766144767144768144769144770144771144772144773144774144775144776144777144778144779144780144781144782144783144784144785144786144787144788144789144790144791144792144793144794144795144796144797144798144799144800144801144802144803144804144805144806144807144808144809144810144811144812144813144814144815144816144817144818144819144820144821144822144823144824144825144826144827144828144829144830144831144832144833144834144835144836144837144838144839144840144841144842144843144844144845144846144847144848144849144850144851144852144853144854144855144856144857144858144859144860144861144862144863144864144865144866144867144868144869144870144871144872144873144874144875144876144877144878144879144880144881144882144883144884144885144886144887144888144889144890144891144892144893144894144895144896144897144898144899144900144901144902144903144904144905144906144907144908144909144910144911144912144913144914144915144916144917144918144919144920144921144922144923144924144925144926144927144928144929144930144931144932144933144934144935144936144937144938144939144940144941144942144943144944144945144946144947144948144949144950144951144952144953144954144955144956144957144958144959144960144961144962144963144964144965144966144967144968144969144970144971144972144973144974144975144976144977144978144979144980144981144982144983144984144985144986144987144988144989144990144991144992144993144994144995144996144997144998144999145000145001145002145003145004145005145006145007145008145009145010145011145012145013145014145015145016145017145018145019145020145021145022145023145024145025145026145027145028145029145030145031145032145033145034145035145036145037145038145039145040145041145042145043145044145045145046145047145048145049145050145051145052145053145054145055145056145057145058145059145060145061145062145063145064145065145066145067145068145069145070145071145072145073145074145075145076145077145078145079145080145081145082145083145084145085145086145087145088145089145090145091145092145093145094145095145096145097145098145099145100145101145102145103145104145105145106145107145108145109145110145111145112145113145114145115145116145117145118145119145120145121145122145123145124145125145126145127145128145129145130145131145132145133145134145135145136145137145138145139145140145141145142145143145144145145145146145147145148145149145150145151145152145153145154145155145156145157145158145159145160145161145162145163145164145165145166145167145168145169145170145171145172145173145174145175145176145177145178145179145180145181145182145183145184145185145186145187145188145189145190145191145192145193145194145195145196145197145198145199145200145201145202145203145204145205145206145207145208145209145210145211145212145213145214145215145216145217145218145219145220145221145222145223145224145225145226145227145228145229145230145231145232145233145234145235145236145237145238145239145240145241145242145243145244145245145246145247145248145249145250145251145252145253145254145255145256145257145258145259145260145261145262145263145264145265145266145267145268145269145270145271145272145273145274145275145276145277145278145279145280145281145282145283145284145285145286145287145288145289145290145291145292145293145294145295145296145297145298145299145300145301145302145303145304145305145306145307145308145309145310145311145312145313145314145315145316145317145318145319145320145321145322145323145324145325145326145327145328145329145330145331145332145333145334145335145336145337145338145339145340145341145342145343145344145345145346145347145348145349145350145351145352145353145354145355145356145357145358145359145360145361145362145363145364145365145366145367145368145369145370145371145372145373145374145375145376145377145378145379145380145381145382145383145384145385145386145387145388145389145390145391145392145393145394145395145396145397145398145399145400145401145402145403145404145405145406145407145408145409145410145411145412145413145414145415145416145417145418145419145420145421145422145423145424145425145426145427145428145429145430145431145432145433145434145435145436145437145438145439145440145441145442145443145444145445145446145447145448145449145450145451145452145453145454145455145456145457145458145459145460145461145462145463145464145465145466145467145468145469145470145471145472145473145474145475145476145477145478145479145480145481145482145483145484145485145486145487145488145489145490145491145492145493145494145495145496145497145498145499145500145501145502145503145504145505145506145507145508145509145510145511145512145513145514145515145516145517145518145519145520145521145522145523145524145525145526145527145528145529145530145531145532145533145534145535145536145537145538145539145540145541145542145543145544145545145546145547145548145549145550145551145552145553145554145555145556145557145558145559145560145561145562145563145564145565145566145567145568145569145570145571145572145573145574145575145576145577145578145579145580145581145582145583145584145585145586145587145588145589145590145591145592145593145594145595145596145597145598145599145600145601145602145603145604145605145606145607145608145609145610145611145612145613145614145615145616145617145618145619145620145621145622145623145624145625145626145627145628145629145630145631145632145633145634145635145636145637145638145639145640145641145642145643145644145645145646145647145648145649145650145651145652145653145654145655145656145657145658145659145660145661145662145663145664145665145666145667145668145669145670145671145672145673145674145675145676145677145678145679145680145681145682145683145684145685145686145687145688145689145690145691145692145693145694145695145696145697145698145699145700145701145702145703145704145705145706145707145708145709145710145711145712145713145714145715145716145717145718145719145720145721145722145723145724145725145726145727145728145729145730145731145732145733145734145735145736145737145738145739145740145741145742145743145744145745145746145747145748145749145750145751145752145753145754145755145756145757145758145759145760145761145762145763145764145765145766145767145768145769145770145771145772145773145774145775145776145777145778145779145780145781145782145783145784145785145786145787145788145789145790145791145792145793145794145795145796145797145798145799145800145801145802145803145804145805145806145807145808145809145810145811145812145813145814145815145816145817145818145819145820145821145822145823145824145825145826145827145828145829145830145831145832145833145834145835145836145837145838145839145840145841145842145843145844145845145846145847145848145849145850145851145852145853145854145855145856145857145858145859145860145861145862145863145864145865145866145867145868145869145870145871145872145873145874145875145876145877145878145879145880145881145882145883145884145885145886145887145888145889145890145891145892145893145894145895145896145897145898145899145900145901145902145903145904145905145906145907145908145909145910145911145912145913145914145915145916145917145918145919145920145921145922145923145924145925145926145927145928145929145930145931145932145933145934145935145936145937145938145939145940145941145942145943145944145945145946145947145948145949145950145951145952145953145954145955145956145957145958145959145960145961145962145963145964145965145966145967145968145969145970145971145972145973145974145975145976145977145978145979145980145981145982145983145984145985145986145987145988145989145990145991145992145993145994145995145996145997145998145999146000146001146002146003146004146005146006146007146008146009146010146011146012146013146014146015146016146017146018146019146020146021146022146023146024146025146026146027146028146029146030146031146032146033146034146035146036146037146038146039146040146041146042146043146044146045146046146047146048146049146050146051146052146053146054146055146056146057146058146059146060146061146062146063146064146065146066146067146068146069146070146071146072146073146074146075146076146077146078146079146080146081146082146083146084146085146086146087146088146089146090146091146092146093146094146095146096146097146098146099146100146101146102146103146104146105146106146107146108146109146110146111146112146113146114146115146116146117146118146119146120146121146122146123146124146125146126146127146128146129146130146131146132146133146134146135146136146137146138146139146140146141146142146143146144146145146146146147146148146149146150146151146152146153146154146155146156146157146158146159146160146161146162146163146164146165146166146167146168146169146170146171146172146173146174146175146176146177146178146179146180146181146182146183146184146185146186146187146188146189146190146191146192146193146194146195146196146197146198146199146200146201146202146203146204146205146206146207146208146209146210146211146212146213146214146215146216146217146218146219146220146221146222146223146224146225146226146227146228146229146230146231146232146233146234146235146236146237146238146239146240146241146242146243146244146245146246146247146248146249146250146251146252146253146254146255146256146257146258146259146260146261146262146263146264146265146266146267146268146269146270146271146272146273146274146275146276146277146278146279146280146281146282146283146284146285146286146287146288146289146290146291146292146293146294146295146296146297146298146299146300146301146302146303146304146305146306146307146308146309146310146311146312146313146314146315146316146317146318146319146320146321146322146323146324146325146326146327146328146329146330146331146332146333146334146335146336146337146338146339146340146341146342146343146344146345146346146347146348146349146350146351146352146353146354146355146356146357146358146359146360146361146362146363146364146365146366146367146368146369146370146371146372146373146374146375146376146377146378146379146380146381146382146383146384146385146386146387146388146389146390146391146392146393146394146395146396146397146398146399146400146401146402146403146404146405146406146407146408146409146410146411146412146413146414146415146416146417146418146419146420146421146422146423146424146425146426146427146428146429146430146431146432146433146434146435146436146437146438146439146440146441146442146443146444146445146446146447146448146449146450146451146452146453146454146455146456146457146458146459146460146461146462146463146464146465146466146467146468146469146470146471146472146473146474146475146476146477146478146479146480146481146482146483146484146485146486146487146488146489146490146491146492146493146494146495146496146497146498146499146500146501146502146503146504146505146506146507146508146509146510146511146512146513146514146515146516146517146518146519146520146521146522146523146524146525146526146527146528146529146530146531146532146533146534146535146536146537146538146539146540146541146542146543146544146545146546146547146548146549146550146551146552146553146554146555146556146557146558146559146560146561146562146563146564146565146566146567146568146569146570146571146572146573146574146575146576146577146578146579146580146581146582146583146584146585146586146587146588146589146590146591146592146593146594146595146596146597146598146599146600146601146602146603146604146605146606146607146608146609146610146611146612146613146614146615146616146617146618146619146620146621146622146623146624146625146626146627146628146629146630146631146632146633146634146635146636146637146638146639146640146641146642146643146644146645146646146647146648146649146650146651146652146653146654146655146656146657146658146659146660146661146662146663146664146665146666146667146668146669146670146671146672146673146674146675146676146677146678146679146680146681146682146683146684146685146686146687146688146689146690146691146692146693146694146695146696146697146698146699146700146701146702146703146704146705146706146707146708146709146710146711146712146713146714146715146716146717146718146719146720146721146722146723146724146725146726146727146728146729146730146731146732146733146734146735146736146737146738146739146740146741146742146743146744146745146746146747146748146749146750146751146752146753146754146755146756146757146758146759146760146761146762146763146764146765146766146767146768146769146770146771146772146773146774146775146776146777146778146779146780146781146782146783146784146785146786146787146788146789146790146791146792146793146794146795146796146797146798146799146800146801146802146803146804146805146806146807146808146809146810146811146812146813146814146815146816146817146818146819146820146821146822146823146824146825146826146827146828146829146830146831146832146833146834146835146836146837146838146839146840146841146842146843146844146845146846146847146848146849146850146851146852146853146854146855146856146857146858146859146860146861146862146863146864146865146866146867146868146869146870146871146872146873146874146875146876146877146878146879146880146881146882146883146884146885146886146887146888146889146890146891146892146893146894146895146896146897146898146899146900146901146902146903146904146905146906146907146908146909146910146911146912146913146914146915146916146917146918146919146920146921146922146923146924146925146926146927146928146929146930146931146932146933146934146935146936146937146938146939146940146941146942146943146944146945146946146947146948146949146950146951146952146953146954146955146956146957146958146959146960146961146962146963146964146965146966146967146968146969146970146971146972146973146974146975146976146977146978146979146980146981146982146983146984146985146986146987146988146989146990146991146992146993146994146995146996146997146998146999147000147001147002147003147004147005147006147007147008147009147010147011147012147013147014147015147016147017147018147019147020147021147022147023147024147025147026147027147028147029147030147031147032147033147034147035147036147037147038147039147040147041147042147043147044147045147046147047147048147049147050147051147052147053147054147055147056147057147058147059147060147061147062147063147064147065147066147067147068147069147070147071147072147073147074147075147076147077147078147079147080147081147082147083147084147085147086147087147088147089147090147091147092147093147094147095147096147097147098147099147100147101147102147103147104147105147106147107147108147109147110147111147112147113147114147115147116147117147118147119147120147121147122147123147124147125147126147127147128147129147130147131147132147133147134147135147136147137147138147139147140147141147142147143147144147145147146147147147148147149147150147151147152147153147154147155147156147157147158147159147160147161147162147163147164147165147166147167147168147169147170147171147172147173147174147175147176147177147178147179147180147181147182147183147184147185147186147187147188147189147190147191147192147193147194147195147196147197147198147199147200147201147202147203147204147205147206147207147208147209147210147211147212147213147214147215147216147217147218147219147220147221147222147223147224147225147226147227147228147229147230147231147232147233147234147235147236147237147238147239147240147241147242147243147244147245147246147247147248147249147250147251147252147253147254147255147256147257147258147259147260147261147262147263147264147265147266147267147268147269147270147271147272147273147274147275147276147277147278147279147280147281147282147283147284147285147286147287147288147289147290147291147292147293147294147295147296147297147298147299147300147301147302147303147304147305147306147307147308147309147310147311147312147313147314147315147316147317147318147319147320147321147322147323147324147325147326147327147328147329147330147331147332147333147334147335147336147337147338147339147340147341147342147343147344147345147346147347147348147349147350147351147352147353147354147355147356147357147358147359147360147361147362147363147364147365147366147367147368147369147370147371147372147373147374147375147376147377147378147379147380147381147382147383147384147385147386147387147388147389147390147391147392147393147394147395147396147397147398147399147400147401147402147403147404147405147406147407147408147409147410147411147412147413147414147415147416147417147418147419147420147421147422147423147424147425147426147427147428147429147430147431147432147433147434147435147436147437147438147439147440147441147442147443147444147445147446147447147448147449147450147451147452147453147454147455147456147457147458147459147460147461147462147463147464147465147466147467147468147469147470147471147472147473147474147475147476147477147478147479147480147481147482147483147484147485147486147487147488147489147490147491147492147493147494147495147496147497147498147499147500147501147502147503147504147505147506147507147508147509147510147511147512147513147514147515147516147517147518147519147520147521147522147523147524147525147526147527147528147529147530147531147532147533147534147535147536147537147538147539147540147541147542147543147544147545147546147547147548147549147550147551147552147553147554147555147556147557147558147559147560147561147562147563147564147565147566147567147568147569147570147571147572147573147574147575147576147577147578147579147580147581147582147583147584147585147586147587147588147589147590147591147592147593147594147595147596147597147598147599147600147601147602147603147604147605147606147607147608147609147610147611147612147613147614147615147616147617147618147619147620147621147622147623147624147625147626147627147628147629147630147631147632147633147634147635147636147637147638147639147640147641147642147643147644147645147646147647147648147649147650147651147652147653147654147655147656147657147658147659147660147661147662147663147664147665147666147667147668147669147670147671147672147673147674147675147676147677147678147679147680147681147682147683147684147685147686147687147688147689147690147691147692147693147694147695147696147697147698147699147700147701147702147703147704147705147706147707147708147709147710147711147712147713147714147715147716147717147718147719147720147721147722147723147724147725147726147727147728147729147730147731147732147733147734147735147736147737147738147739147740147741147742147743147744147745147746147747147748147749147750147751147752147753147754147755147756147757147758147759147760147761147762147763147764147765147766147767147768147769147770147771147772147773147774147775147776147777147778147779147780147781147782147783147784147785147786147787147788147789147790147791147792147793147794147795147796147797147798147799147800147801147802147803147804147805147806147807147808147809147810147811147812147813147814147815147816147817147818147819147820147821147822147823147824147825147826147827147828147829147830147831147832147833147834147835147836147837147838147839147840147841147842147843147844147845147846147847147848147849147850147851147852147853147854147855147856147857147858147859147860147861147862147863147864147865147866147867147868147869147870147871147872147873147874147875147876147877147878147879147880147881147882147883147884147885147886147887147888147889147890147891147892147893147894147895147896147897147898147899147900147901147902147903147904147905147906147907147908147909147910147911147912147913147914147915147916147917147918147919147920147921147922147923147924147925147926147927147928147929147930147931147932147933147934147935147936147937147938147939147940147941147942147943147944147945147946147947147948147949147950147951147952147953147954147955147956147957147958147959147960147961147962147963147964147965147966147967147968147969147970147971147972147973147974147975147976147977147978147979147980147981147982147983147984147985147986147987147988147989147990147991147992147993147994147995147996147997147998147999148000148001148002148003148004148005148006148007148008148009148010148011148012148013148014148015148016148017148018148019148020148021148022148023148024148025148026148027148028148029148030148031148032148033148034148035148036148037148038148039148040148041148042148043148044148045148046148047148048148049148050148051148052148053148054148055148056148057148058148059148060148061148062148063148064148065148066148067148068148069148070148071148072148073148074148075148076148077148078148079148080148081148082148083148084148085148086148087148088148089148090148091148092148093148094148095148096148097148098148099148100148101148102148103148104148105148106148107148108148109148110148111148112148113148114148115148116148117148118148119148120148121148122148123148124148125148126148127148128148129148130148131148132148133148134148135148136148137148138148139148140148141148142148143148144148145148146148147148148148149148150148151148152148153148154148155148156148157148158148159148160148161148162148163148164148165148166148167148168148169148170148171148172148173148174148175148176148177148178148179148180148181148182148183148184148185148186148187148188148189148190148191148192148193148194148195148196148197148198148199148200148201148202148203148204148205148206148207148208148209148210148211148212148213148214148215148216148217148218148219148220148221148222148223148224148225148226148227148228148229148230148231148232148233148234148235148236148237148238148239148240148241148242148243148244148245148246148247148248148249148250148251148252148253148254148255148256148257148258148259148260148261148262148263148264148265148266148267148268148269148270148271148272148273148274148275148276148277148278148279148280148281148282148283148284148285148286148287148288148289148290148291148292148293148294148295148296148297148298148299148300148301148302148303148304148305148306148307148308148309148310148311148312148313148314148315148316148317148318148319148320148321148322148323148324148325148326148327148328148329148330148331148332148333148334148335148336148337148338148339148340148341148342148343148344148345148346148347148348148349148350148351148352148353148354148355148356148357148358148359148360148361148362148363148364148365148366148367148368148369148370148371148372148373148374148375148376148377148378148379148380148381148382148383148384148385148386148387148388148389148390148391148392148393148394148395148396148397148398148399148400148401148402148403148404148405148406148407148408148409148410148411148412148413148414148415148416148417148418148419148420148421148422148423148424148425148426148427148428148429148430148431148432148433148434148435148436148437148438148439148440148441148442148443148444148445148446148447148448148449148450148451148452148453148454148455148456148457148458148459148460148461148462148463148464148465148466148467148468148469148470148471148472148473148474148475148476148477148478148479148480148481148482148483148484148485148486148487148488148489148490148491148492148493148494148495148496148497148498148499148500148501148502148503148504148505148506148507148508148509148510148511148512148513148514148515148516148517148518148519148520148521148522148523148524148525148526148527148528148529148530148531148532148533148534148535148536148537148538148539148540148541148542148543148544148545148546148547148548148549148550148551148552148553148554148555148556148557148558148559148560148561148562148563148564148565148566148567148568148569148570148571148572148573148574148575148576148577148578148579148580148581148582148583148584148585148586148587148588148589148590148591148592148593148594148595148596148597148598148599148600148601148602148603148604148605148606148607148608148609148610148611148612148613148614148615148616148617148618148619148620148621148622148623148624148625148626148627148628148629148630148631148632148633148634148635148636148637148638148639148640148641148642148643148644148645148646148647148648148649148650148651148652148653148654148655148656148657148658148659148660148661148662148663148664148665148666148667148668148669148670148671148672148673148674148675148676148677148678148679148680148681148682148683148684148685148686148687148688148689148690148691148692148693148694148695148696148697148698148699148700148701148702148703148704148705148706148707148708148709148710148711148712148713148714148715148716148717148718148719148720148721148722148723148724148725148726148727148728148729148730148731148732148733148734148735148736148737148738148739148740148741148742148743148744148745148746148747148748148749148750148751148752148753148754148755148756148757148758148759148760148761148762148763148764148765148766148767148768148769148770148771148772148773148774148775148776148777148778148779148780148781148782148783148784148785148786148787148788148789148790148791148792148793148794148795148796148797148798148799148800148801148802148803148804148805148806148807148808148809148810148811148812148813148814148815148816148817148818148819148820148821148822148823148824148825148826148827148828148829148830148831148832148833148834148835148836148837148838148839148840148841148842148843148844148845148846148847148848148849148850148851148852148853148854148855148856148857148858148859148860148861148862148863148864148865148866148867148868148869148870148871148872148873148874148875148876148877148878148879148880148881148882148883148884148885148886148887148888148889148890148891148892148893148894148895148896148897148898148899148900148901148902148903148904148905148906148907148908148909148910148911148912148913148914148915148916148917148918148919148920148921148922148923148924148925148926148927148928148929148930148931148932148933148934148935148936148937148938148939148940148941148942148943148944148945148946148947148948148949148950148951148952148953148954148955148956148957148958148959148960148961148962148963148964148965148966148967148968148969148970148971148972148973148974148975148976148977148978148979148980148981148982148983148984148985148986148987148988148989148990148991148992148993148994148995148996148997148998148999149000149001149002149003149004149005149006149007149008149009149010149011149012149013149014149015149016149017149018149019149020149021149022149023149024149025149026149027149028149029149030149031149032149033149034149035149036149037149038149039149040149041149042149043149044149045149046149047149048149049149050149051149052149053149054149055149056149057149058149059149060149061149062149063149064149065149066149067149068149069149070149071149072149073149074149075149076149077149078149079149080149081149082149083149084149085149086149087149088149089149090149091149092149093149094149095149096149097149098149099149100149101149102149103149104149105149106149107149108149109149110149111149112149113149114149115149116149117149118149119149120149121149122149123149124149125149126149127149128149129149130149131149132149133149134149135149136149137149138149139149140149141149142149143149144149145149146149147149148149149149150149151149152149153149154149155149156149157149158149159149160149161149162149163149164149165149166149167149168149169149170149171149172149173149174149175149176149177149178149179149180149181149182149183149184149185149186149187149188149189149190149191149192149193149194149195149196149197149198149199149200149201149202149203149204149205149206149207149208149209149210149211149212149213149214149215149216149217149218149219149220149221149222149223149224149225149226149227149228149229149230149231149232149233149234149235149236149237149238149239149240149241149242149243149244149245149246149247149248149249149250149251149252149253149254149255149256149257149258149259149260149261149262149263149264149265149266149267149268149269149270149271149272149273149274149275149276149277149278149279149280149281149282149283149284149285149286149287149288149289149290149291149292149293149294149295149296149297149298149299149300149301149302149303149304149305149306149307149308149309149310149311149312149313149314149315149316149317149318149319149320149321149322149323149324149325149326149327149328149329149330149331149332149333149334149335149336149337149338149339149340149341149342149343149344149345149346149347149348149349149350149351149352149353149354149355149356149357149358149359149360149361149362149363149364149365149366149367149368149369149370149371149372149373149374149375149376149377149378149379149380149381149382149383149384149385149386149387149388149389149390149391149392149393149394149395149396149397149398149399149400149401149402149403149404149405149406149407149408149409149410149411149412149413149414149415149416149417149418149419149420149421149422149423149424149425149426149427149428149429149430149431149432149433149434149435149436149437149438149439149440149441149442149443149444149445149446149447149448149449149450149451149452149453149454149455149456149457149458149459149460149461149462149463149464149465149466149467149468149469149470149471149472149473149474149475149476149477149478149479149480149481149482149483149484149485149486149487149488149489149490149491149492149493149494149495149496149497149498149499149500149501149502149503149504149505149506149507149508149509149510149511149512149513149514149515149516149517149518149519149520149521149522149523149524149525149526149527149528149529149530149531149532149533149534149535149536149537149538149539149540149541149542149543149544149545149546149547149548149549149550149551149552149553149554149555149556149557149558149559149560149561149562149563149564149565149566149567149568149569149570149571149572149573149574149575149576149577149578149579149580149581149582149583149584149585149586149587149588149589149590149591149592149593149594149595149596149597149598149599149600149601149602149603149604149605149606149607149608149609149610149611149612149613149614149615149616149617149618149619149620149621149622149623149624149625149626149627149628149629149630149631149632149633149634149635149636149637149638149639149640149641149642149643149644149645149646149647149648149649149650149651149652149653149654149655149656149657149658149659149660149661149662149663149664149665149666149667149668149669149670149671149672149673149674149675149676149677149678149679149680149681149682149683149684149685149686149687149688149689149690149691149692149693149694149695149696149697149698149699149700149701149702149703149704149705149706149707149708149709149710149711149712149713149714149715149716149717149718149719149720149721149722149723149724149725149726149727149728149729149730149731149732149733149734149735149736149737149738149739149740149741149742149743149744149745149746149747149748149749149750149751149752149753149754149755149756149757149758149759149760149761149762149763149764149765149766149767149768149769149770149771149772149773149774149775149776149777149778149779149780149781149782149783149784149785149786149787149788149789149790149791149792149793149794149795149796149797149798149799149800149801149802149803149804149805149806149807149808149809149810149811149812149813149814149815149816149817149818149819149820149821149822149823149824149825149826149827149828149829149830149831149832149833149834149835149836149837149838149839149840149841149842149843149844149845149846149847149848149849149850149851149852149853149854149855149856149857149858149859149860149861149862149863149864149865149866149867149868149869149870149871149872149873149874149875149876149877149878149879149880149881149882149883149884149885149886149887149888149889149890149891149892149893149894149895149896149897149898149899149900149901149902149903149904149905149906149907149908149909149910149911149912149913149914149915149916149917149918149919149920149921149922149923149924149925149926149927149928149929149930149931149932149933149934149935149936149937149938149939149940149941149942149943149944149945149946149947149948149949149950149951149952149953149954149955149956149957149958149959149960149961149962149963149964149965149966149967149968149969149970149971149972149973149974149975149976149977149978149979149980149981149982149983149984149985149986149987149988149989149990149991149992149993149994149995149996149997149998149999150000150001150002150003150004150005150006150007150008150009150010150011150012150013150014150015150016150017150018150019150020150021150022150023150024150025150026150027150028150029150030150031150032150033150034150035150036150037150038150039150040150041150042150043150044150045150046150047150048150049150050150051150052150053150054150055150056150057150058150059150060150061150062150063150064150065150066150067150068150069150070150071150072150073150074150075150076150077150078150079150080150081150082150083150084150085150086150087150088150089150090150091150092150093150094150095150096150097150098150099150100150101150102150103150104150105150106150107150108150109150110150111150112150113150114150115150116150117150118150119150120150121150122150123150124150125150126150127150128150129150130150131150132150133150134150135150136150137150138150139150140150141150142150143150144150145150146150147150148150149150150150151150152150153150154150155150156150157150158150159150160150161150162150163150164150165150166150167150168150169150170150171150172150173150174150175150176150177150178150179150180150181150182150183150184150185150186150187150188150189150190150191150192150193150194150195150196150197150198150199150200150201150202150203150204150205150206150207150208150209150210150211150212150213150214150215150216150217150218150219150220150221150222150223150224150225150226150227150228150229150230150231150232150233150234150235150236150237150238150239150240150241150242150243150244150245150246150247150248150249150250150251150252150253150254150255150256150257150258150259150260150261150262150263150264150265150266150267150268150269150270150271150272150273150274150275150276150277150278150279150280150281150282150283150284150285150286150287150288150289150290150291150292150293150294150295150296150297150298150299150300150301150302150303150304150305150306150307150308150309150310150311150312150313150314150315150316150317150318150319150320150321150322150323150324150325150326150327150328150329150330150331150332150333150334150335150336150337150338150339150340150341150342150343150344150345150346150347150348150349150350150351150352150353150354150355150356150357150358150359150360150361150362150363150364150365150366150367150368150369150370150371150372150373150374150375150376150377150378150379150380150381150382150383150384150385150386150387150388150389150390150391150392150393150394150395150396150397150398150399150400150401150402150403150404150405150406150407150408150409150410150411150412150413150414150415150416150417150418150419150420150421150422150423150424150425150426150427150428150429150430150431150432150433150434150435150436150437150438150439150440150441150442150443150444150445150446150447150448150449150450150451150452150453150454150455150456150457150458150459150460150461150462150463150464150465150466150467150468150469150470150471150472150473150474150475150476150477150478150479150480150481150482150483150484150485150486150487150488150489150490150491150492150493150494150495150496150497150498150499150500150501150502150503150504150505150506150507150508150509150510150511150512150513150514150515150516150517150518150519150520150521150522150523150524150525150526150527150528150529150530150531150532150533150534150535150536150537150538150539150540150541150542150543150544150545150546150547150548150549150550150551150552150553150554150555150556150557150558150559150560150561150562150563150564150565150566150567150568150569150570150571150572150573150574150575150576150577150578150579150580150581150582150583150584150585150586150587150588150589150590150591150592150593150594150595150596150597150598150599150600150601150602150603150604150605150606150607150608150609150610150611150612150613150614150615150616150617150618150619150620150621150622150623150624150625150626150627150628150629150630150631150632150633150634150635150636150637150638150639150640150641150642150643150644150645150646150647150648150649150650150651150652150653150654150655150656150657150658150659150660150661150662150663150664150665150666150667150668150669150670150671150672150673150674150675150676150677150678150679150680150681150682150683150684150685150686150687150688150689150690150691150692150693150694150695150696150697150698150699150700150701150702150703150704150705150706150707150708150709150710150711150712150713150714150715150716150717150718150719150720150721150722150723150724150725150726150727150728150729150730150731150732150733150734150735150736150737150738150739150740150741150742150743150744150745150746150747150748150749150750150751150752150753150754150755150756150757150758150759150760150761150762150763150764150765150766150767150768150769150770150771150772150773150774150775150776150777150778150779150780150781150782150783150784150785150786150787150788150789150790150791150792150793150794150795150796150797150798150799150800150801150802150803150804150805150806150807150808150809150810150811150812150813150814150815150816150817150818150819150820150821150822150823150824150825150826150827150828150829150830150831150832150833150834150835150836150837150838150839150840150841150842150843150844150845150846150847150848150849150850150851150852150853150854150855150856150857150858150859150860150861150862150863150864150865150866150867150868150869150870150871150872150873150874150875150876150877150878150879150880150881150882150883150884150885150886150887150888150889150890150891150892150893150894150895150896150897150898150899150900150901150902150903150904150905150906150907150908150909150910150911150912150913150914150915150916150917150918150919150920150921150922150923150924150925150926150927150928150929150930150931150932150933150934150935150936150937150938150939150940150941150942150943150944150945150946150947150948150949150950150951150952150953150954150955150956150957150958150959150960150961150962150963150964150965150966150967150968150969150970150971150972150973150974150975150976150977150978150979150980150981150982150983150984150985150986150987150988150989150990150991150992150993150994150995150996150997150998150999151000151001151002151003151004151005151006151007151008151009151010151011151012151013151014151015151016151017151018151019151020151021151022151023151024151025151026151027151028151029151030151031151032151033151034151035151036151037151038151039151040151041151042151043151044151045151046151047151048151049151050151051151052151053151054151055151056151057151058151059151060151061151062151063151064151065151066151067151068151069151070151071151072151073151074151075151076151077151078151079151080151081151082151083151084151085151086151087151088151089151090151091151092151093151094151095151096151097151098151099151100151101151102151103151104151105151106151107151108151109151110151111151112151113151114151115151116151117151118151119151120151121151122151123151124151125151126151127151128151129151130151131151132151133151134151135151136151137151138151139151140151141151142151143151144151145151146151147151148151149151150151151151152151153151154151155151156151157151158151159151160151161151162151163151164151165151166151167151168151169151170151171151172151173151174151175151176151177151178151179151180151181151182151183151184151185151186151187151188151189151190151191151192151193151194151195151196151197151198151199151200151201151202151203151204151205151206151207151208151209151210151211151212151213151214151215151216151217151218151219151220151221151222151223151224151225151226151227151228151229151230151231151232151233151234151235151236151237151238151239151240151241151242151243151244151245151246151247151248151249151250151251151252151253151254151255151256151257151258151259151260151261151262151263151264151265151266151267151268151269151270151271151272151273151274151275151276151277151278151279151280151281151282151283151284151285151286151287151288151289151290151291151292151293151294151295151296151297151298151299151300151301151302151303151304151305151306151307151308151309151310151311151312151313151314151315151316151317151318151319151320151321151322151323151324151325151326151327151328151329151330151331151332151333151334151335151336151337151338151339151340151341151342151343151344151345151346151347151348151349151350151351151352151353151354151355151356151357151358151359151360151361151362151363151364151365151366151367151368151369151370151371151372151373151374151375151376151377151378151379151380151381151382151383151384151385151386151387151388151389151390151391151392151393151394151395151396151397151398151399151400151401151402151403151404151405151406151407151408151409151410151411151412151413151414151415151416151417151418151419151420151421151422151423151424151425151426151427151428151429151430151431151432151433151434151435151436151437151438151439151440151441151442151443151444151445151446151447151448151449151450151451151452151453151454151455151456151457151458151459151460151461151462151463151464151465151466151467151468151469151470151471151472151473151474151475151476151477151478151479151480151481151482151483151484151485151486151487151488151489151490151491151492151493151494151495151496151497151498151499151500151501151502151503151504151505151506151507151508151509151510151511151512151513151514151515151516151517151518151519151520151521151522151523151524151525151526151527151528151529151530151531151532151533151534151535151536151537151538151539151540151541151542151543151544151545151546151547151548151549151550151551151552151553151554151555151556151557151558151559151560151561151562151563151564151565151566151567151568151569151570151571151572151573151574151575151576151577151578151579151580151581151582151583151584151585151586151587151588151589151590151591151592151593151594151595151596151597151598151599151600151601151602151603151604151605151606151607151608151609151610151611151612151613151614151615151616151617151618151619151620151621151622151623151624151625151626151627151628151629151630151631151632151633151634151635151636151637151638151639151640151641151642151643151644151645151646151647151648151649151650151651151652151653151654151655151656151657151658151659151660151661151662151663151664151665151666151667151668151669151670151671151672151673151674151675151676151677151678151679151680151681151682151683151684151685151686151687151688151689151690151691151692151693151694151695151696151697151698151699151700151701151702151703151704151705151706151707151708151709151710151711151712151713151714151715151716151717151718151719151720151721151722151723151724151725151726151727151728151729151730151731151732151733151734151735151736151737151738151739151740151741151742151743151744151745151746151747151748151749151750151751151752151753151754151755151756151757151758151759151760151761151762151763151764151765151766151767151768151769151770151771151772151773151774151775151776151777151778151779151780151781151782151783151784151785151786151787151788151789151790151791151792151793151794151795151796151797151798151799151800151801151802151803151804151805151806151807151808151809151810151811151812151813151814151815151816151817151818151819151820151821151822151823151824151825151826151827151828151829151830151831151832151833151834151835151836151837151838151839151840151841151842151843151844151845151846151847151848151849151850151851151852151853151854151855151856151857151858151859151860151861151862151863151864151865151866151867151868151869151870151871151872151873151874151875151876151877151878151879151880151881151882151883151884151885151886151887151888151889151890151891151892151893151894151895151896151897151898151899151900151901151902151903151904151905151906151907151908151909151910151911151912151913151914151915151916151917151918151919151920151921151922151923151924151925151926151927151928151929151930151931151932151933151934151935151936151937151938151939151940151941151942151943151944151945151946151947151948151949151950151951151952151953151954151955151956151957151958151959151960151961151962151963151964151965151966151967151968151969151970151971151972151973151974151975151976151977151978151979151980151981151982151983151984151985151986151987151988151989151990151991151992151993151994151995151996151997151998151999152000152001152002152003152004152005152006152007152008152009152010152011152012152013152014152015152016152017152018152019152020152021152022152023152024152025152026152027152028152029152030152031152032152033152034152035152036152037152038152039152040152041152042152043152044152045152046152047152048152049152050152051152052152053152054152055152056152057152058152059152060152061152062152063152064152065152066152067152068152069152070152071152072152073152074152075152076152077152078152079152080152081152082152083152084152085152086152087152088152089152090152091152092152093152094152095152096152097152098152099152100152101152102152103152104152105152106152107152108152109152110152111152112152113152114152115152116152117152118152119152120152121152122152123152124152125152126152127152128152129152130152131152132152133152134152135152136152137152138152139152140152141152142152143152144152145152146152147152148152149152150152151152152152153152154152155152156152157152158152159152160152161152162152163152164152165152166152167152168152169152170152171152172152173152174152175152176152177152178152179152180152181152182152183152184152185152186152187152188152189152190152191152192152193152194152195152196152197152198152199152200152201152202152203152204152205152206152207152208152209152210152211152212152213152214152215152216152217152218152219152220152221152222152223152224152225152226152227152228152229152230152231152232152233152234152235152236152237152238152239152240152241152242152243152244152245152246152247152248152249152250152251152252152253152254152255152256152257152258152259152260152261152262152263152264152265152266152267152268152269152270152271152272152273152274152275152276152277152278152279152280152281152282152283152284152285152286152287152288152289152290152291152292152293152294152295152296152297152298152299152300152301152302152303152304152305152306152307152308152309152310152311152312152313152314152315152316152317152318152319152320152321152322152323152324152325152326152327152328152329152330152331152332152333152334152335152336152337152338152339152340152341152342152343152344152345152346152347152348152349152350152351152352152353152354152355152356152357152358152359152360152361152362152363152364152365152366152367152368152369152370152371152372152373152374152375152376152377152378152379152380152381152382152383152384152385152386152387152388152389152390152391152392152393152394152395152396152397152398152399152400152401152402152403152404152405152406152407152408152409152410152411152412152413152414152415152416152417152418152419152420152421152422152423152424152425152426152427152428152429152430152431152432152433152434152435152436152437152438152439152440152441152442152443152444152445152446152447152448152449152450152451152452152453152454152455152456152457152458152459152460152461152462152463152464152465152466152467152468152469152470152471152472152473152474152475152476152477152478152479152480152481152482152483152484152485152486152487152488152489152490152491152492152493152494152495152496152497152498152499152500152501152502152503152504152505152506152507152508152509152510152511152512152513152514152515152516152517152518152519152520152521152522152523152524152525152526152527152528152529152530152531152532152533152534152535152536152537152538152539152540152541152542152543152544152545152546152547152548152549152550152551152552152553152554152555152556152557152558152559152560152561152562152563152564152565152566152567152568152569152570152571152572152573152574152575152576152577152578152579152580152581152582152583152584152585152586152587152588152589152590152591152592152593152594152595152596152597152598152599152600152601152602152603152604152605152606152607152608152609152610152611152612152613152614152615152616152617152618152619152620152621152622152623152624152625152626152627152628152629152630152631152632152633152634152635152636152637152638152639152640152641152642152643152644152645152646152647152648152649152650152651152652152653152654152655152656152657152658152659152660152661152662152663152664152665152666152667152668152669152670152671152672152673152674152675152676152677152678152679152680152681152682152683152684152685152686152687152688152689152690152691152692152693152694152695152696152697152698152699152700152701152702152703152704152705152706152707152708152709152710152711152712152713152714152715152716152717152718152719152720152721152722152723152724152725152726152727152728152729152730152731152732152733152734152735152736152737152738152739152740152741152742152743152744152745152746152747152748152749152750152751152752152753152754152755152756152757152758152759152760152761152762152763152764152765152766152767152768152769152770152771152772152773152774152775152776152777152778152779152780152781152782152783152784152785152786152787152788152789152790152791152792152793152794152795152796152797152798152799152800152801152802152803152804152805152806152807152808152809152810152811152812152813152814152815152816152817152818152819152820152821152822152823152824152825152826152827152828152829152830152831152832152833152834152835152836152837152838152839152840152841152842152843152844152845152846152847152848152849152850152851152852152853152854152855152856152857152858152859152860152861152862152863152864152865152866152867152868152869152870152871152872152873152874152875152876152877152878152879152880152881152882152883152884152885152886152887152888152889152890152891152892152893152894152895152896152897152898152899152900152901152902152903152904152905152906152907152908152909152910152911152912152913152914152915152916152917152918152919152920152921152922152923152924152925152926152927152928152929152930152931152932152933152934152935152936152937152938152939152940152941152942152943152944152945152946152947152948152949152950152951152952152953152954152955152956152957152958152959152960152961152962152963152964152965152966152967152968152969152970152971152972152973152974152975152976152977152978152979152980152981152982152983152984152985152986152987152988152989152990152991152992152993152994152995152996152997152998152999153000153001153002153003153004153005153006153007153008153009153010153011153012153013153014153015153016153017153018153019153020153021153022153023153024153025153026153027153028153029153030153031153032153033153034153035153036153037153038153039153040153041153042153043153044153045153046153047153048153049153050153051153052153053153054153055153056153057153058153059153060153061153062153063153064153065153066153067153068153069153070153071153072153073153074153075153076153077153078153079153080153081153082153083153084153085153086153087153088153089153090153091153092153093153094153095153096153097153098153099153100153101153102153103153104153105153106153107153108153109153110153111153112153113153114153115153116153117153118153119153120153121153122153123153124153125153126153127153128153129153130153131153132153133153134153135153136153137153138153139153140153141153142153143153144153145153146153147153148153149153150153151153152153153153154153155153156153157153158153159153160153161153162153163153164153165153166153167153168153169153170153171153172153173153174153175153176153177153178153179153180153181153182153183153184153185153186153187153188153189153190153191153192153193153194153195153196153197153198153199153200153201153202153203153204153205153206153207153208153209153210153211153212153213153214153215153216153217153218153219153220153221153222153223153224153225153226153227153228153229153230153231153232153233153234153235153236153237153238153239153240153241153242153243153244153245153246153247153248153249153250153251153252153253153254153255153256153257153258153259153260153261153262153263153264153265153266153267153268153269153270153271153272153273153274153275153276153277153278153279153280153281153282153283153284153285153286153287153288153289153290153291153292153293153294153295153296153297153298153299153300153301153302153303153304153305153306153307153308153309153310153311153312153313153314153315153316153317153318153319153320153321153322153323153324153325153326153327153328153329153330153331153332153333153334153335153336153337153338153339153340153341153342153343153344153345153346153347153348153349153350153351153352153353153354153355153356153357153358153359153360153361153362153363153364153365153366153367153368153369153370153371153372153373153374153375153376153377153378153379153380153381153382153383153384153385153386153387153388153389153390153391153392153393153394153395153396153397153398153399153400153401153402153403153404153405153406153407153408153409153410153411153412153413153414153415153416153417153418153419153420153421153422153423153424153425153426153427153428153429153430153431153432153433153434153435153436153437153438153439153440153441153442153443153444153445153446153447153448153449153450153451153452153453153454153455153456153457153458153459153460153461153462153463153464153465153466153467153468153469153470153471153472153473153474153475153476153477153478153479153480153481153482153483153484153485153486153487153488153489153490153491153492153493153494153495153496153497153498153499153500153501153502153503153504153505153506153507153508153509153510153511153512153513153514153515153516153517153518153519153520153521153522153523153524153525153526153527153528153529153530153531153532153533153534153535153536153537153538153539153540153541153542153543153544153545153546153547153548153549153550153551153552153553153554153555153556153557153558153559153560153561153562153563153564153565153566153567153568153569153570153571153572153573153574153575153576153577153578153579153580153581153582153583153584153585153586153587153588153589153590153591153592153593153594153595153596153597153598153599153600153601153602153603153604153605153606153607153608153609153610153611153612153613153614153615153616153617153618153619153620153621153622153623153624153625153626153627153628153629153630153631153632153633153634153635153636153637153638153639153640153641153642153643153644153645153646153647153648153649153650153651153652153653153654153655153656153657153658153659153660153661153662153663153664153665153666153667153668153669153670153671153672153673153674153675153676153677153678153679153680153681153682153683153684153685153686153687153688153689153690153691153692153693153694153695153696153697153698153699153700153701153702153703153704153705153706153707153708153709153710153711153712153713153714153715153716153717153718153719153720153721153722153723153724153725153726153727153728153729153730153731153732153733153734153735153736153737153738153739153740153741153742153743153744153745153746153747153748153749153750153751153752153753153754153755153756153757153758153759153760153761153762153763153764153765153766153767153768153769153770153771153772153773153774153775153776153777153778153779153780153781153782153783153784153785153786153787153788153789153790153791153792153793153794153795153796153797153798153799153800153801153802153803153804153805153806153807153808153809153810153811153812153813153814153815153816153817153818153819153820153821153822153823153824153825153826153827153828153829153830153831153832153833153834153835153836153837153838153839153840153841153842153843153844153845153846153847153848153849153850153851153852153853153854153855153856153857153858153859153860153861153862153863153864153865153866153867153868153869153870153871153872153873153874153875153876153877153878153879153880153881153882153883153884153885153886153887153888153889153890153891153892153893153894153895153896153897153898153899153900153901153902153903153904153905153906153907153908153909153910153911153912153913153914153915153916153917153918153919153920153921153922153923153924153925153926153927153928153929153930153931153932153933153934153935153936153937153938153939153940153941153942153943153944153945153946153947153948153949153950153951153952153953153954153955153956153957153958153959153960153961153962153963153964153965153966153967153968153969153970153971153972153973153974153975153976153977153978153979153980153981153982153983153984153985153986153987153988153989153990153991153992153993153994153995153996153997153998153999154000154001154002154003154004154005154006154007154008154009154010154011154012154013154014154015154016154017154018154019154020154021154022154023154024154025154026154027154028154029154030154031154032154033154034154035154036154037154038154039154040154041154042154043154044154045154046154047154048154049154050154051154052154053154054154055154056154057154058154059154060154061154062154063154064154065154066154067154068154069154070154071154072154073154074154075154076154077154078154079154080154081154082154083154084154085154086154087154088154089154090154091154092154093154094154095154096154097154098154099154100154101154102154103154104154105154106154107154108154109154110154111154112154113154114154115154116154117154118154119154120154121154122154123154124154125154126154127154128154129154130154131154132154133154134154135154136154137154138154139154140154141154142154143154144154145154146154147154148154149154150154151154152154153154154154155154156154157154158154159154160154161154162154163154164154165154166154167154168154169154170154171154172154173154174154175154176154177154178154179154180154181154182154183154184154185154186154187154188154189154190154191154192154193154194154195154196154197154198154199154200154201154202154203154204154205154206154207154208154209154210154211154212154213154214154215154216154217154218154219154220154221154222154223154224154225154226154227154228154229154230154231154232154233154234154235154236154237154238154239154240154241154242154243154244154245154246154247154248154249154250154251154252154253154254154255154256154257154258154259154260154261154262154263154264154265154266154267154268154269154270154271154272154273154274154275154276154277154278154279154280154281154282154283154284154285154286154287154288154289154290154291154292154293154294154295154296154297154298154299154300154301154302154303154304154305154306154307154308154309154310154311154312154313154314154315154316154317154318154319154320154321154322154323154324154325154326154327154328154329154330154331154332154333154334154335154336154337154338154339154340154341154342154343154344154345154346154347154348154349154350154351154352154353154354154355154356154357154358154359154360154361154362154363154364154365154366154367154368154369154370154371154372154373154374154375154376154377154378154379154380154381154382154383154384154385154386154387154388154389154390154391154392154393154394154395154396154397154398154399154400154401154402154403154404154405154406154407154408154409154410154411154412154413154414154415154416154417154418154419154420154421154422154423154424154425154426154427154428154429154430154431154432154433154434154435154436154437154438154439154440154441154442154443154444154445154446154447154448154449154450154451154452154453154454154455154456154457154458154459154460154461154462154463154464154465154466154467154468154469154470154471154472154473154474154475154476154477154478154479154480154481154482154483154484154485154486154487154488154489154490154491154492154493154494154495154496154497154498154499154500154501154502154503154504154505154506154507154508154509154510154511154512154513154514154515154516154517154518154519154520154521154522154523154524154525154526154527154528154529154530154531154532154533154534154535154536154537154538154539154540154541154542154543154544154545154546154547154548154549154550154551154552154553154554154555154556154557154558154559154560154561154562154563154564154565154566154567154568154569154570154571154572154573154574154575154576154577154578154579154580154581154582154583154584154585154586154587154588154589154590154591154592154593154594154595154596154597154598154599154600154601154602154603154604154605154606154607154608154609154610154611154612154613154614154615154616154617154618154619154620154621154622154623154624154625154626154627154628154629154630154631154632154633154634154635154636154637154638154639154640154641154642154643154644154645154646154647154648154649154650154651154652154653154654154655154656154657154658154659154660154661154662154663154664154665154666154667154668154669154670154671154672154673154674154675154676154677154678154679154680154681154682154683154684154685154686154687154688154689154690154691154692154693154694154695154696154697154698154699154700154701154702154703154704154705154706154707154708154709154710154711154712154713154714154715154716154717154718154719154720154721154722154723154724154725154726154727154728154729154730154731154732154733154734154735154736154737154738154739154740154741154742154743154744154745154746154747154748154749154750154751154752154753154754154755154756154757154758154759154760154761154762154763154764154765154766154767154768154769154770154771154772154773154774154775154776154777154778154779154780154781154782154783154784154785154786154787154788154789154790154791154792154793154794154795154796154797154798154799154800154801154802154803154804154805154806154807154808154809154810154811154812154813154814154815154816154817154818154819154820154821154822154823154824154825154826154827154828154829154830154831154832154833154834154835154836154837154838154839154840154841154842154843154844154845154846154847154848154849154850154851154852154853154854154855154856154857154858154859154860154861154862154863154864154865154866154867154868154869154870154871154872154873154874154875154876154877154878154879154880154881154882154883154884154885154886154887154888154889154890154891154892154893154894154895154896154897154898154899154900154901154902154903154904154905154906154907154908154909154910154911154912154913154914154915154916154917154918154919154920154921154922154923154924154925154926154927154928154929154930154931154932154933154934154935154936154937154938154939154940154941154942154943154944154945154946154947154948154949154950154951154952154953154954154955154956154957154958154959154960154961154962154963154964154965154966154967154968154969154970154971154972154973154974154975154976154977154978154979154980154981154982154983154984154985154986154987154988154989154990154991154992154993154994154995154996154997154998154999155000155001155002155003155004155005155006155007155008155009155010155011155012155013155014155015155016155017155018155019155020155021155022155023155024155025155026155027155028155029155030155031155032155033155034155035155036155037155038155039155040155041155042155043155044155045155046155047155048155049155050155051155052155053155054155055155056155057155058155059155060155061155062155063155064155065155066155067155068155069155070155071155072155073155074155075155076155077155078155079155080155081155082155083155084155085155086155087155088155089155090155091155092155093155094155095155096155097155098155099155100155101155102155103155104155105155106155107155108155109155110155111155112155113155114155115155116155117155118155119155120155121155122155123155124155125155126155127155128155129155130155131155132155133155134155135155136155137155138155139155140155141155142155143155144155145155146155147155148155149155150155151155152155153155154155155155156155157155158155159155160155161155162155163155164155165155166155167155168155169155170155171155172155173155174155175155176155177155178155179155180155181155182155183155184155185155186155187155188155189155190155191155192155193155194155195155196155197155198155199155200155201155202155203155204155205155206155207155208155209155210155211155212155213155214155215155216155217155218155219155220155221155222155223155224155225155226155227155228155229155230155231155232155233155234155235155236155237155238155239155240155241155242155243155244155245155246155247155248155249155250155251155252155253155254155255155256155257155258155259155260155261155262155263155264155265155266155267155268155269155270155271155272155273155274155275155276155277155278155279155280155281155282155283155284155285155286155287155288155289155290155291155292155293155294155295155296155297155298155299155300155301155302155303155304155305155306155307155308155309155310155311155312155313155314155315155316155317155318155319155320155321155322155323155324155325155326155327155328155329155330155331155332155333155334155335155336155337155338155339155340155341155342155343155344155345155346155347155348155349155350155351155352155353155354155355155356155357155358155359155360155361155362155363155364155365155366155367155368155369155370155371155372155373155374155375155376155377155378155379155380155381155382155383155384155385155386155387155388155389155390155391155392155393155394155395155396155397155398155399155400155401155402155403155404155405155406155407155408155409155410155411155412155413155414155415155416155417155418155419155420155421155422155423155424155425155426155427155428155429155430155431155432155433155434155435155436155437155438155439155440155441155442155443155444155445155446155447155448155449155450155451155452155453155454155455155456155457155458155459155460155461155462155463155464155465155466155467155468155469155470155471155472155473155474155475155476155477155478155479155480155481155482155483155484155485155486155487155488155489155490155491155492155493155494155495155496155497155498155499155500155501155502155503155504155505155506155507155508155509155510155511155512155513155514155515155516155517155518155519155520155521155522155523155524155525155526155527155528155529155530155531155532155533155534155535155536155537155538155539155540155541155542155543155544155545155546155547155548155549155550155551155552155553155554155555155556155557155558155559155560155561155562155563155564155565155566155567155568155569155570155571155572155573155574155575155576155577155578155579155580155581155582155583155584155585155586155587155588155589155590155591155592155593155594155595155596155597155598155599155600155601155602155603155604155605155606155607155608155609155610155611155612155613155614155615155616155617155618155619155620155621155622155623155624155625155626155627155628155629155630155631155632155633155634155635155636155637155638155639155640155641155642155643155644155645155646155647155648155649155650155651155652155653155654155655155656155657155658155659155660155661155662155663155664155665155666155667155668155669155670155671155672155673155674155675155676155677155678155679155680155681155682155683155684155685155686155687155688155689155690155691155692155693155694155695155696155697155698155699155700155701155702155703155704155705155706155707155708155709155710155711155712155713155714155715155716155717155718155719155720155721
  1. declare module "babylonjs/types" {
  2. /** Alias type for value that can be null */
  3. export type Nullable<T> = T | null;
  4. /**
  5. * Alias type for number that are floats
  6. * @ignorenaming
  7. */
  8. export type float = number;
  9. /**
  10. * Alias type for number that are doubles.
  11. * @ignorenaming
  12. */
  13. export type double = number;
  14. /**
  15. * Alias type for number that are integer
  16. * @ignorenaming
  17. */
  18. export type int = number;
  19. /** Alias type for number array or Float32Array */
  20. export type FloatArray = number[] | Float32Array;
  21. /** Alias type for number array or Float32Array or Int32Array or Uint32Array or Uint16Array */
  22. export type IndicesArray = number[] | Int32Array | Uint32Array | Uint16Array;
  23. /**
  24. * Alias for types that can be used by a Buffer or VertexBuffer.
  25. */
  26. export type DataArray = number[] | ArrayBuffer | ArrayBufferView;
  27. /**
  28. * Alias type for primitive types
  29. * @ignorenaming
  30. */
  31. type Primitive = undefined | null | boolean | string | number | Function;
  32. /**
  33. * Type modifier to make all the properties of an object Readonly
  34. */
  35. export type Immutable<T> = T extends Primitive ? T : T extends Array<infer U> ? ReadonlyArray<U> : DeepImmutable<T>;
  36. /**
  37. * Type modifier to make all the properties of an object Readonly recursively
  38. */
  39. export type DeepImmutable<T> = T extends Primitive ? T : T extends Array<infer U> ? DeepImmutableArray<U> : DeepImmutableObject<T>;
  40. /**
  41. * Type modifier to make object properties readonly.
  42. */
  43. export type DeepImmutableObject<T> = {
  44. readonly [K in keyof T]: DeepImmutable<T[K]>;
  45. };
  46. /** @hidden */
  47. interface DeepImmutableArray<T> extends ReadonlyArray<DeepImmutable<T>> {
  48. }
  49. }
  50. declare module "babylonjs/Misc/observable" {
  51. import { Nullable } from "babylonjs/types";
  52. /**
  53. * A class serves as a medium between the observable and its observers
  54. */
  55. export class EventState {
  56. /**
  57. * Create a new EventState
  58. * @param mask defines the mask associated with this state
  59. * @param skipNextObservers defines a flag which will instruct the observable to skip following observers when set to true
  60. * @param target defines the original target of the state
  61. * @param currentTarget defines the current target of the state
  62. */
  63. constructor(mask: number, skipNextObservers?: boolean, target?: any, currentTarget?: any);
  64. /**
  65. * Initialize the current event state
  66. * @param mask defines the mask associated with this state
  67. * @param skipNextObservers defines a flag which will instruct the observable to skip following observers when set to true
  68. * @param target defines the original target of the state
  69. * @param currentTarget defines the current target of the state
  70. * @returns the current event state
  71. */
  72. initalize(mask: number, skipNextObservers?: boolean, target?: any, currentTarget?: any): EventState;
  73. /**
  74. * An Observer can set this property to true to prevent subsequent observers of being notified
  75. */
  76. skipNextObservers: boolean;
  77. /**
  78. * Get the mask value that were used to trigger the event corresponding to this EventState object
  79. */
  80. mask: number;
  81. /**
  82. * The object that originally notified the event
  83. */
  84. target?: any;
  85. /**
  86. * The current object in the bubbling phase
  87. */
  88. currentTarget?: any;
  89. /**
  90. * This will be populated with the return value of the last function that was executed.
  91. * If it is the first function in the callback chain it will be the event data.
  92. */
  93. lastReturnValue?: any;
  94. }
  95. /**
  96. * Represent an Observer registered to a given Observable object.
  97. */
  98. export class Observer<T> {
  99. /**
  100. * Defines the callback to call when the observer is notified
  101. */
  102. callback: (eventData: T, eventState: EventState) => void;
  103. /**
  104. * Defines the mask of the observer (used to filter notifications)
  105. */
  106. mask: number;
  107. /**
  108. * Defines the current scope used to restore the JS context
  109. */
  110. scope: any;
  111. /** @hidden */
  112. _willBeUnregistered: boolean;
  113. /**
  114. * Gets or sets a property defining that the observer as to be unregistered after the next notification
  115. */
  116. unregisterOnNextCall: boolean;
  117. /**
  118. * Creates a new observer
  119. * @param callback defines the callback to call when the observer is notified
  120. * @param mask defines the mask of the observer (used to filter notifications)
  121. * @param scope defines the current scope used to restore the JS context
  122. */
  123. constructor(
  124. /**
  125. * Defines the callback to call when the observer is notified
  126. */
  127. callback: (eventData: T, eventState: EventState) => void,
  128. /**
  129. * Defines the mask of the observer (used to filter notifications)
  130. */
  131. mask: number,
  132. /**
  133. * Defines the current scope used to restore the JS context
  134. */
  135. scope?: any);
  136. }
  137. /**
  138. * Represent a list of observers registered to multiple Observables object.
  139. */
  140. export class MultiObserver<T> {
  141. private _observers;
  142. private _observables;
  143. /**
  144. * Release associated resources
  145. */
  146. dispose(): void;
  147. /**
  148. * Raise a callback when one of the observable will notify
  149. * @param observables defines a list of observables to watch
  150. * @param callback defines the callback to call on notification
  151. * @param mask defines the mask used to filter notifications
  152. * @param scope defines the current scope used to restore the JS context
  153. * @returns the new MultiObserver
  154. */
  155. static Watch<T>(observables: Observable<T>[], callback: (eventData: T, eventState: EventState) => void, mask?: number, scope?: any): MultiObserver<T>;
  156. }
  157. /**
  158. * The Observable class is a simple implementation of the Observable pattern.
  159. *
  160. * There's one slight particularity though: a given Observable can notify its observer using a particular mask value, only the Observers registered with this mask value will be notified.
  161. * This enable a more fine grained execution without having to rely on multiple different Observable objects.
  162. * For instance you may have a given Observable that have four different types of notifications: Move (mask = 0x01), Stop (mask = 0x02), Turn Right (mask = 0X04), Turn Left (mask = 0X08).
  163. * A given observer can register itself with only Move and Stop (mask = 0x03), then it will only be notified when one of these two occurs and will never be for Turn Left/Right.
  164. */
  165. export class Observable<T> {
  166. private _observers;
  167. private _eventState;
  168. private _onObserverAdded;
  169. /**
  170. * Gets the list of observers
  171. */
  172. get observers(): Array<Observer<T>>;
  173. /**
  174. * Creates a new observable
  175. * @param onObserverAdded defines a callback to call when a new observer is added
  176. */
  177. constructor(onObserverAdded?: (observer: Observer<T>) => void);
  178. /**
  179. * Create a new Observer with the specified callback
  180. * @param callback the callback that will be executed for that Observer
  181. * @param mask the mask used to filter observers
  182. * @param insertFirst if true the callback will be inserted at the first position, hence executed before the others ones. If false (default behavior) the callback will be inserted at the last position, executed after all the others already present.
  183. * @param scope optional scope for the callback to be called from
  184. * @param unregisterOnFirstCall defines if the observer as to be unregistered after the next notification
  185. * @returns the new observer created for the callback
  186. */
  187. add(callback: (eventData: T, eventState: EventState) => void, mask?: number, insertFirst?: boolean, scope?: any, unregisterOnFirstCall?: boolean): Nullable<Observer<T>>;
  188. /**
  189. * Create a new Observer with the specified callback and unregisters after the next notification
  190. * @param callback the callback that will be executed for that Observer
  191. * @returns the new observer created for the callback
  192. */
  193. addOnce(callback: (eventData: T, eventState: EventState) => void): Nullable<Observer<T>>;
  194. /**
  195. * Remove an Observer from the Observable object
  196. * @param observer the instance of the Observer to remove
  197. * @returns false if it doesn't belong to this Observable
  198. */
  199. remove(observer: Nullable<Observer<T>>): boolean;
  200. /**
  201. * Remove a callback from the Observable object
  202. * @param callback the callback to remove
  203. * @param scope optional scope. If used only the callbacks with this scope will be removed
  204. * @returns false if it doesn't belong to this Observable
  205. */
  206. removeCallback(callback: (eventData: T, eventState: EventState) => void, scope?: any): boolean;
  207. private _deferUnregister;
  208. private _remove;
  209. /**
  210. * Moves the observable to the top of the observer list making it get called first when notified
  211. * @param observer the observer to move
  212. */
  213. makeObserverTopPriority(observer: Observer<T>): void;
  214. /**
  215. * Moves the observable to the bottom of the observer list making it get called last when notified
  216. * @param observer the observer to move
  217. */
  218. makeObserverBottomPriority(observer: Observer<T>): void;
  219. /**
  220. * Notify all Observers by calling their respective callback with the given data
  221. * Will return true if all observers were executed, false if an observer set skipNextObservers to true, then prevent the subsequent ones to execute
  222. * @param eventData defines the data to send to all observers
  223. * @param mask defines the mask of the current notification (observers with incompatible mask (ie mask & observer.mask === 0) will not be notified)
  224. * @param target defines the original target of the state
  225. * @param currentTarget defines the current target of the state
  226. * @returns false if the complete observer chain was not processed (because one observer set the skipNextObservers to true)
  227. */
  228. notifyObservers(eventData: T, mask?: number, target?: any, currentTarget?: any): boolean;
  229. /**
  230. * Calling this will execute each callback, expecting it to be a promise or return a value.
  231. * If at any point in the chain one function fails, the promise will fail and the execution will not continue.
  232. * This is useful when a chain of events (sometimes async events) is needed to initialize a certain object
  233. * and it is crucial that all callbacks will be executed.
  234. * The order of the callbacks is kept, callbacks are not executed parallel.
  235. *
  236. * @param eventData The data to be sent to each callback
  237. * @param mask is used to filter observers defaults to -1
  238. * @param target defines the callback target (see EventState)
  239. * @param currentTarget defines he current object in the bubbling phase
  240. * @returns {Promise<T>} will return a Promise than resolves when all callbacks executed successfully.
  241. */
  242. notifyObserversWithPromise(eventData: T, mask?: number, target?: any, currentTarget?: any): Promise<T>;
  243. /**
  244. * Notify a specific observer
  245. * @param observer defines the observer to notify
  246. * @param eventData defines the data to be sent to each callback
  247. * @param mask is used to filter observers defaults to -1
  248. */
  249. notifyObserver(observer: Observer<T>, eventData: T, mask?: number): void;
  250. /**
  251. * Gets a boolean indicating if the observable has at least one observer
  252. * @returns true is the Observable has at least one Observer registered
  253. */
  254. hasObservers(): boolean;
  255. /**
  256. * Clear the list of observers
  257. */
  258. clear(): void;
  259. /**
  260. * Clone the current observable
  261. * @returns a new observable
  262. */
  263. clone(): Observable<T>;
  264. /**
  265. * Does this observable handles observer registered with a given mask
  266. * @param mask defines the mask to be tested
  267. * @return whether or not one observer registered with the given mask is handeled
  268. **/
  269. hasSpecificMask(mask?: number): boolean;
  270. }
  271. }
  272. declare module "babylonjs/Misc/domManagement" {
  273. /**
  274. * Sets of helpers dealing with the DOM and some of the recurrent functions needed in
  275. * Babylon.js
  276. */
  277. export class DomManagement {
  278. /**
  279. * Checks if the window object exists
  280. * @returns true if the window object exists
  281. */
  282. static IsWindowObjectExist(): boolean;
  283. /**
  284. * Checks if the navigator object exists
  285. * @returns true if the navigator object exists
  286. */
  287. static IsNavigatorAvailable(): boolean;
  288. /**
  289. * Check if the document object exists
  290. * @returns true if the document object exists
  291. */
  292. static IsDocumentAvailable(): boolean;
  293. /**
  294. * Extracts text content from a DOM element hierarchy
  295. * @param element defines the root element
  296. * @returns a string
  297. */
  298. static GetDOMTextContent(element: HTMLElement): string;
  299. }
  300. }
  301. declare module "babylonjs/Misc/logger" {
  302. /**
  303. * Logger used througouht the application to allow configuration of
  304. * the log level required for the messages.
  305. */
  306. export class Logger {
  307. /**
  308. * No log
  309. */
  310. static readonly NoneLogLevel: number;
  311. /**
  312. * Only message logs
  313. */
  314. static readonly MessageLogLevel: number;
  315. /**
  316. * Only warning logs
  317. */
  318. static readonly WarningLogLevel: number;
  319. /**
  320. * Only error logs
  321. */
  322. static readonly ErrorLogLevel: number;
  323. /**
  324. * All logs
  325. */
  326. static readonly AllLogLevel: number;
  327. private static _LogCache;
  328. /**
  329. * Gets a value indicating the number of loading errors
  330. * @ignorenaming
  331. */
  332. static errorsCount: number;
  333. /**
  334. * Callback called when a new log is added
  335. */
  336. static OnNewCacheEntry: (entry: string) => void;
  337. private static _AddLogEntry;
  338. private static _FormatMessage;
  339. private static _LogDisabled;
  340. private static _LogEnabled;
  341. private static _WarnDisabled;
  342. private static _WarnEnabled;
  343. private static _ErrorDisabled;
  344. private static _ErrorEnabled;
  345. /**
  346. * Log a message to the console
  347. */
  348. static Log: (message: string) => void;
  349. /**
  350. * Write a warning message to the console
  351. */
  352. static Warn: (message: string) => void;
  353. /**
  354. * Write an error message to the console
  355. */
  356. static Error: (message: string) => void;
  357. /**
  358. * Gets current log cache (list of logs)
  359. */
  360. static get LogCache(): string;
  361. /**
  362. * Clears the log cache
  363. */
  364. static ClearLogCache(): void;
  365. /**
  366. * Sets the current log level (MessageLogLevel / WarningLogLevel / ErrorLogLevel)
  367. */
  368. static set LogLevels(level: number);
  369. }
  370. }
  371. declare module "babylonjs/Misc/typeStore" {
  372. /** @hidden */
  373. export class _TypeStore {
  374. /** @hidden */
  375. static RegisteredTypes: {
  376. [key: string]: Object;
  377. };
  378. /** @hidden */
  379. static GetClass(fqdn: string): any;
  380. }
  381. }
  382. declare module "babylonjs/Misc/stringTools" {
  383. /**
  384. * Helper to manipulate strings
  385. */
  386. export class StringTools {
  387. /**
  388. * Checks for a matching suffix at the end of a string (for ES5 and lower)
  389. * @param str Source string
  390. * @param suffix Suffix to search for in the source string
  391. * @returns Boolean indicating whether the suffix was found (true) or not (false)
  392. */
  393. static EndsWith(str: string, suffix: string): boolean;
  394. /**
  395. * Checks for a matching suffix at the beginning of a string (for ES5 and lower)
  396. * @param str Source string
  397. * @param suffix Suffix to search for in the source string
  398. * @returns Boolean indicating whether the suffix was found (true) or not (false)
  399. */
  400. static StartsWith(str: string, suffix: string): boolean;
  401. /**
  402. * Decodes a buffer into a string
  403. * @param buffer The buffer to decode
  404. * @returns The decoded string
  405. */
  406. static Decode(buffer: Uint8Array | Uint16Array): string;
  407. /**
  408. * Encode a buffer to a base64 string
  409. * @param buffer defines the buffer to encode
  410. * @returns the encoded string
  411. */
  412. static EncodeArrayBufferToBase64(buffer: ArrayBuffer | ArrayBufferView): string;
  413. /**
  414. * Converts a number to string and pads with preceeding zeroes until it is of specified length.
  415. * @param num the number to convert and pad
  416. * @param length the expected length of the string
  417. * @returns the padded string
  418. */
  419. static PadNumber(num: number, length: number): string;
  420. }
  421. }
  422. declare module "babylonjs/Misc/deepCopier" {
  423. /**
  424. * Class containing a set of static utilities functions for deep copy.
  425. */
  426. export class DeepCopier {
  427. /**
  428. * Tries to copy an object by duplicating every property
  429. * @param source defines the source object
  430. * @param destination defines the target object
  431. * @param doNotCopyList defines a list of properties to avoid
  432. * @param mustCopyList defines a list of properties to copy (even if they start with _)
  433. */
  434. static DeepCopy(source: any, destination: any, doNotCopyList?: string[], mustCopyList?: string[]): void;
  435. }
  436. }
  437. declare module "babylonjs/Misc/precisionDate" {
  438. /**
  439. * Class containing a set of static utilities functions for precision date
  440. */
  441. export class PrecisionDate {
  442. /**
  443. * Gets either window.performance.now() if supported or Date.now() else
  444. */
  445. static get Now(): number;
  446. }
  447. }
  448. declare module "babylonjs/Misc/devTools" {
  449. /** @hidden */
  450. export class _DevTools {
  451. static WarnImport(name: string): string;
  452. }
  453. }
  454. declare module "babylonjs/Misc/interfaces/iWebRequest" {
  455. /**
  456. * Interface used to define the mechanism to get data from the network
  457. */
  458. export interface IWebRequest {
  459. /**
  460. * Returns client's response url
  461. */
  462. responseURL: string;
  463. /**
  464. * Returns client's status
  465. */
  466. status: number;
  467. /**
  468. * Returns client's status as a text
  469. */
  470. statusText: string;
  471. }
  472. }
  473. declare module "babylonjs/Misc/webRequest" {
  474. import { IWebRequest } from "babylonjs/Misc/interfaces/iWebRequest";
  475. import { Nullable } from "babylonjs/types";
  476. /**
  477. * Extended version of XMLHttpRequest with support for customizations (headers, ...)
  478. */
  479. export class WebRequest implements IWebRequest {
  480. private _xhr;
  481. /**
  482. * Custom HTTP Request Headers to be sent with XMLHttpRequests
  483. * i.e. when loading files, where the server/service expects an Authorization header
  484. */
  485. static CustomRequestHeaders: {
  486. [key: string]: string;
  487. };
  488. /**
  489. * Add callback functions in this array to update all the requests before they get sent to the network
  490. */
  491. static CustomRequestModifiers: ((request: XMLHttpRequest, url: string) => void)[];
  492. private _injectCustomRequestHeaders;
  493. /**
  494. * Gets or sets a function to be called when loading progress changes
  495. */
  496. get onprogress(): ((this: XMLHttpRequest, ev: ProgressEvent) => any) | null;
  497. set onprogress(value: ((this: XMLHttpRequest, ev: ProgressEvent) => any) | null);
  498. /**
  499. * Returns client's state
  500. */
  501. get readyState(): number;
  502. /**
  503. * Returns client's status
  504. */
  505. get status(): number;
  506. /**
  507. * Returns client's status as a text
  508. */
  509. get statusText(): string;
  510. /**
  511. * Returns client's response
  512. */
  513. get response(): any;
  514. /**
  515. * Returns client's response url
  516. */
  517. get responseURL(): string;
  518. /**
  519. * Returns client's response as text
  520. */
  521. get responseText(): string;
  522. /**
  523. * Gets or sets the expected response type
  524. */
  525. get responseType(): XMLHttpRequestResponseType;
  526. set responseType(value: XMLHttpRequestResponseType);
  527. /** @hidden */
  528. addEventListener<K extends keyof XMLHttpRequestEventMap>(type: K, listener: (this: XMLHttpRequest, ev: XMLHttpRequestEventMap[K]) => any, options?: boolean | AddEventListenerOptions): void;
  529. /** @hidden */
  530. removeEventListener<K extends keyof XMLHttpRequestEventMap>(type: K, listener: (this: XMLHttpRequest, ev: XMLHttpRequestEventMap[K]) => any, options?: boolean | EventListenerOptions): void;
  531. /**
  532. * Cancels any network activity
  533. */
  534. abort(): void;
  535. /**
  536. * Initiates the request. The optional argument provides the request body. The argument is ignored if request method is GET or HEAD
  537. * @param body defines an optional request body
  538. */
  539. send(body?: Document | BodyInit | null): void;
  540. /**
  541. * Sets the request method, request URL
  542. * @param method defines the method to use (GET, POST, etc..)
  543. * @param url defines the url to connect with
  544. */
  545. open(method: string, url: string): void;
  546. /**
  547. * Sets the value of a request header.
  548. * @param name The name of the header whose value is to be set
  549. * @param value The value to set as the body of the header
  550. */
  551. setRequestHeader(name: string, value: string): void;
  552. /**
  553. * Get the string containing the text of a particular header's value.
  554. * @param name The name of the header
  555. * @returns The string containing the text of the given header name
  556. */
  557. getResponseHeader(name: string): Nullable<string>;
  558. }
  559. }
  560. declare module "babylonjs/Misc/fileRequest" {
  561. import { Observable } from "babylonjs/Misc/observable";
  562. /**
  563. * File request interface
  564. */
  565. export interface IFileRequest {
  566. /**
  567. * Raised when the request is complete (success or error).
  568. */
  569. onCompleteObservable: Observable<IFileRequest>;
  570. /**
  571. * Aborts the request for a file.
  572. */
  573. abort: () => void;
  574. }
  575. }
  576. declare module "babylonjs/Materials/Textures/renderTargetCreationOptions" {
  577. /**
  578. * Define options used to create a render target texture
  579. */
  580. export class RenderTargetCreationOptions {
  581. /**
  582. * Specifies is mipmaps must be generated
  583. */
  584. generateMipMaps?: boolean;
  585. /** Specifies whether or not a depth should be allocated in the texture (true by default) */
  586. generateDepthBuffer?: boolean;
  587. /** Specifies whether or not a stencil should be allocated in the texture (false by default)*/
  588. generateStencilBuffer?: boolean;
  589. /** Defines texture type (int by default) */
  590. type?: number;
  591. /** Defines sampling mode (trilinear by default) */
  592. samplingMode?: number;
  593. /** Defines format (RGBA by default) */
  594. format?: number;
  595. }
  596. }
  597. declare module "babylonjs/Engines/constants" {
  598. /** Defines the cross module used constants to avoid circular dependncies */
  599. export class Constants {
  600. /** Defines that alpha blending is disabled */
  601. static readonly ALPHA_DISABLE: number;
  602. /** Defines that alpha blending is SRC ALPHA * SRC + DEST */
  603. static readonly ALPHA_ADD: number;
  604. /** Defines that alpha blending is SRC ALPHA * SRC + (1 - SRC ALPHA) * DEST */
  605. static readonly ALPHA_COMBINE: number;
  606. /** Defines that alpha blending is DEST - SRC * DEST */
  607. static readonly ALPHA_SUBTRACT: number;
  608. /** Defines that alpha blending is SRC * DEST */
  609. static readonly ALPHA_MULTIPLY: number;
  610. /** Defines that alpha blending is SRC ALPHA * SRC + (1 - SRC) * DEST */
  611. static readonly ALPHA_MAXIMIZED: number;
  612. /** Defines that alpha blending is SRC + DEST */
  613. static readonly ALPHA_ONEONE: number;
  614. /** Defines that alpha blending is SRC + (1 - SRC ALPHA) * DEST */
  615. static readonly ALPHA_PREMULTIPLIED: number;
  616. /**
  617. * Defines that alpha blending is SRC + (1 - SRC ALPHA) * DEST
  618. * Alpha will be set to (1 - SRC ALPHA) * DEST ALPHA
  619. */
  620. static readonly ALPHA_PREMULTIPLIED_PORTERDUFF: number;
  621. /** Defines that alpha blending is CST * SRC + (1 - CST) * DEST */
  622. static readonly ALPHA_INTERPOLATE: number;
  623. /**
  624. * Defines that alpha blending is SRC + (1 - SRC) * DEST
  625. * Alpha will be set to SRC ALPHA + (1 - SRC ALPHA) * DEST ALPHA
  626. */
  627. static readonly ALPHA_SCREENMODE: number;
  628. /**
  629. * Defines that alpha blending is SRC + DST
  630. * Alpha will be set to SRC ALPHA + DST ALPHA
  631. */
  632. static readonly ALPHA_ONEONE_ONEONE: number;
  633. /**
  634. * Defines that alpha blending is SRC * DST ALPHA + DST
  635. * Alpha will be set to 0
  636. */
  637. static readonly ALPHA_ALPHATOCOLOR: number;
  638. /**
  639. * Defines that alpha blending is SRC * (1 - DST) + DST * (1 - SRC)
  640. */
  641. static readonly ALPHA_REVERSEONEMINUS: number;
  642. /**
  643. * Defines that alpha blending is SRC + DST * (1 - SRC ALPHA)
  644. * Alpha will be set to SRC ALPHA + DST ALPHA * (1 - SRC ALPHA)
  645. */
  646. static readonly ALPHA_SRC_DSTONEMINUSSRCALPHA: number;
  647. /**
  648. * Defines that alpha blending is SRC + DST
  649. * Alpha will be set to SRC ALPHA
  650. */
  651. static readonly ALPHA_ONEONE_ONEZERO: number;
  652. /**
  653. * Defines that alpha blending is SRC * (1 - DST) + DST * (1 - SRC)
  654. * Alpha will be set to DST ALPHA
  655. */
  656. static readonly ALPHA_EXCLUSION: number;
  657. /** Defines that alpha blending equation a SUM */
  658. static readonly ALPHA_EQUATION_ADD: number;
  659. /** Defines that alpha blending equation a SUBSTRACTION */
  660. static readonly ALPHA_EQUATION_SUBSTRACT: number;
  661. /** Defines that alpha blending equation a REVERSE SUBSTRACTION */
  662. static readonly ALPHA_EQUATION_REVERSE_SUBTRACT: number;
  663. /** Defines that alpha blending equation a MAX operation */
  664. static readonly ALPHA_EQUATION_MAX: number;
  665. /** Defines that alpha blending equation a MIN operation */
  666. static readonly ALPHA_EQUATION_MIN: number;
  667. /**
  668. * Defines that alpha blending equation a DARKEN operation:
  669. * It takes the min of the src and sums the alpha channels.
  670. */
  671. static readonly ALPHA_EQUATION_DARKEN: number;
  672. /** Defines that the ressource is not delayed*/
  673. static readonly DELAYLOADSTATE_NONE: number;
  674. /** Defines that the ressource was successfully delay loaded */
  675. static readonly DELAYLOADSTATE_LOADED: number;
  676. /** Defines that the ressource is currently delay loading */
  677. static readonly DELAYLOADSTATE_LOADING: number;
  678. /** Defines that the ressource is delayed and has not started loading */
  679. static readonly DELAYLOADSTATE_NOTLOADED: number;
  680. /** Passed to depthFunction or stencilFunction to specify depth or stencil tests will never pass. i.e. Nothing will be drawn */
  681. static readonly NEVER: number;
  682. /** Passed to depthFunction or stencilFunction to specify depth or stencil tests will always pass. i.e. Pixels will be drawn in the order they are drawn */
  683. static readonly ALWAYS: number;
  684. /** Passed to depthFunction or stencilFunction to specify depth or stencil tests will pass if the new depth value is less than the stored value */
  685. static readonly LESS: number;
  686. /** Passed to depthFunction or stencilFunction to specify depth or stencil tests will pass if the new depth value is equals to the stored value */
  687. static readonly EQUAL: number;
  688. /** Passed to depthFunction or stencilFunction to specify depth or stencil tests will pass if the new depth value is less than or equal to the stored value */
  689. static readonly LEQUAL: number;
  690. /** Passed to depthFunction or stencilFunction to specify depth or stencil tests will pass if the new depth value is greater than the stored value */
  691. static readonly GREATER: number;
  692. /** Passed to depthFunction or stencilFunction to specify depth or stencil tests will pass if the new depth value is greater than or equal to the stored value */
  693. static readonly GEQUAL: number;
  694. /** Passed to depthFunction or stencilFunction to specify depth or stencil tests will pass if the new depth value is not equal to the stored value */
  695. static readonly NOTEQUAL: number;
  696. /** Passed to stencilOperation to specify that stencil value must be kept */
  697. static readonly KEEP: number;
  698. /** Passed to stencilOperation to specify that stencil value must be replaced */
  699. static readonly REPLACE: number;
  700. /** Passed to stencilOperation to specify that stencil value must be incremented */
  701. static readonly INCR: number;
  702. /** Passed to stencilOperation to specify that stencil value must be decremented */
  703. static readonly DECR: number;
  704. /** Passed to stencilOperation to specify that stencil value must be inverted */
  705. static readonly INVERT: number;
  706. /** Passed to stencilOperation to specify that stencil value must be incremented with wrapping */
  707. static readonly INCR_WRAP: number;
  708. /** Passed to stencilOperation to specify that stencil value must be decremented with wrapping */
  709. static readonly DECR_WRAP: number;
  710. /** Texture is not repeating outside of 0..1 UVs */
  711. static readonly TEXTURE_CLAMP_ADDRESSMODE: number;
  712. /** Texture is repeating outside of 0..1 UVs */
  713. static readonly TEXTURE_WRAP_ADDRESSMODE: number;
  714. /** Texture is repeating and mirrored */
  715. static readonly TEXTURE_MIRROR_ADDRESSMODE: number;
  716. /** ALPHA */
  717. static readonly TEXTUREFORMAT_ALPHA: number;
  718. /** LUMINANCE */
  719. static readonly TEXTUREFORMAT_LUMINANCE: number;
  720. /** LUMINANCE_ALPHA */
  721. static readonly TEXTUREFORMAT_LUMINANCE_ALPHA: number;
  722. /** RGB */
  723. static readonly TEXTUREFORMAT_RGB: number;
  724. /** RGBA */
  725. static readonly TEXTUREFORMAT_RGBA: number;
  726. /** RED */
  727. static readonly TEXTUREFORMAT_RED: number;
  728. /** RED (2nd reference) */
  729. static readonly TEXTUREFORMAT_R: number;
  730. /** RG */
  731. static readonly TEXTUREFORMAT_RG: number;
  732. /** RED_INTEGER */
  733. static readonly TEXTUREFORMAT_RED_INTEGER: number;
  734. /** RED_INTEGER (2nd reference) */
  735. static readonly TEXTUREFORMAT_R_INTEGER: number;
  736. /** RG_INTEGER */
  737. static readonly TEXTUREFORMAT_RG_INTEGER: number;
  738. /** RGB_INTEGER */
  739. static readonly TEXTUREFORMAT_RGB_INTEGER: number;
  740. /** RGBA_INTEGER */
  741. static readonly TEXTUREFORMAT_RGBA_INTEGER: number;
  742. /** UNSIGNED_BYTE */
  743. static readonly TEXTURETYPE_UNSIGNED_BYTE: number;
  744. /** UNSIGNED_BYTE (2nd reference) */
  745. static readonly TEXTURETYPE_UNSIGNED_INT: number;
  746. /** FLOAT */
  747. static readonly TEXTURETYPE_FLOAT: number;
  748. /** HALF_FLOAT */
  749. static readonly TEXTURETYPE_HALF_FLOAT: number;
  750. /** BYTE */
  751. static readonly TEXTURETYPE_BYTE: number;
  752. /** SHORT */
  753. static readonly TEXTURETYPE_SHORT: number;
  754. /** UNSIGNED_SHORT */
  755. static readonly TEXTURETYPE_UNSIGNED_SHORT: number;
  756. /** INT */
  757. static readonly TEXTURETYPE_INT: number;
  758. /** UNSIGNED_INT */
  759. static readonly TEXTURETYPE_UNSIGNED_INTEGER: number;
  760. /** UNSIGNED_SHORT_4_4_4_4 */
  761. static readonly TEXTURETYPE_UNSIGNED_SHORT_4_4_4_4: number;
  762. /** UNSIGNED_SHORT_5_5_5_1 */
  763. static readonly TEXTURETYPE_UNSIGNED_SHORT_5_5_5_1: number;
  764. /** UNSIGNED_SHORT_5_6_5 */
  765. static readonly TEXTURETYPE_UNSIGNED_SHORT_5_6_5: number;
  766. /** UNSIGNED_INT_2_10_10_10_REV */
  767. static readonly TEXTURETYPE_UNSIGNED_INT_2_10_10_10_REV: number;
  768. /** UNSIGNED_INT_24_8 */
  769. static readonly TEXTURETYPE_UNSIGNED_INT_24_8: number;
  770. /** UNSIGNED_INT_10F_11F_11F_REV */
  771. static readonly TEXTURETYPE_UNSIGNED_INT_10F_11F_11F_REV: number;
  772. /** UNSIGNED_INT_5_9_9_9_REV */
  773. static readonly TEXTURETYPE_UNSIGNED_INT_5_9_9_9_REV: number;
  774. /** FLOAT_32_UNSIGNED_INT_24_8_REV */
  775. static readonly TEXTURETYPE_FLOAT_32_UNSIGNED_INT_24_8_REV: number;
  776. /** nearest is mag = nearest and min = nearest and no mip */
  777. static readonly TEXTURE_NEAREST_SAMPLINGMODE: number;
  778. /** mag = nearest and min = nearest and mip = none */
  779. static readonly TEXTURE_NEAREST_NEAREST: number;
  780. /** Bilinear is mag = linear and min = linear and no mip */
  781. static readonly TEXTURE_BILINEAR_SAMPLINGMODE: number;
  782. /** mag = linear and min = linear and mip = none */
  783. static readonly TEXTURE_LINEAR_LINEAR: number;
  784. /** Trilinear is mag = linear and min = linear and mip = linear */
  785. static readonly TEXTURE_TRILINEAR_SAMPLINGMODE: number;
  786. /** Trilinear is mag = linear and min = linear and mip = linear */
  787. static readonly TEXTURE_LINEAR_LINEAR_MIPLINEAR: number;
  788. /** mag = nearest and min = nearest and mip = nearest */
  789. static readonly TEXTURE_NEAREST_NEAREST_MIPNEAREST: number;
  790. /** mag = nearest and min = linear and mip = nearest */
  791. static readonly TEXTURE_NEAREST_LINEAR_MIPNEAREST: number;
  792. /** mag = nearest and min = linear and mip = linear */
  793. static readonly TEXTURE_NEAREST_LINEAR_MIPLINEAR: number;
  794. /** mag = nearest and min = linear and mip = none */
  795. static readonly TEXTURE_NEAREST_LINEAR: number;
  796. /** nearest is mag = nearest and min = nearest and mip = linear */
  797. static readonly TEXTURE_NEAREST_NEAREST_MIPLINEAR: number;
  798. /** mag = linear and min = nearest and mip = nearest */
  799. static readonly TEXTURE_LINEAR_NEAREST_MIPNEAREST: number;
  800. /** mag = linear and min = nearest and mip = linear */
  801. static readonly TEXTURE_LINEAR_NEAREST_MIPLINEAR: number;
  802. /** Bilinear is mag = linear and min = linear and mip = nearest */
  803. static readonly TEXTURE_LINEAR_LINEAR_MIPNEAREST: number;
  804. /** mag = linear and min = nearest and mip = none */
  805. static readonly TEXTURE_LINEAR_NEAREST: number;
  806. /** Explicit coordinates mode */
  807. static readonly TEXTURE_EXPLICIT_MODE: number;
  808. /** Spherical coordinates mode */
  809. static readonly TEXTURE_SPHERICAL_MODE: number;
  810. /** Planar coordinates mode */
  811. static readonly TEXTURE_PLANAR_MODE: number;
  812. /** Cubic coordinates mode */
  813. static readonly TEXTURE_CUBIC_MODE: number;
  814. /** Projection coordinates mode */
  815. static readonly TEXTURE_PROJECTION_MODE: number;
  816. /** Skybox coordinates mode */
  817. static readonly TEXTURE_SKYBOX_MODE: number;
  818. /** Inverse Cubic coordinates mode */
  819. static readonly TEXTURE_INVCUBIC_MODE: number;
  820. /** Equirectangular coordinates mode */
  821. static readonly TEXTURE_EQUIRECTANGULAR_MODE: number;
  822. /** Equirectangular Fixed coordinates mode */
  823. static readonly TEXTURE_FIXED_EQUIRECTANGULAR_MODE: number;
  824. /** Equirectangular Fixed Mirrored coordinates mode */
  825. static readonly TEXTURE_FIXED_EQUIRECTANGULAR_MIRRORED_MODE: number;
  826. /** Offline (baking) quality for texture filtering */
  827. static readonly TEXTURE_FILTERING_QUALITY_OFFLINE: number;
  828. /** High quality for texture filtering */
  829. static readonly TEXTURE_FILTERING_QUALITY_HIGH: number;
  830. /** Medium quality for texture filtering */
  831. static readonly TEXTURE_FILTERING_QUALITY_MEDIUM: number;
  832. /** Low quality for texture filtering */
  833. static readonly TEXTURE_FILTERING_QUALITY_LOW: number;
  834. /** Defines that texture rescaling will use a floor to find the closer power of 2 size */
  835. static readonly SCALEMODE_FLOOR: number;
  836. /** Defines that texture rescaling will look for the nearest power of 2 size */
  837. static readonly SCALEMODE_NEAREST: number;
  838. /** Defines that texture rescaling will use a ceil to find the closer power of 2 size */
  839. static readonly SCALEMODE_CEILING: number;
  840. /**
  841. * The dirty texture flag value
  842. */
  843. static readonly MATERIAL_TextureDirtyFlag: number;
  844. /**
  845. * The dirty light flag value
  846. */
  847. static readonly MATERIAL_LightDirtyFlag: number;
  848. /**
  849. * The dirty fresnel flag value
  850. */
  851. static readonly MATERIAL_FresnelDirtyFlag: number;
  852. /**
  853. * The dirty attribute flag value
  854. */
  855. static readonly MATERIAL_AttributesDirtyFlag: number;
  856. /**
  857. * The dirty misc flag value
  858. */
  859. static readonly MATERIAL_MiscDirtyFlag: number;
  860. /**
  861. * The all dirty flag value
  862. */
  863. static readonly MATERIAL_AllDirtyFlag: number;
  864. /**
  865. * Returns the triangle fill mode
  866. */
  867. static readonly MATERIAL_TriangleFillMode: number;
  868. /**
  869. * Returns the wireframe mode
  870. */
  871. static readonly MATERIAL_WireFrameFillMode: number;
  872. /**
  873. * Returns the point fill mode
  874. */
  875. static readonly MATERIAL_PointFillMode: number;
  876. /**
  877. * Returns the point list draw mode
  878. */
  879. static readonly MATERIAL_PointListDrawMode: number;
  880. /**
  881. * Returns the line list draw mode
  882. */
  883. static readonly MATERIAL_LineListDrawMode: number;
  884. /**
  885. * Returns the line loop draw mode
  886. */
  887. static readonly MATERIAL_LineLoopDrawMode: number;
  888. /**
  889. * Returns the line strip draw mode
  890. */
  891. static readonly MATERIAL_LineStripDrawMode: number;
  892. /**
  893. * Returns the triangle strip draw mode
  894. */
  895. static readonly MATERIAL_TriangleStripDrawMode: number;
  896. /**
  897. * Returns the triangle fan draw mode
  898. */
  899. static readonly MATERIAL_TriangleFanDrawMode: number;
  900. /**
  901. * Stores the clock-wise side orientation
  902. */
  903. static readonly MATERIAL_ClockWiseSideOrientation: number;
  904. /**
  905. * Stores the counter clock-wise side orientation
  906. */
  907. static readonly MATERIAL_CounterClockWiseSideOrientation: number;
  908. /**
  909. * Nothing
  910. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  911. */
  912. static readonly ACTION_NothingTrigger: number;
  913. /**
  914. * On pick
  915. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  916. */
  917. static readonly ACTION_OnPickTrigger: number;
  918. /**
  919. * On left pick
  920. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  921. */
  922. static readonly ACTION_OnLeftPickTrigger: number;
  923. /**
  924. * On right pick
  925. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  926. */
  927. static readonly ACTION_OnRightPickTrigger: number;
  928. /**
  929. * On center pick
  930. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  931. */
  932. static readonly ACTION_OnCenterPickTrigger: number;
  933. /**
  934. * On pick down
  935. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  936. */
  937. static readonly ACTION_OnPickDownTrigger: number;
  938. /**
  939. * On double pick
  940. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  941. */
  942. static readonly ACTION_OnDoublePickTrigger: number;
  943. /**
  944. * On pick up
  945. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  946. */
  947. static readonly ACTION_OnPickUpTrigger: number;
  948. /**
  949. * On pick out.
  950. * This trigger will only be raised if you also declared a OnPickDown
  951. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  952. */
  953. static readonly ACTION_OnPickOutTrigger: number;
  954. /**
  955. * On long press
  956. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  957. */
  958. static readonly ACTION_OnLongPressTrigger: number;
  959. /**
  960. * On pointer over
  961. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  962. */
  963. static readonly ACTION_OnPointerOverTrigger: number;
  964. /**
  965. * On pointer out
  966. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  967. */
  968. static readonly ACTION_OnPointerOutTrigger: number;
  969. /**
  970. * On every frame
  971. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  972. */
  973. static readonly ACTION_OnEveryFrameTrigger: number;
  974. /**
  975. * On intersection enter
  976. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  977. */
  978. static readonly ACTION_OnIntersectionEnterTrigger: number;
  979. /**
  980. * On intersection exit
  981. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  982. */
  983. static readonly ACTION_OnIntersectionExitTrigger: number;
  984. /**
  985. * On key down
  986. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  987. */
  988. static readonly ACTION_OnKeyDownTrigger: number;
  989. /**
  990. * On key up
  991. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  992. */
  993. static readonly ACTION_OnKeyUpTrigger: number;
  994. /**
  995. * Billboard mode will only apply to Y axis
  996. */
  997. static readonly PARTICLES_BILLBOARDMODE_Y: number;
  998. /**
  999. * Billboard mode will apply to all axes
  1000. */
  1001. static readonly PARTICLES_BILLBOARDMODE_ALL: number;
  1002. /**
  1003. * Special billboard mode where the particle will be biilboard to the camera but rotated to align with direction
  1004. */
  1005. static readonly PARTICLES_BILLBOARDMODE_STRETCHED: number;
  1006. /** Default culling strategy : this is an exclusion test and it's the more accurate.
  1007. * Test order :
  1008. * Is the bounding sphere outside the frustum ?
  1009. * If not, are the bounding box vertices outside the frustum ?
  1010. * It not, then the cullable object is in the frustum.
  1011. */
  1012. static readonly MESHES_CULLINGSTRATEGY_STANDARD: number;
  1013. /** Culling strategy : Bounding Sphere Only.
  1014. * This is an exclusion test. It's faster than the standard strategy because the bounding box is not tested.
  1015. * It's also less accurate than the standard because some not visible objects can still be selected.
  1016. * Test : is the bounding sphere outside the frustum ?
  1017. * If not, then the cullable object is in the frustum.
  1018. */
  1019. static readonly MESHES_CULLINGSTRATEGY_BOUNDINGSPHERE_ONLY: number;
  1020. /** Culling strategy : Optimistic Inclusion.
  1021. * This in an inclusion test first, then the standard exclusion test.
  1022. * This can be faster when a cullable object is expected to be almost always in the camera frustum.
  1023. * This could also be a little slower than the standard test when the tested object center is not the frustum but one of its bounding box vertex is still inside.
  1024. * Anyway, it's as accurate as the standard strategy.
  1025. * Test :
  1026. * Is the cullable object bounding sphere center in the frustum ?
  1027. * If not, apply the default culling strategy.
  1028. */
  1029. static readonly MESHES_CULLINGSTRATEGY_OPTIMISTIC_INCLUSION: number;
  1030. /** Culling strategy : Optimistic Inclusion then Bounding Sphere Only.
  1031. * This in an inclusion test first, then the bounding sphere only exclusion test.
  1032. * This can be the fastest test when a cullable object is expected to be almost always in the camera frustum.
  1033. * This could also be a little slower than the BoundingSphereOnly strategy when the tested object center is not in the frustum but its bounding sphere still intersects it.
  1034. * It's less accurate than the standard strategy and as accurate as the BoundingSphereOnly strategy.
  1035. * Test :
  1036. * Is the cullable object bounding sphere center in the frustum ?
  1037. * If not, apply the Bounding Sphere Only strategy. No Bounding Box is tested here.
  1038. */
  1039. static readonly MESHES_CULLINGSTRATEGY_OPTIMISTIC_INCLUSION_THEN_BSPHERE_ONLY: number;
  1040. /**
  1041. * No logging while loading
  1042. */
  1043. static readonly SCENELOADER_NO_LOGGING: number;
  1044. /**
  1045. * Minimal logging while loading
  1046. */
  1047. static readonly SCENELOADER_MINIMAL_LOGGING: number;
  1048. /**
  1049. * Summary logging while loading
  1050. */
  1051. static readonly SCENELOADER_SUMMARY_LOGGING: number;
  1052. /**
  1053. * Detailled logging while loading
  1054. */
  1055. static readonly SCENELOADER_DETAILED_LOGGING: number;
  1056. /**
  1057. * Prepass texture index for color
  1058. */
  1059. static readonly PREPASS_COLOR_INDEX: number;
  1060. /**
  1061. * Prepass texture index for irradiance
  1062. */
  1063. static readonly PREPASS_IRRADIANCE_INDEX: number;
  1064. /**
  1065. * Prepass texture index for depth + normal
  1066. */
  1067. static readonly PREPASS_DEPTHNORMAL_INDEX: number;
  1068. /**
  1069. * Prepass texture index for albedo
  1070. */
  1071. static readonly PREPASS_ALBEDO_INDEX: number;
  1072. }
  1073. }
  1074. declare module "babylonjs/Materials/Textures/internalTextureLoader" {
  1075. import { Nullable } from "babylonjs/types";
  1076. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  1077. /**
  1078. * This represents the required contract to create a new type of texture loader.
  1079. */
  1080. export interface IInternalTextureLoader {
  1081. /**
  1082. * Defines wether the loader supports cascade loading the different faces.
  1083. */
  1084. supportCascades: boolean;
  1085. /**
  1086. * This returns if the loader support the current file information.
  1087. * @param extension defines the file extension of the file being loaded
  1088. * @param mimeType defines the optional mime type of the file being loaded
  1089. * @returns true if the loader can load the specified file
  1090. */
  1091. canLoad(extension: string, mimeType?: string): boolean;
  1092. /**
  1093. * Uploads the cube texture data to the WebGL texture. It has already been bound.
  1094. * @param data contains the texture data
  1095. * @param texture defines the BabylonJS internal texture
  1096. * @param createPolynomials will be true if polynomials have been requested
  1097. * @param onLoad defines the callback to trigger once the texture is ready
  1098. * @param onError defines the callback to trigger in case of error
  1099. */
  1100. loadCubeData(data: ArrayBufferView | ArrayBufferView[], texture: InternalTexture, createPolynomials: boolean, onLoad: Nullable<(data?: any) => void>, onError: Nullable<(message?: string, exception?: any) => void>): void;
  1101. /**
  1102. * Uploads the 2D texture data to the WebGL texture. It has already been bound once in the callback.
  1103. * @param data contains the texture data
  1104. * @param texture defines the BabylonJS internal texture
  1105. * @param callback defines the method to call once ready to upload
  1106. */
  1107. loadData(data: ArrayBufferView, texture: InternalTexture, callback: (width: number, height: number, loadMipmap: boolean, isCompressed: boolean, done: () => void, loadFailed?: boolean) => void): void;
  1108. }
  1109. }
  1110. declare module "babylonjs/Engines/IPipelineContext" {
  1111. /**
  1112. * Class used to store and describe the pipeline context associated with an effect
  1113. */
  1114. export interface IPipelineContext {
  1115. /**
  1116. * Gets a boolean indicating that this pipeline context is supporting asynchronous creating
  1117. */
  1118. isAsync: boolean;
  1119. /**
  1120. * Gets a boolean indicating that the context is ready to be used (like shaders / pipelines are compiled and ready for instance)
  1121. */
  1122. isReady: boolean;
  1123. /** @hidden */
  1124. _getVertexShaderCode(): string | null;
  1125. /** @hidden */
  1126. _getFragmentShaderCode(): string | null;
  1127. /** @hidden */
  1128. _handlesSpectorRebuildCallback(onCompiled: (compiledObject: any) => void): void;
  1129. }
  1130. }
  1131. declare module "babylonjs/Meshes/dataBuffer" {
  1132. /**
  1133. * Class used to store gfx data (like WebGLBuffer)
  1134. */
  1135. export class DataBuffer {
  1136. /**
  1137. * Gets or sets the number of objects referencing this buffer
  1138. */
  1139. references: number;
  1140. /** Gets or sets the size of the underlying buffer */
  1141. capacity: number;
  1142. /**
  1143. * Gets or sets a boolean indicating if the buffer contains 32bits indices
  1144. */
  1145. is32Bits: boolean;
  1146. /**
  1147. * Gets the underlying buffer
  1148. */
  1149. get underlyingResource(): any;
  1150. }
  1151. }
  1152. declare module "babylonjs/Engines/Processors/iShaderProcessor" {
  1153. /** @hidden */
  1154. export interface IShaderProcessor {
  1155. attributeProcessor?: (attribute: string) => string;
  1156. varyingProcessor?: (varying: string, isFragment: boolean) => string;
  1157. uniformProcessor?: (uniform: string, isFragment: boolean) => string;
  1158. uniformBufferProcessor?: (uniformBuffer: string, isFragment: boolean) => string;
  1159. endOfUniformBufferProcessor?: (closingBracketLine: string, isFragment: boolean) => string;
  1160. lineProcessor?: (line: string, isFragment: boolean) => string;
  1161. preProcessor?: (code: string, defines: string[], isFragment: boolean) => string;
  1162. postProcessor?: (code: string, defines: string[], isFragment: boolean) => string;
  1163. }
  1164. }
  1165. declare module "babylonjs/Engines/Processors/shaderProcessingOptions" {
  1166. import { IShaderProcessor } from "babylonjs/Engines/Processors/iShaderProcessor";
  1167. /** @hidden */
  1168. export interface ProcessingOptions {
  1169. defines: string[];
  1170. indexParameters: any;
  1171. isFragment: boolean;
  1172. shouldUseHighPrecisionShader: boolean;
  1173. supportsUniformBuffers: boolean;
  1174. shadersRepository: string;
  1175. includesShadersStore: {
  1176. [key: string]: string;
  1177. };
  1178. processor?: IShaderProcessor;
  1179. version: string;
  1180. platformName: string;
  1181. lookForClosingBracketForUniformBuffer?: boolean;
  1182. }
  1183. }
  1184. declare module "babylonjs/Engines/Processors/shaderCodeNode" {
  1185. import { ProcessingOptions } from "babylonjs/Engines/Processors/shaderProcessingOptions";
  1186. /** @hidden */
  1187. export class ShaderCodeNode {
  1188. line: string;
  1189. children: ShaderCodeNode[];
  1190. additionalDefineKey?: string;
  1191. additionalDefineValue?: string;
  1192. isValid(preprocessors: {
  1193. [key: string]: string;
  1194. }): boolean;
  1195. process(preprocessors: {
  1196. [key: string]: string;
  1197. }, options: ProcessingOptions): string;
  1198. }
  1199. }
  1200. declare module "babylonjs/Engines/Processors/shaderCodeCursor" {
  1201. /** @hidden */
  1202. export class ShaderCodeCursor {
  1203. private _lines;
  1204. lineIndex: number;
  1205. get currentLine(): string;
  1206. get canRead(): boolean;
  1207. set lines(value: string[]);
  1208. }
  1209. }
  1210. declare module "babylonjs/Engines/Processors/shaderCodeConditionNode" {
  1211. import { ShaderCodeNode } from "babylonjs/Engines/Processors/shaderCodeNode";
  1212. import { ProcessingOptions } from "babylonjs/Engines/Processors/shaderProcessingOptions";
  1213. /** @hidden */
  1214. export class ShaderCodeConditionNode extends ShaderCodeNode {
  1215. process(preprocessors: {
  1216. [key: string]: string;
  1217. }, options: ProcessingOptions): string;
  1218. }
  1219. }
  1220. declare module "babylonjs/Engines/Processors/Expressions/shaderDefineExpression" {
  1221. /** @hidden */
  1222. export class ShaderDefineExpression {
  1223. isTrue(preprocessors: {
  1224. [key: string]: string;
  1225. }): boolean;
  1226. private static _OperatorPriority;
  1227. private static _Stack;
  1228. static postfixToInfix(postfix: string[]): string;
  1229. static infixToPostfix(infix: string): string[];
  1230. }
  1231. }
  1232. declare module "babylonjs/Engines/Processors/shaderCodeTestNode" {
  1233. import { ShaderCodeNode } from "babylonjs/Engines/Processors/shaderCodeNode";
  1234. import { ShaderDefineExpression } from "babylonjs/Engines/Processors/Expressions/shaderDefineExpression";
  1235. /** @hidden */
  1236. export class ShaderCodeTestNode extends ShaderCodeNode {
  1237. testExpression: ShaderDefineExpression;
  1238. isValid(preprocessors: {
  1239. [key: string]: string;
  1240. }): boolean;
  1241. }
  1242. }
  1243. declare module "babylonjs/Engines/Processors/Expressions/Operators/shaderDefineIsDefinedOperator" {
  1244. import { ShaderDefineExpression } from "babylonjs/Engines/Processors/Expressions/shaderDefineExpression";
  1245. /** @hidden */
  1246. export class ShaderDefineIsDefinedOperator extends ShaderDefineExpression {
  1247. define: string;
  1248. not: boolean;
  1249. constructor(define: string, not?: boolean);
  1250. isTrue(preprocessors: {
  1251. [key: string]: string;
  1252. }): boolean;
  1253. }
  1254. }
  1255. declare module "babylonjs/Engines/Processors/Expressions/Operators/shaderDefineOrOperator" {
  1256. import { ShaderDefineExpression } from "babylonjs/Engines/Processors/Expressions/shaderDefineExpression";
  1257. /** @hidden */
  1258. export class ShaderDefineOrOperator extends ShaderDefineExpression {
  1259. leftOperand: ShaderDefineExpression;
  1260. rightOperand: ShaderDefineExpression;
  1261. isTrue(preprocessors: {
  1262. [key: string]: string;
  1263. }): boolean;
  1264. }
  1265. }
  1266. declare module "babylonjs/Engines/Processors/Expressions/Operators/shaderDefineAndOperator" {
  1267. import { ShaderDefineExpression } from "babylonjs/Engines/Processors/Expressions/shaderDefineExpression";
  1268. /** @hidden */
  1269. export class ShaderDefineAndOperator extends ShaderDefineExpression {
  1270. leftOperand: ShaderDefineExpression;
  1271. rightOperand: ShaderDefineExpression;
  1272. isTrue(preprocessors: {
  1273. [key: string]: string;
  1274. }): boolean;
  1275. }
  1276. }
  1277. declare module "babylonjs/Engines/Processors/Expressions/Operators/shaderDefineArithmeticOperator" {
  1278. import { ShaderDefineExpression } from "babylonjs/Engines/Processors/Expressions/shaderDefineExpression";
  1279. /** @hidden */
  1280. export class ShaderDefineArithmeticOperator extends ShaderDefineExpression {
  1281. define: string;
  1282. operand: string;
  1283. testValue: string;
  1284. constructor(define: string, operand: string, testValue: string);
  1285. isTrue(preprocessors: {
  1286. [key: string]: string;
  1287. }): boolean;
  1288. }
  1289. }
  1290. declare module "babylonjs/Offline/IOfflineProvider" {
  1291. /**
  1292. * Class used to enable access to offline support
  1293. * @see https://doc.babylonjs.com/how_to/caching_resources_in_indexeddb
  1294. */
  1295. export interface IOfflineProvider {
  1296. /**
  1297. * Gets a boolean indicating if scene must be saved in the database
  1298. */
  1299. enableSceneOffline: boolean;
  1300. /**
  1301. * Gets a boolean indicating if textures must be saved in the database
  1302. */
  1303. enableTexturesOffline: boolean;
  1304. /**
  1305. * Open the offline support and make it available
  1306. * @param successCallback defines the callback to call on success
  1307. * @param errorCallback defines the callback to call on error
  1308. */
  1309. open(successCallback: () => void, errorCallback: () => void): void;
  1310. /**
  1311. * Loads an image from the offline support
  1312. * @param url defines the url to load from
  1313. * @param image defines the target DOM image
  1314. */
  1315. loadImage(url: string, image: HTMLImageElement): void;
  1316. /**
  1317. * Loads a file from offline support
  1318. * @param url defines the URL to load from
  1319. * @param sceneLoaded defines a callback to call on success
  1320. * @param progressCallBack defines a callback to call when progress changed
  1321. * @param errorCallback defines a callback to call on error
  1322. * @param useArrayBuffer defines a boolean to use array buffer instead of text string
  1323. */
  1324. loadFile(url: string, sceneLoaded: (data: any) => void, progressCallBack?: (data: any) => void, errorCallback?: () => void, useArrayBuffer?: boolean): void;
  1325. }
  1326. }
  1327. declare module "babylonjs/Misc/filesInputStore" {
  1328. /**
  1329. * Class used to help managing file picking and drag'n'drop
  1330. * File Storage
  1331. */
  1332. export class FilesInputStore {
  1333. /**
  1334. * List of files ready to be loaded
  1335. */
  1336. static FilesToLoad: {
  1337. [key: string]: File;
  1338. };
  1339. }
  1340. }
  1341. declare module "babylonjs/Misc/retryStrategy" {
  1342. import { WebRequest } from "babylonjs/Misc/webRequest";
  1343. /**
  1344. * Class used to define a retry strategy when error happens while loading assets
  1345. */
  1346. export class RetryStrategy {
  1347. /**
  1348. * Function used to defines an exponential back off strategy
  1349. * @param maxRetries defines the maximum number of retries (3 by default)
  1350. * @param baseInterval defines the interval between retries
  1351. * @returns the strategy function to use
  1352. */
  1353. static ExponentialBackoff(maxRetries?: number, baseInterval?: number): (url: string, request: WebRequest, retryIndex: number) => number;
  1354. }
  1355. }
  1356. declare module "babylonjs/Misc/baseError" {
  1357. /**
  1358. * @ignore
  1359. * Application error to support additional information when loading a file
  1360. */
  1361. export abstract class BaseError extends Error {
  1362. protected static _setPrototypeOf: (o: any, proto: object | null) => any;
  1363. }
  1364. }
  1365. declare module "babylonjs/Misc/fileTools" {
  1366. import { WebRequest } from "babylonjs/Misc/webRequest";
  1367. import { Nullable } from "babylonjs/types";
  1368. import { IOfflineProvider } from "babylonjs/Offline/IOfflineProvider";
  1369. import { IFileRequest } from "babylonjs/Misc/fileRequest";
  1370. import { BaseError } from "babylonjs/Misc/baseError";
  1371. /** @ignore */
  1372. export class LoadFileError extends BaseError {
  1373. request?: WebRequest;
  1374. file?: File;
  1375. /**
  1376. * Creates a new LoadFileError
  1377. * @param message defines the message of the error
  1378. * @param request defines the optional web request
  1379. * @param file defines the optional file
  1380. */
  1381. constructor(message: string, object?: WebRequest | File);
  1382. }
  1383. /** @ignore */
  1384. export class RequestFileError extends BaseError {
  1385. request: WebRequest;
  1386. /**
  1387. * Creates a new LoadFileError
  1388. * @param message defines the message of the error
  1389. * @param request defines the optional web request
  1390. */
  1391. constructor(message: string, request: WebRequest);
  1392. }
  1393. /** @ignore */
  1394. export class ReadFileError extends BaseError {
  1395. file: File;
  1396. /**
  1397. * Creates a new ReadFileError
  1398. * @param message defines the message of the error
  1399. * @param file defines the optional file
  1400. */
  1401. constructor(message: string, file: File);
  1402. }
  1403. /**
  1404. * @hidden
  1405. */
  1406. export class FileTools {
  1407. /**
  1408. * Gets or sets the retry strategy to apply when an error happens while loading an asset
  1409. */
  1410. static DefaultRetryStrategy: (url: string, request: WebRequest, retryIndex: number) => number;
  1411. /**
  1412. * Gets or sets the base URL to use to load assets
  1413. */
  1414. static BaseUrl: string;
  1415. /**
  1416. * Default behaviour for cors in the application.
  1417. * It can be a string if the expected behavior is identical in the entire app.
  1418. * Or a callback to be able to set it per url or on a group of them (in case of Video source for instance)
  1419. */
  1420. static CorsBehavior: string | ((url: string | string[]) => string);
  1421. /**
  1422. * Gets or sets a function used to pre-process url before using them to load assets
  1423. */
  1424. static PreprocessUrl: (url: string) => string;
  1425. /**
  1426. * Removes unwanted characters from an url
  1427. * @param url defines the url to clean
  1428. * @returns the cleaned url
  1429. */
  1430. private static _CleanUrl;
  1431. /**
  1432. * Sets the cors behavior on a dom element. This will add the required Tools.CorsBehavior to the element.
  1433. * @param url define the url we are trying
  1434. * @param element define the dom element where to configure the cors policy
  1435. */
  1436. static SetCorsBehavior(url: string | string[], element: {
  1437. crossOrigin: string | null;
  1438. }): void;
  1439. /**
  1440. * Loads an image as an HTMLImageElement.
  1441. * @param input url string, ArrayBuffer, or Blob to load
  1442. * @param onLoad callback called when the image successfully loads
  1443. * @param onError callback called when the image fails to load
  1444. * @param offlineProvider offline provider for caching
  1445. * @param mimeType optional mime type
  1446. * @returns the HTMLImageElement of the loaded image
  1447. */
  1448. static LoadImage(input: string | ArrayBuffer | ArrayBufferView | Blob, onLoad: (img: HTMLImageElement | ImageBitmap) => void, onError: (message?: string, exception?: any) => void, offlineProvider: Nullable<IOfflineProvider>, mimeType?: string): Nullable<HTMLImageElement>;
  1449. /**
  1450. * Reads a file from a File object
  1451. * @param file defines the file to load
  1452. * @param onSuccess defines the callback to call when data is loaded
  1453. * @param onProgress defines the callback to call during loading process
  1454. * @param useArrayBuffer defines a boolean indicating that data must be returned as an ArrayBuffer
  1455. * @param onError defines the callback to call when an error occurs
  1456. * @returns a file request object
  1457. */
  1458. static ReadFile(file: File, onSuccess: (data: any) => void, onProgress?: (ev: ProgressEvent) => any, useArrayBuffer?: boolean, onError?: (error: ReadFileError) => void): IFileRequest;
  1459. /**
  1460. * Loads a file from a url
  1461. * @param url url to load
  1462. * @param onSuccess callback called when the file successfully loads
  1463. * @param onProgress callback called while file is loading (if the server supports this mode)
  1464. * @param offlineProvider defines the offline provider for caching
  1465. * @param useArrayBuffer defines a boolean indicating that date must be returned as ArrayBuffer
  1466. * @param onError callback called when the file fails to load
  1467. * @returns a file request object
  1468. */
  1469. static LoadFile(url: string, onSuccess: (data: string | ArrayBuffer, responseURL?: string) => void, onProgress?: (ev: ProgressEvent) => void, offlineProvider?: IOfflineProvider, useArrayBuffer?: boolean, onError?: (request?: WebRequest, exception?: LoadFileError) => void): IFileRequest;
  1470. /**
  1471. * Loads a file
  1472. * @param url url to load
  1473. * @param onSuccess callback called when the file successfully loads
  1474. * @param onProgress callback called while file is loading (if the server supports this mode)
  1475. * @param useArrayBuffer defines a boolean indicating that date must be returned as ArrayBuffer
  1476. * @param onError callback called when the file fails to load
  1477. * @param onOpened callback called when the web request is opened
  1478. * @returns a file request object
  1479. */
  1480. static RequestFile(url: string, onSuccess: (data: string | ArrayBuffer, request?: WebRequest) => void, onProgress?: (event: ProgressEvent) => void, offlineProvider?: IOfflineProvider, useArrayBuffer?: boolean, onError?: (error: RequestFileError) => void, onOpened?: (request: WebRequest) => void): IFileRequest;
  1481. /**
  1482. * Checks if the loaded document was accessed via `file:`-Protocol.
  1483. * @returns boolean
  1484. */
  1485. static IsFileURL(): boolean;
  1486. }
  1487. }
  1488. declare module "babylonjs/Engines/Processors/shaderProcessor" {
  1489. import { ProcessingOptions } from "babylonjs/Engines/Processors/shaderProcessingOptions";
  1490. import { WebRequest } from "babylonjs/Misc/webRequest";
  1491. import { LoadFileError } from "babylonjs/Misc/fileTools";
  1492. import { IOfflineProvider } from "babylonjs/Offline/IOfflineProvider";
  1493. import { IFileRequest } from "babylonjs/Misc/fileRequest";
  1494. /** @hidden */
  1495. export class ShaderProcessor {
  1496. static Process(sourceCode: string, options: ProcessingOptions, callback: (migratedCode: string) => void): void;
  1497. private static _ProcessPrecision;
  1498. private static _ExtractOperation;
  1499. private static _BuildSubExpression;
  1500. private static _BuildExpression;
  1501. private static _MoveCursorWithinIf;
  1502. private static _MoveCursor;
  1503. private static _EvaluatePreProcessors;
  1504. private static _PreparePreProcessors;
  1505. private static _ProcessShaderConversion;
  1506. private static _ProcessIncludes;
  1507. /**
  1508. * Loads a file from a url
  1509. * @param url url to load
  1510. * @param onSuccess callback called when the file successfully loads
  1511. * @param onProgress callback called while file is loading (if the server supports this mode)
  1512. * @param offlineProvider defines the offline provider for caching
  1513. * @param useArrayBuffer defines a boolean indicating that date must be returned as ArrayBuffer
  1514. * @param onError callback called when the file fails to load
  1515. * @returns a file request object
  1516. * @hidden
  1517. */
  1518. static _FileToolsLoadFile(url: string, onSuccess: (data: string | ArrayBuffer, responseURL?: string) => void, onProgress?: (ev: ProgressEvent) => void, offlineProvider?: IOfflineProvider, useArrayBuffer?: boolean, onError?: (request?: WebRequest, exception?: LoadFileError) => void): IFileRequest;
  1519. }
  1520. }
  1521. declare module "babylonjs/Maths/math.like" {
  1522. import { float, int, DeepImmutable } from "babylonjs/types";
  1523. /**
  1524. * @hidden
  1525. */
  1526. export interface IColor4Like {
  1527. r: float;
  1528. g: float;
  1529. b: float;
  1530. a: float;
  1531. }
  1532. /**
  1533. * @hidden
  1534. */
  1535. export interface IColor3Like {
  1536. r: float;
  1537. g: float;
  1538. b: float;
  1539. }
  1540. /**
  1541. * @hidden
  1542. */
  1543. export interface IVector4Like {
  1544. x: float;
  1545. y: float;
  1546. z: float;
  1547. w: float;
  1548. }
  1549. /**
  1550. * @hidden
  1551. */
  1552. export interface IVector3Like {
  1553. x: float;
  1554. y: float;
  1555. z: float;
  1556. }
  1557. /**
  1558. * @hidden
  1559. */
  1560. export interface IVector2Like {
  1561. x: float;
  1562. y: float;
  1563. }
  1564. /**
  1565. * @hidden
  1566. */
  1567. export interface IMatrixLike {
  1568. toArray(): DeepImmutable<Float32Array | Array<number>>;
  1569. updateFlag: int;
  1570. }
  1571. /**
  1572. * @hidden
  1573. */
  1574. export interface IViewportLike {
  1575. x: float;
  1576. y: float;
  1577. width: float;
  1578. height: float;
  1579. }
  1580. /**
  1581. * @hidden
  1582. */
  1583. export interface IPlaneLike {
  1584. normal: IVector3Like;
  1585. d: float;
  1586. normalize(): void;
  1587. }
  1588. }
  1589. declare module "babylonjs/Materials/iEffectFallbacks" {
  1590. import { Effect } from "babylonjs/Materials/effect";
  1591. /**
  1592. * Interface used to define common properties for effect fallbacks
  1593. */
  1594. export interface IEffectFallbacks {
  1595. /**
  1596. * Removes the defines that should be removed when falling back.
  1597. * @param currentDefines defines the current define statements for the shader.
  1598. * @param effect defines the current effect we try to compile
  1599. * @returns The resulting defines with defines of the current rank removed.
  1600. */
  1601. reduce(currentDefines: string, effect: Effect): string;
  1602. /**
  1603. * Removes the fallback from the bound mesh.
  1604. */
  1605. unBindMesh(): void;
  1606. /**
  1607. * Checks to see if more fallbacks are still availible.
  1608. */
  1609. hasMoreFallbacks: boolean;
  1610. }
  1611. }
  1612. declare module "babylonjs/Misc/andOrNotEvaluator" {
  1613. /**
  1614. * Class used to evalaute queries containing `and` and `or` operators
  1615. */
  1616. export class AndOrNotEvaluator {
  1617. /**
  1618. * Evaluate a query
  1619. * @param query defines the query to evaluate
  1620. * @param evaluateCallback defines the callback used to filter result
  1621. * @returns true if the query matches
  1622. */
  1623. static Eval(query: string, evaluateCallback: (val: any) => boolean): boolean;
  1624. private static _HandleParenthesisContent;
  1625. private static _SimplifyNegation;
  1626. }
  1627. }
  1628. declare module "babylonjs/Misc/tags" {
  1629. /**
  1630. * Class used to store custom tags
  1631. */
  1632. export class Tags {
  1633. /**
  1634. * Adds support for tags on the given object
  1635. * @param obj defines the object to use
  1636. */
  1637. static EnableFor(obj: any): void;
  1638. /**
  1639. * Removes tags support
  1640. * @param obj defines the object to use
  1641. */
  1642. static DisableFor(obj: any): void;
  1643. /**
  1644. * Gets a boolean indicating if the given object has tags
  1645. * @param obj defines the object to use
  1646. * @returns a boolean
  1647. */
  1648. static HasTags(obj: any): boolean;
  1649. /**
  1650. * Gets the tags available on a given object
  1651. * @param obj defines the object to use
  1652. * @param asString defines if the tags must be returned as a string instead of an array of strings
  1653. * @returns the tags
  1654. */
  1655. static GetTags(obj: any, asString?: boolean): any;
  1656. /**
  1657. * Adds tags to an object
  1658. * @param obj defines the object to use
  1659. * @param tagsString defines the tag string. The tags 'true' and 'false' are reserved and cannot be used as tags.
  1660. * A tag cannot start with '||', '&&', and '!'. It cannot contain whitespaces
  1661. */
  1662. static AddTagsTo(obj: any, tagsString: string): void;
  1663. /**
  1664. * @hidden
  1665. */
  1666. static _AddTagTo(obj: any, tag: string): void;
  1667. /**
  1668. * Removes specific tags from a specific object
  1669. * @param obj defines the object to use
  1670. * @param tagsString defines the tags to remove
  1671. */
  1672. static RemoveTagsFrom(obj: any, tagsString: string): void;
  1673. /**
  1674. * @hidden
  1675. */
  1676. static _RemoveTagFrom(obj: any, tag: string): void;
  1677. /**
  1678. * Defines if tags hosted on an object match a given query
  1679. * @param obj defines the object to use
  1680. * @param tagsQuery defines the tag query
  1681. * @returns a boolean
  1682. */
  1683. static MatchesQuery(obj: any, tagsQuery: string): boolean;
  1684. }
  1685. }
  1686. declare module "babylonjs/Maths/math.scalar" {
  1687. /**
  1688. * Scalar computation library
  1689. */
  1690. export class Scalar {
  1691. /**
  1692. * Two pi constants convenient for computation.
  1693. */
  1694. static TwoPi: number;
  1695. /**
  1696. * Boolean : true if the absolute difference between a and b is lower than epsilon (default = 1.401298E-45)
  1697. * @param a number
  1698. * @param b number
  1699. * @param epsilon (default = 1.401298E-45)
  1700. * @returns true if the absolute difference between a and b is lower than epsilon (default = 1.401298E-45)
  1701. */
  1702. static WithinEpsilon(a: number, b: number, epsilon?: number): boolean;
  1703. /**
  1704. * Returns a string : the upper case translation of the number i to hexadecimal.
  1705. * @param i number
  1706. * @returns the upper case translation of the number i to hexadecimal.
  1707. */
  1708. static ToHex(i: number): string;
  1709. /**
  1710. * Returns -1 if value is negative and +1 is value is positive.
  1711. * @param value the value
  1712. * @returns the value itself if it's equal to zero.
  1713. */
  1714. static Sign(value: number): number;
  1715. /**
  1716. * Returns the value itself if it's between min and max.
  1717. * Returns min if the value is lower than min.
  1718. * Returns max if the value is greater than max.
  1719. * @param value the value to clmap
  1720. * @param min the min value to clamp to (default: 0)
  1721. * @param max the max value to clamp to (default: 1)
  1722. * @returns the clamped value
  1723. */
  1724. static Clamp(value: number, min?: number, max?: number): number;
  1725. /**
  1726. * the log2 of value.
  1727. * @param value the value to compute log2 of
  1728. * @returns the log2 of value.
  1729. */
  1730. static Log2(value: number): number;
  1731. /**
  1732. * Loops the value, so that it is never larger than length and never smaller than 0.
  1733. *
  1734. * This is similar to the modulo operator but it works with floating point numbers.
  1735. * For example, using 3.0 for t and 2.5 for length, the result would be 0.5.
  1736. * With t = 5 and length = 2.5, the result would be 0.0.
  1737. * Note, however, that the behaviour is not defined for negative numbers as it is for the modulo operator
  1738. * @param value the value
  1739. * @param length the length
  1740. * @returns the looped value
  1741. */
  1742. static Repeat(value: number, length: number): number;
  1743. /**
  1744. * Normalize the value between 0.0 and 1.0 using min and max values
  1745. * @param value value to normalize
  1746. * @param min max to normalize between
  1747. * @param max min to normalize between
  1748. * @returns the normalized value
  1749. */
  1750. static Normalize(value: number, min: number, max: number): number;
  1751. /**
  1752. * Denormalize the value from 0.0 and 1.0 using min and max values
  1753. * @param normalized value to denormalize
  1754. * @param min max to denormalize between
  1755. * @param max min to denormalize between
  1756. * @returns the denormalized value
  1757. */
  1758. static Denormalize(normalized: number, min: number, max: number): number;
  1759. /**
  1760. * Calculates the shortest difference between two given angles given in degrees.
  1761. * @param current current angle in degrees
  1762. * @param target target angle in degrees
  1763. * @returns the delta
  1764. */
  1765. static DeltaAngle(current: number, target: number): number;
  1766. /**
  1767. * PingPongs the value t, so that it is never larger than length and never smaller than 0.
  1768. * @param tx value
  1769. * @param length length
  1770. * @returns The returned value will move back and forth between 0 and length
  1771. */
  1772. static PingPong(tx: number, length: number): number;
  1773. /**
  1774. * Interpolates between min and max with smoothing at the limits.
  1775. *
  1776. * This function interpolates between min and max in a similar way to Lerp. However, the interpolation will gradually speed up
  1777. * from the start and slow down toward the end. This is useful for creating natural-looking animation, fading and other transitions.
  1778. * @param from from
  1779. * @param to to
  1780. * @param tx value
  1781. * @returns the smooth stepped value
  1782. */
  1783. static SmoothStep(from: number, to: number, tx: number): number;
  1784. /**
  1785. * Moves a value current towards target.
  1786. *
  1787. * This is essentially the same as Mathf.Lerp but instead the function will ensure that the speed never exceeds maxDelta.
  1788. * Negative values of maxDelta pushes the value away from target.
  1789. * @param current current value
  1790. * @param target target value
  1791. * @param maxDelta max distance to move
  1792. * @returns resulting value
  1793. */
  1794. static MoveTowards(current: number, target: number, maxDelta: number): number;
  1795. /**
  1796. * Same as MoveTowards but makes sure the values interpolate correctly when they wrap around 360 degrees.
  1797. *
  1798. * Variables current and target are assumed to be in degrees. For optimization reasons, negative values of maxDelta
  1799. * are not supported and may cause oscillation. To push current away from a target angle, add 180 to that angle instead.
  1800. * @param current current value
  1801. * @param target target value
  1802. * @param maxDelta max distance to move
  1803. * @returns resulting angle
  1804. */
  1805. static MoveTowardsAngle(current: number, target: number, maxDelta: number): number;
  1806. /**
  1807. * Creates a new scalar with values linearly interpolated of "amount" between the start scalar and the end scalar.
  1808. * @param start start value
  1809. * @param end target value
  1810. * @param amount amount to lerp between
  1811. * @returns the lerped value
  1812. */
  1813. static Lerp(start: number, end: number, amount: number): number;
  1814. /**
  1815. * Same as Lerp but makes sure the values interpolate correctly when they wrap around 360 degrees.
  1816. * The parameter t is clamped to the range [0, 1]. Variables a and b are assumed to be in degrees.
  1817. * @param start start value
  1818. * @param end target value
  1819. * @param amount amount to lerp between
  1820. * @returns the lerped value
  1821. */
  1822. static LerpAngle(start: number, end: number, amount: number): number;
  1823. /**
  1824. * Calculates the linear parameter t that produces the interpolant value within the range [a, b].
  1825. * @param a start value
  1826. * @param b target value
  1827. * @param value value between a and b
  1828. * @returns the inverseLerp value
  1829. */
  1830. static InverseLerp(a: number, b: number, value: number): number;
  1831. /**
  1832. * Returns a new scalar located for "amount" (float) on the Hermite spline defined by the scalars "value1", "value3", "tangent1", "tangent2".
  1833. * @see http://mathworld.wolfram.com/HermitePolynomial.html
  1834. * @param value1 spline value
  1835. * @param tangent1 spline value
  1836. * @param value2 spline value
  1837. * @param tangent2 spline value
  1838. * @param amount input value
  1839. * @returns hermite result
  1840. */
  1841. static Hermite(value1: number, tangent1: number, value2: number, tangent2: number, amount: number): number;
  1842. /**
  1843. * Returns a random float number between and min and max values
  1844. * @param min min value of random
  1845. * @param max max value of random
  1846. * @returns random value
  1847. */
  1848. static RandomRange(min: number, max: number): number;
  1849. /**
  1850. * This function returns percentage of a number in a given range.
  1851. *
  1852. * RangeToPercent(40,20,60) will return 0.5 (50%)
  1853. * RangeToPercent(34,0,100) will return 0.34 (34%)
  1854. * @param number to convert to percentage
  1855. * @param min min range
  1856. * @param max max range
  1857. * @returns the percentage
  1858. */
  1859. static RangeToPercent(number: number, min: number, max: number): number;
  1860. /**
  1861. * This function returns number that corresponds to the percentage in a given range.
  1862. *
  1863. * PercentToRange(0.34,0,100) will return 34.
  1864. * @param percent to convert to number
  1865. * @param min min range
  1866. * @param max max range
  1867. * @returns the number
  1868. */
  1869. static PercentToRange(percent: number, min: number, max: number): number;
  1870. /**
  1871. * Returns the angle converted to equivalent value between -Math.PI and Math.PI radians.
  1872. * @param angle The angle to normalize in radian.
  1873. * @return The converted angle.
  1874. */
  1875. static NormalizeRadians(angle: number): number;
  1876. }
  1877. }
  1878. declare module "babylonjs/Maths/math.constants" {
  1879. /**
  1880. * Constant used to convert a value to gamma space
  1881. * @ignorenaming
  1882. */
  1883. export const ToGammaSpace: number;
  1884. /**
  1885. * Constant used to convert a value to linear space
  1886. * @ignorenaming
  1887. */
  1888. export const ToLinearSpace = 2.2;
  1889. /**
  1890. * Constant used to define the minimal number value in Babylon.js
  1891. * @ignorenaming
  1892. */
  1893. let Epsilon: number;
  1894. export { Epsilon };
  1895. }
  1896. declare module "babylonjs/Maths/math.viewport" {
  1897. /**
  1898. * Class used to represent a viewport on screen
  1899. */
  1900. export class Viewport {
  1901. /** viewport left coordinate */
  1902. x: number;
  1903. /** viewport top coordinate */
  1904. y: number;
  1905. /**viewport width */
  1906. width: number;
  1907. /** viewport height */
  1908. height: number;
  1909. /**
  1910. * Creates a Viewport object located at (x, y) and sized (width, height)
  1911. * @param x defines viewport left coordinate
  1912. * @param y defines viewport top coordinate
  1913. * @param width defines the viewport width
  1914. * @param height defines the viewport height
  1915. */
  1916. constructor(
  1917. /** viewport left coordinate */
  1918. x: number,
  1919. /** viewport top coordinate */
  1920. y: number,
  1921. /**viewport width */
  1922. width: number,
  1923. /** viewport height */
  1924. height: number);
  1925. /**
  1926. * Creates a new viewport using absolute sizing (from 0-> width, 0-> height instead of 0->1)
  1927. * @param renderWidth defines the rendering width
  1928. * @param renderHeight defines the rendering height
  1929. * @returns a new Viewport
  1930. */
  1931. toGlobal(renderWidth: number, renderHeight: number): Viewport;
  1932. /**
  1933. * Stores absolute viewport value into a target viewport (from 0-> width, 0-> height instead of 0->1)
  1934. * @param renderWidth defines the rendering width
  1935. * @param renderHeight defines the rendering height
  1936. * @param ref defines the target viewport
  1937. * @returns the current viewport
  1938. */
  1939. toGlobalToRef(renderWidth: number, renderHeight: number, ref: Viewport): Viewport;
  1940. /**
  1941. * Returns a new Viewport copied from the current one
  1942. * @returns a new Viewport
  1943. */
  1944. clone(): Viewport;
  1945. }
  1946. }
  1947. declare module "babylonjs/Misc/arrayTools" {
  1948. /**
  1949. * Class containing a set of static utilities functions for arrays.
  1950. */
  1951. export class ArrayTools {
  1952. /**
  1953. * Returns an array of the given size filled with element built from the given constructor and the paramters
  1954. * @param size the number of element to construct and put in the array
  1955. * @param itemBuilder a callback responsible for creating new instance of item. Called once per array entry.
  1956. * @returns a new array filled with new objects
  1957. */
  1958. static BuildArray<T>(size: number, itemBuilder: () => T): Array<T>;
  1959. }
  1960. }
  1961. declare module "babylonjs/Maths/math.plane" {
  1962. import { DeepImmutable } from "babylonjs/types";
  1963. import { Vector3, Matrix } from "babylonjs/Maths/math.vector";
  1964. /**
  1965. * Represents a plane by the equation ax + by + cz + d = 0
  1966. */
  1967. export class Plane {
  1968. private static _TmpMatrix;
  1969. /**
  1970. * Normal of the plane (a,b,c)
  1971. */
  1972. normal: Vector3;
  1973. /**
  1974. * d component of the plane
  1975. */
  1976. d: number;
  1977. /**
  1978. * Creates a Plane object according to the given floats a, b, c, d and the plane equation : ax + by + cz + d = 0
  1979. * @param a a component of the plane
  1980. * @param b b component of the plane
  1981. * @param c c component of the plane
  1982. * @param d d component of the plane
  1983. */
  1984. constructor(a: number, b: number, c: number, d: number);
  1985. /**
  1986. * @returns the plane coordinates as a new array of 4 elements [a, b, c, d].
  1987. */
  1988. asArray(): number[];
  1989. /**
  1990. * @returns a new plane copied from the current Plane.
  1991. */
  1992. clone(): Plane;
  1993. /**
  1994. * @returns the string "Plane".
  1995. */
  1996. getClassName(): string;
  1997. /**
  1998. * @returns the Plane hash code.
  1999. */
  2000. getHashCode(): number;
  2001. /**
  2002. * Normalize the current Plane in place.
  2003. * @returns the updated Plane.
  2004. */
  2005. normalize(): Plane;
  2006. /**
  2007. * Applies a transformation the plane and returns the result
  2008. * @param transformation the transformation matrix to be applied to the plane
  2009. * @returns a new Plane as the result of the transformation of the current Plane by the given matrix.
  2010. */
  2011. transform(transformation: DeepImmutable<Matrix>): Plane;
  2012. /**
  2013. * Compute the dot product between the point and the plane normal
  2014. * @param point point to calculate the dot product with
  2015. * @returns the dot product (float) of the point coordinates and the plane normal.
  2016. */
  2017. dotCoordinate(point: DeepImmutable<Vector3>): number;
  2018. /**
  2019. * Updates the current Plane from the plane defined by the three given points.
  2020. * @param point1 one of the points used to contruct the plane
  2021. * @param point2 one of the points used to contruct the plane
  2022. * @param point3 one of the points used to contruct the plane
  2023. * @returns the updated Plane.
  2024. */
  2025. copyFromPoints(point1: DeepImmutable<Vector3>, point2: DeepImmutable<Vector3>, point3: DeepImmutable<Vector3>): Plane;
  2026. /**
  2027. * Checks if the plane is facing a given direction
  2028. * @param direction the direction to check if the plane is facing
  2029. * @param epsilon value the dot product is compared against (returns true if dot <= epsilon)
  2030. * @returns True is the vector "direction" is the same side than the plane normal.
  2031. */
  2032. isFrontFacingTo(direction: DeepImmutable<Vector3>, epsilon: number): boolean;
  2033. /**
  2034. * Calculates the distance to a point
  2035. * @param point point to calculate distance to
  2036. * @returns the signed distance (float) from the given point to the Plane.
  2037. */
  2038. signedDistanceTo(point: DeepImmutable<Vector3>): number;
  2039. /**
  2040. * Creates a plane from an array
  2041. * @param array the array to create a plane from
  2042. * @returns a new Plane from the given array.
  2043. */
  2044. static FromArray(array: DeepImmutable<ArrayLike<number>>): Plane;
  2045. /**
  2046. * Creates a plane from three points
  2047. * @param point1 point used to create the plane
  2048. * @param point2 point used to create the plane
  2049. * @param point3 point used to create the plane
  2050. * @returns a new Plane defined by the three given points.
  2051. */
  2052. static FromPoints(point1: DeepImmutable<Vector3>, point2: DeepImmutable<Vector3>, point3: DeepImmutable<Vector3>): Plane;
  2053. /**
  2054. * Creates a plane from an origin point and a normal
  2055. * @param origin origin of the plane to be constructed
  2056. * @param normal normal of the plane to be constructed
  2057. * @returns a new Plane the normal vector to this plane at the given origin point.
  2058. * Note : the vector "normal" is updated because normalized.
  2059. */
  2060. static FromPositionAndNormal(origin: DeepImmutable<Vector3>, normal: Vector3): Plane;
  2061. /**
  2062. * Calculates the distance from a plane and a point
  2063. * @param origin origin of the plane to be constructed
  2064. * @param normal normal of the plane to be constructed
  2065. * @param point point to calculate distance to
  2066. * @returns the signed distance between the plane defined by the normal vector at the "origin"" point and the given other point.
  2067. */
  2068. static SignedDistanceToPlaneFromPositionAndNormal(origin: DeepImmutable<Vector3>, normal: DeepImmutable<Vector3>, point: DeepImmutable<Vector3>): number;
  2069. }
  2070. }
  2071. declare module "babylonjs/Engines/performanceConfigurator" {
  2072. /** @hidden */
  2073. export class PerformanceConfigurator {
  2074. /** @hidden */
  2075. static MatrixUse64Bits: boolean;
  2076. /** @hidden */
  2077. static MatrixTrackPrecisionChange: boolean;
  2078. /** @hidden */
  2079. static MatrixCurrentType: any;
  2080. /** @hidden */
  2081. static MatrixTrackedMatrices: Array<any> | null;
  2082. /** @hidden */
  2083. static SetMatrixPrecision(use64bits: boolean): void;
  2084. }
  2085. }
  2086. declare module "babylonjs/Maths/math.vector" {
  2087. import { Viewport } from "babylonjs/Maths/math.viewport";
  2088. import { DeepImmutable, Nullable, FloatArray, float } from "babylonjs/types";
  2089. import { IPlaneLike } from "babylonjs/Maths/math.like";
  2090. import { Plane } from "babylonjs/Maths/math.plane";
  2091. /**
  2092. * Class representing a vector containing 2 coordinates
  2093. */
  2094. export class Vector2 {
  2095. /** defines the first coordinate */
  2096. x: number;
  2097. /** defines the second coordinate */
  2098. y: number;
  2099. /**
  2100. * Creates a new Vector2 from the given x and y coordinates
  2101. * @param x defines the first coordinate
  2102. * @param y defines the second coordinate
  2103. */
  2104. constructor(
  2105. /** defines the first coordinate */
  2106. x?: number,
  2107. /** defines the second coordinate */
  2108. y?: number);
  2109. /**
  2110. * Gets a string with the Vector2 coordinates
  2111. * @returns a string with the Vector2 coordinates
  2112. */
  2113. toString(): string;
  2114. /**
  2115. * Gets class name
  2116. * @returns the string "Vector2"
  2117. */
  2118. getClassName(): string;
  2119. /**
  2120. * Gets current vector hash code
  2121. * @returns the Vector2 hash code as a number
  2122. */
  2123. getHashCode(): number;
  2124. /**
  2125. * Sets the Vector2 coordinates in the given array or Float32Array from the given index.
  2126. * @param array defines the source array
  2127. * @param index defines the offset in source array
  2128. * @returns the current Vector2
  2129. */
  2130. toArray(array: FloatArray, index?: number): Vector2;
  2131. /**
  2132. * Update the current vector from an array
  2133. * @param array defines the destination array
  2134. * @param index defines the offset in the destination array
  2135. * @returns the current Vector3
  2136. */
  2137. fromArray(array: FloatArray, index?: number): Vector2;
  2138. /**
  2139. * Copy the current vector to an array
  2140. * @returns a new array with 2 elements: the Vector2 coordinates.
  2141. */
  2142. asArray(): number[];
  2143. /**
  2144. * Sets the Vector2 coordinates with the given Vector2 coordinates
  2145. * @param source defines the source Vector2
  2146. * @returns the current updated Vector2
  2147. */
  2148. copyFrom(source: DeepImmutable<Vector2>): Vector2;
  2149. /**
  2150. * Sets the Vector2 coordinates with the given floats
  2151. * @param x defines the first coordinate
  2152. * @param y defines the second coordinate
  2153. * @returns the current updated Vector2
  2154. */
  2155. copyFromFloats(x: number, y: number): Vector2;
  2156. /**
  2157. * Sets the Vector2 coordinates with the given floats
  2158. * @param x defines the first coordinate
  2159. * @param y defines the second coordinate
  2160. * @returns the current updated Vector2
  2161. */
  2162. set(x: number, y: number): Vector2;
  2163. /**
  2164. * Add another vector with the current one
  2165. * @param otherVector defines the other vector
  2166. * @returns a new Vector2 set with the addition of the current Vector2 and the given one coordinates
  2167. */
  2168. add(otherVector: DeepImmutable<Vector2>): Vector2;
  2169. /**
  2170. * Sets the "result" coordinates with the addition of the current Vector2 and the given one coordinates
  2171. * @param otherVector defines the other vector
  2172. * @param result defines the target vector
  2173. * @returns the unmodified current Vector2
  2174. */
  2175. addToRef(otherVector: DeepImmutable<Vector2>, result: Vector2): Vector2;
  2176. /**
  2177. * Set the Vector2 coordinates by adding the given Vector2 coordinates
  2178. * @param otherVector defines the other vector
  2179. * @returns the current updated Vector2
  2180. */
  2181. addInPlace(otherVector: DeepImmutable<Vector2>): Vector2;
  2182. /**
  2183. * Gets a new Vector2 by adding the current Vector2 coordinates to the given Vector3 x, y coordinates
  2184. * @param otherVector defines the other vector
  2185. * @returns a new Vector2
  2186. */
  2187. addVector3(otherVector: Vector3): Vector2;
  2188. /**
  2189. * Gets a new Vector2 set with the subtracted coordinates of the given one from the current Vector2
  2190. * @param otherVector defines the other vector
  2191. * @returns a new Vector2
  2192. */
  2193. subtract(otherVector: Vector2): Vector2;
  2194. /**
  2195. * Sets the "result" coordinates with the subtraction of the given one from the current Vector2 coordinates.
  2196. * @param otherVector defines the other vector
  2197. * @param result defines the target vector
  2198. * @returns the unmodified current Vector2
  2199. */
  2200. subtractToRef(otherVector: DeepImmutable<Vector2>, result: Vector2): Vector2;
  2201. /**
  2202. * Sets the current Vector2 coordinates by subtracting from it the given one coordinates
  2203. * @param otherVector defines the other vector
  2204. * @returns the current updated Vector2
  2205. */
  2206. subtractInPlace(otherVector: DeepImmutable<Vector2>): Vector2;
  2207. /**
  2208. * Multiplies in place the current Vector2 coordinates by the given ones
  2209. * @param otherVector defines the other vector
  2210. * @returns the current updated Vector2
  2211. */
  2212. multiplyInPlace(otherVector: DeepImmutable<Vector2>): Vector2;
  2213. /**
  2214. * Returns a new Vector2 set with the multiplication of the current Vector2 and the given one coordinates
  2215. * @param otherVector defines the other vector
  2216. * @returns a new Vector2
  2217. */
  2218. multiply(otherVector: DeepImmutable<Vector2>): Vector2;
  2219. /**
  2220. * Sets "result" coordinates with the multiplication of the current Vector2 and the given one coordinates
  2221. * @param otherVector defines the other vector
  2222. * @param result defines the target vector
  2223. * @returns the unmodified current Vector2
  2224. */
  2225. multiplyToRef(otherVector: DeepImmutable<Vector2>, result: Vector2): Vector2;
  2226. /**
  2227. * Gets a new Vector2 set with the Vector2 coordinates multiplied by the given floats
  2228. * @param x defines the first coordinate
  2229. * @param y defines the second coordinate
  2230. * @returns a new Vector2
  2231. */
  2232. multiplyByFloats(x: number, y: number): Vector2;
  2233. /**
  2234. * Returns a new Vector2 set with the Vector2 coordinates divided by the given one coordinates
  2235. * @param otherVector defines the other vector
  2236. * @returns a new Vector2
  2237. */
  2238. divide(otherVector: Vector2): Vector2;
  2239. /**
  2240. * Sets the "result" coordinates with the Vector2 divided by the given one coordinates
  2241. * @param otherVector defines the other vector
  2242. * @param result defines the target vector
  2243. * @returns the unmodified current Vector2
  2244. */
  2245. divideToRef(otherVector: DeepImmutable<Vector2>, result: Vector2): Vector2;
  2246. /**
  2247. * Divides the current Vector2 coordinates by the given ones
  2248. * @param otherVector defines the other vector
  2249. * @returns the current updated Vector2
  2250. */
  2251. divideInPlace(otherVector: DeepImmutable<Vector2>): Vector2;
  2252. /**
  2253. * Gets a new Vector2 with current Vector2 negated coordinates
  2254. * @returns a new Vector2
  2255. */
  2256. negate(): Vector2;
  2257. /**
  2258. * Negate this vector in place
  2259. * @returns this
  2260. */
  2261. negateInPlace(): Vector2;
  2262. /**
  2263. * Negate the current Vector2 and stores the result in the given vector "result" coordinates
  2264. * @param result defines the Vector3 object where to store the result
  2265. * @returns the current Vector2
  2266. */
  2267. negateToRef(result: Vector2): Vector2;
  2268. /**
  2269. * Multiply the Vector2 coordinates by scale
  2270. * @param scale defines the scaling factor
  2271. * @returns the current updated Vector2
  2272. */
  2273. scaleInPlace(scale: number): Vector2;
  2274. /**
  2275. * Returns a new Vector2 scaled by "scale" from the current Vector2
  2276. * @param scale defines the scaling factor
  2277. * @returns a new Vector2
  2278. */
  2279. scale(scale: number): Vector2;
  2280. /**
  2281. * Scale the current Vector2 values by a factor to a given Vector2
  2282. * @param scale defines the scale factor
  2283. * @param result defines the Vector2 object where to store the result
  2284. * @returns the unmodified current Vector2
  2285. */
  2286. scaleToRef(scale: number, result: Vector2): Vector2;
  2287. /**
  2288. * Scale the current Vector2 values by a factor and add the result to a given Vector2
  2289. * @param scale defines the scale factor
  2290. * @param result defines the Vector2 object where to store the result
  2291. * @returns the unmodified current Vector2
  2292. */
  2293. scaleAndAddToRef(scale: number, result: Vector2): Vector2;
  2294. /**
  2295. * Gets a boolean if two vectors are equals
  2296. * @param otherVector defines the other vector
  2297. * @returns true if the given vector coordinates strictly equal the current Vector2 ones
  2298. */
  2299. equals(otherVector: DeepImmutable<Vector2>): boolean;
  2300. /**
  2301. * Gets a boolean if two vectors are equals (using an epsilon value)
  2302. * @param otherVector defines the other vector
  2303. * @param epsilon defines the minimal distance to consider equality
  2304. * @returns true if the given vector coordinates are close to the current ones by a distance of epsilon.
  2305. */
  2306. equalsWithEpsilon(otherVector: DeepImmutable<Vector2>, epsilon?: number): boolean;
  2307. /**
  2308. * Gets a new Vector2 from current Vector2 floored values
  2309. * @returns a new Vector2
  2310. */
  2311. floor(): Vector2;
  2312. /**
  2313. * Gets a new Vector2 from current Vector2 floored values
  2314. * @returns a new Vector2
  2315. */
  2316. fract(): Vector2;
  2317. /**
  2318. * Gets the length of the vector
  2319. * @returns the vector length (float)
  2320. */
  2321. length(): number;
  2322. /**
  2323. * Gets the vector squared length
  2324. * @returns the vector squared length (float)
  2325. */
  2326. lengthSquared(): number;
  2327. /**
  2328. * Normalize the vector
  2329. * @returns the current updated Vector2
  2330. */
  2331. normalize(): Vector2;
  2332. /**
  2333. * Gets a new Vector2 copied from the Vector2
  2334. * @returns a new Vector2
  2335. */
  2336. clone(): Vector2;
  2337. /**
  2338. * Gets a new Vector2(0, 0)
  2339. * @returns a new Vector2
  2340. */
  2341. static Zero(): Vector2;
  2342. /**
  2343. * Gets a new Vector2(1, 1)
  2344. * @returns a new Vector2
  2345. */
  2346. static One(): Vector2;
  2347. /**
  2348. * Gets a new Vector2 set from the given index element of the given array
  2349. * @param array defines the data source
  2350. * @param offset defines the offset in the data source
  2351. * @returns a new Vector2
  2352. */
  2353. static FromArray(array: DeepImmutable<ArrayLike<number>>, offset?: number): Vector2;
  2354. /**
  2355. * Sets "result" from the given index element of the given array
  2356. * @param array defines the data source
  2357. * @param offset defines the offset in the data source
  2358. * @param result defines the target vector
  2359. */
  2360. static FromArrayToRef(array: DeepImmutable<ArrayLike<number>>, offset: number, result: Vector2): void;
  2361. /**
  2362. * Gets a new Vector2 located for "amount" (float) on the CatmullRom spline defined by the given four Vector2
  2363. * @param value1 defines 1st point of control
  2364. * @param value2 defines 2nd point of control
  2365. * @param value3 defines 3rd point of control
  2366. * @param value4 defines 4th point of control
  2367. * @param amount defines the interpolation factor
  2368. * @returns a new Vector2
  2369. */
  2370. static CatmullRom(value1: DeepImmutable<Vector2>, value2: DeepImmutable<Vector2>, value3: DeepImmutable<Vector2>, value4: DeepImmutable<Vector2>, amount: number): Vector2;
  2371. /**
  2372. * Returns a new Vector2 set with same the coordinates than "value" ones if the vector "value" is in the square defined by "min" and "max".
  2373. * If a coordinate of "value" is lower than "min" coordinates, the returned Vector2 is given this "min" coordinate.
  2374. * If a coordinate of "value" is greater than "max" coordinates, the returned Vector2 is given this "max" coordinate
  2375. * @param value defines the value to clamp
  2376. * @param min defines the lower limit
  2377. * @param max defines the upper limit
  2378. * @returns a new Vector2
  2379. */
  2380. static Clamp(value: DeepImmutable<Vector2>, min: DeepImmutable<Vector2>, max: DeepImmutable<Vector2>): Vector2;
  2381. /**
  2382. * Returns a new Vector2 located for "amount" (float) on the Hermite spline defined by the vectors "value1", "value3", "tangent1", "tangent2"
  2383. * @param value1 defines the 1st control point
  2384. * @param tangent1 defines the outgoing tangent
  2385. * @param value2 defines the 2nd control point
  2386. * @param tangent2 defines the incoming tangent
  2387. * @param amount defines the interpolation factor
  2388. * @returns a new Vector2
  2389. */
  2390. static Hermite(value1: DeepImmutable<Vector2>, tangent1: DeepImmutable<Vector2>, value2: DeepImmutable<Vector2>, tangent2: DeepImmutable<Vector2>, amount: number): Vector2;
  2391. /**
  2392. * Returns a new Vector2 located for "amount" (float) on the linear interpolation between the vector "start" adn the vector "end".
  2393. * @param start defines the start vector
  2394. * @param end defines the end vector
  2395. * @param amount defines the interpolation factor
  2396. * @returns a new Vector2
  2397. */
  2398. static Lerp(start: DeepImmutable<Vector2>, end: DeepImmutable<Vector2>, amount: number): Vector2;
  2399. /**
  2400. * Gets the dot product of the vector "left" and the vector "right"
  2401. * @param left defines first vector
  2402. * @param right defines second vector
  2403. * @returns the dot product (float)
  2404. */
  2405. static Dot(left: DeepImmutable<Vector2>, right: DeepImmutable<Vector2>): number;
  2406. /**
  2407. * Returns a new Vector2 equal to the normalized given vector
  2408. * @param vector defines the vector to normalize
  2409. * @returns a new Vector2
  2410. */
  2411. static Normalize(vector: DeepImmutable<Vector2>): Vector2;
  2412. /**
  2413. * Gets a new Vector2 set with the minimal coordinate values from the "left" and "right" vectors
  2414. * @param left defines 1st vector
  2415. * @param right defines 2nd vector
  2416. * @returns a new Vector2
  2417. */
  2418. static Minimize(left: DeepImmutable<Vector2>, right: DeepImmutable<Vector2>): Vector2;
  2419. /**
  2420. * Gets a new Vecto2 set with the maximal coordinate values from the "left" and "right" vectors
  2421. * @param left defines 1st vector
  2422. * @param right defines 2nd vector
  2423. * @returns a new Vector2
  2424. */
  2425. static Maximize(left: DeepImmutable<Vector2>, right: DeepImmutable<Vector2>): Vector2;
  2426. /**
  2427. * Gets a new Vector2 set with the transformed coordinates of the given vector by the given transformation matrix
  2428. * @param vector defines the vector to transform
  2429. * @param transformation defines the matrix to apply
  2430. * @returns a new Vector2
  2431. */
  2432. static Transform(vector: DeepImmutable<Vector2>, transformation: DeepImmutable<Matrix>): Vector2;
  2433. /**
  2434. * Transforms the given vector coordinates by the given transformation matrix and stores the result in the vector "result" coordinates
  2435. * @param vector defines the vector to transform
  2436. * @param transformation defines the matrix to apply
  2437. * @param result defines the target vector
  2438. */
  2439. static TransformToRef(vector: DeepImmutable<Vector2>, transformation: DeepImmutable<Matrix>, result: Vector2): void;
  2440. /**
  2441. * Determines if a given vector is included in a triangle
  2442. * @param p defines the vector to test
  2443. * @param p0 defines 1st triangle point
  2444. * @param p1 defines 2nd triangle point
  2445. * @param p2 defines 3rd triangle point
  2446. * @returns true if the point "p" is in the triangle defined by the vertors "p0", "p1", "p2"
  2447. */
  2448. static PointInTriangle(p: DeepImmutable<Vector2>, p0: DeepImmutable<Vector2>, p1: DeepImmutable<Vector2>, p2: DeepImmutable<Vector2>): boolean;
  2449. /**
  2450. * Gets the distance between the vectors "value1" and "value2"
  2451. * @param value1 defines first vector
  2452. * @param value2 defines second vector
  2453. * @returns the distance between vectors
  2454. */
  2455. static Distance(value1: DeepImmutable<Vector2>, value2: DeepImmutable<Vector2>): number;
  2456. /**
  2457. * Returns the squared distance between the vectors "value1" and "value2"
  2458. * @param value1 defines first vector
  2459. * @param value2 defines second vector
  2460. * @returns the squared distance between vectors
  2461. */
  2462. static DistanceSquared(value1: DeepImmutable<Vector2>, value2: DeepImmutable<Vector2>): number;
  2463. /**
  2464. * Gets a new Vector2 located at the center of the vectors "value1" and "value2"
  2465. * @param value1 defines first vector
  2466. * @param value2 defines second vector
  2467. * @returns a new Vector2
  2468. */
  2469. static Center(value1: DeepImmutable<Vector2>, value2: DeepImmutable<Vector2>): Vector2;
  2470. /**
  2471. * Gets the shortest distance (float) between the point "p" and the segment defined by the two points "segA" and "segB".
  2472. * @param p defines the middle point
  2473. * @param segA defines one point of the segment
  2474. * @param segB defines the other point of the segment
  2475. * @returns the shortest distance
  2476. */
  2477. static DistanceOfPointFromSegment(p: DeepImmutable<Vector2>, segA: DeepImmutable<Vector2>, segB: DeepImmutable<Vector2>): number;
  2478. }
  2479. /**
  2480. * Class used to store (x,y,z) vector representation
  2481. * A Vector3 is the main object used in 3D geometry
  2482. * It can represent etiher the coordinates of a point the space, either a direction
  2483. * Reminder: js uses a left handed forward facing system
  2484. */
  2485. export class Vector3 {
  2486. private static _UpReadOnly;
  2487. private static _ZeroReadOnly;
  2488. /** @hidden */
  2489. _x: number;
  2490. /** @hidden */
  2491. _y: number;
  2492. /** @hidden */
  2493. _z: number;
  2494. /** @hidden */
  2495. _isDirty: boolean;
  2496. /** Gets or sets the x coordinate */
  2497. get x(): number;
  2498. set x(value: number);
  2499. /** Gets or sets the y coordinate */
  2500. get y(): number;
  2501. set y(value: number);
  2502. /** Gets or sets the z coordinate */
  2503. get z(): number;
  2504. set z(value: number);
  2505. /**
  2506. * Creates a new Vector3 object from the given x, y, z (floats) coordinates.
  2507. * @param x defines the first coordinates (on X axis)
  2508. * @param y defines the second coordinates (on Y axis)
  2509. * @param z defines the third coordinates (on Z axis)
  2510. */
  2511. constructor(x?: number, y?: number, z?: number);
  2512. /**
  2513. * Creates a string representation of the Vector3
  2514. * @returns a string with the Vector3 coordinates.
  2515. */
  2516. toString(): string;
  2517. /**
  2518. * Gets the class name
  2519. * @returns the string "Vector3"
  2520. */
  2521. getClassName(): string;
  2522. /**
  2523. * Creates the Vector3 hash code
  2524. * @returns a number which tends to be unique between Vector3 instances
  2525. */
  2526. getHashCode(): number;
  2527. /**
  2528. * Creates an array containing three elements : the coordinates of the Vector3
  2529. * @returns a new array of numbers
  2530. */
  2531. asArray(): number[];
  2532. /**
  2533. * Populates the given array or Float32Array from the given index with the successive coordinates of the Vector3
  2534. * @param array defines the destination array
  2535. * @param index defines the offset in the destination array
  2536. * @returns the current Vector3
  2537. */
  2538. toArray(array: FloatArray, index?: number): Vector3;
  2539. /**
  2540. * Update the current vector from an array
  2541. * @param array defines the destination array
  2542. * @param index defines the offset in the destination array
  2543. * @returns the current Vector3
  2544. */
  2545. fromArray(array: FloatArray, index?: number): Vector3;
  2546. /**
  2547. * Converts the current Vector3 into a quaternion (considering that the Vector3 contains Euler angles representation of a rotation)
  2548. * @returns a new Quaternion object, computed from the Vector3 coordinates
  2549. */
  2550. toQuaternion(): Quaternion;
  2551. /**
  2552. * Adds the given vector to the current Vector3
  2553. * @param otherVector defines the second operand
  2554. * @returns the current updated Vector3
  2555. */
  2556. addInPlace(otherVector: DeepImmutable<Vector3>): Vector3;
  2557. /**
  2558. * Adds the given coordinates to the current Vector3
  2559. * @param x defines the x coordinate of the operand
  2560. * @param y defines the y coordinate of the operand
  2561. * @param z defines the z coordinate of the operand
  2562. * @returns the current updated Vector3
  2563. */
  2564. addInPlaceFromFloats(x: number, y: number, z: number): Vector3;
  2565. /**
  2566. * Gets a new Vector3, result of the addition the current Vector3 and the given vector
  2567. * @param otherVector defines the second operand
  2568. * @returns the resulting Vector3
  2569. */
  2570. add(otherVector: DeepImmutable<Vector3>): Vector3;
  2571. /**
  2572. * Adds the current Vector3 to the given one and stores the result in the vector "result"
  2573. * @param otherVector defines the second operand
  2574. * @param result defines the Vector3 object where to store the result
  2575. * @returns the current Vector3
  2576. */
  2577. addToRef(otherVector: DeepImmutable<Vector3>, result: Vector3): Vector3;
  2578. /**
  2579. * Subtract the given vector from the current Vector3
  2580. * @param otherVector defines the second operand
  2581. * @returns the current updated Vector3
  2582. */
  2583. subtractInPlace(otherVector: DeepImmutable<Vector3>): Vector3;
  2584. /**
  2585. * Returns a new Vector3, result of the subtraction of the given vector from the current Vector3
  2586. * @param otherVector defines the second operand
  2587. * @returns the resulting Vector3
  2588. */
  2589. subtract(otherVector: DeepImmutable<Vector3>): Vector3;
  2590. /**
  2591. * Subtracts the given vector from the current Vector3 and stores the result in the vector "result".
  2592. * @param otherVector defines the second operand
  2593. * @param result defines the Vector3 object where to store the result
  2594. * @returns the current Vector3
  2595. */
  2596. subtractToRef(otherVector: DeepImmutable<Vector3>, result: Vector3): Vector3;
  2597. /**
  2598. * Returns a new Vector3 set with the subtraction of the given floats from the current Vector3 coordinates
  2599. * @param x defines the x coordinate of the operand
  2600. * @param y defines the y coordinate of the operand
  2601. * @param z defines the z coordinate of the operand
  2602. * @returns the resulting Vector3
  2603. */
  2604. subtractFromFloats(x: number, y: number, z: number): Vector3;
  2605. /**
  2606. * Subtracts the given floats from the current Vector3 coordinates and set the given vector "result" with this result
  2607. * @param x defines the x coordinate of the operand
  2608. * @param y defines the y coordinate of the operand
  2609. * @param z defines the z coordinate of the operand
  2610. * @param result defines the Vector3 object where to store the result
  2611. * @returns the current Vector3
  2612. */
  2613. subtractFromFloatsToRef(x: number, y: number, z: number, result: Vector3): Vector3;
  2614. /**
  2615. * Gets a new Vector3 set with the current Vector3 negated coordinates
  2616. * @returns a new Vector3
  2617. */
  2618. negate(): Vector3;
  2619. /**
  2620. * Negate this vector in place
  2621. * @returns this
  2622. */
  2623. negateInPlace(): Vector3;
  2624. /**
  2625. * Negate the current Vector3 and stores the result in the given vector "result" coordinates
  2626. * @param result defines the Vector3 object where to store the result
  2627. * @returns the current Vector3
  2628. */
  2629. negateToRef(result: Vector3): Vector3;
  2630. /**
  2631. * Multiplies the Vector3 coordinates by the float "scale"
  2632. * @param scale defines the multiplier factor
  2633. * @returns the current updated Vector3
  2634. */
  2635. scaleInPlace(scale: number): Vector3;
  2636. /**
  2637. * Returns a new Vector3 set with the current Vector3 coordinates multiplied by the float "scale"
  2638. * @param scale defines the multiplier factor
  2639. * @returns a new Vector3
  2640. */
  2641. scale(scale: number): Vector3;
  2642. /**
  2643. * Multiplies the current Vector3 coordinates by the float "scale" and stores the result in the given vector "result" coordinates
  2644. * @param scale defines the multiplier factor
  2645. * @param result defines the Vector3 object where to store the result
  2646. * @returns the current Vector3
  2647. */
  2648. scaleToRef(scale: number, result: Vector3): Vector3;
  2649. /**
  2650. * Scale the current Vector3 values by a factor and add the result to a given Vector3
  2651. * @param scale defines the scale factor
  2652. * @param result defines the Vector3 object where to store the result
  2653. * @returns the unmodified current Vector3
  2654. */
  2655. scaleAndAddToRef(scale: number, result: Vector3): Vector3;
  2656. /**
  2657. * Projects the current vector3 to a plane along a ray starting from a specified origin and directed towards the point.
  2658. * @param origin defines the origin of the projection ray
  2659. * @param plane defines the plane to project to
  2660. * @returns the projected vector3
  2661. */
  2662. projectOnPlane(plane: Plane, origin: Vector3): Vector3;
  2663. /**
  2664. * Projects the current vector3 to a plane along a ray starting from a specified origin and directed towards the point.
  2665. * @param origin defines the origin of the projection ray
  2666. * @param plane defines the plane to project to
  2667. * @param result defines the Vector3 where to store the result
  2668. */
  2669. projectOnPlaneToRef(plane: Plane, origin: Vector3, result: Vector3): void;
  2670. /**
  2671. * Returns true if the current Vector3 and the given vector coordinates are strictly equal
  2672. * @param otherVector defines the second operand
  2673. * @returns true if both vectors are equals
  2674. */
  2675. equals(otherVector: DeepImmutable<Vector3>): boolean;
  2676. /**
  2677. * Returns true if the current Vector3 and the given vector coordinates are distant less than epsilon
  2678. * @param otherVector defines the second operand
  2679. * @param epsilon defines the minimal distance to define values as equals
  2680. * @returns true if both vectors are distant less than epsilon
  2681. */
  2682. equalsWithEpsilon(otherVector: DeepImmutable<Vector3>, epsilon?: number): boolean;
  2683. /**
  2684. * Returns true if the current Vector3 coordinates equals the given floats
  2685. * @param x defines the x coordinate of the operand
  2686. * @param y defines the y coordinate of the operand
  2687. * @param z defines the z coordinate of the operand
  2688. * @returns true if both vectors are equals
  2689. */
  2690. equalsToFloats(x: number, y: number, z: number): boolean;
  2691. /**
  2692. * Multiplies the current Vector3 coordinates by the given ones
  2693. * @param otherVector defines the second operand
  2694. * @returns the current updated Vector3
  2695. */
  2696. multiplyInPlace(otherVector: DeepImmutable<Vector3>): Vector3;
  2697. /**
  2698. * Returns a new Vector3, result of the multiplication of the current Vector3 by the given vector
  2699. * @param otherVector defines the second operand
  2700. * @returns the new Vector3
  2701. */
  2702. multiply(otherVector: DeepImmutable<Vector3>): Vector3;
  2703. /**
  2704. * Multiplies the current Vector3 by the given one and stores the result in the given vector "result"
  2705. * @param otherVector defines the second operand
  2706. * @param result defines the Vector3 object where to store the result
  2707. * @returns the current Vector3
  2708. */
  2709. multiplyToRef(otherVector: DeepImmutable<Vector3>, result: Vector3): Vector3;
  2710. /**
  2711. * Returns a new Vector3 set with the result of the mulliplication of the current Vector3 coordinates by the given floats
  2712. * @param x defines the x coordinate of the operand
  2713. * @param y defines the y coordinate of the operand
  2714. * @param z defines the z coordinate of the operand
  2715. * @returns the new Vector3
  2716. */
  2717. multiplyByFloats(x: number, y: number, z: number): Vector3;
  2718. /**
  2719. * Returns a new Vector3 set with the result of the division of the current Vector3 coordinates by the given ones
  2720. * @param otherVector defines the second operand
  2721. * @returns the new Vector3
  2722. */
  2723. divide(otherVector: DeepImmutable<Vector3>): Vector3;
  2724. /**
  2725. * Divides the current Vector3 coordinates by the given ones and stores the result in the given vector "result"
  2726. * @param otherVector defines the second operand
  2727. * @param result defines the Vector3 object where to store the result
  2728. * @returns the current Vector3
  2729. */
  2730. divideToRef(otherVector: DeepImmutable<Vector3>, result: Vector3): Vector3;
  2731. /**
  2732. * Divides the current Vector3 coordinates by the given ones.
  2733. * @param otherVector defines the second operand
  2734. * @returns the current updated Vector3
  2735. */
  2736. divideInPlace(otherVector: Vector3): Vector3;
  2737. /**
  2738. * Updates the current Vector3 with the minimal coordinate values between its and the given vector ones
  2739. * @param other defines the second operand
  2740. * @returns the current updated Vector3
  2741. */
  2742. minimizeInPlace(other: DeepImmutable<Vector3>): Vector3;
  2743. /**
  2744. * Updates the current Vector3 with the maximal coordinate values between its and the given vector ones.
  2745. * @param other defines the second operand
  2746. * @returns the current updated Vector3
  2747. */
  2748. maximizeInPlace(other: DeepImmutable<Vector3>): Vector3;
  2749. /**
  2750. * Updates the current Vector3 with the minimal coordinate values between its and the given coordinates
  2751. * @param x defines the x coordinate of the operand
  2752. * @param y defines the y coordinate of the operand
  2753. * @param z defines the z coordinate of the operand
  2754. * @returns the current updated Vector3
  2755. */
  2756. minimizeInPlaceFromFloats(x: number, y: number, z: number): Vector3;
  2757. /**
  2758. * Updates the current Vector3 with the maximal coordinate values between its and the given coordinates.
  2759. * @param x defines the x coordinate of the operand
  2760. * @param y defines the y coordinate of the operand
  2761. * @param z defines the z coordinate of the operand
  2762. * @returns the current updated Vector3
  2763. */
  2764. maximizeInPlaceFromFloats(x: number, y: number, z: number): Vector3;
  2765. /**
  2766. * Due to float precision, scale of a mesh could be uniform but float values are off by a small fraction
  2767. * Check if is non uniform within a certain amount of decimal places to account for this
  2768. * @param epsilon the amount the values can differ
  2769. * @returns if the the vector is non uniform to a certain number of decimal places
  2770. */
  2771. isNonUniformWithinEpsilon(epsilon: number): boolean;
  2772. /**
  2773. * Gets a boolean indicating that the vector is non uniform meaning x, y or z are not all the same
  2774. */
  2775. get isNonUniform(): boolean;
  2776. /**
  2777. * Gets a new Vector3 from current Vector3 floored values
  2778. * @returns a new Vector3
  2779. */
  2780. floor(): Vector3;
  2781. /**
  2782. * Gets a new Vector3 from current Vector3 floored values
  2783. * @returns a new Vector3
  2784. */
  2785. fract(): Vector3;
  2786. /**
  2787. * Gets the length of the Vector3
  2788. * @returns the length of the Vector3
  2789. */
  2790. length(): number;
  2791. /**
  2792. * Gets the squared length of the Vector3
  2793. * @returns squared length of the Vector3
  2794. */
  2795. lengthSquared(): number;
  2796. /**
  2797. * Normalize the current Vector3.
  2798. * Please note that this is an in place operation.
  2799. * @returns the current updated Vector3
  2800. */
  2801. normalize(): Vector3;
  2802. /**
  2803. * Reorders the x y z properties of the vector in place
  2804. * @param order new ordering of the properties (eg. for vector 1,2,3 with "ZYX" will produce 3,2,1)
  2805. * @returns the current updated vector
  2806. */
  2807. reorderInPlace(order: string): this;
  2808. /**
  2809. * Rotates the vector around 0,0,0 by a quaternion
  2810. * @param quaternion the rotation quaternion
  2811. * @param result vector to store the result
  2812. * @returns the resulting vector
  2813. */
  2814. rotateByQuaternionToRef(quaternion: Quaternion, result: Vector3): Vector3;
  2815. /**
  2816. * Rotates a vector around a given point
  2817. * @param quaternion the rotation quaternion
  2818. * @param point the point to rotate around
  2819. * @param result vector to store the result
  2820. * @returns the resulting vector
  2821. */
  2822. rotateByQuaternionAroundPointToRef(quaternion: Quaternion, point: Vector3, result: Vector3): Vector3;
  2823. /**
  2824. * Returns a new Vector3 as the cross product of the current vector and the "other" one
  2825. * The cross product is then orthogonal to both current and "other"
  2826. * @param other defines the right operand
  2827. * @returns the cross product
  2828. */
  2829. cross(other: Vector3): Vector3;
  2830. /**
  2831. * Normalize the current Vector3 with the given input length.
  2832. * Please note that this is an in place operation.
  2833. * @param len the length of the vector
  2834. * @returns the current updated Vector3
  2835. */
  2836. normalizeFromLength(len: number): Vector3;
  2837. /**
  2838. * Normalize the current Vector3 to a new vector
  2839. * @returns the new Vector3
  2840. */
  2841. normalizeToNew(): Vector3;
  2842. /**
  2843. * Normalize the current Vector3 to the reference
  2844. * @param reference define the Vector3 to update
  2845. * @returns the updated Vector3
  2846. */
  2847. normalizeToRef(reference: Vector3): Vector3;
  2848. /**
  2849. * Creates a new Vector3 copied from the current Vector3
  2850. * @returns the new Vector3
  2851. */
  2852. clone(): Vector3;
  2853. /**
  2854. * Copies the given vector coordinates to the current Vector3 ones
  2855. * @param source defines the source Vector3
  2856. * @returns the current updated Vector3
  2857. */
  2858. copyFrom(source: DeepImmutable<Vector3>): Vector3;
  2859. /**
  2860. * Copies the given floats to the current Vector3 coordinates
  2861. * @param x defines the x coordinate of the operand
  2862. * @param y defines the y coordinate of the operand
  2863. * @param z defines the z coordinate of the operand
  2864. * @returns the current updated Vector3
  2865. */
  2866. copyFromFloats(x: number, y: number, z: number): Vector3;
  2867. /**
  2868. * Copies the given floats to the current Vector3 coordinates
  2869. * @param x defines the x coordinate of the operand
  2870. * @param y defines the y coordinate of the operand
  2871. * @param z defines the z coordinate of the operand
  2872. * @returns the current updated Vector3
  2873. */
  2874. set(x: number, y: number, z: number): Vector3;
  2875. /**
  2876. * Copies the given float to the current Vector3 coordinates
  2877. * @param v defines the x, y and z coordinates of the operand
  2878. * @returns the current updated Vector3
  2879. */
  2880. setAll(v: number): Vector3;
  2881. /**
  2882. * Get the clip factor between two vectors
  2883. * @param vector0 defines the first operand
  2884. * @param vector1 defines the second operand
  2885. * @param axis defines the axis to use
  2886. * @param size defines the size along the axis
  2887. * @returns the clip factor
  2888. */
  2889. static GetClipFactor(vector0: DeepImmutable<Vector3>, vector1: DeepImmutable<Vector3>, axis: DeepImmutable<Vector3>, size: number): number;
  2890. /**
  2891. * Get angle between two vectors
  2892. * @param vector0 angle between vector0 and vector1
  2893. * @param vector1 angle between vector0 and vector1
  2894. * @param normal direction of the normal
  2895. * @return the angle between vector0 and vector1
  2896. */
  2897. static GetAngleBetweenVectors(vector0: DeepImmutable<Vector3>, vector1: DeepImmutable<Vector3>, normal: DeepImmutable<Vector3>): number;
  2898. /**
  2899. * Returns a new Vector3 set from the index "offset" of the given array
  2900. * @param array defines the source array
  2901. * @param offset defines the offset in the source array
  2902. * @returns the new Vector3
  2903. */
  2904. static FromArray(array: DeepImmutable<ArrayLike<number>>, offset?: number): Vector3;
  2905. /**
  2906. * Returns a new Vector3 set from the index "offset" of the given Float32Array
  2907. * @param array defines the source array
  2908. * @param offset defines the offset in the source array
  2909. * @returns the new Vector3
  2910. * @deprecated Please use FromArray instead.
  2911. */
  2912. static FromFloatArray(array: DeepImmutable<Float32Array>, offset?: number): Vector3;
  2913. /**
  2914. * Sets the given vector "result" with the element values from the index "offset" of the given array
  2915. * @param array defines the source array
  2916. * @param offset defines the offset in the source array
  2917. * @param result defines the Vector3 where to store the result
  2918. */
  2919. static FromArrayToRef(array: DeepImmutable<ArrayLike<number>>, offset: number, result: Vector3): void;
  2920. /**
  2921. * Sets the given vector "result" with the element values from the index "offset" of the given Float32Array
  2922. * @param array defines the source array
  2923. * @param offset defines the offset in the source array
  2924. * @param result defines the Vector3 where to store the result
  2925. * @deprecated Please use FromArrayToRef instead.
  2926. */
  2927. static FromFloatArrayToRef(array: DeepImmutable<Float32Array>, offset: number, result: Vector3): void;
  2928. /**
  2929. * Sets the given vector "result" with the given floats.
  2930. * @param x defines the x coordinate of the source
  2931. * @param y defines the y coordinate of the source
  2932. * @param z defines the z coordinate of the source
  2933. * @param result defines the Vector3 where to store the result
  2934. */
  2935. static FromFloatsToRef(x: number, y: number, z: number, result: Vector3): void;
  2936. /**
  2937. * Returns a new Vector3 set to (0.0, 0.0, 0.0)
  2938. * @returns a new empty Vector3
  2939. */
  2940. static Zero(): Vector3;
  2941. /**
  2942. * Returns a new Vector3 set to (1.0, 1.0, 1.0)
  2943. * @returns a new unit Vector3
  2944. */
  2945. static One(): Vector3;
  2946. /**
  2947. * Returns a new Vector3 set to (0.0, 1.0, 0.0)
  2948. * @returns a new up Vector3
  2949. */
  2950. static Up(): Vector3;
  2951. /**
  2952. * Gets a up Vector3 that must not be updated
  2953. */
  2954. static get UpReadOnly(): DeepImmutable<Vector3>;
  2955. /**
  2956. * Gets a zero Vector3 that must not be updated
  2957. */
  2958. static get ZeroReadOnly(): DeepImmutable<Vector3>;
  2959. /**
  2960. * Returns a new Vector3 set to (0.0, -1.0, 0.0)
  2961. * @returns a new down Vector3
  2962. */
  2963. static Down(): Vector3;
  2964. /**
  2965. * Returns a new Vector3 set to (0.0, 0.0, 1.0)
  2966. * @param rightHandedSystem is the scene right-handed (negative z)
  2967. * @returns a new forward Vector3
  2968. */
  2969. static Forward(rightHandedSystem?: boolean): Vector3;
  2970. /**
  2971. * Returns a new Vector3 set to (0.0, 0.0, -1.0)
  2972. * @param rightHandedSystem is the scene right-handed (negative-z)
  2973. * @returns a new forward Vector3
  2974. */
  2975. static Backward(rightHandedSystem?: boolean): Vector3;
  2976. /**
  2977. * Returns a new Vector3 set to (1.0, 0.0, 0.0)
  2978. * @returns a new right Vector3
  2979. */
  2980. static Right(): Vector3;
  2981. /**
  2982. * Returns a new Vector3 set to (-1.0, 0.0, 0.0)
  2983. * @returns a new left Vector3
  2984. */
  2985. static Left(): Vector3;
  2986. /**
  2987. * Returns a new Vector3 set with the result of the transformation by the given matrix of the given vector.
  2988. * This method computes tranformed coordinates only, not transformed direction vectors (ie. it takes translation in account)
  2989. * @param vector defines the Vector3 to transform
  2990. * @param transformation defines the transformation matrix
  2991. * @returns the transformed Vector3
  2992. */
  2993. static TransformCoordinates(vector: DeepImmutable<Vector3>, transformation: DeepImmutable<Matrix>): Vector3;
  2994. /**
  2995. * Sets the given vector "result" coordinates with the result of the transformation by the given matrix of the given vector
  2996. * This method computes tranformed coordinates only, not transformed direction vectors (ie. it takes translation in account)
  2997. * @param vector defines the Vector3 to transform
  2998. * @param transformation defines the transformation matrix
  2999. * @param result defines the Vector3 where to store the result
  3000. */
  3001. static TransformCoordinatesToRef(vector: DeepImmutable<Vector3>, transformation: DeepImmutable<Matrix>, result: Vector3): void;
  3002. /**
  3003. * Sets the given vector "result" coordinates with the result of the transformation by the given matrix of the given floats (x, y, z)
  3004. * This method computes tranformed coordinates only, not transformed direction vectors
  3005. * @param x define the x coordinate of the source vector
  3006. * @param y define the y coordinate of the source vector
  3007. * @param z define the z coordinate of the source vector
  3008. * @param transformation defines the transformation matrix
  3009. * @param result defines the Vector3 where to store the result
  3010. */
  3011. static TransformCoordinatesFromFloatsToRef(x: number, y: number, z: number, transformation: DeepImmutable<Matrix>, result: Vector3): void;
  3012. /**
  3013. * Returns a new Vector3 set with the result of the normal transformation by the given matrix of the given vector
  3014. * This methods computes transformed normalized direction vectors only (ie. it does not apply translation)
  3015. * @param vector defines the Vector3 to transform
  3016. * @param transformation defines the transformation matrix
  3017. * @returns the new Vector3
  3018. */
  3019. static TransformNormal(vector: DeepImmutable<Vector3>, transformation: DeepImmutable<Matrix>): Vector3;
  3020. /**
  3021. * Sets the given vector "result" with the result of the normal transformation by the given matrix of the given vector
  3022. * This methods computes transformed normalized direction vectors only (ie. it does not apply translation)
  3023. * @param vector defines the Vector3 to transform
  3024. * @param transformation defines the transformation matrix
  3025. * @param result defines the Vector3 where to store the result
  3026. */
  3027. static TransformNormalToRef(vector: DeepImmutable<Vector3>, transformation: DeepImmutable<Matrix>, result: Vector3): void;
  3028. /**
  3029. * Sets the given vector "result" with the result of the normal transformation by the given matrix of the given floats (x, y, z)
  3030. * This methods computes transformed normalized direction vectors only (ie. it does not apply translation)
  3031. * @param x define the x coordinate of the source vector
  3032. * @param y define the y coordinate of the source vector
  3033. * @param z define the z coordinate of the source vector
  3034. * @param transformation defines the transformation matrix
  3035. * @param result defines the Vector3 where to store the result
  3036. */
  3037. static TransformNormalFromFloatsToRef(x: number, y: number, z: number, transformation: DeepImmutable<Matrix>, result: Vector3): void;
  3038. /**
  3039. * Returns a new Vector3 located for "amount" on the CatmullRom interpolation spline defined by the vectors "value1", "value2", "value3", "value4"
  3040. * @param value1 defines the first control point
  3041. * @param value2 defines the second control point
  3042. * @param value3 defines the third control point
  3043. * @param value4 defines the fourth control point
  3044. * @param amount defines the amount on the spline to use
  3045. * @returns the new Vector3
  3046. */
  3047. static CatmullRom(value1: DeepImmutable<Vector3>, value2: DeepImmutable<Vector3>, value3: DeepImmutable<Vector3>, value4: DeepImmutable<Vector3>, amount: number): Vector3;
  3048. /**
  3049. * Returns a new Vector3 set with the coordinates of "value", if the vector "value" is in the cube defined by the vectors "min" and "max"
  3050. * If a coordinate value of "value" is lower than one of the "min" coordinate, then this "value" coordinate is set with the "min" one
  3051. * If a coordinate value of "value" is greater than one of the "max" coordinate, then this "value" coordinate is set with the "max" one
  3052. * @param value defines the current value
  3053. * @param min defines the lower range value
  3054. * @param max defines the upper range value
  3055. * @returns the new Vector3
  3056. */
  3057. static Clamp(value: DeepImmutable<Vector3>, min: DeepImmutable<Vector3>, max: DeepImmutable<Vector3>): Vector3;
  3058. /**
  3059. * Sets the given vector "result" with the coordinates of "value", if the vector "value" is in the cube defined by the vectors "min" and "max"
  3060. * If a coordinate value of "value" is lower than one of the "min" coordinate, then this "value" coordinate is set with the "min" one
  3061. * If a coordinate value of "value" is greater than one of the "max" coordinate, then this "value" coordinate is set with the "max" one
  3062. * @param value defines the current value
  3063. * @param min defines the lower range value
  3064. * @param max defines the upper range value
  3065. * @param result defines the Vector3 where to store the result
  3066. */
  3067. static ClampToRef(value: DeepImmutable<Vector3>, min: DeepImmutable<Vector3>, max: DeepImmutable<Vector3>, result: Vector3): void;
  3068. /**
  3069. * Checks if a given vector is inside a specific range
  3070. * @param v defines the vector to test
  3071. * @param min defines the minimum range
  3072. * @param max defines the maximum range
  3073. */
  3074. static CheckExtends(v: Vector3, min: Vector3, max: Vector3): void;
  3075. /**
  3076. * Returns a new Vector3 located for "amount" (float) on the Hermite interpolation spline defined by the vectors "value1", "tangent1", "value2", "tangent2"
  3077. * @param value1 defines the first control point
  3078. * @param tangent1 defines the first tangent vector
  3079. * @param value2 defines the second control point
  3080. * @param tangent2 defines the second tangent vector
  3081. * @param amount defines the amount on the interpolation spline (between 0 and 1)
  3082. * @returns the new Vector3
  3083. */
  3084. static Hermite(value1: DeepImmutable<Vector3>, tangent1: DeepImmutable<Vector3>, value2: DeepImmutable<Vector3>, tangent2: DeepImmutable<Vector3>, amount: number): Vector3;
  3085. /**
  3086. * Returns a new Vector3 located for "amount" (float) on the linear interpolation between the vectors "start" and "end"
  3087. * @param start defines the start value
  3088. * @param end defines the end value
  3089. * @param amount max defines amount between both (between 0 and 1)
  3090. * @returns the new Vector3
  3091. */
  3092. static Lerp(start: DeepImmutable<Vector3>, end: DeepImmutable<Vector3>, amount: number): Vector3;
  3093. /**
  3094. * Sets the given vector "result" with the result of the linear interpolation from the vector "start" for "amount" to the vector "end"
  3095. * @param start defines the start value
  3096. * @param end defines the end value
  3097. * @param amount max defines amount between both (between 0 and 1)
  3098. * @param result defines the Vector3 where to store the result
  3099. */
  3100. static LerpToRef(start: DeepImmutable<Vector3>, end: DeepImmutable<Vector3>, amount: number, result: Vector3): void;
  3101. /**
  3102. * Returns the dot product (float) between the vectors "left" and "right"
  3103. * @param left defines the left operand
  3104. * @param right defines the right operand
  3105. * @returns the dot product
  3106. */
  3107. static Dot(left: DeepImmutable<Vector3>, right: DeepImmutable<Vector3>): number;
  3108. /**
  3109. * Returns a new Vector3 as the cross product of the vectors "left" and "right"
  3110. * The cross product is then orthogonal to both "left" and "right"
  3111. * @param left defines the left operand
  3112. * @param right defines the right operand
  3113. * @returns the cross product
  3114. */
  3115. static Cross(left: DeepImmutable<Vector3>, right: DeepImmutable<Vector3>): Vector3;
  3116. /**
  3117. * Sets the given vector "result" with the cross product of "left" and "right"
  3118. * The cross product is then orthogonal to both "left" and "right"
  3119. * @param left defines the left operand
  3120. * @param right defines the right operand
  3121. * @param result defines the Vector3 where to store the result
  3122. */
  3123. static CrossToRef(left: DeepImmutable<Vector3>, right: DeepImmutable<Vector3>, result: Vector3): void;
  3124. /**
  3125. * Returns a new Vector3 as the normalization of the given vector
  3126. * @param vector defines the Vector3 to normalize
  3127. * @returns the new Vector3
  3128. */
  3129. static Normalize(vector: DeepImmutable<Vector3>): Vector3;
  3130. /**
  3131. * Sets the given vector "result" with the normalization of the given first vector
  3132. * @param vector defines the Vector3 to normalize
  3133. * @param result defines the Vector3 where to store the result
  3134. */
  3135. static NormalizeToRef(vector: DeepImmutable<Vector3>, result: Vector3): void;
  3136. /**
  3137. * Project a Vector3 onto screen space
  3138. * @param vector defines the Vector3 to project
  3139. * @param world defines the world matrix to use
  3140. * @param transform defines the transform (view x projection) matrix to use
  3141. * @param viewport defines the screen viewport to use
  3142. * @returns the new Vector3
  3143. */
  3144. static Project(vector: DeepImmutable<Vector3>, world: DeepImmutable<Matrix>, transform: DeepImmutable<Matrix>, viewport: DeepImmutable<Viewport>): Vector3;
  3145. /** @hidden */
  3146. static _UnprojectFromInvertedMatrixToRef(source: DeepImmutable<Vector3>, matrix: DeepImmutable<Matrix>, result: Vector3): void;
  3147. /**
  3148. * Unproject from screen space to object space
  3149. * @param source defines the screen space Vector3 to use
  3150. * @param viewportWidth defines the current width of the viewport
  3151. * @param viewportHeight defines the current height of the viewport
  3152. * @param world defines the world matrix to use (can be set to Identity to go to world space)
  3153. * @param transform defines the transform (view x projection) matrix to use
  3154. * @returns the new Vector3
  3155. */
  3156. static UnprojectFromTransform(source: Vector3, viewportWidth: number, viewportHeight: number, world: DeepImmutable<Matrix>, transform: DeepImmutable<Matrix>): Vector3;
  3157. /**
  3158. * Unproject from screen space to object space
  3159. * @param source defines the screen space Vector3 to use
  3160. * @param viewportWidth defines the current width of the viewport
  3161. * @param viewportHeight defines the current height of the viewport
  3162. * @param world defines the world matrix to use (can be set to Identity to go to world space)
  3163. * @param view defines the view matrix to use
  3164. * @param projection defines the projection matrix to use
  3165. * @returns the new Vector3
  3166. */
  3167. static Unproject(source: DeepImmutable<Vector3>, viewportWidth: number, viewportHeight: number, world: DeepImmutable<Matrix>, view: DeepImmutable<Matrix>, projection: DeepImmutable<Matrix>): Vector3;
  3168. /**
  3169. * Unproject from screen space to object space
  3170. * @param source defines the screen space Vector3 to use
  3171. * @param viewportWidth defines the current width of the viewport
  3172. * @param viewportHeight defines the current height of the viewport
  3173. * @param world defines the world matrix to use (can be set to Identity to go to world space)
  3174. * @param view defines the view matrix to use
  3175. * @param projection defines the projection matrix to use
  3176. * @param result defines the Vector3 where to store the result
  3177. */
  3178. static UnprojectToRef(source: DeepImmutable<Vector3>, viewportWidth: number, viewportHeight: number, world: DeepImmutable<Matrix>, view: DeepImmutable<Matrix>, projection: DeepImmutable<Matrix>, result: Vector3): void;
  3179. /**
  3180. * Unproject from screen space to object space
  3181. * @param sourceX defines the screen space x coordinate to use
  3182. * @param sourceY defines the screen space y coordinate to use
  3183. * @param sourceZ defines the screen space z coordinate to use
  3184. * @param viewportWidth defines the current width of the viewport
  3185. * @param viewportHeight defines the current height of the viewport
  3186. * @param world defines the world matrix to use (can be set to Identity to go to world space)
  3187. * @param view defines the view matrix to use
  3188. * @param projection defines the projection matrix to use
  3189. * @param result defines the Vector3 where to store the result
  3190. */
  3191. static UnprojectFloatsToRef(sourceX: float, sourceY: float, sourceZ: float, viewportWidth: number, viewportHeight: number, world: DeepImmutable<Matrix>, view: DeepImmutable<Matrix>, projection: DeepImmutable<Matrix>, result: Vector3): void;
  3192. /**
  3193. * Gets the minimal coordinate values between two Vector3
  3194. * @param left defines the first operand
  3195. * @param right defines the second operand
  3196. * @returns the new Vector3
  3197. */
  3198. static Minimize(left: DeepImmutable<Vector3>, right: DeepImmutable<Vector3>): Vector3;
  3199. /**
  3200. * Gets the maximal coordinate values between two Vector3
  3201. * @param left defines the first operand
  3202. * @param right defines the second operand
  3203. * @returns the new Vector3
  3204. */
  3205. static Maximize(left: DeepImmutable<Vector3>, right: DeepImmutable<Vector3>): Vector3;
  3206. /**
  3207. * Returns the distance between the vectors "value1" and "value2"
  3208. * @param value1 defines the first operand
  3209. * @param value2 defines the second operand
  3210. * @returns the distance
  3211. */
  3212. static Distance(value1: DeepImmutable<Vector3>, value2: DeepImmutable<Vector3>): number;
  3213. /**
  3214. * Returns the squared distance between the vectors "value1" and "value2"
  3215. * @param value1 defines the first operand
  3216. * @param value2 defines the second operand
  3217. * @returns the squared distance
  3218. */
  3219. static DistanceSquared(value1: DeepImmutable<Vector3>, value2: DeepImmutable<Vector3>): number;
  3220. /**
  3221. * Returns a new Vector3 located at the center between "value1" and "value2"
  3222. * @param value1 defines the first operand
  3223. * @param value2 defines the second operand
  3224. * @returns the new Vector3
  3225. */
  3226. static Center(value1: DeepImmutable<Vector3>, value2: DeepImmutable<Vector3>): Vector3;
  3227. /**
  3228. * Given three orthogonal normalized left-handed oriented Vector3 axis in space (target system),
  3229. * RotationFromAxis() returns the rotation Euler angles (ex : rotation.x, rotation.y, rotation.z) to apply
  3230. * to something in order to rotate it from its local system to the given target system
  3231. * Note: axis1, axis2 and axis3 are normalized during this operation
  3232. * @param axis1 defines the first axis
  3233. * @param axis2 defines the second axis
  3234. * @param axis3 defines the third axis
  3235. * @returns a new Vector3
  3236. */
  3237. static RotationFromAxis(axis1: DeepImmutable<Vector3>, axis2: DeepImmutable<Vector3>, axis3: DeepImmutable<Vector3>): Vector3;
  3238. /**
  3239. * The same than RotationFromAxis but updates the given ref Vector3 parameter instead of returning a new Vector3
  3240. * @param axis1 defines the first axis
  3241. * @param axis2 defines the second axis
  3242. * @param axis3 defines the third axis
  3243. * @param ref defines the Vector3 where to store the result
  3244. */
  3245. static RotationFromAxisToRef(axis1: DeepImmutable<Vector3>, axis2: DeepImmutable<Vector3>, axis3: DeepImmutable<Vector3>, ref: Vector3): void;
  3246. }
  3247. /**
  3248. * Vector4 class created for EulerAngle class conversion to Quaternion
  3249. */
  3250. export class Vector4 {
  3251. /** x value of the vector */
  3252. x: number;
  3253. /** y value of the vector */
  3254. y: number;
  3255. /** z value of the vector */
  3256. z: number;
  3257. /** w value of the vector */
  3258. w: number;
  3259. /**
  3260. * Creates a Vector4 object from the given floats.
  3261. * @param x x value of the vector
  3262. * @param y y value of the vector
  3263. * @param z z value of the vector
  3264. * @param w w value of the vector
  3265. */
  3266. constructor(
  3267. /** x value of the vector */
  3268. x: number,
  3269. /** y value of the vector */
  3270. y: number,
  3271. /** z value of the vector */
  3272. z: number,
  3273. /** w value of the vector */
  3274. w: number);
  3275. /**
  3276. * Returns the string with the Vector4 coordinates.
  3277. * @returns a string containing all the vector values
  3278. */
  3279. toString(): string;
  3280. /**
  3281. * Returns the string "Vector4".
  3282. * @returns "Vector4"
  3283. */
  3284. getClassName(): string;
  3285. /**
  3286. * Returns the Vector4 hash code.
  3287. * @returns a unique hash code
  3288. */
  3289. getHashCode(): number;
  3290. /**
  3291. * Returns a new array populated with 4 elements : the Vector4 coordinates.
  3292. * @returns the resulting array
  3293. */
  3294. asArray(): number[];
  3295. /**
  3296. * Populates the given array from the given index with the Vector4 coordinates.
  3297. * @param array array to populate
  3298. * @param index index of the array to start at (default: 0)
  3299. * @returns the Vector4.
  3300. */
  3301. toArray(array: FloatArray, index?: number): Vector4;
  3302. /**
  3303. * Update the current vector from an array
  3304. * @param array defines the destination array
  3305. * @param index defines the offset in the destination array
  3306. * @returns the current Vector3
  3307. */
  3308. fromArray(array: FloatArray, index?: number): Vector4;
  3309. /**
  3310. * Adds the given vector to the current Vector4.
  3311. * @param otherVector the vector to add
  3312. * @returns the updated Vector4.
  3313. */
  3314. addInPlace(otherVector: DeepImmutable<Vector4>): Vector4;
  3315. /**
  3316. * Returns a new Vector4 as the result of the addition of the current Vector4 and the given one.
  3317. * @param otherVector the vector to add
  3318. * @returns the resulting vector
  3319. */
  3320. add(otherVector: DeepImmutable<Vector4>): Vector4;
  3321. /**
  3322. * Updates the given vector "result" with the result of the addition of the current Vector4 and the given one.
  3323. * @param otherVector the vector to add
  3324. * @param result the vector to store the result
  3325. * @returns the current Vector4.
  3326. */
  3327. addToRef(otherVector: DeepImmutable<Vector4>, result: Vector4): Vector4;
  3328. /**
  3329. * Subtract in place the given vector from the current Vector4.
  3330. * @param otherVector the vector to subtract
  3331. * @returns the updated Vector4.
  3332. */
  3333. subtractInPlace(otherVector: DeepImmutable<Vector4>): Vector4;
  3334. /**
  3335. * Returns a new Vector4 with the result of the subtraction of the given vector from the current Vector4.
  3336. * @param otherVector the vector to add
  3337. * @returns the new vector with the result
  3338. */
  3339. subtract(otherVector: DeepImmutable<Vector4>): Vector4;
  3340. /**
  3341. * Sets the given vector "result" with the result of the subtraction of the given vector from the current Vector4.
  3342. * @param otherVector the vector to subtract
  3343. * @param result the vector to store the result
  3344. * @returns the current Vector4.
  3345. */
  3346. subtractToRef(otherVector: DeepImmutable<Vector4>, result: Vector4): Vector4;
  3347. /**
  3348. * Returns a new Vector4 set with the result of the subtraction of the given floats from the current Vector4 coordinates.
  3349. */
  3350. /**
  3351. * Returns a new Vector4 set with the result of the subtraction of the given floats from the current Vector4 coordinates.
  3352. * @param x value to subtract
  3353. * @param y value to subtract
  3354. * @param z value to subtract
  3355. * @param w value to subtract
  3356. * @returns new vector containing the result
  3357. */
  3358. subtractFromFloats(x: number, y: number, z: number, w: number): Vector4;
  3359. /**
  3360. * Sets the given vector "result" set with the result of the subtraction of the given floats from the current Vector4 coordinates.
  3361. * @param x value to subtract
  3362. * @param y value to subtract
  3363. * @param z value to subtract
  3364. * @param w value to subtract
  3365. * @param result the vector to store the result in
  3366. * @returns the current Vector4.
  3367. */
  3368. subtractFromFloatsToRef(x: number, y: number, z: number, w: number, result: Vector4): Vector4;
  3369. /**
  3370. * Returns a new Vector4 set with the current Vector4 negated coordinates.
  3371. * @returns a new vector with the negated values
  3372. */
  3373. negate(): Vector4;
  3374. /**
  3375. * Negate this vector in place
  3376. * @returns this
  3377. */
  3378. negateInPlace(): Vector4;
  3379. /**
  3380. * Negate the current Vector4 and stores the result in the given vector "result" coordinates
  3381. * @param result defines the Vector3 object where to store the result
  3382. * @returns the current Vector4
  3383. */
  3384. negateToRef(result: Vector4): Vector4;
  3385. /**
  3386. * Multiplies the current Vector4 coordinates by scale (float).
  3387. * @param scale the number to scale with
  3388. * @returns the updated Vector4.
  3389. */
  3390. scaleInPlace(scale: number): Vector4;
  3391. /**
  3392. * Returns a new Vector4 set with the current Vector4 coordinates multiplied by scale (float).
  3393. * @param scale the number to scale with
  3394. * @returns a new vector with the result
  3395. */
  3396. scale(scale: number): Vector4;
  3397. /**
  3398. * Sets the given vector "result" with the current Vector4 coordinates multiplied by scale (float).
  3399. * @param scale the number to scale with
  3400. * @param result a vector to store the result in
  3401. * @returns the current Vector4.
  3402. */
  3403. scaleToRef(scale: number, result: Vector4): Vector4;
  3404. /**
  3405. * Scale the current Vector4 values by a factor and add the result to a given Vector4
  3406. * @param scale defines the scale factor
  3407. * @param result defines the Vector4 object where to store the result
  3408. * @returns the unmodified current Vector4
  3409. */
  3410. scaleAndAddToRef(scale: number, result: Vector4): Vector4;
  3411. /**
  3412. * Boolean : True if the current Vector4 coordinates are stricly equal to the given ones.
  3413. * @param otherVector the vector to compare against
  3414. * @returns true if they are equal
  3415. */
  3416. equals(otherVector: DeepImmutable<Vector4>): boolean;
  3417. /**
  3418. * Boolean : True if the current Vector4 coordinates are each beneath the distance "epsilon" from the given vector ones.
  3419. * @param otherVector vector to compare against
  3420. * @param epsilon (Default: very small number)
  3421. * @returns true if they are equal
  3422. */
  3423. equalsWithEpsilon(otherVector: DeepImmutable<Vector4>, epsilon?: number): boolean;
  3424. /**
  3425. * Boolean : True if the given floats are strictly equal to the current Vector4 coordinates.
  3426. * @param x x value to compare against
  3427. * @param y y value to compare against
  3428. * @param z z value to compare against
  3429. * @param w w value to compare against
  3430. * @returns true if equal
  3431. */
  3432. equalsToFloats(x: number, y: number, z: number, w: number): boolean;
  3433. /**
  3434. * Multiplies in place the current Vector4 by the given one.
  3435. * @param otherVector vector to multiple with
  3436. * @returns the updated Vector4.
  3437. */
  3438. multiplyInPlace(otherVector: Vector4): Vector4;
  3439. /**
  3440. * Returns a new Vector4 set with the multiplication result of the current Vector4 and the given one.
  3441. * @param otherVector vector to multiple with
  3442. * @returns resulting new vector
  3443. */
  3444. multiply(otherVector: DeepImmutable<Vector4>): Vector4;
  3445. /**
  3446. * Updates the given vector "result" with the multiplication result of the current Vector4 and the given one.
  3447. * @param otherVector vector to multiple with
  3448. * @param result vector to store the result
  3449. * @returns the current Vector4.
  3450. */
  3451. multiplyToRef(otherVector: DeepImmutable<Vector4>, result: Vector4): Vector4;
  3452. /**
  3453. * Returns a new Vector4 set with the multiplication result of the given floats and the current Vector4 coordinates.
  3454. * @param x x value multiply with
  3455. * @param y y value multiply with
  3456. * @param z z value multiply with
  3457. * @param w w value multiply with
  3458. * @returns resulting new vector
  3459. */
  3460. multiplyByFloats(x: number, y: number, z: number, w: number): Vector4;
  3461. /**
  3462. * Returns a new Vector4 set with the division result of the current Vector4 by the given one.
  3463. * @param otherVector vector to devide with
  3464. * @returns resulting new vector
  3465. */
  3466. divide(otherVector: DeepImmutable<Vector4>): Vector4;
  3467. /**
  3468. * Updates the given vector "result" with the division result of the current Vector4 by the given one.
  3469. * @param otherVector vector to devide with
  3470. * @param result vector to store the result
  3471. * @returns the current Vector4.
  3472. */
  3473. divideToRef(otherVector: DeepImmutable<Vector4>, result: Vector4): Vector4;
  3474. /**
  3475. * Divides the current Vector3 coordinates by the given ones.
  3476. * @param otherVector vector to devide with
  3477. * @returns the updated Vector3.
  3478. */
  3479. divideInPlace(otherVector: DeepImmutable<Vector4>): Vector4;
  3480. /**
  3481. * Updates the Vector4 coordinates with the minimum values between its own and the given vector ones
  3482. * @param other defines the second operand
  3483. * @returns the current updated Vector4
  3484. */
  3485. minimizeInPlace(other: DeepImmutable<Vector4>): Vector4;
  3486. /**
  3487. * Updates the Vector4 coordinates with the maximum values between its own and the given vector ones
  3488. * @param other defines the second operand
  3489. * @returns the current updated Vector4
  3490. */
  3491. maximizeInPlace(other: DeepImmutable<Vector4>): Vector4;
  3492. /**
  3493. * Gets a new Vector4 from current Vector4 floored values
  3494. * @returns a new Vector4
  3495. */
  3496. floor(): Vector4;
  3497. /**
  3498. * Gets a new Vector4 from current Vector3 floored values
  3499. * @returns a new Vector4
  3500. */
  3501. fract(): Vector4;
  3502. /**
  3503. * Returns the Vector4 length (float).
  3504. * @returns the length
  3505. */
  3506. length(): number;
  3507. /**
  3508. * Returns the Vector4 squared length (float).
  3509. * @returns the length squared
  3510. */
  3511. lengthSquared(): number;
  3512. /**
  3513. * Normalizes in place the Vector4.
  3514. * @returns the updated Vector4.
  3515. */
  3516. normalize(): Vector4;
  3517. /**
  3518. * Returns a new Vector3 from the Vector4 (x, y, z) coordinates.
  3519. * @returns this converted to a new vector3
  3520. */
  3521. toVector3(): Vector3;
  3522. /**
  3523. * Returns a new Vector4 copied from the current one.
  3524. * @returns the new cloned vector
  3525. */
  3526. clone(): Vector4;
  3527. /**
  3528. * Updates the current Vector4 with the given one coordinates.
  3529. * @param source the source vector to copy from
  3530. * @returns the updated Vector4.
  3531. */
  3532. copyFrom(source: DeepImmutable<Vector4>): Vector4;
  3533. /**
  3534. * Updates the current Vector4 coordinates with the given floats.
  3535. * @param x float to copy from
  3536. * @param y float to copy from
  3537. * @param z float to copy from
  3538. * @param w float to copy from
  3539. * @returns the updated Vector4.
  3540. */
  3541. copyFromFloats(x: number, y: number, z: number, w: number): Vector4;
  3542. /**
  3543. * Updates the current Vector4 coordinates with the given floats.
  3544. * @param x float to set from
  3545. * @param y float to set from
  3546. * @param z float to set from
  3547. * @param w float to set from
  3548. * @returns the updated Vector4.
  3549. */
  3550. set(x: number, y: number, z: number, w: number): Vector4;
  3551. /**
  3552. * Copies the given float to the current Vector3 coordinates
  3553. * @param v defines the x, y, z and w coordinates of the operand
  3554. * @returns the current updated Vector3
  3555. */
  3556. setAll(v: number): Vector4;
  3557. /**
  3558. * Returns a new Vector4 set from the starting index of the given array.
  3559. * @param array the array to pull values from
  3560. * @param offset the offset into the array to start at
  3561. * @returns the new vector
  3562. */
  3563. static FromArray(array: DeepImmutable<ArrayLike<number>>, offset?: number): Vector4;
  3564. /**
  3565. * Updates the given vector "result" from the starting index of the given array.
  3566. * @param array the array to pull values from
  3567. * @param offset the offset into the array to start at
  3568. * @param result the vector to store the result in
  3569. */
  3570. static FromArrayToRef(array: DeepImmutable<ArrayLike<number>>, offset: number, result: Vector4): void;
  3571. /**
  3572. * Updates the given vector "result" from the starting index of the given Float32Array.
  3573. * @param array the array to pull values from
  3574. * @param offset the offset into the array to start at
  3575. * @param result the vector to store the result in
  3576. */
  3577. static FromFloatArrayToRef(array: DeepImmutable<Float32Array>, offset: number, result: Vector4): void;
  3578. /**
  3579. * Updates the given vector "result" coordinates from the given floats.
  3580. * @param x float to set from
  3581. * @param y float to set from
  3582. * @param z float to set from
  3583. * @param w float to set from
  3584. * @param result the vector to the floats in
  3585. */
  3586. static FromFloatsToRef(x: number, y: number, z: number, w: number, result: Vector4): void;
  3587. /**
  3588. * Returns a new Vector4 set to (0.0, 0.0, 0.0, 0.0)
  3589. * @returns the new vector
  3590. */
  3591. static Zero(): Vector4;
  3592. /**
  3593. * Returns a new Vector4 set to (1.0, 1.0, 1.0, 1.0)
  3594. * @returns the new vector
  3595. */
  3596. static One(): Vector4;
  3597. /**
  3598. * Returns a new normalized Vector4 from the given one.
  3599. * @param vector the vector to normalize
  3600. * @returns the vector
  3601. */
  3602. static Normalize(vector: DeepImmutable<Vector4>): Vector4;
  3603. /**
  3604. * Updates the given vector "result" from the normalization of the given one.
  3605. * @param vector the vector to normalize
  3606. * @param result the vector to store the result in
  3607. */
  3608. static NormalizeToRef(vector: DeepImmutable<Vector4>, result: Vector4): void;
  3609. /**
  3610. * Returns a vector with the minimum values from the left and right vectors
  3611. * @param left left vector to minimize
  3612. * @param right right vector to minimize
  3613. * @returns a new vector with the minimum of the left and right vector values
  3614. */
  3615. static Minimize(left: DeepImmutable<Vector4>, right: DeepImmutable<Vector4>): Vector4;
  3616. /**
  3617. * Returns a vector with the maximum values from the left and right vectors
  3618. * @param left left vector to maximize
  3619. * @param right right vector to maximize
  3620. * @returns a new vector with the maximum of the left and right vector values
  3621. */
  3622. static Maximize(left: DeepImmutable<Vector4>, right: DeepImmutable<Vector4>): Vector4;
  3623. /**
  3624. * Returns the distance (float) between the vectors "value1" and "value2".
  3625. * @param value1 value to calulate the distance between
  3626. * @param value2 value to calulate the distance between
  3627. * @return the distance between the two vectors
  3628. */
  3629. static Distance(value1: DeepImmutable<Vector4>, value2: DeepImmutable<Vector4>): number;
  3630. /**
  3631. * Returns the squared distance (float) between the vectors "value1" and "value2".
  3632. * @param value1 value to calulate the distance between
  3633. * @param value2 value to calulate the distance between
  3634. * @return the distance between the two vectors squared
  3635. */
  3636. static DistanceSquared(value1: DeepImmutable<Vector4>, value2: DeepImmutable<Vector4>): number;
  3637. /**
  3638. * Returns a new Vector4 located at the center between the vectors "value1" and "value2".
  3639. * @param value1 value to calulate the center between
  3640. * @param value2 value to calulate the center between
  3641. * @return the center between the two vectors
  3642. */
  3643. static Center(value1: DeepImmutable<Vector4>, value2: DeepImmutable<Vector4>): Vector4;
  3644. /**
  3645. * Returns a new Vector4 set with the result of the normal transformation by the given matrix of the given vector.
  3646. * This methods computes transformed normalized direction vectors only.
  3647. * @param vector the vector to transform
  3648. * @param transformation the transformation matrix to apply
  3649. * @returns the new vector
  3650. */
  3651. static TransformNormal(vector: DeepImmutable<Vector4>, transformation: DeepImmutable<Matrix>): Vector4;
  3652. /**
  3653. * Sets the given vector "result" with the result of the normal transformation by the given matrix of the given vector.
  3654. * This methods computes transformed normalized direction vectors only.
  3655. * @param vector the vector to transform
  3656. * @param transformation the transformation matrix to apply
  3657. * @param result the vector to store the result in
  3658. */
  3659. static TransformNormalToRef(vector: DeepImmutable<Vector4>, transformation: DeepImmutable<Matrix>, result: Vector4): void;
  3660. /**
  3661. * Sets the given vector "result" with the result of the normal transformation by the given matrix of the given floats (x, y, z, w).
  3662. * This methods computes transformed normalized direction vectors only.
  3663. * @param x value to transform
  3664. * @param y value to transform
  3665. * @param z value to transform
  3666. * @param w value to transform
  3667. * @param transformation the transformation matrix to apply
  3668. * @param result the vector to store the results in
  3669. */
  3670. static TransformNormalFromFloatsToRef(x: number, y: number, z: number, w: number, transformation: DeepImmutable<Matrix>, result: Vector4): void;
  3671. /**
  3672. * Creates a new Vector4 from a Vector3
  3673. * @param source defines the source data
  3674. * @param w defines the 4th component (default is 0)
  3675. * @returns a new Vector4
  3676. */
  3677. static FromVector3(source: Vector3, w?: number): Vector4;
  3678. }
  3679. /**
  3680. * Class used to store quaternion data
  3681. * @see https://en.wikipedia.org/wiki/Quaternion
  3682. * @see https://doc.babylonjs.com/features/position,_rotation,_scaling
  3683. */
  3684. export class Quaternion {
  3685. /** @hidden */
  3686. _x: number;
  3687. /** @hidden */
  3688. _y: number;
  3689. /** @hidden */
  3690. _z: number;
  3691. /** @hidden */
  3692. _w: number;
  3693. /** @hidden */
  3694. _isDirty: boolean;
  3695. /** Gets or sets the x coordinate */
  3696. get x(): number;
  3697. set x(value: number);
  3698. /** Gets or sets the y coordinate */
  3699. get y(): number;
  3700. set y(value: number);
  3701. /** Gets or sets the z coordinate */
  3702. get z(): number;
  3703. set z(value: number);
  3704. /** Gets or sets the w coordinate */
  3705. get w(): number;
  3706. set w(value: number);
  3707. /**
  3708. * Creates a new Quaternion from the given floats
  3709. * @param x defines the first component (0 by default)
  3710. * @param y defines the second component (0 by default)
  3711. * @param z defines the third component (0 by default)
  3712. * @param w defines the fourth component (1.0 by default)
  3713. */
  3714. constructor(x?: number, y?: number, z?: number, w?: number);
  3715. /**
  3716. * Gets a string representation for the current quaternion
  3717. * @returns a string with the Quaternion coordinates
  3718. */
  3719. toString(): string;
  3720. /**
  3721. * Gets the class name of the quaternion
  3722. * @returns the string "Quaternion"
  3723. */
  3724. getClassName(): string;
  3725. /**
  3726. * Gets a hash code for this quaternion
  3727. * @returns the quaternion hash code
  3728. */
  3729. getHashCode(): number;
  3730. /**
  3731. * Copy the quaternion to an array
  3732. * @returns a new array populated with 4 elements from the quaternion coordinates
  3733. */
  3734. asArray(): number[];
  3735. /**
  3736. * Check if two quaternions are equals
  3737. * @param otherQuaternion defines the second operand
  3738. * @return true if the current quaternion and the given one coordinates are strictly equals
  3739. */
  3740. equals(otherQuaternion: DeepImmutable<Quaternion>): boolean;
  3741. /**
  3742. * Gets a boolean if two quaternions are equals (using an epsilon value)
  3743. * @param otherQuaternion defines the other quaternion
  3744. * @param epsilon defines the minimal distance to consider equality
  3745. * @returns true if the given quaternion coordinates are close to the current ones by a distance of epsilon.
  3746. */
  3747. equalsWithEpsilon(otherQuaternion: DeepImmutable<Quaternion>, epsilon?: number): boolean;
  3748. /**
  3749. * Clone the current quaternion
  3750. * @returns a new quaternion copied from the current one
  3751. */
  3752. clone(): Quaternion;
  3753. /**
  3754. * Copy a quaternion to the current one
  3755. * @param other defines the other quaternion
  3756. * @returns the updated current quaternion
  3757. */
  3758. copyFrom(other: DeepImmutable<Quaternion>): Quaternion;
  3759. /**
  3760. * Updates the current quaternion with the given float coordinates
  3761. * @param x defines the x coordinate
  3762. * @param y defines the y coordinate
  3763. * @param z defines the z coordinate
  3764. * @param w defines the w coordinate
  3765. * @returns the updated current quaternion
  3766. */
  3767. copyFromFloats(x: number, y: number, z: number, w: number): Quaternion;
  3768. /**
  3769. * Updates the current quaternion from the given float coordinates
  3770. * @param x defines the x coordinate
  3771. * @param y defines the y coordinate
  3772. * @param z defines the z coordinate
  3773. * @param w defines the w coordinate
  3774. * @returns the updated current quaternion
  3775. */
  3776. set(x: number, y: number, z: number, w: number): Quaternion;
  3777. /**
  3778. * Adds two quaternions
  3779. * @param other defines the second operand
  3780. * @returns a new quaternion as the addition result of the given one and the current quaternion
  3781. */
  3782. add(other: DeepImmutable<Quaternion>): Quaternion;
  3783. /**
  3784. * Add a quaternion to the current one
  3785. * @param other defines the quaternion to add
  3786. * @returns the current quaternion
  3787. */
  3788. addInPlace(other: DeepImmutable<Quaternion>): Quaternion;
  3789. /**
  3790. * Subtract two quaternions
  3791. * @param other defines the second operand
  3792. * @returns a new quaternion as the subtraction result of the given one from the current one
  3793. */
  3794. subtract(other: Quaternion): Quaternion;
  3795. /**
  3796. * Multiplies the current quaternion by a scale factor
  3797. * @param value defines the scale factor
  3798. * @returns a new quaternion set by multiplying the current quaternion coordinates by the float "scale"
  3799. */
  3800. scale(value: number): Quaternion;
  3801. /**
  3802. * Scale the current quaternion values by a factor and stores the result to a given quaternion
  3803. * @param scale defines the scale factor
  3804. * @param result defines the Quaternion object where to store the result
  3805. * @returns the unmodified current quaternion
  3806. */
  3807. scaleToRef(scale: number, result: Quaternion): Quaternion;
  3808. /**
  3809. * Multiplies in place the current quaternion by a scale factor
  3810. * @param value defines the scale factor
  3811. * @returns the current modified quaternion
  3812. */
  3813. scaleInPlace(value: number): Quaternion;
  3814. /**
  3815. * Scale the current quaternion values by a factor and add the result to a given quaternion
  3816. * @param scale defines the scale factor
  3817. * @param result defines the Quaternion object where to store the result
  3818. * @returns the unmodified current quaternion
  3819. */
  3820. scaleAndAddToRef(scale: number, result: Quaternion): Quaternion;
  3821. /**
  3822. * Multiplies two quaternions
  3823. * @param q1 defines the second operand
  3824. * @returns a new quaternion set as the multiplication result of the current one with the given one "q1"
  3825. */
  3826. multiply(q1: DeepImmutable<Quaternion>): Quaternion;
  3827. /**
  3828. * Sets the given "result" as the the multiplication result of the current one with the given one "q1"
  3829. * @param q1 defines the second operand
  3830. * @param result defines the target quaternion
  3831. * @returns the current quaternion
  3832. */
  3833. multiplyToRef(q1: DeepImmutable<Quaternion>, result: Quaternion): Quaternion;
  3834. /**
  3835. * Updates the current quaternion with the multiplication of itself with the given one "q1"
  3836. * @param q1 defines the second operand
  3837. * @returns the currentupdated quaternion
  3838. */
  3839. multiplyInPlace(q1: DeepImmutable<Quaternion>): Quaternion;
  3840. /**
  3841. * Conjugates (1-q) the current quaternion and stores the result in the given quaternion
  3842. * @param ref defines the target quaternion
  3843. * @returns the current quaternion
  3844. */
  3845. conjugateToRef(ref: Quaternion): Quaternion;
  3846. /**
  3847. * Conjugates in place (1-q) the current quaternion
  3848. * @returns the current updated quaternion
  3849. */
  3850. conjugateInPlace(): Quaternion;
  3851. /**
  3852. * Conjugates in place (1-q) the current quaternion
  3853. * @returns a new quaternion
  3854. */
  3855. conjugate(): Quaternion;
  3856. /**
  3857. * Gets length of current quaternion
  3858. * @returns the quaternion length (float)
  3859. */
  3860. length(): number;
  3861. /**
  3862. * Normalize in place the current quaternion
  3863. * @returns the current updated quaternion
  3864. */
  3865. normalize(): Quaternion;
  3866. /**
  3867. * Returns a new Vector3 set with the Euler angles translated from the current quaternion
  3868. * @param order is a reserved parameter and is ignore for now
  3869. * @returns a new Vector3 containing the Euler angles
  3870. */
  3871. toEulerAngles(order?: string): Vector3;
  3872. /**
  3873. * Sets the given vector3 "result" with the Euler angles translated from the current quaternion
  3874. * @param result defines the vector which will be filled with the Euler angles
  3875. * @param order is a reserved parameter and is ignore for now
  3876. * @returns the current unchanged quaternion
  3877. */
  3878. toEulerAnglesToRef(result: Vector3): Quaternion;
  3879. /**
  3880. * Updates the given rotation matrix with the current quaternion values
  3881. * @param result defines the target matrix
  3882. * @returns the current unchanged quaternion
  3883. */
  3884. toRotationMatrix(result: Matrix): Quaternion;
  3885. /**
  3886. * Updates the current quaternion from the given rotation matrix values
  3887. * @param matrix defines the source matrix
  3888. * @returns the current updated quaternion
  3889. */
  3890. fromRotationMatrix(matrix: DeepImmutable<Matrix>): Quaternion;
  3891. /**
  3892. * Creates a new quaternion from a rotation matrix
  3893. * @param matrix defines the source matrix
  3894. * @returns a new quaternion created from the given rotation matrix values
  3895. */
  3896. static FromRotationMatrix(matrix: DeepImmutable<Matrix>): Quaternion;
  3897. /**
  3898. * Updates the given quaternion with the given rotation matrix values
  3899. * @param matrix defines the source matrix
  3900. * @param result defines the target quaternion
  3901. */
  3902. static FromRotationMatrixToRef(matrix: DeepImmutable<Matrix>, result: Quaternion): void;
  3903. /**
  3904. * Returns the dot product (float) between the quaternions "left" and "right"
  3905. * @param left defines the left operand
  3906. * @param right defines the right operand
  3907. * @returns the dot product
  3908. */
  3909. static Dot(left: DeepImmutable<Quaternion>, right: DeepImmutable<Quaternion>): number;
  3910. /**
  3911. * Checks if the two quaternions are close to each other
  3912. * @param quat0 defines the first quaternion to check
  3913. * @param quat1 defines the second quaternion to check
  3914. * @returns true if the two quaternions are close to each other
  3915. */
  3916. static AreClose(quat0: DeepImmutable<Quaternion>, quat1: DeepImmutable<Quaternion>): boolean;
  3917. /**
  3918. * Creates an empty quaternion
  3919. * @returns a new quaternion set to (0.0, 0.0, 0.0)
  3920. */
  3921. static Zero(): Quaternion;
  3922. /**
  3923. * Inverse a given quaternion
  3924. * @param q defines the source quaternion
  3925. * @returns a new quaternion as the inverted current quaternion
  3926. */
  3927. static Inverse(q: DeepImmutable<Quaternion>): Quaternion;
  3928. /**
  3929. * Inverse a given quaternion
  3930. * @param q defines the source quaternion
  3931. * @param result the quaternion the result will be stored in
  3932. * @returns the result quaternion
  3933. */
  3934. static InverseToRef(q: Quaternion, result: Quaternion): Quaternion;
  3935. /**
  3936. * Creates an identity quaternion
  3937. * @returns the identity quaternion
  3938. */
  3939. static Identity(): Quaternion;
  3940. /**
  3941. * Gets a boolean indicating if the given quaternion is identity
  3942. * @param quaternion defines the quaternion to check
  3943. * @returns true if the quaternion is identity
  3944. */
  3945. static IsIdentity(quaternion: DeepImmutable<Quaternion>): boolean;
  3946. /**
  3947. * Creates a quaternion from a rotation around an axis
  3948. * @param axis defines the axis to use
  3949. * @param angle defines the angle to use
  3950. * @returns a new quaternion created from the given axis (Vector3) and angle in radians (float)
  3951. */
  3952. static RotationAxis(axis: DeepImmutable<Vector3>, angle: number): Quaternion;
  3953. /**
  3954. * Creates a rotation around an axis and stores it into the given quaternion
  3955. * @param axis defines the axis to use
  3956. * @param angle defines the angle to use
  3957. * @param result defines the target quaternion
  3958. * @returns the target quaternion
  3959. */
  3960. static RotationAxisToRef(axis: DeepImmutable<Vector3>, angle: number, result: Quaternion): Quaternion;
  3961. /**
  3962. * Creates a new quaternion from data stored into an array
  3963. * @param array defines the data source
  3964. * @param offset defines the offset in the source array where the data starts
  3965. * @returns a new quaternion
  3966. */
  3967. static FromArray(array: DeepImmutable<ArrayLike<number>>, offset?: number): Quaternion;
  3968. /**
  3969. * Updates the given quaternion "result" from the starting index of the given array.
  3970. * @param array the array to pull values from
  3971. * @param offset the offset into the array to start at
  3972. * @param result the quaternion to store the result in
  3973. */
  3974. static FromArrayToRef(array: DeepImmutable<ArrayLike<number>>, offset: number, result: Quaternion): void;
  3975. /**
  3976. * Create a quaternion from Euler rotation angles
  3977. * @param x Pitch
  3978. * @param y Yaw
  3979. * @param z Roll
  3980. * @returns the new Quaternion
  3981. */
  3982. static FromEulerAngles(x: number, y: number, z: number): Quaternion;
  3983. /**
  3984. * Updates a quaternion from Euler rotation angles
  3985. * @param x Pitch
  3986. * @param y Yaw
  3987. * @param z Roll
  3988. * @param result the quaternion to store the result
  3989. * @returns the updated quaternion
  3990. */
  3991. static FromEulerAnglesToRef(x: number, y: number, z: number, result: Quaternion): Quaternion;
  3992. /**
  3993. * Create a quaternion from Euler rotation vector
  3994. * @param vec the Euler vector (x Pitch, y Yaw, z Roll)
  3995. * @returns the new Quaternion
  3996. */
  3997. static FromEulerVector(vec: DeepImmutable<Vector3>): Quaternion;
  3998. /**
  3999. * Updates a quaternion from Euler rotation vector
  4000. * @param vec the Euler vector (x Pitch, y Yaw, z Roll)
  4001. * @param result the quaternion to store the result
  4002. * @returns the updated quaternion
  4003. */
  4004. static FromEulerVectorToRef(vec: DeepImmutable<Vector3>, result: Quaternion): Quaternion;
  4005. /**
  4006. * Creates a new quaternion from the given Euler float angles (y, x, z)
  4007. * @param yaw defines the rotation around Y axis
  4008. * @param pitch defines the rotation around X axis
  4009. * @param roll defines the rotation around Z axis
  4010. * @returns the new quaternion
  4011. */
  4012. static RotationYawPitchRoll(yaw: number, pitch: number, roll: number): Quaternion;
  4013. /**
  4014. * Creates a new rotation from the given Euler float angles (y, x, z) and stores it in the target quaternion
  4015. * @param yaw defines the rotation around Y axis
  4016. * @param pitch defines the rotation around X axis
  4017. * @param roll defines the rotation around Z axis
  4018. * @param result defines the target quaternion
  4019. */
  4020. static RotationYawPitchRollToRef(yaw: number, pitch: number, roll: number, result: Quaternion): void;
  4021. /**
  4022. * Creates a new quaternion from the given Euler float angles expressed in z-x-z orientation
  4023. * @param alpha defines the rotation around first axis
  4024. * @param beta defines the rotation around second axis
  4025. * @param gamma defines the rotation around third axis
  4026. * @returns the new quaternion
  4027. */
  4028. static RotationAlphaBetaGamma(alpha: number, beta: number, gamma: number): Quaternion;
  4029. /**
  4030. * Creates a new quaternion from the given Euler float angles expressed in z-x-z orientation and stores it in the target quaternion
  4031. * @param alpha defines the rotation around first axis
  4032. * @param beta defines the rotation around second axis
  4033. * @param gamma defines the rotation around third axis
  4034. * @param result defines the target quaternion
  4035. */
  4036. static RotationAlphaBetaGammaToRef(alpha: number, beta: number, gamma: number, result: Quaternion): void;
  4037. /**
  4038. * Creates a new quaternion containing the rotation value to reach the target (axis1, axis2, axis3) orientation as a rotated XYZ system (axis1, axis2 and axis3 are normalized during this operation)
  4039. * @param axis1 defines the first axis
  4040. * @param axis2 defines the second axis
  4041. * @param axis3 defines the third axis
  4042. * @returns the new quaternion
  4043. */
  4044. static RotationQuaternionFromAxis(axis1: DeepImmutable<Vector3>, axis2: DeepImmutable<Vector3>, axis3: DeepImmutable<Vector3>): Quaternion;
  4045. /**
  4046. * Creates a rotation value to reach the target (axis1, axis2, axis3) orientation as a rotated XYZ system (axis1, axis2 and axis3 are normalized during this operation) and stores it in the target quaternion
  4047. * @param axis1 defines the first axis
  4048. * @param axis2 defines the second axis
  4049. * @param axis3 defines the third axis
  4050. * @param ref defines the target quaternion
  4051. */
  4052. static RotationQuaternionFromAxisToRef(axis1: DeepImmutable<Vector3>, axis2: DeepImmutable<Vector3>, axis3: DeepImmutable<Vector3>, ref: Quaternion): void;
  4053. /**
  4054. * Interpolates between two quaternions
  4055. * @param left defines first quaternion
  4056. * @param right defines second quaternion
  4057. * @param amount defines the gradient to use
  4058. * @returns the new interpolated quaternion
  4059. */
  4060. static Slerp(left: DeepImmutable<Quaternion>, right: DeepImmutable<Quaternion>, amount: number): Quaternion;
  4061. /**
  4062. * Interpolates between two quaternions and stores it into a target quaternion
  4063. * @param left defines first quaternion
  4064. * @param right defines second quaternion
  4065. * @param amount defines the gradient to use
  4066. * @param result defines the target quaternion
  4067. */
  4068. static SlerpToRef(left: DeepImmutable<Quaternion>, right: DeepImmutable<Quaternion>, amount: number, result: Quaternion): void;
  4069. /**
  4070. * Interpolate between two quaternions using Hermite interpolation
  4071. * @param value1 defines first quaternion
  4072. * @param tangent1 defines the incoming tangent
  4073. * @param value2 defines second quaternion
  4074. * @param tangent2 defines the outgoing tangent
  4075. * @param amount defines the target quaternion
  4076. * @returns the new interpolated quaternion
  4077. */
  4078. static Hermite(value1: DeepImmutable<Quaternion>, tangent1: DeepImmutable<Quaternion>, value2: DeepImmutable<Quaternion>, tangent2: DeepImmutable<Quaternion>, amount: number): Quaternion;
  4079. }
  4080. /**
  4081. * Class used to store matrix data (4x4)
  4082. */
  4083. export class Matrix {
  4084. /**
  4085. * Gets the precision of matrix computations
  4086. */
  4087. static get Use64Bits(): boolean;
  4088. private static _updateFlagSeed;
  4089. private static _identityReadOnly;
  4090. private _isIdentity;
  4091. private _isIdentityDirty;
  4092. private _isIdentity3x2;
  4093. private _isIdentity3x2Dirty;
  4094. /**
  4095. * Gets the update flag of the matrix which is an unique number for the matrix.
  4096. * It will be incremented every time the matrix data change.
  4097. * You can use it to speed the comparison between two versions of the same matrix.
  4098. */
  4099. updateFlag: number;
  4100. private readonly _m;
  4101. /**
  4102. * Gets the internal data of the matrix
  4103. */
  4104. get m(): DeepImmutable<Float32Array | Array<number>>;
  4105. /** @hidden */
  4106. _markAsUpdated(): void;
  4107. /** @hidden */
  4108. private _updateIdentityStatus;
  4109. /**
  4110. * Creates an empty matrix (filled with zeros)
  4111. */
  4112. constructor();
  4113. /**
  4114. * Check if the current matrix is identity
  4115. * @returns true is the matrix is the identity matrix
  4116. */
  4117. isIdentity(): boolean;
  4118. /**
  4119. * Check if the current matrix is identity as a texture matrix (3x2 store in 4x4)
  4120. * @returns true is the matrix is the identity matrix
  4121. */
  4122. isIdentityAs3x2(): boolean;
  4123. /**
  4124. * Gets the determinant of the matrix
  4125. * @returns the matrix determinant
  4126. */
  4127. determinant(): number;
  4128. /**
  4129. * Returns the matrix as a Float32Array or Array<number>
  4130. * @returns the matrix underlying array
  4131. */
  4132. toArray(): DeepImmutable<Float32Array | Array<number>>;
  4133. /**
  4134. * Returns the matrix as a Float32Array or Array<number>
  4135. * @returns the matrix underlying array.
  4136. */
  4137. asArray(): DeepImmutable<Float32Array | Array<number>>;
  4138. /**
  4139. * Inverts the current matrix in place
  4140. * @returns the current inverted matrix
  4141. */
  4142. invert(): Matrix;
  4143. /**
  4144. * Sets all the matrix elements to zero
  4145. * @returns the current matrix
  4146. */
  4147. reset(): Matrix;
  4148. /**
  4149. * Adds the current matrix with a second one
  4150. * @param other defines the matrix to add
  4151. * @returns a new matrix as the addition of the current matrix and the given one
  4152. */
  4153. add(other: DeepImmutable<Matrix>): Matrix;
  4154. /**
  4155. * Sets the given matrix "result" to the addition of the current matrix and the given one
  4156. * @param other defines the matrix to add
  4157. * @param result defines the target matrix
  4158. * @returns the current matrix
  4159. */
  4160. addToRef(other: DeepImmutable<Matrix>, result: Matrix): Matrix;
  4161. /**
  4162. * Adds in place the given matrix to the current matrix
  4163. * @param other defines the second operand
  4164. * @returns the current updated matrix
  4165. */
  4166. addToSelf(other: DeepImmutable<Matrix>): Matrix;
  4167. /**
  4168. * Sets the given matrix to the current inverted Matrix
  4169. * @param other defines the target matrix
  4170. * @returns the unmodified current matrix
  4171. */
  4172. invertToRef(other: Matrix): Matrix;
  4173. /**
  4174. * add a value at the specified position in the current Matrix
  4175. * @param index the index of the value within the matrix. between 0 and 15.
  4176. * @param value the value to be added
  4177. * @returns the current updated matrix
  4178. */
  4179. addAtIndex(index: number, value: number): Matrix;
  4180. /**
  4181. * mutiply the specified position in the current Matrix by a value
  4182. * @param index the index of the value within the matrix. between 0 and 15.
  4183. * @param value the value to be added
  4184. * @returns the current updated matrix
  4185. */
  4186. multiplyAtIndex(index: number, value: number): Matrix;
  4187. /**
  4188. * Inserts the translation vector (using 3 floats) in the current matrix
  4189. * @param x defines the 1st component of the translation
  4190. * @param y defines the 2nd component of the translation
  4191. * @param z defines the 3rd component of the translation
  4192. * @returns the current updated matrix
  4193. */
  4194. setTranslationFromFloats(x: number, y: number, z: number): Matrix;
  4195. /**
  4196. * Adds the translation vector (using 3 floats) in the current matrix
  4197. * @param x defines the 1st component of the translation
  4198. * @param y defines the 2nd component of the translation
  4199. * @param z defines the 3rd component of the translation
  4200. * @returns the current updated matrix
  4201. */
  4202. addTranslationFromFloats(x: number, y: number, z: number): Matrix;
  4203. /**
  4204. * Inserts the translation vector in the current matrix
  4205. * @param vector3 defines the translation to insert
  4206. * @returns the current updated matrix
  4207. */
  4208. setTranslation(vector3: DeepImmutable<Vector3>): Matrix;
  4209. /**
  4210. * Gets the translation value of the current matrix
  4211. * @returns a new Vector3 as the extracted translation from the matrix
  4212. */
  4213. getTranslation(): Vector3;
  4214. /**
  4215. * Fill a Vector3 with the extracted translation from the matrix
  4216. * @param result defines the Vector3 where to store the translation
  4217. * @returns the current matrix
  4218. */
  4219. getTranslationToRef(result: Vector3): Matrix;
  4220. /**
  4221. * Remove rotation and scaling part from the matrix
  4222. * @returns the updated matrix
  4223. */
  4224. removeRotationAndScaling(): Matrix;
  4225. /**
  4226. * Multiply two matrices
  4227. * @param other defines the second operand
  4228. * @returns a new matrix set with the multiplication result of the current Matrix and the given one
  4229. */
  4230. multiply(other: DeepImmutable<Matrix>): Matrix;
  4231. /**
  4232. * Copy the current matrix from the given one
  4233. * @param other defines the source matrix
  4234. * @returns the current updated matrix
  4235. */
  4236. copyFrom(other: DeepImmutable<Matrix>): Matrix;
  4237. /**
  4238. * Populates the given array from the starting index with the current matrix values
  4239. * @param array defines the target array
  4240. * @param offset defines the offset in the target array where to start storing values
  4241. * @returns the current matrix
  4242. */
  4243. copyToArray(array: Float32Array | Array<number>, offset?: number): Matrix;
  4244. /**
  4245. * Sets the given matrix "result" with the multiplication result of the current Matrix and the given one
  4246. * @param other defines the second operand
  4247. * @param result defines the matrix where to store the multiplication
  4248. * @returns the current matrix
  4249. */
  4250. multiplyToRef(other: DeepImmutable<Matrix>, result: Matrix): Matrix;
  4251. /**
  4252. * Sets the Float32Array "result" from the given index "offset" with the multiplication of the current matrix and the given one
  4253. * @param other defines the second operand
  4254. * @param result defines the array where to store the multiplication
  4255. * @param offset defines the offset in the target array where to start storing values
  4256. * @returns the current matrix
  4257. */
  4258. multiplyToArray(other: DeepImmutable<Matrix>, result: Float32Array | Array<number>, offset: number): Matrix;
  4259. /**
  4260. * Check equality between this matrix and a second one
  4261. * @param value defines the second matrix to compare
  4262. * @returns true is the current matrix and the given one values are strictly equal
  4263. */
  4264. equals(value: DeepImmutable<Matrix>): boolean;
  4265. /**
  4266. * Clone the current matrix
  4267. * @returns a new matrix from the current matrix
  4268. */
  4269. clone(): Matrix;
  4270. /**
  4271. * Returns the name of the current matrix class
  4272. * @returns the string "Matrix"
  4273. */
  4274. getClassName(): string;
  4275. /**
  4276. * Gets the hash code of the current matrix
  4277. * @returns the hash code
  4278. */
  4279. getHashCode(): number;
  4280. /**
  4281. * Decomposes the current Matrix into a translation, rotation and scaling components
  4282. * @param scale defines the scale vector3 given as a reference to update
  4283. * @param rotation defines the rotation quaternion given as a reference to update
  4284. * @param translation defines the translation vector3 given as a reference to update
  4285. * @returns true if operation was successful
  4286. */
  4287. decompose(scale?: Vector3, rotation?: Quaternion, translation?: Vector3): boolean;
  4288. /**
  4289. * Gets specific row of the matrix
  4290. * @param index defines the number of the row to get
  4291. * @returns the index-th row of the current matrix as a new Vector4
  4292. */
  4293. getRow(index: number): Nullable<Vector4>;
  4294. /**
  4295. * Sets the index-th row of the current matrix to the vector4 values
  4296. * @param index defines the number of the row to set
  4297. * @param row defines the target vector4
  4298. * @returns the updated current matrix
  4299. */
  4300. setRow(index: number, row: Vector4): Matrix;
  4301. /**
  4302. * Compute the transpose of the matrix
  4303. * @returns the new transposed matrix
  4304. */
  4305. transpose(): Matrix;
  4306. /**
  4307. * Compute the transpose of the matrix and store it in a given matrix
  4308. * @param result defines the target matrix
  4309. * @returns the current matrix
  4310. */
  4311. transposeToRef(result: Matrix): Matrix;
  4312. /**
  4313. * Sets the index-th row of the current matrix with the given 4 x float values
  4314. * @param index defines the row index
  4315. * @param x defines the x component to set
  4316. * @param y defines the y component to set
  4317. * @param z defines the z component to set
  4318. * @param w defines the w component to set
  4319. * @returns the updated current matrix
  4320. */
  4321. setRowFromFloats(index: number, x: number, y: number, z: number, w: number): Matrix;
  4322. /**
  4323. * Compute a new matrix set with the current matrix values multiplied by scale (float)
  4324. * @param scale defines the scale factor
  4325. * @returns a new matrix
  4326. */
  4327. scale(scale: number): Matrix;
  4328. /**
  4329. * Scale the current matrix values by a factor to a given result matrix
  4330. * @param scale defines the scale factor
  4331. * @param result defines the matrix to store the result
  4332. * @returns the current matrix
  4333. */
  4334. scaleToRef(scale: number, result: Matrix): Matrix;
  4335. /**
  4336. * Scale the current matrix values by a factor and add the result to a given matrix
  4337. * @param scale defines the scale factor
  4338. * @param result defines the Matrix to store the result
  4339. * @returns the current matrix
  4340. */
  4341. scaleAndAddToRef(scale: number, result: Matrix): Matrix;
  4342. /**
  4343. * Writes to the given matrix a normal matrix, computed from this one (using values from identity matrix for fourth row and column).
  4344. * @param ref matrix to store the result
  4345. */
  4346. toNormalMatrix(ref: Matrix): void;
  4347. /**
  4348. * Gets only rotation part of the current matrix
  4349. * @returns a new matrix sets to the extracted rotation matrix from the current one
  4350. */
  4351. getRotationMatrix(): Matrix;
  4352. /**
  4353. * Extracts the rotation matrix from the current one and sets it as the given "result"
  4354. * @param result defines the target matrix to store data to
  4355. * @returns the current matrix
  4356. */
  4357. getRotationMatrixToRef(result: Matrix): Matrix;
  4358. /**
  4359. * Toggles model matrix from being right handed to left handed in place and vice versa
  4360. */
  4361. toggleModelMatrixHandInPlace(): void;
  4362. /**
  4363. * Toggles projection matrix from being right handed to left handed in place and vice versa
  4364. */
  4365. toggleProjectionMatrixHandInPlace(): void;
  4366. /**
  4367. * Creates a matrix from an array
  4368. * @param array defines the source array
  4369. * @param offset defines an offset in the source array
  4370. * @returns a new Matrix set from the starting index of the given array
  4371. */
  4372. static FromArray(array: DeepImmutable<ArrayLike<number>>, offset?: number): Matrix;
  4373. /**
  4374. * Copy the content of an array into a given matrix
  4375. * @param array defines the source array
  4376. * @param offset defines an offset in the source array
  4377. * @param result defines the target matrix
  4378. */
  4379. static FromArrayToRef(array: DeepImmutable<ArrayLike<number>>, offset: number, result: Matrix): void;
  4380. /**
  4381. * Stores an array into a matrix after having multiplied each component by a given factor
  4382. * @param array defines the source array
  4383. * @param offset defines the offset in the source array
  4384. * @param scale defines the scaling factor
  4385. * @param result defines the target matrix
  4386. */
  4387. static FromFloat32ArrayToRefScaled(array: DeepImmutable<Float32Array | Array<number>>, offset: number, scale: number, result: Matrix): void;
  4388. /**
  4389. * Gets an identity matrix that must not be updated
  4390. */
  4391. static get IdentityReadOnly(): DeepImmutable<Matrix>;
  4392. /**
  4393. * Stores a list of values (16) inside a given matrix
  4394. * @param initialM11 defines 1st value of 1st row
  4395. * @param initialM12 defines 2nd value of 1st row
  4396. * @param initialM13 defines 3rd value of 1st row
  4397. * @param initialM14 defines 4th value of 1st row
  4398. * @param initialM21 defines 1st value of 2nd row
  4399. * @param initialM22 defines 2nd value of 2nd row
  4400. * @param initialM23 defines 3rd value of 2nd row
  4401. * @param initialM24 defines 4th value of 2nd row
  4402. * @param initialM31 defines 1st value of 3rd row
  4403. * @param initialM32 defines 2nd value of 3rd row
  4404. * @param initialM33 defines 3rd value of 3rd row
  4405. * @param initialM34 defines 4th value of 3rd row
  4406. * @param initialM41 defines 1st value of 4th row
  4407. * @param initialM42 defines 2nd value of 4th row
  4408. * @param initialM43 defines 3rd value of 4th row
  4409. * @param initialM44 defines 4th value of 4th row
  4410. * @param result defines the target matrix
  4411. */
  4412. static FromValuesToRef(initialM11: number, initialM12: number, initialM13: number, initialM14: number, initialM21: number, initialM22: number, initialM23: number, initialM24: number, initialM31: number, initialM32: number, initialM33: number, initialM34: number, initialM41: number, initialM42: number, initialM43: number, initialM44: number, result: Matrix): void;
  4413. /**
  4414. * Creates new matrix from a list of values (16)
  4415. * @param initialM11 defines 1st value of 1st row
  4416. * @param initialM12 defines 2nd value of 1st row
  4417. * @param initialM13 defines 3rd value of 1st row
  4418. * @param initialM14 defines 4th value of 1st row
  4419. * @param initialM21 defines 1st value of 2nd row
  4420. * @param initialM22 defines 2nd value of 2nd row
  4421. * @param initialM23 defines 3rd value of 2nd row
  4422. * @param initialM24 defines 4th value of 2nd row
  4423. * @param initialM31 defines 1st value of 3rd row
  4424. * @param initialM32 defines 2nd value of 3rd row
  4425. * @param initialM33 defines 3rd value of 3rd row
  4426. * @param initialM34 defines 4th value of 3rd row
  4427. * @param initialM41 defines 1st value of 4th row
  4428. * @param initialM42 defines 2nd value of 4th row
  4429. * @param initialM43 defines 3rd value of 4th row
  4430. * @param initialM44 defines 4th value of 4th row
  4431. * @returns the new matrix
  4432. */
  4433. static FromValues(initialM11: number, initialM12: number, initialM13: number, initialM14: number, initialM21: number, initialM22: number, initialM23: number, initialM24: number, initialM31: number, initialM32: number, initialM33: number, initialM34: number, initialM41: number, initialM42: number, initialM43: number, initialM44: number): Matrix;
  4434. /**
  4435. * Creates a new matrix composed by merging scale (vector3), rotation (quaternion) and translation (vector3)
  4436. * @param scale defines the scale vector3
  4437. * @param rotation defines the rotation quaternion
  4438. * @param translation defines the translation vector3
  4439. * @returns a new matrix
  4440. */
  4441. static Compose(scale: DeepImmutable<Vector3>, rotation: DeepImmutable<Quaternion>, translation: DeepImmutable<Vector3>): Matrix;
  4442. /**
  4443. * Sets a matrix to a value composed by merging scale (vector3), rotation (quaternion) and translation (vector3)
  4444. * @param scale defines the scale vector3
  4445. * @param rotation defines the rotation quaternion
  4446. * @param translation defines the translation vector3
  4447. * @param result defines the target matrix
  4448. */
  4449. static ComposeToRef(scale: DeepImmutable<Vector3>, rotation: DeepImmutable<Quaternion>, translation: DeepImmutable<Vector3>, result: Matrix): void;
  4450. /**
  4451. * Creates a new identity matrix
  4452. * @returns a new identity matrix
  4453. */
  4454. static Identity(): Matrix;
  4455. /**
  4456. * Creates a new identity matrix and stores the result in a given matrix
  4457. * @param result defines the target matrix
  4458. */
  4459. static IdentityToRef(result: Matrix): void;
  4460. /**
  4461. * Creates a new zero matrix
  4462. * @returns a new zero matrix
  4463. */
  4464. static Zero(): Matrix;
  4465. /**
  4466. * Creates a new rotation matrix for "angle" radians around the X axis
  4467. * @param angle defines the angle (in radians) to use
  4468. * @return the new matrix
  4469. */
  4470. static RotationX(angle: number): Matrix;
  4471. /**
  4472. * Creates a new matrix as the invert of a given matrix
  4473. * @param source defines the source matrix
  4474. * @returns the new matrix
  4475. */
  4476. static Invert(source: DeepImmutable<Matrix>): Matrix;
  4477. /**
  4478. * Creates a new rotation matrix for "angle" radians around the X axis and stores it in a given matrix
  4479. * @param angle defines the angle (in radians) to use
  4480. * @param result defines the target matrix
  4481. */
  4482. static RotationXToRef(angle: number, result: Matrix): void;
  4483. /**
  4484. * Creates a new rotation matrix for "angle" radians around the Y axis
  4485. * @param angle defines the angle (in radians) to use
  4486. * @return the new matrix
  4487. */
  4488. static RotationY(angle: number): Matrix;
  4489. /**
  4490. * Creates a new rotation matrix for "angle" radians around the Y axis and stores it in a given matrix
  4491. * @param angle defines the angle (in radians) to use
  4492. * @param result defines the target matrix
  4493. */
  4494. static RotationYToRef(angle: number, result: Matrix): void;
  4495. /**
  4496. * Creates a new rotation matrix for "angle" radians around the Z axis
  4497. * @param angle defines the angle (in radians) to use
  4498. * @return the new matrix
  4499. */
  4500. static RotationZ(angle: number): Matrix;
  4501. /**
  4502. * Creates a new rotation matrix for "angle" radians around the Z axis and stores it in a given matrix
  4503. * @param angle defines the angle (in radians) to use
  4504. * @param result defines the target matrix
  4505. */
  4506. static RotationZToRef(angle: number, result: Matrix): void;
  4507. /**
  4508. * Creates a new rotation matrix for "angle" radians around the given axis
  4509. * @param axis defines the axis to use
  4510. * @param angle defines the angle (in radians) to use
  4511. * @return the new matrix
  4512. */
  4513. static RotationAxis(axis: DeepImmutable<Vector3>, angle: number): Matrix;
  4514. /**
  4515. * Creates a new rotation matrix for "angle" radians around the given axis and stores it in a given matrix
  4516. * @param axis defines the axis to use
  4517. * @param angle defines the angle (in radians) to use
  4518. * @param result defines the target matrix
  4519. */
  4520. static RotationAxisToRef(axis: DeepImmutable<Vector3>, angle: number, result: Matrix): void;
  4521. /**
  4522. * Takes normalised vectors and returns a rotation matrix to align "from" with "to".
  4523. * Taken from http://www.iquilezles.org/www/articles/noacos/noacos.htm
  4524. * @param from defines the vector to align
  4525. * @param to defines the vector to align to
  4526. * @param result defines the target matrix
  4527. */
  4528. static RotationAlignToRef(from: DeepImmutable<Vector3>, to: DeepImmutable<Vector3>, result: Matrix): void;
  4529. /**
  4530. * Creates a rotation matrix
  4531. * @param yaw defines the yaw angle in radians (Y axis)
  4532. * @param pitch defines the pitch angle in radians (X axis)
  4533. * @param roll defines the roll angle in radians (Z axis)
  4534. * @returns the new rotation matrix
  4535. */
  4536. static RotationYawPitchRoll(yaw: number, pitch: number, roll: number): Matrix;
  4537. /**
  4538. * Creates a rotation matrix and stores it in a given matrix
  4539. * @param yaw defines the yaw angle in radians (Y axis)
  4540. * @param pitch defines the pitch angle in radians (X axis)
  4541. * @param roll defines the roll angle in radians (Z axis)
  4542. * @param result defines the target matrix
  4543. */
  4544. static RotationYawPitchRollToRef(yaw: number, pitch: number, roll: number, result: Matrix): void;
  4545. /**
  4546. * Creates a scaling matrix
  4547. * @param x defines the scale factor on X axis
  4548. * @param y defines the scale factor on Y axis
  4549. * @param z defines the scale factor on Z axis
  4550. * @returns the new matrix
  4551. */
  4552. static Scaling(x: number, y: number, z: number): Matrix;
  4553. /**
  4554. * Creates a scaling matrix and stores it in a given matrix
  4555. * @param x defines the scale factor on X axis
  4556. * @param y defines the scale factor on Y axis
  4557. * @param z defines the scale factor on Z axis
  4558. * @param result defines the target matrix
  4559. */
  4560. static ScalingToRef(x: number, y: number, z: number, result: Matrix): void;
  4561. /**
  4562. * Creates a translation matrix
  4563. * @param x defines the translation on X axis
  4564. * @param y defines the translation on Y axis
  4565. * @param z defines the translationon Z axis
  4566. * @returns the new matrix
  4567. */
  4568. static Translation(x: number, y: number, z: number): Matrix;
  4569. /**
  4570. * Creates a translation matrix and stores it in a given matrix
  4571. * @param x defines the translation on X axis
  4572. * @param y defines the translation on Y axis
  4573. * @param z defines the translationon Z axis
  4574. * @param result defines the target matrix
  4575. */
  4576. static TranslationToRef(x: number, y: number, z: number, result: Matrix): void;
  4577. /**
  4578. * Returns a new Matrix whose values are the interpolated values for "gradient" (float) between the ones of the matrices "startValue" and "endValue".
  4579. * @param startValue defines the start value
  4580. * @param endValue defines the end value
  4581. * @param gradient defines the gradient factor
  4582. * @returns the new matrix
  4583. */
  4584. static Lerp(startValue: DeepImmutable<Matrix>, endValue: DeepImmutable<Matrix>, gradient: number): Matrix;
  4585. /**
  4586. * Set the given matrix "result" as the interpolated values for "gradient" (float) between the ones of the matrices "startValue" and "endValue".
  4587. * @param startValue defines the start value
  4588. * @param endValue defines the end value
  4589. * @param gradient defines the gradient factor
  4590. * @param result defines the Matrix object where to store data
  4591. */
  4592. static LerpToRef(startValue: DeepImmutable<Matrix>, endValue: DeepImmutable<Matrix>, gradient: number, result: Matrix): void;
  4593. /**
  4594. * Builds a new matrix whose values are computed by:
  4595. * * decomposing the the "startValue" and "endValue" matrices into their respective scale, rotation and translation matrices
  4596. * * interpolating for "gradient" (float) the values between each of these decomposed matrices between the start and the end
  4597. * * recomposing a new matrix from these 3 interpolated scale, rotation and translation matrices
  4598. * @param startValue defines the first matrix
  4599. * @param endValue defines the second matrix
  4600. * @param gradient defines the gradient between the two matrices
  4601. * @returns the new matrix
  4602. */
  4603. static DecomposeLerp(startValue: DeepImmutable<Matrix>, endValue: DeepImmutable<Matrix>, gradient: number): Matrix;
  4604. /**
  4605. * Update a matrix to values which are computed by:
  4606. * * decomposing the the "startValue" and "endValue" matrices into their respective scale, rotation and translation matrices
  4607. * * interpolating for "gradient" (float) the values between each of these decomposed matrices between the start and the end
  4608. * * recomposing a new matrix from these 3 interpolated scale, rotation and translation matrices
  4609. * @param startValue defines the first matrix
  4610. * @param endValue defines the second matrix
  4611. * @param gradient defines the gradient between the two matrices
  4612. * @param result defines the target matrix
  4613. */
  4614. static DecomposeLerpToRef(startValue: DeepImmutable<Matrix>, endValue: DeepImmutable<Matrix>, gradient: number, result: Matrix): void;
  4615. /**
  4616. * Gets a new rotation matrix used to rotate an entity so as it looks at the target vector3, from the eye vector3 position, the up vector3 being oriented like "up"
  4617. * This function works in left handed mode
  4618. * @param eye defines the final position of the entity
  4619. * @param target defines where the entity should look at
  4620. * @param up defines the up vector for the entity
  4621. * @returns the new matrix
  4622. */
  4623. static LookAtLH(eye: DeepImmutable<Vector3>, target: DeepImmutable<Vector3>, up: DeepImmutable<Vector3>): Matrix;
  4624. /**
  4625. * Sets the given "result" Matrix to a rotation matrix used to rotate an entity so that it looks at the target vector3, from the eye vector3 position, the up vector3 being oriented like "up".
  4626. * This function works in left handed mode
  4627. * @param eye defines the final position of the entity
  4628. * @param target defines where the entity should look at
  4629. * @param up defines the up vector for the entity
  4630. * @param result defines the target matrix
  4631. */
  4632. static LookAtLHToRef(eye: DeepImmutable<Vector3>, target: DeepImmutable<Vector3>, up: DeepImmutable<Vector3>, result: Matrix): void;
  4633. /**
  4634. * Gets a new rotation matrix used to rotate an entity so as it looks at the target vector3, from the eye vector3 position, the up vector3 being oriented like "up"
  4635. * This function works in right handed mode
  4636. * @param eye defines the final position of the entity
  4637. * @param target defines where the entity should look at
  4638. * @param up defines the up vector for the entity
  4639. * @returns the new matrix
  4640. */
  4641. static LookAtRH(eye: DeepImmutable<Vector3>, target: DeepImmutable<Vector3>, up: DeepImmutable<Vector3>): Matrix;
  4642. /**
  4643. * Sets the given "result" Matrix to a rotation matrix used to rotate an entity so that it looks at the target vector3, from the eye vector3 position, the up vector3 being oriented like "up".
  4644. * This function works in right handed mode
  4645. * @param eye defines the final position of the entity
  4646. * @param target defines where the entity should look at
  4647. * @param up defines the up vector for the entity
  4648. * @param result defines the target matrix
  4649. */
  4650. static LookAtRHToRef(eye: DeepImmutable<Vector3>, target: DeepImmutable<Vector3>, up: DeepImmutable<Vector3>, result: Matrix): void;
  4651. /**
  4652. * Create a left-handed orthographic projection matrix
  4653. * @param width defines the viewport width
  4654. * @param height defines the viewport height
  4655. * @param znear defines the near clip plane
  4656. * @param zfar defines the far clip plane
  4657. * @returns a new matrix as a left-handed orthographic projection matrix
  4658. */
  4659. static OrthoLH(width: number, height: number, znear: number, zfar: number): Matrix;
  4660. /**
  4661. * Store a left-handed orthographic projection to a given matrix
  4662. * @param width defines the viewport width
  4663. * @param height defines the viewport height
  4664. * @param znear defines the near clip plane
  4665. * @param zfar defines the far clip plane
  4666. * @param result defines the target matrix
  4667. */
  4668. static OrthoLHToRef(width: number, height: number, znear: number, zfar: number, result: Matrix): void;
  4669. /**
  4670. * Create a left-handed orthographic projection matrix
  4671. * @param left defines the viewport left coordinate
  4672. * @param right defines the viewport right coordinate
  4673. * @param bottom defines the viewport bottom coordinate
  4674. * @param top defines the viewport top coordinate
  4675. * @param znear defines the near clip plane
  4676. * @param zfar defines the far clip plane
  4677. * @returns a new matrix as a left-handed orthographic projection matrix
  4678. */
  4679. static OrthoOffCenterLH(left: number, right: number, bottom: number, top: number, znear: number, zfar: number): Matrix;
  4680. /**
  4681. * Stores a left-handed orthographic projection into a given matrix
  4682. * @param left defines the viewport left coordinate
  4683. * @param right defines the viewport right coordinate
  4684. * @param bottom defines the viewport bottom coordinate
  4685. * @param top defines the viewport top coordinate
  4686. * @param znear defines the near clip plane
  4687. * @param zfar defines the far clip plane
  4688. * @param result defines the target matrix
  4689. */
  4690. static OrthoOffCenterLHToRef(left: number, right: number, bottom: number, top: number, znear: number, zfar: number, result: Matrix): void;
  4691. /**
  4692. * Creates a right-handed orthographic projection matrix
  4693. * @param left defines the viewport left coordinate
  4694. * @param right defines the viewport right coordinate
  4695. * @param bottom defines the viewport bottom coordinate
  4696. * @param top defines the viewport top coordinate
  4697. * @param znear defines the near clip plane
  4698. * @param zfar defines the far clip plane
  4699. * @returns a new matrix as a right-handed orthographic projection matrix
  4700. */
  4701. static OrthoOffCenterRH(left: number, right: number, bottom: number, top: number, znear: number, zfar: number): Matrix;
  4702. /**
  4703. * Stores a right-handed orthographic projection into a given matrix
  4704. * @param left defines the viewport left coordinate
  4705. * @param right defines the viewport right coordinate
  4706. * @param bottom defines the viewport bottom coordinate
  4707. * @param top defines the viewport top coordinate
  4708. * @param znear defines the near clip plane
  4709. * @param zfar defines the far clip plane
  4710. * @param result defines the target matrix
  4711. */
  4712. static OrthoOffCenterRHToRef(left: number, right: number, bottom: number, top: number, znear: number, zfar: number, result: Matrix): void;
  4713. /**
  4714. * Creates a left-handed perspective projection matrix
  4715. * @param width defines the viewport width
  4716. * @param height defines the viewport height
  4717. * @param znear defines the near clip plane
  4718. * @param zfar defines the far clip plane
  4719. * @returns a new matrix as a left-handed perspective projection matrix
  4720. */
  4721. static PerspectiveLH(width: number, height: number, znear: number, zfar: number): Matrix;
  4722. /**
  4723. * Creates a left-handed perspective projection matrix
  4724. * @param fov defines the horizontal field of view
  4725. * @param aspect defines the aspect ratio
  4726. * @param znear defines the near clip plane
  4727. * @param zfar defines the far clip plane
  4728. * @returns a new matrix as a left-handed perspective projection matrix
  4729. */
  4730. static PerspectiveFovLH(fov: number, aspect: number, znear: number, zfar: number): Matrix;
  4731. /**
  4732. * Stores a left-handed perspective projection into a given matrix
  4733. * @param fov defines the horizontal field of view
  4734. * @param aspect defines the aspect ratio
  4735. * @param znear defines the near clip plane
  4736. * @param zfar defines the far clip plane
  4737. * @param result defines the target matrix
  4738. * @param isVerticalFovFixed defines it the fov is vertically fixed (default) or horizontally
  4739. */
  4740. static PerspectiveFovLHToRef(fov: number, aspect: number, znear: number, zfar: number, result: Matrix, isVerticalFovFixed?: boolean): void;
  4741. /**
  4742. * Stores a left-handed perspective projection into a given matrix with depth reversed
  4743. * @param fov defines the horizontal field of view
  4744. * @param aspect defines the aspect ratio
  4745. * @param znear defines the near clip plane
  4746. * @param zfar not used as infinity is used as far clip
  4747. * @param result defines the target matrix
  4748. * @param isVerticalFovFixed defines it the fov is vertically fixed (default) or horizontally
  4749. */
  4750. static PerspectiveFovReverseLHToRef(fov: number, aspect: number, znear: number, zfar: number, result: Matrix, isVerticalFovFixed?: boolean): void;
  4751. /**
  4752. * Creates a right-handed perspective projection matrix
  4753. * @param fov defines the horizontal field of view
  4754. * @param aspect defines the aspect ratio
  4755. * @param znear defines the near clip plane
  4756. * @param zfar defines the far clip plane
  4757. * @returns a new matrix as a right-handed perspective projection matrix
  4758. */
  4759. static PerspectiveFovRH(fov: number, aspect: number, znear: number, zfar: number): Matrix;
  4760. /**
  4761. * Stores a right-handed perspective projection into a given matrix
  4762. * @param fov defines the horizontal field of view
  4763. * @param aspect defines the aspect ratio
  4764. * @param znear defines the near clip plane
  4765. * @param zfar defines the far clip plane
  4766. * @param result defines the target matrix
  4767. * @param isVerticalFovFixed defines it the fov is vertically fixed (default) or horizontally
  4768. */
  4769. static PerspectiveFovRHToRef(fov: number, aspect: number, znear: number, zfar: number, result: Matrix, isVerticalFovFixed?: boolean): void;
  4770. /**
  4771. * Stores a right-handed perspective projection into a given matrix
  4772. * @param fov defines the horizontal field of view
  4773. * @param aspect defines the aspect ratio
  4774. * @param znear defines the near clip plane
  4775. * @param zfar not used as infinity is used as far clip
  4776. * @param result defines the target matrix
  4777. * @param isVerticalFovFixed defines it the fov is vertically fixed (default) or horizontally
  4778. */
  4779. static PerspectiveFovReverseRHToRef(fov: number, aspect: number, znear: number, zfar: number, result: Matrix, isVerticalFovFixed?: boolean): void;
  4780. /**
  4781. * Stores a perspective projection for WebVR info a given matrix
  4782. * @param fov defines the field of view
  4783. * @param znear defines the near clip plane
  4784. * @param zfar defines the far clip plane
  4785. * @param result defines the target matrix
  4786. * @param rightHanded defines if the matrix must be in right-handed mode (false by default)
  4787. */
  4788. static PerspectiveFovWebVRToRef(fov: {
  4789. upDegrees: number;
  4790. downDegrees: number;
  4791. leftDegrees: number;
  4792. rightDegrees: number;
  4793. }, znear: number, zfar: number, result: Matrix, rightHanded?: boolean): void;
  4794. /**
  4795. * Computes a complete transformation matrix
  4796. * @param viewport defines the viewport to use
  4797. * @param world defines the world matrix
  4798. * @param view defines the view matrix
  4799. * @param projection defines the projection matrix
  4800. * @param zmin defines the near clip plane
  4801. * @param zmax defines the far clip plane
  4802. * @returns the transformation matrix
  4803. */
  4804. static GetFinalMatrix(viewport: DeepImmutable<Viewport>, world: DeepImmutable<Matrix>, view: DeepImmutable<Matrix>, projection: DeepImmutable<Matrix>, zmin: number, zmax: number): Matrix;
  4805. /**
  4806. * Extracts a 2x2 matrix from a given matrix and store the result in a Float32Array
  4807. * @param matrix defines the matrix to use
  4808. * @returns a new Float32Array array with 4 elements : the 2x2 matrix extracted from the given matrix
  4809. */
  4810. static GetAsMatrix2x2(matrix: DeepImmutable<Matrix>): Float32Array | Array<number>;
  4811. /**
  4812. * Extracts a 3x3 matrix from a given matrix and store the result in a Float32Array
  4813. * @param matrix defines the matrix to use
  4814. * @returns a new Float32Array array with 9 elements : the 3x3 matrix extracted from the given matrix
  4815. */
  4816. static GetAsMatrix3x3(matrix: DeepImmutable<Matrix>): Float32Array | Array<number>;
  4817. /**
  4818. * Compute the transpose of a given matrix
  4819. * @param matrix defines the matrix to transpose
  4820. * @returns the new matrix
  4821. */
  4822. static Transpose(matrix: DeepImmutable<Matrix>): Matrix;
  4823. /**
  4824. * Compute the transpose of a matrix and store it in a target matrix
  4825. * @param matrix defines the matrix to transpose
  4826. * @param result defines the target matrix
  4827. */
  4828. static TransposeToRef(matrix: DeepImmutable<Matrix>, result: Matrix): void;
  4829. /**
  4830. * Computes a reflection matrix from a plane
  4831. * @param plane defines the reflection plane
  4832. * @returns a new matrix
  4833. */
  4834. static Reflection(plane: DeepImmutable<IPlaneLike>): Matrix;
  4835. /**
  4836. * Computes a reflection matrix from a plane
  4837. * @param plane defines the reflection plane
  4838. * @param result defines the target matrix
  4839. */
  4840. static ReflectionToRef(plane: DeepImmutable<IPlaneLike>, result: Matrix): void;
  4841. /**
  4842. * Sets the given matrix as a rotation matrix composed from the 3 left handed axes
  4843. * @param xaxis defines the value of the 1st axis
  4844. * @param yaxis defines the value of the 2nd axis
  4845. * @param zaxis defines the value of the 3rd axis
  4846. * @param result defines the target matrix
  4847. */
  4848. static FromXYZAxesToRef(xaxis: DeepImmutable<Vector3>, yaxis: DeepImmutable<Vector3>, zaxis: DeepImmutable<Vector3>, result: Matrix): void;
  4849. /**
  4850. * Creates a rotation matrix from a quaternion and stores it in a target matrix
  4851. * @param quat defines the quaternion to use
  4852. * @param result defines the target matrix
  4853. */
  4854. static FromQuaternionToRef(quat: DeepImmutable<Quaternion>, result: Matrix): void;
  4855. }
  4856. /**
  4857. * @hidden
  4858. */
  4859. export class TmpVectors {
  4860. static Vector2: Vector2[];
  4861. static Vector3: Vector3[];
  4862. static Vector4: Vector4[];
  4863. static Quaternion: Quaternion[];
  4864. static Matrix: Matrix[];
  4865. }
  4866. }
  4867. declare module "babylonjs/Maths/math.path" {
  4868. import { DeepImmutable, Nullable } from "babylonjs/types";
  4869. import { Vector2, Vector3 } from "babylonjs/Maths/math.vector";
  4870. /**
  4871. * Defines potential orientation for back face culling
  4872. */
  4873. export enum Orientation {
  4874. /**
  4875. * Clockwise
  4876. */
  4877. CW = 0,
  4878. /** Counter clockwise */
  4879. CCW = 1
  4880. }
  4881. /** Class used to represent a Bezier curve */
  4882. export class BezierCurve {
  4883. /**
  4884. * Returns the cubic Bezier interpolated value (float) at "t" (float) from the given x1, y1, x2, y2 floats
  4885. * @param t defines the time
  4886. * @param x1 defines the left coordinate on X axis
  4887. * @param y1 defines the left coordinate on Y axis
  4888. * @param x2 defines the right coordinate on X axis
  4889. * @param y2 defines the right coordinate on Y axis
  4890. * @returns the interpolated value
  4891. */
  4892. static Interpolate(t: number, x1: number, y1: number, x2: number, y2: number): number;
  4893. }
  4894. /**
  4895. * Defines angle representation
  4896. */
  4897. export class Angle {
  4898. private _radians;
  4899. /**
  4900. * Creates an Angle object of "radians" radians (float).
  4901. * @param radians the angle in radians
  4902. */
  4903. constructor(radians: number);
  4904. /**
  4905. * Get value in degrees
  4906. * @returns the Angle value in degrees (float)
  4907. */
  4908. degrees(): number;
  4909. /**
  4910. * Get value in radians
  4911. * @returns the Angle value in radians (float)
  4912. */
  4913. radians(): number;
  4914. /**
  4915. * Gets a new Angle object valued with the gradient angle, in radians, of the line joining two points
  4916. * @param a defines first point as the origin
  4917. * @param b defines point
  4918. * @returns a new Angle
  4919. */
  4920. static BetweenTwoPoints(a: DeepImmutable<Vector2>, b: DeepImmutable<Vector2>): Angle;
  4921. /**
  4922. * Gets a new Angle object from the given float in radians
  4923. * @param radians defines the angle value in radians
  4924. * @returns a new Angle
  4925. */
  4926. static FromRadians(radians: number): Angle;
  4927. /**
  4928. * Gets a new Angle object from the given float in degrees
  4929. * @param degrees defines the angle value in degrees
  4930. * @returns a new Angle
  4931. */
  4932. static FromDegrees(degrees: number): Angle;
  4933. }
  4934. /**
  4935. * This represents an arc in a 2d space.
  4936. */
  4937. export class Arc2 {
  4938. /** Defines the start point of the arc */
  4939. startPoint: Vector2;
  4940. /** Defines the mid point of the arc */
  4941. midPoint: Vector2;
  4942. /** Defines the end point of the arc */
  4943. endPoint: Vector2;
  4944. /**
  4945. * Defines the center point of the arc.
  4946. */
  4947. centerPoint: Vector2;
  4948. /**
  4949. * Defines the radius of the arc.
  4950. */
  4951. radius: number;
  4952. /**
  4953. * Defines the angle of the arc (from mid point to end point).
  4954. */
  4955. angle: Angle;
  4956. /**
  4957. * Defines the start angle of the arc (from start point to middle point).
  4958. */
  4959. startAngle: Angle;
  4960. /**
  4961. * Defines the orientation of the arc (clock wise/counter clock wise).
  4962. */
  4963. orientation: Orientation;
  4964. /**
  4965. * Creates an Arc object from the three given points : start, middle and end.
  4966. * @param startPoint Defines the start point of the arc
  4967. * @param midPoint Defines the midlle point of the arc
  4968. * @param endPoint Defines the end point of the arc
  4969. */
  4970. constructor(
  4971. /** Defines the start point of the arc */
  4972. startPoint: Vector2,
  4973. /** Defines the mid point of the arc */
  4974. midPoint: Vector2,
  4975. /** Defines the end point of the arc */
  4976. endPoint: Vector2);
  4977. }
  4978. /**
  4979. * Represents a 2D path made up of multiple 2D points
  4980. */
  4981. export class Path2 {
  4982. private _points;
  4983. private _length;
  4984. /**
  4985. * If the path start and end point are the same
  4986. */
  4987. closed: boolean;
  4988. /**
  4989. * Creates a Path2 object from the starting 2D coordinates x and y.
  4990. * @param x the starting points x value
  4991. * @param y the starting points y value
  4992. */
  4993. constructor(x: number, y: number);
  4994. /**
  4995. * Adds a new segment until the given coordinates (x, y) to the current Path2.
  4996. * @param x the added points x value
  4997. * @param y the added points y value
  4998. * @returns the updated Path2.
  4999. */
  5000. addLineTo(x: number, y: number): Path2;
  5001. /**
  5002. * Adds _numberOfSegments_ segments according to the arc definition (middle point coordinates, end point coordinates, the arc start point being the current Path2 last point) to the current Path2.
  5003. * @param midX middle point x value
  5004. * @param midY middle point y value
  5005. * @param endX end point x value
  5006. * @param endY end point y value
  5007. * @param numberOfSegments (default: 36)
  5008. * @returns the updated Path2.
  5009. */
  5010. addArcTo(midX: number, midY: number, endX: number, endY: number, numberOfSegments?: number): Path2;
  5011. /**
  5012. * Closes the Path2.
  5013. * @returns the Path2.
  5014. */
  5015. close(): Path2;
  5016. /**
  5017. * Gets the sum of the distance between each sequential point in the path
  5018. * @returns the Path2 total length (float).
  5019. */
  5020. length(): number;
  5021. /**
  5022. * Gets the points which construct the path
  5023. * @returns the Path2 internal array of points.
  5024. */
  5025. getPoints(): Vector2[];
  5026. /**
  5027. * Retreives the point at the distance aways from the starting point
  5028. * @param normalizedLengthPosition the length along the path to retreive the point from
  5029. * @returns a new Vector2 located at a percentage of the Path2 total length on this path.
  5030. */
  5031. getPointAtLengthPosition(normalizedLengthPosition: number): Vector2;
  5032. /**
  5033. * Creates a new path starting from an x and y position
  5034. * @param x starting x value
  5035. * @param y starting y value
  5036. * @returns a new Path2 starting at the coordinates (x, y).
  5037. */
  5038. static StartingAt(x: number, y: number): Path2;
  5039. }
  5040. /**
  5041. * Represents a 3D path made up of multiple 3D points
  5042. */
  5043. export class Path3D {
  5044. /**
  5045. * an array of Vector3, the curve axis of the Path3D
  5046. */
  5047. path: Vector3[];
  5048. private _curve;
  5049. private _distances;
  5050. private _tangents;
  5051. private _normals;
  5052. private _binormals;
  5053. private _raw;
  5054. private _alignTangentsWithPath;
  5055. private readonly _pointAtData;
  5056. /**
  5057. * new Path3D(path, normal, raw)
  5058. * Creates a Path3D. A Path3D is a logical math object, so not a mesh.
  5059. * please read the description in the tutorial : https://doc.babylonjs.com/how_to/how_to_use_path3d
  5060. * @param path an array of Vector3, the curve axis of the Path3D
  5061. * @param firstNormal (options) Vector3, the first wanted normal to the curve. Ex (0, 1, 0) for a vertical normal.
  5062. * @param raw (optional, default false) : boolean, if true the returned Path3D isn't normalized. Useful to depict path acceleration or speed.
  5063. * @param alignTangentsWithPath (optional, default false) : boolean, if true the tangents will be aligned with the path.
  5064. */
  5065. constructor(
  5066. /**
  5067. * an array of Vector3, the curve axis of the Path3D
  5068. */
  5069. path: Vector3[], firstNormal?: Nullable<Vector3>, raw?: boolean, alignTangentsWithPath?: boolean);
  5070. /**
  5071. * Returns the Path3D array of successive Vector3 designing its curve.
  5072. * @returns the Path3D array of successive Vector3 designing its curve.
  5073. */
  5074. getCurve(): Vector3[];
  5075. /**
  5076. * Returns the Path3D array of successive Vector3 designing its curve.
  5077. * @returns the Path3D array of successive Vector3 designing its curve.
  5078. */
  5079. getPoints(): Vector3[];
  5080. /**
  5081. * @returns the computed length (float) of the path.
  5082. */
  5083. length(): number;
  5084. /**
  5085. * Returns an array populated with tangent vectors on each Path3D curve point.
  5086. * @returns an array populated with tangent vectors on each Path3D curve point.
  5087. */
  5088. getTangents(): Vector3[];
  5089. /**
  5090. * Returns an array populated with normal vectors on each Path3D curve point.
  5091. * @returns an array populated with normal vectors on each Path3D curve point.
  5092. */
  5093. getNormals(): Vector3[];
  5094. /**
  5095. * Returns an array populated with binormal vectors on each Path3D curve point.
  5096. * @returns an array populated with binormal vectors on each Path3D curve point.
  5097. */
  5098. getBinormals(): Vector3[];
  5099. /**
  5100. * Returns an array populated with distances (float) of the i-th point from the first curve point.
  5101. * @returns an array populated with distances (float) of the i-th point from the first curve point.
  5102. */
  5103. getDistances(): number[];
  5104. /**
  5105. * Returns an interpolated point along this path
  5106. * @param position the position of the point along this path, from 0.0 to 1.0
  5107. * @returns a new Vector3 as the point
  5108. */
  5109. getPointAt(position: number): Vector3;
  5110. /**
  5111. * Returns the tangent vector of an interpolated Path3D curve point at the specified position along this path.
  5112. * @param position the position of the point along this path, from 0.0 to 1.0
  5113. * @param interpolated (optional, default false) : boolean, if true returns an interpolated tangent instead of the tangent of the previous path point.
  5114. * @returns a tangent vector corresponding to the interpolated Path3D curve point, if not interpolated, the tangent is taken from the precomputed tangents array.
  5115. */
  5116. getTangentAt(position: number, interpolated?: boolean): Vector3;
  5117. /**
  5118. * Returns the tangent vector of an interpolated Path3D curve point at the specified position along this path.
  5119. * @param position the position of the point along this path, from 0.0 to 1.0
  5120. * @param interpolated (optional, default false) : boolean, if true returns an interpolated normal instead of the normal of the previous path point.
  5121. * @returns a normal vector corresponding to the interpolated Path3D curve point, if not interpolated, the normal is taken from the precomputed normals array.
  5122. */
  5123. getNormalAt(position: number, interpolated?: boolean): Vector3;
  5124. /**
  5125. * Returns the binormal vector of an interpolated Path3D curve point at the specified position along this path.
  5126. * @param position the position of the point along this path, from 0.0 to 1.0
  5127. * @param interpolated (optional, default false) : boolean, if true returns an interpolated binormal instead of the binormal of the previous path point.
  5128. * @returns a binormal vector corresponding to the interpolated Path3D curve point, if not interpolated, the binormal is taken from the precomputed binormals array.
  5129. */
  5130. getBinormalAt(position: number, interpolated?: boolean): Vector3;
  5131. /**
  5132. * Returns the distance (float) of an interpolated Path3D curve point at the specified position along this path.
  5133. * @param position the position of the point along this path, from 0.0 to 1.0
  5134. * @returns the distance of the interpolated Path3D curve point at the specified position along this path.
  5135. */
  5136. getDistanceAt(position: number): number;
  5137. /**
  5138. * Returns the array index of the previous point of an interpolated point along this path
  5139. * @param position the position of the point to interpolate along this path, from 0.0 to 1.0
  5140. * @returns the array index
  5141. */
  5142. getPreviousPointIndexAt(position: number): number;
  5143. /**
  5144. * Returns the position of an interpolated point relative to the two path points it lies between, from 0.0 (point A) to 1.0 (point B)
  5145. * @param position the position of the point to interpolate along this path, from 0.0 to 1.0
  5146. * @returns the sub position
  5147. */
  5148. getSubPositionAt(position: number): number;
  5149. /**
  5150. * Returns the position of the closest virtual point on this path to an arbitrary Vector3, from 0.0 to 1.0
  5151. * @param target the vector of which to get the closest position to
  5152. * @returns the position of the closest virtual point on this path to the target vector
  5153. */
  5154. getClosestPositionTo(target: Vector3): number;
  5155. /**
  5156. * Returns a sub path (slice) of this path
  5157. * @param start the position of the fist path point, from 0.0 to 1.0, or a negative value, which will get wrapped around from the end of the path to 0.0 to 1.0 values
  5158. * @param end the position of the last path point, from 0.0 to 1.0, or a negative value, which will get wrapped around from the end of the path to 0.0 to 1.0 values
  5159. * @returns a sub path (slice) of this path
  5160. */
  5161. slice(start?: number, end?: number): Path3D;
  5162. /**
  5163. * Forces the Path3D tangent, normal, binormal and distance recomputation.
  5164. * @param path path which all values are copied into the curves points
  5165. * @param firstNormal which should be projected onto the curve
  5166. * @param alignTangentsWithPath (optional, default false) : boolean, if true the tangents will be aligned with the path
  5167. * @returns the same object updated.
  5168. */
  5169. update(path: Vector3[], firstNormal?: Nullable<Vector3>, alignTangentsWithPath?: boolean): Path3D;
  5170. private _compute;
  5171. private _getFirstNonNullVector;
  5172. private _getLastNonNullVector;
  5173. private _normalVector;
  5174. /**
  5175. * Updates the point at data for an interpolated point along this curve
  5176. * @param position the position of the point along this curve, from 0.0 to 1.0
  5177. * @interpolateTNB wether to compute the interpolated tangent, normal and binormal
  5178. * @returns the (updated) point at data
  5179. */
  5180. private _updatePointAtData;
  5181. /**
  5182. * Updates the point at data from the specified parameters
  5183. * @param position where along the path the interpolated point is, from 0.0 to 1.0
  5184. * @param point the interpolated point
  5185. * @param parentIndex the index of an existing curve point that is on, or else positionally the first behind, the interpolated point
  5186. */
  5187. private _setPointAtData;
  5188. /**
  5189. * Updates the point at interpolation matrix for the tangents, normals and binormals
  5190. */
  5191. private _updateInterpolationMatrix;
  5192. }
  5193. /**
  5194. * A Curve3 object is a logical object, so not a mesh, to handle curves in the 3D geometric space.
  5195. * A Curve3 is designed from a series of successive Vector3.
  5196. * @see https://doc.babylonjs.com/how_to/how_to_use_curve3
  5197. */
  5198. export class Curve3 {
  5199. private _points;
  5200. private _length;
  5201. /**
  5202. * Returns a Curve3 object along a Quadratic Bezier curve : https://doc.babylonjs.com/how_to/how_to_use_curve3#quadratic-bezier-curve
  5203. * @param v0 (Vector3) the origin point of the Quadratic Bezier
  5204. * @param v1 (Vector3) the control point
  5205. * @param v2 (Vector3) the end point of the Quadratic Bezier
  5206. * @param nbPoints (integer) the wanted number of points in the curve
  5207. * @returns the created Curve3
  5208. */
  5209. static CreateQuadraticBezier(v0: DeepImmutable<Vector3>, v1: DeepImmutable<Vector3>, v2: DeepImmutable<Vector3>, nbPoints: number): Curve3;
  5210. /**
  5211. * Returns a Curve3 object along a Cubic Bezier curve : https://doc.babylonjs.com/how_to/how_to_use_curve3#cubic-bezier-curve
  5212. * @param v0 (Vector3) the origin point of the Cubic Bezier
  5213. * @param v1 (Vector3) the first control point
  5214. * @param v2 (Vector3) the second control point
  5215. * @param v3 (Vector3) the end point of the Cubic Bezier
  5216. * @param nbPoints (integer) the wanted number of points in the curve
  5217. * @returns the created Curve3
  5218. */
  5219. static CreateCubicBezier(v0: DeepImmutable<Vector3>, v1: DeepImmutable<Vector3>, v2: DeepImmutable<Vector3>, v3: DeepImmutable<Vector3>, nbPoints: number): Curve3;
  5220. /**
  5221. * Returns a Curve3 object along a Hermite Spline curve : https://doc.babylonjs.com/how_to/how_to_use_curve3#hermite-spline
  5222. * @param p1 (Vector3) the origin point of the Hermite Spline
  5223. * @param t1 (Vector3) the tangent vector at the origin point
  5224. * @param p2 (Vector3) the end point of the Hermite Spline
  5225. * @param t2 (Vector3) the tangent vector at the end point
  5226. * @param nbPoints (integer) the wanted number of points in the curve
  5227. * @returns the created Curve3
  5228. */
  5229. static CreateHermiteSpline(p1: DeepImmutable<Vector3>, t1: DeepImmutable<Vector3>, p2: DeepImmutable<Vector3>, t2: DeepImmutable<Vector3>, nbPoints: number): Curve3;
  5230. /**
  5231. * Returns a Curve3 object along a CatmullRom Spline curve :
  5232. * @param points (array of Vector3) the points the spline must pass through. At least, four points required
  5233. * @param nbPoints (integer) the wanted number of points between each curve control points
  5234. * @param closed (boolean) optional with default false, when true forms a closed loop from the points
  5235. * @returns the created Curve3
  5236. */
  5237. static CreateCatmullRomSpline(points: DeepImmutable<Vector3[]>, nbPoints: number, closed?: boolean): Curve3;
  5238. /**
  5239. * A Curve3 object is a logical object, so not a mesh, to handle curves in the 3D geometric space.
  5240. * A Curve3 is designed from a series of successive Vector3.
  5241. * Tuto : https://doc.babylonjs.com/how_to/how_to_use_curve3#curve3-object
  5242. * @param points points which make up the curve
  5243. */
  5244. constructor(points: Vector3[]);
  5245. /**
  5246. * @returns the Curve3 stored array of successive Vector3
  5247. */
  5248. getPoints(): Vector3[];
  5249. /**
  5250. * @returns the computed length (float) of the curve.
  5251. */
  5252. length(): number;
  5253. /**
  5254. * Returns a new instance of Curve3 object : var curve = curveA.continue(curveB);
  5255. * This new Curve3 is built by translating and sticking the curveB at the end of the curveA.
  5256. * curveA and curveB keep unchanged.
  5257. * @param curve the curve to continue from this curve
  5258. * @returns the newly constructed curve
  5259. */
  5260. continue(curve: DeepImmutable<Curve3>): Curve3;
  5261. private _computeLength;
  5262. }
  5263. }
  5264. declare module "babylonjs/Animations/easing" {
  5265. /**
  5266. * This represents the main contract an easing function should follow.
  5267. * Easing functions are used throughout the animation system.
  5268. * @see https://doc.babylonjs.com/babylon101/animations#easing-functions
  5269. */
  5270. export interface IEasingFunction {
  5271. /**
  5272. * Given an input gradient between 0 and 1, this returns the corrseponding value
  5273. * of the easing function.
  5274. * The link below provides some of the most common examples of easing functions.
  5275. * @see https://easings.net/
  5276. * @param gradient Defines the value between 0 and 1 we want the easing value for
  5277. * @returns the corresponding value on the curve defined by the easing function
  5278. */
  5279. ease(gradient: number): number;
  5280. }
  5281. /**
  5282. * Base class used for every default easing function.
  5283. * @see https://doc.babylonjs.com/babylon101/animations#easing-functions
  5284. */
  5285. export class EasingFunction implements IEasingFunction {
  5286. /**
  5287. * Interpolation follows the mathematical formula associated with the easing function.
  5288. */
  5289. static readonly EASINGMODE_EASEIN: number;
  5290. /**
  5291. * Interpolation follows 100% interpolation minus the output of the formula associated with the easing function.
  5292. */
  5293. static readonly EASINGMODE_EASEOUT: number;
  5294. /**
  5295. * Interpolation uses EaseIn for the first half of the animation and EaseOut for the second half.
  5296. */
  5297. static readonly EASINGMODE_EASEINOUT: number;
  5298. private _easingMode;
  5299. /**
  5300. * Sets the easing mode of the current function.
  5301. * @param easingMode Defines the willing mode (EASINGMODE_EASEIN, EASINGMODE_EASEOUT or EASINGMODE_EASEINOUT)
  5302. */
  5303. setEasingMode(easingMode: number): void;
  5304. /**
  5305. * Gets the current easing mode.
  5306. * @returns the easing mode
  5307. */
  5308. getEasingMode(): number;
  5309. /**
  5310. * @hidden
  5311. */
  5312. easeInCore(gradient: number): number;
  5313. /**
  5314. * Given an input gradient between 0 and 1, this returns the corresponding value
  5315. * of the easing function.
  5316. * @param gradient Defines the value between 0 and 1 we want the easing value for
  5317. * @returns the corresponding value on the curve defined by the easing function
  5318. */
  5319. ease(gradient: number): number;
  5320. }
  5321. /**
  5322. * Easing function with a circle shape (see link below).
  5323. * @see https://easings.net/#easeInCirc
  5324. * @see https://doc.babylonjs.com/babylon101/animations#easing-functions
  5325. */
  5326. export class CircleEase extends EasingFunction implements IEasingFunction {
  5327. /** @hidden */
  5328. easeInCore(gradient: number): number;
  5329. }
  5330. /**
  5331. * Easing function with a ease back shape (see link below).
  5332. * @see https://easings.net/#easeInBack
  5333. * @see https://doc.babylonjs.com/babylon101/animations#easing-functions
  5334. */
  5335. export class BackEase extends EasingFunction implements IEasingFunction {
  5336. /** Defines the amplitude of the function */
  5337. amplitude: number;
  5338. /**
  5339. * Instantiates a back ease easing
  5340. * @see https://easings.net/#easeInBack
  5341. * @param amplitude Defines the amplitude of the function
  5342. */
  5343. constructor(
  5344. /** Defines the amplitude of the function */
  5345. amplitude?: number);
  5346. /** @hidden */
  5347. easeInCore(gradient: number): number;
  5348. }
  5349. /**
  5350. * Easing function with a bouncing shape (see link below).
  5351. * @see https://easings.net/#easeInBounce
  5352. * @see https://doc.babylonjs.com/babylon101/animations#easing-functions
  5353. */
  5354. export class BounceEase extends EasingFunction implements IEasingFunction {
  5355. /** Defines the number of bounces */
  5356. bounces: number;
  5357. /** Defines the amplitude of the bounce */
  5358. bounciness: number;
  5359. /**
  5360. * Instantiates a bounce easing
  5361. * @see https://easings.net/#easeInBounce
  5362. * @param bounces Defines the number of bounces
  5363. * @param bounciness Defines the amplitude of the bounce
  5364. */
  5365. constructor(
  5366. /** Defines the number of bounces */
  5367. bounces?: number,
  5368. /** Defines the amplitude of the bounce */
  5369. bounciness?: number);
  5370. /** @hidden */
  5371. easeInCore(gradient: number): number;
  5372. }
  5373. /**
  5374. * Easing function with a power of 3 shape (see link below).
  5375. * @see https://easings.net/#easeInCubic
  5376. * @see https://doc.babylonjs.com/babylon101/animations#easing-functions
  5377. */
  5378. export class CubicEase extends EasingFunction implements IEasingFunction {
  5379. /** @hidden */
  5380. easeInCore(gradient: number): number;
  5381. }
  5382. /**
  5383. * Easing function with an elastic shape (see link below).
  5384. * @see https://easings.net/#easeInElastic
  5385. * @see https://doc.babylonjs.com/babylon101/animations#easing-functions
  5386. */
  5387. export class ElasticEase extends EasingFunction implements IEasingFunction {
  5388. /** Defines the number of oscillations*/
  5389. oscillations: number;
  5390. /** Defines the amplitude of the oscillations*/
  5391. springiness: number;
  5392. /**
  5393. * Instantiates an elastic easing function
  5394. * @see https://easings.net/#easeInElastic
  5395. * @param oscillations Defines the number of oscillations
  5396. * @param springiness Defines the amplitude of the oscillations
  5397. */
  5398. constructor(
  5399. /** Defines the number of oscillations*/
  5400. oscillations?: number,
  5401. /** Defines the amplitude of the oscillations*/
  5402. springiness?: number);
  5403. /** @hidden */
  5404. easeInCore(gradient: number): number;
  5405. }
  5406. /**
  5407. * Easing function with an exponential shape (see link below).
  5408. * @see https://easings.net/#easeInExpo
  5409. * @see https://doc.babylonjs.com/babylon101/animations#easing-functions
  5410. */
  5411. export class ExponentialEase extends EasingFunction implements IEasingFunction {
  5412. /** Defines the exponent of the function */
  5413. exponent: number;
  5414. /**
  5415. * Instantiates an exponential easing function
  5416. * @see https://easings.net/#easeInExpo
  5417. * @param exponent Defines the exponent of the function
  5418. */
  5419. constructor(
  5420. /** Defines the exponent of the function */
  5421. exponent?: number);
  5422. /** @hidden */
  5423. easeInCore(gradient: number): number;
  5424. }
  5425. /**
  5426. * Easing function with a power shape (see link below).
  5427. * @see https://easings.net/#easeInQuad
  5428. * @see https://doc.babylonjs.com/babylon101/animations#easing-functions
  5429. */
  5430. export class PowerEase extends EasingFunction implements IEasingFunction {
  5431. /** Defines the power of the function */
  5432. power: number;
  5433. /**
  5434. * Instantiates an power base easing function
  5435. * @see https://easings.net/#easeInQuad
  5436. * @param power Defines the power of the function
  5437. */
  5438. constructor(
  5439. /** Defines the power of the function */
  5440. power?: number);
  5441. /** @hidden */
  5442. easeInCore(gradient: number): number;
  5443. }
  5444. /**
  5445. * Easing function with a power of 2 shape (see link below).
  5446. * @see https://easings.net/#easeInQuad
  5447. * @see https://doc.babylonjs.com/babylon101/animations#easing-functions
  5448. */
  5449. export class QuadraticEase extends EasingFunction implements IEasingFunction {
  5450. /** @hidden */
  5451. easeInCore(gradient: number): number;
  5452. }
  5453. /**
  5454. * Easing function with a power of 4 shape (see link below).
  5455. * @see https://easings.net/#easeInQuart
  5456. * @see https://doc.babylonjs.com/babylon101/animations#easing-functions
  5457. */
  5458. export class QuarticEase extends EasingFunction implements IEasingFunction {
  5459. /** @hidden */
  5460. easeInCore(gradient: number): number;
  5461. }
  5462. /**
  5463. * Easing function with a power of 5 shape (see link below).
  5464. * @see https://easings.net/#easeInQuint
  5465. * @see https://doc.babylonjs.com/babylon101/animations#easing-functions
  5466. */
  5467. export class QuinticEase extends EasingFunction implements IEasingFunction {
  5468. /** @hidden */
  5469. easeInCore(gradient: number): number;
  5470. }
  5471. /**
  5472. * Easing function with a sin shape (see link below).
  5473. * @see https://easings.net/#easeInSine
  5474. * @see https://doc.babylonjs.com/babylon101/animations#easing-functions
  5475. */
  5476. export class SineEase extends EasingFunction implements IEasingFunction {
  5477. /** @hidden */
  5478. easeInCore(gradient: number): number;
  5479. }
  5480. /**
  5481. * Easing function with a bezier shape (see link below).
  5482. * @see http://cubic-bezier.com/#.17,.67,.83,.67
  5483. * @see https://doc.babylonjs.com/babylon101/animations#easing-functions
  5484. */
  5485. export class BezierCurveEase extends EasingFunction implements IEasingFunction {
  5486. /** Defines the x component of the start tangent in the bezier curve */
  5487. x1: number;
  5488. /** Defines the y component of the start tangent in the bezier curve */
  5489. y1: number;
  5490. /** Defines the x component of the end tangent in the bezier curve */
  5491. x2: number;
  5492. /** Defines the y component of the end tangent in the bezier curve */
  5493. y2: number;
  5494. /**
  5495. * Instantiates a bezier function
  5496. * @see http://cubic-bezier.com/#.17,.67,.83,.67
  5497. * @param x1 Defines the x component of the start tangent in the bezier curve
  5498. * @param y1 Defines the y component of the start tangent in the bezier curve
  5499. * @param x2 Defines the x component of the end tangent in the bezier curve
  5500. * @param y2 Defines the y component of the end tangent in the bezier curve
  5501. */
  5502. constructor(
  5503. /** Defines the x component of the start tangent in the bezier curve */
  5504. x1?: number,
  5505. /** Defines the y component of the start tangent in the bezier curve */
  5506. y1?: number,
  5507. /** Defines the x component of the end tangent in the bezier curve */
  5508. x2?: number,
  5509. /** Defines the y component of the end tangent in the bezier curve */
  5510. y2?: number);
  5511. /** @hidden */
  5512. easeInCore(gradient: number): number;
  5513. }
  5514. }
  5515. declare module "babylonjs/Maths/math.color" {
  5516. import { DeepImmutable, FloatArray } from "babylonjs/types";
  5517. /**
  5518. * Class used to hold a RBG color
  5519. */
  5520. export class Color3 {
  5521. /**
  5522. * Defines the red component (between 0 and 1, default is 0)
  5523. */
  5524. r: number;
  5525. /**
  5526. * Defines the green component (between 0 and 1, default is 0)
  5527. */
  5528. g: number;
  5529. /**
  5530. * Defines the blue component (between 0 and 1, default is 0)
  5531. */
  5532. b: number;
  5533. /**
  5534. * Creates a new Color3 object from red, green, blue values, all between 0 and 1
  5535. * @param r defines the red component (between 0 and 1, default is 0)
  5536. * @param g defines the green component (between 0 and 1, default is 0)
  5537. * @param b defines the blue component (between 0 and 1, default is 0)
  5538. */
  5539. constructor(
  5540. /**
  5541. * Defines the red component (between 0 and 1, default is 0)
  5542. */
  5543. r?: number,
  5544. /**
  5545. * Defines the green component (between 0 and 1, default is 0)
  5546. */
  5547. g?: number,
  5548. /**
  5549. * Defines the blue component (between 0 and 1, default is 0)
  5550. */
  5551. b?: number);
  5552. /**
  5553. * Creates a string with the Color3 current values
  5554. * @returns the string representation of the Color3 object
  5555. */
  5556. toString(): string;
  5557. /**
  5558. * Returns the string "Color3"
  5559. * @returns "Color3"
  5560. */
  5561. getClassName(): string;
  5562. /**
  5563. * Compute the Color3 hash code
  5564. * @returns an unique number that can be used to hash Color3 objects
  5565. */
  5566. getHashCode(): number;
  5567. /**
  5568. * Stores in the given array from the given starting index the red, green, blue values as successive elements
  5569. * @param array defines the array where to store the r,g,b components
  5570. * @param index defines an optional index in the target array to define where to start storing values
  5571. * @returns the current Color3 object
  5572. */
  5573. toArray(array: FloatArray, index?: number): Color3;
  5574. /**
  5575. * Update the current color with values stored in an array from the starting index of the given array
  5576. * @param array defines the source array
  5577. * @param offset defines an offset in the source array
  5578. * @returns the current Color3 object
  5579. */
  5580. fromArray(array: DeepImmutable<ArrayLike<number>>, offset?: number): Color3;
  5581. /**
  5582. * Returns a new Color4 object from the current Color3 and the given alpha
  5583. * @param alpha defines the alpha component on the new Color4 object (default is 1)
  5584. * @returns a new Color4 object
  5585. */
  5586. toColor4(alpha?: number): Color4;
  5587. /**
  5588. * Returns a new array populated with 3 numeric elements : red, green and blue values
  5589. * @returns the new array
  5590. */
  5591. asArray(): number[];
  5592. /**
  5593. * Returns the luminance value
  5594. * @returns a float value
  5595. */
  5596. toLuminance(): number;
  5597. /**
  5598. * Multiply each Color3 rgb values by the given Color3 rgb values in a new Color3 object
  5599. * @param otherColor defines the second operand
  5600. * @returns the new Color3 object
  5601. */
  5602. multiply(otherColor: DeepImmutable<Color3>): Color3;
  5603. /**
  5604. * Multiply the rgb values of the Color3 and the given Color3 and stores the result in the object "result"
  5605. * @param otherColor defines the second operand
  5606. * @param result defines the Color3 object where to store the result
  5607. * @returns the current Color3
  5608. */
  5609. multiplyToRef(otherColor: DeepImmutable<Color3>, result: Color3): Color3;
  5610. /**
  5611. * Determines equality between Color3 objects
  5612. * @param otherColor defines the second operand
  5613. * @returns true if the rgb values are equal to the given ones
  5614. */
  5615. equals(otherColor: DeepImmutable<Color3>): boolean;
  5616. /**
  5617. * Determines equality between the current Color3 object and a set of r,b,g values
  5618. * @param r defines the red component to check
  5619. * @param g defines the green component to check
  5620. * @param b defines the blue component to check
  5621. * @returns true if the rgb values are equal to the given ones
  5622. */
  5623. equalsFloats(r: number, g: number, b: number): boolean;
  5624. /**
  5625. * Multiplies in place each rgb value by scale
  5626. * @param scale defines the scaling factor
  5627. * @returns the updated Color3
  5628. */
  5629. scale(scale: number): Color3;
  5630. /**
  5631. * Multiplies the rgb values by scale and stores the result into "result"
  5632. * @param scale defines the scaling factor
  5633. * @param result defines the Color3 object where to store the result
  5634. * @returns the unmodified current Color3
  5635. */
  5636. scaleToRef(scale: number, result: Color3): Color3;
  5637. /**
  5638. * Scale the current Color3 values by a factor and add the result to a given Color3
  5639. * @param scale defines the scale factor
  5640. * @param result defines color to store the result into
  5641. * @returns the unmodified current Color3
  5642. */
  5643. scaleAndAddToRef(scale: number, result: Color3): Color3;
  5644. /**
  5645. * Clamps the rgb values by the min and max values and stores the result into "result"
  5646. * @param min defines minimum clamping value (default is 0)
  5647. * @param max defines maximum clamping value (default is 1)
  5648. * @param result defines color to store the result into
  5649. * @returns the original Color3
  5650. */
  5651. clampToRef(min: number | undefined, max: number | undefined, result: Color3): Color3;
  5652. /**
  5653. * Creates a new Color3 set with the added values of the current Color3 and of the given one
  5654. * @param otherColor defines the second operand
  5655. * @returns the new Color3
  5656. */
  5657. add(otherColor: DeepImmutable<Color3>): Color3;
  5658. /**
  5659. * Stores the result of the addition of the current Color3 and given one rgb values into "result"
  5660. * @param otherColor defines the second operand
  5661. * @param result defines Color3 object to store the result into
  5662. * @returns the unmodified current Color3
  5663. */
  5664. addToRef(otherColor: DeepImmutable<Color3>, result: Color3): Color3;
  5665. /**
  5666. * Returns a new Color3 set with the subtracted values of the given one from the current Color3
  5667. * @param otherColor defines the second operand
  5668. * @returns the new Color3
  5669. */
  5670. subtract(otherColor: DeepImmutable<Color3>): Color3;
  5671. /**
  5672. * Stores the result of the subtraction of given one from the current Color3 rgb values into "result"
  5673. * @param otherColor defines the second operand
  5674. * @param result defines Color3 object to store the result into
  5675. * @returns the unmodified current Color3
  5676. */
  5677. subtractToRef(otherColor: DeepImmutable<Color3>, result: Color3): Color3;
  5678. /**
  5679. * Copy the current object
  5680. * @returns a new Color3 copied the current one
  5681. */
  5682. clone(): Color3;
  5683. /**
  5684. * Copies the rgb values from the source in the current Color3
  5685. * @param source defines the source Color3 object
  5686. * @returns the updated Color3 object
  5687. */
  5688. copyFrom(source: DeepImmutable<Color3>): Color3;
  5689. /**
  5690. * Updates the Color3 rgb values from the given floats
  5691. * @param r defines the red component to read from
  5692. * @param g defines the green component to read from
  5693. * @param b defines the blue component to read from
  5694. * @returns the current Color3 object
  5695. */
  5696. copyFromFloats(r: number, g: number, b: number): Color3;
  5697. /**
  5698. * Updates the Color3 rgb values from the given floats
  5699. * @param r defines the red component to read from
  5700. * @param g defines the green component to read from
  5701. * @param b defines the blue component to read from
  5702. * @returns the current Color3 object
  5703. */
  5704. set(r: number, g: number, b: number): Color3;
  5705. /**
  5706. * Compute the Color3 hexadecimal code as a string
  5707. * @returns a string containing the hexadecimal representation of the Color3 object
  5708. */
  5709. toHexString(): string;
  5710. /**
  5711. * Computes a new Color3 converted from the current one to linear space
  5712. * @returns a new Color3 object
  5713. */
  5714. toLinearSpace(): Color3;
  5715. /**
  5716. * Converts current color in rgb space to HSV values
  5717. * @returns a new color3 representing the HSV values
  5718. */
  5719. toHSV(): Color3;
  5720. /**
  5721. * Converts current color in rgb space to HSV values
  5722. * @param result defines the Color3 where to store the HSV values
  5723. */
  5724. toHSVToRef(result: Color3): void;
  5725. /**
  5726. * Converts the Color3 values to linear space and stores the result in "convertedColor"
  5727. * @param convertedColor defines the Color3 object where to store the linear space version
  5728. * @returns the unmodified Color3
  5729. */
  5730. toLinearSpaceToRef(convertedColor: Color3): Color3;
  5731. /**
  5732. * Computes a new Color3 converted from the current one to gamma space
  5733. * @returns a new Color3 object
  5734. */
  5735. toGammaSpace(): Color3;
  5736. /**
  5737. * Converts the Color3 values to gamma space and stores the result in "convertedColor"
  5738. * @param convertedColor defines the Color3 object where to store the gamma space version
  5739. * @returns the unmodified Color3
  5740. */
  5741. toGammaSpaceToRef(convertedColor: Color3): Color3;
  5742. private static _BlackReadOnly;
  5743. /**
  5744. * Convert Hue, saturation and value to a Color3 (RGB)
  5745. * @param hue defines the hue
  5746. * @param saturation defines the saturation
  5747. * @param value defines the value
  5748. * @param result defines the Color3 where to store the RGB values
  5749. */
  5750. static HSVtoRGBToRef(hue: number, saturation: number, value: number, result: Color3): void;
  5751. /**
  5752. * Creates a new Color3 from the string containing valid hexadecimal values
  5753. * @param hex defines a string containing valid hexadecimal values
  5754. * @returns a new Color3 object
  5755. */
  5756. static FromHexString(hex: string): Color3;
  5757. /**
  5758. * Creates a new Color3 from the starting index of the given array
  5759. * @param array defines the source array
  5760. * @param offset defines an offset in the source array
  5761. * @returns a new Color3 object
  5762. */
  5763. static FromArray(array: DeepImmutable<ArrayLike<number>>, offset?: number): Color3;
  5764. /**
  5765. * Creates a new Color3 from the starting index element of the given array
  5766. * @param array defines the source array to read from
  5767. * @param offset defines the offset in the source array
  5768. * @param result defines the target Color3 object
  5769. */
  5770. static FromArrayToRef(array: DeepImmutable<ArrayLike<number>>, offset: number | undefined, result: Color3): void;
  5771. /**
  5772. * Creates a new Color3 from integer values (< 256)
  5773. * @param r defines the red component to read from (value between 0 and 255)
  5774. * @param g defines the green component to read from (value between 0 and 255)
  5775. * @param b defines the blue component to read from (value between 0 and 255)
  5776. * @returns a new Color3 object
  5777. */
  5778. static FromInts(r: number, g: number, b: number): Color3;
  5779. /**
  5780. * Creates a new Color3 with values linearly interpolated of "amount" between the start Color3 and the end Color3
  5781. * @param start defines the start Color3 value
  5782. * @param end defines the end Color3 value
  5783. * @param amount defines the gradient value between start and end
  5784. * @returns a new Color3 object
  5785. */
  5786. static Lerp(start: DeepImmutable<Color3>, end: DeepImmutable<Color3>, amount: number): Color3;
  5787. /**
  5788. * Creates a new Color3 with values linearly interpolated of "amount" between the start Color3 and the end Color3
  5789. * @param left defines the start value
  5790. * @param right defines the end value
  5791. * @param amount defines the gradient factor
  5792. * @param result defines the Color3 object where to store the result
  5793. */
  5794. static LerpToRef(left: DeepImmutable<Color3>, right: DeepImmutable<Color3>, amount: number, result: Color3): void;
  5795. /**
  5796. * Returns a Color3 value containing a red color
  5797. * @returns a new Color3 object
  5798. */
  5799. static Red(): Color3;
  5800. /**
  5801. * Returns a Color3 value containing a green color
  5802. * @returns a new Color3 object
  5803. */
  5804. static Green(): Color3;
  5805. /**
  5806. * Returns a Color3 value containing a blue color
  5807. * @returns a new Color3 object
  5808. */
  5809. static Blue(): Color3;
  5810. /**
  5811. * Returns a Color3 value containing a black color
  5812. * @returns a new Color3 object
  5813. */
  5814. static Black(): Color3;
  5815. /**
  5816. * Gets a Color3 value containing a black color that must not be updated
  5817. */
  5818. static get BlackReadOnly(): DeepImmutable<Color3>;
  5819. /**
  5820. * Returns a Color3 value containing a white color
  5821. * @returns a new Color3 object
  5822. */
  5823. static White(): Color3;
  5824. /**
  5825. * Returns a Color3 value containing a purple color
  5826. * @returns a new Color3 object
  5827. */
  5828. static Purple(): Color3;
  5829. /**
  5830. * Returns a Color3 value containing a magenta color
  5831. * @returns a new Color3 object
  5832. */
  5833. static Magenta(): Color3;
  5834. /**
  5835. * Returns a Color3 value containing a yellow color
  5836. * @returns a new Color3 object
  5837. */
  5838. static Yellow(): Color3;
  5839. /**
  5840. * Returns a Color3 value containing a gray color
  5841. * @returns a new Color3 object
  5842. */
  5843. static Gray(): Color3;
  5844. /**
  5845. * Returns a Color3 value containing a teal color
  5846. * @returns a new Color3 object
  5847. */
  5848. static Teal(): Color3;
  5849. /**
  5850. * Returns a Color3 value containing a random color
  5851. * @returns a new Color3 object
  5852. */
  5853. static Random(): Color3;
  5854. }
  5855. /**
  5856. * Class used to hold a RBGA color
  5857. */
  5858. export class Color4 {
  5859. /**
  5860. * Defines the red component (between 0 and 1, default is 0)
  5861. */
  5862. r: number;
  5863. /**
  5864. * Defines the green component (between 0 and 1, default is 0)
  5865. */
  5866. g: number;
  5867. /**
  5868. * Defines the blue component (between 0 and 1, default is 0)
  5869. */
  5870. b: number;
  5871. /**
  5872. * Defines the alpha component (between 0 and 1, default is 1)
  5873. */
  5874. a: number;
  5875. /**
  5876. * Creates a new Color4 object from red, green, blue values, all between 0 and 1
  5877. * @param r defines the red component (between 0 and 1, default is 0)
  5878. * @param g defines the green component (between 0 and 1, default is 0)
  5879. * @param b defines the blue component (between 0 and 1, default is 0)
  5880. * @param a defines the alpha component (between 0 and 1, default is 1)
  5881. */
  5882. constructor(
  5883. /**
  5884. * Defines the red component (between 0 and 1, default is 0)
  5885. */
  5886. r?: number,
  5887. /**
  5888. * Defines the green component (between 0 and 1, default is 0)
  5889. */
  5890. g?: number,
  5891. /**
  5892. * Defines the blue component (between 0 and 1, default is 0)
  5893. */
  5894. b?: number,
  5895. /**
  5896. * Defines the alpha component (between 0 and 1, default is 1)
  5897. */
  5898. a?: number);
  5899. /**
  5900. * Adds in place the given Color4 values to the current Color4 object
  5901. * @param right defines the second operand
  5902. * @returns the current updated Color4 object
  5903. */
  5904. addInPlace(right: DeepImmutable<Color4>): Color4;
  5905. /**
  5906. * Creates a new array populated with 4 numeric elements : red, green, blue, alpha values
  5907. * @returns the new array
  5908. */
  5909. asArray(): number[];
  5910. /**
  5911. * Stores from the starting index in the given array the Color4 successive values
  5912. * @param array defines the array where to store the r,g,b components
  5913. * @param index defines an optional index in the target array to define where to start storing values
  5914. * @returns the current Color4 object
  5915. */
  5916. toArray(array: number[], index?: number): Color4;
  5917. /**
  5918. * Update the current color with values stored in an array from the starting index of the given array
  5919. * @param array defines the source array
  5920. * @param offset defines an offset in the source array
  5921. * @returns the current Color4 object
  5922. */
  5923. fromArray(array: DeepImmutable<ArrayLike<number>>, offset?: number): Color4;
  5924. /**
  5925. * Determines equality between Color4 objects
  5926. * @param otherColor defines the second operand
  5927. * @returns true if the rgba values are equal to the given ones
  5928. */
  5929. equals(otherColor: DeepImmutable<Color4>): boolean;
  5930. /**
  5931. * Creates a new Color4 set with the added values of the current Color4 and of the given one
  5932. * @param right defines the second operand
  5933. * @returns a new Color4 object
  5934. */
  5935. add(right: DeepImmutable<Color4>): Color4;
  5936. /**
  5937. * Creates a new Color4 set with the subtracted values of the given one from the current Color4
  5938. * @param right defines the second operand
  5939. * @returns a new Color4 object
  5940. */
  5941. subtract(right: DeepImmutable<Color4>): Color4;
  5942. /**
  5943. * Subtracts the given ones from the current Color4 values and stores the results in "result"
  5944. * @param right defines the second operand
  5945. * @param result defines the Color4 object where to store the result
  5946. * @returns the current Color4 object
  5947. */
  5948. subtractToRef(right: DeepImmutable<Color4>, result: Color4): Color4;
  5949. /**
  5950. * Creates a new Color4 with the current Color4 values multiplied by scale
  5951. * @param scale defines the scaling factor to apply
  5952. * @returns a new Color4 object
  5953. */
  5954. scale(scale: number): Color4;
  5955. /**
  5956. * Multiplies the current Color4 values by scale and stores the result in "result"
  5957. * @param scale defines the scaling factor to apply
  5958. * @param result defines the Color4 object where to store the result
  5959. * @returns the current unmodified Color4
  5960. */
  5961. scaleToRef(scale: number, result: Color4): Color4;
  5962. /**
  5963. * Scale the current Color4 values by a factor and add the result to a given Color4
  5964. * @param scale defines the scale factor
  5965. * @param result defines the Color4 object where to store the result
  5966. * @returns the unmodified current Color4
  5967. */
  5968. scaleAndAddToRef(scale: number, result: Color4): Color4;
  5969. /**
  5970. * Clamps the rgb values by the min and max values and stores the result into "result"
  5971. * @param min defines minimum clamping value (default is 0)
  5972. * @param max defines maximum clamping value (default is 1)
  5973. * @param result defines color to store the result into.
  5974. * @returns the cuurent Color4
  5975. */
  5976. clampToRef(min: number | undefined, max: number | undefined, result: Color4): Color4;
  5977. /**
  5978. * Multipy an Color4 value by another and return a new Color4 object
  5979. * @param color defines the Color4 value to multiply by
  5980. * @returns a new Color4 object
  5981. */
  5982. multiply(color: Color4): Color4;
  5983. /**
  5984. * Multipy a Color4 value by another and push the result in a reference value
  5985. * @param color defines the Color4 value to multiply by
  5986. * @param result defines the Color4 to fill the result in
  5987. * @returns the result Color4
  5988. */
  5989. multiplyToRef(color: Color4, result: Color4): Color4;
  5990. /**
  5991. * Creates a string with the Color4 current values
  5992. * @returns the string representation of the Color4 object
  5993. */
  5994. toString(): string;
  5995. /**
  5996. * Returns the string "Color4"
  5997. * @returns "Color4"
  5998. */
  5999. getClassName(): string;
  6000. /**
  6001. * Compute the Color4 hash code
  6002. * @returns an unique number that can be used to hash Color4 objects
  6003. */
  6004. getHashCode(): number;
  6005. /**
  6006. * Creates a new Color4 copied from the current one
  6007. * @returns a new Color4 object
  6008. */
  6009. clone(): Color4;
  6010. /**
  6011. * Copies the given Color4 values into the current one
  6012. * @param source defines the source Color4 object
  6013. * @returns the current updated Color4 object
  6014. */
  6015. copyFrom(source: Color4): Color4;
  6016. /**
  6017. * Copies the given float values into the current one
  6018. * @param r defines the red component to read from
  6019. * @param g defines the green component to read from
  6020. * @param b defines the blue component to read from
  6021. * @param a defines the alpha component to read from
  6022. * @returns the current updated Color4 object
  6023. */
  6024. copyFromFloats(r: number, g: number, b: number, a: number): Color4;
  6025. /**
  6026. * Copies the given float values into the current one
  6027. * @param r defines the red component to read from
  6028. * @param g defines the green component to read from
  6029. * @param b defines the blue component to read from
  6030. * @param a defines the alpha component to read from
  6031. * @returns the current updated Color4 object
  6032. */
  6033. set(r: number, g: number, b: number, a: number): Color4;
  6034. /**
  6035. * Compute the Color4 hexadecimal code as a string
  6036. * @param returnAsColor3 defines if the string should only contains RGB values (off by default)
  6037. * @returns a string containing the hexadecimal representation of the Color4 object
  6038. */
  6039. toHexString(returnAsColor3?: boolean): string;
  6040. /**
  6041. * Computes a new Color4 converted from the current one to linear space
  6042. * @returns a new Color4 object
  6043. */
  6044. toLinearSpace(): Color4;
  6045. /**
  6046. * Converts the Color4 values to linear space and stores the result in "convertedColor"
  6047. * @param convertedColor defines the Color4 object where to store the linear space version
  6048. * @returns the unmodified Color4
  6049. */
  6050. toLinearSpaceToRef(convertedColor: Color4): Color4;
  6051. /**
  6052. * Computes a new Color4 converted from the current one to gamma space
  6053. * @returns a new Color4 object
  6054. */
  6055. toGammaSpace(): Color4;
  6056. /**
  6057. * Converts the Color4 values to gamma space and stores the result in "convertedColor"
  6058. * @param convertedColor defines the Color4 object where to store the gamma space version
  6059. * @returns the unmodified Color4
  6060. */
  6061. toGammaSpaceToRef(convertedColor: Color4): Color4;
  6062. /**
  6063. * Creates a new Color4 from the string containing valid hexadecimal values
  6064. * @param hex defines a string containing valid hexadecimal values
  6065. * @returns a new Color4 object
  6066. */
  6067. static FromHexString(hex: string): Color4;
  6068. /**
  6069. * Creates a new Color4 object set with the linearly interpolated values of "amount" between the left Color4 object and the right Color4 object
  6070. * @param left defines the start value
  6071. * @param right defines the end value
  6072. * @param amount defines the gradient factor
  6073. * @returns a new Color4 object
  6074. */
  6075. static Lerp(left: DeepImmutable<Color4>, right: DeepImmutable<Color4>, amount: number): Color4;
  6076. /**
  6077. * Set the given "result" with the linearly interpolated values of "amount" between the left Color4 object and the right Color4 object
  6078. * @param left defines the start value
  6079. * @param right defines the end value
  6080. * @param amount defines the gradient factor
  6081. * @param result defines the Color4 object where to store data
  6082. */
  6083. static LerpToRef(left: DeepImmutable<Color4>, right: DeepImmutable<Color4>, amount: number, result: Color4): void;
  6084. /**
  6085. * Creates a new Color4 from a Color3 and an alpha value
  6086. * @param color3 defines the source Color3 to read from
  6087. * @param alpha defines the alpha component (1.0 by default)
  6088. * @returns a new Color4 object
  6089. */
  6090. static FromColor3(color3: DeepImmutable<Color3>, alpha?: number): Color4;
  6091. /**
  6092. * Creates a new Color4 from the starting index element of the given array
  6093. * @param array defines the source array to read from
  6094. * @param offset defines the offset in the source array
  6095. * @returns a new Color4 object
  6096. */
  6097. static FromArray(array: DeepImmutable<ArrayLike<number>>, offset?: number): Color4;
  6098. /**
  6099. * Creates a new Color4 from the starting index element of the given array
  6100. * @param array defines the source array to read from
  6101. * @param offset defines the offset in the source array
  6102. * @param result defines the target Color4 object
  6103. */
  6104. static FromArrayToRef(array: DeepImmutable<ArrayLike<number>>, offset: number | undefined, result: Color4): void;
  6105. /**
  6106. * Creates a new Color3 from integer values (< 256)
  6107. * @param r defines the red component to read from (value between 0 and 255)
  6108. * @param g defines the green component to read from (value between 0 and 255)
  6109. * @param b defines the blue component to read from (value between 0 and 255)
  6110. * @param a defines the alpha component to read from (value between 0 and 255)
  6111. * @returns a new Color3 object
  6112. */
  6113. static FromInts(r: number, g: number, b: number, a: number): Color4;
  6114. /**
  6115. * Check the content of a given array and convert it to an array containing RGBA data
  6116. * If the original array was already containing count * 4 values then it is returned directly
  6117. * @param colors defines the array to check
  6118. * @param count defines the number of RGBA data to expect
  6119. * @returns an array containing count * 4 values (RGBA)
  6120. */
  6121. static CheckColors4(colors: number[], count: number): number[];
  6122. }
  6123. /**
  6124. * @hidden
  6125. */
  6126. export class TmpColors {
  6127. static Color3: Color3[];
  6128. static Color4: Color4[];
  6129. }
  6130. }
  6131. declare module "babylonjs/Animations/animationKey" {
  6132. /**
  6133. * Defines an interface which represents an animation key frame
  6134. */
  6135. export interface IAnimationKey {
  6136. /**
  6137. * Frame of the key frame
  6138. */
  6139. frame: number;
  6140. /**
  6141. * Value at the specifies key frame
  6142. */
  6143. value: any;
  6144. /**
  6145. * The input tangent for the cubic hermite spline
  6146. */
  6147. inTangent?: any;
  6148. /**
  6149. * The output tangent for the cubic hermite spline
  6150. */
  6151. outTangent?: any;
  6152. /**
  6153. * The animation interpolation type
  6154. */
  6155. interpolation?: AnimationKeyInterpolation;
  6156. }
  6157. /**
  6158. * Enum for the animation key frame interpolation type
  6159. */
  6160. export enum AnimationKeyInterpolation {
  6161. /**
  6162. * Do not interpolate between keys and use the start key value only. Tangents are ignored
  6163. */
  6164. STEP = 1
  6165. }
  6166. }
  6167. declare module "babylonjs/Animations/animationRange" {
  6168. /**
  6169. * Represents the range of an animation
  6170. */
  6171. export class AnimationRange {
  6172. /**The name of the animation range**/
  6173. name: string;
  6174. /**The starting frame of the animation */
  6175. from: number;
  6176. /**The ending frame of the animation*/
  6177. to: number;
  6178. /**
  6179. * Initializes the range of an animation
  6180. * @param name The name of the animation range
  6181. * @param from The starting frame of the animation
  6182. * @param to The ending frame of the animation
  6183. */
  6184. constructor(
  6185. /**The name of the animation range**/
  6186. name: string,
  6187. /**The starting frame of the animation */
  6188. from: number,
  6189. /**The ending frame of the animation*/
  6190. to: number);
  6191. /**
  6192. * Makes a copy of the animation range
  6193. * @returns A copy of the animation range
  6194. */
  6195. clone(): AnimationRange;
  6196. }
  6197. }
  6198. declare module "babylonjs/Animations/animationEvent" {
  6199. /**
  6200. * Composed of a frame, and an action function
  6201. */
  6202. export class AnimationEvent {
  6203. /** The frame for which the event is triggered **/
  6204. frame: number;
  6205. /** The event to perform when triggered **/
  6206. action: (currentFrame: number) => void;
  6207. /** Specifies if the event should be triggered only once**/
  6208. onlyOnce?: boolean | undefined;
  6209. /**
  6210. * Specifies if the animation event is done
  6211. */
  6212. isDone: boolean;
  6213. /**
  6214. * Initializes the animation event
  6215. * @param frame The frame for which the event is triggered
  6216. * @param action The event to perform when triggered
  6217. * @param onlyOnce Specifies if the event should be triggered only once
  6218. */
  6219. constructor(
  6220. /** The frame for which the event is triggered **/
  6221. frame: number,
  6222. /** The event to perform when triggered **/
  6223. action: (currentFrame: number) => void,
  6224. /** Specifies if the event should be triggered only once**/
  6225. onlyOnce?: boolean | undefined);
  6226. /** @hidden */
  6227. _clone(): AnimationEvent;
  6228. }
  6229. }
  6230. declare module "babylonjs/Behaviors/behavior" {
  6231. import { Nullable } from "babylonjs/types";
  6232. /**
  6233. * Interface used to define a behavior
  6234. */
  6235. export interface Behavior<T> {
  6236. /** gets or sets behavior's name */
  6237. name: string;
  6238. /**
  6239. * Function called when the behavior needs to be initialized (after attaching it to a target)
  6240. */
  6241. init(): void;
  6242. /**
  6243. * Called when the behavior is attached to a target
  6244. * @param target defines the target where the behavior is attached to
  6245. */
  6246. attach(target: T): void;
  6247. /**
  6248. * Called when the behavior is detached from its target
  6249. */
  6250. detach(): void;
  6251. }
  6252. /**
  6253. * Interface implemented by classes supporting behaviors
  6254. */
  6255. export interface IBehaviorAware<T> {
  6256. /**
  6257. * Attach a behavior
  6258. * @param behavior defines the behavior to attach
  6259. * @returns the current host
  6260. */
  6261. addBehavior(behavior: Behavior<T>): T;
  6262. /**
  6263. * Remove a behavior from the current object
  6264. * @param behavior defines the behavior to detach
  6265. * @returns the current host
  6266. */
  6267. removeBehavior(behavior: Behavior<T>): T;
  6268. /**
  6269. * Gets a behavior using its name to search
  6270. * @param name defines the name to search
  6271. * @returns the behavior or null if not found
  6272. */
  6273. getBehaviorByName(name: string): Nullable<Behavior<T>>;
  6274. }
  6275. }
  6276. declare module "babylonjs/Misc/smartArray" {
  6277. /**
  6278. * Defines an array and its length.
  6279. * It can be helpfull to group result from both Arrays and smart arrays in one structure.
  6280. */
  6281. export interface ISmartArrayLike<T> {
  6282. /**
  6283. * The data of the array.
  6284. */
  6285. data: Array<T>;
  6286. /**
  6287. * The active length of the array.
  6288. */
  6289. length: number;
  6290. }
  6291. /**
  6292. * Defines an GC Friendly array where the backfield array do not shrink to prevent over allocations.
  6293. */
  6294. export class SmartArray<T> implements ISmartArrayLike<T> {
  6295. /**
  6296. * The full set of data from the array.
  6297. */
  6298. data: Array<T>;
  6299. /**
  6300. * The active length of the array.
  6301. */
  6302. length: number;
  6303. protected _id: number;
  6304. /**
  6305. * Instantiates a Smart Array.
  6306. * @param capacity defines the default capacity of the array.
  6307. */
  6308. constructor(capacity: number);
  6309. /**
  6310. * Pushes a value at the end of the active data.
  6311. * @param value defines the object to push in the array.
  6312. */
  6313. push(value: T): void;
  6314. /**
  6315. * Iterates over the active data and apply the lambda to them.
  6316. * @param func defines the action to apply on each value.
  6317. */
  6318. forEach(func: (content: T) => void): void;
  6319. /**
  6320. * Sorts the full sets of data.
  6321. * @param compareFn defines the comparison function to apply.
  6322. */
  6323. sort(compareFn: (a: T, b: T) => number): void;
  6324. /**
  6325. * Resets the active data to an empty array.
  6326. */
  6327. reset(): void;
  6328. /**
  6329. * Releases all the data from the array as well as the array.
  6330. */
  6331. dispose(): void;
  6332. /**
  6333. * Concats the active data with a given array.
  6334. * @param array defines the data to concatenate with.
  6335. */
  6336. concat(array: any): void;
  6337. /**
  6338. * Returns the position of a value in the active data.
  6339. * @param value defines the value to find the index for
  6340. * @returns the index if found in the active data otherwise -1
  6341. */
  6342. indexOf(value: T): number;
  6343. /**
  6344. * Returns whether an element is part of the active data.
  6345. * @param value defines the value to look for
  6346. * @returns true if found in the active data otherwise false
  6347. */
  6348. contains(value: T): boolean;
  6349. private static _GlobalId;
  6350. }
  6351. /**
  6352. * Defines an GC Friendly array where the backfield array do not shrink to prevent over allocations.
  6353. * The data in this array can only be present once
  6354. */
  6355. export class SmartArrayNoDuplicate<T> extends SmartArray<T> {
  6356. private _duplicateId;
  6357. /**
  6358. * Pushes a value at the end of the active data.
  6359. * THIS DOES NOT PREVENT DUPPLICATE DATA
  6360. * @param value defines the object to push in the array.
  6361. */
  6362. push(value: T): void;
  6363. /**
  6364. * Pushes a value at the end of the active data.
  6365. * If the data is already present, it won t be added again
  6366. * @param value defines the object to push in the array.
  6367. * @returns true if added false if it was already present
  6368. */
  6369. pushNoDuplicate(value: T): boolean;
  6370. /**
  6371. * Resets the active data to an empty array.
  6372. */
  6373. reset(): void;
  6374. /**
  6375. * Concats the active data with a given array.
  6376. * This ensures no dupplicate will be present in the result.
  6377. * @param array defines the data to concatenate with.
  6378. */
  6379. concatWithNoDuplicate(array: any): void;
  6380. }
  6381. }
  6382. declare module "babylonjs/Cameras/cameraInputsManager" {
  6383. import { Nullable } from "babylonjs/types";
  6384. import { Camera } from "babylonjs/Cameras/camera";
  6385. /**
  6386. * @ignore
  6387. * This is a list of all the different input types that are available in the application.
  6388. * Fo instance: ArcRotateCameraGamepadInput...
  6389. */
  6390. export var CameraInputTypes: {};
  6391. /**
  6392. * This is the contract to implement in order to create a new input class.
  6393. * Inputs are dealing with listening to user actions and moving the camera accordingly.
  6394. */
  6395. export interface ICameraInput<TCamera extends Camera> {
  6396. /**
  6397. * Defines the camera the input is attached to.
  6398. */
  6399. camera: Nullable<TCamera>;
  6400. /**
  6401. * Gets the class name of the current intput.
  6402. * @returns the class name
  6403. */
  6404. getClassName(): string;
  6405. /**
  6406. * Get the friendly name associated with the input class.
  6407. * @returns the input friendly name
  6408. */
  6409. getSimpleName(): string;
  6410. /**
  6411. * Attach the input controls to a specific dom element to get the input from.
  6412. * @param element Defines the element the controls should be listened from
  6413. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  6414. */
  6415. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  6416. /**
  6417. * Detach the current controls from the specified dom element.
  6418. * @param element Defines the element to stop listening the inputs from
  6419. */
  6420. detachControl(element: Nullable<HTMLElement>): void;
  6421. /**
  6422. * Update the current camera state depending on the inputs that have been used this frame.
  6423. * This is a dynamically created lambda to avoid the performance penalty of looping for inputs in the render loop.
  6424. */
  6425. checkInputs?: () => void;
  6426. }
  6427. /**
  6428. * Represents a map of input types to input instance or input index to input instance.
  6429. */
  6430. export interface CameraInputsMap<TCamera extends Camera> {
  6431. /**
  6432. * Accessor to the input by input type.
  6433. */
  6434. [name: string]: ICameraInput<TCamera>;
  6435. /**
  6436. * Accessor to the input by input index.
  6437. */
  6438. [idx: number]: ICameraInput<TCamera>;
  6439. }
  6440. /**
  6441. * This represents the input manager used within a camera.
  6442. * It helps dealing with all the different kind of input attached to a camera.
  6443. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  6444. */
  6445. export class CameraInputsManager<TCamera extends Camera> {
  6446. /**
  6447. * Defines the list of inputs attahed to the camera.
  6448. */
  6449. attached: CameraInputsMap<TCamera>;
  6450. /**
  6451. * Defines the dom element the camera is collecting inputs from.
  6452. * This is null if the controls have not been attached.
  6453. */
  6454. attachedElement: Nullable<HTMLElement>;
  6455. /**
  6456. * Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  6457. */
  6458. noPreventDefault: boolean;
  6459. /**
  6460. * Defined the camera the input manager belongs to.
  6461. */
  6462. camera: TCamera;
  6463. /**
  6464. * Update the current camera state depending on the inputs that have been used this frame.
  6465. * This is a dynamically created lambda to avoid the performance penalty of looping for inputs in the render loop.
  6466. */
  6467. checkInputs: () => void;
  6468. /**
  6469. * Instantiate a new Camera Input Manager.
  6470. * @param camera Defines the camera the input manager blongs to
  6471. */
  6472. constructor(camera: TCamera);
  6473. /**
  6474. * Add an input method to a camera
  6475. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  6476. * @param input camera input method
  6477. */
  6478. add(input: ICameraInput<TCamera>): void;
  6479. /**
  6480. * Remove a specific input method from a camera
  6481. * example: camera.inputs.remove(camera.inputs.attached.mouse);
  6482. * @param inputToRemove camera input method
  6483. */
  6484. remove(inputToRemove: ICameraInput<TCamera>): void;
  6485. /**
  6486. * Remove a specific input type from a camera
  6487. * example: camera.inputs.remove("ArcRotateCameraGamepadInput");
  6488. * @param inputType the type of the input to remove
  6489. */
  6490. removeByType(inputType: string): void;
  6491. private _addCheckInputs;
  6492. /**
  6493. * Attach the input controls to the currently attached dom element to listen the events from.
  6494. * @param input Defines the input to attach
  6495. */
  6496. attachInput(input: ICameraInput<TCamera>): void;
  6497. /**
  6498. * Attach the current manager inputs controls to a specific dom element to listen the events from.
  6499. * @param element Defines the dom element to collect the events from
  6500. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  6501. */
  6502. attachElement(element: HTMLElement, noPreventDefault?: boolean): void;
  6503. /**
  6504. * Detach the current manager inputs controls from a specific dom element.
  6505. * @param element Defines the dom element to collect the events from
  6506. * @param disconnect Defines whether the input should be removed from the current list of attached inputs
  6507. */
  6508. detachElement(element: HTMLElement, disconnect?: boolean): void;
  6509. /**
  6510. * Rebuild the dynamic inputCheck function from the current list of
  6511. * defined inputs in the manager.
  6512. */
  6513. rebuildInputCheck(): void;
  6514. /**
  6515. * Remove all attached input methods from a camera
  6516. */
  6517. clear(): void;
  6518. /**
  6519. * Serialize the current input manager attached to a camera.
  6520. * This ensures than once parsed,
  6521. * the input associated to the camera will be identical to the current ones
  6522. * @param serializedCamera Defines the camera serialization JSON the input serialization should write to
  6523. */
  6524. serialize(serializedCamera: any): void;
  6525. /**
  6526. * Parses an input manager serialized JSON to restore the previous list of inputs
  6527. * and states associated to a camera.
  6528. * @param parsedCamera Defines the JSON to parse
  6529. */
  6530. parse(parsedCamera: any): void;
  6531. }
  6532. }
  6533. declare module "babylonjs/Meshes/buffer" {
  6534. import { Nullable, DataArray } from "babylonjs/types";
  6535. import { DataBuffer } from "babylonjs/Meshes/dataBuffer";
  6536. /**
  6537. * Class used to store data that will be store in GPU memory
  6538. */
  6539. export class Buffer {
  6540. private _engine;
  6541. private _buffer;
  6542. /** @hidden */
  6543. _data: Nullable<DataArray>;
  6544. private _updatable;
  6545. private _instanced;
  6546. private _divisor;
  6547. /**
  6548. * Gets the byte stride.
  6549. */
  6550. readonly byteStride: number;
  6551. /**
  6552. * Constructor
  6553. * @param engine the engine
  6554. * @param data the data to use for this buffer
  6555. * @param updatable whether the data is updatable
  6556. * @param stride the stride (optional)
  6557. * @param postponeInternalCreation whether to postpone creating the internal WebGL buffer (optional)
  6558. * @param instanced whether the buffer is instanced (optional)
  6559. * @param useBytes set to true if the stride in in bytes (optional)
  6560. * @param divisor sets an optional divisor for instances (1 by default)
  6561. */
  6562. constructor(engine: any, data: DataArray, updatable: boolean, stride?: number, postponeInternalCreation?: boolean, instanced?: boolean, useBytes?: boolean, divisor?: number);
  6563. /**
  6564. * Create a new VertexBuffer based on the current buffer
  6565. * @param kind defines the vertex buffer kind (position, normal, etc.)
  6566. * @param offset defines offset in the buffer (0 by default)
  6567. * @param size defines the size in floats of attributes (position is 3 for instance)
  6568. * @param stride defines the stride size in floats in the buffer (the offset to apply to reach next value when data is interleaved)
  6569. * @param instanced defines if the vertex buffer contains indexed data
  6570. * @param useBytes defines if the offset and stride are in bytes *
  6571. * @param divisor sets an optional divisor for instances (1 by default)
  6572. * @returns the new vertex buffer
  6573. */
  6574. createVertexBuffer(kind: string, offset: number, size: number, stride?: number, instanced?: boolean, useBytes?: boolean, divisor?: number): VertexBuffer;
  6575. /**
  6576. * Gets a boolean indicating if the Buffer is updatable?
  6577. * @returns true if the buffer is updatable
  6578. */
  6579. isUpdatable(): boolean;
  6580. /**
  6581. * Gets current buffer's data
  6582. * @returns a DataArray or null
  6583. */
  6584. getData(): Nullable<DataArray>;
  6585. /**
  6586. * Gets underlying native buffer
  6587. * @returns underlying native buffer
  6588. */
  6589. getBuffer(): Nullable<DataBuffer>;
  6590. /**
  6591. * Gets the stride in float32 units (i.e. byte stride / 4).
  6592. * May not be an integer if the byte stride is not divisible by 4.
  6593. * @returns the stride in float32 units
  6594. * @deprecated Please use byteStride instead.
  6595. */
  6596. getStrideSize(): number;
  6597. /**
  6598. * Store data into the buffer. If the buffer was already used it will be either recreated or updated depending on isUpdatable property
  6599. * @param data defines the data to store
  6600. */
  6601. create(data?: Nullable<DataArray>): void;
  6602. /** @hidden */
  6603. _rebuild(): void;
  6604. /**
  6605. * Update current buffer data
  6606. * @param data defines the data to store
  6607. */
  6608. update(data: DataArray): void;
  6609. /**
  6610. * Updates the data directly.
  6611. * @param data the new data
  6612. * @param offset the new offset
  6613. * @param vertexCount the vertex count (optional)
  6614. * @param useBytes set to true if the offset is in bytes
  6615. */
  6616. updateDirectly(data: DataArray, offset: number, vertexCount?: number, useBytes?: boolean): void;
  6617. /**
  6618. * Release all resources
  6619. */
  6620. dispose(): void;
  6621. }
  6622. /**
  6623. * Specialized buffer used to store vertex data
  6624. */
  6625. export class VertexBuffer {
  6626. /** @hidden */
  6627. _buffer: Buffer;
  6628. private _kind;
  6629. private _size;
  6630. private _ownsBuffer;
  6631. private _instanced;
  6632. private _instanceDivisor;
  6633. /**
  6634. * The byte type.
  6635. */
  6636. static readonly BYTE: number;
  6637. /**
  6638. * The unsigned byte type.
  6639. */
  6640. static readonly UNSIGNED_BYTE: number;
  6641. /**
  6642. * The short type.
  6643. */
  6644. static readonly SHORT: number;
  6645. /**
  6646. * The unsigned short type.
  6647. */
  6648. static readonly UNSIGNED_SHORT: number;
  6649. /**
  6650. * The integer type.
  6651. */
  6652. static readonly INT: number;
  6653. /**
  6654. * The unsigned integer type.
  6655. */
  6656. static readonly UNSIGNED_INT: number;
  6657. /**
  6658. * The float type.
  6659. */
  6660. static readonly FLOAT: number;
  6661. /**
  6662. * Gets or sets the instance divisor when in instanced mode
  6663. */
  6664. get instanceDivisor(): number;
  6665. set instanceDivisor(value: number);
  6666. /**
  6667. * Gets the byte stride.
  6668. */
  6669. readonly byteStride: number;
  6670. /**
  6671. * Gets the byte offset.
  6672. */
  6673. readonly byteOffset: number;
  6674. /**
  6675. * Gets whether integer data values should be normalized into a certain range when being casted to a float.
  6676. */
  6677. readonly normalized: boolean;
  6678. /**
  6679. * Gets the data type of each component in the array.
  6680. */
  6681. readonly type: number;
  6682. /**
  6683. * Constructor
  6684. * @param engine the engine
  6685. * @param data the data to use for this vertex buffer
  6686. * @param kind the vertex buffer kind
  6687. * @param updatable whether the data is updatable
  6688. * @param postponeInternalCreation whether to postpone creating the internal WebGL buffer (optional)
  6689. * @param stride the stride (optional)
  6690. * @param instanced whether the buffer is instanced (optional)
  6691. * @param offset the offset of the data (optional)
  6692. * @param size the number of components (optional)
  6693. * @param type the type of the component (optional)
  6694. * @param normalized whether the data contains normalized data (optional)
  6695. * @param useBytes set to true if stride and offset are in bytes (optional)
  6696. * @param divisor defines the instance divisor to use (1 by default)
  6697. */
  6698. constructor(engine: any, data: DataArray | Buffer, kind: string, updatable: boolean, postponeInternalCreation?: boolean, stride?: number, instanced?: boolean, offset?: number, size?: number, type?: number, normalized?: boolean, useBytes?: boolean, divisor?: number);
  6699. /** @hidden */
  6700. _rebuild(): void;
  6701. /**
  6702. * Returns the kind of the VertexBuffer (string)
  6703. * @returns a string
  6704. */
  6705. getKind(): string;
  6706. /**
  6707. * Gets a boolean indicating if the VertexBuffer is updatable?
  6708. * @returns true if the buffer is updatable
  6709. */
  6710. isUpdatable(): boolean;
  6711. /**
  6712. * Gets current buffer's data
  6713. * @returns a DataArray or null
  6714. */
  6715. getData(): Nullable<DataArray>;
  6716. /**
  6717. * Gets underlying native buffer
  6718. * @returns underlying native buffer
  6719. */
  6720. getBuffer(): Nullable<DataBuffer>;
  6721. /**
  6722. * Gets the stride in float32 units (i.e. byte stride / 4).
  6723. * May not be an integer if the byte stride is not divisible by 4.
  6724. * @returns the stride in float32 units
  6725. * @deprecated Please use byteStride instead.
  6726. */
  6727. getStrideSize(): number;
  6728. /**
  6729. * Returns the offset as a multiple of the type byte length.
  6730. * @returns the offset in bytes
  6731. * @deprecated Please use byteOffset instead.
  6732. */
  6733. getOffset(): number;
  6734. /**
  6735. * Returns the number of components per vertex attribute (integer)
  6736. * @returns the size in float
  6737. */
  6738. getSize(): number;
  6739. /**
  6740. * Gets a boolean indicating is the internal buffer of the VertexBuffer is instanced
  6741. * @returns true if this buffer is instanced
  6742. */
  6743. getIsInstanced(): boolean;
  6744. /**
  6745. * Returns the instancing divisor, zero for non-instanced (integer).
  6746. * @returns a number
  6747. */
  6748. getInstanceDivisor(): number;
  6749. /**
  6750. * Store data into the buffer. If the buffer was already used it will be either recreated or updated depending on isUpdatable property
  6751. * @param data defines the data to store
  6752. */
  6753. create(data?: DataArray): void;
  6754. /**
  6755. * Updates the underlying buffer according to the passed numeric array or Float32Array.
  6756. * This function will create a new buffer if the current one is not updatable
  6757. * @param data defines the data to store
  6758. */
  6759. update(data: DataArray): void;
  6760. /**
  6761. * Updates directly the underlying WebGLBuffer according to the passed numeric array or Float32Array.
  6762. * Returns the directly updated WebGLBuffer.
  6763. * @param data the new data
  6764. * @param offset the new offset
  6765. * @param useBytes set to true if the offset is in bytes
  6766. */
  6767. updateDirectly(data: DataArray, offset: number, useBytes?: boolean): void;
  6768. /**
  6769. * Disposes the VertexBuffer and the underlying WebGLBuffer.
  6770. */
  6771. dispose(): void;
  6772. /**
  6773. * Enumerates each value of this vertex buffer as numbers.
  6774. * @param count the number of values to enumerate
  6775. * @param callback the callback function called for each value
  6776. */
  6777. forEach(count: number, callback: (value: number, index: number) => void): void;
  6778. /**
  6779. * Positions
  6780. */
  6781. static readonly PositionKind: string;
  6782. /**
  6783. * Normals
  6784. */
  6785. static readonly NormalKind: string;
  6786. /**
  6787. * Tangents
  6788. */
  6789. static readonly TangentKind: string;
  6790. /**
  6791. * Texture coordinates
  6792. */
  6793. static readonly UVKind: string;
  6794. /**
  6795. * Texture coordinates 2
  6796. */
  6797. static readonly UV2Kind: string;
  6798. /**
  6799. * Texture coordinates 3
  6800. */
  6801. static readonly UV3Kind: string;
  6802. /**
  6803. * Texture coordinates 4
  6804. */
  6805. static readonly UV4Kind: string;
  6806. /**
  6807. * Texture coordinates 5
  6808. */
  6809. static readonly UV5Kind: string;
  6810. /**
  6811. * Texture coordinates 6
  6812. */
  6813. static readonly UV6Kind: string;
  6814. /**
  6815. * Colors
  6816. */
  6817. static readonly ColorKind: string;
  6818. /**
  6819. * Matrix indices (for bones)
  6820. */
  6821. static readonly MatricesIndicesKind: string;
  6822. /**
  6823. * Matrix weights (for bones)
  6824. */
  6825. static readonly MatricesWeightsKind: string;
  6826. /**
  6827. * Additional matrix indices (for bones)
  6828. */
  6829. static readonly MatricesIndicesExtraKind: string;
  6830. /**
  6831. * Additional matrix weights (for bones)
  6832. */
  6833. static readonly MatricesWeightsExtraKind: string;
  6834. /**
  6835. * Deduces the stride given a kind.
  6836. * @param kind The kind string to deduce
  6837. * @returns The deduced stride
  6838. */
  6839. static DeduceStride(kind: string): number;
  6840. /**
  6841. * Gets the byte length of the given type.
  6842. * @param type the type
  6843. * @returns the number of bytes
  6844. */
  6845. static GetTypeByteLength(type: number): number;
  6846. /**
  6847. * Enumerates each value of the given parameters as numbers.
  6848. * @param data the data to enumerate
  6849. * @param byteOffset the byte offset of the data
  6850. * @param byteStride the byte stride of the data
  6851. * @param componentCount the number of components per element
  6852. * @param componentType the type of the component
  6853. * @param count the number of values to enumerate
  6854. * @param normalized whether the data is normalized
  6855. * @param callback the callback function called for each value
  6856. */
  6857. static ForEach(data: DataArray, byteOffset: number, byteStride: number, componentCount: number, componentType: number, count: number, normalized: boolean, callback: (value: number, index: number) => void): void;
  6858. private static _GetFloatValue;
  6859. }
  6860. }
  6861. declare module "babylonjs/Collisions/intersectionInfo" {
  6862. import { Nullable } from "babylonjs/types";
  6863. /**
  6864. * @hidden
  6865. */
  6866. export class IntersectionInfo {
  6867. bu: Nullable<number>;
  6868. bv: Nullable<number>;
  6869. distance: number;
  6870. faceId: number;
  6871. subMeshId: number;
  6872. constructor(bu: Nullable<number>, bv: Nullable<number>, distance: number);
  6873. }
  6874. }
  6875. declare module "babylonjs/Culling/boundingSphere" {
  6876. import { DeepImmutable } from "babylonjs/types";
  6877. import { Matrix, Vector3 } from "babylonjs/Maths/math.vector";
  6878. import { Plane } from "babylonjs/Maths/math.plane";
  6879. /**
  6880. * Class used to store bounding sphere information
  6881. */
  6882. export class BoundingSphere {
  6883. /**
  6884. * Gets the center of the bounding sphere in local space
  6885. */
  6886. readonly center: Vector3;
  6887. /**
  6888. * Radius of the bounding sphere in local space
  6889. */
  6890. radius: number;
  6891. /**
  6892. * Gets the center of the bounding sphere in world space
  6893. */
  6894. readonly centerWorld: Vector3;
  6895. /**
  6896. * Radius of the bounding sphere in world space
  6897. */
  6898. radiusWorld: number;
  6899. /**
  6900. * Gets the minimum vector in local space
  6901. */
  6902. readonly minimum: Vector3;
  6903. /**
  6904. * Gets the maximum vector in local space
  6905. */
  6906. readonly maximum: Vector3;
  6907. private _worldMatrix;
  6908. private static readonly TmpVector3;
  6909. /**
  6910. * Creates a new bounding sphere
  6911. * @param min defines the minimum vector (in local space)
  6912. * @param max defines the maximum vector (in local space)
  6913. * @param worldMatrix defines the new world matrix
  6914. */
  6915. constructor(min: DeepImmutable<Vector3>, max: DeepImmutable<Vector3>, worldMatrix?: DeepImmutable<Matrix>);
  6916. /**
  6917. * Recreates the entire bounding sphere from scratch as if we call the constructor in place
  6918. * @param min defines the new minimum vector (in local space)
  6919. * @param max defines the new maximum vector (in local space)
  6920. * @param worldMatrix defines the new world matrix
  6921. */
  6922. reConstruct(min: DeepImmutable<Vector3>, max: DeepImmutable<Vector3>, worldMatrix?: DeepImmutable<Matrix>): void;
  6923. /**
  6924. * Scale the current bounding sphere by applying a scale factor
  6925. * @param factor defines the scale factor to apply
  6926. * @returns the current bounding box
  6927. */
  6928. scale(factor: number): BoundingSphere;
  6929. /**
  6930. * Gets the world matrix of the bounding box
  6931. * @returns a matrix
  6932. */
  6933. getWorldMatrix(): DeepImmutable<Matrix>;
  6934. /** @hidden */
  6935. _update(worldMatrix: DeepImmutable<Matrix>): void;
  6936. /**
  6937. * Tests if the bounding sphere is intersecting the frustum planes
  6938. * @param frustumPlanes defines the frustum planes to test
  6939. * @returns true if there is an intersection
  6940. */
  6941. isInFrustum(frustumPlanes: Array<DeepImmutable<Plane>>): boolean;
  6942. /**
  6943. * Tests if the bounding sphere center is in between the frustum planes.
  6944. * Used for optimistic fast inclusion.
  6945. * @param frustumPlanes defines the frustum planes to test
  6946. * @returns true if the sphere center is in between the frustum planes
  6947. */
  6948. isCenterInFrustum(frustumPlanes: Array<DeepImmutable<Plane>>): boolean;
  6949. /**
  6950. * Tests if a point is inside the bounding sphere
  6951. * @param point defines the point to test
  6952. * @returns true if the point is inside the bounding sphere
  6953. */
  6954. intersectsPoint(point: DeepImmutable<Vector3>): boolean;
  6955. /**
  6956. * Checks if two sphere intersct
  6957. * @param sphere0 sphere 0
  6958. * @param sphere1 sphere 1
  6959. * @returns true if the speres intersect
  6960. */
  6961. static Intersects(sphere0: DeepImmutable<BoundingSphere>, sphere1: DeepImmutable<BoundingSphere>): boolean;
  6962. }
  6963. }
  6964. declare module "babylonjs/Culling/boundingBox" {
  6965. import { DeepImmutable } from "babylonjs/types";
  6966. import { Matrix, Vector3 } from "babylonjs/Maths/math.vector";
  6967. import { BoundingSphere } from "babylonjs/Culling/boundingSphere";
  6968. import { ICullable } from "babylonjs/Culling/boundingInfo";
  6969. import { Plane } from "babylonjs/Maths/math.plane";
  6970. /**
  6971. * Class used to store bounding box information
  6972. */
  6973. export class BoundingBox implements ICullable {
  6974. /**
  6975. * Gets the 8 vectors representing the bounding box in local space
  6976. */
  6977. readonly vectors: Vector3[];
  6978. /**
  6979. * Gets the center of the bounding box in local space
  6980. */
  6981. readonly center: Vector3;
  6982. /**
  6983. * Gets the center of the bounding box in world space
  6984. */
  6985. readonly centerWorld: Vector3;
  6986. /**
  6987. * Gets the extend size in local space
  6988. */
  6989. readonly extendSize: Vector3;
  6990. /**
  6991. * Gets the extend size in world space
  6992. */
  6993. readonly extendSizeWorld: Vector3;
  6994. /**
  6995. * Gets the OBB (object bounding box) directions
  6996. */
  6997. readonly directions: Vector3[];
  6998. /**
  6999. * Gets the 8 vectors representing the bounding box in world space
  7000. */
  7001. readonly vectorsWorld: Vector3[];
  7002. /**
  7003. * Gets the minimum vector in world space
  7004. */
  7005. readonly minimumWorld: Vector3;
  7006. /**
  7007. * Gets the maximum vector in world space
  7008. */
  7009. readonly maximumWorld: Vector3;
  7010. /**
  7011. * Gets the minimum vector in local space
  7012. */
  7013. readonly minimum: Vector3;
  7014. /**
  7015. * Gets the maximum vector in local space
  7016. */
  7017. readonly maximum: Vector3;
  7018. private _worldMatrix;
  7019. private static readonly TmpVector3;
  7020. /**
  7021. * @hidden
  7022. */
  7023. _tag: number;
  7024. /**
  7025. * Creates a new bounding box
  7026. * @param min defines the minimum vector (in local space)
  7027. * @param max defines the maximum vector (in local space)
  7028. * @param worldMatrix defines the new world matrix
  7029. */
  7030. constructor(min: DeepImmutable<Vector3>, max: DeepImmutable<Vector3>, worldMatrix?: DeepImmutable<Matrix>);
  7031. /**
  7032. * Recreates the entire bounding box from scratch as if we call the constructor in place
  7033. * @param min defines the new minimum vector (in local space)
  7034. * @param max defines the new maximum vector (in local space)
  7035. * @param worldMatrix defines the new world matrix
  7036. */
  7037. reConstruct(min: DeepImmutable<Vector3>, max: DeepImmutable<Vector3>, worldMatrix?: DeepImmutable<Matrix>): void;
  7038. /**
  7039. * Scale the current bounding box by applying a scale factor
  7040. * @param factor defines the scale factor to apply
  7041. * @returns the current bounding box
  7042. */
  7043. scale(factor: number): BoundingBox;
  7044. /**
  7045. * Gets the world matrix of the bounding box
  7046. * @returns a matrix
  7047. */
  7048. getWorldMatrix(): DeepImmutable<Matrix>;
  7049. /** @hidden */
  7050. _update(world: DeepImmutable<Matrix>): void;
  7051. /**
  7052. * Tests if the bounding box is intersecting the frustum planes
  7053. * @param frustumPlanes defines the frustum planes to test
  7054. * @returns true if there is an intersection
  7055. */
  7056. isInFrustum(frustumPlanes: Array<DeepImmutable<Plane>>): boolean;
  7057. /**
  7058. * Tests if the bounding box is entirely inside the frustum planes
  7059. * @param frustumPlanes defines the frustum planes to test
  7060. * @returns true if there is an inclusion
  7061. */
  7062. isCompletelyInFrustum(frustumPlanes: Array<DeepImmutable<Plane>>): boolean;
  7063. /**
  7064. * Tests if a point is inside the bounding box
  7065. * @param point defines the point to test
  7066. * @returns true if the point is inside the bounding box
  7067. */
  7068. intersectsPoint(point: DeepImmutable<Vector3>): boolean;
  7069. /**
  7070. * Tests if the bounding box intersects with a bounding sphere
  7071. * @param sphere defines the sphere to test
  7072. * @returns true if there is an intersection
  7073. */
  7074. intersectsSphere(sphere: DeepImmutable<BoundingSphere>): boolean;
  7075. /**
  7076. * Tests if the bounding box intersects with a box defined by a min and max vectors
  7077. * @param min defines the min vector to use
  7078. * @param max defines the max vector to use
  7079. * @returns true if there is an intersection
  7080. */
  7081. intersectsMinMax(min: DeepImmutable<Vector3>, max: DeepImmutable<Vector3>): boolean;
  7082. /**
  7083. * Tests if two bounding boxes are intersections
  7084. * @param box0 defines the first box to test
  7085. * @param box1 defines the second box to test
  7086. * @returns true if there is an intersection
  7087. */
  7088. static Intersects(box0: DeepImmutable<BoundingBox>, box1: DeepImmutable<BoundingBox>): boolean;
  7089. /**
  7090. * Tests if a bounding box defines by a min/max vectors intersects a sphere
  7091. * @param minPoint defines the minimum vector of the bounding box
  7092. * @param maxPoint defines the maximum vector of the bounding box
  7093. * @param sphereCenter defines the sphere center
  7094. * @param sphereRadius defines the sphere radius
  7095. * @returns true if there is an intersection
  7096. */
  7097. static IntersectsSphere(minPoint: DeepImmutable<Vector3>, maxPoint: DeepImmutable<Vector3>, sphereCenter: DeepImmutable<Vector3>, sphereRadius: number): boolean;
  7098. /**
  7099. * Tests if a bounding box defined with 8 vectors is entirely inside frustum planes
  7100. * @param boundingVectors defines an array of 8 vectors representing a bounding box
  7101. * @param frustumPlanes defines the frustum planes to test
  7102. * @return true if there is an inclusion
  7103. */
  7104. static IsCompletelyInFrustum(boundingVectors: Array<DeepImmutable<Vector3>>, frustumPlanes: Array<DeepImmutable<Plane>>): boolean;
  7105. /**
  7106. * Tests if a bounding box defined with 8 vectors intersects frustum planes
  7107. * @param boundingVectors defines an array of 8 vectors representing a bounding box
  7108. * @param frustumPlanes defines the frustum planes to test
  7109. * @return true if there is an intersection
  7110. */
  7111. static IsInFrustum(boundingVectors: Array<DeepImmutable<Vector3>>, frustumPlanes: Array<DeepImmutable<Plane>>): boolean;
  7112. }
  7113. }
  7114. declare module "babylonjs/Collisions/collider" {
  7115. import { Nullable, IndicesArray } from "babylonjs/types";
  7116. import { Vector3 } from "babylonjs/Maths/math.vector";
  7117. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  7118. import { Plane } from "babylonjs/Maths/math.plane";
  7119. /** @hidden */
  7120. export class Collider {
  7121. /** Define if a collision was found */
  7122. collisionFound: boolean;
  7123. /**
  7124. * Define last intersection point in local space
  7125. */
  7126. intersectionPoint: Vector3;
  7127. /**
  7128. * Define last collided mesh
  7129. */
  7130. collidedMesh: Nullable<AbstractMesh>;
  7131. private _collisionPoint;
  7132. private _planeIntersectionPoint;
  7133. private _tempVector;
  7134. private _tempVector2;
  7135. private _tempVector3;
  7136. private _tempVector4;
  7137. private _edge;
  7138. private _baseToVertex;
  7139. private _destinationPoint;
  7140. private _slidePlaneNormal;
  7141. private _displacementVector;
  7142. /** @hidden */
  7143. _radius: Vector3;
  7144. /** @hidden */
  7145. _retry: number;
  7146. private _velocity;
  7147. private _basePoint;
  7148. private _epsilon;
  7149. /** @hidden */
  7150. _velocityWorldLength: number;
  7151. /** @hidden */
  7152. _basePointWorld: Vector3;
  7153. private _velocityWorld;
  7154. private _normalizedVelocity;
  7155. /** @hidden */
  7156. _initialVelocity: Vector3;
  7157. /** @hidden */
  7158. _initialPosition: Vector3;
  7159. private _nearestDistance;
  7160. private _collisionMask;
  7161. get collisionMask(): number;
  7162. set collisionMask(mask: number);
  7163. /**
  7164. * Gets the plane normal used to compute the sliding response (in local space)
  7165. */
  7166. get slidePlaneNormal(): Vector3;
  7167. /** @hidden */
  7168. _initialize(source: Vector3, dir: Vector3, e: number): void;
  7169. /** @hidden */
  7170. _checkPointInTriangle(point: Vector3, pa: Vector3, pb: Vector3, pc: Vector3, n: Vector3): boolean;
  7171. /** @hidden */
  7172. _canDoCollision(sphereCenter: Vector3, sphereRadius: number, vecMin: Vector3, vecMax: Vector3): boolean;
  7173. /** @hidden */
  7174. _testTriangle(faceIndex: number, trianglePlaneArray: Array<Plane>, p1: Vector3, p2: Vector3, p3: Vector3, hasMaterial: boolean, hostMesh: AbstractMesh): void;
  7175. /** @hidden */
  7176. _collide(trianglePlaneArray: Array<Plane>, pts: Vector3[], indices: IndicesArray, indexStart: number, indexEnd: number, decal: number, hasMaterial: boolean, hostMesh: AbstractMesh): void;
  7177. /** @hidden */
  7178. _getResponse(pos: Vector3, vel: Vector3): void;
  7179. }
  7180. }
  7181. declare module "babylonjs/Culling/boundingInfo" {
  7182. import { DeepImmutable } from "babylonjs/types";
  7183. import { Matrix, Vector3 } from "babylonjs/Maths/math.vector";
  7184. import { BoundingBox } from "babylonjs/Culling/boundingBox";
  7185. import { BoundingSphere } from "babylonjs/Culling/boundingSphere";
  7186. import { Plane } from "babylonjs/Maths/math.plane";
  7187. import { Collider } from "babylonjs/Collisions/collider";
  7188. /**
  7189. * Interface for cullable objects
  7190. * @see https://doc.babylonjs.com/babylon101/materials#back-face-culling
  7191. */
  7192. export interface ICullable {
  7193. /**
  7194. * Checks if the object or part of the object is in the frustum
  7195. * @param frustumPlanes Camera near/planes
  7196. * @returns true if the object is in frustum otherwise false
  7197. */
  7198. isInFrustum(frustumPlanes: Plane[]): boolean;
  7199. /**
  7200. * Checks if a cullable object (mesh...) is in the camera frustum
  7201. * Unlike isInFrustum this cheks the full bounding box
  7202. * @param frustumPlanes Camera near/planes
  7203. * @returns true if the object is in frustum otherwise false
  7204. */
  7205. isCompletelyInFrustum(frustumPlanes: Plane[]): boolean;
  7206. }
  7207. /**
  7208. * Info for a bounding data of a mesh
  7209. */
  7210. export class BoundingInfo implements ICullable {
  7211. /**
  7212. * Bounding box for the mesh
  7213. */
  7214. readonly boundingBox: BoundingBox;
  7215. /**
  7216. * Bounding sphere for the mesh
  7217. */
  7218. readonly boundingSphere: BoundingSphere;
  7219. private _isLocked;
  7220. private static readonly TmpVector3;
  7221. /**
  7222. * Constructs bounding info
  7223. * @param minimum min vector of the bounding box/sphere
  7224. * @param maximum max vector of the bounding box/sphere
  7225. * @param worldMatrix defines the new world matrix
  7226. */
  7227. constructor(minimum: DeepImmutable<Vector3>, maximum: DeepImmutable<Vector3>, worldMatrix?: DeepImmutable<Matrix>);
  7228. /**
  7229. * Recreates the entire bounding info from scratch as if we call the constructor in place
  7230. * @param min defines the new minimum vector (in local space)
  7231. * @param max defines the new maximum vector (in local space)
  7232. * @param worldMatrix defines the new world matrix
  7233. */
  7234. reConstruct(min: DeepImmutable<Vector3>, max: DeepImmutable<Vector3>, worldMatrix?: DeepImmutable<Matrix>): void;
  7235. /**
  7236. * min vector of the bounding box/sphere
  7237. */
  7238. get minimum(): Vector3;
  7239. /**
  7240. * max vector of the bounding box/sphere
  7241. */
  7242. get maximum(): Vector3;
  7243. /**
  7244. * If the info is locked and won't be updated to avoid perf overhead
  7245. */
  7246. get isLocked(): boolean;
  7247. set isLocked(value: boolean);
  7248. /**
  7249. * Updates the bounding sphere and box
  7250. * @param world world matrix to be used to update
  7251. */
  7252. update(world: DeepImmutable<Matrix>): void;
  7253. /**
  7254. * Recreate the bounding info to be centered around a specific point given a specific extend.
  7255. * @param center New center of the bounding info
  7256. * @param extend New extend of the bounding info
  7257. * @returns the current bounding info
  7258. */
  7259. centerOn(center: DeepImmutable<Vector3>, extend: DeepImmutable<Vector3>): BoundingInfo;
  7260. /**
  7261. * Scale the current bounding info by applying a scale factor
  7262. * @param factor defines the scale factor to apply
  7263. * @returns the current bounding info
  7264. */
  7265. scale(factor: number): BoundingInfo;
  7266. /**
  7267. * Returns `true` if the bounding info is within the frustum defined by the passed array of planes.
  7268. * @param frustumPlanes defines the frustum to test
  7269. * @param strategy defines the strategy to use for the culling (default is BABYLON.AbstractMesh.CULLINGSTRATEGY_STANDARD)
  7270. * @returns true if the bounding info is in the frustum planes
  7271. */
  7272. isInFrustum(frustumPlanes: Array<DeepImmutable<Plane>>, strategy?: number): boolean;
  7273. /**
  7274. * Gets the world distance between the min and max points of the bounding box
  7275. */
  7276. get diagonalLength(): number;
  7277. /**
  7278. * Checks if a cullable object (mesh...) is in the camera frustum
  7279. * Unlike isInFrustum this cheks the full bounding box
  7280. * @param frustumPlanes Camera near/planes
  7281. * @returns true if the object is in frustum otherwise false
  7282. */
  7283. isCompletelyInFrustum(frustumPlanes: Array<DeepImmutable<Plane>>): boolean;
  7284. /** @hidden */
  7285. _checkCollision(collider: Collider): boolean;
  7286. /**
  7287. * Checks if a point is inside the bounding box and bounding sphere or the mesh
  7288. * @see https://doc.babylonjs.com/babylon101/intersect_collisions_-_mesh
  7289. * @param point the point to check intersection with
  7290. * @returns if the point intersects
  7291. */
  7292. intersectsPoint(point: DeepImmutable<Vector3>): boolean;
  7293. /**
  7294. * Checks if another bounding info intersects the bounding box and bounding sphere or the mesh
  7295. * @see https://doc.babylonjs.com/babylon101/intersect_collisions_-_mesh
  7296. * @param boundingInfo the bounding info to check intersection with
  7297. * @param precise if the intersection should be done using OBB
  7298. * @returns if the bounding info intersects
  7299. */
  7300. intersects(boundingInfo: DeepImmutable<BoundingInfo>, precise: boolean): boolean;
  7301. }
  7302. }
  7303. declare module "babylonjs/Maths/math.functions" {
  7304. import { FloatArray, Nullable, IndicesArray } from "babylonjs/types";
  7305. import { Vector2, Vector3 } from "babylonjs/Maths/math.vector";
  7306. /**
  7307. * Extracts minimum and maximum values from a list of indexed positions
  7308. * @param positions defines the positions to use
  7309. * @param indices defines the indices to the positions
  7310. * @param indexStart defines the start index
  7311. * @param indexCount defines the end index
  7312. * @param bias defines bias value to add to the result
  7313. * @return minimum and maximum values
  7314. */
  7315. export function extractMinAndMaxIndexed(positions: FloatArray, indices: IndicesArray, indexStart: number, indexCount: number, bias?: Nullable<Vector2>): {
  7316. minimum: Vector3;
  7317. maximum: Vector3;
  7318. };
  7319. /**
  7320. * Extracts minimum and maximum values from a list of positions
  7321. * @param positions defines the positions to use
  7322. * @param start defines the start index in the positions array
  7323. * @param count defines the number of positions to handle
  7324. * @param bias defines bias value to add to the result
  7325. * @param stride defines the stride size to use (distance between two positions in the positions array)
  7326. * @return minimum and maximum values
  7327. */
  7328. export function extractMinAndMax(positions: FloatArray, start: number, count: number, bias?: Nullable<Vector2>, stride?: number): {
  7329. minimum: Vector3;
  7330. maximum: Vector3;
  7331. };
  7332. }
  7333. declare module "babylonjs/Meshes/WebGL/webGLDataBuffer" {
  7334. import { DataBuffer } from "babylonjs/Meshes/dataBuffer";
  7335. /** @hidden */
  7336. export class WebGLDataBuffer extends DataBuffer {
  7337. private _buffer;
  7338. constructor(resource: WebGLBuffer);
  7339. get underlyingResource(): any;
  7340. }
  7341. }
  7342. declare module "babylonjs/Engines/WebGL/webGLPipelineContext" {
  7343. import { IPipelineContext } from "babylonjs/Engines/IPipelineContext";
  7344. import { Nullable } from "babylonjs/types";
  7345. import { ThinEngine } from "babylonjs/Engines/thinEngine";
  7346. /** @hidden */
  7347. export class WebGLPipelineContext implements IPipelineContext {
  7348. engine: ThinEngine;
  7349. program: Nullable<WebGLProgram>;
  7350. context?: WebGLRenderingContext;
  7351. vertexShader?: WebGLShader;
  7352. fragmentShader?: WebGLShader;
  7353. isParallelCompiled: boolean;
  7354. onCompiled?: () => void;
  7355. transformFeedback?: WebGLTransformFeedback | null;
  7356. vertexCompilationError: Nullable<string>;
  7357. fragmentCompilationError: Nullable<string>;
  7358. programLinkError: Nullable<string>;
  7359. programValidationError: Nullable<string>;
  7360. get isAsync(): boolean;
  7361. get isReady(): boolean;
  7362. _handlesSpectorRebuildCallback(onCompiled: (program: WebGLProgram) => void): void;
  7363. _getVertexShaderCode(): string | null;
  7364. _getFragmentShaderCode(): string | null;
  7365. }
  7366. }
  7367. declare module "babylonjs/Engines/Extensions/engine.uniformBuffer" {
  7368. import { FloatArray, Nullable } from "babylonjs/types";
  7369. import { DataBuffer } from "babylonjs/Meshes/dataBuffer";
  7370. import { IPipelineContext } from "babylonjs/Engines/IPipelineContext";
  7371. module "babylonjs/Engines/thinEngine" {
  7372. interface ThinEngine {
  7373. /**
  7374. * Create an uniform buffer
  7375. * @see https://doc.babylonjs.com/features/webgl2#uniform-buffer-objets
  7376. * @param elements defines the content of the uniform buffer
  7377. * @returns the webGL uniform buffer
  7378. */
  7379. createUniformBuffer(elements: FloatArray): DataBuffer;
  7380. /**
  7381. * Create a dynamic uniform buffer
  7382. * @see https://doc.babylonjs.com/features/webgl2#uniform-buffer-objets
  7383. * @param elements defines the content of the uniform buffer
  7384. * @returns the webGL uniform buffer
  7385. */
  7386. createDynamicUniformBuffer(elements: FloatArray): DataBuffer;
  7387. /**
  7388. * Update an existing uniform buffer
  7389. * @see https://doc.babylonjs.com/features/webgl2#uniform-buffer-objets
  7390. * @param uniformBuffer defines the target uniform buffer
  7391. * @param elements defines the content to update
  7392. * @param offset defines the offset in the uniform buffer where update should start
  7393. * @param count defines the size of the data to update
  7394. */
  7395. updateUniformBuffer(uniformBuffer: DataBuffer, elements: FloatArray, offset?: number, count?: number): void;
  7396. /**
  7397. * Bind an uniform buffer to the current webGL context
  7398. * @param buffer defines the buffer to bind
  7399. */
  7400. bindUniformBuffer(buffer: Nullable<DataBuffer>): void;
  7401. /**
  7402. * Bind a buffer to the current webGL context at a given location
  7403. * @param buffer defines the buffer to bind
  7404. * @param location defines the index where to bind the buffer
  7405. */
  7406. bindUniformBufferBase(buffer: DataBuffer, location: number): void;
  7407. /**
  7408. * Bind a specific block at a given index in a specific shader program
  7409. * @param pipelineContext defines the pipeline context to use
  7410. * @param blockName defines the block name
  7411. * @param index defines the index where to bind the block
  7412. */
  7413. bindUniformBlock(pipelineContext: IPipelineContext, blockName: string, index: number): void;
  7414. }
  7415. }
  7416. }
  7417. declare module "babylonjs/Materials/uniformBuffer" {
  7418. import { Nullable, FloatArray } from "babylonjs/types";
  7419. import { Matrix, Vector3, Vector4 } from "babylonjs/Maths/math.vector";
  7420. import { Engine } from "babylonjs/Engines/engine";
  7421. import { Effect } from "babylonjs/Materials/effect";
  7422. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  7423. import { DataBuffer } from "babylonjs/Meshes/dataBuffer";
  7424. import { Color3 } from "babylonjs/Maths/math.color";
  7425. import "babylonjs/Engines/Extensions/engine.uniformBuffer";
  7426. /**
  7427. * Uniform buffer objects.
  7428. *
  7429. * Handles blocks of uniform on the GPU.
  7430. *
  7431. * If WebGL 2 is not available, this class falls back on traditionnal setUniformXXX calls.
  7432. *
  7433. * For more information, please refer to :
  7434. * https://www.khronos.org/opengl/wiki/Uniform_Buffer_Object
  7435. */
  7436. export class UniformBuffer {
  7437. private _engine;
  7438. private _buffer;
  7439. private _data;
  7440. private _bufferData;
  7441. private _dynamic?;
  7442. private _uniformLocations;
  7443. private _uniformSizes;
  7444. private _uniformLocationPointer;
  7445. private _needSync;
  7446. private _noUBO;
  7447. private _currentEffect;
  7448. /** @hidden */
  7449. _alreadyBound: boolean;
  7450. private static _MAX_UNIFORM_SIZE;
  7451. private static _tempBuffer;
  7452. /**
  7453. * Lambda to Update a 3x3 Matrix in a uniform buffer.
  7454. * This is dynamic to allow compat with webgl 1 and 2.
  7455. * You will need to pass the name of the uniform as well as the value.
  7456. */
  7457. updateMatrix3x3: (name: string, matrix: Float32Array) => void;
  7458. /**
  7459. * Lambda to Update a 2x2 Matrix in a uniform buffer.
  7460. * This is dynamic to allow compat with webgl 1 and 2.
  7461. * You will need to pass the name of the uniform as well as the value.
  7462. */
  7463. updateMatrix2x2: (name: string, matrix: Float32Array) => void;
  7464. /**
  7465. * Lambda to Update a single float in a uniform buffer.
  7466. * This is dynamic to allow compat with webgl 1 and 2.
  7467. * You will need to pass the name of the uniform as well as the value.
  7468. */
  7469. updateFloat: (name: string, x: number) => void;
  7470. /**
  7471. * Lambda to Update a vec2 of float in a uniform buffer.
  7472. * This is dynamic to allow compat with webgl 1 and 2.
  7473. * You will need to pass the name of the uniform as well as the value.
  7474. */
  7475. updateFloat2: (name: string, x: number, y: number, suffix?: string) => void;
  7476. /**
  7477. * Lambda to Update a vec3 of float in a uniform buffer.
  7478. * This is dynamic to allow compat with webgl 1 and 2.
  7479. * You will need to pass the name of the uniform as well as the value.
  7480. */
  7481. updateFloat3: (name: string, x: number, y: number, z: number, suffix?: string) => void;
  7482. /**
  7483. * Lambda to Update a vec4 of float in a uniform buffer.
  7484. * This is dynamic to allow compat with webgl 1 and 2.
  7485. * You will need to pass the name of the uniform as well as the value.
  7486. */
  7487. updateFloat4: (name: string, x: number, y: number, z: number, w: number, suffix?: string) => void;
  7488. /**
  7489. * Lambda to Update a 4x4 Matrix in a uniform buffer.
  7490. * This is dynamic to allow compat with webgl 1 and 2.
  7491. * You will need to pass the name of the uniform as well as the value.
  7492. */
  7493. updateMatrix: (name: string, mat: Matrix) => void;
  7494. /**
  7495. * Lambda to Update vec3 of float from a Vector in a uniform buffer.
  7496. * This is dynamic to allow compat with webgl 1 and 2.
  7497. * You will need to pass the name of the uniform as well as the value.
  7498. */
  7499. updateVector3: (name: string, vector: Vector3) => void;
  7500. /**
  7501. * Lambda to Update vec4 of float from a Vector in a uniform buffer.
  7502. * This is dynamic to allow compat with webgl 1 and 2.
  7503. * You will need to pass the name of the uniform as well as the value.
  7504. */
  7505. updateVector4: (name: string, vector: Vector4) => void;
  7506. /**
  7507. * Lambda to Update vec3 of float from a Color in a uniform buffer.
  7508. * This is dynamic to allow compat with webgl 1 and 2.
  7509. * You will need to pass the name of the uniform as well as the value.
  7510. */
  7511. updateColor3: (name: string, color: Color3, suffix?: string) => void;
  7512. /**
  7513. * Lambda to Update vec4 of float from a Color in a uniform buffer.
  7514. * This is dynamic to allow compat with webgl 1 and 2.
  7515. * You will need to pass the name of the uniform as well as the value.
  7516. */
  7517. updateColor4: (name: string, color: Color3, alpha: number, suffix?: string) => void;
  7518. /**
  7519. * Instantiates a new Uniform buffer objects.
  7520. *
  7521. * Handles blocks of uniform on the GPU.
  7522. *
  7523. * If WebGL 2 is not available, this class falls back on traditionnal setUniformXXX calls.
  7524. *
  7525. * For more information, please refer to :
  7526. * @see https://www.khronos.org/opengl/wiki/Uniform_Buffer_Object
  7527. * @param engine Define the engine the buffer is associated with
  7528. * @param data Define the data contained in the buffer
  7529. * @param dynamic Define if the buffer is updatable
  7530. */
  7531. constructor(engine: Engine, data?: number[], dynamic?: boolean);
  7532. /**
  7533. * Indicates if the buffer is using the WebGL2 UBO implementation,
  7534. * or just falling back on setUniformXXX calls.
  7535. */
  7536. get useUbo(): boolean;
  7537. /**
  7538. * Indicates if the WebGL underlying uniform buffer is in sync
  7539. * with the javascript cache data.
  7540. */
  7541. get isSync(): boolean;
  7542. /**
  7543. * Indicates if the WebGL underlying uniform buffer is dynamic.
  7544. * Also, a dynamic UniformBuffer will disable cache verification and always
  7545. * update the underlying WebGL uniform buffer to the GPU.
  7546. * @returns if Dynamic, otherwise false
  7547. */
  7548. isDynamic(): boolean;
  7549. /**
  7550. * The data cache on JS side.
  7551. * @returns the underlying data as a float array
  7552. */
  7553. getData(): Float32Array;
  7554. /**
  7555. * The underlying WebGL Uniform buffer.
  7556. * @returns the webgl buffer
  7557. */
  7558. getBuffer(): Nullable<DataBuffer>;
  7559. /**
  7560. * std140 layout specifies how to align data within an UBO structure.
  7561. * See https://khronos.org/registry/OpenGL/specs/gl/glspec45.core.pdf#page=159
  7562. * for specs.
  7563. */
  7564. private _fillAlignment;
  7565. /**
  7566. * Adds an uniform in the buffer.
  7567. * Warning : the subsequents calls of this function must be in the same order as declared in the shader
  7568. * for the layout to be correct !
  7569. * @param name Name of the uniform, as used in the uniform block in the shader.
  7570. * @param size Data size, or data directly.
  7571. */
  7572. addUniform(name: string, size: number | number[]): void;
  7573. /**
  7574. * Adds a Matrix 4x4 to the uniform buffer.
  7575. * @param name Name of the uniform, as used in the uniform block in the shader.
  7576. * @param mat A 4x4 matrix.
  7577. */
  7578. addMatrix(name: string, mat: Matrix): void;
  7579. /**
  7580. * Adds a vec2 to the uniform buffer.
  7581. * @param name Name of the uniform, as used in the uniform block in the shader.
  7582. * @param x Define the x component value of the vec2
  7583. * @param y Define the y component value of the vec2
  7584. */
  7585. addFloat2(name: string, x: number, y: number): void;
  7586. /**
  7587. * Adds a vec3 to the uniform buffer.
  7588. * @param name Name of the uniform, as used in the uniform block in the shader.
  7589. * @param x Define the x component value of the vec3
  7590. * @param y Define the y component value of the vec3
  7591. * @param z Define the z component value of the vec3
  7592. */
  7593. addFloat3(name: string, x: number, y: number, z: number): void;
  7594. /**
  7595. * Adds a vec3 to the uniform buffer.
  7596. * @param name Name of the uniform, as used in the uniform block in the shader.
  7597. * @param color Define the vec3 from a Color
  7598. */
  7599. addColor3(name: string, color: Color3): void;
  7600. /**
  7601. * Adds a vec4 to the uniform buffer.
  7602. * @param name Name of the uniform, as used in the uniform block in the shader.
  7603. * @param color Define the rgb components from a Color
  7604. * @param alpha Define the a component of the vec4
  7605. */
  7606. addColor4(name: string, color: Color3, alpha: number): void;
  7607. /**
  7608. * Adds a vec3 to the uniform buffer.
  7609. * @param name Name of the uniform, as used in the uniform block in the shader.
  7610. * @param vector Define the vec3 components from a Vector
  7611. */
  7612. addVector3(name: string, vector: Vector3): void;
  7613. /**
  7614. * Adds a Matrix 3x3 to the uniform buffer.
  7615. * @param name Name of the uniform, as used in the uniform block in the shader.
  7616. */
  7617. addMatrix3x3(name: string): void;
  7618. /**
  7619. * Adds a Matrix 2x2 to the uniform buffer.
  7620. * @param name Name of the uniform, as used in the uniform block in the shader.
  7621. */
  7622. addMatrix2x2(name: string): void;
  7623. /**
  7624. * Effectively creates the WebGL Uniform Buffer, once layout is completed with `addUniform`.
  7625. */
  7626. create(): void;
  7627. /** @hidden */
  7628. _rebuild(): void;
  7629. /**
  7630. * Updates the WebGL Uniform Buffer on the GPU.
  7631. * If the `dynamic` flag is set to true, no cache comparison is done.
  7632. * Otherwise, the buffer will be updated only if the cache differs.
  7633. */
  7634. update(): void;
  7635. /**
  7636. * Updates the value of an uniform. The `update` method must be called afterwards to make it effective in the GPU.
  7637. * @param uniformName Define the name of the uniform, as used in the uniform block in the shader.
  7638. * @param data Define the flattened data
  7639. * @param size Define the size of the data.
  7640. */
  7641. updateUniform(uniformName: string, data: FloatArray, size: number): void;
  7642. private _valueCache;
  7643. private _cacheMatrix;
  7644. private _updateMatrix3x3ForUniform;
  7645. private _updateMatrix3x3ForEffect;
  7646. private _updateMatrix2x2ForEffect;
  7647. private _updateMatrix2x2ForUniform;
  7648. private _updateFloatForEffect;
  7649. private _updateFloatForUniform;
  7650. private _updateFloat2ForEffect;
  7651. private _updateFloat2ForUniform;
  7652. private _updateFloat3ForEffect;
  7653. private _updateFloat3ForUniform;
  7654. private _updateFloat4ForEffect;
  7655. private _updateFloat4ForUniform;
  7656. private _updateMatrixForEffect;
  7657. private _updateMatrixForUniform;
  7658. private _updateVector3ForEffect;
  7659. private _updateVector3ForUniform;
  7660. private _updateVector4ForEffect;
  7661. private _updateVector4ForUniform;
  7662. private _updateColor3ForEffect;
  7663. private _updateColor3ForUniform;
  7664. private _updateColor4ForEffect;
  7665. private _updateColor4ForUniform;
  7666. /**
  7667. * Sets a sampler uniform on the effect.
  7668. * @param name Define the name of the sampler.
  7669. * @param texture Define the texture to set in the sampler
  7670. */
  7671. setTexture(name: string, texture: Nullable<BaseTexture>): void;
  7672. /**
  7673. * Directly updates the value of the uniform in the cache AND on the GPU.
  7674. * @param uniformName Define the name of the uniform, as used in the uniform block in the shader.
  7675. * @param data Define the flattened data
  7676. */
  7677. updateUniformDirectly(uniformName: string, data: FloatArray): void;
  7678. /**
  7679. * Binds this uniform buffer to an effect.
  7680. * @param effect Define the effect to bind the buffer to
  7681. * @param name Name of the uniform block in the shader.
  7682. */
  7683. bindToEffect(effect: Effect, name: string): void;
  7684. /**
  7685. * Disposes the uniform buffer.
  7686. */
  7687. dispose(): void;
  7688. }
  7689. }
  7690. declare module "babylonjs/Misc/iInspectable" {
  7691. /**
  7692. * Enum that determines the text-wrapping mode to use.
  7693. */
  7694. export enum InspectableType {
  7695. /**
  7696. * Checkbox for booleans
  7697. */
  7698. Checkbox = 0,
  7699. /**
  7700. * Sliders for numbers
  7701. */
  7702. Slider = 1,
  7703. /**
  7704. * Vector3
  7705. */
  7706. Vector3 = 2,
  7707. /**
  7708. * Quaternions
  7709. */
  7710. Quaternion = 3,
  7711. /**
  7712. * Color3
  7713. */
  7714. Color3 = 4,
  7715. /**
  7716. * String
  7717. */
  7718. String = 5
  7719. }
  7720. /**
  7721. * Interface used to define custom inspectable properties.
  7722. * This interface is used by the inspector to display custom property grids
  7723. * @see https://doc.babylonjs.com/how_to/debug_layer#extensibility
  7724. */
  7725. export interface IInspectable {
  7726. /**
  7727. * Gets the label to display
  7728. */
  7729. label: string;
  7730. /**
  7731. * Gets the name of the property to edit
  7732. */
  7733. propertyName: string;
  7734. /**
  7735. * Gets the type of the editor to use
  7736. */
  7737. type: InspectableType;
  7738. /**
  7739. * Gets the minimum value of the property when using in "slider" mode
  7740. */
  7741. min?: number;
  7742. /**
  7743. * Gets the maximum value of the property when using in "slider" mode
  7744. */
  7745. max?: number;
  7746. /**
  7747. * Gets the setp to use when using in "slider" mode
  7748. */
  7749. step?: number;
  7750. }
  7751. }
  7752. declare module "babylonjs/Misc/timingTools" {
  7753. /**
  7754. * Class used to provide helper for timing
  7755. */
  7756. export class TimingTools {
  7757. /**
  7758. * Polyfill for setImmediate
  7759. * @param action defines the action to execute after the current execution block
  7760. */
  7761. static SetImmediate(action: () => void): void;
  7762. }
  7763. }
  7764. declare module "babylonjs/Misc/instantiationTools" {
  7765. /**
  7766. * Class used to enable instatition of objects by class name
  7767. */
  7768. export class InstantiationTools {
  7769. /**
  7770. * Use this object to register external classes like custom textures or material
  7771. * to allow the laoders to instantiate them
  7772. */
  7773. static RegisteredExternalClasses: {
  7774. [key: string]: Object;
  7775. };
  7776. /**
  7777. * Tries to instantiate a new object from a given class name
  7778. * @param className defines the class name to instantiate
  7779. * @returns the new object or null if the system was not able to do the instantiation
  7780. */
  7781. static Instantiate(className: string): any;
  7782. }
  7783. }
  7784. declare module "babylonjs/Engines/depthTextureCreationOptions" {
  7785. /**
  7786. * Define options used to create a depth texture
  7787. */
  7788. export class DepthTextureCreationOptions {
  7789. /** Specifies whether or not a stencil should be allocated in the texture */
  7790. generateStencil?: boolean;
  7791. /** Specifies whether or not bilinear filtering is enable on the texture */
  7792. bilinearFiltering?: boolean;
  7793. /** Specifies the comparison function to set on the texture. If 0 or undefined, the texture is not in comparison mode */
  7794. comparisonFunction?: number;
  7795. /** Specifies if the created texture is a cube texture */
  7796. isCube?: boolean;
  7797. }
  7798. }
  7799. declare module "babylonjs/Engines/Extensions/engine.cubeTexture" {
  7800. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  7801. import { Nullable } from "babylonjs/types";
  7802. import { Scene } from "babylonjs/scene";
  7803. import { DepthTextureCreationOptions } from "babylonjs/Engines/depthTextureCreationOptions";
  7804. module "babylonjs/Engines/thinEngine" {
  7805. interface ThinEngine {
  7806. /**
  7807. * Creates a depth stencil cube texture.
  7808. * This is only available in WebGL 2.
  7809. * @param size The size of face edge in the cube texture.
  7810. * @param options The options defining the cube texture.
  7811. * @returns The cube texture
  7812. */
  7813. _createDepthStencilCubeTexture(size: number, options: DepthTextureCreationOptions): InternalTexture;
  7814. /**
  7815. * Creates a cube texture
  7816. * @param rootUrl defines the url where the files to load is located
  7817. * @param scene defines the current scene
  7818. * @param files defines the list of files to load (1 per face)
  7819. * @param noMipmap defines a boolean indicating that no mipmaps shall be generated (false by default)
  7820. * @param onLoad defines an optional callback raised when the texture is loaded
  7821. * @param onError defines an optional callback raised if there is an issue to load the texture
  7822. * @param format defines the format of the data
  7823. * @param forcedExtension defines the extension to use to pick the right loader
  7824. * @param createPolynomials if a polynomial sphere should be created for the cube texture
  7825. * @param lodScale defines the scale applied to environment texture. This manages the range of LOD level used for IBL according to the roughness
  7826. * @param lodOffset defines the offset applied to environment texture. This manages first LOD level used for IBL according to the roughness
  7827. * @param fallback defines texture to use while falling back when (compressed) texture file not found.
  7828. * @returns the cube texture as an InternalTexture
  7829. */
  7830. createCubeTexture(rootUrl: string, scene: Nullable<Scene>, files: Nullable<string[]>, noMipmap: boolean | undefined, onLoad: Nullable<(data?: any) => void>, onError: Nullable<(message?: string, exception?: any) => void>, format: number | undefined, forcedExtension: any, createPolynomials: boolean, lodScale: number, lodOffset: number, fallback: Nullable<InternalTexture>): InternalTexture;
  7831. /**
  7832. * Creates a cube texture
  7833. * @param rootUrl defines the url where the files to load is located
  7834. * @param scene defines the current scene
  7835. * @param files defines the list of files to load (1 per face)
  7836. * @param noMipmap defines a boolean indicating that no mipmaps shall be generated (false by default)
  7837. * @param onLoad defines an optional callback raised when the texture is loaded
  7838. * @param onError defines an optional callback raised if there is an issue to load the texture
  7839. * @param format defines the format of the data
  7840. * @param forcedExtension defines the extension to use to pick the right loader
  7841. * @returns the cube texture as an InternalTexture
  7842. */
  7843. createCubeTexture(rootUrl: string, scene: Nullable<Scene>, files: Nullable<string[]>, noMipmap: boolean, onLoad: Nullable<(data?: any) => void>, onError: Nullable<(message?: string, exception?: any) => void>, format: number | undefined, forcedExtension: any): InternalTexture;
  7844. /**
  7845. * Creates a cube texture
  7846. * @param rootUrl defines the url where the files to load is located
  7847. * @param scene defines the current scene
  7848. * @param files defines the list of files to load (1 per face)
  7849. * @param noMipmap defines a boolean indicating that no mipmaps shall be generated (false by default)
  7850. * @param onLoad defines an optional callback raised when the texture is loaded
  7851. * @param onError defines an optional callback raised if there is an issue to load the texture
  7852. * @param format defines the format of the data
  7853. * @param forcedExtension defines the extension to use to pick the right loader
  7854. * @param createPolynomials if a polynomial sphere should be created for the cube texture
  7855. * @param lodScale defines the scale applied to environment texture. This manages the range of LOD level used for IBL according to the roughness
  7856. * @param lodOffset defines the offset applied to environment texture. This manages first LOD level used for IBL according to the roughness
  7857. * @returns the cube texture as an InternalTexture
  7858. */
  7859. createCubeTexture(rootUrl: string, scene: Nullable<Scene>, files: Nullable<string[]>, noMipmap: boolean, onLoad: Nullable<(data?: any) => void>, onError: Nullable<(message?: string, exception?: any) => void>, format: number | undefined, forcedExtension: any, createPolynomials: boolean, lodScale: number, lodOffset: number): InternalTexture;
  7860. /** @hidden */
  7861. _partialLoadFile(url: string, index: number, loadedFiles: ArrayBuffer[], onfinish: (files: ArrayBuffer[]) => void, onErrorCallBack: Nullable<(message?: string, exception?: any) => void>): void;
  7862. /** @hidden */
  7863. _cascadeLoadFiles(scene: Nullable<Scene>, onfinish: (images: ArrayBuffer[]) => void, files: string[], onError: Nullable<(message?: string, exception?: any) => void>): void;
  7864. /** @hidden */
  7865. _cascadeLoadImgs(scene: Nullable<Scene>, onfinish: (images: HTMLImageElement[]) => void, files: string[], onError: Nullable<(message?: string, exception?: any) => void>, mimeType?: string): void;
  7866. /** @hidden */
  7867. _partialLoadImg(url: string, index: number, loadedImages: HTMLImageElement[], scene: Nullable<Scene>, onfinish: (images: HTMLImageElement[]) => void, onErrorCallBack: Nullable<(message?: string, exception?: any) => void>, mimeType?: string): void;
  7868. /**
  7869. * @hidden
  7870. */
  7871. _setCubeMapTextureParams(loadMipmap: boolean): void;
  7872. }
  7873. }
  7874. }
  7875. declare module "babylonjs/Materials/Textures/cubeTexture" {
  7876. import { Nullable } from "babylonjs/types";
  7877. import { Scene } from "babylonjs/scene";
  7878. import { Matrix, Vector3 } from "babylonjs/Maths/math.vector";
  7879. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  7880. import { ThinEngine } from "babylonjs/Engines/thinEngine";
  7881. import "babylonjs/Engines/Extensions/engine.cubeTexture";
  7882. import { Observable } from "babylonjs/Misc/observable";
  7883. /**
  7884. * Class for creating a cube texture
  7885. */
  7886. export class CubeTexture extends BaseTexture {
  7887. private _delayedOnLoad;
  7888. /**
  7889. * Observable triggered once the texture has been loaded.
  7890. */
  7891. onLoadObservable: Observable<CubeTexture>;
  7892. /**
  7893. * The url of the texture
  7894. */
  7895. url: string;
  7896. /**
  7897. * Gets or sets the center of the bounding box associated with the cube texture.
  7898. * It must define where the camera used to render the texture was set
  7899. * @see https://doc.babylonjs.com/how_to/reflect#using-local-cubemap-mode
  7900. */
  7901. boundingBoxPosition: Vector3;
  7902. private _boundingBoxSize;
  7903. /**
  7904. * Gets or sets the size of the bounding box associated with the cube texture
  7905. * When defined, the cubemap will switch to local mode
  7906. * @see https://community.arm.com/graphics/b/blog/posts/reflections-based-on-local-cubemaps-in-unity
  7907. * @example https://www.babylonjs-playground.com/#RNASML
  7908. */
  7909. set boundingBoxSize(value: Vector3);
  7910. /**
  7911. * Returns the bounding box size
  7912. * @see https://doc.babylonjs.com/how_to/reflect#using-local-cubemap-mode
  7913. */
  7914. get boundingBoxSize(): Vector3;
  7915. protected _rotationY: number;
  7916. /**
  7917. * Sets texture matrix rotation angle around Y axis in radians.
  7918. */
  7919. set rotationY(value: number);
  7920. /**
  7921. * Gets texture matrix rotation angle around Y axis radians.
  7922. */
  7923. get rotationY(): number;
  7924. /**
  7925. * Are mip maps generated for this texture or not.
  7926. */
  7927. get noMipmap(): boolean;
  7928. private _noMipmap;
  7929. private _files;
  7930. protected _forcedExtension: Nullable<string>;
  7931. private _extensions;
  7932. private _textureMatrix;
  7933. private _format;
  7934. private _createPolynomials;
  7935. /**
  7936. * Creates a cube texture from an array of image urls
  7937. * @param files defines an array of image urls
  7938. * @param scene defines the hosting scene
  7939. * @param noMipmap specifies if mip maps are not used
  7940. * @returns a cube texture
  7941. */
  7942. static CreateFromImages(files: string[], scene: Scene, noMipmap?: boolean): CubeTexture;
  7943. /**
  7944. * Creates and return a texture created from prefilterd data by tools like IBL Baker or Lys.
  7945. * @param url defines the url of the prefiltered texture
  7946. * @param scene defines the scene the texture is attached to
  7947. * @param forcedExtension defines the extension of the file if different from the url
  7948. * @param createPolynomials defines whether or not to create polynomial harmonics from the texture data if necessary
  7949. * @return the prefiltered texture
  7950. */
  7951. static CreateFromPrefilteredData(url: string, scene: Scene, forcedExtension?: any, createPolynomials?: boolean): CubeTexture;
  7952. /**
  7953. * Creates a cube texture to use with reflection for instance. It can be based upon dds or six images as well
  7954. * as prefiltered data.
  7955. * @param rootUrl defines the url of the texture or the root name of the six images
  7956. * @param null defines the scene or engine the texture is attached to
  7957. * @param extensions defines the suffixes add to the picture name in case six images are in use like _px.jpg...
  7958. * @param noMipmap defines if mipmaps should be created or not
  7959. * @param files defines the six files to load for the different faces in that order: px, py, pz, nx, ny, nz
  7960. * @param onLoad defines a callback triggered at the end of the file load if no errors occured
  7961. * @param onError defines a callback triggered in case of error during load
  7962. * @param format defines the internal format to use for the texture once loaded
  7963. * @param prefiltered defines whether or not the texture is created from prefiltered data
  7964. * @param forcedExtension defines the extensions to use (force a special type of file to load) in case it is different from the file name
  7965. * @param createPolynomials defines whether or not to create polynomial harmonics from the texture data if necessary
  7966. * @param lodScale defines the scale applied to environment texture. This manages the range of LOD level used for IBL according to the roughness
  7967. * @param lodOffset defines the offset applied to environment texture. This manages first LOD level used for IBL according to the roughness
  7968. * @return the cube texture
  7969. */
  7970. constructor(rootUrl: string, sceneOrEngine: Scene | ThinEngine, extensions?: Nullable<string[]>, noMipmap?: boolean, files?: Nullable<string[]>, onLoad?: Nullable<() => void>, onError?: Nullable<(message?: string, exception?: any) => void>, format?: number, prefiltered?: boolean, forcedExtension?: any, createPolynomials?: boolean, lodScale?: number, lodOffset?: number);
  7971. /**
  7972. * Get the current class name of the texture useful for serialization or dynamic coding.
  7973. * @returns "CubeTexture"
  7974. */
  7975. getClassName(): string;
  7976. /**
  7977. * Update the url (and optional buffer) of this texture if url was null during construction.
  7978. * @param url the url of the texture
  7979. * @param forcedExtension defines the extension to use
  7980. * @param onLoad callback called when the texture is loaded (defaults to null)
  7981. * @param prefiltered Defines whether the updated texture is prefiltered or not
  7982. */
  7983. updateURL(url: string, forcedExtension?: string, onLoad?: () => void, prefiltered?: boolean): void;
  7984. /**
  7985. * Delays loading of the cube texture
  7986. * @param forcedExtension defines the extension to use
  7987. */
  7988. delayLoad(forcedExtension?: string): void;
  7989. /**
  7990. * Returns the reflection texture matrix
  7991. * @returns the reflection texture matrix
  7992. */
  7993. getReflectionTextureMatrix(): Matrix;
  7994. /**
  7995. * Sets the reflection texture matrix
  7996. * @param value Reflection texture matrix
  7997. */
  7998. setReflectionTextureMatrix(value: Matrix): void;
  7999. /**
  8000. * Parses text to create a cube texture
  8001. * @param parsedTexture define the serialized text to read from
  8002. * @param scene defines the hosting scene
  8003. * @param rootUrl defines the root url of the cube texture
  8004. * @returns a cube texture
  8005. */
  8006. static Parse(parsedTexture: any, scene: Scene, rootUrl: string): CubeTexture;
  8007. /**
  8008. * Makes a clone, or deep copy, of the cube texture
  8009. * @returns a new cube texture
  8010. */
  8011. clone(): CubeTexture;
  8012. }
  8013. }
  8014. declare module "babylonjs/Materials/materialDefines" {
  8015. /**
  8016. * Manages the defines for the Material
  8017. */
  8018. export class MaterialDefines {
  8019. /** @hidden */
  8020. protected _keys: string[];
  8021. private _isDirty;
  8022. /** @hidden */
  8023. _renderId: number;
  8024. /** @hidden */
  8025. _areLightsDirty: boolean;
  8026. /** @hidden */
  8027. _areLightsDisposed: boolean;
  8028. /** @hidden */
  8029. _areAttributesDirty: boolean;
  8030. /** @hidden */
  8031. _areTexturesDirty: boolean;
  8032. /** @hidden */
  8033. _areFresnelDirty: boolean;
  8034. /** @hidden */
  8035. _areMiscDirty: boolean;
  8036. /** @hidden */
  8037. _areImageProcessingDirty: boolean;
  8038. /** @hidden */
  8039. _normals: boolean;
  8040. /** @hidden */
  8041. _uvs: boolean;
  8042. /** @hidden */
  8043. _needNormals: boolean;
  8044. /** @hidden */
  8045. _needUVs: boolean;
  8046. [id: string]: any;
  8047. /**
  8048. * Specifies if the material needs to be re-calculated
  8049. */
  8050. get isDirty(): boolean;
  8051. /**
  8052. * Marks the material to indicate that it has been re-calculated
  8053. */
  8054. markAsProcessed(): void;
  8055. /**
  8056. * Marks the material to indicate that it needs to be re-calculated
  8057. */
  8058. markAsUnprocessed(): void;
  8059. /**
  8060. * Marks the material to indicate all of its defines need to be re-calculated
  8061. */
  8062. markAllAsDirty(): void;
  8063. /**
  8064. * Marks the material to indicate that image processing needs to be re-calculated
  8065. */
  8066. markAsImageProcessingDirty(): void;
  8067. /**
  8068. * Marks the material to indicate the lights need to be re-calculated
  8069. * @param disposed Defines whether the light is dirty due to dispose or not
  8070. */
  8071. markAsLightDirty(disposed?: boolean): void;
  8072. /**
  8073. * Marks the attribute state as changed
  8074. */
  8075. markAsAttributesDirty(): void;
  8076. /**
  8077. * Marks the texture state as changed
  8078. */
  8079. markAsTexturesDirty(): void;
  8080. /**
  8081. * Marks the fresnel state as changed
  8082. */
  8083. markAsFresnelDirty(): void;
  8084. /**
  8085. * Marks the misc state as changed
  8086. */
  8087. markAsMiscDirty(): void;
  8088. /**
  8089. * Rebuilds the material defines
  8090. */
  8091. rebuild(): void;
  8092. /**
  8093. * Specifies if two material defines are equal
  8094. * @param other - A material define instance to compare to
  8095. * @returns - Boolean indicating if the material defines are equal (true) or not (false)
  8096. */
  8097. isEqual(other: MaterialDefines): boolean;
  8098. /**
  8099. * Clones this instance's defines to another instance
  8100. * @param other - material defines to clone values to
  8101. */
  8102. cloneTo(other: MaterialDefines): void;
  8103. /**
  8104. * Resets the material define values
  8105. */
  8106. reset(): void;
  8107. /**
  8108. * Converts the material define values to a string
  8109. * @returns - String of material define information
  8110. */
  8111. toString(): string;
  8112. }
  8113. }
  8114. declare module "babylonjs/Materials/colorCurves" {
  8115. import { Effect } from "babylonjs/Materials/effect";
  8116. /**
  8117. * The color grading curves provide additional color adjustmnent that is applied after any color grading transform (3D LUT).
  8118. * They allow basic adjustment of saturation and small exposure adjustments, along with color filter tinting to provide white balance adjustment or more stylistic effects.
  8119. * These are similar to controls found in many professional imaging or colorist software. The global controls are applied to the entire image. For advanced tuning, extra controls are provided to adjust the shadow, midtone and highlight areas of the image;
  8120. * corresponding to low luminance, medium luminance, and high luminance areas respectively.
  8121. */
  8122. export class ColorCurves {
  8123. private _dirty;
  8124. private _tempColor;
  8125. private _globalCurve;
  8126. private _highlightsCurve;
  8127. private _midtonesCurve;
  8128. private _shadowsCurve;
  8129. private _positiveCurve;
  8130. private _negativeCurve;
  8131. private _globalHue;
  8132. private _globalDensity;
  8133. private _globalSaturation;
  8134. private _globalExposure;
  8135. /**
  8136. * Gets the global Hue value.
  8137. * The hue value is a standard HSB hue in the range [0,360] where 0=red, 120=green and 240=blue. The default value is 30 degrees (orange).
  8138. */
  8139. get globalHue(): number;
  8140. /**
  8141. * Sets the global Hue value.
  8142. * The hue value is a standard HSB hue in the range [0,360] where 0=red, 120=green and 240=blue. The default value is 30 degrees (orange).
  8143. */
  8144. set globalHue(value: number);
  8145. /**
  8146. * Gets the global Density value.
  8147. * The density value is in range [-100,+100] where 0 means the color filter has no effect and +100 means the color filter has maximum effect.
  8148. * Values less than zero provide a filter of opposite hue.
  8149. */
  8150. get globalDensity(): number;
  8151. /**
  8152. * Sets the global Density value.
  8153. * The density value is in range [-100,+100] where 0 means the color filter has no effect and +100 means the color filter has maximum effect.
  8154. * Values less than zero provide a filter of opposite hue.
  8155. */
  8156. set globalDensity(value: number);
  8157. /**
  8158. * Gets the global Saturation value.
  8159. * This is an adjustment value in the range [-100,+100], where the default value of 0.0 makes no adjustment, positive values increase saturation and negative values decrease saturation.
  8160. */
  8161. get globalSaturation(): number;
  8162. /**
  8163. * Sets the global Saturation value.
  8164. * This is an adjustment value in the range [-100,+100], where the default value of 0.0 makes no adjustment, positive values increase saturation and negative values decrease saturation.
  8165. */
  8166. set globalSaturation(value: number);
  8167. /**
  8168. * Gets the global Exposure value.
  8169. * This is an adjustment value in the range [-100,+100], where the default value of 0.0 makes no adjustment, positive values increase exposure and negative values decrease exposure.
  8170. */
  8171. get globalExposure(): number;
  8172. /**
  8173. * Sets the global Exposure value.
  8174. * This is an adjustment value in the range [-100,+100], where the default value of 0.0 makes no adjustment, positive values increase exposure and negative values decrease exposure.
  8175. */
  8176. set globalExposure(value: number);
  8177. private _highlightsHue;
  8178. private _highlightsDensity;
  8179. private _highlightsSaturation;
  8180. private _highlightsExposure;
  8181. /**
  8182. * Gets the highlights Hue value.
  8183. * The hue value is a standard HSB hue in the range [0,360] where 0=red, 120=green and 240=blue. The default value is 30 degrees (orange).
  8184. */
  8185. get highlightsHue(): number;
  8186. /**
  8187. * Sets the highlights Hue value.
  8188. * The hue value is a standard HSB hue in the range [0,360] where 0=red, 120=green and 240=blue. The default value is 30 degrees (orange).
  8189. */
  8190. set highlightsHue(value: number);
  8191. /**
  8192. * Gets the highlights Density value.
  8193. * The density value is in range [-100,+100] where 0 means the color filter has no effect and +100 means the color filter has maximum effect.
  8194. * Values less than zero provide a filter of opposite hue.
  8195. */
  8196. get highlightsDensity(): number;
  8197. /**
  8198. * Sets the highlights Density value.
  8199. * The density value is in range [-100,+100] where 0 means the color filter has no effect and +100 means the color filter has maximum effect.
  8200. * Values less than zero provide a filter of opposite hue.
  8201. */
  8202. set highlightsDensity(value: number);
  8203. /**
  8204. * Gets the highlights Saturation value.
  8205. * This is an adjustment value in the range [-100,+100], where the default value of 0.0 makes no adjustment, positive values increase saturation and negative values decrease saturation.
  8206. */
  8207. get highlightsSaturation(): number;
  8208. /**
  8209. * Sets the highlights Saturation value.
  8210. * This is an adjustment value in the range [-100,+100], where the default value of 0.0 makes no adjustment, positive values increase saturation and negative values decrease saturation.
  8211. */
  8212. set highlightsSaturation(value: number);
  8213. /**
  8214. * Gets the highlights Exposure value.
  8215. * This is an adjustment value in the range [-100,+100], where the default value of 0.0 makes no adjustment, positive values increase exposure and negative values decrease exposure.
  8216. */
  8217. get highlightsExposure(): number;
  8218. /**
  8219. * Sets the highlights Exposure value.
  8220. * This is an adjustment value in the range [-100,+100], where the default value of 0.0 makes no adjustment, positive values increase exposure and negative values decrease exposure.
  8221. */
  8222. set highlightsExposure(value: number);
  8223. private _midtonesHue;
  8224. private _midtonesDensity;
  8225. private _midtonesSaturation;
  8226. private _midtonesExposure;
  8227. /**
  8228. * Gets the midtones Hue value.
  8229. * The hue value is a standard HSB hue in the range [0,360] where 0=red, 120=green and 240=blue. The default value is 30 degrees (orange).
  8230. */
  8231. get midtonesHue(): number;
  8232. /**
  8233. * Sets the midtones Hue value.
  8234. * The hue value is a standard HSB hue in the range [0,360] where 0=red, 120=green and 240=blue. The default value is 30 degrees (orange).
  8235. */
  8236. set midtonesHue(value: number);
  8237. /**
  8238. * Gets the midtones Density value.
  8239. * The density value is in range [-100,+100] where 0 means the color filter has no effect and +100 means the color filter has maximum effect.
  8240. * Values less than zero provide a filter of opposite hue.
  8241. */
  8242. get midtonesDensity(): number;
  8243. /**
  8244. * Sets the midtones Density value.
  8245. * The density value is in range [-100,+100] where 0 means the color filter has no effect and +100 means the color filter has maximum effect.
  8246. * Values less than zero provide a filter of opposite hue.
  8247. */
  8248. set midtonesDensity(value: number);
  8249. /**
  8250. * Gets the midtones Saturation value.
  8251. * This is an adjustment value in the range [-100,+100], where the default value of 0.0 makes no adjustment, positive values increase saturation and negative values decrease saturation.
  8252. */
  8253. get midtonesSaturation(): number;
  8254. /**
  8255. * Sets the midtones Saturation value.
  8256. * This is an adjustment value in the range [-100,+100], where the default value of 0.0 makes no adjustment, positive values increase saturation and negative values decrease saturation.
  8257. */
  8258. set midtonesSaturation(value: number);
  8259. /**
  8260. * Gets the midtones Exposure value.
  8261. * This is an adjustment value in the range [-100,+100], where the default value of 0.0 makes no adjustment, positive values increase exposure and negative values decrease exposure.
  8262. */
  8263. get midtonesExposure(): number;
  8264. /**
  8265. * Sets the midtones Exposure value.
  8266. * This is an adjustment value in the range [-100,+100], where the default value of 0.0 makes no adjustment, positive values increase exposure and negative values decrease exposure.
  8267. */
  8268. set midtonesExposure(value: number);
  8269. private _shadowsHue;
  8270. private _shadowsDensity;
  8271. private _shadowsSaturation;
  8272. private _shadowsExposure;
  8273. /**
  8274. * Gets the shadows Hue value.
  8275. * The hue value is a standard HSB hue in the range [0,360] where 0=red, 120=green and 240=blue. The default value is 30 degrees (orange).
  8276. */
  8277. get shadowsHue(): number;
  8278. /**
  8279. * Sets the shadows Hue value.
  8280. * The hue value is a standard HSB hue in the range [0,360] where 0=red, 120=green and 240=blue. The default value is 30 degrees (orange).
  8281. */
  8282. set shadowsHue(value: number);
  8283. /**
  8284. * Gets the shadows Density value.
  8285. * The density value is in range [-100,+100] where 0 means the color filter has no effect and +100 means the color filter has maximum effect.
  8286. * Values less than zero provide a filter of opposite hue.
  8287. */
  8288. get shadowsDensity(): number;
  8289. /**
  8290. * Sets the shadows Density value.
  8291. * The density value is in range [-100,+100] where 0 means the color filter has no effect and +100 means the color filter has maximum effect.
  8292. * Values less than zero provide a filter of opposite hue.
  8293. */
  8294. set shadowsDensity(value: number);
  8295. /**
  8296. * Gets the shadows Saturation value.
  8297. * This is an adjustment value in the range [-100,+100], where the default value of 0.0 makes no adjustment, positive values increase saturation and negative values decrease saturation.
  8298. */
  8299. get shadowsSaturation(): number;
  8300. /**
  8301. * Sets the shadows Saturation value.
  8302. * This is an adjustment value in the range [-100,+100], where the default value of 0.0 makes no adjustment, positive values increase saturation and negative values decrease saturation.
  8303. */
  8304. set shadowsSaturation(value: number);
  8305. /**
  8306. * Gets the shadows Exposure value.
  8307. * This is an adjustment value in the range [-100,+100], where the default value of 0.0 makes no adjustment, positive values increase exposure and negative values decrease exposure.
  8308. */
  8309. get shadowsExposure(): number;
  8310. /**
  8311. * Sets the shadows Exposure value.
  8312. * This is an adjustment value in the range [-100,+100], where the default value of 0.0 makes no adjustment, positive values increase exposure and negative values decrease exposure.
  8313. */
  8314. set shadowsExposure(value: number);
  8315. /**
  8316. * Returns the class name
  8317. * @returns The class name
  8318. */
  8319. getClassName(): string;
  8320. /**
  8321. * Binds the color curves to the shader.
  8322. * @param colorCurves The color curve to bind
  8323. * @param effect The effect to bind to
  8324. * @param positiveUniform The positive uniform shader parameter
  8325. * @param neutralUniform The neutral uniform shader parameter
  8326. * @param negativeUniform The negative uniform shader parameter
  8327. */
  8328. static Bind(colorCurves: ColorCurves, effect: Effect, positiveUniform?: string, neutralUniform?: string, negativeUniform?: string): void;
  8329. /**
  8330. * Prepare the list of uniforms associated with the ColorCurves effects.
  8331. * @param uniformsList The list of uniforms used in the effect
  8332. */
  8333. static PrepareUniforms(uniformsList: string[]): void;
  8334. /**
  8335. * Returns color grading data based on a hue, density, saturation and exposure value.
  8336. * @param filterHue The hue of the color filter.
  8337. * @param filterDensity The density of the color filter.
  8338. * @param saturation The saturation.
  8339. * @param exposure The exposure.
  8340. * @param result The result data container.
  8341. */
  8342. private getColorGradingDataToRef;
  8343. /**
  8344. * Takes an input slider value and returns an adjusted value that provides extra control near the centre.
  8345. * @param value The input slider value in range [-100,100].
  8346. * @returns Adjusted value.
  8347. */
  8348. private static applyColorGradingSliderNonlinear;
  8349. /**
  8350. * Returns an RGBA Color4 based on Hue, Saturation and Brightness (also referred to as value, HSV).
  8351. * @param hue The hue (H) input.
  8352. * @param saturation The saturation (S) input.
  8353. * @param brightness The brightness (B) input.
  8354. * @result An RGBA color represented as Vector4.
  8355. */
  8356. private static fromHSBToRef;
  8357. /**
  8358. * Returns a value clamped between min and max
  8359. * @param value The value to clamp
  8360. * @param min The minimum of value
  8361. * @param max The maximum of value
  8362. * @returns The clamped value.
  8363. */
  8364. private static clamp;
  8365. /**
  8366. * Clones the current color curve instance.
  8367. * @return The cloned curves
  8368. */
  8369. clone(): ColorCurves;
  8370. /**
  8371. * Serializes the current color curve instance to a json representation.
  8372. * @return a JSON representation
  8373. */
  8374. serialize(): any;
  8375. /**
  8376. * Parses the color curve from a json representation.
  8377. * @param source the JSON source to parse
  8378. * @return The parsed curves
  8379. */
  8380. static Parse(source: any): ColorCurves;
  8381. }
  8382. }
  8383. declare module "babylonjs/Materials/imageProcessingConfiguration" {
  8384. import { Observable } from "babylonjs/Misc/observable";
  8385. import { Nullable } from "babylonjs/types";
  8386. import { Color4 } from "babylonjs/Maths/math.color";
  8387. import { MaterialDefines } from "babylonjs/Materials/materialDefines";
  8388. import { Effect } from "babylonjs/Materials/effect";
  8389. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  8390. import { ColorCurves } from "babylonjs/Materials/colorCurves";
  8391. /**
  8392. * Interface to follow in your material defines to integrate easily the
  8393. * Image proccessing functions.
  8394. * @hidden
  8395. */
  8396. export interface IImageProcessingConfigurationDefines {
  8397. IMAGEPROCESSING: boolean;
  8398. VIGNETTE: boolean;
  8399. VIGNETTEBLENDMODEMULTIPLY: boolean;
  8400. VIGNETTEBLENDMODEOPAQUE: boolean;
  8401. TONEMAPPING: boolean;
  8402. TONEMAPPING_ACES: boolean;
  8403. CONTRAST: boolean;
  8404. EXPOSURE: boolean;
  8405. COLORCURVES: boolean;
  8406. COLORGRADING: boolean;
  8407. COLORGRADING3D: boolean;
  8408. SAMPLER3DGREENDEPTH: boolean;
  8409. SAMPLER3DBGRMAP: boolean;
  8410. IMAGEPROCESSINGPOSTPROCESS: boolean;
  8411. }
  8412. /**
  8413. * @hidden
  8414. */
  8415. export class ImageProcessingConfigurationDefines extends MaterialDefines implements IImageProcessingConfigurationDefines {
  8416. IMAGEPROCESSING: boolean;
  8417. VIGNETTE: boolean;
  8418. VIGNETTEBLENDMODEMULTIPLY: boolean;
  8419. VIGNETTEBLENDMODEOPAQUE: boolean;
  8420. TONEMAPPING: boolean;
  8421. TONEMAPPING_ACES: boolean;
  8422. CONTRAST: boolean;
  8423. COLORCURVES: boolean;
  8424. COLORGRADING: boolean;
  8425. COLORGRADING3D: boolean;
  8426. SAMPLER3DGREENDEPTH: boolean;
  8427. SAMPLER3DBGRMAP: boolean;
  8428. IMAGEPROCESSINGPOSTPROCESS: boolean;
  8429. EXPOSURE: boolean;
  8430. constructor();
  8431. }
  8432. /**
  8433. * This groups together the common properties used for image processing either in direct forward pass
  8434. * or through post processing effect depending on the use of the image processing pipeline in your scene
  8435. * or not.
  8436. */
  8437. export class ImageProcessingConfiguration {
  8438. /**
  8439. * Default tone mapping applied in BabylonJS.
  8440. */
  8441. static readonly TONEMAPPING_STANDARD: number;
  8442. /**
  8443. * ACES Tone mapping (used by default in unreal and unity). This can help getting closer
  8444. * to other engines rendering to increase portability.
  8445. */
  8446. static readonly TONEMAPPING_ACES: number;
  8447. /**
  8448. * Color curves setup used in the effect if colorCurvesEnabled is set to true
  8449. */
  8450. colorCurves: Nullable<ColorCurves>;
  8451. private _colorCurvesEnabled;
  8452. /**
  8453. * Gets wether the color curves effect is enabled.
  8454. */
  8455. get colorCurvesEnabled(): boolean;
  8456. /**
  8457. * Sets wether the color curves effect is enabled.
  8458. */
  8459. set colorCurvesEnabled(value: boolean);
  8460. private _colorGradingTexture;
  8461. /**
  8462. * Color grading LUT texture used in the effect if colorGradingEnabled is set to true
  8463. */
  8464. get colorGradingTexture(): Nullable<BaseTexture>;
  8465. /**
  8466. * Color grading LUT texture used in the effect if colorGradingEnabled is set to true
  8467. */
  8468. set colorGradingTexture(value: Nullable<BaseTexture>);
  8469. private _colorGradingEnabled;
  8470. /**
  8471. * Gets wether the color grading effect is enabled.
  8472. */
  8473. get colorGradingEnabled(): boolean;
  8474. /**
  8475. * Sets wether the color grading effect is enabled.
  8476. */
  8477. set colorGradingEnabled(value: boolean);
  8478. private _colorGradingWithGreenDepth;
  8479. /**
  8480. * Gets wether the color grading effect is using a green depth for the 3d Texture.
  8481. */
  8482. get colorGradingWithGreenDepth(): boolean;
  8483. /**
  8484. * Sets wether the color grading effect is using a green depth for the 3d Texture.
  8485. */
  8486. set colorGradingWithGreenDepth(value: boolean);
  8487. private _colorGradingBGR;
  8488. /**
  8489. * Gets wether the color grading texture contains BGR values.
  8490. */
  8491. get colorGradingBGR(): boolean;
  8492. /**
  8493. * Sets wether the color grading texture contains BGR values.
  8494. */
  8495. set colorGradingBGR(value: boolean);
  8496. /** @hidden */
  8497. _exposure: number;
  8498. /**
  8499. * Gets the Exposure used in the effect.
  8500. */
  8501. get exposure(): number;
  8502. /**
  8503. * Sets the Exposure used in the effect.
  8504. */
  8505. set exposure(value: number);
  8506. private _toneMappingEnabled;
  8507. /**
  8508. * Gets wether the tone mapping effect is enabled.
  8509. */
  8510. get toneMappingEnabled(): boolean;
  8511. /**
  8512. * Sets wether the tone mapping effect is enabled.
  8513. */
  8514. set toneMappingEnabled(value: boolean);
  8515. private _toneMappingType;
  8516. /**
  8517. * Gets the type of tone mapping effect.
  8518. */
  8519. get toneMappingType(): number;
  8520. /**
  8521. * Sets the type of tone mapping effect used in BabylonJS.
  8522. */
  8523. set toneMappingType(value: number);
  8524. protected _contrast: number;
  8525. /**
  8526. * Gets the contrast used in the effect.
  8527. */
  8528. get contrast(): number;
  8529. /**
  8530. * Sets the contrast used in the effect.
  8531. */
  8532. set contrast(value: number);
  8533. /**
  8534. * Vignette stretch size.
  8535. */
  8536. vignetteStretch: number;
  8537. /**
  8538. * Vignette centre X Offset.
  8539. */
  8540. vignetteCentreX: number;
  8541. /**
  8542. * Vignette centre Y Offset.
  8543. */
  8544. vignetteCentreY: number;
  8545. /**
  8546. * Vignette weight or intensity of the vignette effect.
  8547. */
  8548. vignetteWeight: number;
  8549. /**
  8550. * Color of the vignette applied on the screen through the chosen blend mode (vignetteBlendMode)
  8551. * if vignetteEnabled is set to true.
  8552. */
  8553. vignetteColor: Color4;
  8554. /**
  8555. * Camera field of view used by the Vignette effect.
  8556. */
  8557. vignetteCameraFov: number;
  8558. private _vignetteBlendMode;
  8559. /**
  8560. * Gets the vignette blend mode allowing different kind of effect.
  8561. */
  8562. get vignetteBlendMode(): number;
  8563. /**
  8564. * Sets the vignette blend mode allowing different kind of effect.
  8565. */
  8566. set vignetteBlendMode(value: number);
  8567. private _vignetteEnabled;
  8568. /**
  8569. * Gets wether the vignette effect is enabled.
  8570. */
  8571. get vignetteEnabled(): boolean;
  8572. /**
  8573. * Sets wether the vignette effect is enabled.
  8574. */
  8575. set vignetteEnabled(value: boolean);
  8576. private _applyByPostProcess;
  8577. /**
  8578. * Gets wether the image processing is applied through a post process or not.
  8579. */
  8580. get applyByPostProcess(): boolean;
  8581. /**
  8582. * Sets wether the image processing is applied through a post process or not.
  8583. */
  8584. set applyByPostProcess(value: boolean);
  8585. private _isEnabled;
  8586. /**
  8587. * Gets wether the image processing is enabled or not.
  8588. */
  8589. get isEnabled(): boolean;
  8590. /**
  8591. * Sets wether the image processing is enabled or not.
  8592. */
  8593. set isEnabled(value: boolean);
  8594. /**
  8595. * An event triggered when the configuration changes and requires Shader to Update some parameters.
  8596. */
  8597. onUpdateParameters: Observable<ImageProcessingConfiguration>;
  8598. /**
  8599. * Method called each time the image processing information changes requires to recompile the effect.
  8600. */
  8601. protected _updateParameters(): void;
  8602. /**
  8603. * Gets the current class name.
  8604. * @return "ImageProcessingConfiguration"
  8605. */
  8606. getClassName(): string;
  8607. /**
  8608. * Prepare the list of uniforms associated with the Image Processing effects.
  8609. * @param uniforms The list of uniforms used in the effect
  8610. * @param defines the list of defines currently in use
  8611. */
  8612. static PrepareUniforms(uniforms: string[], defines: IImageProcessingConfigurationDefines): void;
  8613. /**
  8614. * Prepare the list of samplers associated with the Image Processing effects.
  8615. * @param samplersList The list of uniforms used in the effect
  8616. * @param defines the list of defines currently in use
  8617. */
  8618. static PrepareSamplers(samplersList: string[], defines: IImageProcessingConfigurationDefines): void;
  8619. /**
  8620. * Prepare the list of defines associated to the shader.
  8621. * @param defines the list of defines to complete
  8622. * @param forPostProcess Define if we are currently in post process mode or not
  8623. */
  8624. prepareDefines(defines: IImageProcessingConfigurationDefines, forPostProcess?: boolean): void;
  8625. /**
  8626. * Returns true if all the image processing information are ready.
  8627. * @returns True if ready, otherwise, false
  8628. */
  8629. isReady(): boolean;
  8630. /**
  8631. * Binds the image processing to the shader.
  8632. * @param effect The effect to bind to
  8633. * @param overrideAspectRatio Override the aspect ratio of the effect
  8634. */
  8635. bind(effect: Effect, overrideAspectRatio?: number): void;
  8636. /**
  8637. * Clones the current image processing instance.
  8638. * @return The cloned image processing
  8639. */
  8640. clone(): ImageProcessingConfiguration;
  8641. /**
  8642. * Serializes the current image processing instance to a json representation.
  8643. * @return a JSON representation
  8644. */
  8645. serialize(): any;
  8646. /**
  8647. * Parses the image processing from a json representation.
  8648. * @param source the JSON source to parse
  8649. * @return The parsed image processing
  8650. */
  8651. static Parse(source: any): ImageProcessingConfiguration;
  8652. private static _VIGNETTEMODE_MULTIPLY;
  8653. private static _VIGNETTEMODE_OPAQUE;
  8654. /**
  8655. * Used to apply the vignette as a mix with the pixel color.
  8656. */
  8657. static get VIGNETTEMODE_MULTIPLY(): number;
  8658. /**
  8659. * Used to apply the vignette as a replacement of the pixel color.
  8660. */
  8661. static get VIGNETTEMODE_OPAQUE(): number;
  8662. }
  8663. }
  8664. declare module "babylonjs/Shaders/postprocess.vertex" {
  8665. /** @hidden */
  8666. export var postprocessVertexShader: {
  8667. name: string;
  8668. shader: string;
  8669. };
  8670. }
  8671. declare module "babylonjs/Engines/Extensions/engine.renderTarget" {
  8672. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  8673. import { RenderTargetCreationOptions } from "babylonjs/Materials/Textures/renderTargetCreationOptions";
  8674. import { DepthTextureCreationOptions } from "babylonjs/Engines/depthTextureCreationOptions";
  8675. module "babylonjs/Engines/thinEngine" {
  8676. interface ThinEngine {
  8677. /**
  8678. * Creates a new render target texture
  8679. * @param size defines the size of the texture
  8680. * @param options defines the options used to create the texture
  8681. * @returns a new render target texture stored in an InternalTexture
  8682. */
  8683. createRenderTargetTexture(size: number | {
  8684. width: number;
  8685. height: number;
  8686. layers?: number;
  8687. }, options: boolean | RenderTargetCreationOptions): InternalTexture;
  8688. /**
  8689. * Creates a depth stencil texture.
  8690. * This is only available in WebGL 2 or with the depth texture extension available.
  8691. * @param size The size of face edge in the texture.
  8692. * @param options The options defining the texture.
  8693. * @returns The texture
  8694. */
  8695. createDepthStencilTexture(size: number | {
  8696. width: number;
  8697. height: number;
  8698. layers?: number;
  8699. }, options: DepthTextureCreationOptions): InternalTexture;
  8700. /** @hidden */
  8701. _createDepthStencilTexture(size: number | {
  8702. width: number;
  8703. height: number;
  8704. layers?: number;
  8705. }, options: DepthTextureCreationOptions): InternalTexture;
  8706. }
  8707. }
  8708. }
  8709. declare module "babylonjs/Materials/Node/Enums/nodeMaterialBlockConnectionPointTypes" {
  8710. /**
  8711. * Defines the kind of connection point for node based material
  8712. */
  8713. export enum NodeMaterialBlockConnectionPointTypes {
  8714. /** Float */
  8715. Float = 1,
  8716. /** Int */
  8717. Int = 2,
  8718. /** Vector2 */
  8719. Vector2 = 4,
  8720. /** Vector3 */
  8721. Vector3 = 8,
  8722. /** Vector4 */
  8723. Vector4 = 16,
  8724. /** Color3 */
  8725. Color3 = 32,
  8726. /** Color4 */
  8727. Color4 = 64,
  8728. /** Matrix */
  8729. Matrix = 128,
  8730. /** Custom object */
  8731. Object = 256,
  8732. /** Detect type based on connection */
  8733. AutoDetect = 1024,
  8734. /** Output type that will be defined by input type */
  8735. BasedOnInput = 2048
  8736. }
  8737. }
  8738. declare module "babylonjs/Materials/Node/Enums/nodeMaterialBlockTargets" {
  8739. /**
  8740. * Enum used to define the target of a block
  8741. */
  8742. export enum NodeMaterialBlockTargets {
  8743. /** Vertex shader */
  8744. Vertex = 1,
  8745. /** Fragment shader */
  8746. Fragment = 2,
  8747. /** Neutral */
  8748. Neutral = 4,
  8749. /** Vertex and Fragment */
  8750. VertexAndFragment = 3
  8751. }
  8752. }
  8753. declare module "babylonjs/Materials/Node/Enums/nodeMaterialBlockConnectionPointMode" {
  8754. /**
  8755. * Enum defining the mode of a NodeMaterialBlockConnectionPoint
  8756. */
  8757. export enum NodeMaterialBlockConnectionPointMode {
  8758. /** Value is an uniform */
  8759. Uniform = 0,
  8760. /** Value is a mesh attribute */
  8761. Attribute = 1,
  8762. /** Value is a varying between vertex and fragment shaders */
  8763. Varying = 2,
  8764. /** Mode is undefined */
  8765. Undefined = 3
  8766. }
  8767. }
  8768. declare module "babylonjs/Materials/Node/Enums/nodeMaterialSystemValues" {
  8769. /**
  8770. * Enum used to define system values e.g. values automatically provided by the system
  8771. */
  8772. export enum NodeMaterialSystemValues {
  8773. /** World */
  8774. World = 1,
  8775. /** View */
  8776. View = 2,
  8777. /** Projection */
  8778. Projection = 3,
  8779. /** ViewProjection */
  8780. ViewProjection = 4,
  8781. /** WorldView */
  8782. WorldView = 5,
  8783. /** WorldViewProjection */
  8784. WorldViewProjection = 6,
  8785. /** CameraPosition */
  8786. CameraPosition = 7,
  8787. /** Fog Color */
  8788. FogColor = 8,
  8789. /** Delta time */
  8790. DeltaTime = 9
  8791. }
  8792. }
  8793. declare module "babylonjs/Maths/math.axis" {
  8794. import { Vector3 } from "babylonjs/Maths/math.vector";
  8795. /** Defines supported spaces */
  8796. export enum Space {
  8797. /** Local (object) space */
  8798. LOCAL = 0,
  8799. /** World space */
  8800. WORLD = 1,
  8801. /** Bone space */
  8802. BONE = 2
  8803. }
  8804. /** Defines the 3 main axes */
  8805. export class Axis {
  8806. /** X axis */
  8807. static X: Vector3;
  8808. /** Y axis */
  8809. static Y: Vector3;
  8810. /** Z axis */
  8811. static Z: Vector3;
  8812. }
  8813. }
  8814. declare module "babylonjs/Maths/math.frustum" {
  8815. import { Matrix } from "babylonjs/Maths/math.vector";
  8816. import { DeepImmutable } from "babylonjs/types";
  8817. import { Plane } from "babylonjs/Maths/math.plane";
  8818. /**
  8819. * Represents a camera frustum
  8820. */
  8821. export class Frustum {
  8822. /**
  8823. * Gets the planes representing the frustum
  8824. * @param transform matrix to be applied to the returned planes
  8825. * @returns a new array of 6 Frustum planes computed by the given transformation matrix.
  8826. */
  8827. static GetPlanes(transform: DeepImmutable<Matrix>): Plane[];
  8828. /**
  8829. * Gets the near frustum plane transformed by the transform matrix
  8830. * @param transform transformation matrix to be applied to the resulting frustum plane
  8831. * @param frustumPlane the resuling frustum plane
  8832. */
  8833. static GetNearPlaneToRef(transform: DeepImmutable<Matrix>, frustumPlane: Plane): void;
  8834. /**
  8835. * Gets the far frustum plane transformed by the transform matrix
  8836. * @param transform transformation matrix to be applied to the resulting frustum plane
  8837. * @param frustumPlane the resuling frustum plane
  8838. */
  8839. static GetFarPlaneToRef(transform: DeepImmutable<Matrix>, frustumPlane: Plane): void;
  8840. /**
  8841. * Gets the left frustum plane transformed by the transform matrix
  8842. * @param transform transformation matrix to be applied to the resulting frustum plane
  8843. * @param frustumPlane the resuling frustum plane
  8844. */
  8845. static GetLeftPlaneToRef(transform: DeepImmutable<Matrix>, frustumPlane: Plane): void;
  8846. /**
  8847. * Gets the right frustum plane transformed by the transform matrix
  8848. * @param transform transformation matrix to be applied to the resulting frustum plane
  8849. * @param frustumPlane the resuling frustum plane
  8850. */
  8851. static GetRightPlaneToRef(transform: DeepImmutable<Matrix>, frustumPlane: Plane): void;
  8852. /**
  8853. * Gets the top frustum plane transformed by the transform matrix
  8854. * @param transform transformation matrix to be applied to the resulting frustum plane
  8855. * @param frustumPlane the resuling frustum plane
  8856. */
  8857. static GetTopPlaneToRef(transform: DeepImmutable<Matrix>, frustumPlane: Plane): void;
  8858. /**
  8859. * Gets the bottom frustum plane transformed by the transform matrix
  8860. * @param transform transformation matrix to be applied to the resulting frustum plane
  8861. * @param frustumPlane the resuling frustum plane
  8862. */
  8863. static GetBottomPlaneToRef(transform: DeepImmutable<Matrix>, frustumPlane: Plane): void;
  8864. /**
  8865. * Sets the given array "frustumPlanes" with the 6 Frustum planes computed by the given transformation matrix.
  8866. * @param transform transformation matrix to be applied to the resulting frustum planes
  8867. * @param frustumPlanes the resuling frustum planes
  8868. */
  8869. static GetPlanesToRef(transform: DeepImmutable<Matrix>, frustumPlanes: Plane[]): void;
  8870. }
  8871. }
  8872. declare module "babylonjs/Maths/math.size" {
  8873. /**
  8874. * Interface for the size containing width and height
  8875. */
  8876. export interface ISize {
  8877. /**
  8878. * Width
  8879. */
  8880. width: number;
  8881. /**
  8882. * Heighht
  8883. */
  8884. height: number;
  8885. }
  8886. /**
  8887. * Size containing widht and height
  8888. */
  8889. export class Size implements ISize {
  8890. /**
  8891. * Width
  8892. */
  8893. width: number;
  8894. /**
  8895. * Height
  8896. */
  8897. height: number;
  8898. /**
  8899. * Creates a Size object from the given width and height (floats).
  8900. * @param width width of the new size
  8901. * @param height height of the new size
  8902. */
  8903. constructor(width: number, height: number);
  8904. /**
  8905. * Returns a string with the Size width and height
  8906. * @returns a string with the Size width and height
  8907. */
  8908. toString(): string;
  8909. /**
  8910. * "Size"
  8911. * @returns the string "Size"
  8912. */
  8913. getClassName(): string;
  8914. /**
  8915. * Returns the Size hash code.
  8916. * @returns a hash code for a unique width and height
  8917. */
  8918. getHashCode(): number;
  8919. /**
  8920. * Updates the current size from the given one.
  8921. * @param src the given size
  8922. */
  8923. copyFrom(src: Size): void;
  8924. /**
  8925. * Updates in place the current Size from the given floats.
  8926. * @param width width of the new size
  8927. * @param height height of the new size
  8928. * @returns the updated Size.
  8929. */
  8930. copyFromFloats(width: number, height: number): Size;
  8931. /**
  8932. * Updates in place the current Size from the given floats.
  8933. * @param width width to set
  8934. * @param height height to set
  8935. * @returns the updated Size.
  8936. */
  8937. set(width: number, height: number): Size;
  8938. /**
  8939. * Multiplies the width and height by numbers
  8940. * @param w factor to multiple the width by
  8941. * @param h factor to multiple the height by
  8942. * @returns a new Size set with the multiplication result of the current Size and the given floats.
  8943. */
  8944. multiplyByFloats(w: number, h: number): Size;
  8945. /**
  8946. * Clones the size
  8947. * @returns a new Size copied from the given one.
  8948. */
  8949. clone(): Size;
  8950. /**
  8951. * True if the current Size and the given one width and height are strictly equal.
  8952. * @param other the other size to compare against
  8953. * @returns True if the current Size and the given one width and height are strictly equal.
  8954. */
  8955. equals(other: Size): boolean;
  8956. /**
  8957. * The surface of the Size : width * height (float).
  8958. */
  8959. get surface(): number;
  8960. /**
  8961. * Create a new size of zero
  8962. * @returns a new Size set to (0.0, 0.0)
  8963. */
  8964. static Zero(): Size;
  8965. /**
  8966. * Sums the width and height of two sizes
  8967. * @param otherSize size to add to this size
  8968. * @returns a new Size set as the addition result of the current Size and the given one.
  8969. */
  8970. add(otherSize: Size): Size;
  8971. /**
  8972. * Subtracts the width and height of two
  8973. * @param otherSize size to subtract to this size
  8974. * @returns a new Size set as the subtraction result of the given one from the current Size.
  8975. */
  8976. subtract(otherSize: Size): Size;
  8977. /**
  8978. * Creates a new Size set at the linear interpolation "amount" between "start" and "end"
  8979. * @param start starting size to lerp between
  8980. * @param end end size to lerp between
  8981. * @param amount amount to lerp between the start and end values
  8982. * @returns a new Size set at the linear interpolation "amount" between "start" and "end"
  8983. */
  8984. static Lerp(start: Size, end: Size, amount: number): Size;
  8985. }
  8986. }
  8987. declare module "babylonjs/Maths/math.vertexFormat" {
  8988. import { Vector3, Vector2 } from "babylonjs/Maths/math.vector";
  8989. /**
  8990. * Contains position and normal vectors for a vertex
  8991. */
  8992. export class PositionNormalVertex {
  8993. /** the position of the vertex (defaut: 0,0,0) */
  8994. position: Vector3;
  8995. /** the normal of the vertex (defaut: 0,1,0) */
  8996. normal: Vector3;
  8997. /**
  8998. * Creates a PositionNormalVertex
  8999. * @param position the position of the vertex (defaut: 0,0,0)
  9000. * @param normal the normal of the vertex (defaut: 0,1,0)
  9001. */
  9002. constructor(
  9003. /** the position of the vertex (defaut: 0,0,0) */
  9004. position?: Vector3,
  9005. /** the normal of the vertex (defaut: 0,1,0) */
  9006. normal?: Vector3);
  9007. /**
  9008. * Clones the PositionNormalVertex
  9009. * @returns the cloned PositionNormalVertex
  9010. */
  9011. clone(): PositionNormalVertex;
  9012. }
  9013. /**
  9014. * Contains position, normal and uv vectors for a vertex
  9015. */
  9016. export class PositionNormalTextureVertex {
  9017. /** the position of the vertex (defaut: 0,0,0) */
  9018. position: Vector3;
  9019. /** the normal of the vertex (defaut: 0,1,0) */
  9020. normal: Vector3;
  9021. /** the uv of the vertex (default: 0,0) */
  9022. uv: Vector2;
  9023. /**
  9024. * Creates a PositionNormalTextureVertex
  9025. * @param position the position of the vertex (defaut: 0,0,0)
  9026. * @param normal the normal of the vertex (defaut: 0,1,0)
  9027. * @param uv the uv of the vertex (default: 0,0)
  9028. */
  9029. constructor(
  9030. /** the position of the vertex (defaut: 0,0,0) */
  9031. position?: Vector3,
  9032. /** the normal of the vertex (defaut: 0,1,0) */
  9033. normal?: Vector3,
  9034. /** the uv of the vertex (default: 0,0) */
  9035. uv?: Vector2);
  9036. /**
  9037. * Clones the PositionNormalTextureVertex
  9038. * @returns the cloned PositionNormalTextureVertex
  9039. */
  9040. clone(): PositionNormalTextureVertex;
  9041. }
  9042. }
  9043. declare module "babylonjs/Maths/math" {
  9044. export * from "babylonjs/Maths/math.axis";
  9045. export * from "babylonjs/Maths/math.color";
  9046. export * from "babylonjs/Maths/math.constants";
  9047. export * from "babylonjs/Maths/math.frustum";
  9048. export * from "babylonjs/Maths/math.path";
  9049. export * from "babylonjs/Maths/math.plane";
  9050. export * from "babylonjs/Maths/math.size";
  9051. export * from "babylonjs/Maths/math.vector";
  9052. export * from "babylonjs/Maths/math.vertexFormat";
  9053. export * from "babylonjs/Maths/math.viewport";
  9054. }
  9055. declare module "babylonjs/Materials/Node/Blocks/Input/animatedInputBlockTypes" {
  9056. /**
  9057. * Enum defining the type of animations supported by InputBlock
  9058. */
  9059. export enum AnimatedInputBlockTypes {
  9060. /** No animation */
  9061. None = 0,
  9062. /** Time based animation. Will only work for floats */
  9063. Time = 1
  9064. }
  9065. }
  9066. declare module "babylonjs/Lights/shadowLight" {
  9067. import { Camera } from "babylonjs/Cameras/camera";
  9068. import { Scene } from "babylonjs/scene";
  9069. import { Matrix, Vector3 } from "babylonjs/Maths/math.vector";
  9070. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  9071. import { Light } from "babylonjs/Lights/light";
  9072. /**
  9073. * Interface describing all the common properties and methods a shadow light needs to implement.
  9074. * This helps both the shadow generator and materials to genrate the corresponding shadow maps
  9075. * as well as binding the different shadow properties to the effects.
  9076. */
  9077. export interface IShadowLight extends Light {
  9078. /**
  9079. * The light id in the scene (used in scene.findLighById for instance)
  9080. */
  9081. id: string;
  9082. /**
  9083. * The position the shdow will be casted from.
  9084. */
  9085. position: Vector3;
  9086. /**
  9087. * In 2d mode (needCube being false), the direction used to cast the shadow.
  9088. */
  9089. direction: Vector3;
  9090. /**
  9091. * The transformed position. Position of the light in world space taking parenting in account.
  9092. */
  9093. transformedPosition: Vector3;
  9094. /**
  9095. * The transformed direction. Direction of the light in world space taking parenting in account.
  9096. */
  9097. transformedDirection: Vector3;
  9098. /**
  9099. * The friendly name of the light in the scene.
  9100. */
  9101. name: string;
  9102. /**
  9103. * Defines the shadow projection clipping minimum z value.
  9104. */
  9105. shadowMinZ: number;
  9106. /**
  9107. * Defines the shadow projection clipping maximum z value.
  9108. */
  9109. shadowMaxZ: number;
  9110. /**
  9111. * Computes the transformed information (transformedPosition and transformedDirection in World space) of the current light
  9112. * @returns true if the information has been computed, false if it does not need to (no parenting)
  9113. */
  9114. computeTransformedInformation(): boolean;
  9115. /**
  9116. * Gets the scene the light belongs to.
  9117. * @returns The scene
  9118. */
  9119. getScene(): Scene;
  9120. /**
  9121. * Callback defining a custom Projection Matrix Builder.
  9122. * This can be used to override the default projection matrix computation.
  9123. */
  9124. customProjectionMatrixBuilder: (viewMatrix: Matrix, renderList: Array<AbstractMesh>, result: Matrix) => void;
  9125. /**
  9126. * Sets the shadow projection matrix in parameter to the generated projection matrix.
  9127. * @param matrix The materix to updated with the projection information
  9128. * @param viewMatrix The transform matrix of the light
  9129. * @param renderList The list of mesh to render in the map
  9130. * @returns The current light
  9131. */
  9132. setShadowProjectionMatrix(matrix: Matrix, viewMatrix: Matrix, renderList: Array<AbstractMesh>): IShadowLight;
  9133. /**
  9134. * Gets the current depth scale used in ESM.
  9135. * @returns The scale
  9136. */
  9137. getDepthScale(): number;
  9138. /**
  9139. * Returns whether or not the shadow generation require a cube texture or a 2d texture.
  9140. * @returns true if a cube texture needs to be use
  9141. */
  9142. needCube(): boolean;
  9143. /**
  9144. * Detects if the projection matrix requires to be recomputed this frame.
  9145. * @returns true if it requires to be recomputed otherwise, false.
  9146. */
  9147. needProjectionMatrixCompute(): boolean;
  9148. /**
  9149. * Forces the shadow generator to recompute the projection matrix even if position and direction did not changed.
  9150. */
  9151. forceProjectionMatrixCompute(): void;
  9152. /**
  9153. * Get the direction to use to render the shadow map. In case of cube texture, the face index can be passed.
  9154. * @param faceIndex The index of the face we are computed the direction to generate shadow
  9155. * @returns The set direction in 2d mode otherwise the direction to the cubemap face if needCube() is true
  9156. */
  9157. getShadowDirection(faceIndex?: number): Vector3;
  9158. /**
  9159. * Gets the minZ used for shadow according to both the scene and the light.
  9160. * @param activeCamera The camera we are returning the min for
  9161. * @returns the depth min z
  9162. */
  9163. getDepthMinZ(activeCamera: Camera): number;
  9164. /**
  9165. * Gets the maxZ used for shadow according to both the scene and the light.
  9166. * @param activeCamera The camera we are returning the max for
  9167. * @returns the depth max z
  9168. */
  9169. getDepthMaxZ(activeCamera: Camera): number;
  9170. }
  9171. /**
  9172. * Base implementation IShadowLight
  9173. * It groups all the common behaviour in order to reduce dupplication and better follow the DRY pattern.
  9174. */
  9175. export abstract class ShadowLight extends Light implements IShadowLight {
  9176. protected abstract _setDefaultShadowProjectionMatrix(matrix: Matrix, viewMatrix: Matrix, renderList: Array<AbstractMesh>): void;
  9177. protected _position: Vector3;
  9178. protected _setPosition(value: Vector3): void;
  9179. /**
  9180. * Sets the position the shadow will be casted from. Also use as the light position for both
  9181. * point and spot lights.
  9182. */
  9183. get position(): Vector3;
  9184. /**
  9185. * Sets the position the shadow will be casted from. Also use as the light position for both
  9186. * point and spot lights.
  9187. */
  9188. set position(value: Vector3);
  9189. protected _direction: Vector3;
  9190. protected _setDirection(value: Vector3): void;
  9191. /**
  9192. * In 2d mode (needCube being false), gets the direction used to cast the shadow.
  9193. * Also use as the light direction on spot and directional lights.
  9194. */
  9195. get direction(): Vector3;
  9196. /**
  9197. * In 2d mode (needCube being false), sets the direction used to cast the shadow.
  9198. * Also use as the light direction on spot and directional lights.
  9199. */
  9200. set direction(value: Vector3);
  9201. protected _shadowMinZ: number;
  9202. /**
  9203. * Gets the shadow projection clipping minimum z value.
  9204. */
  9205. get shadowMinZ(): number;
  9206. /**
  9207. * Sets the shadow projection clipping minimum z value.
  9208. */
  9209. set shadowMinZ(value: number);
  9210. protected _shadowMaxZ: number;
  9211. /**
  9212. * Sets the shadow projection clipping maximum z value.
  9213. */
  9214. get shadowMaxZ(): number;
  9215. /**
  9216. * Gets the shadow projection clipping maximum z value.
  9217. */
  9218. set shadowMaxZ(value: number);
  9219. /**
  9220. * Callback defining a custom Projection Matrix Builder.
  9221. * This can be used to override the default projection matrix computation.
  9222. */
  9223. customProjectionMatrixBuilder: (viewMatrix: Matrix, renderList: Array<AbstractMesh>, result: Matrix) => void;
  9224. /**
  9225. * The transformed position. Position of the light in world space taking parenting in account.
  9226. */
  9227. transformedPosition: Vector3;
  9228. /**
  9229. * The transformed direction. Direction of the light in world space taking parenting in account.
  9230. */
  9231. transformedDirection: Vector3;
  9232. private _needProjectionMatrixCompute;
  9233. /**
  9234. * Computes the transformed information (transformedPosition and transformedDirection in World space) of the current light
  9235. * @returns true if the information has been computed, false if it does not need to (no parenting)
  9236. */
  9237. computeTransformedInformation(): boolean;
  9238. /**
  9239. * Return the depth scale used for the shadow map.
  9240. * @returns the depth scale.
  9241. */
  9242. getDepthScale(): number;
  9243. /**
  9244. * Get the direction to use to render the shadow map. In case of cube texture, the face index can be passed.
  9245. * @param faceIndex The index of the face we are computed the direction to generate shadow
  9246. * @returns The set direction in 2d mode otherwise the direction to the cubemap face if needCube() is true
  9247. */
  9248. getShadowDirection(faceIndex?: number): Vector3;
  9249. /**
  9250. * Returns the ShadowLight absolute position in the World.
  9251. * @returns the position vector in world space
  9252. */
  9253. getAbsolutePosition(): Vector3;
  9254. /**
  9255. * Sets the ShadowLight direction toward the passed target.
  9256. * @param target The point to target in local space
  9257. * @returns the updated ShadowLight direction
  9258. */
  9259. setDirectionToTarget(target: Vector3): Vector3;
  9260. /**
  9261. * Returns the light rotation in euler definition.
  9262. * @returns the x y z rotation in local space.
  9263. */
  9264. getRotation(): Vector3;
  9265. /**
  9266. * Returns whether or not the shadow generation require a cube texture or a 2d texture.
  9267. * @returns true if a cube texture needs to be use
  9268. */
  9269. needCube(): boolean;
  9270. /**
  9271. * Detects if the projection matrix requires to be recomputed this frame.
  9272. * @returns true if it requires to be recomputed otherwise, false.
  9273. */
  9274. needProjectionMatrixCompute(): boolean;
  9275. /**
  9276. * Forces the shadow generator to recompute the projection matrix even if position and direction did not changed.
  9277. */
  9278. forceProjectionMatrixCompute(): void;
  9279. /** @hidden */
  9280. _initCache(): void;
  9281. /** @hidden */
  9282. _isSynchronized(): boolean;
  9283. /**
  9284. * Computes the world matrix of the node
  9285. * @param force defines if the cache version should be invalidated forcing the world matrix to be created from scratch
  9286. * @returns the world matrix
  9287. */
  9288. computeWorldMatrix(force?: boolean): Matrix;
  9289. /**
  9290. * Gets the minZ used for shadow according to both the scene and the light.
  9291. * @param activeCamera The camera we are returning the min for
  9292. * @returns the depth min z
  9293. */
  9294. getDepthMinZ(activeCamera: Camera): number;
  9295. /**
  9296. * Gets the maxZ used for shadow according to both the scene and the light.
  9297. * @param activeCamera The camera we are returning the max for
  9298. * @returns the depth max z
  9299. */
  9300. getDepthMaxZ(activeCamera: Camera): number;
  9301. /**
  9302. * Sets the shadow projection matrix in parameter to the generated projection matrix.
  9303. * @param matrix The materix to updated with the projection information
  9304. * @param viewMatrix The transform matrix of the light
  9305. * @param renderList The list of mesh to render in the map
  9306. * @returns The current light
  9307. */
  9308. setShadowProjectionMatrix(matrix: Matrix, viewMatrix: Matrix, renderList: Array<AbstractMesh>): IShadowLight;
  9309. }
  9310. }
  9311. declare module "babylonjs/Shaders/ShadersInclude/packingFunctions" {
  9312. /** @hidden */
  9313. export var packingFunctions: {
  9314. name: string;
  9315. shader: string;
  9316. };
  9317. }
  9318. declare module "babylonjs/Shaders/ShadersInclude/bayerDitherFunctions" {
  9319. /** @hidden */
  9320. export var bayerDitherFunctions: {
  9321. name: string;
  9322. shader: string;
  9323. };
  9324. }
  9325. declare module "babylonjs/Shaders/ShadersInclude/shadowMapFragmentDeclaration" {
  9326. import "babylonjs/Shaders/ShadersInclude/packingFunctions";
  9327. import "babylonjs/Shaders/ShadersInclude/bayerDitherFunctions";
  9328. /** @hidden */
  9329. export var shadowMapFragmentDeclaration: {
  9330. name: string;
  9331. shader: string;
  9332. };
  9333. }
  9334. declare module "babylonjs/Shaders/ShadersInclude/clipPlaneFragmentDeclaration" {
  9335. /** @hidden */
  9336. export var clipPlaneFragmentDeclaration: {
  9337. name: string;
  9338. shader: string;
  9339. };
  9340. }
  9341. declare module "babylonjs/Shaders/ShadersInclude/clipPlaneFragment" {
  9342. /** @hidden */
  9343. export var clipPlaneFragment: {
  9344. name: string;
  9345. shader: string;
  9346. };
  9347. }
  9348. declare module "babylonjs/Shaders/ShadersInclude/shadowMapFragment" {
  9349. /** @hidden */
  9350. export var shadowMapFragment: {
  9351. name: string;
  9352. shader: string;
  9353. };
  9354. }
  9355. declare module "babylonjs/Shaders/shadowMap.fragment" {
  9356. import "babylonjs/Shaders/ShadersInclude/shadowMapFragmentDeclaration";
  9357. import "babylonjs/Shaders/ShadersInclude/clipPlaneFragmentDeclaration";
  9358. import "babylonjs/Shaders/ShadersInclude/clipPlaneFragment";
  9359. import "babylonjs/Shaders/ShadersInclude/shadowMapFragment";
  9360. /** @hidden */
  9361. export var shadowMapPixelShader: {
  9362. name: string;
  9363. shader: string;
  9364. };
  9365. }
  9366. declare module "babylonjs/Shaders/ShadersInclude/bonesDeclaration" {
  9367. /** @hidden */
  9368. export var bonesDeclaration: {
  9369. name: string;
  9370. shader: string;
  9371. };
  9372. }
  9373. declare module "babylonjs/Shaders/ShadersInclude/morphTargetsVertexGlobalDeclaration" {
  9374. /** @hidden */
  9375. export var morphTargetsVertexGlobalDeclaration: {
  9376. name: string;
  9377. shader: string;
  9378. };
  9379. }
  9380. declare module "babylonjs/Shaders/ShadersInclude/morphTargetsVertexDeclaration" {
  9381. /** @hidden */
  9382. export var morphTargetsVertexDeclaration: {
  9383. name: string;
  9384. shader: string;
  9385. };
  9386. }
  9387. declare module "babylonjs/Shaders/ShadersInclude/instancesDeclaration" {
  9388. /** @hidden */
  9389. export var instancesDeclaration: {
  9390. name: string;
  9391. shader: string;
  9392. };
  9393. }
  9394. declare module "babylonjs/Shaders/ShadersInclude/helperFunctions" {
  9395. /** @hidden */
  9396. export var helperFunctions: {
  9397. name: string;
  9398. shader: string;
  9399. };
  9400. }
  9401. declare module "babylonjs/Shaders/ShadersInclude/shadowMapVertexDeclaration" {
  9402. /** @hidden */
  9403. export var shadowMapVertexDeclaration: {
  9404. name: string;
  9405. shader: string;
  9406. };
  9407. }
  9408. declare module "babylonjs/Shaders/ShadersInclude/clipPlaneVertexDeclaration" {
  9409. /** @hidden */
  9410. export var clipPlaneVertexDeclaration: {
  9411. name: string;
  9412. shader: string;
  9413. };
  9414. }
  9415. declare module "babylonjs/Shaders/ShadersInclude/morphTargetsVertex" {
  9416. /** @hidden */
  9417. export var morphTargetsVertex: {
  9418. name: string;
  9419. shader: string;
  9420. };
  9421. }
  9422. declare module "babylonjs/Shaders/ShadersInclude/instancesVertex" {
  9423. /** @hidden */
  9424. export var instancesVertex: {
  9425. name: string;
  9426. shader: string;
  9427. };
  9428. }
  9429. declare module "babylonjs/Shaders/ShadersInclude/bonesVertex" {
  9430. /** @hidden */
  9431. export var bonesVertex: {
  9432. name: string;
  9433. shader: string;
  9434. };
  9435. }
  9436. declare module "babylonjs/Shaders/ShadersInclude/shadowMapVertexNormalBias" {
  9437. /** @hidden */
  9438. export var shadowMapVertexNormalBias: {
  9439. name: string;
  9440. shader: string;
  9441. };
  9442. }
  9443. declare module "babylonjs/Shaders/ShadersInclude/shadowMapVertexMetric" {
  9444. /** @hidden */
  9445. export var shadowMapVertexMetric: {
  9446. name: string;
  9447. shader: string;
  9448. };
  9449. }
  9450. declare module "babylonjs/Shaders/ShadersInclude/clipPlaneVertex" {
  9451. /** @hidden */
  9452. export var clipPlaneVertex: {
  9453. name: string;
  9454. shader: string;
  9455. };
  9456. }
  9457. declare module "babylonjs/Shaders/shadowMap.vertex" {
  9458. import "babylonjs/Shaders/ShadersInclude/bonesDeclaration";
  9459. import "babylonjs/Shaders/ShadersInclude/morphTargetsVertexGlobalDeclaration";
  9460. import "babylonjs/Shaders/ShadersInclude/morphTargetsVertexDeclaration";
  9461. import "babylonjs/Shaders/ShadersInclude/instancesDeclaration";
  9462. import "babylonjs/Shaders/ShadersInclude/helperFunctions";
  9463. import "babylonjs/Shaders/ShadersInclude/shadowMapVertexDeclaration";
  9464. import "babylonjs/Shaders/ShadersInclude/clipPlaneVertexDeclaration";
  9465. import "babylonjs/Shaders/ShadersInclude/morphTargetsVertex";
  9466. import "babylonjs/Shaders/ShadersInclude/instancesVertex";
  9467. import "babylonjs/Shaders/ShadersInclude/bonesVertex";
  9468. import "babylonjs/Shaders/ShadersInclude/shadowMapVertexNormalBias";
  9469. import "babylonjs/Shaders/ShadersInclude/shadowMapVertexMetric";
  9470. import "babylonjs/Shaders/ShadersInclude/clipPlaneVertex";
  9471. /** @hidden */
  9472. export var shadowMapVertexShader: {
  9473. name: string;
  9474. shader: string;
  9475. };
  9476. }
  9477. declare module "babylonjs/Shaders/depthBoxBlur.fragment" {
  9478. /** @hidden */
  9479. export var depthBoxBlurPixelShader: {
  9480. name: string;
  9481. shader: string;
  9482. };
  9483. }
  9484. declare module "babylonjs/Shaders/ShadersInclude/shadowMapFragmentSoftTransparentShadow" {
  9485. /** @hidden */
  9486. export var shadowMapFragmentSoftTransparentShadow: {
  9487. name: string;
  9488. shader: string;
  9489. };
  9490. }
  9491. declare module "babylonjs/Materials/effectFallbacks" {
  9492. import { IEffectFallbacks } from "babylonjs/Materials/iEffectFallbacks";
  9493. import { Effect } from "babylonjs/Materials/effect";
  9494. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  9495. /**
  9496. * EffectFallbacks can be used to add fallbacks (properties to disable) to certain properties when desired to improve performance.
  9497. * (Eg. Start at high quality with reflection and fog, if fps is low, remove reflection, if still low remove fog)
  9498. */
  9499. export class EffectFallbacks implements IEffectFallbacks {
  9500. private _defines;
  9501. private _currentRank;
  9502. private _maxRank;
  9503. private _mesh;
  9504. /**
  9505. * Removes the fallback from the bound mesh.
  9506. */
  9507. unBindMesh(): void;
  9508. /**
  9509. * Adds a fallback on the specified property.
  9510. * @param rank The rank of the fallback (Lower ranks will be fallbacked to first)
  9511. * @param define The name of the define in the shader
  9512. */
  9513. addFallback(rank: number, define: string): void;
  9514. /**
  9515. * Sets the mesh to use CPU skinning when needing to fallback.
  9516. * @param rank The rank of the fallback (Lower ranks will be fallbacked to first)
  9517. * @param mesh The mesh to use the fallbacks.
  9518. */
  9519. addCPUSkinningFallback(rank: number, mesh: AbstractMesh): void;
  9520. /**
  9521. * Checks to see if more fallbacks are still availible.
  9522. */
  9523. get hasMoreFallbacks(): boolean;
  9524. /**
  9525. * Removes the defines that should be removed when falling back.
  9526. * @param currentDefines defines the current define statements for the shader.
  9527. * @param effect defines the current effect we try to compile
  9528. * @returns The resulting defines with defines of the current rank removed.
  9529. */
  9530. reduce(currentDefines: string, effect: Effect): string;
  9531. }
  9532. }
  9533. declare module "babylonjs/Actions/action" {
  9534. import { Observable } from "babylonjs/Misc/observable";
  9535. import { Condition } from "babylonjs/Actions/condition";
  9536. import { AbstractActionManager } from "babylonjs/Actions/abstractActionManager";
  9537. import { Nullable } from "babylonjs/types";
  9538. import { Scene } from "babylonjs/scene";
  9539. import { ActionManager } from "babylonjs/Actions/actionManager";
  9540. import { ActionEvent } from "babylonjs/Actions/actionEvent";
  9541. import { Node } from "babylonjs/node";
  9542. /**
  9543. * Interface used to define Action
  9544. */
  9545. export interface IAction {
  9546. /**
  9547. * Trigger for the action
  9548. */
  9549. trigger: number;
  9550. /** Options of the trigger */
  9551. triggerOptions: any;
  9552. /**
  9553. * Gets the trigger parameters
  9554. * @returns the trigger parameters
  9555. */
  9556. getTriggerParameter(): any;
  9557. /**
  9558. * Internal only - executes current action event
  9559. * @hidden
  9560. */
  9561. _executeCurrent(evt?: ActionEvent): void;
  9562. /**
  9563. * Serialize placeholder for child classes
  9564. * @param parent of child
  9565. * @returns the serialized object
  9566. */
  9567. serialize(parent: any): any;
  9568. /**
  9569. * Internal only
  9570. * @hidden
  9571. */
  9572. _prepare(): void;
  9573. /**
  9574. * Internal only - manager for action
  9575. * @hidden
  9576. */
  9577. _actionManager: Nullable<AbstractActionManager>;
  9578. /**
  9579. * Adds action to chain of actions, may be a DoNothingAction
  9580. * @param action defines the next action to execute
  9581. * @returns The action passed in
  9582. * @see https://www.babylonjs-playground.com/#1T30HR#0
  9583. */
  9584. then(action: IAction): IAction;
  9585. }
  9586. /**
  9587. * The action to be carried out following a trigger
  9588. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#available-actions
  9589. */
  9590. export class Action implements IAction {
  9591. /** the trigger, with or without parameters, for the action */
  9592. triggerOptions: any;
  9593. /**
  9594. * Trigger for the action
  9595. */
  9596. trigger: number;
  9597. /**
  9598. * Internal only - manager for action
  9599. * @hidden
  9600. */
  9601. _actionManager: ActionManager;
  9602. private _nextActiveAction;
  9603. private _child;
  9604. private _condition?;
  9605. private _triggerParameter;
  9606. /**
  9607. * An event triggered prior to action being executed.
  9608. */
  9609. onBeforeExecuteObservable: Observable<Action>;
  9610. /**
  9611. * Creates a new Action
  9612. * @param triggerOptions the trigger, with or without parameters, for the action
  9613. * @param condition an optional determinant of action
  9614. */
  9615. constructor(
  9616. /** the trigger, with or without parameters, for the action */
  9617. triggerOptions: any, condition?: Condition);
  9618. /**
  9619. * Internal only
  9620. * @hidden
  9621. */
  9622. _prepare(): void;
  9623. /**
  9624. * Gets the trigger parameters
  9625. * @returns the trigger parameters
  9626. */
  9627. getTriggerParameter(): any;
  9628. /**
  9629. * Internal only - executes current action event
  9630. * @hidden
  9631. */
  9632. _executeCurrent(evt?: ActionEvent): void;
  9633. /**
  9634. * Execute placeholder for child classes
  9635. * @param evt optional action event
  9636. */
  9637. execute(evt?: ActionEvent): void;
  9638. /**
  9639. * Skips to next active action
  9640. */
  9641. skipToNextActiveAction(): void;
  9642. /**
  9643. * Adds action to chain of actions, may be a DoNothingAction
  9644. * @param action defines the next action to execute
  9645. * @returns The action passed in
  9646. * @see https://www.babylonjs-playground.com/#1T30HR#0
  9647. */
  9648. then(action: Action): Action;
  9649. /**
  9650. * Internal only
  9651. * @hidden
  9652. */
  9653. _getProperty(propertyPath: string): string;
  9654. /**
  9655. * Internal only
  9656. * @hidden
  9657. */
  9658. _getEffectiveTarget(target: any, propertyPath: string): any;
  9659. /**
  9660. * Serialize placeholder for child classes
  9661. * @param parent of child
  9662. * @returns the serialized object
  9663. */
  9664. serialize(parent: any): any;
  9665. /**
  9666. * Internal only called by serialize
  9667. * @hidden
  9668. */
  9669. protected _serialize(serializedAction: any, parent?: any): any;
  9670. /**
  9671. * Internal only
  9672. * @hidden
  9673. */
  9674. static _SerializeValueAsString: (value: any) => string;
  9675. /**
  9676. * Internal only
  9677. * @hidden
  9678. */
  9679. static _GetTargetProperty: (target: Scene | Node) => {
  9680. name: string;
  9681. targetType: string;
  9682. value: string;
  9683. };
  9684. }
  9685. }
  9686. declare module "babylonjs/Actions/condition" {
  9687. import { ActionManager } from "babylonjs/Actions/actionManager";
  9688. /**
  9689. * A Condition applied to an Action
  9690. */
  9691. export class Condition {
  9692. /**
  9693. * Internal only - manager for action
  9694. * @hidden
  9695. */
  9696. _actionManager: ActionManager;
  9697. /**
  9698. * Internal only
  9699. * @hidden
  9700. */
  9701. _evaluationId: number;
  9702. /**
  9703. * Internal only
  9704. * @hidden
  9705. */
  9706. _currentResult: boolean;
  9707. /**
  9708. * Creates a new Condition
  9709. * @param actionManager the manager of the action the condition is applied to
  9710. */
  9711. constructor(actionManager: ActionManager);
  9712. /**
  9713. * Check if the current condition is valid
  9714. * @returns a boolean
  9715. */
  9716. isValid(): boolean;
  9717. /**
  9718. * Internal only
  9719. * @hidden
  9720. */
  9721. _getProperty(propertyPath: string): string;
  9722. /**
  9723. * Internal only
  9724. * @hidden
  9725. */
  9726. _getEffectiveTarget(target: any, propertyPath: string): any;
  9727. /**
  9728. * Serialize placeholder for child classes
  9729. * @returns the serialized object
  9730. */
  9731. serialize(): any;
  9732. /**
  9733. * Internal only
  9734. * @hidden
  9735. */
  9736. protected _serialize(serializedCondition: any): any;
  9737. }
  9738. /**
  9739. * Defines specific conditional operators as extensions of Condition
  9740. */
  9741. export class ValueCondition extends Condition {
  9742. /** path to specify the property of the target the conditional operator uses */
  9743. propertyPath: string;
  9744. /** the value compared by the conditional operator against the current value of the property */
  9745. value: any;
  9746. /** the conditional operator, default ValueCondition.IsEqual */
  9747. operator: number;
  9748. /**
  9749. * Internal only
  9750. * @hidden
  9751. */
  9752. private static _IsEqual;
  9753. /**
  9754. * Internal only
  9755. * @hidden
  9756. */
  9757. private static _IsDifferent;
  9758. /**
  9759. * Internal only
  9760. * @hidden
  9761. */
  9762. private static _IsGreater;
  9763. /**
  9764. * Internal only
  9765. * @hidden
  9766. */
  9767. private static _IsLesser;
  9768. /**
  9769. * returns the number for IsEqual
  9770. */
  9771. static get IsEqual(): number;
  9772. /**
  9773. * Returns the number for IsDifferent
  9774. */
  9775. static get IsDifferent(): number;
  9776. /**
  9777. * Returns the number for IsGreater
  9778. */
  9779. static get IsGreater(): number;
  9780. /**
  9781. * Returns the number for IsLesser
  9782. */
  9783. static get IsLesser(): number;
  9784. /**
  9785. * Internal only The action manager for the condition
  9786. * @hidden
  9787. */
  9788. _actionManager: ActionManager;
  9789. /**
  9790. * Internal only
  9791. * @hidden
  9792. */
  9793. private _target;
  9794. /**
  9795. * Internal only
  9796. * @hidden
  9797. */
  9798. private _effectiveTarget;
  9799. /**
  9800. * Internal only
  9801. * @hidden
  9802. */
  9803. private _property;
  9804. /**
  9805. * Creates a new ValueCondition
  9806. * @param actionManager manager for the action the condition applies to
  9807. * @param target for the action
  9808. * @param propertyPath path to specify the property of the target the conditional operator uses
  9809. * @param value the value compared by the conditional operator against the current value of the property
  9810. * @param operator the conditional operator, default ValueCondition.IsEqual
  9811. */
  9812. constructor(actionManager: ActionManager, target: any,
  9813. /** path to specify the property of the target the conditional operator uses */
  9814. propertyPath: string,
  9815. /** the value compared by the conditional operator against the current value of the property */
  9816. value: any,
  9817. /** the conditional operator, default ValueCondition.IsEqual */
  9818. operator?: number);
  9819. /**
  9820. * Compares the given value with the property value for the specified conditional operator
  9821. * @returns the result of the comparison
  9822. */
  9823. isValid(): boolean;
  9824. /**
  9825. * Serialize the ValueCondition into a JSON compatible object
  9826. * @returns serialization object
  9827. */
  9828. serialize(): any;
  9829. /**
  9830. * Gets the name of the conditional operator for the ValueCondition
  9831. * @param operator the conditional operator
  9832. * @returns the name
  9833. */
  9834. static GetOperatorName(operator: number): string;
  9835. }
  9836. /**
  9837. * Defines a predicate condition as an extension of Condition
  9838. */
  9839. export class PredicateCondition extends Condition {
  9840. /** defines the predicate function used to validate the condition */
  9841. predicate: () => boolean;
  9842. /**
  9843. * Internal only - manager for action
  9844. * @hidden
  9845. */
  9846. _actionManager: ActionManager;
  9847. /**
  9848. * Creates a new PredicateCondition
  9849. * @param actionManager manager for the action the condition applies to
  9850. * @param predicate defines the predicate function used to validate the condition
  9851. */
  9852. constructor(actionManager: ActionManager,
  9853. /** defines the predicate function used to validate the condition */
  9854. predicate: () => boolean);
  9855. /**
  9856. * @returns the validity of the predicate condition
  9857. */
  9858. isValid(): boolean;
  9859. }
  9860. /**
  9861. * Defines a state condition as an extension of Condition
  9862. */
  9863. export class StateCondition extends Condition {
  9864. /** Value to compare with target state */
  9865. value: string;
  9866. /**
  9867. * Internal only - manager for action
  9868. * @hidden
  9869. */
  9870. _actionManager: ActionManager;
  9871. /**
  9872. * Internal only
  9873. * @hidden
  9874. */
  9875. private _target;
  9876. /**
  9877. * Creates a new StateCondition
  9878. * @param actionManager manager for the action the condition applies to
  9879. * @param target of the condition
  9880. * @param value to compare with target state
  9881. */
  9882. constructor(actionManager: ActionManager, target: any,
  9883. /** Value to compare with target state */
  9884. value: string);
  9885. /**
  9886. * Gets a boolean indicating if the current condition is met
  9887. * @returns the validity of the state
  9888. */
  9889. isValid(): boolean;
  9890. /**
  9891. * Serialize the StateCondition into a JSON compatible object
  9892. * @returns serialization object
  9893. */
  9894. serialize(): any;
  9895. }
  9896. }
  9897. declare module "babylonjs/Actions/directActions" {
  9898. import { Action } from "babylonjs/Actions/action";
  9899. import { Condition } from "babylonjs/Actions/condition";
  9900. import { ActionEvent } from "babylonjs/Actions/actionEvent";
  9901. /**
  9902. * This defines an action responsible to toggle a boolean once triggered.
  9903. * @see https://doc.babylonjs.com/how_to/how_to_use_actions
  9904. */
  9905. export class SwitchBooleanAction extends Action {
  9906. /**
  9907. * The path to the boolean property in the target object
  9908. */
  9909. propertyPath: string;
  9910. private _target;
  9911. private _effectiveTarget;
  9912. private _property;
  9913. /**
  9914. * Instantiate the action
  9915. * @param triggerOptions defines the trigger options
  9916. * @param target defines the object containing the boolean
  9917. * @param propertyPath defines the path to the boolean property in the target object
  9918. * @param condition defines the trigger related conditions
  9919. */
  9920. constructor(triggerOptions: any, target: any, propertyPath: string, condition?: Condition);
  9921. /** @hidden */
  9922. _prepare(): void;
  9923. /**
  9924. * Execute the action toggle the boolean value.
  9925. */
  9926. execute(): void;
  9927. /**
  9928. * Serializes the actions and its related information.
  9929. * @param parent defines the object to serialize in
  9930. * @returns the serialized object
  9931. */
  9932. serialize(parent: any): any;
  9933. }
  9934. /**
  9935. * This defines an action responsible to set a the state field of the target
  9936. * to a desired value once triggered.
  9937. * @see https://doc.babylonjs.com/how_to/how_to_use_actions
  9938. */
  9939. export class SetStateAction extends Action {
  9940. /**
  9941. * The value to store in the state field.
  9942. */
  9943. value: string;
  9944. private _target;
  9945. /**
  9946. * Instantiate the action
  9947. * @param triggerOptions defines the trigger options
  9948. * @param target defines the object containing the state property
  9949. * @param value defines the value to store in the state field
  9950. * @param condition defines the trigger related conditions
  9951. */
  9952. constructor(triggerOptions: any, target: any, value: string, condition?: Condition);
  9953. /**
  9954. * Execute the action and store the value on the target state property.
  9955. */
  9956. execute(): void;
  9957. /**
  9958. * Serializes the actions and its related information.
  9959. * @param parent defines the object to serialize in
  9960. * @returns the serialized object
  9961. */
  9962. serialize(parent: any): any;
  9963. }
  9964. /**
  9965. * This defines an action responsible to set a property of the target
  9966. * to a desired value once triggered.
  9967. * @see https://doc.babylonjs.com/how_to/how_to_use_actions
  9968. */
  9969. export class SetValueAction extends Action {
  9970. /**
  9971. * The path of the property to set in the target.
  9972. */
  9973. propertyPath: string;
  9974. /**
  9975. * The value to set in the property
  9976. */
  9977. value: any;
  9978. private _target;
  9979. private _effectiveTarget;
  9980. private _property;
  9981. /**
  9982. * Instantiate the action
  9983. * @param triggerOptions defines the trigger options
  9984. * @param target defines the object containing the property
  9985. * @param propertyPath defines the path of the property to set in the target
  9986. * @param value defines the value to set in the property
  9987. * @param condition defines the trigger related conditions
  9988. */
  9989. constructor(triggerOptions: any, target: any, propertyPath: string, value: any, condition?: Condition);
  9990. /** @hidden */
  9991. _prepare(): void;
  9992. /**
  9993. * Execute the action and set the targetted property to the desired value.
  9994. */
  9995. execute(): void;
  9996. /**
  9997. * Serializes the actions and its related information.
  9998. * @param parent defines the object to serialize in
  9999. * @returns the serialized object
  10000. */
  10001. serialize(parent: any): any;
  10002. }
  10003. /**
  10004. * This defines an action responsible to increment the target value
  10005. * to a desired value once triggered.
  10006. * @see https://doc.babylonjs.com/how_to/how_to_use_actions
  10007. */
  10008. export class IncrementValueAction extends Action {
  10009. /**
  10010. * The path of the property to increment in the target.
  10011. */
  10012. propertyPath: string;
  10013. /**
  10014. * The value we should increment the property by.
  10015. */
  10016. value: any;
  10017. private _target;
  10018. private _effectiveTarget;
  10019. private _property;
  10020. /**
  10021. * Instantiate the action
  10022. * @param triggerOptions defines the trigger options
  10023. * @param target defines the object containing the property
  10024. * @param propertyPath defines the path of the property to increment in the target
  10025. * @param value defines the value value we should increment the property by
  10026. * @param condition defines the trigger related conditions
  10027. */
  10028. constructor(triggerOptions: any, target: any, propertyPath: string, value: any, condition?: Condition);
  10029. /** @hidden */
  10030. _prepare(): void;
  10031. /**
  10032. * Execute the action and increment the target of the value amount.
  10033. */
  10034. execute(): void;
  10035. /**
  10036. * Serializes the actions and its related information.
  10037. * @param parent defines the object to serialize in
  10038. * @returns the serialized object
  10039. */
  10040. serialize(parent: any): any;
  10041. }
  10042. /**
  10043. * This defines an action responsible to start an animation once triggered.
  10044. * @see https://doc.babylonjs.com/how_to/how_to_use_actions
  10045. */
  10046. export class PlayAnimationAction extends Action {
  10047. /**
  10048. * Where the animation should start (animation frame)
  10049. */
  10050. from: number;
  10051. /**
  10052. * Where the animation should stop (animation frame)
  10053. */
  10054. to: number;
  10055. /**
  10056. * Define if the animation should loop or stop after the first play.
  10057. */
  10058. loop?: boolean;
  10059. private _target;
  10060. /**
  10061. * Instantiate the action
  10062. * @param triggerOptions defines the trigger options
  10063. * @param target defines the target animation or animation name
  10064. * @param from defines from where the animation should start (animation frame)
  10065. * @param end defines where the animation should stop (animation frame)
  10066. * @param loop defines if the animation should loop or stop after the first play
  10067. * @param condition defines the trigger related conditions
  10068. */
  10069. constructor(triggerOptions: any, target: any, from: number, to: number, loop?: boolean, condition?: Condition);
  10070. /** @hidden */
  10071. _prepare(): void;
  10072. /**
  10073. * Execute the action and play the animation.
  10074. */
  10075. execute(): void;
  10076. /**
  10077. * Serializes the actions and its related information.
  10078. * @param parent defines the object to serialize in
  10079. * @returns the serialized object
  10080. */
  10081. serialize(parent: any): any;
  10082. }
  10083. /**
  10084. * This defines an action responsible to stop an animation once triggered.
  10085. * @see https://doc.babylonjs.com/how_to/how_to_use_actions
  10086. */
  10087. export class StopAnimationAction extends Action {
  10088. private _target;
  10089. /**
  10090. * Instantiate the action
  10091. * @param triggerOptions defines the trigger options
  10092. * @param target defines the target animation or animation name
  10093. * @param condition defines the trigger related conditions
  10094. */
  10095. constructor(triggerOptions: any, target: any, condition?: Condition);
  10096. /** @hidden */
  10097. _prepare(): void;
  10098. /**
  10099. * Execute the action and stop the animation.
  10100. */
  10101. execute(): void;
  10102. /**
  10103. * Serializes the actions and its related information.
  10104. * @param parent defines the object to serialize in
  10105. * @returns the serialized object
  10106. */
  10107. serialize(parent: any): any;
  10108. }
  10109. /**
  10110. * This defines an action responsible that does nothing once triggered.
  10111. * @see https://doc.babylonjs.com/how_to/how_to_use_actions
  10112. */
  10113. export class DoNothingAction extends Action {
  10114. /**
  10115. * Instantiate the action
  10116. * @param triggerOptions defines the trigger options
  10117. * @param condition defines the trigger related conditions
  10118. */
  10119. constructor(triggerOptions?: any, condition?: Condition);
  10120. /**
  10121. * Execute the action and do nothing.
  10122. */
  10123. execute(): void;
  10124. /**
  10125. * Serializes the actions and its related information.
  10126. * @param parent defines the object to serialize in
  10127. * @returns the serialized object
  10128. */
  10129. serialize(parent: any): any;
  10130. }
  10131. /**
  10132. * This defines an action responsible to trigger several actions once triggered.
  10133. * @see https://doc.babylonjs.com/how_to/how_to_use_actions
  10134. */
  10135. export class CombineAction extends Action {
  10136. /**
  10137. * The list of aggregated animations to run.
  10138. */
  10139. children: Action[];
  10140. /**
  10141. * Instantiate the action
  10142. * @param triggerOptions defines the trigger options
  10143. * @param children defines the list of aggregated animations to run
  10144. * @param condition defines the trigger related conditions
  10145. */
  10146. constructor(triggerOptions: any, children: Action[], condition?: Condition);
  10147. /** @hidden */
  10148. _prepare(): void;
  10149. /**
  10150. * Execute the action and executes all the aggregated actions.
  10151. */
  10152. execute(evt: ActionEvent): void;
  10153. /**
  10154. * Serializes the actions and its related information.
  10155. * @param parent defines the object to serialize in
  10156. * @returns the serialized object
  10157. */
  10158. serialize(parent: any): any;
  10159. }
  10160. /**
  10161. * This defines an action responsible to run code (external event) once triggered.
  10162. * @see https://doc.babylonjs.com/how_to/how_to_use_actions
  10163. */
  10164. export class ExecuteCodeAction extends Action {
  10165. /**
  10166. * The callback function to run.
  10167. */
  10168. func: (evt: ActionEvent) => void;
  10169. /**
  10170. * Instantiate the action
  10171. * @param triggerOptions defines the trigger options
  10172. * @param func defines the callback function to run
  10173. * @param condition defines the trigger related conditions
  10174. */
  10175. constructor(triggerOptions: any, func: (evt: ActionEvent) => void, condition?: Condition);
  10176. /**
  10177. * Execute the action and run the attached code.
  10178. */
  10179. execute(evt: ActionEvent): void;
  10180. }
  10181. /**
  10182. * This defines an action responsible to set the parent property of the target once triggered.
  10183. * @see https://doc.babylonjs.com/how_to/how_to_use_actions
  10184. */
  10185. export class SetParentAction extends Action {
  10186. private _parent;
  10187. private _target;
  10188. /**
  10189. * Instantiate the action
  10190. * @param triggerOptions defines the trigger options
  10191. * @param target defines the target containing the parent property
  10192. * @param parent defines from where the animation should start (animation frame)
  10193. * @param condition defines the trigger related conditions
  10194. */
  10195. constructor(triggerOptions: any, target: any, parent: any, condition?: Condition);
  10196. /** @hidden */
  10197. _prepare(): void;
  10198. /**
  10199. * Execute the action and set the parent property.
  10200. */
  10201. execute(): void;
  10202. /**
  10203. * Serializes the actions and its related information.
  10204. * @param parent defines the object to serialize in
  10205. * @returns the serialized object
  10206. */
  10207. serialize(parent: any): any;
  10208. }
  10209. }
  10210. declare module "babylonjs/Actions/actionManager" {
  10211. import { Nullable } from "babylonjs/types";
  10212. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  10213. import { Scene } from "babylonjs/scene";
  10214. import { IAction } from "babylonjs/Actions/action";
  10215. import { IActionEvent } from "babylonjs/Actions/actionEvent";
  10216. import { AbstractActionManager } from "babylonjs/Actions/abstractActionManager";
  10217. /**
  10218. * Action Manager manages all events to be triggered on a given mesh or the global scene.
  10219. * A single scene can have many Action Managers to handle predefined actions on specific meshes.
  10220. * @see https://doc.babylonjs.com/how_to/how_to_use_actions
  10221. */
  10222. export class ActionManager extends AbstractActionManager {
  10223. /**
  10224. * Nothing
  10225. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  10226. */
  10227. static readonly NothingTrigger: number;
  10228. /**
  10229. * On pick
  10230. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  10231. */
  10232. static readonly OnPickTrigger: number;
  10233. /**
  10234. * On left pick
  10235. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  10236. */
  10237. static readonly OnLeftPickTrigger: number;
  10238. /**
  10239. * On right pick
  10240. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  10241. */
  10242. static readonly OnRightPickTrigger: number;
  10243. /**
  10244. * On center pick
  10245. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  10246. */
  10247. static readonly OnCenterPickTrigger: number;
  10248. /**
  10249. * On pick down
  10250. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  10251. */
  10252. static readonly OnPickDownTrigger: number;
  10253. /**
  10254. * On double pick
  10255. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  10256. */
  10257. static readonly OnDoublePickTrigger: number;
  10258. /**
  10259. * On pick up
  10260. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  10261. */
  10262. static readonly OnPickUpTrigger: number;
  10263. /**
  10264. * On pick out.
  10265. * This trigger will only be raised if you also declared a OnPickDown
  10266. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  10267. */
  10268. static readonly OnPickOutTrigger: number;
  10269. /**
  10270. * On long press
  10271. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  10272. */
  10273. static readonly OnLongPressTrigger: number;
  10274. /**
  10275. * On pointer over
  10276. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  10277. */
  10278. static readonly OnPointerOverTrigger: number;
  10279. /**
  10280. * On pointer out
  10281. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  10282. */
  10283. static readonly OnPointerOutTrigger: number;
  10284. /**
  10285. * On every frame
  10286. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  10287. */
  10288. static readonly OnEveryFrameTrigger: number;
  10289. /**
  10290. * On intersection enter
  10291. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  10292. */
  10293. static readonly OnIntersectionEnterTrigger: number;
  10294. /**
  10295. * On intersection exit
  10296. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  10297. */
  10298. static readonly OnIntersectionExitTrigger: number;
  10299. /**
  10300. * On key down
  10301. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  10302. */
  10303. static readonly OnKeyDownTrigger: number;
  10304. /**
  10305. * On key up
  10306. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  10307. */
  10308. static readonly OnKeyUpTrigger: number;
  10309. private _scene;
  10310. /**
  10311. * Creates a new action manager
  10312. * @param scene defines the hosting scene
  10313. */
  10314. constructor(scene: Scene);
  10315. /**
  10316. * Releases all associated resources
  10317. */
  10318. dispose(): void;
  10319. /**
  10320. * Gets hosting scene
  10321. * @returns the hosting scene
  10322. */
  10323. getScene(): Scene;
  10324. /**
  10325. * Does this action manager handles actions of any of the given triggers
  10326. * @param triggers defines the triggers to be tested
  10327. * @return a boolean indicating whether one (or more) of the triggers is handled
  10328. */
  10329. hasSpecificTriggers(triggers: number[]): boolean;
  10330. /**
  10331. * Does this action manager handles actions of any of the given triggers. This function takes two arguments for
  10332. * speed.
  10333. * @param triggerA defines the trigger to be tested
  10334. * @param triggerB defines the trigger to be tested
  10335. * @return a boolean indicating whether one (or more) of the triggers is handled
  10336. */
  10337. hasSpecificTriggers2(triggerA: number, triggerB: number): boolean;
  10338. /**
  10339. * Does this action manager handles actions of a given trigger
  10340. * @param trigger defines the trigger to be tested
  10341. * @param parameterPredicate defines an optional predicate to filter triggers by parameter
  10342. * @return whether the trigger is handled
  10343. */
  10344. hasSpecificTrigger(trigger: number, parameterPredicate?: (parameter: any) => boolean): boolean;
  10345. /**
  10346. * Does this action manager has pointer triggers
  10347. */
  10348. get hasPointerTriggers(): boolean;
  10349. /**
  10350. * Does this action manager has pick triggers
  10351. */
  10352. get hasPickTriggers(): boolean;
  10353. /**
  10354. * Registers an action to this action manager
  10355. * @param action defines the action to be registered
  10356. * @return the action amended (prepared) after registration
  10357. */
  10358. registerAction(action: IAction): Nullable<IAction>;
  10359. /**
  10360. * Unregisters an action to this action manager
  10361. * @param action defines the action to be unregistered
  10362. * @return a boolean indicating whether the action has been unregistered
  10363. */
  10364. unregisterAction(action: IAction): Boolean;
  10365. /**
  10366. * Process a specific trigger
  10367. * @param trigger defines the trigger to process
  10368. * @param evt defines the event details to be processed
  10369. */
  10370. processTrigger(trigger: number, evt?: IActionEvent): void;
  10371. /** @hidden */
  10372. _getEffectiveTarget(target: any, propertyPath: string): any;
  10373. /** @hidden */
  10374. _getProperty(propertyPath: string): string;
  10375. /**
  10376. * Serialize this manager to a JSON object
  10377. * @param name defines the property name to store this manager
  10378. * @returns a JSON representation of this manager
  10379. */
  10380. serialize(name: string): any;
  10381. /**
  10382. * Creates a new ActionManager from a JSON data
  10383. * @param parsedActions defines the JSON data to read from
  10384. * @param object defines the hosting mesh
  10385. * @param scene defines the hosting scene
  10386. */
  10387. static Parse(parsedActions: any, object: Nullable<AbstractMesh>, scene: Scene): void;
  10388. /**
  10389. * Get a trigger name by index
  10390. * @param trigger defines the trigger index
  10391. * @returns a trigger name
  10392. */
  10393. static GetTriggerName(trigger: number): string;
  10394. }
  10395. }
  10396. declare module "babylonjs/Sprites/sprite" {
  10397. import { Vector3 } from "babylonjs/Maths/math.vector";
  10398. import { Nullable } from "babylonjs/types";
  10399. import { ActionManager } from "babylonjs/Actions/actionManager";
  10400. import { ISpriteManager, SpriteManager } from "babylonjs/Sprites/spriteManager";
  10401. import { Color4 } from "babylonjs/Maths/math.color";
  10402. import { Observable } from "babylonjs/Misc/observable";
  10403. import { IAnimatable } from "babylonjs/Animations/animatable.interface";
  10404. import { Animation } from "babylonjs/Animations/animation";
  10405. /**
  10406. * Class used to represent a sprite
  10407. * @see https://doc.babylonjs.com/babylon101/sprites
  10408. */
  10409. export class Sprite implements IAnimatable {
  10410. /** defines the name */
  10411. name: string;
  10412. /** Gets or sets the current world position */
  10413. position: Vector3;
  10414. /** Gets or sets the main color */
  10415. color: Color4;
  10416. /** Gets or sets the width */
  10417. width: number;
  10418. /** Gets or sets the height */
  10419. height: number;
  10420. /** Gets or sets rotation angle */
  10421. angle: number;
  10422. /** Gets or sets the cell index in the sprite sheet */
  10423. cellIndex: number;
  10424. /** Gets or sets the cell reference in the sprite sheet, uses sprite's filename when added to sprite sheet */
  10425. cellRef: string;
  10426. /** Gets or sets a boolean indicating if UV coordinates should be inverted in U axis */
  10427. invertU: boolean;
  10428. /** Gets or sets a boolean indicating if UV coordinates should be inverted in B axis */
  10429. invertV: boolean;
  10430. /** Gets or sets a boolean indicating that this sprite should be disposed after animation ends */
  10431. disposeWhenFinishedAnimating: boolean;
  10432. /** Gets the list of attached animations */
  10433. animations: Nullable<Array<Animation>>;
  10434. /** Gets or sets a boolean indicating if the sprite can be picked */
  10435. isPickable: boolean;
  10436. /** Gets or sets a boolean indicating that sprite texture alpha will be used for precise picking (false by default) */
  10437. useAlphaForPicking: boolean;
  10438. /** @hidden */
  10439. _xOffset: number;
  10440. /** @hidden */
  10441. _yOffset: number;
  10442. /** @hidden */
  10443. _xSize: number;
  10444. /** @hidden */
  10445. _ySize: number;
  10446. /**
  10447. * Gets or sets the associated action manager
  10448. */
  10449. actionManager: Nullable<ActionManager>;
  10450. /**
  10451. * An event triggered when the control has been disposed
  10452. */
  10453. onDisposeObservable: Observable<Sprite>;
  10454. private _animationStarted;
  10455. private _loopAnimation;
  10456. private _fromIndex;
  10457. private _toIndex;
  10458. private _delay;
  10459. private _direction;
  10460. private _manager;
  10461. private _time;
  10462. private _onAnimationEnd;
  10463. /**
  10464. * Gets or sets a boolean indicating if the sprite is visible (renderable). Default is true
  10465. */
  10466. isVisible: boolean;
  10467. /**
  10468. * Gets or sets the sprite size
  10469. */
  10470. get size(): number;
  10471. set size(value: number);
  10472. /**
  10473. * Returns a boolean indicating if the animation is started
  10474. */
  10475. get animationStarted(): boolean;
  10476. /**
  10477. * Gets or sets the unique id of the sprite
  10478. */
  10479. uniqueId: number;
  10480. /**
  10481. * Gets the manager of this sprite
  10482. */
  10483. get manager(): ISpriteManager;
  10484. /**
  10485. * Creates a new Sprite
  10486. * @param name defines the name
  10487. * @param manager defines the manager
  10488. */
  10489. constructor(
  10490. /** defines the name */
  10491. name: string, manager: ISpriteManager);
  10492. /**
  10493. * Returns the string "Sprite"
  10494. * @returns "Sprite"
  10495. */
  10496. getClassName(): string;
  10497. /** Gets or sets the initial key for the animation (setting it will restart the animation) */
  10498. get fromIndex(): number;
  10499. set fromIndex(value: number);
  10500. /** Gets or sets the end key for the animation (setting it will restart the animation) */
  10501. get toIndex(): number;
  10502. set toIndex(value: number);
  10503. /** Gets or sets a boolean indicating if the animation is looping (setting it will restart the animation) */
  10504. get loopAnimation(): boolean;
  10505. set loopAnimation(value: boolean);
  10506. /** Gets or sets the delay between cell changes (setting it will restart the animation) */
  10507. get delay(): number;
  10508. set delay(value: number);
  10509. /**
  10510. * Starts an animation
  10511. * @param from defines the initial key
  10512. * @param to defines the end key
  10513. * @param loop defines if the animation must loop
  10514. * @param delay defines the start delay (in ms)
  10515. * @param onAnimationEnd defines a callback to call when animation ends
  10516. */
  10517. playAnimation(from: number, to: number, loop: boolean, delay: number, onAnimationEnd?: Nullable<() => void>): void;
  10518. /** Stops current animation (if any) */
  10519. stopAnimation(): void;
  10520. /** @hidden */
  10521. _animate(deltaTime: number): void;
  10522. /** Release associated resources */
  10523. dispose(): void;
  10524. /**
  10525. * Serializes the sprite to a JSON object
  10526. * @returns the JSON object
  10527. */
  10528. serialize(): any;
  10529. /**
  10530. * Parses a JSON object to create a new sprite
  10531. * @param parsedSprite The JSON object to parse
  10532. * @param manager defines the hosting manager
  10533. * @returns the new sprite
  10534. */
  10535. static Parse(parsedSprite: any, manager: SpriteManager): Sprite;
  10536. }
  10537. }
  10538. declare module "babylonjs/Collisions/pickingInfo" {
  10539. import { Nullable } from "babylonjs/types";
  10540. import { Vector3, Vector2 } from "babylonjs/Maths/math.vector";
  10541. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  10542. import { Sprite } from "babylonjs/Sprites/sprite";
  10543. import { Ray } from "babylonjs/Culling/ray";
  10544. /**
  10545. * Information about the result of picking within a scene
  10546. * @see https://doc.babylonjs.com/babylon101/picking_collisions
  10547. */
  10548. export class PickingInfo {
  10549. /** @hidden */
  10550. _pickingUnavailable: boolean;
  10551. /**
  10552. * If the pick collided with an object
  10553. */
  10554. hit: boolean;
  10555. /**
  10556. * Distance away where the pick collided
  10557. */
  10558. distance: number;
  10559. /**
  10560. * The location of pick collision
  10561. */
  10562. pickedPoint: Nullable<Vector3>;
  10563. /**
  10564. * The mesh corresponding the the pick collision
  10565. */
  10566. pickedMesh: Nullable<AbstractMesh>;
  10567. /** (See getTextureCoordinates) The barycentric U coordinate that is used when calculating the texture coordinates of the collision.*/
  10568. bu: number;
  10569. /** (See getTextureCoordinates) The barycentric V coordinate that is used when calculating the texture coordinates of the collision.*/
  10570. bv: number;
  10571. /** The index of the face on the mesh that was picked, or the index of the Line if the picked Mesh is a LinesMesh */
  10572. faceId: number;
  10573. /** The index of the face on the subMesh that was picked, or the index of the Line if the picked Mesh is a LinesMesh */
  10574. subMeshFaceId: number;
  10575. /** Id of the the submesh that was picked */
  10576. subMeshId: number;
  10577. /** If a sprite was picked, this will be the sprite the pick collided with */
  10578. pickedSprite: Nullable<Sprite>;
  10579. /** If we are pikcing a mesh with thin instance, this will give you the picked thin instance */
  10580. thinInstanceIndex: number;
  10581. /**
  10582. * If a mesh was used to do the picking (eg. 6dof controller) this will be populated.
  10583. */
  10584. originMesh: Nullable<AbstractMesh>;
  10585. /**
  10586. * The ray that was used to perform the picking.
  10587. */
  10588. ray: Nullable<Ray>;
  10589. /**
  10590. * Gets the normal correspodning to the face the pick collided with
  10591. * @param useWorldCoordinates If the resulting normal should be relative to the world (default: false)
  10592. * @param useVerticesNormals If the vertices normals should be used to calculate the normal instead of the normal map
  10593. * @returns The normal correspodning to the face the pick collided with
  10594. */
  10595. getNormal(useWorldCoordinates?: boolean, useVerticesNormals?: boolean): Nullable<Vector3>;
  10596. /**
  10597. * Gets the texture coordinates of where the pick occured
  10598. * @returns the vector containing the coordnates of the texture
  10599. */
  10600. getTextureCoordinates(): Nullable<Vector2>;
  10601. }
  10602. }
  10603. declare module "babylonjs/Culling/ray" {
  10604. import { DeepImmutable, Nullable, float } from "babylonjs/types";
  10605. import { Matrix, Vector3 } from "babylonjs/Maths/math.vector";
  10606. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  10607. import { PickingInfo } from "babylonjs/Collisions/pickingInfo";
  10608. import { IntersectionInfo } from "babylonjs/Collisions/intersectionInfo";
  10609. import { BoundingBox } from "babylonjs/Culling/boundingBox";
  10610. import { BoundingSphere } from "babylonjs/Culling/boundingSphere";
  10611. import { Plane } from "babylonjs/Maths/math.plane";
  10612. /**
  10613. * Class representing a ray with position and direction
  10614. */
  10615. export class Ray {
  10616. /** origin point */
  10617. origin: Vector3;
  10618. /** direction */
  10619. direction: Vector3;
  10620. /** length of the ray */
  10621. length: number;
  10622. private static readonly _TmpVector3;
  10623. private _tmpRay;
  10624. /**
  10625. * Creates a new ray
  10626. * @param origin origin point
  10627. * @param direction direction
  10628. * @param length length of the ray
  10629. */
  10630. constructor(
  10631. /** origin point */
  10632. origin: Vector3,
  10633. /** direction */
  10634. direction: Vector3,
  10635. /** length of the ray */
  10636. length?: number);
  10637. /**
  10638. * Checks if the ray intersects a box
  10639. * This does not account for the ray lenght by design to improve perfs.
  10640. * @param minimum bound of the box
  10641. * @param maximum bound of the box
  10642. * @param intersectionTreshold extra extend to be added to the box in all direction
  10643. * @returns if the box was hit
  10644. */
  10645. intersectsBoxMinMax(minimum: DeepImmutable<Vector3>, maximum: DeepImmutable<Vector3>, intersectionTreshold?: number): boolean;
  10646. /**
  10647. * Checks if the ray intersects a box
  10648. * This does not account for the ray lenght by design to improve perfs.
  10649. * @param box the bounding box to check
  10650. * @param intersectionTreshold extra extend to be added to the BoundingBox in all direction
  10651. * @returns if the box was hit
  10652. */
  10653. intersectsBox(box: DeepImmutable<BoundingBox>, intersectionTreshold?: number): boolean;
  10654. /**
  10655. * If the ray hits a sphere
  10656. * @param sphere the bounding sphere to check
  10657. * @param intersectionTreshold extra extend to be added to the BoundingSphere in all direction
  10658. * @returns true if it hits the sphere
  10659. */
  10660. intersectsSphere(sphere: DeepImmutable<BoundingSphere>, intersectionTreshold?: number): boolean;
  10661. /**
  10662. * If the ray hits a triange
  10663. * @param vertex0 triangle vertex
  10664. * @param vertex1 triangle vertex
  10665. * @param vertex2 triangle vertex
  10666. * @returns intersection information if hit
  10667. */
  10668. intersectsTriangle(vertex0: DeepImmutable<Vector3>, vertex1: DeepImmutable<Vector3>, vertex2: DeepImmutable<Vector3>): Nullable<IntersectionInfo>;
  10669. /**
  10670. * Checks if ray intersects a plane
  10671. * @param plane the plane to check
  10672. * @returns the distance away it was hit
  10673. */
  10674. intersectsPlane(plane: DeepImmutable<Plane>): Nullable<number>;
  10675. /**
  10676. * Calculate the intercept of a ray on a given axis
  10677. * @param axis to check 'x' | 'y' | 'z'
  10678. * @param offset from axis interception (i.e. an offset of 1y is intercepted above ground)
  10679. * @returns a vector containing the coordinates where 'axis' is equal to zero (else offset), or null if there is no intercept.
  10680. */
  10681. intersectsAxis(axis: string, offset?: number): Nullable<Vector3>;
  10682. /**
  10683. * Checks if ray intersects a mesh
  10684. * @param mesh the mesh to check
  10685. * @param fastCheck defines if the first intersection will be used (and not the closest)
  10686. * @returns picking info of the intersecton
  10687. */
  10688. intersectsMesh(mesh: DeepImmutable<AbstractMesh>, fastCheck?: boolean): PickingInfo;
  10689. /**
  10690. * Checks if ray intersects a mesh
  10691. * @param meshes the meshes to check
  10692. * @param fastCheck defines if the first intersection will be used (and not the closest)
  10693. * @param results array to store result in
  10694. * @returns Array of picking infos
  10695. */
  10696. intersectsMeshes(meshes: Array<DeepImmutable<AbstractMesh>>, fastCheck?: boolean, results?: Array<PickingInfo>): Array<PickingInfo>;
  10697. private _comparePickingInfo;
  10698. private static smallnum;
  10699. private static rayl;
  10700. /**
  10701. * Intersection test between the ray and a given segment whithin a given tolerance (threshold)
  10702. * @param sega the first point of the segment to test the intersection against
  10703. * @param segb the second point of the segment to test the intersection against
  10704. * @param threshold the tolerance margin, if the ray doesn't intersect the segment but is close to the given threshold, the intersection is successful
  10705. * @return the distance from the ray origin to the intersection point if there's intersection, or -1 if there's no intersection
  10706. */
  10707. intersectionSegment(sega: DeepImmutable<Vector3>, segb: DeepImmutable<Vector3>, threshold: number): number;
  10708. /**
  10709. * Update the ray from viewport position
  10710. * @param x position
  10711. * @param y y position
  10712. * @param viewportWidth viewport width
  10713. * @param viewportHeight viewport height
  10714. * @param world world matrix
  10715. * @param view view matrix
  10716. * @param projection projection matrix
  10717. * @returns this ray updated
  10718. */
  10719. update(x: number, y: number, viewportWidth: number, viewportHeight: number, world: DeepImmutable<Matrix>, view: DeepImmutable<Matrix>, projection: DeepImmutable<Matrix>): Ray;
  10720. /**
  10721. * Creates a ray with origin and direction of 0,0,0
  10722. * @returns the new ray
  10723. */
  10724. static Zero(): Ray;
  10725. /**
  10726. * Creates a new ray from screen space and viewport
  10727. * @param x position
  10728. * @param y y position
  10729. * @param viewportWidth viewport width
  10730. * @param viewportHeight viewport height
  10731. * @param world world matrix
  10732. * @param view view matrix
  10733. * @param projection projection matrix
  10734. * @returns new ray
  10735. */
  10736. static CreateNew(x: number, y: number, viewportWidth: number, viewportHeight: number, world: DeepImmutable<Matrix>, view: DeepImmutable<Matrix>, projection: DeepImmutable<Matrix>): Ray;
  10737. /**
  10738. * Function will create a new transformed ray starting from origin and ending at the end point. Ray's length will be set, and ray will be
  10739. * transformed to the given world matrix.
  10740. * @param origin The origin point
  10741. * @param end The end point
  10742. * @param world a matrix to transform the ray to. Default is the identity matrix.
  10743. * @returns the new ray
  10744. */
  10745. static CreateNewFromTo(origin: Vector3, end: Vector3, world?: DeepImmutable<Matrix>): Ray;
  10746. /**
  10747. * Transforms a ray by a matrix
  10748. * @param ray ray to transform
  10749. * @param matrix matrix to apply
  10750. * @returns the resulting new ray
  10751. */
  10752. static Transform(ray: DeepImmutable<Ray>, matrix: DeepImmutable<Matrix>): Ray;
  10753. /**
  10754. * Transforms a ray by a matrix
  10755. * @param ray ray to transform
  10756. * @param matrix matrix to apply
  10757. * @param result ray to store result in
  10758. */
  10759. static TransformToRef(ray: DeepImmutable<Ray>, matrix: DeepImmutable<Matrix>, result: Ray): void;
  10760. /**
  10761. * Unproject a ray from screen space to object space
  10762. * @param sourceX defines the screen space x coordinate to use
  10763. * @param sourceY defines the screen space y coordinate to use
  10764. * @param viewportWidth defines the current width of the viewport
  10765. * @param viewportHeight defines the current height of the viewport
  10766. * @param world defines the world matrix to use (can be set to Identity to go to world space)
  10767. * @param view defines the view matrix to use
  10768. * @param projection defines the projection matrix to use
  10769. */
  10770. unprojectRayToRef(sourceX: float, sourceY: float, viewportWidth: number, viewportHeight: number, world: DeepImmutable<Matrix>, view: DeepImmutable<Matrix>, projection: DeepImmutable<Matrix>): void;
  10771. }
  10772. /**
  10773. * Type used to define predicate used to select faces when a mesh intersection is detected
  10774. */
  10775. export type TrianglePickingPredicate = (p0: Vector3, p1: Vector3, p2: Vector3, ray: Ray) => boolean;
  10776. module "babylonjs/scene" {
  10777. interface Scene {
  10778. /** @hidden */
  10779. _tempPickingRay: Nullable<Ray>;
  10780. /** @hidden */
  10781. _cachedRayForTransform: Ray;
  10782. /** @hidden */
  10783. _pickWithRayInverseMatrix: Matrix;
  10784. /** @hidden */
  10785. _internalPick(rayFunction: (world: Matrix) => Ray, predicate?: (mesh: AbstractMesh) => boolean, fastCheck?: boolean, onlyBoundingInfo?: boolean, trianglePredicate?: TrianglePickingPredicate): Nullable<PickingInfo>;
  10786. /** @hidden */
  10787. _internalMultiPick(rayFunction: (world: Matrix) => Ray, predicate?: (mesh: AbstractMesh) => boolean, trianglePredicate?: TrianglePickingPredicate): Nullable<PickingInfo[]>;
  10788. /** @hidden */
  10789. _internalPickForMesh(pickingInfo: Nullable<PickingInfo>, rayFunction: (world: Matrix) => Ray, mesh: AbstractMesh, world: Matrix, fastCheck?: boolean, onlyBoundingInfo?: boolean, trianglePredicate?: TrianglePickingPredicate): Nullable<PickingInfo>;
  10790. }
  10791. }
  10792. }
  10793. declare module "babylonjs/sceneComponent" {
  10794. import { Scene } from "babylonjs/scene";
  10795. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  10796. import { SubMesh } from "babylonjs/Meshes/subMesh";
  10797. import { _InstancesBatch } from "babylonjs/Meshes/mesh";
  10798. import { SmartArrayNoDuplicate } from "babylonjs/Misc/smartArray";
  10799. import { Nullable } from "babylonjs/types";
  10800. import { Camera } from "babylonjs/Cameras/camera";
  10801. import { RenderTargetTexture } from "babylonjs/Materials/Textures/renderTargetTexture";
  10802. import { PickingInfo } from "babylonjs/Collisions/pickingInfo";
  10803. import { AbstractScene } from "babylonjs/abstractScene";
  10804. import { Mesh } from "babylonjs/Meshes/mesh";
  10805. /**
  10806. * Groups all the scene component constants in one place to ease maintenance.
  10807. * @hidden
  10808. */
  10809. export class SceneComponentConstants {
  10810. static readonly NAME_EFFECTLAYER: string;
  10811. static readonly NAME_LAYER: string;
  10812. static readonly NAME_LENSFLARESYSTEM: string;
  10813. static readonly NAME_BOUNDINGBOXRENDERER: string;
  10814. static readonly NAME_PARTICLESYSTEM: string;
  10815. static readonly NAME_GAMEPAD: string;
  10816. static readonly NAME_SIMPLIFICATIONQUEUE: string;
  10817. static readonly NAME_GEOMETRYBUFFERRENDERER: string;
  10818. static readonly NAME_PREPASSRENDERER: string;
  10819. static readonly NAME_DEPTHRENDERER: string;
  10820. static readonly NAME_POSTPROCESSRENDERPIPELINEMANAGER: string;
  10821. static readonly NAME_SPRITE: string;
  10822. static readonly NAME_OUTLINERENDERER: string;
  10823. static readonly NAME_PROCEDURALTEXTURE: string;
  10824. static readonly NAME_SHADOWGENERATOR: string;
  10825. static readonly NAME_OCTREE: string;
  10826. static readonly NAME_PHYSICSENGINE: string;
  10827. static readonly NAME_AUDIO: string;
  10828. static readonly STEP_ISREADYFORMESH_EFFECTLAYER: number;
  10829. static readonly STEP_BEFOREEVALUATEACTIVEMESH_BOUNDINGBOXRENDERER: number;
  10830. static readonly STEP_EVALUATESUBMESH_BOUNDINGBOXRENDERER: number;
  10831. static readonly STEP_ACTIVEMESH_BOUNDINGBOXRENDERER: number;
  10832. static readonly STEP_CAMERADRAWRENDERTARGET_EFFECTLAYER: number;
  10833. static readonly STEP_BEFORECAMERADRAW_EFFECTLAYER: number;
  10834. static readonly STEP_BEFORECAMERADRAW_LAYER: number;
  10835. static readonly STEP_BEFORECAMERADRAW_PREPASS: number;
  10836. static readonly STEP_BEFORERENDERTARGETDRAW_LAYER: number;
  10837. static readonly STEP_BEFORERENDERINGMESH_OUTLINE: number;
  10838. static readonly STEP_AFTERRENDERINGMESH_OUTLINE: number;
  10839. static readonly STEP_AFTERRENDERINGGROUPDRAW_EFFECTLAYER_DRAW: number;
  10840. static readonly STEP_AFTERRENDERINGGROUPDRAW_BOUNDINGBOXRENDERER: number;
  10841. static readonly STEP_BEFORECAMERAUPDATE_SIMPLIFICATIONQUEUE: number;
  10842. static readonly STEP_BEFORECAMERAUPDATE_GAMEPAD: number;
  10843. static readonly STEP_BEFORECLEAR_PROCEDURALTEXTURE: number;
  10844. static readonly STEP_AFTERRENDERTARGETDRAW_LAYER: number;
  10845. static readonly STEP_AFTERCAMERADRAW_EFFECTLAYER: number;
  10846. static readonly STEP_AFTERCAMERADRAW_LENSFLARESYSTEM: number;
  10847. static readonly STEP_AFTERCAMERADRAW_EFFECTLAYER_DRAW: number;
  10848. static readonly STEP_AFTERCAMERADRAW_LAYER: number;
  10849. static readonly STEP_AFTERCAMERADRAW_PREPASS: number;
  10850. static readonly STEP_AFTERRENDER_AUDIO: number;
  10851. static readonly STEP_GATHERRENDERTARGETS_DEPTHRENDERER: number;
  10852. static readonly STEP_GATHERRENDERTARGETS_GEOMETRYBUFFERRENDERER: number;
  10853. static readonly STEP_GATHERRENDERTARGETS_SHADOWGENERATOR: number;
  10854. static readonly STEP_GATHERRENDERTARGETS_POSTPROCESSRENDERPIPELINEMANAGER: number;
  10855. static readonly STEP_GATHERACTIVECAMERARENDERTARGETS_DEPTHRENDERER: number;
  10856. static readonly STEP_BEFORECLEARSTAGE_PREPASS: number;
  10857. static readonly STEP_POINTERMOVE_SPRITE: number;
  10858. static readonly STEP_POINTERDOWN_SPRITE: number;
  10859. static readonly STEP_POINTERUP_SPRITE: number;
  10860. }
  10861. /**
  10862. * This represents a scene component.
  10863. *
  10864. * This is used to decouple the dependency the scene is having on the different workloads like
  10865. * layers, post processes...
  10866. */
  10867. export interface ISceneComponent {
  10868. /**
  10869. * The name of the component. Each component must have a unique name.
  10870. */
  10871. name: string;
  10872. /**
  10873. * The scene the component belongs to.
  10874. */
  10875. scene: Scene;
  10876. /**
  10877. * Register the component to one instance of a scene.
  10878. */
  10879. register(): void;
  10880. /**
  10881. * Rebuilds the elements related to this component in case of
  10882. * context lost for instance.
  10883. */
  10884. rebuild(): void;
  10885. /**
  10886. * Disposes the component and the associated ressources.
  10887. */
  10888. dispose(): void;
  10889. }
  10890. /**
  10891. * This represents a SERIALIZABLE scene component.
  10892. *
  10893. * This extends Scene Component to add Serialization methods on top.
  10894. */
  10895. export interface ISceneSerializableComponent extends ISceneComponent {
  10896. /**
  10897. * Adds all the elements from the container to the scene
  10898. * @param container the container holding the elements
  10899. */
  10900. addFromContainer(container: AbstractScene): void;
  10901. /**
  10902. * Removes all the elements in the container from the scene
  10903. * @param container contains the elements to remove
  10904. * @param dispose if the removed element should be disposed (default: false)
  10905. */
  10906. removeFromContainer(container: AbstractScene, dispose?: boolean): void;
  10907. /**
  10908. * Serializes the component data to the specified json object
  10909. * @param serializationObject The object to serialize to
  10910. */
  10911. serialize(serializationObject: any): void;
  10912. }
  10913. /**
  10914. * Strong typing of a Mesh related stage step action
  10915. */
  10916. export type MeshStageAction = (mesh: AbstractMesh, hardwareInstancedRendering: boolean) => boolean;
  10917. /**
  10918. * Strong typing of a Evaluate Sub Mesh related stage step action
  10919. */
  10920. export type EvaluateSubMeshStageAction = (mesh: AbstractMesh, subMesh: SubMesh) => void;
  10921. /**
  10922. * Strong typing of a Active Mesh related stage step action
  10923. */
  10924. export type ActiveMeshStageAction = (sourceMesh: AbstractMesh, mesh: AbstractMesh) => void;
  10925. /**
  10926. * Strong typing of a Camera related stage step action
  10927. */
  10928. export type CameraStageAction = (camera: Camera) => void;
  10929. /**
  10930. * Strong typing of a Camera Frame buffer related stage step action
  10931. */
  10932. export type CameraStageFrameBufferAction = (camera: Camera) => boolean;
  10933. /**
  10934. * Strong typing of a Render Target related stage step action
  10935. */
  10936. export type RenderTargetStageAction = (renderTarget: RenderTargetTexture) => void;
  10937. /**
  10938. * Strong typing of a RenderingGroup related stage step action
  10939. */
  10940. export type RenderingGroupStageAction = (renderingGroupId: number) => void;
  10941. /**
  10942. * Strong typing of a Mesh Render related stage step action
  10943. */
  10944. export type RenderingMeshStageAction = (mesh: Mesh, subMesh: SubMesh, batch: _InstancesBatch) => void;
  10945. /**
  10946. * Strong typing of a simple stage step action
  10947. */
  10948. export type SimpleStageAction = () => void;
  10949. /**
  10950. * Strong typing of a render target action.
  10951. */
  10952. export type RenderTargetsStageAction = (renderTargets: SmartArrayNoDuplicate<RenderTargetTexture>) => void;
  10953. /**
  10954. * Strong typing of a pointer move action.
  10955. */
  10956. export type PointerMoveStageAction = (unTranslatedPointerX: number, unTranslatedPointerY: number, pickResult: Nullable<PickingInfo>, isMeshPicked: boolean, element: HTMLElement) => Nullable<PickingInfo>;
  10957. /**
  10958. * Strong typing of a pointer up/down action.
  10959. */
  10960. export type PointerUpDownStageAction = (unTranslatedPointerX: number, unTranslatedPointerY: number, pickResult: Nullable<PickingInfo>, evt: PointerEvent) => Nullable<PickingInfo>;
  10961. /**
  10962. * Representation of a stage in the scene (Basically a list of ordered steps)
  10963. * @hidden
  10964. */
  10965. export class Stage<T extends Function> extends Array<{
  10966. index: number;
  10967. component: ISceneComponent;
  10968. action: T;
  10969. }> {
  10970. /**
  10971. * Hide ctor from the rest of the world.
  10972. * @param items The items to add.
  10973. */
  10974. private constructor();
  10975. /**
  10976. * Creates a new Stage.
  10977. * @returns A new instance of a Stage
  10978. */
  10979. static Create<T extends Function>(): Stage<T>;
  10980. /**
  10981. * Registers a step in an ordered way in the targeted stage.
  10982. * @param index Defines the position to register the step in
  10983. * @param component Defines the component attached to the step
  10984. * @param action Defines the action to launch during the step
  10985. */
  10986. registerStep(index: number, component: ISceneComponent, action: T): void;
  10987. /**
  10988. * Clears all the steps from the stage.
  10989. */
  10990. clear(): void;
  10991. }
  10992. }
  10993. declare module "babylonjs/Sprites/spriteSceneComponent" {
  10994. import { Nullable } from "babylonjs/types";
  10995. import { Observable } from "babylonjs/Misc/observable";
  10996. import { Scene } from "babylonjs/scene";
  10997. import { Sprite } from "babylonjs/Sprites/sprite";
  10998. import { ISpriteManager } from "babylonjs/Sprites/spriteManager";
  10999. import { Ray } from "babylonjs/Culling/ray";
  11000. import { Camera } from "babylonjs/Cameras/camera";
  11001. import { PickingInfo } from "babylonjs/Collisions/pickingInfo";
  11002. import { ISceneComponent } from "babylonjs/sceneComponent";
  11003. module "babylonjs/scene" {
  11004. interface Scene {
  11005. /** @hidden */
  11006. _pointerOverSprite: Nullable<Sprite>;
  11007. /** @hidden */
  11008. _pickedDownSprite: Nullable<Sprite>;
  11009. /** @hidden */
  11010. _tempSpritePickingRay: Nullable<Ray>;
  11011. /**
  11012. * All of the sprite managers added to this scene
  11013. * @see https://doc.babylonjs.com/babylon101/sprites
  11014. */
  11015. spriteManagers: Array<ISpriteManager>;
  11016. /**
  11017. * An event triggered when sprites rendering is about to start
  11018. * Note: This event can be trigger more than once per frame (because sprites can be rendered by render target textures as well)
  11019. */
  11020. onBeforeSpritesRenderingObservable: Observable<Scene>;
  11021. /**
  11022. * An event triggered when sprites rendering is done
  11023. * Note: This event can be trigger more than once per frame (because sprites can be rendered by render target textures as well)
  11024. */
  11025. onAfterSpritesRenderingObservable: Observable<Scene>;
  11026. /** @hidden */
  11027. _internalPickSprites(ray: Ray, predicate?: (sprite: Sprite) => boolean, fastCheck?: boolean, camera?: Camera): Nullable<PickingInfo>;
  11028. /** Launch a ray to try to pick a sprite in the scene
  11029. * @param x position on screen
  11030. * @param y position on screen
  11031. * @param predicate Predicate function used to determine eligible sprites. Can be set to null. In this case, a sprite must have isPickable set to true
  11032. * @param fastCheck defines if the first intersection will be used (and not the closest)
  11033. * @param camera camera to use for computing the picking ray. Can be set to null. In this case, the scene.activeCamera will be used
  11034. * @returns a PickingInfo
  11035. */
  11036. pickSprite(x: number, y: number, predicate?: (sprite: Sprite) => boolean, fastCheck?: boolean, camera?: Camera): Nullable<PickingInfo>;
  11037. /** Use the given ray to pick a sprite in the scene
  11038. * @param ray The ray (in world space) to use to pick meshes
  11039. * @param predicate Predicate function used to determine eligible sprites. Can be set to null. In this case, a sprite must have isPickable set to true
  11040. * @param fastCheck defines if the first intersection will be used (and not the closest)
  11041. * @param camera camera to use. Can be set to null. In this case, the scene.activeCamera will be used
  11042. * @returns a PickingInfo
  11043. */
  11044. pickSpriteWithRay(ray: Ray, predicate?: (sprite: Sprite) => boolean, fastCheck?: boolean, camera?: Camera): Nullable<PickingInfo>;
  11045. /** @hidden */
  11046. _internalMultiPickSprites(ray: Ray, predicate?: (sprite: Sprite) => boolean, camera?: Camera): Nullable<PickingInfo[]>;
  11047. /** Launch a ray to try to pick sprites in the scene
  11048. * @param x position on screen
  11049. * @param y position on screen
  11050. * @param predicate Predicate function used to determine eligible sprites. Can be set to null. In this case, a sprite must have isPickable set to true
  11051. * @param camera camera to use for computing the picking ray. Can be set to null. In this case, the scene.activeCamera will be used
  11052. * @returns a PickingInfo array
  11053. */
  11054. multiPickSprite(x: number, y: number, predicate?: (sprite: Sprite) => boolean, camera?: Camera): Nullable<PickingInfo[]>;
  11055. /** Use the given ray to pick sprites in the scene
  11056. * @param ray The ray (in world space) to use to pick meshes
  11057. * @param predicate Predicate function used to determine eligible sprites. Can be set to null. In this case, a sprite must have isPickable set to true
  11058. * @param camera camera to use. Can be set to null. In this case, the scene.activeCamera will be used
  11059. * @returns a PickingInfo array
  11060. */
  11061. multiPickSpriteWithRay(ray: Ray, predicate?: (sprite: Sprite) => boolean, camera?: Camera): Nullable<PickingInfo[]>;
  11062. /**
  11063. * Force the sprite under the pointer
  11064. * @param sprite defines the sprite to use
  11065. */
  11066. setPointerOverSprite(sprite: Nullable<Sprite>): void;
  11067. /**
  11068. * Gets the sprite under the pointer
  11069. * @returns a Sprite or null if no sprite is under the pointer
  11070. */
  11071. getPointerOverSprite(): Nullable<Sprite>;
  11072. }
  11073. }
  11074. /**
  11075. * Defines the sprite scene component responsible to manage sprites
  11076. * in a given scene.
  11077. */
  11078. export class SpriteSceneComponent implements ISceneComponent {
  11079. /**
  11080. * The component name helpfull to identify the component in the list of scene components.
  11081. */
  11082. readonly name: string;
  11083. /**
  11084. * The scene the component belongs to.
  11085. */
  11086. scene: Scene;
  11087. /** @hidden */
  11088. private _spritePredicate;
  11089. /**
  11090. * Creates a new instance of the component for the given scene
  11091. * @param scene Defines the scene to register the component in
  11092. */
  11093. constructor(scene: Scene);
  11094. /**
  11095. * Registers the component in a given scene
  11096. */
  11097. register(): void;
  11098. /**
  11099. * Rebuilds the elements related to this component in case of
  11100. * context lost for instance.
  11101. */
  11102. rebuild(): void;
  11103. /**
  11104. * Disposes the component and the associated ressources.
  11105. */
  11106. dispose(): void;
  11107. private _pickSpriteButKeepRay;
  11108. private _pointerMove;
  11109. private _pointerDown;
  11110. private _pointerUp;
  11111. }
  11112. }
  11113. declare module "babylonjs/Shaders/ShadersInclude/fogFragmentDeclaration" {
  11114. /** @hidden */
  11115. export var fogFragmentDeclaration: {
  11116. name: string;
  11117. shader: string;
  11118. };
  11119. }
  11120. declare module "babylonjs/Shaders/ShadersInclude/fogFragment" {
  11121. /** @hidden */
  11122. export var fogFragment: {
  11123. name: string;
  11124. shader: string;
  11125. };
  11126. }
  11127. declare module "babylonjs/Shaders/sprites.fragment" {
  11128. import "babylonjs/Shaders/ShadersInclude/fogFragmentDeclaration";
  11129. import "babylonjs/Shaders/ShadersInclude/fogFragment";
  11130. /** @hidden */
  11131. export var spritesPixelShader: {
  11132. name: string;
  11133. shader: string;
  11134. };
  11135. }
  11136. declare module "babylonjs/Shaders/ShadersInclude/fogVertexDeclaration" {
  11137. /** @hidden */
  11138. export var fogVertexDeclaration: {
  11139. name: string;
  11140. shader: string;
  11141. };
  11142. }
  11143. declare module "babylonjs/Shaders/sprites.vertex" {
  11144. import "babylonjs/Shaders/ShadersInclude/fogVertexDeclaration";
  11145. /** @hidden */
  11146. export var spritesVertexShader: {
  11147. name: string;
  11148. shader: string;
  11149. };
  11150. }
  11151. declare module "babylonjs/Sprites/spriteManager" {
  11152. import { IDisposable, Scene } from "babylonjs/scene";
  11153. import { Nullable } from "babylonjs/types";
  11154. import { Observable } from "babylonjs/Misc/observable";
  11155. import { Sprite } from "babylonjs/Sprites/sprite";
  11156. import { PickingInfo } from "babylonjs/Collisions/pickingInfo";
  11157. import { Camera } from "babylonjs/Cameras/camera";
  11158. import { Texture } from "babylonjs/Materials/Textures/texture";
  11159. import "babylonjs/Shaders/sprites.fragment";
  11160. import "babylonjs/Shaders/sprites.vertex";
  11161. import { Ray } from "babylonjs/Culling/ray";
  11162. /**
  11163. * Defines the minimum interface to fullfil in order to be a sprite manager.
  11164. */
  11165. export interface ISpriteManager extends IDisposable {
  11166. /**
  11167. * Gets manager's name
  11168. */
  11169. name: string;
  11170. /**
  11171. * Restricts the camera to viewing objects with the same layerMask.
  11172. * A camera with a layerMask of 1 will render spriteManager.layerMask & camera.layerMask!== 0
  11173. */
  11174. layerMask: number;
  11175. /**
  11176. * Gets or sets a boolean indicating if the mesh can be picked (by scene.pick for instance or through actions). Default is true
  11177. */
  11178. isPickable: boolean;
  11179. /**
  11180. * Gets the hosting scene
  11181. */
  11182. scene: Scene;
  11183. /**
  11184. * Specifies the rendering group id for this mesh (0 by default)
  11185. * @see https://doc.babylonjs.com/resources/transparency_and_how_meshes_are_rendered#rendering-groups
  11186. */
  11187. renderingGroupId: number;
  11188. /**
  11189. * Defines the list of sprites managed by the manager.
  11190. */
  11191. sprites: Array<Sprite>;
  11192. /**
  11193. * Gets or sets the spritesheet texture
  11194. */
  11195. texture: Texture;
  11196. /** Defines the default width of a cell in the spritesheet */
  11197. cellWidth: number;
  11198. /** Defines the default height of a cell in the spritesheet */
  11199. cellHeight: number;
  11200. /**
  11201. * Tests the intersection of a sprite with a specific ray.
  11202. * @param ray The ray we are sending to test the collision
  11203. * @param camera The camera space we are sending rays in
  11204. * @param predicate A predicate allowing excluding sprites from the list of object to test
  11205. * @param fastCheck defines if the first intersection will be used (and not the closest)
  11206. * @returns picking info or null.
  11207. */
  11208. intersects(ray: Ray, camera: Camera, predicate?: (sprite: Sprite) => boolean, fastCheck?: boolean): Nullable<PickingInfo>;
  11209. /**
  11210. * Intersects the sprites with a ray
  11211. * @param ray defines the ray to intersect with
  11212. * @param camera defines the current active camera
  11213. * @param predicate defines a predicate used to select candidate sprites
  11214. * @returns null if no hit or a PickingInfo array
  11215. */
  11216. multiIntersects(ray: Ray, camera: Camera, predicate?: (sprite: Sprite) => boolean): Nullable<PickingInfo[]>;
  11217. /**
  11218. * Renders the list of sprites on screen.
  11219. */
  11220. render(): void;
  11221. }
  11222. /**
  11223. * Class used to manage multiple sprites on the same spritesheet
  11224. * @see https://doc.babylonjs.com/babylon101/sprites
  11225. */
  11226. export class SpriteManager implements ISpriteManager {
  11227. /** defines the manager's name */
  11228. name: string;
  11229. /** Define the Url to load snippets */
  11230. static SnippetUrl: string;
  11231. /** Snippet ID if the manager was created from the snippet server */
  11232. snippetId: string;
  11233. /** Gets the list of sprites */
  11234. sprites: Sprite[];
  11235. /** Gets or sets the rendering group id (0 by default) */
  11236. renderingGroupId: number;
  11237. /** Gets or sets camera layer mask */
  11238. layerMask: number;
  11239. /** Gets or sets a boolean indicating if the manager must consider scene fog when rendering */
  11240. fogEnabled: boolean;
  11241. /** Gets or sets a boolean indicating if the sprites are pickable */
  11242. isPickable: boolean;
  11243. /** Defines the default width of a cell in the spritesheet */
  11244. cellWidth: number;
  11245. /** Defines the default height of a cell in the spritesheet */
  11246. cellHeight: number;
  11247. /** Associative array from JSON sprite data file */
  11248. private _cellData;
  11249. /** Array of sprite names from JSON sprite data file */
  11250. private _spriteMap;
  11251. /** True when packed cell data from JSON file is ready*/
  11252. private _packedAndReady;
  11253. private _textureContent;
  11254. private _useInstancing;
  11255. /**
  11256. * An event triggered when the manager is disposed.
  11257. */
  11258. onDisposeObservable: Observable<SpriteManager>;
  11259. private _onDisposeObserver;
  11260. /**
  11261. * Callback called when the manager is disposed
  11262. */
  11263. set onDispose(callback: () => void);
  11264. private _capacity;
  11265. private _fromPacked;
  11266. private _spriteTexture;
  11267. private _epsilon;
  11268. private _scene;
  11269. private _vertexData;
  11270. private _buffer;
  11271. private _vertexBuffers;
  11272. private _spriteBuffer;
  11273. private _indexBuffer;
  11274. private _effectBase;
  11275. private _effectFog;
  11276. private _vertexBufferSize;
  11277. /**
  11278. * Gets or sets the unique id of the sprite
  11279. */
  11280. uniqueId: number;
  11281. /**
  11282. * Gets the array of sprites
  11283. */
  11284. get children(): Sprite[];
  11285. /**
  11286. * Gets the hosting scene
  11287. */
  11288. get scene(): Scene;
  11289. /**
  11290. * Gets the capacity of the manager
  11291. */
  11292. get capacity(): number;
  11293. /**
  11294. * Gets or sets the spritesheet texture
  11295. */
  11296. get texture(): Texture;
  11297. set texture(value: Texture);
  11298. private _blendMode;
  11299. /**
  11300. * Blend mode use to render the particle, it can be any of
  11301. * the static Constants.ALPHA_x properties provided in this class.
  11302. * Default value is Constants.ALPHA_COMBINE
  11303. */
  11304. get blendMode(): number;
  11305. set blendMode(blendMode: number);
  11306. /** Disables writing to the depth buffer when rendering the sprites.
  11307. * It can be handy to disable depth writing when using textures without alpha channel
  11308. * and setting some specific blend modes.
  11309. */
  11310. disableDepthWrite: boolean;
  11311. /**
  11312. * Creates a new sprite manager
  11313. * @param name defines the manager's name
  11314. * @param imgUrl defines the sprite sheet url
  11315. * @param capacity defines the maximum allowed number of sprites
  11316. * @param cellSize defines the size of a sprite cell
  11317. * @param scene defines the hosting scene
  11318. * @param epsilon defines the epsilon value to align texture (0.01 by default)
  11319. * @param samplingMode defines the smapling mode to use with spritesheet
  11320. * @param fromPacked set to false; do not alter
  11321. * @param spriteJSON null otherwise a JSON object defining sprite sheet data; do not alter
  11322. */
  11323. constructor(
  11324. /** defines the manager's name */
  11325. name: string, imgUrl: string, capacity: number, cellSize: any, scene: Scene, epsilon?: number, samplingMode?: number, fromPacked?: boolean, spriteJSON?: any | null);
  11326. /**
  11327. * Returns the string "SpriteManager"
  11328. * @returns "SpriteManager"
  11329. */
  11330. getClassName(): string;
  11331. private _makePacked;
  11332. private _appendSpriteVertex;
  11333. private _checkTextureAlpha;
  11334. /**
  11335. * Intersects the sprites with a ray
  11336. * @param ray defines the ray to intersect with
  11337. * @param camera defines the current active camera
  11338. * @param predicate defines a predicate used to select candidate sprites
  11339. * @param fastCheck defines if a fast check only must be done (the first potential sprite is will be used and not the closer)
  11340. * @returns null if no hit or a PickingInfo
  11341. */
  11342. intersects(ray: Ray, camera: Camera, predicate?: (sprite: Sprite) => boolean, fastCheck?: boolean): Nullable<PickingInfo>;
  11343. /**
  11344. * Intersects the sprites with a ray
  11345. * @param ray defines the ray to intersect with
  11346. * @param camera defines the current active camera
  11347. * @param predicate defines a predicate used to select candidate sprites
  11348. * @returns null if no hit or a PickingInfo array
  11349. */
  11350. multiIntersects(ray: Ray, camera: Camera, predicate?: (sprite: Sprite) => boolean): Nullable<PickingInfo[]>;
  11351. /**
  11352. * Render all child sprites
  11353. */
  11354. render(): void;
  11355. /**
  11356. * Release associated resources
  11357. */
  11358. dispose(): void;
  11359. /**
  11360. * Serializes the sprite manager to a JSON object
  11361. * @param serializeTexture defines if the texture must be serialized as well
  11362. * @returns the JSON object
  11363. */
  11364. serialize(serializeTexture?: boolean): any;
  11365. /**
  11366. * Parses a JSON object to create a new sprite manager.
  11367. * @param parsedManager The JSON object to parse
  11368. * @param scene The scene to create the sprite managerin
  11369. * @param rootUrl The root url to use to load external dependencies like texture
  11370. * @returns the new sprite manager
  11371. */
  11372. static Parse(parsedManager: any, scene: Scene, rootUrl: string): SpriteManager;
  11373. /**
  11374. * Creates a sprite manager from a snippet saved in a remote file
  11375. * @param name defines the name of the sprite manager to create (can be null or empty to use the one from the json data)
  11376. * @param url defines the url to load from
  11377. * @param scene defines the hosting scene
  11378. * @param rootUrl defines the root URL to use to load textures and relative dependencies
  11379. * @returns a promise that will resolve to the new sprite manager
  11380. */
  11381. static ParseFromFileAsync(name: Nullable<string>, url: string, scene: Scene, rootUrl?: string): Promise<SpriteManager>;
  11382. /**
  11383. * Creates a sprite manager from a snippet saved by the sprite editor
  11384. * @param snippetId defines the snippet to load (can be set to _BLANK to create a default one)
  11385. * @param scene defines the hosting scene
  11386. * @param rootUrl defines the root URL to use to load textures and relative dependencies
  11387. * @returns a promise that will resolve to the new sprite manager
  11388. */
  11389. static CreateFromSnippetAsync(snippetId: string, scene: Scene, rootUrl?: string): Promise<SpriteManager>;
  11390. }
  11391. }
  11392. declare module "babylonjs/Misc/gradients" {
  11393. import { Color3, Color4 } from "babylonjs/Maths/math.color";
  11394. /** Interface used by value gradients (color, factor, ...) */
  11395. export interface IValueGradient {
  11396. /**
  11397. * Gets or sets the gradient value (between 0 and 1)
  11398. */
  11399. gradient: number;
  11400. }
  11401. /** Class used to store color4 gradient */
  11402. export class ColorGradient implements IValueGradient {
  11403. /**
  11404. * Gets or sets the gradient value (between 0 and 1)
  11405. */
  11406. gradient: number;
  11407. /**
  11408. * Gets or sets first associated color
  11409. */
  11410. color1: Color4;
  11411. /**
  11412. * Gets or sets second associated color
  11413. */
  11414. color2?: Color4 | undefined;
  11415. /**
  11416. * Creates a new color4 gradient
  11417. * @param gradient gets or sets the gradient value (between 0 and 1)
  11418. * @param color1 gets or sets first associated color
  11419. * @param color2 gets or sets first second color
  11420. */
  11421. constructor(
  11422. /**
  11423. * Gets or sets the gradient value (between 0 and 1)
  11424. */
  11425. gradient: number,
  11426. /**
  11427. * Gets or sets first associated color
  11428. */
  11429. color1: Color4,
  11430. /**
  11431. * Gets or sets second associated color
  11432. */
  11433. color2?: Color4 | undefined);
  11434. /**
  11435. * Will get a color picked randomly between color1 and color2.
  11436. * If color2 is undefined then color1 will be used
  11437. * @param result defines the target Color4 to store the result in
  11438. */
  11439. getColorToRef(result: Color4): void;
  11440. }
  11441. /** Class used to store color 3 gradient */
  11442. export class Color3Gradient implements IValueGradient {
  11443. /**
  11444. * Gets or sets the gradient value (between 0 and 1)
  11445. */
  11446. gradient: number;
  11447. /**
  11448. * Gets or sets the associated color
  11449. */
  11450. color: Color3;
  11451. /**
  11452. * Creates a new color3 gradient
  11453. * @param gradient gets or sets the gradient value (between 0 and 1)
  11454. * @param color gets or sets associated color
  11455. */
  11456. constructor(
  11457. /**
  11458. * Gets or sets the gradient value (between 0 and 1)
  11459. */
  11460. gradient: number,
  11461. /**
  11462. * Gets or sets the associated color
  11463. */
  11464. color: Color3);
  11465. }
  11466. /** Class used to store factor gradient */
  11467. export class FactorGradient implements IValueGradient {
  11468. /**
  11469. * Gets or sets the gradient value (between 0 and 1)
  11470. */
  11471. gradient: number;
  11472. /**
  11473. * Gets or sets first associated factor
  11474. */
  11475. factor1: number;
  11476. /**
  11477. * Gets or sets second associated factor
  11478. */
  11479. factor2?: number | undefined;
  11480. /**
  11481. * Creates a new factor gradient
  11482. * @param gradient gets or sets the gradient value (between 0 and 1)
  11483. * @param factor1 gets or sets first associated factor
  11484. * @param factor2 gets or sets second associated factor
  11485. */
  11486. constructor(
  11487. /**
  11488. * Gets or sets the gradient value (between 0 and 1)
  11489. */
  11490. gradient: number,
  11491. /**
  11492. * Gets or sets first associated factor
  11493. */
  11494. factor1: number,
  11495. /**
  11496. * Gets or sets second associated factor
  11497. */
  11498. factor2?: number | undefined);
  11499. /**
  11500. * Will get a number picked randomly between factor1 and factor2.
  11501. * If factor2 is undefined then factor1 will be used
  11502. * @returns the picked number
  11503. */
  11504. getFactor(): number;
  11505. }
  11506. /**
  11507. * Helper used to simplify some generic gradient tasks
  11508. */
  11509. export class GradientHelper {
  11510. /**
  11511. * Gets the current gradient from an array of IValueGradient
  11512. * @param ratio defines the current ratio to get
  11513. * @param gradients defines the array of IValueGradient
  11514. * @param updateFunc defines the callback function used to get the final value from the selected gradients
  11515. */
  11516. static GetCurrentGradient(ratio: number, gradients: IValueGradient[], updateFunc: (current: IValueGradient, next: IValueGradient, scale: number) => void): void;
  11517. }
  11518. }
  11519. declare module "babylonjs/Engines/Extensions/engine.rawTexture" {
  11520. import { Nullable } from "babylonjs/types";
  11521. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  11522. import { Scene } from "babylonjs/scene";
  11523. module "babylonjs/Engines/thinEngine" {
  11524. interface ThinEngine {
  11525. /**
  11526. * Creates a raw texture
  11527. * @param data defines the data to store in the texture
  11528. * @param width defines the width of the texture
  11529. * @param height defines the height of the texture
  11530. * @param format defines the format of the data
  11531. * @param generateMipMaps defines if the engine should generate the mip levels
  11532. * @param invertY defines if data must be stored with Y axis inverted
  11533. * @param samplingMode defines the required sampling mode (Texture.NEAREST_SAMPLINGMODE by default)
  11534. * @param compression defines the compression used (null by default)
  11535. * @param type defines the type fo the data (Engine.TEXTURETYPE_UNSIGNED_INT by default)
  11536. * @returns the raw texture inside an InternalTexture
  11537. */
  11538. createRawTexture(data: Nullable<ArrayBufferView>, width: number, height: number, format: number, generateMipMaps: boolean, invertY: boolean, samplingMode: number, compression: Nullable<string>, type: number): InternalTexture;
  11539. /**
  11540. * Update a raw texture
  11541. * @param texture defines the texture to update
  11542. * @param data defines the data to store in the texture
  11543. * @param format defines the format of the data
  11544. * @param invertY defines if data must be stored with Y axis inverted
  11545. */
  11546. updateRawTexture(texture: Nullable<InternalTexture>, data: Nullable<ArrayBufferView>, format: number, invertY: boolean): void;
  11547. /**
  11548. * Update a raw texture
  11549. * @param texture defines the texture to update
  11550. * @param data defines the data to store in the texture
  11551. * @param format defines the format of the data
  11552. * @param invertY defines if data must be stored with Y axis inverted
  11553. * @param compression defines the compression used (null by default)
  11554. * @param type defines the type fo the data (Engine.TEXTURETYPE_UNSIGNED_INT by default)
  11555. */
  11556. updateRawTexture(texture: Nullable<InternalTexture>, data: Nullable<ArrayBufferView>, format: number, invertY: boolean, compression: Nullable<string>, type: number): void;
  11557. /**
  11558. * Creates a new raw cube texture
  11559. * @param data defines the array of data to use to create each face
  11560. * @param size defines the size of the textures
  11561. * @param format defines the format of the data
  11562. * @param type defines the type of the data (like Engine.TEXTURETYPE_UNSIGNED_INT)
  11563. * @param generateMipMaps defines if the engine should generate the mip levels
  11564. * @param invertY defines if data must be stored with Y axis inverted
  11565. * @param samplingMode defines the required sampling mode (like Texture.NEAREST_SAMPLINGMODE)
  11566. * @param compression defines the compression used (null by default)
  11567. * @returns the cube texture as an InternalTexture
  11568. */
  11569. createRawCubeTexture(data: Nullable<ArrayBufferView[]>, size: number, format: number, type: number, generateMipMaps: boolean, invertY: boolean, samplingMode: number, compression: Nullable<string>): InternalTexture;
  11570. /**
  11571. * Update a raw cube texture
  11572. * @param texture defines the texture to udpdate
  11573. * @param data defines the data to store
  11574. * @param format defines the data format
  11575. * @param type defines the type fo the data (Engine.TEXTURETYPE_UNSIGNED_INT by default)
  11576. * @param invertY defines if data must be stored with Y axis inverted
  11577. */
  11578. updateRawCubeTexture(texture: InternalTexture, data: ArrayBufferView[], format: number, type: number, invertY: boolean): void;
  11579. /**
  11580. * Update a raw cube texture
  11581. * @param texture defines the texture to udpdate
  11582. * @param data defines the data to store
  11583. * @param format defines the data format
  11584. * @param type defines the type fo the data (Engine.TEXTURETYPE_UNSIGNED_INT by default)
  11585. * @param invertY defines if data must be stored with Y axis inverted
  11586. * @param compression defines the compression used (null by default)
  11587. */
  11588. updateRawCubeTexture(texture: InternalTexture, data: ArrayBufferView[], format: number, type: number, invertY: boolean, compression: Nullable<string>): void;
  11589. /**
  11590. * Update a raw cube texture
  11591. * @param texture defines the texture to udpdate
  11592. * @param data defines the data to store
  11593. * @param format defines the data format
  11594. * @param type defines the type fo the data (Engine.TEXTURETYPE_UNSIGNED_INT by default)
  11595. * @param invertY defines if data must be stored with Y axis inverted
  11596. * @param compression defines the compression used (null by default)
  11597. * @param level defines which level of the texture to update
  11598. */
  11599. updateRawCubeTexture(texture: InternalTexture, data: ArrayBufferView[], format: number, type: number, invertY: boolean, compression: Nullable<string>, level: number): void;
  11600. /**
  11601. * Creates a new raw cube texture from a specified url
  11602. * @param url defines the url where the data is located
  11603. * @param scene defines the current scene
  11604. * @param size defines the size of the textures
  11605. * @param format defines the format of the data
  11606. * @param type defines the type fo the data (like Engine.TEXTURETYPE_UNSIGNED_INT)
  11607. * @param noMipmap defines if the engine should avoid generating the mip levels
  11608. * @param callback defines a callback used to extract texture data from loaded data
  11609. * @param mipmapGenerator defines to provide an optional tool to generate mip levels
  11610. * @param onLoad defines a callback called when texture is loaded
  11611. * @param onError defines a callback called if there is an error
  11612. * @returns the cube texture as an InternalTexture
  11613. */
  11614. createRawCubeTextureFromUrl(url: string, scene: Nullable<Scene>, size: number, format: number, type: number, noMipmap: boolean, callback: (ArrayBuffer: ArrayBuffer) => Nullable<ArrayBufferView[]>, mipmapGenerator: Nullable<((faces: ArrayBufferView[]) => ArrayBufferView[][])>, onLoad: Nullable<() => void>, onError: Nullable<(message?: string, exception?: any) => void>): InternalTexture;
  11615. /**
  11616. * Creates a new raw cube texture from a specified url
  11617. * @param url defines the url where the data is located
  11618. * @param scene defines the current scene
  11619. * @param size defines the size of the textures
  11620. * @param format defines the format of the data
  11621. * @param type defines the type fo the data (like Engine.TEXTURETYPE_UNSIGNED_INT)
  11622. * @param noMipmap defines if the engine should avoid generating the mip levels
  11623. * @param callback defines a callback used to extract texture data from loaded data
  11624. * @param mipmapGenerator defines to provide an optional tool to generate mip levels
  11625. * @param onLoad defines a callback called when texture is loaded
  11626. * @param onError defines a callback called if there is an error
  11627. * @param samplingMode defines the required sampling mode (like Texture.NEAREST_SAMPLINGMODE)
  11628. * @param invertY defines if data must be stored with Y axis inverted
  11629. * @returns the cube texture as an InternalTexture
  11630. */
  11631. createRawCubeTextureFromUrl(url: string, scene: Nullable<Scene>, size: number, format: number, type: number, noMipmap: boolean, callback: (ArrayBuffer: ArrayBuffer) => Nullable<ArrayBufferView[]>, mipmapGenerator: Nullable<((faces: ArrayBufferView[]) => ArrayBufferView[][])>, onLoad: Nullable<() => void>, onError: Nullable<(message?: string, exception?: any) => void>, samplingMode: number, invertY: boolean): InternalTexture;
  11632. /**
  11633. * Creates a new raw 3D texture
  11634. * @param data defines the data used to create the texture
  11635. * @param width defines the width of the texture
  11636. * @param height defines the height of the texture
  11637. * @param depth defines the depth of the texture
  11638. * @param format defines the format of the texture
  11639. * @param generateMipMaps defines if the engine must generate mip levels
  11640. * @param invertY defines if data must be stored with Y axis inverted
  11641. * @param samplingMode defines the required sampling mode (like Texture.NEAREST_SAMPLINGMODE)
  11642. * @param compression defines the compressed used (can be null)
  11643. * @param textureType defines the compressed used (can be null)
  11644. * @returns a new raw 3D texture (stored in an InternalTexture)
  11645. */
  11646. createRawTexture3D(data: Nullable<ArrayBufferView>, width: number, height: number, depth: number, format: number, generateMipMaps: boolean, invertY: boolean, samplingMode: number, compression: Nullable<string>, textureType: number): InternalTexture;
  11647. /**
  11648. * Update a raw 3D texture
  11649. * @param texture defines the texture to update
  11650. * @param data defines the data to store
  11651. * @param format defines the data format
  11652. * @param invertY defines if data must be stored with Y axis inverted
  11653. */
  11654. updateRawTexture3D(texture: InternalTexture, data: Nullable<ArrayBufferView>, format: number, invertY: boolean): void;
  11655. /**
  11656. * Update a raw 3D texture
  11657. * @param texture defines the texture to update
  11658. * @param data defines the data to store
  11659. * @param format defines the data format
  11660. * @param invertY defines if data must be stored with Y axis inverted
  11661. * @param compression defines the used compression (can be null)
  11662. * @param textureType defines the texture Type (Engine.TEXTURETYPE_UNSIGNED_INT, Engine.TEXTURETYPE_FLOAT...)
  11663. */
  11664. updateRawTexture3D(texture: InternalTexture, data: Nullable<ArrayBufferView>, format: number, invertY: boolean, compression: Nullable<string>, textureType: number): void;
  11665. /**
  11666. * Creates a new raw 2D array texture
  11667. * @param data defines the data used to create the texture
  11668. * @param width defines the width of the texture
  11669. * @param height defines the height of the texture
  11670. * @param depth defines the number of layers of the texture
  11671. * @param format defines the format of the texture
  11672. * @param generateMipMaps defines if the engine must generate mip levels
  11673. * @param invertY defines if data must be stored with Y axis inverted
  11674. * @param samplingMode defines the required sampling mode (like Texture.NEAREST_SAMPLINGMODE)
  11675. * @param compression defines the compressed used (can be null)
  11676. * @param textureType defines the compressed used (can be null)
  11677. * @returns a new raw 2D array texture (stored in an InternalTexture)
  11678. */
  11679. createRawTexture2DArray(data: Nullable<ArrayBufferView>, width: number, height: number, depth: number, format: number, generateMipMaps: boolean, invertY: boolean, samplingMode: number, compression: Nullable<string>, textureType: number): InternalTexture;
  11680. /**
  11681. * Update a raw 2D array texture
  11682. * @param texture defines the texture to update
  11683. * @param data defines the data to store
  11684. * @param format defines the data format
  11685. * @param invertY defines if data must be stored with Y axis inverted
  11686. */
  11687. updateRawTexture2DArray(texture: InternalTexture, data: Nullable<ArrayBufferView>, format: number, invertY: boolean): void;
  11688. /**
  11689. * Update a raw 2D array texture
  11690. * @param texture defines the texture to update
  11691. * @param data defines the data to store
  11692. * @param format defines the data format
  11693. * @param invertY defines if data must be stored with Y axis inverted
  11694. * @param compression defines the used compression (can be null)
  11695. * @param textureType defines the texture Type (Engine.TEXTURETYPE_UNSIGNED_INT, Engine.TEXTURETYPE_FLOAT...)
  11696. */
  11697. updateRawTexture2DArray(texture: InternalTexture, data: Nullable<ArrayBufferView>, format: number, invertY: boolean, compression: Nullable<string>, textureType: number): void;
  11698. }
  11699. }
  11700. }
  11701. declare module "babylonjs/Materials/Textures/rawTexture" {
  11702. import { Texture } from "babylonjs/Materials/Textures/texture";
  11703. import "babylonjs/Engines/Extensions/engine.rawTexture";
  11704. import { Nullable } from "babylonjs/types";
  11705. import { ThinEngine } from "babylonjs/Engines/thinEngine";
  11706. import { Scene } from "babylonjs/scene";
  11707. /**
  11708. * Raw texture can help creating a texture directly from an array of data.
  11709. * This can be super useful if you either get the data from an uncompressed source or
  11710. * if you wish to create your texture pixel by pixel.
  11711. */
  11712. export class RawTexture extends Texture {
  11713. /**
  11714. * Define the format of the data (RGB, RGBA... Engine.TEXTUREFORMAT_xxx)
  11715. */
  11716. format: number;
  11717. /**
  11718. * Instantiates a new RawTexture.
  11719. * Raw texture can help creating a texture directly from an array of data.
  11720. * This can be super useful if you either get the data from an uncompressed source or
  11721. * if you wish to create your texture pixel by pixel.
  11722. * @param data define the array of data to use to create the texture
  11723. * @param width define the width of the texture
  11724. * @param height define the height of the texture
  11725. * @param format define the format of the data (RGB, RGBA... Engine.TEXTUREFORMAT_xxx)
  11726. * @param sceneOrEngine defines the scene or engine the texture will belong to
  11727. * @param generateMipMaps define whether mip maps should be generated or not
  11728. * @param invertY define if the data should be flipped on Y when uploaded to the GPU
  11729. * @param samplingMode define the texture sampling mode (Texture.xxx_SAMPLINGMODE)
  11730. * @param type define the format of the data (int, float... Engine.TEXTURETYPE_xxx)
  11731. */
  11732. constructor(data: ArrayBufferView, width: number, height: number,
  11733. /**
  11734. * Define the format of the data (RGB, RGBA... Engine.TEXTUREFORMAT_xxx)
  11735. */
  11736. format: number, sceneOrEngine: Nullable<Scene | ThinEngine>, generateMipMaps?: boolean, invertY?: boolean, samplingMode?: number, type?: number);
  11737. /**
  11738. * Updates the texture underlying data.
  11739. * @param data Define the new data of the texture
  11740. */
  11741. update(data: ArrayBufferView): void;
  11742. /**
  11743. * Creates a luminance texture from some data.
  11744. * @param data Define the texture data
  11745. * @param width Define the width of the texture
  11746. * @param height Define the height of the texture
  11747. * @param sceneOrEngine defines the scene or engine the texture will belong to
  11748. * @param generateMipMaps Define whether or not to create mip maps for the texture
  11749. * @param invertY define if the data should be flipped on Y when uploaded to the GPU
  11750. * @param samplingMode define the texture sampling mode (Texture.xxx_SAMPLINGMODE)
  11751. * @returns the luminance texture
  11752. */
  11753. static CreateLuminanceTexture(data: ArrayBufferView, width: number, height: number, sceneOrEngine: Nullable<Scene | ThinEngine>, generateMipMaps?: boolean, invertY?: boolean, samplingMode?: number): RawTexture;
  11754. /**
  11755. * Creates a luminance alpha texture from some data.
  11756. * @param data Define the texture data
  11757. * @param width Define the width of the texture
  11758. * @param height Define the height of the texture
  11759. * @param sceneOrEngine defines the scene or engine the texture will belong to
  11760. * @param generateMipMaps Define whether or not to create mip maps for the texture
  11761. * @param invertY define if the data should be flipped on Y when uploaded to the GPU
  11762. * @param samplingMode define the texture sampling mode (Texture.xxx_SAMPLINGMODE)
  11763. * @returns the luminance alpha texture
  11764. */
  11765. static CreateLuminanceAlphaTexture(data: ArrayBufferView, width: number, height: number, sceneOrEngine: Nullable<Scene | ThinEngine>, generateMipMaps?: boolean, invertY?: boolean, samplingMode?: number): RawTexture;
  11766. /**
  11767. * Creates an alpha texture from some data.
  11768. * @param data Define the texture data
  11769. * @param width Define the width of the texture
  11770. * @param height Define the height of the texture
  11771. * @param sceneOrEngine defines the scene or engine the texture will belong to
  11772. * @param generateMipMaps Define whether or not to create mip maps for the texture
  11773. * @param invertY define if the data should be flipped on Y when uploaded to the GPU
  11774. * @param samplingMode define the texture sampling mode (Texture.xxx_SAMPLINGMODE)
  11775. * @returns the alpha texture
  11776. */
  11777. static CreateAlphaTexture(data: ArrayBufferView, width: number, height: number, sceneOrEngine: Nullable<Scene | ThinEngine>, generateMipMaps?: boolean, invertY?: boolean, samplingMode?: number): RawTexture;
  11778. /**
  11779. * Creates a RGB texture from some data.
  11780. * @param data Define the texture data
  11781. * @param width Define the width of the texture
  11782. * @param height Define the height of the texture
  11783. * @param sceneOrEngine defines the scene or engine the texture will belong to
  11784. * @param generateMipMaps Define whether or not to create mip maps for the texture
  11785. * @param invertY define if the data should be flipped on Y when uploaded to the GPU
  11786. * @param samplingMode define the texture sampling mode (Texture.xxx_SAMPLINGMODE)
  11787. * @param type define the format of the data (int, float... Engine.TEXTURETYPE_xxx)
  11788. * @returns the RGB alpha texture
  11789. */
  11790. static CreateRGBTexture(data: ArrayBufferView, width: number, height: number, sceneOrEngine: Nullable<Scene | ThinEngine>, generateMipMaps?: boolean, invertY?: boolean, samplingMode?: number, type?: number): RawTexture;
  11791. /**
  11792. * Creates a RGBA texture from some data.
  11793. * @param data Define the texture data
  11794. * @param width Define the width of the texture
  11795. * @param height Define the height of the texture
  11796. * @param sceneOrEngine defines the scene or engine the texture will belong to
  11797. * @param generateMipMaps Define whether or not to create mip maps for the texture
  11798. * @param invertY define if the data should be flipped on Y when uploaded to the GPU
  11799. * @param samplingMode define the texture sampling mode (Texture.xxx_SAMPLINGMODE)
  11800. * @param type define the format of the data (int, float... Engine.TEXTURETYPE_xxx)
  11801. * @returns the RGBA texture
  11802. */
  11803. static CreateRGBATexture(data: ArrayBufferView, width: number, height: number, sceneOrEngine: Nullable<Scene | ThinEngine>, generateMipMaps?: boolean, invertY?: boolean, samplingMode?: number, type?: number): RawTexture;
  11804. /**
  11805. * Creates a R texture from some data.
  11806. * @param data Define the texture data
  11807. * @param width Define the width of the texture
  11808. * @param height Define the height of the texture
  11809. * @param sceneOrEngine defines the scene or engine the texture will belong to
  11810. * @param generateMipMaps Define whether or not to create mip maps for the texture
  11811. * @param invertY define if the data should be flipped on Y when uploaded to the GPU
  11812. * @param samplingMode define the texture sampling mode (Texture.xxx_SAMPLINGMODE)
  11813. * @param type define the format of the data (int, float... Engine.TEXTURETYPE_xxx)
  11814. * @returns the R texture
  11815. */
  11816. static CreateRTexture(data: ArrayBufferView, width: number, height: number, sceneOrEngine: Nullable<Scene | ThinEngine>, generateMipMaps?: boolean, invertY?: boolean, samplingMode?: number, type?: number): RawTexture;
  11817. }
  11818. }
  11819. declare module "babylonjs/Engines/Extensions/engine.dynamicBuffer" {
  11820. import { DataBuffer } from "babylonjs/Meshes/dataBuffer";
  11821. import { IndicesArray, DataArray } from "babylonjs/types";
  11822. module "babylonjs/Engines/thinEngine" {
  11823. interface ThinEngine {
  11824. /**
  11825. * Update a dynamic index buffer
  11826. * @param indexBuffer defines the target index buffer
  11827. * @param indices defines the data to update
  11828. * @param offset defines the offset in the target index buffer where update should start
  11829. */
  11830. updateDynamicIndexBuffer(indexBuffer: DataBuffer, indices: IndicesArray, offset?: number): void;
  11831. /**
  11832. * Updates a dynamic vertex buffer.
  11833. * @param vertexBuffer the vertex buffer to update
  11834. * @param data the data used to update the vertex buffer
  11835. * @param byteOffset the byte offset of the data
  11836. * @param byteLength the byte length of the data
  11837. */
  11838. updateDynamicVertexBuffer(vertexBuffer: DataBuffer, data: DataArray, byteOffset?: number, byteLength?: number): void;
  11839. }
  11840. }
  11841. }
  11842. declare module "babylonjs/Materials/Textures/Procedurals/proceduralTextureSceneComponent" {
  11843. import { Scene } from "babylonjs/scene";
  11844. import { ISceneComponent } from "babylonjs/sceneComponent";
  11845. import { ProceduralTexture } from "babylonjs/Materials/Textures/Procedurals/proceduralTexture";
  11846. module "babylonjs/abstractScene" {
  11847. interface AbstractScene {
  11848. /**
  11849. * The list of procedural textures added to the scene
  11850. * @see https://doc.babylonjs.com/how_to/how_to_use_procedural_textures
  11851. */
  11852. proceduralTextures: Array<ProceduralTexture>;
  11853. }
  11854. }
  11855. /**
  11856. * Defines the Procedural Texture scene component responsible to manage any Procedural Texture
  11857. * in a given scene.
  11858. */
  11859. export class ProceduralTextureSceneComponent implements ISceneComponent {
  11860. /**
  11861. * The component name helpfull to identify the component in the list of scene components.
  11862. */
  11863. readonly name: string;
  11864. /**
  11865. * The scene the component belongs to.
  11866. */
  11867. scene: Scene;
  11868. /**
  11869. * Creates a new instance of the component for the given scene
  11870. * @param scene Defines the scene to register the component in
  11871. */
  11872. constructor(scene: Scene);
  11873. /**
  11874. * Registers the component in a given scene
  11875. */
  11876. register(): void;
  11877. /**
  11878. * Rebuilds the elements related to this component in case of
  11879. * context lost for instance.
  11880. */
  11881. rebuild(): void;
  11882. /**
  11883. * Disposes the component and the associated ressources.
  11884. */
  11885. dispose(): void;
  11886. private _beforeClear;
  11887. }
  11888. }
  11889. declare module "babylonjs/Engines/Extensions/engine.renderTargetCube" {
  11890. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  11891. import { RenderTargetCreationOptions } from "babylonjs/Materials/Textures/renderTargetCreationOptions";
  11892. module "babylonjs/Engines/thinEngine" {
  11893. interface ThinEngine {
  11894. /**
  11895. * Creates a new render target cube texture
  11896. * @param size defines the size of the texture
  11897. * @param options defines the options used to create the texture
  11898. * @returns a new render target cube texture stored in an InternalTexture
  11899. */
  11900. createRenderTargetCubeTexture(size: number, options?: Partial<RenderTargetCreationOptions>): InternalTexture;
  11901. }
  11902. }
  11903. }
  11904. declare module "babylonjs/Shaders/procedural.vertex" {
  11905. /** @hidden */
  11906. export var proceduralVertexShader: {
  11907. name: string;
  11908. shader: string;
  11909. };
  11910. }
  11911. declare module "babylonjs/Materials/Textures/Procedurals/proceduralTexture" {
  11912. import { Observable } from "babylonjs/Misc/observable";
  11913. import { Nullable } from "babylonjs/types";
  11914. import { Scene } from "babylonjs/scene";
  11915. import { Matrix, Vector3, Vector2 } from "babylonjs/Maths/math.vector";
  11916. import { Color4, Color3 } from "babylonjs/Maths/math.color";
  11917. import { Effect } from "babylonjs/Materials/effect";
  11918. import { Texture } from "babylonjs/Materials/Textures/texture";
  11919. import "babylonjs/Engines/Extensions/engine.renderTarget";
  11920. import "babylonjs/Engines/Extensions/engine.renderTargetCube";
  11921. import "babylonjs/Shaders/procedural.vertex";
  11922. /**
  11923. * Procedural texturing is a way to programmatically create a texture. There are 2 types of procedural textures: code-only, and code that references some classic 2D images, sometimes calmpler' images.
  11924. * This is the base class of any Procedural texture and contains most of the shareable code.
  11925. * @see https://doc.babylonjs.com/how_to/how_to_use_procedural_textures
  11926. */
  11927. export class ProceduralTexture extends Texture {
  11928. /**
  11929. * Define if the texture is enabled or not (disabled texture will not render)
  11930. */
  11931. isEnabled: boolean;
  11932. /**
  11933. * Define if the texture must be cleared before rendering (default is true)
  11934. */
  11935. autoClear: boolean;
  11936. /**
  11937. * Callback called when the texture is generated
  11938. */
  11939. onGenerated: () => void;
  11940. /**
  11941. * Event raised when the texture is generated
  11942. */
  11943. onGeneratedObservable: Observable<ProceduralTexture>;
  11944. /** @hidden */
  11945. _generateMipMaps: boolean;
  11946. /** @hidden **/
  11947. _effect: Effect;
  11948. /** @hidden */
  11949. _textures: {
  11950. [key: string]: Texture;
  11951. };
  11952. /** @hidden */
  11953. protected _fallbackTexture: Nullable<Texture>;
  11954. private _size;
  11955. private _currentRefreshId;
  11956. private _frameId;
  11957. private _refreshRate;
  11958. private _vertexBuffers;
  11959. private _indexBuffer;
  11960. private _uniforms;
  11961. private _samplers;
  11962. private _fragment;
  11963. private _floats;
  11964. private _ints;
  11965. private _floatsArrays;
  11966. private _colors3;
  11967. private _colors4;
  11968. private _vectors2;
  11969. private _vectors3;
  11970. private _matrices;
  11971. private _fallbackTextureUsed;
  11972. private _fullEngine;
  11973. private _cachedDefines;
  11974. private _contentUpdateId;
  11975. private _contentData;
  11976. /**
  11977. * Instantiates a new procedural texture.
  11978. * Procedural texturing is a way to programmatically create a texture. There are 2 types of procedural textures: code-only, and code that references some classic 2D images, sometimes called 'refMaps' or 'sampler' images.
  11979. * This is the base class of any Procedural texture and contains most of the shareable code.
  11980. * @see https://doc.babylonjs.com/how_to/how_to_use_procedural_textures
  11981. * @param name Define the name of the texture
  11982. * @param size Define the size of the texture to create
  11983. * @param fragment Define the fragment shader to use to generate the texture or null if it is defined later
  11984. * @param scene Define the scene the texture belongs to
  11985. * @param fallbackTexture Define a fallback texture in case there were issues to create the custom texture
  11986. * @param generateMipMaps Define if the texture should creates mip maps or not
  11987. * @param isCube Define if the texture is a cube texture or not (this will render each faces of the cube)
  11988. */
  11989. constructor(name: string, size: any, fragment: any, scene: Nullable<Scene>, fallbackTexture?: Nullable<Texture>, generateMipMaps?: boolean, isCube?: boolean);
  11990. /**
  11991. * The effect that is created when initializing the post process.
  11992. * @returns The created effect corresponding the the postprocess.
  11993. */
  11994. getEffect(): Effect;
  11995. /**
  11996. * Gets texture content (Use this function wisely as reading from a texture can be slow)
  11997. * @returns an ArrayBufferView (Uint8Array or Float32Array)
  11998. */
  11999. getContent(): Nullable<ArrayBufferView>;
  12000. private _createIndexBuffer;
  12001. /** @hidden */
  12002. _rebuild(): void;
  12003. /**
  12004. * Resets the texture in order to recreate its associated resources.
  12005. * This can be called in case of context loss
  12006. */
  12007. reset(): void;
  12008. protected _getDefines(): string;
  12009. /**
  12010. * Is the texture ready to be used ? (rendered at least once)
  12011. * @returns true if ready, otherwise, false.
  12012. */
  12013. isReady(): boolean;
  12014. /**
  12015. * Resets the refresh counter of the texture and start bak from scratch.
  12016. * Could be useful to regenerate the texture if it is setup to render only once.
  12017. */
  12018. resetRefreshCounter(): void;
  12019. /**
  12020. * Set the fragment shader to use in order to render the texture.
  12021. * @param fragment This can be set to a path (into the shader store) or to a json object containing a fragmentElement property.
  12022. */
  12023. setFragment(fragment: any): void;
  12024. /**
  12025. * Define the refresh rate of the texture or the rendering frequency.
  12026. * Use 0 to render just once, 1 to render on every frame, 2 to render every two frames and so on...
  12027. */
  12028. get refreshRate(): number;
  12029. set refreshRate(value: number);
  12030. /** @hidden */
  12031. _shouldRender(): boolean;
  12032. /**
  12033. * Get the size the texture is rendering at.
  12034. * @returns the size (texture is always squared)
  12035. */
  12036. getRenderSize(): number;
  12037. /**
  12038. * Resize the texture to new value.
  12039. * @param size Define the new size the texture should have
  12040. * @param generateMipMaps Define whether the new texture should create mip maps
  12041. */
  12042. resize(size: number, generateMipMaps: boolean): void;
  12043. private _checkUniform;
  12044. /**
  12045. * Set a texture in the shader program used to render.
  12046. * @param name Define the name of the uniform samplers as defined in the shader
  12047. * @param texture Define the texture to bind to this sampler
  12048. * @return the texture itself allowing "fluent" like uniform updates
  12049. */
  12050. setTexture(name: string, texture: Texture): ProceduralTexture;
  12051. /**
  12052. * Set a float in the shader.
  12053. * @param name Define the name of the uniform as defined in the shader
  12054. * @param value Define the value to give to the uniform
  12055. * @return the texture itself allowing "fluent" like uniform updates
  12056. */
  12057. setFloat(name: string, value: number): ProceduralTexture;
  12058. /**
  12059. * Set a int in the shader.
  12060. * @param name Define the name of the uniform as defined in the shader
  12061. * @param value Define the value to give to the uniform
  12062. * @return the texture itself allowing "fluent" like uniform updates
  12063. */
  12064. setInt(name: string, value: number): ProceduralTexture;
  12065. /**
  12066. * Set an array of floats in the shader.
  12067. * @param name Define the name of the uniform as defined in the shader
  12068. * @param value Define the value to give to the uniform
  12069. * @return the texture itself allowing "fluent" like uniform updates
  12070. */
  12071. setFloats(name: string, value: number[]): ProceduralTexture;
  12072. /**
  12073. * Set a vec3 in the shader from a Color3.
  12074. * @param name Define the name of the uniform as defined in the shader
  12075. * @param value Define the value to give to the uniform
  12076. * @return the texture itself allowing "fluent" like uniform updates
  12077. */
  12078. setColor3(name: string, value: Color3): ProceduralTexture;
  12079. /**
  12080. * Set a vec4 in the shader from a Color4.
  12081. * @param name Define the name of the uniform as defined in the shader
  12082. * @param value Define the value to give to the uniform
  12083. * @return the texture itself allowing "fluent" like uniform updates
  12084. */
  12085. setColor4(name: string, value: Color4): ProceduralTexture;
  12086. /**
  12087. * Set a vec2 in the shader from a Vector2.
  12088. * @param name Define the name of the uniform as defined in the shader
  12089. * @param value Define the value to give to the uniform
  12090. * @return the texture itself allowing "fluent" like uniform updates
  12091. */
  12092. setVector2(name: string, value: Vector2): ProceduralTexture;
  12093. /**
  12094. * Set a vec3 in the shader from a Vector3.
  12095. * @param name Define the name of the uniform as defined in the shader
  12096. * @param value Define the value to give to the uniform
  12097. * @return the texture itself allowing "fluent" like uniform updates
  12098. */
  12099. setVector3(name: string, value: Vector3): ProceduralTexture;
  12100. /**
  12101. * Set a mat4 in the shader from a MAtrix.
  12102. * @param name Define the name of the uniform as defined in the shader
  12103. * @param value Define the value to give to the uniform
  12104. * @return the texture itself allowing "fluent" like uniform updates
  12105. */
  12106. setMatrix(name: string, value: Matrix): ProceduralTexture;
  12107. /**
  12108. * Render the texture to its associated render target.
  12109. * @param useCameraPostProcess Define if camera post process should be applied to the texture
  12110. */
  12111. render(useCameraPostProcess?: boolean): void;
  12112. /**
  12113. * Clone the texture.
  12114. * @returns the cloned texture
  12115. */
  12116. clone(): ProceduralTexture;
  12117. /**
  12118. * Dispose the texture and release its asoociated resources.
  12119. */
  12120. dispose(): void;
  12121. }
  12122. }
  12123. declare module "babylonjs/Particles/baseParticleSystem" {
  12124. import { Nullable } from "babylonjs/types";
  12125. import { Vector2, Vector3 } from "babylonjs/Maths/math.vector";
  12126. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  12127. import { ImageProcessingConfiguration, ImageProcessingConfigurationDefines } from "babylonjs/Materials/imageProcessingConfiguration";
  12128. import { ColorGradient, FactorGradient, Color3Gradient, IValueGradient } from "babylonjs/Misc/gradients";
  12129. import { BoxParticleEmitter, IParticleEmitterType, PointParticleEmitter, HemisphericParticleEmitter, SphereParticleEmitter, SphereDirectedParticleEmitter, CylinderParticleEmitter, CylinderDirectedParticleEmitter, ConeParticleEmitter } from "babylonjs/Particles/EmitterTypes/index";
  12130. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  12131. import { Color4 } from "babylonjs/Maths/math.color";
  12132. import { ThinEngine } from "babylonjs/Engines/thinEngine";
  12133. import "babylonjs/Engines/Extensions/engine.dynamicBuffer";
  12134. import { Animation } from "babylonjs/Animations/animation";
  12135. import { Scene } from "babylonjs/scene";
  12136. import { ProceduralTexture } from "babylonjs/Materials/Textures/Procedurals/proceduralTexture";
  12137. import { RawTexture } from "babylonjs/Materials/Textures/rawTexture";
  12138. /**
  12139. * This represents the base class for particle system in Babylon.
  12140. * Particles are often small sprites used to simulate hard-to-reproduce phenomena like fire, smoke, water, or abstract visual effects like magic glitter and faery dust.
  12141. * Particles can take different shapes while emitted like box, sphere, cone or you can write your custom function.
  12142. * @example https://doc.babylonjs.com/babylon101/particles
  12143. */
  12144. export class BaseParticleSystem {
  12145. /**
  12146. * Source color is added to the destination color without alpha affecting the result
  12147. */
  12148. static BLENDMODE_ONEONE: number;
  12149. /**
  12150. * Blend current color and particle color using particle’s alpha
  12151. */
  12152. static BLENDMODE_STANDARD: number;
  12153. /**
  12154. * Add current color and particle color multiplied by particle’s alpha
  12155. */
  12156. static BLENDMODE_ADD: number;
  12157. /**
  12158. * Multiply current color with particle color
  12159. */
  12160. static BLENDMODE_MULTIPLY: number;
  12161. /**
  12162. * Multiply current color with particle color then add current color and particle color multiplied by particle’s alpha
  12163. */
  12164. static BLENDMODE_MULTIPLYADD: number;
  12165. /**
  12166. * List of animations used by the particle system.
  12167. */
  12168. animations: Animation[];
  12169. /**
  12170. * Gets or sets the unique id of the particle system
  12171. */
  12172. uniqueId: number;
  12173. /**
  12174. * The id of the Particle system.
  12175. */
  12176. id: string;
  12177. /**
  12178. * The friendly name of the Particle system.
  12179. */
  12180. name: string;
  12181. /**
  12182. * Snippet ID if the particle system was created from the snippet server
  12183. */
  12184. snippetId: string;
  12185. /**
  12186. * The rendering group used by the Particle system to chose when to render.
  12187. */
  12188. renderingGroupId: number;
  12189. /**
  12190. * The emitter represents the Mesh or position we are attaching the particle system to.
  12191. */
  12192. emitter: Nullable<AbstractMesh | Vector3>;
  12193. /**
  12194. * The maximum number of particles to emit per frame
  12195. */
  12196. emitRate: number;
  12197. /**
  12198. * If you want to launch only a few particles at once, that can be done, as well.
  12199. */
  12200. manualEmitCount: number;
  12201. /**
  12202. * The overall motion speed (0.01 is default update speed, faster updates = faster animation)
  12203. */
  12204. updateSpeed: number;
  12205. /**
  12206. * The amount of time the particle system is running (depends of the overall update speed).
  12207. */
  12208. targetStopDuration: number;
  12209. /**
  12210. * Specifies whether the particle system will be disposed once it reaches the end of the animation.
  12211. */
  12212. disposeOnStop: boolean;
  12213. /**
  12214. * Minimum power of emitting particles.
  12215. */
  12216. minEmitPower: number;
  12217. /**
  12218. * Maximum power of emitting particles.
  12219. */
  12220. maxEmitPower: number;
  12221. /**
  12222. * Minimum life time of emitting particles.
  12223. */
  12224. minLifeTime: number;
  12225. /**
  12226. * Maximum life time of emitting particles.
  12227. */
  12228. maxLifeTime: number;
  12229. /**
  12230. * Minimum Size of emitting particles.
  12231. */
  12232. minSize: number;
  12233. /**
  12234. * Maximum Size of emitting particles.
  12235. */
  12236. maxSize: number;
  12237. /**
  12238. * Minimum scale of emitting particles on X axis.
  12239. */
  12240. minScaleX: number;
  12241. /**
  12242. * Maximum scale of emitting particles on X axis.
  12243. */
  12244. maxScaleX: number;
  12245. /**
  12246. * Minimum scale of emitting particles on Y axis.
  12247. */
  12248. minScaleY: number;
  12249. /**
  12250. * Maximum scale of emitting particles on Y axis.
  12251. */
  12252. maxScaleY: number;
  12253. /**
  12254. * Gets or sets the minimal initial rotation in radians.
  12255. */
  12256. minInitialRotation: number;
  12257. /**
  12258. * Gets or sets the maximal initial rotation in radians.
  12259. */
  12260. maxInitialRotation: number;
  12261. /**
  12262. * Minimum angular speed of emitting particles (Z-axis rotation for each particle).
  12263. */
  12264. minAngularSpeed: number;
  12265. /**
  12266. * Maximum angular speed of emitting particles (Z-axis rotation for each particle).
  12267. */
  12268. maxAngularSpeed: number;
  12269. /**
  12270. * The texture used to render each particle. (this can be a spritesheet)
  12271. */
  12272. particleTexture: Nullable<BaseTexture>;
  12273. /**
  12274. * The layer mask we are rendering the particles through.
  12275. */
  12276. layerMask: number;
  12277. /**
  12278. * This can help using your own shader to render the particle system.
  12279. * The according effect will be created
  12280. */
  12281. customShader: any;
  12282. /**
  12283. * By default particle system starts as soon as they are created. This prevents the
  12284. * automatic start to happen and let you decide when to start emitting particles.
  12285. */
  12286. preventAutoStart: boolean;
  12287. private _noiseTexture;
  12288. /**
  12289. * Gets or sets a texture used to add random noise to particle positions
  12290. */
  12291. get noiseTexture(): Nullable<ProceduralTexture>;
  12292. set noiseTexture(value: Nullable<ProceduralTexture>);
  12293. /** Gets or sets the strength to apply to the noise value (default is (10, 10, 10)) */
  12294. noiseStrength: Vector3;
  12295. /**
  12296. * Callback triggered when the particle animation is ending.
  12297. */
  12298. onAnimationEnd: Nullable<() => void>;
  12299. /**
  12300. * Blend mode use to render the particle, it can be either ParticleSystem.BLENDMODE_ONEONE or ParticleSystem.BLENDMODE_STANDARD.
  12301. */
  12302. blendMode: number;
  12303. /**
  12304. * Forces the particle to write their depth information to the depth buffer. This can help preventing other draw calls
  12305. * to override the particles.
  12306. */
  12307. forceDepthWrite: boolean;
  12308. /** Gets or sets a value indicating how many cycles (or frames) must be executed before first rendering (this value has to be set before starting the system). Default is 0 */
  12309. preWarmCycles: number;
  12310. /** Gets or sets a value indicating the time step multiplier to use in pre-warm mode (default is 1) */
  12311. preWarmStepOffset: number;
  12312. /**
  12313. * If using a spritesheet (isAnimationSheetEnabled) defines the speed of the sprite loop (default is 1 meaning the animation will play once during the entire particle lifetime)
  12314. */
  12315. spriteCellChangeSpeed: number;
  12316. /**
  12317. * If using a spritesheet (isAnimationSheetEnabled) defines the first sprite cell to display
  12318. */
  12319. startSpriteCellID: number;
  12320. /**
  12321. * If using a spritesheet (isAnimationSheetEnabled) defines the last sprite cell to display
  12322. */
  12323. endSpriteCellID: number;
  12324. /**
  12325. * If using a spritesheet (isAnimationSheetEnabled), defines the sprite cell width to use
  12326. */
  12327. spriteCellWidth: number;
  12328. /**
  12329. * If using a spritesheet (isAnimationSheetEnabled), defines the sprite cell height to use
  12330. */
  12331. spriteCellHeight: number;
  12332. /**
  12333. * This allows the system to random pick the start cell ID between startSpriteCellID and endSpriteCellID
  12334. */
  12335. spriteRandomStartCell: boolean;
  12336. /** Gets or sets a Vector2 used to move the pivot (by default (0,0)) */
  12337. translationPivot: Vector2;
  12338. /** @hidden */
  12339. protected _isAnimationSheetEnabled: boolean;
  12340. /**
  12341. * Gets or sets a boolean indicating that hosted animations (in the system.animations array) must be started when system.start() is called
  12342. */
  12343. beginAnimationOnStart: boolean;
  12344. /**
  12345. * Gets or sets the frame to start the animation from when beginAnimationOnStart is true
  12346. */
  12347. beginAnimationFrom: number;
  12348. /**
  12349. * Gets or sets the frame to end the animation on when beginAnimationOnStart is true
  12350. */
  12351. beginAnimationTo: number;
  12352. /**
  12353. * Gets or sets a boolean indicating if animations must loop when beginAnimationOnStart is true
  12354. */
  12355. beginAnimationLoop: boolean;
  12356. /**
  12357. * Gets or sets a world offset applied to all particles
  12358. */
  12359. worldOffset: Vector3;
  12360. /**
  12361. * Gets or sets whether an animation sprite sheet is enabled or not on the particle system
  12362. */
  12363. get isAnimationSheetEnabled(): boolean;
  12364. set isAnimationSheetEnabled(value: boolean);
  12365. /**
  12366. * Get hosting scene
  12367. * @returns the scene
  12368. */
  12369. getScene(): Nullable<Scene>;
  12370. /**
  12371. * You can use gravity if you want to give an orientation to your particles.
  12372. */
  12373. gravity: Vector3;
  12374. protected _colorGradients: Nullable<Array<ColorGradient>>;
  12375. protected _sizeGradients: Nullable<Array<FactorGradient>>;
  12376. protected _lifeTimeGradients: Nullable<Array<FactorGradient>>;
  12377. protected _angularSpeedGradients: Nullable<Array<FactorGradient>>;
  12378. protected _velocityGradients: Nullable<Array<FactorGradient>>;
  12379. protected _limitVelocityGradients: Nullable<Array<FactorGradient>>;
  12380. protected _dragGradients: Nullable<Array<FactorGradient>>;
  12381. protected _emitRateGradients: Nullable<Array<FactorGradient>>;
  12382. protected _startSizeGradients: Nullable<Array<FactorGradient>>;
  12383. protected _rampGradients: Nullable<Array<Color3Gradient>>;
  12384. protected _colorRemapGradients: Nullable<Array<FactorGradient>>;
  12385. protected _alphaRemapGradients: Nullable<Array<FactorGradient>>;
  12386. protected _hasTargetStopDurationDependantGradient(): boolean | null;
  12387. /**
  12388. * Defines the delay in milliseconds before starting the system (0 by default)
  12389. */
  12390. startDelay: number;
  12391. /**
  12392. * Gets the current list of drag gradients.
  12393. * You must use addDragGradient and removeDragGradient to udpate this list
  12394. * @returns the list of drag gradients
  12395. */
  12396. getDragGradients(): Nullable<Array<FactorGradient>>;
  12397. /** Gets or sets a value indicating the damping to apply if the limit velocity factor is reached */
  12398. limitVelocityDamping: number;
  12399. /**
  12400. * Gets the current list of limit velocity gradients.
  12401. * You must use addLimitVelocityGradient and removeLimitVelocityGradient to udpate this list
  12402. * @returns the list of limit velocity gradients
  12403. */
  12404. getLimitVelocityGradients(): Nullable<Array<FactorGradient>>;
  12405. /**
  12406. * Gets the current list of color gradients.
  12407. * You must use addColorGradient and removeColorGradient to udpate this list
  12408. * @returns the list of color gradients
  12409. */
  12410. getColorGradients(): Nullable<Array<ColorGradient>>;
  12411. /**
  12412. * Gets the current list of size gradients.
  12413. * You must use addSizeGradient and removeSizeGradient to udpate this list
  12414. * @returns the list of size gradients
  12415. */
  12416. getSizeGradients(): Nullable<Array<FactorGradient>>;
  12417. /**
  12418. * Gets the current list of color remap gradients.
  12419. * You must use addColorRemapGradient and removeColorRemapGradient to udpate this list
  12420. * @returns the list of color remap gradients
  12421. */
  12422. getColorRemapGradients(): Nullable<Array<FactorGradient>>;
  12423. /**
  12424. * Gets the current list of alpha remap gradients.
  12425. * You must use addAlphaRemapGradient and removeAlphaRemapGradient to udpate this list
  12426. * @returns the list of alpha remap gradients
  12427. */
  12428. getAlphaRemapGradients(): Nullable<Array<FactorGradient>>;
  12429. /**
  12430. * Gets the current list of life time gradients.
  12431. * You must use addLifeTimeGradient and removeLifeTimeGradient to udpate this list
  12432. * @returns the list of life time gradients
  12433. */
  12434. getLifeTimeGradients(): Nullable<Array<FactorGradient>>;
  12435. /**
  12436. * Gets the current list of angular speed gradients.
  12437. * You must use addAngularSpeedGradient and removeAngularSpeedGradient to udpate this list
  12438. * @returns the list of angular speed gradients
  12439. */
  12440. getAngularSpeedGradients(): Nullable<Array<FactorGradient>>;
  12441. /**
  12442. * Gets the current list of velocity gradients.
  12443. * You must use addVelocityGradient and removeVelocityGradient to udpate this list
  12444. * @returns the list of velocity gradients
  12445. */
  12446. getVelocityGradients(): Nullable<Array<FactorGradient>>;
  12447. /**
  12448. * Gets the current list of start size gradients.
  12449. * You must use addStartSizeGradient and removeStartSizeGradient to udpate this list
  12450. * @returns the list of start size gradients
  12451. */
  12452. getStartSizeGradients(): Nullable<Array<FactorGradient>>;
  12453. /**
  12454. * Gets the current list of emit rate gradients.
  12455. * You must use addEmitRateGradient and removeEmitRateGradient to udpate this list
  12456. * @returns the list of emit rate gradients
  12457. */
  12458. getEmitRateGradients(): Nullable<Array<FactorGradient>>;
  12459. /**
  12460. * Random direction of each particle after it has been emitted, between direction1 and direction2 vectors.
  12461. * This only works when particleEmitterTyps is a BoxParticleEmitter
  12462. */
  12463. get direction1(): Vector3;
  12464. set direction1(value: Vector3);
  12465. /**
  12466. * Random direction of each particle after it has been emitted, between direction1 and direction2 vectors.
  12467. * This only works when particleEmitterTyps is a BoxParticleEmitter
  12468. */
  12469. get direction2(): Vector3;
  12470. set direction2(value: Vector3);
  12471. /**
  12472. * Minimum box point around our emitter. Our emitter is the center of particles source, but if you want your particles to emit from more than one point, then you can tell it to do so.
  12473. * This only works when particleEmitterTyps is a BoxParticleEmitter
  12474. */
  12475. get minEmitBox(): Vector3;
  12476. set minEmitBox(value: Vector3);
  12477. /**
  12478. * Maximum box point around our emitter. Our emitter is the center of particles source, but if you want your particles to emit from more than one point, then you can tell it to do so.
  12479. * This only works when particleEmitterTyps is a BoxParticleEmitter
  12480. */
  12481. get maxEmitBox(): Vector3;
  12482. set maxEmitBox(value: Vector3);
  12483. /**
  12484. * Random color of each particle after it has been emitted, between color1 and color2 vectors
  12485. */
  12486. color1: Color4;
  12487. /**
  12488. * Random color of each particle after it has been emitted, between color1 and color2 vectors
  12489. */
  12490. color2: Color4;
  12491. /**
  12492. * Color the particle will have at the end of its lifetime
  12493. */
  12494. colorDead: Color4;
  12495. /**
  12496. * An optional mask to filter some colors out of the texture, or filter a part of the alpha channel
  12497. */
  12498. textureMask: Color4;
  12499. /**
  12500. * The particle emitter type defines the emitter used by the particle system.
  12501. * It can be for example box, sphere, or cone...
  12502. */
  12503. particleEmitterType: IParticleEmitterType;
  12504. /** @hidden */
  12505. _isSubEmitter: boolean;
  12506. /**
  12507. * Gets or sets the billboard mode to use when isBillboardBased = true.
  12508. * Value can be: ParticleSystem.BILLBOARDMODE_ALL, ParticleSystem.BILLBOARDMODE_Y, ParticleSystem.BILLBOARDMODE_STRETCHED
  12509. */
  12510. billboardMode: number;
  12511. protected _isBillboardBased: boolean;
  12512. /**
  12513. * Gets or sets a boolean indicating if the particles must be rendered as billboard or aligned with the direction
  12514. */
  12515. get isBillboardBased(): boolean;
  12516. set isBillboardBased(value: boolean);
  12517. /**
  12518. * The scene the particle system belongs to.
  12519. */
  12520. protected _scene: Nullable<Scene>;
  12521. /**
  12522. * The engine the particle system belongs to.
  12523. */
  12524. protected _engine: ThinEngine;
  12525. /**
  12526. * Local cache of defines for image processing.
  12527. */
  12528. protected _imageProcessingConfigurationDefines: ImageProcessingConfigurationDefines;
  12529. /**
  12530. * Default configuration related to image processing available in the standard Material.
  12531. */
  12532. protected _imageProcessingConfiguration: Nullable<ImageProcessingConfiguration>;
  12533. /**
  12534. * Gets the image processing configuration used either in this material.
  12535. */
  12536. get imageProcessingConfiguration(): Nullable<ImageProcessingConfiguration>;
  12537. /**
  12538. * Sets the Default image processing configuration used either in the this material.
  12539. *
  12540. * If sets to null, the scene one is in use.
  12541. */
  12542. set imageProcessingConfiguration(value: Nullable<ImageProcessingConfiguration>);
  12543. /**
  12544. * Attaches a new image processing configuration to the Standard Material.
  12545. * @param configuration
  12546. */
  12547. protected _attachImageProcessingConfiguration(configuration: Nullable<ImageProcessingConfiguration>): void;
  12548. /** @hidden */
  12549. protected _reset(): void;
  12550. /** @hidden */
  12551. protected _removeGradientAndTexture(gradient: number, gradients: Nullable<IValueGradient[]>, texture: Nullable<RawTexture>): BaseParticleSystem;
  12552. /**
  12553. * Instantiates a particle system.
  12554. * Particles are often small sprites used to simulate hard-to-reproduce phenomena like fire, smoke, water, or abstract visual effects like magic glitter and faery dust.
  12555. * @param name The name of the particle system
  12556. */
  12557. constructor(name: string);
  12558. /**
  12559. * Creates a Point Emitter for the particle system (emits directly from the emitter position)
  12560. * @param direction1 Particles are emitted between the direction1 and direction2 from within the box
  12561. * @param direction2 Particles are emitted between the direction1 and direction2 from within the box
  12562. * @returns the emitter
  12563. */
  12564. createPointEmitter(direction1: Vector3, direction2: Vector3): PointParticleEmitter;
  12565. /**
  12566. * Creates a Hemisphere Emitter for the particle system (emits along the hemisphere radius)
  12567. * @param radius The radius of the hemisphere to emit from
  12568. * @param radiusRange The range of the hemisphere to emit from [0-1] 0 Surface Only, 1 Entire Radius
  12569. * @returns the emitter
  12570. */
  12571. createHemisphericEmitter(radius?: number, radiusRange?: number): HemisphericParticleEmitter;
  12572. /**
  12573. * Creates a Sphere Emitter for the particle system (emits along the sphere radius)
  12574. * @param radius The radius of the sphere to emit from
  12575. * @param radiusRange The range of the sphere to emit from [0-1] 0 Surface Only, 1 Entire Radius
  12576. * @returns the emitter
  12577. */
  12578. createSphereEmitter(radius?: number, radiusRange?: number): SphereParticleEmitter;
  12579. /**
  12580. * Creates a Directed Sphere Emitter for the particle system (emits between direction1 and direction2)
  12581. * @param radius The radius of the sphere to emit from
  12582. * @param direction1 Particles are emitted between the direction1 and direction2 from within the sphere
  12583. * @param direction2 Particles are emitted between the direction1 and direction2 from within the sphere
  12584. * @returns the emitter
  12585. */
  12586. createDirectedSphereEmitter(radius?: number, direction1?: Vector3, direction2?: Vector3): SphereDirectedParticleEmitter;
  12587. /**
  12588. * Creates a Cylinder Emitter for the particle system (emits from the cylinder to the particle position)
  12589. * @param radius The radius of the emission cylinder
  12590. * @param height The height of the emission cylinder
  12591. * @param radiusRange The range of emission [0-1] 0 Surface only, 1 Entire Radius
  12592. * @param directionRandomizer How much to randomize the particle direction [0-1]
  12593. * @returns the emitter
  12594. */
  12595. createCylinderEmitter(radius?: number, height?: number, radiusRange?: number, directionRandomizer?: number): CylinderParticleEmitter;
  12596. /**
  12597. * Creates a Directed Cylinder Emitter for the particle system (emits between direction1 and direction2)
  12598. * @param radius The radius of the cylinder to emit from
  12599. * @param height The height of the emission cylinder
  12600. * @param radiusRange the range of the emission cylinder [0-1] 0 Surface only, 1 Entire Radius (1 by default)
  12601. * @param direction1 Particles are emitted between the direction1 and direction2 from within the cylinder
  12602. * @param direction2 Particles are emitted between the direction1 and direction2 from within the cylinder
  12603. * @returns the emitter
  12604. */
  12605. createDirectedCylinderEmitter(radius?: number, height?: number, radiusRange?: number, direction1?: Vector3, direction2?: Vector3): CylinderDirectedParticleEmitter;
  12606. /**
  12607. * Creates a Cone Emitter for the particle system (emits from the cone to the particle position)
  12608. * @param radius The radius of the cone to emit from
  12609. * @param angle The base angle of the cone
  12610. * @returns the emitter
  12611. */
  12612. createConeEmitter(radius?: number, angle?: number): ConeParticleEmitter;
  12613. /**
  12614. * Creates a Box Emitter for the particle system. (emits between direction1 and direction2 from withing the box defined by minEmitBox and maxEmitBox)
  12615. * @param direction1 Particles are emitted between the direction1 and direction2 from within the box
  12616. * @param direction2 Particles are emitted between the direction1 and direction2 from within the box
  12617. * @param minEmitBox Particles are emitted from the box between minEmitBox and maxEmitBox
  12618. * @param maxEmitBox Particles are emitted from the box between minEmitBox and maxEmitBox
  12619. * @returns the emitter
  12620. */
  12621. createBoxEmitter(direction1: Vector3, direction2: Vector3, minEmitBox: Vector3, maxEmitBox: Vector3): BoxParticleEmitter;
  12622. }
  12623. }
  12624. declare module "babylonjs/Particles/subEmitter" {
  12625. import { ThinEngine } from "babylonjs/Engines/thinEngine";
  12626. import { Scene } from "babylonjs/scene";
  12627. import { ParticleSystem } from "babylonjs/Particles/particleSystem";
  12628. /**
  12629. * Type of sub emitter
  12630. */
  12631. export enum SubEmitterType {
  12632. /**
  12633. * Attached to the particle over it's lifetime
  12634. */
  12635. ATTACHED = 0,
  12636. /**
  12637. * Created when the particle dies
  12638. */
  12639. END = 1
  12640. }
  12641. /**
  12642. * Sub emitter class used to emit particles from an existing particle
  12643. */
  12644. export class SubEmitter {
  12645. /**
  12646. * the particle system to be used by the sub emitter
  12647. */
  12648. particleSystem: ParticleSystem;
  12649. /**
  12650. * Type of the submitter (Default: END)
  12651. */
  12652. type: SubEmitterType;
  12653. /**
  12654. * If the particle should inherit the direction from the particle it's attached to. (+Y will face the direction the particle is moving) (Default: false)
  12655. * Note: This only is supported when using an emitter of type Mesh
  12656. */
  12657. inheritDirection: boolean;
  12658. /**
  12659. * How much of the attached particles speed should be added to the sub emitted particle (default: 0)
  12660. */
  12661. inheritedVelocityAmount: number;
  12662. /**
  12663. * Creates a sub emitter
  12664. * @param particleSystem the particle system to be used by the sub emitter
  12665. */
  12666. constructor(
  12667. /**
  12668. * the particle system to be used by the sub emitter
  12669. */
  12670. particleSystem: ParticleSystem);
  12671. /**
  12672. * Clones the sub emitter
  12673. * @returns the cloned sub emitter
  12674. */
  12675. clone(): SubEmitter;
  12676. /**
  12677. * Serialize current object to a JSON object
  12678. * @returns the serialized object
  12679. */
  12680. serialize(): any;
  12681. /** @hidden */
  12682. static _ParseParticleSystem(system: any, sceneOrEngine: Scene | ThinEngine, rootUrl: string): ParticleSystem;
  12683. /**
  12684. * Creates a new SubEmitter from a serialized JSON version
  12685. * @param serializationObject defines the JSON object to read from
  12686. * @param sceneOrEngine defines the hosting scene or the hosting engine
  12687. * @param rootUrl defines the rootUrl for data loading
  12688. * @returns a new SubEmitter
  12689. */
  12690. static Parse(serializationObject: any, sceneOrEngine: Scene | ThinEngine, rootUrl: string): SubEmitter;
  12691. /** Release associated resources */
  12692. dispose(): void;
  12693. }
  12694. }
  12695. declare module "babylonjs/Shaders/ShadersInclude/imageProcessingDeclaration" {
  12696. /** @hidden */
  12697. export var imageProcessingDeclaration: {
  12698. name: string;
  12699. shader: string;
  12700. };
  12701. }
  12702. declare module "babylonjs/Shaders/ShadersInclude/imageProcessingFunctions" {
  12703. /** @hidden */
  12704. export var imageProcessingFunctions: {
  12705. name: string;
  12706. shader: string;
  12707. };
  12708. }
  12709. declare module "babylonjs/Shaders/particles.fragment" {
  12710. import "babylonjs/Shaders/ShadersInclude/clipPlaneFragmentDeclaration";
  12711. import "babylonjs/Shaders/ShadersInclude/imageProcessingDeclaration";
  12712. import "babylonjs/Shaders/ShadersInclude/helperFunctions";
  12713. import "babylonjs/Shaders/ShadersInclude/imageProcessingFunctions";
  12714. import "babylonjs/Shaders/ShadersInclude/clipPlaneFragment";
  12715. /** @hidden */
  12716. export var particlesPixelShader: {
  12717. name: string;
  12718. shader: string;
  12719. };
  12720. }
  12721. declare module "babylonjs/Shaders/particles.vertex" {
  12722. import "babylonjs/Shaders/ShadersInclude/clipPlaneVertexDeclaration";
  12723. import "babylonjs/Shaders/ShadersInclude/clipPlaneVertex";
  12724. /** @hidden */
  12725. export var particlesVertexShader: {
  12726. name: string;
  12727. shader: string;
  12728. };
  12729. }
  12730. declare module "babylonjs/Misc/interfaces/iClipPlanesHolder" {
  12731. import { Nullable } from "babylonjs/types";
  12732. import { Plane } from "babylonjs/Maths/math";
  12733. /**
  12734. * Interface used to define entities containing multiple clip planes
  12735. */
  12736. export interface IClipPlanesHolder {
  12737. /**
  12738. * Gets or sets the active clipplane 1
  12739. */
  12740. clipPlane: Nullable<Plane>;
  12741. /**
  12742. * Gets or sets the active clipplane 2
  12743. */
  12744. clipPlane2: Nullable<Plane>;
  12745. /**
  12746. * Gets or sets the active clipplane 3
  12747. */
  12748. clipPlane3: Nullable<Plane>;
  12749. /**
  12750. * Gets or sets the active clipplane 4
  12751. */
  12752. clipPlane4: Nullable<Plane>;
  12753. /**
  12754. * Gets or sets the active clipplane 5
  12755. */
  12756. clipPlane5: Nullable<Plane>;
  12757. /**
  12758. * Gets or sets the active clipplane 6
  12759. */
  12760. clipPlane6: Nullable<Plane>;
  12761. }
  12762. }
  12763. declare module "babylonjs/Materials/thinMaterialHelper" {
  12764. import { Effect } from "babylonjs/Materials/effect";
  12765. import { IClipPlanesHolder } from "babylonjs/Misc/interfaces/iClipPlanesHolder";
  12766. /**
  12767. * "Static Class" containing a few commonly used helper while dealing with material for rendering purpose.
  12768. *
  12769. * It is complementary with MaterialHelper but provides completely independent functions (for tree shaking sake)
  12770. *
  12771. * This works by convention in BabylonJS but is meant to be use only with shader following the in place naming rules and conventions.
  12772. */
  12773. export class ThinMaterialHelper {
  12774. /**
  12775. * Binds the clip plane information from the holder to the effect.
  12776. * @param effect The effect we are binding the data to
  12777. * @param holder The entity containing the clip plane information
  12778. */
  12779. static BindClipPlane(effect: Effect, holder: IClipPlanesHolder): void;
  12780. }
  12781. }
  12782. declare module "babylonjs/Engines/Extensions/engine.alpha" {
  12783. module "babylonjs/Engines/thinEngine" {
  12784. interface ThinEngine {
  12785. /**
  12786. * Sets alpha constants used by some alpha blending modes
  12787. * @param r defines the red component
  12788. * @param g defines the green component
  12789. * @param b defines the blue component
  12790. * @param a defines the alpha component
  12791. */
  12792. setAlphaConstants(r: number, g: number, b: number, a: number): void;
  12793. /**
  12794. * Sets the current alpha mode
  12795. * @param mode defines the mode to use (one of the Engine.ALPHA_XXX)
  12796. * @param noDepthWriteChange defines if depth writing state should remains unchanged (false by default)
  12797. * @see https://doc.babylonjs.com/resources/transparency_and_how_meshes_are_rendered
  12798. */
  12799. setAlphaMode(mode: number, noDepthWriteChange?: boolean): void;
  12800. /**
  12801. * Gets the current alpha mode
  12802. * @see https://doc.babylonjs.com/resources/transparency_and_how_meshes_are_rendered
  12803. * @returns the current alpha mode
  12804. */
  12805. getAlphaMode(): number;
  12806. /**
  12807. * Sets the current alpha equation
  12808. * @param equation defines the equation to use (one of the Engine.ALPHA_EQUATION_XXX)
  12809. */
  12810. setAlphaEquation(equation: number): void;
  12811. /**
  12812. * Gets the current alpha equation.
  12813. * @returns the current alpha equation
  12814. */
  12815. getAlphaEquation(): number;
  12816. }
  12817. }
  12818. }
  12819. declare module "babylonjs/Particles/particleSystem" {
  12820. import { Nullable } from "babylonjs/types";
  12821. import { FactorGradient, Color3Gradient } from "babylonjs/Misc/gradients";
  12822. import { Observable } from "babylonjs/Misc/observable";
  12823. import { Vector3, Matrix } from "babylonjs/Maths/math.vector";
  12824. import { Effect } from "babylonjs/Materials/effect";
  12825. import { IDisposable } from "babylonjs/scene";
  12826. import { IParticleSystem } from "babylonjs/Particles/IParticleSystem";
  12827. import { BaseParticleSystem } from "babylonjs/Particles/baseParticleSystem";
  12828. import { Particle } from "babylonjs/Particles/particle";
  12829. import { SubEmitter } from "babylonjs/Particles/subEmitter";
  12830. import { IAnimatable } from "babylonjs/Animations/animatable.interface";
  12831. import "babylonjs/Shaders/particles.fragment";
  12832. import "babylonjs/Shaders/particles.vertex";
  12833. import { Color4, Color3 } from "babylonjs/Maths/math.color";
  12834. import { ThinEngine } from "babylonjs/Engines/thinEngine";
  12835. import "babylonjs/Engines/Extensions/engine.alpha";
  12836. import { Scene } from "babylonjs/scene";
  12837. /**
  12838. * This represents a particle system in Babylon.
  12839. * Particles are often small sprites used to simulate hard-to-reproduce phenomena like fire, smoke, water, or abstract visual effects like magic glitter and faery dust.
  12840. * Particles can take different shapes while emitted like box, sphere, cone or you can write your custom function.
  12841. * @example https://doc.babylonjs.com/babylon101/particles
  12842. */
  12843. export class ParticleSystem extends BaseParticleSystem implements IDisposable, IAnimatable, IParticleSystem {
  12844. /**
  12845. * Billboard mode will only apply to Y axis
  12846. */
  12847. static readonly BILLBOARDMODE_Y: number;
  12848. /**
  12849. * Billboard mode will apply to all axes
  12850. */
  12851. static readonly BILLBOARDMODE_ALL: number;
  12852. /**
  12853. * Special billboard mode where the particle will be biilboard to the camera but rotated to align with direction
  12854. */
  12855. static readonly BILLBOARDMODE_STRETCHED: number;
  12856. /**
  12857. * This function can be defined to provide custom update for active particles.
  12858. * This function will be called instead of regular update (age, position, color, etc.).
  12859. * Do not forget that this function will be called on every frame so try to keep it simple and fast :)
  12860. */
  12861. updateFunction: (particles: Particle[]) => void;
  12862. private _emitterWorldMatrix;
  12863. /**
  12864. * This function can be defined to specify initial direction for every new particle.
  12865. * It by default use the emitterType defined function
  12866. */
  12867. startDirectionFunction: (worldMatrix: Matrix, directionToUpdate: Vector3, particle: Particle, isLocal: boolean) => void;
  12868. /**
  12869. * This function can be defined to specify initial position for every new particle.
  12870. * It by default use the emitterType defined function
  12871. */
  12872. startPositionFunction: (worldMatrix: Matrix, positionToUpdate: Vector3, particle: Particle, isLocal: boolean) => void;
  12873. /**
  12874. * @hidden
  12875. */
  12876. _inheritedVelocityOffset: Vector3;
  12877. /**
  12878. * An event triggered when the system is disposed
  12879. */
  12880. onDisposeObservable: Observable<IParticleSystem>;
  12881. private _onDisposeObserver;
  12882. /**
  12883. * Sets a callback that will be triggered when the system is disposed
  12884. */
  12885. set onDispose(callback: () => void);
  12886. private _particles;
  12887. private _epsilon;
  12888. private _capacity;
  12889. private _stockParticles;
  12890. private _newPartsExcess;
  12891. private _vertexData;
  12892. private _vertexBuffer;
  12893. private _vertexBuffers;
  12894. private _spriteBuffer;
  12895. private _indexBuffer;
  12896. private _effect;
  12897. private _customEffect;
  12898. private _cachedDefines;
  12899. private _scaledColorStep;
  12900. private _colorDiff;
  12901. private _scaledDirection;
  12902. private _scaledGravity;
  12903. private _currentRenderId;
  12904. private _alive;
  12905. private _useInstancing;
  12906. private _started;
  12907. private _stopped;
  12908. private _actualFrame;
  12909. private _scaledUpdateSpeed;
  12910. private _vertexBufferSize;
  12911. /** @hidden */
  12912. _currentEmitRateGradient: Nullable<FactorGradient>;
  12913. /** @hidden */
  12914. _currentEmitRate1: number;
  12915. /** @hidden */
  12916. _currentEmitRate2: number;
  12917. /** @hidden */
  12918. _currentStartSizeGradient: Nullable<FactorGradient>;
  12919. /** @hidden */
  12920. _currentStartSize1: number;
  12921. /** @hidden */
  12922. _currentStartSize2: number;
  12923. private readonly _rawTextureWidth;
  12924. private _rampGradientsTexture;
  12925. private _useRampGradients;
  12926. /** Gets or sets a matrix to use to compute projection */
  12927. defaultProjectionMatrix: Matrix;
  12928. /** Gets or sets a matrix to use to compute view */
  12929. defaultViewMatrix: Matrix;
  12930. /** Gets or sets a boolean indicating that ramp gradients must be used
  12931. * @see https://doc.babylonjs.com/babylon101/particles#ramp-gradients
  12932. */
  12933. get useRampGradients(): boolean;
  12934. set useRampGradients(value: boolean);
  12935. /**
  12936. * The Sub-emitters templates that will be used to generate the sub particle system to be associated with the system, this property is used by the root particle system only.
  12937. * When a particle is spawned, an array will be chosen at random and all the emitters in that array will be attached to the particle. (Default: [])
  12938. */
  12939. subEmitters: Array<ParticleSystem | SubEmitter | Array<SubEmitter>>;
  12940. private _subEmitters;
  12941. /**
  12942. * @hidden
  12943. * If the particle systems emitter should be disposed when the particle system is disposed
  12944. */
  12945. _disposeEmitterOnDispose: boolean;
  12946. /**
  12947. * The current active Sub-systems, this property is used by the root particle system only.
  12948. */
  12949. activeSubSystems: Array<ParticleSystem>;
  12950. /**
  12951. * Specifies if the particles are updated in emitter local space or world space
  12952. */
  12953. isLocal: boolean;
  12954. private _rootParticleSystem;
  12955. /**
  12956. * Gets the current list of active particles
  12957. */
  12958. get particles(): Particle[];
  12959. /**
  12960. * Gets the number of particles active at the same time.
  12961. * @returns The number of active particles.
  12962. */
  12963. getActiveCount(): number;
  12964. /**
  12965. * Returns the string "ParticleSystem"
  12966. * @returns a string containing the class name
  12967. */
  12968. getClassName(): string;
  12969. /**
  12970. * Gets a boolean indicating that the system is stopping
  12971. * @returns true if the system is currently stopping
  12972. */
  12973. isStopping(): boolean;
  12974. /**
  12975. * Gets the custom effect used to render the particles
  12976. * @param blendMode Blend mode for which the effect should be retrieved
  12977. * @returns The effect
  12978. */
  12979. getCustomEffect(blendMode?: number): Nullable<Effect>;
  12980. /**
  12981. * Sets the custom effect used to render the particles
  12982. * @param effect The effect to set
  12983. * @param blendMode Blend mode for which the effect should be set
  12984. */
  12985. setCustomEffect(effect: Nullable<Effect>, blendMode?: number): void;
  12986. /** @hidden */
  12987. private _onBeforeDrawParticlesObservable;
  12988. /**
  12989. * Observable that will be called just before the particles are drawn
  12990. */
  12991. get onBeforeDrawParticlesObservable(): Observable<Nullable<Effect>>;
  12992. /**
  12993. * Gets the name of the particle vertex shader
  12994. */
  12995. get vertexShaderName(): string;
  12996. /**
  12997. * Instantiates a particle system.
  12998. * Particles are often small sprites used to simulate hard-to-reproduce phenomena like fire, smoke, water, or abstract visual effects like magic glitter and faery dust.
  12999. * @param name The name of the particle system
  13000. * @param capacity The max number of particles alive at the same time
  13001. * @param sceneOrEngine The scene the particle system belongs to or the engine to use if no scene
  13002. * @param customEffect a custom effect used to change the way particles are rendered by default
  13003. * @param isAnimationSheetEnabled Must be true if using a spritesheet to animate the particles texture
  13004. * @param epsilon Offset used to render the particles
  13005. */
  13006. constructor(name: string, capacity: number, sceneOrEngine: Scene | ThinEngine, customEffect?: Nullable<Effect>, isAnimationSheetEnabled?: boolean, epsilon?: number);
  13007. private _addFactorGradient;
  13008. private _removeFactorGradient;
  13009. /**
  13010. * Adds a new life time gradient
  13011. * @param gradient defines the gradient to use (between 0 and 1)
  13012. * @param factor defines the life time factor to affect to the specified gradient
  13013. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  13014. * @returns the current particle system
  13015. */
  13016. addLifeTimeGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  13017. /**
  13018. * Remove a specific life time gradient
  13019. * @param gradient defines the gradient to remove
  13020. * @returns the current particle system
  13021. */
  13022. removeLifeTimeGradient(gradient: number): IParticleSystem;
  13023. /**
  13024. * Adds a new size gradient
  13025. * @param gradient defines the gradient to use (between 0 and 1)
  13026. * @param factor defines the size factor to affect to the specified gradient
  13027. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  13028. * @returns the current particle system
  13029. */
  13030. addSizeGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  13031. /**
  13032. * Remove a specific size gradient
  13033. * @param gradient defines the gradient to remove
  13034. * @returns the current particle system
  13035. */
  13036. removeSizeGradient(gradient: number): IParticleSystem;
  13037. /**
  13038. * Adds a new color remap gradient
  13039. * @param gradient defines the gradient to use (between 0 and 1)
  13040. * @param min defines the color remap minimal range
  13041. * @param max defines the color remap maximal range
  13042. * @returns the current particle system
  13043. */
  13044. addColorRemapGradient(gradient: number, min: number, max: number): IParticleSystem;
  13045. /**
  13046. * Remove a specific color remap gradient
  13047. * @param gradient defines the gradient to remove
  13048. * @returns the current particle system
  13049. */
  13050. removeColorRemapGradient(gradient: number): IParticleSystem;
  13051. /**
  13052. * Adds a new alpha remap gradient
  13053. * @param gradient defines the gradient to use (between 0 and 1)
  13054. * @param min defines the alpha remap minimal range
  13055. * @param max defines the alpha remap maximal range
  13056. * @returns the current particle system
  13057. */
  13058. addAlphaRemapGradient(gradient: number, min: number, max: number): IParticleSystem;
  13059. /**
  13060. * Remove a specific alpha remap gradient
  13061. * @param gradient defines the gradient to remove
  13062. * @returns the current particle system
  13063. */
  13064. removeAlphaRemapGradient(gradient: number): IParticleSystem;
  13065. /**
  13066. * Adds a new angular speed gradient
  13067. * @param gradient defines the gradient to use (between 0 and 1)
  13068. * @param factor defines the angular speed to affect to the specified gradient
  13069. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  13070. * @returns the current particle system
  13071. */
  13072. addAngularSpeedGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  13073. /**
  13074. * Remove a specific angular speed gradient
  13075. * @param gradient defines the gradient to remove
  13076. * @returns the current particle system
  13077. */
  13078. removeAngularSpeedGradient(gradient: number): IParticleSystem;
  13079. /**
  13080. * Adds a new velocity gradient
  13081. * @param gradient defines the gradient to use (between 0 and 1)
  13082. * @param factor defines the velocity to affect to the specified gradient
  13083. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  13084. * @returns the current particle system
  13085. */
  13086. addVelocityGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  13087. /**
  13088. * Remove a specific velocity gradient
  13089. * @param gradient defines the gradient to remove
  13090. * @returns the current particle system
  13091. */
  13092. removeVelocityGradient(gradient: number): IParticleSystem;
  13093. /**
  13094. * Adds a new limit velocity gradient
  13095. * @param gradient defines the gradient to use (between 0 and 1)
  13096. * @param factor defines the limit velocity value to affect to the specified gradient
  13097. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  13098. * @returns the current particle system
  13099. */
  13100. addLimitVelocityGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  13101. /**
  13102. * Remove a specific limit velocity gradient
  13103. * @param gradient defines the gradient to remove
  13104. * @returns the current particle system
  13105. */
  13106. removeLimitVelocityGradient(gradient: number): IParticleSystem;
  13107. /**
  13108. * Adds a new drag gradient
  13109. * @param gradient defines the gradient to use (between 0 and 1)
  13110. * @param factor defines the drag value to affect to the specified gradient
  13111. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  13112. * @returns the current particle system
  13113. */
  13114. addDragGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  13115. /**
  13116. * Remove a specific drag gradient
  13117. * @param gradient defines the gradient to remove
  13118. * @returns the current particle system
  13119. */
  13120. removeDragGradient(gradient: number): IParticleSystem;
  13121. /**
  13122. * Adds a new emit rate gradient (please note that this will only work if you set the targetStopDuration property)
  13123. * @param gradient defines the gradient to use (between 0 and 1)
  13124. * @param factor defines the emit rate value to affect to the specified gradient
  13125. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  13126. * @returns the current particle system
  13127. */
  13128. addEmitRateGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  13129. /**
  13130. * Remove a specific emit rate gradient
  13131. * @param gradient defines the gradient to remove
  13132. * @returns the current particle system
  13133. */
  13134. removeEmitRateGradient(gradient: number): IParticleSystem;
  13135. /**
  13136. * Adds a new start size gradient (please note that this will only work if you set the targetStopDuration property)
  13137. * @param gradient defines the gradient to use (between 0 and 1)
  13138. * @param factor defines the start size value to affect to the specified gradient
  13139. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  13140. * @returns the current particle system
  13141. */
  13142. addStartSizeGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  13143. /**
  13144. * Remove a specific start size gradient
  13145. * @param gradient defines the gradient to remove
  13146. * @returns the current particle system
  13147. */
  13148. removeStartSizeGradient(gradient: number): IParticleSystem;
  13149. private _createRampGradientTexture;
  13150. /**
  13151. * Gets the current list of ramp gradients.
  13152. * You must use addRampGradient and removeRampGradient to udpate this list
  13153. * @returns the list of ramp gradients
  13154. */
  13155. getRampGradients(): Nullable<Array<Color3Gradient>>;
  13156. /** Force the system to rebuild all gradients that need to be resync */
  13157. forceRefreshGradients(): void;
  13158. private _syncRampGradientTexture;
  13159. /**
  13160. * Adds a new ramp gradient used to remap particle colors
  13161. * @param gradient defines the gradient to use (between 0 and 1)
  13162. * @param color defines the color to affect to the specified gradient
  13163. * @returns the current particle system
  13164. */
  13165. addRampGradient(gradient: number, color: Color3): ParticleSystem;
  13166. /**
  13167. * Remove a specific ramp gradient
  13168. * @param gradient defines the gradient to remove
  13169. * @returns the current particle system
  13170. */
  13171. removeRampGradient(gradient: number): ParticleSystem;
  13172. /**
  13173. * Adds a new color gradient
  13174. * @param gradient defines the gradient to use (between 0 and 1)
  13175. * @param color1 defines the color to affect to the specified gradient
  13176. * @param color2 defines an additional color used to define a range ([color, color2]) with main color to pick the final color from
  13177. * @returns this particle system
  13178. */
  13179. addColorGradient(gradient: number, color1: Color4, color2?: Color4): IParticleSystem;
  13180. /**
  13181. * Remove a specific color gradient
  13182. * @param gradient defines the gradient to remove
  13183. * @returns this particle system
  13184. */
  13185. removeColorGradient(gradient: number): IParticleSystem;
  13186. private _fetchR;
  13187. protected _reset(): void;
  13188. private _resetEffect;
  13189. private _createVertexBuffers;
  13190. private _createIndexBuffer;
  13191. /**
  13192. * Gets the maximum number of particles active at the same time.
  13193. * @returns The max number of active particles.
  13194. */
  13195. getCapacity(): number;
  13196. /**
  13197. * Gets whether there are still active particles in the system.
  13198. * @returns True if it is alive, otherwise false.
  13199. */
  13200. isAlive(): boolean;
  13201. /**
  13202. * Gets if the system has been started. (Note: this will still be true after stop is called)
  13203. * @returns True if it has been started, otherwise false.
  13204. */
  13205. isStarted(): boolean;
  13206. private _prepareSubEmitterInternalArray;
  13207. /**
  13208. * Starts the particle system and begins to emit
  13209. * @param delay defines the delay in milliseconds before starting the system (this.startDelay by default)
  13210. */
  13211. start(delay?: number): void;
  13212. /**
  13213. * Stops the particle system.
  13214. * @param stopSubEmitters if true it will stop the current system and all created sub-Systems if false it will stop the current root system only, this param is used by the root particle system only. the default value is true.
  13215. */
  13216. stop(stopSubEmitters?: boolean): void;
  13217. /**
  13218. * Remove all active particles
  13219. */
  13220. reset(): void;
  13221. /**
  13222. * @hidden (for internal use only)
  13223. */
  13224. _appendParticleVertex(index: number, particle: Particle, offsetX: number, offsetY: number): void;
  13225. /**
  13226. * "Recycles" one of the particle by copying it back to the "stock" of particles and removing it from the active list.
  13227. * Its lifetime will start back at 0.
  13228. */
  13229. recycleParticle: (particle: Particle) => void;
  13230. private _stopSubEmitters;
  13231. private _createParticle;
  13232. private _removeFromRoot;
  13233. private _emitFromParticle;
  13234. private _update;
  13235. /** @hidden */
  13236. static _GetAttributeNamesOrOptions(isAnimationSheetEnabled?: boolean, isBillboardBased?: boolean, useRampGradients?: boolean): string[];
  13237. /** @hidden */
  13238. static _GetEffectCreationOptions(isAnimationSheetEnabled?: boolean): string[];
  13239. /**
  13240. * Fill the defines array according to the current settings of the particle system
  13241. * @param defines Array to be updated
  13242. * @param blendMode blend mode to take into account when updating the array
  13243. */
  13244. fillDefines(defines: Array<string>, blendMode: number): void;
  13245. /**
  13246. * Fill the uniforms, attributes and samplers arrays according to the current settings of the particle system
  13247. * @param uniforms Uniforms array to fill
  13248. * @param attributes Attributes array to fill
  13249. * @param samplers Samplers array to fill
  13250. */
  13251. fillUniformsAttributesAndSamplerNames(uniforms: Array<string>, attributes: Array<string>, samplers: Array<string>): void;
  13252. /** @hidden */
  13253. private _getEffect;
  13254. /**
  13255. * Animates the particle system for the current frame by emitting new particles and or animating the living ones.
  13256. * @param preWarmOnly will prevent the system from updating the vertex buffer (default is false)
  13257. */
  13258. animate(preWarmOnly?: boolean): void;
  13259. private _appendParticleVertices;
  13260. /**
  13261. * Rebuilds the particle system.
  13262. */
  13263. rebuild(): void;
  13264. /**
  13265. * Is this system ready to be used/rendered
  13266. * @return true if the system is ready
  13267. */
  13268. isReady(): boolean;
  13269. private _render;
  13270. /**
  13271. * Renders the particle system in its current state.
  13272. * @returns the current number of particles
  13273. */
  13274. render(): number;
  13275. /**
  13276. * Disposes the particle system and free the associated resources
  13277. * @param disposeTexture defines if the particule texture must be disposed as well (true by default)
  13278. */
  13279. dispose(disposeTexture?: boolean): void;
  13280. /**
  13281. * Clones the particle system.
  13282. * @param name The name of the cloned object
  13283. * @param newEmitter The new emitter to use
  13284. * @returns the cloned particle system
  13285. */
  13286. clone(name: string, newEmitter: any): ParticleSystem;
  13287. /**
  13288. * Serializes the particle system to a JSON object
  13289. * @param serializeTexture defines if the texture must be serialized as well
  13290. * @returns the JSON object
  13291. */
  13292. serialize(serializeTexture?: boolean): any;
  13293. /** @hidden */
  13294. static _Serialize(serializationObject: any, particleSystem: IParticleSystem, serializeTexture: boolean): void;
  13295. /** @hidden */
  13296. static _Parse(parsedParticleSystem: any, particleSystem: IParticleSystem, sceneOrEngine: Scene | ThinEngine, rootUrl: string): void;
  13297. /**
  13298. * Parses a JSON object to create a particle system.
  13299. * @param parsedParticleSystem The JSON object to parse
  13300. * @param sceneOrEngine The scene or the engine to create the particle system in
  13301. * @param rootUrl The root url to use to load external dependencies like texture
  13302. * @param doNotStart Ignore the preventAutoStart attribute and does not start
  13303. * @returns the Parsed particle system
  13304. */
  13305. static Parse(parsedParticleSystem: any, sceneOrEngine: Scene | ThinEngine, rootUrl: string, doNotStart?: boolean): ParticleSystem;
  13306. }
  13307. }
  13308. declare module "babylonjs/Particles/particle" {
  13309. import { Nullable } from "babylonjs/types";
  13310. import { Vector2, Vector3, Vector4 } from "babylonjs/Maths/math.vector";
  13311. import { Color4 } from "babylonjs/Maths/math.color";
  13312. import { ParticleSystem } from "babylonjs/Particles/particleSystem";
  13313. import { SubEmitter } from "babylonjs/Particles/subEmitter";
  13314. import { ColorGradient, FactorGradient } from "babylonjs/Misc/gradients";
  13315. /**
  13316. * A particle represents one of the element emitted by a particle system.
  13317. * This is mainly define by its coordinates, direction, velocity and age.
  13318. */
  13319. export class Particle {
  13320. /**
  13321. * The particle system the particle belongs to.
  13322. */
  13323. particleSystem: ParticleSystem;
  13324. private static _Count;
  13325. /**
  13326. * Unique ID of the particle
  13327. */
  13328. id: number;
  13329. /**
  13330. * The world position of the particle in the scene.
  13331. */
  13332. position: Vector3;
  13333. /**
  13334. * The world direction of the particle in the scene.
  13335. */
  13336. direction: Vector3;
  13337. /**
  13338. * The color of the particle.
  13339. */
  13340. color: Color4;
  13341. /**
  13342. * The color change of the particle per step.
  13343. */
  13344. colorStep: Color4;
  13345. /**
  13346. * Defines how long will the life of the particle be.
  13347. */
  13348. lifeTime: number;
  13349. /**
  13350. * The current age of the particle.
  13351. */
  13352. age: number;
  13353. /**
  13354. * The current size of the particle.
  13355. */
  13356. size: number;
  13357. /**
  13358. * The current scale of the particle.
  13359. */
  13360. scale: Vector2;
  13361. /**
  13362. * The current angle of the particle.
  13363. */
  13364. angle: number;
  13365. /**
  13366. * Defines how fast is the angle changing.
  13367. */
  13368. angularSpeed: number;
  13369. /**
  13370. * Defines the cell index used by the particle to be rendered from a sprite.
  13371. */
  13372. cellIndex: number;
  13373. /**
  13374. * The information required to support color remapping
  13375. */
  13376. remapData: Vector4;
  13377. /** @hidden */
  13378. _randomCellOffset?: number;
  13379. /** @hidden */
  13380. _initialDirection: Nullable<Vector3>;
  13381. /** @hidden */
  13382. _attachedSubEmitters: Nullable<Array<SubEmitter>>;
  13383. /** @hidden */
  13384. _initialStartSpriteCellID: number;
  13385. /** @hidden */
  13386. _initialEndSpriteCellID: number;
  13387. /** @hidden */
  13388. _currentColorGradient: Nullable<ColorGradient>;
  13389. /** @hidden */
  13390. _currentColor1: Color4;
  13391. /** @hidden */
  13392. _currentColor2: Color4;
  13393. /** @hidden */
  13394. _currentSizeGradient: Nullable<FactorGradient>;
  13395. /** @hidden */
  13396. _currentSize1: number;
  13397. /** @hidden */
  13398. _currentSize2: number;
  13399. /** @hidden */
  13400. _currentAngularSpeedGradient: Nullable<FactorGradient>;
  13401. /** @hidden */
  13402. _currentAngularSpeed1: number;
  13403. /** @hidden */
  13404. _currentAngularSpeed2: number;
  13405. /** @hidden */
  13406. _currentVelocityGradient: Nullable<FactorGradient>;
  13407. /** @hidden */
  13408. _currentVelocity1: number;
  13409. /** @hidden */
  13410. _currentVelocity2: number;
  13411. /** @hidden */
  13412. _currentLimitVelocityGradient: Nullable<FactorGradient>;
  13413. /** @hidden */
  13414. _currentLimitVelocity1: number;
  13415. /** @hidden */
  13416. _currentLimitVelocity2: number;
  13417. /** @hidden */
  13418. _currentDragGradient: Nullable<FactorGradient>;
  13419. /** @hidden */
  13420. _currentDrag1: number;
  13421. /** @hidden */
  13422. _currentDrag2: number;
  13423. /** @hidden */
  13424. _randomNoiseCoordinates1: Vector3;
  13425. /** @hidden */
  13426. _randomNoiseCoordinates2: Vector3;
  13427. /** @hidden */
  13428. _localPosition?: Vector3;
  13429. /**
  13430. * Creates a new instance Particle
  13431. * @param particleSystem the particle system the particle belongs to
  13432. */
  13433. constructor(
  13434. /**
  13435. * The particle system the particle belongs to.
  13436. */
  13437. particleSystem: ParticleSystem);
  13438. private updateCellInfoFromSystem;
  13439. /**
  13440. * Defines how the sprite cell index is updated for the particle
  13441. */
  13442. updateCellIndex(): void;
  13443. /** @hidden */
  13444. _inheritParticleInfoToSubEmitter(subEmitter: SubEmitter): void;
  13445. /** @hidden */
  13446. _inheritParticleInfoToSubEmitters(): void;
  13447. /** @hidden */
  13448. _reset(): void;
  13449. /**
  13450. * Copy the properties of particle to another one.
  13451. * @param other the particle to copy the information to.
  13452. */
  13453. copyTo(other: Particle): void;
  13454. }
  13455. }
  13456. declare module "babylonjs/Particles/EmitterTypes/IParticleEmitterType" {
  13457. import { Vector3, Matrix } from "babylonjs/Maths/math.vector";
  13458. import { Effect } from "babylonjs/Materials/effect";
  13459. import { Particle } from "babylonjs/Particles/particle";
  13460. import { Nullable } from "babylonjs/types";
  13461. import { Scene } from "babylonjs/scene";
  13462. /**
  13463. * Particle emitter represents a volume emitting particles.
  13464. * This is the responsibility of the implementation to define the volume shape like cone/sphere/box.
  13465. */
  13466. export interface IParticleEmitterType {
  13467. /**
  13468. * Called by the particle System when the direction is computed for the created particle.
  13469. * @param worldMatrix is the world matrix of the particle system
  13470. * @param directionToUpdate is the direction vector to update with the result
  13471. * @param particle is the particle we are computed the direction for
  13472. * @param isLocal defines if the direction should be set in local space
  13473. */
  13474. startDirectionFunction(worldMatrix: Matrix, directionToUpdate: Vector3, particle: Particle, isLocal: boolean): void;
  13475. /**
  13476. * Called by the particle System when the position is computed for the created particle.
  13477. * @param worldMatrix is the world matrix of the particle system
  13478. * @param positionToUpdate is the position vector to update with the result
  13479. * @param particle is the particle we are computed the position for
  13480. * @param isLocal defines if the position should be set in local space
  13481. */
  13482. startPositionFunction(worldMatrix: Matrix, positionToUpdate: Vector3, particle: Particle, isLocal: boolean): void;
  13483. /**
  13484. * Clones the current emitter and returns a copy of it
  13485. * @returns the new emitter
  13486. */
  13487. clone(): IParticleEmitterType;
  13488. /**
  13489. * Called by the GPUParticleSystem to setup the update shader
  13490. * @param effect defines the update shader
  13491. */
  13492. applyToShader(effect: Effect): void;
  13493. /**
  13494. * Returns a string to use to update the GPU particles update shader
  13495. * @returns the effect defines string
  13496. */
  13497. getEffectDefines(): string;
  13498. /**
  13499. * Returns a string representing the class name
  13500. * @returns a string containing the class name
  13501. */
  13502. getClassName(): string;
  13503. /**
  13504. * Serializes the particle system to a JSON object.
  13505. * @returns the JSON object
  13506. */
  13507. serialize(): any;
  13508. /**
  13509. * Parse properties from a JSON object
  13510. * @param serializationObject defines the JSON object
  13511. * @param scene defines the hosting scene
  13512. */
  13513. parse(serializationObject: any, scene: Nullable<Scene>): void;
  13514. }
  13515. }
  13516. declare module "babylonjs/Particles/EmitterTypes/boxParticleEmitter" {
  13517. import { Vector3, Matrix } from "babylonjs/Maths/math.vector";
  13518. import { Effect } from "babylonjs/Materials/effect";
  13519. import { Particle } from "babylonjs/Particles/particle";
  13520. import { IParticleEmitterType } from "babylonjs/Particles/EmitterTypes/IParticleEmitterType";
  13521. /**
  13522. * Particle emitter emitting particles from the inside of a box.
  13523. * It emits the particles randomly between 2 given directions.
  13524. */
  13525. export class BoxParticleEmitter implements IParticleEmitterType {
  13526. /**
  13527. * Random direction of each particle after it has been emitted, between direction1 and direction2 vectors.
  13528. */
  13529. direction1: Vector3;
  13530. /**
  13531. * Random direction of each particle after it has been emitted, between direction1 and direction2 vectors.
  13532. */
  13533. direction2: Vector3;
  13534. /**
  13535. * Minimum box point around our emitter. Our emitter is the center of particles source, but if you want your particles to emit from more than one point, then you can tell it to do so.
  13536. */
  13537. minEmitBox: Vector3;
  13538. /**
  13539. * Maximum box point around our emitter. Our emitter is the center of particles source, but if you want your particles to emit from more than one point, then you can tell it to do so.
  13540. */
  13541. maxEmitBox: Vector3;
  13542. /**
  13543. * Creates a new instance BoxParticleEmitter
  13544. */
  13545. constructor();
  13546. /**
  13547. * Called by the particle System when the direction is computed for the created particle.
  13548. * @param worldMatrix is the world matrix of the particle system
  13549. * @param directionToUpdate is the direction vector to update with the result
  13550. * @param particle is the particle we are computed the direction for
  13551. * @param isLocal defines if the direction should be set in local space
  13552. */
  13553. startDirectionFunction(worldMatrix: Matrix, directionToUpdate: Vector3, particle: Particle, isLocal: boolean): void;
  13554. /**
  13555. * Called by the particle System when the position is computed for the created particle.
  13556. * @param worldMatrix is the world matrix of the particle system
  13557. * @param positionToUpdate is the position vector to update with the result
  13558. * @param particle is the particle we are computed the position for
  13559. * @param isLocal defines if the position should be set in local space
  13560. */
  13561. startPositionFunction(worldMatrix: Matrix, positionToUpdate: Vector3, particle: Particle, isLocal: boolean): void;
  13562. /**
  13563. * Clones the current emitter and returns a copy of it
  13564. * @returns the new emitter
  13565. */
  13566. clone(): BoxParticleEmitter;
  13567. /**
  13568. * Called by the GPUParticleSystem to setup the update shader
  13569. * @param effect defines the update shader
  13570. */
  13571. applyToShader(effect: Effect): void;
  13572. /**
  13573. * Returns a string to use to update the GPU particles update shader
  13574. * @returns a string containng the defines string
  13575. */
  13576. getEffectDefines(): string;
  13577. /**
  13578. * Returns the string "BoxParticleEmitter"
  13579. * @returns a string containing the class name
  13580. */
  13581. getClassName(): string;
  13582. /**
  13583. * Serializes the particle system to a JSON object.
  13584. * @returns the JSON object
  13585. */
  13586. serialize(): any;
  13587. /**
  13588. * Parse properties from a JSON object
  13589. * @param serializationObject defines the JSON object
  13590. */
  13591. parse(serializationObject: any): void;
  13592. }
  13593. }
  13594. declare module "babylonjs/Particles/EmitterTypes/coneParticleEmitter" {
  13595. import { Vector3, Matrix } from "babylonjs/Maths/math.vector";
  13596. import { Effect } from "babylonjs/Materials/effect";
  13597. import { Particle } from "babylonjs/Particles/particle";
  13598. import { IParticleEmitterType } from "babylonjs/Particles/EmitterTypes/IParticleEmitterType";
  13599. /**
  13600. * Particle emitter emitting particles from the inside of a cone.
  13601. * It emits the particles alongside the cone volume from the base to the particle.
  13602. * The emission direction might be randomized.
  13603. */
  13604. export class ConeParticleEmitter implements IParticleEmitterType {
  13605. /** defines how much to randomize the particle direction [0-1] (default is 0) */
  13606. directionRandomizer: number;
  13607. private _radius;
  13608. private _angle;
  13609. private _height;
  13610. /**
  13611. * Gets or sets a value indicating where on the radius the start position should be picked (1 = everywhere, 0 = only surface)
  13612. */
  13613. radiusRange: number;
  13614. /**
  13615. * Gets or sets a value indicating where on the height the start position should be picked (1 = everywhere, 0 = only surface)
  13616. */
  13617. heightRange: number;
  13618. /**
  13619. * Gets or sets a value indicating if all the particles should be emitted from the spawn point only (the base of the cone)
  13620. */
  13621. emitFromSpawnPointOnly: boolean;
  13622. /**
  13623. * Gets or sets the radius of the emission cone
  13624. */
  13625. get radius(): number;
  13626. set radius(value: number);
  13627. /**
  13628. * Gets or sets the angle of the emission cone
  13629. */
  13630. get angle(): number;
  13631. set angle(value: number);
  13632. private _buildHeight;
  13633. /**
  13634. * Creates a new instance ConeParticleEmitter
  13635. * @param radius the radius of the emission cone (1 by default)
  13636. * @param angle the cone base angle (PI by default)
  13637. * @param directionRandomizer defines how much to randomize the particle direction [0-1] (default is 0)
  13638. */
  13639. constructor(radius?: number, angle?: number,
  13640. /** defines how much to randomize the particle direction [0-1] (default is 0) */
  13641. directionRandomizer?: number);
  13642. /**
  13643. * Called by the particle System when the direction is computed for the created particle.
  13644. * @param worldMatrix is the world matrix of the particle system
  13645. * @param directionToUpdate is the direction vector to update with the result
  13646. * @param particle is the particle we are computed the direction for
  13647. * @param isLocal defines if the direction should be set in local space
  13648. */
  13649. startDirectionFunction(worldMatrix: Matrix, directionToUpdate: Vector3, particle: Particle, isLocal: boolean): void;
  13650. /**
  13651. * Called by the particle System when the position is computed for the created particle.
  13652. * @param worldMatrix is the world matrix of the particle system
  13653. * @param positionToUpdate is the position vector to update with the result
  13654. * @param particle is the particle we are computed the position for
  13655. * @param isLocal defines if the position should be set in local space
  13656. */
  13657. startPositionFunction(worldMatrix: Matrix, positionToUpdate: Vector3, particle: Particle, isLocal: boolean): void;
  13658. /**
  13659. * Clones the current emitter and returns a copy of it
  13660. * @returns the new emitter
  13661. */
  13662. clone(): ConeParticleEmitter;
  13663. /**
  13664. * Called by the GPUParticleSystem to setup the update shader
  13665. * @param effect defines the update shader
  13666. */
  13667. applyToShader(effect: Effect): void;
  13668. /**
  13669. * Returns a string to use to update the GPU particles update shader
  13670. * @returns a string containng the defines string
  13671. */
  13672. getEffectDefines(): string;
  13673. /**
  13674. * Returns the string "ConeParticleEmitter"
  13675. * @returns a string containing the class name
  13676. */
  13677. getClassName(): string;
  13678. /**
  13679. * Serializes the particle system to a JSON object.
  13680. * @returns the JSON object
  13681. */
  13682. serialize(): any;
  13683. /**
  13684. * Parse properties from a JSON object
  13685. * @param serializationObject defines the JSON object
  13686. */
  13687. parse(serializationObject: any): void;
  13688. }
  13689. }
  13690. declare module "babylonjs/Particles/EmitterTypes/cylinderParticleEmitter" {
  13691. import { Vector3, Matrix } from "babylonjs/Maths/math.vector";
  13692. import { Effect } from "babylonjs/Materials/effect";
  13693. import { Particle } from "babylonjs/Particles/particle";
  13694. import { IParticleEmitterType } from "babylonjs/Particles/EmitterTypes/IParticleEmitterType";
  13695. /**
  13696. * Particle emitter emitting particles from the inside of a cylinder.
  13697. * It emits the particles alongside the cylinder radius. The emission direction might be randomized.
  13698. */
  13699. export class CylinderParticleEmitter implements IParticleEmitterType {
  13700. /**
  13701. * The radius of the emission cylinder.
  13702. */
  13703. radius: number;
  13704. /**
  13705. * The height of the emission cylinder.
  13706. */
  13707. height: number;
  13708. /**
  13709. * The range of emission [0-1] 0 Surface only, 1 Entire Radius.
  13710. */
  13711. radiusRange: number;
  13712. /**
  13713. * How much to randomize the particle direction [0-1].
  13714. */
  13715. directionRandomizer: number;
  13716. /**
  13717. * Creates a new instance CylinderParticleEmitter
  13718. * @param radius the radius of the emission cylinder (1 by default)
  13719. * @param height the height of the emission cylinder (1 by default)
  13720. * @param radiusRange the range of the emission cylinder [0-1] 0 Surface only, 1 Entire Radius (1 by default)
  13721. * @param directionRandomizer defines how much to randomize the particle direction [0-1]
  13722. */
  13723. constructor(
  13724. /**
  13725. * The radius of the emission cylinder.
  13726. */
  13727. radius?: number,
  13728. /**
  13729. * The height of the emission cylinder.
  13730. */
  13731. height?: number,
  13732. /**
  13733. * The range of emission [0-1] 0 Surface only, 1 Entire Radius.
  13734. */
  13735. radiusRange?: number,
  13736. /**
  13737. * How much to randomize the particle direction [0-1].
  13738. */
  13739. directionRandomizer?: number);
  13740. /**
  13741. * Called by the particle System when the direction is computed for the created particle.
  13742. * @param worldMatrix is the world matrix of the particle system
  13743. * @param directionToUpdate is the direction vector to update with the result
  13744. * @param particle is the particle we are computed the direction for
  13745. * @param isLocal defines if the direction should be set in local space
  13746. */
  13747. startDirectionFunction(worldMatrix: Matrix, directionToUpdate: Vector3, particle: Particle, isLocal: boolean): void;
  13748. /**
  13749. * Called by the particle System when the position is computed for the created particle.
  13750. * @param worldMatrix is the world matrix of the particle system
  13751. * @param positionToUpdate is the position vector to update with the result
  13752. * @param particle is the particle we are computed the position for
  13753. * @param isLocal defines if the position should be set in local space
  13754. */
  13755. startPositionFunction(worldMatrix: Matrix, positionToUpdate: Vector3, particle: Particle, isLocal: boolean): void;
  13756. /**
  13757. * Clones the current emitter and returns a copy of it
  13758. * @returns the new emitter
  13759. */
  13760. clone(): CylinderParticleEmitter;
  13761. /**
  13762. * Called by the GPUParticleSystem to setup the update shader
  13763. * @param effect defines the update shader
  13764. */
  13765. applyToShader(effect: Effect): void;
  13766. /**
  13767. * Returns a string to use to update the GPU particles update shader
  13768. * @returns a string containng the defines string
  13769. */
  13770. getEffectDefines(): string;
  13771. /**
  13772. * Returns the string "CylinderParticleEmitter"
  13773. * @returns a string containing the class name
  13774. */
  13775. getClassName(): string;
  13776. /**
  13777. * Serializes the particle system to a JSON object.
  13778. * @returns the JSON object
  13779. */
  13780. serialize(): any;
  13781. /**
  13782. * Parse properties from a JSON object
  13783. * @param serializationObject defines the JSON object
  13784. */
  13785. parse(serializationObject: any): void;
  13786. }
  13787. /**
  13788. * Particle emitter emitting particles from the inside of a cylinder.
  13789. * It emits the particles randomly between two vectors.
  13790. */
  13791. export class CylinderDirectedParticleEmitter extends CylinderParticleEmitter {
  13792. /**
  13793. * The min limit of the emission direction.
  13794. */
  13795. direction1: Vector3;
  13796. /**
  13797. * The max limit of the emission direction.
  13798. */
  13799. direction2: Vector3;
  13800. /**
  13801. * Creates a new instance CylinderDirectedParticleEmitter
  13802. * @param radius the radius of the emission cylinder (1 by default)
  13803. * @param height the height of the emission cylinder (1 by default)
  13804. * @param radiusRange the range of the emission cylinder [0-1] 0 Surface only, 1 Entire Radius (1 by default)
  13805. * @param direction1 the min limit of the emission direction (up vector by default)
  13806. * @param direction2 the max limit of the emission direction (up vector by default)
  13807. */
  13808. constructor(radius?: number, height?: number, radiusRange?: number,
  13809. /**
  13810. * The min limit of the emission direction.
  13811. */
  13812. direction1?: Vector3,
  13813. /**
  13814. * The max limit of the emission direction.
  13815. */
  13816. direction2?: Vector3);
  13817. /**
  13818. * Called by the particle System when the direction is computed for the created particle.
  13819. * @param worldMatrix is the world matrix of the particle system
  13820. * @param directionToUpdate is the direction vector to update with the result
  13821. * @param particle is the particle we are computed the direction for
  13822. */
  13823. startDirectionFunction(worldMatrix: Matrix, directionToUpdate: Vector3, particle: Particle): void;
  13824. /**
  13825. * Clones the current emitter and returns a copy of it
  13826. * @returns the new emitter
  13827. */
  13828. clone(): CylinderDirectedParticleEmitter;
  13829. /**
  13830. * Called by the GPUParticleSystem to setup the update shader
  13831. * @param effect defines the update shader
  13832. */
  13833. applyToShader(effect: Effect): void;
  13834. /**
  13835. * Returns a string to use to update the GPU particles update shader
  13836. * @returns a string containng the defines string
  13837. */
  13838. getEffectDefines(): string;
  13839. /**
  13840. * Returns the string "CylinderDirectedParticleEmitter"
  13841. * @returns a string containing the class name
  13842. */
  13843. getClassName(): string;
  13844. /**
  13845. * Serializes the particle system to a JSON object.
  13846. * @returns the JSON object
  13847. */
  13848. serialize(): any;
  13849. /**
  13850. * Parse properties from a JSON object
  13851. * @param serializationObject defines the JSON object
  13852. */
  13853. parse(serializationObject: any): void;
  13854. }
  13855. }
  13856. declare module "babylonjs/Particles/EmitterTypes/hemisphericParticleEmitter" {
  13857. import { Vector3, Matrix } from "babylonjs/Maths/math.vector";
  13858. import { Effect } from "babylonjs/Materials/effect";
  13859. import { Particle } from "babylonjs/Particles/particle";
  13860. import { IParticleEmitterType } from "babylonjs/Particles/EmitterTypes/IParticleEmitterType";
  13861. /**
  13862. * Particle emitter emitting particles from the inside of a hemisphere.
  13863. * It emits the particles alongside the hemisphere radius. The emission direction might be randomized.
  13864. */
  13865. export class HemisphericParticleEmitter implements IParticleEmitterType {
  13866. /**
  13867. * The radius of the emission hemisphere.
  13868. */
  13869. radius: number;
  13870. /**
  13871. * The range of emission [0-1] 0 Surface only, 1 Entire Radius.
  13872. */
  13873. radiusRange: number;
  13874. /**
  13875. * How much to randomize the particle direction [0-1].
  13876. */
  13877. directionRandomizer: number;
  13878. /**
  13879. * Creates a new instance HemisphericParticleEmitter
  13880. * @param radius the radius of the emission hemisphere (1 by default)
  13881. * @param radiusRange the range of the emission hemisphere [0-1] 0 Surface only, 1 Entire Radius (1 by default)
  13882. * @param directionRandomizer defines how much to randomize the particle direction [0-1]
  13883. */
  13884. constructor(
  13885. /**
  13886. * The radius of the emission hemisphere.
  13887. */
  13888. radius?: number,
  13889. /**
  13890. * The range of emission [0-1] 0 Surface only, 1 Entire Radius.
  13891. */
  13892. radiusRange?: number,
  13893. /**
  13894. * How much to randomize the particle direction [0-1].
  13895. */
  13896. directionRandomizer?: number);
  13897. /**
  13898. * Called by the particle System when the direction is computed for the created particle.
  13899. * @param worldMatrix is the world matrix of the particle system
  13900. * @param directionToUpdate is the direction vector to update with the result
  13901. * @param particle is the particle we are computed the direction for
  13902. * @param isLocal defines if the direction should be set in local space
  13903. */
  13904. startDirectionFunction(worldMatrix: Matrix, directionToUpdate: Vector3, particle: Particle, isLocal: boolean): void;
  13905. /**
  13906. * Called by the particle System when the position is computed for the created particle.
  13907. * @param worldMatrix is the world matrix of the particle system
  13908. * @param positionToUpdate is the position vector to update with the result
  13909. * @param particle is the particle we are computed the position for
  13910. * @param isLocal defines if the position should be set in local space
  13911. */
  13912. startPositionFunction(worldMatrix: Matrix, positionToUpdate: Vector3, particle: Particle, isLocal: boolean): void;
  13913. /**
  13914. * Clones the current emitter and returns a copy of it
  13915. * @returns the new emitter
  13916. */
  13917. clone(): HemisphericParticleEmitter;
  13918. /**
  13919. * Called by the GPUParticleSystem to setup the update shader
  13920. * @param effect defines the update shader
  13921. */
  13922. applyToShader(effect: Effect): void;
  13923. /**
  13924. * Returns a string to use to update the GPU particles update shader
  13925. * @returns a string containng the defines string
  13926. */
  13927. getEffectDefines(): string;
  13928. /**
  13929. * Returns the string "HemisphericParticleEmitter"
  13930. * @returns a string containing the class name
  13931. */
  13932. getClassName(): string;
  13933. /**
  13934. * Serializes the particle system to a JSON object.
  13935. * @returns the JSON object
  13936. */
  13937. serialize(): any;
  13938. /**
  13939. * Parse properties from a JSON object
  13940. * @param serializationObject defines the JSON object
  13941. */
  13942. parse(serializationObject: any): void;
  13943. }
  13944. }
  13945. declare module "babylonjs/Particles/EmitterTypes/pointParticleEmitter" {
  13946. import { Vector3, Matrix } from "babylonjs/Maths/math.vector";
  13947. import { Effect } from "babylonjs/Materials/effect";
  13948. import { Particle } from "babylonjs/Particles/particle";
  13949. import { IParticleEmitterType } from "babylonjs/Particles/EmitterTypes/IParticleEmitterType";
  13950. /**
  13951. * Particle emitter emitting particles from a point.
  13952. * It emits the particles randomly between 2 given directions.
  13953. */
  13954. export class PointParticleEmitter implements IParticleEmitterType {
  13955. /**
  13956. * Random direction of each particle after it has been emitted, between direction1 and direction2 vectors.
  13957. */
  13958. direction1: Vector3;
  13959. /**
  13960. * Random direction of each particle after it has been emitted, between direction1 and direction2 vectors.
  13961. */
  13962. direction2: Vector3;
  13963. /**
  13964. * Creates a new instance PointParticleEmitter
  13965. */
  13966. constructor();
  13967. /**
  13968. * Called by the particle System when the direction is computed for the created particle.
  13969. * @param worldMatrix is the world matrix of the particle system
  13970. * @param directionToUpdate is the direction vector to update with the result
  13971. * @param particle is the particle we are computed the direction for
  13972. * @param isLocal defines if the direction should be set in local space
  13973. */
  13974. startDirectionFunction(worldMatrix: Matrix, directionToUpdate: Vector3, particle: Particle, isLocal: boolean): void;
  13975. /**
  13976. * Called by the particle System when the position is computed for the created particle.
  13977. * @param worldMatrix is the world matrix of the particle system
  13978. * @param positionToUpdate is the position vector to update with the result
  13979. * @param particle is the particle we are computed the position for
  13980. * @param isLocal defines if the position should be set in local space
  13981. */
  13982. startPositionFunction(worldMatrix: Matrix, positionToUpdate: Vector3, particle: Particle, isLocal: boolean): void;
  13983. /**
  13984. * Clones the current emitter and returns a copy of it
  13985. * @returns the new emitter
  13986. */
  13987. clone(): PointParticleEmitter;
  13988. /**
  13989. * Called by the GPUParticleSystem to setup the update shader
  13990. * @param effect defines the update shader
  13991. */
  13992. applyToShader(effect: Effect): void;
  13993. /**
  13994. * Returns a string to use to update the GPU particles update shader
  13995. * @returns a string containng the defines string
  13996. */
  13997. getEffectDefines(): string;
  13998. /**
  13999. * Returns the string "PointParticleEmitter"
  14000. * @returns a string containing the class name
  14001. */
  14002. getClassName(): string;
  14003. /**
  14004. * Serializes the particle system to a JSON object.
  14005. * @returns the JSON object
  14006. */
  14007. serialize(): any;
  14008. /**
  14009. * Parse properties from a JSON object
  14010. * @param serializationObject defines the JSON object
  14011. */
  14012. parse(serializationObject: any): void;
  14013. }
  14014. }
  14015. declare module "babylonjs/Particles/EmitterTypes/sphereParticleEmitter" {
  14016. import { Vector3, Matrix } from "babylonjs/Maths/math.vector";
  14017. import { Effect } from "babylonjs/Materials/effect";
  14018. import { Particle } from "babylonjs/Particles/particle";
  14019. import { IParticleEmitterType } from "babylonjs/Particles/EmitterTypes/IParticleEmitterType";
  14020. /**
  14021. * Particle emitter emitting particles from the inside of a sphere.
  14022. * It emits the particles alongside the sphere radius. The emission direction might be randomized.
  14023. */
  14024. export class SphereParticleEmitter implements IParticleEmitterType {
  14025. /**
  14026. * The radius of the emission sphere.
  14027. */
  14028. radius: number;
  14029. /**
  14030. * The range of emission [0-1] 0 Surface only, 1 Entire Radius.
  14031. */
  14032. radiusRange: number;
  14033. /**
  14034. * How much to randomize the particle direction [0-1].
  14035. */
  14036. directionRandomizer: number;
  14037. /**
  14038. * Creates a new instance SphereParticleEmitter
  14039. * @param radius the radius of the emission sphere (1 by default)
  14040. * @param radiusRange the range of the emission sphere [0-1] 0 Surface only, 1 Entire Radius (1 by default)
  14041. * @param directionRandomizer defines how much to randomize the particle direction [0-1]
  14042. */
  14043. constructor(
  14044. /**
  14045. * The radius of the emission sphere.
  14046. */
  14047. radius?: number,
  14048. /**
  14049. * The range of emission [0-1] 0 Surface only, 1 Entire Radius.
  14050. */
  14051. radiusRange?: number,
  14052. /**
  14053. * How much to randomize the particle direction [0-1].
  14054. */
  14055. directionRandomizer?: number);
  14056. /**
  14057. * Called by the particle System when the direction is computed for the created particle.
  14058. * @param worldMatrix is the world matrix of the particle system
  14059. * @param directionToUpdate is the direction vector to update with the result
  14060. * @param particle is the particle we are computed the direction for
  14061. * @param isLocal defines if the direction should be set in local space
  14062. */
  14063. startDirectionFunction(worldMatrix: Matrix, directionToUpdate: Vector3, particle: Particle, isLocal: boolean): void;
  14064. /**
  14065. * Called by the particle System when the position is computed for the created particle.
  14066. * @param worldMatrix is the world matrix of the particle system
  14067. * @param positionToUpdate is the position vector to update with the result
  14068. * @param particle is the particle we are computed the position for
  14069. * @param isLocal defines if the position should be set in local space
  14070. */
  14071. startPositionFunction(worldMatrix: Matrix, positionToUpdate: Vector3, particle: Particle, isLocal: boolean): void;
  14072. /**
  14073. * Clones the current emitter and returns a copy of it
  14074. * @returns the new emitter
  14075. */
  14076. clone(): SphereParticleEmitter;
  14077. /**
  14078. * Called by the GPUParticleSystem to setup the update shader
  14079. * @param effect defines the update shader
  14080. */
  14081. applyToShader(effect: Effect): void;
  14082. /**
  14083. * Returns a string to use to update the GPU particles update shader
  14084. * @returns a string containng the defines string
  14085. */
  14086. getEffectDefines(): string;
  14087. /**
  14088. * Returns the string "SphereParticleEmitter"
  14089. * @returns a string containing the class name
  14090. */
  14091. getClassName(): string;
  14092. /**
  14093. * Serializes the particle system to a JSON object.
  14094. * @returns the JSON object
  14095. */
  14096. serialize(): any;
  14097. /**
  14098. * Parse properties from a JSON object
  14099. * @param serializationObject defines the JSON object
  14100. */
  14101. parse(serializationObject: any): void;
  14102. }
  14103. /**
  14104. * Particle emitter emitting particles from the inside of a sphere.
  14105. * It emits the particles randomly between two vectors.
  14106. */
  14107. export class SphereDirectedParticleEmitter extends SphereParticleEmitter {
  14108. /**
  14109. * The min limit of the emission direction.
  14110. */
  14111. direction1: Vector3;
  14112. /**
  14113. * The max limit of the emission direction.
  14114. */
  14115. direction2: Vector3;
  14116. /**
  14117. * Creates a new instance SphereDirectedParticleEmitter
  14118. * @param radius the radius of the emission sphere (1 by default)
  14119. * @param direction1 the min limit of the emission direction (up vector by default)
  14120. * @param direction2 the max limit of the emission direction (up vector by default)
  14121. */
  14122. constructor(radius?: number,
  14123. /**
  14124. * The min limit of the emission direction.
  14125. */
  14126. direction1?: Vector3,
  14127. /**
  14128. * The max limit of the emission direction.
  14129. */
  14130. direction2?: Vector3);
  14131. /**
  14132. * Called by the particle System when the direction is computed for the created particle.
  14133. * @param worldMatrix is the world matrix of the particle system
  14134. * @param directionToUpdate is the direction vector to update with the result
  14135. * @param particle is the particle we are computed the direction for
  14136. */
  14137. startDirectionFunction(worldMatrix: Matrix, directionToUpdate: Vector3, particle: Particle): void;
  14138. /**
  14139. * Clones the current emitter and returns a copy of it
  14140. * @returns the new emitter
  14141. */
  14142. clone(): SphereDirectedParticleEmitter;
  14143. /**
  14144. * Called by the GPUParticleSystem to setup the update shader
  14145. * @param effect defines the update shader
  14146. */
  14147. applyToShader(effect: Effect): void;
  14148. /**
  14149. * Returns a string to use to update the GPU particles update shader
  14150. * @returns a string containng the defines string
  14151. */
  14152. getEffectDefines(): string;
  14153. /**
  14154. * Returns the string "SphereDirectedParticleEmitter"
  14155. * @returns a string containing the class name
  14156. */
  14157. getClassName(): string;
  14158. /**
  14159. * Serializes the particle system to a JSON object.
  14160. * @returns the JSON object
  14161. */
  14162. serialize(): any;
  14163. /**
  14164. * Parse properties from a JSON object
  14165. * @param serializationObject defines the JSON object
  14166. */
  14167. parse(serializationObject: any): void;
  14168. }
  14169. }
  14170. declare module "babylonjs/Particles/EmitterTypes/customParticleEmitter" {
  14171. import { Vector3, Matrix } from "babylonjs/Maths/math.vector";
  14172. import { Effect } from "babylonjs/Materials/effect";
  14173. import { Particle } from "babylonjs/Particles/particle";
  14174. import { IParticleEmitterType } from "babylonjs/Particles/EmitterTypes/IParticleEmitterType";
  14175. import { Nullable } from "babylonjs/types";
  14176. /**
  14177. * Particle emitter emitting particles from a custom list of positions.
  14178. */
  14179. export class CustomParticleEmitter implements IParticleEmitterType {
  14180. /**
  14181. * Gets or sets the position generator that will create the inital position of each particle.
  14182. * Index will be provided when used with GPU particle. Particle will be provided when used with CPU particles
  14183. */
  14184. particlePositionGenerator: (index: number, particle: Nullable<Particle>, outPosition: Vector3) => void;
  14185. /**
  14186. * Gets or sets the destination generator that will create the final destination of each particle.
  14187. * * Index will be provided when used with GPU particle. Particle will be provided when used with CPU particles
  14188. */
  14189. particleDestinationGenerator: (index: number, particle: Nullable<Particle>, outDestination: Vector3) => void;
  14190. /**
  14191. * Creates a new instance CustomParticleEmitter
  14192. */
  14193. constructor();
  14194. /**
  14195. * Called by the particle System when the direction is computed for the created particle.
  14196. * @param worldMatrix is the world matrix of the particle system
  14197. * @param directionToUpdate is the direction vector to update with the result
  14198. * @param particle is the particle we are computed the direction for
  14199. * @param isLocal defines if the direction should be set in local space
  14200. */
  14201. startDirectionFunction(worldMatrix: Matrix, directionToUpdate: Vector3, particle: Particle, isLocal: boolean): void;
  14202. /**
  14203. * Called by the particle System when the position is computed for the created particle.
  14204. * @param worldMatrix is the world matrix of the particle system
  14205. * @param positionToUpdate is the position vector to update with the result
  14206. * @param particle is the particle we are computed the position for
  14207. * @param isLocal defines if the position should be set in local space
  14208. */
  14209. startPositionFunction(worldMatrix: Matrix, positionToUpdate: Vector3, particle: Particle, isLocal: boolean): void;
  14210. /**
  14211. * Clones the current emitter and returns a copy of it
  14212. * @returns the new emitter
  14213. */
  14214. clone(): CustomParticleEmitter;
  14215. /**
  14216. * Called by the GPUParticleSystem to setup the update shader
  14217. * @param effect defines the update shader
  14218. */
  14219. applyToShader(effect: Effect): void;
  14220. /**
  14221. * Returns a string to use to update the GPU particles update shader
  14222. * @returns a string containng the defines string
  14223. */
  14224. getEffectDefines(): string;
  14225. /**
  14226. * Returns the string "PointParticleEmitter"
  14227. * @returns a string containing the class name
  14228. */
  14229. getClassName(): string;
  14230. /**
  14231. * Serializes the particle system to a JSON object.
  14232. * @returns the JSON object
  14233. */
  14234. serialize(): any;
  14235. /**
  14236. * Parse properties from a JSON object
  14237. * @param serializationObject defines the JSON object
  14238. */
  14239. parse(serializationObject: any): void;
  14240. }
  14241. }
  14242. declare module "babylonjs/Particles/EmitterTypes/meshParticleEmitter" {
  14243. import { Vector3, Matrix } from "babylonjs/Maths/math.vector";
  14244. import { Effect } from "babylonjs/Materials/effect";
  14245. import { Particle } from "babylonjs/Particles/particle";
  14246. import { IParticleEmitterType } from "babylonjs/Particles/EmitterTypes/IParticleEmitterType";
  14247. import { Nullable } from "babylonjs/types";
  14248. import { Scene } from "babylonjs/scene";
  14249. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  14250. /**
  14251. * Particle emitter emitting particles from the inside of a box.
  14252. * It emits the particles randomly between 2 given directions.
  14253. */
  14254. export class MeshParticleEmitter implements IParticleEmitterType {
  14255. private _indices;
  14256. private _positions;
  14257. private _normals;
  14258. private _storedNormal;
  14259. private _mesh;
  14260. /**
  14261. * Random direction of each particle after it has been emitted, between direction1 and direction2 vectors.
  14262. */
  14263. direction1: Vector3;
  14264. /**
  14265. * Random direction of each particle after it has been emitted, between direction1 and direction2 vectors.
  14266. */
  14267. direction2: Vector3;
  14268. /**
  14269. * Gets or sets a boolean indicating that particle directions must be built from mesh face normals
  14270. */
  14271. useMeshNormalsForDirection: boolean;
  14272. /** Defines the mesh to use as source */
  14273. get mesh(): Nullable<AbstractMesh>;
  14274. set mesh(value: Nullable<AbstractMesh>);
  14275. /**
  14276. * Creates a new instance MeshParticleEmitter
  14277. * @param mesh defines the mesh to use as source
  14278. */
  14279. constructor(mesh?: Nullable<AbstractMesh>);
  14280. /**
  14281. * Called by the particle System when the direction is computed for the created particle.
  14282. * @param worldMatrix is the world matrix of the particle system
  14283. * @param directionToUpdate is the direction vector to update with the result
  14284. * @param particle is the particle we are computed the direction for
  14285. * @param isLocal defines if the direction should be set in local space
  14286. */
  14287. startDirectionFunction(worldMatrix: Matrix, directionToUpdate: Vector3, particle: Particle, isLocal: boolean): void;
  14288. /**
  14289. * Called by the particle System when the position is computed for the created particle.
  14290. * @param worldMatrix is the world matrix of the particle system
  14291. * @param positionToUpdate is the position vector to update with the result
  14292. * @param particle is the particle we are computed the position for
  14293. * @param isLocal defines if the position should be set in local space
  14294. */
  14295. startPositionFunction(worldMatrix: Matrix, positionToUpdate: Vector3, particle: Particle, isLocal: boolean): void;
  14296. /**
  14297. * Clones the current emitter and returns a copy of it
  14298. * @returns the new emitter
  14299. */
  14300. clone(): MeshParticleEmitter;
  14301. /**
  14302. * Called by the GPUParticleSystem to setup the update shader
  14303. * @param effect defines the update shader
  14304. */
  14305. applyToShader(effect: Effect): void;
  14306. /**
  14307. * Returns a string to use to update the GPU particles update shader
  14308. * @returns a string containng the defines string
  14309. */
  14310. getEffectDefines(): string;
  14311. /**
  14312. * Returns the string "BoxParticleEmitter"
  14313. * @returns a string containing the class name
  14314. */
  14315. getClassName(): string;
  14316. /**
  14317. * Serializes the particle system to a JSON object.
  14318. * @returns the JSON object
  14319. */
  14320. serialize(): any;
  14321. /**
  14322. * Parse properties from a JSON object
  14323. * @param serializationObject defines the JSON object
  14324. * @param scene defines the hosting scene
  14325. */
  14326. parse(serializationObject: any, scene: Nullable<Scene>): void;
  14327. }
  14328. }
  14329. declare module "babylonjs/Particles/EmitterTypes/index" {
  14330. export * from "babylonjs/Particles/EmitterTypes/boxParticleEmitter";
  14331. export * from "babylonjs/Particles/EmitterTypes/coneParticleEmitter";
  14332. export * from "babylonjs/Particles/EmitterTypes/cylinderParticleEmitter";
  14333. export * from "babylonjs/Particles/EmitterTypes/hemisphericParticleEmitter";
  14334. export * from "babylonjs/Particles/EmitterTypes/IParticleEmitterType";
  14335. export * from "babylonjs/Particles/EmitterTypes/pointParticleEmitter";
  14336. export * from "babylonjs/Particles/EmitterTypes/sphereParticleEmitter";
  14337. export * from "babylonjs/Particles/EmitterTypes/customParticleEmitter";
  14338. export * from "babylonjs/Particles/EmitterTypes/meshParticleEmitter";
  14339. }
  14340. declare module "babylonjs/Particles/IParticleSystem" {
  14341. import { Nullable } from "babylonjs/types";
  14342. import { Vector2, Vector3, Matrix } from "babylonjs/Maths/math.vector";
  14343. import { Color3, Color4 } from "babylonjs/Maths/math.color";
  14344. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  14345. import { BoxParticleEmitter, IParticleEmitterType, PointParticleEmitter, HemisphericParticleEmitter, SphereParticleEmitter, SphereDirectedParticleEmitter, CylinderParticleEmitter, ConeParticleEmitter } from "babylonjs/Particles/EmitterTypes/index";
  14346. import { Scene } from "babylonjs/scene";
  14347. import { ColorGradient, FactorGradient, Color3Gradient } from "babylonjs/Misc/gradients";
  14348. import { Effect } from "babylonjs/Materials/effect";
  14349. import { Observable } from "babylonjs/Misc/observable";
  14350. import { Animation } from "babylonjs/Animations/animation";
  14351. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  14352. /**
  14353. * Interface representing a particle system in Babylon.js.
  14354. * This groups the common functionalities that needs to be implemented in order to create a particle system.
  14355. * A particle system represents a way to manage particles from their emission to their animation and rendering.
  14356. */
  14357. export interface IParticleSystem {
  14358. /**
  14359. * List of animations used by the particle system.
  14360. */
  14361. animations: Animation[];
  14362. /**
  14363. * The id of the Particle system.
  14364. */
  14365. id: string;
  14366. /**
  14367. * The name of the Particle system.
  14368. */
  14369. name: string;
  14370. /**
  14371. * The emitter represents the Mesh or position we are attaching the particle system to.
  14372. */
  14373. emitter: Nullable<AbstractMesh | Vector3>;
  14374. /**
  14375. * Gets or sets a boolean indicating if the particles must be rendered as billboard or aligned with the direction
  14376. */
  14377. isBillboardBased: boolean;
  14378. /**
  14379. * The rendering group used by the Particle system to chose when to render.
  14380. */
  14381. renderingGroupId: number;
  14382. /**
  14383. * The layer mask we are rendering the particles through.
  14384. */
  14385. layerMask: number;
  14386. /**
  14387. * The overall motion speed (0.01 is default update speed, faster updates = faster animation)
  14388. */
  14389. updateSpeed: number;
  14390. /**
  14391. * The amount of time the particle system is running (depends of the overall update speed).
  14392. */
  14393. targetStopDuration: number;
  14394. /**
  14395. * The texture used to render each particle. (this can be a spritesheet)
  14396. */
  14397. particleTexture: Nullable<BaseTexture>;
  14398. /**
  14399. * Blend mode use to render the particle, it can be either ParticleSystem.BLENDMODE_ONEONE, ParticleSystem.BLENDMODE_STANDARD or ParticleSystem.BLENDMODE_ADD.
  14400. */
  14401. blendMode: number;
  14402. /**
  14403. * Minimum life time of emitting particles.
  14404. */
  14405. minLifeTime: number;
  14406. /**
  14407. * Maximum life time of emitting particles.
  14408. */
  14409. maxLifeTime: number;
  14410. /**
  14411. * Minimum Size of emitting particles.
  14412. */
  14413. minSize: number;
  14414. /**
  14415. * Maximum Size of emitting particles.
  14416. */
  14417. maxSize: number;
  14418. /**
  14419. * Minimum scale of emitting particles on X axis.
  14420. */
  14421. minScaleX: number;
  14422. /**
  14423. * Maximum scale of emitting particles on X axis.
  14424. */
  14425. maxScaleX: number;
  14426. /**
  14427. * Minimum scale of emitting particles on Y axis.
  14428. */
  14429. minScaleY: number;
  14430. /**
  14431. * Maximum scale of emitting particles on Y axis.
  14432. */
  14433. maxScaleY: number;
  14434. /**
  14435. * Random color of each particle after it has been emitted, between color1 and color2 vectors.
  14436. */
  14437. color1: Color4;
  14438. /**
  14439. * Random color of each particle after it has been emitted, between color1 and color2 vectors.
  14440. */
  14441. color2: Color4;
  14442. /**
  14443. * Color the particle will have at the end of its lifetime.
  14444. */
  14445. colorDead: Color4;
  14446. /**
  14447. * The maximum number of particles to emit per frame until we reach the activeParticleCount value
  14448. */
  14449. emitRate: number;
  14450. /**
  14451. * You can use gravity if you want to give an orientation to your particles.
  14452. */
  14453. gravity: Vector3;
  14454. /**
  14455. * Minimum power of emitting particles.
  14456. */
  14457. minEmitPower: number;
  14458. /**
  14459. * Maximum power of emitting particles.
  14460. */
  14461. maxEmitPower: number;
  14462. /**
  14463. * Minimum angular speed of emitting particles (Z-axis rotation for each particle).
  14464. */
  14465. minAngularSpeed: number;
  14466. /**
  14467. * Maximum angular speed of emitting particles (Z-axis rotation for each particle).
  14468. */
  14469. maxAngularSpeed: number;
  14470. /**
  14471. * Gets or sets the minimal initial rotation in radians.
  14472. */
  14473. minInitialRotation: number;
  14474. /**
  14475. * Gets or sets the maximal initial rotation in radians.
  14476. */
  14477. maxInitialRotation: number;
  14478. /**
  14479. * The particle emitter type defines the emitter used by the particle system.
  14480. * It can be for example box, sphere, or cone...
  14481. */
  14482. particleEmitterType: Nullable<IParticleEmitterType>;
  14483. /**
  14484. * Defines the delay in milliseconds before starting the system (0 by default)
  14485. */
  14486. startDelay: number;
  14487. /**
  14488. * Gets or sets a value indicating how many cycles (or frames) must be executed before first rendering (this value has to be set before starting the system). Default is 0
  14489. */
  14490. preWarmCycles: number;
  14491. /**
  14492. * Gets or sets a value indicating the time step multiplier to use in pre-warm mode (default is 1)
  14493. */
  14494. preWarmStepOffset: number;
  14495. /**
  14496. * If using a spritesheet (isAnimationSheetEnabled) defines the speed of the sprite loop (default is 1 meaning the animation will play once during the entire particle lifetime)
  14497. */
  14498. spriteCellChangeSpeed: number;
  14499. /**
  14500. * If using a spritesheet (isAnimationSheetEnabled) defines the first sprite cell to display
  14501. */
  14502. startSpriteCellID: number;
  14503. /**
  14504. * If using a spritesheet (isAnimationSheetEnabled) defines the last sprite cell to display
  14505. */
  14506. endSpriteCellID: number;
  14507. /**
  14508. * If using a spritesheet (isAnimationSheetEnabled), defines the sprite cell width to use
  14509. */
  14510. spriteCellWidth: number;
  14511. /**
  14512. * If using a spritesheet (isAnimationSheetEnabled), defines the sprite cell height to use
  14513. */
  14514. spriteCellHeight: number;
  14515. /**
  14516. * This allows the system to random pick the start cell ID between startSpriteCellID and endSpriteCellID
  14517. */
  14518. spriteRandomStartCell: boolean;
  14519. /**
  14520. * Gets or sets a boolean indicating if a spritesheet is used to animate the particles texture
  14521. */
  14522. isAnimationSheetEnabled: boolean;
  14523. /** Gets or sets a Vector2 used to move the pivot (by default (0,0)) */
  14524. translationPivot: Vector2;
  14525. /**
  14526. * Gets or sets a texture used to add random noise to particle positions
  14527. */
  14528. noiseTexture: Nullable<BaseTexture>;
  14529. /** Gets or sets the strength to apply to the noise value (default is (10, 10, 10)) */
  14530. noiseStrength: Vector3;
  14531. /**
  14532. * Gets or sets the billboard mode to use when isBillboardBased = true.
  14533. * Value can be: ParticleSystem.BILLBOARDMODE_ALL, ParticleSystem.BILLBOARDMODE_Y, ParticleSystem.BILLBOARDMODE_STRETCHED
  14534. */
  14535. billboardMode: number;
  14536. /** Gets or sets a value indicating the damping to apply if the limit velocity factor is reached */
  14537. limitVelocityDamping: number;
  14538. /**
  14539. * Gets or sets a boolean indicating that hosted animations (in the system.animations array) must be started when system.start() is called
  14540. */
  14541. beginAnimationOnStart: boolean;
  14542. /**
  14543. * Gets or sets the frame to start the animation from when beginAnimationOnStart is true
  14544. */
  14545. beginAnimationFrom: number;
  14546. /**
  14547. * Gets or sets the frame to end the animation on when beginAnimationOnStart is true
  14548. */
  14549. beginAnimationTo: number;
  14550. /**
  14551. * Gets or sets a boolean indicating if animations must loop when beginAnimationOnStart is true
  14552. */
  14553. beginAnimationLoop: boolean;
  14554. /**
  14555. * Specifies whether the particle system will be disposed once it reaches the end of the animation.
  14556. */
  14557. disposeOnStop: boolean;
  14558. /**
  14559. * Specifies if the particles are updated in emitter local space or world space
  14560. */
  14561. isLocal: boolean;
  14562. /** Snippet ID if the particle system was created from the snippet server */
  14563. snippetId: string;
  14564. /** Gets or sets a matrix to use to compute projection */
  14565. defaultProjectionMatrix: Matrix;
  14566. /**
  14567. * Gets the maximum number of particles active at the same time.
  14568. * @returns The max number of active particles.
  14569. */
  14570. getCapacity(): number;
  14571. /**
  14572. * Gets the number of particles active at the same time.
  14573. * @returns The number of active particles.
  14574. */
  14575. getActiveCount(): number;
  14576. /**
  14577. * Gets if the system has been started. (Note: this will still be true after stop is called)
  14578. * @returns True if it has been started, otherwise false.
  14579. */
  14580. isStarted(): boolean;
  14581. /**
  14582. * Animates the particle system for this frame.
  14583. */
  14584. animate(): void;
  14585. /**
  14586. * Renders the particle system in its current state.
  14587. * @returns the current number of particles
  14588. */
  14589. render(): number;
  14590. /**
  14591. * Dispose the particle system and frees its associated resources.
  14592. * @param disposeTexture defines if the particule texture must be disposed as well (true by default)
  14593. */
  14594. dispose(disposeTexture?: boolean): void;
  14595. /**
  14596. * An event triggered when the system is disposed
  14597. */
  14598. onDisposeObservable: Observable<IParticleSystem>;
  14599. /**
  14600. * Clones the particle system.
  14601. * @param name The name of the cloned object
  14602. * @param newEmitter The new emitter to use
  14603. * @returns the cloned particle system
  14604. */
  14605. clone(name: string, newEmitter: any): Nullable<IParticleSystem>;
  14606. /**
  14607. * Serializes the particle system to a JSON object
  14608. * @param serializeTexture defines if the texture must be serialized as well
  14609. * @returns the JSON object
  14610. */
  14611. serialize(serializeTexture: boolean): any;
  14612. /**
  14613. * Rebuild the particle system
  14614. */
  14615. rebuild(): void;
  14616. /** Force the system to rebuild all gradients that need to be resync */
  14617. forceRefreshGradients(): void;
  14618. /**
  14619. * Starts the particle system and begins to emit
  14620. * @param delay defines the delay in milliseconds before starting the system (0 by default)
  14621. */
  14622. start(delay?: number): void;
  14623. /**
  14624. * Stops the particle system.
  14625. */
  14626. stop(): void;
  14627. /**
  14628. * Remove all active particles
  14629. */
  14630. reset(): void;
  14631. /**
  14632. * Gets a boolean indicating that the system is stopping
  14633. * @returns true if the system is currently stopping
  14634. */
  14635. isStopping(): boolean;
  14636. /**
  14637. * Is this system ready to be used/rendered
  14638. * @return true if the system is ready
  14639. */
  14640. isReady(): boolean;
  14641. /**
  14642. * Returns the string "ParticleSystem"
  14643. * @returns a string containing the class name
  14644. */
  14645. getClassName(): string;
  14646. /**
  14647. * Gets the custom effect used to render the particles
  14648. * @param blendMode Blend mode for which the effect should be retrieved
  14649. * @returns The effect
  14650. */
  14651. getCustomEffect(blendMode: number): Nullable<Effect>;
  14652. /**
  14653. * Sets the custom effect used to render the particles
  14654. * @param effect The effect to set
  14655. * @param blendMode Blend mode for which the effect should be set
  14656. */
  14657. setCustomEffect(effect: Nullable<Effect>, blendMode: number): void;
  14658. /**
  14659. * Fill the defines array according to the current settings of the particle system
  14660. * @param defines Array to be updated
  14661. * @param blendMode blend mode to take into account when updating the array
  14662. */
  14663. fillDefines(defines: Array<string>, blendMode: number): void;
  14664. /**
  14665. * Fill the uniforms, attributes and samplers arrays according to the current settings of the particle system
  14666. * @param uniforms Uniforms array to fill
  14667. * @param attributes Attributes array to fill
  14668. * @param samplers Samplers array to fill
  14669. */
  14670. fillUniformsAttributesAndSamplerNames(uniforms: Array<string>, attributes: Array<string>, samplers: Array<string>): void;
  14671. /**
  14672. * Observable that will be called just before the particles are drawn
  14673. */
  14674. onBeforeDrawParticlesObservable: Observable<Nullable<Effect>>;
  14675. /**
  14676. * Gets the name of the particle vertex shader
  14677. */
  14678. vertexShaderName: string;
  14679. /**
  14680. * Adds a new color gradient
  14681. * @param gradient defines the gradient to use (between 0 and 1)
  14682. * @param color1 defines the color to affect to the specified gradient
  14683. * @param color2 defines an additional color used to define a range ([color, color2]) with main color to pick the final color from
  14684. * @returns the current particle system
  14685. */
  14686. addColorGradient(gradient: number, color1: Color4, color2?: Color4): IParticleSystem;
  14687. /**
  14688. * Remove a specific color gradient
  14689. * @param gradient defines the gradient to remove
  14690. * @returns the current particle system
  14691. */
  14692. removeColorGradient(gradient: number): IParticleSystem;
  14693. /**
  14694. * Adds a new size gradient
  14695. * @param gradient defines the gradient to use (between 0 and 1)
  14696. * @param factor defines the size factor to affect to the specified gradient
  14697. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  14698. * @returns the current particle system
  14699. */
  14700. addSizeGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  14701. /**
  14702. * Remove a specific size gradient
  14703. * @param gradient defines the gradient to remove
  14704. * @returns the current particle system
  14705. */
  14706. removeSizeGradient(gradient: number): IParticleSystem;
  14707. /**
  14708. * Gets the current list of color gradients.
  14709. * You must use addColorGradient and removeColorGradient to udpate this list
  14710. * @returns the list of color gradients
  14711. */
  14712. getColorGradients(): Nullable<Array<ColorGradient>>;
  14713. /**
  14714. * Gets the current list of size gradients.
  14715. * You must use addSizeGradient and removeSizeGradient to udpate this list
  14716. * @returns the list of size gradients
  14717. */
  14718. getSizeGradients(): Nullable<Array<FactorGradient>>;
  14719. /**
  14720. * Gets the current list of angular speed gradients.
  14721. * You must use addAngularSpeedGradient and removeAngularSpeedGradient to udpate this list
  14722. * @returns the list of angular speed gradients
  14723. */
  14724. getAngularSpeedGradients(): Nullable<Array<FactorGradient>>;
  14725. /**
  14726. * Adds a new angular speed gradient
  14727. * @param gradient defines the gradient to use (between 0 and 1)
  14728. * @param factor defines the angular speed to affect to the specified gradient
  14729. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  14730. * @returns the current particle system
  14731. */
  14732. addAngularSpeedGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  14733. /**
  14734. * Remove a specific angular speed gradient
  14735. * @param gradient defines the gradient to remove
  14736. * @returns the current particle system
  14737. */
  14738. removeAngularSpeedGradient(gradient: number): IParticleSystem;
  14739. /**
  14740. * Gets the current list of velocity gradients.
  14741. * You must use addVelocityGradient and removeVelocityGradient to udpate this list
  14742. * @returns the list of velocity gradients
  14743. */
  14744. getVelocityGradients(): Nullable<Array<FactorGradient>>;
  14745. /**
  14746. * Adds a new velocity gradient
  14747. * @param gradient defines the gradient to use (between 0 and 1)
  14748. * @param factor defines the velocity to affect to the specified gradient
  14749. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  14750. * @returns the current particle system
  14751. */
  14752. addVelocityGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  14753. /**
  14754. * Remove a specific velocity gradient
  14755. * @param gradient defines the gradient to remove
  14756. * @returns the current particle system
  14757. */
  14758. removeVelocityGradient(gradient: number): IParticleSystem;
  14759. /**
  14760. * Gets the current list of limit velocity gradients.
  14761. * You must use addLimitVelocityGradient and removeLimitVelocityGradient to udpate this list
  14762. * @returns the list of limit velocity gradients
  14763. */
  14764. getLimitVelocityGradients(): Nullable<Array<FactorGradient>>;
  14765. /**
  14766. * Adds a new limit velocity gradient
  14767. * @param gradient defines the gradient to use (between 0 and 1)
  14768. * @param factor defines the limit velocity to affect to the specified gradient
  14769. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  14770. * @returns the current particle system
  14771. */
  14772. addLimitVelocityGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  14773. /**
  14774. * Remove a specific limit velocity gradient
  14775. * @param gradient defines the gradient to remove
  14776. * @returns the current particle system
  14777. */
  14778. removeLimitVelocityGradient(gradient: number): IParticleSystem;
  14779. /**
  14780. * Adds a new drag gradient
  14781. * @param gradient defines the gradient to use (between 0 and 1)
  14782. * @param factor defines the drag to affect to the specified gradient
  14783. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  14784. * @returns the current particle system
  14785. */
  14786. addDragGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  14787. /**
  14788. * Remove a specific drag gradient
  14789. * @param gradient defines the gradient to remove
  14790. * @returns the current particle system
  14791. */
  14792. removeDragGradient(gradient: number): IParticleSystem;
  14793. /**
  14794. * Gets the current list of drag gradients.
  14795. * You must use addDragGradient and removeDragGradient to udpate this list
  14796. * @returns the list of drag gradients
  14797. */
  14798. getDragGradients(): Nullable<Array<FactorGradient>>;
  14799. /**
  14800. * Adds a new emit rate gradient (please note that this will only work if you set the targetStopDuration property)
  14801. * @param gradient defines the gradient to use (between 0 and 1)
  14802. * @param factor defines the emit rate to affect to the specified gradient
  14803. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  14804. * @returns the current particle system
  14805. */
  14806. addEmitRateGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  14807. /**
  14808. * Remove a specific emit rate gradient
  14809. * @param gradient defines the gradient to remove
  14810. * @returns the current particle system
  14811. */
  14812. removeEmitRateGradient(gradient: number): IParticleSystem;
  14813. /**
  14814. * Gets the current list of emit rate gradients.
  14815. * You must use addEmitRateGradient and removeEmitRateGradient to udpate this list
  14816. * @returns the list of emit rate gradients
  14817. */
  14818. getEmitRateGradients(): Nullable<Array<FactorGradient>>;
  14819. /**
  14820. * Adds a new start size gradient (please note that this will only work if you set the targetStopDuration property)
  14821. * @param gradient defines the gradient to use (between 0 and 1)
  14822. * @param factor defines the start size to affect to the specified gradient
  14823. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  14824. * @returns the current particle system
  14825. */
  14826. addStartSizeGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  14827. /**
  14828. * Remove a specific start size gradient
  14829. * @param gradient defines the gradient to remove
  14830. * @returns the current particle system
  14831. */
  14832. removeStartSizeGradient(gradient: number): IParticleSystem;
  14833. /**
  14834. * Gets the current list of start size gradients.
  14835. * You must use addStartSizeGradient and removeStartSizeGradient to udpate this list
  14836. * @returns the list of start size gradients
  14837. */
  14838. getStartSizeGradients(): Nullable<Array<FactorGradient>>;
  14839. /**
  14840. * Adds a new life time gradient
  14841. * @param gradient defines the gradient to use (between 0 and 1)
  14842. * @param factor defines the life time factor to affect to the specified gradient
  14843. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  14844. * @returns the current particle system
  14845. */
  14846. addLifeTimeGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  14847. /**
  14848. * Remove a specific life time gradient
  14849. * @param gradient defines the gradient to remove
  14850. * @returns the current particle system
  14851. */
  14852. removeLifeTimeGradient(gradient: number): IParticleSystem;
  14853. /**
  14854. * Gets the current list of life time gradients.
  14855. * You must use addLifeTimeGradient and removeLifeTimeGradient to udpate this list
  14856. * @returns the list of life time gradients
  14857. */
  14858. getLifeTimeGradients(): Nullable<Array<FactorGradient>>;
  14859. /**
  14860. * Gets the current list of color gradients.
  14861. * You must use addColorGradient and removeColorGradient to udpate this list
  14862. * @returns the list of color gradients
  14863. */
  14864. getColorGradients(): Nullable<Array<ColorGradient>>;
  14865. /**
  14866. * Adds a new ramp gradient used to remap particle colors
  14867. * @param gradient defines the gradient to use (between 0 and 1)
  14868. * @param color defines the color to affect to the specified gradient
  14869. * @returns the current particle system
  14870. */
  14871. addRampGradient(gradient: number, color: Color3): IParticleSystem;
  14872. /**
  14873. * Gets the current list of ramp gradients.
  14874. * You must use addRampGradient and removeRampGradient to udpate this list
  14875. * @returns the list of ramp gradients
  14876. */
  14877. getRampGradients(): Nullable<Array<Color3Gradient>>;
  14878. /** Gets or sets a boolean indicating that ramp gradients must be used
  14879. * @see https://doc.babylonjs.com/babylon101/particles#ramp-gradients
  14880. */
  14881. useRampGradients: boolean;
  14882. /**
  14883. * Adds a new color remap gradient
  14884. * @param gradient defines the gradient to use (between 0 and 1)
  14885. * @param min defines the color remap minimal range
  14886. * @param max defines the color remap maximal range
  14887. * @returns the current particle system
  14888. */
  14889. addColorRemapGradient(gradient: number, min: number, max: number): IParticleSystem;
  14890. /**
  14891. * Gets the current list of color remap gradients.
  14892. * You must use addColorRemapGradient and removeColorRemapGradient to udpate this list
  14893. * @returns the list of color remap gradients
  14894. */
  14895. getColorRemapGradients(): Nullable<Array<FactorGradient>>;
  14896. /**
  14897. * Adds a new alpha remap gradient
  14898. * @param gradient defines the gradient to use (between 0 and 1)
  14899. * @param min defines the alpha remap minimal range
  14900. * @param max defines the alpha remap maximal range
  14901. * @returns the current particle system
  14902. */
  14903. addAlphaRemapGradient(gradient: number, min: number, max: number): IParticleSystem;
  14904. /**
  14905. * Gets the current list of alpha remap gradients.
  14906. * You must use addAlphaRemapGradient and removeAlphaRemapGradient to udpate this list
  14907. * @returns the list of alpha remap gradients
  14908. */
  14909. getAlphaRemapGradients(): Nullable<Array<FactorGradient>>;
  14910. /**
  14911. * Creates a Point Emitter for the particle system (emits directly from the emitter position)
  14912. * @param direction1 Particles are emitted between the direction1 and direction2 from within the box
  14913. * @param direction2 Particles are emitted between the direction1 and direction2 from within the box
  14914. * @returns the emitter
  14915. */
  14916. createPointEmitter(direction1: Vector3, direction2: Vector3): PointParticleEmitter;
  14917. /**
  14918. * Creates a Hemisphere Emitter for the particle system (emits along the hemisphere radius)
  14919. * @param radius The radius of the hemisphere to emit from
  14920. * @param radiusRange The range of the hemisphere to emit from [0-1] 0 Surface Only, 1 Entire Radius
  14921. * @returns the emitter
  14922. */
  14923. createHemisphericEmitter(radius: number, radiusRange: number): HemisphericParticleEmitter;
  14924. /**
  14925. * Creates a Sphere Emitter for the particle system (emits along the sphere radius)
  14926. * @param radius The radius of the sphere to emit from
  14927. * @param radiusRange The range of the sphere to emit from [0-1] 0 Surface Only, 1 Entire Radius
  14928. * @returns the emitter
  14929. */
  14930. createSphereEmitter(radius: number, radiusRange: number): SphereParticleEmitter;
  14931. /**
  14932. * Creates a Directed Sphere Emitter for the particle system (emits between direction1 and direction2)
  14933. * @param radius The radius of the sphere to emit from
  14934. * @param direction1 Particles are emitted between the direction1 and direction2 from within the sphere
  14935. * @param direction2 Particles are emitted between the direction1 and direction2 from within the sphere
  14936. * @returns the emitter
  14937. */
  14938. createDirectedSphereEmitter(radius: number, direction1: Vector3, direction2: Vector3): SphereDirectedParticleEmitter;
  14939. /**
  14940. * Creates a Cylinder Emitter for the particle system (emits from the cylinder to the particle position)
  14941. * @param radius The radius of the emission cylinder
  14942. * @param height The height of the emission cylinder
  14943. * @param radiusRange The range of emission [0-1] 0 Surface only, 1 Entire Radius
  14944. * @param directionRandomizer How much to randomize the particle direction [0-1]
  14945. * @returns the emitter
  14946. */
  14947. createCylinderEmitter(radius: number, height: number, radiusRange: number, directionRandomizer: number): CylinderParticleEmitter;
  14948. /**
  14949. * Creates a Directed Cylinder Emitter for the particle system (emits between direction1 and direction2)
  14950. * @param radius The radius of the cylinder to emit from
  14951. * @param height The height of the emission cylinder
  14952. * @param radiusRange the range of the emission cylinder [0-1] 0 Surface only, 1 Entire Radius (1 by default)
  14953. * @param direction1 Particles are emitted between the direction1 and direction2 from within the cylinder
  14954. * @param direction2 Particles are emitted between the direction1 and direction2 from within the cylinder
  14955. * @returns the emitter
  14956. */
  14957. createDirectedCylinderEmitter(radius: number, height: number, radiusRange: number, direction1: Vector3, direction2: Vector3): SphereDirectedParticleEmitter;
  14958. /**
  14959. * Creates a Cone Emitter for the particle system (emits from the cone to the particle position)
  14960. * @param radius The radius of the cone to emit from
  14961. * @param angle The base angle of the cone
  14962. * @returns the emitter
  14963. */
  14964. createConeEmitter(radius: number, angle: number): ConeParticleEmitter;
  14965. /**
  14966. * Creates a Box Emitter for the particle system. (emits between direction1 and direction2 from withing the box defined by minEmitBox and maxEmitBox)
  14967. * @param direction1 Particles are emitted between the direction1 and direction2 from within the box
  14968. * @param direction2 Particles are emitted between the direction1 and direction2 from within the box
  14969. * @param minEmitBox Particles are emitted from the box between minEmitBox and maxEmitBox
  14970. * @param maxEmitBox Particles are emitted from the box between minEmitBox and maxEmitBox
  14971. * @returns the emitter
  14972. */
  14973. createBoxEmitter(direction1: Vector3, direction2: Vector3, minEmitBox: Vector3, maxEmitBox: Vector3): BoxParticleEmitter;
  14974. /**
  14975. * Get hosting scene
  14976. * @returns the scene
  14977. */
  14978. getScene(): Nullable<Scene>;
  14979. }
  14980. }
  14981. declare module "babylonjs/Meshes/transformNode" {
  14982. import { DeepImmutable } from "babylonjs/types";
  14983. import { Observable } from "babylonjs/Misc/observable";
  14984. import { Nullable } from "babylonjs/types";
  14985. import { Camera } from "babylonjs/Cameras/camera";
  14986. import { Scene } from "babylonjs/scene";
  14987. import { Quaternion, Matrix, Vector3 } from "babylonjs/Maths/math.vector";
  14988. import { Node } from "babylonjs/node";
  14989. import { Bone } from "babylonjs/Bones/bone";
  14990. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  14991. import { Space } from "babylonjs/Maths/math.axis";
  14992. /**
  14993. * A TransformNode is an object that is not rendered but can be used as a center of transformation. This can decrease memory usage and increase rendering speed compared to using an empty mesh as a parent and is less complicated than using a pivot matrix.
  14994. * @see https://doc.babylonjs.com/how_to/transformnode
  14995. */
  14996. export class TransformNode extends Node {
  14997. /**
  14998. * Object will not rotate to face the camera
  14999. */
  15000. static BILLBOARDMODE_NONE: number;
  15001. /**
  15002. * Object will rotate to face the camera but only on the x axis
  15003. */
  15004. static BILLBOARDMODE_X: number;
  15005. /**
  15006. * Object will rotate to face the camera but only on the y axis
  15007. */
  15008. static BILLBOARDMODE_Y: number;
  15009. /**
  15010. * Object will rotate to face the camera but only on the z axis
  15011. */
  15012. static BILLBOARDMODE_Z: number;
  15013. /**
  15014. * Object will rotate to face the camera
  15015. */
  15016. static BILLBOARDMODE_ALL: number;
  15017. /**
  15018. * Object will rotate to face the camera's position instead of orientation
  15019. */
  15020. static BILLBOARDMODE_USE_POSITION: number;
  15021. private static _TmpRotation;
  15022. private static _TmpScaling;
  15023. private static _TmpTranslation;
  15024. private _forward;
  15025. private _forwardInverted;
  15026. private _up;
  15027. private _right;
  15028. private _rightInverted;
  15029. private _position;
  15030. private _rotation;
  15031. private _rotationQuaternion;
  15032. protected _scaling: Vector3;
  15033. protected _isDirty: boolean;
  15034. private _transformToBoneReferal;
  15035. private _isAbsoluteSynced;
  15036. private _billboardMode;
  15037. /**
  15038. * Gets or sets the billboard mode. Default is 0.
  15039. *
  15040. * | Value | Type | Description |
  15041. * | --- | --- | --- |
  15042. * | 0 | BILLBOARDMODE_NONE | |
  15043. * | 1 | BILLBOARDMODE_X | |
  15044. * | 2 | BILLBOARDMODE_Y | |
  15045. * | 4 | BILLBOARDMODE_Z | |
  15046. * | 7 | BILLBOARDMODE_ALL | |
  15047. *
  15048. */
  15049. get billboardMode(): number;
  15050. set billboardMode(value: number);
  15051. private _preserveParentRotationForBillboard;
  15052. /**
  15053. * Gets or sets a boolean indicating that parent rotation should be preserved when using billboards.
  15054. * This could be useful for glTF objects where parent rotation helps converting from right handed to left handed
  15055. */
  15056. get preserveParentRotationForBillboard(): boolean;
  15057. set preserveParentRotationForBillboard(value: boolean);
  15058. /**
  15059. * Multiplication factor on scale x/y/z when computing the world matrix. Eg. for a 1x1x1 cube setting this to 2 will make it a 2x2x2 cube
  15060. */
  15061. scalingDeterminant: number;
  15062. private _infiniteDistance;
  15063. /**
  15064. * Gets or sets the distance of the object to max, often used by skybox
  15065. */
  15066. get infiniteDistance(): boolean;
  15067. set infiniteDistance(value: boolean);
  15068. /**
  15069. * Gets or sets a boolean indicating that non uniform scaling (when at least one component is different from others) should be ignored.
  15070. * By default the system will update normals to compensate
  15071. */
  15072. ignoreNonUniformScaling: boolean;
  15073. /**
  15074. * Gets or sets a boolean indicating that even if rotationQuaternion is defined, you can keep updating rotation property and Babylon.js will just mix both
  15075. */
  15076. reIntegrateRotationIntoRotationQuaternion: boolean;
  15077. /** @hidden */
  15078. _poseMatrix: Nullable<Matrix>;
  15079. /** @hidden */
  15080. _localMatrix: Matrix;
  15081. private _usePivotMatrix;
  15082. private _absolutePosition;
  15083. private _absoluteScaling;
  15084. private _absoluteRotationQuaternion;
  15085. private _pivotMatrix;
  15086. private _pivotMatrixInverse;
  15087. protected _postMultiplyPivotMatrix: boolean;
  15088. protected _isWorldMatrixFrozen: boolean;
  15089. /** @hidden */
  15090. _indexInSceneTransformNodesArray: number;
  15091. /**
  15092. * An event triggered after the world matrix is updated
  15093. */
  15094. onAfterWorldMatrixUpdateObservable: Observable<TransformNode>;
  15095. constructor(name: string, scene?: Nullable<Scene>, isPure?: boolean);
  15096. /**
  15097. * Gets a string identifying the name of the class
  15098. * @returns "TransformNode" string
  15099. */
  15100. getClassName(): string;
  15101. /**
  15102. * Gets or set the node position (default is (0.0, 0.0, 0.0))
  15103. */
  15104. get position(): Vector3;
  15105. set position(newPosition: Vector3);
  15106. /**
  15107. * Gets or sets the rotation property : a Vector3 defining the rotation value in radians around each local axis X, Y, Z (default is (0.0, 0.0, 0.0)).
  15108. * If rotation quaternion is set, this Vector3 will be ignored and copy from the quaternion
  15109. */
  15110. get rotation(): Vector3;
  15111. set rotation(newRotation: Vector3);
  15112. /**
  15113. * Gets or sets the scaling property : a Vector3 defining the node scaling along each local axis X, Y, Z (default is (0.0, 0.0, 0.0)).
  15114. */
  15115. get scaling(): Vector3;
  15116. set scaling(newScaling: Vector3);
  15117. /**
  15118. * Gets or sets the rotation Quaternion property : this a Quaternion object defining the node rotation by using a unit quaternion (undefined by default, but can be null).
  15119. * If set, only the rotationQuaternion is then used to compute the node rotation (ie. node.rotation will be ignored)
  15120. */
  15121. get rotationQuaternion(): Nullable<Quaternion>;
  15122. set rotationQuaternion(quaternion: Nullable<Quaternion>);
  15123. /**
  15124. * The forward direction of that transform in world space.
  15125. */
  15126. get forward(): Vector3;
  15127. /**
  15128. * The up direction of that transform in world space.
  15129. */
  15130. get up(): Vector3;
  15131. /**
  15132. * The right direction of that transform in world space.
  15133. */
  15134. get right(): Vector3;
  15135. /**
  15136. * Copies the parameter passed Matrix into the mesh Pose matrix.
  15137. * @param matrix the matrix to copy the pose from
  15138. * @returns this TransformNode.
  15139. */
  15140. updatePoseMatrix(matrix: Matrix): TransformNode;
  15141. /**
  15142. * Returns the mesh Pose matrix.
  15143. * @returns the pose matrix
  15144. */
  15145. getPoseMatrix(): Matrix;
  15146. /** @hidden */
  15147. _isSynchronized(): boolean;
  15148. /** @hidden */
  15149. _initCache(): void;
  15150. /**
  15151. * Flag the transform node as dirty (Forcing it to update everything)
  15152. * @param property if set to "rotation" the objects rotationQuaternion will be set to null
  15153. * @returns this transform node
  15154. */
  15155. markAsDirty(property: string): TransformNode;
  15156. /**
  15157. * Returns the current mesh absolute position.
  15158. * Returns a Vector3.
  15159. */
  15160. get absolutePosition(): Vector3;
  15161. /**
  15162. * Returns the current mesh absolute scaling.
  15163. * Returns a Vector3.
  15164. */
  15165. get absoluteScaling(): Vector3;
  15166. /**
  15167. * Returns the current mesh absolute rotation.
  15168. * Returns a Quaternion.
  15169. */
  15170. get absoluteRotationQuaternion(): Quaternion;
  15171. /**
  15172. * Sets a new matrix to apply before all other transformation
  15173. * @param matrix defines the transform matrix
  15174. * @returns the current TransformNode
  15175. */
  15176. setPreTransformMatrix(matrix: Matrix): TransformNode;
  15177. /**
  15178. * Sets a new pivot matrix to the current node
  15179. * @param matrix defines the new pivot matrix to use
  15180. * @param postMultiplyPivotMatrix defines if the pivot matrix must be cancelled in the world matrix. When this parameter is set to true (default), the inverse of the pivot matrix is also applied at the end to cancel the transformation effect
  15181. * @returns the current TransformNode
  15182. */
  15183. setPivotMatrix(matrix: DeepImmutable<Matrix>, postMultiplyPivotMatrix?: boolean): TransformNode;
  15184. /**
  15185. * Returns the mesh pivot matrix.
  15186. * Default : Identity.
  15187. * @returns the matrix
  15188. */
  15189. getPivotMatrix(): Matrix;
  15190. /**
  15191. * Instantiate (when possible) or clone that node with its hierarchy
  15192. * @param newParent defines the new parent to use for the instance (or clone)
  15193. * @param options defines options to configure how copy is done
  15194. * @param onNewNodeCreated defines an option callback to call when a clone or an instance is created
  15195. * @returns an instance (or a clone) of the current node with its hiearchy
  15196. */
  15197. instantiateHierarchy(newParent?: Nullable<TransformNode>, options?: {
  15198. doNotInstantiate: boolean;
  15199. }, onNewNodeCreated?: (source: TransformNode, clone: TransformNode) => void): Nullable<TransformNode>;
  15200. /**
  15201. * Prevents the World matrix to be computed any longer
  15202. * @param newWorldMatrix defines an optional matrix to use as world matrix
  15203. * @returns the TransformNode.
  15204. */
  15205. freezeWorldMatrix(newWorldMatrix?: Nullable<Matrix>): TransformNode;
  15206. /**
  15207. * Allows back the World matrix computation.
  15208. * @returns the TransformNode.
  15209. */
  15210. unfreezeWorldMatrix(): this;
  15211. /**
  15212. * True if the World matrix has been frozen.
  15213. */
  15214. get isWorldMatrixFrozen(): boolean;
  15215. /**
  15216. * Retuns the mesh absolute position in the World.
  15217. * @returns a Vector3.
  15218. */
  15219. getAbsolutePosition(): Vector3;
  15220. /**
  15221. * Sets the mesh absolute position in the World from a Vector3 or an Array(3).
  15222. * @param absolutePosition the absolute position to set
  15223. * @returns the TransformNode.
  15224. */
  15225. setAbsolutePosition(absolutePosition: Vector3): TransformNode;
  15226. /**
  15227. * Sets the mesh position in its local space.
  15228. * @param vector3 the position to set in localspace
  15229. * @returns the TransformNode.
  15230. */
  15231. setPositionWithLocalVector(vector3: Vector3): TransformNode;
  15232. /**
  15233. * Returns the mesh position in the local space from the current World matrix values.
  15234. * @returns a new Vector3.
  15235. */
  15236. getPositionExpressedInLocalSpace(): Vector3;
  15237. /**
  15238. * Translates the mesh along the passed Vector3 in its local space.
  15239. * @param vector3 the distance to translate in localspace
  15240. * @returns the TransformNode.
  15241. */
  15242. locallyTranslate(vector3: Vector3): TransformNode;
  15243. private static _lookAtVectorCache;
  15244. /**
  15245. * Orients a mesh towards a target point. Mesh must be drawn facing user.
  15246. * @param targetPoint the position (must be in same space as current mesh) to look at
  15247. * @param yawCor optional yaw (y-axis) correction in radians
  15248. * @param pitchCor optional pitch (x-axis) correction in radians
  15249. * @param rollCor optional roll (z-axis) correction in radians
  15250. * @param space the choosen space of the target
  15251. * @returns the TransformNode.
  15252. */
  15253. lookAt(targetPoint: Vector3, yawCor?: number, pitchCor?: number, rollCor?: number, space?: Space): TransformNode;
  15254. /**
  15255. * Returns a new Vector3 that is the localAxis, expressed in the mesh local space, rotated like the mesh.
  15256. * This Vector3 is expressed in the World space.
  15257. * @param localAxis axis to rotate
  15258. * @returns a new Vector3 that is the localAxis, expressed in the mesh local space, rotated like the mesh.
  15259. */
  15260. getDirection(localAxis: Vector3): Vector3;
  15261. /**
  15262. * Sets the Vector3 "result" as the rotated Vector3 "localAxis" in the same rotation than the mesh.
  15263. * localAxis is expressed in the mesh local space.
  15264. * result is computed in the Wordl space from the mesh World matrix.
  15265. * @param localAxis axis to rotate
  15266. * @param result the resulting transformnode
  15267. * @returns this TransformNode.
  15268. */
  15269. getDirectionToRef(localAxis: Vector3, result: Vector3): TransformNode;
  15270. /**
  15271. * Sets this transform node rotation to the given local axis.
  15272. * @param localAxis the axis in local space
  15273. * @param yawCor optional yaw (y-axis) correction in radians
  15274. * @param pitchCor optional pitch (x-axis) correction in radians
  15275. * @param rollCor optional roll (z-axis) correction in radians
  15276. * @returns this TransformNode
  15277. */
  15278. setDirection(localAxis: Vector3, yawCor?: number, pitchCor?: number, rollCor?: number): TransformNode;
  15279. /**
  15280. * Sets a new pivot point to the current node
  15281. * @param point defines the new pivot point to use
  15282. * @param space defines if the point is in world or local space (local by default)
  15283. * @returns the current TransformNode
  15284. */
  15285. setPivotPoint(point: Vector3, space?: Space): TransformNode;
  15286. /**
  15287. * Returns a new Vector3 set with the mesh pivot point coordinates in the local space.
  15288. * @returns the pivot point
  15289. */
  15290. getPivotPoint(): Vector3;
  15291. /**
  15292. * Sets the passed Vector3 "result" with the coordinates of the mesh pivot point in the local space.
  15293. * @param result the vector3 to store the result
  15294. * @returns this TransformNode.
  15295. */
  15296. getPivotPointToRef(result: Vector3): TransformNode;
  15297. /**
  15298. * Returns a new Vector3 set with the mesh pivot point World coordinates.
  15299. * @returns a new Vector3 set with the mesh pivot point World coordinates.
  15300. */
  15301. getAbsolutePivotPoint(): Vector3;
  15302. /**
  15303. * Sets the Vector3 "result" coordinates with the mesh pivot point World coordinates.
  15304. * @param result vector3 to store the result
  15305. * @returns this TransformNode.
  15306. */
  15307. getAbsolutePivotPointToRef(result: Vector3): TransformNode;
  15308. /**
  15309. * Defines the passed node as the parent of the current node.
  15310. * The node will remain exactly where it is and its position / rotation will be updated accordingly
  15311. * @see https://doc.babylonjs.com/how_to/parenting
  15312. * @param node the node ot set as the parent
  15313. * @returns this TransformNode.
  15314. */
  15315. setParent(node: Nullable<Node>): TransformNode;
  15316. private _nonUniformScaling;
  15317. /**
  15318. * True if the scaling property of this object is non uniform eg. (1,2,1)
  15319. */
  15320. get nonUniformScaling(): boolean;
  15321. /** @hidden */
  15322. _updateNonUniformScalingState(value: boolean): boolean;
  15323. /**
  15324. * Attach the current TransformNode to another TransformNode associated with a bone
  15325. * @param bone Bone affecting the TransformNode
  15326. * @param affectedTransformNode TransformNode associated with the bone
  15327. * @returns this object
  15328. */
  15329. attachToBone(bone: Bone, affectedTransformNode: TransformNode): TransformNode;
  15330. /**
  15331. * Detach the transform node if its associated with a bone
  15332. * @returns this object
  15333. */
  15334. detachFromBone(): TransformNode;
  15335. private static _rotationAxisCache;
  15336. /**
  15337. * Rotates the mesh around the axis vector for the passed angle (amount) expressed in radians, in the given space.
  15338. * space (default LOCAL) can be either Space.LOCAL, either Space.WORLD.
  15339. * Note that the property `rotationQuaternion` is then automatically updated and the property `rotation` is set to (0,0,0) and no longer used.
  15340. * The passed axis is also normalized.
  15341. * @param axis the axis to rotate around
  15342. * @param amount the amount to rotate in radians
  15343. * @param space Space to rotate in (Default: local)
  15344. * @returns the TransformNode.
  15345. */
  15346. rotate(axis: Vector3, amount: number, space?: Space): TransformNode;
  15347. /**
  15348. * Rotates the mesh around the axis vector for the passed angle (amount) expressed in radians, in world space.
  15349. * Note that the property `rotationQuaternion` is then automatically updated and the property `rotation` is set to (0,0,0) and no longer used.
  15350. * The passed axis is also normalized. .
  15351. * Method is based on http://www.euclideanspace.com/maths/geometry/affine/aroundPoint/index.htm
  15352. * @param point the point to rotate around
  15353. * @param axis the axis to rotate around
  15354. * @param amount the amount to rotate in radians
  15355. * @returns the TransformNode
  15356. */
  15357. rotateAround(point: Vector3, axis: Vector3, amount: number): TransformNode;
  15358. /**
  15359. * Translates the mesh along the axis vector for the passed distance in the given space.
  15360. * space (default LOCAL) can be either Space.LOCAL, either Space.WORLD.
  15361. * @param axis the axis to translate in
  15362. * @param distance the distance to translate
  15363. * @param space Space to rotate in (Default: local)
  15364. * @returns the TransformNode.
  15365. */
  15366. translate(axis: Vector3, distance: number, space?: Space): TransformNode;
  15367. /**
  15368. * Adds a rotation step to the mesh current rotation.
  15369. * x, y, z are Euler angles expressed in radians.
  15370. * This methods updates the current mesh rotation, either mesh.rotation, either mesh.rotationQuaternion if it's set.
  15371. * This means this rotation is made in the mesh local space only.
  15372. * It's useful to set a custom rotation order different from the BJS standard one YXZ.
  15373. * Example : this rotates the mesh first around its local X axis, then around its local Z axis, finally around its local Y axis.
  15374. * ```javascript
  15375. * mesh.addRotation(x1, 0, 0).addRotation(0, 0, z2).addRotation(0, 0, y3);
  15376. * ```
  15377. * Note that `addRotation()` accumulates the passed rotation values to the current ones and computes the .rotation or .rotationQuaternion updated values.
  15378. * Under the hood, only quaternions are used. So it's a little faster is you use .rotationQuaternion because it doesn't need to translate them back to Euler angles.
  15379. * @param x Rotation to add
  15380. * @param y Rotation to add
  15381. * @param z Rotation to add
  15382. * @returns the TransformNode.
  15383. */
  15384. addRotation(x: number, y: number, z: number): TransformNode;
  15385. /**
  15386. * @hidden
  15387. */
  15388. protected _getEffectiveParent(): Nullable<Node>;
  15389. /**
  15390. * Computes the world matrix of the node
  15391. * @param force defines if the cache version should be invalidated forcing the world matrix to be created from scratch
  15392. * @returns the world matrix
  15393. */
  15394. computeWorldMatrix(force?: boolean): Matrix;
  15395. /**
  15396. * Resets this nodeTransform's local matrix to Matrix.Identity().
  15397. * @param independentOfChildren indicates if all child nodeTransform's world-space transform should be preserved.
  15398. */
  15399. resetLocalMatrix(independentOfChildren?: boolean): void;
  15400. protected _afterComputeWorldMatrix(): void;
  15401. /**
  15402. * If you'd like to be called back after the mesh position, rotation or scaling has been updated.
  15403. * @param func callback function to add
  15404. *
  15405. * @returns the TransformNode.
  15406. */
  15407. registerAfterWorldMatrixUpdate(func: (mesh: TransformNode) => void): TransformNode;
  15408. /**
  15409. * Removes a registered callback function.
  15410. * @param func callback function to remove
  15411. * @returns the TransformNode.
  15412. */
  15413. unregisterAfterWorldMatrixUpdate(func: (mesh: TransformNode) => void): TransformNode;
  15414. /**
  15415. * Gets the position of the current mesh in camera space
  15416. * @param camera defines the camera to use
  15417. * @returns a position
  15418. */
  15419. getPositionInCameraSpace(camera?: Nullable<Camera>): Vector3;
  15420. /**
  15421. * Returns the distance from the mesh to the active camera
  15422. * @param camera defines the camera to use
  15423. * @returns the distance
  15424. */
  15425. getDistanceToCamera(camera?: Nullable<Camera>): number;
  15426. /**
  15427. * Clone the current transform node
  15428. * @param name Name of the new clone
  15429. * @param newParent New parent for the clone
  15430. * @param doNotCloneChildren Do not clone children hierarchy
  15431. * @returns the new transform node
  15432. */
  15433. clone(name: string, newParent: Nullable<Node>, doNotCloneChildren?: boolean): Nullable<TransformNode>;
  15434. /**
  15435. * Serializes the objects information.
  15436. * @param currentSerializationObject defines the object to serialize in
  15437. * @returns the serialized object
  15438. */
  15439. serialize(currentSerializationObject?: any): any;
  15440. /**
  15441. * Returns a new TransformNode object parsed from the source provided.
  15442. * @param parsedTransformNode is the source.
  15443. * @param scene the scne the object belongs to
  15444. * @param rootUrl is a string, it's the root URL to prefix the `delayLoadingFile` property with
  15445. * @returns a new TransformNode object parsed from the source provided.
  15446. */
  15447. static Parse(parsedTransformNode: any, scene: Scene, rootUrl: string): TransformNode;
  15448. /**
  15449. * Get all child-transformNodes of this node
  15450. * @param directDescendantsOnly defines if true only direct descendants of 'this' will be considered, if false direct and also indirect (children of children, an so on in a recursive manner) descendants of 'this' will be considered
  15451. * @param predicate defines an optional predicate that will be called on every evaluated child, the predicate must return true for a given child to be part of the result, otherwise it will be ignored
  15452. * @returns an array of TransformNode
  15453. */
  15454. getChildTransformNodes(directDescendantsOnly?: boolean, predicate?: (node: Node) => boolean): TransformNode[];
  15455. /**
  15456. * Releases resources associated with this transform node.
  15457. * @param doNotRecurse Set to true to not recurse into each children (recurse into each children by default)
  15458. * @param disposeMaterialAndTextures Set to true to also dispose referenced materials and textures (false by default)
  15459. */
  15460. dispose(doNotRecurse?: boolean, disposeMaterialAndTextures?: boolean): void;
  15461. /**
  15462. * Uniformly scales the mesh to fit inside of a unit cube (1 X 1 X 1 units)
  15463. * @param includeDescendants Use the hierarchy's bounding box instead of the mesh's bounding box. Default is false
  15464. * @param ignoreRotation ignore rotation when computing the scale (ie. object will be axis aligned). Default is false
  15465. * @param predicate predicate that is passed in to getHierarchyBoundingVectors when selecting which object should be included when scaling
  15466. * @returns the current mesh
  15467. */
  15468. normalizeToUnitCube(includeDescendants?: boolean, ignoreRotation?: boolean, predicate?: Nullable<(node: AbstractMesh) => boolean>): TransformNode;
  15469. private _syncAbsoluteScalingAndRotation;
  15470. }
  15471. }
  15472. declare module "babylonjs/Animations/animationPropertiesOverride" {
  15473. /**
  15474. * Class used to override all child animations of a given target
  15475. */
  15476. export class AnimationPropertiesOverride {
  15477. /**
  15478. * Gets or sets a value indicating if animation blending must be used
  15479. */
  15480. enableBlending: boolean;
  15481. /**
  15482. * Gets or sets the blending speed to use when enableBlending is true
  15483. */
  15484. blendingSpeed: number;
  15485. /**
  15486. * Gets or sets the default loop mode to use
  15487. */
  15488. loopMode: number;
  15489. }
  15490. }
  15491. declare module "babylonjs/Bones/bone" {
  15492. import { Skeleton } from "babylonjs/Bones/skeleton";
  15493. import { Vector3, Quaternion, Matrix } from "babylonjs/Maths/math.vector";
  15494. import { Nullable } from "babylonjs/types";
  15495. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  15496. import { TransformNode } from "babylonjs/Meshes/transformNode";
  15497. import { Node } from "babylonjs/node";
  15498. import { Space } from "babylonjs/Maths/math.axis";
  15499. import { AnimationPropertiesOverride } from "babylonjs/Animations/animationPropertiesOverride";
  15500. /**
  15501. * Class used to store bone information
  15502. * @see https://doc.babylonjs.com/how_to/how_to_use_bones_and_skeletons
  15503. */
  15504. export class Bone extends Node {
  15505. /**
  15506. * defines the bone name
  15507. */
  15508. name: string;
  15509. private static _tmpVecs;
  15510. private static _tmpQuat;
  15511. private static _tmpMats;
  15512. /**
  15513. * Gets the list of child bones
  15514. */
  15515. children: Bone[];
  15516. /** Gets the animations associated with this bone */
  15517. animations: import("babylonjs/Animations/animation").Animation[];
  15518. /**
  15519. * Gets or sets bone length
  15520. */
  15521. length: number;
  15522. /**
  15523. * @hidden Internal only
  15524. * Set this value to map this bone to a different index in the transform matrices
  15525. * Set this value to -1 to exclude the bone from the transform matrices
  15526. */
  15527. _index: Nullable<number>;
  15528. private _skeleton;
  15529. private _localMatrix;
  15530. private _restPose;
  15531. private _bindPose;
  15532. private _baseMatrix;
  15533. private _absoluteTransform;
  15534. private _invertedAbsoluteTransform;
  15535. private _parent;
  15536. private _scalingDeterminant;
  15537. private _worldTransform;
  15538. private _localScaling;
  15539. private _localRotation;
  15540. private _localPosition;
  15541. private _needToDecompose;
  15542. private _needToCompose;
  15543. /** @hidden */
  15544. _linkedTransformNode: Nullable<TransformNode>;
  15545. /** @hidden */
  15546. _waitingTransformNodeId: Nullable<string>;
  15547. /** @hidden */
  15548. get _matrix(): Matrix;
  15549. /** @hidden */
  15550. set _matrix(value: Matrix);
  15551. /**
  15552. * Create a new bone
  15553. * @param name defines the bone name
  15554. * @param skeleton defines the parent skeleton
  15555. * @param parentBone defines the parent (can be null if the bone is the root)
  15556. * @param localMatrix defines the local matrix
  15557. * @param restPose defines the rest pose matrix
  15558. * @param baseMatrix defines the base matrix
  15559. * @param index defines index of the bone in the hiearchy
  15560. */
  15561. constructor(
  15562. /**
  15563. * defines the bone name
  15564. */
  15565. name: string, skeleton: Skeleton, parentBone?: Nullable<Bone>, localMatrix?: Nullable<Matrix>, restPose?: Nullable<Matrix>, baseMatrix?: Nullable<Matrix>, index?: Nullable<number>);
  15566. /**
  15567. * Gets the current object class name.
  15568. * @return the class name
  15569. */
  15570. getClassName(): string;
  15571. /**
  15572. * Gets the parent skeleton
  15573. * @returns a skeleton
  15574. */
  15575. getSkeleton(): Skeleton;
  15576. /**
  15577. * Gets parent bone
  15578. * @returns a bone or null if the bone is the root of the bone hierarchy
  15579. */
  15580. getParent(): Nullable<Bone>;
  15581. /**
  15582. * Returns an array containing the root bones
  15583. * @returns an array containing the root bones
  15584. */
  15585. getChildren(): Array<Bone>;
  15586. /**
  15587. * Gets the node index in matrix array generated for rendering
  15588. * @returns the node index
  15589. */
  15590. getIndex(): number;
  15591. /**
  15592. * Sets the parent bone
  15593. * @param parent defines the parent (can be null if the bone is the root)
  15594. * @param updateDifferenceMatrix defines if the difference matrix must be updated
  15595. */
  15596. setParent(parent: Nullable<Bone>, updateDifferenceMatrix?: boolean): void;
  15597. /**
  15598. * Gets the local matrix
  15599. * @returns a matrix
  15600. */
  15601. getLocalMatrix(): Matrix;
  15602. /**
  15603. * Gets the base matrix (initial matrix which remains unchanged)
  15604. * @returns a matrix
  15605. */
  15606. getBaseMatrix(): Matrix;
  15607. /**
  15608. * Gets the rest pose matrix
  15609. * @returns a matrix
  15610. */
  15611. getRestPose(): Matrix;
  15612. /**
  15613. * Sets the rest pose matrix
  15614. * @param matrix the local-space rest pose to set for this bone
  15615. */
  15616. setRestPose(matrix: Matrix): void;
  15617. /**
  15618. * Gets the bind pose matrix
  15619. * @returns the bind pose matrix
  15620. */
  15621. getBindPose(): Matrix;
  15622. /**
  15623. * Sets the bind pose matrix
  15624. * @param matrix the local-space bind pose to set for this bone
  15625. */
  15626. setBindPose(matrix: Matrix): void;
  15627. /**
  15628. * Gets a matrix used to store world matrix (ie. the matrix sent to shaders)
  15629. */
  15630. getWorldMatrix(): Matrix;
  15631. /**
  15632. * Sets the local matrix to rest pose matrix
  15633. */
  15634. returnToRest(): void;
  15635. /**
  15636. * Gets the inverse of the absolute transform matrix.
  15637. * This matrix will be multiplied by local matrix to get the difference matrix (ie. the difference between original state and current state)
  15638. * @returns a matrix
  15639. */
  15640. getInvertedAbsoluteTransform(): Matrix;
  15641. /**
  15642. * Gets the absolute transform matrix (ie base matrix * parent world matrix)
  15643. * @returns a matrix
  15644. */
  15645. getAbsoluteTransform(): Matrix;
  15646. /**
  15647. * Links with the given transform node.
  15648. * The local matrix of this bone is copied from the transform node every frame.
  15649. * @param transformNode defines the transform node to link to
  15650. */
  15651. linkTransformNode(transformNode: Nullable<TransformNode>): void;
  15652. /**
  15653. * Gets the node used to drive the bone's transformation
  15654. * @returns a transform node or null
  15655. */
  15656. getTransformNode(): Nullable<TransformNode>;
  15657. /** Gets or sets current position (in local space) */
  15658. get position(): Vector3;
  15659. set position(newPosition: Vector3);
  15660. /** Gets or sets current rotation (in local space) */
  15661. get rotation(): Vector3;
  15662. set rotation(newRotation: Vector3);
  15663. /** Gets or sets current rotation quaternion (in local space) */
  15664. get rotationQuaternion(): Quaternion;
  15665. set rotationQuaternion(newRotation: Quaternion);
  15666. /** Gets or sets current scaling (in local space) */
  15667. get scaling(): Vector3;
  15668. set scaling(newScaling: Vector3);
  15669. /**
  15670. * Gets the animation properties override
  15671. */
  15672. get animationPropertiesOverride(): Nullable<AnimationPropertiesOverride>;
  15673. private _decompose;
  15674. private _compose;
  15675. /**
  15676. * Update the base and local matrices
  15677. * @param matrix defines the new base or local matrix
  15678. * @param updateDifferenceMatrix defines if the difference matrix must be updated
  15679. * @param updateLocalMatrix defines if the local matrix should be updated
  15680. */
  15681. updateMatrix(matrix: Matrix, updateDifferenceMatrix?: boolean, updateLocalMatrix?: boolean): void;
  15682. /** @hidden */
  15683. _updateDifferenceMatrix(rootMatrix?: Matrix, updateChildren?: boolean): void;
  15684. /**
  15685. * Flag the bone as dirty (Forcing it to update everything)
  15686. */
  15687. markAsDirty(): void;
  15688. /** @hidden */
  15689. _markAsDirtyAndCompose(): void;
  15690. private _markAsDirtyAndDecompose;
  15691. /**
  15692. * Translate the bone in local or world space
  15693. * @param vec The amount to translate the bone
  15694. * @param space The space that the translation is in
  15695. * @param mesh The mesh that this bone is attached to. This is only used in world space
  15696. */
  15697. translate(vec: Vector3, space?: Space, mesh?: AbstractMesh): void;
  15698. /**
  15699. * Set the postion of the bone in local or world space
  15700. * @param position The position to set the bone
  15701. * @param space The space that the position is in
  15702. * @param mesh The mesh that this bone is attached to. This is only used in world space
  15703. */
  15704. setPosition(position: Vector3, space?: Space, mesh?: AbstractMesh): void;
  15705. /**
  15706. * Set the absolute position of the bone (world space)
  15707. * @param position The position to set the bone
  15708. * @param mesh The mesh that this bone is attached to
  15709. */
  15710. setAbsolutePosition(position: Vector3, mesh?: AbstractMesh): void;
  15711. /**
  15712. * Scale the bone on the x, y and z axes (in local space)
  15713. * @param x The amount to scale the bone on the x axis
  15714. * @param y The amount to scale the bone on the y axis
  15715. * @param z The amount to scale the bone on the z axis
  15716. * @param scaleChildren sets this to true if children of the bone should be scaled as well (false by default)
  15717. */
  15718. scale(x: number, y: number, z: number, scaleChildren?: boolean): void;
  15719. /**
  15720. * Set the bone scaling in local space
  15721. * @param scale defines the scaling vector
  15722. */
  15723. setScale(scale: Vector3): void;
  15724. /**
  15725. * Gets the current scaling in local space
  15726. * @returns the current scaling vector
  15727. */
  15728. getScale(): Vector3;
  15729. /**
  15730. * Gets the current scaling in local space and stores it in a target vector
  15731. * @param result defines the target vector
  15732. */
  15733. getScaleToRef(result: Vector3): void;
  15734. /**
  15735. * Set the yaw, pitch, and roll of the bone in local or world space
  15736. * @param yaw The rotation of the bone on the y axis
  15737. * @param pitch The rotation of the bone on the x axis
  15738. * @param roll The rotation of the bone on the z axis
  15739. * @param space The space that the axes of rotation are in
  15740. * @param mesh The mesh that this bone is attached to. This is only used in world space
  15741. */
  15742. setYawPitchRoll(yaw: number, pitch: number, roll: number, space?: Space, mesh?: AbstractMesh): void;
  15743. /**
  15744. * Add a rotation to the bone on an axis in local or world space
  15745. * @param axis The axis to rotate the bone on
  15746. * @param amount The amount to rotate the bone
  15747. * @param space The space that the axis is in
  15748. * @param mesh The mesh that this bone is attached to. This is only used in world space
  15749. */
  15750. rotate(axis: Vector3, amount: number, space?: Space, mesh?: AbstractMesh): void;
  15751. /**
  15752. * Set the rotation of the bone to a particular axis angle in local or world space
  15753. * @param axis The axis to rotate the bone on
  15754. * @param angle The angle that the bone should be rotated to
  15755. * @param space The space that the axis is in
  15756. * @param mesh The mesh that this bone is attached to. This is only used in world space
  15757. */
  15758. setAxisAngle(axis: Vector3, angle: number, space?: Space, mesh?: AbstractMesh): void;
  15759. /**
  15760. * Set the euler rotation of the bone in local of world space
  15761. * @param rotation The euler rotation that the bone should be set to
  15762. * @param space The space that the rotation is in
  15763. * @param mesh The mesh that this bone is attached to. This is only used in world space
  15764. */
  15765. setRotation(rotation: Vector3, space?: Space, mesh?: AbstractMesh): void;
  15766. /**
  15767. * Set the quaternion rotation of the bone in local of world space
  15768. * @param quat The quaternion rotation that the bone should be set to
  15769. * @param space The space that the rotation is in
  15770. * @param mesh The mesh that this bone is attached to. This is only used in world space
  15771. */
  15772. setRotationQuaternion(quat: Quaternion, space?: Space, mesh?: AbstractMesh): void;
  15773. /**
  15774. * Set the rotation matrix of the bone in local of world space
  15775. * @param rotMat The rotation matrix that the bone should be set to
  15776. * @param space The space that the rotation is in
  15777. * @param mesh The mesh that this bone is attached to. This is only used in world space
  15778. */
  15779. setRotationMatrix(rotMat: Matrix, space?: Space, mesh?: AbstractMesh): void;
  15780. private _rotateWithMatrix;
  15781. private _getNegativeRotationToRef;
  15782. /**
  15783. * Get the position of the bone in local or world space
  15784. * @param space The space that the returned position is in
  15785. * @param mesh The mesh that this bone is attached to. This is only used in world space
  15786. * @returns The position of the bone
  15787. */
  15788. getPosition(space?: Space, mesh?: Nullable<AbstractMesh>): Vector3;
  15789. /**
  15790. * Copy the position of the bone to a vector3 in local or world space
  15791. * @param space The space that the returned position is in
  15792. * @param mesh The mesh that this bone is attached to. This is only used in world space
  15793. * @param result The vector3 to copy the position to
  15794. */
  15795. getPositionToRef(space: Space | undefined, mesh: Nullable<AbstractMesh>, result: Vector3): void;
  15796. /**
  15797. * Get the absolute position of the bone (world space)
  15798. * @param mesh The mesh that this bone is attached to
  15799. * @returns The absolute position of the bone
  15800. */
  15801. getAbsolutePosition(mesh?: Nullable<AbstractMesh>): Vector3;
  15802. /**
  15803. * Copy the absolute position of the bone (world space) to the result param
  15804. * @param mesh The mesh that this bone is attached to
  15805. * @param result The vector3 to copy the absolute position to
  15806. */
  15807. getAbsolutePositionToRef(mesh: AbstractMesh, result: Vector3): void;
  15808. /**
  15809. * Compute the absolute transforms of this bone and its children
  15810. */
  15811. computeAbsoluteTransforms(): void;
  15812. /**
  15813. * Get the world direction from an axis that is in the local space of the bone
  15814. * @param localAxis The local direction that is used to compute the world direction
  15815. * @param mesh The mesh that this bone is attached to
  15816. * @returns The world direction
  15817. */
  15818. getDirection(localAxis: Vector3, mesh?: Nullable<AbstractMesh>): Vector3;
  15819. /**
  15820. * Copy the world direction to a vector3 from an axis that is in the local space of the bone
  15821. * @param localAxis The local direction that is used to compute the world direction
  15822. * @param mesh The mesh that this bone is attached to
  15823. * @param result The vector3 that the world direction will be copied to
  15824. */
  15825. getDirectionToRef(localAxis: Vector3, mesh: AbstractMesh | null | undefined, result: Vector3): void;
  15826. /**
  15827. * Get the euler rotation of the bone in local or world space
  15828. * @param space The space that the rotation should be in
  15829. * @param mesh The mesh that this bone is attached to. This is only used in world space
  15830. * @returns The euler rotation
  15831. */
  15832. getRotation(space?: Space, mesh?: Nullable<AbstractMesh>): Vector3;
  15833. /**
  15834. * Copy the euler rotation of the bone to a vector3. The rotation can be in either local or world space
  15835. * @param space The space that the rotation should be in
  15836. * @param mesh The mesh that this bone is attached to. This is only used in world space
  15837. * @param result The vector3 that the rotation should be copied to
  15838. */
  15839. getRotationToRef(space: Space | undefined, mesh: AbstractMesh | null | undefined, result: Vector3): void;
  15840. /**
  15841. * Get the quaternion rotation of the bone in either local or world space
  15842. * @param space The space that the rotation should be in
  15843. * @param mesh The mesh that this bone is attached to. This is only used in world space
  15844. * @returns The quaternion rotation
  15845. */
  15846. getRotationQuaternion(space?: Space, mesh?: Nullable<AbstractMesh>): Quaternion;
  15847. /**
  15848. * Copy the quaternion rotation of the bone to a quaternion. The rotation can be in either local or world space
  15849. * @param space The space that the rotation should be in
  15850. * @param mesh The mesh that this bone is attached to. This is only used in world space
  15851. * @param result The quaternion that the rotation should be copied to
  15852. */
  15853. getRotationQuaternionToRef(space: Space | undefined, mesh: AbstractMesh | null | undefined, result: Quaternion): void;
  15854. /**
  15855. * Get the rotation matrix of the bone in local or world space
  15856. * @param space The space that the rotation should be in
  15857. * @param mesh The mesh that this bone is attached to. This is only used in world space
  15858. * @returns The rotation matrix
  15859. */
  15860. getRotationMatrix(space: Space | undefined, mesh: AbstractMesh): Matrix;
  15861. /**
  15862. * Copy the rotation matrix of the bone to a matrix. The rotation can be in either local or world space
  15863. * @param space The space that the rotation should be in
  15864. * @param mesh The mesh that this bone is attached to. This is only used in world space
  15865. * @param result The quaternion that the rotation should be copied to
  15866. */
  15867. getRotationMatrixToRef(space: Space | undefined, mesh: AbstractMesh, result: Matrix): void;
  15868. /**
  15869. * Get the world position of a point that is in the local space of the bone
  15870. * @param position The local position
  15871. * @param mesh The mesh that this bone is attached to
  15872. * @returns The world position
  15873. */
  15874. getAbsolutePositionFromLocal(position: Vector3, mesh?: Nullable<AbstractMesh>): Vector3;
  15875. /**
  15876. * Get the world position of a point that is in the local space of the bone and copy it to the result param
  15877. * @param position The local position
  15878. * @param mesh The mesh that this bone is attached to
  15879. * @param result The vector3 that the world position should be copied to
  15880. */
  15881. getAbsolutePositionFromLocalToRef(position: Vector3, mesh: AbstractMesh | null | undefined, result: Vector3): void;
  15882. /**
  15883. * Get the local position of a point that is in world space
  15884. * @param position The world position
  15885. * @param mesh The mesh that this bone is attached to
  15886. * @returns The local position
  15887. */
  15888. getLocalPositionFromAbsolute(position: Vector3, mesh?: Nullable<AbstractMesh>): Vector3;
  15889. /**
  15890. * Get the local position of a point that is in world space and copy it to the result param
  15891. * @param position The world position
  15892. * @param mesh The mesh that this bone is attached to
  15893. * @param result The vector3 that the local position should be copied to
  15894. */
  15895. getLocalPositionFromAbsoluteToRef(position: Vector3, mesh: AbstractMesh | null | undefined, result: Vector3): void;
  15896. }
  15897. }
  15898. declare module "babylonjs/Animations/runtimeAnimation" {
  15899. import { Animation, _IAnimationState } from "babylonjs/Animations/animation";
  15900. import { Animatable } from "babylonjs/Animations/animatable";
  15901. import { Scene } from "babylonjs/scene";
  15902. /**
  15903. * Defines a runtime animation
  15904. */
  15905. export class RuntimeAnimation {
  15906. private _events;
  15907. /**
  15908. * The current frame of the runtime animation
  15909. */
  15910. private _currentFrame;
  15911. /**
  15912. * The animation used by the runtime animation
  15913. */
  15914. private _animation;
  15915. /**
  15916. * The target of the runtime animation
  15917. */
  15918. private _target;
  15919. /**
  15920. * The initiating animatable
  15921. */
  15922. private _host;
  15923. /**
  15924. * The original value of the runtime animation
  15925. */
  15926. private _originalValue;
  15927. /**
  15928. * The original blend value of the runtime animation
  15929. */
  15930. private _originalBlendValue;
  15931. /**
  15932. * The offsets cache of the runtime animation
  15933. */
  15934. private _offsetsCache;
  15935. /**
  15936. * The high limits cache of the runtime animation
  15937. */
  15938. private _highLimitsCache;
  15939. /**
  15940. * Specifies if the runtime animation has been stopped
  15941. */
  15942. private _stopped;
  15943. /**
  15944. * The blending factor of the runtime animation
  15945. */
  15946. private _blendingFactor;
  15947. /**
  15948. * The BabylonJS scene
  15949. */
  15950. private _scene;
  15951. /**
  15952. * The current value of the runtime animation
  15953. */
  15954. private _currentValue;
  15955. /** @hidden */
  15956. _animationState: _IAnimationState;
  15957. /**
  15958. * The active target of the runtime animation
  15959. */
  15960. private _activeTargets;
  15961. private _currentActiveTarget;
  15962. private _directTarget;
  15963. /**
  15964. * The target path of the runtime animation
  15965. */
  15966. private _targetPath;
  15967. /**
  15968. * The weight of the runtime animation
  15969. */
  15970. private _weight;
  15971. /**
  15972. * The ratio offset of the runtime animation
  15973. */
  15974. private _ratioOffset;
  15975. /**
  15976. * The previous delay of the runtime animation
  15977. */
  15978. private _previousDelay;
  15979. /**
  15980. * The previous ratio of the runtime animation
  15981. */
  15982. private _previousRatio;
  15983. private _enableBlending;
  15984. private _keys;
  15985. private _minFrame;
  15986. private _maxFrame;
  15987. private _minValue;
  15988. private _maxValue;
  15989. private _targetIsArray;
  15990. /**
  15991. * Gets the current frame of the runtime animation
  15992. */
  15993. get currentFrame(): number;
  15994. /**
  15995. * Gets the weight of the runtime animation
  15996. */
  15997. get weight(): number;
  15998. /**
  15999. * Gets the current value of the runtime animation
  16000. */
  16001. get currentValue(): any;
  16002. /**
  16003. * Gets the target path of the runtime animation
  16004. */
  16005. get targetPath(): string;
  16006. /**
  16007. * Gets the actual target of the runtime animation
  16008. */
  16009. get target(): any;
  16010. /**
  16011. * Gets the additive state of the runtime animation
  16012. */
  16013. get isAdditive(): boolean;
  16014. /** @hidden */
  16015. _onLoop: () => void;
  16016. /**
  16017. * Create a new RuntimeAnimation object
  16018. * @param target defines the target of the animation
  16019. * @param animation defines the source animation object
  16020. * @param scene defines the hosting scene
  16021. * @param host defines the initiating Animatable
  16022. */
  16023. constructor(target: any, animation: Animation, scene: Scene, host: Animatable);
  16024. private _preparePath;
  16025. /**
  16026. * Gets the animation from the runtime animation
  16027. */
  16028. get animation(): Animation;
  16029. /**
  16030. * Resets the runtime animation to the beginning
  16031. * @param restoreOriginal defines whether to restore the target property to the original value
  16032. */
  16033. reset(restoreOriginal?: boolean): void;
  16034. /**
  16035. * Specifies if the runtime animation is stopped
  16036. * @returns Boolean specifying if the runtime animation is stopped
  16037. */
  16038. isStopped(): boolean;
  16039. /**
  16040. * Disposes of the runtime animation
  16041. */
  16042. dispose(): void;
  16043. /**
  16044. * Apply the interpolated value to the target
  16045. * @param currentValue defines the value computed by the animation
  16046. * @param weight defines the weight to apply to this value (Defaults to 1.0)
  16047. */
  16048. setValue(currentValue: any, weight: number): void;
  16049. private _getOriginalValues;
  16050. private _setValue;
  16051. /**
  16052. * Gets the loop pmode of the runtime animation
  16053. * @returns Loop Mode
  16054. */
  16055. private _getCorrectLoopMode;
  16056. /**
  16057. * Move the current animation to a given frame
  16058. * @param frame defines the frame to move to
  16059. */
  16060. goToFrame(frame: number): void;
  16061. /**
  16062. * @hidden Internal use only
  16063. */
  16064. _prepareForSpeedRatioChange(newSpeedRatio: number): void;
  16065. /**
  16066. * Execute the current animation
  16067. * @param delay defines the delay to add to the current frame
  16068. * @param from defines the lower bound of the animation range
  16069. * @param to defines the upper bound of the animation range
  16070. * @param loop defines if the current animation must loop
  16071. * @param speedRatio defines the current speed ratio
  16072. * @param weight defines the weight of the animation (default is -1 so no weight)
  16073. * @param onLoop optional callback called when animation loops
  16074. * @returns a boolean indicating if the animation is running
  16075. */
  16076. animate(delay: number, from: number, to: number, loop: boolean, speedRatio: number, weight?: number): boolean;
  16077. }
  16078. }
  16079. declare module "babylonjs/Animations/animatable" {
  16080. import { Animation } from "babylonjs/Animations/animation";
  16081. import { RuntimeAnimation } from "babylonjs/Animations/runtimeAnimation";
  16082. import { Nullable } from "babylonjs/types";
  16083. import { Observable } from "babylonjs/Misc/observable";
  16084. import { Scene } from "babylonjs/scene";
  16085. import { Matrix, Quaternion, Vector3 } from "babylonjs/Maths/math.vector";
  16086. import { Node } from "babylonjs/node";
  16087. /**
  16088. * Class used to store an actual running animation
  16089. */
  16090. export class Animatable {
  16091. /** defines the target object */
  16092. target: any;
  16093. /** defines the starting frame number (default is 0) */
  16094. fromFrame: number;
  16095. /** defines the ending frame number (default is 100) */
  16096. toFrame: number;
  16097. /** defines if the animation must loop (default is false) */
  16098. loopAnimation: boolean;
  16099. /** defines a callback to call when animation ends if it is not looping */
  16100. onAnimationEnd?: (() => void) | null | undefined;
  16101. /** defines a callback to call when animation loops */
  16102. onAnimationLoop?: (() => void) | null | undefined;
  16103. /** defines whether the animation should be evaluated additively */
  16104. isAdditive: boolean;
  16105. private _localDelayOffset;
  16106. private _pausedDelay;
  16107. private _runtimeAnimations;
  16108. private _paused;
  16109. private _scene;
  16110. private _speedRatio;
  16111. private _weight;
  16112. private _syncRoot;
  16113. /**
  16114. * Gets or sets a boolean indicating if the animatable must be disposed and removed at the end of the animation.
  16115. * This will only apply for non looping animation (default is true)
  16116. */
  16117. disposeOnEnd: boolean;
  16118. /**
  16119. * Gets a boolean indicating if the animation has started
  16120. */
  16121. animationStarted: boolean;
  16122. /**
  16123. * Observer raised when the animation ends
  16124. */
  16125. onAnimationEndObservable: Observable<Animatable>;
  16126. /**
  16127. * Observer raised when the animation loops
  16128. */
  16129. onAnimationLoopObservable: Observable<Animatable>;
  16130. /**
  16131. * Gets the root Animatable used to synchronize and normalize animations
  16132. */
  16133. get syncRoot(): Nullable<Animatable>;
  16134. /**
  16135. * Gets the current frame of the first RuntimeAnimation
  16136. * Used to synchronize Animatables
  16137. */
  16138. get masterFrame(): number;
  16139. /**
  16140. * Gets or sets the animatable weight (-1.0 by default meaning not weighted)
  16141. */
  16142. get weight(): number;
  16143. set weight(value: number);
  16144. /**
  16145. * Gets or sets the speed ratio to apply to the animatable (1.0 by default)
  16146. */
  16147. get speedRatio(): number;
  16148. set speedRatio(value: number);
  16149. /**
  16150. * Creates a new Animatable
  16151. * @param scene defines the hosting scene
  16152. * @param target defines the target object
  16153. * @param fromFrame defines the starting frame number (default is 0)
  16154. * @param toFrame defines the ending frame number (default is 100)
  16155. * @param loopAnimation defines if the animation must loop (default is false)
  16156. * @param speedRatio defines the factor to apply to animation speed (default is 1)
  16157. * @param onAnimationEnd defines a callback to call when animation ends if it is not looping
  16158. * @param animations defines a group of animation to add to the new Animatable
  16159. * @param onAnimationLoop defines a callback to call when animation loops
  16160. * @param isAdditive defines whether the animation should be evaluated additively
  16161. */
  16162. constructor(scene: Scene,
  16163. /** defines the target object */
  16164. target: any,
  16165. /** defines the starting frame number (default is 0) */
  16166. fromFrame?: number,
  16167. /** defines the ending frame number (default is 100) */
  16168. toFrame?: number,
  16169. /** defines if the animation must loop (default is false) */
  16170. loopAnimation?: boolean, speedRatio?: number,
  16171. /** defines a callback to call when animation ends if it is not looping */
  16172. onAnimationEnd?: (() => void) | null | undefined, animations?: Animation[],
  16173. /** defines a callback to call when animation loops */
  16174. onAnimationLoop?: (() => void) | null | undefined,
  16175. /** defines whether the animation should be evaluated additively */
  16176. isAdditive?: boolean);
  16177. /**
  16178. * Synchronize and normalize current Animatable with a source Animatable
  16179. * This is useful when using animation weights and when animations are not of the same length
  16180. * @param root defines the root Animatable to synchronize with
  16181. * @returns the current Animatable
  16182. */
  16183. syncWith(root: Animatable): Animatable;
  16184. /**
  16185. * Gets the list of runtime animations
  16186. * @returns an array of RuntimeAnimation
  16187. */
  16188. getAnimations(): RuntimeAnimation[];
  16189. /**
  16190. * Adds more animations to the current animatable
  16191. * @param target defines the target of the animations
  16192. * @param animations defines the new animations to add
  16193. */
  16194. appendAnimations(target: any, animations: Animation[]): void;
  16195. /**
  16196. * Gets the source animation for a specific property
  16197. * @param property defines the propertyu to look for
  16198. * @returns null or the source animation for the given property
  16199. */
  16200. getAnimationByTargetProperty(property: string): Nullable<Animation>;
  16201. /**
  16202. * Gets the runtime animation for a specific property
  16203. * @param property defines the propertyu to look for
  16204. * @returns null or the runtime animation for the given property
  16205. */
  16206. getRuntimeAnimationByTargetProperty(property: string): Nullable<RuntimeAnimation>;
  16207. /**
  16208. * Resets the animatable to its original state
  16209. */
  16210. reset(): void;
  16211. /**
  16212. * Allows the animatable to blend with current running animations
  16213. * @see https://doc.babylonjs.com/babylon101/animations#animation-blending
  16214. * @param blendingSpeed defines the blending speed to use
  16215. */
  16216. enableBlending(blendingSpeed: number): void;
  16217. /**
  16218. * Disable animation blending
  16219. * @see https://doc.babylonjs.com/babylon101/animations#animation-blending
  16220. */
  16221. disableBlending(): void;
  16222. /**
  16223. * Jump directly to a given frame
  16224. * @param frame defines the frame to jump to
  16225. */
  16226. goToFrame(frame: number): void;
  16227. /**
  16228. * Pause the animation
  16229. */
  16230. pause(): void;
  16231. /**
  16232. * Restart the animation
  16233. */
  16234. restart(): void;
  16235. private _raiseOnAnimationEnd;
  16236. /**
  16237. * Stop and delete the current animation
  16238. * @param animationName defines a string used to only stop some of the runtime animations instead of all
  16239. * @param targetMask - a function that determines if the animation should be stopped based on its target (all animations will be stopped if both this and animationName are empty)
  16240. */
  16241. stop(animationName?: string, targetMask?: (target: any) => boolean): void;
  16242. /**
  16243. * Wait asynchronously for the animation to end
  16244. * @returns a promise which will be fullfilled when the animation ends
  16245. */
  16246. waitAsync(): Promise<Animatable>;
  16247. /** @hidden */
  16248. _animate(delay: number): boolean;
  16249. }
  16250. module "babylonjs/scene" {
  16251. interface Scene {
  16252. /** @hidden */
  16253. _registerTargetForLateAnimationBinding(runtimeAnimation: RuntimeAnimation, originalValue: any): void;
  16254. /** @hidden */
  16255. _processLateAnimationBindingsForMatrices(holder: {
  16256. totalWeight: number;
  16257. totalAdditiveWeight: number;
  16258. animations: RuntimeAnimation[];
  16259. additiveAnimations: RuntimeAnimation[];
  16260. originalValue: Matrix;
  16261. }): any;
  16262. /** @hidden */
  16263. _processLateAnimationBindingsForQuaternions(holder: {
  16264. totalWeight: number;
  16265. totalAdditiveWeight: number;
  16266. animations: RuntimeAnimation[];
  16267. additiveAnimations: RuntimeAnimation[];
  16268. originalValue: Quaternion;
  16269. }, refQuaternion: Quaternion): Quaternion;
  16270. /** @hidden */
  16271. _processLateAnimationBindings(): void;
  16272. /**
  16273. * Will start the animation sequence of a given target
  16274. * @param target defines the target
  16275. * @param from defines from which frame should animation start
  16276. * @param to defines until which frame should animation run.
  16277. * @param weight defines the weight to apply to the animation (1.0 by default)
  16278. * @param loop defines if the animation loops
  16279. * @param speedRatio defines the speed in which to run the animation (1.0 by default)
  16280. * @param onAnimationEnd defines the function to be executed when the animation ends
  16281. * @param animatable defines an animatable object. If not provided a new one will be created from the given params
  16282. * @param targetMask defines if the target should be animated if animations are present (this is called recursively on descendant animatables regardless of return value)
  16283. * @param onAnimationLoop defines the callback to call when an animation loops
  16284. * @param isAdditive defines whether the animation should be evaluated additively (false by default)
  16285. * @returns the animatable object created for this animation
  16286. */
  16287. beginWeightedAnimation(target: any, from: number, to: number, weight: number, loop?: boolean, speedRatio?: number, onAnimationEnd?: () => void, animatable?: Animatable, targetMask?: (target: any) => boolean, onAnimationLoop?: () => void, isAdditive?: boolean): Animatable;
  16288. /**
  16289. * Will start the animation sequence of a given target
  16290. * @param target defines the target
  16291. * @param from defines from which frame should animation start
  16292. * @param to defines until which frame should animation run.
  16293. * @param loop defines if the animation loops
  16294. * @param speedRatio defines the speed in which to run the animation (1.0 by default)
  16295. * @param onAnimationEnd defines the function to be executed when the animation ends
  16296. * @param animatable defines an animatable object. If not provided a new one will be created from the given params
  16297. * @param stopCurrent defines if the current animations must be stopped first (true by default)
  16298. * @param targetMask defines if the target should be animate if animations are present (this is called recursively on descendant animatables regardless of return value)
  16299. * @param onAnimationLoop defines the callback to call when an animation loops
  16300. * @param isAdditive defines whether the animation should be evaluated additively (false by default)
  16301. * @returns the animatable object created for this animation
  16302. */
  16303. beginAnimation(target: any, from: number, to: number, loop?: boolean, speedRatio?: number, onAnimationEnd?: () => void, animatable?: Animatable, stopCurrent?: boolean, targetMask?: (target: any) => boolean, onAnimationLoop?: () => void, isAdditive?: boolean): Animatable;
  16304. /**
  16305. * Will start the animation sequence of a given target and its hierarchy
  16306. * @param target defines the target
  16307. * @param directDescendantsOnly if true only direct descendants will be used, if false direct and also indirect (children of children, an so on in a recursive manner) descendants will be used.
  16308. * @param from defines from which frame should animation start
  16309. * @param to defines until which frame should animation run.
  16310. * @param loop defines if the animation loops
  16311. * @param speedRatio defines the speed in which to run the animation (1.0 by default)
  16312. * @param onAnimationEnd defines the function to be executed when the animation ends
  16313. * @param animatable defines an animatable object. If not provided a new one will be created from the given params
  16314. * @param stopCurrent defines if the current animations must be stopped first (true by default)
  16315. * @param targetMask defines if the target should be animated if animations are present (this is called recursively on descendant animatables regardless of return value)
  16316. * @param onAnimationLoop defines the callback to call when an animation loops
  16317. * @param isAdditive defines whether the animation should be evaluated additively (false by default)
  16318. * @returns the list of created animatables
  16319. */
  16320. beginHierarchyAnimation(target: any, directDescendantsOnly: boolean, from: number, to: number, loop?: boolean, speedRatio?: number, onAnimationEnd?: () => void, animatable?: Animatable, stopCurrent?: boolean, targetMask?: (target: any) => boolean, onAnimationLoop?: () => void, isAdditive?: boolean): Animatable[];
  16321. /**
  16322. * Begin a new animation on a given node
  16323. * @param target defines the target where the animation will take place
  16324. * @param animations defines the list of animations to start
  16325. * @param from defines the initial value
  16326. * @param to defines the final value
  16327. * @param loop defines if you want animation to loop (off by default)
  16328. * @param speedRatio defines the speed ratio to apply to all animations
  16329. * @param onAnimationEnd defines the callback to call when an animation ends (will be called once per node)
  16330. * @param onAnimationLoop defines the callback to call when an animation loops
  16331. * @param isAdditive defines whether the animation should be evaluated additively (false by default)
  16332. * @returns the list of created animatables
  16333. */
  16334. beginDirectAnimation(target: any, animations: Animation[], from: number, to: number, loop?: boolean, speedRatio?: number, onAnimationEnd?: () => void, onAnimationLoop?: () => void, isAdditive?: boolean): Animatable;
  16335. /**
  16336. * Begin a new animation on a given node and its hierarchy
  16337. * @param target defines the root node where the animation will take place
  16338. * @param directDescendantsOnly if true only direct descendants will be used, if false direct and also indirect (children of children, an so on in a recursive manner) descendants will be used.
  16339. * @param animations defines the list of animations to start
  16340. * @param from defines the initial value
  16341. * @param to defines the final value
  16342. * @param loop defines if you want animation to loop (off by default)
  16343. * @param speedRatio defines the speed ratio to apply to all animations
  16344. * @param onAnimationEnd defines the callback to call when an animation ends (will be called once per node)
  16345. * @param onAnimationLoop defines the callback to call when an animation loops
  16346. * @param isAdditive defines whether the animation should be evaluated additively (false by default)
  16347. * @returns the list of animatables created for all nodes
  16348. */
  16349. beginDirectHierarchyAnimation(target: Node, directDescendantsOnly: boolean, animations: Animation[], from: number, to: number, loop?: boolean, speedRatio?: number, onAnimationEnd?: () => void, onAnimationLoop?: () => void, isAdditive?: boolean): Animatable[];
  16350. /**
  16351. * Gets the animatable associated with a specific target
  16352. * @param target defines the target of the animatable
  16353. * @returns the required animatable if found
  16354. */
  16355. getAnimatableByTarget(target: any): Nullable<Animatable>;
  16356. /**
  16357. * Gets all animatables associated with a given target
  16358. * @param target defines the target to look animatables for
  16359. * @returns an array of Animatables
  16360. */
  16361. getAllAnimatablesByTarget(target: any): Array<Animatable>;
  16362. /**
  16363. * Stops and removes all animations that have been applied to the scene
  16364. */
  16365. stopAllAnimations(): void;
  16366. /**
  16367. * Gets the current delta time used by animation engine
  16368. */
  16369. deltaTime: number;
  16370. }
  16371. }
  16372. module "babylonjs/Bones/bone" {
  16373. interface Bone {
  16374. /**
  16375. * Copy an animation range from another bone
  16376. * @param source defines the source bone
  16377. * @param rangeName defines the range name to copy
  16378. * @param frameOffset defines the frame offset
  16379. * @param rescaleAsRequired defines if rescaling must be applied if required
  16380. * @param skelDimensionsRatio defines the scaling ratio
  16381. * @returns true if operation was successful
  16382. */
  16383. copyAnimationRange(source: Bone, rangeName: string, frameOffset: number, rescaleAsRequired: boolean, skelDimensionsRatio: Nullable<Vector3>): boolean;
  16384. }
  16385. }
  16386. }
  16387. declare module "babylonjs/Bones/skeleton" {
  16388. import { Bone } from "babylonjs/Bones/bone";
  16389. import { Observable } from "babylonjs/Misc/observable";
  16390. import { Vector3, Matrix } from "babylonjs/Maths/math.vector";
  16391. import { Scene } from "babylonjs/scene";
  16392. import { Nullable } from "babylonjs/types";
  16393. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  16394. import { RawTexture } from "babylonjs/Materials/Textures/rawTexture";
  16395. import { Animatable } from "babylonjs/Animations/animatable";
  16396. import { AnimationPropertiesOverride } from "babylonjs/Animations/animationPropertiesOverride";
  16397. import { Animation } from "babylonjs/Animations/animation";
  16398. import { AnimationRange } from "babylonjs/Animations/animationRange";
  16399. import { IInspectable } from "babylonjs/Misc/iInspectable";
  16400. import { IAnimatable } from "babylonjs/Animations/animatable.interface";
  16401. /**
  16402. * Class used to handle skinning animations
  16403. * @see https://doc.babylonjs.com/how_to/how_to_use_bones_and_skeletons
  16404. */
  16405. export class Skeleton implements IAnimatable {
  16406. /** defines the skeleton name */
  16407. name: string;
  16408. /** defines the skeleton Id */
  16409. id: string;
  16410. /**
  16411. * Defines the list of child bones
  16412. */
  16413. bones: Bone[];
  16414. /**
  16415. * Defines an estimate of the dimension of the skeleton at rest
  16416. */
  16417. dimensionsAtRest: Vector3;
  16418. /**
  16419. * Defines a boolean indicating if the root matrix is provided by meshes or by the current skeleton (this is the default value)
  16420. */
  16421. needInitialSkinMatrix: boolean;
  16422. /**
  16423. * Defines a mesh that override the matrix used to get the world matrix (null by default).
  16424. */
  16425. overrideMesh: Nullable<AbstractMesh>;
  16426. /**
  16427. * Gets the list of animations attached to this skeleton
  16428. */
  16429. animations: Array<Animation>;
  16430. private _scene;
  16431. private _isDirty;
  16432. private _transformMatrices;
  16433. private _transformMatrixTexture;
  16434. private _meshesWithPoseMatrix;
  16435. private _animatables;
  16436. private _identity;
  16437. private _synchronizedWithMesh;
  16438. private _ranges;
  16439. private _lastAbsoluteTransformsUpdateId;
  16440. private _canUseTextureForBones;
  16441. private _uniqueId;
  16442. /** @hidden */
  16443. _numBonesWithLinkedTransformNode: number;
  16444. /** @hidden */
  16445. _hasWaitingData: Nullable<boolean>;
  16446. /** @hidden */
  16447. _waitingOverrideMeshId: Nullable<string>;
  16448. /**
  16449. * Specifies if the skeleton should be serialized
  16450. */
  16451. doNotSerialize: boolean;
  16452. private _useTextureToStoreBoneMatrices;
  16453. /**
  16454. * Gets or sets a boolean indicating that bone matrices should be stored as a texture instead of using shader uniforms (default is true).
  16455. * Please note that this option is not available if the hardware does not support it
  16456. */
  16457. get useTextureToStoreBoneMatrices(): boolean;
  16458. set useTextureToStoreBoneMatrices(value: boolean);
  16459. private _animationPropertiesOverride;
  16460. /**
  16461. * Gets or sets the animation properties override
  16462. */
  16463. get animationPropertiesOverride(): Nullable<AnimationPropertiesOverride>;
  16464. set animationPropertiesOverride(value: Nullable<AnimationPropertiesOverride>);
  16465. /**
  16466. * List of inspectable custom properties (used by the Inspector)
  16467. * @see https://doc.babylonjs.com/how_to/debug_layer#extensibility
  16468. */
  16469. inspectableCustomProperties: IInspectable[];
  16470. /**
  16471. * An observable triggered before computing the skeleton's matrices
  16472. */
  16473. onBeforeComputeObservable: Observable<Skeleton>;
  16474. /**
  16475. * Gets a boolean indicating that the skeleton effectively stores matrices into a texture
  16476. */
  16477. get isUsingTextureForMatrices(): boolean;
  16478. /**
  16479. * Gets the unique ID of this skeleton
  16480. */
  16481. get uniqueId(): number;
  16482. /**
  16483. * Creates a new skeleton
  16484. * @param name defines the skeleton name
  16485. * @param id defines the skeleton Id
  16486. * @param scene defines the hosting scene
  16487. */
  16488. constructor(
  16489. /** defines the skeleton name */
  16490. name: string,
  16491. /** defines the skeleton Id */
  16492. id: string, scene: Scene);
  16493. /**
  16494. * Gets the current object class name.
  16495. * @return the class name
  16496. */
  16497. getClassName(): string;
  16498. /**
  16499. * Returns an array containing the root bones
  16500. * @returns an array containing the root bones
  16501. */
  16502. getChildren(): Array<Bone>;
  16503. /**
  16504. * Gets the list of transform matrices to send to shaders (one matrix per bone)
  16505. * @param mesh defines the mesh to use to get the root matrix (if needInitialSkinMatrix === true)
  16506. * @returns a Float32Array containing matrices data
  16507. */
  16508. getTransformMatrices(mesh: AbstractMesh): Float32Array;
  16509. /**
  16510. * Gets the list of transform matrices to send to shaders inside a texture (one matrix per bone)
  16511. * @param mesh defines the mesh to use to get the root matrix (if needInitialSkinMatrix === true)
  16512. * @returns a raw texture containing the data
  16513. */
  16514. getTransformMatrixTexture(mesh: AbstractMesh): Nullable<RawTexture>;
  16515. /**
  16516. * Gets the current hosting scene
  16517. * @returns a scene object
  16518. */
  16519. getScene(): Scene;
  16520. /**
  16521. * Gets a string representing the current skeleton data
  16522. * @param fullDetails defines a boolean indicating if we want a verbose version
  16523. * @returns a string representing the current skeleton data
  16524. */
  16525. toString(fullDetails?: boolean): string;
  16526. /**
  16527. * Get bone's index searching by name
  16528. * @param name defines bone's name to search for
  16529. * @return the indice of the bone. Returns -1 if not found
  16530. */
  16531. getBoneIndexByName(name: string): number;
  16532. /**
  16533. * Creater a new animation range
  16534. * @param name defines the name of the range
  16535. * @param from defines the start key
  16536. * @param to defines the end key
  16537. */
  16538. createAnimationRange(name: string, from: number, to: number): void;
  16539. /**
  16540. * Delete a specific animation range
  16541. * @param name defines the name of the range
  16542. * @param deleteFrames defines if frames must be removed as well
  16543. */
  16544. deleteAnimationRange(name: string, deleteFrames?: boolean): void;
  16545. /**
  16546. * Gets a specific animation range
  16547. * @param name defines the name of the range to look for
  16548. * @returns the requested animation range or null if not found
  16549. */
  16550. getAnimationRange(name: string): Nullable<AnimationRange>;
  16551. /**
  16552. * Gets the list of all animation ranges defined on this skeleton
  16553. * @returns an array
  16554. */
  16555. getAnimationRanges(): Nullable<AnimationRange>[];
  16556. /**
  16557. * Copy animation range from a source skeleton.
  16558. * This is not for a complete retargeting, only between very similar skeleton's with only possible bone length differences
  16559. * @param source defines the source skeleton
  16560. * @param name defines the name of the range to copy
  16561. * @param rescaleAsRequired defines if rescaling must be applied if required
  16562. * @returns true if operation was successful
  16563. */
  16564. copyAnimationRange(source: Skeleton, name: string, rescaleAsRequired?: boolean): boolean;
  16565. /**
  16566. * Forces the skeleton to go to rest pose
  16567. */
  16568. returnToRest(): void;
  16569. private _getHighestAnimationFrame;
  16570. /**
  16571. * Begin a specific animation range
  16572. * @param name defines the name of the range to start
  16573. * @param loop defines if looping must be turned on (false by default)
  16574. * @param speedRatio defines the speed ratio to apply (1 by default)
  16575. * @param onAnimationEnd defines a callback which will be called when animation will end
  16576. * @returns a new animatable
  16577. */
  16578. beginAnimation(name: string, loop?: boolean, speedRatio?: number, onAnimationEnd?: () => void): Nullable<Animatable>;
  16579. /**
  16580. * Convert the keyframes for a range of animation on a skeleton to be relative to a given reference frame.
  16581. * @param skeleton defines the Skeleton containing the animation range to convert
  16582. * @param referenceFrame defines the frame that keyframes in the range will be relative to
  16583. * @param range defines the name of the AnimationRange belonging to the Skeleton to convert
  16584. * @returns the original skeleton
  16585. */
  16586. static MakeAnimationAdditive(skeleton: Skeleton, referenceFrame: number | undefined, range: string): Nullable<Skeleton>;
  16587. /** @hidden */
  16588. _markAsDirty(): void;
  16589. /** @hidden */
  16590. _registerMeshWithPoseMatrix(mesh: AbstractMesh): void;
  16591. /** @hidden */
  16592. _unregisterMeshWithPoseMatrix(mesh: AbstractMesh): void;
  16593. private _computeTransformMatrices;
  16594. /**
  16595. * Build all resources required to render a skeleton
  16596. */
  16597. prepare(): void;
  16598. /**
  16599. * Gets the list of animatables currently running for this skeleton
  16600. * @returns an array of animatables
  16601. */
  16602. getAnimatables(): IAnimatable[];
  16603. /**
  16604. * Clone the current skeleton
  16605. * @param name defines the name of the new skeleton
  16606. * @param id defines the id of the new skeleton
  16607. * @returns the new skeleton
  16608. */
  16609. clone(name: string, id?: string): Skeleton;
  16610. /**
  16611. * Enable animation blending for this skeleton
  16612. * @param blendingSpeed defines the blending speed to apply
  16613. * @see https://doc.babylonjs.com/babylon101/animations#animation-blending
  16614. */
  16615. enableBlending(blendingSpeed?: number): void;
  16616. /**
  16617. * Releases all resources associated with the current skeleton
  16618. */
  16619. dispose(): void;
  16620. /**
  16621. * Serialize the skeleton in a JSON object
  16622. * @returns a JSON object
  16623. */
  16624. serialize(): any;
  16625. /**
  16626. * Creates a new skeleton from serialized data
  16627. * @param parsedSkeleton defines the serialized data
  16628. * @param scene defines the hosting scene
  16629. * @returns a new skeleton
  16630. */
  16631. static Parse(parsedSkeleton: any, scene: Scene): Skeleton;
  16632. /**
  16633. * Compute all node absolute transforms
  16634. * @param forceUpdate defines if computation must be done even if cache is up to date
  16635. */
  16636. computeAbsoluteTransforms(forceUpdate?: boolean): void;
  16637. /**
  16638. * Gets the root pose matrix
  16639. * @returns a matrix
  16640. */
  16641. getPoseMatrix(): Nullable<Matrix>;
  16642. /**
  16643. * Sorts bones per internal index
  16644. */
  16645. sortBones(): void;
  16646. private _sortBones;
  16647. }
  16648. }
  16649. declare module "babylonjs/Meshes/instancedMesh" {
  16650. import { Nullable, FloatArray, IndicesArray } from "babylonjs/types";
  16651. import { Vector3, Matrix } from "babylonjs/Maths/math.vector";
  16652. import { Camera } from "babylonjs/Cameras/camera";
  16653. import { Node } from "babylonjs/node";
  16654. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  16655. import { Mesh } from "babylonjs/Meshes/mesh";
  16656. import { Material } from "babylonjs/Materials/material";
  16657. import { Skeleton } from "babylonjs/Bones/skeleton";
  16658. import { Light } from "babylonjs/Lights/light";
  16659. import { VertexBuffer } from "babylonjs/Meshes/buffer";
  16660. /**
  16661. * Creates an instance based on a source mesh.
  16662. */
  16663. export class InstancedMesh extends AbstractMesh {
  16664. private _sourceMesh;
  16665. private _currentLOD;
  16666. /** @hidden */
  16667. _indexInSourceMeshInstanceArray: number;
  16668. constructor(name: string, source: Mesh);
  16669. /**
  16670. * Returns the string "InstancedMesh".
  16671. */
  16672. getClassName(): string;
  16673. /** Gets the list of lights affecting that mesh */
  16674. get lightSources(): Light[];
  16675. _resyncLightSources(): void;
  16676. _resyncLightSource(light: Light): void;
  16677. _removeLightSource(light: Light, dispose: boolean): void;
  16678. /**
  16679. * If the source mesh receives shadows
  16680. */
  16681. get receiveShadows(): boolean;
  16682. /**
  16683. * The material of the source mesh
  16684. */
  16685. get material(): Nullable<Material>;
  16686. /**
  16687. * Visibility of the source mesh
  16688. */
  16689. get visibility(): number;
  16690. /**
  16691. * Skeleton of the source mesh
  16692. */
  16693. get skeleton(): Nullable<Skeleton>;
  16694. /**
  16695. * Rendering ground id of the source mesh
  16696. */
  16697. get renderingGroupId(): number;
  16698. set renderingGroupId(value: number);
  16699. /**
  16700. * Returns the total number of vertices (integer).
  16701. */
  16702. getTotalVertices(): number;
  16703. /**
  16704. * Returns a positive integer : the total number of indices in this mesh geometry.
  16705. * @returns the numner of indices or zero if the mesh has no geometry.
  16706. */
  16707. getTotalIndices(): number;
  16708. /**
  16709. * The source mesh of the instance
  16710. */
  16711. get sourceMesh(): Mesh;
  16712. /**
  16713. * Creates a new InstancedMesh object from the mesh model.
  16714. * @see https://doc.babylonjs.com/how_to/how_to_use_instances
  16715. * @param name defines the name of the new instance
  16716. * @returns a new InstancedMesh
  16717. */
  16718. createInstance(name: string): InstancedMesh;
  16719. /**
  16720. * Is this node ready to be used/rendered
  16721. * @param completeCheck defines if a complete check (including materials and lights) has to be done (false by default)
  16722. * @return {boolean} is it ready
  16723. */
  16724. isReady(completeCheck?: boolean): boolean;
  16725. /**
  16726. * Returns an array of integers or a typed array (Int32Array, Uint32Array, Uint16Array) populated with the mesh indices.
  16727. * @param kind kind of verticies to retreive (eg. positons, normals, uvs, etc.)
  16728. * @param copyWhenShared If true (default false) and and if the mesh geometry is shared among some other meshes, the returned array is a copy of the internal one.
  16729. * @returns a float array or a Float32Array of the requested kind of data : positons, normals, uvs, etc.
  16730. */
  16731. getVerticesData(kind: string, copyWhenShared?: boolean): Nullable<FloatArray>;
  16732. /**
  16733. * Sets the vertex data of the mesh geometry for the requested `kind`.
  16734. * If the mesh has no geometry, a new Geometry object is set to the mesh and then passed this vertex data.
  16735. * The `data` are either a numeric array either a Float32Array.
  16736. * The parameter `updatable` is passed as is to the underlying Geometry object constructor (if initianilly none) or updater.
  16737. * The parameter `stride` is an optional positive integer, it is usually automatically deducted from the `kind` (3 for positions or normals, 2 for UV, etc).
  16738. * Note that a new underlying VertexBuffer object is created each call.
  16739. * If the `kind` is the `PositionKind`, the mesh BoundingInfo is renewed, so the bounding box and sphere, and the mesh World Matrix is recomputed.
  16740. *
  16741. * Possible `kind` values :
  16742. * - VertexBuffer.PositionKind
  16743. * - VertexBuffer.UVKind
  16744. * - VertexBuffer.UV2Kind
  16745. * - VertexBuffer.UV3Kind
  16746. * - VertexBuffer.UV4Kind
  16747. * - VertexBuffer.UV5Kind
  16748. * - VertexBuffer.UV6Kind
  16749. * - VertexBuffer.ColorKind
  16750. * - VertexBuffer.MatricesIndicesKind
  16751. * - VertexBuffer.MatricesIndicesExtraKind
  16752. * - VertexBuffer.MatricesWeightsKind
  16753. * - VertexBuffer.MatricesWeightsExtraKind
  16754. *
  16755. * Returns the Mesh.
  16756. */
  16757. setVerticesData(kind: string, data: FloatArray, updatable?: boolean, stride?: number): AbstractMesh;
  16758. /**
  16759. * Updates the existing vertex data of the mesh geometry for the requested `kind`.
  16760. * If the mesh has no geometry, it is simply returned as it is.
  16761. * The `data` are either a numeric array either a Float32Array.
  16762. * No new underlying VertexBuffer object is created.
  16763. * If the `kind` is the `PositionKind` and if `updateExtends` is true, the mesh BoundingInfo is renewed, so the bounding box and sphere, and the mesh World Matrix is recomputed.
  16764. * If the parameter `makeItUnique` is true, a new global geometry is created from this positions and is set to the mesh.
  16765. *
  16766. * Possible `kind` values :
  16767. * - VertexBuffer.PositionKind
  16768. * - VertexBuffer.UVKind
  16769. * - VertexBuffer.UV2Kind
  16770. * - VertexBuffer.UV3Kind
  16771. * - VertexBuffer.UV4Kind
  16772. * - VertexBuffer.UV5Kind
  16773. * - VertexBuffer.UV6Kind
  16774. * - VertexBuffer.ColorKind
  16775. * - VertexBuffer.MatricesIndicesKind
  16776. * - VertexBuffer.MatricesIndicesExtraKind
  16777. * - VertexBuffer.MatricesWeightsKind
  16778. * - VertexBuffer.MatricesWeightsExtraKind
  16779. *
  16780. * Returns the Mesh.
  16781. */
  16782. updateVerticesData(kind: string, data: FloatArray, updateExtends?: boolean, makeItUnique?: boolean): Mesh;
  16783. /**
  16784. * Sets the mesh indices.
  16785. * Expects an array populated with integers or a typed array (Int32Array, Uint32Array, Uint16Array).
  16786. * If the mesh has no geometry, a new Geometry object is created and set to the mesh.
  16787. * This method creates a new index buffer each call.
  16788. * Returns the Mesh.
  16789. */
  16790. setIndices(indices: IndicesArray, totalVertices?: Nullable<number>): Mesh;
  16791. /**
  16792. * Boolean : True if the mesh owns the requested kind of data.
  16793. */
  16794. isVerticesDataPresent(kind: string): boolean;
  16795. /**
  16796. * Returns an array of indices (IndicesArray).
  16797. */
  16798. getIndices(): Nullable<IndicesArray>;
  16799. get _positions(): Nullable<Vector3[]>;
  16800. /**
  16801. * This method recomputes and sets a new BoundingInfo to the mesh unless it is locked.
  16802. * This means the mesh underlying bounding box and sphere are recomputed.
  16803. * @param applySkeleton defines whether to apply the skeleton before computing the bounding info
  16804. * @returns the current mesh
  16805. */
  16806. refreshBoundingInfo(applySkeleton?: boolean): InstancedMesh;
  16807. /** @hidden */
  16808. _preActivate(): InstancedMesh;
  16809. /** @hidden */
  16810. _activate(renderId: number, intermediateRendering: boolean): boolean;
  16811. /** @hidden */
  16812. _postActivate(): void;
  16813. getWorldMatrix(): Matrix;
  16814. get isAnInstance(): boolean;
  16815. /**
  16816. * Returns the current associated LOD AbstractMesh.
  16817. */
  16818. getLOD(camera: Camera): AbstractMesh;
  16819. /** @hidden */
  16820. _preActivateForIntermediateRendering(renderId: number): Mesh;
  16821. /** @hidden */
  16822. _syncSubMeshes(): InstancedMesh;
  16823. /** @hidden */
  16824. _generatePointsArray(): boolean;
  16825. /** @hidden */
  16826. _updateBoundingInfo(): AbstractMesh;
  16827. /**
  16828. * Creates a new InstancedMesh from the current mesh.
  16829. * - name (string) : the cloned mesh name
  16830. * - newParent (optional Node) : the optional Node to parent the clone to.
  16831. * - doNotCloneChildren (optional boolean, default `false`) : if `true` the model children aren't cloned.
  16832. *
  16833. * Returns the clone.
  16834. */
  16835. clone(name: string, newParent?: Nullable<Node>, doNotCloneChildren?: boolean): InstancedMesh;
  16836. /**
  16837. * Disposes the InstancedMesh.
  16838. * Returns nothing.
  16839. */
  16840. dispose(doNotRecurse?: boolean, disposeMaterialAndTextures?: boolean): void;
  16841. }
  16842. module "babylonjs/Meshes/mesh" {
  16843. interface Mesh {
  16844. /**
  16845. * Register a custom buffer that will be instanced
  16846. * @see https://doc.babylonjs.com/how_to/how_to_use_instances#custom-buffers
  16847. * @param kind defines the buffer kind
  16848. * @param stride defines the stride in floats
  16849. */
  16850. registerInstancedBuffer(kind: string, stride: number): void;
  16851. /**
  16852. * true to use the edge renderer for all instances of this mesh
  16853. */
  16854. edgesShareWithInstances: boolean;
  16855. /** @hidden */
  16856. _userInstancedBuffersStorage: {
  16857. data: {
  16858. [key: string]: Float32Array;
  16859. };
  16860. sizes: {
  16861. [key: string]: number;
  16862. };
  16863. vertexBuffers: {
  16864. [key: string]: Nullable<VertexBuffer>;
  16865. };
  16866. strides: {
  16867. [key: string]: number;
  16868. };
  16869. };
  16870. }
  16871. }
  16872. module "babylonjs/Meshes/abstractMesh" {
  16873. interface AbstractMesh {
  16874. /**
  16875. * Object used to store instanced buffers defined by user
  16876. * @see https://doc.babylonjs.com/how_to/how_to_use_instances#custom-buffers
  16877. */
  16878. instancedBuffers: {
  16879. [key: string]: any;
  16880. };
  16881. }
  16882. }
  16883. }
  16884. declare module "babylonjs/Materials/shaderMaterial" {
  16885. import { Nullable } from "babylonjs/types";
  16886. import { Scene } from "babylonjs/scene";
  16887. import { Matrix, Vector3, Vector2, Vector4 } from "babylonjs/Maths/math.vector";
  16888. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  16889. import { Mesh } from "babylonjs/Meshes/mesh";
  16890. import { SubMesh } from "babylonjs/Meshes/subMesh";
  16891. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  16892. import { Effect } from "babylonjs/Materials/effect";
  16893. import { Material } from "babylonjs/Materials/material";
  16894. import { Color3, Color4 } from "babylonjs/Maths/math.color";
  16895. /**
  16896. * Defines the options associated with the creation of a shader material.
  16897. */
  16898. export interface IShaderMaterialOptions {
  16899. /**
  16900. * Does the material work in alpha blend mode
  16901. */
  16902. needAlphaBlending: boolean;
  16903. /**
  16904. * Does the material work in alpha test mode
  16905. */
  16906. needAlphaTesting: boolean;
  16907. /**
  16908. * The list of attribute names used in the shader
  16909. */
  16910. attributes: string[];
  16911. /**
  16912. * The list of unifrom names used in the shader
  16913. */
  16914. uniforms: string[];
  16915. /**
  16916. * The list of UBO names used in the shader
  16917. */
  16918. uniformBuffers: string[];
  16919. /**
  16920. * The list of sampler names used in the shader
  16921. */
  16922. samplers: string[];
  16923. /**
  16924. * The list of defines used in the shader
  16925. */
  16926. defines: string[];
  16927. }
  16928. /**
  16929. * The ShaderMaterial object has the necessary methods to pass data from your scene to the Vertex and Fragment Shaders and returns a material that can be applied to any mesh.
  16930. *
  16931. * This returned material effects how the mesh will look based on the code in the shaders.
  16932. *
  16933. * @see https://doc.babylonjs.com/how_to/shader_material
  16934. */
  16935. export class ShaderMaterial extends Material {
  16936. private _shaderPath;
  16937. private _options;
  16938. private _textures;
  16939. private _textureArrays;
  16940. private _floats;
  16941. private _ints;
  16942. private _floatsArrays;
  16943. private _colors3;
  16944. private _colors3Arrays;
  16945. private _colors4;
  16946. private _colors4Arrays;
  16947. private _vectors2;
  16948. private _vectors3;
  16949. private _vectors4;
  16950. private _matrices;
  16951. private _matrixArrays;
  16952. private _matrices3x3;
  16953. private _matrices2x2;
  16954. private _vectors2Arrays;
  16955. private _vectors3Arrays;
  16956. private _vectors4Arrays;
  16957. private _cachedWorldViewMatrix;
  16958. private _cachedWorldViewProjectionMatrix;
  16959. private _renderId;
  16960. private _multiview;
  16961. private _cachedDefines;
  16962. /** Define the Url to load snippets */
  16963. static SnippetUrl: string;
  16964. /** Snippet ID if the material was created from the snippet server */
  16965. snippetId: string;
  16966. /**
  16967. * Instantiate a new shader material.
  16968. * The ShaderMaterial object has the necessary methods to pass data from your scene to the Vertex and Fragment Shaders and returns a material that can be applied to any mesh.
  16969. * This returned material effects how the mesh will look based on the code in the shaders.
  16970. * @see https://doc.babylonjs.com/how_to/shader_material
  16971. * @param name Define the name of the material in the scene
  16972. * @param scene Define the scene the material belongs to
  16973. * @param shaderPath Defines the route to the shader code in one of three ways:
  16974. * * object: { vertex: "custom", fragment: "custom" }, used with Effect.ShadersStore["customVertexShader"] and Effect.ShadersStore["customFragmentShader"]
  16975. * * object: { vertexElement: "vertexShaderCode", fragmentElement: "fragmentShaderCode" }, used with shader code in script tags
  16976. * * object: { vertexSource: "vertex shader code string", fragmentSource: "fragment shader code string" } using with strings containing the shaders code
  16977. * * string: "./COMMON_NAME", used with external files COMMON_NAME.vertex.fx and COMMON_NAME.fragment.fx in index.html folder.
  16978. * @param options Define the options used to create the shader
  16979. */
  16980. constructor(name: string, scene: Scene, shaderPath: any, options?: Partial<IShaderMaterialOptions>);
  16981. /**
  16982. * Gets the shader path used to define the shader code
  16983. * It can be modified to trigger a new compilation
  16984. */
  16985. get shaderPath(): any;
  16986. /**
  16987. * Sets the shader path used to define the shader code
  16988. * It can be modified to trigger a new compilation
  16989. */
  16990. set shaderPath(shaderPath: any);
  16991. /**
  16992. * Gets the options used to compile the shader.
  16993. * They can be modified to trigger a new compilation
  16994. */
  16995. get options(): IShaderMaterialOptions;
  16996. /**
  16997. * Gets the current class name of the material e.g. "ShaderMaterial"
  16998. * Mainly use in serialization.
  16999. * @returns the class name
  17000. */
  17001. getClassName(): string;
  17002. /**
  17003. * Specifies if the material will require alpha blending
  17004. * @returns a boolean specifying if alpha blending is needed
  17005. */
  17006. needAlphaBlending(): boolean;
  17007. /**
  17008. * Specifies if this material should be rendered in alpha test mode
  17009. * @returns a boolean specifying if an alpha test is needed.
  17010. */
  17011. needAlphaTesting(): boolean;
  17012. private _checkUniform;
  17013. /**
  17014. * Set a texture in the shader.
  17015. * @param name Define the name of the uniform samplers as defined in the shader
  17016. * @param texture Define the texture to bind to this sampler
  17017. * @return the material itself allowing "fluent" like uniform updates
  17018. */
  17019. setTexture(name: string, texture: BaseTexture): ShaderMaterial;
  17020. /**
  17021. * Set a texture array in the shader.
  17022. * @param name Define the name of the uniform sampler array as defined in the shader
  17023. * @param textures Define the list of textures to bind to this sampler
  17024. * @return the material itself allowing "fluent" like uniform updates
  17025. */
  17026. setTextureArray(name: string, textures: BaseTexture[]): ShaderMaterial;
  17027. /**
  17028. * Set a float in the shader.
  17029. * @param name Define the name of the uniform as defined in the shader
  17030. * @param value Define the value to give to the uniform
  17031. * @return the material itself allowing "fluent" like uniform updates
  17032. */
  17033. setFloat(name: string, value: number): ShaderMaterial;
  17034. /**
  17035. * Set a int in the shader.
  17036. * @param name Define the name of the uniform as defined in the shader
  17037. * @param value Define the value to give to the uniform
  17038. * @return the material itself allowing "fluent" like uniform updates
  17039. */
  17040. setInt(name: string, value: number): ShaderMaterial;
  17041. /**
  17042. * Set an array of floats in the shader.
  17043. * @param name Define the name of the uniform as defined in the shader
  17044. * @param value Define the value to give to the uniform
  17045. * @return the material itself allowing "fluent" like uniform updates
  17046. */
  17047. setFloats(name: string, value: number[]): ShaderMaterial;
  17048. /**
  17049. * Set a vec3 in the shader from a Color3.
  17050. * @param name Define the name of the uniform as defined in the shader
  17051. * @param value Define the value to give to the uniform
  17052. * @return the material itself allowing "fluent" like uniform updates
  17053. */
  17054. setColor3(name: string, value: Color3): ShaderMaterial;
  17055. /**
  17056. * Set a vec3 array in the shader from a Color3 array.
  17057. * @param name Define the name of the uniform as defined in the shader
  17058. * @param value Define the value to give to the uniform
  17059. * @return the material itself allowing "fluent" like uniform updates
  17060. */
  17061. setColor3Array(name: string, value: Color3[]): ShaderMaterial;
  17062. /**
  17063. * Set a vec4 in the shader from a Color4.
  17064. * @param name Define the name of the uniform as defined in the shader
  17065. * @param value Define the value to give to the uniform
  17066. * @return the material itself allowing "fluent" like uniform updates
  17067. */
  17068. setColor4(name: string, value: Color4): ShaderMaterial;
  17069. /**
  17070. * Set a vec4 array in the shader from a Color4 array.
  17071. * @param name Define the name of the uniform as defined in the shader
  17072. * @param value Define the value to give to the uniform
  17073. * @return the material itself allowing "fluent" like uniform updates
  17074. */
  17075. setColor4Array(name: string, value: Color4[]): ShaderMaterial;
  17076. /**
  17077. * Set a vec2 in the shader from a Vector2.
  17078. * @param name Define the name of the uniform as defined in the shader
  17079. * @param value Define the value to give to the uniform
  17080. * @return the material itself allowing "fluent" like uniform updates
  17081. */
  17082. setVector2(name: string, value: Vector2): ShaderMaterial;
  17083. /**
  17084. * Set a vec3 in the shader from a Vector3.
  17085. * @param name Define the name of the uniform as defined in the shader
  17086. * @param value Define the value to give to the uniform
  17087. * @return the material itself allowing "fluent" like uniform updates
  17088. */
  17089. setVector3(name: string, value: Vector3): ShaderMaterial;
  17090. /**
  17091. * Set a vec4 in the shader from a Vector4.
  17092. * @param name Define the name of the uniform as defined in the shader
  17093. * @param value Define the value to give to the uniform
  17094. * @return the material itself allowing "fluent" like uniform updates
  17095. */
  17096. setVector4(name: string, value: Vector4): ShaderMaterial;
  17097. /**
  17098. * Set a mat4 in the shader from a Matrix.
  17099. * @param name Define the name of the uniform as defined in the shader
  17100. * @param value Define the value to give to the uniform
  17101. * @return the material itself allowing "fluent" like uniform updates
  17102. */
  17103. setMatrix(name: string, value: Matrix): ShaderMaterial;
  17104. /**
  17105. * Set a float32Array in the shader from a matrix array.
  17106. * @param name Define the name of the uniform as defined in the shader
  17107. * @param value Define the value to give to the uniform
  17108. * @return the material itself allowing "fluent" like uniform updates
  17109. */
  17110. setMatrices(name: string, value: Matrix[]): ShaderMaterial;
  17111. /**
  17112. * Set a mat3 in the shader from a Float32Array.
  17113. * @param name Define the name of the uniform as defined in the shader
  17114. * @param value Define the value to give to the uniform
  17115. * @return the material itself allowing "fluent" like uniform updates
  17116. */
  17117. setMatrix3x3(name: string, value: Float32Array | Array<number>): ShaderMaterial;
  17118. /**
  17119. * Set a mat2 in the shader from a Float32Array.
  17120. * @param name Define the name of the uniform as defined in the shader
  17121. * @param value Define the value to give to the uniform
  17122. * @return the material itself allowing "fluent" like uniform updates
  17123. */
  17124. setMatrix2x2(name: string, value: Float32Array | Array<number>): ShaderMaterial;
  17125. /**
  17126. * Set a vec2 array in the shader from a number array.
  17127. * @param name Define the name of the uniform as defined in the shader
  17128. * @param value Define the value to give to the uniform
  17129. * @return the material itself allowing "fluent" like uniform updates
  17130. */
  17131. setArray2(name: string, value: number[]): ShaderMaterial;
  17132. /**
  17133. * Set a vec3 array in the shader from a number array.
  17134. * @param name Define the name of the uniform as defined in the shader
  17135. * @param value Define the value to give to the uniform
  17136. * @return the material itself allowing "fluent" like uniform updates
  17137. */
  17138. setArray3(name: string, value: number[]): ShaderMaterial;
  17139. /**
  17140. * Set a vec4 array in the shader from a number array.
  17141. * @param name Define the name of the uniform as defined in the shader
  17142. * @param value Define the value to give to the uniform
  17143. * @return the material itself allowing "fluent" like uniform updates
  17144. */
  17145. setArray4(name: string, value: number[]): ShaderMaterial;
  17146. private _checkCache;
  17147. /**
  17148. * Specifies that the submesh is ready to be used
  17149. * @param mesh defines the mesh to check
  17150. * @param subMesh defines which submesh to check
  17151. * @param useInstances specifies that instances should be used
  17152. * @returns a boolean indicating that the submesh is ready or not
  17153. */
  17154. isReadyForSubMesh(mesh: AbstractMesh, subMesh: SubMesh, useInstances?: boolean): boolean;
  17155. /**
  17156. * Checks if the material is ready to render the requested mesh
  17157. * @param mesh Define the mesh to render
  17158. * @param useInstances Define whether or not the material is used with instances
  17159. * @returns true if ready, otherwise false
  17160. */
  17161. isReady(mesh?: AbstractMesh, useInstances?: boolean): boolean;
  17162. /**
  17163. * Binds the world matrix to the material
  17164. * @param world defines the world transformation matrix
  17165. * @param effectOverride - If provided, use this effect instead of internal effect
  17166. */
  17167. bindOnlyWorldMatrix(world: Matrix, effectOverride?: Nullable<Effect>): void;
  17168. /**
  17169. * Binds the submesh to this material by preparing the effect and shader to draw
  17170. * @param world defines the world transformation matrix
  17171. * @param mesh defines the mesh containing the submesh
  17172. * @param subMesh defines the submesh to bind the material to
  17173. */
  17174. bindForSubMesh(world: Matrix, mesh: Mesh, subMesh: SubMesh): void;
  17175. /**
  17176. * Binds the material to the mesh
  17177. * @param world defines the world transformation matrix
  17178. * @param mesh defines the mesh to bind the material to
  17179. * @param effectOverride - If provided, use this effect instead of internal effect
  17180. */
  17181. bind(world: Matrix, mesh?: Mesh, effectOverride?: Nullable<Effect>): void;
  17182. protected _afterBind(mesh?: Mesh): void;
  17183. /**
  17184. * Gets the active textures from the material
  17185. * @returns an array of textures
  17186. */
  17187. getActiveTextures(): BaseTexture[];
  17188. /**
  17189. * Specifies if the material uses a texture
  17190. * @param texture defines the texture to check against the material
  17191. * @returns a boolean specifying if the material uses the texture
  17192. */
  17193. hasTexture(texture: BaseTexture): boolean;
  17194. /**
  17195. * Makes a duplicate of the material, and gives it a new name
  17196. * @param name defines the new name for the duplicated material
  17197. * @returns the cloned material
  17198. */
  17199. clone(name: string): ShaderMaterial;
  17200. /**
  17201. * Disposes the material
  17202. * @param forceDisposeEffect specifies if effects should be forcefully disposed
  17203. * @param forceDisposeTextures specifies if textures should be forcefully disposed
  17204. * @param notBoundToMesh specifies if the material that is being disposed is known to be not bound to any mesh
  17205. */
  17206. dispose(forceDisposeEffect?: boolean, forceDisposeTextures?: boolean, notBoundToMesh?: boolean): void;
  17207. /**
  17208. * Serializes this material in a JSON representation
  17209. * @returns the serialized material object
  17210. */
  17211. serialize(): any;
  17212. /**
  17213. * Creates a shader material from parsed shader material data
  17214. * @param source defines the JSON represnetation of the material
  17215. * @param scene defines the hosting scene
  17216. * @param rootUrl defines the root URL to use to load textures and relative dependencies
  17217. * @returns a new material
  17218. */
  17219. static Parse(source: any, scene: Scene, rootUrl: string): ShaderMaterial;
  17220. /**
  17221. * Creates a new ShaderMaterial from a snippet saved in a remote file
  17222. * @param name defines the name of the ShaderMaterial to create (can be null or empty to use the one from the json data)
  17223. * @param url defines the url to load from
  17224. * @param scene defines the hosting scene
  17225. * @param rootUrl defines the root URL to use to load textures and relative dependencies
  17226. * @returns a promise that will resolve to the new ShaderMaterial
  17227. */
  17228. static ParseFromFileAsync(name: Nullable<string>, url: string, scene: Scene, rootUrl?: string): Promise<ShaderMaterial>;
  17229. /**
  17230. * Creates a ShaderMaterial from a snippet saved by the Inspector
  17231. * @param snippetId defines the snippet to load
  17232. * @param scene defines the hosting scene
  17233. * @param rootUrl defines the root URL to use to load textures and relative dependencies
  17234. * @returns a promise that will resolve to the new ShaderMaterial
  17235. */
  17236. static CreateFromSnippetAsync(snippetId: string, scene: Scene, rootUrl?: string): Promise<ShaderMaterial>;
  17237. }
  17238. }
  17239. declare module "babylonjs/Shaders/color.fragment" {
  17240. import "babylonjs/Shaders/ShadersInclude/clipPlaneFragmentDeclaration";
  17241. import "babylonjs/Shaders/ShadersInclude/clipPlaneFragment";
  17242. /** @hidden */
  17243. export var colorPixelShader: {
  17244. name: string;
  17245. shader: string;
  17246. };
  17247. }
  17248. declare module "babylonjs/Shaders/color.vertex" {
  17249. import "babylonjs/Shaders/ShadersInclude/bonesDeclaration";
  17250. import "babylonjs/Shaders/ShadersInclude/clipPlaneVertexDeclaration";
  17251. import "babylonjs/Shaders/ShadersInclude/instancesDeclaration";
  17252. import "babylonjs/Shaders/ShadersInclude/instancesVertex";
  17253. import "babylonjs/Shaders/ShadersInclude/bonesVertex";
  17254. import "babylonjs/Shaders/ShadersInclude/clipPlaneVertex";
  17255. /** @hidden */
  17256. export var colorVertexShader: {
  17257. name: string;
  17258. shader: string;
  17259. };
  17260. }
  17261. declare module "babylonjs/Meshes/linesMesh" {
  17262. import { Nullable } from "babylonjs/types";
  17263. import { Scene } from "babylonjs/scene";
  17264. import { Color3 } from "babylonjs/Maths/math.color";
  17265. import { Node } from "babylonjs/node";
  17266. import { SubMesh } from "babylonjs/Meshes/subMesh";
  17267. import { Mesh } from "babylonjs/Meshes/mesh";
  17268. import { InstancedMesh } from "babylonjs/Meshes/instancedMesh";
  17269. import { Effect } from "babylonjs/Materials/effect";
  17270. import { Material } from "babylonjs/Materials/material";
  17271. import "babylonjs/Shaders/color.fragment";
  17272. import "babylonjs/Shaders/color.vertex";
  17273. /**
  17274. * Line mesh
  17275. * @see https://doc.babylonjs.com/babylon101/parametric_shapes
  17276. */
  17277. export class LinesMesh extends Mesh {
  17278. /**
  17279. * If vertex color should be applied to the mesh
  17280. */
  17281. readonly useVertexColor?: boolean | undefined;
  17282. /**
  17283. * If vertex alpha should be applied to the mesh
  17284. */
  17285. readonly useVertexAlpha?: boolean | undefined;
  17286. /**
  17287. * Color of the line (Default: White)
  17288. */
  17289. color: Color3;
  17290. /**
  17291. * Alpha of the line (Default: 1)
  17292. */
  17293. alpha: number;
  17294. /**
  17295. * The intersection Threshold is the margin applied when intersection a segment of the LinesMesh with a Ray.
  17296. * This margin is expressed in world space coordinates, so its value may vary.
  17297. * Default value is 0.1
  17298. */
  17299. intersectionThreshold: number;
  17300. private _colorShader;
  17301. private color4;
  17302. /**
  17303. * Creates a new LinesMesh
  17304. * @param name defines the name
  17305. * @param scene defines the hosting scene
  17306. * @param parent defines the parent mesh if any
  17307. * @param source defines the optional source LinesMesh used to clone data from
  17308. * @param doNotCloneChildren When cloning, skip cloning child meshes of source, default False.
  17309. * When false, achieved by calling a clone(), also passing False.
  17310. * This will make creation of children, recursive.
  17311. * @param useVertexColor defines if this LinesMesh supports vertex color
  17312. * @param useVertexAlpha defines if this LinesMesh supports vertex alpha
  17313. */
  17314. constructor(name: string, scene?: Nullable<Scene>, parent?: Nullable<Node>, source?: Nullable<LinesMesh>, doNotCloneChildren?: boolean,
  17315. /**
  17316. * If vertex color should be applied to the mesh
  17317. */
  17318. useVertexColor?: boolean | undefined,
  17319. /**
  17320. * If vertex alpha should be applied to the mesh
  17321. */
  17322. useVertexAlpha?: boolean | undefined);
  17323. private _addClipPlaneDefine;
  17324. private _removeClipPlaneDefine;
  17325. isReady(): boolean;
  17326. /**
  17327. * Returns the string "LineMesh"
  17328. */
  17329. getClassName(): string;
  17330. /**
  17331. * @hidden
  17332. */
  17333. get material(): Material;
  17334. /**
  17335. * @hidden
  17336. */
  17337. set material(value: Material);
  17338. /**
  17339. * @hidden
  17340. */
  17341. get checkCollisions(): boolean;
  17342. /** @hidden */
  17343. _bind(subMesh: SubMesh, effect: Effect, fillMode: number): Mesh;
  17344. /** @hidden */
  17345. _draw(subMesh: SubMesh, fillMode: number, instancesCount?: number): Mesh;
  17346. /**
  17347. * Disposes of the line mesh
  17348. * @param doNotRecurse If children should be disposed
  17349. */
  17350. dispose(doNotRecurse?: boolean): void;
  17351. /**
  17352. * Returns a new LineMesh object cloned from the current one.
  17353. */
  17354. clone(name: string, newParent?: Nullable<Node>, doNotCloneChildren?: boolean): LinesMesh;
  17355. /**
  17356. * Creates a new InstancedLinesMesh object from the mesh model.
  17357. * @see https://doc.babylonjs.com/how_to/how_to_use_instances
  17358. * @param name defines the name of the new instance
  17359. * @returns a new InstancedLinesMesh
  17360. */
  17361. createInstance(name: string): InstancedLinesMesh;
  17362. }
  17363. /**
  17364. * Creates an instance based on a source LinesMesh
  17365. */
  17366. export class InstancedLinesMesh extends InstancedMesh {
  17367. /**
  17368. * The intersection Threshold is the margin applied when intersection a segment of the LinesMesh with a Ray.
  17369. * This margin is expressed in world space coordinates, so its value may vary.
  17370. * Initilized with the intersectionThreshold value of the source LinesMesh
  17371. */
  17372. intersectionThreshold: number;
  17373. constructor(name: string, source: LinesMesh);
  17374. /**
  17375. * Returns the string "InstancedLinesMesh".
  17376. */
  17377. getClassName(): string;
  17378. }
  17379. }
  17380. declare module "babylonjs/Shaders/line.fragment" {
  17381. /** @hidden */
  17382. export var linePixelShader: {
  17383. name: string;
  17384. shader: string;
  17385. };
  17386. }
  17387. declare module "babylonjs/Shaders/line.vertex" {
  17388. import "babylonjs/Shaders/ShadersInclude/instancesDeclaration";
  17389. import "babylonjs/Shaders/ShadersInclude/instancesVertex";
  17390. /** @hidden */
  17391. export var lineVertexShader: {
  17392. name: string;
  17393. shader: string;
  17394. };
  17395. }
  17396. declare module "babylonjs/Rendering/edgesRenderer" {
  17397. import { Nullable } from "babylonjs/types";
  17398. import { VertexBuffer } from "babylonjs/Meshes/buffer";
  17399. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  17400. import { Vector3, Matrix } from "babylonjs/Maths/math.vector";
  17401. import { IDisposable } from "babylonjs/scene";
  17402. import { ShaderMaterial } from "babylonjs/Materials/shaderMaterial";
  17403. import "babylonjs/Shaders/line.fragment";
  17404. import "babylonjs/Shaders/line.vertex";
  17405. import { DataBuffer } from "babylonjs/Meshes/dataBuffer";
  17406. import { SmartArray } from "babylonjs/Misc/smartArray";
  17407. module "babylonjs/scene" {
  17408. interface Scene {
  17409. /** @hidden */
  17410. _edgeRenderLineShader: Nullable<ShaderMaterial>;
  17411. }
  17412. }
  17413. module "babylonjs/Meshes/abstractMesh" {
  17414. interface AbstractMesh {
  17415. /**
  17416. * Gets the edgesRenderer associated with the mesh
  17417. */
  17418. edgesRenderer: Nullable<EdgesRenderer>;
  17419. }
  17420. }
  17421. module "babylonjs/Meshes/linesMesh" {
  17422. interface LinesMesh {
  17423. /**
  17424. * Enables the edge rendering mode on the mesh.
  17425. * This mode makes the mesh edges visible
  17426. * @param epsilon defines the maximal distance between two angles to detect a face
  17427. * @param checkVerticesInsteadOfIndices indicates that we should check vertex list directly instead of faces
  17428. * @returns the currentAbstractMesh
  17429. * @see https://www.babylonjs-playground.com/#19O9TU#0
  17430. */
  17431. enableEdgesRendering(epsilon?: number, checkVerticesInsteadOfIndices?: boolean): AbstractMesh;
  17432. }
  17433. }
  17434. module "babylonjs/Meshes/linesMesh" {
  17435. interface InstancedLinesMesh {
  17436. /**
  17437. * Enables the edge rendering mode on the mesh.
  17438. * This mode makes the mesh edges visible
  17439. * @param epsilon defines the maximal distance between two angles to detect a face
  17440. * @param checkVerticesInsteadOfIndices indicates that we should check vertex list directly instead of faces
  17441. * @returns the current InstancedLinesMesh
  17442. * @see https://www.babylonjs-playground.com/#19O9TU#0
  17443. */
  17444. enableEdgesRendering(epsilon?: number, checkVerticesInsteadOfIndices?: boolean): InstancedLinesMesh;
  17445. }
  17446. }
  17447. /**
  17448. * Defines the minimum contract an Edges renderer should follow.
  17449. */
  17450. export interface IEdgesRenderer extends IDisposable {
  17451. /**
  17452. * Gets or sets a boolean indicating if the edgesRenderer is active
  17453. */
  17454. isEnabled: boolean;
  17455. /**
  17456. * Renders the edges of the attached mesh,
  17457. */
  17458. render(): void;
  17459. /**
  17460. * Checks wether or not the edges renderer is ready to render.
  17461. * @return true if ready, otherwise false.
  17462. */
  17463. isReady(): boolean;
  17464. /**
  17465. * List of instances to render in case the source mesh has instances
  17466. */
  17467. customInstances: SmartArray<Matrix>;
  17468. }
  17469. /**
  17470. * Defines the additional options of the edges renderer
  17471. */
  17472. export interface IEdgesRendererOptions {
  17473. /**
  17474. * Gets or sets a boolean indicating that the alternate edge finder algorithm must be used
  17475. * If not defined, the default value is true
  17476. */
  17477. useAlternateEdgeFinder?: boolean;
  17478. /**
  17479. * Gets or sets a boolean indicating that the vertex merger fast processing must be used.
  17480. * If not defined, the default value is true.
  17481. * You should normally leave it undefined (or set it to true), except if you see some artifacts in the edges rendering (can happen with complex geometries)
  17482. * This option is used only if useAlternateEdgeFinder = true
  17483. */
  17484. useFastVertexMerger?: boolean;
  17485. /**
  17486. * During edges processing, the vertices are merged if they are close enough: epsilonVertexMerge is the limit whithin which vertices are considered to be equal.
  17487. * The default value is 1e-6
  17488. * This option is used only if useAlternateEdgeFinder = true
  17489. */
  17490. epsilonVertexMerge?: number;
  17491. /**
  17492. * Gets or sets a boolean indicating that tessellation should be applied before finding the edges. You may need to activate this option if your geometry is a bit
  17493. * unusual, like having a vertex of a triangle in-between two vertices of an edge of another triangle. It happens often when using CSG to construct meshes.
  17494. * This option is used only if useAlternateEdgeFinder = true
  17495. */
  17496. applyTessellation?: boolean;
  17497. /**
  17498. * The limit under which 3 vertices are considered to be aligned. 3 vertices PQR are considered aligned if distance(PQ) + distance(QR) - distance(PR) < epsilonVertexAligned
  17499. * The default value is 1e-6
  17500. * This option is used only if useAlternateEdgeFinder = true
  17501. */
  17502. epsilonVertexAligned?: number;
  17503. }
  17504. /**
  17505. * This class is used to generate edges of the mesh that could then easily be rendered in a scene.
  17506. */
  17507. export class EdgesRenderer implements IEdgesRenderer {
  17508. /**
  17509. * Define the size of the edges with an orthographic camera
  17510. */
  17511. edgesWidthScalerForOrthographic: number;
  17512. /**
  17513. * Define the size of the edges with a perspective camera
  17514. */
  17515. edgesWidthScalerForPerspective: number;
  17516. protected _source: AbstractMesh;
  17517. protected _linesPositions: number[];
  17518. protected _linesNormals: number[];
  17519. protected _linesIndices: number[];
  17520. protected _epsilon: number;
  17521. protected _indicesCount: number;
  17522. protected _lineShader: ShaderMaterial;
  17523. protected _ib: DataBuffer;
  17524. protected _buffers: {
  17525. [key: string]: Nullable<VertexBuffer>;
  17526. };
  17527. protected _buffersForInstances: {
  17528. [key: string]: Nullable<VertexBuffer>;
  17529. };
  17530. protected _checkVerticesInsteadOfIndices: boolean;
  17531. protected _options: Nullable<IEdgesRendererOptions>;
  17532. private _meshRebuildObserver;
  17533. private _meshDisposeObserver;
  17534. /** Gets or sets a boolean indicating if the edgesRenderer is active */
  17535. isEnabled: boolean;
  17536. /**
  17537. * List of instances to render in case the source mesh has instances
  17538. */
  17539. customInstances: SmartArray<Matrix>;
  17540. private static GetShader;
  17541. /**
  17542. * Creates an instance of the EdgesRenderer. It is primarily use to display edges of a mesh.
  17543. * Beware when you use this class with complex objects as the adjacencies computation can be really long
  17544. * @param source Mesh used to create edges
  17545. * @param epsilon sum of angles in adjacency to check for edge
  17546. * @param checkVerticesInsteadOfIndices bases the edges detection on vertices vs indices. Note that this parameter is not used if options.useAlternateEdgeFinder = true
  17547. * @param generateEdgesLines - should generate Lines or only prepare resources.
  17548. * @param options The options to apply when generating the edges
  17549. */
  17550. constructor(source: AbstractMesh, epsilon?: number, checkVerticesInsteadOfIndices?: boolean, generateEdgesLines?: boolean, options?: IEdgesRendererOptions);
  17551. protected _prepareRessources(): void;
  17552. /** @hidden */
  17553. _rebuild(): void;
  17554. /**
  17555. * Releases the required resources for the edges renderer
  17556. */
  17557. dispose(): void;
  17558. protected _processEdgeForAdjacencies(pa: number, pb: number, p0: number, p1: number, p2: number): number;
  17559. protected _processEdgeForAdjacenciesWithVertices(pa: Vector3, pb: Vector3, p0: Vector3, p1: Vector3, p2: Vector3): number;
  17560. /**
  17561. * Checks if the pair of p0 and p1 is en edge
  17562. * @param faceIndex
  17563. * @param edge
  17564. * @param faceNormals
  17565. * @param p0
  17566. * @param p1
  17567. * @private
  17568. */
  17569. protected _checkEdge(faceIndex: number, edge: number, faceNormals: Array<Vector3>, p0: Vector3, p1: Vector3): void;
  17570. /**
  17571. * push line into the position, normal and index buffer
  17572. * @protected
  17573. */
  17574. protected createLine(p0: Vector3, p1: Vector3, offset: number): void;
  17575. /**
  17576. * See https://playground.babylonjs.com/#R3JR6V#1 for a visual display of the algorithm
  17577. */
  17578. private _tessellateTriangle;
  17579. private _generateEdgesLinesAlternate;
  17580. /**
  17581. * Generates lines edges from adjacencjes
  17582. * @private
  17583. */
  17584. _generateEdgesLines(): void;
  17585. /**
  17586. * Checks wether or not the edges renderer is ready to render.
  17587. * @return true if ready, otherwise false.
  17588. */
  17589. isReady(): boolean;
  17590. /**
  17591. * Renders the edges of the attached mesh,
  17592. */
  17593. render(): void;
  17594. }
  17595. /**
  17596. * LineEdgesRenderer for LineMeshes to remove unnecessary triangulation
  17597. */
  17598. export class LineEdgesRenderer extends EdgesRenderer {
  17599. /**
  17600. * This constructor turns off auto generating edges line in Edges Renderer to make it here.
  17601. * @param source LineMesh used to generate edges
  17602. * @param epsilon not important (specified angle for edge detection)
  17603. * @param checkVerticesInsteadOfIndices not important for LineMesh
  17604. */
  17605. constructor(source: AbstractMesh, epsilon?: number, checkVerticesInsteadOfIndices?: boolean);
  17606. /**
  17607. * Generate edges for each line in LinesMesh. Every Line should be rendered as edge.
  17608. */
  17609. _generateEdgesLines(): void;
  17610. }
  17611. }
  17612. declare module "babylonjs/Rendering/renderingGroup" {
  17613. import { SmartArray, SmartArrayNoDuplicate } from "babylonjs/Misc/smartArray";
  17614. import { SubMesh } from "babylonjs/Meshes/subMesh";
  17615. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  17616. import { Nullable } from "babylonjs/types";
  17617. import { IParticleSystem } from "babylonjs/Particles/IParticleSystem";
  17618. import { IEdgesRenderer } from "babylonjs/Rendering/edgesRenderer";
  17619. import { ISpriteManager } from "babylonjs/Sprites/spriteManager";
  17620. import { Material } from "babylonjs/Materials/material";
  17621. import { Scene } from "babylonjs/scene";
  17622. /**
  17623. * This represents the object necessary to create a rendering group.
  17624. * This is exclusively used and created by the rendering manager.
  17625. * To modify the behavior, you use the available helpers in your scene or meshes.
  17626. * @hidden
  17627. */
  17628. export class RenderingGroup {
  17629. index: number;
  17630. private static _zeroVector;
  17631. private _scene;
  17632. private _opaqueSubMeshes;
  17633. private _transparentSubMeshes;
  17634. private _alphaTestSubMeshes;
  17635. private _depthOnlySubMeshes;
  17636. private _particleSystems;
  17637. private _spriteManagers;
  17638. private _opaqueSortCompareFn;
  17639. private _alphaTestSortCompareFn;
  17640. private _transparentSortCompareFn;
  17641. private _renderOpaque;
  17642. private _renderAlphaTest;
  17643. private _renderTransparent;
  17644. /** @hidden */
  17645. _edgesRenderers: SmartArrayNoDuplicate<IEdgesRenderer>;
  17646. onBeforeTransparentRendering: () => void;
  17647. /**
  17648. * Set the opaque sort comparison function.
  17649. * If null the sub meshes will be render in the order they were created
  17650. */
  17651. set opaqueSortCompareFn(value: Nullable<(a: SubMesh, b: SubMesh) => number>);
  17652. /**
  17653. * Set the alpha test sort comparison function.
  17654. * If null the sub meshes will be render in the order they were created
  17655. */
  17656. set alphaTestSortCompareFn(value: Nullable<(a: SubMesh, b: SubMesh) => number>);
  17657. /**
  17658. * Set the transparent sort comparison function.
  17659. * If null the sub meshes will be render in the order they were created
  17660. */
  17661. set transparentSortCompareFn(value: Nullable<(a: SubMesh, b: SubMesh) => number>);
  17662. /**
  17663. * Creates a new rendering group.
  17664. * @param index The rendering group index
  17665. * @param opaqueSortCompareFn The opaque sort comparison function. If null no order is applied
  17666. * @param alphaTestSortCompareFn The alpha test sort comparison function. If null no order is applied
  17667. * @param transparentSortCompareFn The transparent sort comparison function. If null back to front + alpha index sort is applied
  17668. */
  17669. constructor(index: number, scene: Scene, opaqueSortCompareFn?: Nullable<(a: SubMesh, b: SubMesh) => number>, alphaTestSortCompareFn?: Nullable<(a: SubMesh, b: SubMesh) => number>, transparentSortCompareFn?: Nullable<(a: SubMesh, b: SubMesh) => number>);
  17670. /**
  17671. * Render all the sub meshes contained in the group.
  17672. * @param customRenderFunction Used to override the default render behaviour of the group.
  17673. * @returns true if rendered some submeshes.
  17674. */
  17675. render(customRenderFunction: Nullable<(opaqueSubMeshes: SmartArray<SubMesh>, transparentSubMeshes: SmartArray<SubMesh>, alphaTestSubMeshes: SmartArray<SubMesh>, depthOnlySubMeshes: SmartArray<SubMesh>) => void>, renderSprites: boolean, renderParticles: boolean, activeMeshes: Nullable<AbstractMesh[]>): void;
  17676. /**
  17677. * Renders the opaque submeshes in the order from the opaqueSortCompareFn.
  17678. * @param subMeshes The submeshes to render
  17679. */
  17680. private renderOpaqueSorted;
  17681. /**
  17682. * Renders the opaque submeshes in the order from the alphatestSortCompareFn.
  17683. * @param subMeshes The submeshes to render
  17684. */
  17685. private renderAlphaTestSorted;
  17686. /**
  17687. * Renders the opaque submeshes in the order from the transparentSortCompareFn.
  17688. * @param subMeshes The submeshes to render
  17689. */
  17690. private renderTransparentSorted;
  17691. /**
  17692. * Renders the submeshes in a specified order.
  17693. * @param subMeshes The submeshes to sort before render
  17694. * @param sortCompareFn The comparison function use to sort
  17695. * @param cameraPosition The camera position use to preprocess the submeshes to help sorting
  17696. * @param transparent Specifies to activate blending if true
  17697. */
  17698. private static renderSorted;
  17699. /**
  17700. * Renders the submeshes in the order they were dispatched (no sort applied).
  17701. * @param subMeshes The submeshes to render
  17702. */
  17703. private static renderUnsorted;
  17704. /**
  17705. * Build in function which can be applied to ensure meshes of a special queue (opaque, alpha test, transparent)
  17706. * are rendered back to front if in the same alpha index.
  17707. *
  17708. * @param a The first submesh
  17709. * @param b The second submesh
  17710. * @returns The result of the comparison
  17711. */
  17712. static defaultTransparentSortCompare(a: SubMesh, b: SubMesh): number;
  17713. /**
  17714. * Build in function which can be applied to ensure meshes of a special queue (opaque, alpha test, transparent)
  17715. * are rendered back to front.
  17716. *
  17717. * @param a The first submesh
  17718. * @param b The second submesh
  17719. * @returns The result of the comparison
  17720. */
  17721. static backToFrontSortCompare(a: SubMesh, b: SubMesh): number;
  17722. /**
  17723. * Build in function which can be applied to ensure meshes of a special queue (opaque, alpha test, transparent)
  17724. * are rendered front to back (prevent overdraw).
  17725. *
  17726. * @param a The first submesh
  17727. * @param b The second submesh
  17728. * @returns The result of the comparison
  17729. */
  17730. static frontToBackSortCompare(a: SubMesh, b: SubMesh): number;
  17731. /**
  17732. * Resets the different lists of submeshes to prepare a new frame.
  17733. */
  17734. prepare(): void;
  17735. dispose(): void;
  17736. /**
  17737. * Inserts the submesh in its correct queue depending on its material.
  17738. * @param subMesh The submesh to dispatch
  17739. * @param [mesh] Optional reference to the submeshes's mesh. Provide if you have an exiting reference to improve performance.
  17740. * @param [material] Optional reference to the submeshes's material. Provide if you have an exiting reference to improve performance.
  17741. */
  17742. dispatch(subMesh: SubMesh, mesh?: AbstractMesh, material?: Nullable<Material>): void;
  17743. dispatchSprites(spriteManager: ISpriteManager): void;
  17744. dispatchParticles(particleSystem: IParticleSystem): void;
  17745. private _renderParticles;
  17746. private _renderSprites;
  17747. }
  17748. }
  17749. declare module "babylonjs/Rendering/renderingManager" {
  17750. import { Nullable } from "babylonjs/types";
  17751. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  17752. import { SubMesh } from "babylonjs/Meshes/subMesh";
  17753. import { SmartArray } from "babylonjs/Misc/smartArray";
  17754. import { ISpriteManager } from "babylonjs/Sprites/spriteManager";
  17755. import { IParticleSystem } from "babylonjs/Particles/IParticleSystem";
  17756. import { Material } from "babylonjs/Materials/material";
  17757. import { Scene } from "babylonjs/scene";
  17758. import { Camera } from "babylonjs/Cameras/camera";
  17759. /**
  17760. * Interface describing the different options available in the rendering manager
  17761. * regarding Auto Clear between groups.
  17762. */
  17763. export interface IRenderingManagerAutoClearSetup {
  17764. /**
  17765. * Defines whether or not autoclear is enable.
  17766. */
  17767. autoClear: boolean;
  17768. /**
  17769. * Defines whether or not to autoclear the depth buffer.
  17770. */
  17771. depth: boolean;
  17772. /**
  17773. * Defines whether or not to autoclear the stencil buffer.
  17774. */
  17775. stencil: boolean;
  17776. }
  17777. /**
  17778. * This class is used by the onRenderingGroupObservable
  17779. */
  17780. export class RenderingGroupInfo {
  17781. /**
  17782. * The Scene that being rendered
  17783. */
  17784. scene: Scene;
  17785. /**
  17786. * The camera currently used for the rendering pass
  17787. */
  17788. camera: Nullable<Camera>;
  17789. /**
  17790. * The ID of the renderingGroup being processed
  17791. */
  17792. renderingGroupId: number;
  17793. }
  17794. /**
  17795. * This is the manager responsible of all the rendering for meshes sprites and particles.
  17796. * It is enable to manage the different groups as well as the different necessary sort functions.
  17797. * This should not be used directly aside of the few static configurations
  17798. */
  17799. export class RenderingManager {
  17800. /**
  17801. * The max id used for rendering groups (not included)
  17802. */
  17803. static MAX_RENDERINGGROUPS: number;
  17804. /**
  17805. * The min id used for rendering groups (included)
  17806. */
  17807. static MIN_RENDERINGGROUPS: number;
  17808. /**
  17809. * Used to globally prevent autoclearing scenes.
  17810. */
  17811. static AUTOCLEAR: boolean;
  17812. /**
  17813. * @hidden
  17814. */
  17815. _useSceneAutoClearSetup: boolean;
  17816. private _scene;
  17817. private _renderingGroups;
  17818. private _depthStencilBufferAlreadyCleaned;
  17819. private _autoClearDepthStencil;
  17820. private _customOpaqueSortCompareFn;
  17821. private _customAlphaTestSortCompareFn;
  17822. private _customTransparentSortCompareFn;
  17823. private _renderingGroupInfo;
  17824. /**
  17825. * Instantiates a new rendering group for a particular scene
  17826. * @param scene Defines the scene the groups belongs to
  17827. */
  17828. constructor(scene: Scene);
  17829. private _clearDepthStencilBuffer;
  17830. /**
  17831. * Renders the entire managed groups. This is used by the scene or the different rennder targets.
  17832. * @hidden
  17833. */
  17834. render(customRenderFunction: Nullable<(opaqueSubMeshes: SmartArray<SubMesh>, transparentSubMeshes: SmartArray<SubMesh>, alphaTestSubMeshes: SmartArray<SubMesh>, depthOnlySubMeshes: SmartArray<SubMesh>) => void>, activeMeshes: Nullable<AbstractMesh[]>, renderParticles: boolean, renderSprites: boolean): void;
  17835. /**
  17836. * Resets the different information of the group to prepare a new frame
  17837. * @hidden
  17838. */
  17839. reset(): void;
  17840. /**
  17841. * Dispose and release the group and its associated resources.
  17842. * @hidden
  17843. */
  17844. dispose(): void;
  17845. /**
  17846. * Clear the info related to rendering groups preventing retention points during dispose.
  17847. */
  17848. freeRenderingGroups(): void;
  17849. private _prepareRenderingGroup;
  17850. /**
  17851. * Add a sprite manager to the rendering manager in order to render it this frame.
  17852. * @param spriteManager Define the sprite manager to render
  17853. */
  17854. dispatchSprites(spriteManager: ISpriteManager): void;
  17855. /**
  17856. * Add a particle system to the rendering manager in order to render it this frame.
  17857. * @param particleSystem Define the particle system to render
  17858. */
  17859. dispatchParticles(particleSystem: IParticleSystem): void;
  17860. /**
  17861. * Add a submesh to the manager in order to render it this frame
  17862. * @param subMesh The submesh to dispatch
  17863. * @param mesh Optional reference to the submeshes's mesh. Provide if you have an exiting reference to improve performance.
  17864. * @param material Optional reference to the submeshes's material. Provide if you have an exiting reference to improve performance.
  17865. */
  17866. dispatch(subMesh: SubMesh, mesh?: AbstractMesh, material?: Nullable<Material>): void;
  17867. /**
  17868. * Overrides the default sort function applied in the renderging group to prepare the meshes.
  17869. * This allowed control for front to back rendering or reversly depending of the special needs.
  17870. *
  17871. * @param renderingGroupId The rendering group id corresponding to its index
  17872. * @param opaqueSortCompareFn The opaque queue comparison function use to sort.
  17873. * @param alphaTestSortCompareFn The alpha test queue comparison function use to sort.
  17874. * @param transparentSortCompareFn The transparent queue comparison function use to sort.
  17875. */
  17876. setRenderingOrder(renderingGroupId: number, opaqueSortCompareFn?: Nullable<(a: SubMesh, b: SubMesh) => number>, alphaTestSortCompareFn?: Nullable<(a: SubMesh, b: SubMesh) => number>, transparentSortCompareFn?: Nullable<(a: SubMesh, b: SubMesh) => number>): void;
  17877. /**
  17878. * Specifies whether or not the stencil and depth buffer are cleared between two rendering groups.
  17879. *
  17880. * @param renderingGroupId The rendering group id corresponding to its index
  17881. * @param autoClearDepthStencil Automatically clears depth and stencil between groups if true.
  17882. * @param depth Automatically clears depth between groups if true and autoClear is true.
  17883. * @param stencil Automatically clears stencil between groups if true and autoClear is true.
  17884. */
  17885. setRenderingAutoClearDepthStencil(renderingGroupId: number, autoClearDepthStencil: boolean, depth?: boolean, stencil?: boolean): void;
  17886. /**
  17887. * Gets the current auto clear configuration for one rendering group of the rendering
  17888. * manager.
  17889. * @param index the rendering group index to get the information for
  17890. * @returns The auto clear setup for the requested rendering group
  17891. */
  17892. getAutoClearDepthStencilSetup(index: number): IRenderingManagerAutoClearSetup;
  17893. }
  17894. }
  17895. declare module "babylonjs/Lights/Shadows/shadowGenerator" {
  17896. import { SmartArray } from "babylonjs/Misc/smartArray";
  17897. import { Nullable } from "babylonjs/types";
  17898. import { Scene } from "babylonjs/scene";
  17899. import { Matrix, Vector3 } from "babylonjs/Maths/math.vector";
  17900. import { SubMesh } from "babylonjs/Meshes/subMesh";
  17901. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  17902. import { Mesh } from "babylonjs/Meshes/mesh";
  17903. import { IShadowLight } from "babylonjs/Lights/shadowLight";
  17904. import { MaterialDefines } from "babylonjs/Materials/materialDefines";
  17905. import { Effect } from "babylonjs/Materials/effect";
  17906. import { RenderTargetTexture } from "babylonjs/Materials/Textures/renderTargetTexture";
  17907. import { PostProcess } from "babylonjs/PostProcesses/postProcess";
  17908. import "babylonjs/Shaders/shadowMap.fragment";
  17909. import "babylonjs/Shaders/shadowMap.vertex";
  17910. import "babylonjs/Shaders/depthBoxBlur.fragment";
  17911. import "babylonjs/Shaders/ShadersInclude/shadowMapFragmentSoftTransparentShadow";
  17912. import { Observable } from "babylonjs/Misc/observable";
  17913. /**
  17914. * Defines the options associated with the creation of a custom shader for a shadow generator.
  17915. */
  17916. export interface ICustomShaderOptions {
  17917. /**
  17918. * Gets or sets the custom shader name to use
  17919. */
  17920. shaderName: string;
  17921. /**
  17922. * The list of attribute names used in the shader
  17923. */
  17924. attributes?: string[];
  17925. /**
  17926. * The list of unifrom names used in the shader
  17927. */
  17928. uniforms?: string[];
  17929. /**
  17930. * The list of sampler names used in the shader
  17931. */
  17932. samplers?: string[];
  17933. /**
  17934. * The list of defines used in the shader
  17935. */
  17936. defines?: string[];
  17937. }
  17938. /**
  17939. * Interface to implement to create a shadow generator compatible with BJS.
  17940. */
  17941. export interface IShadowGenerator {
  17942. /** Gets or set the id of the shadow generator. It will be the one from the light if not defined */
  17943. id: string;
  17944. /**
  17945. * Gets the main RTT containing the shadow map (usually storing depth from the light point of view).
  17946. * @returns The render target texture if present otherwise, null
  17947. */
  17948. getShadowMap(): Nullable<RenderTargetTexture>;
  17949. /**
  17950. * Determine wheter the shadow generator is ready or not (mainly all effects and related post processes needs to be ready).
  17951. * @param subMesh The submesh we want to render in the shadow map
  17952. * @param useInstances Defines wether will draw in the map using instances
  17953. * @param isTransparent Indicates that isReady is called for a transparent subMesh
  17954. * @returns true if ready otherwise, false
  17955. */
  17956. isReady(subMesh: SubMesh, useInstances: boolean, isTransparent: boolean): boolean;
  17957. /**
  17958. * Prepare all the defines in a material relying on a shadow map at the specified light index.
  17959. * @param defines Defines of the material we want to update
  17960. * @param lightIndex Index of the light in the enabled light list of the material
  17961. */
  17962. prepareDefines(defines: MaterialDefines, lightIndex: number): void;
  17963. /**
  17964. * Binds the shadow related information inside of an effect (information like near, far, darkness...
  17965. * defined in the generator but impacting the effect).
  17966. * It implies the unifroms available on the materials are the standard BJS ones.
  17967. * @param lightIndex Index of the light in the enabled light list of the material owning the effect
  17968. * @param effect The effect we are binfing the information for
  17969. */
  17970. bindShadowLight(lightIndex: string, effect: Effect): void;
  17971. /**
  17972. * Gets the transformation matrix used to project the meshes into the map from the light point of view.
  17973. * (eq to shadow prjection matrix * light transform matrix)
  17974. * @returns The transform matrix used to create the shadow map
  17975. */
  17976. getTransformMatrix(): Matrix;
  17977. /**
  17978. * Recreates the shadow map dependencies like RTT and post processes. This can be used during the switch between
  17979. * Cube and 2D textures for instance.
  17980. */
  17981. recreateShadowMap(): void;
  17982. /**
  17983. * Forces all the attached effect to compile to enable rendering only once ready vs. lazyly compiling effects.
  17984. * @param onCompiled Callback triggered at the and of the effects compilation
  17985. * @param options Sets of optional options forcing the compilation with different modes
  17986. */
  17987. forceCompilation(onCompiled?: (generator: IShadowGenerator) => void, options?: Partial<{
  17988. useInstances: boolean;
  17989. }>): void;
  17990. /**
  17991. * Forces all the attached effect to compile to enable rendering only once ready vs. lazyly compiling effects.
  17992. * @param options Sets of optional options forcing the compilation with different modes
  17993. * @returns A promise that resolves when the compilation completes
  17994. */
  17995. forceCompilationAsync(options?: Partial<{
  17996. useInstances: boolean;
  17997. }>): Promise<void>;
  17998. /**
  17999. * Serializes the shadow generator setup to a json object.
  18000. * @returns The serialized JSON object
  18001. */
  18002. serialize(): any;
  18003. /**
  18004. * Disposes the Shadow map and related Textures and effects.
  18005. */
  18006. dispose(): void;
  18007. }
  18008. /**
  18009. * Default implementation IShadowGenerator.
  18010. * This is the main object responsible of generating shadows in the framework.
  18011. * Documentation: https://doc.babylonjs.com/babylon101/shadows
  18012. */
  18013. export class ShadowGenerator implements IShadowGenerator {
  18014. /**
  18015. * Name of the shadow generator class
  18016. */
  18017. static CLASSNAME: string;
  18018. /**
  18019. * Shadow generator mode None: no filtering applied.
  18020. */
  18021. static readonly FILTER_NONE: number;
  18022. /**
  18023. * Shadow generator mode ESM: Exponential Shadow Mapping.
  18024. * (http://developer.download.nvidia.com/presentations/2008/GDC/GDC08_SoftShadowMapping.pdf)
  18025. */
  18026. static readonly FILTER_EXPONENTIALSHADOWMAP: number;
  18027. /**
  18028. * Shadow generator mode Poisson Sampling: Percentage Closer Filtering.
  18029. * (Multiple Tap around evenly distributed around the pixel are used to evaluate the shadow strength)
  18030. */
  18031. static readonly FILTER_POISSONSAMPLING: number;
  18032. /**
  18033. * Shadow generator mode ESM: Blurred Exponential Shadow Mapping.
  18034. * (http://developer.download.nvidia.com/presentations/2008/GDC/GDC08_SoftShadowMapping.pdf)
  18035. */
  18036. static readonly FILTER_BLUREXPONENTIALSHADOWMAP: number;
  18037. /**
  18038. * Shadow generator mode ESM: Exponential Shadow Mapping using the inverse of the exponential preventing
  18039. * edge artifacts on steep falloff.
  18040. * (http://developer.download.nvidia.com/presentations/2008/GDC/GDC08_SoftShadowMapping.pdf)
  18041. */
  18042. static readonly FILTER_CLOSEEXPONENTIALSHADOWMAP: number;
  18043. /**
  18044. * Shadow generator mode ESM: Blurred Exponential Shadow Mapping using the inverse of the exponential preventing
  18045. * edge artifacts on steep falloff.
  18046. * (http://developer.download.nvidia.com/presentations/2008/GDC/GDC08_SoftShadowMapping.pdf)
  18047. */
  18048. static readonly FILTER_BLURCLOSEEXPONENTIALSHADOWMAP: number;
  18049. /**
  18050. * Shadow generator mode PCF: Percentage Closer Filtering
  18051. * benefits from Webgl 2 shadow samplers. Fallback to Poisson Sampling in Webgl 1
  18052. * (https://developer.nvidia.com/gpugems/GPUGems/gpugems_ch11.html)
  18053. */
  18054. static readonly FILTER_PCF: number;
  18055. /**
  18056. * Shadow generator mode PCSS: Percentage Closering Soft Shadow.
  18057. * benefits from Webgl 2 shadow samplers. Fallback to Poisson Sampling in Webgl 1
  18058. * Contact Hardening
  18059. */
  18060. static readonly FILTER_PCSS: number;
  18061. /**
  18062. * Reserved for PCF and PCSS
  18063. * Highest Quality.
  18064. *
  18065. * Execute PCF on a 5*5 kernel improving a lot the shadow aliasing artifacts.
  18066. *
  18067. * Execute PCSS with 32 taps blocker search and 64 taps PCF.
  18068. */
  18069. static readonly QUALITY_HIGH: number;
  18070. /**
  18071. * Reserved for PCF and PCSS
  18072. * Good tradeoff for quality/perf cross devices
  18073. *
  18074. * Execute PCF on a 3*3 kernel.
  18075. *
  18076. * Execute PCSS with 16 taps blocker search and 32 taps PCF.
  18077. */
  18078. static readonly QUALITY_MEDIUM: number;
  18079. /**
  18080. * Reserved for PCF and PCSS
  18081. * The lowest quality but the fastest.
  18082. *
  18083. * Execute PCF on a 1*1 kernel.
  18084. *
  18085. * Execute PCSS with 16 taps blocker search and 16 taps PCF.
  18086. */
  18087. static readonly QUALITY_LOW: number;
  18088. /** Gets or set the id of the shadow generator. It will be the one from the light if not defined */
  18089. id: string;
  18090. /** Gets or sets the custom shader name to use */
  18091. customShaderOptions: ICustomShaderOptions;
  18092. /**
  18093. * Observable triggered before the shadow is rendered. Can be used to update internal effect state
  18094. */
  18095. onBeforeShadowMapRenderObservable: Observable<Effect>;
  18096. /**
  18097. * Observable triggered after the shadow is rendered. Can be used to restore internal effect state
  18098. */
  18099. onAfterShadowMapRenderObservable: Observable<Effect>;
  18100. /**
  18101. * Observable triggered before a mesh is rendered in the shadow map.
  18102. * Can be used to update internal effect state (that you can get from the onBeforeShadowMapRenderObservable)
  18103. */
  18104. onBeforeShadowMapRenderMeshObservable: Observable<Mesh>;
  18105. /**
  18106. * Observable triggered after a mesh is rendered in the shadow map.
  18107. * Can be used to update internal effect state (that you can get from the onAfterShadowMapRenderObservable)
  18108. */
  18109. onAfterShadowMapRenderMeshObservable: Observable<Mesh>;
  18110. protected _bias: number;
  18111. /**
  18112. * Gets the bias: offset applied on the depth preventing acnea (in light direction).
  18113. */
  18114. get bias(): number;
  18115. /**
  18116. * Sets the bias: offset applied on the depth preventing acnea (in light direction).
  18117. */
  18118. set bias(bias: number);
  18119. protected _normalBias: number;
  18120. /**
  18121. * Gets the normalBias: offset applied on the depth preventing acnea (along side the normal direction and proportinal to the light/normal angle).
  18122. */
  18123. get normalBias(): number;
  18124. /**
  18125. * Sets the normalBias: offset applied on the depth preventing acnea (along side the normal direction and proportinal to the light/normal angle).
  18126. */
  18127. set normalBias(normalBias: number);
  18128. protected _blurBoxOffset: number;
  18129. /**
  18130. * Gets the blur box offset: offset applied during the blur pass.
  18131. * Only useful if useKernelBlur = false
  18132. */
  18133. get blurBoxOffset(): number;
  18134. /**
  18135. * Sets the blur box offset: offset applied during the blur pass.
  18136. * Only useful if useKernelBlur = false
  18137. */
  18138. set blurBoxOffset(value: number);
  18139. protected _blurScale: number;
  18140. /**
  18141. * Gets the blur scale: scale of the blurred texture compared to the main shadow map.
  18142. * 2 means half of the size.
  18143. */
  18144. get blurScale(): number;
  18145. /**
  18146. * Sets the blur scale: scale of the blurred texture compared to the main shadow map.
  18147. * 2 means half of the size.
  18148. */
  18149. set blurScale(value: number);
  18150. protected _blurKernel: number;
  18151. /**
  18152. * Gets the blur kernel: kernel size of the blur pass.
  18153. * Only useful if useKernelBlur = true
  18154. */
  18155. get blurKernel(): number;
  18156. /**
  18157. * Sets the blur kernel: kernel size of the blur pass.
  18158. * Only useful if useKernelBlur = true
  18159. */
  18160. set blurKernel(value: number);
  18161. protected _useKernelBlur: boolean;
  18162. /**
  18163. * Gets whether the blur pass is a kernel blur (if true) or box blur.
  18164. * Only useful in filtered mode (useBlurExponentialShadowMap...)
  18165. */
  18166. get useKernelBlur(): boolean;
  18167. /**
  18168. * Sets whether the blur pass is a kernel blur (if true) or box blur.
  18169. * Only useful in filtered mode (useBlurExponentialShadowMap...)
  18170. */
  18171. set useKernelBlur(value: boolean);
  18172. protected _depthScale: number;
  18173. /**
  18174. * Gets the depth scale used in ESM mode.
  18175. */
  18176. get depthScale(): number;
  18177. /**
  18178. * Sets the depth scale used in ESM mode.
  18179. * This can override the scale stored on the light.
  18180. */
  18181. set depthScale(value: number);
  18182. protected _validateFilter(filter: number): number;
  18183. protected _filter: number;
  18184. /**
  18185. * Gets the current mode of the shadow generator (normal, PCF, ESM...).
  18186. * The returned value is a number equal to one of the available mode defined in ShadowMap.FILTER_x like _FILTER_NONE
  18187. */
  18188. get filter(): number;
  18189. /**
  18190. * Sets the current mode of the shadow generator (normal, PCF, ESM...).
  18191. * The returned value is a number equal to one of the available mode defined in ShadowMap.FILTER_x like _FILTER_NONE
  18192. */
  18193. set filter(value: number);
  18194. /**
  18195. * Gets if the current filter is set to Poisson Sampling.
  18196. */
  18197. get usePoissonSampling(): boolean;
  18198. /**
  18199. * Sets the current filter to Poisson Sampling.
  18200. */
  18201. set usePoissonSampling(value: boolean);
  18202. /**
  18203. * Gets if the current filter is set to ESM.
  18204. */
  18205. get useExponentialShadowMap(): boolean;
  18206. /**
  18207. * Sets the current filter is to ESM.
  18208. */
  18209. set useExponentialShadowMap(value: boolean);
  18210. /**
  18211. * Gets if the current filter is set to filtered ESM.
  18212. */
  18213. get useBlurExponentialShadowMap(): boolean;
  18214. /**
  18215. * Gets if the current filter is set to filtered ESM.
  18216. */
  18217. set useBlurExponentialShadowMap(value: boolean);
  18218. /**
  18219. * Gets if the current filter is set to "close ESM" (using the inverse of the
  18220. * exponential to prevent steep falloff artifacts).
  18221. */
  18222. get useCloseExponentialShadowMap(): boolean;
  18223. /**
  18224. * Sets the current filter to "close ESM" (using the inverse of the
  18225. * exponential to prevent steep falloff artifacts).
  18226. */
  18227. set useCloseExponentialShadowMap(value: boolean);
  18228. /**
  18229. * Gets if the current filter is set to filtered "close ESM" (using the inverse of the
  18230. * exponential to prevent steep falloff artifacts).
  18231. */
  18232. get useBlurCloseExponentialShadowMap(): boolean;
  18233. /**
  18234. * Sets the current filter to filtered "close ESM" (using the inverse of the
  18235. * exponential to prevent steep falloff artifacts).
  18236. */
  18237. set useBlurCloseExponentialShadowMap(value: boolean);
  18238. /**
  18239. * Gets if the current filter is set to "PCF" (percentage closer filtering).
  18240. */
  18241. get usePercentageCloserFiltering(): boolean;
  18242. /**
  18243. * Sets the current filter to "PCF" (percentage closer filtering).
  18244. */
  18245. set usePercentageCloserFiltering(value: boolean);
  18246. protected _filteringQuality: number;
  18247. /**
  18248. * Gets the PCF or PCSS Quality.
  18249. * Only valid if usePercentageCloserFiltering or usePercentageCloserFiltering is true.
  18250. */
  18251. get filteringQuality(): number;
  18252. /**
  18253. * Sets the PCF or PCSS Quality.
  18254. * Only valid if usePercentageCloserFiltering or usePercentageCloserFiltering is true.
  18255. */
  18256. set filteringQuality(filteringQuality: number);
  18257. /**
  18258. * Gets if the current filter is set to "PCSS" (contact hardening).
  18259. */
  18260. get useContactHardeningShadow(): boolean;
  18261. /**
  18262. * Sets the current filter to "PCSS" (contact hardening).
  18263. */
  18264. set useContactHardeningShadow(value: boolean);
  18265. protected _contactHardeningLightSizeUVRatio: number;
  18266. /**
  18267. * Gets the Light Size (in shadow map uv unit) used in PCSS to determine the blocker search area and the penumbra size.
  18268. * Using a ratio helps keeping shape stability independently of the map size.
  18269. *
  18270. * It does not account for the light projection as it was having too much
  18271. * instability during the light setup or during light position changes.
  18272. *
  18273. * Only valid if useContactHardeningShadow is true.
  18274. */
  18275. get contactHardeningLightSizeUVRatio(): number;
  18276. /**
  18277. * Sets the Light Size (in shadow map uv unit) used in PCSS to determine the blocker search area and the penumbra size.
  18278. * Using a ratio helps keeping shape stability independently of the map size.
  18279. *
  18280. * It does not account for the light projection as it was having too much
  18281. * instability during the light setup or during light position changes.
  18282. *
  18283. * Only valid if useContactHardeningShadow is true.
  18284. */
  18285. set contactHardeningLightSizeUVRatio(contactHardeningLightSizeUVRatio: number);
  18286. protected _darkness: number;
  18287. /** Gets or sets the actual darkness of a shadow */
  18288. get darkness(): number;
  18289. set darkness(value: number);
  18290. /**
  18291. * Returns the darkness value (float). This can only decrease the actual darkness of a shadow.
  18292. * 0 means strongest and 1 would means no shadow.
  18293. * @returns the darkness.
  18294. */
  18295. getDarkness(): number;
  18296. /**
  18297. * Sets the darkness value (float). This can only decrease the actual darkness of a shadow.
  18298. * @param darkness The darkness value 0 means strongest and 1 would means no shadow.
  18299. * @returns the shadow generator allowing fluent coding.
  18300. */
  18301. setDarkness(darkness: number): ShadowGenerator;
  18302. protected _transparencyShadow: boolean;
  18303. /** Gets or sets the ability to have transparent shadow */
  18304. get transparencyShadow(): boolean;
  18305. set transparencyShadow(value: boolean);
  18306. /**
  18307. * Sets the ability to have transparent shadow (boolean).
  18308. * @param transparent True if transparent else False
  18309. * @returns the shadow generator allowing fluent coding
  18310. */
  18311. setTransparencyShadow(transparent: boolean): ShadowGenerator;
  18312. /**
  18313. * Enables or disables shadows with varying strength based on the transparency
  18314. * When it is enabled, the strength of the shadow is taken equal to mesh.visibility
  18315. * If you enabled an alpha texture on your material, the alpha value red from the texture is also combined to compute the strength:
  18316. * mesh.visibility * alphaTexture.a
  18317. * Note that by definition transparencyShadow must be set to true for enableSoftTransparentShadow to work!
  18318. */
  18319. enableSoftTransparentShadow: boolean;
  18320. protected _shadowMap: Nullable<RenderTargetTexture>;
  18321. protected _shadowMap2: Nullable<RenderTargetTexture>;
  18322. /**
  18323. * Gets the main RTT containing the shadow map (usually storing depth from the light point of view).
  18324. * @returns The render target texture if present otherwise, null
  18325. */
  18326. getShadowMap(): Nullable<RenderTargetTexture>;
  18327. /**
  18328. * Gets the RTT used during rendering (can be a blurred version of the shadow map or the shadow map itself).
  18329. * @returns The render target texture if the shadow map is present otherwise, null
  18330. */
  18331. getShadowMapForRendering(): Nullable<RenderTargetTexture>;
  18332. /**
  18333. * Gets the class name of that object
  18334. * @returns "ShadowGenerator"
  18335. */
  18336. getClassName(): string;
  18337. /**
  18338. * Helper function to add a mesh and its descendants to the list of shadow casters.
  18339. * @param mesh Mesh to add
  18340. * @param includeDescendants boolean indicating if the descendants should be added. Default to true
  18341. * @returns the Shadow Generator itself
  18342. */
  18343. addShadowCaster(mesh: AbstractMesh, includeDescendants?: boolean): ShadowGenerator;
  18344. /**
  18345. * Helper function to remove a mesh and its descendants from the list of shadow casters
  18346. * @param mesh Mesh to remove
  18347. * @param includeDescendants boolean indicating if the descendants should be removed. Default to true
  18348. * @returns the Shadow Generator itself
  18349. */
  18350. removeShadowCaster(mesh: AbstractMesh, includeDescendants?: boolean): ShadowGenerator;
  18351. /**
  18352. * Controls the extent to which the shadows fade out at the edge of the frustum
  18353. */
  18354. frustumEdgeFalloff: number;
  18355. protected _light: IShadowLight;
  18356. /**
  18357. * Returns the associated light object.
  18358. * @returns the light generating the shadow
  18359. */
  18360. getLight(): IShadowLight;
  18361. /**
  18362. * If true the shadow map is generated by rendering the back face of the mesh instead of the front face.
  18363. * This can help with self-shadowing as the geometry making up the back of objects is slightly offset.
  18364. * It might on the other hand introduce peter panning.
  18365. */
  18366. forceBackFacesOnly: boolean;
  18367. protected _scene: Scene;
  18368. protected _lightDirection: Vector3;
  18369. protected _effect: Effect;
  18370. protected _viewMatrix: Matrix;
  18371. protected _projectionMatrix: Matrix;
  18372. protected _transformMatrix: Matrix;
  18373. protected _cachedPosition: Vector3;
  18374. protected _cachedDirection: Vector3;
  18375. protected _cachedDefines: string;
  18376. protected _currentRenderID: number;
  18377. protected _boxBlurPostprocess: Nullable<PostProcess>;
  18378. protected _kernelBlurXPostprocess: Nullable<PostProcess>;
  18379. protected _kernelBlurYPostprocess: Nullable<PostProcess>;
  18380. protected _blurPostProcesses: PostProcess[];
  18381. protected _mapSize: number;
  18382. protected _currentFaceIndex: number;
  18383. protected _currentFaceIndexCache: number;
  18384. protected _textureType: number;
  18385. protected _defaultTextureMatrix: Matrix;
  18386. protected _storedUniqueId: Nullable<number>;
  18387. /** @hidden */
  18388. static _SceneComponentInitialization: (scene: Scene) => void;
  18389. /**
  18390. * Creates a ShadowGenerator object.
  18391. * A ShadowGenerator is the required tool to use the shadows.
  18392. * Each light casting shadows needs to use its own ShadowGenerator.
  18393. * Documentation : https://doc.babylonjs.com/babylon101/shadows
  18394. * @param mapSize The size of the texture what stores the shadows. Example : 1024.
  18395. * @param light The light object generating the shadows.
  18396. * @param usefulFloatFirst By default the generator will try to use half float textures but if you need precision (for self shadowing for instance), you can use this option to enforce full float texture.
  18397. */
  18398. constructor(mapSize: number, light: IShadowLight, usefulFloatFirst?: boolean);
  18399. protected _initializeGenerator(): void;
  18400. protected _createTargetRenderTexture(): void;
  18401. protected _initializeShadowMap(): void;
  18402. protected _initializeBlurRTTAndPostProcesses(): void;
  18403. protected _renderForShadowMap(opaqueSubMeshes: SmartArray<SubMesh>, alphaTestSubMeshes: SmartArray<SubMesh>, transparentSubMeshes: SmartArray<SubMesh>, depthOnlySubMeshes: SmartArray<SubMesh>): void;
  18404. protected _bindCustomEffectForRenderSubMeshForShadowMap(subMesh: SubMesh, effect: Effect, matriceNames: any, mesh: AbstractMesh): void;
  18405. protected _renderSubMeshForShadowMap(subMesh: SubMesh, isTransparent?: boolean): void;
  18406. protected _applyFilterValues(): void;
  18407. /**
  18408. * Forces all the attached effect to compile to enable rendering only once ready vs. lazyly compiling effects.
  18409. * @param onCompiled Callback triggered at the and of the effects compilation
  18410. * @param options Sets of optional options forcing the compilation with different modes
  18411. */
  18412. forceCompilation(onCompiled?: (generator: IShadowGenerator) => void, options?: Partial<{
  18413. useInstances: boolean;
  18414. }>): void;
  18415. /**
  18416. * Forces all the attached effect to compile to enable rendering only once ready vs. lazyly compiling effects.
  18417. * @param options Sets of optional options forcing the compilation with different modes
  18418. * @returns A promise that resolves when the compilation completes
  18419. */
  18420. forceCompilationAsync(options?: Partial<{
  18421. useInstances: boolean;
  18422. }>): Promise<void>;
  18423. protected _isReadyCustomDefines(defines: any, subMesh: SubMesh, useInstances: boolean): void;
  18424. private _prepareShadowDefines;
  18425. /**
  18426. * Determine wheter the shadow generator is ready or not (mainly all effects and related post processes needs to be ready).
  18427. * @param subMesh The submesh we want to render in the shadow map
  18428. * @param useInstances Defines wether will draw in the map using instances
  18429. * @param isTransparent Indicates that isReady is called for a transparent subMesh
  18430. * @returns true if ready otherwise, false
  18431. */
  18432. isReady(subMesh: SubMesh, useInstances: boolean, isTransparent: boolean): boolean;
  18433. /**
  18434. * Prepare all the defines in a material relying on a shadow map at the specified light index.
  18435. * @param defines Defines of the material we want to update
  18436. * @param lightIndex Index of the light in the enabled light list of the material
  18437. */
  18438. prepareDefines(defines: any, lightIndex: number): void;
  18439. /**
  18440. * Binds the shadow related information inside of an effect (information like near, far, darkness...
  18441. * defined in the generator but impacting the effect).
  18442. * @param lightIndex Index of the light in the enabled light list of the material owning the effect
  18443. * @param effect The effect we are binfing the information for
  18444. */
  18445. bindShadowLight(lightIndex: string, effect: Effect): void;
  18446. /**
  18447. * Gets the transformation matrix used to project the meshes into the map from the light point of view.
  18448. * (eq to shadow prjection matrix * light transform matrix)
  18449. * @returns The transform matrix used to create the shadow map
  18450. */
  18451. getTransformMatrix(): Matrix;
  18452. /**
  18453. * Recreates the shadow map dependencies like RTT and post processes. This can be used during the switch between
  18454. * Cube and 2D textures for instance.
  18455. */
  18456. recreateShadowMap(): void;
  18457. protected _disposeBlurPostProcesses(): void;
  18458. protected _disposeRTTandPostProcesses(): void;
  18459. /**
  18460. * Disposes the ShadowGenerator.
  18461. * Returns nothing.
  18462. */
  18463. dispose(): void;
  18464. /**
  18465. * Serializes the shadow generator setup to a json object.
  18466. * @returns The serialized JSON object
  18467. */
  18468. serialize(): any;
  18469. /**
  18470. * Parses a serialized ShadowGenerator and returns a new ShadowGenerator.
  18471. * @param parsedShadowGenerator The JSON object to parse
  18472. * @param scene The scene to create the shadow map for
  18473. * @param constr A function that builds a shadow generator or undefined to create an instance of the default shadow generator
  18474. * @returns The parsed shadow generator
  18475. */
  18476. static Parse(parsedShadowGenerator: any, scene: Scene, constr?: (mapSize: number, light: IShadowLight) => ShadowGenerator): ShadowGenerator;
  18477. }
  18478. }
  18479. declare module "babylonjs/Lights/light" {
  18480. import { Nullable } from "babylonjs/types";
  18481. import { Scene } from "babylonjs/scene";
  18482. import { Vector3 } from "babylonjs/Maths/math.vector";
  18483. import { Color3 } from "babylonjs/Maths/math.color";
  18484. import { Node } from "babylonjs/node";
  18485. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  18486. import { Effect } from "babylonjs/Materials/effect";
  18487. import { UniformBuffer } from "babylonjs/Materials/uniformBuffer";
  18488. import { IShadowGenerator } from "babylonjs/Lights/Shadows/shadowGenerator";
  18489. /**
  18490. * Base class of all the lights in Babylon. It groups all the generic information about lights.
  18491. * Lights are used, as you would expect, to affect how meshes are seen, in terms of both illumination and colour.
  18492. * All meshes allow light to pass through them unless shadow generation is activated. The default number of lights allowed is four but this can be increased.
  18493. */
  18494. export abstract class Light extends Node {
  18495. /**
  18496. * Falloff Default: light is falling off following the material specification:
  18497. * standard material is using standard falloff whereas pbr material can request special falloff per materials.
  18498. */
  18499. static readonly FALLOFF_DEFAULT: number;
  18500. /**
  18501. * Falloff Physical: light is falling off following the inverse squared distance law.
  18502. */
  18503. static readonly FALLOFF_PHYSICAL: number;
  18504. /**
  18505. * Falloff gltf: light is falling off as described in the gltf moving to PBR document
  18506. * to enhance interoperability with other engines.
  18507. */
  18508. static readonly FALLOFF_GLTF: number;
  18509. /**
  18510. * Falloff Standard: light is falling off like in the standard material
  18511. * to enhance interoperability with other materials.
  18512. */
  18513. static readonly FALLOFF_STANDARD: number;
  18514. /**
  18515. * If every light affecting the material is in this lightmapMode,
  18516. * material.lightmapTexture adds or multiplies
  18517. * (depends on material.useLightmapAsShadowmap)
  18518. * after every other light calculations.
  18519. */
  18520. static readonly LIGHTMAP_DEFAULT: number;
  18521. /**
  18522. * material.lightmapTexture as only diffuse lighting from this light
  18523. * adds only specular lighting from this light
  18524. * adds dynamic shadows
  18525. */
  18526. static readonly LIGHTMAP_SPECULAR: number;
  18527. /**
  18528. * material.lightmapTexture as only lighting
  18529. * no light calculation from this light
  18530. * only adds dynamic shadows from this light
  18531. */
  18532. static readonly LIGHTMAP_SHADOWSONLY: number;
  18533. /**
  18534. * Each light type uses the default quantity according to its type:
  18535. * point/spot lights use luminous intensity
  18536. * directional lights use illuminance
  18537. */
  18538. static readonly INTENSITYMODE_AUTOMATIC: number;
  18539. /**
  18540. * lumen (lm)
  18541. */
  18542. static readonly INTENSITYMODE_LUMINOUSPOWER: number;
  18543. /**
  18544. * candela (lm/sr)
  18545. */
  18546. static readonly INTENSITYMODE_LUMINOUSINTENSITY: number;
  18547. /**
  18548. * lux (lm/m^2)
  18549. */
  18550. static readonly INTENSITYMODE_ILLUMINANCE: number;
  18551. /**
  18552. * nit (cd/m^2)
  18553. */
  18554. static readonly INTENSITYMODE_LUMINANCE: number;
  18555. /**
  18556. * Light type const id of the point light.
  18557. */
  18558. static readonly LIGHTTYPEID_POINTLIGHT: number;
  18559. /**
  18560. * Light type const id of the directional light.
  18561. */
  18562. static readonly LIGHTTYPEID_DIRECTIONALLIGHT: number;
  18563. /**
  18564. * Light type const id of the spot light.
  18565. */
  18566. static readonly LIGHTTYPEID_SPOTLIGHT: number;
  18567. /**
  18568. * Light type const id of the hemispheric light.
  18569. */
  18570. static readonly LIGHTTYPEID_HEMISPHERICLIGHT: number;
  18571. /**
  18572. * Diffuse gives the basic color to an object.
  18573. */
  18574. diffuse: Color3;
  18575. /**
  18576. * Specular produces a highlight color on an object.
  18577. * Note: This is note affecting PBR materials.
  18578. */
  18579. specular: Color3;
  18580. /**
  18581. * Defines the falloff type for this light. This lets overrriding how punctual light are
  18582. * falling off base on range or angle.
  18583. * This can be set to any values in Light.FALLOFF_x.
  18584. *
  18585. * Note: This is only useful for PBR Materials at the moment. This could be extended if required to
  18586. * other types of materials.
  18587. */
  18588. falloffType: number;
  18589. /**
  18590. * Strength of the light.
  18591. * Note: By default it is define in the framework own unit.
  18592. * Note: In PBR materials the intensityMode can be use to chose what unit the intensity is defined in.
  18593. */
  18594. intensity: number;
  18595. private _range;
  18596. protected _inverseSquaredRange: number;
  18597. /**
  18598. * Defines how far from the source the light is impacting in scene units.
  18599. * Note: Unused in PBR material as the distance light falloff is defined following the inverse squared falloff.
  18600. */
  18601. get range(): number;
  18602. /**
  18603. * Defines how far from the source the light is impacting in scene units.
  18604. * Note: Unused in PBR material as the distance light falloff is defined following the inverse squared falloff.
  18605. */
  18606. set range(value: number);
  18607. /**
  18608. * Cached photometric scale default to 1.0 as the automatic intensity mode defaults to 1.0 for every type
  18609. * of light.
  18610. */
  18611. private _photometricScale;
  18612. private _intensityMode;
  18613. /**
  18614. * Gets the photometric scale used to interpret the intensity.
  18615. * This is only relevant with PBR Materials where the light intensity can be defined in a physical way.
  18616. */
  18617. get intensityMode(): number;
  18618. /**
  18619. * Sets the photometric scale used to interpret the intensity.
  18620. * This is only relevant with PBR Materials where the light intensity can be defined in a physical way.
  18621. */
  18622. set intensityMode(value: number);
  18623. private _radius;
  18624. /**
  18625. * Gets the light radius used by PBR Materials to simulate soft area lights.
  18626. */
  18627. get radius(): number;
  18628. /**
  18629. * sets the light radius used by PBR Materials to simulate soft area lights.
  18630. */
  18631. set radius(value: number);
  18632. private _renderPriority;
  18633. /**
  18634. * Defines the rendering priority of the lights. It can help in case of fallback or number of lights
  18635. * exceeding the number allowed of the materials.
  18636. */
  18637. renderPriority: number;
  18638. private _shadowEnabled;
  18639. /**
  18640. * Gets wether or not the shadows are enabled for this light. This can help turning off/on shadow without detaching
  18641. * the current shadow generator.
  18642. */
  18643. get shadowEnabled(): boolean;
  18644. /**
  18645. * Sets wether or not the shadows are enabled for this light. This can help turning off/on shadow without detaching
  18646. * the current shadow generator.
  18647. */
  18648. set shadowEnabled(value: boolean);
  18649. private _includedOnlyMeshes;
  18650. /**
  18651. * Gets the only meshes impacted by this light.
  18652. */
  18653. get includedOnlyMeshes(): AbstractMesh[];
  18654. /**
  18655. * Sets the only meshes impacted by this light.
  18656. */
  18657. set includedOnlyMeshes(value: AbstractMesh[]);
  18658. private _excludedMeshes;
  18659. /**
  18660. * Gets the meshes not impacted by this light.
  18661. */
  18662. get excludedMeshes(): AbstractMesh[];
  18663. /**
  18664. * Sets the meshes not impacted by this light.
  18665. */
  18666. set excludedMeshes(value: AbstractMesh[]);
  18667. private _excludeWithLayerMask;
  18668. /**
  18669. * Gets the layer id use to find what meshes are not impacted by the light.
  18670. * Inactive if 0
  18671. */
  18672. get excludeWithLayerMask(): number;
  18673. /**
  18674. * Sets the layer id use to find what meshes are not impacted by the light.
  18675. * Inactive if 0
  18676. */
  18677. set excludeWithLayerMask(value: number);
  18678. private _includeOnlyWithLayerMask;
  18679. /**
  18680. * Gets the layer id use to find what meshes are impacted by the light.
  18681. * Inactive if 0
  18682. */
  18683. get includeOnlyWithLayerMask(): number;
  18684. /**
  18685. * Sets the layer id use to find what meshes are impacted by the light.
  18686. * Inactive if 0
  18687. */
  18688. set includeOnlyWithLayerMask(value: number);
  18689. private _lightmapMode;
  18690. /**
  18691. * Gets the lightmap mode of this light (should be one of the constants defined by Light.LIGHTMAP_x)
  18692. */
  18693. get lightmapMode(): number;
  18694. /**
  18695. * Sets the lightmap mode of this light (should be one of the constants defined by Light.LIGHTMAP_x)
  18696. */
  18697. set lightmapMode(value: number);
  18698. /**
  18699. * Shadow generator associted to the light.
  18700. * @hidden Internal use only.
  18701. */
  18702. _shadowGenerator: Nullable<IShadowGenerator>;
  18703. /**
  18704. * @hidden Internal use only.
  18705. */
  18706. _excludedMeshesIds: string[];
  18707. /**
  18708. * @hidden Internal use only.
  18709. */
  18710. _includedOnlyMeshesIds: string[];
  18711. /**
  18712. * The current light unifom buffer.
  18713. * @hidden Internal use only.
  18714. */
  18715. _uniformBuffer: UniformBuffer;
  18716. /** @hidden */
  18717. _renderId: number;
  18718. /**
  18719. * Creates a Light object in the scene.
  18720. * Documentation : https://doc.babylonjs.com/babylon101/lights
  18721. * @param name The firendly name of the light
  18722. * @param scene The scene the light belongs too
  18723. */
  18724. constructor(name: string, scene: Scene);
  18725. protected abstract _buildUniformLayout(): void;
  18726. /**
  18727. * Sets the passed Effect "effect" with the Light information.
  18728. * @param effect The effect to update
  18729. * @param lightIndex The index of the light in the effect to update
  18730. * @returns The light
  18731. */
  18732. abstract transferToEffect(effect: Effect, lightIndex: string): Light;
  18733. /**
  18734. * Sets the passed Effect "effect" with the Light textures.
  18735. * @param effect The effect to update
  18736. * @param lightIndex The index of the light in the effect to update
  18737. * @returns The light
  18738. */
  18739. transferTexturesToEffect(effect: Effect, lightIndex: string): Light;
  18740. /**
  18741. * Binds the lights information from the scene to the effect for the given mesh.
  18742. * @param lightIndex Light index
  18743. * @param scene The scene where the light belongs to
  18744. * @param effect The effect we are binding the data to
  18745. * @param useSpecular Defines if specular is supported
  18746. * @param rebuildInParallel Specifies whether the shader is rebuilding in parallel
  18747. */
  18748. _bindLight(lightIndex: number, scene: Scene, effect: Effect, useSpecular: boolean, rebuildInParallel?: boolean): void;
  18749. /**
  18750. * Sets the passed Effect "effect" with the Light information.
  18751. * @param effect The effect to update
  18752. * @param lightDataUniformName The uniform used to store light data (position or direction)
  18753. * @returns The light
  18754. */
  18755. abstract transferToNodeMaterialEffect(effect: Effect, lightDataUniformName: string): Light;
  18756. /**
  18757. * Returns the string "Light".
  18758. * @returns the class name
  18759. */
  18760. getClassName(): string;
  18761. /** @hidden */
  18762. readonly _isLight: boolean;
  18763. /**
  18764. * Converts the light information to a readable string for debug purpose.
  18765. * @param fullDetails Supports for multiple levels of logging within scene loading
  18766. * @returns the human readable light info
  18767. */
  18768. toString(fullDetails?: boolean): string;
  18769. /** @hidden */
  18770. protected _syncParentEnabledState(): void;
  18771. /**
  18772. * Set the enabled state of this node.
  18773. * @param value - the new enabled state
  18774. */
  18775. setEnabled(value: boolean): void;
  18776. /**
  18777. * Returns the Light associated shadow generator if any.
  18778. * @return the associated shadow generator.
  18779. */
  18780. getShadowGenerator(): Nullable<IShadowGenerator>;
  18781. /**
  18782. * Returns a Vector3, the absolute light position in the World.
  18783. * @returns the world space position of the light
  18784. */
  18785. getAbsolutePosition(): Vector3;
  18786. /**
  18787. * Specifies if the light will affect the passed mesh.
  18788. * @param mesh The mesh to test against the light
  18789. * @return true the mesh is affected otherwise, false.
  18790. */
  18791. canAffectMesh(mesh: AbstractMesh): boolean;
  18792. /**
  18793. * Sort function to order lights for rendering.
  18794. * @param a First Light object to compare to second.
  18795. * @param b Second Light object to compare first.
  18796. * @return -1 to reduce's a's index relative to be, 0 for no change, 1 to increase a's index relative to b.
  18797. */
  18798. static CompareLightsPriority(a: Light, b: Light): number;
  18799. /**
  18800. * Releases resources associated with this node.
  18801. * @param doNotRecurse Set to true to not recurse into each children (recurse into each children by default)
  18802. * @param disposeMaterialAndTextures Set to true to also dispose referenced materials and textures (false by default)
  18803. */
  18804. dispose(doNotRecurse?: boolean, disposeMaterialAndTextures?: boolean): void;
  18805. /**
  18806. * Returns the light type ID (integer).
  18807. * @returns The light Type id as a constant defines in Light.LIGHTTYPEID_x
  18808. */
  18809. getTypeID(): number;
  18810. /**
  18811. * Returns the intensity scaled by the Photometric Scale according to the light type and intensity mode.
  18812. * @returns the scaled intensity in intensity mode unit
  18813. */
  18814. getScaledIntensity(): number;
  18815. /**
  18816. * Returns a new Light object, named "name", from the current one.
  18817. * @param name The name of the cloned light
  18818. * @param newParent The parent of this light, if it has one
  18819. * @returns the new created light
  18820. */
  18821. clone(name: string, newParent?: Nullable<Node>): Nullable<Light>;
  18822. /**
  18823. * Serializes the current light into a Serialization object.
  18824. * @returns the serialized object.
  18825. */
  18826. serialize(): any;
  18827. /**
  18828. * Creates a new typed light from the passed type (integer) : point light = 0, directional light = 1, spot light = 2, hemispheric light = 3.
  18829. * This new light is named "name" and added to the passed scene.
  18830. * @param type Type according to the types available in Light.LIGHTTYPEID_x
  18831. * @param name The friendly name of the light
  18832. * @param scene The scene the new light will belong to
  18833. * @returns the constructor function
  18834. */
  18835. static GetConstructorFromName(type: number, name: string, scene: Scene): Nullable<() => Light>;
  18836. /**
  18837. * Parses the passed "parsedLight" and returns a new instanced Light from this parsing.
  18838. * @param parsedLight The JSON representation of the light
  18839. * @param scene The scene to create the parsed light in
  18840. * @returns the created light after parsing
  18841. */
  18842. static Parse(parsedLight: any, scene: Scene): Nullable<Light>;
  18843. private _hookArrayForExcluded;
  18844. private _hookArrayForIncludedOnly;
  18845. private _resyncMeshes;
  18846. /**
  18847. * Forces the meshes to update their light related information in their rendering used effects
  18848. * @hidden Internal Use Only
  18849. */
  18850. _markMeshesAsLightDirty(): void;
  18851. /**
  18852. * Recomputes the cached photometric scale if needed.
  18853. */
  18854. private _computePhotometricScale;
  18855. /**
  18856. * Returns the Photometric Scale according to the light type and intensity mode.
  18857. */
  18858. private _getPhotometricScale;
  18859. /**
  18860. * Reorder the light in the scene according to their defined priority.
  18861. * @hidden Internal Use Only
  18862. */
  18863. _reorderLightsInScene(): void;
  18864. /**
  18865. * Prepares the list of defines specific to the light type.
  18866. * @param defines the list of defines
  18867. * @param lightIndex defines the index of the light for the effect
  18868. */
  18869. abstract prepareLightSpecificDefines(defines: any, lightIndex: number): void;
  18870. }
  18871. }
  18872. declare module "babylonjs/Cameras/targetCamera" {
  18873. import { Nullable } from "babylonjs/types";
  18874. import { Camera } from "babylonjs/Cameras/camera";
  18875. import { Scene } from "babylonjs/scene";
  18876. import { Quaternion, Matrix, Vector3, Vector2 } from "babylonjs/Maths/math.vector";
  18877. /**
  18878. * A target camera takes a mesh or position as a target and continues to look at it while it moves.
  18879. * This is the base of the follow, arc rotate cameras and Free camera
  18880. * @see https://doc.babylonjs.com/features/cameras
  18881. */
  18882. export class TargetCamera extends Camera {
  18883. private static _RigCamTransformMatrix;
  18884. private static _TargetTransformMatrix;
  18885. private static _TargetFocalPoint;
  18886. private _tmpUpVector;
  18887. private _tmpTargetVector;
  18888. /**
  18889. * Define the current direction the camera is moving to
  18890. */
  18891. cameraDirection: Vector3;
  18892. /**
  18893. * Define the current rotation the camera is rotating to
  18894. */
  18895. cameraRotation: Vector2;
  18896. /** Gets or sets a boolean indicating that the scaling of the parent hierarchy will not be taken in account by the camera */
  18897. ignoreParentScaling: boolean;
  18898. /**
  18899. * When set, the up vector of the camera will be updated by the rotation of the camera
  18900. */
  18901. updateUpVectorFromRotation: boolean;
  18902. private _tmpQuaternion;
  18903. /**
  18904. * Define the current rotation of the camera
  18905. */
  18906. rotation: Vector3;
  18907. /**
  18908. * Define the current rotation of the camera as a quaternion to prevent Gimbal lock
  18909. */
  18910. rotationQuaternion: Quaternion;
  18911. /**
  18912. * Define the current speed of the camera
  18913. */
  18914. speed: number;
  18915. /**
  18916. * Add constraint to the camera to prevent it to move freely in all directions and
  18917. * around all axis.
  18918. */
  18919. noRotationConstraint: boolean;
  18920. /**
  18921. * Reverses mouselook direction to 'natural' panning as opposed to traditional direct
  18922. * panning
  18923. */
  18924. invertRotation: boolean;
  18925. /**
  18926. * Speed multiplier for inverse camera panning
  18927. */
  18928. inverseRotationSpeed: number;
  18929. /**
  18930. * Define the current target of the camera as an object or a position.
  18931. */
  18932. lockedTarget: any;
  18933. /** @hidden */
  18934. _currentTarget: Vector3;
  18935. /** @hidden */
  18936. _initialFocalDistance: number;
  18937. /** @hidden */
  18938. _viewMatrix: Matrix;
  18939. /** @hidden */
  18940. _camMatrix: Matrix;
  18941. /** @hidden */
  18942. _cameraTransformMatrix: Matrix;
  18943. /** @hidden */
  18944. _cameraRotationMatrix: Matrix;
  18945. /** @hidden */
  18946. _referencePoint: Vector3;
  18947. /** @hidden */
  18948. _transformedReferencePoint: Vector3;
  18949. /** @hidden */
  18950. _reset: () => void;
  18951. private _defaultUp;
  18952. /**
  18953. * Instantiates a target camera that takes a mesh or position as a target and continues to look at it while it moves.
  18954. * This is the base of the follow, arc rotate cameras and Free camera
  18955. * @see https://doc.babylonjs.com/features/cameras
  18956. * @param name Defines the name of the camera in the scene
  18957. * @param position Defines the start position of the camera in the scene
  18958. * @param scene Defines the scene the camera belongs to
  18959. * @param setActiveOnSceneIfNoneActive Defines wheter the camera should be marked as active if not other active cameras have been defined
  18960. */
  18961. constructor(name: string, position: Vector3, scene: Scene, setActiveOnSceneIfNoneActive?: boolean);
  18962. /**
  18963. * Gets the position in front of the camera at a given distance.
  18964. * @param distance The distance from the camera we want the position to be
  18965. * @returns the position
  18966. */
  18967. getFrontPosition(distance: number): Vector3;
  18968. /** @hidden */
  18969. _getLockedTargetPosition(): Nullable<Vector3>;
  18970. private _storedPosition;
  18971. private _storedRotation;
  18972. private _storedRotationQuaternion;
  18973. /**
  18974. * Store current camera state of the camera (fov, position, rotation, etc..)
  18975. * @returns the camera
  18976. */
  18977. storeState(): Camera;
  18978. /**
  18979. * Restored camera state. You must call storeState() first
  18980. * @returns whether it was successful or not
  18981. * @hidden
  18982. */
  18983. _restoreStateValues(): boolean;
  18984. /** @hidden */
  18985. _initCache(): void;
  18986. /** @hidden */
  18987. _updateCache(ignoreParentClass?: boolean): void;
  18988. /** @hidden */
  18989. _isSynchronizedViewMatrix(): boolean;
  18990. /** @hidden */
  18991. _computeLocalCameraSpeed(): number;
  18992. /**
  18993. * Defines the target the camera should look at.
  18994. * @param target Defines the new target as a Vector or a mesh
  18995. */
  18996. setTarget(target: Vector3): void;
  18997. /**
  18998. * Defines the target point of the camera.
  18999. * The camera looks towards it form the radius distance.
  19000. */
  19001. get target(): Vector3;
  19002. set target(value: Vector3);
  19003. /**
  19004. * Return the current target position of the camera. This value is expressed in local space.
  19005. * @returns the target position
  19006. */
  19007. getTarget(): Vector3;
  19008. /** @hidden */
  19009. _decideIfNeedsToMove(): boolean;
  19010. /** @hidden */
  19011. _updatePosition(): void;
  19012. /** @hidden */
  19013. _checkInputs(): void;
  19014. protected _updateCameraRotationMatrix(): void;
  19015. /**
  19016. * Update the up vector to apply the rotation of the camera (So if you changed the camera rotation.z this will let you update the up vector as well)
  19017. * @returns the current camera
  19018. */
  19019. private _rotateUpVectorWithCameraRotationMatrix;
  19020. private _cachedRotationZ;
  19021. private _cachedQuaternionRotationZ;
  19022. /** @hidden */
  19023. _getViewMatrix(): Matrix;
  19024. protected _computeViewMatrix(position: Vector3, target: Vector3, up: Vector3): void;
  19025. /**
  19026. * @hidden
  19027. */
  19028. createRigCamera(name: string, cameraIndex: number): Nullable<Camera>;
  19029. /**
  19030. * @hidden
  19031. */
  19032. _updateRigCameras(): void;
  19033. private _getRigCamPositionAndTarget;
  19034. /**
  19035. * Gets the current object class name.
  19036. * @return the class name
  19037. */
  19038. getClassName(): string;
  19039. }
  19040. }
  19041. declare module "babylonjs/Events/keyboardEvents" {
  19042. /**
  19043. * Gather the list of keyboard event types as constants.
  19044. */
  19045. export class KeyboardEventTypes {
  19046. /**
  19047. * The keydown event is fired when a key becomes active (pressed).
  19048. */
  19049. static readonly KEYDOWN: number;
  19050. /**
  19051. * The keyup event is fired when a key has been released.
  19052. */
  19053. static readonly KEYUP: number;
  19054. }
  19055. /**
  19056. * This class is used to store keyboard related info for the onKeyboardObservable event.
  19057. */
  19058. export class KeyboardInfo {
  19059. /**
  19060. * Defines the type of event (KeyboardEventTypes)
  19061. */
  19062. type: number;
  19063. /**
  19064. * Defines the related dom event
  19065. */
  19066. event: KeyboardEvent;
  19067. /**
  19068. * Instantiates a new keyboard info.
  19069. * This class is used to store keyboard related info for the onKeyboardObservable event.
  19070. * @param type Defines the type of event (KeyboardEventTypes)
  19071. * @param event Defines the related dom event
  19072. */
  19073. constructor(
  19074. /**
  19075. * Defines the type of event (KeyboardEventTypes)
  19076. */
  19077. type: number,
  19078. /**
  19079. * Defines the related dom event
  19080. */
  19081. event: KeyboardEvent);
  19082. }
  19083. /**
  19084. * This class is used to store keyboard related info for the onPreKeyboardObservable event.
  19085. * Set the skipOnKeyboardObservable property to true if you want the engine to stop any process after this event is triggered, even not calling onKeyboardObservable
  19086. */
  19087. export class KeyboardInfoPre extends KeyboardInfo {
  19088. /**
  19089. * Defines the type of event (KeyboardEventTypes)
  19090. */
  19091. type: number;
  19092. /**
  19093. * Defines the related dom event
  19094. */
  19095. event: KeyboardEvent;
  19096. /**
  19097. * Defines whether the engine should skip the next onKeyboardObservable associated to this pre.
  19098. */
  19099. skipOnPointerObservable: boolean;
  19100. /**
  19101. * Instantiates a new keyboard pre info.
  19102. * This class is used to store keyboard related info for the onPreKeyboardObservable event.
  19103. * @param type Defines the type of event (KeyboardEventTypes)
  19104. * @param event Defines the related dom event
  19105. */
  19106. constructor(
  19107. /**
  19108. * Defines the type of event (KeyboardEventTypes)
  19109. */
  19110. type: number,
  19111. /**
  19112. * Defines the related dom event
  19113. */
  19114. event: KeyboardEvent);
  19115. }
  19116. }
  19117. declare module "babylonjs/Cameras/Inputs/freeCameraKeyboardMoveInput" {
  19118. import { Nullable } from "babylonjs/types";
  19119. import { ICameraInput } from "babylonjs/Cameras/cameraInputsManager";
  19120. import { FreeCamera } from "babylonjs/Cameras/freeCamera";
  19121. /**
  19122. * Manage the keyboard inputs to control the movement of a free camera.
  19123. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  19124. */
  19125. export class FreeCameraKeyboardMoveInput implements ICameraInput<FreeCamera> {
  19126. /**
  19127. * Defines the camera the input is attached to.
  19128. */
  19129. camera: FreeCamera;
  19130. /**
  19131. * Gets or Set the list of keyboard keys used to control the forward move of the camera.
  19132. */
  19133. keysUp: number[];
  19134. /**
  19135. * Gets or Set the list of keyboard keys used to control the upward move of the camera.
  19136. */
  19137. keysUpward: number[];
  19138. /**
  19139. * Gets or Set the list of keyboard keys used to control the backward move of the camera.
  19140. */
  19141. keysDown: number[];
  19142. /**
  19143. * Gets or Set the list of keyboard keys used to control the downward move of the camera.
  19144. */
  19145. keysDownward: number[];
  19146. /**
  19147. * Gets or Set the list of keyboard keys used to control the left strafe move of the camera.
  19148. */
  19149. keysLeft: number[];
  19150. /**
  19151. * Gets or Set the list of keyboard keys used to control the right strafe move of the camera.
  19152. */
  19153. keysRight: number[];
  19154. private _keys;
  19155. private _onCanvasBlurObserver;
  19156. private _onKeyboardObserver;
  19157. private _engine;
  19158. private _scene;
  19159. /**
  19160. * Attach the input controls to a specific dom element to get the input from.
  19161. * @param element Defines the element the controls should be listened from
  19162. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  19163. */
  19164. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  19165. /**
  19166. * Detach the current controls from the specified dom element.
  19167. * @param element Defines the element to stop listening the inputs from
  19168. */
  19169. detachControl(element: Nullable<HTMLElement>): void;
  19170. /**
  19171. * Update the current camera state depending on the inputs that have been used this frame.
  19172. * This is a dynamically created lambda to avoid the performance penalty of looping for inputs in the render loop.
  19173. */
  19174. checkInputs(): void;
  19175. /**
  19176. * Gets the class name of the current intput.
  19177. * @returns the class name
  19178. */
  19179. getClassName(): string;
  19180. /** @hidden */
  19181. _onLostFocus(): void;
  19182. /**
  19183. * Get the friendly name associated with the input class.
  19184. * @returns the input friendly name
  19185. */
  19186. getSimpleName(): string;
  19187. }
  19188. }
  19189. declare module "babylonjs/Events/pointerEvents" {
  19190. import { Nullable } from "babylonjs/types";
  19191. import { Vector2 } from "babylonjs/Maths/math.vector";
  19192. import { PickingInfo } from "babylonjs/Collisions/pickingInfo";
  19193. import { Ray } from "babylonjs/Culling/ray";
  19194. /**
  19195. * Gather the list of pointer event types as constants.
  19196. */
  19197. export class PointerEventTypes {
  19198. /**
  19199. * The pointerdown event is fired when a pointer becomes active. For mouse, it is fired when the device transitions from no buttons depressed to at least one button depressed. For touch, it is fired when physical contact is made with the digitizer. For pen, it is fired when the stylus makes physical contact with the digitizer.
  19200. */
  19201. static readonly POINTERDOWN: number;
  19202. /**
  19203. * The pointerup event is fired when a pointer is no longer active.
  19204. */
  19205. static readonly POINTERUP: number;
  19206. /**
  19207. * The pointermove event is fired when a pointer changes coordinates.
  19208. */
  19209. static readonly POINTERMOVE: number;
  19210. /**
  19211. * The pointerwheel event is fired when a mouse wheel has been rotated.
  19212. */
  19213. static readonly POINTERWHEEL: number;
  19214. /**
  19215. * The pointerpick event is fired when a mesh or sprite has been picked by the pointer.
  19216. */
  19217. static readonly POINTERPICK: number;
  19218. /**
  19219. * The pointertap event is fired when a the object has been touched and released without drag.
  19220. */
  19221. static readonly POINTERTAP: number;
  19222. /**
  19223. * The pointerdoubletap event is fired when a the object has been touched and released twice without drag.
  19224. */
  19225. static readonly POINTERDOUBLETAP: number;
  19226. }
  19227. /**
  19228. * Base class of pointer info types.
  19229. */
  19230. export class PointerInfoBase {
  19231. /**
  19232. * Defines the type of event (PointerEventTypes)
  19233. */
  19234. type: number;
  19235. /**
  19236. * Defines the related dom event
  19237. */
  19238. event: PointerEvent | MouseWheelEvent;
  19239. /**
  19240. * Instantiates the base class of pointers info.
  19241. * @param type Defines the type of event (PointerEventTypes)
  19242. * @param event Defines the related dom event
  19243. */
  19244. constructor(
  19245. /**
  19246. * Defines the type of event (PointerEventTypes)
  19247. */
  19248. type: number,
  19249. /**
  19250. * Defines the related dom event
  19251. */
  19252. event: PointerEvent | MouseWheelEvent);
  19253. }
  19254. /**
  19255. * This class is used to store pointer related info for the onPrePointerObservable event.
  19256. * Set the skipOnPointerObservable property to true if you want the engine to stop any process after this event is triggered, even not calling onPointerObservable
  19257. */
  19258. export class PointerInfoPre extends PointerInfoBase {
  19259. /**
  19260. * Ray from a pointer if availible (eg. 6dof controller)
  19261. */
  19262. ray: Nullable<Ray>;
  19263. /**
  19264. * Defines the local position of the pointer on the canvas.
  19265. */
  19266. localPosition: Vector2;
  19267. /**
  19268. * Defines whether the engine should skip the next OnPointerObservable associated to this pre.
  19269. */
  19270. skipOnPointerObservable: boolean;
  19271. /**
  19272. * Instantiates a PointerInfoPre to store pointer related info to the onPrePointerObservable event.
  19273. * @param type Defines the type of event (PointerEventTypes)
  19274. * @param event Defines the related dom event
  19275. * @param localX Defines the local x coordinates of the pointer when the event occured
  19276. * @param localY Defines the local y coordinates of the pointer when the event occured
  19277. */
  19278. constructor(type: number, event: PointerEvent | MouseWheelEvent, localX: number, localY: number);
  19279. }
  19280. /**
  19281. * This type contains all the data related to a pointer event in Babylon.js.
  19282. * The event member is an instance of PointerEvent for all types except PointerWheel and is of type MouseWheelEvent when type equals PointerWheel. The different event types can be found in the PointerEventTypes class.
  19283. */
  19284. export class PointerInfo extends PointerInfoBase {
  19285. /**
  19286. * Defines the picking info associated to the info (if any)\
  19287. */
  19288. pickInfo: Nullable<PickingInfo>;
  19289. /**
  19290. * Instantiates a PointerInfo to store pointer related info to the onPointerObservable event.
  19291. * @param type Defines the type of event (PointerEventTypes)
  19292. * @param event Defines the related dom event
  19293. * @param pickInfo Defines the picking info associated to the info (if any)\
  19294. */
  19295. constructor(type: number, event: PointerEvent | MouseWheelEvent,
  19296. /**
  19297. * Defines the picking info associated to the info (if any)\
  19298. */
  19299. pickInfo: Nullable<PickingInfo>);
  19300. }
  19301. /**
  19302. * Data relating to a touch event on the screen.
  19303. */
  19304. export interface PointerTouch {
  19305. /**
  19306. * X coordinate of touch.
  19307. */
  19308. x: number;
  19309. /**
  19310. * Y coordinate of touch.
  19311. */
  19312. y: number;
  19313. /**
  19314. * Id of touch. Unique for each finger.
  19315. */
  19316. pointerId: number;
  19317. /**
  19318. * Event type passed from DOM.
  19319. */
  19320. type: any;
  19321. }
  19322. }
  19323. declare module "babylonjs/Cameras/Inputs/freeCameraMouseInput" {
  19324. import { Observable } from "babylonjs/Misc/observable";
  19325. import { Nullable } from "babylonjs/types";
  19326. import { ICameraInput } from "babylonjs/Cameras/cameraInputsManager";
  19327. import { FreeCamera } from "babylonjs/Cameras/freeCamera";
  19328. /**
  19329. * Manage the mouse inputs to control the movement of a free camera.
  19330. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  19331. */
  19332. export class FreeCameraMouseInput implements ICameraInput<FreeCamera> {
  19333. /**
  19334. * Define if touch is enabled in the mouse input
  19335. */
  19336. touchEnabled: boolean;
  19337. /**
  19338. * Defines the camera the input is attached to.
  19339. */
  19340. camera: FreeCamera;
  19341. /**
  19342. * Defines the buttons associated with the input to handle camera move.
  19343. */
  19344. buttons: number[];
  19345. /**
  19346. * Defines the pointer angular sensibility along the X and Y axis or how fast is the camera rotating.
  19347. */
  19348. angularSensibility: number;
  19349. private _pointerInput;
  19350. private _onMouseMove;
  19351. private _observer;
  19352. private previousPosition;
  19353. /**
  19354. * Observable for when a pointer move event occurs containing the move offset
  19355. */
  19356. onPointerMovedObservable: Observable<{
  19357. offsetX: number;
  19358. offsetY: number;
  19359. }>;
  19360. /**
  19361. * @hidden
  19362. * If the camera should be rotated automatically based on pointer movement
  19363. */
  19364. _allowCameraRotation: boolean;
  19365. /**
  19366. * Manage the mouse inputs to control the movement of a free camera.
  19367. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  19368. * @param touchEnabled Defines if touch is enabled or not
  19369. */
  19370. constructor(
  19371. /**
  19372. * Define if touch is enabled in the mouse input
  19373. */
  19374. touchEnabled?: boolean);
  19375. /**
  19376. * Attach the input controls to a specific dom element to get the input from.
  19377. * @param element Defines the element the controls should be listened from
  19378. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  19379. */
  19380. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  19381. /**
  19382. * Called on JS contextmenu event.
  19383. * Override this method to provide functionality.
  19384. */
  19385. protected onContextMenu(evt: PointerEvent): void;
  19386. /**
  19387. * Detach the current controls from the specified dom element.
  19388. * @param element Defines the element to stop listening the inputs from
  19389. */
  19390. detachControl(element: Nullable<HTMLElement>): void;
  19391. /**
  19392. * Gets the class name of the current intput.
  19393. * @returns the class name
  19394. */
  19395. getClassName(): string;
  19396. /**
  19397. * Get the friendly name associated with the input class.
  19398. * @returns the input friendly name
  19399. */
  19400. getSimpleName(): string;
  19401. }
  19402. }
  19403. declare module "babylonjs/Cameras/Inputs/freeCameraTouchInput" {
  19404. import { Nullable } from "babylonjs/types";
  19405. import { ICameraInput } from "babylonjs/Cameras/cameraInputsManager";
  19406. import { FreeCamera } from "babylonjs/Cameras/freeCamera";
  19407. /**
  19408. * Manage the touch inputs to control the movement of a free camera.
  19409. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  19410. */
  19411. export class FreeCameraTouchInput implements ICameraInput<FreeCamera> {
  19412. /**
  19413. * Define if mouse events can be treated as touch events
  19414. */
  19415. allowMouse: boolean;
  19416. /**
  19417. * Defines the camera the input is attached to.
  19418. */
  19419. camera: FreeCamera;
  19420. /**
  19421. * Defines the touch sensibility for rotation.
  19422. * The higher the faster.
  19423. */
  19424. touchAngularSensibility: number;
  19425. /**
  19426. * Defines the touch sensibility for move.
  19427. * The higher the faster.
  19428. */
  19429. touchMoveSensibility: number;
  19430. private _offsetX;
  19431. private _offsetY;
  19432. private _pointerPressed;
  19433. private _pointerInput;
  19434. private _observer;
  19435. private _onLostFocus;
  19436. /**
  19437. * Manage the touch inputs to control the movement of a free camera.
  19438. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  19439. * @param allowMouse Defines if mouse events can be treated as touch events
  19440. */
  19441. constructor(
  19442. /**
  19443. * Define if mouse events can be treated as touch events
  19444. */
  19445. allowMouse?: boolean);
  19446. /**
  19447. * Attach the input controls to a specific dom element to get the input from.
  19448. * @param element Defines the element the controls should be listened from
  19449. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  19450. */
  19451. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  19452. /**
  19453. * Detach the current controls from the specified dom element.
  19454. * @param element Defines the element to stop listening the inputs from
  19455. */
  19456. detachControl(element: Nullable<HTMLElement>): void;
  19457. /**
  19458. * Update the current camera state depending on the inputs that have been used this frame.
  19459. * This is a dynamically created lambda to avoid the performance penalty of looping for inputs in the render loop.
  19460. */
  19461. checkInputs(): void;
  19462. /**
  19463. * Gets the class name of the current intput.
  19464. * @returns the class name
  19465. */
  19466. getClassName(): string;
  19467. /**
  19468. * Get the friendly name associated with the input class.
  19469. * @returns the input friendly name
  19470. */
  19471. getSimpleName(): string;
  19472. }
  19473. }
  19474. declare module "babylonjs/Cameras/freeCameraInputsManager" {
  19475. import { FreeCamera } from "babylonjs/Cameras/freeCamera";
  19476. import { CameraInputsManager } from "babylonjs/Cameras/cameraInputsManager";
  19477. import { FreeCameraMouseInput } from "babylonjs/Cameras/Inputs/freeCameraMouseInput";
  19478. import { Nullable } from "babylonjs/types";
  19479. /**
  19480. * Default Inputs manager for the FreeCamera.
  19481. * It groups all the default supported inputs for ease of use.
  19482. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  19483. */
  19484. export class FreeCameraInputsManager extends CameraInputsManager<FreeCamera> {
  19485. /**
  19486. * @hidden
  19487. */
  19488. _mouseInput: Nullable<FreeCameraMouseInput>;
  19489. /**
  19490. * Instantiates a new FreeCameraInputsManager.
  19491. * @param camera Defines the camera the inputs belong to
  19492. */
  19493. constructor(camera: FreeCamera);
  19494. /**
  19495. * Add keyboard input support to the input manager.
  19496. * @returns the current input manager
  19497. */
  19498. addKeyboard(): FreeCameraInputsManager;
  19499. /**
  19500. * Add mouse input support to the input manager.
  19501. * @param touchEnabled if the FreeCameraMouseInput should support touch (default: true)
  19502. * @returns the current input manager
  19503. */
  19504. addMouse(touchEnabled?: boolean): FreeCameraInputsManager;
  19505. /**
  19506. * Removes the mouse input support from the manager
  19507. * @returns the current input manager
  19508. */
  19509. removeMouse(): FreeCameraInputsManager;
  19510. /**
  19511. * Add touch input support to the input manager.
  19512. * @returns the current input manager
  19513. */
  19514. addTouch(): FreeCameraInputsManager;
  19515. /**
  19516. * Remove all attached input methods from a camera
  19517. */
  19518. clear(): void;
  19519. }
  19520. }
  19521. declare module "babylonjs/Cameras/freeCamera" {
  19522. import { Vector3 } from "babylonjs/Maths/math.vector";
  19523. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  19524. import { Scene } from "babylonjs/scene";
  19525. import { TargetCamera } from "babylonjs/Cameras/targetCamera";
  19526. import { FreeCameraInputsManager } from "babylonjs/Cameras/freeCameraInputsManager";
  19527. /**
  19528. * This represents a free type of camera. It can be useful in First Person Shooter game for instance.
  19529. * Please consider using the new UniversalCamera instead as it adds more functionality like the gamepad.
  19530. * @see https://doc.babylonjs.com/features/cameras#universal-camera
  19531. */
  19532. export class FreeCamera extends TargetCamera {
  19533. /**
  19534. * Define the collision ellipsoid of the camera.
  19535. * This is helpful to simulate a camera body like the player body around the camera
  19536. * @see https://doc.babylonjs.com/babylon101/cameras,_mesh_collisions_and_gravity#arcrotatecamera
  19537. */
  19538. ellipsoid: Vector3;
  19539. /**
  19540. * Define an offset for the position of the ellipsoid around the camera.
  19541. * This can be helpful to determine the center of the body near the gravity center of the body
  19542. * instead of its head.
  19543. */
  19544. ellipsoidOffset: Vector3;
  19545. /**
  19546. * Enable or disable collisions of the camera with the rest of the scene objects.
  19547. */
  19548. checkCollisions: boolean;
  19549. /**
  19550. * Enable or disable gravity on the camera.
  19551. */
  19552. applyGravity: boolean;
  19553. /**
  19554. * Define the input manager associated to the camera.
  19555. */
  19556. inputs: FreeCameraInputsManager;
  19557. /**
  19558. * Gets the input sensibility for a mouse input. (default is 2000.0)
  19559. * Higher values reduce sensitivity.
  19560. */
  19561. get angularSensibility(): number;
  19562. /**
  19563. * Sets the input sensibility for a mouse input. (default is 2000.0)
  19564. * Higher values reduce sensitivity.
  19565. */
  19566. set angularSensibility(value: number);
  19567. /**
  19568. * Gets or Set the list of keyboard keys used to control the forward move of the camera.
  19569. */
  19570. get keysUp(): number[];
  19571. set keysUp(value: number[]);
  19572. /**
  19573. * Gets or Set the list of keyboard keys used to control the upward move of the camera.
  19574. */
  19575. get keysUpward(): number[];
  19576. set keysUpward(value: number[]);
  19577. /**
  19578. * Gets or Set the list of keyboard keys used to control the backward move of the camera.
  19579. */
  19580. get keysDown(): number[];
  19581. set keysDown(value: number[]);
  19582. /**
  19583. * Gets or Set the list of keyboard keys used to control the downward move of the camera.
  19584. */
  19585. get keysDownward(): number[];
  19586. set keysDownward(value: number[]);
  19587. /**
  19588. * Gets or Set the list of keyboard keys used to control the left strafe move of the camera.
  19589. */
  19590. get keysLeft(): number[];
  19591. set keysLeft(value: number[]);
  19592. /**
  19593. * Gets or Set the list of keyboard keys used to control the right strafe move of the camera.
  19594. */
  19595. get keysRight(): number[];
  19596. set keysRight(value: number[]);
  19597. /**
  19598. * Event raised when the camera collide with a mesh in the scene.
  19599. */
  19600. onCollide: (collidedMesh: AbstractMesh) => void;
  19601. private _collider;
  19602. private _needMoveForGravity;
  19603. private _oldPosition;
  19604. private _diffPosition;
  19605. private _newPosition;
  19606. /** @hidden */
  19607. _localDirection: Vector3;
  19608. /** @hidden */
  19609. _transformedDirection: Vector3;
  19610. /**
  19611. * Instantiates a Free Camera.
  19612. * This represents a free type of camera. It can be useful in First Person Shooter game for instance.
  19613. * Please consider using the new UniversalCamera instead as it adds more functionality like touch to this camera.
  19614. * @see https://doc.babylonjs.com/features/cameras#universal-camera
  19615. * @param name Define the name of the camera in the scene
  19616. * @param position Define the start position of the camera in the scene
  19617. * @param scene Define the scene the camera belongs to
  19618. * @param setActiveOnSceneIfNoneActive Defines wheter the camera should be marked as active if not other active cameras have been defined
  19619. */
  19620. constructor(name: string, position: Vector3, scene: Scene, setActiveOnSceneIfNoneActive?: boolean);
  19621. /**
  19622. * Attached controls to the current camera.
  19623. * @param element Defines the element the controls should be listened from
  19624. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  19625. */
  19626. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  19627. /**
  19628. * Detach the current controls from the camera.
  19629. * The camera will stop reacting to inputs.
  19630. * @param element Defines the element to stop listening the inputs from
  19631. */
  19632. detachControl(element: HTMLElement): void;
  19633. private _collisionMask;
  19634. /**
  19635. * Define a collision mask to limit the list of object the camera can collide with
  19636. */
  19637. get collisionMask(): number;
  19638. set collisionMask(mask: number);
  19639. /** @hidden */
  19640. _collideWithWorld(displacement: Vector3): void;
  19641. private _onCollisionPositionChange;
  19642. /** @hidden */
  19643. _checkInputs(): void;
  19644. /** @hidden */
  19645. _decideIfNeedsToMove(): boolean;
  19646. /** @hidden */
  19647. _updatePosition(): void;
  19648. /**
  19649. * Destroy the camera and release the current resources hold by it.
  19650. */
  19651. dispose(): void;
  19652. /**
  19653. * Gets the current object class name.
  19654. * @return the class name
  19655. */
  19656. getClassName(): string;
  19657. }
  19658. }
  19659. declare module "babylonjs/Gamepads/gamepad" {
  19660. import { Observable } from "babylonjs/Misc/observable";
  19661. /**
  19662. * Represents a gamepad control stick position
  19663. */
  19664. export class StickValues {
  19665. /**
  19666. * The x component of the control stick
  19667. */
  19668. x: number;
  19669. /**
  19670. * The y component of the control stick
  19671. */
  19672. y: number;
  19673. /**
  19674. * Initializes the gamepad x and y control stick values
  19675. * @param x The x component of the gamepad control stick value
  19676. * @param y The y component of the gamepad control stick value
  19677. */
  19678. constructor(
  19679. /**
  19680. * The x component of the control stick
  19681. */
  19682. x: number,
  19683. /**
  19684. * The y component of the control stick
  19685. */
  19686. y: number);
  19687. }
  19688. /**
  19689. * An interface which manages callbacks for gamepad button changes
  19690. */
  19691. export interface GamepadButtonChanges {
  19692. /**
  19693. * Called when a gamepad has been changed
  19694. */
  19695. changed: boolean;
  19696. /**
  19697. * Called when a gamepad press event has been triggered
  19698. */
  19699. pressChanged: boolean;
  19700. /**
  19701. * Called when a touch event has been triggered
  19702. */
  19703. touchChanged: boolean;
  19704. /**
  19705. * Called when a value has changed
  19706. */
  19707. valueChanged: boolean;
  19708. }
  19709. /**
  19710. * Represents a gamepad
  19711. */
  19712. export class Gamepad {
  19713. /**
  19714. * The id of the gamepad
  19715. */
  19716. id: string;
  19717. /**
  19718. * The index of the gamepad
  19719. */
  19720. index: number;
  19721. /**
  19722. * The browser gamepad
  19723. */
  19724. browserGamepad: any;
  19725. /**
  19726. * Specifies what type of gamepad this represents
  19727. */
  19728. type: number;
  19729. private _leftStick;
  19730. private _rightStick;
  19731. /** @hidden */
  19732. _isConnected: boolean;
  19733. private _leftStickAxisX;
  19734. private _leftStickAxisY;
  19735. private _rightStickAxisX;
  19736. private _rightStickAxisY;
  19737. /**
  19738. * Triggered when the left control stick has been changed
  19739. */
  19740. private _onleftstickchanged;
  19741. /**
  19742. * Triggered when the right control stick has been changed
  19743. */
  19744. private _onrightstickchanged;
  19745. /**
  19746. * Represents a gamepad controller
  19747. */
  19748. static GAMEPAD: number;
  19749. /**
  19750. * Represents a generic controller
  19751. */
  19752. static GENERIC: number;
  19753. /**
  19754. * Represents an XBox controller
  19755. */
  19756. static XBOX: number;
  19757. /**
  19758. * Represents a pose-enabled controller
  19759. */
  19760. static POSE_ENABLED: number;
  19761. /**
  19762. * Represents an Dual Shock controller
  19763. */
  19764. static DUALSHOCK: number;
  19765. /**
  19766. * Specifies whether the left control stick should be Y-inverted
  19767. */
  19768. protected _invertLeftStickY: boolean;
  19769. /**
  19770. * Specifies if the gamepad has been connected
  19771. */
  19772. get isConnected(): boolean;
  19773. /**
  19774. * Initializes the gamepad
  19775. * @param id The id of the gamepad
  19776. * @param index The index of the gamepad
  19777. * @param browserGamepad The browser gamepad
  19778. * @param leftStickX The x component of the left joystick
  19779. * @param leftStickY The y component of the left joystick
  19780. * @param rightStickX The x component of the right joystick
  19781. * @param rightStickY The y component of the right joystick
  19782. */
  19783. constructor(
  19784. /**
  19785. * The id of the gamepad
  19786. */
  19787. id: string,
  19788. /**
  19789. * The index of the gamepad
  19790. */
  19791. index: number,
  19792. /**
  19793. * The browser gamepad
  19794. */
  19795. browserGamepad: any, leftStickX?: number, leftStickY?: number, rightStickX?: number, rightStickY?: number);
  19796. /**
  19797. * Callback triggered when the left joystick has changed
  19798. * @param callback
  19799. */
  19800. onleftstickchanged(callback: (values: StickValues) => void): void;
  19801. /**
  19802. * Callback triggered when the right joystick has changed
  19803. * @param callback
  19804. */
  19805. onrightstickchanged(callback: (values: StickValues) => void): void;
  19806. /**
  19807. * Gets the left joystick
  19808. */
  19809. get leftStick(): StickValues;
  19810. /**
  19811. * Sets the left joystick values
  19812. */
  19813. set leftStick(newValues: StickValues);
  19814. /**
  19815. * Gets the right joystick
  19816. */
  19817. get rightStick(): StickValues;
  19818. /**
  19819. * Sets the right joystick value
  19820. */
  19821. set rightStick(newValues: StickValues);
  19822. /**
  19823. * Updates the gamepad joystick positions
  19824. */
  19825. update(): void;
  19826. /**
  19827. * Disposes the gamepad
  19828. */
  19829. dispose(): void;
  19830. }
  19831. /**
  19832. * Represents a generic gamepad
  19833. */
  19834. export class GenericPad extends Gamepad {
  19835. private _buttons;
  19836. private _onbuttondown;
  19837. private _onbuttonup;
  19838. /**
  19839. * Observable triggered when a button has been pressed
  19840. */
  19841. onButtonDownObservable: Observable<number>;
  19842. /**
  19843. * Observable triggered when a button has been released
  19844. */
  19845. onButtonUpObservable: Observable<number>;
  19846. /**
  19847. * Callback triggered when a button has been pressed
  19848. * @param callback Called when a button has been pressed
  19849. */
  19850. onbuttondown(callback: (buttonPressed: number) => void): void;
  19851. /**
  19852. * Callback triggered when a button has been released
  19853. * @param callback Called when a button has been released
  19854. */
  19855. onbuttonup(callback: (buttonReleased: number) => void): void;
  19856. /**
  19857. * Initializes the generic gamepad
  19858. * @param id The id of the generic gamepad
  19859. * @param index The index of the generic gamepad
  19860. * @param browserGamepad The browser gamepad
  19861. */
  19862. constructor(id: string, index: number, browserGamepad: any);
  19863. private _setButtonValue;
  19864. /**
  19865. * Updates the generic gamepad
  19866. */
  19867. update(): void;
  19868. /**
  19869. * Disposes the generic gamepad
  19870. */
  19871. dispose(): void;
  19872. }
  19873. }
  19874. declare module "babylonjs/Gamepads/Controllers/poseEnabledController" {
  19875. import { Observable } from "babylonjs/Misc/observable";
  19876. import { Nullable } from "babylonjs/types";
  19877. import { Quaternion, Matrix, Vector3 } from "babylonjs/Maths/math.vector";
  19878. import { TransformNode } from "babylonjs/Meshes/transformNode";
  19879. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  19880. import { Ray } from "babylonjs/Culling/ray";
  19881. import { Gamepad } from "babylonjs/Gamepads/gamepad";
  19882. import { PoseControlled, DevicePose } from "babylonjs/Cameras/VR/webVRCamera";
  19883. import { TargetCamera } from "babylonjs/Cameras/targetCamera";
  19884. /**
  19885. * Defines the types of pose enabled controllers that are supported
  19886. */
  19887. export enum PoseEnabledControllerType {
  19888. /**
  19889. * HTC Vive
  19890. */
  19891. VIVE = 0,
  19892. /**
  19893. * Oculus Rift
  19894. */
  19895. OCULUS = 1,
  19896. /**
  19897. * Windows mixed reality
  19898. */
  19899. WINDOWS = 2,
  19900. /**
  19901. * Samsung gear VR
  19902. */
  19903. GEAR_VR = 3,
  19904. /**
  19905. * Google Daydream
  19906. */
  19907. DAYDREAM = 4,
  19908. /**
  19909. * Generic
  19910. */
  19911. GENERIC = 5
  19912. }
  19913. /**
  19914. * Defines the MutableGamepadButton interface for the state of a gamepad button
  19915. */
  19916. export interface MutableGamepadButton {
  19917. /**
  19918. * Value of the button/trigger
  19919. */
  19920. value: number;
  19921. /**
  19922. * If the button/trigger is currently touched
  19923. */
  19924. touched: boolean;
  19925. /**
  19926. * If the button/trigger is currently pressed
  19927. */
  19928. pressed: boolean;
  19929. }
  19930. /**
  19931. * Defines the ExtendedGamepadButton interface for a gamepad button which includes state provided by a pose controller
  19932. * @hidden
  19933. */
  19934. export interface ExtendedGamepadButton extends GamepadButton {
  19935. /**
  19936. * If the button/trigger is currently pressed
  19937. */
  19938. readonly pressed: boolean;
  19939. /**
  19940. * If the button/trigger is currently touched
  19941. */
  19942. readonly touched: boolean;
  19943. /**
  19944. * Value of the button/trigger
  19945. */
  19946. readonly value: number;
  19947. }
  19948. /** @hidden */
  19949. export interface _GamePadFactory {
  19950. /**
  19951. * Returns whether or not the current gamepad can be created for this type of controller.
  19952. * @param gamepadInfo Defines the gamepad info as received from the controller APIs.
  19953. * @returns true if it can be created, otherwise false
  19954. */
  19955. canCreate(gamepadInfo: any): boolean;
  19956. /**
  19957. * Creates a new instance of the Gamepad.
  19958. * @param gamepadInfo Defines the gamepad info as received from the controller APIs.
  19959. * @returns the new gamepad instance
  19960. */
  19961. create(gamepadInfo: any): Gamepad;
  19962. }
  19963. /**
  19964. * Defines the PoseEnabledControllerHelper object that is used initialize a gamepad as the controller type it is specified as (eg. windows mixed reality controller)
  19965. */
  19966. export class PoseEnabledControllerHelper {
  19967. /** @hidden */
  19968. static _ControllerFactories: _GamePadFactory[];
  19969. /** @hidden */
  19970. static _DefaultControllerFactory: Nullable<(gamepadInfo: any) => Gamepad>;
  19971. /**
  19972. * Initializes a gamepad as the controller type it is specified as (eg. windows mixed reality controller)
  19973. * @param vrGamepad the gamepad to initialized
  19974. * @returns a vr controller of the type the gamepad identified as
  19975. */
  19976. static InitiateController(vrGamepad: any): Gamepad;
  19977. }
  19978. /**
  19979. * Defines the PoseEnabledController object that contains state of a vr capable controller
  19980. */
  19981. export class PoseEnabledController extends Gamepad implements PoseControlled {
  19982. /**
  19983. * If the controller is used in a webXR session
  19984. */
  19985. isXR: boolean;
  19986. private _deviceRoomPosition;
  19987. private _deviceRoomRotationQuaternion;
  19988. /**
  19989. * The device position in babylon space
  19990. */
  19991. devicePosition: Vector3;
  19992. /**
  19993. * The device rotation in babylon space
  19994. */
  19995. deviceRotationQuaternion: Quaternion;
  19996. /**
  19997. * The scale factor of the device in babylon space
  19998. */
  19999. deviceScaleFactor: number;
  20000. /**
  20001. * (Likely devicePosition should be used instead) The device position in its room space
  20002. */
  20003. position: Vector3;
  20004. /**
  20005. * (Likely deviceRotationQuaternion should be used instead) The device rotation in its room space
  20006. */
  20007. rotationQuaternion: Quaternion;
  20008. /**
  20009. * The type of controller (Eg. Windows mixed reality)
  20010. */
  20011. controllerType: PoseEnabledControllerType;
  20012. protected _calculatedPosition: Vector3;
  20013. private _calculatedRotation;
  20014. /**
  20015. * The raw pose from the device
  20016. */
  20017. rawPose: DevicePose;
  20018. private _trackPosition;
  20019. private _maxRotationDistFromHeadset;
  20020. private _draggedRoomRotation;
  20021. /**
  20022. * @hidden
  20023. */
  20024. _disableTrackPosition(fixedPosition: Vector3): void;
  20025. /**
  20026. * Internal, the mesh attached to the controller
  20027. * @hidden
  20028. */
  20029. _mesh: Nullable<AbstractMesh>;
  20030. private _poseControlledCamera;
  20031. private _leftHandSystemQuaternion;
  20032. /**
  20033. * Internal, matrix used to convert room space to babylon space
  20034. * @hidden
  20035. */
  20036. _deviceToWorld: Matrix;
  20037. /**
  20038. * Node to be used when casting a ray from the controller
  20039. * @hidden
  20040. */
  20041. _pointingPoseNode: Nullable<TransformNode>;
  20042. /**
  20043. * Name of the child mesh that can be used to cast a ray from the controller
  20044. */
  20045. static readonly POINTING_POSE: string;
  20046. /**
  20047. * Creates a new PoseEnabledController from a gamepad
  20048. * @param browserGamepad the gamepad that the PoseEnabledController should be created from
  20049. */
  20050. constructor(browserGamepad: any);
  20051. private _workingMatrix;
  20052. /**
  20053. * Updates the state of the pose enbaled controller and mesh based on the current position and rotation of the controller
  20054. */
  20055. update(): void;
  20056. /**
  20057. * Updates only the pose device and mesh without doing any button event checking
  20058. */
  20059. protected _updatePoseAndMesh(): void;
  20060. /**
  20061. * Updates the state of the pose enbaled controller based on the raw pose data from the device
  20062. * @param poseData raw pose fromthe device
  20063. */
  20064. updateFromDevice(poseData: DevicePose): void;
  20065. /**
  20066. * @hidden
  20067. */
  20068. _meshAttachedObservable: Observable<AbstractMesh>;
  20069. /**
  20070. * Attaches a mesh to the controller
  20071. * @param mesh the mesh to be attached
  20072. */
  20073. attachToMesh(mesh: AbstractMesh): void;
  20074. /**
  20075. * Attaches the controllers mesh to a camera
  20076. * @param camera the camera the mesh should be attached to
  20077. */
  20078. attachToPoseControlledCamera(camera: TargetCamera): void;
  20079. /**
  20080. * Disposes of the controller
  20081. */
  20082. dispose(): void;
  20083. /**
  20084. * The mesh that is attached to the controller
  20085. */
  20086. get mesh(): Nullable<AbstractMesh>;
  20087. /**
  20088. * Gets the ray of the controller in the direction the controller is pointing
  20089. * @param length the length the resulting ray should be
  20090. * @returns a ray in the direction the controller is pointing
  20091. */
  20092. getForwardRay(length?: number): Ray;
  20093. }
  20094. }
  20095. declare module "babylonjs/Gamepads/Controllers/webVRController" {
  20096. import { Observable } from "babylonjs/Misc/observable";
  20097. import { Scene } from "babylonjs/scene";
  20098. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  20099. import { PoseEnabledController, ExtendedGamepadButton, MutableGamepadButton } from "babylonjs/Gamepads/Controllers/poseEnabledController";
  20100. import { StickValues, GamepadButtonChanges } from "babylonjs/Gamepads/gamepad";
  20101. import { Nullable } from "babylonjs/types";
  20102. /**
  20103. * Defines the WebVRController object that represents controllers tracked in 3D space
  20104. */
  20105. export abstract class WebVRController extends PoseEnabledController {
  20106. /**
  20107. * Internal, the default controller model for the controller
  20108. */
  20109. protected _defaultModel: Nullable<AbstractMesh>;
  20110. /**
  20111. * Fired when the trigger state has changed
  20112. */
  20113. onTriggerStateChangedObservable: Observable<ExtendedGamepadButton>;
  20114. /**
  20115. * Fired when the main button state has changed
  20116. */
  20117. onMainButtonStateChangedObservable: Observable<ExtendedGamepadButton>;
  20118. /**
  20119. * Fired when the secondary button state has changed
  20120. */
  20121. onSecondaryButtonStateChangedObservable: Observable<ExtendedGamepadButton>;
  20122. /**
  20123. * Fired when the pad state has changed
  20124. */
  20125. onPadStateChangedObservable: Observable<ExtendedGamepadButton>;
  20126. /**
  20127. * Fired when controllers stick values have changed
  20128. */
  20129. onPadValuesChangedObservable: Observable<StickValues>;
  20130. /**
  20131. * Array of button availible on the controller
  20132. */
  20133. protected _buttons: Array<MutableGamepadButton>;
  20134. private _onButtonStateChange;
  20135. /**
  20136. * Fired when a controller button's state has changed
  20137. * @param callback the callback containing the button that was modified
  20138. */
  20139. onButtonStateChange(callback: (controlledIndex: number, buttonIndex: number, state: ExtendedGamepadButton) => void): void;
  20140. /**
  20141. * X and Y axis corresponding to the controllers joystick
  20142. */
  20143. pad: StickValues;
  20144. /**
  20145. * 'left' or 'right', see https://w3c.github.io/gamepad/extensions.html#gamepadhand-enum
  20146. */
  20147. hand: string;
  20148. /**
  20149. * The default controller model for the controller
  20150. */
  20151. get defaultModel(): Nullable<AbstractMesh>;
  20152. /**
  20153. * Creates a new WebVRController from a gamepad
  20154. * @param vrGamepad the gamepad that the WebVRController should be created from
  20155. */
  20156. constructor(vrGamepad: any);
  20157. /**
  20158. * Updates the state of the controller and mesh based on the current position and rotation of the controller
  20159. */
  20160. update(): void;
  20161. /**
  20162. * Function to be called when a button is modified
  20163. */
  20164. protected abstract _handleButtonChange(buttonIdx: number, value: ExtendedGamepadButton, changes: GamepadButtonChanges): void;
  20165. /**
  20166. * Loads a mesh and attaches it to the controller
  20167. * @param scene the scene the mesh should be added to
  20168. * @param meshLoaded callback for when the mesh has been loaded
  20169. */
  20170. abstract initControllerMesh(scene: Scene, meshLoaded?: (mesh: AbstractMesh) => void): void;
  20171. private _setButtonValue;
  20172. private _changes;
  20173. private _checkChanges;
  20174. /**
  20175. * Disposes of th webVRCOntroller
  20176. */
  20177. dispose(): void;
  20178. }
  20179. }
  20180. declare module "babylonjs/Lights/hemisphericLight" {
  20181. import { Nullable } from "babylonjs/types";
  20182. import { Scene } from "babylonjs/scene";
  20183. import { Matrix, Vector3 } from "babylonjs/Maths/math.vector";
  20184. import { Color3 } from "babylonjs/Maths/math.color";
  20185. import { Effect } from "babylonjs/Materials/effect";
  20186. import { Light } from "babylonjs/Lights/light";
  20187. import { IShadowGenerator } from "babylonjs/Lights/Shadows/shadowGenerator";
  20188. /**
  20189. * The HemisphericLight simulates the ambient environment light,
  20190. * so the passed direction is the light reflection direction, not the incoming direction.
  20191. */
  20192. export class HemisphericLight extends Light {
  20193. /**
  20194. * The groundColor is the light in the opposite direction to the one specified during creation.
  20195. * You can think of the diffuse and specular light as coming from the centre of the object in the given direction and the groundColor light in the opposite direction.
  20196. */
  20197. groundColor: Color3;
  20198. /**
  20199. * The light reflection direction, not the incoming direction.
  20200. */
  20201. direction: Vector3;
  20202. /**
  20203. * Creates a HemisphericLight object in the scene according to the passed direction (Vector3).
  20204. * The HemisphericLight simulates the ambient environment light, so the passed direction is the light reflection direction, not the incoming direction.
  20205. * The HemisphericLight can't cast shadows.
  20206. * Documentation : https://doc.babylonjs.com/babylon101/lights
  20207. * @param name The friendly name of the light
  20208. * @param direction The direction of the light reflection
  20209. * @param scene The scene the light belongs to
  20210. */
  20211. constructor(name: string, direction: Vector3, scene: Scene);
  20212. protected _buildUniformLayout(): void;
  20213. /**
  20214. * Returns the string "HemisphericLight".
  20215. * @return The class name
  20216. */
  20217. getClassName(): string;
  20218. /**
  20219. * Sets the HemisphericLight direction towards the passed target (Vector3).
  20220. * Returns the updated direction.
  20221. * @param target The target the direction should point to
  20222. * @return The computed direction
  20223. */
  20224. setDirectionToTarget(target: Vector3): Vector3;
  20225. /**
  20226. * Returns the shadow generator associated to the light.
  20227. * @returns Always null for hemispheric lights because it does not support shadows.
  20228. */
  20229. getShadowGenerator(): Nullable<IShadowGenerator>;
  20230. /**
  20231. * Sets the passed Effect object with the HemisphericLight normalized direction and color and the passed name (string).
  20232. * @param effect The effect to update
  20233. * @param lightIndex The index of the light in the effect to update
  20234. * @returns The hemispheric light
  20235. */
  20236. transferToEffect(effect: Effect, lightIndex: string): HemisphericLight;
  20237. transferToNodeMaterialEffect(effect: Effect, lightDataUniformName: string): this;
  20238. /**
  20239. * Computes the world matrix of the node
  20240. * @param force defines if the cache version should be invalidated forcing the world matrix to be created from scratch
  20241. * @param useWasUpdatedFlag defines a reserved property
  20242. * @returns the world matrix
  20243. */
  20244. computeWorldMatrix(): Matrix;
  20245. /**
  20246. * Returns the integer 3.
  20247. * @return The light Type id as a constant defines in Light.LIGHTTYPEID_x
  20248. */
  20249. getTypeID(): number;
  20250. /**
  20251. * Prepares the list of defines specific to the light type.
  20252. * @param defines the list of defines
  20253. * @param lightIndex defines the index of the light for the effect
  20254. */
  20255. prepareLightSpecificDefines(defines: any, lightIndex: number): void;
  20256. }
  20257. }
  20258. declare module "babylonjs/Shaders/vrMultiviewToSingleview.fragment" {
  20259. /** @hidden */
  20260. export var vrMultiviewToSingleviewPixelShader: {
  20261. name: string;
  20262. shader: string;
  20263. };
  20264. }
  20265. declare module "babylonjs/Materials/Textures/MultiviewRenderTarget" {
  20266. import { RenderTargetTexture } from "babylonjs/Materials/Textures/renderTargetTexture";
  20267. import { Scene } from "babylonjs/scene";
  20268. /**
  20269. * Renders to multiple views with a single draw call
  20270. * @see https://www.khronos.org/registry/webgl/extensions/WEBGL_multiview/
  20271. */
  20272. export class MultiviewRenderTarget extends RenderTargetTexture {
  20273. /**
  20274. * Creates a multiview render target
  20275. * @param scene scene used with the render target
  20276. * @param size the size of the render target (used for each view)
  20277. */
  20278. constructor(scene: Scene, size?: number | {
  20279. width: number;
  20280. height: number;
  20281. } | {
  20282. ratio: number;
  20283. });
  20284. /**
  20285. * @hidden
  20286. * @param faceIndex the face index, if its a cube texture
  20287. */
  20288. _bindFrameBuffer(faceIndex?: number): void;
  20289. /**
  20290. * Gets the number of views the corresponding to the texture (eg. a MultiviewRenderTarget will have > 1)
  20291. * @returns the view count
  20292. */
  20293. getViewCount(): number;
  20294. }
  20295. }
  20296. declare module "babylonjs/Engines/Extensions/engine.multiview" {
  20297. import { Camera } from "babylonjs/Cameras/camera";
  20298. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  20299. import { Nullable } from "babylonjs/types";
  20300. import { RenderTargetTexture } from "babylonjs/Materials/Textures/renderTargetTexture";
  20301. import { Matrix } from "babylonjs/Maths/math.vector";
  20302. import { UniformBuffer } from "babylonjs/Materials/uniformBuffer";
  20303. module "babylonjs/Engines/engine" {
  20304. interface Engine {
  20305. /**
  20306. * Creates a new multiview render target
  20307. * @param width defines the width of the texture
  20308. * @param height defines the height of the texture
  20309. * @returns the created multiview texture
  20310. */
  20311. createMultiviewRenderTargetTexture(width: number, height: number): InternalTexture;
  20312. /**
  20313. * Binds a multiview framebuffer to be drawn to
  20314. * @param multiviewTexture texture to bind
  20315. */
  20316. bindMultiviewFramebuffer(multiviewTexture: InternalTexture): void;
  20317. }
  20318. }
  20319. module "babylonjs/Cameras/camera" {
  20320. interface Camera {
  20321. /**
  20322. * @hidden
  20323. * For cameras that cannot use multiview images to display directly. (e.g. webVR camera will render to multiview texture, then copy to each eye texture and go from there)
  20324. */
  20325. _useMultiviewToSingleView: boolean;
  20326. /**
  20327. * @hidden
  20328. * For cameras that cannot use multiview images to display directly. (e.g. webVR camera will render to multiview texture, then copy to each eye texture and go from there)
  20329. */
  20330. _multiviewTexture: Nullable<RenderTargetTexture>;
  20331. /**
  20332. * @hidden
  20333. * ensures the multiview texture of the camera exists and has the specified width/height
  20334. * @param width height to set on the multiview texture
  20335. * @param height width to set on the multiview texture
  20336. */
  20337. _resizeOrCreateMultiviewTexture(width: number, height: number): void;
  20338. }
  20339. }
  20340. module "babylonjs/scene" {
  20341. interface Scene {
  20342. /** @hidden */
  20343. _transformMatrixR: Matrix;
  20344. /** @hidden */
  20345. _multiviewSceneUbo: Nullable<UniformBuffer>;
  20346. /** @hidden */
  20347. _createMultiviewUbo(): void;
  20348. /** @hidden */
  20349. _updateMultiviewUbo(viewR?: Matrix, projectionR?: Matrix): void;
  20350. /** @hidden */
  20351. _renderMultiviewToSingleView(camera: Camera): void;
  20352. }
  20353. }
  20354. }
  20355. declare module "babylonjs/PostProcesses/vrMultiviewToSingleviewPostProcess" {
  20356. import { Camera } from "babylonjs/Cameras/camera";
  20357. import { PostProcess } from "babylonjs/PostProcesses/postProcess";
  20358. import "babylonjs/Shaders/vrMultiviewToSingleview.fragment";
  20359. import "babylonjs/Engines/Extensions/engine.multiview";
  20360. /**
  20361. * VRMultiviewToSingleview used to convert multiview texture arrays to standard textures for scenarios such as webVR
  20362. * This will not be used for webXR as it supports displaying texture arrays directly
  20363. */
  20364. export class VRMultiviewToSingleviewPostProcess extends PostProcess {
  20365. /**
  20366. * Gets a string identifying the name of the class
  20367. * @returns "VRMultiviewToSingleviewPostProcess" string
  20368. */
  20369. getClassName(): string;
  20370. /**
  20371. * Initializes a VRMultiviewToSingleview
  20372. * @param name name of the post process
  20373. * @param camera camera to be applied to
  20374. * @param scaleFactor scaling factor to the size of the output texture
  20375. */
  20376. constructor(name: string, camera: Camera, scaleFactor: number);
  20377. }
  20378. }
  20379. declare module "babylonjs/Cameras/RigModes/webVRRigMode" { }
  20380. declare module "babylonjs/Engines/Extensions/engine.webVR" {
  20381. import { Nullable } from "babylonjs/types";
  20382. import { Size } from "babylonjs/Maths/math.size";
  20383. import { Observable } from "babylonjs/Misc/observable";
  20384. import { WebVROptions } from "babylonjs/Cameras/VR/webVRCamera";
  20385. /**
  20386. * Interface used to define additional presentation attributes
  20387. */
  20388. export interface IVRPresentationAttributes {
  20389. /**
  20390. * Defines a boolean indicating that we want to get 72hz mode on Oculus Browser (default is off eg. 60hz)
  20391. */
  20392. highRefreshRate: boolean;
  20393. /**
  20394. * Enables foveation in VR to improve perf. 0 none, 1 low, 2 medium, 3 high (Default is 1)
  20395. */
  20396. foveationLevel: number;
  20397. }
  20398. module "babylonjs/Engines/engine" {
  20399. interface Engine {
  20400. /** @hidden */
  20401. _vrDisplay: any;
  20402. /** @hidden */
  20403. _vrSupported: boolean;
  20404. /** @hidden */
  20405. _oldSize: Size;
  20406. /** @hidden */
  20407. _oldHardwareScaleFactor: number;
  20408. /** @hidden */
  20409. _vrExclusivePointerMode: boolean;
  20410. /** @hidden */
  20411. _webVRInitPromise: Promise<IDisplayChangedEventArgs>;
  20412. /** @hidden */
  20413. _onVRDisplayPointerRestricted: () => void;
  20414. /** @hidden */
  20415. _onVRDisplayPointerUnrestricted: () => void;
  20416. /** @hidden */
  20417. _onVrDisplayConnect: Nullable<(display: any) => void>;
  20418. /** @hidden */
  20419. _onVrDisplayDisconnect: Nullable<() => void>;
  20420. /** @hidden */
  20421. _onVrDisplayPresentChange: Nullable<() => void>;
  20422. /**
  20423. * Observable signaled when VR display mode changes
  20424. */
  20425. onVRDisplayChangedObservable: Observable<IDisplayChangedEventArgs>;
  20426. /**
  20427. * Observable signaled when VR request present is complete
  20428. */
  20429. onVRRequestPresentComplete: Observable<boolean>;
  20430. /**
  20431. * Observable signaled when VR request present starts
  20432. */
  20433. onVRRequestPresentStart: Observable<Engine>;
  20434. /**
  20435. * Gets a boolean indicating that the engine is currently in VR exclusive mode for the pointers
  20436. * @see https://docs.microsoft.com/en-us/microsoft-edge/webvr/essentials#mouse-input
  20437. */
  20438. isInVRExclusivePointerMode: boolean;
  20439. /**
  20440. * Gets a boolean indicating if a webVR device was detected
  20441. * @returns true if a webVR device was detected
  20442. */
  20443. isVRDevicePresent(): boolean;
  20444. /**
  20445. * Gets the current webVR device
  20446. * @returns the current webVR device (or null)
  20447. */
  20448. getVRDevice(): any;
  20449. /**
  20450. * Initializes a webVR display and starts listening to display change events
  20451. * The onVRDisplayChangedObservable will be notified upon these changes
  20452. * @returns A promise containing a VRDisplay and if vr is supported
  20453. */
  20454. initWebVRAsync(): Promise<IDisplayChangedEventArgs>;
  20455. /** @hidden */
  20456. _getVRDisplaysAsync(): Promise<IDisplayChangedEventArgs>;
  20457. /**
  20458. * Gets or sets the presentation attributes used to configure VR rendering
  20459. */
  20460. vrPresentationAttributes?: IVRPresentationAttributes;
  20461. /**
  20462. * Call this function to switch to webVR mode
  20463. * Will do nothing if webVR is not supported or if there is no webVR device
  20464. * @param options the webvr options provided to the camera. mainly used for multiview
  20465. * @see https://doc.babylonjs.com/how_to/webvr_camera
  20466. */
  20467. enableVR(options: WebVROptions): void;
  20468. /** @hidden */
  20469. _onVRFullScreenTriggered(): void;
  20470. }
  20471. }
  20472. }
  20473. declare module "babylonjs/Cameras/VR/webVRCamera" {
  20474. import { Nullable } from "babylonjs/types";
  20475. import { Observable } from "babylonjs/Misc/observable";
  20476. import { FreeCamera } from "babylonjs/Cameras/freeCamera";
  20477. import { Scene } from "babylonjs/scene";
  20478. import { Quaternion, Matrix, Vector3 } from "babylonjs/Maths/math.vector";
  20479. import { WebVRController } from "babylonjs/Gamepads/Controllers/webVRController";
  20480. import { Node } from "babylonjs/node";
  20481. import { Ray } from "babylonjs/Culling/ray";
  20482. import "babylonjs/Cameras/RigModes/webVRRigMode";
  20483. import "babylonjs/Engines/Extensions/engine.webVR";
  20484. /**
  20485. * This is a copy of VRPose. See https://developer.mozilla.org/en-US/docs/Web/API/VRPose
  20486. * IMPORTANT!! The data is right-hand data.
  20487. * @export
  20488. * @interface DevicePose
  20489. */
  20490. export interface DevicePose {
  20491. /**
  20492. * The position of the device, values in array are [x,y,z].
  20493. */
  20494. readonly position: Nullable<Float32Array>;
  20495. /**
  20496. * The linearVelocity of the device, values in array are [x,y,z].
  20497. */
  20498. readonly linearVelocity: Nullable<Float32Array>;
  20499. /**
  20500. * The linearAcceleration of the device, values in array are [x,y,z].
  20501. */
  20502. readonly linearAcceleration: Nullable<Float32Array>;
  20503. /**
  20504. * The orientation of the device in a quaternion array, values in array are [x,y,z,w].
  20505. */
  20506. readonly orientation: Nullable<Float32Array>;
  20507. /**
  20508. * The angularVelocity of the device, values in array are [x,y,z].
  20509. */
  20510. readonly angularVelocity: Nullable<Float32Array>;
  20511. /**
  20512. * The angularAcceleration of the device, values in array are [x,y,z].
  20513. */
  20514. readonly angularAcceleration: Nullable<Float32Array>;
  20515. }
  20516. /**
  20517. * Interface representing a pose controlled object in Babylon.
  20518. * A pose controlled object has both regular pose values as well as pose values
  20519. * from an external device such as a VR head mounted display
  20520. */
  20521. export interface PoseControlled {
  20522. /**
  20523. * The position of the object in babylon space.
  20524. */
  20525. position: Vector3;
  20526. /**
  20527. * The rotation quaternion of the object in babylon space.
  20528. */
  20529. rotationQuaternion: Quaternion;
  20530. /**
  20531. * The position of the device in babylon space.
  20532. */
  20533. devicePosition?: Vector3;
  20534. /**
  20535. * The rotation quaternion of the device in babylon space.
  20536. */
  20537. deviceRotationQuaternion: Quaternion;
  20538. /**
  20539. * The raw pose coming from the device.
  20540. */
  20541. rawPose: Nullable<DevicePose>;
  20542. /**
  20543. * The scale of the device to be used when translating from device space to babylon space.
  20544. */
  20545. deviceScaleFactor: number;
  20546. /**
  20547. * Updates the poseControlled values based on the input device pose.
  20548. * @param poseData the pose data to update the object with
  20549. */
  20550. updateFromDevice(poseData: DevicePose): void;
  20551. }
  20552. /**
  20553. * Set of options to customize the webVRCamera
  20554. */
  20555. export interface WebVROptions {
  20556. /**
  20557. * Sets if the webVR camera should be tracked to the vrDevice. (default: true)
  20558. */
  20559. trackPosition?: boolean;
  20560. /**
  20561. * Sets the scale of the vrDevice in babylon space. (default: 1)
  20562. */
  20563. positionScale?: number;
  20564. /**
  20565. * If there are more than one VRDisplays, this will choose the display matching this name. (default: pick first vrDisplay)
  20566. */
  20567. displayName?: string;
  20568. /**
  20569. * Should the native controller meshes be initialized. (default: true)
  20570. */
  20571. controllerMeshes?: boolean;
  20572. /**
  20573. * Creating a default HemiLight only on controllers. (default: true)
  20574. */
  20575. defaultLightingOnControllers?: boolean;
  20576. /**
  20577. * If you don't want to use the default VR button of the helper. (default: false)
  20578. */
  20579. useCustomVRButton?: boolean;
  20580. /**
  20581. * If you'd like to provide your own button to the VRHelper. (default: standard babylon vr button)
  20582. */
  20583. customVRButton?: HTMLButtonElement;
  20584. /**
  20585. * To change the length of the ray for gaze/controllers. Will be scaled by positionScale. (default: 100)
  20586. */
  20587. rayLength?: number;
  20588. /**
  20589. * To change the default offset from the ground to account for user's height in meters. Will be scaled by positionScale. (default: 1.7)
  20590. */
  20591. defaultHeight?: number;
  20592. /**
  20593. * If multiview should be used if availible (default: false)
  20594. */
  20595. useMultiview?: boolean;
  20596. }
  20597. /**
  20598. * This represents a WebVR camera.
  20599. * The WebVR camera is Babylon's simple interface to interaction with Windows Mixed Reality, HTC Vive and Oculus Rift.
  20600. * @example https://doc.babylonjs.com/how_to/webvr_camera
  20601. */
  20602. export class WebVRFreeCamera extends FreeCamera implements PoseControlled {
  20603. private webVROptions;
  20604. /**
  20605. * @hidden
  20606. * The vrDisplay tied to the camera. See https://developer.mozilla.org/en-US/docs/Web/API/VRDisplay
  20607. */
  20608. _vrDevice: any;
  20609. /**
  20610. * The rawPose of the vrDevice.
  20611. */
  20612. rawPose: Nullable<DevicePose>;
  20613. private _onVREnabled;
  20614. private _specsVersion;
  20615. private _attached;
  20616. private _frameData;
  20617. protected _descendants: Array<Node>;
  20618. private _deviceRoomPosition;
  20619. /** @hidden */
  20620. _deviceRoomRotationQuaternion: Quaternion;
  20621. private _standingMatrix;
  20622. /**
  20623. * Represents device position in babylon space.
  20624. */
  20625. devicePosition: Vector3;
  20626. /**
  20627. * Represents device rotation in babylon space.
  20628. */
  20629. deviceRotationQuaternion: Quaternion;
  20630. /**
  20631. * The scale of the device to be used when translating from device space to babylon space.
  20632. */
  20633. deviceScaleFactor: number;
  20634. private _deviceToWorld;
  20635. private _worldToDevice;
  20636. /**
  20637. * References to the webVR controllers for the vrDevice.
  20638. */
  20639. controllers: Array<WebVRController>;
  20640. /**
  20641. * Emits an event when a controller is attached.
  20642. */
  20643. onControllersAttachedObservable: Observable<WebVRController[]>;
  20644. /**
  20645. * Emits an event when a controller's mesh has been loaded;
  20646. */
  20647. onControllerMeshLoadedObservable: Observable<WebVRController>;
  20648. /**
  20649. * Emits an event when the HMD's pose has been updated.
  20650. */
  20651. onPoseUpdatedFromDeviceObservable: Observable<any>;
  20652. private _poseSet;
  20653. /**
  20654. * If the rig cameras be used as parent instead of this camera.
  20655. */
  20656. rigParenting: boolean;
  20657. private _lightOnControllers;
  20658. private _defaultHeight?;
  20659. /**
  20660. * Instantiates a WebVRFreeCamera.
  20661. * @param name The name of the WebVRFreeCamera
  20662. * @param position The starting anchor position for the camera
  20663. * @param scene The scene the camera belongs to
  20664. * @param webVROptions a set of customizable options for the webVRCamera
  20665. */
  20666. constructor(name: string, position: Vector3, scene: Scene, webVROptions?: WebVROptions);
  20667. /**
  20668. * Gets the device distance from the ground in meters.
  20669. * @returns the distance in meters from the vrDevice to ground in device space. If standing matrix is not supported for the vrDevice 0 is returned.
  20670. */
  20671. deviceDistanceToRoomGround(): number;
  20672. /**
  20673. * Enables the standing matrix when supported. This can be used to position the user's view the correct height from the ground.
  20674. * @param callback will be called when the standing matrix is set. Callback parameter is if the standing matrix is supported.
  20675. */
  20676. useStandingMatrix(callback?: (bool: boolean) => void): void;
  20677. /**
  20678. * Enables the standing matrix when supported. This can be used to position the user's view the correct height from the ground.
  20679. * @returns A promise with a boolean set to if the standing matrix is supported.
  20680. */
  20681. useStandingMatrixAsync(): Promise<boolean>;
  20682. /**
  20683. * Disposes the camera
  20684. */
  20685. dispose(): void;
  20686. /**
  20687. * Gets a vrController by name.
  20688. * @param name The name of the controller to retreive
  20689. * @returns the controller matching the name specified or null if not found
  20690. */
  20691. getControllerByName(name: string): Nullable<WebVRController>;
  20692. private _leftController;
  20693. /**
  20694. * The controller corresponding to the users left hand.
  20695. */
  20696. get leftController(): Nullable<WebVRController>;
  20697. private _rightController;
  20698. /**
  20699. * The controller corresponding to the users right hand.
  20700. */
  20701. get rightController(): Nullable<WebVRController>;
  20702. /**
  20703. * Casts a ray forward from the vrCamera's gaze.
  20704. * @param length Length of the ray (default: 100)
  20705. * @returns the ray corresponding to the gaze
  20706. */
  20707. getForwardRay(length?: number): Ray;
  20708. /**
  20709. * @hidden
  20710. * Updates the camera based on device's frame data
  20711. */
  20712. _checkInputs(): void;
  20713. /**
  20714. * Updates the poseControlled values based on the input device pose.
  20715. * @param poseData Pose coming from the device
  20716. */
  20717. updateFromDevice(poseData: DevicePose): void;
  20718. private _htmlElementAttached;
  20719. private _detachIfAttached;
  20720. /**
  20721. * WebVR's attach control will start broadcasting frames to the device.
  20722. * Note that in certain browsers (chrome for example) this function must be called
  20723. * within a user-interaction callback. Example:
  20724. * <pre> scene.onPointerDown = function() { camera.attachControl(canvas); }</pre>
  20725. *
  20726. * @param element html element to attach the vrDevice to
  20727. * @param noPreventDefault prevent the default html element operation when attaching the vrDevice
  20728. */
  20729. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  20730. /**
  20731. * Detaches the camera from the html element and disables VR
  20732. *
  20733. * @param element html element to detach from
  20734. */
  20735. detachControl(element: HTMLElement): void;
  20736. /**
  20737. * @returns the name of this class
  20738. */
  20739. getClassName(): string;
  20740. /**
  20741. * Calls resetPose on the vrDisplay
  20742. * See: https://developer.mozilla.org/en-US/docs/Web/API/VRDisplay/resetPose
  20743. */
  20744. resetToCurrentRotation(): void;
  20745. /**
  20746. * @hidden
  20747. * Updates the rig cameras (left and right eye)
  20748. */
  20749. _updateRigCameras(): void;
  20750. private _workingVector;
  20751. private _oneVector;
  20752. private _workingMatrix;
  20753. private updateCacheCalled;
  20754. private _correctPositionIfNotTrackPosition;
  20755. /**
  20756. * @hidden
  20757. * Updates the cached values of the camera
  20758. * @param ignoreParentClass ignores updating the parent class's cache (default: false)
  20759. */
  20760. _updateCache(ignoreParentClass?: boolean): void;
  20761. /**
  20762. * @hidden
  20763. * Get current device position in babylon world
  20764. */
  20765. _computeDevicePosition(): void;
  20766. /**
  20767. * Updates the current device position and rotation in the babylon world
  20768. */
  20769. update(): void;
  20770. /**
  20771. * @hidden
  20772. * Gets the view matrix of this camera (Always set to identity as left and right eye cameras contain the actual view matrix)
  20773. * @returns an identity matrix
  20774. */
  20775. _getViewMatrix(): Matrix;
  20776. private _tmpMatrix;
  20777. /**
  20778. * This function is called by the two RIG cameras.
  20779. * 'this' is the left or right camera (and NOT (!!!) the WebVRFreeCamera instance)
  20780. * @hidden
  20781. */
  20782. _getWebVRViewMatrix(): Matrix;
  20783. /** @hidden */
  20784. _getWebVRProjectionMatrix(): Matrix;
  20785. private _onGamepadConnectedObserver;
  20786. private _onGamepadDisconnectedObserver;
  20787. private _updateCacheWhenTrackingDisabledObserver;
  20788. /**
  20789. * Initializes the controllers and their meshes
  20790. */
  20791. initControllers(): void;
  20792. }
  20793. }
  20794. declare module "babylonjs/Materials/materialHelper" {
  20795. import { Nullable } from "babylonjs/types";
  20796. import { Scene } from "babylonjs/scene";
  20797. import { Engine } from "babylonjs/Engines/engine";
  20798. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  20799. import { Light } from "babylonjs/Lights/light";
  20800. import { UniformBuffer } from "babylonjs/Materials/uniformBuffer";
  20801. import { Effect, IEffectCreationOptions } from "babylonjs/Materials/effect";
  20802. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  20803. import { MaterialDefines } from "babylonjs/Materials/materialDefines";
  20804. import { EffectFallbacks } from "babylonjs/Materials/effectFallbacks";
  20805. /**
  20806. * "Static Class" containing the most commonly used helper while dealing with material for rendering purpose.
  20807. *
  20808. * It contains the basic tools to help defining defines, binding uniform for the common part of the materials.
  20809. *
  20810. * This works by convention in BabylonJS but is meant to be use only with shader following the in place naming rules and conventions.
  20811. */
  20812. export class MaterialHelper {
  20813. /**
  20814. * Bind the current view position to an effect.
  20815. * @param effect The effect to be bound
  20816. * @param scene The scene the eyes position is used from
  20817. * @param variableName name of the shader variable that will hold the eye position
  20818. */
  20819. static BindEyePosition(effect: Effect, scene: Scene, variableName?: string): void;
  20820. /**
  20821. * Helps preparing the defines values about the UVs in used in the effect.
  20822. * UVs are shared as much as we can accross channels in the shaders.
  20823. * @param texture The texture we are preparing the UVs for
  20824. * @param defines The defines to update
  20825. * @param key The channel key "diffuse", "specular"... used in the shader
  20826. */
  20827. static PrepareDefinesForMergedUV(texture: BaseTexture, defines: any, key: string): void;
  20828. /**
  20829. * Binds a texture matrix value to its corrsponding uniform
  20830. * @param texture The texture to bind the matrix for
  20831. * @param uniformBuffer The uniform buffer receivin the data
  20832. * @param key The channel key "diffuse", "specular"... used in the shader
  20833. */
  20834. static BindTextureMatrix(texture: BaseTexture, uniformBuffer: UniformBuffer, key: string): void;
  20835. /**
  20836. * Gets the current status of the fog (should it be enabled?)
  20837. * @param mesh defines the mesh to evaluate for fog support
  20838. * @param scene defines the hosting scene
  20839. * @returns true if fog must be enabled
  20840. */
  20841. static GetFogState(mesh: AbstractMesh, scene: Scene): boolean;
  20842. /**
  20843. * Helper used to prepare the list of defines associated with misc. values for shader compilation
  20844. * @param mesh defines the current mesh
  20845. * @param scene defines the current scene
  20846. * @param useLogarithmicDepth defines if logarithmic depth has to be turned on
  20847. * @param pointsCloud defines if point cloud rendering has to be turned on
  20848. * @param fogEnabled defines if fog has to be turned on
  20849. * @param alphaTest defines if alpha testing has to be turned on
  20850. * @param defines defines the current list of defines
  20851. */
  20852. static PrepareDefinesForMisc(mesh: AbstractMesh, scene: Scene, useLogarithmicDepth: boolean, pointsCloud: boolean, fogEnabled: boolean, alphaTest: boolean, defines: any): void;
  20853. /**
  20854. * Helper used to prepare the list of defines associated with frame values for shader compilation
  20855. * @param scene defines the current scene
  20856. * @param engine defines the current engine
  20857. * @param defines specifies the list of active defines
  20858. * @param useInstances defines if instances have to be turned on
  20859. * @param useClipPlane defines if clip plane have to be turned on
  20860. * @param useInstances defines if instances have to be turned on
  20861. * @param useThinInstances defines if thin instances have to be turned on
  20862. */
  20863. static PrepareDefinesForFrameBoundValues(scene: Scene, engine: Engine, defines: any, useInstances: boolean, useClipPlane?: Nullable<boolean>, useThinInstances?: boolean): void;
  20864. /**
  20865. * Prepares the defines for bones
  20866. * @param mesh The mesh containing the geometry data we will draw
  20867. * @param defines The defines to update
  20868. */
  20869. static PrepareDefinesForBones(mesh: AbstractMesh, defines: any): void;
  20870. /**
  20871. * Prepares the defines for morph targets
  20872. * @param mesh The mesh containing the geometry data we will draw
  20873. * @param defines The defines to update
  20874. */
  20875. static PrepareDefinesForMorphTargets(mesh: AbstractMesh, defines: any): void;
  20876. /**
  20877. * Prepares the defines used in the shader depending on the attributes data available in the mesh
  20878. * @param mesh The mesh containing the geometry data we will draw
  20879. * @param defines The defines to update
  20880. * @param useVertexColor Precise whether vertex colors should be used or not (override mesh info)
  20881. * @param useBones Precise whether bones should be used or not (override mesh info)
  20882. * @param useMorphTargets Precise whether morph targets should be used or not (override mesh info)
  20883. * @param useVertexAlpha Precise whether vertex alpha should be used or not (override mesh info)
  20884. * @returns false if defines are considered not dirty and have not been checked
  20885. */
  20886. static PrepareDefinesForAttributes(mesh: AbstractMesh, defines: any, useVertexColor: boolean, useBones: boolean, useMorphTargets?: boolean, useVertexAlpha?: boolean): boolean;
  20887. /**
  20888. * Prepares the defines related to multiview
  20889. * @param scene The scene we are intending to draw
  20890. * @param defines The defines to update
  20891. */
  20892. static PrepareDefinesForMultiview(scene: Scene, defines: any): void;
  20893. /**
  20894. * Prepares the defines related to the prepass
  20895. * @param scene The scene we are intending to draw
  20896. * @param defines The defines to update
  20897. * @param canRenderToMRT Indicates if this material renders to several textures in the prepass
  20898. */
  20899. static PrepareDefinesForPrePass(scene: Scene, defines: any, canRenderToMRT: boolean): void;
  20900. /**
  20901. * Prepares the defines related to the light information passed in parameter
  20902. * @param scene The scene we are intending to draw
  20903. * @param mesh The mesh the effect is compiling for
  20904. * @param light The light the effect is compiling for
  20905. * @param lightIndex The index of the light
  20906. * @param defines The defines to update
  20907. * @param specularSupported Specifies whether specular is supported or not (override lights data)
  20908. * @param state Defines the current state regarding what is needed (normals, etc...)
  20909. */
  20910. static PrepareDefinesForLight(scene: Scene, mesh: AbstractMesh, light: Light, lightIndex: number, defines: any, specularSupported: boolean, state: {
  20911. needNormals: boolean;
  20912. needRebuild: boolean;
  20913. shadowEnabled: boolean;
  20914. specularEnabled: boolean;
  20915. lightmapMode: boolean;
  20916. }): void;
  20917. /**
  20918. * Prepares the defines related to the light information passed in parameter
  20919. * @param scene The scene we are intending to draw
  20920. * @param mesh The mesh the effect is compiling for
  20921. * @param defines The defines to update
  20922. * @param specularSupported Specifies whether specular is supported or not (override lights data)
  20923. * @param maxSimultaneousLights Specfies how manuy lights can be added to the effect at max
  20924. * @param disableLighting Specifies whether the lighting is disabled (override scene and light)
  20925. * @returns true if normals will be required for the rest of the effect
  20926. */
  20927. static PrepareDefinesForLights(scene: Scene, mesh: AbstractMesh, defines: any, specularSupported: boolean, maxSimultaneousLights?: number, disableLighting?: boolean): boolean;
  20928. /**
  20929. * Prepares the uniforms and samplers list to be used in the effect (for a specific light)
  20930. * @param lightIndex defines the light index
  20931. * @param uniformsList The uniform list
  20932. * @param samplersList The sampler list
  20933. * @param projectedLightTexture defines if projected texture must be used
  20934. * @param uniformBuffersList defines an optional list of uniform buffers
  20935. */
  20936. static PrepareUniformsAndSamplersForLight(lightIndex: number, uniformsList: string[], samplersList: string[], projectedLightTexture?: any, uniformBuffersList?: Nullable<string[]>): void;
  20937. /**
  20938. * Prepares the uniforms and samplers list to be used in the effect
  20939. * @param uniformsListOrOptions The uniform names to prepare or an EffectCreationOptions containing the liist and extra information
  20940. * @param samplersList The sampler list
  20941. * @param defines The defines helping in the list generation
  20942. * @param maxSimultaneousLights The maximum number of simultanous light allowed in the effect
  20943. */
  20944. static PrepareUniformsAndSamplersList(uniformsListOrOptions: string[] | IEffectCreationOptions, samplersList?: string[], defines?: any, maxSimultaneousLights?: number): void;
  20945. /**
  20946. * This helps decreasing rank by rank the shadow quality (0 being the highest rank and quality)
  20947. * @param defines The defines to update while falling back
  20948. * @param fallbacks The authorized effect fallbacks
  20949. * @param maxSimultaneousLights The maximum number of lights allowed
  20950. * @param rank the current rank of the Effect
  20951. * @returns The newly affected rank
  20952. */
  20953. static HandleFallbacksForShadows(defines: any, fallbacks: EffectFallbacks, maxSimultaneousLights?: number, rank?: number): number;
  20954. private static _TmpMorphInfluencers;
  20955. /**
  20956. * Prepares the list of attributes required for morph targets according to the effect defines.
  20957. * @param attribs The current list of supported attribs
  20958. * @param mesh The mesh to prepare the morph targets attributes for
  20959. * @param influencers The number of influencers
  20960. */
  20961. static PrepareAttributesForMorphTargetsInfluencers(attribs: string[], mesh: AbstractMesh, influencers: number): void;
  20962. /**
  20963. * Prepares the list of attributes required for morph targets according to the effect defines.
  20964. * @param attribs The current list of supported attribs
  20965. * @param mesh The mesh to prepare the morph targets attributes for
  20966. * @param defines The current Defines of the effect
  20967. */
  20968. static PrepareAttributesForMorphTargets(attribs: string[], mesh: AbstractMesh, defines: any): void;
  20969. /**
  20970. * Prepares the list of attributes required for bones according to the effect defines.
  20971. * @param attribs The current list of supported attribs
  20972. * @param mesh The mesh to prepare the bones attributes for
  20973. * @param defines The current Defines of the effect
  20974. * @param fallbacks The current efffect fallback strategy
  20975. */
  20976. static PrepareAttributesForBones(attribs: string[], mesh: AbstractMesh, defines: any, fallbacks: EffectFallbacks): void;
  20977. /**
  20978. * Check and prepare the list of attributes required for instances according to the effect defines.
  20979. * @param attribs The current list of supported attribs
  20980. * @param defines The current MaterialDefines of the effect
  20981. */
  20982. static PrepareAttributesForInstances(attribs: string[], defines: MaterialDefines): void;
  20983. /**
  20984. * Add the list of attributes required for instances to the attribs array.
  20985. * @param attribs The current list of supported attribs
  20986. */
  20987. static PushAttributesForInstances(attribs: string[]): void;
  20988. /**
  20989. * Binds the light information to the effect.
  20990. * @param light The light containing the generator
  20991. * @param effect The effect we are binding the data to
  20992. * @param lightIndex The light index in the effect used to render
  20993. */
  20994. static BindLightProperties(light: Light, effect: Effect, lightIndex: number): void;
  20995. /**
  20996. * Binds the lights information from the scene to the effect for the given mesh.
  20997. * @param light Light to bind
  20998. * @param lightIndex Light index
  20999. * @param scene The scene where the light belongs to
  21000. * @param effect The effect we are binding the data to
  21001. * @param useSpecular Defines if specular is supported
  21002. * @param rebuildInParallel Specifies whether the shader is rebuilding in parallel
  21003. */
  21004. static BindLight(light: Light, lightIndex: number, scene: Scene, effect: Effect, useSpecular: boolean, rebuildInParallel?: boolean): void;
  21005. /**
  21006. * Binds the lights information from the scene to the effect for the given mesh.
  21007. * @param scene The scene the lights belongs to
  21008. * @param mesh The mesh we are binding the information to render
  21009. * @param effect The effect we are binding the data to
  21010. * @param defines The generated defines for the effect
  21011. * @param maxSimultaneousLights The maximum number of light that can be bound to the effect
  21012. * @param rebuildInParallel Specifies whether the shader is rebuilding in parallel
  21013. */
  21014. static BindLights(scene: Scene, mesh: AbstractMesh, effect: Effect, defines: any, maxSimultaneousLights?: number, rebuildInParallel?: boolean): void;
  21015. private static _tempFogColor;
  21016. /**
  21017. * Binds the fog information from the scene to the effect for the given mesh.
  21018. * @param scene The scene the lights belongs to
  21019. * @param mesh The mesh we are binding the information to render
  21020. * @param effect The effect we are binding the data to
  21021. * @param linearSpace Defines if the fog effect is applied in linear space
  21022. */
  21023. static BindFogParameters(scene: Scene, mesh: AbstractMesh, effect: Effect, linearSpace?: boolean): void;
  21024. /**
  21025. * Binds the bones information from the mesh to the effect.
  21026. * @param mesh The mesh we are binding the information to render
  21027. * @param effect The effect we are binding the data to
  21028. */
  21029. static BindBonesParameters(mesh?: AbstractMesh, effect?: Effect): void;
  21030. /**
  21031. * Binds the morph targets information from the mesh to the effect.
  21032. * @param abstractMesh The mesh we are binding the information to render
  21033. * @param effect The effect we are binding the data to
  21034. */
  21035. static BindMorphTargetParameters(abstractMesh: AbstractMesh, effect: Effect): void;
  21036. /**
  21037. * Binds the logarithmic depth information from the scene to the effect for the given defines.
  21038. * @param defines The generated defines used in the effect
  21039. * @param effect The effect we are binding the data to
  21040. * @param scene The scene we are willing to render with logarithmic scale for
  21041. */
  21042. static BindLogDepth(defines: any, effect: Effect, scene: Scene): void;
  21043. /**
  21044. * Binds the clip plane information from the scene to the effect.
  21045. * @param scene The scene the clip plane information are extracted from
  21046. * @param effect The effect we are binding the data to
  21047. */
  21048. static BindClipPlane(effect: Effect, scene: Scene): void;
  21049. }
  21050. }
  21051. declare module "babylonjs/Materials/Node/Blocks/Input/inputBlock" {
  21052. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  21053. import { NodeMaterialBlockConnectionPointTypes } from "babylonjs/Materials/Node/Enums/nodeMaterialBlockConnectionPointTypes";
  21054. import { NodeMaterialSystemValues } from "babylonjs/Materials/Node/Enums/nodeMaterialSystemValues";
  21055. import { Nullable } from "babylonjs/types";
  21056. import { Effect } from "babylonjs/Materials/effect";
  21057. import { Matrix } from "babylonjs/Maths/math.vector";
  21058. import { Scene } from "babylonjs/scene";
  21059. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  21060. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  21061. import { NodeMaterialBlockTargets } from "babylonjs/Materials/Node/Enums/nodeMaterialBlockTargets";
  21062. import { AnimatedInputBlockTypes } from "babylonjs/Materials/Node/Blocks/Input/animatedInputBlockTypes";
  21063. import { Observable } from "babylonjs/Misc/observable";
  21064. /**
  21065. * Block used to expose an input value
  21066. */
  21067. export class InputBlock extends NodeMaterialBlock {
  21068. private _mode;
  21069. private _associatedVariableName;
  21070. private _storedValue;
  21071. private _valueCallback;
  21072. private _type;
  21073. private _animationType;
  21074. /** Gets or set a value used to limit the range of float values */
  21075. min: number;
  21076. /** Gets or set a value used to limit the range of float values */
  21077. max: number;
  21078. /** Gets or set a value indicating that this input can only get 0 and 1 values */
  21079. isBoolean: boolean;
  21080. /** Gets or sets a value used by the Node Material editor to determine how to configure the current value if it is a matrix */
  21081. matrixMode: number;
  21082. /** @hidden */
  21083. _systemValue: Nullable<NodeMaterialSystemValues>;
  21084. /** Gets or sets a boolean indicating that this input can be edited in the Inspector (false by default) */
  21085. visibleInInspector: boolean;
  21086. /** Gets or sets a boolean indicating that the value of this input will not change after a build */
  21087. isConstant: boolean;
  21088. /** Gets or sets the group to use to display this block in the Inspector */
  21089. groupInInspector: string;
  21090. /** Gets an observable raised when the value is changed */
  21091. onValueChangedObservable: Observable<InputBlock>;
  21092. /**
  21093. * Gets or sets the connection point type (default is float)
  21094. */
  21095. get type(): NodeMaterialBlockConnectionPointTypes;
  21096. /**
  21097. * Creates a new InputBlock
  21098. * @param name defines the block name
  21099. * @param target defines the target of that block (Vertex by default)
  21100. * @param type defines the type of the input (can be set to NodeMaterialBlockConnectionPointTypes.AutoDetect)
  21101. */
  21102. constructor(name: string, target?: NodeMaterialBlockTargets, type?: NodeMaterialBlockConnectionPointTypes);
  21103. /**
  21104. * Validates if a name is a reserve word.
  21105. * @param newName the new name to be given to the node.
  21106. * @returns false if the name is a reserve word, else true.
  21107. */
  21108. validateBlockName(newName: string): boolean;
  21109. /**
  21110. * Gets the output component
  21111. */
  21112. get output(): NodeMaterialConnectionPoint;
  21113. /**
  21114. * Set the source of this connection point to a vertex attribute
  21115. * @param attributeName defines the attribute name (position, uv, normal, etc...). If not specified it will take the connection point name
  21116. * @returns the current connection point
  21117. */
  21118. setAsAttribute(attributeName?: string): InputBlock;
  21119. /**
  21120. * Set the source of this connection point to a system value
  21121. * @param value define the system value to use (world, view, etc...) or null to switch to manual value
  21122. * @returns the current connection point
  21123. */
  21124. setAsSystemValue(value: Nullable<NodeMaterialSystemValues>): InputBlock;
  21125. /**
  21126. * Gets or sets the value of that point.
  21127. * Please note that this value will be ignored if valueCallback is defined
  21128. */
  21129. get value(): any;
  21130. set value(value: any);
  21131. /**
  21132. * Gets or sets a callback used to get the value of that point.
  21133. * Please note that setting this value will force the connection point to ignore the value property
  21134. */
  21135. get valueCallback(): () => any;
  21136. set valueCallback(value: () => any);
  21137. /**
  21138. * Gets or sets the associated variable name in the shader
  21139. */
  21140. get associatedVariableName(): string;
  21141. set associatedVariableName(value: string);
  21142. /** Gets or sets the type of animation applied to the input */
  21143. get animationType(): AnimatedInputBlockTypes;
  21144. set animationType(value: AnimatedInputBlockTypes);
  21145. /**
  21146. * Gets a boolean indicating that this connection point not defined yet
  21147. */
  21148. get isUndefined(): boolean;
  21149. /**
  21150. * Gets or sets a boolean indicating that this connection point is coming from an uniform.
  21151. * In this case the connection point name must be the name of the uniform to use.
  21152. * Can only be set on inputs
  21153. */
  21154. get isUniform(): boolean;
  21155. set isUniform(value: boolean);
  21156. /**
  21157. * Gets or sets a boolean indicating that this connection point is coming from an attribute.
  21158. * In this case the connection point name must be the name of the attribute to use
  21159. * Can only be set on inputs
  21160. */
  21161. get isAttribute(): boolean;
  21162. set isAttribute(value: boolean);
  21163. /**
  21164. * Gets or sets a boolean indicating that this connection point is generating a varying variable.
  21165. * Can only be set on exit points
  21166. */
  21167. get isVarying(): boolean;
  21168. set isVarying(value: boolean);
  21169. /**
  21170. * Gets a boolean indicating that the current connection point is a system value
  21171. */
  21172. get isSystemValue(): boolean;
  21173. /**
  21174. * Gets or sets the current well known value or null if not defined as a system value
  21175. */
  21176. get systemValue(): Nullable<NodeMaterialSystemValues>;
  21177. set systemValue(value: Nullable<NodeMaterialSystemValues>);
  21178. /**
  21179. * Gets the current class name
  21180. * @returns the class name
  21181. */
  21182. getClassName(): string;
  21183. /**
  21184. * Animate the input if animationType !== None
  21185. * @param scene defines the rendering scene
  21186. */
  21187. animate(scene: Scene): void;
  21188. private _emitDefine;
  21189. initialize(state: NodeMaterialBuildState): void;
  21190. /**
  21191. * Set the input block to its default value (based on its type)
  21192. */
  21193. setDefaultValue(): void;
  21194. private _emitConstant;
  21195. /** @hidden */
  21196. get _noContextSwitch(): boolean;
  21197. private _emit;
  21198. /** @hidden */
  21199. _transmitWorld(effect: Effect, world: Matrix, worldView: Matrix, worldViewProjection: Matrix): void;
  21200. /** @hidden */
  21201. _transmit(effect: Effect, scene: Scene): void;
  21202. protected _buildBlock(state: NodeMaterialBuildState): void;
  21203. protected _dumpPropertiesCode(): string;
  21204. dispose(): void;
  21205. serialize(): any;
  21206. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  21207. }
  21208. }
  21209. declare module "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint" {
  21210. import { NodeMaterialBlockConnectionPointTypes } from "babylonjs/Materials/Node/Enums/nodeMaterialBlockConnectionPointTypes";
  21211. import { NodeMaterialBlockTargets } from "babylonjs/Materials/Node/Enums/nodeMaterialBlockTargets";
  21212. import { Nullable } from "babylonjs/types";
  21213. import { InputBlock } from "babylonjs/Materials/Node/Blocks/Input/inputBlock";
  21214. import { Observable } from "babylonjs/Misc/observable";
  21215. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  21216. /**
  21217. * Enum used to define the compatibility state between two connection points
  21218. */
  21219. export enum NodeMaterialConnectionPointCompatibilityStates {
  21220. /** Points are compatibles */
  21221. Compatible = 0,
  21222. /** Points are incompatible because of their types */
  21223. TypeIncompatible = 1,
  21224. /** Points are incompatible because of their targets (vertex vs fragment) */
  21225. TargetIncompatible = 2
  21226. }
  21227. /**
  21228. * Defines the direction of a connection point
  21229. */
  21230. export enum NodeMaterialConnectionPointDirection {
  21231. /** Input */
  21232. Input = 0,
  21233. /** Output */
  21234. Output = 1
  21235. }
  21236. /**
  21237. * Defines a connection point for a block
  21238. */
  21239. export class NodeMaterialConnectionPoint {
  21240. /** @hidden */
  21241. _ownerBlock: NodeMaterialBlock;
  21242. /** @hidden */
  21243. _connectedPoint: Nullable<NodeMaterialConnectionPoint>;
  21244. private _endpoints;
  21245. private _associatedVariableName;
  21246. private _direction;
  21247. /** @hidden */
  21248. _typeConnectionSource: Nullable<NodeMaterialConnectionPoint>;
  21249. /** @hidden */
  21250. _linkedConnectionSource: Nullable<NodeMaterialConnectionPoint>;
  21251. private _type;
  21252. /** @hidden */
  21253. _enforceAssociatedVariableName: boolean;
  21254. /** Gets the direction of the point */
  21255. get direction(): NodeMaterialConnectionPointDirection;
  21256. /** Indicates that this connection point needs dual validation before being connected to another point */
  21257. needDualDirectionValidation: boolean;
  21258. /**
  21259. * Gets or sets the additional types supported by this connection point
  21260. */
  21261. acceptedConnectionPointTypes: NodeMaterialBlockConnectionPointTypes[];
  21262. /**
  21263. * Gets or sets the additional types excluded by this connection point
  21264. */
  21265. excludedConnectionPointTypes: NodeMaterialBlockConnectionPointTypes[];
  21266. /**
  21267. * Observable triggered when this point is connected
  21268. */
  21269. onConnectionObservable: Observable<NodeMaterialConnectionPoint>;
  21270. /**
  21271. * Gets or sets the associated variable name in the shader
  21272. */
  21273. get associatedVariableName(): string;
  21274. set associatedVariableName(value: string);
  21275. /** Get the inner type (ie AutoDetect for instance instead of the inferred one) */
  21276. get innerType(): NodeMaterialBlockConnectionPointTypes;
  21277. /**
  21278. * Gets or sets the connection point type (default is float)
  21279. */
  21280. get type(): NodeMaterialBlockConnectionPointTypes;
  21281. set type(value: NodeMaterialBlockConnectionPointTypes);
  21282. /**
  21283. * Gets or sets the connection point name
  21284. */
  21285. name: string;
  21286. /**
  21287. * Gets or sets the connection point name
  21288. */
  21289. displayName: string;
  21290. /**
  21291. * Gets or sets a boolean indicating that this connection point can be omitted
  21292. */
  21293. isOptional: boolean;
  21294. /**
  21295. * Gets or sets a boolean indicating that this connection point is exposed on a frame
  21296. */
  21297. isExposedOnFrame: boolean;
  21298. /**
  21299. * Gets or sets a string indicating that this uniform must be defined under a #ifdef
  21300. */
  21301. define: string;
  21302. /** @hidden */
  21303. _prioritizeVertex: boolean;
  21304. private _target;
  21305. /** Gets or sets the target of that connection point */
  21306. get target(): NodeMaterialBlockTargets;
  21307. set target(value: NodeMaterialBlockTargets);
  21308. /**
  21309. * Gets a boolean indicating that the current point is connected to another NodeMaterialBlock
  21310. */
  21311. get isConnected(): boolean;
  21312. /**
  21313. * Gets a boolean indicating that the current point is connected to an input block
  21314. */
  21315. get isConnectedToInputBlock(): boolean;
  21316. /**
  21317. * Gets a the connected input block (if any)
  21318. */
  21319. get connectInputBlock(): Nullable<InputBlock>;
  21320. /** Get the other side of the connection (if any) */
  21321. get connectedPoint(): Nullable<NodeMaterialConnectionPoint>;
  21322. /** Get the block that owns this connection point */
  21323. get ownerBlock(): NodeMaterialBlock;
  21324. /** Get the block connected on the other side of this connection (if any) */
  21325. get sourceBlock(): Nullable<NodeMaterialBlock>;
  21326. /** Get the block connected on the endpoints of this connection (if any) */
  21327. get connectedBlocks(): Array<NodeMaterialBlock>;
  21328. /** Gets the list of connected endpoints */
  21329. get endpoints(): NodeMaterialConnectionPoint[];
  21330. /** Gets a boolean indicating if that output point is connected to at least one input */
  21331. get hasEndpoints(): boolean;
  21332. /** Gets a boolean indicating that this connection will be used in the vertex shader */
  21333. get isConnectedInVertexShader(): boolean;
  21334. /** Gets a boolean indicating that this connection will be used in the fragment shader */
  21335. get isConnectedInFragmentShader(): boolean;
  21336. /**
  21337. * Creates a block suitable to be used as an input for this input point.
  21338. * If null is returned, a block based on the point type will be created.
  21339. * @returns The returned string parameter is the name of the output point of NodeMaterialBlock (first parameter of the returned array) that can be connected to the input
  21340. */
  21341. createCustomInputBlock(): Nullable<[NodeMaterialBlock, string]>;
  21342. /**
  21343. * Creates a new connection point
  21344. * @param name defines the connection point name
  21345. * @param ownerBlock defines the block hosting this connection point
  21346. * @param direction defines the direction of the connection point
  21347. */
  21348. constructor(name: string, ownerBlock: NodeMaterialBlock, direction: NodeMaterialConnectionPointDirection);
  21349. /**
  21350. * Gets the current class name e.g. "NodeMaterialConnectionPoint"
  21351. * @returns the class name
  21352. */
  21353. getClassName(): string;
  21354. /**
  21355. * Gets a boolean indicating if the current point can be connected to another point
  21356. * @param connectionPoint defines the other connection point
  21357. * @returns a boolean
  21358. */
  21359. canConnectTo(connectionPoint: NodeMaterialConnectionPoint): boolean;
  21360. /**
  21361. * Gets a number indicating if the current point can be connected to another point
  21362. * @param connectionPoint defines the other connection point
  21363. * @returns a number defining the compatibility state
  21364. */
  21365. checkCompatibilityState(connectionPoint: NodeMaterialConnectionPoint): NodeMaterialConnectionPointCompatibilityStates;
  21366. /**
  21367. * Connect this point to another connection point
  21368. * @param connectionPoint defines the other connection point
  21369. * @param ignoreConstraints defines if the system will ignore connection type constraints (default is false)
  21370. * @returns the current connection point
  21371. */
  21372. connectTo(connectionPoint: NodeMaterialConnectionPoint, ignoreConstraints?: boolean): NodeMaterialConnectionPoint;
  21373. /**
  21374. * Disconnect this point from one of his endpoint
  21375. * @param endpoint defines the other connection point
  21376. * @returns the current connection point
  21377. */
  21378. disconnectFrom(endpoint: NodeMaterialConnectionPoint): NodeMaterialConnectionPoint;
  21379. /**
  21380. * Serializes this point in a JSON representation
  21381. * @param isInput defines if the connection point is an input (default is true)
  21382. * @returns the serialized point object
  21383. */
  21384. serialize(isInput?: boolean): any;
  21385. /**
  21386. * Release resources
  21387. */
  21388. dispose(): void;
  21389. }
  21390. }
  21391. declare module "babylonjs/Materials/Node/Enums/nodeMaterialModes" {
  21392. /**
  21393. * Enum used to define the material modes
  21394. */
  21395. export enum NodeMaterialModes {
  21396. /** Regular material */
  21397. Material = 0,
  21398. /** For post process */
  21399. PostProcess = 1,
  21400. /** For particle system */
  21401. Particle = 2
  21402. }
  21403. }
  21404. declare module "babylonjs/Materials/Node/Blocks/Dual/textureBlock" {
  21405. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  21406. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  21407. import { NodeMaterialBlockTargets } from "babylonjs/Materials/Node/Enums/nodeMaterialBlockTargets";
  21408. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  21409. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  21410. import { NodeMaterial, NodeMaterialDefines } from "babylonjs/Materials/Node/nodeMaterial";
  21411. import { Effect } from "babylonjs/Materials/effect";
  21412. import { Mesh } from "babylonjs/Meshes/mesh";
  21413. import { Nullable } from "babylonjs/types";
  21414. import { Texture } from "babylonjs/Materials/Textures/texture";
  21415. import { Scene } from "babylonjs/scene";
  21416. import "babylonjs/Shaders/ShadersInclude/helperFunctions";
  21417. /**
  21418. * Block used to read a texture from a sampler
  21419. */
  21420. export class TextureBlock extends NodeMaterialBlock {
  21421. private _defineName;
  21422. private _linearDefineName;
  21423. private _gammaDefineName;
  21424. private _tempTextureRead;
  21425. private _samplerName;
  21426. private _transformedUVName;
  21427. private _textureTransformName;
  21428. private _textureInfoName;
  21429. private _mainUVName;
  21430. private _mainUVDefineName;
  21431. private _fragmentOnly;
  21432. /**
  21433. * Gets or sets the texture associated with the node
  21434. */
  21435. texture: Nullable<Texture>;
  21436. /**
  21437. * Gets or sets a boolean indicating if content needs to be converted to gamma space
  21438. */
  21439. convertToGammaSpace: boolean;
  21440. /**
  21441. * Gets or sets a boolean indicating if content needs to be converted to linear space
  21442. */
  21443. convertToLinearSpace: boolean;
  21444. /**
  21445. * Create a new TextureBlock
  21446. * @param name defines the block name
  21447. */
  21448. constructor(name: string, fragmentOnly?: boolean);
  21449. /**
  21450. * Gets the current class name
  21451. * @returns the class name
  21452. */
  21453. getClassName(): string;
  21454. /**
  21455. * Gets the uv input component
  21456. */
  21457. get uv(): NodeMaterialConnectionPoint;
  21458. /**
  21459. * Gets the rgba output component
  21460. */
  21461. get rgba(): NodeMaterialConnectionPoint;
  21462. /**
  21463. * Gets the rgb output component
  21464. */
  21465. get rgb(): NodeMaterialConnectionPoint;
  21466. /**
  21467. * Gets the r output component
  21468. */
  21469. get r(): NodeMaterialConnectionPoint;
  21470. /**
  21471. * Gets the g output component
  21472. */
  21473. get g(): NodeMaterialConnectionPoint;
  21474. /**
  21475. * Gets the b output component
  21476. */
  21477. get b(): NodeMaterialConnectionPoint;
  21478. /**
  21479. * Gets the a output component
  21480. */
  21481. get a(): NodeMaterialConnectionPoint;
  21482. get target(): NodeMaterialBlockTargets;
  21483. autoConfigure(material: NodeMaterial): void;
  21484. initializeDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines, useInstances?: boolean): void;
  21485. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  21486. isReady(): boolean;
  21487. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh): void;
  21488. private get _isMixed();
  21489. private _injectVertexCode;
  21490. private _writeTextureRead;
  21491. private _writeOutput;
  21492. protected _buildBlock(state: NodeMaterialBuildState): this | undefined;
  21493. protected _dumpPropertiesCode(): string;
  21494. serialize(): any;
  21495. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  21496. }
  21497. }
  21498. declare module "babylonjs/Shaders/ShadersInclude/reflectionFunction" {
  21499. /** @hidden */
  21500. export var reflectionFunction: {
  21501. name: string;
  21502. shader: string;
  21503. };
  21504. }
  21505. declare module "babylonjs/Materials/Node/Blocks/Dual/reflectionTextureBaseBlock" {
  21506. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  21507. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  21508. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  21509. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  21510. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  21511. import { NodeMaterial, NodeMaterialDefines } from "babylonjs/Materials/Node/nodeMaterial";
  21512. import { Effect } from "babylonjs/Materials/effect";
  21513. import { Mesh } from "babylonjs/Meshes/mesh";
  21514. import { Nullable } from "babylonjs/types";
  21515. import { Scene } from "babylonjs/scene";
  21516. import "babylonjs/Shaders/ShadersInclude/reflectionFunction";
  21517. /**
  21518. * Base block used to read a reflection texture from a sampler
  21519. */
  21520. export abstract class ReflectionTextureBaseBlock extends NodeMaterialBlock {
  21521. /** @hidden */
  21522. _define3DName: string;
  21523. /** @hidden */
  21524. _defineCubicName: string;
  21525. /** @hidden */
  21526. _defineExplicitName: string;
  21527. /** @hidden */
  21528. _defineProjectionName: string;
  21529. /** @hidden */
  21530. _defineLocalCubicName: string;
  21531. /** @hidden */
  21532. _defineSphericalName: string;
  21533. /** @hidden */
  21534. _definePlanarName: string;
  21535. /** @hidden */
  21536. _defineEquirectangularName: string;
  21537. /** @hidden */
  21538. _defineMirroredEquirectangularFixedName: string;
  21539. /** @hidden */
  21540. _defineEquirectangularFixedName: string;
  21541. /** @hidden */
  21542. _defineSkyboxName: string;
  21543. /** @hidden */
  21544. _defineOppositeZ: string;
  21545. /** @hidden */
  21546. _cubeSamplerName: string;
  21547. /** @hidden */
  21548. _2DSamplerName: string;
  21549. protected _positionUVWName: string;
  21550. protected _directionWName: string;
  21551. protected _reflectionVectorName: string;
  21552. /** @hidden */
  21553. _reflectionCoordsName: string;
  21554. /** @hidden */
  21555. _reflectionMatrixName: string;
  21556. protected _reflectionColorName: string;
  21557. /**
  21558. * Gets or sets the texture associated with the node
  21559. */
  21560. texture: Nullable<BaseTexture>;
  21561. /**
  21562. * Create a new ReflectionTextureBaseBlock
  21563. * @param name defines the block name
  21564. */
  21565. constructor(name: string);
  21566. /**
  21567. * Gets the current class name
  21568. * @returns the class name
  21569. */
  21570. getClassName(): string;
  21571. /**
  21572. * Gets the world position input component
  21573. */
  21574. abstract get position(): NodeMaterialConnectionPoint;
  21575. /**
  21576. * Gets the world position input component
  21577. */
  21578. abstract get worldPosition(): NodeMaterialConnectionPoint;
  21579. /**
  21580. * Gets the world normal input component
  21581. */
  21582. abstract get worldNormal(): NodeMaterialConnectionPoint;
  21583. /**
  21584. * Gets the world input component
  21585. */
  21586. abstract get world(): NodeMaterialConnectionPoint;
  21587. /**
  21588. * Gets the camera (or eye) position component
  21589. */
  21590. abstract get cameraPosition(): NodeMaterialConnectionPoint;
  21591. /**
  21592. * Gets the view input component
  21593. */
  21594. abstract get view(): NodeMaterialConnectionPoint;
  21595. protected _getTexture(): Nullable<BaseTexture>;
  21596. autoConfigure(material: NodeMaterial): void;
  21597. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  21598. isReady(): boolean;
  21599. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh): void;
  21600. /**
  21601. * Gets the code to inject in the vertex shader
  21602. * @param state current state of the node material building
  21603. * @returns the shader code
  21604. */
  21605. handleVertexSide(state: NodeMaterialBuildState): string;
  21606. /**
  21607. * Handles the inits for the fragment code path
  21608. * @param state node material build state
  21609. */
  21610. handleFragmentSideInits(state: NodeMaterialBuildState): void;
  21611. /**
  21612. * Generates the reflection coords code for the fragment code path
  21613. * @param worldNormalVarName name of the world normal variable
  21614. * @param worldPos name of the world position variable. If not provided, will use the world position connected to this block
  21615. * @param onlyReflectionVector if true, generates code only for the reflection vector computation, not for the reflection coordinates
  21616. * @returns the shader code
  21617. */
  21618. handleFragmentSideCodeReflectionCoords(worldNormalVarName: string, worldPos?: string, onlyReflectionVector?: boolean): string;
  21619. /**
  21620. * Generates the reflection color code for the fragment code path
  21621. * @param lodVarName name of the lod variable
  21622. * @param swizzleLookupTexture swizzle to use for the final color variable
  21623. * @returns the shader code
  21624. */
  21625. handleFragmentSideCodeReflectionColor(lodVarName?: string, swizzleLookupTexture?: string): string;
  21626. /**
  21627. * Generates the code corresponding to the connected output points
  21628. * @param state node material build state
  21629. * @param varName name of the variable to output
  21630. * @returns the shader code
  21631. */
  21632. writeOutputs(state: NodeMaterialBuildState, varName: string): string;
  21633. protected _buildBlock(state: NodeMaterialBuildState): this;
  21634. protected _dumpPropertiesCode(): string;
  21635. serialize(): any;
  21636. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  21637. }
  21638. }
  21639. declare module "babylonjs/Materials/Node/nodeMaterialConnectionPointCustomObject" {
  21640. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  21641. import { NodeMaterialConnectionPoint, NodeMaterialConnectionPointDirection, NodeMaterialConnectionPointCompatibilityStates } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  21642. import { Nullable } from "babylonjs/types";
  21643. /**
  21644. * Defines a connection point to be used for points with a custom object type
  21645. */
  21646. export class NodeMaterialConnectionPointCustomObject<T extends NodeMaterialBlock> extends NodeMaterialConnectionPoint {
  21647. private _blockType;
  21648. private _blockName;
  21649. private _nameForCheking?;
  21650. /**
  21651. * Creates a new connection point
  21652. * @param name defines the connection point name
  21653. * @param ownerBlock defines the block hosting this connection point
  21654. * @param direction defines the direction of the connection point
  21655. */
  21656. constructor(name: string, ownerBlock: NodeMaterialBlock, direction: NodeMaterialConnectionPointDirection, _blockType: new (...args: any[]) => T, _blockName: string, _nameForCheking?: string | undefined);
  21657. /**
  21658. * Gets a number indicating if the current point can be connected to another point
  21659. * @param connectionPoint defines the other connection point
  21660. * @returns a number defining the compatibility state
  21661. */
  21662. checkCompatibilityState(connectionPoint: NodeMaterialConnectionPoint): NodeMaterialConnectionPointCompatibilityStates;
  21663. /**
  21664. * Creates a block suitable to be used as an input for this input point.
  21665. * If null is returned, a block based on the point type will be created.
  21666. * @returns The returned string parameter is the name of the output point of NodeMaterialBlock (first parameter of the returned array) that can be connected to the input
  21667. */
  21668. createCustomInputBlock(): Nullable<[NodeMaterialBlock, string]>;
  21669. }
  21670. }
  21671. declare module "babylonjs/Materials/Node/nodeMaterialDecorator" {
  21672. /**
  21673. * Enum defining the type of properties that can be edited in the property pages in the NME
  21674. */
  21675. export enum PropertyTypeForEdition {
  21676. /** property is a boolean */
  21677. Boolean = 0,
  21678. /** property is a float */
  21679. Float = 1,
  21680. /** property is a Vector2 */
  21681. Vector2 = 2,
  21682. /** property is a list of values */
  21683. List = 3
  21684. }
  21685. /**
  21686. * Interface that defines an option in a variable of type list
  21687. */
  21688. export interface IEditablePropertyListOption {
  21689. /** label of the option */
  21690. "label": string;
  21691. /** value of the option */
  21692. "value": number;
  21693. }
  21694. /**
  21695. * Interface that defines the options available for an editable property
  21696. */
  21697. export interface IEditablePropertyOption {
  21698. /** min value */
  21699. "min"?: number;
  21700. /** max value */
  21701. "max"?: number;
  21702. /** notifiers: indicates which actions to take when the property is changed */
  21703. "notifiers"?: {
  21704. /** the material should be rebuilt */
  21705. "rebuild"?: boolean;
  21706. /** the preview should be updated */
  21707. "update"?: boolean;
  21708. };
  21709. /** list of the options for a variable of type list */
  21710. "options"?: IEditablePropertyListOption[];
  21711. }
  21712. /**
  21713. * Interface that describes an editable property
  21714. */
  21715. export interface IPropertyDescriptionForEdition {
  21716. /** name of the property */
  21717. "propertyName": string;
  21718. /** display name of the property */
  21719. "displayName": string;
  21720. /** type of the property */
  21721. "type": PropertyTypeForEdition;
  21722. /** group of the property - all properties with the same group value will be displayed in a specific section */
  21723. "groupName": string;
  21724. /** options for the property */
  21725. "options": IEditablePropertyOption;
  21726. }
  21727. /**
  21728. * Decorator that flags a property in a node material block as being editable
  21729. */
  21730. export function editableInPropertyPage(displayName: string, propertyType?: PropertyTypeForEdition, groupName?: string, options?: IEditablePropertyOption): (target: any, propertyKey: string) => void;
  21731. }
  21732. declare module "babylonjs/Materials/Node/Blocks/PBR/refractionBlock" {
  21733. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  21734. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  21735. import { NodeMaterial, NodeMaterialDefines } from "babylonjs/Materials/Node/nodeMaterial";
  21736. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  21737. import { Nullable } from "babylonjs/types";
  21738. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  21739. import { Mesh } from "babylonjs/Meshes/mesh";
  21740. import { SubMesh } from "babylonjs/Meshes/subMesh";
  21741. import { Effect } from "babylonjs/Materials/effect";
  21742. import { Scene } from "babylonjs/scene";
  21743. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  21744. /**
  21745. * Block used to implement the refraction part of the sub surface module of the PBR material
  21746. */
  21747. export class RefractionBlock extends NodeMaterialBlock {
  21748. /** @hidden */
  21749. _define3DName: string;
  21750. /** @hidden */
  21751. _refractionMatrixName: string;
  21752. /** @hidden */
  21753. _defineLODRefractionAlpha: string;
  21754. /** @hidden */
  21755. _defineLinearSpecularRefraction: string;
  21756. /** @hidden */
  21757. _defineOppositeZ: string;
  21758. /** @hidden */
  21759. _cubeSamplerName: string;
  21760. /** @hidden */
  21761. _2DSamplerName: string;
  21762. /** @hidden */
  21763. _vRefractionMicrosurfaceInfosName: string;
  21764. /** @hidden */
  21765. _vRefractionInfosName: string;
  21766. private _scene;
  21767. /**
  21768. * This parameters will make the material used its opacity to control how much it is refracting aginst not.
  21769. * Materials half opaque for instance using refraction could benefit from this control.
  21770. */
  21771. linkRefractionWithTransparency: boolean;
  21772. /**
  21773. * Controls if refraction needs to be inverted on Y. This could be useful for procedural texture.
  21774. */
  21775. invertRefractionY: boolean;
  21776. /**
  21777. * Gets or sets the texture associated with the node
  21778. */
  21779. texture: Nullable<BaseTexture>;
  21780. /**
  21781. * Create a new RefractionBlock
  21782. * @param name defines the block name
  21783. */
  21784. constructor(name: string);
  21785. /**
  21786. * Gets the current class name
  21787. * @returns the class name
  21788. */
  21789. getClassName(): string;
  21790. /**
  21791. * Gets the intensity input component
  21792. */
  21793. get intensity(): NodeMaterialConnectionPoint;
  21794. /**
  21795. * Gets the index of refraction input component
  21796. */
  21797. get indexOfRefraction(): NodeMaterialConnectionPoint;
  21798. /**
  21799. * Gets the tint at distance input component
  21800. */
  21801. get tintAtDistance(): NodeMaterialConnectionPoint;
  21802. /**
  21803. * Gets the view input component
  21804. */
  21805. get view(): NodeMaterialConnectionPoint;
  21806. /**
  21807. * Gets the refraction object output component
  21808. */
  21809. get refraction(): NodeMaterialConnectionPoint;
  21810. /**
  21811. * Returns true if the block has a texture
  21812. */
  21813. get hasTexture(): boolean;
  21814. protected _getTexture(): Nullable<BaseTexture>;
  21815. autoConfigure(material: NodeMaterial): void;
  21816. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  21817. isReady(): boolean;
  21818. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh, subMesh?: SubMesh): void;
  21819. /**
  21820. * Gets the main code of the block (fragment side)
  21821. * @param state current state of the node material building
  21822. * @returns the shader code
  21823. */
  21824. getCode(state: NodeMaterialBuildState): string;
  21825. protected _buildBlock(state: NodeMaterialBuildState): this;
  21826. protected _dumpPropertiesCode(): string;
  21827. serialize(): any;
  21828. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  21829. }
  21830. }
  21831. declare module "babylonjs/Materials/Node/Blocks/Dual/currentScreenBlock" {
  21832. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  21833. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  21834. import { NodeMaterialBlockTargets } from "babylonjs/Materials/Node/Enums/nodeMaterialBlockTargets";
  21835. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  21836. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  21837. import { NodeMaterialDefines } from "babylonjs/Materials/Node/nodeMaterial";
  21838. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  21839. import { Nullable } from "babylonjs/types";
  21840. import { Scene } from "babylonjs/scene";
  21841. import { NodeMaterial } from "babylonjs/Materials/Node/nodeMaterial";
  21842. /**
  21843. * Base block used as input for post process
  21844. */
  21845. export class CurrentScreenBlock extends NodeMaterialBlock {
  21846. private _samplerName;
  21847. private _linearDefineName;
  21848. private _gammaDefineName;
  21849. private _mainUVName;
  21850. private _tempTextureRead;
  21851. /**
  21852. * Gets or sets the texture associated with the node
  21853. */
  21854. texture: Nullable<BaseTexture>;
  21855. /**
  21856. * Gets or sets a boolean indicating if content needs to be converted to gamma space
  21857. */
  21858. convertToGammaSpace: boolean;
  21859. /**
  21860. * Gets or sets a boolean indicating if content needs to be converted to linear space
  21861. */
  21862. convertToLinearSpace: boolean;
  21863. /**
  21864. * Create a new CurrentScreenBlock
  21865. * @param name defines the block name
  21866. */
  21867. constructor(name: string);
  21868. /**
  21869. * Gets the current class name
  21870. * @returns the class name
  21871. */
  21872. getClassName(): string;
  21873. /**
  21874. * Gets the uv input component
  21875. */
  21876. get uv(): NodeMaterialConnectionPoint;
  21877. /**
  21878. * Gets the rgba output component
  21879. */
  21880. get rgba(): NodeMaterialConnectionPoint;
  21881. /**
  21882. * Gets the rgb output component
  21883. */
  21884. get rgb(): NodeMaterialConnectionPoint;
  21885. /**
  21886. * Gets the r output component
  21887. */
  21888. get r(): NodeMaterialConnectionPoint;
  21889. /**
  21890. * Gets the g output component
  21891. */
  21892. get g(): NodeMaterialConnectionPoint;
  21893. /**
  21894. * Gets the b output component
  21895. */
  21896. get b(): NodeMaterialConnectionPoint;
  21897. /**
  21898. * Gets the a output component
  21899. */
  21900. get a(): NodeMaterialConnectionPoint;
  21901. /**
  21902. * Initialize the block and prepare the context for build
  21903. * @param state defines the state that will be used for the build
  21904. */
  21905. initialize(state: NodeMaterialBuildState): void;
  21906. get target(): NodeMaterialBlockTargets;
  21907. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  21908. isReady(): boolean;
  21909. private _injectVertexCode;
  21910. private _writeTextureRead;
  21911. private _writeOutput;
  21912. protected _buildBlock(state: NodeMaterialBuildState): this | undefined;
  21913. serialize(): any;
  21914. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  21915. }
  21916. }
  21917. declare module "babylonjs/Materials/Node/Blocks/Particle/particleTextureBlock" {
  21918. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  21919. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  21920. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  21921. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  21922. import { NodeMaterialDefines } from "babylonjs/Materials/Node/nodeMaterial";
  21923. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  21924. import { Nullable } from "babylonjs/types";
  21925. import { Scene } from "babylonjs/scene";
  21926. import { NodeMaterial } from "babylonjs/Materials/Node/nodeMaterial";
  21927. /**
  21928. * Base block used for the particle texture
  21929. */
  21930. export class ParticleTextureBlock extends NodeMaterialBlock {
  21931. private _samplerName;
  21932. private _linearDefineName;
  21933. private _gammaDefineName;
  21934. private _tempTextureRead;
  21935. /**
  21936. * Gets or sets the texture associated with the node
  21937. */
  21938. texture: Nullable<BaseTexture>;
  21939. /**
  21940. * Gets or sets a boolean indicating if content needs to be converted to gamma space
  21941. */
  21942. convertToGammaSpace: boolean;
  21943. /**
  21944. * Gets or sets a boolean indicating if content needs to be converted to linear space
  21945. */
  21946. convertToLinearSpace: boolean;
  21947. /**
  21948. * Create a new ParticleTextureBlock
  21949. * @param name defines the block name
  21950. */
  21951. constructor(name: string);
  21952. /**
  21953. * Gets the current class name
  21954. * @returns the class name
  21955. */
  21956. getClassName(): string;
  21957. /**
  21958. * Gets the uv input component
  21959. */
  21960. get uv(): NodeMaterialConnectionPoint;
  21961. /**
  21962. * Gets the rgba output component
  21963. */
  21964. get rgba(): NodeMaterialConnectionPoint;
  21965. /**
  21966. * Gets the rgb output component
  21967. */
  21968. get rgb(): NodeMaterialConnectionPoint;
  21969. /**
  21970. * Gets the r output component
  21971. */
  21972. get r(): NodeMaterialConnectionPoint;
  21973. /**
  21974. * Gets the g output component
  21975. */
  21976. get g(): NodeMaterialConnectionPoint;
  21977. /**
  21978. * Gets the b output component
  21979. */
  21980. get b(): NodeMaterialConnectionPoint;
  21981. /**
  21982. * Gets the a output component
  21983. */
  21984. get a(): NodeMaterialConnectionPoint;
  21985. /**
  21986. * Initialize the block and prepare the context for build
  21987. * @param state defines the state that will be used for the build
  21988. */
  21989. initialize(state: NodeMaterialBuildState): void;
  21990. autoConfigure(material: NodeMaterial): void;
  21991. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  21992. isReady(): boolean;
  21993. private _writeOutput;
  21994. protected _buildBlock(state: NodeMaterialBuildState): this | undefined;
  21995. serialize(): any;
  21996. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  21997. }
  21998. }
  21999. declare module "babylonjs/Materials/Node/nodeMaterialBuildStateSharedData" {
  22000. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  22001. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  22002. import { InputBlock } from "babylonjs/Materials/Node/Blocks/Input/inputBlock";
  22003. import { TextureBlock } from "babylonjs/Materials/Node/Blocks/Dual/textureBlock";
  22004. import { ReflectionTextureBaseBlock } from "babylonjs/Materials/Node/Blocks/Dual/reflectionTextureBaseBlock";
  22005. import { RefractionBlock } from "babylonjs/Materials/Node/Blocks/PBR/refractionBlock";
  22006. import { CurrentScreenBlock } from "babylonjs/Materials/Node/Blocks/Dual/currentScreenBlock";
  22007. import { ParticleTextureBlock } from "babylonjs/Materials/Node/Blocks/Particle/particleTextureBlock";
  22008. import { Scene } from "babylonjs/scene";
  22009. /**
  22010. * Class used to store shared data between 2 NodeMaterialBuildState
  22011. */
  22012. export class NodeMaterialBuildStateSharedData {
  22013. /**
  22014. * Gets the list of emitted varyings
  22015. */
  22016. temps: string[];
  22017. /**
  22018. * Gets the list of emitted varyings
  22019. */
  22020. varyings: string[];
  22021. /**
  22022. * Gets the varying declaration string
  22023. */
  22024. varyingDeclaration: string;
  22025. /**
  22026. * Input blocks
  22027. */
  22028. inputBlocks: InputBlock[];
  22029. /**
  22030. * Input blocks
  22031. */
  22032. textureBlocks: (TextureBlock | ReflectionTextureBaseBlock | RefractionBlock | CurrentScreenBlock | ParticleTextureBlock)[];
  22033. /**
  22034. * Bindable blocks (Blocks that need to set data to the effect)
  22035. */
  22036. bindableBlocks: NodeMaterialBlock[];
  22037. /**
  22038. * List of blocks that can provide a compilation fallback
  22039. */
  22040. blocksWithFallbacks: NodeMaterialBlock[];
  22041. /**
  22042. * List of blocks that can provide a define update
  22043. */
  22044. blocksWithDefines: NodeMaterialBlock[];
  22045. /**
  22046. * List of blocks that can provide a repeatable content
  22047. */
  22048. repeatableContentBlocks: NodeMaterialBlock[];
  22049. /**
  22050. * List of blocks that can provide a dynamic list of uniforms
  22051. */
  22052. dynamicUniformBlocks: NodeMaterialBlock[];
  22053. /**
  22054. * List of blocks that can block the isReady function for the material
  22055. */
  22056. blockingBlocks: NodeMaterialBlock[];
  22057. /**
  22058. * Gets the list of animated inputs
  22059. */
  22060. animatedInputs: InputBlock[];
  22061. /**
  22062. * Build Id used to avoid multiple recompilations
  22063. */
  22064. buildId: number;
  22065. /** List of emitted variables */
  22066. variableNames: {
  22067. [key: string]: number;
  22068. };
  22069. /** List of emitted defines */
  22070. defineNames: {
  22071. [key: string]: number;
  22072. };
  22073. /** Should emit comments? */
  22074. emitComments: boolean;
  22075. /** Emit build activity */
  22076. verbose: boolean;
  22077. /** Gets or sets the hosting scene */
  22078. scene: Scene;
  22079. /**
  22080. * Gets the compilation hints emitted at compilation time
  22081. */
  22082. hints: {
  22083. needWorldViewMatrix: boolean;
  22084. needWorldViewProjectionMatrix: boolean;
  22085. needAlphaBlending: boolean;
  22086. needAlphaTesting: boolean;
  22087. };
  22088. /**
  22089. * List of compilation checks
  22090. */
  22091. checks: {
  22092. emitVertex: boolean;
  22093. emitFragment: boolean;
  22094. notConnectedNonOptionalInputs: NodeMaterialConnectionPoint[];
  22095. };
  22096. /**
  22097. * Is vertex program allowed to be empty?
  22098. */
  22099. allowEmptyVertexProgram: boolean;
  22100. /** Creates a new shared data */
  22101. constructor();
  22102. /**
  22103. * Emits console errors and exceptions if there is a failing check
  22104. */
  22105. emitErrors(): void;
  22106. }
  22107. }
  22108. declare module "babylonjs/Materials/Node/nodeMaterialBuildState" {
  22109. import { NodeMaterialBlockConnectionPointTypes } from "babylonjs/Materials/Node/Enums/nodeMaterialBlockConnectionPointTypes";
  22110. import { NodeMaterialBlockTargets } from "babylonjs/Materials/Node/Enums/nodeMaterialBlockTargets";
  22111. import { NodeMaterialBuildStateSharedData } from "babylonjs/Materials/Node/nodeMaterialBuildStateSharedData";
  22112. /**
  22113. * Class used to store node based material build state
  22114. */
  22115. export class NodeMaterialBuildState {
  22116. /** Gets or sets a boolean indicating if the current state can emit uniform buffers */
  22117. supportUniformBuffers: boolean;
  22118. /**
  22119. * Gets the list of emitted attributes
  22120. */
  22121. attributes: string[];
  22122. /**
  22123. * Gets the list of emitted uniforms
  22124. */
  22125. uniforms: string[];
  22126. /**
  22127. * Gets the list of emitted constants
  22128. */
  22129. constants: string[];
  22130. /**
  22131. * Gets the list of emitted samplers
  22132. */
  22133. samplers: string[];
  22134. /**
  22135. * Gets the list of emitted functions
  22136. */
  22137. functions: {
  22138. [key: string]: string;
  22139. };
  22140. /**
  22141. * Gets the list of emitted extensions
  22142. */
  22143. extensions: {
  22144. [key: string]: string;
  22145. };
  22146. /**
  22147. * Gets the target of the compilation state
  22148. */
  22149. target: NodeMaterialBlockTargets;
  22150. /**
  22151. * Gets the list of emitted counters
  22152. */
  22153. counters: {
  22154. [key: string]: number;
  22155. };
  22156. /**
  22157. * Shared data between multiple NodeMaterialBuildState instances
  22158. */
  22159. sharedData: NodeMaterialBuildStateSharedData;
  22160. /** @hidden */
  22161. _vertexState: NodeMaterialBuildState;
  22162. /** @hidden */
  22163. _attributeDeclaration: string;
  22164. /** @hidden */
  22165. _uniformDeclaration: string;
  22166. /** @hidden */
  22167. _constantDeclaration: string;
  22168. /** @hidden */
  22169. _samplerDeclaration: string;
  22170. /** @hidden */
  22171. _varyingTransfer: string;
  22172. /** @hidden */
  22173. _injectAtEnd: string;
  22174. private _repeatableContentAnchorIndex;
  22175. /** @hidden */
  22176. _builtCompilationString: string;
  22177. /**
  22178. * Gets the emitted compilation strings
  22179. */
  22180. compilationString: string;
  22181. /**
  22182. * Finalize the compilation strings
  22183. * @param state defines the current compilation state
  22184. */
  22185. finalize(state: NodeMaterialBuildState): void;
  22186. /** @hidden */
  22187. get _repeatableContentAnchor(): string;
  22188. /** @hidden */
  22189. _getFreeVariableName(prefix: string): string;
  22190. /** @hidden */
  22191. _getFreeDefineName(prefix: string): string;
  22192. /** @hidden */
  22193. _excludeVariableName(name: string): void;
  22194. /** @hidden */
  22195. _emit2DSampler(name: string): void;
  22196. /** @hidden */
  22197. _getGLType(type: NodeMaterialBlockConnectionPointTypes): string;
  22198. /** @hidden */
  22199. _emitExtension(name: string, extension: string, define?: string): void;
  22200. /** @hidden */
  22201. _emitFunction(name: string, code: string, comments: string): void;
  22202. /** @hidden */
  22203. _emitCodeFromInclude(includeName: string, comments: string, options?: {
  22204. replaceStrings?: {
  22205. search: RegExp;
  22206. replace: string;
  22207. }[];
  22208. repeatKey?: string;
  22209. }): string;
  22210. /** @hidden */
  22211. _emitFunctionFromInclude(includeName: string, comments: string, options?: {
  22212. repeatKey?: string;
  22213. removeAttributes?: boolean;
  22214. removeUniforms?: boolean;
  22215. removeVaryings?: boolean;
  22216. removeIfDef?: boolean;
  22217. replaceStrings?: {
  22218. search: RegExp;
  22219. replace: string;
  22220. }[];
  22221. }, storeKey?: string): void;
  22222. /** @hidden */
  22223. _registerTempVariable(name: string): boolean;
  22224. /** @hidden */
  22225. _emitVaryingFromString(name: string, type: string, define?: string, notDefine?: boolean): boolean;
  22226. /** @hidden */
  22227. _emitUniformFromString(name: string, type: string, define?: string, notDefine?: boolean): void;
  22228. /** @hidden */
  22229. _emitFloat(value: number): string;
  22230. }
  22231. }
  22232. declare module "babylonjs/Misc/uniqueIdGenerator" {
  22233. /**
  22234. * Helper class used to generate session unique ID
  22235. */
  22236. export class UniqueIdGenerator {
  22237. private static _UniqueIdCounter;
  22238. /**
  22239. * Gets an unique (relatively to the current scene) Id
  22240. */
  22241. static get UniqueId(): number;
  22242. }
  22243. }
  22244. declare module "babylonjs/Materials/Node/nodeMaterialBlock" {
  22245. import { NodeMaterialBlockConnectionPointTypes } from "babylonjs/Materials/Node/Enums/nodeMaterialBlockConnectionPointTypes";
  22246. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  22247. import { Nullable } from "babylonjs/types";
  22248. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  22249. import { NodeMaterialBlockTargets } from "babylonjs/Materials/Node/Enums/nodeMaterialBlockTargets";
  22250. import { Effect } from "babylonjs/Materials/effect";
  22251. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  22252. import { Mesh } from "babylonjs/Meshes/mesh";
  22253. import { SubMesh } from "babylonjs/Meshes/subMesh";
  22254. import { NodeMaterial, NodeMaterialDefines } from "babylonjs/Materials/Node/nodeMaterial";
  22255. import { Scene } from "babylonjs/scene";
  22256. import { EffectFallbacks } from "babylonjs/Materials/effectFallbacks";
  22257. /**
  22258. * Defines a block that can be used inside a node based material
  22259. */
  22260. export class NodeMaterialBlock {
  22261. private _buildId;
  22262. private _buildTarget;
  22263. private _target;
  22264. private _isFinalMerger;
  22265. private _isInput;
  22266. private _name;
  22267. protected _isUnique: boolean;
  22268. /** Gets or sets a boolean indicating that only one input can be connected at a time */
  22269. inputsAreExclusive: boolean;
  22270. /** @hidden */
  22271. _codeVariableName: string;
  22272. /** @hidden */
  22273. _inputs: NodeMaterialConnectionPoint[];
  22274. /** @hidden */
  22275. _outputs: NodeMaterialConnectionPoint[];
  22276. /** @hidden */
  22277. _preparationId: number;
  22278. /**
  22279. * Gets the name of the block
  22280. */
  22281. get name(): string;
  22282. /**
  22283. * Sets the name of the block. Will check if the name is valid.
  22284. */
  22285. set name(newName: string);
  22286. /**
  22287. * Gets or sets the unique id of the node
  22288. */
  22289. uniqueId: number;
  22290. /**
  22291. * Gets or sets the comments associated with this block
  22292. */
  22293. comments: string;
  22294. /**
  22295. * Gets a boolean indicating that this block can only be used once per NodeMaterial
  22296. */
  22297. get isUnique(): boolean;
  22298. /**
  22299. * Gets a boolean indicating that this block is an end block (e.g. it is generating a system value)
  22300. */
  22301. get isFinalMerger(): boolean;
  22302. /**
  22303. * Gets a boolean indicating that this block is an input (e.g. it sends data to the shader)
  22304. */
  22305. get isInput(): boolean;
  22306. /**
  22307. * Gets or sets the build Id
  22308. */
  22309. get buildId(): number;
  22310. set buildId(value: number);
  22311. /**
  22312. * Gets or sets the target of the block
  22313. */
  22314. get target(): NodeMaterialBlockTargets;
  22315. set target(value: NodeMaterialBlockTargets);
  22316. /**
  22317. * Gets the list of input points
  22318. */
  22319. get inputs(): NodeMaterialConnectionPoint[];
  22320. /** Gets the list of output points */
  22321. get outputs(): NodeMaterialConnectionPoint[];
  22322. /**
  22323. * Find an input by its name
  22324. * @param name defines the name of the input to look for
  22325. * @returns the input or null if not found
  22326. */
  22327. getInputByName(name: string): Nullable<NodeMaterialConnectionPoint>;
  22328. /**
  22329. * Find an output by its name
  22330. * @param name defines the name of the outputto look for
  22331. * @returns the output or null if not found
  22332. */
  22333. getOutputByName(name: string): Nullable<NodeMaterialConnectionPoint>;
  22334. /**
  22335. * Creates a new NodeMaterialBlock
  22336. * @param name defines the block name
  22337. * @param target defines the target of that block (Vertex by default)
  22338. * @param isFinalMerger defines a boolean indicating that this block is an end block (e.g. it is generating a system value). Default is false
  22339. * @param isInput defines a boolean indicating that this block is an input (e.g. it sends data to the shader). Default is false
  22340. */
  22341. constructor(name: string, target?: NodeMaterialBlockTargets, isFinalMerger?: boolean, isInput?: boolean);
  22342. /**
  22343. * Initialize the block and prepare the context for build
  22344. * @param state defines the state that will be used for the build
  22345. */
  22346. initialize(state: NodeMaterialBuildState): void;
  22347. /**
  22348. * Bind data to effect. Will only be called for blocks with isBindable === true
  22349. * @param effect defines the effect to bind data to
  22350. * @param nodeMaterial defines the hosting NodeMaterial
  22351. * @param mesh defines the mesh that will be rendered
  22352. * @param subMesh defines the submesh that will be rendered
  22353. */
  22354. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh, subMesh?: SubMesh): void;
  22355. protected _declareOutput(output: NodeMaterialConnectionPoint, state: NodeMaterialBuildState): string;
  22356. protected _writeVariable(currentPoint: NodeMaterialConnectionPoint): string;
  22357. protected _writeFloat(value: number): string;
  22358. /**
  22359. * Gets the current class name e.g. "NodeMaterialBlock"
  22360. * @returns the class name
  22361. */
  22362. getClassName(): string;
  22363. /**
  22364. * Register a new input. Must be called inside a block constructor
  22365. * @param name defines the connection point name
  22366. * @param type defines the connection point type
  22367. * @param isOptional defines a boolean indicating that this input can be omitted
  22368. * @param target defines the target to use to limit the connection point (will be VertexAndFragment by default)
  22369. * @param point an already created connection point. If not provided, create a new one
  22370. * @returns the current block
  22371. */
  22372. registerInput(name: string, type: NodeMaterialBlockConnectionPointTypes, isOptional?: boolean, target?: NodeMaterialBlockTargets, point?: NodeMaterialConnectionPoint): this;
  22373. /**
  22374. * Register a new output. Must be called inside a block constructor
  22375. * @param name defines the connection point name
  22376. * @param type defines the connection point type
  22377. * @param target defines the target to use to limit the connection point (will be VertexAndFragment by default)
  22378. * @param point an already created connection point. If not provided, create a new one
  22379. * @returns the current block
  22380. */
  22381. registerOutput(name: string, type: NodeMaterialBlockConnectionPointTypes, target?: NodeMaterialBlockTargets, point?: NodeMaterialConnectionPoint): this;
  22382. /**
  22383. * Will return the first available input e.g. the first one which is not an uniform or an attribute
  22384. * @param forOutput defines an optional connection point to check compatibility with
  22385. * @returns the first available input or null
  22386. */
  22387. getFirstAvailableInput(forOutput?: Nullable<NodeMaterialConnectionPoint>): Nullable<NodeMaterialConnectionPoint>;
  22388. /**
  22389. * Will return the first available output e.g. the first one which is not yet connected and not a varying
  22390. * @param forBlock defines an optional block to check compatibility with
  22391. * @returns the first available input or null
  22392. */
  22393. getFirstAvailableOutput(forBlock?: Nullable<NodeMaterialBlock>): Nullable<NodeMaterialConnectionPoint>;
  22394. /**
  22395. * Gets the sibling of the given output
  22396. * @param current defines the current output
  22397. * @returns the next output in the list or null
  22398. */
  22399. getSiblingOutput(current: NodeMaterialConnectionPoint): Nullable<NodeMaterialConnectionPoint>;
  22400. /**
  22401. * Connect current block with another block
  22402. * @param other defines the block to connect with
  22403. * @param options define the various options to help pick the right connections
  22404. * @returns the current block
  22405. */
  22406. connectTo(other: NodeMaterialBlock, options?: {
  22407. input?: string;
  22408. output?: string;
  22409. outputSwizzle?: string;
  22410. }): this | undefined;
  22411. protected _buildBlock(state: NodeMaterialBuildState): void;
  22412. /**
  22413. * Add uniforms, samplers and uniform buffers at compilation time
  22414. * @param state defines the state to update
  22415. * @param nodeMaterial defines the node material requesting the update
  22416. * @param defines defines the material defines to update
  22417. * @param uniformBuffers defines the list of uniform buffer names
  22418. */
  22419. updateUniformsAndSamples(state: NodeMaterialBuildState, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines, uniformBuffers: string[]): void;
  22420. /**
  22421. * Add potential fallbacks if shader compilation fails
  22422. * @param mesh defines the mesh to be rendered
  22423. * @param fallbacks defines the current prioritized list of fallbacks
  22424. */
  22425. provideFallbacks(mesh: AbstractMesh, fallbacks: EffectFallbacks): void;
  22426. /**
  22427. * Initialize defines for shader compilation
  22428. * @param mesh defines the mesh to be rendered
  22429. * @param nodeMaterial defines the node material requesting the update
  22430. * @param defines defines the material defines to update
  22431. * @param useInstances specifies that instances should be used
  22432. */
  22433. initializeDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines, useInstances?: boolean): void;
  22434. /**
  22435. * Update defines for shader compilation
  22436. * @param mesh defines the mesh to be rendered
  22437. * @param nodeMaterial defines the node material requesting the update
  22438. * @param defines defines the material defines to update
  22439. * @param useInstances specifies that instances should be used
  22440. * @param subMesh defines which submesh to render
  22441. */
  22442. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines, useInstances?: boolean, subMesh?: SubMesh): void;
  22443. /**
  22444. * Lets the block try to connect some inputs automatically
  22445. * @param material defines the hosting NodeMaterial
  22446. */
  22447. autoConfigure(material: NodeMaterial): void;
  22448. /**
  22449. * Function called when a block is declared as repeatable content generator
  22450. * @param vertexShaderState defines the current compilation state for the vertex shader
  22451. * @param fragmentShaderState defines the current compilation state for the fragment shader
  22452. * @param mesh defines the mesh to be rendered
  22453. * @param defines defines the material defines to update
  22454. */
  22455. replaceRepeatableContent(vertexShaderState: NodeMaterialBuildState, fragmentShaderState: NodeMaterialBuildState, mesh: AbstractMesh, defines: NodeMaterialDefines): void;
  22456. /**
  22457. * Checks if the block is ready
  22458. * @param mesh defines the mesh to be rendered
  22459. * @param nodeMaterial defines the node material requesting the update
  22460. * @param defines defines the material defines to update
  22461. * @param useInstances specifies that instances should be used
  22462. * @returns true if the block is ready
  22463. */
  22464. isReady(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines, useInstances?: boolean): boolean;
  22465. protected _linkConnectionTypes(inputIndex0: number, inputIndex1: number): void;
  22466. private _processBuild;
  22467. /**
  22468. * Validates the new name for the block node.
  22469. * @param newName the new name to be given to the node.
  22470. * @returns false if the name is a reserve word, else true.
  22471. */
  22472. validateBlockName(newName: string): boolean;
  22473. /**
  22474. * Compile the current node and generate the shader code
  22475. * @param state defines the current compilation state (uniforms, samplers, current string)
  22476. * @param activeBlocks defines the list of active blocks (i.e. blocks to compile)
  22477. * @returns true if already built
  22478. */
  22479. build(state: NodeMaterialBuildState, activeBlocks: NodeMaterialBlock[]): boolean;
  22480. protected _inputRename(name: string): string;
  22481. protected _outputRename(name: string): string;
  22482. protected _dumpPropertiesCode(): string;
  22483. /** @hidden */
  22484. _dumpCode(uniqueNames: string[], alreadyDumped: NodeMaterialBlock[]): string;
  22485. /** @hidden */
  22486. _dumpCodeForOutputConnections(alreadyDumped: NodeMaterialBlock[]): string;
  22487. /**
  22488. * Clone the current block to a new identical block
  22489. * @param scene defines the hosting scene
  22490. * @param rootUrl defines the root URL to use to load textures and relative dependencies
  22491. * @returns a copy of the current block
  22492. */
  22493. clone(scene: Scene, rootUrl?: string): Nullable<NodeMaterialBlock>;
  22494. /**
  22495. * Serializes this block in a JSON representation
  22496. * @returns the serialized block object
  22497. */
  22498. serialize(): any;
  22499. /** @hidden */
  22500. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  22501. private _deserializePortDisplayNamesAndExposedOnFrame;
  22502. /**
  22503. * Release resources
  22504. */
  22505. dispose(): void;
  22506. }
  22507. }
  22508. declare module "babylonjs/Materials/pushMaterial" {
  22509. import { Nullable } from "babylonjs/types";
  22510. import { Scene } from "babylonjs/scene";
  22511. import { Matrix } from "babylonjs/Maths/math.vector";
  22512. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  22513. import { Mesh } from "babylonjs/Meshes/mesh";
  22514. import { Material } from "babylonjs/Materials/material";
  22515. import { Effect } from "babylonjs/Materials/effect";
  22516. import { SubMesh } from "babylonjs/Meshes/subMesh";
  22517. /**
  22518. * Base class of materials working in push mode in babylon JS
  22519. * @hidden
  22520. */
  22521. export class PushMaterial extends Material {
  22522. protected _activeEffect: Effect;
  22523. protected _normalMatrix: Matrix;
  22524. constructor(name: string, scene: Scene);
  22525. getEffect(): Effect;
  22526. isReady(mesh?: AbstractMesh, useInstances?: boolean): boolean;
  22527. protected _isReadyForSubMesh(subMesh: SubMesh): boolean;
  22528. /**
  22529. * Binds the given world matrix to the active effect
  22530. *
  22531. * @param world the matrix to bind
  22532. */
  22533. bindOnlyWorldMatrix(world: Matrix): void;
  22534. /**
  22535. * Binds the given normal matrix to the active effect
  22536. *
  22537. * @param normalMatrix the matrix to bind
  22538. */
  22539. bindOnlyNormalMatrix(normalMatrix: Matrix): void;
  22540. bind(world: Matrix, mesh?: Mesh): void;
  22541. protected _afterBind(mesh: Mesh, effect?: Nullable<Effect>): void;
  22542. protected _mustRebind(scene: Scene, effect: Effect, visibility?: number): boolean;
  22543. }
  22544. }
  22545. declare module "babylonjs/Materials/Node/Optimizers/nodeMaterialOptimizer" {
  22546. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  22547. /**
  22548. * Root class for all node material optimizers
  22549. */
  22550. export class NodeMaterialOptimizer {
  22551. /**
  22552. * Function used to optimize a NodeMaterial graph
  22553. * @param vertexOutputNodes defines the list of output nodes for the vertex shader
  22554. * @param fragmentOutputNodes defines the list of output nodes for the fragment shader
  22555. */
  22556. optimize(vertexOutputNodes: NodeMaterialBlock[], fragmentOutputNodes: NodeMaterialBlock[]): void;
  22557. }
  22558. }
  22559. declare module "babylonjs/Materials/Node/Blocks/transformBlock" {
  22560. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  22561. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  22562. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  22563. import { Scene } from "babylonjs/scene";
  22564. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  22565. import { NodeMaterial, NodeMaterialDefines } from "babylonjs/Materials/Node/nodeMaterial";
  22566. import { SubMesh } from "babylonjs/Meshes/subMesh";
  22567. /**
  22568. * Block used to transform a vector (2, 3 or 4) with a matrix. It will generate a Vector4
  22569. */
  22570. export class TransformBlock extends NodeMaterialBlock {
  22571. /**
  22572. * Defines the value to use to complement W value to transform it to a Vector4
  22573. */
  22574. complementW: number;
  22575. /**
  22576. * Defines the value to use to complement z value to transform it to a Vector4
  22577. */
  22578. complementZ: number;
  22579. /**
  22580. * Creates a new TransformBlock
  22581. * @param name defines the block name
  22582. */
  22583. constructor(name: string);
  22584. /**
  22585. * Gets the current class name
  22586. * @returns the class name
  22587. */
  22588. getClassName(): string;
  22589. /**
  22590. * Gets the vector input
  22591. */
  22592. get vector(): NodeMaterialConnectionPoint;
  22593. /**
  22594. * Gets the output component
  22595. */
  22596. get output(): NodeMaterialConnectionPoint;
  22597. /**
  22598. * Gets the xyz output component
  22599. */
  22600. get xyz(): NodeMaterialConnectionPoint;
  22601. /**
  22602. * Gets the matrix transform input
  22603. */
  22604. get transform(): NodeMaterialConnectionPoint;
  22605. protected _buildBlock(state: NodeMaterialBuildState): this;
  22606. /**
  22607. * Update defines for shader compilation
  22608. * @param mesh defines the mesh to be rendered
  22609. * @param nodeMaterial defines the node material requesting the update
  22610. * @param defines defines the material defines to update
  22611. * @param useInstances specifies that instances should be used
  22612. * @param subMesh defines which submesh to render
  22613. */
  22614. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines, useInstances?: boolean, subMesh?: SubMesh): void;
  22615. serialize(): any;
  22616. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  22617. protected _dumpPropertiesCode(): string;
  22618. }
  22619. }
  22620. declare module "babylonjs/Materials/Node/Blocks/Vertex/vertexOutputBlock" {
  22621. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  22622. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  22623. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  22624. /**
  22625. * Block used to output the vertex position
  22626. */
  22627. export class VertexOutputBlock extends NodeMaterialBlock {
  22628. /**
  22629. * Creates a new VertexOutputBlock
  22630. * @param name defines the block name
  22631. */
  22632. constructor(name: string);
  22633. /**
  22634. * Gets the current class name
  22635. * @returns the class name
  22636. */
  22637. getClassName(): string;
  22638. /**
  22639. * Gets the vector input component
  22640. */
  22641. get vector(): NodeMaterialConnectionPoint;
  22642. protected _buildBlock(state: NodeMaterialBuildState): this;
  22643. }
  22644. }
  22645. declare module "babylonjs/Materials/Node/Blocks/Fragment/fragmentOutputBlock" {
  22646. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  22647. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  22648. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  22649. /**
  22650. * Block used to output the final color
  22651. */
  22652. export class FragmentOutputBlock extends NodeMaterialBlock {
  22653. /**
  22654. * Create a new FragmentOutputBlock
  22655. * @param name defines the block name
  22656. */
  22657. constructor(name: string);
  22658. /**
  22659. * Gets the current class name
  22660. * @returns the class name
  22661. */
  22662. getClassName(): string;
  22663. /**
  22664. * Gets the rgba input component
  22665. */
  22666. get rgba(): NodeMaterialConnectionPoint;
  22667. /**
  22668. * Gets the rgb input component
  22669. */
  22670. get rgb(): NodeMaterialConnectionPoint;
  22671. /**
  22672. * Gets the a input component
  22673. */
  22674. get a(): NodeMaterialConnectionPoint;
  22675. protected _buildBlock(state: NodeMaterialBuildState): this;
  22676. }
  22677. }
  22678. declare module "babylonjs/Materials/Node/Blocks/Particle/particleRampGradientBlock" {
  22679. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  22680. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  22681. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  22682. /**
  22683. * Block used for the particle ramp gradient section
  22684. */
  22685. export class ParticleRampGradientBlock extends NodeMaterialBlock {
  22686. /**
  22687. * Create a new ParticleRampGradientBlock
  22688. * @param name defines the block name
  22689. */
  22690. constructor(name: string);
  22691. /**
  22692. * Gets the current class name
  22693. * @returns the class name
  22694. */
  22695. getClassName(): string;
  22696. /**
  22697. * Gets the color input component
  22698. */
  22699. get color(): NodeMaterialConnectionPoint;
  22700. /**
  22701. * Gets the rampColor output component
  22702. */
  22703. get rampColor(): NodeMaterialConnectionPoint;
  22704. /**
  22705. * Initialize the block and prepare the context for build
  22706. * @param state defines the state that will be used for the build
  22707. */
  22708. initialize(state: NodeMaterialBuildState): void;
  22709. protected _buildBlock(state: NodeMaterialBuildState): this | undefined;
  22710. }
  22711. }
  22712. declare module "babylonjs/Materials/Node/Blocks/Particle/particleBlendMultiplyBlock" {
  22713. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  22714. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  22715. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  22716. /**
  22717. * Block used for the particle blend multiply section
  22718. */
  22719. export class ParticleBlendMultiplyBlock extends NodeMaterialBlock {
  22720. /**
  22721. * Create a new ParticleBlendMultiplyBlock
  22722. * @param name defines the block name
  22723. */
  22724. constructor(name: string);
  22725. /**
  22726. * Gets the current class name
  22727. * @returns the class name
  22728. */
  22729. getClassName(): string;
  22730. /**
  22731. * Gets the color input component
  22732. */
  22733. get color(): NodeMaterialConnectionPoint;
  22734. /**
  22735. * Gets the alphaTexture input component
  22736. */
  22737. get alphaTexture(): NodeMaterialConnectionPoint;
  22738. /**
  22739. * Gets the alphaColor input component
  22740. */
  22741. get alphaColor(): NodeMaterialConnectionPoint;
  22742. /**
  22743. * Gets the blendColor output component
  22744. */
  22745. get blendColor(): NodeMaterialConnectionPoint;
  22746. /**
  22747. * Initialize the block and prepare the context for build
  22748. * @param state defines the state that will be used for the build
  22749. */
  22750. initialize(state: NodeMaterialBuildState): void;
  22751. protected _buildBlock(state: NodeMaterialBuildState): this | undefined;
  22752. }
  22753. }
  22754. declare module "babylonjs/Materials/Node/Blocks/vectorMergerBlock" {
  22755. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  22756. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  22757. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  22758. /**
  22759. * Block used to create a Vector2/3/4 out of individual inputs (one for each component)
  22760. */
  22761. export class VectorMergerBlock extends NodeMaterialBlock {
  22762. /**
  22763. * Create a new VectorMergerBlock
  22764. * @param name defines the block name
  22765. */
  22766. constructor(name: string);
  22767. /**
  22768. * Gets the current class name
  22769. * @returns the class name
  22770. */
  22771. getClassName(): string;
  22772. /**
  22773. * Gets the xyz component (input)
  22774. */
  22775. get xyzIn(): NodeMaterialConnectionPoint;
  22776. /**
  22777. * Gets the xy component (input)
  22778. */
  22779. get xyIn(): NodeMaterialConnectionPoint;
  22780. /**
  22781. * Gets the x component (input)
  22782. */
  22783. get x(): NodeMaterialConnectionPoint;
  22784. /**
  22785. * Gets the y component (input)
  22786. */
  22787. get y(): NodeMaterialConnectionPoint;
  22788. /**
  22789. * Gets the z component (input)
  22790. */
  22791. get z(): NodeMaterialConnectionPoint;
  22792. /**
  22793. * Gets the w component (input)
  22794. */
  22795. get w(): NodeMaterialConnectionPoint;
  22796. /**
  22797. * Gets the xyzw component (output)
  22798. */
  22799. get xyzw(): NodeMaterialConnectionPoint;
  22800. /**
  22801. * Gets the xyz component (output)
  22802. */
  22803. get xyzOut(): NodeMaterialConnectionPoint;
  22804. /**
  22805. * Gets the xy component (output)
  22806. */
  22807. get xyOut(): NodeMaterialConnectionPoint;
  22808. /**
  22809. * Gets the xy component (output)
  22810. * @deprecated Please use xyOut instead.
  22811. */
  22812. get xy(): NodeMaterialConnectionPoint;
  22813. /**
  22814. * Gets the xyz component (output)
  22815. * @deprecated Please use xyzOut instead.
  22816. */
  22817. get xyz(): NodeMaterialConnectionPoint;
  22818. protected _buildBlock(state: NodeMaterialBuildState): this;
  22819. }
  22820. }
  22821. declare module "babylonjs/Materials/Node/Blocks/remapBlock" {
  22822. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  22823. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  22824. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  22825. import { Vector2 } from "babylonjs/Maths/math.vector";
  22826. import { Scene } from "babylonjs/scene";
  22827. /**
  22828. * Block used to remap a float from a range to a new one
  22829. */
  22830. export class RemapBlock extends NodeMaterialBlock {
  22831. /**
  22832. * Gets or sets the source range
  22833. */
  22834. sourceRange: Vector2;
  22835. /**
  22836. * Gets or sets the target range
  22837. */
  22838. targetRange: Vector2;
  22839. /**
  22840. * Creates a new RemapBlock
  22841. * @param name defines the block name
  22842. */
  22843. constructor(name: string);
  22844. /**
  22845. * Gets the current class name
  22846. * @returns the class name
  22847. */
  22848. getClassName(): string;
  22849. /**
  22850. * Gets the input component
  22851. */
  22852. get input(): NodeMaterialConnectionPoint;
  22853. /**
  22854. * Gets the source min input component
  22855. */
  22856. get sourceMin(): NodeMaterialConnectionPoint;
  22857. /**
  22858. * Gets the source max input component
  22859. */
  22860. get sourceMax(): NodeMaterialConnectionPoint;
  22861. /**
  22862. * Gets the target min input component
  22863. */
  22864. get targetMin(): NodeMaterialConnectionPoint;
  22865. /**
  22866. * Gets the target max input component
  22867. */
  22868. get targetMax(): NodeMaterialConnectionPoint;
  22869. /**
  22870. * Gets the output component
  22871. */
  22872. get output(): NodeMaterialConnectionPoint;
  22873. protected _buildBlock(state: NodeMaterialBuildState): this;
  22874. protected _dumpPropertiesCode(): string;
  22875. serialize(): any;
  22876. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  22877. }
  22878. }
  22879. declare module "babylonjs/Materials/Node/Blocks/multiplyBlock" {
  22880. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  22881. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  22882. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  22883. /**
  22884. * Block used to multiply 2 values
  22885. */
  22886. export class MultiplyBlock extends NodeMaterialBlock {
  22887. /**
  22888. * Creates a new MultiplyBlock
  22889. * @param name defines the block name
  22890. */
  22891. constructor(name: string);
  22892. /**
  22893. * Gets the current class name
  22894. * @returns the class name
  22895. */
  22896. getClassName(): string;
  22897. /**
  22898. * Gets the left operand input component
  22899. */
  22900. get left(): NodeMaterialConnectionPoint;
  22901. /**
  22902. * Gets the right operand input component
  22903. */
  22904. get right(): NodeMaterialConnectionPoint;
  22905. /**
  22906. * Gets the output component
  22907. */
  22908. get output(): NodeMaterialConnectionPoint;
  22909. protected _buildBlock(state: NodeMaterialBuildState): this;
  22910. }
  22911. }
  22912. declare module "babylonjs/Materials/Node/Blocks/colorSplitterBlock" {
  22913. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  22914. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  22915. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  22916. /**
  22917. * Block used to expand a Color3/4 into 4 outputs (one for each component)
  22918. */
  22919. export class ColorSplitterBlock extends NodeMaterialBlock {
  22920. /**
  22921. * Create a new ColorSplitterBlock
  22922. * @param name defines the block name
  22923. */
  22924. constructor(name: string);
  22925. /**
  22926. * Gets the current class name
  22927. * @returns the class name
  22928. */
  22929. getClassName(): string;
  22930. /**
  22931. * Gets the rgba component (input)
  22932. */
  22933. get rgba(): NodeMaterialConnectionPoint;
  22934. /**
  22935. * Gets the rgb component (input)
  22936. */
  22937. get rgbIn(): NodeMaterialConnectionPoint;
  22938. /**
  22939. * Gets the rgb component (output)
  22940. */
  22941. get rgbOut(): NodeMaterialConnectionPoint;
  22942. /**
  22943. * Gets the r component (output)
  22944. */
  22945. get r(): NodeMaterialConnectionPoint;
  22946. /**
  22947. * Gets the g component (output)
  22948. */
  22949. get g(): NodeMaterialConnectionPoint;
  22950. /**
  22951. * Gets the b component (output)
  22952. */
  22953. get b(): NodeMaterialConnectionPoint;
  22954. /**
  22955. * Gets the a component (output)
  22956. */
  22957. get a(): NodeMaterialConnectionPoint;
  22958. protected _inputRename(name: string): string;
  22959. protected _outputRename(name: string): string;
  22960. protected _buildBlock(state: NodeMaterialBuildState): this | undefined;
  22961. }
  22962. }
  22963. declare module "babylonjs/Materials/Node/nodeMaterial" {
  22964. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  22965. import { PushMaterial } from "babylonjs/Materials/pushMaterial";
  22966. import { Scene } from "babylonjs/scene";
  22967. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  22968. import { Matrix } from "babylonjs/Maths/math.vector";
  22969. import { Mesh } from "babylonjs/Meshes/mesh";
  22970. import { Engine } from "babylonjs/Engines/engine";
  22971. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  22972. import { Observable } from "babylonjs/Misc/observable";
  22973. import { SubMesh } from "babylonjs/Meshes/subMesh";
  22974. import { MaterialDefines } from "babylonjs/Materials/materialDefines";
  22975. import { NodeMaterialOptimizer } from "babylonjs/Materials/Node/Optimizers/nodeMaterialOptimizer";
  22976. import { ImageProcessingConfiguration, IImageProcessingConfigurationDefines } from "babylonjs/Materials/imageProcessingConfiguration";
  22977. import { Nullable } from "babylonjs/types";
  22978. import { InputBlock } from "babylonjs/Materials/Node/Blocks/Input/inputBlock";
  22979. import { TextureBlock } from "babylonjs/Materials/Node/Blocks/Dual/textureBlock";
  22980. import { ReflectionTextureBaseBlock } from "babylonjs/Materials/Node/Blocks/Dual/reflectionTextureBaseBlock";
  22981. import { RefractionBlock } from "babylonjs/Materials/Node/Blocks/PBR/refractionBlock";
  22982. import { CurrentScreenBlock } from "babylonjs/Materials/Node/Blocks/Dual/currentScreenBlock";
  22983. import { ParticleTextureBlock } from "babylonjs/Materials/Node/Blocks/Particle/particleTextureBlock";
  22984. import { Effect } from "babylonjs/Materials/effect";
  22985. import { PostProcess, PostProcessOptions } from "babylonjs/PostProcesses/postProcess";
  22986. import { Camera } from "babylonjs/Cameras/camera";
  22987. import { NodeMaterialModes } from "babylonjs/Materials/Node/Enums/nodeMaterialModes";
  22988. import { IParticleSystem } from "babylonjs/Particles/IParticleSystem";
  22989. /**
  22990. * Interface used to configure the node material editor
  22991. */
  22992. export interface INodeMaterialEditorOptions {
  22993. /** Define the URl to load node editor script */
  22994. editorURL?: string;
  22995. }
  22996. /** @hidden */
  22997. export class NodeMaterialDefines extends MaterialDefines implements IImageProcessingConfigurationDefines {
  22998. NORMAL: boolean;
  22999. TANGENT: boolean;
  23000. UV1: boolean;
  23001. /** BONES */
  23002. NUM_BONE_INFLUENCERS: number;
  23003. BonesPerMesh: number;
  23004. BONETEXTURE: boolean;
  23005. /** MORPH TARGETS */
  23006. MORPHTARGETS: boolean;
  23007. MORPHTARGETS_NORMAL: boolean;
  23008. MORPHTARGETS_TANGENT: boolean;
  23009. MORPHTARGETS_UV: boolean;
  23010. NUM_MORPH_INFLUENCERS: number;
  23011. /** IMAGE PROCESSING */
  23012. IMAGEPROCESSING: boolean;
  23013. VIGNETTE: boolean;
  23014. VIGNETTEBLENDMODEMULTIPLY: boolean;
  23015. VIGNETTEBLENDMODEOPAQUE: boolean;
  23016. TONEMAPPING: boolean;
  23017. TONEMAPPING_ACES: boolean;
  23018. CONTRAST: boolean;
  23019. EXPOSURE: boolean;
  23020. COLORCURVES: boolean;
  23021. COLORGRADING: boolean;
  23022. COLORGRADING3D: boolean;
  23023. SAMPLER3DGREENDEPTH: boolean;
  23024. SAMPLER3DBGRMAP: boolean;
  23025. IMAGEPROCESSINGPOSTPROCESS: boolean;
  23026. /** MISC. */
  23027. BUMPDIRECTUV: number;
  23028. constructor();
  23029. setValue(name: string, value: any, markAsUnprocessedIfDirty?: boolean): void;
  23030. }
  23031. /**
  23032. * Class used to configure NodeMaterial
  23033. */
  23034. export interface INodeMaterialOptions {
  23035. /**
  23036. * Defines if blocks should emit comments
  23037. */
  23038. emitComments: boolean;
  23039. }
  23040. /**
  23041. * Class used to create a node based material built by assembling shader blocks
  23042. */
  23043. export class NodeMaterial extends PushMaterial {
  23044. private static _BuildIdGenerator;
  23045. private _options;
  23046. private _vertexCompilationState;
  23047. private _fragmentCompilationState;
  23048. private _sharedData;
  23049. private _buildId;
  23050. private _buildWasSuccessful;
  23051. private _cachedWorldViewMatrix;
  23052. private _cachedWorldViewProjectionMatrix;
  23053. private _optimizers;
  23054. private _animationFrame;
  23055. /** Define the Url to load node editor script */
  23056. static EditorURL: string;
  23057. /** Define the Url to load snippets */
  23058. static SnippetUrl: string;
  23059. /** Gets or sets a boolean indicating that node materials should not deserialize textures from json / snippet content */
  23060. static IgnoreTexturesAtLoadTime: boolean;
  23061. private BJSNODEMATERIALEDITOR;
  23062. /** Get the inspector from bundle or global */
  23063. private _getGlobalNodeMaterialEditor;
  23064. /**
  23065. * Snippet ID if the material was created from the snippet server
  23066. */
  23067. snippetId: string;
  23068. /**
  23069. * Gets or sets data used by visual editor
  23070. * @see https://nme.babylonjs.com
  23071. */
  23072. editorData: any;
  23073. /**
  23074. * Gets or sets a boolean indicating that alpha value must be ignored (This will turn alpha blending off even if an alpha value is produced by the material)
  23075. */
  23076. ignoreAlpha: boolean;
  23077. /**
  23078. * Defines the maximum number of lights that can be used in the material
  23079. */
  23080. maxSimultaneousLights: number;
  23081. /**
  23082. * Observable raised when the material is built
  23083. */
  23084. onBuildObservable: Observable<NodeMaterial>;
  23085. /**
  23086. * Gets or sets the root nodes of the material vertex shader
  23087. */
  23088. _vertexOutputNodes: NodeMaterialBlock[];
  23089. /**
  23090. * Gets or sets the root nodes of the material fragment (pixel) shader
  23091. */
  23092. _fragmentOutputNodes: NodeMaterialBlock[];
  23093. /** Gets or sets options to control the node material overall behavior */
  23094. get options(): INodeMaterialOptions;
  23095. set options(options: INodeMaterialOptions);
  23096. /**
  23097. * Default configuration related to image processing available in the standard Material.
  23098. */
  23099. protected _imageProcessingConfiguration: ImageProcessingConfiguration;
  23100. /**
  23101. * Gets the image processing configuration used either in this material.
  23102. */
  23103. get imageProcessingConfiguration(): ImageProcessingConfiguration;
  23104. /**
  23105. * Sets the Default image processing configuration used either in the this material.
  23106. *
  23107. * If sets to null, the scene one is in use.
  23108. */
  23109. set imageProcessingConfiguration(value: ImageProcessingConfiguration);
  23110. /**
  23111. * Gets an array of blocks that needs to be serialized even if they are not yet connected
  23112. */
  23113. attachedBlocks: NodeMaterialBlock[];
  23114. /**
  23115. * Specifies the mode of the node material
  23116. * @hidden
  23117. */
  23118. _mode: NodeMaterialModes;
  23119. /**
  23120. * Gets the mode property
  23121. */
  23122. get mode(): NodeMaterialModes;
  23123. /**
  23124. * Create a new node based material
  23125. * @param name defines the material name
  23126. * @param scene defines the hosting scene
  23127. * @param options defines creation option
  23128. */
  23129. constructor(name: string, scene?: Scene, options?: Partial<INodeMaterialOptions>);
  23130. /**
  23131. * Gets the current class name of the material e.g. "NodeMaterial"
  23132. * @returns the class name
  23133. */
  23134. getClassName(): string;
  23135. /**
  23136. * Keep track of the image processing observer to allow dispose and replace.
  23137. */
  23138. private _imageProcessingObserver;
  23139. /**
  23140. * Attaches a new image processing configuration to the Standard Material.
  23141. * @param configuration
  23142. */
  23143. protected _attachImageProcessingConfiguration(configuration: Nullable<ImageProcessingConfiguration>): void;
  23144. /**
  23145. * Get a block by its name
  23146. * @param name defines the name of the block to retrieve
  23147. * @returns the required block or null if not found
  23148. */
  23149. getBlockByName(name: string): Nullable<NodeMaterialBlock>;
  23150. /**
  23151. * Get a block by its name
  23152. * @param predicate defines the predicate used to find the good candidate
  23153. * @returns the required block or null if not found
  23154. */
  23155. getBlockByPredicate(predicate: (block: NodeMaterialBlock) => boolean): Nullable<NodeMaterialBlock>;
  23156. /**
  23157. * Get an input block by its name
  23158. * @param predicate defines the predicate used to find the good candidate
  23159. * @returns the required input block or null if not found
  23160. */
  23161. getInputBlockByPredicate(predicate: (block: InputBlock) => boolean): Nullable<InputBlock>;
  23162. /**
  23163. * Gets the list of input blocks attached to this material
  23164. * @returns an array of InputBlocks
  23165. */
  23166. getInputBlocks(): InputBlock[];
  23167. /**
  23168. * Adds a new optimizer to the list of optimizers
  23169. * @param optimizer defines the optimizers to add
  23170. * @returns the current material
  23171. */
  23172. registerOptimizer(optimizer: NodeMaterialOptimizer): this | undefined;
  23173. /**
  23174. * Remove an optimizer from the list of optimizers
  23175. * @param optimizer defines the optimizers to remove
  23176. * @returns the current material
  23177. */
  23178. unregisterOptimizer(optimizer: NodeMaterialOptimizer): this | undefined;
  23179. /**
  23180. * Add a new block to the list of output nodes
  23181. * @param node defines the node to add
  23182. * @returns the current material
  23183. */
  23184. addOutputNode(node: NodeMaterialBlock): this;
  23185. /**
  23186. * Remove a block from the list of root nodes
  23187. * @param node defines the node to remove
  23188. * @returns the current material
  23189. */
  23190. removeOutputNode(node: NodeMaterialBlock): this;
  23191. private _addVertexOutputNode;
  23192. private _removeVertexOutputNode;
  23193. private _addFragmentOutputNode;
  23194. private _removeFragmentOutputNode;
  23195. /**
  23196. * Specifies if the material will require alpha blending
  23197. * @returns a boolean specifying if alpha blending is needed
  23198. */
  23199. needAlphaBlending(): boolean;
  23200. /**
  23201. * Specifies if this material should be rendered in alpha test mode
  23202. * @returns a boolean specifying if an alpha test is needed.
  23203. */
  23204. needAlphaTesting(): boolean;
  23205. private _initializeBlock;
  23206. private _resetDualBlocks;
  23207. /**
  23208. * Remove a block from the current node material
  23209. * @param block defines the block to remove
  23210. */
  23211. removeBlock(block: NodeMaterialBlock): void;
  23212. /**
  23213. * Build the material and generates the inner effect
  23214. * @param verbose defines if the build should log activity
  23215. */
  23216. build(verbose?: boolean): void;
  23217. /**
  23218. * Runs an otpimization phase to try to improve the shader code
  23219. */
  23220. optimize(): void;
  23221. private _prepareDefinesForAttributes;
  23222. /**
  23223. * Create a post process from the material
  23224. * @param camera The camera to apply the render pass to.
  23225. * @param options The required width/height ratio to downsize to before computing the render pass. (Use 1.0 for full size)
  23226. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  23227. * @param engine The engine which the post process will be applied. (default: current engine)
  23228. * @param reusable If the post process can be reused on the same frame. (default: false)
  23229. * @param textureType Type of textures used when performing the post process. (default: 0)
  23230. * @param textureFormat Format of textures used when performing the post process. (default: TEXTUREFORMAT_RGBA)
  23231. * @returns the post process created
  23232. */
  23233. createPostProcess(camera: Nullable<Camera>, options?: number | PostProcessOptions, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number, textureFormat?: number): PostProcess;
  23234. /**
  23235. * Create the post process effect from the material
  23236. * @param postProcess The post process to create the effect for
  23237. */
  23238. createEffectForPostProcess(postProcess: PostProcess): void;
  23239. private _createEffectOrPostProcess;
  23240. private _createEffectForParticles;
  23241. /**
  23242. * Create the effect to be used as the custom effect for a particle system
  23243. * @param particleSystem Particle system to create the effect for
  23244. * @param onCompiled defines a function to call when the effect creation is successful
  23245. * @param onError defines a function to call when the effect creation has failed
  23246. */
  23247. createEffectForParticles(particleSystem: IParticleSystem, onCompiled?: (effect: Effect) => void, onError?: (effect: Effect, errors: string) => void): void;
  23248. private _processDefines;
  23249. /**
  23250. * Get if the submesh is ready to be used and all its information available.
  23251. * Child classes can use it to update shaders
  23252. * @param mesh defines the mesh to check
  23253. * @param subMesh defines which submesh to check
  23254. * @param useInstances specifies that instances should be used
  23255. * @returns a boolean indicating that the submesh is ready or not
  23256. */
  23257. isReadyForSubMesh(mesh: AbstractMesh, subMesh: SubMesh, useInstances?: boolean): boolean;
  23258. /**
  23259. * Get a string representing the shaders built by the current node graph
  23260. */
  23261. get compiledShaders(): string;
  23262. /**
  23263. * Binds the world matrix to the material
  23264. * @param world defines the world transformation matrix
  23265. */
  23266. bindOnlyWorldMatrix(world: Matrix): void;
  23267. /**
  23268. * Binds the submesh to this material by preparing the effect and shader to draw
  23269. * @param world defines the world transformation matrix
  23270. * @param mesh defines the mesh containing the submesh
  23271. * @param subMesh defines the submesh to bind the material to
  23272. */
  23273. bindForSubMesh(world: Matrix, mesh: Mesh, subMesh: SubMesh): void;
  23274. /**
  23275. * Gets the active textures from the material
  23276. * @returns an array of textures
  23277. */
  23278. getActiveTextures(): BaseTexture[];
  23279. /**
  23280. * Gets the list of texture blocks
  23281. * @returns an array of texture blocks
  23282. */
  23283. getTextureBlocks(): (TextureBlock | ReflectionTextureBaseBlock | RefractionBlock | CurrentScreenBlock | ParticleTextureBlock)[];
  23284. /**
  23285. * Specifies if the material uses a texture
  23286. * @param texture defines the texture to check against the material
  23287. * @returns a boolean specifying if the material uses the texture
  23288. */
  23289. hasTexture(texture: BaseTexture): boolean;
  23290. /**
  23291. * Disposes the material
  23292. * @param forceDisposeEffect specifies if effects should be forcefully disposed
  23293. * @param forceDisposeTextures specifies if textures should be forcefully disposed
  23294. * @param notBoundToMesh specifies if the material that is being disposed is known to be not bound to any mesh
  23295. */
  23296. dispose(forceDisposeEffect?: boolean, forceDisposeTextures?: boolean, notBoundToMesh?: boolean): void;
  23297. /** Creates the node editor window. */
  23298. private _createNodeEditor;
  23299. /**
  23300. * Launch the node material editor
  23301. * @param config Define the configuration of the editor
  23302. * @return a promise fulfilled when the node editor is visible
  23303. */
  23304. edit(config?: INodeMaterialEditorOptions): Promise<void>;
  23305. /**
  23306. * Clear the current material
  23307. */
  23308. clear(): void;
  23309. /**
  23310. * Clear the current material and set it to a default state
  23311. */
  23312. setToDefault(): void;
  23313. /**
  23314. * Clear the current material and set it to a default state for post process
  23315. */
  23316. setToDefaultPostProcess(): void;
  23317. /**
  23318. * Clear the current material and set it to a default state for particle
  23319. */
  23320. setToDefaultParticle(): void;
  23321. /**
  23322. * Loads the current Node Material from a url pointing to a file save by the Node Material Editor
  23323. * @param url defines the url to load from
  23324. * @returns a promise that will fullfil when the material is fully loaded
  23325. */
  23326. loadAsync(url: string): Promise<void>;
  23327. private _gatherBlocks;
  23328. /**
  23329. * Generate a string containing the code declaration required to create an equivalent of this material
  23330. * @returns a string
  23331. */
  23332. generateCode(): string;
  23333. /**
  23334. * Serializes this material in a JSON representation
  23335. * @returns the serialized material object
  23336. */
  23337. serialize(selectedBlocks?: NodeMaterialBlock[]): any;
  23338. private _restoreConnections;
  23339. /**
  23340. * Clear the current graph and load a new one from a serialization object
  23341. * @param source defines the JSON representation of the material
  23342. * @param rootUrl defines the root URL to use to load textures and relative dependencies
  23343. * @param merge defines whether or not the source must be merged or replace the current content
  23344. */
  23345. loadFromSerialization(source: any, rootUrl?: string, merge?: boolean): void;
  23346. /**
  23347. * Makes a duplicate of the current material.
  23348. * @param name - name to use for the new material.
  23349. */
  23350. clone(name: string): NodeMaterial;
  23351. /**
  23352. * Creates a node material from parsed material data
  23353. * @param source defines the JSON representation of the material
  23354. * @param scene defines the hosting scene
  23355. * @param rootUrl defines the root URL to use to load textures and relative dependencies
  23356. * @returns a new node material
  23357. */
  23358. static Parse(source: any, scene: Scene, rootUrl?: string): NodeMaterial;
  23359. /**
  23360. * Creates a node material from a snippet saved in a remote file
  23361. * @param name defines the name of the material to create
  23362. * @param url defines the url to load from
  23363. * @param scene defines the hosting scene
  23364. * @returns a promise that will resolve to the new node material
  23365. */
  23366. static ParseFromFileAsync(name: string, url: string, scene: Scene): Promise<NodeMaterial>;
  23367. /**
  23368. * Creates a node material from a snippet saved by the node material editor
  23369. * @param snippetId defines the snippet to load
  23370. * @param scene defines the hosting scene
  23371. * @param rootUrl defines the root URL to use to load textures and relative dependencies
  23372. * @param nodeMaterial defines a node material to update (instead of creating a new one)
  23373. * @returns a promise that will resolve to the new node material
  23374. */
  23375. static ParseFromSnippetAsync(snippetId: string, scene: Scene, rootUrl?: string, nodeMaterial?: NodeMaterial): Promise<NodeMaterial>;
  23376. /**
  23377. * Creates a new node material set to default basic configuration
  23378. * @param name defines the name of the material
  23379. * @param scene defines the hosting scene
  23380. * @returns a new NodeMaterial
  23381. */
  23382. static CreateDefault(name: string, scene?: Scene): NodeMaterial;
  23383. }
  23384. }
  23385. declare module "babylonjs/PostProcesses/postProcess" {
  23386. import { Nullable } from "babylonjs/types";
  23387. import { SmartArray } from "babylonjs/Misc/smartArray";
  23388. import { Observable } from "babylonjs/Misc/observable";
  23389. import { Vector2 } from "babylonjs/Maths/math.vector";
  23390. import { Camera } from "babylonjs/Cameras/camera";
  23391. import { Effect } from "babylonjs/Materials/effect";
  23392. import "babylonjs/Shaders/postprocess.vertex";
  23393. import { IInspectable } from "babylonjs/Misc/iInspectable";
  23394. import { Engine } from "babylonjs/Engines/engine";
  23395. import { Color4 } from "babylonjs/Maths/math.color";
  23396. import "babylonjs/Engines/Extensions/engine.renderTarget";
  23397. import { NodeMaterial } from "babylonjs/Materials/Node/nodeMaterial";
  23398. import { Scene } from "babylonjs/scene";
  23399. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  23400. /**
  23401. * Size options for a post process
  23402. */
  23403. export type PostProcessOptions = {
  23404. width: number;
  23405. height: number;
  23406. };
  23407. /**
  23408. * PostProcess can be used to apply a shader to a texture after it has been rendered
  23409. * See https://doc.babylonjs.com/how_to/how_to_use_postprocesses
  23410. */
  23411. export class PostProcess {
  23412. /**
  23413. * Gets or sets the unique id of the post process
  23414. */
  23415. uniqueId: number;
  23416. /** Name of the PostProcess. */
  23417. name: string;
  23418. /**
  23419. * Width of the texture to apply the post process on
  23420. */
  23421. width: number;
  23422. /**
  23423. * Height of the texture to apply the post process on
  23424. */
  23425. height: number;
  23426. /**
  23427. * Gets the node material used to create this postprocess (null if the postprocess was manually created)
  23428. */
  23429. nodeMaterialSource: Nullable<NodeMaterial>;
  23430. /**
  23431. * Internal, reference to the location where this postprocess was output to. (Typically the texture on the next postprocess in the chain)
  23432. * @hidden
  23433. */
  23434. _outputTexture: Nullable<InternalTexture>;
  23435. /**
  23436. * Sampling mode used by the shader
  23437. * See https://doc.babylonjs.com/classes/3.1/texture
  23438. */
  23439. renderTargetSamplingMode: number;
  23440. /**
  23441. * Clear color to use when screen clearing
  23442. */
  23443. clearColor: Color4;
  23444. /**
  23445. * If the buffer needs to be cleared before applying the post process. (default: true)
  23446. * Should be set to false if shader will overwrite all previous pixels.
  23447. */
  23448. autoClear: boolean;
  23449. /**
  23450. * Type of alpha mode to use when performing the post process (default: Engine.ALPHA_DISABLE)
  23451. */
  23452. alphaMode: number;
  23453. /**
  23454. * Sets the setAlphaBlendConstants of the babylon engine
  23455. */
  23456. alphaConstants: Color4;
  23457. /**
  23458. * Animations to be used for the post processing
  23459. */
  23460. animations: import("babylonjs/Animations/animation").Animation[];
  23461. /**
  23462. * Enable Pixel Perfect mode where texture is not scaled to be power of 2.
  23463. * Can only be used on a single postprocess or on the last one of a chain. (default: false)
  23464. */
  23465. enablePixelPerfectMode: boolean;
  23466. /**
  23467. * Force the postprocess to be applied without taking in account viewport
  23468. */
  23469. forceFullscreenViewport: boolean;
  23470. /**
  23471. * List of inspectable custom properties (used by the Inspector)
  23472. * @see https://doc.babylonjs.com/how_to/debug_layer#extensibility
  23473. */
  23474. inspectableCustomProperties: IInspectable[];
  23475. /**
  23476. * Scale mode for the post process (default: Engine.SCALEMODE_FLOOR)
  23477. *
  23478. * | Value | Type | Description |
  23479. * | ----- | ----------------------------------- | ----------- |
  23480. * | 1 | SCALEMODE_FLOOR | [engine.scalemode_floor](https://doc.babylonjs.com/api/classes/babylon.engine#scalemode_floor) |
  23481. * | 2 | SCALEMODE_NEAREST | [engine.scalemode_nearest](https://doc.babylonjs.com/api/classes/babylon.engine#scalemode_nearest) |
  23482. * | 3 | SCALEMODE_CEILING | [engine.scalemode_ceiling](https://doc.babylonjs.com/api/classes/babylon.engine#scalemode_ceiling) |
  23483. *
  23484. */
  23485. scaleMode: number;
  23486. /**
  23487. * Force textures to be a power of two (default: false)
  23488. */
  23489. alwaysForcePOT: boolean;
  23490. private _samples;
  23491. /**
  23492. * Number of sample textures (default: 1)
  23493. */
  23494. get samples(): number;
  23495. set samples(n: number);
  23496. /**
  23497. * Modify the scale of the post process to be the same as the viewport (default: false)
  23498. */
  23499. adaptScaleToCurrentViewport: boolean;
  23500. private _camera;
  23501. protected _scene: Scene;
  23502. private _engine;
  23503. private _options;
  23504. private _reusable;
  23505. private _textureType;
  23506. private _textureFormat;
  23507. /**
  23508. * Smart array of input and output textures for the post process.
  23509. * @hidden
  23510. */
  23511. _textures: SmartArray<import("babylonjs/Materials/Textures/internalTexture").InternalTexture>;
  23512. /**
  23513. * The index in _textures that corresponds to the output texture.
  23514. * @hidden
  23515. */
  23516. _currentRenderTextureInd: number;
  23517. private _effect;
  23518. private _samplers;
  23519. private _fragmentUrl;
  23520. private _vertexUrl;
  23521. private _parameters;
  23522. private _scaleRatio;
  23523. protected _indexParameters: any;
  23524. private _shareOutputWithPostProcess;
  23525. private _texelSize;
  23526. private _forcedOutputTexture;
  23527. /**
  23528. * Returns the fragment url or shader name used in the post process.
  23529. * @returns the fragment url or name in the shader store.
  23530. */
  23531. getEffectName(): string;
  23532. /**
  23533. * An event triggered when the postprocess is activated.
  23534. */
  23535. onActivateObservable: Observable<Camera>;
  23536. private _onActivateObserver;
  23537. /**
  23538. * A function that is added to the onActivateObservable
  23539. */
  23540. set onActivate(callback: Nullable<(camera: Camera) => void>);
  23541. /**
  23542. * An event triggered when the postprocess changes its size.
  23543. */
  23544. onSizeChangedObservable: Observable<PostProcess>;
  23545. private _onSizeChangedObserver;
  23546. /**
  23547. * A function that is added to the onSizeChangedObservable
  23548. */
  23549. set onSizeChanged(callback: (postProcess: PostProcess) => void);
  23550. /**
  23551. * An event triggered when the postprocess applies its effect.
  23552. */
  23553. onApplyObservable: Observable<Effect>;
  23554. private _onApplyObserver;
  23555. /**
  23556. * A function that is added to the onApplyObservable
  23557. */
  23558. set onApply(callback: (effect: Effect) => void);
  23559. /**
  23560. * An event triggered before rendering the postprocess
  23561. */
  23562. onBeforeRenderObservable: Observable<Effect>;
  23563. private _onBeforeRenderObserver;
  23564. /**
  23565. * A function that is added to the onBeforeRenderObservable
  23566. */
  23567. set onBeforeRender(callback: (effect: Effect) => void);
  23568. /**
  23569. * An event triggered after rendering the postprocess
  23570. */
  23571. onAfterRenderObservable: Observable<Effect>;
  23572. private _onAfterRenderObserver;
  23573. /**
  23574. * A function that is added to the onAfterRenderObservable
  23575. */
  23576. set onAfterRender(callback: (efect: Effect) => void);
  23577. /**
  23578. * The input texture for this post process and the output texture of the previous post process. When added to a pipeline the previous post process will
  23579. * render it's output into this texture and this texture will be used as textureSampler in the fragment shader of this post process.
  23580. */
  23581. get inputTexture(): InternalTexture;
  23582. set inputTexture(value: InternalTexture);
  23583. /**
  23584. * Since inputTexture should always be defined, if we previously manually set `inputTexture`,
  23585. * the only way to unset it is to use this function to restore its internal state
  23586. */
  23587. restoreDefaultInputTexture(): void;
  23588. /**
  23589. * Gets the camera which post process is applied to.
  23590. * @returns The camera the post process is applied to.
  23591. */
  23592. getCamera(): Camera;
  23593. /**
  23594. * Gets the texel size of the postprocess.
  23595. * See https://en.wikipedia.org/wiki/Texel_(graphics)
  23596. */
  23597. get texelSize(): Vector2;
  23598. /**
  23599. * Creates a new instance PostProcess
  23600. * @param name The name of the PostProcess.
  23601. * @param fragmentUrl The url of the fragment shader to be used.
  23602. * @param parameters Array of the names of uniform non-sampler2D variables that will be passed to the shader.
  23603. * @param samplers Array of the names of uniform sampler2D variables that will be passed to the shader.
  23604. * @param options The required width/height ratio to downsize to before computing the render pass. (Use 1.0 for full size)
  23605. * @param camera The camera to apply the render pass to.
  23606. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  23607. * @param engine The engine which the post process will be applied. (default: current engine)
  23608. * @param reusable If the post process can be reused on the same frame. (default: false)
  23609. * @param defines String of defines that will be set when running the fragment shader. (default: null)
  23610. * @param textureType Type of textures used when performing the post process. (default: 0)
  23611. * @param vertexUrl The url of the vertex shader to be used. (default: "postprocess")
  23612. * @param indexParameters The index parameters to be used for babylons include syntax "#include<kernelBlurVaryingDeclaration>[0..varyingCount]". (default: undefined) See usage in babylon.blurPostProcess.ts and kernelBlur.vertex.fx
  23613. * @param blockCompilation If the shader should not be compiled imediatly. (default: false)
  23614. * @param textureFormat Format of textures used when performing the post process. (default: TEXTUREFORMAT_RGBA)
  23615. */
  23616. constructor(name: string, fragmentUrl: string, parameters: Nullable<string[]>, samplers: Nullable<string[]>, options: number | PostProcessOptions, camera: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, defines?: Nullable<string>, textureType?: number, vertexUrl?: string, indexParameters?: any, blockCompilation?: boolean, textureFormat?: number);
  23617. /**
  23618. * Gets a string identifying the name of the class
  23619. * @returns "PostProcess" string
  23620. */
  23621. getClassName(): string;
  23622. /**
  23623. * Gets the engine which this post process belongs to.
  23624. * @returns The engine the post process was enabled with.
  23625. */
  23626. getEngine(): Engine;
  23627. /**
  23628. * The effect that is created when initializing the post process.
  23629. * @returns The created effect corresponding the the postprocess.
  23630. */
  23631. getEffect(): Effect;
  23632. /**
  23633. * To avoid multiple redundant textures for multiple post process, the output the output texture for this post process can be shared with another.
  23634. * @param postProcess The post process to share the output with.
  23635. * @returns This post process.
  23636. */
  23637. shareOutputWith(postProcess: PostProcess): PostProcess;
  23638. /**
  23639. * Reverses the effect of calling shareOutputWith and returns the post process back to its original state.
  23640. * This should be called if the post process that shares output with this post process is disabled/disposed.
  23641. */
  23642. useOwnOutput(): void;
  23643. /**
  23644. * Updates the effect with the current post process compile time values and recompiles the shader.
  23645. * @param defines Define statements that should be added at the beginning of the shader. (default: null)
  23646. * @param uniforms Set of uniform variables that will be passed to the shader. (default: null)
  23647. * @param samplers Set of Texture2D variables that will be passed to the shader. (default: null)
  23648. * @param indexParameters The index parameters to be used for babylons include syntax "#include<kernelBlurVaryingDeclaration>[0..varyingCount]". (default: undefined) See usage in babylon.blurPostProcess.ts and kernelBlur.vertex.fx
  23649. * @param onCompiled Called when the shader has been compiled.
  23650. * @param onError Called if there is an error when compiling a shader.
  23651. * @param vertexUrl The url of the vertex shader to be used (default: the one given at construction time)
  23652. * @param fragmentUrl The url of the fragment shader to be used (default: the one given at construction time)
  23653. */
  23654. updateEffect(defines?: Nullable<string>, uniforms?: Nullable<string[]>, samplers?: Nullable<string[]>, indexParameters?: any, onCompiled?: (effect: Effect) => void, onError?: (effect: Effect, errors: string) => void, vertexUrl?: string, fragmentUrl?: string): void;
  23655. /**
  23656. * The post process is reusable if it can be used multiple times within one frame.
  23657. * @returns If the post process is reusable
  23658. */
  23659. isReusable(): boolean;
  23660. /** invalidate frameBuffer to hint the postprocess to create a depth buffer */
  23661. markTextureDirty(): void;
  23662. /**
  23663. * Activates the post process by intializing the textures to be used when executed. Notifies onActivateObservable.
  23664. * When this post process is used in a pipeline, this is call will bind the input texture of this post process to the output of the previous.
  23665. * @param camera The camera that will be used in the post process. This camera will be used when calling onActivateObservable.
  23666. * @param sourceTexture The source texture to be inspected to get the width and height if not specified in the post process constructor. (default: null)
  23667. * @param forceDepthStencil If true, a depth and stencil buffer will be generated. (default: false)
  23668. * @returns The target texture that was bound to be written to.
  23669. */
  23670. activate(camera: Nullable<Camera>, sourceTexture?: Nullable<InternalTexture>, forceDepthStencil?: boolean): InternalTexture;
  23671. /**
  23672. * If the post process is supported.
  23673. */
  23674. get isSupported(): boolean;
  23675. /**
  23676. * The aspect ratio of the output texture.
  23677. */
  23678. get aspectRatio(): number;
  23679. /**
  23680. * Get a value indicating if the post-process is ready to be used
  23681. * @returns true if the post-process is ready (shader is compiled)
  23682. */
  23683. isReady(): boolean;
  23684. /**
  23685. * Binds all textures and uniforms to the shader, this will be run on every pass.
  23686. * @returns the effect corresponding to this post process. Null if not compiled or not ready.
  23687. */
  23688. apply(): Nullable<Effect>;
  23689. private _disposeTextures;
  23690. /**
  23691. * Disposes the post process.
  23692. * @param camera The camera to dispose the post process on.
  23693. */
  23694. dispose(camera?: Camera): void;
  23695. /**
  23696. * Serializes the particle system to a JSON object
  23697. * @returns the JSON object
  23698. */
  23699. serialize(): any;
  23700. /**
  23701. * Creates a material from parsed material data
  23702. * @param parsedPostProcess defines parsed post process data
  23703. * @param scene defines the hosting scene
  23704. * @param rootUrl defines the root URL to use to load textures
  23705. * @returns a new post process
  23706. */
  23707. static Parse(parsedPostProcess: any, scene: Scene, rootUrl: string): Nullable<PostProcess>;
  23708. }
  23709. }
  23710. declare module "babylonjs/Shaders/ShadersInclude/kernelBlurVaryingDeclaration" {
  23711. /** @hidden */
  23712. export var kernelBlurVaryingDeclaration: {
  23713. name: string;
  23714. shader: string;
  23715. };
  23716. }
  23717. declare module "babylonjs/Shaders/ShadersInclude/kernelBlurFragment" {
  23718. /** @hidden */
  23719. export var kernelBlurFragment: {
  23720. name: string;
  23721. shader: string;
  23722. };
  23723. }
  23724. declare module "babylonjs/Shaders/ShadersInclude/kernelBlurFragment2" {
  23725. /** @hidden */
  23726. export var kernelBlurFragment2: {
  23727. name: string;
  23728. shader: string;
  23729. };
  23730. }
  23731. declare module "babylonjs/Shaders/kernelBlur.fragment" {
  23732. import "babylonjs/Shaders/ShadersInclude/kernelBlurVaryingDeclaration";
  23733. import "babylonjs/Shaders/ShadersInclude/packingFunctions";
  23734. import "babylonjs/Shaders/ShadersInclude/kernelBlurFragment";
  23735. import "babylonjs/Shaders/ShadersInclude/kernelBlurFragment2";
  23736. /** @hidden */
  23737. export var kernelBlurPixelShader: {
  23738. name: string;
  23739. shader: string;
  23740. };
  23741. }
  23742. declare module "babylonjs/Shaders/ShadersInclude/kernelBlurVertex" {
  23743. /** @hidden */
  23744. export var kernelBlurVertex: {
  23745. name: string;
  23746. shader: string;
  23747. };
  23748. }
  23749. declare module "babylonjs/Shaders/kernelBlur.vertex" {
  23750. import "babylonjs/Shaders/ShadersInclude/kernelBlurVaryingDeclaration";
  23751. import "babylonjs/Shaders/ShadersInclude/kernelBlurVertex";
  23752. /** @hidden */
  23753. export var kernelBlurVertexShader: {
  23754. name: string;
  23755. shader: string;
  23756. };
  23757. }
  23758. declare module "babylonjs/PostProcesses/blurPostProcess" {
  23759. import { Vector2 } from "babylonjs/Maths/math.vector";
  23760. import { Nullable } from "babylonjs/types";
  23761. import { PostProcess, PostProcessOptions } from "babylonjs/PostProcesses/postProcess";
  23762. import { Camera } from "babylonjs/Cameras/camera";
  23763. import { Effect } from "babylonjs/Materials/effect";
  23764. import { Engine } from "babylonjs/Engines/engine";
  23765. import "babylonjs/Shaders/kernelBlur.fragment";
  23766. import "babylonjs/Shaders/kernelBlur.vertex";
  23767. import { Scene } from "babylonjs/scene";
  23768. /**
  23769. * The Blur Post Process which blurs an image based on a kernel and direction.
  23770. * Can be used twice in x and y directions to perform a guassian blur in two passes.
  23771. */
  23772. export class BlurPostProcess extends PostProcess {
  23773. private blockCompilation;
  23774. protected _kernel: number;
  23775. protected _idealKernel: number;
  23776. protected _packedFloat: boolean;
  23777. private _staticDefines;
  23778. /** The direction in which to blur the image. */
  23779. direction: Vector2;
  23780. /**
  23781. * Sets the length in pixels of the blur sample region
  23782. */
  23783. set kernel(v: number);
  23784. /**
  23785. * Gets the length in pixels of the blur sample region
  23786. */
  23787. get kernel(): number;
  23788. /**
  23789. * Sets wether or not the blur needs to unpack/repack floats
  23790. */
  23791. set packedFloat(v: boolean);
  23792. /**
  23793. * Gets wether or not the blur is unpacking/repacking floats
  23794. */
  23795. get packedFloat(): boolean;
  23796. /**
  23797. * Gets a string identifying the name of the class
  23798. * @returns "BlurPostProcess" string
  23799. */
  23800. getClassName(): string;
  23801. /**
  23802. * Creates a new instance BlurPostProcess
  23803. * @param name The name of the effect.
  23804. * @param direction The direction in which to blur the image.
  23805. * @param kernel The size of the kernel to be used when computing the blur. eg. Size of 3 will blur the center pixel by 2 pixels surrounding it.
  23806. * @param options The required width/height ratio to downsize to before computing the render pass. (Use 1.0 for full size)
  23807. * @param camera The camera to apply the render pass to.
  23808. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  23809. * @param engine The engine which the post process will be applied. (default: current engine)
  23810. * @param reusable If the post process can be reused on the same frame. (default: false)
  23811. * @param textureType Type of textures used when performing the post process. (default: 0)
  23812. * @param blockCompilation If compilation of the shader should not be done in the constructor. The updateEffect method can be used to compile the shader at a later time. (default: false)
  23813. */
  23814. constructor(name: string, direction: Vector2, kernel: number, options: number | PostProcessOptions, camera: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number, defines?: string, blockCompilation?: boolean);
  23815. /**
  23816. * Updates the effect with the current post process compile time values and recompiles the shader.
  23817. * @param defines Define statements that should be added at the beginning of the shader. (default: null)
  23818. * @param uniforms Set of uniform variables that will be passed to the shader. (default: null)
  23819. * @param samplers Set of Texture2D variables that will be passed to the shader. (default: null)
  23820. * @param indexParameters The index parameters to be used for babylons include syntax "#include<kernelBlurVaryingDeclaration>[0..varyingCount]". (default: undefined) See usage in babylon.blurPostProcess.ts and kernelBlur.vertex.fx
  23821. * @param onCompiled Called when the shader has been compiled.
  23822. * @param onError Called if there is an error when compiling a shader.
  23823. */
  23824. updateEffect(defines?: Nullable<string>, uniforms?: Nullable<string[]>, samplers?: Nullable<string[]>, indexParameters?: any, onCompiled?: (effect: Effect) => void, onError?: (effect: Effect, errors: string) => void): void;
  23825. protected _updateParameters(onCompiled?: (effect: Effect) => void, onError?: (effect: Effect, errors: string) => void): void;
  23826. /**
  23827. * Best kernels are odd numbers that when divided by 2, their integer part is even, so 5, 9 or 13.
  23828. * Other odd kernels optimize correctly but require proportionally more samples, even kernels are
  23829. * possible but will produce minor visual artifacts. Since each new kernel requires a new shader we
  23830. * want to minimize kernel changes, having gaps between physical kernels is helpful in that regard.
  23831. * The gaps between physical kernels are compensated for in the weighting of the samples
  23832. * @param idealKernel Ideal blur kernel.
  23833. * @return Nearest best kernel.
  23834. */
  23835. protected _nearestBestKernel(idealKernel: number): number;
  23836. /**
  23837. * Calculates the value of a Gaussian distribution with sigma 3 at a given point.
  23838. * @param x The point on the Gaussian distribution to sample.
  23839. * @return the value of the Gaussian function at x.
  23840. */
  23841. protected _gaussianWeight(x: number): number;
  23842. /**
  23843. * Generates a string that can be used as a floating point number in GLSL.
  23844. * @param x Value to print.
  23845. * @param decimalFigures Number of decimal places to print the number to (excluding trailing 0s).
  23846. * @return GLSL float string.
  23847. */
  23848. protected _glslFloat(x: number, decimalFigures?: number): string;
  23849. /** @hidden */
  23850. static _Parse(parsedPostProcess: any, targetCamera: Camera, scene: Scene, rootUrl: string): Nullable<BlurPostProcess>;
  23851. }
  23852. }
  23853. declare module "babylonjs/Materials/Textures/mirrorTexture" {
  23854. import { Scene } from "babylonjs/scene";
  23855. import { RenderTargetTexture } from "babylonjs/Materials/Textures/renderTargetTexture";
  23856. import { Plane } from "babylonjs/Maths/math.plane";
  23857. /**
  23858. * Mirror texture can be used to simulate the view from a mirror in a scene.
  23859. * It will dynamically be rendered every frame to adapt to the camera point of view.
  23860. * You can then easily use it as a reflectionTexture on a flat surface.
  23861. * In case the surface is not a plane, please consider relying on reflection probes.
  23862. * @see https://doc.babylonjs.com/how_to/reflect#mirrors
  23863. */
  23864. export class MirrorTexture extends RenderTargetTexture {
  23865. private scene;
  23866. /**
  23867. * Define the reflection plane we want to use. The mirrorPlane is usually set to the constructed reflector.
  23868. * It is possible to directly set the mirrorPlane by directly using a Plane(a, b, c, d) where a, b and c give the plane normal vector (a, b, c) and d is a scalar displacement from the mirrorPlane to the origin. However in all but the very simplest of situations it is more straight forward to set it to the reflector as stated in the doc.
  23869. * @see https://doc.babylonjs.com/how_to/reflect#mirrors
  23870. */
  23871. mirrorPlane: Plane;
  23872. /**
  23873. * Define the blur ratio used to blur the reflection if needed.
  23874. */
  23875. set blurRatio(value: number);
  23876. get blurRatio(): number;
  23877. /**
  23878. * Define the adaptive blur kernel used to blur the reflection if needed.
  23879. * This will autocompute the closest best match for the `blurKernel`
  23880. */
  23881. set adaptiveBlurKernel(value: number);
  23882. /**
  23883. * Define the blur kernel used to blur the reflection if needed.
  23884. * Please consider using `adaptiveBlurKernel` as it could find the closest best value for you.
  23885. */
  23886. set blurKernel(value: number);
  23887. /**
  23888. * Define the blur kernel on the X Axis used to blur the reflection if needed.
  23889. * Please consider using `adaptiveBlurKernel` as it could find the closest best value for you.
  23890. */
  23891. set blurKernelX(value: number);
  23892. get blurKernelX(): number;
  23893. /**
  23894. * Define the blur kernel on the Y Axis used to blur the reflection if needed.
  23895. * Please consider using `adaptiveBlurKernel` as it could find the closest best value for you.
  23896. */
  23897. set blurKernelY(value: number);
  23898. get blurKernelY(): number;
  23899. private _autoComputeBlurKernel;
  23900. protected _onRatioRescale(): void;
  23901. private _updateGammaSpace;
  23902. private _imageProcessingConfigChangeObserver;
  23903. private _transformMatrix;
  23904. private _mirrorMatrix;
  23905. private _savedViewMatrix;
  23906. private _blurX;
  23907. private _blurY;
  23908. private _adaptiveBlurKernel;
  23909. private _blurKernelX;
  23910. private _blurKernelY;
  23911. private _blurRatio;
  23912. /**
  23913. * Instantiates a Mirror Texture.
  23914. * Mirror texture can be used to simulate the view from a mirror in a scene.
  23915. * It will dynamically be rendered every frame to adapt to the camera point of view.
  23916. * You can then easily use it as a reflectionTexture on a flat surface.
  23917. * In case the surface is not a plane, please consider relying on reflection probes.
  23918. * @see https://doc.babylonjs.com/how_to/reflect#mirrors
  23919. * @param name
  23920. * @param size
  23921. * @param scene
  23922. * @param generateMipMaps
  23923. * @param type
  23924. * @param samplingMode
  23925. * @param generateDepthBuffer
  23926. */
  23927. constructor(name: string, size: number | {
  23928. width: number;
  23929. height: number;
  23930. } | {
  23931. ratio: number;
  23932. }, scene: Scene, generateMipMaps?: boolean, type?: number, samplingMode?: number, generateDepthBuffer?: boolean);
  23933. private _preparePostProcesses;
  23934. /**
  23935. * Clone the mirror texture.
  23936. * @returns the cloned texture
  23937. */
  23938. clone(): MirrorTexture;
  23939. /**
  23940. * Serialize the texture to a JSON representation you could use in Parse later on
  23941. * @returns the serialized JSON representation
  23942. */
  23943. serialize(): any;
  23944. /**
  23945. * Dispose the texture and release its associated resources.
  23946. */
  23947. dispose(): void;
  23948. }
  23949. }
  23950. declare module "babylonjs/Materials/Textures/texture" {
  23951. import { Observable } from "babylonjs/Misc/observable";
  23952. import { Nullable } from "babylonjs/types";
  23953. import { Matrix } from "babylonjs/Maths/math.vector";
  23954. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  23955. import { IInspectable } from "babylonjs/Misc/iInspectable";
  23956. import { ThinEngine } from "babylonjs/Engines/thinEngine";
  23957. import { CubeTexture } from "babylonjs/Materials/Textures/cubeTexture";
  23958. import { MirrorTexture } from "babylonjs/Materials/Textures/mirrorTexture";
  23959. import { RenderTargetTexture } from "babylonjs/Materials/Textures/renderTargetTexture";
  23960. import { Scene } from "babylonjs/scene";
  23961. /**
  23962. * This represents a texture in babylon. It can be easily loaded from a network, base64 or html input.
  23963. * @see https://doc.babylonjs.com/babylon101/materials#texture
  23964. */
  23965. export class Texture extends BaseTexture {
  23966. /**
  23967. * Gets or sets a general boolean used to indicate that textures containing direct data (buffers) must be saved as part of the serialization process
  23968. */
  23969. static SerializeBuffers: boolean;
  23970. /** @hidden */
  23971. static _CubeTextureParser: (jsonTexture: any, scene: Scene, rootUrl: string) => CubeTexture;
  23972. /** @hidden */
  23973. static _CreateMirror: (name: string, renderTargetSize: number, scene: Scene, generateMipMaps: boolean) => MirrorTexture;
  23974. /** @hidden */
  23975. static _CreateRenderTargetTexture: (name: string, renderTargetSize: number, scene: Scene, generateMipMaps: boolean) => RenderTargetTexture;
  23976. /** nearest is mag = nearest and min = nearest and mip = linear */
  23977. static readonly NEAREST_SAMPLINGMODE: number;
  23978. /** nearest is mag = nearest and min = nearest and mip = linear */
  23979. static readonly NEAREST_NEAREST_MIPLINEAR: number;
  23980. /** Bilinear is mag = linear and min = linear and mip = nearest */
  23981. static readonly BILINEAR_SAMPLINGMODE: number;
  23982. /** Bilinear is mag = linear and min = linear and mip = nearest */
  23983. static readonly LINEAR_LINEAR_MIPNEAREST: number;
  23984. /** Trilinear is mag = linear and min = linear and mip = linear */
  23985. static readonly TRILINEAR_SAMPLINGMODE: number;
  23986. /** Trilinear is mag = linear and min = linear and mip = linear */
  23987. static readonly LINEAR_LINEAR_MIPLINEAR: number;
  23988. /** mag = nearest and min = nearest and mip = nearest */
  23989. static readonly NEAREST_NEAREST_MIPNEAREST: number;
  23990. /** mag = nearest and min = linear and mip = nearest */
  23991. static readonly NEAREST_LINEAR_MIPNEAREST: number;
  23992. /** mag = nearest and min = linear and mip = linear */
  23993. static readonly NEAREST_LINEAR_MIPLINEAR: number;
  23994. /** mag = nearest and min = linear and mip = none */
  23995. static readonly NEAREST_LINEAR: number;
  23996. /** mag = nearest and min = nearest and mip = none */
  23997. static readonly NEAREST_NEAREST: number;
  23998. /** mag = linear and min = nearest and mip = nearest */
  23999. static readonly LINEAR_NEAREST_MIPNEAREST: number;
  24000. /** mag = linear and min = nearest and mip = linear */
  24001. static readonly LINEAR_NEAREST_MIPLINEAR: number;
  24002. /** mag = linear and min = linear and mip = none */
  24003. static readonly LINEAR_LINEAR: number;
  24004. /** mag = linear and min = nearest and mip = none */
  24005. static readonly LINEAR_NEAREST: number;
  24006. /** Explicit coordinates mode */
  24007. static readonly EXPLICIT_MODE: number;
  24008. /** Spherical coordinates mode */
  24009. static readonly SPHERICAL_MODE: number;
  24010. /** Planar coordinates mode */
  24011. static readonly PLANAR_MODE: number;
  24012. /** Cubic coordinates mode */
  24013. static readonly CUBIC_MODE: number;
  24014. /** Projection coordinates mode */
  24015. static readonly PROJECTION_MODE: number;
  24016. /** Inverse Cubic coordinates mode */
  24017. static readonly SKYBOX_MODE: number;
  24018. /** Inverse Cubic coordinates mode */
  24019. static readonly INVCUBIC_MODE: number;
  24020. /** Equirectangular coordinates mode */
  24021. static readonly EQUIRECTANGULAR_MODE: number;
  24022. /** Equirectangular Fixed coordinates mode */
  24023. static readonly FIXED_EQUIRECTANGULAR_MODE: number;
  24024. /** Equirectangular Fixed Mirrored coordinates mode */
  24025. static readonly FIXED_EQUIRECTANGULAR_MIRRORED_MODE: number;
  24026. /** Texture is not repeating outside of 0..1 UVs */
  24027. static readonly CLAMP_ADDRESSMODE: number;
  24028. /** Texture is repeating outside of 0..1 UVs */
  24029. static readonly WRAP_ADDRESSMODE: number;
  24030. /** Texture is repeating and mirrored */
  24031. static readonly MIRROR_ADDRESSMODE: number;
  24032. /**
  24033. * Gets or sets a boolean which defines if the texture url must be build from the serialized URL instead of just using the name and loading them side by side with the scene file
  24034. */
  24035. static UseSerializedUrlIfAny: boolean;
  24036. /**
  24037. * Define the url of the texture.
  24038. */
  24039. url: Nullable<string>;
  24040. /**
  24041. * Define an offset on the texture to offset the u coordinates of the UVs
  24042. * @see https://doc.babylonjs.com/how_to/more_materials#offsetting
  24043. */
  24044. uOffset: number;
  24045. /**
  24046. * Define an offset on the texture to offset the v coordinates of the UVs
  24047. * @see https://doc.babylonjs.com/how_to/more_materials#offsetting
  24048. */
  24049. vOffset: number;
  24050. /**
  24051. * Define an offset on the texture to scale the u coordinates of the UVs
  24052. * @see https://doc.babylonjs.com/how_to/more_materials#tiling
  24053. */
  24054. uScale: number;
  24055. /**
  24056. * Define an offset on the texture to scale the v coordinates of the UVs
  24057. * @see https://doc.babylonjs.com/how_to/more_materials#tiling
  24058. */
  24059. vScale: number;
  24060. /**
  24061. * Define an offset on the texture to rotate around the u coordinates of the UVs
  24062. * @see https://doc.babylonjs.com/how_to/more_materials
  24063. */
  24064. uAng: number;
  24065. /**
  24066. * Define an offset on the texture to rotate around the v coordinates of the UVs
  24067. * @see https://doc.babylonjs.com/how_to/more_materials
  24068. */
  24069. vAng: number;
  24070. /**
  24071. * Define an offset on the texture to rotate around the w coordinates of the UVs (in case of 3d texture)
  24072. * @see https://doc.babylonjs.com/how_to/more_materials
  24073. */
  24074. wAng: number;
  24075. /**
  24076. * Defines the center of rotation (U)
  24077. */
  24078. uRotationCenter: number;
  24079. /**
  24080. * Defines the center of rotation (V)
  24081. */
  24082. vRotationCenter: number;
  24083. /**
  24084. * Defines the center of rotation (W)
  24085. */
  24086. wRotationCenter: number;
  24087. /**
  24088. * Are mip maps generated for this texture or not.
  24089. */
  24090. get noMipmap(): boolean;
  24091. /**
  24092. * List of inspectable custom properties (used by the Inspector)
  24093. * @see https://doc.babylonjs.com/how_to/debug_layer#extensibility
  24094. */
  24095. inspectableCustomProperties: Nullable<IInspectable[]>;
  24096. private _noMipmap;
  24097. /** @hidden */
  24098. _invertY: boolean;
  24099. private _rowGenerationMatrix;
  24100. private _cachedTextureMatrix;
  24101. private _projectionModeMatrix;
  24102. private _t0;
  24103. private _t1;
  24104. private _t2;
  24105. private _cachedUOffset;
  24106. private _cachedVOffset;
  24107. private _cachedUScale;
  24108. private _cachedVScale;
  24109. private _cachedUAng;
  24110. private _cachedVAng;
  24111. private _cachedWAng;
  24112. private _cachedProjectionMatrixId;
  24113. private _cachedCoordinatesMode;
  24114. /** @hidden */
  24115. protected _initialSamplingMode: number;
  24116. /** @hidden */
  24117. _buffer: Nullable<string | ArrayBuffer | ArrayBufferView | HTMLImageElement | Blob | ImageBitmap>;
  24118. private _deleteBuffer;
  24119. protected _format: Nullable<number>;
  24120. private _delayedOnLoad;
  24121. private _delayedOnError;
  24122. private _mimeType?;
  24123. /** Returns the texture mime type if it was defined by a loader (undefined else) */
  24124. get mimeType(): string | undefined;
  24125. /**
  24126. * Observable triggered once the texture has been loaded.
  24127. */
  24128. onLoadObservable: Observable<Texture>;
  24129. protected _isBlocking: boolean;
  24130. /**
  24131. * Is the texture preventing material to render while loading.
  24132. * If false, a default texture will be used instead of the loading one during the preparation step.
  24133. */
  24134. set isBlocking(value: boolean);
  24135. get isBlocking(): boolean;
  24136. /**
  24137. * Get the current sampling mode associated with the texture.
  24138. */
  24139. get samplingMode(): number;
  24140. /**
  24141. * Gets a boolean indicating if the texture needs to be inverted on the y axis during loading
  24142. */
  24143. get invertY(): boolean;
  24144. /**
  24145. * Instantiates a new texture.
  24146. * This represents a texture in babylon. It can be easily loaded from a network, base64 or html input.
  24147. * @see https://doc.babylonjs.com/babylon101/materials#texture
  24148. * @param url defines the url of the picture to load as a texture
  24149. * @param sceneOrEngine defines the scene or engine the texture will belong to
  24150. * @param noMipmap defines if the texture will require mip maps or not
  24151. * @param invertY defines if the texture needs to be inverted on the y axis during loading
  24152. * @param samplingMode defines the sampling mode we want for the texture while fectching from it (Texture.NEAREST_SAMPLINGMODE...)
  24153. * @param onLoad defines a callback triggered when the texture has been loaded
  24154. * @param onError defines a callback triggered when an error occurred during the loading session
  24155. * @param buffer defines the buffer to load the texture from in case the texture is loaded from a buffer representation
  24156. * @param deleteBuffer defines if the buffer we are loading the texture from should be deleted after load
  24157. * @param format defines the format of the texture we are trying to load (Engine.TEXTUREFORMAT_RGBA...)
  24158. * @param mimeType defines an optional mime type information
  24159. */
  24160. constructor(url: Nullable<string>, sceneOrEngine: Nullable<Scene | ThinEngine>, noMipmap?: boolean, invertY?: boolean, samplingMode?: number, onLoad?: Nullable<() => void>, onError?: Nullable<(message?: string, exception?: any) => void>, buffer?: Nullable<string | ArrayBuffer | ArrayBufferView | HTMLImageElement | Blob | ImageBitmap>, deleteBuffer?: boolean, format?: number, mimeType?: string);
  24161. /**
  24162. * Update the url (and optional buffer) of this texture if url was null during construction.
  24163. * @param url the url of the texture
  24164. * @param buffer the buffer of the texture (defaults to null)
  24165. * @param onLoad callback called when the texture is loaded (defaults to null)
  24166. */
  24167. updateURL(url: string, buffer?: Nullable<string | ArrayBuffer | ArrayBufferView | HTMLImageElement | Blob>, onLoad?: () => void): void;
  24168. /**
  24169. * Finish the loading sequence of a texture flagged as delayed load.
  24170. * @hidden
  24171. */
  24172. delayLoad(): void;
  24173. private _prepareRowForTextureGeneration;
  24174. /**
  24175. * Get the current texture matrix which includes the requested offsetting, tiling and rotation components.
  24176. * @returns the transform matrix of the texture.
  24177. */
  24178. getTextureMatrix(uBase?: number): Matrix;
  24179. /**
  24180. * Get the current matrix used to apply reflection. This is useful to rotate an environment texture for instance.
  24181. * @returns The reflection texture transform
  24182. */
  24183. getReflectionTextureMatrix(): Matrix;
  24184. /**
  24185. * Clones the texture.
  24186. * @returns the cloned texture
  24187. */
  24188. clone(): Texture;
  24189. /**
  24190. * Serialize the texture to a JSON representation we can easily use in the resepective Parse function.
  24191. * @returns The JSON representation of the texture
  24192. */
  24193. serialize(): any;
  24194. /**
  24195. * Get the current class name of the texture useful for serialization or dynamic coding.
  24196. * @returns "Texture"
  24197. */
  24198. getClassName(): string;
  24199. /**
  24200. * Dispose the texture and release its associated resources.
  24201. */
  24202. dispose(): void;
  24203. /**
  24204. * Parse the JSON representation of a texture in order to recreate the texture in the given scene.
  24205. * @param parsedTexture Define the JSON representation of the texture
  24206. * @param scene Define the scene the parsed texture should be instantiated in
  24207. * @param rootUrl Define the root url of the parsing sequence in the case of relative dependencies
  24208. * @returns The parsed texture if successful
  24209. */
  24210. static Parse(parsedTexture: any, scene: Scene, rootUrl: string): Nullable<BaseTexture>;
  24211. /**
  24212. * Creates a texture from its base 64 representation.
  24213. * @param data Define the base64 payload without the data: prefix
  24214. * @param name Define the name of the texture in the scene useful fo caching purpose for instance
  24215. * @param scene Define the scene the texture should belong to
  24216. * @param noMipmap Forces the texture to not create mip map information if true
  24217. * @param invertY define if the texture needs to be inverted on the y axis during loading
  24218. * @param samplingMode define the sampling mode we want for the texture while fectching from it (Texture.NEAREST_SAMPLINGMODE...)
  24219. * @param onLoad define a callback triggered when the texture has been loaded
  24220. * @param onError define a callback triggered when an error occurred during the loading session
  24221. * @param format define the format of the texture we are trying to load (Engine.TEXTUREFORMAT_RGBA...)
  24222. * @returns the created texture
  24223. */
  24224. static CreateFromBase64String(data: string, name: string, scene: Scene, noMipmap?: boolean, invertY?: boolean, samplingMode?: number, onLoad?: Nullable<() => void>, onError?: Nullable<() => void>, format?: number): Texture;
  24225. /**
  24226. * Creates a texture from its data: representation. (data: will be added in case only the payload has been passed in)
  24227. * @param data Define the base64 payload without the data: prefix
  24228. * @param name Define the name of the texture in the scene useful fo caching purpose for instance
  24229. * @param buffer define the buffer to load the texture from in case the texture is loaded from a buffer representation
  24230. * @param scene Define the scene the texture should belong to
  24231. * @param deleteBuffer define if the buffer we are loading the texture from should be deleted after load
  24232. * @param noMipmap Forces the texture to not create mip map information if true
  24233. * @param invertY define if the texture needs to be inverted on the y axis during loading
  24234. * @param samplingMode define the sampling mode we want for the texture while fectching from it (Texture.NEAREST_SAMPLINGMODE...)
  24235. * @param onLoad define a callback triggered when the texture has been loaded
  24236. * @param onError define a callback triggered when an error occurred during the loading session
  24237. * @param format define the format of the texture we are trying to load (Engine.TEXTUREFORMAT_RGBA...)
  24238. * @returns the created texture
  24239. */
  24240. static LoadFromDataString(name: string, buffer: any, scene: Scene, deleteBuffer?: boolean, noMipmap?: boolean, invertY?: boolean, samplingMode?: number, onLoad?: Nullable<() => void>, onError?: Nullable<(message?: string, exception?: any) => void>, format?: number): Texture;
  24241. }
  24242. }
  24243. declare module "babylonjs/PostProcesses/postProcessManager" {
  24244. import { Nullable } from "babylonjs/types";
  24245. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  24246. import { PostProcess } from "babylonjs/PostProcesses/postProcess";
  24247. import { Scene } from "babylonjs/scene";
  24248. /**
  24249. * PostProcessManager is used to manage one or more post processes or post process pipelines
  24250. * See https://doc.babylonjs.com/how_to/how_to_use_postprocesses
  24251. */
  24252. export class PostProcessManager {
  24253. private _scene;
  24254. private _indexBuffer;
  24255. private _vertexBuffers;
  24256. /**
  24257. * Creates a new instance PostProcess
  24258. * @param scene The scene that the post process is associated with.
  24259. */
  24260. constructor(scene: Scene);
  24261. private _prepareBuffers;
  24262. private _buildIndexBuffer;
  24263. /**
  24264. * Rebuilds the vertex buffers of the manager.
  24265. * @hidden
  24266. */
  24267. _rebuild(): void;
  24268. /**
  24269. * Prepares a frame to be run through a post process.
  24270. * @param sourceTexture The input texture to the post procesess. (default: null)
  24271. * @param postProcesses An array of post processes to be run. (default: null)
  24272. * @returns True if the post processes were able to be run.
  24273. * @hidden
  24274. */
  24275. _prepareFrame(sourceTexture?: Nullable<InternalTexture>, postProcesses?: Nullable<PostProcess[]>): boolean;
  24276. /**
  24277. * Manually render a set of post processes to a texture.
  24278. * Please note, the frame buffer won't be unbound after the call in case you have more render to do.
  24279. * @param postProcesses An array of post processes to be run.
  24280. * @param targetTexture The target texture to render to.
  24281. * @param forceFullscreenViewport force gl.viewport to be full screen eg. 0,0,textureWidth,textureHeight
  24282. * @param faceIndex defines the face to render to if a cubemap is defined as the target
  24283. * @param lodLevel defines which lod of the texture to render to
  24284. * @param doNotBindFrambuffer If set to true, assumes that the framebuffer has been bound previously
  24285. */
  24286. directRender(postProcesses: PostProcess[], targetTexture?: Nullable<InternalTexture>, forceFullscreenViewport?: boolean, faceIndex?: number, lodLevel?: number, doNotBindFrambuffer?: boolean): void;
  24287. /**
  24288. * Finalize the result of the output of the postprocesses.
  24289. * @param doNotPresent If true the result will not be displayed to the screen.
  24290. * @param targetTexture The target texture to render to.
  24291. * @param faceIndex The index of the face to bind the target texture to.
  24292. * @param postProcesses The array of post processes to render.
  24293. * @param forceFullscreenViewport force gl.viewport to be full screen eg. 0,0,textureWidth,textureHeight (default: false)
  24294. * @hidden
  24295. */
  24296. _finalizeFrame(doNotPresent?: boolean, targetTexture?: InternalTexture, faceIndex?: number, postProcesses?: Array<PostProcess>, forceFullscreenViewport?: boolean): void;
  24297. /**
  24298. * Disposes of the post process manager.
  24299. */
  24300. dispose(): void;
  24301. }
  24302. }
  24303. declare module "babylonjs/Materials/Textures/renderTargetTexture" {
  24304. import { Observable } from "babylonjs/Misc/observable";
  24305. import { SmartArray } from "babylonjs/Misc/smartArray";
  24306. import { Nullable, Immutable } from "babylonjs/types";
  24307. import { Camera } from "babylonjs/Cameras/camera";
  24308. import { Scene } from "babylonjs/scene";
  24309. import { Matrix, Vector3 } from "babylonjs/Maths/math.vector";
  24310. import { Color4 } from "babylonjs/Maths/math.color";
  24311. import { RenderTargetCreationOptions } from "babylonjs/Materials/Textures/renderTargetCreationOptions";
  24312. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  24313. import { SubMesh } from "babylonjs/Meshes/subMesh";
  24314. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  24315. import { Texture } from "babylonjs/Materials/Textures/texture";
  24316. import { PostProcess } from "babylonjs/PostProcesses/postProcess";
  24317. import { RenderingManager } from "babylonjs/Rendering/renderingManager";
  24318. import "babylonjs/Engines/Extensions/engine.renderTarget";
  24319. import "babylonjs/Engines/Extensions/engine.renderTargetCube";
  24320. import { Engine } from "babylonjs/Engines/engine";
  24321. /**
  24322. * This Helps creating a texture that will be created from a camera in your scene.
  24323. * It is basically a dynamic texture that could be used to create special effects for instance.
  24324. * Actually, It is the base of lot of effects in the framework like post process, shadows, effect layers and rendering pipelines...
  24325. */
  24326. export class RenderTargetTexture extends Texture {
  24327. /**
  24328. * The texture will only be rendered once which can be useful to improve performance if everything in your render is static for instance.
  24329. */
  24330. static readonly REFRESHRATE_RENDER_ONCE: number;
  24331. /**
  24332. * The texture will only be rendered rendered every frame and is recomended for dynamic contents.
  24333. */
  24334. static readonly REFRESHRATE_RENDER_ONEVERYFRAME: number;
  24335. /**
  24336. * The texture will be rendered every 2 frames which could be enough if your dynamic objects are not
  24337. * the central point of your effect and can save a lot of performances.
  24338. */
  24339. static readonly REFRESHRATE_RENDER_ONEVERYTWOFRAMES: number;
  24340. /**
  24341. * Use this predicate to dynamically define the list of mesh you want to render.
  24342. * If set, the renderList property will be overwritten.
  24343. */
  24344. renderListPredicate: (AbstractMesh: AbstractMesh) => boolean;
  24345. private _renderList;
  24346. /**
  24347. * Use this list to define the list of mesh you want to render.
  24348. */
  24349. get renderList(): Nullable<Array<AbstractMesh>>;
  24350. set renderList(value: Nullable<Array<AbstractMesh>>);
  24351. /**
  24352. * Use this function to overload the renderList array at rendering time.
  24353. * Return null to render with the curent renderList, else return the list of meshes to use for rendering.
  24354. * For 2DArray RTT, layerOrFace is the index of the layer that is going to be rendered, else it is the faceIndex of
  24355. * the cube (if the RTT is a cube, else layerOrFace=0).
  24356. * The renderList passed to the function is the current render list (the one that will be used if the function returns null).
  24357. * The length of this list is passed through renderListLength: don't use renderList.length directly because the array can
  24358. * hold dummy elements!
  24359. */
  24360. getCustomRenderList: (layerOrFace: number, renderList: Nullable<Immutable<Array<AbstractMesh>>>, renderListLength: number) => Nullable<Array<AbstractMesh>>;
  24361. private _hookArray;
  24362. /**
  24363. * Define if particles should be rendered in your texture.
  24364. */
  24365. renderParticles: boolean;
  24366. /**
  24367. * Define if sprites should be rendered in your texture.
  24368. */
  24369. renderSprites: boolean;
  24370. /**
  24371. * Define the camera used to render the texture.
  24372. */
  24373. activeCamera: Nullable<Camera>;
  24374. /**
  24375. * Override the mesh isReady function with your own one.
  24376. */
  24377. customIsReadyFunction: (mesh: AbstractMesh, refreshRate: number) => boolean;
  24378. /**
  24379. * Override the render function of the texture with your own one.
  24380. */
  24381. customRenderFunction: (opaqueSubMeshes: SmartArray<SubMesh>, alphaTestSubMeshes: SmartArray<SubMesh>, transparentSubMeshes: SmartArray<SubMesh>, depthOnlySubMeshes: SmartArray<SubMesh>, beforeTransparents?: () => void) => void;
  24382. /**
  24383. * Define if camera post processes should be use while rendering the texture.
  24384. */
  24385. useCameraPostProcesses: boolean;
  24386. /**
  24387. * Define if the camera viewport should be respected while rendering the texture or if the render should be done to the entire texture.
  24388. */
  24389. ignoreCameraViewport: boolean;
  24390. private _postProcessManager;
  24391. private _postProcesses;
  24392. private _resizeObserver;
  24393. /**
  24394. * An event triggered when the texture is unbind.
  24395. */
  24396. onBeforeBindObservable: Observable<RenderTargetTexture>;
  24397. /**
  24398. * An event triggered when the texture is unbind.
  24399. */
  24400. onAfterUnbindObservable: Observable<RenderTargetTexture>;
  24401. private _onAfterUnbindObserver;
  24402. /**
  24403. * Set a after unbind callback in the texture.
  24404. * This has been kept for backward compatibility and use of onAfterUnbindObservable is recommended.
  24405. */
  24406. set onAfterUnbind(callback: () => void);
  24407. /**
  24408. * An event triggered before rendering the texture
  24409. */
  24410. onBeforeRenderObservable: Observable<number>;
  24411. private _onBeforeRenderObserver;
  24412. /**
  24413. * Set a before render callback in the texture.
  24414. * This has been kept for backward compatibility and use of onBeforeRenderObservable is recommended.
  24415. */
  24416. set onBeforeRender(callback: (faceIndex: number) => void);
  24417. /**
  24418. * An event triggered after rendering the texture
  24419. */
  24420. onAfterRenderObservable: Observable<number>;
  24421. private _onAfterRenderObserver;
  24422. /**
  24423. * Set a after render callback in the texture.
  24424. * This has been kept for backward compatibility and use of onAfterRenderObservable is recommended.
  24425. */
  24426. set onAfterRender(callback: (faceIndex: number) => void);
  24427. /**
  24428. * An event triggered after the texture clear
  24429. */
  24430. onClearObservable: Observable<Engine>;
  24431. private _onClearObserver;
  24432. /**
  24433. * Set a clear callback in the texture.
  24434. * This has been kept for backward compatibility and use of onClearObservable is recommended.
  24435. */
  24436. set onClear(callback: (Engine: Engine) => void);
  24437. /**
  24438. * An event triggered when the texture is resized.
  24439. */
  24440. onResizeObservable: Observable<RenderTargetTexture>;
  24441. /**
  24442. * Define the clear color of the Render Target if it should be different from the scene.
  24443. */
  24444. clearColor: Color4;
  24445. protected _size: number | {
  24446. width: number;
  24447. height: number;
  24448. layers?: number;
  24449. };
  24450. protected _initialSizeParameter: number | {
  24451. width: number;
  24452. height: number;
  24453. } | {
  24454. ratio: number;
  24455. };
  24456. protected _sizeRatio: Nullable<number>;
  24457. /** @hidden */
  24458. _generateMipMaps: boolean;
  24459. protected _renderingManager: RenderingManager;
  24460. /** @hidden */
  24461. _waitingRenderList?: string[];
  24462. protected _doNotChangeAspectRatio: boolean;
  24463. protected _currentRefreshId: number;
  24464. protected _refreshRate: number;
  24465. protected _textureMatrix: Matrix;
  24466. protected _samples: number;
  24467. protected _renderTargetOptions: RenderTargetCreationOptions;
  24468. /**
  24469. * Gets render target creation options that were used.
  24470. */
  24471. get renderTargetOptions(): RenderTargetCreationOptions;
  24472. protected _onRatioRescale(): void;
  24473. /**
  24474. * Gets or sets the center of the bounding box associated with the texture (when in cube mode)
  24475. * It must define where the camera used to render the texture is set
  24476. */
  24477. boundingBoxPosition: Vector3;
  24478. private _boundingBoxSize;
  24479. /**
  24480. * Gets or sets the size of the bounding box associated with the texture (when in cube mode)
  24481. * When defined, the cubemap will switch to local mode
  24482. * @see https://community.arm.com/graphics/b/blog/posts/reflections-based-on-local-cubemaps-in-unity
  24483. * @example https://www.babylonjs-playground.com/#RNASML
  24484. */
  24485. set boundingBoxSize(value: Vector3);
  24486. get boundingBoxSize(): Vector3;
  24487. /**
  24488. * In case the RTT has been created with a depth texture, get the associated
  24489. * depth texture.
  24490. * Otherwise, return null.
  24491. */
  24492. get depthStencilTexture(): Nullable<InternalTexture>;
  24493. /**
  24494. * Instantiate a render target texture. This is mainly used to render of screen the scene to for instance apply post processse
  24495. * or used a shadow, depth texture...
  24496. * @param name The friendly name of the texture
  24497. * @param size The size of the RTT (number if square, or {width: number, height:number} or {ratio:} to define a ratio from the main scene)
  24498. * @param scene The scene the RTT belongs to. The latest created scene will be used if not precised.
  24499. * @param generateMipMaps True if mip maps need to be generated after render.
  24500. * @param doNotChangeAspectRatio True to not change the aspect ratio of the scene in the RTT
  24501. * @param type The type of the buffer in the RTT (int, half float, float...)
  24502. * @param isCube True if a cube texture needs to be created
  24503. * @param samplingMode The sampling mode to be usedwith the render target (Linear, Nearest...)
  24504. * @param generateDepthBuffer True to generate a depth buffer
  24505. * @param generateStencilBuffer True to generate a stencil buffer
  24506. * @param isMulti True if multiple textures need to be created (Draw Buffers)
  24507. * @param format The internal format of the buffer in the RTT (RED, RG, RGB, RGBA, ALPHA...)
  24508. * @param delayAllocation if the texture allocation should be delayed (default: false)
  24509. */
  24510. constructor(name: string, size: number | {
  24511. width: number;
  24512. height: number;
  24513. layers?: number;
  24514. } | {
  24515. ratio: number;
  24516. }, scene: Nullable<Scene>, generateMipMaps?: boolean, doNotChangeAspectRatio?: boolean, type?: number, isCube?: boolean, samplingMode?: number, generateDepthBuffer?: boolean, generateStencilBuffer?: boolean, isMulti?: boolean, format?: number, delayAllocation?: boolean);
  24517. /**
  24518. * Creates a depth stencil texture.
  24519. * This is only available in WebGL 2 or with the depth texture extension available.
  24520. * @param comparisonFunction Specifies the comparison function to set on the texture. If 0 or undefined, the texture is not in comparison mode
  24521. * @param bilinearFiltering Specifies whether or not bilinear filtering is enable on the texture
  24522. * @param generateStencil Specifies whether or not a stencil should be allocated in the texture
  24523. */
  24524. createDepthStencilTexture(comparisonFunction?: number, bilinearFiltering?: boolean, generateStencil?: boolean): void;
  24525. private _processSizeParameter;
  24526. /**
  24527. * Define the number of samples to use in case of MSAA.
  24528. * It defaults to one meaning no MSAA has been enabled.
  24529. */
  24530. get samples(): number;
  24531. set samples(value: number);
  24532. /**
  24533. * Resets the refresh counter of the texture and start bak from scratch.
  24534. * Could be useful to regenerate the texture if it is setup to render only once.
  24535. */
  24536. resetRefreshCounter(): void;
  24537. /**
  24538. * Define the refresh rate of the texture or the rendering frequency.
  24539. * Use 0 to render just once, 1 to render on every frame, 2 to render every two frames and so on...
  24540. */
  24541. get refreshRate(): number;
  24542. set refreshRate(value: number);
  24543. /**
  24544. * Adds a post process to the render target rendering passes.
  24545. * @param postProcess define the post process to add
  24546. */
  24547. addPostProcess(postProcess: PostProcess): void;
  24548. /**
  24549. * Clear all the post processes attached to the render target
  24550. * @param dispose define if the cleared post processesshould also be disposed (false by default)
  24551. */
  24552. clearPostProcesses(dispose?: boolean): void;
  24553. /**
  24554. * Remove one of the post process from the list of attached post processes to the texture
  24555. * @param postProcess define the post process to remove from the list
  24556. */
  24557. removePostProcess(postProcess: PostProcess): void;
  24558. /** @hidden */
  24559. _shouldRender(): boolean;
  24560. /**
  24561. * Gets the actual render size of the texture.
  24562. * @returns the width of the render size
  24563. */
  24564. getRenderSize(): number;
  24565. /**
  24566. * Gets the actual render width of the texture.
  24567. * @returns the width of the render size
  24568. */
  24569. getRenderWidth(): number;
  24570. /**
  24571. * Gets the actual render height of the texture.
  24572. * @returns the height of the render size
  24573. */
  24574. getRenderHeight(): number;
  24575. /**
  24576. * Gets the actual number of layers of the texture.
  24577. * @returns the number of layers
  24578. */
  24579. getRenderLayers(): number;
  24580. /**
  24581. * Get if the texture can be rescaled or not.
  24582. */
  24583. get canRescale(): boolean;
  24584. /**
  24585. * Resize the texture using a ratio.
  24586. * @param ratio the ratio to apply to the texture size in order to compute the new target size
  24587. */
  24588. scale(ratio: number): void;
  24589. /**
  24590. * Get the texture reflection matrix used to rotate/transform the reflection.
  24591. * @returns the reflection matrix
  24592. */
  24593. getReflectionTextureMatrix(): Matrix;
  24594. /**
  24595. * Resize the texture to a new desired size.
  24596. * Be carrefull as it will recreate all the data in the new texture.
  24597. * @param size Define the new size. It can be:
  24598. * - a number for squared texture,
  24599. * - an object containing { width: number, height: number }
  24600. * - or an object containing a ratio { ratio: number }
  24601. */
  24602. resize(size: number | {
  24603. width: number;
  24604. height: number;
  24605. } | {
  24606. ratio: number;
  24607. }): void;
  24608. private _defaultRenderListPrepared;
  24609. /**
  24610. * Renders all the objects from the render list into the texture.
  24611. * @param useCameraPostProcess Define if camera post processes should be used during the rendering
  24612. * @param dumpForDebug Define if the rendering result should be dumped (copied) for debugging purpose
  24613. */
  24614. render(useCameraPostProcess?: boolean, dumpForDebug?: boolean): void;
  24615. private _bestReflectionRenderTargetDimension;
  24616. private _prepareRenderingManager;
  24617. /**
  24618. * @hidden
  24619. * @param faceIndex face index to bind to if this is a cubetexture
  24620. * @param layer defines the index of the texture to bind in the array
  24621. */
  24622. _bindFrameBuffer(faceIndex?: number, layer?: number): void;
  24623. protected unbindFrameBuffer(engine: Engine, faceIndex: number): void;
  24624. private renderToTarget;
  24625. /**
  24626. * Overrides the default sort function applied in the renderging group to prepare the meshes.
  24627. * This allowed control for front to back rendering or reversly depending of the special needs.
  24628. *
  24629. * @param renderingGroupId The rendering group id corresponding to its index
  24630. * @param opaqueSortCompareFn The opaque queue comparison function use to sort.
  24631. * @param alphaTestSortCompareFn The alpha test queue comparison function use to sort.
  24632. * @param transparentSortCompareFn The transparent queue comparison function use to sort.
  24633. */
  24634. setRenderingOrder(renderingGroupId: number, opaqueSortCompareFn?: Nullable<(a: SubMesh, b: SubMesh) => number>, alphaTestSortCompareFn?: Nullable<(a: SubMesh, b: SubMesh) => number>, transparentSortCompareFn?: Nullable<(a: SubMesh, b: SubMesh) => number>): void;
  24635. /**
  24636. * Specifies whether or not the stencil and depth buffer are cleared between two rendering groups.
  24637. *
  24638. * @param renderingGroupId The rendering group id corresponding to its index
  24639. * @param autoClearDepthStencil Automatically clears depth and stencil between groups if true.
  24640. */
  24641. setRenderingAutoClearDepthStencil(renderingGroupId: number, autoClearDepthStencil: boolean): void;
  24642. /**
  24643. * Clones the texture.
  24644. * @returns the cloned texture
  24645. */
  24646. clone(): RenderTargetTexture;
  24647. /**
  24648. * Serialize the texture to a JSON representation we can easily use in the resepective Parse function.
  24649. * @returns The JSON representation of the texture
  24650. */
  24651. serialize(): any;
  24652. /**
  24653. * This will remove the attached framebuffer objects. The texture will not be able to be used as render target anymore
  24654. */
  24655. disposeFramebufferObjects(): void;
  24656. /**
  24657. * Dispose the texture and release its associated resources.
  24658. */
  24659. dispose(): void;
  24660. /** @hidden */
  24661. _rebuild(): void;
  24662. /**
  24663. * Clear the info related to rendering groups preventing retention point in material dispose.
  24664. */
  24665. freeRenderingGroups(): void;
  24666. /**
  24667. * Gets the number of views the corresponding to the texture (eg. a MultiviewRenderTarget will have > 1)
  24668. * @returns the view count
  24669. */
  24670. getViewCount(): number;
  24671. }
  24672. }
  24673. declare module "babylonjs/Misc/guid" {
  24674. /**
  24675. * Class used to manipulate GUIDs
  24676. */
  24677. export class GUID {
  24678. /**
  24679. * Implementation from http://stackoverflow.com/questions/105034/how-to-create-a-guid-uuid-in-javascript/2117523#answer-2117523
  24680. * Be aware Math.random() could cause collisions, but:
  24681. * "All but 6 of the 128 bits of the ID are randomly generated, which means that for any two ids, there's a 1 in 2^^122 (or 5.3x10^^36) chance they'll collide"
  24682. * @returns a pseudo random id
  24683. */
  24684. static RandomId(): string;
  24685. }
  24686. }
  24687. declare module "babylonjs/Materials/shadowDepthWrapper" {
  24688. import { Nullable } from "babylonjs/types";
  24689. import { Scene } from "babylonjs/scene";
  24690. import { SubMesh } from "babylonjs/Meshes/subMesh";
  24691. import { Material } from "babylonjs/Materials/material";
  24692. import { Effect } from "babylonjs/Materials/effect";
  24693. import { ShadowGenerator } from "babylonjs/Lights/Shadows/shadowGenerator";
  24694. /**
  24695. * Options to be used when creating a shadow depth material
  24696. */
  24697. export interface IIOptionShadowDepthMaterial {
  24698. /** Variables in the vertex shader code that need to have their names remapped.
  24699. * The format is: ["var_name", "var_remapped_name", "var_name", "var_remapped_name", ...]
  24700. * "var_name" should be either: worldPos or vNormalW
  24701. * So, if the variable holding the world position in your vertex shader is not named worldPos, you must tell the system
  24702. * the name to use instead by using: ["worldPos", "myWorldPosVar"] assuming the variable is named myWorldPosVar in your code.
  24703. * If the normal must also be remapped: ["worldPos", "myWorldPosVar", "vNormalW", "myWorldNormal"]
  24704. */
  24705. remappedVariables?: string[];
  24706. /** Set standalone to true if the base material wrapped by ShadowDepthMaterial is not used for a regular object but for depth shadow generation only */
  24707. standalone?: boolean;
  24708. }
  24709. /**
  24710. * Class that can be used to wrap a base material to generate accurate shadows when using custom vertex/fragment code in the base material
  24711. */
  24712. export class ShadowDepthWrapper {
  24713. private _scene;
  24714. private _options?;
  24715. private _baseMaterial;
  24716. private _onEffectCreatedObserver;
  24717. private _subMeshToEffect;
  24718. private _subMeshToDepthEffect;
  24719. private _meshes;
  24720. /** @hidden */
  24721. _matriceNames: any;
  24722. /** Gets the standalone status of the wrapper */
  24723. get standalone(): boolean;
  24724. /** Gets the base material the wrapper is built upon */
  24725. get baseMaterial(): Material;
  24726. /**
  24727. * Instantiate a new shadow depth wrapper.
  24728. * It works by injecting some specific code in the vertex/fragment shaders of the base material and is used by a shadow generator to
  24729. * generate the shadow depth map. For more information, please refer to the documentation:
  24730. * https://doc.babylonjs.com/babylon101/shadows
  24731. * @param baseMaterial Material to wrap
  24732. * @param scene Define the scene the material belongs to
  24733. * @param options Options used to create the wrapper
  24734. */
  24735. constructor(baseMaterial: Material, scene: Scene, options?: IIOptionShadowDepthMaterial);
  24736. /**
  24737. * Gets the effect to use to generate the depth map
  24738. * @param subMesh subMesh to get the effect for
  24739. * @param shadowGenerator shadow generator to get the effect for
  24740. * @returns the effect to use to generate the depth map for the subMesh + shadow generator specified
  24741. */
  24742. getEffect(subMesh: Nullable<SubMesh>, shadowGenerator: ShadowGenerator): Nullable<Effect>;
  24743. /**
  24744. * Specifies that the submesh is ready to be used for depth rendering
  24745. * @param subMesh submesh to check
  24746. * @param defines the list of defines to take into account when checking the effect
  24747. * @param shadowGenerator combined with subMesh, it defines the effect to check
  24748. * @param useInstances specifies that instances should be used
  24749. * @returns a boolean indicating that the submesh is ready or not
  24750. */
  24751. isReadyForSubMesh(subMesh: SubMesh, defines: string[], shadowGenerator: ShadowGenerator, useInstances: boolean): boolean;
  24752. /**
  24753. * Disposes the resources
  24754. */
  24755. dispose(): void;
  24756. private _makeEffect;
  24757. }
  24758. }
  24759. declare module "babylonjs/Engines/Extensions/engine.multiRender" {
  24760. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  24761. import { IMultiRenderTargetOptions } from "babylonjs/Materials/Textures/multiRenderTarget";
  24762. import { Nullable } from "babylonjs/types";
  24763. module "babylonjs/Engines/thinEngine" {
  24764. interface ThinEngine {
  24765. /**
  24766. * Unbind a list of render target textures from the webGL context
  24767. * This is used only when drawBuffer extension or webGL2 are active
  24768. * @param textures defines the render target textures to unbind
  24769. * @param disableGenerateMipMaps defines a boolean indicating that mipmaps must not be generated
  24770. * @param onBeforeUnbind defines a function which will be called before the effective unbind
  24771. */
  24772. unBindMultiColorAttachmentFramebuffer(textures: InternalTexture[], disableGenerateMipMaps: boolean, onBeforeUnbind?: () => void): void;
  24773. /**
  24774. * Create a multi render target texture
  24775. * @see https://doc.babylonjs.com/features/webgl2#multiple-render-target
  24776. * @param size defines the size of the texture
  24777. * @param options defines the creation options
  24778. * @returns the cube texture as an InternalTexture
  24779. */
  24780. createMultipleRenderTarget(size: any, options: IMultiRenderTargetOptions): InternalTexture[];
  24781. /**
  24782. * Update the sample count for a given multiple render target texture
  24783. * @see https://doc.babylonjs.com/features/webgl2#multisample-render-targets
  24784. * @param textures defines the textures to update
  24785. * @param samples defines the sample count to set
  24786. * @returns the effective sample count (could be 0 if multisample render targets are not supported)
  24787. */
  24788. updateMultipleRenderTargetTextureSampleCount(textures: Nullable<InternalTexture[]>, samples: number): number;
  24789. /**
  24790. * Select a subsets of attachments to draw to.
  24791. * @param attachments gl attachments
  24792. */
  24793. bindAttachments(attachments: number[]): void;
  24794. }
  24795. }
  24796. }
  24797. declare module "babylonjs/Materials/Textures/multiRenderTarget" {
  24798. import { Scene } from "babylonjs/scene";
  24799. import { Engine } from "babylonjs/Engines/engine";
  24800. import { Texture } from "babylonjs/Materials/Textures/texture";
  24801. import { RenderTargetTexture } from "babylonjs/Materials/Textures/renderTargetTexture";
  24802. import "babylonjs/Engines/Extensions/engine.multiRender";
  24803. /**
  24804. * Creation options of the multi render target texture.
  24805. */
  24806. export interface IMultiRenderTargetOptions {
  24807. /**
  24808. * Define if the texture needs to create mip maps after render.
  24809. */
  24810. generateMipMaps?: boolean;
  24811. /**
  24812. * Define the types of all the draw buffers we want to create
  24813. */
  24814. types?: number[];
  24815. /**
  24816. * Define the sampling modes of all the draw buffers we want to create
  24817. */
  24818. samplingModes?: number[];
  24819. /**
  24820. * Define if a depth buffer is required
  24821. */
  24822. generateDepthBuffer?: boolean;
  24823. /**
  24824. * Define if a stencil buffer is required
  24825. */
  24826. generateStencilBuffer?: boolean;
  24827. /**
  24828. * Define if a depth texture is required instead of a depth buffer
  24829. */
  24830. generateDepthTexture?: boolean;
  24831. /**
  24832. * Define the number of desired draw buffers
  24833. */
  24834. textureCount?: number;
  24835. /**
  24836. * Define if aspect ratio should be adapted to the texture or stay the scene one
  24837. */
  24838. doNotChangeAspectRatio?: boolean;
  24839. /**
  24840. * Define the default type of the buffers we are creating
  24841. */
  24842. defaultType?: number;
  24843. }
  24844. /**
  24845. * A multi render target, like a render target provides the ability to render to a texture.
  24846. * Unlike the render target, it can render to several draw buffers in one draw.
  24847. * This is specially interesting in deferred rendering or for any effects requiring more than
  24848. * just one color from a single pass.
  24849. */
  24850. export class MultiRenderTarget extends RenderTargetTexture {
  24851. private _internalTextures;
  24852. private _textures;
  24853. private _multiRenderTargetOptions;
  24854. private _count;
  24855. /**
  24856. * Get if draw buffers are currently supported by the used hardware and browser.
  24857. */
  24858. get isSupported(): boolean;
  24859. /**
  24860. * Get the list of textures generated by the multi render target.
  24861. */
  24862. get textures(): Texture[];
  24863. /**
  24864. * Gets the number of textures in this MRT. This number can be different from `_textures.length` in case a depth texture is generated.
  24865. */
  24866. get count(): number;
  24867. /**
  24868. * Get the depth texture generated by the multi render target if options.generateDepthTexture has been set
  24869. */
  24870. get depthTexture(): Texture;
  24871. /**
  24872. * Set the wrapping mode on U of all the textures we are rendering to.
  24873. * Can be any of the Texture. (CLAMP_ADDRESSMODE, MIRROR_ADDRESSMODE or WRAP_ADDRESSMODE)
  24874. */
  24875. set wrapU(wrap: number);
  24876. /**
  24877. * Set the wrapping mode on V of all the textures we are rendering to.
  24878. * Can be any of the Texture. (CLAMP_ADDRESSMODE, MIRROR_ADDRESSMODE or WRAP_ADDRESSMODE)
  24879. */
  24880. set wrapV(wrap: number);
  24881. /**
  24882. * Instantiate a new multi render target texture.
  24883. * A multi render target, like a render target provides the ability to render to a texture.
  24884. * Unlike the render target, it can render to several draw buffers in one draw.
  24885. * This is specially interesting in deferred rendering or for any effects requiring more than
  24886. * just one color from a single pass.
  24887. * @param name Define the name of the texture
  24888. * @param size Define the size of the buffers to render to
  24889. * @param count Define the number of target we are rendering into
  24890. * @param scene Define the scene the texture belongs to
  24891. * @param options Define the options used to create the multi render target
  24892. */
  24893. constructor(name: string, size: any, count: number, scene: Scene, options?: IMultiRenderTargetOptions);
  24894. /** @hidden */
  24895. _rebuild(): void;
  24896. private _createInternalTextures;
  24897. private _createTextures;
  24898. /**
  24899. * Define the number of samples used if MSAA is enabled.
  24900. */
  24901. get samples(): number;
  24902. set samples(value: number);
  24903. /**
  24904. * Resize all the textures in the multi render target.
  24905. * Be carrefull as it will recreate all the data in the new texture.
  24906. * @param size Define the new size
  24907. */
  24908. resize(size: any): void;
  24909. protected unbindFrameBuffer(engine: Engine, faceIndex: number): void;
  24910. /**
  24911. * Dispose the render targets and their associated resources
  24912. */
  24913. dispose(): void;
  24914. /**
  24915. * Release all the underlying texture used as draw buffers.
  24916. */
  24917. releaseInternalTextures(): void;
  24918. }
  24919. }
  24920. declare module "babylonjs/Shaders/imageProcessing.fragment" {
  24921. import "babylonjs/Shaders/ShadersInclude/imageProcessingDeclaration";
  24922. import "babylonjs/Shaders/ShadersInclude/helperFunctions";
  24923. import "babylonjs/Shaders/ShadersInclude/imageProcessingFunctions";
  24924. /** @hidden */
  24925. export var imageProcessingPixelShader: {
  24926. name: string;
  24927. shader: string;
  24928. };
  24929. }
  24930. declare module "babylonjs/PostProcesses/imageProcessingPostProcess" {
  24931. import { Nullable } from "babylonjs/types";
  24932. import { Color4 } from "babylonjs/Maths/math.color";
  24933. import { Camera } from "babylonjs/Cameras/camera";
  24934. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  24935. import { ColorCurves } from "babylonjs/Materials/colorCurves";
  24936. import { ImageProcessingConfiguration } from "babylonjs/Materials/imageProcessingConfiguration";
  24937. import { PostProcess, PostProcessOptions } from "babylonjs/PostProcesses/postProcess";
  24938. import { Engine } from "babylonjs/Engines/engine";
  24939. import "babylonjs/Shaders/imageProcessing.fragment";
  24940. import "babylonjs/Shaders/postprocess.vertex";
  24941. /**
  24942. * ImageProcessingPostProcess
  24943. * @see https://doc.babylonjs.com/how_to/how_to_use_postprocesses#imageprocessing
  24944. */
  24945. export class ImageProcessingPostProcess extends PostProcess {
  24946. /**
  24947. * Default configuration related to image processing available in the PBR Material.
  24948. */
  24949. protected _imageProcessingConfiguration: ImageProcessingConfiguration;
  24950. /**
  24951. * Gets the image processing configuration used either in this material.
  24952. */
  24953. get imageProcessingConfiguration(): ImageProcessingConfiguration;
  24954. /**
  24955. * Sets the Default image processing configuration used either in the this material.
  24956. *
  24957. * If sets to null, the scene one is in use.
  24958. */
  24959. set imageProcessingConfiguration(value: ImageProcessingConfiguration);
  24960. /**
  24961. * Keep track of the image processing observer to allow dispose and replace.
  24962. */
  24963. private _imageProcessingObserver;
  24964. /**
  24965. * Attaches a new image processing configuration to the PBR Material.
  24966. * @param configuration
  24967. */
  24968. protected _attachImageProcessingConfiguration(configuration: Nullable<ImageProcessingConfiguration>, doNotBuild?: boolean): void;
  24969. /**
  24970. * If the post process is supported.
  24971. */
  24972. get isSupported(): boolean;
  24973. /**
  24974. * Gets Color curves setup used in the effect if colorCurvesEnabled is set to true .
  24975. */
  24976. get colorCurves(): Nullable<ColorCurves>;
  24977. /**
  24978. * Sets Color curves setup used in the effect if colorCurvesEnabled is set to true .
  24979. */
  24980. set colorCurves(value: Nullable<ColorCurves>);
  24981. /**
  24982. * Gets wether the color curves effect is enabled.
  24983. */
  24984. get colorCurvesEnabled(): boolean;
  24985. /**
  24986. * Sets wether the color curves effect is enabled.
  24987. */
  24988. set colorCurvesEnabled(value: boolean);
  24989. /**
  24990. * Gets Color grading LUT texture used in the effect if colorGradingEnabled is set to true.
  24991. */
  24992. get colorGradingTexture(): Nullable<BaseTexture>;
  24993. /**
  24994. * Sets Color grading LUT texture used in the effect if colorGradingEnabled is set to true.
  24995. */
  24996. set colorGradingTexture(value: Nullable<BaseTexture>);
  24997. /**
  24998. * Gets wether the color grading effect is enabled.
  24999. */
  25000. get colorGradingEnabled(): boolean;
  25001. /**
  25002. * Gets wether the color grading effect is enabled.
  25003. */
  25004. set colorGradingEnabled(value: boolean);
  25005. /**
  25006. * Gets exposure used in the effect.
  25007. */
  25008. get exposure(): number;
  25009. /**
  25010. * Sets exposure used in the effect.
  25011. */
  25012. set exposure(value: number);
  25013. /**
  25014. * Gets wether tonemapping is enabled or not.
  25015. */
  25016. get toneMappingEnabled(): boolean;
  25017. /**
  25018. * Sets wether tonemapping is enabled or not
  25019. */
  25020. set toneMappingEnabled(value: boolean);
  25021. /**
  25022. * Gets the type of tone mapping effect.
  25023. */
  25024. get toneMappingType(): number;
  25025. /**
  25026. * Sets the type of tone mapping effect.
  25027. */
  25028. set toneMappingType(value: number);
  25029. /**
  25030. * Gets contrast used in the effect.
  25031. */
  25032. get contrast(): number;
  25033. /**
  25034. * Sets contrast used in the effect.
  25035. */
  25036. set contrast(value: number);
  25037. /**
  25038. * Gets Vignette stretch size.
  25039. */
  25040. get vignetteStretch(): number;
  25041. /**
  25042. * Sets Vignette stretch size.
  25043. */
  25044. set vignetteStretch(value: number);
  25045. /**
  25046. * Gets Vignette centre X Offset.
  25047. */
  25048. get vignetteCentreX(): number;
  25049. /**
  25050. * Sets Vignette centre X Offset.
  25051. */
  25052. set vignetteCentreX(value: number);
  25053. /**
  25054. * Gets Vignette centre Y Offset.
  25055. */
  25056. get vignetteCentreY(): number;
  25057. /**
  25058. * Sets Vignette centre Y Offset.
  25059. */
  25060. set vignetteCentreY(value: number);
  25061. /**
  25062. * Gets Vignette weight or intensity of the vignette effect.
  25063. */
  25064. get vignetteWeight(): number;
  25065. /**
  25066. * Sets Vignette weight or intensity of the vignette effect.
  25067. */
  25068. set vignetteWeight(value: number);
  25069. /**
  25070. * Gets Color of the vignette applied on the screen through the chosen blend mode (vignetteBlendMode)
  25071. * if vignetteEnabled is set to true.
  25072. */
  25073. get vignetteColor(): Color4;
  25074. /**
  25075. * Sets Color of the vignette applied on the screen through the chosen blend mode (vignetteBlendMode)
  25076. * if vignetteEnabled is set to true.
  25077. */
  25078. set vignetteColor(value: Color4);
  25079. /**
  25080. * Gets Camera field of view used by the Vignette effect.
  25081. */
  25082. get vignetteCameraFov(): number;
  25083. /**
  25084. * Sets Camera field of view used by the Vignette effect.
  25085. */
  25086. set vignetteCameraFov(value: number);
  25087. /**
  25088. * Gets the vignette blend mode allowing different kind of effect.
  25089. */
  25090. get vignetteBlendMode(): number;
  25091. /**
  25092. * Sets the vignette blend mode allowing different kind of effect.
  25093. */
  25094. set vignetteBlendMode(value: number);
  25095. /**
  25096. * Gets wether the vignette effect is enabled.
  25097. */
  25098. get vignetteEnabled(): boolean;
  25099. /**
  25100. * Sets wether the vignette effect is enabled.
  25101. */
  25102. set vignetteEnabled(value: boolean);
  25103. private _fromLinearSpace;
  25104. /**
  25105. * Gets wether the input of the processing is in Gamma or Linear Space.
  25106. */
  25107. get fromLinearSpace(): boolean;
  25108. /**
  25109. * Sets wether the input of the processing is in Gamma or Linear Space.
  25110. */
  25111. set fromLinearSpace(value: boolean);
  25112. /**
  25113. * Defines cache preventing GC.
  25114. */
  25115. private _defines;
  25116. constructor(name: string, options: number | PostProcessOptions, camera?: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number, imageProcessingConfiguration?: ImageProcessingConfiguration);
  25117. /**
  25118. * "ImageProcessingPostProcess"
  25119. * @returns "ImageProcessingPostProcess"
  25120. */
  25121. getClassName(): string;
  25122. /**
  25123. * @hidden
  25124. */
  25125. _updateParameters(): void;
  25126. dispose(camera?: Camera): void;
  25127. }
  25128. }
  25129. declare module "babylonjs/Shaders/ShadersInclude/fibonacci" {
  25130. /** @hidden */
  25131. export var fibonacci: {
  25132. name: string;
  25133. shader: string;
  25134. };
  25135. }
  25136. declare module "babylonjs/Shaders/ShadersInclude/subSurfaceScatteringFunctions" {
  25137. /** @hidden */
  25138. export var subSurfaceScatteringFunctions: {
  25139. name: string;
  25140. shader: string;
  25141. };
  25142. }
  25143. declare module "babylonjs/Shaders/ShadersInclude/diffusionProfile" {
  25144. /** @hidden */
  25145. export var diffusionProfile: {
  25146. name: string;
  25147. shader: string;
  25148. };
  25149. }
  25150. declare module "babylonjs/Shaders/subSurfaceScattering.fragment" {
  25151. import "babylonjs/Shaders/ShadersInclude/fibonacci";
  25152. import "babylonjs/Shaders/ShadersInclude/helperFunctions";
  25153. import "babylonjs/Shaders/ShadersInclude/subSurfaceScatteringFunctions";
  25154. import "babylonjs/Shaders/ShadersInclude/diffusionProfile";
  25155. /** @hidden */
  25156. export var subSurfaceScatteringPixelShader: {
  25157. name: string;
  25158. shader: string;
  25159. };
  25160. }
  25161. declare module "babylonjs/PostProcesses/subSurfaceScatteringPostProcess" {
  25162. import { Nullable } from "babylonjs/types";
  25163. import { Camera } from "babylonjs/Cameras/camera";
  25164. import { PostProcess, PostProcessOptions } from "babylonjs/PostProcesses/postProcess";
  25165. import { Engine } from "babylonjs/Engines/engine";
  25166. import { Scene } from "babylonjs/scene";
  25167. import "babylonjs/Shaders/imageProcessing.fragment";
  25168. import "babylonjs/Shaders/subSurfaceScattering.fragment";
  25169. import "babylonjs/Shaders/postprocess.vertex";
  25170. /**
  25171. * Sub surface scattering post process
  25172. */
  25173. export class SubSurfaceScatteringPostProcess extends PostProcess {
  25174. /**
  25175. * Gets a string identifying the name of the class
  25176. * @returns "SubSurfaceScatteringPostProcess" string
  25177. */
  25178. getClassName(): string;
  25179. constructor(name: string, scene: Scene, options: number | PostProcessOptions, camera?: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number);
  25180. }
  25181. }
  25182. declare module "babylonjs/Rendering/prePassEffectConfiguration" {
  25183. import { PostProcess } from "babylonjs/PostProcesses/postProcess";
  25184. /**
  25185. * Interface for defining prepass effects in the prepass post-process pipeline
  25186. */
  25187. export interface PrePassEffectConfiguration {
  25188. /**
  25189. * Post process to attach for this effect
  25190. */
  25191. postProcess: PostProcess;
  25192. /**
  25193. * Is the effect enabled
  25194. */
  25195. enabled: boolean;
  25196. /**
  25197. * Disposes the effect configuration
  25198. */
  25199. dispose(): void;
  25200. /**
  25201. * Disposes the effect configuration
  25202. */
  25203. createPostProcess: () => PostProcess;
  25204. }
  25205. }
  25206. declare module "babylonjs/Rendering/subSurfaceConfiguration" {
  25207. import { Scene } from "babylonjs/scene";
  25208. import { Color3 } from "babylonjs/Maths/math.color";
  25209. import { SubSurfaceScatteringPostProcess } from "babylonjs/PostProcesses/subSurfaceScatteringPostProcess";
  25210. import { PrePassEffectConfiguration } from "babylonjs/Rendering/prePassEffectConfiguration";
  25211. /**
  25212. * Contains all parameters needed for the prepass to perform
  25213. * screen space subsurface scattering
  25214. */
  25215. export class SubSurfaceConfiguration implements PrePassEffectConfiguration {
  25216. private _ssDiffusionS;
  25217. private _ssFilterRadii;
  25218. private _ssDiffusionD;
  25219. /**
  25220. * Post process to attach for screen space subsurface scattering
  25221. */
  25222. postProcess: SubSurfaceScatteringPostProcess;
  25223. /**
  25224. * Diffusion profile color for subsurface scattering
  25225. */
  25226. get ssDiffusionS(): number[];
  25227. /**
  25228. * Diffusion profile max color channel value for subsurface scattering
  25229. */
  25230. get ssDiffusionD(): number[];
  25231. /**
  25232. * Diffusion profile filter radius for subsurface scattering
  25233. */
  25234. get ssFilterRadii(): number[];
  25235. /**
  25236. * Is subsurface enabled
  25237. */
  25238. enabled: boolean;
  25239. /**
  25240. * Diffusion profile colors for subsurface scattering
  25241. * You can add one diffusion color using `addDiffusionProfile` on `scene.prePassRenderer`
  25242. * See ...
  25243. * Note that you can only store up to 5 of them
  25244. */
  25245. ssDiffusionProfileColors: Color3[];
  25246. /**
  25247. * Defines the ratio real world => scene units.
  25248. * Used for subsurface scattering
  25249. */
  25250. metersPerUnit: number;
  25251. private _scene;
  25252. /**
  25253. * Builds a subsurface configuration object
  25254. * @param scene The scene
  25255. */
  25256. constructor(scene: Scene);
  25257. /**
  25258. * Adds a new diffusion profile.
  25259. * Useful for more realistic subsurface scattering on diverse materials.
  25260. * @param color The color of the diffusion profile. Should be the average color of the material.
  25261. * @return The index of the diffusion profile for the material subsurface configuration
  25262. */
  25263. addDiffusionProfile(color: Color3): number;
  25264. /**
  25265. * Creates the sss post process
  25266. * @return The created post process
  25267. */
  25268. createPostProcess(): SubSurfaceScatteringPostProcess;
  25269. /**
  25270. * Deletes all diffusion profiles.
  25271. * Note that in order to render subsurface scattering, you should have at least 1 diffusion profile.
  25272. */
  25273. clearAllDiffusionProfiles(): void;
  25274. /**
  25275. * Disposes this object
  25276. */
  25277. dispose(): void;
  25278. /**
  25279. * @hidden
  25280. * https://zero-radiance.github.io/post/sampling-diffusion/
  25281. *
  25282. * Importance sample the normalized diffuse reflectance profile for the computed value of 's'.
  25283. * ------------------------------------------------------------------------------------
  25284. * R[r, phi, s] = s * (Exp[-r * s] + Exp[-r * s / 3]) / (8 * Pi * r)
  25285. * PDF[r, phi, s] = r * R[r, phi, s]
  25286. * CDF[r, s] = 1 - 1/4 * Exp[-r * s] - 3/4 * Exp[-r * s / 3]
  25287. * ------------------------------------------------------------------------------------
  25288. * We importance sample the color channel with the widest scattering distance.
  25289. */
  25290. getDiffusionProfileParameters(color: Color3): number;
  25291. /**
  25292. * Performs sampling of a Normalized Burley diffusion profile in polar coordinates.
  25293. * 'u' is the random number (the value of the CDF): [0, 1).
  25294. * rcp(s) = 1 / ShapeParam = ScatteringDistance.
  25295. * Returns the sampled radial distance, s.t. (u = 0 -> r = 0) and (u = 1 -> r = Inf).
  25296. */
  25297. private _sampleBurleyDiffusionProfile;
  25298. }
  25299. }
  25300. declare module "babylonjs/Rendering/prePassRenderer" {
  25301. import { MultiRenderTarget } from "babylonjs/Materials/Textures/multiRenderTarget";
  25302. import { Scene } from "babylonjs/scene";
  25303. import { ImageProcessingPostProcess } from "babylonjs/PostProcesses/imageProcessingPostProcess";
  25304. import { Effect } from "babylonjs/Materials/effect";
  25305. import { SubSurfaceConfiguration } from "babylonjs/Rendering/subSurfaceConfiguration";
  25306. /**
  25307. * Renders a pre pass of the scene
  25308. * This means every mesh in the scene will be rendered to a render target texture
  25309. * And then this texture will be composited to the rendering canvas with post processes
  25310. * It is necessary for effects like subsurface scattering or deferred shading
  25311. */
  25312. export class PrePassRenderer {
  25313. /** @hidden */
  25314. static _SceneComponentInitialization: (scene: Scene) => void;
  25315. private _scene;
  25316. private _engine;
  25317. private _isDirty;
  25318. /**
  25319. * Number of textures in the multi render target texture where the scene is directly rendered
  25320. */
  25321. readonly mrtCount: number;
  25322. /**
  25323. * The render target where the scene is directly rendered
  25324. */
  25325. prePassRT: MultiRenderTarget;
  25326. private _mrtTypes;
  25327. private _multiRenderAttachments;
  25328. private _defaultAttachments;
  25329. private _clearAttachments;
  25330. private _postProcesses;
  25331. private readonly _clearColor;
  25332. /**
  25333. * Image processing post process for composition
  25334. */
  25335. imageProcessingPostProcess: ImageProcessingPostProcess;
  25336. /**
  25337. * Configuration for sub surface scattering post process
  25338. */
  25339. subSurfaceConfiguration: SubSurfaceConfiguration;
  25340. /**
  25341. * Should materials render their geometry on the MRT
  25342. */
  25343. materialsShouldRenderGeometry: boolean;
  25344. /**
  25345. * Should materials render the irradiance information on the MRT
  25346. */
  25347. materialsShouldRenderIrradiance: boolean;
  25348. private _enabled;
  25349. /**
  25350. * Indicates if the prepass is enabled
  25351. */
  25352. get enabled(): boolean;
  25353. /**
  25354. * How many samples are used for MSAA of the scene render target
  25355. */
  25356. get samples(): number;
  25357. set samples(n: number);
  25358. /**
  25359. * Instanciates a prepass renderer
  25360. * @param scene The scene
  25361. */
  25362. constructor(scene: Scene);
  25363. private _initializeAttachments;
  25364. private _createCompositionEffect;
  25365. /**
  25366. * Indicates if rendering a prepass is supported
  25367. */
  25368. get isSupported(): boolean;
  25369. /**
  25370. * Sets the proper output textures to draw in the engine.
  25371. * @param effect The effect that is drawn. It can be or not be compatible with drawing to several output textures.
  25372. */
  25373. bindAttachmentsForEffect(effect: Effect): void;
  25374. /**
  25375. * @hidden
  25376. */
  25377. _beforeCameraDraw(): void;
  25378. /**
  25379. * @hidden
  25380. */
  25381. _afterCameraDraw(): void;
  25382. private _checkRTSize;
  25383. private _bindFrameBuffer;
  25384. /**
  25385. * Clears the scene render target (in the sense of settings pixels to the scene clear color value)
  25386. */
  25387. clear(): void;
  25388. private _setState;
  25389. private _enable;
  25390. private _disable;
  25391. private _resetPostProcessChain;
  25392. private _bindPostProcessChain;
  25393. /**
  25394. * Marks the prepass renderer as dirty, triggering a check if the prepass is necessary for the next rendering.
  25395. */
  25396. markAsDirty(): void;
  25397. private _update;
  25398. /**
  25399. * Disposes the prepass renderer.
  25400. */
  25401. dispose(): void;
  25402. }
  25403. }
  25404. declare module "babylonjs/Materials/material" {
  25405. import { IAnimatable } from "babylonjs/Animations/animatable.interface";
  25406. import { SmartArray } from "babylonjs/Misc/smartArray";
  25407. import { Observable } from "babylonjs/Misc/observable";
  25408. import { Nullable } from "babylonjs/types";
  25409. import { Scene } from "babylonjs/scene";
  25410. import { Matrix } from "babylonjs/Maths/math.vector";
  25411. import { SubMesh } from "babylonjs/Meshes/subMesh";
  25412. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  25413. import { UniformBuffer } from "babylonjs/Materials/uniformBuffer";
  25414. import { Effect } from "babylonjs/Materials/effect";
  25415. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  25416. import { RenderTargetTexture } from "babylonjs/Materials/Textures/renderTargetTexture";
  25417. import { MaterialDefines } from "babylonjs/Materials/materialDefines";
  25418. import { IInspectable } from "babylonjs/Misc/iInspectable";
  25419. import { ShadowDepthWrapper } from "babylonjs/Materials/shadowDepthWrapper";
  25420. import { PrePassRenderer } from "babylonjs/Rendering/prePassRenderer";
  25421. import { Mesh } from "babylonjs/Meshes/mesh";
  25422. import { Animation } from "babylonjs/Animations/animation";
  25423. /**
  25424. * Options for compiling materials.
  25425. */
  25426. export interface IMaterialCompilationOptions {
  25427. /**
  25428. * Defines whether clip planes are enabled.
  25429. */
  25430. clipPlane: boolean;
  25431. /**
  25432. * Defines whether instances are enabled.
  25433. */
  25434. useInstances: boolean;
  25435. }
  25436. /**
  25437. * Options passed when calling customShaderNameResolve
  25438. */
  25439. export interface ICustomShaderNameResolveOptions {
  25440. /**
  25441. * If provided, will be called two times with the vertex and fragment code so that this code can be updated before it is compiled by the GPU
  25442. */
  25443. processFinalCode?: Nullable<(shaderType: string, code: string) => string>;
  25444. }
  25445. /**
  25446. * Base class for the main features of a material in Babylon.js
  25447. */
  25448. export class Material implements IAnimatable {
  25449. /**
  25450. * Returns the triangle fill mode
  25451. */
  25452. static readonly TriangleFillMode: number;
  25453. /**
  25454. * Returns the wireframe mode
  25455. */
  25456. static readonly WireFrameFillMode: number;
  25457. /**
  25458. * Returns the point fill mode
  25459. */
  25460. static readonly PointFillMode: number;
  25461. /**
  25462. * Returns the point list draw mode
  25463. */
  25464. static readonly PointListDrawMode: number;
  25465. /**
  25466. * Returns the line list draw mode
  25467. */
  25468. static readonly LineListDrawMode: number;
  25469. /**
  25470. * Returns the line loop draw mode
  25471. */
  25472. static readonly LineLoopDrawMode: number;
  25473. /**
  25474. * Returns the line strip draw mode
  25475. */
  25476. static readonly LineStripDrawMode: number;
  25477. /**
  25478. * Returns the triangle strip draw mode
  25479. */
  25480. static readonly TriangleStripDrawMode: number;
  25481. /**
  25482. * Returns the triangle fan draw mode
  25483. */
  25484. static readonly TriangleFanDrawMode: number;
  25485. /**
  25486. * Stores the clock-wise side orientation
  25487. */
  25488. static readonly ClockWiseSideOrientation: number;
  25489. /**
  25490. * Stores the counter clock-wise side orientation
  25491. */
  25492. static readonly CounterClockWiseSideOrientation: number;
  25493. /**
  25494. * The dirty texture flag value
  25495. */
  25496. static readonly TextureDirtyFlag: number;
  25497. /**
  25498. * The dirty light flag value
  25499. */
  25500. static readonly LightDirtyFlag: number;
  25501. /**
  25502. * The dirty fresnel flag value
  25503. */
  25504. static readonly FresnelDirtyFlag: number;
  25505. /**
  25506. * The dirty attribute flag value
  25507. */
  25508. static readonly AttributesDirtyFlag: number;
  25509. /**
  25510. * The dirty misc flag value
  25511. */
  25512. static readonly MiscDirtyFlag: number;
  25513. /**
  25514. * The all dirty flag value
  25515. */
  25516. static readonly AllDirtyFlag: number;
  25517. /**
  25518. * MaterialTransparencyMode: No transparency mode, Alpha channel is not use.
  25519. */
  25520. static readonly MATERIAL_OPAQUE: number;
  25521. /**
  25522. * MaterialTransparencyMode: Alpha Test mode, pixel are discarded below a certain threshold defined by the alpha cutoff value.
  25523. */
  25524. static readonly MATERIAL_ALPHATEST: number;
  25525. /**
  25526. * MaterialTransparencyMode: Pixels are blended (according to the alpha mode) with the already drawn pixels in the current frame buffer.
  25527. */
  25528. static readonly MATERIAL_ALPHABLEND: number;
  25529. /**
  25530. * MaterialTransparencyMode: Pixels are blended (according to the alpha mode) with the already drawn pixels in the current frame buffer.
  25531. * They are also discarded below the alpha cutoff threshold to improve performances.
  25532. */
  25533. static readonly MATERIAL_ALPHATESTANDBLEND: number;
  25534. /**
  25535. * The Whiteout method is used to blend normals.
  25536. * Details of the algorithm can be found here: https://blog.selfshadow.com/publications/blending-in-detail/
  25537. */
  25538. static readonly MATERIAL_NORMALBLENDMETHOD_WHITEOUT: number;
  25539. /**
  25540. * The Reoriented Normal Mapping method is used to blend normals.
  25541. * Details of the algorithm can be found here: https://blog.selfshadow.com/publications/blending-in-detail/
  25542. */
  25543. static readonly MATERIAL_NORMALBLENDMETHOD_RNM: number;
  25544. /**
  25545. * Custom callback helping to override the default shader used in the material.
  25546. */
  25547. customShaderNameResolve: (shaderName: string, uniforms: string[], uniformBuffers: string[], samplers: string[], defines: MaterialDefines | string[], attributes?: string[], options?: ICustomShaderNameResolveOptions) => string;
  25548. /**
  25549. * Custom shadow depth material to use for shadow rendering instead of the in-built one
  25550. */
  25551. shadowDepthWrapper: Nullable<ShadowDepthWrapper>;
  25552. /**
  25553. * Gets or sets a boolean indicating that the material is allowed (if supported) to do shader hot swapping.
  25554. * This means that the material can keep using a previous shader while a new one is being compiled.
  25555. * This is mostly used when shader parallel compilation is supported (true by default)
  25556. */
  25557. allowShaderHotSwapping: boolean;
  25558. /**
  25559. * The ID of the material
  25560. */
  25561. id: string;
  25562. /**
  25563. * Gets or sets the unique id of the material
  25564. */
  25565. uniqueId: number;
  25566. /**
  25567. * The name of the material
  25568. */
  25569. name: string;
  25570. /**
  25571. * Gets or sets user defined metadata
  25572. */
  25573. metadata: any;
  25574. /**
  25575. * For internal use only. Please do not use.
  25576. */
  25577. reservedDataStore: any;
  25578. /**
  25579. * Specifies if the ready state should be checked on each call
  25580. */
  25581. checkReadyOnEveryCall: boolean;
  25582. /**
  25583. * Specifies if the ready state should be checked once
  25584. */
  25585. checkReadyOnlyOnce: boolean;
  25586. /**
  25587. * The state of the material
  25588. */
  25589. state: string;
  25590. /**
  25591. * If the material can be rendered to several textures with MRT extension
  25592. */
  25593. get canRenderToMRT(): boolean;
  25594. /**
  25595. * The alpha value of the material
  25596. */
  25597. protected _alpha: number;
  25598. /**
  25599. * List of inspectable custom properties (used by the Inspector)
  25600. * @see https://doc.babylonjs.com/how_to/debug_layer#extensibility
  25601. */
  25602. inspectableCustomProperties: IInspectable[];
  25603. /**
  25604. * Sets the alpha value of the material
  25605. */
  25606. set alpha(value: number);
  25607. /**
  25608. * Gets the alpha value of the material
  25609. */
  25610. get alpha(): number;
  25611. /**
  25612. * Specifies if back face culling is enabled
  25613. */
  25614. protected _backFaceCulling: boolean;
  25615. /**
  25616. * Sets the back-face culling state
  25617. */
  25618. set backFaceCulling(value: boolean);
  25619. /**
  25620. * Gets the back-face culling state
  25621. */
  25622. get backFaceCulling(): boolean;
  25623. /**
  25624. * Stores the value for side orientation
  25625. */
  25626. sideOrientation: number;
  25627. /**
  25628. * Callback triggered when the material is compiled
  25629. */
  25630. onCompiled: Nullable<(effect: Effect) => void>;
  25631. /**
  25632. * Callback triggered when an error occurs
  25633. */
  25634. onError: Nullable<(effect: Effect, errors: string) => void>;
  25635. /**
  25636. * Callback triggered to get the render target textures
  25637. */
  25638. getRenderTargetTextures: Nullable<() => SmartArray<RenderTargetTexture>>;
  25639. /**
  25640. * Gets a boolean indicating that current material needs to register RTT
  25641. */
  25642. get hasRenderTargetTextures(): boolean;
  25643. /**
  25644. * Specifies if the material should be serialized
  25645. */
  25646. doNotSerialize: boolean;
  25647. /**
  25648. * @hidden
  25649. */
  25650. _storeEffectOnSubMeshes: boolean;
  25651. /**
  25652. * Stores the animations for the material
  25653. */
  25654. animations: Nullable<Array<Animation>>;
  25655. /**
  25656. * An event triggered when the material is disposed
  25657. */
  25658. onDisposeObservable: Observable<Material>;
  25659. /**
  25660. * An observer which watches for dispose events
  25661. */
  25662. private _onDisposeObserver;
  25663. private _onUnBindObservable;
  25664. /**
  25665. * Called during a dispose event
  25666. */
  25667. set onDispose(callback: () => void);
  25668. private _onBindObservable;
  25669. /**
  25670. * An event triggered when the material is bound
  25671. */
  25672. get onBindObservable(): Observable<AbstractMesh>;
  25673. /**
  25674. * An observer which watches for bind events
  25675. */
  25676. private _onBindObserver;
  25677. /**
  25678. * Called during a bind event
  25679. */
  25680. set onBind(callback: (Mesh: AbstractMesh) => void);
  25681. /**
  25682. * An event triggered when the material is unbound
  25683. */
  25684. get onUnBindObservable(): Observable<Material>;
  25685. protected _onEffectCreatedObservable: Nullable<Observable<{
  25686. effect: Effect;
  25687. subMesh: Nullable<SubMesh>;
  25688. }>>;
  25689. /**
  25690. * An event triggered when the effect is (re)created
  25691. */
  25692. get onEffectCreatedObservable(): Observable<{
  25693. effect: Effect;
  25694. subMesh: Nullable<SubMesh>;
  25695. }>;
  25696. /**
  25697. * Stores the value of the alpha mode
  25698. */
  25699. private _alphaMode;
  25700. /**
  25701. * Sets the value of the alpha mode.
  25702. *
  25703. * | Value | Type | Description |
  25704. * | --- | --- | --- |
  25705. * | 0 | ALPHA_DISABLE | |
  25706. * | 1 | ALPHA_ADD | |
  25707. * | 2 | ALPHA_COMBINE | |
  25708. * | 3 | ALPHA_SUBTRACT | |
  25709. * | 4 | ALPHA_MULTIPLY | |
  25710. * | 5 | ALPHA_MAXIMIZED | |
  25711. * | 6 | ALPHA_ONEONE | |
  25712. * | 7 | ALPHA_PREMULTIPLIED | |
  25713. * | 8 | ALPHA_PREMULTIPLIED_PORTERDUFF | |
  25714. * | 9 | ALPHA_INTERPOLATE | |
  25715. * | 10 | ALPHA_SCREENMODE | |
  25716. *
  25717. */
  25718. set alphaMode(value: number);
  25719. /**
  25720. * Gets the value of the alpha mode
  25721. */
  25722. get alphaMode(): number;
  25723. /**
  25724. * Stores the state of the need depth pre-pass value
  25725. */
  25726. private _needDepthPrePass;
  25727. /**
  25728. * Sets the need depth pre-pass value
  25729. */
  25730. set needDepthPrePass(value: boolean);
  25731. /**
  25732. * Gets the depth pre-pass value
  25733. */
  25734. get needDepthPrePass(): boolean;
  25735. /**
  25736. * Specifies if depth writing should be disabled
  25737. */
  25738. disableDepthWrite: boolean;
  25739. /**
  25740. * Specifies if color writing should be disabled
  25741. */
  25742. disableColorWrite: boolean;
  25743. /**
  25744. * Specifies if depth writing should be forced
  25745. */
  25746. forceDepthWrite: boolean;
  25747. /**
  25748. * Specifies the depth function that should be used. 0 means the default engine function
  25749. */
  25750. depthFunction: number;
  25751. /**
  25752. * Specifies if there should be a separate pass for culling
  25753. */
  25754. separateCullingPass: boolean;
  25755. /**
  25756. * Stores the state specifing if fog should be enabled
  25757. */
  25758. private _fogEnabled;
  25759. /**
  25760. * Sets the state for enabling fog
  25761. */
  25762. set fogEnabled(value: boolean);
  25763. /**
  25764. * Gets the value of the fog enabled state
  25765. */
  25766. get fogEnabled(): boolean;
  25767. /**
  25768. * Stores the size of points
  25769. */
  25770. pointSize: number;
  25771. /**
  25772. * Stores the z offset value
  25773. */
  25774. zOffset: number;
  25775. get wireframe(): boolean;
  25776. /**
  25777. * Sets the state of wireframe mode
  25778. */
  25779. set wireframe(value: boolean);
  25780. /**
  25781. * Gets the value specifying if point clouds are enabled
  25782. */
  25783. get pointsCloud(): boolean;
  25784. /**
  25785. * Sets the state of point cloud mode
  25786. */
  25787. set pointsCloud(value: boolean);
  25788. /**
  25789. * Gets the material fill mode
  25790. */
  25791. get fillMode(): number;
  25792. /**
  25793. * Sets the material fill mode
  25794. */
  25795. set fillMode(value: number);
  25796. /**
  25797. * @hidden
  25798. * Stores the effects for the material
  25799. */
  25800. _effect: Nullable<Effect>;
  25801. /**
  25802. * Specifies if uniform buffers should be used
  25803. */
  25804. private _useUBO;
  25805. /**
  25806. * Stores a reference to the scene
  25807. */
  25808. private _scene;
  25809. /**
  25810. * Stores the fill mode state
  25811. */
  25812. private _fillMode;
  25813. /**
  25814. * Specifies if the depth write state should be cached
  25815. */
  25816. private _cachedDepthWriteState;
  25817. /**
  25818. * Specifies if the color write state should be cached
  25819. */
  25820. private _cachedColorWriteState;
  25821. /**
  25822. * Specifies if the depth function state should be cached
  25823. */
  25824. private _cachedDepthFunctionState;
  25825. /**
  25826. * Stores the uniform buffer
  25827. */
  25828. protected _uniformBuffer: UniformBuffer;
  25829. /** @hidden */
  25830. _indexInSceneMaterialArray: number;
  25831. /** @hidden */
  25832. meshMap: Nullable<{
  25833. [id: string]: AbstractMesh | undefined;
  25834. }>;
  25835. /**
  25836. * Creates a material instance
  25837. * @param name defines the name of the material
  25838. * @param scene defines the scene to reference
  25839. * @param doNotAdd specifies if the material should be added to the scene
  25840. */
  25841. constructor(name: string, scene: Scene, doNotAdd?: boolean);
  25842. /**
  25843. * Returns a string representation of the current material
  25844. * @param fullDetails defines a boolean indicating which levels of logging is desired
  25845. * @returns a string with material information
  25846. */
  25847. toString(fullDetails?: boolean): string;
  25848. /**
  25849. * Gets the class name of the material
  25850. * @returns a string with the class name of the material
  25851. */
  25852. getClassName(): string;
  25853. /**
  25854. * Specifies if updates for the material been locked
  25855. */
  25856. get isFrozen(): boolean;
  25857. /**
  25858. * Locks updates for the material
  25859. */
  25860. freeze(): void;
  25861. /**
  25862. * Unlocks updates for the material
  25863. */
  25864. unfreeze(): void;
  25865. /**
  25866. * Specifies if the material is ready to be used
  25867. * @param mesh defines the mesh to check
  25868. * @param useInstances specifies if instances should be used
  25869. * @returns a boolean indicating if the material is ready to be used
  25870. */
  25871. isReady(mesh?: AbstractMesh, useInstances?: boolean): boolean;
  25872. /**
  25873. * Specifies that the submesh is ready to be used
  25874. * @param mesh defines the mesh to check
  25875. * @param subMesh defines which submesh to check
  25876. * @param useInstances specifies that instances should be used
  25877. * @returns a boolean indicating that the submesh is ready or not
  25878. */
  25879. isReadyForSubMesh(mesh: AbstractMesh, subMesh: SubMesh, useInstances?: boolean): boolean;
  25880. /**
  25881. * Returns the material effect
  25882. * @returns the effect associated with the material
  25883. */
  25884. getEffect(): Nullable<Effect>;
  25885. /**
  25886. * Returns the current scene
  25887. * @returns a Scene
  25888. */
  25889. getScene(): Scene;
  25890. /**
  25891. * Enforces alpha test in opaque or blend mode in order to improve the performances of some situations.
  25892. */
  25893. protected _forceAlphaTest: boolean;
  25894. /**
  25895. * The transparency mode of the material.
  25896. */
  25897. protected _transparencyMode: Nullable<number>;
  25898. /**
  25899. * Gets the current transparency mode.
  25900. */
  25901. get transparencyMode(): Nullable<number>;
  25902. /**
  25903. * Sets the transparency mode of the material.
  25904. *
  25905. * | Value | Type | Description |
  25906. * | ----- | ----------------------------------- | ----------- |
  25907. * | 0 | OPAQUE | |
  25908. * | 1 | ALPHATEST | |
  25909. * | 2 | ALPHABLEND | |
  25910. * | 3 | ALPHATESTANDBLEND | |
  25911. *
  25912. */
  25913. set transparencyMode(value: Nullable<number>);
  25914. /**
  25915. * Returns true if alpha blending should be disabled.
  25916. */
  25917. protected get _disableAlphaBlending(): boolean;
  25918. /**
  25919. * Specifies whether or not this material should be rendered in alpha blend mode.
  25920. * @returns a boolean specifying if alpha blending is needed
  25921. */
  25922. needAlphaBlending(): boolean;
  25923. /**
  25924. * Specifies if the mesh will require alpha blending
  25925. * @param mesh defines the mesh to check
  25926. * @returns a boolean specifying if alpha blending is needed for the mesh
  25927. */
  25928. needAlphaBlendingForMesh(mesh: AbstractMesh): boolean;
  25929. /**
  25930. * Specifies whether or not this material should be rendered in alpha test mode.
  25931. * @returns a boolean specifying if an alpha test is needed.
  25932. */
  25933. needAlphaTesting(): boolean;
  25934. /**
  25935. * Specifies if material alpha testing should be turned on for the mesh
  25936. * @param mesh defines the mesh to check
  25937. */
  25938. protected _shouldTurnAlphaTestOn(mesh: AbstractMesh): boolean;
  25939. /**
  25940. * Gets the texture used for the alpha test
  25941. * @returns the texture to use for alpha testing
  25942. */
  25943. getAlphaTestTexture(): Nullable<BaseTexture>;
  25944. /**
  25945. * Marks the material to indicate that it needs to be re-calculated
  25946. */
  25947. markDirty(): void;
  25948. /** @hidden */
  25949. _preBind(effect?: Effect, overrideOrientation?: Nullable<number>): boolean;
  25950. /**
  25951. * Binds the material to the mesh
  25952. * @param world defines the world transformation matrix
  25953. * @param mesh defines the mesh to bind the material to
  25954. */
  25955. bind(world: Matrix, mesh?: Mesh): void;
  25956. /**
  25957. * Binds the submesh to the material
  25958. * @param world defines the world transformation matrix
  25959. * @param mesh defines the mesh containing the submesh
  25960. * @param subMesh defines the submesh to bind the material to
  25961. */
  25962. bindForSubMesh(world: Matrix, mesh: Mesh, subMesh: SubMesh): void;
  25963. /**
  25964. * Binds the world matrix to the material
  25965. * @param world defines the world transformation matrix
  25966. */
  25967. bindOnlyWorldMatrix(world: Matrix): void;
  25968. /**
  25969. * Binds the scene's uniform buffer to the effect.
  25970. * @param effect defines the effect to bind to the scene uniform buffer
  25971. * @param sceneUbo defines the uniform buffer storing scene data
  25972. */
  25973. bindSceneUniformBuffer(effect: Effect, sceneUbo: UniformBuffer): void;
  25974. /**
  25975. * Binds the view matrix to the effect
  25976. * @param effect defines the effect to bind the view matrix to
  25977. */
  25978. bindView(effect: Effect): void;
  25979. /**
  25980. * Binds the view projection matrix to the effect
  25981. * @param effect defines the effect to bind the view projection matrix to
  25982. */
  25983. bindViewProjection(effect: Effect): void;
  25984. /**
  25985. * Processes to execute after binding the material to a mesh
  25986. * @param mesh defines the rendered mesh
  25987. */
  25988. protected _afterBind(mesh?: Mesh): void;
  25989. /**
  25990. * Unbinds the material from the mesh
  25991. */
  25992. unbind(): void;
  25993. /**
  25994. * Gets the active textures from the material
  25995. * @returns an array of textures
  25996. */
  25997. getActiveTextures(): BaseTexture[];
  25998. /**
  25999. * Specifies if the material uses a texture
  26000. * @param texture defines the texture to check against the material
  26001. * @returns a boolean specifying if the material uses the texture
  26002. */
  26003. hasTexture(texture: BaseTexture): boolean;
  26004. /**
  26005. * Makes a duplicate of the material, and gives it a new name
  26006. * @param name defines the new name for the duplicated material
  26007. * @returns the cloned material
  26008. */
  26009. clone(name: string): Nullable<Material>;
  26010. /**
  26011. * Gets the meshes bound to the material
  26012. * @returns an array of meshes bound to the material
  26013. */
  26014. getBindedMeshes(): AbstractMesh[];
  26015. /**
  26016. * Force shader compilation
  26017. * @param mesh defines the mesh associated with this material
  26018. * @param onCompiled defines a function to execute once the material is compiled
  26019. * @param options defines the options to configure the compilation
  26020. * @param onError defines a function to execute if the material fails compiling
  26021. */
  26022. forceCompilation(mesh: AbstractMesh, onCompiled?: (material: Material) => void, options?: Partial<IMaterialCompilationOptions>, onError?: (reason: string) => void): void;
  26023. /**
  26024. * Force shader compilation
  26025. * @param mesh defines the mesh that will use this material
  26026. * @param options defines additional options for compiling the shaders
  26027. * @returns a promise that resolves when the compilation completes
  26028. */
  26029. forceCompilationAsync(mesh: AbstractMesh, options?: Partial<IMaterialCompilationOptions>): Promise<void>;
  26030. private static readonly _AllDirtyCallBack;
  26031. private static readonly _ImageProcessingDirtyCallBack;
  26032. private static readonly _TextureDirtyCallBack;
  26033. private static readonly _FresnelDirtyCallBack;
  26034. private static readonly _MiscDirtyCallBack;
  26035. private static readonly _LightsDirtyCallBack;
  26036. private static readonly _AttributeDirtyCallBack;
  26037. private static _FresnelAndMiscDirtyCallBack;
  26038. private static _TextureAndMiscDirtyCallBack;
  26039. private static readonly _DirtyCallbackArray;
  26040. private static readonly _RunDirtyCallBacks;
  26041. /**
  26042. * Marks a define in the material to indicate that it needs to be re-computed
  26043. * @param flag defines a flag used to determine which parts of the material have to be marked as dirty
  26044. */
  26045. markAsDirty(flag: number): void;
  26046. /**
  26047. * Marks all submeshes of a material to indicate that their material defines need to be re-calculated
  26048. * @param func defines a function which checks material defines against the submeshes
  26049. */
  26050. protected _markAllSubMeshesAsDirty(func: (defines: MaterialDefines) => void): void;
  26051. /**
  26052. * Indicates that the scene should check if the rendering now needs a prepass
  26053. */
  26054. protected _markScenePrePassDirty(): void;
  26055. /**
  26056. * Indicates that we need to re-calculated for all submeshes
  26057. */
  26058. protected _markAllSubMeshesAsAllDirty(): void;
  26059. /**
  26060. * Indicates that image processing needs to be re-calculated for all submeshes
  26061. */
  26062. protected _markAllSubMeshesAsImageProcessingDirty(): void;
  26063. /**
  26064. * Indicates that textures need to be re-calculated for all submeshes
  26065. */
  26066. protected _markAllSubMeshesAsTexturesDirty(): void;
  26067. /**
  26068. * Indicates that fresnel needs to be re-calculated for all submeshes
  26069. */
  26070. protected _markAllSubMeshesAsFresnelDirty(): void;
  26071. /**
  26072. * Indicates that fresnel and misc need to be re-calculated for all submeshes
  26073. */
  26074. protected _markAllSubMeshesAsFresnelAndMiscDirty(): void;
  26075. /**
  26076. * Indicates that lights need to be re-calculated for all submeshes
  26077. */
  26078. protected _markAllSubMeshesAsLightsDirty(): void;
  26079. /**
  26080. * Indicates that attributes need to be re-calculated for all submeshes
  26081. */
  26082. protected _markAllSubMeshesAsAttributesDirty(): void;
  26083. /**
  26084. * Indicates that misc needs to be re-calculated for all submeshes
  26085. */
  26086. protected _markAllSubMeshesAsMiscDirty(): void;
  26087. /**
  26088. * Indicates that textures and misc need to be re-calculated for all submeshes
  26089. */
  26090. protected _markAllSubMeshesAsTexturesAndMiscDirty(): void;
  26091. /**
  26092. * Sets the required values to the prepass renderer.
  26093. * @param prePassRenderer defines the prepass renderer to setup.
  26094. * @returns true if the pre pass is needed.
  26095. */
  26096. setPrePassRenderer(prePassRenderer: PrePassRenderer): boolean;
  26097. /**
  26098. * Disposes the material
  26099. * @param forceDisposeEffect specifies if effects should be forcefully disposed
  26100. * @param forceDisposeTextures specifies if textures should be forcefully disposed
  26101. * @param notBoundToMesh specifies if the material that is being disposed is known to be not bound to any mesh
  26102. */
  26103. dispose(forceDisposeEffect?: boolean, forceDisposeTextures?: boolean, notBoundToMesh?: boolean): void;
  26104. /** @hidden */
  26105. private releaseVertexArrayObject;
  26106. /**
  26107. * Serializes this material
  26108. * @returns the serialized material object
  26109. */
  26110. serialize(): any;
  26111. /**
  26112. * Creates a material from parsed material data
  26113. * @param parsedMaterial defines parsed material data
  26114. * @param scene defines the hosting scene
  26115. * @param rootUrl defines the root URL to use to load textures
  26116. * @returns a new material
  26117. */
  26118. static Parse(parsedMaterial: any, scene: Scene, rootUrl: string): Nullable<Material>;
  26119. }
  26120. }
  26121. declare module "babylonjs/Materials/multiMaterial" {
  26122. import { Nullable } from "babylonjs/types";
  26123. import { Scene } from "babylonjs/scene";
  26124. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  26125. import { SubMesh } from "babylonjs/Meshes/subMesh";
  26126. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  26127. import { Material } from "babylonjs/Materials/material";
  26128. /**
  26129. * A multi-material is used to apply different materials to different parts of the same object without the need of
  26130. * separate meshes. This can be use to improve performances.
  26131. * @see https://doc.babylonjs.com/how_to/multi_materials
  26132. */
  26133. export class MultiMaterial extends Material {
  26134. private _subMaterials;
  26135. /**
  26136. * Gets or Sets the list of Materials used within the multi material.
  26137. * They need to be ordered according to the submeshes order in the associated mesh
  26138. */
  26139. get subMaterials(): Nullable<Material>[];
  26140. set subMaterials(value: Nullable<Material>[]);
  26141. /**
  26142. * Function used to align with Node.getChildren()
  26143. * @returns the list of Materials used within the multi material
  26144. */
  26145. getChildren(): Nullable<Material>[];
  26146. /**
  26147. * Instantiates a new Multi Material
  26148. * A multi-material is used to apply different materials to different parts of the same object without the need of
  26149. * separate meshes. This can be use to improve performances.
  26150. * @see https://doc.babylonjs.com/how_to/multi_materials
  26151. * @param name Define the name in the scene
  26152. * @param scene Define the scene the material belongs to
  26153. */
  26154. constructor(name: string, scene: Scene);
  26155. private _hookArray;
  26156. /**
  26157. * Get one of the submaterial by its index in the submaterials array
  26158. * @param index The index to look the sub material at
  26159. * @returns The Material if the index has been defined
  26160. */
  26161. getSubMaterial(index: number): Nullable<Material>;
  26162. /**
  26163. * Get the list of active textures for the whole sub materials list.
  26164. * @returns All the textures that will be used during the rendering
  26165. */
  26166. getActiveTextures(): BaseTexture[];
  26167. /**
  26168. * Gets the current class name of the material e.g. "MultiMaterial"
  26169. * Mainly use in serialization.
  26170. * @returns the class name
  26171. */
  26172. getClassName(): string;
  26173. /**
  26174. * Checks if the material is ready to render the requested sub mesh
  26175. * @param mesh Define the mesh the submesh belongs to
  26176. * @param subMesh Define the sub mesh to look readyness for
  26177. * @param useInstances Define whether or not the material is used with instances
  26178. * @returns true if ready, otherwise false
  26179. */
  26180. isReadyForSubMesh(mesh: AbstractMesh, subMesh: SubMesh, useInstances?: boolean): boolean;
  26181. /**
  26182. * Clones the current material and its related sub materials
  26183. * @param name Define the name of the newly cloned material
  26184. * @param cloneChildren Define if submaterial will be cloned or shared with the parent instance
  26185. * @returns the cloned material
  26186. */
  26187. clone(name: string, cloneChildren?: boolean): MultiMaterial;
  26188. /**
  26189. * Serializes the materials into a JSON representation.
  26190. * @returns the JSON representation
  26191. */
  26192. serialize(): any;
  26193. /**
  26194. * Dispose the material and release its associated resources
  26195. * @param forceDisposeEffect Define if we want to force disposing the associated effect (if false the shader is not released and could be reuse later on)
  26196. * @param forceDisposeTextures Define if we want to force disposing the associated textures (if false, they will not be disposed and can still be use elsewhere in the app)
  26197. * @param forceDisposeChildren Define if we want to force disposing the associated submaterials (if false, they will not be disposed and can still be use elsewhere in the app)
  26198. */
  26199. dispose(forceDisposeEffect?: boolean, forceDisposeTextures?: boolean, forceDisposeChildren?: boolean): void;
  26200. /**
  26201. * Creates a MultiMaterial from parsed MultiMaterial data.
  26202. * @param parsedMultiMaterial defines parsed MultiMaterial data.
  26203. * @param scene defines the hosting scene
  26204. * @returns a new MultiMaterial
  26205. */
  26206. static ParseMultiMaterial(parsedMultiMaterial: any, scene: Scene): MultiMaterial;
  26207. }
  26208. }
  26209. declare module "babylonjs/Meshes/subMesh" {
  26210. import { Nullable, IndicesArray, DeepImmutable, FloatArray } from "babylonjs/types";
  26211. import { Matrix, Vector3 } from "babylonjs/Maths/math.vector";
  26212. import { Engine } from "babylonjs/Engines/engine";
  26213. import { IntersectionInfo } from "babylonjs/Collisions/intersectionInfo";
  26214. import { ICullable, BoundingInfo } from "babylonjs/Culling/boundingInfo";
  26215. import { Effect } from "babylonjs/Materials/effect";
  26216. import { DataBuffer } from "babylonjs/Meshes/dataBuffer";
  26217. import { Plane } from "babylonjs/Maths/math.plane";
  26218. import { Collider } from "babylonjs/Collisions/collider";
  26219. import { Material } from "babylonjs/Materials/material";
  26220. import { MaterialDefines } from "babylonjs/Materials/materialDefines";
  26221. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  26222. import { Mesh } from "babylonjs/Meshes/mesh";
  26223. import { Ray } from "babylonjs/Culling/ray";
  26224. import { TrianglePickingPredicate } from "babylonjs/Culling/ray";
  26225. /**
  26226. * Defines a subdivision inside a mesh
  26227. */
  26228. export class SubMesh implements ICullable {
  26229. /** the material index to use */
  26230. materialIndex: number;
  26231. /** vertex index start */
  26232. verticesStart: number;
  26233. /** vertices count */
  26234. verticesCount: number;
  26235. /** index start */
  26236. indexStart: number;
  26237. /** indices count */
  26238. indexCount: number;
  26239. /** @hidden */
  26240. _materialDefines: Nullable<MaterialDefines>;
  26241. /** @hidden */
  26242. _materialEffect: Nullable<Effect>;
  26243. /** @hidden */
  26244. _effectOverride: Nullable<Effect>;
  26245. /**
  26246. * Gets material defines used by the effect associated to the sub mesh
  26247. */
  26248. get materialDefines(): Nullable<MaterialDefines>;
  26249. /**
  26250. * Sets material defines used by the effect associated to the sub mesh
  26251. */
  26252. set materialDefines(defines: Nullable<MaterialDefines>);
  26253. /**
  26254. * Gets associated effect
  26255. */
  26256. get effect(): Nullable<Effect>;
  26257. /**
  26258. * Sets associated effect (effect used to render this submesh)
  26259. * @param effect defines the effect to associate with
  26260. * @param defines defines the set of defines used to compile this effect
  26261. */
  26262. setEffect(effect: Nullable<Effect>, defines?: Nullable<MaterialDefines>): void;
  26263. /** @hidden */
  26264. _linesIndexCount: number;
  26265. private _mesh;
  26266. private _renderingMesh;
  26267. private _boundingInfo;
  26268. private _linesIndexBuffer;
  26269. /** @hidden */
  26270. _lastColliderWorldVertices: Nullable<Vector3[]>;
  26271. /** @hidden */
  26272. _trianglePlanes: Plane[];
  26273. /** @hidden */
  26274. _lastColliderTransformMatrix: Nullable<Matrix>;
  26275. /** @hidden */
  26276. _renderId: number;
  26277. /** @hidden */
  26278. _alphaIndex: number;
  26279. /** @hidden */
  26280. _distanceToCamera: number;
  26281. /** @hidden */
  26282. _id: number;
  26283. private _currentMaterial;
  26284. /**
  26285. * Add a new submesh to a mesh
  26286. * @param materialIndex defines the material index to use
  26287. * @param verticesStart defines vertex index start
  26288. * @param verticesCount defines vertices count
  26289. * @param indexStart defines index start
  26290. * @param indexCount defines indices count
  26291. * @param mesh defines the parent mesh
  26292. * @param renderingMesh defines an optional rendering mesh
  26293. * @param createBoundingBox defines if bounding box should be created for this submesh
  26294. * @returns the new submesh
  26295. */
  26296. static AddToMesh(materialIndex: number, verticesStart: number, verticesCount: number, indexStart: number, indexCount: number, mesh: AbstractMesh, renderingMesh?: Mesh, createBoundingBox?: boolean): SubMesh;
  26297. /**
  26298. * Creates a new submesh
  26299. * @param materialIndex defines the material index to use
  26300. * @param verticesStart defines vertex index start
  26301. * @param verticesCount defines vertices count
  26302. * @param indexStart defines index start
  26303. * @param indexCount defines indices count
  26304. * @param mesh defines the parent mesh
  26305. * @param renderingMesh defines an optional rendering mesh
  26306. * @param createBoundingBox defines if bounding box should be created for this submesh
  26307. * @param addToMesh defines a boolean indicating that the submesh must be added to the mesh.subMeshes array (true by default)
  26308. */
  26309. constructor(
  26310. /** the material index to use */
  26311. materialIndex: number,
  26312. /** vertex index start */
  26313. verticesStart: number,
  26314. /** vertices count */
  26315. verticesCount: number,
  26316. /** index start */
  26317. indexStart: number,
  26318. /** indices count */
  26319. indexCount: number, mesh: AbstractMesh, renderingMesh?: Mesh, createBoundingBox?: boolean, addToMesh?: boolean);
  26320. /**
  26321. * Returns true if this submesh covers the entire parent mesh
  26322. * @ignorenaming
  26323. */
  26324. get IsGlobal(): boolean;
  26325. /**
  26326. * Returns the submesh BoudingInfo object
  26327. * @returns current bounding info (or mesh's one if the submesh is global)
  26328. */
  26329. getBoundingInfo(): BoundingInfo;
  26330. /**
  26331. * Sets the submesh BoundingInfo
  26332. * @param boundingInfo defines the new bounding info to use
  26333. * @returns the SubMesh
  26334. */
  26335. setBoundingInfo(boundingInfo: BoundingInfo): SubMesh;
  26336. /**
  26337. * Returns the mesh of the current submesh
  26338. * @return the parent mesh
  26339. */
  26340. getMesh(): AbstractMesh;
  26341. /**
  26342. * Returns the rendering mesh of the submesh
  26343. * @returns the rendering mesh (could be different from parent mesh)
  26344. */
  26345. getRenderingMesh(): Mesh;
  26346. /**
  26347. * Returns the replacement mesh of the submesh
  26348. * @returns the replacement mesh (could be different from parent mesh)
  26349. */
  26350. getReplacementMesh(): Nullable<AbstractMesh>;
  26351. /**
  26352. * Returns the effective mesh of the submesh
  26353. * @returns the effective mesh (could be different from parent mesh)
  26354. */
  26355. getEffectiveMesh(): AbstractMesh;
  26356. /**
  26357. * Returns the submesh material
  26358. * @returns null or the current material
  26359. */
  26360. getMaterial(): Nullable<Material>;
  26361. private _IsMultiMaterial;
  26362. /**
  26363. * Sets a new updated BoundingInfo object to the submesh
  26364. * @param data defines an optional position array to use to determine the bounding info
  26365. * @returns the SubMesh
  26366. */
  26367. refreshBoundingInfo(data?: Nullable<FloatArray>): SubMesh;
  26368. /** @hidden */
  26369. _checkCollision(collider: Collider): boolean;
  26370. /**
  26371. * Updates the submesh BoundingInfo
  26372. * @param world defines the world matrix to use to update the bounding info
  26373. * @returns the submesh
  26374. */
  26375. updateBoundingInfo(world: DeepImmutable<Matrix>): SubMesh;
  26376. /**
  26377. * True is the submesh bounding box intersects the frustum defined by the passed array of planes.
  26378. * @param frustumPlanes defines the frustum planes
  26379. * @returns true if the submesh is intersecting with the frustum
  26380. */
  26381. isInFrustum(frustumPlanes: Plane[]): boolean;
  26382. /**
  26383. * True is the submesh bounding box is completely inside the frustum defined by the passed array of planes
  26384. * @param frustumPlanes defines the frustum planes
  26385. * @returns true if the submesh is inside the frustum
  26386. */
  26387. isCompletelyInFrustum(frustumPlanes: Plane[]): boolean;
  26388. /**
  26389. * Renders the submesh
  26390. * @param enableAlphaMode defines if alpha needs to be used
  26391. * @returns the submesh
  26392. */
  26393. render(enableAlphaMode: boolean): SubMesh;
  26394. /**
  26395. * @hidden
  26396. */
  26397. _getLinesIndexBuffer(indices: IndicesArray, engine: Engine): DataBuffer;
  26398. /**
  26399. * Checks if the submesh intersects with a ray
  26400. * @param ray defines the ray to test
  26401. * @returns true is the passed ray intersects the submesh bounding box
  26402. */
  26403. canIntersects(ray: Ray): boolean;
  26404. /**
  26405. * Intersects current submesh with a ray
  26406. * @param ray defines the ray to test
  26407. * @param positions defines mesh's positions array
  26408. * @param indices defines mesh's indices array
  26409. * @param fastCheck defines if the first intersection will be used (and not the closest)
  26410. * @param trianglePredicate defines an optional predicate used to select faces when a mesh intersection is detected
  26411. * @returns intersection info or null if no intersection
  26412. */
  26413. intersects(ray: Ray, positions: Vector3[], indices: IndicesArray, fastCheck?: boolean, trianglePredicate?: TrianglePickingPredicate): Nullable<IntersectionInfo>;
  26414. /** @hidden */
  26415. private _intersectLines;
  26416. /** @hidden */
  26417. private _intersectUnIndexedLines;
  26418. /** @hidden */
  26419. private _intersectTriangles;
  26420. /** @hidden */
  26421. private _intersectUnIndexedTriangles;
  26422. /** @hidden */
  26423. _rebuild(): void;
  26424. /**
  26425. * Creates a new submesh from the passed mesh
  26426. * @param newMesh defines the new hosting mesh
  26427. * @param newRenderingMesh defines an optional rendering mesh
  26428. * @returns the new submesh
  26429. */
  26430. clone(newMesh: AbstractMesh, newRenderingMesh?: Mesh): SubMesh;
  26431. /**
  26432. * Release associated resources
  26433. */
  26434. dispose(): void;
  26435. /**
  26436. * Gets the class name
  26437. * @returns the string "SubMesh".
  26438. */
  26439. getClassName(): string;
  26440. /**
  26441. * Creates a new submesh from indices data
  26442. * @param materialIndex the index of the main mesh material
  26443. * @param startIndex the index where to start the copy in the mesh indices array
  26444. * @param indexCount the number of indices to copy then from the startIndex
  26445. * @param mesh the main mesh to create the submesh from
  26446. * @param renderingMesh the optional rendering mesh
  26447. * @returns a new submesh
  26448. */
  26449. static CreateFromIndices(materialIndex: number, startIndex: number, indexCount: number, mesh: AbstractMesh, renderingMesh?: Mesh): SubMesh;
  26450. }
  26451. }
  26452. declare module "babylonjs/Loading/sceneLoaderFlags" {
  26453. /**
  26454. * Class used to represent data loading progression
  26455. */
  26456. export class SceneLoaderFlags {
  26457. private static _ForceFullSceneLoadingForIncremental;
  26458. private static _ShowLoadingScreen;
  26459. private static _CleanBoneMatrixWeights;
  26460. private static _loggingLevel;
  26461. /**
  26462. * Gets or sets a boolean indicating if entire scene must be loaded even if scene contains incremental data
  26463. */
  26464. static get ForceFullSceneLoadingForIncremental(): boolean;
  26465. static set ForceFullSceneLoadingForIncremental(value: boolean);
  26466. /**
  26467. * Gets or sets a boolean indicating if loading screen must be displayed while loading a scene
  26468. */
  26469. static get ShowLoadingScreen(): boolean;
  26470. static set ShowLoadingScreen(value: boolean);
  26471. /**
  26472. * Defines the current logging level (while loading the scene)
  26473. * @ignorenaming
  26474. */
  26475. static get loggingLevel(): number;
  26476. static set loggingLevel(value: number);
  26477. /**
  26478. * Gets or set a boolean indicating if matrix weights must be cleaned upon loading
  26479. */
  26480. static get CleanBoneMatrixWeights(): boolean;
  26481. static set CleanBoneMatrixWeights(value: boolean);
  26482. }
  26483. }
  26484. declare module "babylonjs/Meshes/geometry" {
  26485. import { Nullable, FloatArray, DataArray, IndicesArray } from "babylonjs/types";
  26486. import { Scene } from "babylonjs/scene";
  26487. import { Vector3, Vector2 } from "babylonjs/Maths/math.vector";
  26488. import { Engine } from "babylonjs/Engines/engine";
  26489. import { IGetSetVerticesData, VertexData } from "babylonjs/Meshes/mesh.vertexData";
  26490. import { VertexBuffer } from "babylonjs/Meshes/buffer";
  26491. import { Effect } from "babylonjs/Materials/effect";
  26492. import { BoundingInfo } from "babylonjs/Culling/boundingInfo";
  26493. import { DataBuffer } from "babylonjs/Meshes/dataBuffer";
  26494. import { Mesh } from "babylonjs/Meshes/mesh";
  26495. /**
  26496. * Class used to store geometry data (vertex buffers + index buffer)
  26497. */
  26498. export class Geometry implements IGetSetVerticesData {
  26499. /**
  26500. * Gets or sets the ID of the geometry
  26501. */
  26502. id: string;
  26503. /**
  26504. * Gets or sets the unique ID of the geometry
  26505. */
  26506. uniqueId: number;
  26507. /**
  26508. * Gets the delay loading state of the geometry (none by default which means not delayed)
  26509. */
  26510. delayLoadState: number;
  26511. /**
  26512. * Gets the file containing the data to load when running in delay load state
  26513. */
  26514. delayLoadingFile: Nullable<string>;
  26515. /**
  26516. * Callback called when the geometry is updated
  26517. */
  26518. onGeometryUpdated: (geometry: Geometry, kind?: string) => void;
  26519. private _scene;
  26520. private _engine;
  26521. private _meshes;
  26522. private _totalVertices;
  26523. /** @hidden */
  26524. _indices: IndicesArray;
  26525. /** @hidden */
  26526. _vertexBuffers: {
  26527. [key: string]: VertexBuffer;
  26528. };
  26529. private _isDisposed;
  26530. private _extend;
  26531. private _boundingBias;
  26532. /** @hidden */
  26533. _delayInfo: Array<string>;
  26534. private _indexBuffer;
  26535. private _indexBufferIsUpdatable;
  26536. /** @hidden */
  26537. _boundingInfo: Nullable<BoundingInfo>;
  26538. /** @hidden */
  26539. _delayLoadingFunction: Nullable<(any: any, geometry: Geometry) => void>;
  26540. /** @hidden */
  26541. _softwareSkinningFrameId: number;
  26542. private _vertexArrayObjects;
  26543. private _updatable;
  26544. /** @hidden */
  26545. _positions: Nullable<Vector3[]>;
  26546. /**
  26547. * Gets or sets the Bias Vector to apply on the bounding elements (box/sphere), the max extend is computed as v += v * bias.x + bias.y, the min is computed as v -= v * bias.x + bias.y
  26548. */
  26549. get boundingBias(): Vector2;
  26550. /**
  26551. * Gets or sets the Bias Vector to apply on the bounding elements (box/sphere), the max extend is computed as v += v * bias.x + bias.y, the min is computed as v -= v * bias.x + bias.y
  26552. */
  26553. set boundingBias(value: Vector2);
  26554. /**
  26555. * Static function used to attach a new empty geometry to a mesh
  26556. * @param mesh defines the mesh to attach the geometry to
  26557. * @returns the new Geometry
  26558. */
  26559. static CreateGeometryForMesh(mesh: Mesh): Geometry;
  26560. /** Get the list of meshes using this geometry */
  26561. get meshes(): Mesh[];
  26562. /**
  26563. * If set to true (false by defaut), the bounding info applied to the meshes sharing this geometry will be the bounding info defined at the class level
  26564. * and won't be computed based on the vertex positions (which is what we get when useBoundingInfoFromGeometry = false)
  26565. */
  26566. useBoundingInfoFromGeometry: boolean;
  26567. /**
  26568. * Creates a new geometry
  26569. * @param id defines the unique ID
  26570. * @param scene defines the hosting scene
  26571. * @param vertexData defines the VertexData used to get geometry data
  26572. * @param updatable defines if geometry must be updatable (false by default)
  26573. * @param mesh defines the mesh that will be associated with the geometry
  26574. */
  26575. constructor(id: string, scene: Scene, vertexData?: VertexData, updatable?: boolean, mesh?: Nullable<Mesh>);
  26576. /**
  26577. * Gets the current extend of the geometry
  26578. */
  26579. get extend(): {
  26580. minimum: Vector3;
  26581. maximum: Vector3;
  26582. };
  26583. /**
  26584. * Gets the hosting scene
  26585. * @returns the hosting Scene
  26586. */
  26587. getScene(): Scene;
  26588. /**
  26589. * Gets the hosting engine
  26590. * @returns the hosting Engine
  26591. */
  26592. getEngine(): Engine;
  26593. /**
  26594. * Defines if the geometry is ready to use
  26595. * @returns true if the geometry is ready to be used
  26596. */
  26597. isReady(): boolean;
  26598. /**
  26599. * Gets a value indicating that the geometry should not be serialized
  26600. */
  26601. get doNotSerialize(): boolean;
  26602. /** @hidden */
  26603. _rebuild(): void;
  26604. /**
  26605. * Affects all geometry data in one call
  26606. * @param vertexData defines the geometry data
  26607. * @param updatable defines if the geometry must be flagged as updatable (false as default)
  26608. */
  26609. setAllVerticesData(vertexData: VertexData, updatable?: boolean): void;
  26610. /**
  26611. * Set specific vertex data
  26612. * @param kind defines the data kind (Position, normal, etc...)
  26613. * @param data defines the vertex data to use
  26614. * @param updatable defines if the vertex must be flagged as updatable (false as default)
  26615. * @param stride defines the stride to use (0 by default). This value is deduced from the kind value if not specified
  26616. */
  26617. setVerticesData(kind: string, data: FloatArray, updatable?: boolean, stride?: number): void;
  26618. /**
  26619. * Removes a specific vertex data
  26620. * @param kind defines the data kind (Position, normal, etc...)
  26621. */
  26622. removeVerticesData(kind: string): void;
  26623. /**
  26624. * Affect a vertex buffer to the geometry. the vertexBuffer.getKind() function is used to determine where to store the data
  26625. * @param buffer defines the vertex buffer to use
  26626. * @param totalVertices defines the total number of vertices for position kind (could be null)
  26627. */
  26628. setVerticesBuffer(buffer: VertexBuffer, totalVertices?: Nullable<number>): void;
  26629. /**
  26630. * Update a specific vertex buffer
  26631. * This function will directly update the underlying DataBuffer according to the passed numeric array or Float32Array
  26632. * It will do nothing if the buffer is not updatable
  26633. * @param kind defines the data kind (Position, normal, etc...)
  26634. * @param data defines the data to use
  26635. * @param offset defines the offset in the target buffer where to store the data
  26636. * @param useBytes set to true if the offset is in bytes
  26637. */
  26638. updateVerticesDataDirectly(kind: string, data: DataArray, offset: number, useBytes?: boolean): void;
  26639. /**
  26640. * Update a specific vertex buffer
  26641. * This function will create a new buffer if the current one is not updatable
  26642. * @param kind defines the data kind (Position, normal, etc...)
  26643. * @param data defines the data to use
  26644. * @param updateExtends defines if the geometry extends must be recomputed (false by default)
  26645. */
  26646. updateVerticesData(kind: string, data: FloatArray, updateExtends?: boolean): void;
  26647. private _updateBoundingInfo;
  26648. /** @hidden */
  26649. _bind(effect: Nullable<Effect>, indexToBind?: Nullable<DataBuffer>): void;
  26650. /**
  26651. * Gets total number of vertices
  26652. * @returns the total number of vertices
  26653. */
  26654. getTotalVertices(): number;
  26655. /**
  26656. * Gets a specific vertex data attached to this geometry. Float data is constructed if the vertex buffer data cannot be returned directly.
  26657. * @param kind defines the data kind (Position, normal, etc...)
  26658. * @param copyWhenShared defines if the returned array must be cloned upon returning it if the current geometry is shared between multiple meshes
  26659. * @param forceCopy defines a boolean indicating that the returned array must be cloned upon returning it
  26660. * @returns a float array containing vertex data
  26661. */
  26662. getVerticesData(kind: string, copyWhenShared?: boolean, forceCopy?: boolean): Nullable<FloatArray>;
  26663. /**
  26664. * Returns a boolean defining if the vertex data for the requested `kind` is updatable
  26665. * @param kind defines the data kind (Position, normal, etc...)
  26666. * @returns true if the vertex buffer with the specified kind is updatable
  26667. */
  26668. isVertexBufferUpdatable(kind: string): boolean;
  26669. /**
  26670. * Gets a specific vertex buffer
  26671. * @param kind defines the data kind (Position, normal, etc...)
  26672. * @returns a VertexBuffer
  26673. */
  26674. getVertexBuffer(kind: string): Nullable<VertexBuffer>;
  26675. /**
  26676. * Returns all vertex buffers
  26677. * @return an object holding all vertex buffers indexed by kind
  26678. */
  26679. getVertexBuffers(): Nullable<{
  26680. [key: string]: VertexBuffer;
  26681. }>;
  26682. /**
  26683. * Gets a boolean indicating if specific vertex buffer is present
  26684. * @param kind defines the data kind (Position, normal, etc...)
  26685. * @returns true if data is present
  26686. */
  26687. isVerticesDataPresent(kind: string): boolean;
  26688. /**
  26689. * Gets a list of all attached data kinds (Position, normal, etc...)
  26690. * @returns a list of string containing all kinds
  26691. */
  26692. getVerticesDataKinds(): string[];
  26693. /**
  26694. * Update index buffer
  26695. * @param indices defines the indices to store in the index buffer
  26696. * @param offset defines the offset in the target buffer where to store the data
  26697. * @param gpuMemoryOnly defines a boolean indicating that only the GPU memory must be updated leaving the CPU version of the indices unchanged (false by default)
  26698. */
  26699. updateIndices(indices: IndicesArray, offset?: number, gpuMemoryOnly?: boolean): void;
  26700. /**
  26701. * Creates a new index buffer
  26702. * @param indices defines the indices to store in the index buffer
  26703. * @param totalVertices defines the total number of vertices (could be null)
  26704. * @param updatable defines if the index buffer must be flagged as updatable (false by default)
  26705. */
  26706. setIndices(indices: IndicesArray, totalVertices?: Nullable<number>, updatable?: boolean): void;
  26707. /**
  26708. * Return the total number of indices
  26709. * @returns the total number of indices
  26710. */
  26711. getTotalIndices(): number;
  26712. /**
  26713. * Gets the index buffer array
  26714. * @param copyWhenShared defines if the returned array must be cloned upon returning it if the current geometry is shared between multiple meshes
  26715. * @param forceCopy defines a boolean indicating that the returned array must be cloned upon returning it
  26716. * @returns the index buffer array
  26717. */
  26718. getIndices(copyWhenShared?: boolean, forceCopy?: boolean): Nullable<IndicesArray>;
  26719. /**
  26720. * Gets the index buffer
  26721. * @return the index buffer
  26722. */
  26723. getIndexBuffer(): Nullable<DataBuffer>;
  26724. /** @hidden */
  26725. _releaseVertexArrayObject(effect?: Nullable<Effect>): void;
  26726. /**
  26727. * Release the associated resources for a specific mesh
  26728. * @param mesh defines the source mesh
  26729. * @param shouldDispose defines if the geometry must be disposed if there is no more mesh pointing to it
  26730. */
  26731. releaseForMesh(mesh: Mesh, shouldDispose?: boolean): void;
  26732. /**
  26733. * Apply current geometry to a given mesh
  26734. * @param mesh defines the mesh to apply geometry to
  26735. */
  26736. applyToMesh(mesh: Mesh): void;
  26737. private _updateExtend;
  26738. private _applyToMesh;
  26739. private notifyUpdate;
  26740. /**
  26741. * Load the geometry if it was flagged as delay loaded
  26742. * @param scene defines the hosting scene
  26743. * @param onLoaded defines a callback called when the geometry is loaded
  26744. */
  26745. load(scene: Scene, onLoaded?: () => void): void;
  26746. private _queueLoad;
  26747. /**
  26748. * Invert the geometry to move from a right handed system to a left handed one.
  26749. */
  26750. toLeftHanded(): void;
  26751. /** @hidden */
  26752. _resetPointsArrayCache(): void;
  26753. /** @hidden */
  26754. _generatePointsArray(): boolean;
  26755. /**
  26756. * Gets a value indicating if the geometry is disposed
  26757. * @returns true if the geometry was disposed
  26758. */
  26759. isDisposed(): boolean;
  26760. private _disposeVertexArrayObjects;
  26761. /**
  26762. * Free all associated resources
  26763. */
  26764. dispose(): void;
  26765. /**
  26766. * Clone the current geometry into a new geometry
  26767. * @param id defines the unique ID of the new geometry
  26768. * @returns a new geometry object
  26769. */
  26770. copy(id: string): Geometry;
  26771. /**
  26772. * Serialize the current geometry info (and not the vertices data) into a JSON object
  26773. * @return a JSON representation of the current geometry data (without the vertices data)
  26774. */
  26775. serialize(): any;
  26776. private toNumberArray;
  26777. /**
  26778. * Serialize all vertices data into a JSON oject
  26779. * @returns a JSON representation of the current geometry data
  26780. */
  26781. serializeVerticeData(): any;
  26782. /**
  26783. * Extracts a clone of a mesh geometry
  26784. * @param mesh defines the source mesh
  26785. * @param id defines the unique ID of the new geometry object
  26786. * @returns the new geometry object
  26787. */
  26788. static ExtractFromMesh(mesh: Mesh, id: string): Nullable<Geometry>;
  26789. /**
  26790. * You should now use Tools.RandomId(), this method is still here for legacy reasons.
  26791. * Implementation from http://stackoverflow.com/questions/105034/how-to-create-a-guid-uuid-in-javascript/2117523#answer-2117523
  26792. * Be aware Math.random() could cause collisions, but:
  26793. * "All but 6 of the 128 bits of the ID are randomly generated, which means that for any two ids, there's a 1 in 2^^122 (or 5.3x10^^36) chance they'll collide"
  26794. * @returns a string containing a new GUID
  26795. */
  26796. static RandomId(): string;
  26797. /** @hidden */
  26798. static _ImportGeometry(parsedGeometry: any, mesh: Mesh): void;
  26799. private static _CleanMatricesWeights;
  26800. /**
  26801. * Create a new geometry from persisted data (Using .babylon file format)
  26802. * @param parsedVertexData defines the persisted data
  26803. * @param scene defines the hosting scene
  26804. * @param rootUrl defines the root url to use to load assets (like delayed data)
  26805. * @returns the new geometry object
  26806. */
  26807. static Parse(parsedVertexData: any, scene: Scene, rootUrl: string): Nullable<Geometry>;
  26808. }
  26809. }
  26810. declare module "babylonjs/Meshes/mesh.vertexData" {
  26811. import { Nullable, FloatArray, IndicesArray } from "babylonjs/types";
  26812. import { Matrix, Vector3, Vector2, Vector4 } from "babylonjs/Maths/math.vector";
  26813. import { Color4, Color3 } from "babylonjs/Maths/math.color";
  26814. import { Geometry } from "babylonjs/Meshes/geometry";
  26815. import { Mesh } from "babylonjs/Meshes/mesh";
  26816. /**
  26817. * Define an interface for all classes that will get and set the data on vertices
  26818. */
  26819. export interface IGetSetVerticesData {
  26820. /**
  26821. * Gets a boolean indicating if specific vertex data is present
  26822. * @param kind defines the vertex data kind to use
  26823. * @returns true is data kind is present
  26824. */
  26825. isVerticesDataPresent(kind: string): boolean;
  26826. /**
  26827. * Gets a specific vertex data attached to this geometry. Float data is constructed if the vertex buffer data cannot be returned directly.
  26828. * @param kind defines the data kind (Position, normal, etc...)
  26829. * @param copyWhenShared defines if the returned array must be cloned upon returning it if the current geometry is shared between multiple meshes
  26830. * @param forceCopy defines a boolean indicating that the returned array must be cloned upon returning it
  26831. * @returns a float array containing vertex data
  26832. */
  26833. getVerticesData(kind: string, copyWhenShared?: boolean, forceCopy?: boolean): Nullable<FloatArray>;
  26834. /**
  26835. * Returns an array of integers or a typed array (Int32Array, Uint32Array, Uint16Array) populated with the mesh indices.
  26836. * @param copyWhenShared If true (default false) and and if the mesh geometry is shared among some other meshes, the returned array is a copy of the internal one.
  26837. * @param forceCopy defines a boolean indicating that the returned array must be cloned upon returning it
  26838. * @returns the indices array or an empty array if the mesh has no geometry
  26839. */
  26840. getIndices(copyWhenShared?: boolean, forceCopy?: boolean): Nullable<IndicesArray>;
  26841. /**
  26842. * Set specific vertex data
  26843. * @param kind defines the data kind (Position, normal, etc...)
  26844. * @param data defines the vertex data to use
  26845. * @param updatable defines if the vertex must be flagged as updatable (false as default)
  26846. * @param stride defines the stride to use (0 by default). This value is deduced from the kind value if not specified
  26847. */
  26848. setVerticesData(kind: string, data: FloatArray, updatable: boolean): void;
  26849. /**
  26850. * Update a specific associated vertex buffer
  26851. * @param kind defines which buffer to write to (positions, indices, normals, etc). Possible `kind` values :
  26852. * - VertexBuffer.PositionKind
  26853. * - VertexBuffer.UVKind
  26854. * - VertexBuffer.UV2Kind
  26855. * - VertexBuffer.UV3Kind
  26856. * - VertexBuffer.UV4Kind
  26857. * - VertexBuffer.UV5Kind
  26858. * - VertexBuffer.UV6Kind
  26859. * - VertexBuffer.ColorKind
  26860. * - VertexBuffer.MatricesIndicesKind
  26861. * - VertexBuffer.MatricesIndicesExtraKind
  26862. * - VertexBuffer.MatricesWeightsKind
  26863. * - VertexBuffer.MatricesWeightsExtraKind
  26864. * @param data defines the data source
  26865. * @param updateExtends defines if extends info of the mesh must be updated (can be null). This is mostly useful for "position" kind
  26866. * @param makeItUnique defines if the geometry associated with the mesh must be cloned to make the change only for this mesh (and not all meshes associated with the same geometry)
  26867. */
  26868. updateVerticesData(kind: string, data: FloatArray, updateExtends?: boolean, makeItUnique?: boolean): void;
  26869. /**
  26870. * Creates a new index buffer
  26871. * @param indices defines the indices to store in the index buffer
  26872. * @param totalVertices defines the total number of vertices (could be null)
  26873. * @param updatable defines if the index buffer must be flagged as updatable (false by default)
  26874. */
  26875. setIndices(indices: IndicesArray, totalVertices: Nullable<number>, updatable?: boolean): void;
  26876. }
  26877. /**
  26878. * This class contains the various kinds of data on every vertex of a mesh used in determining its shape and appearance
  26879. */
  26880. export class VertexData {
  26881. /**
  26882. * Mesh side orientation : usually the external or front surface
  26883. */
  26884. static readonly FRONTSIDE: number;
  26885. /**
  26886. * Mesh side orientation : usually the internal or back surface
  26887. */
  26888. static readonly BACKSIDE: number;
  26889. /**
  26890. * Mesh side orientation : both internal and external or front and back surfaces
  26891. */
  26892. static readonly DOUBLESIDE: number;
  26893. /**
  26894. * Mesh side orientation : by default, `FRONTSIDE`
  26895. */
  26896. static readonly DEFAULTSIDE: number;
  26897. /**
  26898. * An array of the x, y, z position of each vertex [...., x, y, z, .....]
  26899. */
  26900. positions: Nullable<FloatArray>;
  26901. /**
  26902. * An array of the x, y, z normal vector of each vertex [...., x, y, z, .....]
  26903. */
  26904. normals: Nullable<FloatArray>;
  26905. /**
  26906. * An array of the x, y, z tangent vector of each vertex [...., x, y, z, .....]
  26907. */
  26908. tangents: Nullable<FloatArray>;
  26909. /**
  26910. * An array of u,v which maps a texture image onto each vertex [...., u, v, .....]
  26911. */
  26912. uvs: Nullable<FloatArray>;
  26913. /**
  26914. * A second array of u,v which maps a texture image onto each vertex [...., u, v, .....]
  26915. */
  26916. uvs2: Nullable<FloatArray>;
  26917. /**
  26918. * A third array of u,v which maps a texture image onto each vertex [...., u, v, .....]
  26919. */
  26920. uvs3: Nullable<FloatArray>;
  26921. /**
  26922. * A fourth array of u,v which maps a texture image onto each vertex [...., u, v, .....]
  26923. */
  26924. uvs4: Nullable<FloatArray>;
  26925. /**
  26926. * A fifth array of u,v which maps a texture image onto each vertex [...., u, v, .....]
  26927. */
  26928. uvs5: Nullable<FloatArray>;
  26929. /**
  26930. * A sixth array of u,v which maps a texture image onto each vertex [...., u, v, .....]
  26931. */
  26932. uvs6: Nullable<FloatArray>;
  26933. /**
  26934. * An array of the r, g, b, a, color of each vertex [...., r, g, b, a, .....]
  26935. */
  26936. colors: Nullable<FloatArray>;
  26937. /**
  26938. * An array containing the list of indices to the array of matrices produced by bones, each vertex have up to 4 indices (8 if the matricesIndicesExtra is set).
  26939. */
  26940. matricesIndices: Nullable<FloatArray>;
  26941. /**
  26942. * An array containing the list of weights defining the weight of each indexed matrix in the final computation
  26943. */
  26944. matricesWeights: Nullable<FloatArray>;
  26945. /**
  26946. * An array extending the number of possible indices
  26947. */
  26948. matricesIndicesExtra: Nullable<FloatArray>;
  26949. /**
  26950. * An array extending the number of possible weights when the number of indices is extended
  26951. */
  26952. matricesWeightsExtra: Nullable<FloatArray>;
  26953. /**
  26954. * An array of i, j, k the three vertex indices required for each triangular facet [...., i, j, k .....]
  26955. */
  26956. indices: Nullable<IndicesArray>;
  26957. /**
  26958. * Uses the passed data array to set the set the values for the specified kind of data
  26959. * @param data a linear array of floating numbers
  26960. * @param kind the type of data that is being set, eg positions, colors etc
  26961. */
  26962. set(data: FloatArray, kind: string): void;
  26963. /**
  26964. * Associates the vertexData to the passed Mesh.
  26965. * Sets it as updatable or not (default `false`)
  26966. * @param mesh the mesh the vertexData is applied to
  26967. * @param updatable when used and having the value true allows new data to update the vertexData
  26968. * @returns the VertexData
  26969. */
  26970. applyToMesh(mesh: Mesh, updatable?: boolean): VertexData;
  26971. /**
  26972. * Associates the vertexData to the passed Geometry.
  26973. * Sets it as updatable or not (default `false`)
  26974. * @param geometry the geometry the vertexData is applied to
  26975. * @param updatable when used and having the value true allows new data to update the vertexData
  26976. * @returns VertexData
  26977. */
  26978. applyToGeometry(geometry: Geometry, updatable?: boolean): VertexData;
  26979. /**
  26980. * Updates the associated mesh
  26981. * @param mesh the mesh to be updated
  26982. * @param updateExtends when true the mesh BoundingInfo will be renewed when and if position kind is updated, optional with default false
  26983. * @param makeItUnique when true, and when and if position kind is updated, a new global geometry will be created from these positions and set to the mesh, optional with default false
  26984. * @returns VertexData
  26985. */
  26986. updateMesh(mesh: Mesh): VertexData;
  26987. /**
  26988. * Updates the associated geometry
  26989. * @param geometry the geometry to be updated
  26990. * @param updateExtends when true BoundingInfo will be renewed when and if position kind is updated, optional with default false
  26991. * @param makeItUnique when true, and when and if position kind is updated, a new global geometry will be created from these positions and set to the mesh, optional with default false
  26992. * @returns VertexData.
  26993. */
  26994. updateGeometry(geometry: Geometry): VertexData;
  26995. private _applyTo;
  26996. private _update;
  26997. /**
  26998. * Transforms each position and each normal of the vertexData according to the passed Matrix
  26999. * @param matrix the transforming matrix
  27000. * @returns the VertexData
  27001. */
  27002. transform(matrix: Matrix): VertexData;
  27003. /**
  27004. * Merges the passed VertexData into the current one
  27005. * @param other the VertexData to be merged into the current one
  27006. * @param use32BitsIndices defines a boolean indicating if indices must be store in a 32 bits array
  27007. * @returns the modified VertexData
  27008. */
  27009. merge(other: VertexData, use32BitsIndices?: boolean): VertexData;
  27010. private _mergeElement;
  27011. private _validate;
  27012. /**
  27013. * Serializes the VertexData
  27014. * @returns a serialized object
  27015. */
  27016. serialize(): any;
  27017. /**
  27018. * Extracts the vertexData from a mesh
  27019. * @param mesh the mesh from which to extract the VertexData
  27020. * @param copyWhenShared defines if the VertexData must be cloned when shared between multiple meshes, optional, default false
  27021. * @param forceCopy indicating that the VertexData must be cloned, optional, default false
  27022. * @returns the object VertexData associated to the passed mesh
  27023. */
  27024. static ExtractFromMesh(mesh: Mesh, copyWhenShared?: boolean, forceCopy?: boolean): VertexData;
  27025. /**
  27026. * Extracts the vertexData from the geometry
  27027. * @param geometry the geometry from which to extract the VertexData
  27028. * @param copyWhenShared defines if the VertexData must be cloned when the geometrty is shared between multiple meshes, optional, default false
  27029. * @param forceCopy indicating that the VertexData must be cloned, optional, default false
  27030. * @returns the object VertexData associated to the passed mesh
  27031. */
  27032. static ExtractFromGeometry(geometry: Geometry, copyWhenShared?: boolean, forceCopy?: boolean): VertexData;
  27033. private static _ExtractFrom;
  27034. /**
  27035. * Creates the VertexData for a Ribbon
  27036. * @param options an object used to set the following optional parameters for the ribbon, required but can be empty
  27037. * * pathArray array of paths, each of which an array of successive Vector3
  27038. * * closeArray creates a seam between the first and the last paths of the pathArray, optional, default false
  27039. * * closePath creates a seam between the first and the last points of each path of the path array, optional, default false
  27040. * * offset a positive integer, only used when pathArray contains a single path (offset = 10 means the point 1 is joined to the point 11), default rounded half size of the pathArray length
  27041. * * sideOrientation optional and takes the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  27042. * * frontUvs only usable when you create a double-sided mesh, used to choose what parts of the texture image to crop and apply on the front side, optional, default vector4 (0, 0, 1, 1)
  27043. * * backUVs only usable when you create a double-sided mesh, used to choose what parts of the texture image to crop and apply on the back side, optional, default vector4 (0, 0, 1, 1)
  27044. * * invertUV swaps in the U and V coordinates when applying a texture, optional, default false
  27045. * * uvs a linear array, of length 2 * number of vertices, of custom UV values, optional
  27046. * * colors a linear array, of length 4 * number of vertices, of custom color values, optional
  27047. * @returns the VertexData of the ribbon
  27048. */
  27049. static CreateRibbon(options: {
  27050. pathArray: Vector3[][];
  27051. closeArray?: boolean;
  27052. closePath?: boolean;
  27053. offset?: number;
  27054. sideOrientation?: number;
  27055. frontUVs?: Vector4;
  27056. backUVs?: Vector4;
  27057. invertUV?: boolean;
  27058. uvs?: Vector2[];
  27059. colors?: Color4[];
  27060. }): VertexData;
  27061. /**
  27062. * Creates the VertexData for a box
  27063. * @param options an object used to set the following optional parameters for the box, required but can be empty
  27064. * * size sets the width, height and depth of the box to the value of size, optional default 1
  27065. * * width sets the width (x direction) of the box, overwrites the width set by size, optional, default size
  27066. * * height sets the height (y direction) of the box, overwrites the height set by size, optional, default size
  27067. * * depth sets the depth (z direction) of the box, overwrites the depth set by size, optional, default size
  27068. * * faceUV an array of 6 Vector4 elements used to set different images to each box side
  27069. * * faceColors an array of 6 Color3 elements used to set different colors to each box side
  27070. * * sideOrientation optional and takes the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  27071. * * frontUvs only usable when you create a double-sided mesh, used to choose what parts of the texture image to crop and apply on the front side, optional, default vector4 (0, 0, 1, 1)
  27072. * * backUVs only usable when you create a double-sided mesh, used to choose what parts of the texture image to crop and apply on the back side, optional, default vector4 (0, 0, 1, 1)
  27073. * @returns the VertexData of the box
  27074. */
  27075. static CreateBox(options: {
  27076. size?: number;
  27077. width?: number;
  27078. height?: number;
  27079. depth?: number;
  27080. faceUV?: Vector4[];
  27081. faceColors?: Color4[];
  27082. sideOrientation?: number;
  27083. frontUVs?: Vector4;
  27084. backUVs?: Vector4;
  27085. }): VertexData;
  27086. /**
  27087. * Creates the VertexData for a tiled box
  27088. * @param options an object used to set the following optional parameters for the box, required but can be empty
  27089. * * faceTiles sets the pattern, tile size and number of tiles for a face
  27090. * * faceUV an array of 6 Vector4 elements used to set different images to each box side
  27091. * * faceColors an array of 6 Color3 elements used to set different colors to each box side
  27092. * * sideOrientation optional and takes the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  27093. * @returns the VertexData of the box
  27094. */
  27095. static CreateTiledBox(options: {
  27096. pattern?: number;
  27097. width?: number;
  27098. height?: number;
  27099. depth?: number;
  27100. tileSize?: number;
  27101. tileWidth?: number;
  27102. tileHeight?: number;
  27103. alignHorizontal?: number;
  27104. alignVertical?: number;
  27105. faceUV?: Vector4[];
  27106. faceColors?: Color4[];
  27107. sideOrientation?: number;
  27108. }): VertexData;
  27109. /**
  27110. * Creates the VertexData for a tiled plane
  27111. * @param options an object used to set the following optional parameters for the box, required but can be empty
  27112. * * pattern a limited pattern arrangement depending on the number
  27113. * * tileSize sets the width, height and depth of the tile to the value of size, optional default 1
  27114. * * tileWidth sets the width (x direction) of the tile, overwrites the width set by size, optional, default size
  27115. * * tileHeight sets the height (y direction) of the tile, overwrites the height set by size, optional, default size
  27116. * * sideOrientation optional and takes the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  27117. * * frontUvs only usable when you create a double-sided mesh, used to choose what parts of the texture image to crop and apply on the front side, optional, default vector4 (0, 0, 1, 1)
  27118. * * backUVs only usable when you create a double-sided mesh, used to choose what parts of the texture image to crop and apply on the back side, optional, default vector4 (0, 0, 1, 1)
  27119. * @returns the VertexData of the tiled plane
  27120. */
  27121. static CreateTiledPlane(options: {
  27122. pattern?: number;
  27123. tileSize?: number;
  27124. tileWidth?: number;
  27125. tileHeight?: number;
  27126. size?: number;
  27127. width?: number;
  27128. height?: number;
  27129. alignHorizontal?: number;
  27130. alignVertical?: number;
  27131. sideOrientation?: number;
  27132. frontUVs?: Vector4;
  27133. backUVs?: Vector4;
  27134. }): VertexData;
  27135. /**
  27136. * Creates the VertexData for an ellipsoid, defaults to a sphere
  27137. * @param options an object used to set the following optional parameters for the box, required but can be empty
  27138. * * segments sets the number of horizontal strips optional, default 32
  27139. * * diameter sets the axes dimensions, diameterX, diameterY and diameterZ to the value of diameter, optional default 1
  27140. * * diameterX sets the diameterX (x direction) of the ellipsoid, overwrites the diameterX set by diameter, optional, default diameter
  27141. * * diameterY sets the diameterY (y direction) of the ellipsoid, overwrites the diameterY set by diameter, optional, default diameter
  27142. * * diameterZ sets the diameterZ (z direction) of the ellipsoid, overwrites the diameterZ set by diameter, optional, default diameter
  27143. * * arc a number from 0 to 1, to create an unclosed ellipsoid based on the fraction of the circumference (latitude) given by the arc value, optional, default 1
  27144. * * slice a number from 0 to 1, to create an unclosed ellipsoid based on the fraction of the height (latitude) given by the arc value, optional, default 1
  27145. * * sideOrientation optional and takes the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  27146. * * frontUvs only usable when you create a double-sided mesh, used to choose what parts of the texture image to crop and apply on the front side, optional, default vector4 (0, 0, 1, 1)
  27147. * * backUVs only usable when you create a double-sided mesh, used to choose what parts of the texture image to crop and apply on the back side, optional, default vector4 (0, 0, 1, 1)
  27148. * @returns the VertexData of the ellipsoid
  27149. */
  27150. static CreateSphere(options: {
  27151. segments?: number;
  27152. diameter?: number;
  27153. diameterX?: number;
  27154. diameterY?: number;
  27155. diameterZ?: number;
  27156. arc?: number;
  27157. slice?: number;
  27158. sideOrientation?: number;
  27159. frontUVs?: Vector4;
  27160. backUVs?: Vector4;
  27161. }): VertexData;
  27162. /**
  27163. * Creates the VertexData for a cylinder, cone or prism
  27164. * @param options an object used to set the following optional parameters for the box, required but can be empty
  27165. * * height sets the height (y direction) of the cylinder, optional, default 2
  27166. * * diameterTop sets the diameter of the top of the cone, overwrites diameter, optional, default diameter
  27167. * * diameterBottom sets the diameter of the bottom of the cone, overwrites diameter, optional, default diameter
  27168. * * diameter sets the diameter of the top and bottom of the cone, optional default 1
  27169. * * tessellation the number of prism sides, 3 for a triangular prism, optional, default 24
  27170. * * subdivisions` the number of rings along the cylinder height, optional, default 1
  27171. * * arc a number from 0 to 1, to create an unclosed cylinder based on the fraction of the circumference given by the arc value, optional, default 1
  27172. * * faceColors an array of Color3 elements used to set different colors to the top, rings and bottom respectively
  27173. * * faceUV an array of Vector4 elements used to set different images to the top, rings and bottom respectively
  27174. * * hasRings when true makes each subdivision independantly treated as a face for faceUV and faceColors, optional, default false
  27175. * * enclose when true closes an open cylinder by adding extra flat faces between the height axis and vertical edges, think cut cake
  27176. * * sideOrientation optional and takes the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  27177. * * frontUvs only usable when you create a double-sided mesh, used to choose what parts of the texture image to crop and apply on the front side, optional, default vector4 (0, 0, 1, 1)
  27178. * * backUVs only usable when you create a double-sided mesh, used to choose what parts of the texture image to crop and apply on the back side, optional, default vector4 (0, 0, 1, 1)
  27179. * @returns the VertexData of the cylinder, cone or prism
  27180. */
  27181. static CreateCylinder(options: {
  27182. height?: number;
  27183. diameterTop?: number;
  27184. diameterBottom?: number;
  27185. diameter?: number;
  27186. tessellation?: number;
  27187. subdivisions?: number;
  27188. arc?: number;
  27189. faceColors?: Color4[];
  27190. faceUV?: Vector4[];
  27191. hasRings?: boolean;
  27192. enclose?: boolean;
  27193. sideOrientation?: number;
  27194. frontUVs?: Vector4;
  27195. backUVs?: Vector4;
  27196. }): VertexData;
  27197. /**
  27198. * Creates the VertexData for a torus
  27199. * @param options an object used to set the following optional parameters for the box, required but can be empty
  27200. * * diameter the diameter of the torus, optional default 1
  27201. * * thickness the diameter of the tube forming the torus, optional default 0.5
  27202. * * tessellation the number of prism sides, 3 for a triangular prism, optional, default 24
  27203. * * sideOrientation optional and takes the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  27204. * * frontUvs only usable when you create a double-sided mesh, used to choose what parts of the texture image to crop and apply on the front side, optional, default vector4 (0, 0, 1, 1)
  27205. * * backUVs only usable when you create a double-sided mesh, used to choose what parts of the texture image to crop and apply on the back side, optional, default vector4 (0, 0, 1, 1)
  27206. * @returns the VertexData of the torus
  27207. */
  27208. static CreateTorus(options: {
  27209. diameter?: number;
  27210. thickness?: number;
  27211. tessellation?: number;
  27212. sideOrientation?: number;
  27213. frontUVs?: Vector4;
  27214. backUVs?: Vector4;
  27215. }): VertexData;
  27216. /**
  27217. * Creates the VertexData of the LineSystem
  27218. * @param options an object used to set the following optional parameters for the LineSystem, required but can be empty
  27219. * - lines an array of lines, each line being an array of successive Vector3
  27220. * - colors an array of line colors, each of the line colors being an array of successive Color4, one per line point
  27221. * @returns the VertexData of the LineSystem
  27222. */
  27223. static CreateLineSystem(options: {
  27224. lines: Vector3[][];
  27225. colors?: Nullable<Color4[][]>;
  27226. }): VertexData;
  27227. /**
  27228. * Create the VertexData for a DashedLines
  27229. * @param options an object used to set the following optional parameters for the DashedLines, required but can be empty
  27230. * - points an array successive Vector3
  27231. * - dashSize the size of the dashes relative to the dash number, optional, default 3
  27232. * - gapSize the size of the gap between two successive dashes relative to the dash number, optional, default 1
  27233. * - dashNb the intended total number of dashes, optional, default 200
  27234. * @returns the VertexData for the DashedLines
  27235. */
  27236. static CreateDashedLines(options: {
  27237. points: Vector3[];
  27238. dashSize?: number;
  27239. gapSize?: number;
  27240. dashNb?: number;
  27241. }): VertexData;
  27242. /**
  27243. * Creates the VertexData for a Ground
  27244. * @param options an object used to set the following optional parameters for the Ground, required but can be empty
  27245. * - width the width (x direction) of the ground, optional, default 1
  27246. * - height the height (z direction) of the ground, optional, default 1
  27247. * - subdivisions the number of subdivisions per side, optional, default 1
  27248. * @returns the VertexData of the Ground
  27249. */
  27250. static CreateGround(options: {
  27251. width?: number;
  27252. height?: number;
  27253. subdivisions?: number;
  27254. subdivisionsX?: number;
  27255. subdivisionsY?: number;
  27256. }): VertexData;
  27257. /**
  27258. * Creates the VertexData for a TiledGround by subdividing the ground into tiles
  27259. * @param options an object used to set the following optional parameters for the Ground, required but can be empty
  27260. * * xmin the ground minimum X coordinate, optional, default -1
  27261. * * zmin the ground minimum Z coordinate, optional, default -1
  27262. * * xmax the ground maximum X coordinate, optional, default 1
  27263. * * zmax the ground maximum Z coordinate, optional, default 1
  27264. * * subdivisions a javascript object {w: positive integer, h: positive integer}, `w` and `h` are the numbers of subdivisions on the ground width and height creating 'tiles', default {w: 6, h: 6}
  27265. * * precision a javascript object {w: positive integer, h: positive integer}, `w` and `h` are the numbers of subdivisions on the tile width and height, default {w: 2, h: 2}
  27266. * @returns the VertexData of the TiledGround
  27267. */
  27268. static CreateTiledGround(options: {
  27269. xmin: number;
  27270. zmin: number;
  27271. xmax: number;
  27272. zmax: number;
  27273. subdivisions?: {
  27274. w: number;
  27275. h: number;
  27276. };
  27277. precision?: {
  27278. w: number;
  27279. h: number;
  27280. };
  27281. }): VertexData;
  27282. /**
  27283. * Creates the VertexData of the Ground designed from a heightmap
  27284. * @param options an object used to set the following parameters for the Ground, required and provided by MeshBuilder.CreateGroundFromHeightMap
  27285. * * width the width (x direction) of the ground
  27286. * * height the height (z direction) of the ground
  27287. * * subdivisions the number of subdivisions per side
  27288. * * minHeight the minimum altitude on the ground, optional, default 0
  27289. * * maxHeight the maximum altitude on the ground, optional default 1
  27290. * * colorFilter the filter to apply to the image pixel colors to compute the height, optional Color3, default (0.3, 0.59, 0.11)
  27291. * * buffer the array holding the image color data
  27292. * * bufferWidth the width of image
  27293. * * bufferHeight the height of image
  27294. * * alphaFilter Remove any data where the alpha channel is below this value, defaults 0 (all data visible)
  27295. * @returns the VertexData of the Ground designed from a heightmap
  27296. */
  27297. static CreateGroundFromHeightMap(options: {
  27298. width: number;
  27299. height: number;
  27300. subdivisions: number;
  27301. minHeight: number;
  27302. maxHeight: number;
  27303. colorFilter: Color3;
  27304. buffer: Uint8Array;
  27305. bufferWidth: number;
  27306. bufferHeight: number;
  27307. alphaFilter: number;
  27308. }): VertexData;
  27309. /**
  27310. * Creates the VertexData for a Plane
  27311. * @param options an object used to set the following optional parameters for the plane, required but can be empty
  27312. * * size sets the width and height of the plane to the value of size, optional default 1
  27313. * * width sets the width (x direction) of the plane, overwrites the width set by size, optional, default size
  27314. * * height sets the height (y direction) of the plane, overwrites the height set by size, optional, default size
  27315. * * sideOrientation optional and takes the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  27316. * * frontUvs only usable when you create a double-sided mesh, used to choose what parts of the texture image to crop and apply on the front side, optional, default vector4 (0, 0, 1, 1)
  27317. * * backUVs only usable when you create a double-sided mesh, used to choose what parts of the texture image to crop and apply on the back side, optional, default vector4 (0, 0, 1, 1)
  27318. * @returns the VertexData of the box
  27319. */
  27320. static CreatePlane(options: {
  27321. size?: number;
  27322. width?: number;
  27323. height?: number;
  27324. sideOrientation?: number;
  27325. frontUVs?: Vector4;
  27326. backUVs?: Vector4;
  27327. }): VertexData;
  27328. /**
  27329. * Creates the VertexData of the Disc or regular Polygon
  27330. * @param options an object used to set the following optional parameters for the disc, required but can be empty
  27331. * * radius the radius of the disc, optional default 0.5
  27332. * * tessellation the number of polygon sides, optional, default 64
  27333. * * arc a number from 0 to 1, to create an unclosed polygon based on the fraction of the circumference given by the arc value, optional, default 1
  27334. * * sideOrientation optional and takes the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  27335. * * frontUvs only usable when you create a double-sided mesh, used to choose what parts of the texture image to crop and apply on the front side, optional, default vector4 (0, 0, 1, 1)
  27336. * * backUVs only usable when you create a double-sided mesh, used to choose what parts of the texture image to crop and apply on the back side, optional, default vector4 (0, 0, 1, 1)
  27337. * @returns the VertexData of the box
  27338. */
  27339. static CreateDisc(options: {
  27340. radius?: number;
  27341. tessellation?: number;
  27342. arc?: number;
  27343. sideOrientation?: number;
  27344. frontUVs?: Vector4;
  27345. backUVs?: Vector4;
  27346. }): VertexData;
  27347. /**
  27348. * Creates the VertexData for an irregular Polygon in the XoZ plane using a mesh built by polygonTriangulation.build()
  27349. * All parameters are provided by MeshBuilder.CreatePolygon as needed
  27350. * @param polygon a mesh built from polygonTriangulation.build()
  27351. * @param sideOrientation takes the values Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  27352. * @param fUV an array of Vector4 elements used to set different images to the top, rings and bottom respectively
  27353. * @param fColors an array of Color3 elements used to set different colors to the top, rings and bottom respectively
  27354. * @param frontUVs only usable when you create a double-sided mesh, used to choose what parts of the texture image to crop and apply on the front side, optional, default vector4 (0, 0, 1, 1)
  27355. * @param backUVs only usable when you create a double-sided mesh, used to choose what parts of the texture image to crop and apply on the back side, optional, default vector4 (0, 0, 1, 1)
  27356. * @param wrap a boolean, default false, when true and fUVs used texture is wrapped around all sides, when false texture is applied side
  27357. * @returns the VertexData of the Polygon
  27358. */
  27359. static CreatePolygon(polygon: Mesh, sideOrientation: number, fUV?: Vector4[], fColors?: Color4[], frontUVs?: Vector4, backUVs?: Vector4, wrap?: boolean): VertexData;
  27360. /**
  27361. * Creates the VertexData of the IcoSphere
  27362. * @param options an object used to set the following optional parameters for the IcoSphere, required but can be empty
  27363. * * radius the radius of the IcoSphere, optional default 1
  27364. * * radiusX allows stretching in the x direction, optional, default radius
  27365. * * radiusY allows stretching in the y direction, optional, default radius
  27366. * * radiusZ allows stretching in the z direction, optional, default radius
  27367. * * flat when true creates a flat shaded mesh, optional, default true
  27368. * * subdivisions increasing the subdivisions increases the number of faces, optional, default 4
  27369. * * sideOrientation optional and takes the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  27370. * * frontUvs only usable when you create a double-sided mesh, used to choose what parts of the texture image to crop and apply on the front side, optional, default vector4 (0, 0, 1, 1)
  27371. * * backUVs only usable when you create a double-sided mesh, used to choose what parts of the texture image to crop and apply on the back side, optional, default vector4 (0, 0, 1, 1)
  27372. * @returns the VertexData of the IcoSphere
  27373. */
  27374. static CreateIcoSphere(options: {
  27375. radius?: number;
  27376. radiusX?: number;
  27377. radiusY?: number;
  27378. radiusZ?: number;
  27379. flat?: boolean;
  27380. subdivisions?: number;
  27381. sideOrientation?: number;
  27382. frontUVs?: Vector4;
  27383. backUVs?: Vector4;
  27384. }): VertexData;
  27385. /**
  27386. * Creates the VertexData for a Polyhedron
  27387. * @param options an object used to set the following optional parameters for the polyhedron, required but can be empty
  27388. * * type provided types are:
  27389. * * 0 : Tetrahedron, 1 : Octahedron, 2 : Dodecahedron, 3 : Icosahedron, 4 : Rhombicuboctahedron, 5 : Triangular Prism, 6 : Pentagonal Prism, 7 : Hexagonal Prism, 8 : Square Pyramid (J1)
  27390. * * 9 : Pentagonal Pyramid (J2), 10 : Triangular Dipyramid (J12), 11 : Pentagonal Dipyramid (J13), 12 : Elongated Square Dipyramid (J15), 13 : Elongated Pentagonal Dipyramid (J16), 14 : Elongated Pentagonal Cupola (J20)
  27391. * * size the size of the IcoSphere, optional default 1
  27392. * * sizeX allows stretching in the x direction, optional, default size
  27393. * * sizeY allows stretching in the y direction, optional, default size
  27394. * * sizeZ allows stretching in the z direction, optional, default size
  27395. * * custom a number that overwrites the type to create from an extended set of polyhedron from https://www.babylonjs-playground.com/#21QRSK#15 with minimised editor
  27396. * * faceUV an array of Vector4 elements used to set different images to the top, rings and bottom respectively
  27397. * * faceColors an array of Color3 elements used to set different colors to the top, rings and bottom respectively
  27398. * * flat when true creates a flat shaded mesh, optional, default true
  27399. * * subdivisions increasing the subdivisions increases the number of faces, optional, default 4
  27400. * * sideOrientation optional and takes the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  27401. * * frontUvs only usable when you create a double-sided mesh, used to choose what parts of the texture image to crop and apply on the front side, optional, default vector4 (0, 0, 1, 1)
  27402. * * backUVs only usable when you create a double-sided mesh, used to choose what parts of the texture image to crop and apply on the back side, optional, default vector4 (0, 0, 1, 1)
  27403. * @returns the VertexData of the Polyhedron
  27404. */
  27405. static CreatePolyhedron(options: {
  27406. type?: number;
  27407. size?: number;
  27408. sizeX?: number;
  27409. sizeY?: number;
  27410. sizeZ?: number;
  27411. custom?: any;
  27412. faceUV?: Vector4[];
  27413. faceColors?: Color4[];
  27414. flat?: boolean;
  27415. sideOrientation?: number;
  27416. frontUVs?: Vector4;
  27417. backUVs?: Vector4;
  27418. }): VertexData;
  27419. /**
  27420. * Creates the VertexData for a TorusKnot
  27421. * @param options an object used to set the following optional parameters for the TorusKnot, required but can be empty
  27422. * * radius the radius of the torus knot, optional, default 2
  27423. * * tube the thickness of the tube, optional, default 0.5
  27424. * * radialSegments the number of sides on each tube segments, optional, default 32
  27425. * * tubularSegments the number of tubes to decompose the knot into, optional, default 32
  27426. * * p the number of windings around the z axis, optional, default 2
  27427. * * q the number of windings around the x axis, optional, default 3
  27428. * * sideOrientation optional and takes the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  27429. * * frontUvs only usable when you create a double-sided mesh, used to choose what parts of the texture image to crop and apply on the front side, optional, default vector4 (0, 0, 1, 1)
  27430. * * backUVs only usable when you create a double-sided mesh, used to choose what parts of the texture image to crop and apply on the back side, optional, default vector4 (0, 0, 1, 1)
  27431. * @returns the VertexData of the Torus Knot
  27432. */
  27433. static CreateTorusKnot(options: {
  27434. radius?: number;
  27435. tube?: number;
  27436. radialSegments?: number;
  27437. tubularSegments?: number;
  27438. p?: number;
  27439. q?: number;
  27440. sideOrientation?: number;
  27441. frontUVs?: Vector4;
  27442. backUVs?: Vector4;
  27443. }): VertexData;
  27444. /**
  27445. * Compute normals for given positions and indices
  27446. * @param positions an array of vertex positions, [...., x, y, z, ......]
  27447. * @param indices an array of indices in groups of three for each triangular facet, [...., i, j, k, ......]
  27448. * @param normals an array of vertex normals, [...., x, y, z, ......]
  27449. * @param options an object used to set the following optional parameters for the TorusKnot, optional
  27450. * * facetNormals : optional array of facet normals (vector3)
  27451. * * facetPositions : optional array of facet positions (vector3)
  27452. * * facetPartitioning : optional partitioning array. facetPositions is required for facetPartitioning computation
  27453. * * ratio : optional partitioning ratio / bounding box, required for facetPartitioning computation
  27454. * * bInfo : optional bounding info, required for facetPartitioning computation
  27455. * * bbSize : optional bounding box size data, required for facetPartitioning computation
  27456. * * subDiv : optional partitioning data about subdivsions on each axis (int), required for facetPartitioning computation
  27457. * * useRightHandedSystem: optional boolean to for right handed system computation
  27458. * * depthSort : optional boolean to enable the facet depth sort computation
  27459. * * distanceTo : optional Vector3 to compute the facet depth from this location
  27460. * * depthSortedFacets : optional array of depthSortedFacets to store the facet distances from the reference location
  27461. */
  27462. static ComputeNormals(positions: any, indices: any, normals: any, options?: {
  27463. facetNormals?: any;
  27464. facetPositions?: any;
  27465. facetPartitioning?: any;
  27466. ratio?: number;
  27467. bInfo?: any;
  27468. bbSize?: Vector3;
  27469. subDiv?: any;
  27470. useRightHandedSystem?: boolean;
  27471. depthSort?: boolean;
  27472. distanceTo?: Vector3;
  27473. depthSortedFacets?: any;
  27474. }): void;
  27475. /** @hidden */
  27476. static _ComputeSides(sideOrientation: number, positions: FloatArray, indices: FloatArray, normals: FloatArray, uvs: FloatArray, frontUVs?: Vector4, backUVs?: Vector4): void;
  27477. /**
  27478. * Applies VertexData created from the imported parameters to the geometry
  27479. * @param parsedVertexData the parsed data from an imported file
  27480. * @param geometry the geometry to apply the VertexData to
  27481. */
  27482. static ImportVertexData(parsedVertexData: any, geometry: Geometry): void;
  27483. }
  27484. }
  27485. declare module "babylonjs/Morph/morphTarget" {
  27486. import { IAnimatable } from "babylonjs/Animations/animatable.interface";
  27487. import { Observable } from "babylonjs/Misc/observable";
  27488. import { Nullable, FloatArray } from "babylonjs/types";
  27489. import { Scene } from "babylonjs/scene";
  27490. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  27491. import { AnimationPropertiesOverride } from "babylonjs/Animations/animationPropertiesOverride";
  27492. /**
  27493. * Defines a target to use with MorphTargetManager
  27494. * @see https://doc.babylonjs.com/how_to/how_to_use_morphtargets
  27495. */
  27496. export class MorphTarget implements IAnimatable {
  27497. /** defines the name of the target */
  27498. name: string;
  27499. /**
  27500. * Gets or sets the list of animations
  27501. */
  27502. animations: import("babylonjs/Animations/animation").Animation[];
  27503. private _scene;
  27504. private _positions;
  27505. private _normals;
  27506. private _tangents;
  27507. private _uvs;
  27508. private _influence;
  27509. private _uniqueId;
  27510. /**
  27511. * Observable raised when the influence changes
  27512. */
  27513. onInfluenceChanged: Observable<boolean>;
  27514. /** @hidden */
  27515. _onDataLayoutChanged: Observable<void>;
  27516. /**
  27517. * Gets or sets the influence of this target (ie. its weight in the overall morphing)
  27518. */
  27519. get influence(): number;
  27520. set influence(influence: number);
  27521. /**
  27522. * Gets or sets the id of the morph Target
  27523. */
  27524. id: string;
  27525. private _animationPropertiesOverride;
  27526. /**
  27527. * Gets or sets the animation properties override
  27528. */
  27529. get animationPropertiesOverride(): Nullable<AnimationPropertiesOverride>;
  27530. set animationPropertiesOverride(value: Nullable<AnimationPropertiesOverride>);
  27531. /**
  27532. * Creates a new MorphTarget
  27533. * @param name defines the name of the target
  27534. * @param influence defines the influence to use
  27535. * @param scene defines the scene the morphtarget belongs to
  27536. */
  27537. constructor(
  27538. /** defines the name of the target */
  27539. name: string, influence?: number, scene?: Nullable<Scene>);
  27540. /**
  27541. * Gets the unique ID of this manager
  27542. */
  27543. get uniqueId(): number;
  27544. /**
  27545. * Gets a boolean defining if the target contains position data
  27546. */
  27547. get hasPositions(): boolean;
  27548. /**
  27549. * Gets a boolean defining if the target contains normal data
  27550. */
  27551. get hasNormals(): boolean;
  27552. /**
  27553. * Gets a boolean defining if the target contains tangent data
  27554. */
  27555. get hasTangents(): boolean;
  27556. /**
  27557. * Gets a boolean defining if the target contains texture coordinates data
  27558. */
  27559. get hasUVs(): boolean;
  27560. /**
  27561. * Affects position data to this target
  27562. * @param data defines the position data to use
  27563. */
  27564. setPositions(data: Nullable<FloatArray>): void;
  27565. /**
  27566. * Gets the position data stored in this target
  27567. * @returns a FloatArray containing the position data (or null if not present)
  27568. */
  27569. getPositions(): Nullable<FloatArray>;
  27570. /**
  27571. * Affects normal data to this target
  27572. * @param data defines the normal data to use
  27573. */
  27574. setNormals(data: Nullable<FloatArray>): void;
  27575. /**
  27576. * Gets the normal data stored in this target
  27577. * @returns a FloatArray containing the normal data (or null if not present)
  27578. */
  27579. getNormals(): Nullable<FloatArray>;
  27580. /**
  27581. * Affects tangent data to this target
  27582. * @param data defines the tangent data to use
  27583. */
  27584. setTangents(data: Nullable<FloatArray>): void;
  27585. /**
  27586. * Gets the tangent data stored in this target
  27587. * @returns a FloatArray containing the tangent data (or null if not present)
  27588. */
  27589. getTangents(): Nullable<FloatArray>;
  27590. /**
  27591. * Affects texture coordinates data to this target
  27592. * @param data defines the texture coordinates data to use
  27593. */
  27594. setUVs(data: Nullable<FloatArray>): void;
  27595. /**
  27596. * Gets the texture coordinates data stored in this target
  27597. * @returns a FloatArray containing the texture coordinates data (or null if not present)
  27598. */
  27599. getUVs(): Nullable<FloatArray>;
  27600. /**
  27601. * Clone the current target
  27602. * @returns a new MorphTarget
  27603. */
  27604. clone(): MorphTarget;
  27605. /**
  27606. * Serializes the current target into a Serialization object
  27607. * @returns the serialized object
  27608. */
  27609. serialize(): any;
  27610. /**
  27611. * Returns the string "MorphTarget"
  27612. * @returns "MorphTarget"
  27613. */
  27614. getClassName(): string;
  27615. /**
  27616. * Creates a new target from serialized data
  27617. * @param serializationObject defines the serialized data to use
  27618. * @returns a new MorphTarget
  27619. */
  27620. static Parse(serializationObject: any): MorphTarget;
  27621. /**
  27622. * Creates a MorphTarget from mesh data
  27623. * @param mesh defines the source mesh
  27624. * @param name defines the name to use for the new target
  27625. * @param influence defines the influence to attach to the target
  27626. * @returns a new MorphTarget
  27627. */
  27628. static FromMesh(mesh: AbstractMesh, name?: string, influence?: number): MorphTarget;
  27629. }
  27630. }
  27631. declare module "babylonjs/Morph/morphTargetManager" {
  27632. import { Nullable } from "babylonjs/types";
  27633. import { Scene } from "babylonjs/scene";
  27634. import { MorphTarget } from "babylonjs/Morph/morphTarget";
  27635. /**
  27636. * This class is used to deform meshes using morphing between different targets
  27637. * @see https://doc.babylonjs.com/how_to/how_to_use_morphtargets
  27638. */
  27639. export class MorphTargetManager {
  27640. private _targets;
  27641. private _targetInfluenceChangedObservers;
  27642. private _targetDataLayoutChangedObservers;
  27643. private _activeTargets;
  27644. private _scene;
  27645. private _influences;
  27646. private _supportsNormals;
  27647. private _supportsTangents;
  27648. private _supportsUVs;
  27649. private _vertexCount;
  27650. private _uniqueId;
  27651. private _tempInfluences;
  27652. /**
  27653. * Gets or sets a boolean indicating if normals must be morphed
  27654. */
  27655. enableNormalMorphing: boolean;
  27656. /**
  27657. * Gets or sets a boolean indicating if tangents must be morphed
  27658. */
  27659. enableTangentMorphing: boolean;
  27660. /**
  27661. * Gets or sets a boolean indicating if UV must be morphed
  27662. */
  27663. enableUVMorphing: boolean;
  27664. /**
  27665. * Creates a new MorphTargetManager
  27666. * @param scene defines the current scene
  27667. */
  27668. constructor(scene?: Nullable<Scene>);
  27669. /**
  27670. * Gets the unique ID of this manager
  27671. */
  27672. get uniqueId(): number;
  27673. /**
  27674. * Gets the number of vertices handled by this manager
  27675. */
  27676. get vertexCount(): number;
  27677. /**
  27678. * Gets a boolean indicating if this manager supports morphing of normals
  27679. */
  27680. get supportsNormals(): boolean;
  27681. /**
  27682. * Gets a boolean indicating if this manager supports morphing of tangents
  27683. */
  27684. get supportsTangents(): boolean;
  27685. /**
  27686. * Gets a boolean indicating if this manager supports morphing of texture coordinates
  27687. */
  27688. get supportsUVs(): boolean;
  27689. /**
  27690. * Gets the number of targets stored in this manager
  27691. */
  27692. get numTargets(): number;
  27693. /**
  27694. * Gets the number of influencers (ie. the number of targets with influences > 0)
  27695. */
  27696. get numInfluencers(): number;
  27697. /**
  27698. * Gets the list of influences (one per target)
  27699. */
  27700. get influences(): Float32Array;
  27701. /**
  27702. * Gets the active target at specified index. An active target is a target with an influence > 0
  27703. * @param index defines the index to check
  27704. * @returns the requested target
  27705. */
  27706. getActiveTarget(index: number): MorphTarget;
  27707. /**
  27708. * Gets the target at specified index
  27709. * @param index defines the index to check
  27710. * @returns the requested target
  27711. */
  27712. getTarget(index: number): MorphTarget;
  27713. /**
  27714. * Add a new target to this manager
  27715. * @param target defines the target to add
  27716. */
  27717. addTarget(target: MorphTarget): void;
  27718. /**
  27719. * Removes a target from the manager
  27720. * @param target defines the target to remove
  27721. */
  27722. removeTarget(target: MorphTarget): void;
  27723. /**
  27724. * Clone the current manager
  27725. * @returns a new MorphTargetManager
  27726. */
  27727. clone(): MorphTargetManager;
  27728. /**
  27729. * Serializes the current manager into a Serialization object
  27730. * @returns the serialized object
  27731. */
  27732. serialize(): any;
  27733. private _syncActiveTargets;
  27734. /**
  27735. * Syncrhonize the targets with all the meshes using this morph target manager
  27736. */
  27737. synchronize(): void;
  27738. /**
  27739. * Creates a new MorphTargetManager from serialized data
  27740. * @param serializationObject defines the serialized data
  27741. * @param scene defines the hosting scene
  27742. * @returns the new MorphTargetManager
  27743. */
  27744. static Parse(serializationObject: any, scene: Scene): MorphTargetManager;
  27745. }
  27746. }
  27747. declare module "babylonjs/Meshes/meshLODLevel" {
  27748. import { Mesh } from "babylonjs/Meshes/mesh";
  27749. import { Nullable } from "babylonjs/types";
  27750. /**
  27751. * Class used to represent a specific level of detail of a mesh
  27752. * @see https://doc.babylonjs.com/how_to/how_to_use_lod
  27753. */
  27754. export class MeshLODLevel {
  27755. /** Defines the distance where this level should start being displayed */
  27756. distance: number;
  27757. /** Defines the mesh to use to render this level */
  27758. mesh: Nullable<Mesh>;
  27759. /**
  27760. * Creates a new LOD level
  27761. * @param distance defines the distance where this level should star being displayed
  27762. * @param mesh defines the mesh to use to render this level
  27763. */
  27764. constructor(
  27765. /** Defines the distance where this level should start being displayed */
  27766. distance: number,
  27767. /** Defines the mesh to use to render this level */
  27768. mesh: Nullable<Mesh>);
  27769. }
  27770. }
  27771. declare module "babylonjs/Misc/canvasGenerator" {
  27772. /**
  27773. * Helper class used to generate a canvas to manipulate images
  27774. */
  27775. export class CanvasGenerator {
  27776. /**
  27777. * Create a new canvas (or offscreen canvas depending on the context)
  27778. * @param width defines the expected width
  27779. * @param height defines the expected height
  27780. * @return a new canvas or offscreen canvas
  27781. */
  27782. static CreateCanvas(width: number, height: number): HTMLCanvasElement | OffscreenCanvas;
  27783. }
  27784. }
  27785. declare module "babylonjs/Meshes/groundMesh" {
  27786. import { Scene } from "babylonjs/scene";
  27787. import { Vector3 } from "babylonjs/Maths/math.vector";
  27788. import { Mesh } from "babylonjs/Meshes/mesh";
  27789. /**
  27790. * Mesh representing the gorund
  27791. */
  27792. export class GroundMesh extends Mesh {
  27793. /** If octree should be generated */
  27794. generateOctree: boolean;
  27795. private _heightQuads;
  27796. /** @hidden */
  27797. _subdivisionsX: number;
  27798. /** @hidden */
  27799. _subdivisionsY: number;
  27800. /** @hidden */
  27801. _width: number;
  27802. /** @hidden */
  27803. _height: number;
  27804. /** @hidden */
  27805. _minX: number;
  27806. /** @hidden */
  27807. _maxX: number;
  27808. /** @hidden */
  27809. _minZ: number;
  27810. /** @hidden */
  27811. _maxZ: number;
  27812. constructor(name: string, scene: Scene);
  27813. /**
  27814. * "GroundMesh"
  27815. * @returns "GroundMesh"
  27816. */
  27817. getClassName(): string;
  27818. /**
  27819. * The minimum of x and y subdivisions
  27820. */
  27821. get subdivisions(): number;
  27822. /**
  27823. * X subdivisions
  27824. */
  27825. get subdivisionsX(): number;
  27826. /**
  27827. * Y subdivisions
  27828. */
  27829. get subdivisionsY(): number;
  27830. /**
  27831. * This function will update an octree to help to select the right submeshes for rendering, picking and collision computations.
  27832. * Please note that you must have a decent number of submeshes to get performance improvements when using an octree
  27833. * @param chunksCount the number of subdivisions for x and y
  27834. * @param octreeBlocksSize (Default: 32)
  27835. */
  27836. optimize(chunksCount: number, octreeBlocksSize?: number): void;
  27837. /**
  27838. * Returns a height (y) value in the Worl system :
  27839. * the ground altitude at the coordinates (x, z) expressed in the World system.
  27840. * @param x x coordinate
  27841. * @param z z coordinate
  27842. * @returns the ground y position if (x, z) are outside the ground surface.
  27843. */
  27844. getHeightAtCoordinates(x: number, z: number): number;
  27845. /**
  27846. * Returns a normalized vector (Vector3) orthogonal to the ground
  27847. * at the ground coordinates (x, z) expressed in the World system.
  27848. * @param x x coordinate
  27849. * @param z z coordinate
  27850. * @returns Vector3(0.0, 1.0, 0.0) if (x, z) are outside the ground surface.
  27851. */
  27852. getNormalAtCoordinates(x: number, z: number): Vector3;
  27853. /**
  27854. * Updates the Vector3 passed a reference with a normalized vector orthogonal to the ground
  27855. * at the ground coordinates (x, z) expressed in the World system.
  27856. * Doesn't uptade the reference Vector3 if (x, z) are outside the ground surface.
  27857. * @param x x coordinate
  27858. * @param z z coordinate
  27859. * @param ref vector to store the result
  27860. * @returns the GroundMesh.
  27861. */
  27862. getNormalAtCoordinatesToRef(x: number, z: number, ref: Vector3): GroundMesh;
  27863. /**
  27864. * Force the heights to be recomputed for getHeightAtCoordinates() or getNormalAtCoordinates()
  27865. * if the ground has been updated.
  27866. * This can be used in the render loop.
  27867. * @returns the GroundMesh.
  27868. */
  27869. updateCoordinateHeights(): GroundMesh;
  27870. private _getFacetAt;
  27871. private _initHeightQuads;
  27872. private _computeHeightQuads;
  27873. /**
  27874. * Serializes this ground mesh
  27875. * @param serializationObject object to write serialization to
  27876. */
  27877. serialize(serializationObject: any): void;
  27878. /**
  27879. * Parses a serialized ground mesh
  27880. * @param parsedMesh the serialized mesh
  27881. * @param scene the scene to create the ground mesh in
  27882. * @returns the created ground mesh
  27883. */
  27884. static Parse(parsedMesh: any, scene: Scene): GroundMesh;
  27885. }
  27886. }
  27887. declare module "babylonjs/Physics/physicsJoint" {
  27888. import { Vector3 } from "babylonjs/Maths/math.vector";
  27889. import { IPhysicsEnginePlugin } from "babylonjs/Physics/IPhysicsEngine";
  27890. /**
  27891. * Interface for Physics-Joint data
  27892. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  27893. */
  27894. export interface PhysicsJointData {
  27895. /**
  27896. * The main pivot of the joint
  27897. */
  27898. mainPivot?: Vector3;
  27899. /**
  27900. * The connected pivot of the joint
  27901. */
  27902. connectedPivot?: Vector3;
  27903. /**
  27904. * The main axis of the joint
  27905. */
  27906. mainAxis?: Vector3;
  27907. /**
  27908. * The connected axis of the joint
  27909. */
  27910. connectedAxis?: Vector3;
  27911. /**
  27912. * The collision of the joint
  27913. */
  27914. collision?: boolean;
  27915. /**
  27916. * Native Oimo/Cannon/Energy data
  27917. */
  27918. nativeParams?: any;
  27919. }
  27920. /**
  27921. * This is a holder class for the physics joint created by the physics plugin
  27922. * It holds a set of functions to control the underlying joint
  27923. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  27924. */
  27925. export class PhysicsJoint {
  27926. /**
  27927. * The type of the physics joint
  27928. */
  27929. type: number;
  27930. /**
  27931. * The data for the physics joint
  27932. */
  27933. jointData: PhysicsJointData;
  27934. private _physicsJoint;
  27935. protected _physicsPlugin: IPhysicsEnginePlugin;
  27936. /**
  27937. * Initializes the physics joint
  27938. * @param type The type of the physics joint
  27939. * @param jointData The data for the physics joint
  27940. */
  27941. constructor(
  27942. /**
  27943. * The type of the physics joint
  27944. */
  27945. type: number,
  27946. /**
  27947. * The data for the physics joint
  27948. */
  27949. jointData: PhysicsJointData);
  27950. /**
  27951. * Gets the physics joint
  27952. */
  27953. get physicsJoint(): any;
  27954. /**
  27955. * Sets the physics joint
  27956. */
  27957. set physicsJoint(newJoint: any);
  27958. /**
  27959. * Sets the physics plugin
  27960. */
  27961. set physicsPlugin(physicsPlugin: IPhysicsEnginePlugin);
  27962. /**
  27963. * Execute a function that is physics-plugin specific.
  27964. * @param {Function} func the function that will be executed.
  27965. * It accepts two parameters: the physics world and the physics joint
  27966. */
  27967. executeNativeFunction(func: (world: any, physicsJoint: any) => void): void;
  27968. /**
  27969. * Distance-Joint type
  27970. */
  27971. static DistanceJoint: number;
  27972. /**
  27973. * Hinge-Joint type
  27974. */
  27975. static HingeJoint: number;
  27976. /**
  27977. * Ball-and-Socket joint type
  27978. */
  27979. static BallAndSocketJoint: number;
  27980. /**
  27981. * Wheel-Joint type
  27982. */
  27983. static WheelJoint: number;
  27984. /**
  27985. * Slider-Joint type
  27986. */
  27987. static SliderJoint: number;
  27988. /**
  27989. * Prismatic-Joint type
  27990. */
  27991. static PrismaticJoint: number;
  27992. /**
  27993. * Universal-Joint type
  27994. * ENERGY FTW! (compare with this - @see http://ode-wiki.org/wiki/index.php?title=Manual:_Joint_Types_and_Functions)
  27995. */
  27996. static UniversalJoint: number;
  27997. /**
  27998. * Hinge-Joint 2 type
  27999. */
  28000. static Hinge2Joint: number;
  28001. /**
  28002. * Point to Point Joint type. Similar to a Ball-Joint. Different in parameters
  28003. */
  28004. static PointToPointJoint: number;
  28005. /**
  28006. * Spring-Joint type
  28007. */
  28008. static SpringJoint: number;
  28009. /**
  28010. * Lock-Joint type
  28011. */
  28012. static LockJoint: number;
  28013. }
  28014. /**
  28015. * A class representing a physics distance joint
  28016. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  28017. */
  28018. export class DistanceJoint extends PhysicsJoint {
  28019. /**
  28020. *
  28021. * @param jointData The data for the Distance-Joint
  28022. */
  28023. constructor(jointData: DistanceJointData);
  28024. /**
  28025. * Update the predefined distance.
  28026. * @param maxDistance The maximum preferred distance
  28027. * @param minDistance The minimum preferred distance
  28028. */
  28029. updateDistance(maxDistance: number, minDistance?: number): void;
  28030. }
  28031. /**
  28032. * Represents a Motor-Enabled Joint
  28033. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  28034. */
  28035. export class MotorEnabledJoint extends PhysicsJoint implements IMotorEnabledJoint {
  28036. /**
  28037. * Initializes the Motor-Enabled Joint
  28038. * @param type The type of the joint
  28039. * @param jointData The physica joint data for the joint
  28040. */
  28041. constructor(type: number, jointData: PhysicsJointData);
  28042. /**
  28043. * Set the motor values.
  28044. * Attention, this function is plugin specific. Engines won't react 100% the same.
  28045. * @param force the force to apply
  28046. * @param maxForce max force for this motor.
  28047. */
  28048. setMotor(force?: number, maxForce?: number): void;
  28049. /**
  28050. * Set the motor's limits.
  28051. * Attention, this function is plugin specific. Engines won't react 100% the same.
  28052. * @param upperLimit The upper limit of the motor
  28053. * @param lowerLimit The lower limit of the motor
  28054. */
  28055. setLimit(upperLimit: number, lowerLimit?: number): void;
  28056. }
  28057. /**
  28058. * This class represents a single physics Hinge-Joint
  28059. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  28060. */
  28061. export class HingeJoint extends MotorEnabledJoint {
  28062. /**
  28063. * Initializes the Hinge-Joint
  28064. * @param jointData The joint data for the Hinge-Joint
  28065. */
  28066. constructor(jointData: PhysicsJointData);
  28067. /**
  28068. * Set the motor values.
  28069. * Attention, this function is plugin specific. Engines won't react 100% the same.
  28070. * @param {number} force the force to apply
  28071. * @param {number} maxForce max force for this motor.
  28072. */
  28073. setMotor(force?: number, maxForce?: number): void;
  28074. /**
  28075. * Set the motor's limits.
  28076. * Attention, this function is plugin specific. Engines won't react 100% the same.
  28077. * @param upperLimit The upper limit of the motor
  28078. * @param lowerLimit The lower limit of the motor
  28079. */
  28080. setLimit(upperLimit: number, lowerLimit?: number): void;
  28081. }
  28082. /**
  28083. * This class represents a dual hinge physics joint (same as wheel joint)
  28084. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  28085. */
  28086. export class Hinge2Joint extends MotorEnabledJoint {
  28087. /**
  28088. * Initializes the Hinge2-Joint
  28089. * @param jointData The joint data for the Hinge2-Joint
  28090. */
  28091. constructor(jointData: PhysicsJointData);
  28092. /**
  28093. * Set the motor values.
  28094. * Attention, this function is plugin specific. Engines won't react 100% the same.
  28095. * @param {number} targetSpeed the speed the motor is to reach
  28096. * @param {number} maxForce max force for this motor.
  28097. * @param {motorIndex} the motor's index, 0 or 1.
  28098. */
  28099. setMotor(targetSpeed?: number, maxForce?: number, motorIndex?: number): void;
  28100. /**
  28101. * Set the motor limits.
  28102. * Attention, this function is plugin specific. Engines won't react 100% the same.
  28103. * @param {number} upperLimit the upper limit
  28104. * @param {number} lowerLimit lower limit
  28105. * @param {motorIndex} the motor's index, 0 or 1.
  28106. */
  28107. setLimit(upperLimit: number, lowerLimit?: number, motorIndex?: number): void;
  28108. }
  28109. /**
  28110. * Interface for a motor enabled joint
  28111. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  28112. */
  28113. export interface IMotorEnabledJoint {
  28114. /**
  28115. * Physics joint
  28116. */
  28117. physicsJoint: any;
  28118. /**
  28119. * Sets the motor of the motor-enabled joint
  28120. * @param force The force of the motor
  28121. * @param maxForce The maximum force of the motor
  28122. * @param motorIndex The index of the motor
  28123. */
  28124. setMotor(force?: number, maxForce?: number, motorIndex?: number): void;
  28125. /**
  28126. * Sets the limit of the motor
  28127. * @param upperLimit The upper limit of the motor
  28128. * @param lowerLimit The lower limit of the motor
  28129. * @param motorIndex The index of the motor
  28130. */
  28131. setLimit(upperLimit: number, lowerLimit?: number, motorIndex?: number): void;
  28132. }
  28133. /**
  28134. * Joint data for a Distance-Joint
  28135. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  28136. */
  28137. export interface DistanceJointData extends PhysicsJointData {
  28138. /**
  28139. * Max distance the 2 joint objects can be apart
  28140. */
  28141. maxDistance: number;
  28142. }
  28143. /**
  28144. * Joint data from a spring joint
  28145. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  28146. */
  28147. export interface SpringJointData extends PhysicsJointData {
  28148. /**
  28149. * Length of the spring
  28150. */
  28151. length: number;
  28152. /**
  28153. * Stiffness of the spring
  28154. */
  28155. stiffness: number;
  28156. /**
  28157. * Damping of the spring
  28158. */
  28159. damping: number;
  28160. /** this callback will be called when applying the force to the impostors. */
  28161. forceApplicationCallback: () => void;
  28162. }
  28163. }
  28164. declare module "babylonjs/Physics/physicsRaycastResult" {
  28165. import { Vector3 } from "babylonjs/Maths/math.vector";
  28166. /**
  28167. * Holds the data for the raycast result
  28168. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  28169. */
  28170. export class PhysicsRaycastResult {
  28171. private _hasHit;
  28172. private _hitDistance;
  28173. private _hitNormalWorld;
  28174. private _hitPointWorld;
  28175. private _rayFromWorld;
  28176. private _rayToWorld;
  28177. /**
  28178. * Gets if there was a hit
  28179. */
  28180. get hasHit(): boolean;
  28181. /**
  28182. * Gets the distance from the hit
  28183. */
  28184. get hitDistance(): number;
  28185. /**
  28186. * Gets the hit normal/direction in the world
  28187. */
  28188. get hitNormalWorld(): Vector3;
  28189. /**
  28190. * Gets the hit point in the world
  28191. */
  28192. get hitPointWorld(): Vector3;
  28193. /**
  28194. * Gets the ray "start point" of the ray in the world
  28195. */
  28196. get rayFromWorld(): Vector3;
  28197. /**
  28198. * Gets the ray "end point" of the ray in the world
  28199. */
  28200. get rayToWorld(): Vector3;
  28201. /**
  28202. * Sets the hit data (normal & point in world space)
  28203. * @param hitNormalWorld defines the normal in world space
  28204. * @param hitPointWorld defines the point in world space
  28205. */
  28206. setHitData(hitNormalWorld: IXYZ, hitPointWorld: IXYZ): void;
  28207. /**
  28208. * Sets the distance from the start point to the hit point
  28209. * @param distance
  28210. */
  28211. setHitDistance(distance: number): void;
  28212. /**
  28213. * Calculates the distance manually
  28214. */
  28215. calculateHitDistance(): void;
  28216. /**
  28217. * Resets all the values to default
  28218. * @param from The from point on world space
  28219. * @param to The to point on world space
  28220. */
  28221. reset(from?: Vector3, to?: Vector3): void;
  28222. }
  28223. /**
  28224. * Interface for the size containing width and height
  28225. */
  28226. interface IXYZ {
  28227. /**
  28228. * X
  28229. */
  28230. x: number;
  28231. /**
  28232. * Y
  28233. */
  28234. y: number;
  28235. /**
  28236. * Z
  28237. */
  28238. z: number;
  28239. }
  28240. }
  28241. declare module "babylonjs/Physics/IPhysicsEngine" {
  28242. import { Nullable } from "babylonjs/types";
  28243. import { Vector3, Quaternion } from "babylonjs/Maths/math.vector";
  28244. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  28245. import { PhysicsImpostor, IPhysicsEnabledObject } from "babylonjs/Physics/physicsImpostor";
  28246. import { PhysicsJoint, IMotorEnabledJoint } from "babylonjs/Physics/physicsJoint";
  28247. import { PhysicsRaycastResult } from "babylonjs/Physics/physicsRaycastResult";
  28248. /**
  28249. * Interface used to describe a physics joint
  28250. */
  28251. export interface PhysicsImpostorJoint {
  28252. /** Defines the main impostor to which the joint is linked */
  28253. mainImpostor: PhysicsImpostor;
  28254. /** Defines the impostor that is connected to the main impostor using this joint */
  28255. connectedImpostor: PhysicsImpostor;
  28256. /** Defines the joint itself */
  28257. joint: PhysicsJoint;
  28258. }
  28259. /** @hidden */
  28260. export interface IPhysicsEnginePlugin {
  28261. world: any;
  28262. name: string;
  28263. setGravity(gravity: Vector3): void;
  28264. setTimeStep(timeStep: number): void;
  28265. getTimeStep(): number;
  28266. executeStep(delta: number, impostors: Array<PhysicsImpostor>): void;
  28267. applyImpulse(impostor: PhysicsImpostor, force: Vector3, contactPoint: Vector3): void;
  28268. applyForce(impostor: PhysicsImpostor, force: Vector3, contactPoint: Vector3): void;
  28269. generatePhysicsBody(impostor: PhysicsImpostor): void;
  28270. removePhysicsBody(impostor: PhysicsImpostor): void;
  28271. generateJoint(joint: PhysicsImpostorJoint): void;
  28272. removeJoint(joint: PhysicsImpostorJoint): void;
  28273. isSupported(): boolean;
  28274. setTransformationFromPhysicsBody(impostor: PhysicsImpostor): void;
  28275. setPhysicsBodyTransformation(impostor: PhysicsImpostor, newPosition: Vector3, newRotation: Quaternion): void;
  28276. setLinearVelocity(impostor: PhysicsImpostor, velocity: Nullable<Vector3>): void;
  28277. setAngularVelocity(impostor: PhysicsImpostor, velocity: Nullable<Vector3>): void;
  28278. getLinearVelocity(impostor: PhysicsImpostor): Nullable<Vector3>;
  28279. getAngularVelocity(impostor: PhysicsImpostor): Nullable<Vector3>;
  28280. setBodyMass(impostor: PhysicsImpostor, mass: number): void;
  28281. getBodyMass(impostor: PhysicsImpostor): number;
  28282. getBodyFriction(impostor: PhysicsImpostor): number;
  28283. setBodyFriction(impostor: PhysicsImpostor, friction: number): void;
  28284. getBodyRestitution(impostor: PhysicsImpostor): number;
  28285. setBodyRestitution(impostor: PhysicsImpostor, restitution: number): void;
  28286. getBodyPressure?(impostor: PhysicsImpostor): number;
  28287. setBodyPressure?(impostor: PhysicsImpostor, pressure: number): void;
  28288. getBodyStiffness?(impostor: PhysicsImpostor): number;
  28289. setBodyStiffness?(impostor: PhysicsImpostor, stiffness: number): void;
  28290. getBodyVelocityIterations?(impostor: PhysicsImpostor): number;
  28291. setBodyVelocityIterations?(impostor: PhysicsImpostor, velocityIterations: number): void;
  28292. getBodyPositionIterations?(impostor: PhysicsImpostor): number;
  28293. setBodyPositionIterations?(impostor: PhysicsImpostor, positionIterations: number): void;
  28294. appendAnchor?(impostor: PhysicsImpostor, otherImpostor: PhysicsImpostor, width: number, height: number, influence: number, noCollisionBetweenLinkedBodies: boolean): void;
  28295. appendHook?(impostor: PhysicsImpostor, otherImpostor: PhysicsImpostor, length: number, influence: number, noCollisionBetweenLinkedBodies: boolean): void;
  28296. sleepBody(impostor: PhysicsImpostor): void;
  28297. wakeUpBody(impostor: PhysicsImpostor): void;
  28298. raycast(from: Vector3, to: Vector3): PhysicsRaycastResult;
  28299. updateDistanceJoint(joint: PhysicsJoint, maxDistance: number, minDistance?: number): void;
  28300. setMotor(joint: IMotorEnabledJoint, speed: number, maxForce?: number, motorIndex?: number): void;
  28301. setLimit(joint: IMotorEnabledJoint, upperLimit: number, lowerLimit?: number, motorIndex?: number): void;
  28302. getRadius(impostor: PhysicsImpostor): number;
  28303. getBoxSizeToRef(impostor: PhysicsImpostor, result: Vector3): void;
  28304. syncMeshWithImpostor(mesh: AbstractMesh, impostor: PhysicsImpostor): void;
  28305. dispose(): void;
  28306. }
  28307. /**
  28308. * Interface used to define a physics engine
  28309. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  28310. */
  28311. export interface IPhysicsEngine {
  28312. /**
  28313. * Gets the gravity vector used by the simulation
  28314. */
  28315. gravity: Vector3;
  28316. /**
  28317. * Sets the gravity vector used by the simulation
  28318. * @param gravity defines the gravity vector to use
  28319. */
  28320. setGravity(gravity: Vector3): void;
  28321. /**
  28322. * Set the time step of the physics engine.
  28323. * Default is 1/60.
  28324. * To slow it down, enter 1/600 for example.
  28325. * To speed it up, 1/30
  28326. * @param newTimeStep the new timestep to apply to this world.
  28327. */
  28328. setTimeStep(newTimeStep: number): void;
  28329. /**
  28330. * Get the time step of the physics engine.
  28331. * @returns the current time step
  28332. */
  28333. getTimeStep(): number;
  28334. /**
  28335. * Set the sub time step of the physics engine.
  28336. * Default is 0 meaning there is no sub steps
  28337. * To increase physics resolution precision, set a small value (like 1 ms)
  28338. * @param subTimeStep defines the new sub timestep used for physics resolution.
  28339. */
  28340. setSubTimeStep(subTimeStep: number): void;
  28341. /**
  28342. * Get the sub time step of the physics engine.
  28343. * @returns the current sub time step
  28344. */
  28345. getSubTimeStep(): number;
  28346. /**
  28347. * Release all resources
  28348. */
  28349. dispose(): void;
  28350. /**
  28351. * Gets the name of the current physics plugin
  28352. * @returns the name of the plugin
  28353. */
  28354. getPhysicsPluginName(): string;
  28355. /**
  28356. * Adding a new impostor for the impostor tracking.
  28357. * This will be done by the impostor itself.
  28358. * @param impostor the impostor to add
  28359. */
  28360. addImpostor(impostor: PhysicsImpostor): void;
  28361. /**
  28362. * Remove an impostor from the engine.
  28363. * This impostor and its mesh will not longer be updated by the physics engine.
  28364. * @param impostor the impostor to remove
  28365. */
  28366. removeImpostor(impostor: PhysicsImpostor): void;
  28367. /**
  28368. * Add a joint to the physics engine
  28369. * @param mainImpostor defines the main impostor to which the joint is added.
  28370. * @param connectedImpostor defines the impostor that is connected to the main impostor using this joint
  28371. * @param joint defines the joint that will connect both impostors.
  28372. */
  28373. addJoint(mainImpostor: PhysicsImpostor, connectedImpostor: PhysicsImpostor, joint: PhysicsJoint): void;
  28374. /**
  28375. * Removes a joint from the simulation
  28376. * @param mainImpostor defines the impostor used with the joint
  28377. * @param connectedImpostor defines the other impostor connected to the main one by the joint
  28378. * @param joint defines the joint to remove
  28379. */
  28380. removeJoint(mainImpostor: PhysicsImpostor, connectedImpostor: PhysicsImpostor, joint: PhysicsJoint): void;
  28381. /**
  28382. * Gets the current plugin used to run the simulation
  28383. * @returns current plugin
  28384. */
  28385. getPhysicsPlugin(): IPhysicsEnginePlugin;
  28386. /**
  28387. * Gets the list of physic impostors
  28388. * @returns an array of PhysicsImpostor
  28389. */
  28390. getImpostors(): Array<PhysicsImpostor>;
  28391. /**
  28392. * Gets the impostor for a physics enabled object
  28393. * @param object defines the object impersonated by the impostor
  28394. * @returns the PhysicsImpostor or null if not found
  28395. */
  28396. getImpostorForPhysicsObject(object: IPhysicsEnabledObject): Nullable<PhysicsImpostor>;
  28397. /**
  28398. * Gets the impostor for a physics body object
  28399. * @param body defines physics body used by the impostor
  28400. * @returns the PhysicsImpostor or null if not found
  28401. */
  28402. getImpostorWithPhysicsBody(body: any): Nullable<PhysicsImpostor>;
  28403. /**
  28404. * Does a raycast in the physics world
  28405. * @param from when should the ray start?
  28406. * @param to when should the ray end?
  28407. * @returns PhysicsRaycastResult
  28408. */
  28409. raycast(from: Vector3, to: Vector3): PhysicsRaycastResult;
  28410. /**
  28411. * Called by the scene. No need to call it.
  28412. * @param delta defines the timespam between frames
  28413. */
  28414. _step(delta: number): void;
  28415. }
  28416. }
  28417. declare module "babylonjs/Physics/physicsImpostor" {
  28418. import { Nullable, IndicesArray } from "babylonjs/types";
  28419. import { Vector3, Matrix, Quaternion } from "babylonjs/Maths/math.vector";
  28420. import { TransformNode } from "babylonjs/Meshes/transformNode";
  28421. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  28422. import { Scene } from "babylonjs/scene";
  28423. import { Bone } from "babylonjs/Bones/bone";
  28424. import { BoundingInfo } from "babylonjs/Culling/boundingInfo";
  28425. import { PhysicsJoint, PhysicsJointData } from "babylonjs/Physics/physicsJoint";
  28426. import { Space } from "babylonjs/Maths/math.axis";
  28427. /**
  28428. * The interface for the physics imposter parameters
  28429. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  28430. */
  28431. export interface PhysicsImpostorParameters {
  28432. /**
  28433. * The mass of the physics imposter
  28434. */
  28435. mass: number;
  28436. /**
  28437. * The friction of the physics imposter
  28438. */
  28439. friction?: number;
  28440. /**
  28441. * The coefficient of restitution of the physics imposter
  28442. */
  28443. restitution?: number;
  28444. /**
  28445. * The native options of the physics imposter
  28446. */
  28447. nativeOptions?: any;
  28448. /**
  28449. * Specifies if the parent should be ignored
  28450. */
  28451. ignoreParent?: boolean;
  28452. /**
  28453. * Specifies if bi-directional transformations should be disabled
  28454. */
  28455. disableBidirectionalTransformation?: boolean;
  28456. /**
  28457. * The pressure inside the physics imposter, soft object only
  28458. */
  28459. pressure?: number;
  28460. /**
  28461. * The stiffness the physics imposter, soft object only
  28462. */
  28463. stiffness?: number;
  28464. /**
  28465. * The number of iterations used in maintaining consistent vertex velocities, soft object only
  28466. */
  28467. velocityIterations?: number;
  28468. /**
  28469. * The number of iterations used in maintaining consistent vertex positions, soft object only
  28470. */
  28471. positionIterations?: number;
  28472. /**
  28473. * The number used to fix points on a cloth (0, 1, 2, 4, 8) or rope (0, 1, 2) only
  28474. * 0 None, 1, back left or top, 2, back right or bottom, 4, front left, 8, front right
  28475. * Add to fix multiple points
  28476. */
  28477. fixedPoints?: number;
  28478. /**
  28479. * The collision margin around a soft object
  28480. */
  28481. margin?: number;
  28482. /**
  28483. * The collision margin around a soft object
  28484. */
  28485. damping?: number;
  28486. /**
  28487. * The path for a rope based on an extrusion
  28488. */
  28489. path?: any;
  28490. /**
  28491. * The shape of an extrusion used for a rope based on an extrusion
  28492. */
  28493. shape?: any;
  28494. }
  28495. /**
  28496. * Interface for a physics-enabled object
  28497. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  28498. */
  28499. export interface IPhysicsEnabledObject {
  28500. /**
  28501. * The position of the physics-enabled object
  28502. */
  28503. position: Vector3;
  28504. /**
  28505. * The rotation of the physics-enabled object
  28506. */
  28507. rotationQuaternion: Nullable<Quaternion>;
  28508. /**
  28509. * The scale of the physics-enabled object
  28510. */
  28511. scaling: Vector3;
  28512. /**
  28513. * The rotation of the physics-enabled object
  28514. */
  28515. rotation?: Vector3;
  28516. /**
  28517. * The parent of the physics-enabled object
  28518. */
  28519. parent?: any;
  28520. /**
  28521. * The bounding info of the physics-enabled object
  28522. * @returns The bounding info of the physics-enabled object
  28523. */
  28524. getBoundingInfo(): BoundingInfo;
  28525. /**
  28526. * Computes the world matrix
  28527. * @param force Specifies if the world matrix should be computed by force
  28528. * @returns A world matrix
  28529. */
  28530. computeWorldMatrix(force: boolean): Matrix;
  28531. /**
  28532. * Gets the world matrix
  28533. * @returns A world matrix
  28534. */
  28535. getWorldMatrix?(): Matrix;
  28536. /**
  28537. * Gets the child meshes
  28538. * @param directDescendantsOnly Specifies if only direct-descendants should be obtained
  28539. * @returns An array of abstract meshes
  28540. */
  28541. getChildMeshes?(directDescendantsOnly?: boolean): Array<AbstractMesh>;
  28542. /**
  28543. * Gets the vertex data
  28544. * @param kind The type of vertex data
  28545. * @returns A nullable array of numbers, or a float32 array
  28546. */
  28547. getVerticesData(kind: string): Nullable<Array<number> | Float32Array>;
  28548. /**
  28549. * Gets the indices from the mesh
  28550. * @returns A nullable array of index arrays
  28551. */
  28552. getIndices?(): Nullable<IndicesArray>;
  28553. /**
  28554. * Gets the scene from the mesh
  28555. * @returns the indices array or null
  28556. */
  28557. getScene?(): Scene;
  28558. /**
  28559. * Gets the absolute position from the mesh
  28560. * @returns the absolute position
  28561. */
  28562. getAbsolutePosition(): Vector3;
  28563. /**
  28564. * Gets the absolute pivot point from the mesh
  28565. * @returns the absolute pivot point
  28566. */
  28567. getAbsolutePivotPoint(): Vector3;
  28568. /**
  28569. * Rotates the mesh
  28570. * @param axis The axis of rotation
  28571. * @param amount The amount of rotation
  28572. * @param space The space of the rotation
  28573. * @returns The rotation transform node
  28574. */
  28575. rotate(axis: Vector3, amount: number, space?: Space): TransformNode;
  28576. /**
  28577. * Translates the mesh
  28578. * @param axis The axis of translation
  28579. * @param distance The distance of translation
  28580. * @param space The space of the translation
  28581. * @returns The transform node
  28582. */
  28583. translate(axis: Vector3, distance: number, space?: Space): TransformNode;
  28584. /**
  28585. * Sets the absolute position of the mesh
  28586. * @param absolutePosition The absolute position of the mesh
  28587. * @returns The transform node
  28588. */
  28589. setAbsolutePosition(absolutePosition: Vector3): TransformNode;
  28590. /**
  28591. * Gets the class name of the mesh
  28592. * @returns The class name
  28593. */
  28594. getClassName(): string;
  28595. }
  28596. /**
  28597. * Represents a physics imposter
  28598. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  28599. */
  28600. export class PhysicsImpostor {
  28601. /**
  28602. * The physics-enabled object used as the physics imposter
  28603. */
  28604. object: IPhysicsEnabledObject;
  28605. /**
  28606. * The type of the physics imposter
  28607. */
  28608. type: number;
  28609. private _options;
  28610. private _scene?;
  28611. /**
  28612. * The default object size of the imposter
  28613. */
  28614. static DEFAULT_OBJECT_SIZE: Vector3;
  28615. /**
  28616. * The identity quaternion of the imposter
  28617. */
  28618. static IDENTITY_QUATERNION: Quaternion;
  28619. /** @hidden */
  28620. _pluginData: any;
  28621. private _physicsEngine;
  28622. private _physicsBody;
  28623. private _bodyUpdateRequired;
  28624. private _onBeforePhysicsStepCallbacks;
  28625. private _onAfterPhysicsStepCallbacks;
  28626. /** @hidden */
  28627. _onPhysicsCollideCallbacks: Array<{
  28628. callback: (collider: PhysicsImpostor, collidedAgainst: PhysicsImpostor) => void;
  28629. otherImpostors: Array<PhysicsImpostor>;
  28630. }>;
  28631. private _deltaPosition;
  28632. private _deltaRotation;
  28633. private _deltaRotationConjugated;
  28634. /** @hidden */
  28635. _isFromLine: boolean;
  28636. private _parent;
  28637. private _isDisposed;
  28638. private static _tmpVecs;
  28639. private static _tmpQuat;
  28640. /**
  28641. * Specifies if the physics imposter is disposed
  28642. */
  28643. get isDisposed(): boolean;
  28644. /**
  28645. * Gets the mass of the physics imposter
  28646. */
  28647. get mass(): number;
  28648. set mass(value: number);
  28649. /**
  28650. * Gets the coefficient of friction
  28651. */
  28652. get friction(): number;
  28653. /**
  28654. * Sets the coefficient of friction
  28655. */
  28656. set friction(value: number);
  28657. /**
  28658. * Gets the coefficient of restitution
  28659. */
  28660. get restitution(): number;
  28661. /**
  28662. * Sets the coefficient of restitution
  28663. */
  28664. set restitution(value: number);
  28665. /**
  28666. * Gets the pressure of a soft body; only supported by the AmmoJSPlugin
  28667. */
  28668. get pressure(): number;
  28669. /**
  28670. * Sets the pressure of a soft body; only supported by the AmmoJSPlugin
  28671. */
  28672. set pressure(value: number);
  28673. /**
  28674. * Gets the stiffness of a soft body; only supported by the AmmoJSPlugin
  28675. */
  28676. get stiffness(): number;
  28677. /**
  28678. * Sets the stiffness of a soft body; only supported by the AmmoJSPlugin
  28679. */
  28680. set stiffness(value: number);
  28681. /**
  28682. * Gets the velocityIterations of a soft body; only supported by the AmmoJSPlugin
  28683. */
  28684. get velocityIterations(): number;
  28685. /**
  28686. * Sets the velocityIterations of a soft body; only supported by the AmmoJSPlugin
  28687. */
  28688. set velocityIterations(value: number);
  28689. /**
  28690. * Gets the positionIterations of a soft body; only supported by the AmmoJSPlugin
  28691. */
  28692. get positionIterations(): number;
  28693. /**
  28694. * Sets the positionIterations of a soft body; only supported by the AmmoJSPlugin
  28695. */
  28696. set positionIterations(value: number);
  28697. /**
  28698. * The unique id of the physics imposter
  28699. * set by the physics engine when adding this impostor to the array
  28700. */
  28701. uniqueId: number;
  28702. /**
  28703. * @hidden
  28704. */
  28705. soft: boolean;
  28706. /**
  28707. * @hidden
  28708. */
  28709. segments: number;
  28710. private _joints;
  28711. /**
  28712. * Initializes the physics imposter
  28713. * @param object The physics-enabled object used as the physics imposter
  28714. * @param type The type of the physics imposter
  28715. * @param _options The options for the physics imposter
  28716. * @param _scene The Babylon scene
  28717. */
  28718. constructor(
  28719. /**
  28720. * The physics-enabled object used as the physics imposter
  28721. */
  28722. object: IPhysicsEnabledObject,
  28723. /**
  28724. * The type of the physics imposter
  28725. */
  28726. type: number, _options?: PhysicsImpostorParameters, _scene?: Scene | undefined);
  28727. /**
  28728. * This function will completly initialize this impostor.
  28729. * It will create a new body - but only if this mesh has no parent.
  28730. * If it has, this impostor will not be used other than to define the impostor
  28731. * of the child mesh.
  28732. * @hidden
  28733. */
  28734. _init(): void;
  28735. private _getPhysicsParent;
  28736. /**
  28737. * Should a new body be generated.
  28738. * @returns boolean specifying if body initialization is required
  28739. */
  28740. isBodyInitRequired(): boolean;
  28741. /**
  28742. * Sets the updated scaling
  28743. * @param updated Specifies if the scaling is updated
  28744. */
  28745. setScalingUpdated(): void;
  28746. /**
  28747. * Force a regeneration of this or the parent's impostor's body.
  28748. * Use under cautious - This will remove all joints already implemented.
  28749. */
  28750. forceUpdate(): void;
  28751. /**
  28752. * Gets the body that holds this impostor. Either its own, or its parent.
  28753. */
  28754. get physicsBody(): any;
  28755. /**
  28756. * Get the parent of the physics imposter
  28757. * @returns Physics imposter or null
  28758. */
  28759. get parent(): Nullable<PhysicsImpostor>;
  28760. /**
  28761. * Sets the parent of the physics imposter
  28762. */
  28763. set parent(value: Nullable<PhysicsImpostor>);
  28764. /**
  28765. * Set the physics body. Used mainly by the physics engine/plugin
  28766. */
  28767. set physicsBody(physicsBody: any);
  28768. /**
  28769. * Resets the update flags
  28770. */
  28771. resetUpdateFlags(): void;
  28772. /**
  28773. * Gets the object extend size
  28774. * @returns the object extend size
  28775. */
  28776. getObjectExtendSize(): Vector3;
  28777. /**
  28778. * Gets the object center
  28779. * @returns The object center
  28780. */
  28781. getObjectCenter(): Vector3;
  28782. /**
  28783. * Get a specific parameter from the options parameters
  28784. * @param paramName The object parameter name
  28785. * @returns The object parameter
  28786. */
  28787. getParam(paramName: string): any;
  28788. /**
  28789. * Sets a specific parameter in the options given to the physics plugin
  28790. * @param paramName The parameter name
  28791. * @param value The value of the parameter
  28792. */
  28793. setParam(paramName: string, value: number): void;
  28794. /**
  28795. * Specifically change the body's mass option. Won't recreate the physics body object
  28796. * @param mass The mass of the physics imposter
  28797. */
  28798. setMass(mass: number): void;
  28799. /**
  28800. * Gets the linear velocity
  28801. * @returns linear velocity or null
  28802. */
  28803. getLinearVelocity(): Nullable<Vector3>;
  28804. /**
  28805. * Sets the linear velocity
  28806. * @param velocity linear velocity or null
  28807. */
  28808. setLinearVelocity(velocity: Nullable<Vector3>): void;
  28809. /**
  28810. * Gets the angular velocity
  28811. * @returns angular velocity or null
  28812. */
  28813. getAngularVelocity(): Nullable<Vector3>;
  28814. /**
  28815. * Sets the angular velocity
  28816. * @param velocity The velocity or null
  28817. */
  28818. setAngularVelocity(velocity: Nullable<Vector3>): void;
  28819. /**
  28820. * Execute a function with the physics plugin native code
  28821. * Provide a function the will have two variables - the world object and the physics body object
  28822. * @param func The function to execute with the physics plugin native code
  28823. */
  28824. executeNativeFunction(func: (world: any, physicsBody: any) => void): void;
  28825. /**
  28826. * Register a function that will be executed before the physics world is stepping forward
  28827. * @param func The function to execute before the physics world is stepped forward
  28828. */
  28829. registerBeforePhysicsStep(func: (impostor: PhysicsImpostor) => void): void;
  28830. /**
  28831. * Unregister a function that will be executed before the physics world is stepping forward
  28832. * @param func The function to execute before the physics world is stepped forward
  28833. */
  28834. unregisterBeforePhysicsStep(func: (impostor: PhysicsImpostor) => void): void;
  28835. /**
  28836. * Register a function that will be executed after the physics step
  28837. * @param func The function to execute after physics step
  28838. */
  28839. registerAfterPhysicsStep(func: (impostor: PhysicsImpostor) => void): void;
  28840. /**
  28841. * Unregisters a function that will be executed after the physics step
  28842. * @param func The function to execute after physics step
  28843. */
  28844. unregisterAfterPhysicsStep(func: (impostor: PhysicsImpostor) => void): void;
  28845. /**
  28846. * register a function that will be executed when this impostor collides against a different body
  28847. * @param collideAgainst Physics imposter, or array of physics imposters to collide against
  28848. * @param func Callback that is executed on collision
  28849. */
  28850. registerOnPhysicsCollide(collideAgainst: PhysicsImpostor | Array<PhysicsImpostor>, func: (collider: PhysicsImpostor, collidedAgainst: PhysicsImpostor) => void): void;
  28851. /**
  28852. * Unregisters the physics imposter on contact
  28853. * @param collideAgainst The physics object to collide against
  28854. * @param func Callback to execute on collision
  28855. */
  28856. unregisterOnPhysicsCollide(collideAgainst: PhysicsImpostor | Array<PhysicsImpostor>, func: (collider: PhysicsImpostor, collidedAgainst: PhysicsImpostor | Array<PhysicsImpostor>) => void): void;
  28857. private _tmpQuat;
  28858. private _tmpQuat2;
  28859. /**
  28860. * Get the parent rotation
  28861. * @returns The parent rotation
  28862. */
  28863. getParentsRotation(): Quaternion;
  28864. /**
  28865. * this function is executed by the physics engine.
  28866. */
  28867. beforeStep: () => void;
  28868. /**
  28869. * this function is executed by the physics engine
  28870. */
  28871. afterStep: () => void;
  28872. /**
  28873. * Legacy collision detection event support
  28874. */
  28875. onCollideEvent: Nullable<(collider: PhysicsImpostor, collidedWith: PhysicsImpostor) => void>;
  28876. /**
  28877. * event and body object due to cannon's event-based architecture.
  28878. */
  28879. onCollide: (e: {
  28880. body: any;
  28881. }) => void;
  28882. /**
  28883. * Apply a force
  28884. * @param force The force to apply
  28885. * @param contactPoint The contact point for the force
  28886. * @returns The physics imposter
  28887. */
  28888. applyForce(force: Vector3, contactPoint: Vector3): PhysicsImpostor;
  28889. /**
  28890. * Apply an impulse
  28891. * @param force The impulse force
  28892. * @param contactPoint The contact point for the impulse force
  28893. * @returns The physics imposter
  28894. */
  28895. applyImpulse(force: Vector3, contactPoint: Vector3): PhysicsImpostor;
  28896. /**
  28897. * A help function to create a joint
  28898. * @param otherImpostor A physics imposter used to create a joint
  28899. * @param jointType The type of joint
  28900. * @param jointData The data for the joint
  28901. * @returns The physics imposter
  28902. */
  28903. createJoint(otherImpostor: PhysicsImpostor, jointType: number, jointData: PhysicsJointData): PhysicsImpostor;
  28904. /**
  28905. * Add a joint to this impostor with a different impostor
  28906. * @param otherImpostor A physics imposter used to add a joint
  28907. * @param joint The joint to add
  28908. * @returns The physics imposter
  28909. */
  28910. addJoint(otherImpostor: PhysicsImpostor, joint: PhysicsJoint): PhysicsImpostor;
  28911. /**
  28912. * Add an anchor to a cloth impostor
  28913. * @param otherImpostor rigid impostor to anchor to
  28914. * @param width ratio across width from 0 to 1
  28915. * @param height ratio up height from 0 to 1
  28916. * @param influence the elasticity between cloth impostor and anchor from 0, very stretchy to 1, little strech
  28917. * @param noCollisionBetweenLinkedBodies when true collisions between cloth impostor and anchor are ignored; default false
  28918. * @returns impostor the soft imposter
  28919. */
  28920. addAnchor(otherImpostor: PhysicsImpostor, width: number, height: number, influence: number, noCollisionBetweenLinkedBodies: boolean): PhysicsImpostor;
  28921. /**
  28922. * Add a hook to a rope impostor
  28923. * @param otherImpostor rigid impostor to anchor to
  28924. * @param length ratio across rope from 0 to 1
  28925. * @param influence the elasticity between rope impostor and anchor from 0, very stretchy to 1, little strech
  28926. * @param noCollisionBetweenLinkedBodies when true collisions between soft impostor and anchor are ignored; default false
  28927. * @returns impostor the rope imposter
  28928. */
  28929. addHook(otherImpostor: PhysicsImpostor, length: number, influence: number, noCollisionBetweenLinkedBodies: boolean): PhysicsImpostor;
  28930. /**
  28931. * Will keep this body still, in a sleep mode.
  28932. * @returns the physics imposter
  28933. */
  28934. sleep(): PhysicsImpostor;
  28935. /**
  28936. * Wake the body up.
  28937. * @returns The physics imposter
  28938. */
  28939. wakeUp(): PhysicsImpostor;
  28940. /**
  28941. * Clones the physics imposter
  28942. * @param newObject The physics imposter clones to this physics-enabled object
  28943. * @returns A nullable physics imposter
  28944. */
  28945. clone(newObject: IPhysicsEnabledObject): Nullable<PhysicsImpostor>;
  28946. /**
  28947. * Disposes the physics imposter
  28948. */
  28949. dispose(): void;
  28950. /**
  28951. * Sets the delta position
  28952. * @param position The delta position amount
  28953. */
  28954. setDeltaPosition(position: Vector3): void;
  28955. /**
  28956. * Sets the delta rotation
  28957. * @param rotation The delta rotation amount
  28958. */
  28959. setDeltaRotation(rotation: Quaternion): void;
  28960. /**
  28961. * Gets the box size of the physics imposter and stores the result in the input parameter
  28962. * @param result Stores the box size
  28963. * @returns The physics imposter
  28964. */
  28965. getBoxSizeToRef(result: Vector3): PhysicsImpostor;
  28966. /**
  28967. * Gets the radius of the physics imposter
  28968. * @returns Radius of the physics imposter
  28969. */
  28970. getRadius(): number;
  28971. /**
  28972. * Sync a bone with this impostor
  28973. * @param bone The bone to sync to the impostor.
  28974. * @param boneMesh The mesh that the bone is influencing.
  28975. * @param jointPivot The pivot of the joint / bone in local space.
  28976. * @param distToJoint Optional distance from the impostor to the joint.
  28977. * @param adjustRotation Optional quaternion for adjusting the local rotation of the bone.
  28978. */
  28979. syncBoneWithImpostor(bone: Bone, boneMesh: AbstractMesh, jointPivot: Vector3, distToJoint?: number, adjustRotation?: Quaternion): void;
  28980. /**
  28981. * Sync impostor to a bone
  28982. * @param bone The bone that the impostor will be synced to.
  28983. * @param boneMesh The mesh that the bone is influencing.
  28984. * @param jointPivot The pivot of the joint / bone in local space.
  28985. * @param distToJoint Optional distance from the impostor to the joint.
  28986. * @param adjustRotation Optional quaternion for adjusting the local rotation of the bone.
  28987. * @param boneAxis Optional vector3 axis the bone is aligned with
  28988. */
  28989. syncImpostorWithBone(bone: Bone, boneMesh: AbstractMesh, jointPivot: Vector3, distToJoint?: number, adjustRotation?: Quaternion, boneAxis?: Vector3): void;
  28990. /**
  28991. * No-Imposter type
  28992. */
  28993. static NoImpostor: number;
  28994. /**
  28995. * Sphere-Imposter type
  28996. */
  28997. static SphereImpostor: number;
  28998. /**
  28999. * Box-Imposter type
  29000. */
  29001. static BoxImpostor: number;
  29002. /**
  29003. * Plane-Imposter type
  29004. */
  29005. static PlaneImpostor: number;
  29006. /**
  29007. * Mesh-imposter type
  29008. */
  29009. static MeshImpostor: number;
  29010. /**
  29011. * Capsule-Impostor type (Ammo.js plugin only)
  29012. */
  29013. static CapsuleImpostor: number;
  29014. /**
  29015. * Cylinder-Imposter type
  29016. */
  29017. static CylinderImpostor: number;
  29018. /**
  29019. * Particle-Imposter type
  29020. */
  29021. static ParticleImpostor: number;
  29022. /**
  29023. * Heightmap-Imposter type
  29024. */
  29025. static HeightmapImpostor: number;
  29026. /**
  29027. * ConvexHull-Impostor type (Ammo.js plugin only)
  29028. */
  29029. static ConvexHullImpostor: number;
  29030. /**
  29031. * Custom-Imposter type (Ammo.js plugin only)
  29032. */
  29033. static CustomImpostor: number;
  29034. /**
  29035. * Rope-Imposter type
  29036. */
  29037. static RopeImpostor: number;
  29038. /**
  29039. * Cloth-Imposter type
  29040. */
  29041. static ClothImpostor: number;
  29042. /**
  29043. * Softbody-Imposter type
  29044. */
  29045. static SoftbodyImpostor: number;
  29046. }
  29047. }
  29048. declare module "babylonjs/Meshes/mesh" {
  29049. import { Observable } from "babylonjs/Misc/observable";
  29050. import { IAnimatable } from "babylonjs/Animations/animatable.interface";
  29051. import { Nullable, FloatArray, IndicesArray } from "babylonjs/types";
  29052. import { Camera } from "babylonjs/Cameras/camera";
  29053. import { Scene } from "babylonjs/scene";
  29054. import { Matrix, Vector3, Vector2, Vector4 } from "babylonjs/Maths/math.vector";
  29055. import { Color4 } from "babylonjs/Maths/math.color";
  29056. import { Engine } from "babylonjs/Engines/engine";
  29057. import { Node } from "babylonjs/node";
  29058. import { VertexBuffer } from "babylonjs/Meshes/buffer";
  29059. import { IGetSetVerticesData } from "babylonjs/Meshes/mesh.vertexData";
  29060. import { Buffer } from "babylonjs/Meshes/buffer";
  29061. import { Geometry } from "babylonjs/Meshes/geometry";
  29062. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  29063. import { SubMesh } from "babylonjs/Meshes/subMesh";
  29064. import { BoundingSphere } from "babylonjs/Culling/boundingSphere";
  29065. import { Effect } from "babylonjs/Materials/effect";
  29066. import { Material } from "babylonjs/Materials/material";
  29067. import { Skeleton } from "babylonjs/Bones/skeleton";
  29068. import { MorphTargetManager } from "babylonjs/Morph/morphTargetManager";
  29069. import { MeshLODLevel } from "babylonjs/Meshes/meshLODLevel";
  29070. import { Path3D } from "babylonjs/Maths/math.path";
  29071. import { Plane } from "babylonjs/Maths/math.plane";
  29072. import { TransformNode } from "babylonjs/Meshes/transformNode";
  29073. import { LinesMesh } from "babylonjs/Meshes/linesMesh";
  29074. import { InstancedMesh } from "babylonjs/Meshes/instancedMesh";
  29075. import { GroundMesh } from "babylonjs/Meshes/groundMesh";
  29076. import { IPhysicsEnabledObject } from "babylonjs/Physics/physicsImpostor";
  29077. import { PhysicsImpostor } from "babylonjs/Physics/physicsImpostor";
  29078. /**
  29079. * @hidden
  29080. **/
  29081. export class _CreationDataStorage {
  29082. closePath?: boolean;
  29083. closeArray?: boolean;
  29084. idx: number[];
  29085. dashSize: number;
  29086. gapSize: number;
  29087. path3D: Path3D;
  29088. pathArray: Vector3[][];
  29089. arc: number;
  29090. radius: number;
  29091. cap: number;
  29092. tessellation: number;
  29093. }
  29094. /**
  29095. * @hidden
  29096. **/
  29097. class _InstanceDataStorage {
  29098. visibleInstances: any;
  29099. batchCache: _InstancesBatch;
  29100. instancesBufferSize: number;
  29101. instancesBuffer: Nullable<Buffer>;
  29102. instancesData: Float32Array;
  29103. overridenInstanceCount: number;
  29104. isFrozen: boolean;
  29105. previousBatch: Nullable<_InstancesBatch>;
  29106. hardwareInstancedRendering: boolean;
  29107. sideOrientation: number;
  29108. manualUpdate: boolean;
  29109. }
  29110. /**
  29111. * @hidden
  29112. **/
  29113. export class _InstancesBatch {
  29114. mustReturn: boolean;
  29115. visibleInstances: Nullable<import("babylonjs/Meshes/instancedMesh").InstancedMesh[]>[];
  29116. renderSelf: boolean[];
  29117. hardwareInstancedRendering: boolean[];
  29118. }
  29119. /**
  29120. * @hidden
  29121. **/
  29122. class _ThinInstanceDataStorage {
  29123. instancesCount: number;
  29124. matrixBuffer: Nullable<Buffer>;
  29125. matrixBufferSize: number;
  29126. matrixData: Nullable<Float32Array>;
  29127. boundingVectors: Array<Vector3>;
  29128. worldMatrices: Nullable<Matrix[]>;
  29129. }
  29130. /**
  29131. * Class used to represent renderable models
  29132. */
  29133. export class Mesh extends AbstractMesh implements IGetSetVerticesData {
  29134. /**
  29135. * Mesh side orientation : usually the external or front surface
  29136. */
  29137. static readonly FRONTSIDE: number;
  29138. /**
  29139. * Mesh side orientation : usually the internal or back surface
  29140. */
  29141. static readonly BACKSIDE: number;
  29142. /**
  29143. * Mesh side orientation : both internal and external or front and back surfaces
  29144. */
  29145. static readonly DOUBLESIDE: number;
  29146. /**
  29147. * Mesh side orientation : by default, `FRONTSIDE`
  29148. */
  29149. static readonly DEFAULTSIDE: number;
  29150. /**
  29151. * Mesh cap setting : no cap
  29152. */
  29153. static readonly NO_CAP: number;
  29154. /**
  29155. * Mesh cap setting : one cap at the beginning of the mesh
  29156. */
  29157. static readonly CAP_START: number;
  29158. /**
  29159. * Mesh cap setting : one cap at the end of the mesh
  29160. */
  29161. static readonly CAP_END: number;
  29162. /**
  29163. * Mesh cap setting : two caps, one at the beginning and one at the end of the mesh
  29164. */
  29165. static readonly CAP_ALL: number;
  29166. /**
  29167. * Mesh pattern setting : no flip or rotate
  29168. */
  29169. static readonly NO_FLIP: number;
  29170. /**
  29171. * Mesh pattern setting : flip (reflect in y axis) alternate tiles on each row or column
  29172. */
  29173. static readonly FLIP_TILE: number;
  29174. /**
  29175. * Mesh pattern setting : rotate (180degs) alternate tiles on each row or column
  29176. */
  29177. static readonly ROTATE_TILE: number;
  29178. /**
  29179. * Mesh pattern setting : flip (reflect in y axis) all tiles on alternate rows
  29180. */
  29181. static readonly FLIP_ROW: number;
  29182. /**
  29183. * Mesh pattern setting : rotate (180degs) all tiles on alternate rows
  29184. */
  29185. static readonly ROTATE_ROW: number;
  29186. /**
  29187. * Mesh pattern setting : flip and rotate alternate tiles on each row or column
  29188. */
  29189. static readonly FLIP_N_ROTATE_TILE: number;
  29190. /**
  29191. * Mesh pattern setting : rotate pattern and rotate
  29192. */
  29193. static readonly FLIP_N_ROTATE_ROW: number;
  29194. /**
  29195. * Mesh tile positioning : part tiles same on left/right or top/bottom
  29196. */
  29197. static readonly CENTER: number;
  29198. /**
  29199. * Mesh tile positioning : part tiles on left
  29200. */
  29201. static readonly LEFT: number;
  29202. /**
  29203. * Mesh tile positioning : part tiles on right
  29204. */
  29205. static readonly RIGHT: number;
  29206. /**
  29207. * Mesh tile positioning : part tiles on top
  29208. */
  29209. static readonly TOP: number;
  29210. /**
  29211. * Mesh tile positioning : part tiles on bottom
  29212. */
  29213. static readonly BOTTOM: number;
  29214. /**
  29215. * Gets the default side orientation.
  29216. * @param orientation the orientation to value to attempt to get
  29217. * @returns the default orientation
  29218. * @hidden
  29219. */
  29220. static _GetDefaultSideOrientation(orientation?: number): number;
  29221. private _internalMeshDataInfo;
  29222. get computeBonesUsingShaders(): boolean;
  29223. set computeBonesUsingShaders(value: boolean);
  29224. /**
  29225. * An event triggered before rendering the mesh
  29226. */
  29227. get onBeforeRenderObservable(): Observable<Mesh>;
  29228. /**
  29229. * An event triggered before binding the mesh
  29230. */
  29231. get onBeforeBindObservable(): Observable<Mesh>;
  29232. /**
  29233. * An event triggered after rendering the mesh
  29234. */
  29235. get onAfterRenderObservable(): Observable<Mesh>;
  29236. /**
  29237. * An event triggered before drawing the mesh
  29238. */
  29239. get onBeforeDrawObservable(): Observable<Mesh>;
  29240. private _onBeforeDrawObserver;
  29241. /**
  29242. * Sets a callback to call before drawing the mesh. It is recommended to use onBeforeDrawObservable instead
  29243. */
  29244. set onBeforeDraw(callback: () => void);
  29245. get hasInstances(): boolean;
  29246. get hasThinInstances(): boolean;
  29247. /**
  29248. * Gets the delay loading state of the mesh (when delay loading is turned on)
  29249. * @see https://doc.babylonjs.com/how_to/using_the_incremental_loading_system
  29250. */
  29251. delayLoadState: number;
  29252. /**
  29253. * Gets the list of instances created from this mesh
  29254. * it is not supposed to be modified manually.
  29255. * Note also that the order of the InstancedMesh wihin the array is not significant and might change.
  29256. * @see https://doc.babylonjs.com/how_to/how_to_use_instances
  29257. */
  29258. instances: import("babylonjs/Meshes/instancedMesh").InstancedMesh[];
  29259. /**
  29260. * Gets the file containing delay loading data for this mesh
  29261. */
  29262. delayLoadingFile: string;
  29263. /** @hidden */
  29264. _binaryInfo: any;
  29265. /**
  29266. * User defined function used to change how LOD level selection is done
  29267. * @see https://doc.babylonjs.com/how_to/how_to_use_lod
  29268. */
  29269. onLODLevelSelection: (distance: number, mesh: Mesh, selectedLevel: Nullable<Mesh>) => void;
  29270. /**
  29271. * Gets or sets the morph target manager
  29272. * @see https://doc.babylonjs.com/how_to/how_to_use_morphtargets
  29273. */
  29274. get morphTargetManager(): Nullable<MorphTargetManager>;
  29275. set morphTargetManager(value: Nullable<MorphTargetManager>);
  29276. /** @hidden */
  29277. _creationDataStorage: Nullable<_CreationDataStorage>;
  29278. /** @hidden */
  29279. _geometry: Nullable<Geometry>;
  29280. /** @hidden */
  29281. _delayInfo: Array<string>;
  29282. /** @hidden */
  29283. _delayLoadingFunction: (any: any, mesh: Mesh) => void;
  29284. /** @hidden */
  29285. _instanceDataStorage: _InstanceDataStorage;
  29286. /** @hidden */
  29287. _thinInstanceDataStorage: _ThinInstanceDataStorage;
  29288. private _effectiveMaterial;
  29289. /** @hidden */
  29290. _shouldGenerateFlatShading: boolean;
  29291. /** @hidden */
  29292. _originalBuilderSideOrientation: number;
  29293. /**
  29294. * Use this property to change the original side orientation defined at construction time
  29295. */
  29296. overrideMaterialSideOrientation: Nullable<number>;
  29297. /**
  29298. * Gets the source mesh (the one used to clone this one from)
  29299. */
  29300. get source(): Nullable<Mesh>;
  29301. /**
  29302. * Gets or sets a boolean indicating that this mesh does not use index buffer
  29303. */
  29304. get isUnIndexed(): boolean;
  29305. set isUnIndexed(value: boolean);
  29306. /** Gets the array buffer used to store the instanced buffer used for instances' world matrices */
  29307. get worldMatrixInstancedBuffer(): Float32Array;
  29308. /** Gets or sets a boolean indicating that the update of the instance buffer of the world matrices is manual */
  29309. get manualUpdateOfWorldMatrixInstancedBuffer(): boolean;
  29310. set manualUpdateOfWorldMatrixInstancedBuffer(value: boolean);
  29311. /**
  29312. * @constructor
  29313. * @param name The value used by scene.getMeshByName() to do a lookup.
  29314. * @param scene The scene to add this mesh to.
  29315. * @param parent The parent of this mesh, if it has one
  29316. * @param source An optional Mesh from which geometry is shared, cloned.
  29317. * @param doNotCloneChildren When cloning, skip cloning child meshes of source, default False.
  29318. * When false, achieved by calling a clone(), also passing False.
  29319. * This will make creation of children, recursive.
  29320. * @param clonePhysicsImpostor When cloning, include cloning mesh physics impostor, default True.
  29321. */
  29322. constructor(name: string, scene?: Nullable<Scene>, parent?: Nullable<Node>, source?: Nullable<Mesh>, doNotCloneChildren?: boolean, clonePhysicsImpostor?: boolean);
  29323. instantiateHierarchy(newParent?: Nullable<TransformNode>, options?: {
  29324. doNotInstantiate: boolean;
  29325. }, onNewNodeCreated?: (source: TransformNode, clone: TransformNode) => void): Nullable<TransformNode>;
  29326. /**
  29327. * Gets the class name
  29328. * @returns the string "Mesh".
  29329. */
  29330. getClassName(): string;
  29331. /** @hidden */
  29332. get _isMesh(): boolean;
  29333. /**
  29334. * Returns a description of this mesh
  29335. * @param fullDetails define if full details about this mesh must be used
  29336. * @returns a descriptive string representing this mesh
  29337. */
  29338. toString(fullDetails?: boolean): string;
  29339. /** @hidden */
  29340. _unBindEffect(): void;
  29341. /**
  29342. * Gets a boolean indicating if this mesh has LOD
  29343. */
  29344. get hasLODLevels(): boolean;
  29345. /**
  29346. * Gets the list of MeshLODLevel associated with the current mesh
  29347. * @returns an array of MeshLODLevel
  29348. */
  29349. getLODLevels(): MeshLODLevel[];
  29350. private _sortLODLevels;
  29351. /**
  29352. * Add a mesh as LOD level triggered at the given distance.
  29353. * @see https://doc.babylonjs.com/how_to/how_to_use_lod
  29354. * @param distance The distance from the center of the object to show this level
  29355. * @param mesh The mesh to be added as LOD level (can be null)
  29356. * @return This mesh (for chaining)
  29357. */
  29358. addLODLevel(distance: number, mesh: Nullable<Mesh>): Mesh;
  29359. /**
  29360. * Returns the LOD level mesh at the passed distance or null if not found.
  29361. * @see https://doc.babylonjs.com/how_to/how_to_use_lod
  29362. * @param distance The distance from the center of the object to show this level
  29363. * @returns a Mesh or `null`
  29364. */
  29365. getLODLevelAtDistance(distance: number): Nullable<Mesh>;
  29366. /**
  29367. * Remove a mesh from the LOD array
  29368. * @see https://doc.babylonjs.com/how_to/how_to_use_lod
  29369. * @param mesh defines the mesh to be removed
  29370. * @return This mesh (for chaining)
  29371. */
  29372. removeLODLevel(mesh: Mesh): Mesh;
  29373. /**
  29374. * Returns the registered LOD mesh distant from the parameter `camera` position if any, else returns the current mesh.
  29375. * @see https://doc.babylonjs.com/how_to/how_to_use_lod
  29376. * @param camera defines the camera to use to compute distance
  29377. * @param boundingSphere defines a custom bounding sphere to use instead of the one from this mesh
  29378. * @return This mesh (for chaining)
  29379. */
  29380. getLOD(camera: Camera, boundingSphere?: BoundingSphere): Nullable<AbstractMesh>;
  29381. /**
  29382. * Gets the mesh internal Geometry object
  29383. */
  29384. get geometry(): Nullable<Geometry>;
  29385. /**
  29386. * Returns the total number of vertices within the mesh geometry or zero if the mesh has no geometry.
  29387. * @returns the total number of vertices
  29388. */
  29389. getTotalVertices(): number;
  29390. /**
  29391. * Returns the content of an associated vertex buffer
  29392. * @param kind defines which buffer to read from (positions, indices, normals, etc). Possible `kind` values :
  29393. * - VertexBuffer.PositionKind
  29394. * - VertexBuffer.UVKind
  29395. * - VertexBuffer.UV2Kind
  29396. * - VertexBuffer.UV3Kind
  29397. * - VertexBuffer.UV4Kind
  29398. * - VertexBuffer.UV5Kind
  29399. * - VertexBuffer.UV6Kind
  29400. * - VertexBuffer.ColorKind
  29401. * - VertexBuffer.MatricesIndicesKind
  29402. * - VertexBuffer.MatricesIndicesExtraKind
  29403. * - VertexBuffer.MatricesWeightsKind
  29404. * - VertexBuffer.MatricesWeightsExtraKind
  29405. * @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
  29406. * @param forceCopy defines a boolean forcing the copy of the buffer no matter what the value of copyWhenShared is
  29407. * @returns a FloatArray or null if the mesh has no geometry or no vertex buffer for this kind.
  29408. */
  29409. getVerticesData(kind: string, copyWhenShared?: boolean, forceCopy?: boolean): Nullable<FloatArray>;
  29410. /**
  29411. * Returns the mesh VertexBuffer object from the requested `kind`
  29412. * @param kind defines which buffer to read from (positions, indices, normals, etc). Possible `kind` values :
  29413. * - VertexBuffer.PositionKind
  29414. * - VertexBuffer.NormalKind
  29415. * - VertexBuffer.UVKind
  29416. * - VertexBuffer.UV2Kind
  29417. * - VertexBuffer.UV3Kind
  29418. * - VertexBuffer.UV4Kind
  29419. * - VertexBuffer.UV5Kind
  29420. * - VertexBuffer.UV6Kind
  29421. * - VertexBuffer.ColorKind
  29422. * - VertexBuffer.MatricesIndicesKind
  29423. * - VertexBuffer.MatricesIndicesExtraKind
  29424. * - VertexBuffer.MatricesWeightsKind
  29425. * - VertexBuffer.MatricesWeightsExtraKind
  29426. * @returns a FloatArray or null if the mesh has no vertex buffer for this kind.
  29427. */
  29428. getVertexBuffer(kind: string): Nullable<VertexBuffer>;
  29429. /**
  29430. * Tests if a specific vertex buffer is associated with this mesh
  29431. * @param kind defines which buffer to check (positions, indices, normals, etc). Possible `kind` values :
  29432. * - VertexBuffer.PositionKind
  29433. * - VertexBuffer.NormalKind
  29434. * - VertexBuffer.UVKind
  29435. * - VertexBuffer.UV2Kind
  29436. * - VertexBuffer.UV3Kind
  29437. * - VertexBuffer.UV4Kind
  29438. * - VertexBuffer.UV5Kind
  29439. * - VertexBuffer.UV6Kind
  29440. * - VertexBuffer.ColorKind
  29441. * - VertexBuffer.MatricesIndicesKind
  29442. * - VertexBuffer.MatricesIndicesExtraKind
  29443. * - VertexBuffer.MatricesWeightsKind
  29444. * - VertexBuffer.MatricesWeightsExtraKind
  29445. * @returns a boolean
  29446. */
  29447. isVerticesDataPresent(kind: string): boolean;
  29448. /**
  29449. * Returns a boolean defining if the vertex data for the requested `kind` is updatable.
  29450. * @param kind defines which buffer to check (positions, indices, normals, etc). Possible `kind` values :
  29451. * - VertexBuffer.PositionKind
  29452. * - VertexBuffer.UVKind
  29453. * - VertexBuffer.UV2Kind
  29454. * - VertexBuffer.UV3Kind
  29455. * - VertexBuffer.UV4Kind
  29456. * - VertexBuffer.UV5Kind
  29457. * - VertexBuffer.UV6Kind
  29458. * - VertexBuffer.ColorKind
  29459. * - VertexBuffer.MatricesIndicesKind
  29460. * - VertexBuffer.MatricesIndicesExtraKind
  29461. * - VertexBuffer.MatricesWeightsKind
  29462. * - VertexBuffer.MatricesWeightsExtraKind
  29463. * @returns a boolean
  29464. */
  29465. isVertexBufferUpdatable(kind: string): boolean;
  29466. /**
  29467. * Returns a string which contains the list of existing `kinds` of Vertex Data associated with this mesh.
  29468. * @param kind defines which buffer to read from (positions, indices, normals, etc). Possible `kind` values :
  29469. * - VertexBuffer.PositionKind
  29470. * - VertexBuffer.NormalKind
  29471. * - VertexBuffer.UVKind
  29472. * - VertexBuffer.UV2Kind
  29473. * - VertexBuffer.UV3Kind
  29474. * - VertexBuffer.UV4Kind
  29475. * - VertexBuffer.UV5Kind
  29476. * - VertexBuffer.UV6Kind
  29477. * - VertexBuffer.ColorKind
  29478. * - VertexBuffer.MatricesIndicesKind
  29479. * - VertexBuffer.MatricesIndicesExtraKind
  29480. * - VertexBuffer.MatricesWeightsKind
  29481. * - VertexBuffer.MatricesWeightsExtraKind
  29482. * @returns an array of strings
  29483. */
  29484. getVerticesDataKinds(): string[];
  29485. /**
  29486. * Returns a positive integer : the total number of indices in this mesh geometry.
  29487. * @returns the numner of indices or zero if the mesh has no geometry.
  29488. */
  29489. getTotalIndices(): number;
  29490. /**
  29491. * Returns an array of integers or a typed array (Int32Array, Uint32Array, Uint16Array) populated with the mesh indices.
  29492. * @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.
  29493. * @param forceCopy defines a boolean indicating that the returned array must be cloned upon returning it
  29494. * @returns the indices array or an empty array if the mesh has no geometry
  29495. */
  29496. getIndices(copyWhenShared?: boolean, forceCopy?: boolean): Nullable<IndicesArray>;
  29497. get isBlocked(): boolean;
  29498. /**
  29499. * Determine if the current mesh is ready to be rendered
  29500. * @param completeCheck defines if a complete check (including materials and lights) has to be done (false by default)
  29501. * @param forceInstanceSupport will check if the mesh will be ready when used with instances (false by default)
  29502. * @returns true if all associated assets are ready (material, textures, shaders)
  29503. */
  29504. isReady(completeCheck?: boolean, forceInstanceSupport?: boolean): boolean;
  29505. /**
  29506. * 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.
  29507. */
  29508. get areNormalsFrozen(): boolean;
  29509. /**
  29510. * 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.
  29511. * @returns the current mesh
  29512. */
  29513. freezeNormals(): Mesh;
  29514. /**
  29515. * 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
  29516. * @returns the current mesh
  29517. */
  29518. unfreezeNormals(): Mesh;
  29519. /**
  29520. * Sets a value overriding the instance count. Only applicable when custom instanced InterleavedVertexBuffer are used rather than InstancedMeshs
  29521. */
  29522. set overridenInstanceCount(count: number);
  29523. /** @hidden */
  29524. _preActivate(): Mesh;
  29525. /** @hidden */
  29526. _preActivateForIntermediateRendering(renderId: number): Mesh;
  29527. /** @hidden */
  29528. _registerInstanceForRenderId(instance: InstancedMesh, renderId: number): Mesh;
  29529. protected _afterComputeWorldMatrix(): void;
  29530. /** @hidden */
  29531. _postActivate(): void;
  29532. /**
  29533. * This method recomputes and sets a new BoundingInfo to the mesh unless it is locked.
  29534. * This means the mesh underlying bounding box and sphere are recomputed.
  29535. * @param applySkeleton defines whether to apply the skeleton before computing the bounding info
  29536. * @returns the current mesh
  29537. */
  29538. refreshBoundingInfo(applySkeleton?: boolean): Mesh;
  29539. /** @hidden */
  29540. _createGlobalSubMesh(force: boolean): Nullable<SubMesh>;
  29541. /**
  29542. * This function will subdivide the mesh into multiple submeshes
  29543. * @param count defines the expected number of submeshes
  29544. */
  29545. subdivide(count: number): void;
  29546. /**
  29547. * Copy a FloatArray into a specific associated vertex buffer
  29548. * @param kind defines which buffer to write to (positions, indices, normals, etc). Possible `kind` values :
  29549. * - VertexBuffer.PositionKind
  29550. * - VertexBuffer.UVKind
  29551. * - VertexBuffer.UV2Kind
  29552. * - VertexBuffer.UV3Kind
  29553. * - VertexBuffer.UV4Kind
  29554. * - VertexBuffer.UV5Kind
  29555. * - VertexBuffer.UV6Kind
  29556. * - VertexBuffer.ColorKind
  29557. * - VertexBuffer.MatricesIndicesKind
  29558. * - VertexBuffer.MatricesIndicesExtraKind
  29559. * - VertexBuffer.MatricesWeightsKind
  29560. * - VertexBuffer.MatricesWeightsExtraKind
  29561. * @param data defines the data source
  29562. * @param updatable defines if the updated vertex buffer must be flagged as updatable
  29563. * @param stride defines the data stride size (can be null)
  29564. * @returns the current mesh
  29565. */
  29566. setVerticesData(kind: string, data: FloatArray, updatable?: boolean, stride?: number): AbstractMesh;
  29567. /**
  29568. * Delete a vertex buffer associated with this mesh
  29569. * @param kind defines which buffer to delete (positions, indices, normals, etc). Possible `kind` values :
  29570. * - VertexBuffer.PositionKind
  29571. * - VertexBuffer.UVKind
  29572. * - VertexBuffer.UV2Kind
  29573. * - VertexBuffer.UV3Kind
  29574. * - VertexBuffer.UV4Kind
  29575. * - VertexBuffer.UV5Kind
  29576. * - VertexBuffer.UV6Kind
  29577. * - VertexBuffer.ColorKind
  29578. * - VertexBuffer.MatricesIndicesKind
  29579. * - VertexBuffer.MatricesIndicesExtraKind
  29580. * - VertexBuffer.MatricesWeightsKind
  29581. * - VertexBuffer.MatricesWeightsExtraKind
  29582. */
  29583. removeVerticesData(kind: string): void;
  29584. /**
  29585. * Flags an associated vertex buffer as updatable
  29586. * @param kind defines which buffer to use (positions, indices, normals, etc). Possible `kind` values :
  29587. * - VertexBuffer.PositionKind
  29588. * - VertexBuffer.UVKind
  29589. * - VertexBuffer.UV2Kind
  29590. * - VertexBuffer.UV3Kind
  29591. * - VertexBuffer.UV4Kind
  29592. * - VertexBuffer.UV5Kind
  29593. * - VertexBuffer.UV6Kind
  29594. * - VertexBuffer.ColorKind
  29595. * - VertexBuffer.MatricesIndicesKind
  29596. * - VertexBuffer.MatricesIndicesExtraKind
  29597. * - VertexBuffer.MatricesWeightsKind
  29598. * - VertexBuffer.MatricesWeightsExtraKind
  29599. * @param updatable defines if the updated vertex buffer must be flagged as updatable
  29600. */
  29601. markVerticesDataAsUpdatable(kind: string, updatable?: boolean): void;
  29602. /**
  29603. * Sets the mesh global Vertex Buffer
  29604. * @param buffer defines the buffer to use
  29605. * @returns the current mesh
  29606. */
  29607. setVerticesBuffer(buffer: VertexBuffer): Mesh;
  29608. /**
  29609. * Update a specific associated vertex buffer
  29610. * @param kind defines which buffer to write to (positions, indices, normals, etc). Possible `kind` values :
  29611. * - VertexBuffer.PositionKind
  29612. * - VertexBuffer.UVKind
  29613. * - VertexBuffer.UV2Kind
  29614. * - VertexBuffer.UV3Kind
  29615. * - VertexBuffer.UV4Kind
  29616. * - VertexBuffer.UV5Kind
  29617. * - VertexBuffer.UV6Kind
  29618. * - VertexBuffer.ColorKind
  29619. * - VertexBuffer.MatricesIndicesKind
  29620. * - VertexBuffer.MatricesIndicesExtraKind
  29621. * - VertexBuffer.MatricesWeightsKind
  29622. * - VertexBuffer.MatricesWeightsExtraKind
  29623. * @param data defines the data source
  29624. * @param updateExtends defines if extends info of the mesh must be updated (can be null). This is mostly useful for "position" kind
  29625. * @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)
  29626. * @returns the current mesh
  29627. */
  29628. updateVerticesData(kind: string, data: FloatArray, updateExtends?: boolean, makeItUnique?: boolean): AbstractMesh;
  29629. /**
  29630. * This method updates the vertex positions of an updatable mesh according to the `positionFunction` returned values.
  29631. * @see https://doc.babylonjs.com/how_to/how_to_dynamically_morph_a_mesh#other-shapes-updatemeshpositions
  29632. * @param positionFunction is a simple JS function what is passed the mesh `positions` array. It doesn't need to return anything
  29633. * @param computeNormals is a boolean (default true) to enable/disable the mesh normal recomputation after the vertex position update
  29634. * @returns the current mesh
  29635. */
  29636. updateMeshPositions(positionFunction: (data: FloatArray) => void, computeNormals?: boolean): Mesh;
  29637. /**
  29638. * Creates a un-shared specific occurence of the geometry for the mesh.
  29639. * @returns the current mesh
  29640. */
  29641. makeGeometryUnique(): Mesh;
  29642. /**
  29643. * Set the index buffer of this mesh
  29644. * @param indices defines the source data
  29645. * @param totalVertices defines the total number of vertices referenced by this index data (can be null)
  29646. * @param updatable defines if the updated index buffer must be flagged as updatable (default is false)
  29647. * @returns the current mesh
  29648. */
  29649. setIndices(indices: IndicesArray, totalVertices?: Nullable<number>, updatable?: boolean): AbstractMesh;
  29650. /**
  29651. * Update the current index buffer
  29652. * @param indices defines the source data
  29653. * @param offset defines the offset in the index buffer where to store the new data (can be null)
  29654. * @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)
  29655. * @returns the current mesh
  29656. */
  29657. updateIndices(indices: IndicesArray, offset?: number, gpuMemoryOnly?: boolean): AbstractMesh;
  29658. /**
  29659. * Invert the geometry to move from a right handed system to a left handed one.
  29660. * @returns the current mesh
  29661. */
  29662. toLeftHanded(): Mesh;
  29663. /** @hidden */
  29664. _bind(subMesh: SubMesh, effect: Effect, fillMode: number): Mesh;
  29665. /** @hidden */
  29666. _draw(subMesh: SubMesh, fillMode: number, instancesCount?: number): Mesh;
  29667. /**
  29668. * Registers for this mesh a javascript function called just before the rendering process
  29669. * @param func defines the function to call before rendering this mesh
  29670. * @returns the current mesh
  29671. */
  29672. registerBeforeRender(func: (mesh: AbstractMesh) => void): Mesh;
  29673. /**
  29674. * Disposes a previously registered javascript function called before the rendering
  29675. * @param func defines the function to remove
  29676. * @returns the current mesh
  29677. */
  29678. unregisterBeforeRender(func: (mesh: AbstractMesh) => void): Mesh;
  29679. /**
  29680. * Registers for this mesh a javascript function called just after the rendering is complete
  29681. * @param func defines the function to call after rendering this mesh
  29682. * @returns the current mesh
  29683. */
  29684. registerAfterRender(func: (mesh: AbstractMesh) => void): Mesh;
  29685. /**
  29686. * Disposes a previously registered javascript function called after the rendering.
  29687. * @param func defines the function to remove
  29688. * @returns the current mesh
  29689. */
  29690. unregisterAfterRender(func: (mesh: AbstractMesh) => void): Mesh;
  29691. /** @hidden */
  29692. _getInstancesRenderList(subMeshId: number, isReplacementMode?: boolean): _InstancesBatch;
  29693. /** @hidden */
  29694. _renderWithInstances(subMesh: SubMesh, fillMode: number, batch: _InstancesBatch, effect: Effect, engine: Engine): Mesh;
  29695. /** @hidden */
  29696. _renderWithThinInstances(subMesh: SubMesh, fillMode: number, effect: Effect, engine: Engine): void;
  29697. /** @hidden */
  29698. _processInstancedBuffers(visibleInstances: InstancedMesh[], renderSelf: boolean): void;
  29699. /** @hidden */
  29700. _processRendering(renderingMesh: AbstractMesh, subMesh: SubMesh, effect: Effect, fillMode: number, batch: _InstancesBatch, hardwareInstancedRendering: boolean, onBeforeDraw: (isInstance: boolean, world: Matrix, effectiveMaterial?: Material) => void, effectiveMaterial?: Material): Mesh;
  29701. /** @hidden */
  29702. _rebuild(): void;
  29703. /** @hidden */
  29704. _freeze(): void;
  29705. /** @hidden */
  29706. _unFreeze(): void;
  29707. /**
  29708. * 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
  29709. * @param subMesh defines the subMesh to render
  29710. * @param enableAlphaMode defines if alpha mode can be changed
  29711. * @param effectiveMeshReplacement defines an optional mesh used to provide info for the rendering
  29712. * @returns the current mesh
  29713. */
  29714. render(subMesh: SubMesh, enableAlphaMode: boolean, effectiveMeshReplacement?: AbstractMesh): Mesh;
  29715. private _onBeforeDraw;
  29716. /**
  29717. * Renormalize the mesh and patch it up if there are no weights
  29718. * Similar to normalization by adding the weights compute the reciprocal and multiply all elements, this wil ensure that everything adds to 1.
  29719. * However in the case of zero weights then we set just a single influence to 1.
  29720. * We check in the function for extra's present and if so we use the normalizeSkinWeightsWithExtras rather than the FourWeights version.
  29721. */
  29722. cleanMatrixWeights(): void;
  29723. private normalizeSkinFourWeights;
  29724. private normalizeSkinWeightsAndExtra;
  29725. /**
  29726. * ValidateSkinning is used to determine that a mesh has valid skinning data along with skin metrics, if missing weights,
  29727. * or not normalized it is returned as invalid mesh the string can be used for console logs, or on screen messages to let
  29728. * the user know there was an issue with importing the mesh
  29729. * @returns a validation object with skinned, valid and report string
  29730. */
  29731. validateSkinning(): {
  29732. skinned: boolean;
  29733. valid: boolean;
  29734. report: string;
  29735. };
  29736. /** @hidden */
  29737. _checkDelayState(): Mesh;
  29738. private _queueLoad;
  29739. /**
  29740. * Returns `true` if the mesh is within the frustum defined by the passed array of planes.
  29741. * A mesh is in the frustum if its bounding box intersects the frustum
  29742. * @param frustumPlanes defines the frustum to test
  29743. * @returns true if the mesh is in the frustum planes
  29744. */
  29745. isInFrustum(frustumPlanes: Plane[]): boolean;
  29746. /**
  29747. * Sets the mesh material by the material or multiMaterial `id` property
  29748. * @param id is a string identifying the material or the multiMaterial
  29749. * @returns the current mesh
  29750. */
  29751. setMaterialByID(id: string): Mesh;
  29752. /**
  29753. * Returns as a new array populated with the mesh material and/or skeleton, if any.
  29754. * @returns an array of IAnimatable
  29755. */
  29756. getAnimatables(): IAnimatable[];
  29757. /**
  29758. * Modifies the mesh geometry according to the passed transformation matrix.
  29759. * This method returns nothing but it really modifies the mesh even if it's originally not set as updatable.
  29760. * The mesh normals are modified using the same transformation.
  29761. * Note that, under the hood, this method sets a new VertexBuffer each call.
  29762. * @param transform defines the transform matrix to use
  29763. * @see https://doc.babylonjs.com/resources/baking_transformations
  29764. * @returns the current mesh
  29765. */
  29766. bakeTransformIntoVertices(transform: Matrix): Mesh;
  29767. /**
  29768. * Modifies the mesh geometry according to its own current World Matrix.
  29769. * The mesh World Matrix is then reset.
  29770. * This method returns nothing but really modifies the mesh even if it's originally not set as updatable.
  29771. * Note that, under the hood, this method sets a new VertexBuffer each call.
  29772. * @see https://doc.babylonjs.com/resources/baking_transformations
  29773. * @param bakeIndependenlyOfChildren indicates whether to preserve all child nodes' World Matrix during baking
  29774. * @returns the current mesh
  29775. */
  29776. bakeCurrentTransformIntoVertices(bakeIndependenlyOfChildren?: boolean): Mesh;
  29777. /** @hidden */
  29778. get _positions(): Nullable<Vector3[]>;
  29779. /** @hidden */
  29780. _resetPointsArrayCache(): Mesh;
  29781. /** @hidden */
  29782. _generatePointsArray(): boolean;
  29783. /**
  29784. * Returns a new Mesh object generated from the current mesh properties.
  29785. * This method must not get confused with createInstance()
  29786. * @param name is a string, the name given to the new mesh
  29787. * @param newParent can be any Node object (default `null`)
  29788. * @param doNotCloneChildren allows/denies the recursive cloning of the original mesh children if any (default `false`)
  29789. * @param clonePhysicsImpostor allows/denies the cloning in the same time of the original mesh `body` used by the physics engine, if any (default `true`)
  29790. * @returns a new mesh
  29791. */
  29792. clone(name?: string, newParent?: Nullable<Node>, doNotCloneChildren?: boolean, clonePhysicsImpostor?: boolean): Mesh;
  29793. /**
  29794. * Releases resources associated with this mesh.
  29795. * @param doNotRecurse Set to true to not recurse into each children (recurse into each children by default)
  29796. * @param disposeMaterialAndTextures Set to true to also dispose referenced materials and textures (false by default)
  29797. */
  29798. dispose(doNotRecurse?: boolean, disposeMaterialAndTextures?: boolean): void;
  29799. /** @hidden */
  29800. _disposeInstanceSpecificData(): void;
  29801. /** @hidden */
  29802. _disposeThinInstanceSpecificData(): void;
  29803. /**
  29804. * Modifies the mesh geometry according to a displacement map.
  29805. * 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.
  29806. * The mesh must be set as updatable. Its internal geometry is directly modified, no new buffer are allocated.
  29807. * @param url is a string, the URL from the image file is to be downloaded.
  29808. * @param minHeight is the lower limit of the displacement.
  29809. * @param maxHeight is the upper limit of the displacement.
  29810. * @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.
  29811. * @param uvOffset is an optional vector2 used to offset UV.
  29812. * @param uvScale is an optional vector2 used to scale UV.
  29813. * @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.
  29814. * @returns the Mesh.
  29815. */
  29816. applyDisplacementMap(url: string, minHeight: number, maxHeight: number, onSuccess?: (mesh: Mesh) => void, uvOffset?: Vector2, uvScale?: Vector2, forceUpdate?: boolean): Mesh;
  29817. /**
  29818. * Modifies the mesh geometry according to a displacementMap buffer.
  29819. * 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.
  29820. * The mesh must be set as updatable. Its internal geometry is directly modified, no new buffer are allocated.
  29821. * @param buffer is a `Uint8Array` buffer containing series of `Uint8` lower than 255, the red, green, blue and alpha values of each successive pixel.
  29822. * @param heightMapWidth is the width of the buffer image.
  29823. * @param heightMapHeight is the height of the buffer image.
  29824. * @param minHeight is the lower limit of the displacement.
  29825. * @param maxHeight is the upper limit of the displacement.
  29826. * @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.
  29827. * @param uvOffset is an optional vector2 used to offset UV.
  29828. * @param uvScale is an optional vector2 used to scale UV.
  29829. * @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.
  29830. * @returns the Mesh.
  29831. */
  29832. applyDisplacementMapFromBuffer(buffer: Uint8Array, heightMapWidth: number, heightMapHeight: number, minHeight: number, maxHeight: number, uvOffset?: Vector2, uvScale?: Vector2, forceUpdate?: boolean): Mesh;
  29833. /**
  29834. * Modify the mesh to get a flat shading rendering.
  29835. * This means each mesh facet will then have its own normals. Usually new vertices are added in the mesh geometry to get this result.
  29836. * Warning : the mesh is really modified even if not set originally as updatable and, under the hood, a new VertexBuffer is allocated.
  29837. * @returns current mesh
  29838. */
  29839. convertToFlatShadedMesh(): Mesh;
  29840. /**
  29841. * This method removes all the mesh indices and add new vertices (duplication) in order to unfold facets into buffers.
  29842. * In other words, more vertices, no more indices and a single bigger VBO.
  29843. * The mesh is really modified even if not set originally as updatable. Under the hood, a new VertexBuffer is allocated.
  29844. * @returns current mesh
  29845. */
  29846. convertToUnIndexedMesh(): Mesh;
  29847. /**
  29848. * Inverses facet orientations.
  29849. * Warning : the mesh is really modified even if not set originally as updatable. A new VertexBuffer is created under the hood each call.
  29850. * @param flipNormals will also inverts the normals
  29851. * @returns current mesh
  29852. */
  29853. flipFaces(flipNormals?: boolean): Mesh;
  29854. /**
  29855. * Increase the number of facets and hence vertices in a mesh
  29856. * Vertex normals are interpolated from existing vertex normals
  29857. * Warning : the mesh is really modified even if not set originally as updatable. A new VertexBuffer is created under the hood each call.
  29858. * @param numberPerEdge the number of new vertices to add to each edge of a facet, optional default 1
  29859. */
  29860. increaseVertices(numberPerEdge: number): void;
  29861. /**
  29862. * Force adjacent facets to share vertices and remove any facets that have all vertices in a line
  29863. * This will undo any application of covertToFlatShadedMesh
  29864. * Warning : the mesh is really modified even if not set originally as updatable. A new VertexBuffer is created under the hood each call.
  29865. */
  29866. forceSharedVertices(): void;
  29867. /** @hidden */
  29868. static _instancedMeshFactory(name: string, mesh: Mesh): InstancedMesh;
  29869. /** @hidden */
  29870. static _PhysicsImpostorParser(scene: Scene, physicObject: IPhysicsEnabledObject, jsonObject: any): PhysicsImpostor;
  29871. /**
  29872. * Creates a new InstancedMesh object from the mesh model.
  29873. * @see https://doc.babylonjs.com/how_to/how_to_use_instances
  29874. * @param name defines the name of the new instance
  29875. * @returns a new InstancedMesh
  29876. */
  29877. createInstance(name: string): InstancedMesh;
  29878. /**
  29879. * Synchronises all the mesh instance submeshes to the current mesh submeshes, if any.
  29880. * After this call, all the mesh instances have the same submeshes than the current mesh.
  29881. * @returns the current mesh
  29882. */
  29883. synchronizeInstances(): Mesh;
  29884. /**
  29885. * Optimization of the mesh's indices, in case a mesh has duplicated vertices.
  29886. * The function will only reorder the indices and will not remove unused vertices to avoid problems with submeshes.
  29887. * This should be used together with the simplification to avoid disappearing triangles.
  29888. * @param successCallback an optional success callback to be called after the optimization finished.
  29889. * @returns the current mesh
  29890. */
  29891. optimizeIndices(successCallback?: (mesh?: Mesh) => void): Mesh;
  29892. /**
  29893. * Serialize current mesh
  29894. * @param serializationObject defines the object which will receive the serialization data
  29895. */
  29896. serialize(serializationObject: any): void;
  29897. /** @hidden */
  29898. _syncGeometryWithMorphTargetManager(): void;
  29899. /** @hidden */
  29900. static _GroundMeshParser: (parsedMesh: any, scene: Scene) => Mesh;
  29901. /**
  29902. * Returns a new Mesh object parsed from the source provided.
  29903. * @param parsedMesh is the source
  29904. * @param scene defines the hosting scene
  29905. * @param rootUrl is the root URL to prefix the `delayLoadingFile` property with
  29906. * @returns a new Mesh
  29907. */
  29908. static Parse(parsedMesh: any, scene: Scene, rootUrl: string): Mesh;
  29909. /**
  29910. * Creates a ribbon mesh. Please consider using the same method from the MeshBuilder class instead
  29911. * @see https://doc.babylonjs.com/how_to/parametric_shapes
  29912. * @param name defines the name of the mesh to create
  29913. * @param pathArray is a required array of paths, what are each an array of successive Vector3. The pathArray parameter depicts the ribbon geometry.
  29914. * @param closeArray creates a seam between the first and the last paths of the path array (default is false)
  29915. * @param closePath creates a seam between the first and the last points of each path of the path array
  29916. * @param offset is taken in account only if the `pathArray` is containing a single path
  29917. * @param scene defines the hosting scene
  29918. * @param updatable defines if the mesh must be flagged as updatable
  29919. * @param sideOrientation defines the mesh side orientation (https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation)
  29920. * @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)
  29921. * @returns a new Mesh
  29922. */
  29923. static CreateRibbon(name: string, pathArray: Vector3[][], closeArray: boolean, closePath: boolean, offset: number, scene?: Scene, updatable?: boolean, sideOrientation?: number, instance?: Mesh): Mesh;
  29924. /**
  29925. * Creates a plane polygonal mesh. By default, this is a disc. Please consider using the same method from the MeshBuilder class instead
  29926. * @param name defines the name of the mesh to create
  29927. * @param radius sets the radius size (float) of the polygon (default 0.5)
  29928. * @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
  29929. * @param scene defines the hosting scene
  29930. * @param updatable defines if the mesh must be flagged as updatable
  29931. * @param sideOrientation defines the mesh side orientation (https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation)
  29932. * @returns a new Mesh
  29933. */
  29934. static CreateDisc(name: string, radius: number, tessellation: number, scene?: Nullable<Scene>, updatable?: boolean, sideOrientation?: number): Mesh;
  29935. /**
  29936. * Creates a box mesh. Please consider using the same method from the MeshBuilder class instead
  29937. * @param name defines the name of the mesh to create
  29938. * @param size sets the size (float) of each box side (default 1)
  29939. * @param scene defines the hosting scene
  29940. * @param updatable defines if the mesh must be flagged as updatable
  29941. * @param sideOrientation defines the mesh side orientation (https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation)
  29942. * @returns a new Mesh
  29943. */
  29944. static CreateBox(name: string, size: number, scene?: Nullable<Scene>, updatable?: boolean, sideOrientation?: number): Mesh;
  29945. /**
  29946. * Creates a sphere mesh. Please consider using the same method from the MeshBuilder class instead
  29947. * @param name defines the name of the mesh to create
  29948. * @param segments sets the sphere number of horizontal stripes (positive integer, default 32)
  29949. * @param diameter sets the diameter size (float) of the sphere (default 1)
  29950. * @param scene defines the hosting scene
  29951. * @param updatable defines if the mesh must be flagged as updatable
  29952. * @param sideOrientation defines the mesh side orientation (https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation)
  29953. * @returns a new Mesh
  29954. */
  29955. static CreateSphere(name: string, segments: number, diameter: number, scene?: Scene, updatable?: boolean, sideOrientation?: number): Mesh;
  29956. /**
  29957. * Creates a hemisphere mesh. Please consider using the same method from the MeshBuilder class instead
  29958. * @param name defines the name of the mesh to create
  29959. * @param segments sets the sphere number of horizontal stripes (positive integer, default 32)
  29960. * @param diameter sets the diameter size (float) of the sphere (default 1)
  29961. * @param scene defines the hosting scene
  29962. * @returns a new Mesh
  29963. */
  29964. static CreateHemisphere(name: string, segments: number, diameter: number, scene?: Scene): Mesh;
  29965. /**
  29966. * Creates a cylinder or a cone mesh. Please consider using the same method from the MeshBuilder class instead
  29967. * @param name defines the name of the mesh to create
  29968. * @param height sets the height size (float) of the cylinder/cone (float, default 2)
  29969. * @param diameterTop set the top cap diameter (floats, default 1)
  29970. * @param diameterBottom set the bottom cap diameter (floats, default 1). This value can't be zero
  29971. * @param tessellation sets the number of cylinder sides (positive integer, default 24). Set it to 3 to get a prism for instance
  29972. * @param subdivisions sets the number of rings along the cylinder height (positive integer, default 1)
  29973. * @param scene defines the hosting scene
  29974. * @param updatable defines if the mesh must be flagged as updatable
  29975. * @param sideOrientation defines the mesh side orientation (https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation)
  29976. * @returns a new Mesh
  29977. */
  29978. static CreateCylinder(name: string, height: number, diameterTop: number, diameterBottom: number, tessellation: number, subdivisions: any, scene?: Scene, updatable?: any, sideOrientation?: number): Mesh;
  29979. /**
  29980. * Creates a torus mesh. Please consider using the same method from the MeshBuilder class instead
  29981. * @param name defines the name of the mesh to create
  29982. * @param diameter sets the diameter size (float) of the torus (default 1)
  29983. * @param thickness sets the diameter size of the tube of the torus (float, default 0.5)
  29984. * @param tessellation sets the number of torus sides (postive integer, default 16)
  29985. * @param scene defines the hosting scene
  29986. * @param updatable defines if the mesh must be flagged as updatable
  29987. * @param sideOrientation defines the mesh side orientation (https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation)
  29988. * @returns a new Mesh
  29989. */
  29990. static CreateTorus(name: string, diameter: number, thickness: number, tessellation: number, scene?: Scene, updatable?: boolean, sideOrientation?: number): Mesh;
  29991. /**
  29992. * Creates a torus knot mesh. Please consider using the same method from the MeshBuilder class instead
  29993. * @param name defines the name of the mesh to create
  29994. * @param radius sets the global radius size (float) of the torus knot (default 2)
  29995. * @param tube sets the diameter size of the tube of the torus (float, default 0.5)
  29996. * @param radialSegments sets the number of sides on each tube segments (positive integer, default 32)
  29997. * @param tubularSegments sets the number of tubes to decompose the knot into (positive integer, default 32)
  29998. * @param p the number of windings on X axis (positive integers, default 2)
  29999. * @param q the number of windings on Y axis (positive integers, default 3)
  30000. * @param scene defines the hosting scene
  30001. * @param updatable defines if the mesh must be flagged as updatable
  30002. * @param sideOrientation defines the mesh side orientation (https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation)
  30003. * @returns a new Mesh
  30004. */
  30005. static CreateTorusKnot(name: string, radius: number, tube: number, radialSegments: number, tubularSegments: number, p: number, q: number, scene?: Scene, updatable?: boolean, sideOrientation?: number): Mesh;
  30006. /**
  30007. * Creates a line mesh. Please consider using the same method from the MeshBuilder class instead.
  30008. * @param name defines the name of the mesh to create
  30009. * @param points is an array successive Vector3
  30010. * @param scene defines the hosting scene
  30011. * @param updatable defines if the mesh must be flagged as updatable
  30012. * @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).
  30013. * @returns a new Mesh
  30014. */
  30015. static CreateLines(name: string, points: Vector3[], scene?: Nullable<Scene>, updatable?: boolean, instance?: Nullable<LinesMesh>): LinesMesh;
  30016. /**
  30017. * Creates a dashed line mesh. Please consider using the same method from the MeshBuilder class instead
  30018. * @param name defines the name of the mesh to create
  30019. * @param points is an array successive Vector3
  30020. * @param dashSize is the size of the dashes relatively the dash number (positive float, default 3)
  30021. * @param gapSize is the size of the gap between two successive dashes relatively the dash number (positive float, default 1)
  30022. * @param dashNb is the intended total number of dashes (positive integer, default 200)
  30023. * @param scene defines the hosting scene
  30024. * @param updatable defines if the mesh must be flagged as updatable
  30025. * @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)
  30026. * @returns a new Mesh
  30027. */
  30028. static CreateDashedLines(name: string, points: Vector3[], dashSize: number, gapSize: number, dashNb: number, scene?: Nullable<Scene>, updatable?: boolean, instance?: LinesMesh): LinesMesh;
  30029. /**
  30030. * Creates a polygon mesh.Please consider using the same method from the MeshBuilder class instead
  30031. * The polygon's shape will depend on the input parameters and is constructed parallel to a ground mesh.
  30032. * 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.
  30033. * You can set the mesh side orientation with the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  30034. * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created.
  30035. * Remember you can only change the shape positions, not their number when updating a polygon.
  30036. * @see https://doc.babylonjs.com/how_to/parametric_shapes#non-regular-polygon
  30037. * @param name defines the name of the mesh to create
  30038. * @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
  30039. * @param scene defines the hosting scene
  30040. * @param holes is a required array of arrays of successive Vector3 used to defines holes in the polygon
  30041. * @param updatable defines if the mesh must be flagged as updatable
  30042. * @param sideOrientation defines the mesh side orientation (https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation)
  30043. * @param earcutInjection can be used to inject your own earcut reference
  30044. * @returns a new Mesh
  30045. */
  30046. static CreatePolygon(name: string, shape: Vector3[], scene: Scene, holes?: Vector3[][], updatable?: boolean, sideOrientation?: number, earcutInjection?: any): Mesh;
  30047. /**
  30048. * Creates an extruded polygon mesh, with depth in the Y direction. Please consider using the same method from the MeshBuilder class instead.
  30049. * @see https://doc.babylonjs.com/how_to/parametric_shapes#extruded-non-regular-polygon
  30050. * @param name defines the name of the mesh to create
  30051. * @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
  30052. * @param depth defines the height of extrusion
  30053. * @param scene defines the hosting scene
  30054. * @param holes is a required array of arrays of successive Vector3 used to defines holes in the polygon
  30055. * @param updatable defines if the mesh must be flagged as updatable
  30056. * @param sideOrientation defines the mesh side orientation (https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation)
  30057. * @param earcutInjection can be used to inject your own earcut reference
  30058. * @returns a new Mesh
  30059. */
  30060. static ExtrudePolygon(name: string, shape: Vector3[], depth: number, scene: Scene, holes?: Vector3[][], updatable?: boolean, sideOrientation?: number, earcutInjection?: any): Mesh;
  30061. /**
  30062. * Creates an extruded shape mesh.
  30063. * 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
  30064. * @see https://doc.babylonjs.com/how_to/parametric_shapes
  30065. * @see https://doc.babylonjs.com/how_to/parametric_shapes#extruded-shapes
  30066. * @param name defines the name of the mesh to create
  30067. * @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
  30068. * @param path is a required array of successive Vector3. This is the axis curve the shape is extruded along
  30069. * @param scale is the value to scale the shape
  30070. * @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
  30071. * @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
  30072. * @param scene defines the hosting scene
  30073. * @param updatable defines if the mesh must be flagged as updatable
  30074. * @param sideOrientation defines the mesh side orientation (https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation)
  30075. * @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)
  30076. * @returns a new Mesh
  30077. */
  30078. static ExtrudeShape(name: string, shape: Vector3[], path: Vector3[], scale: number, rotation: number, cap: number, scene?: Nullable<Scene>, updatable?: boolean, sideOrientation?: number, instance?: Mesh): Mesh;
  30079. /**
  30080. * Creates an custom extruded shape mesh.
  30081. * The custom extrusion is a parametric shape.
  30082. * It has no predefined shape. Its final shape will depend on the input parameters.
  30083. * Please consider using the same method from the MeshBuilder class instead
  30084. * @see https://doc.babylonjs.com/how_to/parametric_shapes#extruded-shapes
  30085. * @param name defines the name of the mesh to create
  30086. * @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
  30087. * @param path is a required array of successive Vector3. This is the axis curve the shape is extruded along
  30088. * @param scaleFunction is a custom Javascript function called on each path point
  30089. * @param rotationFunction is a custom Javascript function called on each path point
  30090. * @param ribbonCloseArray forces the extrusion underlying ribbon to close all the paths in its `pathArray`
  30091. * @param ribbonClosePath forces the extrusion underlying ribbon to close its `pathArray`
  30092. * @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
  30093. * @param scene defines the hosting scene
  30094. * @param updatable defines if the mesh must be flagged as updatable
  30095. * @param sideOrientation defines the mesh side orientation (https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation)
  30096. * @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)
  30097. * @returns a new Mesh
  30098. */
  30099. 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;
  30100. /**
  30101. * Creates lathe mesh.
  30102. * The lathe is a shape with a symetry axis : a 2D model shape is rotated around this axis to design the lathe.
  30103. * Please consider using the same method from the MeshBuilder class instead
  30104. * @param name defines the name of the mesh to create
  30105. * @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
  30106. * @param radius is the radius value of the lathe
  30107. * @param tessellation is the side number of the lathe.
  30108. * @param scene defines the hosting scene
  30109. * @param updatable defines if the mesh must be flagged as updatable
  30110. * @param sideOrientation defines the mesh side orientation (https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation)
  30111. * @returns a new Mesh
  30112. */
  30113. static CreateLathe(name: string, shape: Vector3[], radius: number, tessellation: number, scene: Scene, updatable?: boolean, sideOrientation?: number): Mesh;
  30114. /**
  30115. * Creates a plane mesh. Please consider using the same method from the MeshBuilder class instead
  30116. * @param name defines the name of the mesh to create
  30117. * @param size sets the size (float) of both sides of the plane at once (default 1)
  30118. * @param scene defines the hosting scene
  30119. * @param updatable defines if the mesh must be flagged as updatable
  30120. * @param sideOrientation defines the mesh side orientation (https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation)
  30121. * @returns a new Mesh
  30122. */
  30123. static CreatePlane(name: string, size: number, scene: Scene, updatable?: boolean, sideOrientation?: number): Mesh;
  30124. /**
  30125. * Creates a ground mesh.
  30126. * Please consider using the same method from the MeshBuilder class instead
  30127. * @param name defines the name of the mesh to create
  30128. * @param width set the width of the ground
  30129. * @param height set the height of the ground
  30130. * @param subdivisions sets the number of subdivisions per side
  30131. * @param scene defines the hosting scene
  30132. * @param updatable defines if the mesh must be flagged as updatable
  30133. * @returns a new Mesh
  30134. */
  30135. static CreateGround(name: string, width: number, height: number, subdivisions: number, scene?: Scene, updatable?: boolean): Mesh;
  30136. /**
  30137. * Creates a tiled ground mesh.
  30138. * Please consider using the same method from the MeshBuilder class instead
  30139. * @param name defines the name of the mesh to create
  30140. * @param xmin set the ground minimum X coordinate
  30141. * @param zmin set the ground minimum Y coordinate
  30142. * @param xmax set the ground maximum X coordinate
  30143. * @param zmax set the ground maximum Z coordinate
  30144. * @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
  30145. * @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
  30146. * @param scene defines the hosting scene
  30147. * @param updatable defines if the mesh must be flagged as updatable
  30148. * @returns a new Mesh
  30149. */
  30150. static CreateTiledGround(name: string, xmin: number, zmin: number, xmax: number, zmax: number, subdivisions: {
  30151. w: number;
  30152. h: number;
  30153. }, precision: {
  30154. w: number;
  30155. h: number;
  30156. }, scene: Scene, updatable?: boolean): Mesh;
  30157. /**
  30158. * Creates a ground mesh from a height map.
  30159. * Please consider using the same method from the MeshBuilder class instead
  30160. * @see https://doc.babylonjs.com/babylon101/height_map
  30161. * @param name defines the name of the mesh to create
  30162. * @param url sets the URL of the height map image resource
  30163. * @param width set the ground width size
  30164. * @param height set the ground height size
  30165. * @param subdivisions sets the number of subdivision per side
  30166. * @param minHeight is the minimum altitude on the ground
  30167. * @param maxHeight is the maximum altitude on the ground
  30168. * @param scene defines the hosting scene
  30169. * @param updatable defines if the mesh must be flagged as updatable
  30170. * @param onReady is a callback function that will be called once the mesh is built (the height map download can last some time)
  30171. * @param alphaFilter will filter any data where the alpha channel is below this value, defaults 0 (all data visible)
  30172. * @returns a new Mesh
  30173. */
  30174. 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;
  30175. /**
  30176. * Creates a tube mesh.
  30177. * The tube is a parametric shape.
  30178. * It has no predefined shape. Its final shape will depend on the input parameters.
  30179. * Please consider using the same method from the MeshBuilder class instead
  30180. * @see https://doc.babylonjs.com/how_to/parametric_shapes
  30181. * @param name defines the name of the mesh to create
  30182. * @param path is a required array of successive Vector3. It is the curve used as the axis of the tube
  30183. * @param radius sets the tube radius size
  30184. * @param tessellation is the number of sides on the tubular surface
  30185. * @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
  30186. * @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
  30187. * @param scene defines the hosting scene
  30188. * @param updatable defines if the mesh must be flagged as updatable
  30189. * @param sideOrientation defines the mesh side orientation (https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation)
  30190. * @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)
  30191. * @returns a new Mesh
  30192. */
  30193. static CreateTube(name: string, path: Vector3[], radius: number, tessellation: number, radiusFunction: {
  30194. (i: number, distance: number): number;
  30195. }, cap: number, scene: Scene, updatable?: boolean, sideOrientation?: number, instance?: Mesh): Mesh;
  30196. /**
  30197. * Creates a polyhedron mesh.
  30198. * Please consider using the same method from the MeshBuilder class instead.
  30199. * * 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
  30200. * * The parameter `size` (positive float, default 1) sets the polygon size
  30201. * * You can overwrite the `size` on each dimension bu using the parameters `sizeX`, `sizeY` or `sizeZ` (positive floats, default to `size` value)
  30202. * * 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`
  30203. * * 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
  30204. * * 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)`)
  30205. * * 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
  30206. * * 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
  30207. * * You can also set the mesh side orientation with the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  30208. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  30209. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  30210. * @param name defines the name of the mesh to create
  30211. * @param options defines the options used to create the mesh
  30212. * @param scene defines the hosting scene
  30213. * @returns a new Mesh
  30214. */
  30215. static CreatePolyhedron(name: string, options: {
  30216. type?: number;
  30217. size?: number;
  30218. sizeX?: number;
  30219. sizeY?: number;
  30220. sizeZ?: number;
  30221. custom?: any;
  30222. faceUV?: Vector4[];
  30223. faceColors?: Color4[];
  30224. updatable?: boolean;
  30225. sideOrientation?: number;
  30226. }, scene: Scene): Mesh;
  30227. /**
  30228. * Creates a sphere based upon an icosahedron with 20 triangular faces which can be subdivided
  30229. * * The parameter `radius` sets the radius size (float) of the icosphere (default 1)
  30230. * * 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`)
  30231. * * The parameter `subdivisions` sets the number of subdivisions (postive integer, default 4). The more subdivisions, the more faces on the icosphere whatever its size
  30232. * * 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
  30233. * * You can also set the mesh side orientation with the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  30234. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  30235. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  30236. * @param name defines the name of the mesh
  30237. * @param options defines the options used to create the mesh
  30238. * @param scene defines the hosting scene
  30239. * @returns a new Mesh
  30240. * @see https://doc.babylonjs.com/how_to/polyhedra_shapes#icosphere
  30241. */
  30242. static CreateIcoSphere(name: string, options: {
  30243. radius?: number;
  30244. flat?: boolean;
  30245. subdivisions?: number;
  30246. sideOrientation?: number;
  30247. updatable?: boolean;
  30248. }, scene: Scene): Mesh;
  30249. /**
  30250. * Creates a decal mesh.
  30251. * Please consider using the same method from the MeshBuilder class instead.
  30252. * A decal is a mesh usually applied as a model onto the surface of another mesh
  30253. * @param name defines the name of the mesh
  30254. * @param sourceMesh defines the mesh receiving the decal
  30255. * @param position sets the position of the decal in world coordinates
  30256. * @param normal sets the normal of the mesh where the decal is applied onto in world coordinates
  30257. * @param size sets the decal scaling
  30258. * @param angle sets the angle to rotate the decal
  30259. * @returns a new Mesh
  30260. */
  30261. static CreateDecal(name: string, sourceMesh: AbstractMesh, position: Vector3, normal: Vector3, size: Vector3, angle: number): Mesh;
  30262. /**
  30263. * Prepare internal position array for software CPU skinning
  30264. * @returns original positions used for CPU skinning. Useful for integrating Morphing with skeletons in same mesh
  30265. */
  30266. setPositionsForCPUSkinning(): Float32Array;
  30267. /**
  30268. * Prepare internal normal array for software CPU skinning
  30269. * @returns original normals used for CPU skinning. Useful for integrating Morphing with skeletons in same mesh.
  30270. */
  30271. setNormalsForCPUSkinning(): Float32Array;
  30272. /**
  30273. * Updates the vertex buffer by applying transformation from the bones
  30274. * @param skeleton defines the skeleton to apply to current mesh
  30275. * @returns the current mesh
  30276. */
  30277. applySkeleton(skeleton: Skeleton): Mesh;
  30278. /**
  30279. * 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
  30280. * @param meshes defines the list of meshes to scan
  30281. * @returns an object `{min:` Vector3`, max:` Vector3`}`
  30282. */
  30283. static MinMax(meshes: AbstractMesh[]): {
  30284. min: Vector3;
  30285. max: Vector3;
  30286. };
  30287. /**
  30288. * Returns the center of the `{min:` Vector3`, max:` Vector3`}` or the center of MinMax vector3 computed from a mesh array
  30289. * @param meshesOrMinMaxVector could be an array of meshes or a `{min:` Vector3`, max:` Vector3`}` object
  30290. * @returns a vector3
  30291. */
  30292. static Center(meshesOrMinMaxVector: {
  30293. min: Vector3;
  30294. max: Vector3;
  30295. } | AbstractMesh[]): Vector3;
  30296. /**
  30297. * Merge the array of meshes into a single mesh for performance reasons.
  30298. * @param meshes defines he vertices source. They should all be of the same material. Entries can empty
  30299. * @param disposeSource when true (default), dispose of the vertices from the source meshes
  30300. * @param allow32BitsIndices when the sum of the vertices > 64k, this must be set to true
  30301. * @param meshSubclass when set, vertices inserted into this Mesh. Meshes can then be merged into a Mesh sub-class.
  30302. * @param subdivideWithSubMeshes when true (false default), subdivide mesh to his subMesh array with meshes source.
  30303. * @param multiMultiMaterials when true (false default), subdivide mesh and accept multiple multi materials, ignores subdivideWithSubMeshes.
  30304. * @returns a new mesh
  30305. */
  30306. static MergeMeshes(meshes: Array<Mesh>, disposeSource?: boolean, allow32BitsIndices?: boolean, meshSubclass?: Mesh, subdivideWithSubMeshes?: boolean, multiMultiMaterials?: boolean): Nullable<Mesh>;
  30307. /** @hidden */
  30308. addInstance(instance: InstancedMesh): void;
  30309. /** @hidden */
  30310. removeInstance(instance: InstancedMesh): void;
  30311. }
  30312. }
  30313. declare module "babylonjs/Cameras/camera" {
  30314. import { SmartArray } from "babylonjs/Misc/smartArray";
  30315. import { Observable } from "babylonjs/Misc/observable";
  30316. import { Nullable } from "babylonjs/types";
  30317. import { CameraInputsManager } from "babylonjs/Cameras/cameraInputsManager";
  30318. import { Scene } from "babylonjs/scene";
  30319. import { Matrix, Vector3, Quaternion } from "babylonjs/Maths/math.vector";
  30320. import { Node } from "babylonjs/node";
  30321. import { Mesh } from "babylonjs/Meshes/mesh";
  30322. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  30323. import { ICullable } from "babylonjs/Culling/boundingInfo";
  30324. import { Viewport } from "babylonjs/Maths/math.viewport";
  30325. import { PostProcess } from "babylonjs/PostProcesses/postProcess";
  30326. import { RenderTargetTexture } from "babylonjs/Materials/Textures/renderTargetTexture";
  30327. import { FreeCamera } from "babylonjs/Cameras/freeCamera";
  30328. import { Ray } from "babylonjs/Culling/ray";
  30329. /**
  30330. * This is the base class of all the camera used in the application.
  30331. * @see https://doc.babylonjs.com/features/cameras
  30332. */
  30333. export class Camera extends Node {
  30334. /** @hidden */
  30335. static _createDefaultParsedCamera: (name: string, scene: Scene) => Camera;
  30336. /**
  30337. * This is the default projection mode used by the cameras.
  30338. * It helps recreating a feeling of perspective and better appreciate depth.
  30339. * This is the best way to simulate real life cameras.
  30340. */
  30341. static readonly PERSPECTIVE_CAMERA: number;
  30342. /**
  30343. * This helps creating camera with an orthographic mode.
  30344. * 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.
  30345. */
  30346. static readonly ORTHOGRAPHIC_CAMERA: number;
  30347. /**
  30348. * This is the default FOV mode for perspective cameras.
  30349. * This setting aligns the upper and lower bounds of the viewport to the upper and lower bounds of the camera frustum.
  30350. */
  30351. static readonly FOVMODE_VERTICAL_FIXED: number;
  30352. /**
  30353. * This setting aligns the left and right bounds of the viewport to the left and right bounds of the camera frustum.
  30354. */
  30355. static readonly FOVMODE_HORIZONTAL_FIXED: number;
  30356. /**
  30357. * This specifies ther is no need for a camera rig.
  30358. * Basically only one eye is rendered corresponding to the camera.
  30359. */
  30360. static readonly RIG_MODE_NONE: number;
  30361. /**
  30362. * Simulates a camera Rig with one blue eye and one red eye.
  30363. * This can be use with 3d blue and red glasses.
  30364. */
  30365. static readonly RIG_MODE_STEREOSCOPIC_ANAGLYPH: number;
  30366. /**
  30367. * Defines that both eyes of the camera will be rendered side by side with a parallel target.
  30368. */
  30369. static readonly RIG_MODE_STEREOSCOPIC_SIDEBYSIDE_PARALLEL: number;
  30370. /**
  30371. * Defines that both eyes of the camera will be rendered side by side with a none parallel target.
  30372. */
  30373. static readonly RIG_MODE_STEREOSCOPIC_SIDEBYSIDE_CROSSEYED: number;
  30374. /**
  30375. * Defines that both eyes of the camera will be rendered over under each other.
  30376. */
  30377. static readonly RIG_MODE_STEREOSCOPIC_OVERUNDER: number;
  30378. /**
  30379. * Defines that both eyes of the camera will be rendered on successive lines interlaced for passive 3d monitors.
  30380. */
  30381. static readonly RIG_MODE_STEREOSCOPIC_INTERLACED: number;
  30382. /**
  30383. * Defines that both eyes of the camera should be renderered in a VR mode (carbox).
  30384. */
  30385. static readonly RIG_MODE_VR: number;
  30386. /**
  30387. * Defines that both eyes of the camera should be renderered in a VR mode (webVR).
  30388. */
  30389. static readonly RIG_MODE_WEBVR: number;
  30390. /**
  30391. * Custom rig mode allowing rig cameras to be populated manually with any number of cameras
  30392. */
  30393. static readonly RIG_MODE_CUSTOM: number;
  30394. /**
  30395. * Defines if by default attaching controls should prevent the default javascript event to continue.
  30396. */
  30397. static ForceAttachControlToAlwaysPreventDefault: boolean;
  30398. /**
  30399. * Define the input manager associated with the camera.
  30400. */
  30401. inputs: CameraInputsManager<Camera>;
  30402. /** @hidden */
  30403. _position: Vector3;
  30404. /**
  30405. * Define the current local position of the camera in the scene
  30406. */
  30407. get position(): Vector3;
  30408. set position(newPosition: Vector3);
  30409. protected _upVector: Vector3;
  30410. /**
  30411. * The vector the camera should consider as up.
  30412. * (default is Vector3(0, 1, 0) aka Vector3.Up())
  30413. */
  30414. set upVector(vec: Vector3);
  30415. get upVector(): Vector3;
  30416. /**
  30417. * Define the current limit on the left side for an orthographic camera
  30418. * In scene unit
  30419. */
  30420. orthoLeft: Nullable<number>;
  30421. /**
  30422. * Define the current limit on the right side for an orthographic camera
  30423. * In scene unit
  30424. */
  30425. orthoRight: Nullable<number>;
  30426. /**
  30427. * Define the current limit on the bottom side for an orthographic camera
  30428. * In scene unit
  30429. */
  30430. orthoBottom: Nullable<number>;
  30431. /**
  30432. * Define the current limit on the top side for an orthographic camera
  30433. * In scene unit
  30434. */
  30435. orthoTop: Nullable<number>;
  30436. /**
  30437. * Field Of View is set in Radians. (default is 0.8)
  30438. */
  30439. fov: number;
  30440. /**
  30441. * Define the minimum distance the camera can see from.
  30442. * This is important to note that the depth buffer are not infinite and the closer it starts
  30443. * the more your scene might encounter depth fighting issue.
  30444. */
  30445. minZ: number;
  30446. /**
  30447. * Define the maximum distance the camera can see to.
  30448. * This is important to note that the depth buffer are not infinite and the further it end
  30449. * the more your scene might encounter depth fighting issue.
  30450. */
  30451. maxZ: number;
  30452. /**
  30453. * Define the default inertia of the camera.
  30454. * This helps giving a smooth feeling to the camera movement.
  30455. */
  30456. inertia: number;
  30457. /**
  30458. * Define the mode of the camera (Camera.PERSPECTIVE_CAMERA or Camera.ORTHOGRAPHIC_CAMERA)
  30459. */
  30460. mode: number;
  30461. /**
  30462. * Define whether the camera is intermediate.
  30463. * This is useful to not present the output directly to the screen in case of rig without post process for instance
  30464. */
  30465. isIntermediate: boolean;
  30466. /**
  30467. * Define the viewport of the camera.
  30468. * This correspond to the portion of the screen the camera will render to in normalized 0 to 1 unit.
  30469. */
  30470. viewport: Viewport;
  30471. /**
  30472. * Restricts the camera to viewing objects with the same layerMask.
  30473. * A camera with a layerMask of 1 will render mesh.layerMask & camera.layerMask!== 0
  30474. */
  30475. layerMask: number;
  30476. /**
  30477. * fovMode sets the camera frustum bounds to the viewport bounds. (default is FOVMODE_VERTICAL_FIXED)
  30478. */
  30479. fovMode: number;
  30480. /**
  30481. * Rig mode of the camera.
  30482. * This is useful to create the camera with two "eyes" instead of one to create VR or stereoscopic scenes.
  30483. * This is normally controlled byt the camera themselves as internal use.
  30484. */
  30485. cameraRigMode: number;
  30486. /**
  30487. * Defines the distance between both "eyes" in case of a RIG
  30488. */
  30489. interaxialDistance: number;
  30490. /**
  30491. * Defines if stereoscopic rendering is done side by side or over under.
  30492. */
  30493. isStereoscopicSideBySide: boolean;
  30494. /**
  30495. * 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
  30496. * This is pretty helpfull if you wish to make a camera render to a texture you could reuse somewhere
  30497. * else in the scene. (Eg. security camera)
  30498. *
  30499. * 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)
  30500. */
  30501. customRenderTargets: import("babylonjs/Materials/Textures/renderTargetTexture").RenderTargetTexture[];
  30502. /**
  30503. * When set, the camera will render to this render target instead of the default canvas
  30504. *
  30505. * If the desire is to use the output of a camera as a texture in the scene consider using camera.customRenderTargets instead
  30506. */
  30507. outputRenderTarget: Nullable<RenderTargetTexture>;
  30508. /**
  30509. * Observable triggered when the camera view matrix has changed.
  30510. */
  30511. onViewMatrixChangedObservable: Observable<Camera>;
  30512. /**
  30513. * Observable triggered when the camera Projection matrix has changed.
  30514. */
  30515. onProjectionMatrixChangedObservable: Observable<Camera>;
  30516. /**
  30517. * Observable triggered when the inputs have been processed.
  30518. */
  30519. onAfterCheckInputsObservable: Observable<Camera>;
  30520. /**
  30521. * Observable triggered when reset has been called and applied to the camera.
  30522. */
  30523. onRestoreStateObservable: Observable<Camera>;
  30524. /**
  30525. * Is this camera a part of a rig system?
  30526. */
  30527. isRigCamera: boolean;
  30528. /**
  30529. * If isRigCamera set to true this will be set with the parent camera.
  30530. * The parent camera is not (!) necessarily the .parent of this camera (like in the case of XR)
  30531. */
  30532. rigParent?: Camera;
  30533. /** @hidden */
  30534. _cameraRigParams: any;
  30535. /** @hidden */
  30536. _rigCameras: Camera[];
  30537. /** @hidden */
  30538. _rigPostProcess: Nullable<PostProcess>;
  30539. protected _webvrViewMatrix: Matrix;
  30540. /** @hidden */
  30541. _skipRendering: boolean;
  30542. /** @hidden */
  30543. _projectionMatrix: Matrix;
  30544. /** @hidden */
  30545. _postProcesses: Nullable<import("babylonjs/PostProcesses/postProcess").PostProcess>[];
  30546. /** @hidden */
  30547. _activeMeshes: SmartArray<AbstractMesh>;
  30548. protected _globalPosition: Vector3;
  30549. /** @hidden */
  30550. _computedViewMatrix: Matrix;
  30551. private _doNotComputeProjectionMatrix;
  30552. private _transformMatrix;
  30553. private _frustumPlanes;
  30554. private _refreshFrustumPlanes;
  30555. private _storedFov;
  30556. private _stateStored;
  30557. /**
  30558. * Instantiates a new camera object.
  30559. * This should not be used directly but through the inherited cameras: ArcRotate, Free...
  30560. * @see https://doc.babylonjs.com/features/cameras
  30561. * @param name Defines the name of the camera in the scene
  30562. * @param position Defines the position of the camera
  30563. * @param scene Defines the scene the camera belongs too
  30564. * @param setActiveOnSceneIfNoneActive Defines if the camera should be set as active after creation if no other camera have been defined in the scene
  30565. */
  30566. constructor(name: string, position: Vector3, scene: Scene, setActiveOnSceneIfNoneActive?: boolean);
  30567. /**
  30568. * Store current camera state (fov, position, etc..)
  30569. * @returns the camera
  30570. */
  30571. storeState(): Camera;
  30572. /**
  30573. * Restores the camera state values if it has been stored. You must call storeState() first
  30574. */
  30575. protected _restoreStateValues(): boolean;
  30576. /**
  30577. * Restored camera state. You must call storeState() first.
  30578. * @returns true if restored and false otherwise
  30579. */
  30580. restoreState(): boolean;
  30581. /**
  30582. * Gets the class name of the camera.
  30583. * @returns the class name
  30584. */
  30585. getClassName(): string;
  30586. /** @hidden */
  30587. readonly _isCamera: boolean;
  30588. /**
  30589. * Gets a string representation of the camera useful for debug purpose.
  30590. * @param fullDetails Defines that a more verboe level of logging is required
  30591. * @returns the string representation
  30592. */
  30593. toString(fullDetails?: boolean): string;
  30594. /**
  30595. * Gets the current world space position of the camera.
  30596. */
  30597. get globalPosition(): Vector3;
  30598. /**
  30599. * Gets the list of active meshes this frame (meshes no culled or excluded by lod s in the frame)
  30600. * @returns the active meshe list
  30601. */
  30602. getActiveMeshes(): SmartArray<AbstractMesh>;
  30603. /**
  30604. * Check whether a mesh is part of the current active mesh list of the camera
  30605. * @param mesh Defines the mesh to check
  30606. * @returns true if active, false otherwise
  30607. */
  30608. isActiveMesh(mesh: Mesh): boolean;
  30609. /**
  30610. * Is this camera ready to be used/rendered
  30611. * @param completeCheck defines if a complete check (including post processes) has to be done (false by default)
  30612. * @return true if the camera is ready
  30613. */
  30614. isReady(completeCheck?: boolean): boolean;
  30615. /** @hidden */
  30616. _initCache(): void;
  30617. /** @hidden */
  30618. _updateCache(ignoreParentClass?: boolean): void;
  30619. /** @hidden */
  30620. _isSynchronized(): boolean;
  30621. /** @hidden */
  30622. _isSynchronizedViewMatrix(): boolean;
  30623. /** @hidden */
  30624. _isSynchronizedProjectionMatrix(): boolean;
  30625. /**
  30626. * Attach the input controls to a specific dom element to get the input from.
  30627. * @param element Defines the element the controls should be listened from
  30628. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  30629. */
  30630. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  30631. /**
  30632. * Detach the current controls from the specified dom element.
  30633. * @param element Defines the element to stop listening the inputs from
  30634. */
  30635. detachControl(element: HTMLElement): void;
  30636. /**
  30637. * Update the camera state according to the different inputs gathered during the frame.
  30638. */
  30639. update(): void;
  30640. /** @hidden */
  30641. _checkInputs(): void;
  30642. /** @hidden */
  30643. get rigCameras(): Camera[];
  30644. /**
  30645. * Gets the post process used by the rig cameras
  30646. */
  30647. get rigPostProcess(): Nullable<PostProcess>;
  30648. /**
  30649. * Internal, gets the first post proces.
  30650. * @returns the first post process to be run on this camera.
  30651. */
  30652. _getFirstPostProcess(): Nullable<PostProcess>;
  30653. private _cascadePostProcessesToRigCams;
  30654. /**
  30655. * Attach a post process to the camera.
  30656. * @see https://doc.babylonjs.com/how_to/how_to_use_postprocesses#attach-postprocess
  30657. * @param postProcess The post process to attach to the camera
  30658. * @param insertAt The position of the post process in case several of them are in use in the scene
  30659. * @returns the position the post process has been inserted at
  30660. */
  30661. attachPostProcess(postProcess: PostProcess, insertAt?: Nullable<number>): number;
  30662. /**
  30663. * Detach a post process to the camera.
  30664. * @see https://doc.babylonjs.com/how_to/how_to_use_postprocesses#attach-postprocess
  30665. * @param postProcess The post process to detach from the camera
  30666. */
  30667. detachPostProcess(postProcess: PostProcess): void;
  30668. /**
  30669. * Gets the current world matrix of the camera
  30670. */
  30671. getWorldMatrix(): Matrix;
  30672. /** @hidden */
  30673. _getViewMatrix(): Matrix;
  30674. /**
  30675. * Gets the current view matrix of the camera.
  30676. * @param force forces the camera to recompute the matrix without looking at the cached state
  30677. * @returns the view matrix
  30678. */
  30679. getViewMatrix(force?: boolean): Matrix;
  30680. /**
  30681. * Freeze the projection matrix.
  30682. * It will prevent the cache check of the camera projection compute and can speed up perf
  30683. * if no parameter of the camera are meant to change
  30684. * @param projection Defines manually a projection if necessary
  30685. */
  30686. freezeProjectionMatrix(projection?: Matrix): void;
  30687. /**
  30688. * Unfreeze the projection matrix if it has previously been freezed by freezeProjectionMatrix.
  30689. */
  30690. unfreezeProjectionMatrix(): void;
  30691. /**
  30692. * Gets the current projection matrix of the camera.
  30693. * @param force forces the camera to recompute the matrix without looking at the cached state
  30694. * @returns the projection matrix
  30695. */
  30696. getProjectionMatrix(force?: boolean): Matrix;
  30697. /**
  30698. * Gets the transformation matrix (ie. the multiplication of view by projection matrices)
  30699. * @returns a Matrix
  30700. */
  30701. getTransformationMatrix(): Matrix;
  30702. private _updateFrustumPlanes;
  30703. /**
  30704. * Checks if a cullable object (mesh...) is in the camera frustum
  30705. * This checks the bounding box center. See isCompletelyInFrustum for a full bounding check
  30706. * @param target The object to check
  30707. * @param checkRigCameras If the rig cameras should be checked (eg. with webVR camera both eyes should be checked) (Default: false)
  30708. * @returns true if the object is in frustum otherwise false
  30709. */
  30710. isInFrustum(target: ICullable, checkRigCameras?: boolean): boolean;
  30711. /**
  30712. * Checks if a cullable object (mesh...) is in the camera frustum
  30713. * Unlike isInFrustum this cheks the full bounding box
  30714. * @param target The object to check
  30715. * @returns true if the object is in frustum otherwise false
  30716. */
  30717. isCompletelyInFrustum(target: ICullable): boolean;
  30718. /**
  30719. * Gets a ray in the forward direction from the camera.
  30720. * @param length Defines the length of the ray to create
  30721. * @param transform Defines the transform to apply to the ray, by default the world matrx is used to create a workd space ray
  30722. * @param origin Defines the start point of the ray which defaults to the camera position
  30723. * @returns the forward ray
  30724. */
  30725. getForwardRay(length?: number, transform?: Matrix, origin?: Vector3): Ray;
  30726. /**
  30727. * Gets a ray in the forward direction from the camera.
  30728. * @param refRay the ray to (re)use when setting the values
  30729. * @param length Defines the length of the ray to create
  30730. * @param transform Defines the transform to apply to the ray, by default the world matrx is used to create a workd space ray
  30731. * @param origin Defines the start point of the ray which defaults to the camera position
  30732. * @returns the forward ray
  30733. */
  30734. getForwardRayToRef(refRay: Ray, length?: number, transform?: Matrix, origin?: Vector3): Ray;
  30735. /**
  30736. * Releases resources associated with this node.
  30737. * @param doNotRecurse Set to true to not recurse into each children (recurse into each children by default)
  30738. * @param disposeMaterialAndTextures Set to true to also dispose referenced materials and textures (false by default)
  30739. */
  30740. dispose(doNotRecurse?: boolean, disposeMaterialAndTextures?: boolean): void;
  30741. /** @hidden */
  30742. _isLeftCamera: boolean;
  30743. /**
  30744. * Gets the left camera of a rig setup in case of Rigged Camera
  30745. */
  30746. get isLeftCamera(): boolean;
  30747. /** @hidden */
  30748. _isRightCamera: boolean;
  30749. /**
  30750. * Gets the right camera of a rig setup in case of Rigged Camera
  30751. */
  30752. get isRightCamera(): boolean;
  30753. /**
  30754. * Gets the left camera of a rig setup in case of Rigged Camera
  30755. */
  30756. get leftCamera(): Nullable<FreeCamera>;
  30757. /**
  30758. * Gets the right camera of a rig setup in case of Rigged Camera
  30759. */
  30760. get rightCamera(): Nullable<FreeCamera>;
  30761. /**
  30762. * Gets the left camera target of a rig setup in case of Rigged Camera
  30763. * @returns the target position
  30764. */
  30765. getLeftTarget(): Nullable<Vector3>;
  30766. /**
  30767. * Gets the right camera target of a rig setup in case of Rigged Camera
  30768. * @returns the target position
  30769. */
  30770. getRightTarget(): Nullable<Vector3>;
  30771. /**
  30772. * @hidden
  30773. */
  30774. setCameraRigMode(mode: number, rigParams: any): void;
  30775. /** @hidden */
  30776. static _setStereoscopicRigMode(camera: Camera): void;
  30777. /** @hidden */
  30778. static _setStereoscopicAnaglyphRigMode(camera: Camera): void;
  30779. /** @hidden */
  30780. static _setVRRigMode(camera: Camera, rigParams: any): void;
  30781. /** @hidden */
  30782. static _setWebVRRigMode(camera: Camera, rigParams: any): void;
  30783. /** @hidden */
  30784. _getVRProjectionMatrix(): Matrix;
  30785. protected _updateCameraRotationMatrix(): void;
  30786. protected _updateWebVRCameraRotationMatrix(): void;
  30787. /**
  30788. * This function MUST be overwritten by the different WebVR cameras available.
  30789. * The context in which it is running is the RIG camera. So 'this' is the TargetCamera, left or right.
  30790. * @hidden
  30791. */
  30792. _getWebVRProjectionMatrix(): Matrix;
  30793. /**
  30794. * This function MUST be overwritten by the different WebVR cameras available.
  30795. * The context in which it is running is the RIG camera. So 'this' is the TargetCamera, left or right.
  30796. * @hidden
  30797. */
  30798. _getWebVRViewMatrix(): Matrix;
  30799. /** @hidden */
  30800. setCameraRigParameter(name: string, value: any): void;
  30801. /**
  30802. * needs to be overridden by children so sub has required properties to be copied
  30803. * @hidden
  30804. */
  30805. createRigCamera(name: string, cameraIndex: number): Nullable<Camera>;
  30806. /**
  30807. * May need to be overridden by children
  30808. * @hidden
  30809. */
  30810. _updateRigCameras(): void;
  30811. /** @hidden */
  30812. _setupInputs(): void;
  30813. /**
  30814. * Serialiaze the camera setup to a json represention
  30815. * @returns the JSON representation
  30816. */
  30817. serialize(): any;
  30818. /**
  30819. * Clones the current camera.
  30820. * @param name The cloned camera name
  30821. * @returns the cloned camera
  30822. */
  30823. clone(name: string): Camera;
  30824. /**
  30825. * Gets the direction of the camera relative to a given local axis.
  30826. * @param localAxis Defines the reference axis to provide a relative direction.
  30827. * @return the direction
  30828. */
  30829. getDirection(localAxis: Vector3): Vector3;
  30830. /**
  30831. * Returns the current camera absolute rotation
  30832. */
  30833. get absoluteRotation(): Quaternion;
  30834. /**
  30835. * Gets the direction of the camera relative to a given local axis into a passed vector.
  30836. * @param localAxis Defines the reference axis to provide a relative direction.
  30837. * @param result Defines the vector to store the result in
  30838. */
  30839. getDirectionToRef(localAxis: Vector3, result: Vector3): void;
  30840. /**
  30841. * Gets a camera constructor for a given camera type
  30842. * @param type The type of the camera to construct (should be equal to one of the camera class name)
  30843. * @param name The name of the camera the result will be able to instantiate
  30844. * @param scene The scene the result will construct the camera in
  30845. * @param interaxial_distance In case of stereoscopic setup, the distance between both eyes
  30846. * @param isStereoscopicSideBySide In case of stereoscopic setup, should the sereo be side b side
  30847. * @returns a factory method to construc the camera
  30848. */
  30849. static GetConstructorFromName(type: string, name: string, scene: Scene, interaxial_distance?: number, isStereoscopicSideBySide?: boolean): () => Camera;
  30850. /**
  30851. * Compute the world matrix of the camera.
  30852. * @returns the camera world matrix
  30853. */
  30854. computeWorldMatrix(): Matrix;
  30855. /**
  30856. * Parse a JSON and creates the camera from the parsed information
  30857. * @param parsedCamera The JSON to parse
  30858. * @param scene The scene to instantiate the camera in
  30859. * @returns the newly constructed camera
  30860. */
  30861. static Parse(parsedCamera: any, scene: Scene): Camera;
  30862. }
  30863. }
  30864. declare module "babylonjs/Meshes/Builders/discBuilder" {
  30865. import { Nullable } from "babylonjs/types";
  30866. import { Scene } from "babylonjs/scene";
  30867. import { Vector4 } from "babylonjs/Maths/math.vector";
  30868. import { Mesh } from "babylonjs/Meshes/mesh";
  30869. /**
  30870. * Class containing static functions to help procedurally build meshes
  30871. */
  30872. export class DiscBuilder {
  30873. /**
  30874. * Creates a plane polygonal mesh. By default, this is a disc
  30875. * * The parameter `radius` sets the radius size (float) of the polygon (default 0.5)
  30876. * * 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
  30877. * * 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
  30878. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  30879. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  30880. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  30881. * @param name defines the name of the mesh
  30882. * @param options defines the options used to create the mesh
  30883. * @param scene defines the hosting scene
  30884. * @returns the plane polygonal mesh
  30885. * @see https://doc.babylonjs.com/how_to/set_shapes#disc-or-regular-polygon
  30886. */
  30887. static CreateDisc(name: string, options: {
  30888. radius?: number;
  30889. tessellation?: number;
  30890. arc?: number;
  30891. updatable?: boolean;
  30892. sideOrientation?: number;
  30893. frontUVs?: Vector4;
  30894. backUVs?: Vector4;
  30895. }, scene?: Nullable<Scene>): Mesh;
  30896. }
  30897. }
  30898. declare module "babylonjs/Materials/fresnelParameters" {
  30899. import { DeepImmutable } from "babylonjs/types";
  30900. import { Color3 } from "babylonjs/Maths/math.color";
  30901. /**
  30902. * Options to be used when creating a FresnelParameters.
  30903. */
  30904. export type IFresnelParametersCreationOptions = {
  30905. /**
  30906. * Define the color used on edges (grazing angle)
  30907. */
  30908. leftColor?: Color3;
  30909. /**
  30910. * Define the color used on center
  30911. */
  30912. rightColor?: Color3;
  30913. /**
  30914. * Define bias applied to computed fresnel term
  30915. */
  30916. bias?: number;
  30917. /**
  30918. * Defined the power exponent applied to fresnel term
  30919. */
  30920. power?: number;
  30921. /**
  30922. * Define if the fresnel effect is enable or not.
  30923. */
  30924. isEnabled?: boolean;
  30925. };
  30926. /**
  30927. * Serialized format for FresnelParameters.
  30928. */
  30929. export type IFresnelParametersSerialized = {
  30930. /**
  30931. * Define the color used on edges (grazing angle) [as an array]
  30932. */
  30933. leftColor: number[];
  30934. /**
  30935. * Define the color used on center [as an array]
  30936. */
  30937. rightColor: number[];
  30938. /**
  30939. * Define bias applied to computed fresnel term
  30940. */
  30941. bias: number;
  30942. /**
  30943. * Defined the power exponent applied to fresnel term
  30944. */
  30945. power?: number;
  30946. /**
  30947. * Define if the fresnel effect is enable or not.
  30948. */
  30949. isEnabled: boolean;
  30950. };
  30951. /**
  30952. * This represents all the required information to add a fresnel effect on a material:
  30953. * @see https://doc.babylonjs.com/how_to/how_to_use_fresnelparameters
  30954. */
  30955. export class FresnelParameters {
  30956. private _isEnabled;
  30957. /**
  30958. * Define if the fresnel effect is enable or not.
  30959. */
  30960. get isEnabled(): boolean;
  30961. set isEnabled(value: boolean);
  30962. /**
  30963. * Define the color used on edges (grazing angle)
  30964. */
  30965. leftColor: Color3;
  30966. /**
  30967. * Define the color used on center
  30968. */
  30969. rightColor: Color3;
  30970. /**
  30971. * Define bias applied to computed fresnel term
  30972. */
  30973. bias: number;
  30974. /**
  30975. * Defined the power exponent applied to fresnel term
  30976. */
  30977. power: number;
  30978. /**
  30979. * Creates a new FresnelParameters object.
  30980. *
  30981. * @param options provide your own settings to optionally to override defaults
  30982. */
  30983. constructor(options?: IFresnelParametersCreationOptions);
  30984. /**
  30985. * Clones the current fresnel and its valuues
  30986. * @returns a clone fresnel configuration
  30987. */
  30988. clone(): FresnelParameters;
  30989. /**
  30990. * Determines equality between FresnelParameters objects
  30991. * @param otherFresnelParameters defines the second operand
  30992. * @returns true if the power, bias, leftColor, rightColor and isEnabled values are equal to the given ones
  30993. */
  30994. equals(otherFresnelParameters: DeepImmutable<FresnelParameters>): boolean;
  30995. /**
  30996. * Serializes the current fresnel parameters to a JSON representation.
  30997. * @return the JSON serialization
  30998. */
  30999. serialize(): IFresnelParametersSerialized;
  31000. /**
  31001. * Parse a JSON object and deserialize it to a new Fresnel parameter object.
  31002. * @param parsedFresnelParameters Define the JSON representation
  31003. * @returns the parsed parameters
  31004. */
  31005. static Parse(parsedFresnelParameters: IFresnelParametersSerialized): FresnelParameters;
  31006. }
  31007. }
  31008. declare module "babylonjs/Materials/materialFlags" {
  31009. /**
  31010. * This groups all the flags used to control the materials channel.
  31011. */
  31012. export class MaterialFlags {
  31013. private static _DiffuseTextureEnabled;
  31014. /**
  31015. * Are diffuse textures enabled in the application.
  31016. */
  31017. static get DiffuseTextureEnabled(): boolean;
  31018. static set DiffuseTextureEnabled(value: boolean);
  31019. private static _DetailTextureEnabled;
  31020. /**
  31021. * Are detail textures enabled in the application.
  31022. */
  31023. static get DetailTextureEnabled(): boolean;
  31024. static set DetailTextureEnabled(value: boolean);
  31025. private static _AmbientTextureEnabled;
  31026. /**
  31027. * Are ambient textures enabled in the application.
  31028. */
  31029. static get AmbientTextureEnabled(): boolean;
  31030. static set AmbientTextureEnabled(value: boolean);
  31031. private static _OpacityTextureEnabled;
  31032. /**
  31033. * Are opacity textures enabled in the application.
  31034. */
  31035. static get OpacityTextureEnabled(): boolean;
  31036. static set OpacityTextureEnabled(value: boolean);
  31037. private static _ReflectionTextureEnabled;
  31038. /**
  31039. * Are reflection textures enabled in the application.
  31040. */
  31041. static get ReflectionTextureEnabled(): boolean;
  31042. static set ReflectionTextureEnabled(value: boolean);
  31043. private static _EmissiveTextureEnabled;
  31044. /**
  31045. * Are emissive textures enabled in the application.
  31046. */
  31047. static get EmissiveTextureEnabled(): boolean;
  31048. static set EmissiveTextureEnabled(value: boolean);
  31049. private static _SpecularTextureEnabled;
  31050. /**
  31051. * Are specular textures enabled in the application.
  31052. */
  31053. static get SpecularTextureEnabled(): boolean;
  31054. static set SpecularTextureEnabled(value: boolean);
  31055. private static _BumpTextureEnabled;
  31056. /**
  31057. * Are bump textures enabled in the application.
  31058. */
  31059. static get BumpTextureEnabled(): boolean;
  31060. static set BumpTextureEnabled(value: boolean);
  31061. private static _LightmapTextureEnabled;
  31062. /**
  31063. * Are lightmap textures enabled in the application.
  31064. */
  31065. static get LightmapTextureEnabled(): boolean;
  31066. static set LightmapTextureEnabled(value: boolean);
  31067. private static _RefractionTextureEnabled;
  31068. /**
  31069. * Are refraction textures enabled in the application.
  31070. */
  31071. static get RefractionTextureEnabled(): boolean;
  31072. static set RefractionTextureEnabled(value: boolean);
  31073. private static _ColorGradingTextureEnabled;
  31074. /**
  31075. * Are color grading textures enabled in the application.
  31076. */
  31077. static get ColorGradingTextureEnabled(): boolean;
  31078. static set ColorGradingTextureEnabled(value: boolean);
  31079. private static _FresnelEnabled;
  31080. /**
  31081. * Are fresnels enabled in the application.
  31082. */
  31083. static get FresnelEnabled(): boolean;
  31084. static set FresnelEnabled(value: boolean);
  31085. private static _ClearCoatTextureEnabled;
  31086. /**
  31087. * Are clear coat textures enabled in the application.
  31088. */
  31089. static get ClearCoatTextureEnabled(): boolean;
  31090. static set ClearCoatTextureEnabled(value: boolean);
  31091. private static _ClearCoatBumpTextureEnabled;
  31092. /**
  31093. * Are clear coat bump textures enabled in the application.
  31094. */
  31095. static get ClearCoatBumpTextureEnabled(): boolean;
  31096. static set ClearCoatBumpTextureEnabled(value: boolean);
  31097. private static _ClearCoatTintTextureEnabled;
  31098. /**
  31099. * Are clear coat tint textures enabled in the application.
  31100. */
  31101. static get ClearCoatTintTextureEnabled(): boolean;
  31102. static set ClearCoatTintTextureEnabled(value: boolean);
  31103. private static _SheenTextureEnabled;
  31104. /**
  31105. * Are sheen textures enabled in the application.
  31106. */
  31107. static get SheenTextureEnabled(): boolean;
  31108. static set SheenTextureEnabled(value: boolean);
  31109. private static _AnisotropicTextureEnabled;
  31110. /**
  31111. * Are anisotropic textures enabled in the application.
  31112. */
  31113. static get AnisotropicTextureEnabled(): boolean;
  31114. static set AnisotropicTextureEnabled(value: boolean);
  31115. private static _ThicknessTextureEnabled;
  31116. /**
  31117. * Are thickness textures enabled in the application.
  31118. */
  31119. static get ThicknessTextureEnabled(): boolean;
  31120. static set ThicknessTextureEnabled(value: boolean);
  31121. }
  31122. }
  31123. declare module "babylonjs/Shaders/ShadersInclude/defaultFragmentDeclaration" {
  31124. /** @hidden */
  31125. export var defaultFragmentDeclaration: {
  31126. name: string;
  31127. shader: string;
  31128. };
  31129. }
  31130. declare module "babylonjs/Shaders/ShadersInclude/defaultUboDeclaration" {
  31131. /** @hidden */
  31132. export var defaultUboDeclaration: {
  31133. name: string;
  31134. shader: string;
  31135. };
  31136. }
  31137. declare module "babylonjs/Shaders/ShadersInclude/prePassDeclaration" {
  31138. /** @hidden */
  31139. export var prePassDeclaration: {
  31140. name: string;
  31141. shader: string;
  31142. };
  31143. }
  31144. declare module "babylonjs/Shaders/ShadersInclude/lightFragmentDeclaration" {
  31145. /** @hidden */
  31146. export var lightFragmentDeclaration: {
  31147. name: string;
  31148. shader: string;
  31149. };
  31150. }
  31151. declare module "babylonjs/Shaders/ShadersInclude/lightUboDeclaration" {
  31152. /** @hidden */
  31153. export var lightUboDeclaration: {
  31154. name: string;
  31155. shader: string;
  31156. };
  31157. }
  31158. declare module "babylonjs/Shaders/ShadersInclude/lightsFragmentFunctions" {
  31159. /** @hidden */
  31160. export var lightsFragmentFunctions: {
  31161. name: string;
  31162. shader: string;
  31163. };
  31164. }
  31165. declare module "babylonjs/Shaders/ShadersInclude/shadowsFragmentFunctions" {
  31166. /** @hidden */
  31167. export var shadowsFragmentFunctions: {
  31168. name: string;
  31169. shader: string;
  31170. };
  31171. }
  31172. declare module "babylonjs/Shaders/ShadersInclude/fresnelFunction" {
  31173. /** @hidden */
  31174. export var fresnelFunction: {
  31175. name: string;
  31176. shader: string;
  31177. };
  31178. }
  31179. declare module "babylonjs/Shaders/ShadersInclude/bumpFragmentMainFunctions" {
  31180. /** @hidden */
  31181. export var bumpFragmentMainFunctions: {
  31182. name: string;
  31183. shader: string;
  31184. };
  31185. }
  31186. declare module "babylonjs/Shaders/ShadersInclude/bumpFragmentFunctions" {
  31187. /** @hidden */
  31188. export var bumpFragmentFunctions: {
  31189. name: string;
  31190. shader: string;
  31191. };
  31192. }
  31193. declare module "babylonjs/Shaders/ShadersInclude/logDepthDeclaration" {
  31194. /** @hidden */
  31195. export var logDepthDeclaration: {
  31196. name: string;
  31197. shader: string;
  31198. };
  31199. }
  31200. declare module "babylonjs/Shaders/ShadersInclude/bumpFragment" {
  31201. /** @hidden */
  31202. export var bumpFragment: {
  31203. name: string;
  31204. shader: string;
  31205. };
  31206. }
  31207. declare module "babylonjs/Shaders/ShadersInclude/depthPrePass" {
  31208. /** @hidden */
  31209. export var depthPrePass: {
  31210. name: string;
  31211. shader: string;
  31212. };
  31213. }
  31214. declare module "babylonjs/Shaders/ShadersInclude/lightFragment" {
  31215. /** @hidden */
  31216. export var lightFragment: {
  31217. name: string;
  31218. shader: string;
  31219. };
  31220. }
  31221. declare module "babylonjs/Shaders/ShadersInclude/logDepthFragment" {
  31222. /** @hidden */
  31223. export var logDepthFragment: {
  31224. name: string;
  31225. shader: string;
  31226. };
  31227. }
  31228. declare module "babylonjs/Shaders/default.fragment" {
  31229. import "babylonjs/Shaders/ShadersInclude/defaultFragmentDeclaration";
  31230. import "babylonjs/Shaders/ShadersInclude/defaultUboDeclaration";
  31231. import "babylonjs/Shaders/ShadersInclude/prePassDeclaration";
  31232. import "babylonjs/Shaders/ShadersInclude/helperFunctions";
  31233. import "babylonjs/Shaders/ShadersInclude/lightFragmentDeclaration";
  31234. import "babylonjs/Shaders/ShadersInclude/lightUboDeclaration";
  31235. import "babylonjs/Shaders/ShadersInclude/lightsFragmentFunctions";
  31236. import "babylonjs/Shaders/ShadersInclude/shadowsFragmentFunctions";
  31237. import "babylonjs/Shaders/ShadersInclude/fresnelFunction";
  31238. import "babylonjs/Shaders/ShadersInclude/reflectionFunction";
  31239. import "babylonjs/Shaders/ShadersInclude/imageProcessingDeclaration";
  31240. import "babylonjs/Shaders/ShadersInclude/imageProcessingFunctions";
  31241. import "babylonjs/Shaders/ShadersInclude/bumpFragmentMainFunctions";
  31242. import "babylonjs/Shaders/ShadersInclude/bumpFragmentFunctions";
  31243. import "babylonjs/Shaders/ShadersInclude/clipPlaneFragmentDeclaration";
  31244. import "babylonjs/Shaders/ShadersInclude/logDepthDeclaration";
  31245. import "babylonjs/Shaders/ShadersInclude/fogFragmentDeclaration";
  31246. import "babylonjs/Shaders/ShadersInclude/clipPlaneFragment";
  31247. import "babylonjs/Shaders/ShadersInclude/bumpFragment";
  31248. import "babylonjs/Shaders/ShadersInclude/depthPrePass";
  31249. import "babylonjs/Shaders/ShadersInclude/lightFragment";
  31250. import "babylonjs/Shaders/ShadersInclude/logDepthFragment";
  31251. import "babylonjs/Shaders/ShadersInclude/fogFragment";
  31252. /** @hidden */
  31253. export var defaultPixelShader: {
  31254. name: string;
  31255. shader: string;
  31256. };
  31257. }
  31258. declare module "babylonjs/Shaders/ShadersInclude/defaultVertexDeclaration" {
  31259. /** @hidden */
  31260. export var defaultVertexDeclaration: {
  31261. name: string;
  31262. shader: string;
  31263. };
  31264. }
  31265. declare module "babylonjs/Shaders/ShadersInclude/bumpVertexDeclaration" {
  31266. /** @hidden */
  31267. export var bumpVertexDeclaration: {
  31268. name: string;
  31269. shader: string;
  31270. };
  31271. }
  31272. declare module "babylonjs/Shaders/ShadersInclude/bumpVertex" {
  31273. /** @hidden */
  31274. export var bumpVertex: {
  31275. name: string;
  31276. shader: string;
  31277. };
  31278. }
  31279. declare module "babylonjs/Shaders/ShadersInclude/fogVertex" {
  31280. /** @hidden */
  31281. export var fogVertex: {
  31282. name: string;
  31283. shader: string;
  31284. };
  31285. }
  31286. declare module "babylonjs/Shaders/ShadersInclude/shadowsVertex" {
  31287. /** @hidden */
  31288. export var shadowsVertex: {
  31289. name: string;
  31290. shader: string;
  31291. };
  31292. }
  31293. declare module "babylonjs/Shaders/ShadersInclude/pointCloudVertex" {
  31294. /** @hidden */
  31295. export var pointCloudVertex: {
  31296. name: string;
  31297. shader: string;
  31298. };
  31299. }
  31300. declare module "babylonjs/Shaders/ShadersInclude/logDepthVertex" {
  31301. /** @hidden */
  31302. export var logDepthVertex: {
  31303. name: string;
  31304. shader: string;
  31305. };
  31306. }
  31307. declare module "babylonjs/Shaders/default.vertex" {
  31308. import "babylonjs/Shaders/ShadersInclude/defaultVertexDeclaration";
  31309. import "babylonjs/Shaders/ShadersInclude/defaultUboDeclaration";
  31310. import "babylonjs/Shaders/ShadersInclude/helperFunctions";
  31311. import "babylonjs/Shaders/ShadersInclude/bonesDeclaration";
  31312. import "babylonjs/Shaders/ShadersInclude/instancesDeclaration";
  31313. import "babylonjs/Shaders/ShadersInclude/bumpVertexDeclaration";
  31314. import "babylonjs/Shaders/ShadersInclude/clipPlaneVertexDeclaration";
  31315. import "babylonjs/Shaders/ShadersInclude/fogVertexDeclaration";
  31316. import "babylonjs/Shaders/ShadersInclude/lightFragmentDeclaration";
  31317. import "babylonjs/Shaders/ShadersInclude/lightUboDeclaration";
  31318. import "babylonjs/Shaders/ShadersInclude/morphTargetsVertexGlobalDeclaration";
  31319. import "babylonjs/Shaders/ShadersInclude/morphTargetsVertexDeclaration";
  31320. import "babylonjs/Shaders/ShadersInclude/logDepthDeclaration";
  31321. import "babylonjs/Shaders/ShadersInclude/morphTargetsVertex";
  31322. import "babylonjs/Shaders/ShadersInclude/instancesVertex";
  31323. import "babylonjs/Shaders/ShadersInclude/bonesVertex";
  31324. import "babylonjs/Shaders/ShadersInclude/bumpVertex";
  31325. import "babylonjs/Shaders/ShadersInclude/clipPlaneVertex";
  31326. import "babylonjs/Shaders/ShadersInclude/fogVertex";
  31327. import "babylonjs/Shaders/ShadersInclude/shadowsVertex";
  31328. import "babylonjs/Shaders/ShadersInclude/pointCloudVertex";
  31329. import "babylonjs/Shaders/ShadersInclude/logDepthVertex";
  31330. /** @hidden */
  31331. export var defaultVertexShader: {
  31332. name: string;
  31333. shader: string;
  31334. };
  31335. }
  31336. declare module "babylonjs/Materials/material.detailMapConfiguration" {
  31337. import { Nullable } from "babylonjs/types";
  31338. import { Scene } from "babylonjs/scene";
  31339. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  31340. import { UniformBuffer } from "babylonjs/Materials/uniformBuffer";
  31341. import { IAnimatable } from "babylonjs/Animations/animatable.interface";
  31342. /**
  31343. * @hidden
  31344. */
  31345. export interface IMaterialDetailMapDefines {
  31346. DETAIL: boolean;
  31347. DETAILDIRECTUV: number;
  31348. DETAIL_NORMALBLENDMETHOD: number;
  31349. /** @hidden */
  31350. _areTexturesDirty: boolean;
  31351. }
  31352. /**
  31353. * Define the code related to the detail map parameters of a material
  31354. *
  31355. * Inspired from:
  31356. * 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
  31357. * Unreal: https://docs.unrealengine.com/en-US/Engine/Rendering/Materials/HowTo/DetailTexturing/index.html
  31358. * Cryengine: https://docs.cryengine.com/display/SDKDOC2/Detail+Maps
  31359. */
  31360. export class DetailMapConfiguration {
  31361. private _texture;
  31362. /**
  31363. * The detail texture of the material.
  31364. */
  31365. texture: Nullable<BaseTexture>;
  31366. /**
  31367. * Defines how strongly the detail diffuse/albedo channel is blended with the regular diffuse/albedo texture
  31368. * Bigger values mean stronger blending
  31369. */
  31370. diffuseBlendLevel: number;
  31371. /**
  31372. * Defines how strongly the detail roughness channel is blended with the regular roughness value
  31373. * Bigger values mean stronger blending. Only used with PBR materials
  31374. */
  31375. roughnessBlendLevel: number;
  31376. /**
  31377. * Defines how strong the bump effect from the detail map is
  31378. * Bigger values mean stronger effect
  31379. */
  31380. bumpLevel: number;
  31381. private _normalBlendMethod;
  31382. /**
  31383. * The method used to blend the bump and detail normals together
  31384. */
  31385. normalBlendMethod: number;
  31386. private _isEnabled;
  31387. /**
  31388. * Enable or disable the detail map on this material
  31389. */
  31390. isEnabled: boolean;
  31391. /** @hidden */
  31392. private _internalMarkAllSubMeshesAsTexturesDirty;
  31393. /** @hidden */
  31394. _markAllSubMeshesAsTexturesDirty(): void;
  31395. /**
  31396. * Instantiate a new detail map
  31397. * @param markAllSubMeshesAsTexturesDirty Callback to flag the material to dirty
  31398. */
  31399. constructor(markAllSubMeshesAsTexturesDirty: () => void);
  31400. /**
  31401. * Gets whether the submesh is ready to be used or not.
  31402. * @param defines the list of "defines" to update.
  31403. * @param scene defines the scene the material belongs to.
  31404. * @returns - boolean indicating that the submesh is ready or not.
  31405. */
  31406. isReadyForSubMesh(defines: IMaterialDetailMapDefines, scene: Scene): boolean;
  31407. /**
  31408. * Update the defines for detail map usage
  31409. * @param defines the list of "defines" to update.
  31410. * @param scene defines the scene the material belongs to.
  31411. */
  31412. prepareDefines(defines: IMaterialDetailMapDefines, scene: Scene): void;
  31413. /**
  31414. * Binds the material data.
  31415. * @param uniformBuffer defines the Uniform buffer to fill in.
  31416. * @param scene defines the scene the material belongs to.
  31417. * @param isFrozen defines whether the material is frozen or not.
  31418. */
  31419. bindForSubMesh(uniformBuffer: UniformBuffer, scene: Scene, isFrozen: boolean): void;
  31420. /**
  31421. * Checks to see if a texture is used in the material.
  31422. * @param texture - Base texture to use.
  31423. * @returns - Boolean specifying if a texture is used in the material.
  31424. */
  31425. hasTexture(texture: BaseTexture): boolean;
  31426. /**
  31427. * Returns an array of the actively used textures.
  31428. * @param activeTextures Array of BaseTextures
  31429. */
  31430. getActiveTextures(activeTextures: BaseTexture[]): void;
  31431. /**
  31432. * Returns the animatable textures.
  31433. * @param animatables Array of animatable textures.
  31434. */
  31435. getAnimatables(animatables: IAnimatable[]): void;
  31436. /**
  31437. * Disposes the resources of the material.
  31438. * @param forceDisposeTextures - Forces the disposal of all textures.
  31439. */
  31440. dispose(forceDisposeTextures?: boolean): void;
  31441. /**
  31442. * Get the current class name useful for serialization or dynamic coding.
  31443. * @returns "DetailMap"
  31444. */
  31445. getClassName(): string;
  31446. /**
  31447. * Add the required uniforms to the current list.
  31448. * @param uniforms defines the current uniform list.
  31449. */
  31450. static AddUniforms(uniforms: string[]): void;
  31451. /**
  31452. * Add the required samplers to the current list.
  31453. * @param samplers defines the current sampler list.
  31454. */
  31455. static AddSamplers(samplers: string[]): void;
  31456. /**
  31457. * Add the required uniforms to the current buffer.
  31458. * @param uniformBuffer defines the current uniform buffer.
  31459. */
  31460. static PrepareUniformBuffer(uniformBuffer: UniformBuffer): void;
  31461. /**
  31462. * Makes a duplicate of the current instance into another one.
  31463. * @param detailMap define the instance where to copy the info
  31464. */
  31465. copyTo(detailMap: DetailMapConfiguration): void;
  31466. /**
  31467. * Serializes this detail map instance
  31468. * @returns - An object with the serialized instance.
  31469. */
  31470. serialize(): any;
  31471. /**
  31472. * Parses a detail map setting from a serialized object.
  31473. * @param source - Serialized object.
  31474. * @param scene Defines the scene we are parsing for
  31475. * @param rootUrl Defines the rootUrl to load from
  31476. */
  31477. parse(source: any, scene: Scene, rootUrl: string): void;
  31478. }
  31479. }
  31480. declare module "babylonjs/Materials/standardMaterial" {
  31481. import { SmartArray } from "babylonjs/Misc/smartArray";
  31482. import { IAnimatable } from "babylonjs/Animations/animatable.interface";
  31483. import { Nullable } from "babylonjs/types";
  31484. import { Scene } from "babylonjs/scene";
  31485. import { Matrix } from "babylonjs/Maths/math.vector";
  31486. import { Color3 } from "babylonjs/Maths/math.color";
  31487. import { SubMesh } from "babylonjs/Meshes/subMesh";
  31488. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  31489. import { Mesh } from "babylonjs/Meshes/mesh";
  31490. import { ImageProcessingConfiguration, IImageProcessingConfigurationDefines } from "babylonjs/Materials/imageProcessingConfiguration";
  31491. import { ColorCurves } from "babylonjs/Materials/colorCurves";
  31492. import { FresnelParameters } from "babylonjs/Materials/fresnelParameters";
  31493. import { MaterialDefines } from "babylonjs/Materials/materialDefines";
  31494. import { PushMaterial } from "babylonjs/Materials/pushMaterial";
  31495. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  31496. import { RenderTargetTexture } from "babylonjs/Materials/Textures/renderTargetTexture";
  31497. import "babylonjs/Shaders/default.fragment";
  31498. import "babylonjs/Shaders/default.vertex";
  31499. import { IMaterialDetailMapDefines, DetailMapConfiguration } from "babylonjs/Materials/material.detailMapConfiguration";
  31500. /** @hidden */
  31501. export class StandardMaterialDefines extends MaterialDefines implements IImageProcessingConfigurationDefines, IMaterialDetailMapDefines {
  31502. MAINUV1: boolean;
  31503. MAINUV2: boolean;
  31504. DIFFUSE: boolean;
  31505. DIFFUSEDIRECTUV: number;
  31506. DETAIL: boolean;
  31507. DETAILDIRECTUV: number;
  31508. DETAIL_NORMALBLENDMETHOD: number;
  31509. AMBIENT: boolean;
  31510. AMBIENTDIRECTUV: number;
  31511. OPACITY: boolean;
  31512. OPACITYDIRECTUV: number;
  31513. OPACITYRGB: boolean;
  31514. REFLECTION: boolean;
  31515. EMISSIVE: boolean;
  31516. EMISSIVEDIRECTUV: number;
  31517. SPECULAR: boolean;
  31518. SPECULARDIRECTUV: number;
  31519. BUMP: boolean;
  31520. BUMPDIRECTUV: number;
  31521. PARALLAX: boolean;
  31522. PARALLAXOCCLUSION: boolean;
  31523. SPECULAROVERALPHA: boolean;
  31524. CLIPPLANE: boolean;
  31525. CLIPPLANE2: boolean;
  31526. CLIPPLANE3: boolean;
  31527. CLIPPLANE4: boolean;
  31528. CLIPPLANE5: boolean;
  31529. CLIPPLANE6: boolean;
  31530. ALPHATEST: boolean;
  31531. DEPTHPREPASS: boolean;
  31532. ALPHAFROMDIFFUSE: boolean;
  31533. POINTSIZE: boolean;
  31534. FOG: boolean;
  31535. SPECULARTERM: boolean;
  31536. DIFFUSEFRESNEL: boolean;
  31537. OPACITYFRESNEL: boolean;
  31538. REFLECTIONFRESNEL: boolean;
  31539. REFRACTIONFRESNEL: boolean;
  31540. EMISSIVEFRESNEL: boolean;
  31541. FRESNEL: boolean;
  31542. NORMAL: boolean;
  31543. UV1: boolean;
  31544. UV2: boolean;
  31545. VERTEXCOLOR: boolean;
  31546. VERTEXALPHA: boolean;
  31547. NUM_BONE_INFLUENCERS: number;
  31548. BonesPerMesh: number;
  31549. BONETEXTURE: boolean;
  31550. INSTANCES: boolean;
  31551. THIN_INSTANCES: boolean;
  31552. GLOSSINESS: boolean;
  31553. ROUGHNESS: boolean;
  31554. EMISSIVEASILLUMINATION: boolean;
  31555. LINKEMISSIVEWITHDIFFUSE: boolean;
  31556. REFLECTIONFRESNELFROMSPECULAR: boolean;
  31557. LIGHTMAP: boolean;
  31558. LIGHTMAPDIRECTUV: number;
  31559. OBJECTSPACE_NORMALMAP: boolean;
  31560. USELIGHTMAPASSHADOWMAP: boolean;
  31561. REFLECTIONMAP_3D: boolean;
  31562. REFLECTIONMAP_SPHERICAL: boolean;
  31563. REFLECTIONMAP_PLANAR: boolean;
  31564. REFLECTIONMAP_CUBIC: boolean;
  31565. USE_LOCAL_REFLECTIONMAP_CUBIC: boolean;
  31566. REFLECTIONMAP_PROJECTION: boolean;
  31567. REFLECTIONMAP_SKYBOX: boolean;
  31568. REFLECTIONMAP_EXPLICIT: boolean;
  31569. REFLECTIONMAP_EQUIRECTANGULAR: boolean;
  31570. REFLECTIONMAP_EQUIRECTANGULAR_FIXED: boolean;
  31571. REFLECTIONMAP_MIRROREDEQUIRECTANGULAR_FIXED: boolean;
  31572. INVERTCUBICMAP: boolean;
  31573. LOGARITHMICDEPTH: boolean;
  31574. REFRACTION: boolean;
  31575. REFRACTIONMAP_3D: boolean;
  31576. REFLECTIONOVERALPHA: boolean;
  31577. TWOSIDEDLIGHTING: boolean;
  31578. SHADOWFLOAT: boolean;
  31579. MORPHTARGETS: boolean;
  31580. MORPHTARGETS_NORMAL: boolean;
  31581. MORPHTARGETS_TANGENT: boolean;
  31582. MORPHTARGETS_UV: boolean;
  31583. NUM_MORPH_INFLUENCERS: number;
  31584. NONUNIFORMSCALING: boolean;
  31585. PREMULTIPLYALPHA: boolean;
  31586. ALPHATEST_AFTERALLALPHACOMPUTATIONS: boolean;
  31587. ALPHABLEND: boolean;
  31588. PREPASS: boolean;
  31589. SCENE_MRT_COUNT: number;
  31590. RGBDLIGHTMAP: boolean;
  31591. RGBDREFLECTION: boolean;
  31592. RGBDREFRACTION: boolean;
  31593. IMAGEPROCESSING: boolean;
  31594. VIGNETTE: boolean;
  31595. VIGNETTEBLENDMODEMULTIPLY: boolean;
  31596. VIGNETTEBLENDMODEOPAQUE: boolean;
  31597. TONEMAPPING: boolean;
  31598. TONEMAPPING_ACES: boolean;
  31599. CONTRAST: boolean;
  31600. COLORCURVES: boolean;
  31601. COLORGRADING: boolean;
  31602. COLORGRADING3D: boolean;
  31603. SAMPLER3DGREENDEPTH: boolean;
  31604. SAMPLER3DBGRMAP: boolean;
  31605. IMAGEPROCESSINGPOSTPROCESS: boolean;
  31606. MULTIVIEW: boolean;
  31607. /**
  31608. * If the reflection texture on this material is in linear color space
  31609. * @hidden
  31610. */
  31611. IS_REFLECTION_LINEAR: boolean;
  31612. /**
  31613. * If the refraction texture on this material is in linear color space
  31614. * @hidden
  31615. */
  31616. IS_REFRACTION_LINEAR: boolean;
  31617. EXPOSURE: boolean;
  31618. constructor();
  31619. setReflectionMode(modeToEnable: string): void;
  31620. }
  31621. /**
  31622. * This is the default material used in Babylon. It is the best trade off between quality
  31623. * and performances.
  31624. * @see https://doc.babylonjs.com/babylon101/materials
  31625. */
  31626. export class StandardMaterial extends PushMaterial {
  31627. private _diffuseTexture;
  31628. /**
  31629. * The basic texture of the material as viewed under a light.
  31630. */
  31631. diffuseTexture: Nullable<BaseTexture>;
  31632. private _ambientTexture;
  31633. /**
  31634. * AKA Occlusion Texture in other nomenclature, it helps adding baked shadows into your material.
  31635. */
  31636. ambientTexture: Nullable<BaseTexture>;
  31637. private _opacityTexture;
  31638. /**
  31639. * Define the transparency of the material from a texture.
  31640. * The final alpha value can be read either from the red channel (if texture.getAlphaFromRGB is false)
  31641. * or from the luminance or the current texel (if texture.getAlphaFromRGB is true)
  31642. */
  31643. opacityTexture: Nullable<BaseTexture>;
  31644. private _reflectionTexture;
  31645. /**
  31646. * Define the texture used to display the reflection.
  31647. * @see https://doc.babylonjs.com/how_to/reflect#how-to-obtain-reflections-and-refractions
  31648. */
  31649. reflectionTexture: Nullable<BaseTexture>;
  31650. private _emissiveTexture;
  31651. /**
  31652. * Define texture of the material as if self lit.
  31653. * This will be mixed in the final result even in the absence of light.
  31654. */
  31655. emissiveTexture: Nullable<BaseTexture>;
  31656. private _specularTexture;
  31657. /**
  31658. * Define how the color and intensity of the highlight given by the light in the material.
  31659. */
  31660. specularTexture: Nullable<BaseTexture>;
  31661. private _bumpTexture;
  31662. /**
  31663. * Bump mapping is a technique to simulate bump and dents on a rendered surface.
  31664. * 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.
  31665. * @see https://doc.babylonjs.com/how_to/more_materials#bump-map
  31666. */
  31667. bumpTexture: Nullable<BaseTexture>;
  31668. private _lightmapTexture;
  31669. /**
  31670. * Complex lighting can be computationally expensive to compute at runtime.
  31671. * To save on computation, lightmaps may be used to store calculated lighting in a texture which will be applied to a given mesh.
  31672. * @see https://doc.babylonjs.com/babylon101/lights#lightmaps
  31673. */
  31674. lightmapTexture: Nullable<BaseTexture>;
  31675. private _refractionTexture;
  31676. /**
  31677. * Define the texture used to display the refraction.
  31678. * @see https://doc.babylonjs.com/how_to/reflect#how-to-obtain-reflections-and-refractions
  31679. */
  31680. refractionTexture: Nullable<BaseTexture>;
  31681. /**
  31682. * The color of the material lit by the environmental background lighting.
  31683. * @see https://doc.babylonjs.com/babylon101/materials#ambient-color-example
  31684. */
  31685. ambientColor: Color3;
  31686. /**
  31687. * The basic color of the material as viewed under a light.
  31688. */
  31689. diffuseColor: Color3;
  31690. /**
  31691. * Define how the color and intensity of the highlight given by the light in the material.
  31692. */
  31693. specularColor: Color3;
  31694. /**
  31695. * Define the color of the material as if self lit.
  31696. * This will be mixed in the final result even in the absence of light.
  31697. */
  31698. emissiveColor: Color3;
  31699. /**
  31700. * Defines how sharp are the highlights in the material.
  31701. * The bigger the value the sharper giving a more glossy feeling to the result.
  31702. * Reversely, the smaller the value the blurrier giving a more rough feeling to the result.
  31703. */
  31704. specularPower: number;
  31705. private _useAlphaFromDiffuseTexture;
  31706. /**
  31707. * Does the transparency come from the diffuse texture alpha channel.
  31708. */
  31709. useAlphaFromDiffuseTexture: boolean;
  31710. private _useEmissiveAsIllumination;
  31711. /**
  31712. * If true, the emissive value is added into the end result, otherwise it is multiplied in.
  31713. */
  31714. useEmissiveAsIllumination: boolean;
  31715. private _linkEmissiveWithDiffuse;
  31716. /**
  31717. * If true, some kind of energy conservation will prevent the end result to be more than 1 by reducing
  31718. * the emissive level when the final color is close to one.
  31719. */
  31720. linkEmissiveWithDiffuse: boolean;
  31721. private _useSpecularOverAlpha;
  31722. /**
  31723. * Specifies that the material will keep the specular highlights over a transparent surface (only the most limunous ones).
  31724. * A car glass is a good exemple of that. When sun reflects on it you can not see what is behind.
  31725. */
  31726. useSpecularOverAlpha: boolean;
  31727. private _useReflectionOverAlpha;
  31728. /**
  31729. * Specifies that the material will keeps the reflection highlights over a transparent surface (only the most limunous ones).
  31730. * A car glass is a good exemple of that. When the street lights reflects on it you can not see what is behind.
  31731. */
  31732. useReflectionOverAlpha: boolean;
  31733. private _disableLighting;
  31734. /**
  31735. * Does lights from the scene impacts this material.
  31736. * It can be a nice trick for performance to disable lighting on a fully emissive material.
  31737. */
  31738. disableLighting: boolean;
  31739. private _useObjectSpaceNormalMap;
  31740. /**
  31741. * Allows using an object space normal map (instead of tangent space).
  31742. */
  31743. useObjectSpaceNormalMap: boolean;
  31744. private _useParallax;
  31745. /**
  31746. * Is parallax enabled or not.
  31747. * @see https://doc.babylonjs.com/how_to/using_parallax_mapping
  31748. */
  31749. useParallax: boolean;
  31750. private _useParallaxOcclusion;
  31751. /**
  31752. * Is parallax occlusion enabled or not.
  31753. * If true, the outcome is way more realistic than traditional Parallax but you can expect a performance hit that worthes consideration.
  31754. * @see https://doc.babylonjs.com/how_to/using_parallax_mapping
  31755. */
  31756. useParallaxOcclusion: boolean;
  31757. /**
  31758. * 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.
  31759. */
  31760. parallaxScaleBias: number;
  31761. private _roughness;
  31762. /**
  31763. * Helps to define how blurry the reflections should appears in the material.
  31764. */
  31765. roughness: number;
  31766. /**
  31767. * In case of refraction, define the value of the index of refraction.
  31768. * @see https://doc.babylonjs.com/how_to/reflect#how-to-obtain-reflections-and-refractions
  31769. */
  31770. indexOfRefraction: number;
  31771. /**
  31772. * Invert the refraction texture alongside the y axis.
  31773. * It can be useful with procedural textures or probe for instance.
  31774. * @see https://doc.babylonjs.com/how_to/reflect#how-to-obtain-reflections-and-refractions
  31775. */
  31776. invertRefractionY: boolean;
  31777. /**
  31778. * Defines the alpha limits in alpha test mode.
  31779. */
  31780. alphaCutOff: number;
  31781. private _useLightmapAsShadowmap;
  31782. /**
  31783. * In case of light mapping, define whether the map contains light or shadow informations.
  31784. */
  31785. useLightmapAsShadowmap: boolean;
  31786. private _diffuseFresnelParameters;
  31787. /**
  31788. * Define the diffuse fresnel parameters of the material.
  31789. * @see https://doc.babylonjs.com/how_to/how_to_use_fresnelparameters
  31790. */
  31791. diffuseFresnelParameters: FresnelParameters;
  31792. private _opacityFresnelParameters;
  31793. /**
  31794. * Define the opacity fresnel parameters of the material.
  31795. * @see https://doc.babylonjs.com/how_to/how_to_use_fresnelparameters
  31796. */
  31797. opacityFresnelParameters: FresnelParameters;
  31798. private _reflectionFresnelParameters;
  31799. /**
  31800. * Define the reflection fresnel parameters of the material.
  31801. * @see https://doc.babylonjs.com/how_to/how_to_use_fresnelparameters
  31802. */
  31803. reflectionFresnelParameters: FresnelParameters;
  31804. private _refractionFresnelParameters;
  31805. /**
  31806. * Define the refraction fresnel parameters of the material.
  31807. * @see https://doc.babylonjs.com/how_to/how_to_use_fresnelparameters
  31808. */
  31809. refractionFresnelParameters: FresnelParameters;
  31810. private _emissiveFresnelParameters;
  31811. /**
  31812. * Define the emissive fresnel parameters of the material.
  31813. * @see https://doc.babylonjs.com/how_to/how_to_use_fresnelparameters
  31814. */
  31815. emissiveFresnelParameters: FresnelParameters;
  31816. private _useReflectionFresnelFromSpecular;
  31817. /**
  31818. * If true automatically deducts the fresnels values from the material specularity.
  31819. * @see https://doc.babylonjs.com/how_to/how_to_use_fresnelparameters
  31820. */
  31821. useReflectionFresnelFromSpecular: boolean;
  31822. private _useGlossinessFromSpecularMapAlpha;
  31823. /**
  31824. * Defines if the glossiness/roughness of the material should be read from the specular map alpha channel
  31825. */
  31826. useGlossinessFromSpecularMapAlpha: boolean;
  31827. private _maxSimultaneousLights;
  31828. /**
  31829. * Defines the maximum number of lights that can be used in the material
  31830. */
  31831. maxSimultaneousLights: number;
  31832. private _invertNormalMapX;
  31833. /**
  31834. * If sets to true, x component of normal map value will invert (x = 1.0 - x).
  31835. */
  31836. invertNormalMapX: boolean;
  31837. private _invertNormalMapY;
  31838. /**
  31839. * If sets to true, y component of normal map value will invert (y = 1.0 - y).
  31840. */
  31841. invertNormalMapY: boolean;
  31842. private _twoSidedLighting;
  31843. /**
  31844. * If sets to true and backfaceCulling is false, normals will be flipped on the backside.
  31845. */
  31846. twoSidedLighting: boolean;
  31847. /**
  31848. * Default configuration related to image processing available in the standard Material.
  31849. */
  31850. protected _imageProcessingConfiguration: ImageProcessingConfiguration;
  31851. /**
  31852. * Gets the image processing configuration used either in this material.
  31853. */
  31854. get imageProcessingConfiguration(): ImageProcessingConfiguration;
  31855. /**
  31856. * Sets the Default image processing configuration used either in the this material.
  31857. *
  31858. * If sets to null, the scene one is in use.
  31859. */
  31860. set imageProcessingConfiguration(value: ImageProcessingConfiguration);
  31861. /**
  31862. * Keep track of the image processing observer to allow dispose and replace.
  31863. */
  31864. private _imageProcessingObserver;
  31865. /**
  31866. * Attaches a new image processing configuration to the Standard Material.
  31867. * @param configuration
  31868. */
  31869. protected _attachImageProcessingConfiguration(configuration: Nullable<ImageProcessingConfiguration>): void;
  31870. /**
  31871. * Gets wether the color curves effect is enabled.
  31872. */
  31873. get cameraColorCurvesEnabled(): boolean;
  31874. /**
  31875. * Sets wether the color curves effect is enabled.
  31876. */
  31877. set cameraColorCurvesEnabled(value: boolean);
  31878. /**
  31879. * Gets wether the color grading effect is enabled.
  31880. */
  31881. get cameraColorGradingEnabled(): boolean;
  31882. /**
  31883. * Gets wether the color grading effect is enabled.
  31884. */
  31885. set cameraColorGradingEnabled(value: boolean);
  31886. /**
  31887. * Gets wether tonemapping is enabled or not.
  31888. */
  31889. get cameraToneMappingEnabled(): boolean;
  31890. /**
  31891. * Sets wether tonemapping is enabled or not
  31892. */
  31893. set cameraToneMappingEnabled(value: boolean);
  31894. /**
  31895. * The camera exposure used on this material.
  31896. * This property is here and not in the camera to allow controlling exposure without full screen post process.
  31897. * This corresponds to a photographic exposure.
  31898. */
  31899. get cameraExposure(): number;
  31900. /**
  31901. * The camera exposure used on this material.
  31902. * This property is here and not in the camera to allow controlling exposure without full screen post process.
  31903. * This corresponds to a photographic exposure.
  31904. */
  31905. set cameraExposure(value: number);
  31906. /**
  31907. * Gets The camera contrast used on this material.
  31908. */
  31909. get cameraContrast(): number;
  31910. /**
  31911. * Sets The camera contrast used on this material.
  31912. */
  31913. set cameraContrast(value: number);
  31914. /**
  31915. * Gets the Color Grading 2D Lookup Texture.
  31916. */
  31917. get cameraColorGradingTexture(): Nullable<BaseTexture>;
  31918. /**
  31919. * Sets the Color Grading 2D Lookup Texture.
  31920. */
  31921. set cameraColorGradingTexture(value: Nullable<BaseTexture>);
  31922. /**
  31923. * The color grading curves provide additional color adjustmnent that is applied after any color grading transform (3D LUT).
  31924. * They allow basic adjustment of saturation and small exposure adjustments, along with color filter tinting to provide white balance adjustment or more stylistic effects.
  31925. * 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;
  31926. * corresponding to low luminance, medium luminance, and high luminance areas respectively.
  31927. */
  31928. get cameraColorCurves(): Nullable<ColorCurves>;
  31929. /**
  31930. * The color grading curves provide additional color adjustmnent that is applied after any color grading transform (3D LUT).
  31931. * They allow basic adjustment of saturation and small exposure adjustments, along with color filter tinting to provide white balance adjustment or more stylistic effects.
  31932. * 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;
  31933. * corresponding to low luminance, medium luminance, and high luminance areas respectively.
  31934. */
  31935. set cameraColorCurves(value: Nullable<ColorCurves>);
  31936. /**
  31937. * Can this material render to several textures at once
  31938. */
  31939. get canRenderToMRT(): boolean;
  31940. /**
  31941. * Defines the detail map parameters for the material.
  31942. */
  31943. readonly detailMap: DetailMapConfiguration;
  31944. protected _renderTargets: SmartArray<RenderTargetTexture>;
  31945. protected _worldViewProjectionMatrix: Matrix;
  31946. protected _globalAmbientColor: Color3;
  31947. protected _useLogarithmicDepth: boolean;
  31948. protected _rebuildInParallel: boolean;
  31949. /**
  31950. * Instantiates a new standard material.
  31951. * This is the default material used in Babylon. It is the best trade off between quality
  31952. * and performances.
  31953. * @see https://doc.babylonjs.com/babylon101/materials
  31954. * @param name Define the name of the material in the scene
  31955. * @param scene Define the scene the material belong to
  31956. */
  31957. constructor(name: string, scene: Scene);
  31958. /**
  31959. * Gets a boolean indicating that current material needs to register RTT
  31960. */
  31961. get hasRenderTargetTextures(): boolean;
  31962. /**
  31963. * Gets the current class name of the material e.g. "StandardMaterial"
  31964. * Mainly use in serialization.
  31965. * @returns the class name
  31966. */
  31967. getClassName(): string;
  31968. /**
  31969. * In case the depth buffer does not allow enough depth precision for your scene (might be the case in large scenes)
  31970. * You can try switching to logarithmic depth.
  31971. * @see https://doc.babylonjs.com/how_to/using_logarithmic_depth_buffer
  31972. */
  31973. get useLogarithmicDepth(): boolean;
  31974. set useLogarithmicDepth(value: boolean);
  31975. /**
  31976. * Specifies if the material will require alpha blending
  31977. * @returns a boolean specifying if alpha blending is needed
  31978. */
  31979. needAlphaBlending(): boolean;
  31980. /**
  31981. * Specifies if this material should be rendered in alpha test mode
  31982. * @returns a boolean specifying if an alpha test is needed.
  31983. */
  31984. needAlphaTesting(): boolean;
  31985. protected _shouldUseAlphaFromDiffuseTexture(): boolean;
  31986. /**
  31987. * Get the texture used for alpha test purpose.
  31988. * @returns the diffuse texture in case of the standard material.
  31989. */
  31990. getAlphaTestTexture(): Nullable<BaseTexture>;
  31991. /**
  31992. * Get if the submesh is ready to be used and all its information available.
  31993. * Child classes can use it to update shaders
  31994. * @param mesh defines the mesh to check
  31995. * @param subMesh defines which submesh to check
  31996. * @param useInstances specifies that instances should be used
  31997. * @returns a boolean indicating that the submesh is ready or not
  31998. */
  31999. isReadyForSubMesh(mesh: AbstractMesh, subMesh: SubMesh, useInstances?: boolean): boolean;
  32000. /**
  32001. * Builds the material UBO layouts.
  32002. * Used internally during the effect preparation.
  32003. */
  32004. buildUniformLayout(): void;
  32005. /**
  32006. * Unbinds the material from the mesh
  32007. */
  32008. unbind(): void;
  32009. /**
  32010. * Binds the submesh to this material by preparing the effect and shader to draw
  32011. * @param world defines the world transformation matrix
  32012. * @param mesh defines the mesh containing the submesh
  32013. * @param subMesh defines the submesh to bind the material to
  32014. */
  32015. bindForSubMesh(world: Matrix, mesh: Mesh, subMesh: SubMesh): void;
  32016. /**
  32017. * Get the list of animatables in the material.
  32018. * @returns the list of animatables object used in the material
  32019. */
  32020. getAnimatables(): IAnimatable[];
  32021. /**
  32022. * Gets the active textures from the material
  32023. * @returns an array of textures
  32024. */
  32025. getActiveTextures(): BaseTexture[];
  32026. /**
  32027. * Specifies if the material uses a texture
  32028. * @param texture defines the texture to check against the material
  32029. * @returns a boolean specifying if the material uses the texture
  32030. */
  32031. hasTexture(texture: BaseTexture): boolean;
  32032. /**
  32033. * Disposes the material
  32034. * @param forceDisposeEffect specifies if effects should be forcefully disposed
  32035. * @param forceDisposeTextures specifies if textures should be forcefully disposed
  32036. */
  32037. dispose(forceDisposeEffect?: boolean, forceDisposeTextures?: boolean): void;
  32038. /**
  32039. * Makes a duplicate of the material, and gives it a new name
  32040. * @param name defines the new name for the duplicated material
  32041. * @returns the cloned material
  32042. */
  32043. clone(name: string): StandardMaterial;
  32044. /**
  32045. * Serializes this material in a JSON representation
  32046. * @returns the serialized material object
  32047. */
  32048. serialize(): any;
  32049. /**
  32050. * Creates a standard material from parsed material data
  32051. * @param source defines the JSON representation of the material
  32052. * @param scene defines the hosting scene
  32053. * @param rootUrl defines the root URL to use to load textures and relative dependencies
  32054. * @returns a new standard material
  32055. */
  32056. static Parse(source: any, scene: Scene, rootUrl: string): StandardMaterial;
  32057. /**
  32058. * Are diffuse textures enabled in the application.
  32059. */
  32060. static get DiffuseTextureEnabled(): boolean;
  32061. static set DiffuseTextureEnabled(value: boolean);
  32062. /**
  32063. * Are detail textures enabled in the application.
  32064. */
  32065. static get DetailTextureEnabled(): boolean;
  32066. static set DetailTextureEnabled(value: boolean);
  32067. /**
  32068. * Are ambient textures enabled in the application.
  32069. */
  32070. static get AmbientTextureEnabled(): boolean;
  32071. static set AmbientTextureEnabled(value: boolean);
  32072. /**
  32073. * Are opacity textures enabled in the application.
  32074. */
  32075. static get OpacityTextureEnabled(): boolean;
  32076. static set OpacityTextureEnabled(value: boolean);
  32077. /**
  32078. * Are reflection textures enabled in the application.
  32079. */
  32080. static get ReflectionTextureEnabled(): boolean;
  32081. static set ReflectionTextureEnabled(value: boolean);
  32082. /**
  32083. * Are emissive textures enabled in the application.
  32084. */
  32085. static get EmissiveTextureEnabled(): boolean;
  32086. static set EmissiveTextureEnabled(value: boolean);
  32087. /**
  32088. * Are specular textures enabled in the application.
  32089. */
  32090. static get SpecularTextureEnabled(): boolean;
  32091. static set SpecularTextureEnabled(value: boolean);
  32092. /**
  32093. * Are bump textures enabled in the application.
  32094. */
  32095. static get BumpTextureEnabled(): boolean;
  32096. static set BumpTextureEnabled(value: boolean);
  32097. /**
  32098. * Are lightmap textures enabled in the application.
  32099. */
  32100. static get LightmapTextureEnabled(): boolean;
  32101. static set LightmapTextureEnabled(value: boolean);
  32102. /**
  32103. * Are refraction textures enabled in the application.
  32104. */
  32105. static get RefractionTextureEnabled(): boolean;
  32106. static set RefractionTextureEnabled(value: boolean);
  32107. /**
  32108. * Are color grading textures enabled in the application.
  32109. */
  32110. static get ColorGradingTextureEnabled(): boolean;
  32111. static set ColorGradingTextureEnabled(value: boolean);
  32112. /**
  32113. * Are fresnels enabled in the application.
  32114. */
  32115. static get FresnelEnabled(): boolean;
  32116. static set FresnelEnabled(value: boolean);
  32117. }
  32118. }
  32119. declare module "babylonjs/Particles/solidParticleSystem" {
  32120. import { Nullable } from "babylonjs/types";
  32121. import { Mesh } from "babylonjs/Meshes/mesh";
  32122. import { Scene, IDisposable } from "babylonjs/scene";
  32123. import { DepthSortedParticle, SolidParticle, SolidParticleVertex } from "babylonjs/Particles/solidParticle";
  32124. import { Material } from "babylonjs/Materials/material";
  32125. import { MultiMaterial } from "babylonjs/Materials/multiMaterial";
  32126. import { PickingInfo } from "babylonjs/Collisions/pickingInfo";
  32127. /**
  32128. * The SPS is a single updatable mesh. The solid particles are simply separate parts or faces fo this big mesh.
  32129. *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.
  32130. * The SPS is also a particle system. It provides some methods to manage the particles.
  32131. * However it is behavior agnostic. This means it has no emitter, no particle physics, no particle recycler. You have to implement your own behavior.
  32132. *
  32133. * Full documentation here : https://doc.babylonjs.com/how_to/Solid_Particle_System
  32134. */
  32135. export class SolidParticleSystem implements IDisposable {
  32136. /**
  32137. * The SPS array of Solid Particle objects. Just access each particle as with any classic array.
  32138. * Example : var p = SPS.particles[i];
  32139. */
  32140. particles: SolidParticle[];
  32141. /**
  32142. * The SPS total number of particles. Read only. Use SPS.counter instead if you need to set your own value.
  32143. */
  32144. nbParticles: number;
  32145. /**
  32146. * If the particles must ever face the camera (default false). Useful for planar particles.
  32147. */
  32148. billboard: boolean;
  32149. /**
  32150. * Recompute normals when adding a shape
  32151. */
  32152. recomputeNormals: boolean;
  32153. /**
  32154. * This a counter ofr your own usage. It's not set by any SPS functions.
  32155. */
  32156. counter: number;
  32157. /**
  32158. * The SPS name. This name is also given to the underlying mesh.
  32159. */
  32160. name: string;
  32161. /**
  32162. * The SPS mesh. It's a standard BJS Mesh, so all the methods from the Mesh class are avalaible.
  32163. */
  32164. mesh: Mesh;
  32165. /**
  32166. * This empty object is intended to store some SPS specific or temporary values in order to lower the Garbage Collector activity.
  32167. * Please read : https://doc.babylonjs.com/how_to/Solid_Particle_System#garbage-collector-concerns
  32168. */
  32169. vars: any;
  32170. /**
  32171. * This array is populated when the SPS is set as 'pickable'.
  32172. * Each key of this array is a `faceId` value that you can get from a pickResult object.
  32173. * Each element of this array is an object `{idx: int, faceId: int}`.
  32174. * `idx` is the picked particle index in the `SPS.particles` array
  32175. * `faceId` is the picked face index counted within this particle.
  32176. * This array is the first element of the pickedBySubMesh array : sps.pickBySubMesh[0].
  32177. * It's not pertinent to use it when using a SPS with the support for MultiMaterial enabled.
  32178. * Use the method SPS.pickedParticle(pickingInfo) instead.
  32179. * Please read : https://doc.babylonjs.com/how_to/Solid_Particle_System#pickable-particles
  32180. */
  32181. pickedParticles: {
  32182. idx: number;
  32183. faceId: number;
  32184. }[];
  32185. /**
  32186. * This array is populated when the SPS is set as 'pickable'
  32187. * Each key of this array is a submesh index.
  32188. * Each element of this array is a second array defined like this :
  32189. * Each key of this second array is a `faceId` value that you can get from a pickResult object.
  32190. * Each element of this second array is an object `{idx: int, faceId: int}`.
  32191. * `idx` is the picked particle index in the `SPS.particles` array
  32192. * `faceId` is the picked face index counted within this particle.
  32193. * It's better to use the method SPS.pickedParticle(pickingInfo) rather than using directly this array.
  32194. * Please read : https://doc.babylonjs.com/how_to/Solid_Particle_System#pickable-particles
  32195. */
  32196. pickedBySubMesh: {
  32197. idx: number;
  32198. faceId: number;
  32199. }[][];
  32200. /**
  32201. * This array is populated when `enableDepthSort` is set to true.
  32202. * Each element of this array is an instance of the class DepthSortedParticle.
  32203. */
  32204. depthSortedParticles: DepthSortedParticle[];
  32205. /**
  32206. * If the particle intersection must be computed only with the bounding sphere (no bounding box computation, so faster). (Internal use only)
  32207. * @hidden
  32208. */
  32209. _bSphereOnly: boolean;
  32210. /**
  32211. * A number to multiply the boundind sphere radius by in order to reduce it for instance. (Internal use only)
  32212. * @hidden
  32213. */
  32214. _bSphereRadiusFactor: number;
  32215. private _scene;
  32216. private _positions;
  32217. private _indices;
  32218. private _normals;
  32219. private _colors;
  32220. private _uvs;
  32221. private _indices32;
  32222. private _positions32;
  32223. private _normals32;
  32224. private _fixedNormal32;
  32225. private _colors32;
  32226. private _uvs32;
  32227. private _index;
  32228. private _updatable;
  32229. private _pickable;
  32230. private _isVisibilityBoxLocked;
  32231. private _alwaysVisible;
  32232. private _depthSort;
  32233. private _expandable;
  32234. private _shapeCounter;
  32235. private _copy;
  32236. private _color;
  32237. private _computeParticleColor;
  32238. private _computeParticleTexture;
  32239. private _computeParticleRotation;
  32240. private _computeParticleVertex;
  32241. private _computeBoundingBox;
  32242. private _depthSortParticles;
  32243. private _camera;
  32244. private _mustUnrotateFixedNormals;
  32245. private _particlesIntersect;
  32246. private _needs32Bits;
  32247. private _isNotBuilt;
  32248. private _lastParticleId;
  32249. private _idxOfId;
  32250. private _multimaterialEnabled;
  32251. private _useModelMaterial;
  32252. private _indicesByMaterial;
  32253. private _materialIndexes;
  32254. private _depthSortFunction;
  32255. private _materialSortFunction;
  32256. private _materials;
  32257. private _multimaterial;
  32258. private _materialIndexesById;
  32259. private _defaultMaterial;
  32260. private _autoUpdateSubMeshes;
  32261. private _tmpVertex;
  32262. /**
  32263. * Creates a SPS (Solid Particle System) object.
  32264. * @param name (String) is the SPS name, this will be the underlying mesh name.
  32265. * @param scene (Scene) is the scene in which the SPS is added.
  32266. * @param options defines the options of the sps e.g.
  32267. * * updatable (optional boolean, default true) : if the SPS must be updatable or immutable.
  32268. * * isPickable (optional boolean, default false) : if the solid particles must be pickable.
  32269. * * enableDepthSort (optional boolean, default false) : if the solid particles must be sorted in the geometry according to their distance to the camera.
  32270. * * 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.
  32271. * * enableMultiMaterial (optional boolean, default false) : if the solid particles can be given different materials.
  32272. * * expandable (optional boolean, default false) : if particles can still be added after the initial SPS mesh creation.
  32273. * * particleIntersection (optional boolean, default false) : if the solid particle intersections must be computed.
  32274. * * boundingSphereOnly (optional boolean, default false) : if the particle intersection must be computed only with the bounding sphere (no bounding box computation, so faster).
  32275. * * bSphereRadiusFactor (optional float, default 1.0) : a number to multiply the boundind sphere radius by in order to reduce it for instance.
  32276. * @example bSphereRadiusFactor = 1.0 / Math.sqrt(3.0) => the bounding sphere exactly matches a spherical mesh.
  32277. */
  32278. constructor(name: string, scene: Scene, options?: {
  32279. updatable?: boolean;
  32280. isPickable?: boolean;
  32281. enableDepthSort?: boolean;
  32282. particleIntersection?: boolean;
  32283. boundingSphereOnly?: boolean;
  32284. bSphereRadiusFactor?: number;
  32285. expandable?: boolean;
  32286. useModelMaterial?: boolean;
  32287. enableMultiMaterial?: boolean;
  32288. });
  32289. /**
  32290. * Builds the SPS underlying mesh. Returns a standard Mesh.
  32291. * If no model shape was added to the SPS, the returned mesh is just a single triangular plane.
  32292. * @returns the created mesh
  32293. */
  32294. buildMesh(): Mesh;
  32295. /**
  32296. * Digests the mesh and generates as many solid particles in the system as wanted. Returns the SPS.
  32297. * These particles will have the same geometry than the mesh parts and will be positioned at the same localisation than the mesh original places.
  32298. * Thus the particles generated from `digest()` have their property `position` set yet.
  32299. * @param mesh ( Mesh ) is the mesh to be digested
  32300. * @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
  32301. * {delta} (optional integer, default 0) is the random extra number of facets per particle , each particle will have between `facetNb` and `facetNb + delta` facets
  32302. * {number} (optional positive integer) is the wanted number of particles : each particle is built with `mesh_total_facets / number` facets
  32303. * {storage} (optional existing array) is an array where the particles will be stored for a further use instead of being inserted in the SPS.
  32304. * @returns the current SPS
  32305. */
  32306. digest(mesh: Mesh, options?: {
  32307. facetNb?: number;
  32308. number?: number;
  32309. delta?: number;
  32310. storage?: [];
  32311. }): SolidParticleSystem;
  32312. /**
  32313. * Unrotate the fixed normals in case the mesh was built with pre-rotated particles, ex : use of positionFunction in addShape()
  32314. * @hidden
  32315. */
  32316. private _unrotateFixedNormals;
  32317. /**
  32318. * Resets the temporary working copy particle
  32319. * @hidden
  32320. */
  32321. private _resetCopy;
  32322. /**
  32323. * Inserts the shape model geometry in the global SPS mesh by updating the positions, indices, normals, colors, uvs arrays
  32324. * @param p the current index in the positions array to be updated
  32325. * @param ind the current index in the indices array
  32326. * @param shape a Vector3 array, the shape geometry
  32327. * @param positions the positions array to be updated
  32328. * @param meshInd the shape indices array
  32329. * @param indices the indices array to be updated
  32330. * @param meshUV the shape uv array
  32331. * @param uvs the uv array to be updated
  32332. * @param meshCol the shape color array
  32333. * @param colors the color array to be updated
  32334. * @param meshNor the shape normals array
  32335. * @param normals the normals array to be updated
  32336. * @param idx the particle index
  32337. * @param idxInShape the particle index in its shape
  32338. * @param options the addShape() method passed options
  32339. * @model the particle model
  32340. * @hidden
  32341. */
  32342. private _meshBuilder;
  32343. /**
  32344. * Returns a shape Vector3 array from positions float array
  32345. * @param positions float array
  32346. * @returns a vector3 array
  32347. * @hidden
  32348. */
  32349. private _posToShape;
  32350. /**
  32351. * Returns a shapeUV array from a float uvs (array deep copy)
  32352. * @param uvs as a float array
  32353. * @returns a shapeUV array
  32354. * @hidden
  32355. */
  32356. private _uvsToShapeUV;
  32357. /**
  32358. * Adds a new particle object in the particles array
  32359. * @param idx particle index in particles array
  32360. * @param id particle id
  32361. * @param idxpos positionIndex : the starting index of the particle vertices in the SPS "positions" array
  32362. * @param idxind indiceIndex : he starting index of the particle indices in the SPS "indices" array
  32363. * @param model particle ModelShape object
  32364. * @param shapeId model shape identifier
  32365. * @param idxInShape index of the particle in the current model
  32366. * @param bInfo model bounding info object
  32367. * @param storage target storage array, if any
  32368. * @hidden
  32369. */
  32370. private _addParticle;
  32371. /**
  32372. * Adds some particles to the SPS from the model shape. Returns the shape id.
  32373. * Please read the doc : https://doc.babylonjs.com/how_to/Solid_Particle_System#create-an-immutable-sps
  32374. * @param mesh is any Mesh object that will be used as a model for the solid particles.
  32375. * @param nb (positive integer) the number of particles to be created from this model
  32376. * @param options {positionFunction} is an optional javascript function to called for each particle on SPS creation.
  32377. * {vertexFunction} is an optional javascript function to called for each vertex of each particle on SPS creation
  32378. * {storage} (optional existing array) is an array where the particles will be stored for a further use instead of being inserted in the SPS.
  32379. * @returns the number of shapes in the system
  32380. */
  32381. addShape(mesh: Mesh, nb: number, options?: {
  32382. positionFunction?: any;
  32383. vertexFunction?: any;
  32384. storage?: [];
  32385. }): number;
  32386. /**
  32387. * Rebuilds a particle back to its just built status : if needed, recomputes the custom positions and vertices
  32388. * @hidden
  32389. */
  32390. private _rebuildParticle;
  32391. /**
  32392. * Rebuilds the whole mesh and updates the VBO : custom positions and vertices are recomputed if needed.
  32393. * @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.
  32394. * @returns the SPS.
  32395. */
  32396. rebuildMesh(reset?: boolean): SolidParticleSystem;
  32397. /** Removes the particles from the start-th to the end-th included from an expandable SPS (required).
  32398. * Returns an array with the removed particles.
  32399. * 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.
  32400. * The SPS can't be empty so at least one particle needs to remain in place.
  32401. * Under the hood, the VertexData array, so the VBO buffer, is recreated each call.
  32402. * @param start index of the first particle to remove
  32403. * @param end index of the last particle to remove (included)
  32404. * @returns an array populated with the removed particles
  32405. */
  32406. removeParticles(start: number, end: number): SolidParticle[];
  32407. /**
  32408. * Inserts some pre-created particles in the solid particle system so that they can be managed by setParticles().
  32409. * @param solidParticleArray an array populated with Solid Particles objects
  32410. * @returns the SPS
  32411. */
  32412. insertParticlesFromArray(solidParticleArray: SolidParticle[]): SolidParticleSystem;
  32413. /**
  32414. * Creates a new particle and modifies the SPS mesh geometry :
  32415. * - calls _meshBuilder() to increase the SPS mesh geometry step by step
  32416. * - calls _addParticle() to populate the particle array
  32417. * factorized code from addShape() and insertParticlesFromArray()
  32418. * @param idx particle index in the particles array
  32419. * @param i particle index in its shape
  32420. * @param modelShape particle ModelShape object
  32421. * @param shape shape vertex array
  32422. * @param meshInd shape indices array
  32423. * @param meshUV shape uv array
  32424. * @param meshCol shape color array
  32425. * @param meshNor shape normals array
  32426. * @param bbInfo shape bounding info
  32427. * @param storage target particle storage
  32428. * @options addShape() passed options
  32429. * @hidden
  32430. */
  32431. private _insertNewParticle;
  32432. /**
  32433. * Sets all the particles : this method actually really updates the mesh according to the particle positions, rotations, colors, textures, etc.
  32434. * This method calls `updateParticle()` for each particle of the SPS.
  32435. * For an animated SPS, it is usually called within the render loop.
  32436. * 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.
  32437. * @param start The particle index in the particle array where to start to compute the particle property values _(default 0)_
  32438. * @param end The particle index in the particle array where to stop to compute the particle property values _(default nbParticle - 1)_
  32439. * @param update If the mesh must be finally updated on this call after all the particle computations _(default true)_
  32440. * @returns the SPS.
  32441. */
  32442. setParticles(start?: number, end?: number, update?: boolean): SolidParticleSystem;
  32443. /**
  32444. * Disposes the SPS.
  32445. */
  32446. dispose(): void;
  32447. /** Returns an object {idx: numbern faceId: number} for the picked particle from the passed pickingInfo object.
  32448. * idx is the particle index in the SPS
  32449. * faceId is the picked face index counted within this particle.
  32450. * Returns null if the pickInfo can't identify a picked particle.
  32451. * @param pickingInfo (PickingInfo object)
  32452. * @returns {idx: number, faceId: number} or null
  32453. */
  32454. pickedParticle(pickingInfo: PickingInfo): Nullable<{
  32455. idx: number;
  32456. faceId: number;
  32457. }>;
  32458. /**
  32459. * Returns a SolidParticle object from its identifier : particle.id
  32460. * @param id (integer) the particle Id
  32461. * @returns the searched particle or null if not found in the SPS.
  32462. */
  32463. getParticleById(id: number): Nullable<SolidParticle>;
  32464. /**
  32465. * Returns a new array populated with the particles having the passed shapeId.
  32466. * @param shapeId (integer) the shape identifier
  32467. * @returns a new solid particle array
  32468. */
  32469. getParticlesByShapeId(shapeId: number): SolidParticle[];
  32470. /**
  32471. * Populates the passed array "ref" with the particles having the passed shapeId.
  32472. * @param shapeId the shape identifier
  32473. * @returns the SPS
  32474. * @param ref
  32475. */
  32476. getParticlesByShapeIdToRef(shapeId: number, ref: SolidParticle[]): SolidParticleSystem;
  32477. /**
  32478. * Computes the required SubMeshes according the materials assigned to the particles.
  32479. * @returns the solid particle system.
  32480. * Does nothing if called before the SPS mesh is built.
  32481. */
  32482. computeSubMeshes(): SolidParticleSystem;
  32483. /**
  32484. * Sorts the solid particles by material when MultiMaterial is enabled.
  32485. * Updates the indices32 array.
  32486. * Updates the indicesByMaterial array.
  32487. * Updates the mesh indices array.
  32488. * @returns the SPS
  32489. * @hidden
  32490. */
  32491. private _sortParticlesByMaterial;
  32492. /**
  32493. * Sets the material indexes by id materialIndexesById[id] = materialIndex
  32494. * @hidden
  32495. */
  32496. private _setMaterialIndexesById;
  32497. /**
  32498. * Returns an array with unique values of Materials from the passed array
  32499. * @param array the material array to be checked and filtered
  32500. * @hidden
  32501. */
  32502. private _filterUniqueMaterialId;
  32503. /**
  32504. * Sets a new Standard Material as _defaultMaterial if not already set.
  32505. * @hidden
  32506. */
  32507. private _setDefaultMaterial;
  32508. /**
  32509. * Visibilty helper : Recomputes the visible size according to the mesh bounding box
  32510. * doc : https://doc.babylonjs.com/how_to/Solid_Particle_System#sps-visibility
  32511. * @returns the SPS.
  32512. */
  32513. refreshVisibleSize(): SolidParticleSystem;
  32514. /**
  32515. * Visibility helper : Sets the size of a visibility box, this sets the underlying mesh bounding box.
  32516. * @param size the size (float) of the visibility box
  32517. * note : this doesn't lock the SPS mesh bounding box.
  32518. * doc : https://doc.babylonjs.com/how_to/Solid_Particle_System#sps-visibility
  32519. */
  32520. setVisibilityBox(size: number): void;
  32521. /**
  32522. * Gets whether the SPS as always visible or not
  32523. * doc : https://doc.babylonjs.com/how_to/Solid_Particle_System#sps-visibility
  32524. */
  32525. get isAlwaysVisible(): boolean;
  32526. /**
  32527. * Sets the SPS as always visible or not
  32528. * doc : https://doc.babylonjs.com/how_to/Solid_Particle_System#sps-visibility
  32529. */
  32530. set isAlwaysVisible(val: boolean);
  32531. /**
  32532. * Sets the SPS visibility box as locked or not. This enables/disables the underlying mesh bounding box updates.
  32533. * doc : https://doc.babylonjs.com/how_to/Solid_Particle_System#sps-visibility
  32534. */
  32535. set isVisibilityBoxLocked(val: boolean);
  32536. /**
  32537. * Gets if the SPS visibility box as locked or not. This enables/disables the underlying mesh bounding box updates.
  32538. * doc : https://doc.babylonjs.com/how_to/Solid_Particle_System#sps-visibility
  32539. */
  32540. get isVisibilityBoxLocked(): boolean;
  32541. /**
  32542. * Tells to `setParticles()` to compute the particle rotations or not.
  32543. * Default value : true. The SPS is faster when it's set to false.
  32544. * Note : the particle rotations aren't stored values, so setting `computeParticleRotation` to false will prevents the particle to rotate.
  32545. */
  32546. set computeParticleRotation(val: boolean);
  32547. /**
  32548. * Tells to `setParticles()` to compute the particle colors or not.
  32549. * Default value : true. The SPS is faster when it's set to false.
  32550. * Note : the particle colors are stored values, so setting `computeParticleColor` to false will keep yet the last colors set.
  32551. */
  32552. set computeParticleColor(val: boolean);
  32553. set computeParticleTexture(val: boolean);
  32554. /**
  32555. * Tells to `setParticles()` to call the vertex function for each vertex of each particle, or not.
  32556. * Default value : false. The SPS is faster when it's set to false.
  32557. * Note : the particle custom vertex positions aren't stored values.
  32558. */
  32559. set computeParticleVertex(val: boolean);
  32560. /**
  32561. * Tells to `setParticles()` to compute or not the mesh bounding box when computing the particle positions.
  32562. */
  32563. set computeBoundingBox(val: boolean);
  32564. /**
  32565. * Tells to `setParticles()` to sort or not the distance between each particle and the camera.
  32566. * Skipped when `enableDepthSort` is set to `false` (default) at construction time.
  32567. * Default : `true`
  32568. */
  32569. set depthSortParticles(val: boolean);
  32570. /**
  32571. * Gets if `setParticles()` computes the particle rotations or not.
  32572. * Default value : true. The SPS is faster when it's set to false.
  32573. * Note : the particle rotations aren't stored values, so setting `computeParticleRotation` to false will prevents the particle to rotate.
  32574. */
  32575. get computeParticleRotation(): boolean;
  32576. /**
  32577. * Gets if `setParticles()` computes the particle colors or not.
  32578. * Default value : true. The SPS is faster when it's set to false.
  32579. * Note : the particle colors are stored values, so setting `computeParticleColor` to false will keep yet the last colors set.
  32580. */
  32581. get computeParticleColor(): boolean;
  32582. /**
  32583. * Gets if `setParticles()` computes the particle textures or not.
  32584. * Default value : true. The SPS is faster when it's set to false.
  32585. * Note : the particle textures are stored values, so setting `computeParticleTexture` to false will keep yet the last colors set.
  32586. */
  32587. get computeParticleTexture(): boolean;
  32588. /**
  32589. * Gets if `setParticles()` calls the vertex function for each vertex of each particle, or not.
  32590. * Default value : false. The SPS is faster when it's set to false.
  32591. * Note : the particle custom vertex positions aren't stored values.
  32592. */
  32593. get computeParticleVertex(): boolean;
  32594. /**
  32595. * Gets if `setParticles()` computes or not the mesh bounding box when computing the particle positions.
  32596. */
  32597. get computeBoundingBox(): boolean;
  32598. /**
  32599. * Gets if `setParticles()` sorts or not the distance between each particle and the camera.
  32600. * Skipped when `enableDepthSort` is set to `false` (default) at construction time.
  32601. * Default : `true`
  32602. */
  32603. get depthSortParticles(): boolean;
  32604. /**
  32605. * Gets if the SPS is created as expandable at construction time.
  32606. * Default : `false`
  32607. */
  32608. get expandable(): boolean;
  32609. /**
  32610. * Gets if the SPS supports the Multi Materials
  32611. */
  32612. get multimaterialEnabled(): boolean;
  32613. /**
  32614. * Gets if the SPS uses the model materials for its own multimaterial.
  32615. */
  32616. get useModelMaterial(): boolean;
  32617. /**
  32618. * The SPS used material array.
  32619. */
  32620. get materials(): Material[];
  32621. /**
  32622. * Sets the SPS MultiMaterial from the passed materials.
  32623. * Note : the passed array is internally copied and not used then by reference.
  32624. * @param materials an array of material objects. This array indexes are the materialIndex values of the particles.
  32625. */
  32626. setMultiMaterial(materials: Material[]): void;
  32627. /**
  32628. * The SPS computed multimaterial object
  32629. */
  32630. get multimaterial(): MultiMaterial;
  32631. set multimaterial(mm: MultiMaterial);
  32632. /**
  32633. * If the subMeshes must be updated on the next call to setParticles()
  32634. */
  32635. get autoUpdateSubMeshes(): boolean;
  32636. set autoUpdateSubMeshes(val: boolean);
  32637. /**
  32638. * This function does nothing. It may be overwritten to set all the particle first values.
  32639. * The SPS doesn't call this function, you may have to call it by your own.
  32640. * doc : https://doc.babylonjs.com/how_to/Solid_Particle_System#particle-management
  32641. */
  32642. initParticles(): void;
  32643. /**
  32644. * This function does nothing. It may be overwritten to recycle a particle.
  32645. * The SPS doesn't call this function, you may have to call it by your own.
  32646. * doc : https://doc.babylonjs.com/how_to/Solid_Particle_System#particle-management
  32647. * @param particle The particle to recycle
  32648. * @returns the recycled particle
  32649. */
  32650. recycleParticle(particle: SolidParticle): SolidParticle;
  32651. /**
  32652. * Updates a particle : this function should be overwritten by the user.
  32653. * It is called on each particle by `setParticles()`. This is the place to code each particle behavior.
  32654. * doc : https://doc.babylonjs.com/how_to/Solid_Particle_System#particle-management
  32655. * @example : just set a particle position or velocity and recycle conditions
  32656. * @param particle The particle to update
  32657. * @returns the updated particle
  32658. */
  32659. updateParticle(particle: SolidParticle): SolidParticle;
  32660. /**
  32661. * Updates a vertex of a particle : it can be overwritten by the user.
  32662. * This will be called on each vertex particle by `setParticles()` if `computeParticleVertex` is set to true only.
  32663. * @param particle the current particle
  32664. * @param vertex the current vertex of the current particle : a SolidParticleVertex object
  32665. * @param pt the index of the current vertex in the particle shape
  32666. * doc : https://doc.babylonjs.com/how_to/Solid_Particle_System#update-each-particle-shape
  32667. * @example : just set a vertex particle position or color
  32668. * @returns the sps
  32669. */
  32670. updateParticleVertex(particle: SolidParticle, vertex: SolidParticleVertex, pt: number): SolidParticleSystem;
  32671. /**
  32672. * This will be called before any other treatment by `setParticles()` and will be passed three parameters.
  32673. * This does nothing and may be overwritten by the user.
  32674. * @param start the particle index in the particle array where to stop to iterate, same than the value passed to setParticle()
  32675. * @param stop the particle index in the particle array where to stop to iterate, same than the value passed to setParticle()
  32676. * @param update the boolean update value actually passed to setParticles()
  32677. */
  32678. beforeUpdateParticles(start?: number, stop?: number, update?: boolean): void;
  32679. /**
  32680. * This will be called by `setParticles()` after all the other treatments and just before the actual mesh update.
  32681. * This will be passed three parameters.
  32682. * This does nothing and may be overwritten by the user.
  32683. * @param start the particle index in the particle array where to stop to iterate, same than the value passed to setParticle()
  32684. * @param stop the particle index in the particle array where to stop to iterate, same than the value passed to setParticle()
  32685. * @param update the boolean update value actually passed to setParticles()
  32686. */
  32687. afterUpdateParticles(start?: number, stop?: number, update?: boolean): void;
  32688. }
  32689. }
  32690. declare module "babylonjs/Particles/solidParticle" {
  32691. import { Nullable } from "babylonjs/types";
  32692. import { Vector3, Matrix, Quaternion, Vector4, Vector2 } from "babylonjs/Maths/math.vector";
  32693. import { Color4 } from "babylonjs/Maths/math.color";
  32694. import { Mesh } from "babylonjs/Meshes/mesh";
  32695. import { BoundingInfo } from "babylonjs/Culling/boundingInfo";
  32696. import { SolidParticleSystem } from "babylonjs/Particles/solidParticleSystem";
  32697. import { Plane } from "babylonjs/Maths/math.plane";
  32698. import { Material } from "babylonjs/Materials/material";
  32699. /**
  32700. * Represents one particle of a solid particle system.
  32701. */
  32702. export class SolidParticle {
  32703. /**
  32704. * particle global index
  32705. */
  32706. idx: number;
  32707. /**
  32708. * particle identifier
  32709. */
  32710. id: number;
  32711. /**
  32712. * The color of the particle
  32713. */
  32714. color: Nullable<Color4>;
  32715. /**
  32716. * The world space position of the particle.
  32717. */
  32718. position: Vector3;
  32719. /**
  32720. * The world space rotation of the particle. (Not use if rotationQuaternion is set)
  32721. */
  32722. rotation: Vector3;
  32723. /**
  32724. * The world space rotation quaternion of the particle.
  32725. */
  32726. rotationQuaternion: Nullable<Quaternion>;
  32727. /**
  32728. * The scaling of the particle.
  32729. */
  32730. scaling: Vector3;
  32731. /**
  32732. * The uvs of the particle.
  32733. */
  32734. uvs: Vector4;
  32735. /**
  32736. * The current speed of the particle.
  32737. */
  32738. velocity: Vector3;
  32739. /**
  32740. * The pivot point in the particle local space.
  32741. */
  32742. pivot: Vector3;
  32743. /**
  32744. * Must the particle be translated from its pivot point in its local space ?
  32745. * In this case, the pivot point is set at the origin of the particle local space and the particle is translated.
  32746. * Default : false
  32747. */
  32748. translateFromPivot: boolean;
  32749. /**
  32750. * Is the particle active or not ?
  32751. */
  32752. alive: boolean;
  32753. /**
  32754. * Is the particle visible or not ?
  32755. */
  32756. isVisible: boolean;
  32757. /**
  32758. * Index of this particle in the global "positions" array (Internal use)
  32759. * @hidden
  32760. */
  32761. _pos: number;
  32762. /**
  32763. * @hidden Index of this particle in the global "indices" array (Internal use)
  32764. */
  32765. _ind: number;
  32766. /**
  32767. * @hidden ModelShape of this particle (Internal use)
  32768. */
  32769. _model: ModelShape;
  32770. /**
  32771. * ModelShape id of this particle
  32772. */
  32773. shapeId: number;
  32774. /**
  32775. * Index of the particle in its shape id
  32776. */
  32777. idxInShape: number;
  32778. /**
  32779. * @hidden Reference to the shape model BoundingInfo object (Internal use)
  32780. */
  32781. _modelBoundingInfo: BoundingInfo;
  32782. /**
  32783. * @hidden Particle BoundingInfo object (Internal use)
  32784. */
  32785. _boundingInfo: BoundingInfo;
  32786. /**
  32787. * @hidden Reference to the SPS what the particle belongs to (Internal use)
  32788. */
  32789. _sps: SolidParticleSystem;
  32790. /**
  32791. * @hidden Still set as invisible in order to skip useless computations (Internal use)
  32792. */
  32793. _stillInvisible: boolean;
  32794. /**
  32795. * @hidden Last computed particle rotation matrix
  32796. */
  32797. _rotationMatrix: number[];
  32798. /**
  32799. * Parent particle Id, if any.
  32800. * Default null.
  32801. */
  32802. parentId: Nullable<number>;
  32803. /**
  32804. * The particle material identifier (integer) when MultiMaterials are enabled in the SPS.
  32805. */
  32806. materialIndex: Nullable<number>;
  32807. /**
  32808. * Custom object or properties.
  32809. */
  32810. props: Nullable<any>;
  32811. /**
  32812. * The culling strategy to use to check whether the solid particle must be culled or not when using isInFrustum().
  32813. * The possible values are :
  32814. * - AbstractMesh.CULLINGSTRATEGY_STANDARD
  32815. * - AbstractMesh.CULLINGSTRATEGY_BOUNDINGSPHERE_ONLY
  32816. * - AbstractMesh.CULLINGSTRATEGY_OPTIMISTIC_INCLUSION
  32817. * - AbstractMesh.CULLINGSTRATEGY_OPTIMISTIC_INCLUSION_THEN_BSPHERE_ONLY
  32818. * The default value for solid particles is AbstractMesh.CULLINGSTRATEGY_BOUNDINGSPHERE_ONLY
  32819. * Please read each static variable documentation in the class AbstractMesh to get details about the culling process.
  32820. * */
  32821. cullingStrategy: number;
  32822. /**
  32823. * @hidden Internal global position in the SPS.
  32824. */
  32825. _globalPosition: Vector3;
  32826. /**
  32827. * Creates a Solid Particle object.
  32828. * Don't create particles manually, use instead the Solid Particle System internal tools like _addParticle()
  32829. * @param particleIndex (integer) is the particle index in the Solid Particle System pool.
  32830. * @param particleId (integer) is the particle identifier. Unless some particles are removed from the SPS, it's the same value than the particle idx.
  32831. * @param positionIndex (integer) is the starting index of the particle vertices in the SPS "positions" array.
  32832. * @param indiceIndex (integer) is the starting index of the particle indices in the SPS "indices" array.
  32833. * @param model (ModelShape) is a reference to the model shape on what the particle is designed.
  32834. * @param shapeId (integer) is the model shape identifier in the SPS.
  32835. * @param idxInShape (integer) is the index of the particle in the current model (ex: the 10th box of addShape(box, 30))
  32836. * @param sps defines the sps it is associated to
  32837. * @param modelBoundingInfo is the reference to the model BoundingInfo used for intersection computations.
  32838. * @param materialIndex is the particle material identifier (integer) when the MultiMaterials are enabled in the SPS.
  32839. */
  32840. constructor(particleIndex: number, particleId: number, positionIndex: number, indiceIndex: number, model: Nullable<ModelShape>, shapeId: number, idxInShape: number, sps: SolidParticleSystem, modelBoundingInfo?: Nullable<BoundingInfo>, materialIndex?: Nullable<number>);
  32841. /**
  32842. * Copies the particle property values into the existing target : position, rotation, scaling, uvs, colors, pivot, parent, visibility, alive
  32843. * @param target the particle target
  32844. * @returns the current particle
  32845. */
  32846. copyToRef(target: SolidParticle): SolidParticle;
  32847. /**
  32848. * Legacy support, changed scale to scaling
  32849. */
  32850. get scale(): Vector3;
  32851. /**
  32852. * Legacy support, changed scale to scaling
  32853. */
  32854. set scale(scale: Vector3);
  32855. /**
  32856. * Legacy support, changed quaternion to rotationQuaternion
  32857. */
  32858. get quaternion(): Nullable<Quaternion>;
  32859. /**
  32860. * Legacy support, changed quaternion to rotationQuaternion
  32861. */
  32862. set quaternion(q: Nullable<Quaternion>);
  32863. /**
  32864. * Returns a boolean. True if the particle intersects another particle or another mesh, else false.
  32865. * The intersection is computed on the particle bounding sphere and Axis Aligned Bounding Box (AABB)
  32866. * @param target is the object (solid particle or mesh) what the intersection is computed against.
  32867. * @returns true if it intersects
  32868. */
  32869. intersectsMesh(target: Mesh | SolidParticle): boolean;
  32870. /**
  32871. * Returns `true` if the solid particle is within the frustum defined by the passed array of planes.
  32872. * A particle is in the frustum if its bounding box intersects the frustum
  32873. * @param frustumPlanes defines the frustum to test
  32874. * @returns true if the particle is in the frustum planes
  32875. */
  32876. isInFrustum(frustumPlanes: Plane[]): boolean;
  32877. /**
  32878. * get the rotation matrix of the particle
  32879. * @hidden
  32880. */
  32881. getRotationMatrix(m: Matrix): void;
  32882. }
  32883. /**
  32884. * Represents the shape of the model used by one particle of a solid particle system.
  32885. * SPS internal tool, don't use it manually.
  32886. */
  32887. export class ModelShape {
  32888. /**
  32889. * The shape id
  32890. * @hidden
  32891. */
  32892. shapeID: number;
  32893. /**
  32894. * flat array of model positions (internal use)
  32895. * @hidden
  32896. */
  32897. _shape: Vector3[];
  32898. /**
  32899. * flat array of model UVs (internal use)
  32900. * @hidden
  32901. */
  32902. _shapeUV: number[];
  32903. /**
  32904. * color array of the model
  32905. * @hidden
  32906. */
  32907. _shapeColors: number[];
  32908. /**
  32909. * indices array of the model
  32910. * @hidden
  32911. */
  32912. _indices: number[];
  32913. /**
  32914. * normals array of the model
  32915. * @hidden
  32916. */
  32917. _normals: number[];
  32918. /**
  32919. * length of the shape in the model indices array (internal use)
  32920. * @hidden
  32921. */
  32922. _indicesLength: number;
  32923. /**
  32924. * Custom position function (internal use)
  32925. * @hidden
  32926. */
  32927. _positionFunction: Nullable<(particle: SolidParticle, i: number, s: number) => void>;
  32928. /**
  32929. * Custom vertex function (internal use)
  32930. * @hidden
  32931. */
  32932. _vertexFunction: Nullable<(particle: SolidParticle, vertex: Vector3, i: number) => void>;
  32933. /**
  32934. * Model material (internal use)
  32935. * @hidden
  32936. */
  32937. _material: Nullable<Material>;
  32938. /**
  32939. * 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.
  32940. * SPS internal tool, don't use it manually.
  32941. * @hidden
  32942. */
  32943. 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>);
  32944. }
  32945. /**
  32946. * Represents a Depth Sorted Particle in the solid particle system.
  32947. * @hidden
  32948. */
  32949. export class DepthSortedParticle {
  32950. /**
  32951. * Particle index
  32952. */
  32953. idx: number;
  32954. /**
  32955. * Index of the particle in the "indices" array
  32956. */
  32957. ind: number;
  32958. /**
  32959. * Length of the particle shape in the "indices" array
  32960. */
  32961. indicesLength: number;
  32962. /**
  32963. * Squared distance from the particle to the camera
  32964. */
  32965. sqDistance: number;
  32966. /**
  32967. * Material index when used with MultiMaterials
  32968. */
  32969. materialIndex: number;
  32970. /**
  32971. * Creates a new sorted particle
  32972. * @param materialIndex
  32973. */
  32974. constructor(idx: number, ind: number, indLength: number, materialIndex: number);
  32975. }
  32976. /**
  32977. * Represents a solid particle vertex
  32978. */
  32979. export class SolidParticleVertex {
  32980. /**
  32981. * Vertex position
  32982. */
  32983. position: Vector3;
  32984. /**
  32985. * Vertex color
  32986. */
  32987. color: Color4;
  32988. /**
  32989. * Vertex UV
  32990. */
  32991. uv: Vector2;
  32992. /**
  32993. * Creates a new solid particle vertex
  32994. */
  32995. constructor();
  32996. /** Vertex x coordinate */
  32997. get x(): number;
  32998. set x(val: number);
  32999. /** Vertex y coordinate */
  33000. get y(): number;
  33001. set y(val: number);
  33002. /** Vertex z coordinate */
  33003. get z(): number;
  33004. set z(val: number);
  33005. }
  33006. }
  33007. declare module "babylonjs/Collisions/meshCollisionData" {
  33008. import { Collider } from "babylonjs/Collisions/collider";
  33009. import { Vector3 } from "babylonjs/Maths/math.vector";
  33010. import { Nullable } from "babylonjs/types";
  33011. import { Observer } from "babylonjs/Misc/observable";
  33012. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  33013. /**
  33014. * @hidden
  33015. */
  33016. export class _MeshCollisionData {
  33017. _checkCollisions: boolean;
  33018. _collisionMask: number;
  33019. _collisionGroup: number;
  33020. _surroundingMeshes: Nullable<AbstractMesh[]>;
  33021. _collider: Nullable<Collider>;
  33022. _oldPositionForCollisions: Vector3;
  33023. _diffPositionForCollisions: Vector3;
  33024. _onCollideObserver: Nullable<Observer<AbstractMesh>>;
  33025. _onCollisionPositionChangeObserver: Nullable<Observer<Vector3>>;
  33026. }
  33027. }
  33028. declare module "babylonjs/Meshes/abstractMesh" {
  33029. import { Observable } from "babylonjs/Misc/observable";
  33030. import { Nullable, FloatArray, IndicesArray, DeepImmutable } from "babylonjs/types";
  33031. import { Camera } from "babylonjs/Cameras/camera";
  33032. import { Scene, IDisposable } from "babylonjs/scene";
  33033. import { Matrix, Vector3, Vector2 } from "babylonjs/Maths/math.vector";
  33034. import { Node } from "babylonjs/node";
  33035. import { IGetSetVerticesData } from "babylonjs/Meshes/mesh.vertexData";
  33036. import { TransformNode } from "babylonjs/Meshes/transformNode";
  33037. import { SubMesh } from "babylonjs/Meshes/subMesh";
  33038. import { PickingInfo } from "babylonjs/Collisions/pickingInfo";
  33039. import { ICullable, BoundingInfo } from "babylonjs/Culling/boundingInfo";
  33040. import { Material } from "babylonjs/Materials/material";
  33041. import { Light } from "babylonjs/Lights/light";
  33042. import { Skeleton } from "babylonjs/Bones/skeleton";
  33043. import { IEdgesRenderer } from "babylonjs/Rendering/edgesRenderer";
  33044. import { SolidParticle } from "babylonjs/Particles/solidParticle";
  33045. import { AbstractActionManager } from "babylonjs/Actions/abstractActionManager";
  33046. import { RawTexture } from "babylonjs/Materials/Textures/rawTexture";
  33047. import { Color3, Color4 } from "babylonjs/Maths/math.color";
  33048. import { Plane } from "babylonjs/Maths/math.plane";
  33049. import { IParticleSystem } from "babylonjs/Particles/IParticleSystem";
  33050. import { Ray } from "babylonjs/Culling/ray";
  33051. import { Collider } from "babylonjs/Collisions/collider";
  33052. import { TrianglePickingPredicate } from "babylonjs/Culling/ray";
  33053. import { RenderingGroup } from "babylonjs/Rendering/renderingGroup";
  33054. /** @hidden */
  33055. class _FacetDataStorage {
  33056. facetPositions: Vector3[];
  33057. facetNormals: Vector3[];
  33058. facetPartitioning: number[][];
  33059. facetNb: number;
  33060. partitioningSubdivisions: number;
  33061. partitioningBBoxRatio: number;
  33062. facetDataEnabled: boolean;
  33063. facetParameters: any;
  33064. bbSize: Vector3;
  33065. subDiv: {
  33066. max: number;
  33067. X: number;
  33068. Y: number;
  33069. Z: number;
  33070. };
  33071. facetDepthSort: boolean;
  33072. facetDepthSortEnabled: boolean;
  33073. depthSortedIndices: IndicesArray;
  33074. depthSortedFacets: {
  33075. ind: number;
  33076. sqDistance: number;
  33077. }[];
  33078. facetDepthSortFunction: (f1: {
  33079. ind: number;
  33080. sqDistance: number;
  33081. }, f2: {
  33082. ind: number;
  33083. sqDistance: number;
  33084. }) => number;
  33085. facetDepthSortFrom: Vector3;
  33086. facetDepthSortOrigin: Vector3;
  33087. invertedMatrix: Matrix;
  33088. }
  33089. /**
  33090. * @hidden
  33091. **/
  33092. class _InternalAbstractMeshDataInfo {
  33093. _hasVertexAlpha: boolean;
  33094. _useVertexColors: boolean;
  33095. _numBoneInfluencers: number;
  33096. _applyFog: boolean;
  33097. _receiveShadows: boolean;
  33098. _facetData: _FacetDataStorage;
  33099. _visibility: number;
  33100. _skeleton: Nullable<Skeleton>;
  33101. _layerMask: number;
  33102. _computeBonesUsingShaders: boolean;
  33103. _isActive: boolean;
  33104. _onlyForInstances: boolean;
  33105. _isActiveIntermediate: boolean;
  33106. _onlyForInstancesIntermediate: boolean;
  33107. _actAsRegularMesh: boolean;
  33108. }
  33109. /**
  33110. * Class used to store all common mesh properties
  33111. */
  33112. export class AbstractMesh extends TransformNode implements IDisposable, ICullable, IGetSetVerticesData {
  33113. /** No occlusion */
  33114. static OCCLUSION_TYPE_NONE: number;
  33115. /** Occlusion set to optimisitic */
  33116. static OCCLUSION_TYPE_OPTIMISTIC: number;
  33117. /** Occlusion set to strict */
  33118. static OCCLUSION_TYPE_STRICT: number;
  33119. /** Use an accurante occlusion algorithm */
  33120. static OCCLUSION_ALGORITHM_TYPE_ACCURATE: number;
  33121. /** Use a conservative occlusion algorithm */
  33122. static OCCLUSION_ALGORITHM_TYPE_CONSERVATIVE: number;
  33123. /** Default culling strategy : this is an exclusion test and it's the more accurate.
  33124. * Test order :
  33125. * Is the bounding sphere outside the frustum ?
  33126. * If not, are the bounding box vertices outside the frustum ?
  33127. * It not, then the cullable object is in the frustum.
  33128. */
  33129. static readonly CULLINGSTRATEGY_STANDARD: number;
  33130. /** Culling strategy : Bounding Sphere Only.
  33131. * This is an exclusion test. It's faster than the standard strategy because the bounding box is not tested.
  33132. * It's also less accurate than the standard because some not visible objects can still be selected.
  33133. * Test : is the bounding sphere outside the frustum ?
  33134. * If not, then the cullable object is in the frustum.
  33135. */
  33136. static readonly CULLINGSTRATEGY_BOUNDINGSPHERE_ONLY: number;
  33137. /** Culling strategy : Optimistic Inclusion.
  33138. * This in an inclusion test first, then the standard exclusion test.
  33139. * This can be faster when a cullable object is expected to be almost always in the camera frustum.
  33140. * 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.
  33141. * Anyway, it's as accurate as the standard strategy.
  33142. * Test :
  33143. * Is the cullable object bounding sphere center in the frustum ?
  33144. * If not, apply the default culling strategy.
  33145. */
  33146. static readonly CULLINGSTRATEGY_OPTIMISTIC_INCLUSION: number;
  33147. /** Culling strategy : Optimistic Inclusion then Bounding Sphere Only.
  33148. * This in an inclusion test first, then the bounding sphere only exclusion test.
  33149. * This can be the fastest test when a cullable object is expected to be almost always in the camera frustum.
  33150. * 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.
  33151. * It's less accurate than the standard strategy and as accurate as the BoundingSphereOnly strategy.
  33152. * Test :
  33153. * Is the cullable object bounding sphere center in the frustum ?
  33154. * If not, apply the Bounding Sphere Only strategy. No Bounding Box is tested here.
  33155. */
  33156. static readonly CULLINGSTRATEGY_OPTIMISTIC_INCLUSION_THEN_BSPHERE_ONLY: number;
  33157. /**
  33158. * No billboard
  33159. */
  33160. static get BILLBOARDMODE_NONE(): number;
  33161. /** Billboard on X axis */
  33162. static get BILLBOARDMODE_X(): number;
  33163. /** Billboard on Y axis */
  33164. static get BILLBOARDMODE_Y(): number;
  33165. /** Billboard on Z axis */
  33166. static get BILLBOARDMODE_Z(): number;
  33167. /** Billboard on all axes */
  33168. static get BILLBOARDMODE_ALL(): number;
  33169. /** Billboard on using position instead of orientation */
  33170. static get BILLBOARDMODE_USE_POSITION(): number;
  33171. /** @hidden */
  33172. _internalAbstractMeshDataInfo: _InternalAbstractMeshDataInfo;
  33173. /**
  33174. * The culling strategy to use to check whether the mesh must be rendered or not.
  33175. * This value can be changed at any time and will be used on the next render mesh selection.
  33176. * The possible values are :
  33177. * - AbstractMesh.CULLINGSTRATEGY_STANDARD
  33178. * - AbstractMesh.CULLINGSTRATEGY_BOUNDINGSPHERE_ONLY
  33179. * - AbstractMesh.CULLINGSTRATEGY_OPTIMISTIC_INCLUSION
  33180. * - AbstractMesh.CULLINGSTRATEGY_OPTIMISTIC_INCLUSION_THEN_BSPHERE_ONLY
  33181. * Please read each static variable documentation to get details about the culling process.
  33182. * */
  33183. cullingStrategy: number;
  33184. /**
  33185. * Gets the number of facets in the mesh
  33186. * @see https://doc.babylonjs.com/how_to/how_to_use_facetdata#what-is-a-mesh-facet
  33187. */
  33188. get facetNb(): number;
  33189. /**
  33190. * Gets or set the number (integer) of subdivisions per axis in the partioning space
  33191. * @see https://doc.babylonjs.com/how_to/how_to_use_facetdata#tweaking-the-partitioning
  33192. */
  33193. get partitioningSubdivisions(): number;
  33194. set partitioningSubdivisions(nb: number);
  33195. /**
  33196. * The ratio (float) to apply to the bouding box size to set to the partioning space.
  33197. * Ex : 1.01 (default) the partioning space is 1% bigger than the bounding box
  33198. * @see https://doc.babylonjs.com/how_to/how_to_use_facetdata#tweaking-the-partitioning
  33199. */
  33200. get partitioningBBoxRatio(): number;
  33201. set partitioningBBoxRatio(ratio: number);
  33202. /**
  33203. * Gets or sets a boolean indicating that the facets must be depth sorted on next call to `updateFacetData()`.
  33204. * Works only for updatable meshes.
  33205. * Doesn't work with multi-materials
  33206. * @see https://doc.babylonjs.com/how_to/how_to_use_facetdata#facet-depth-sort
  33207. */
  33208. get mustDepthSortFacets(): boolean;
  33209. set mustDepthSortFacets(sort: boolean);
  33210. /**
  33211. * The location (Vector3) where the facet depth sort must be computed from.
  33212. * By default, the active camera position.
  33213. * Used only when facet depth sort is enabled
  33214. * @see https://doc.babylonjs.com/how_to/how_to_use_facetdata#facet-depth-sort
  33215. */
  33216. get facetDepthSortFrom(): Vector3;
  33217. set facetDepthSortFrom(location: Vector3);
  33218. /**
  33219. * gets a boolean indicating if facetData is enabled
  33220. * @see https://doc.babylonjs.com/how_to/how_to_use_facetdata#what-is-a-mesh-facet
  33221. */
  33222. get isFacetDataEnabled(): boolean;
  33223. /** @hidden */
  33224. _updateNonUniformScalingState(value: boolean): boolean;
  33225. /**
  33226. * An event triggered when this mesh collides with another one
  33227. */
  33228. onCollideObservable: Observable<AbstractMesh>;
  33229. /** Set a function to call when this mesh collides with another one */
  33230. set onCollide(callback: () => void);
  33231. /**
  33232. * An event triggered when the collision's position changes
  33233. */
  33234. onCollisionPositionChangeObservable: Observable<Vector3>;
  33235. /** Set a function to call when the collision's position changes */
  33236. set onCollisionPositionChange(callback: () => void);
  33237. /**
  33238. * An event triggered when material is changed
  33239. */
  33240. onMaterialChangedObservable: Observable<AbstractMesh>;
  33241. /**
  33242. * Gets or sets the orientation for POV movement & rotation
  33243. */
  33244. definedFacingForward: boolean;
  33245. /** @hidden */
  33246. _occlusionQuery: Nullable<WebGLQuery>;
  33247. /** @hidden */
  33248. _renderingGroup: Nullable<RenderingGroup>;
  33249. /**
  33250. * Gets or sets mesh visibility between 0 and 1 (default is 1)
  33251. */
  33252. get visibility(): number;
  33253. /**
  33254. * Gets or sets mesh visibility between 0 and 1 (default is 1)
  33255. */
  33256. set visibility(value: number);
  33257. /** Gets or sets the alpha index used to sort transparent meshes
  33258. * @see https://doc.babylonjs.com/resources/transparency_and_how_meshes_are_rendered#alpha-index
  33259. */
  33260. alphaIndex: number;
  33261. /**
  33262. * Gets or sets a boolean indicating if the mesh is visible (renderable). Default is true
  33263. */
  33264. isVisible: boolean;
  33265. /**
  33266. * Gets or sets a boolean indicating if the mesh can be picked (by scene.pick for instance or through actions). Default is true
  33267. */
  33268. isPickable: boolean;
  33269. /** Gets or sets a boolean indicating that bounding boxes of subMeshes must be rendered as well (false by default) */
  33270. showSubMeshesBoundingBox: boolean;
  33271. /** Gets or sets a boolean indicating if the mesh must be considered as a ray blocker for lens flares (false by default)
  33272. * @see https://doc.babylonjs.com/how_to/how_to_use_lens_flares
  33273. */
  33274. isBlocker: boolean;
  33275. /**
  33276. * Gets or sets a boolean indicating that pointer move events must be supported on this mesh (false by default)
  33277. */
  33278. enablePointerMoveEvents: boolean;
  33279. private _renderingGroupId;
  33280. /**
  33281. * Specifies the rendering group id for this mesh (0 by default)
  33282. * @see https://doc.babylonjs.com/resources/transparency_and_how_meshes_are_rendered#rendering-groups
  33283. */
  33284. get renderingGroupId(): number;
  33285. set renderingGroupId(value: number);
  33286. private _material;
  33287. /** Gets or sets current material */
  33288. get material(): Nullable<Material>;
  33289. set material(value: Nullable<Material>);
  33290. /**
  33291. * Gets or sets a boolean indicating that this mesh can receive realtime shadows
  33292. * @see https://doc.babylonjs.com/babylon101/shadows
  33293. */
  33294. get receiveShadows(): boolean;
  33295. set receiveShadows(value: boolean);
  33296. /** Defines color to use when rendering outline */
  33297. outlineColor: Color3;
  33298. /** Define width to use when rendering outline */
  33299. outlineWidth: number;
  33300. /** Defines color to use when rendering overlay */
  33301. overlayColor: Color3;
  33302. /** Defines alpha to use when rendering overlay */
  33303. overlayAlpha: number;
  33304. /** Gets or sets a boolean indicating that this mesh contains vertex color data with alpha values */
  33305. get hasVertexAlpha(): boolean;
  33306. set hasVertexAlpha(value: boolean);
  33307. /** 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) */
  33308. get useVertexColors(): boolean;
  33309. set useVertexColors(value: boolean);
  33310. /**
  33311. * Gets or sets a boolean indicating that bone animations must be computed by the CPU (false by default)
  33312. */
  33313. get computeBonesUsingShaders(): boolean;
  33314. set computeBonesUsingShaders(value: boolean);
  33315. /** Gets or sets the number of allowed bone influences per vertex (4 by default) */
  33316. get numBoneInfluencers(): number;
  33317. set numBoneInfluencers(value: number);
  33318. /** Gets or sets a boolean indicating that this mesh will allow fog to be rendered on it (true by default) */
  33319. get applyFog(): boolean;
  33320. set applyFog(value: boolean);
  33321. /** Gets or sets a boolean indicating that internal octree (if available) can be used to boost submeshes selection (true by default) */
  33322. useOctreeForRenderingSelection: boolean;
  33323. /** Gets or sets a boolean indicating that internal octree (if available) can be used to boost submeshes picking (true by default) */
  33324. useOctreeForPicking: boolean;
  33325. /** Gets or sets a boolean indicating that internal octree (if available) can be used to boost submeshes collision (true by default) */
  33326. useOctreeForCollisions: boolean;
  33327. /**
  33328. * Gets or sets the current layer mask (default is 0x0FFFFFFF)
  33329. * @see https://doc.babylonjs.com/how_to/layermasks_and_multi-cam_textures
  33330. */
  33331. get layerMask(): number;
  33332. set layerMask(value: number);
  33333. /**
  33334. * True if the mesh must be rendered in any case (this will shortcut the frustum clipping phase)
  33335. */
  33336. alwaysSelectAsActiveMesh: boolean;
  33337. /**
  33338. * Gets or sets a boolean indicating that the bounding info does not need to be kept in sync (for performance reason)
  33339. */
  33340. doNotSyncBoundingInfo: boolean;
  33341. /**
  33342. * Gets or sets the current action manager
  33343. * @see https://doc.babylonjs.com/how_to/how_to_use_actions
  33344. */
  33345. actionManager: Nullable<AbstractActionManager>;
  33346. private _meshCollisionData;
  33347. /**
  33348. * Gets or sets the ellipsoid used to impersonate this mesh when using collision engine (default is (0.5, 1, 0.5))
  33349. * @see https://doc.babylonjs.com/babylon101/cameras,_mesh_collisions_and_gravity
  33350. */
  33351. ellipsoid: Vector3;
  33352. /**
  33353. * Gets or sets the ellipsoid offset used to impersonate this mesh when using collision engine (default is (0, 0, 0))
  33354. * @see https://doc.babylonjs.com/babylon101/cameras,_mesh_collisions_and_gravity
  33355. */
  33356. ellipsoidOffset: Vector3;
  33357. /**
  33358. * Gets or sets a collision mask used to mask collisions (default is -1).
  33359. * A collision between A and B will happen if A.collisionGroup & b.collisionMask !== 0
  33360. */
  33361. get collisionMask(): number;
  33362. set collisionMask(mask: number);
  33363. /**
  33364. * Gets or sets the current collision group mask (-1 by default).
  33365. * A collision between A and B will happen if A.collisionGroup & b.collisionMask !== 0
  33366. */
  33367. get collisionGroup(): number;
  33368. set collisionGroup(mask: number);
  33369. /**
  33370. * Gets or sets current surrounding meshes (null by default).
  33371. *
  33372. * By default collision detection is tested against every mesh in the scene.
  33373. * It is possible to set surroundingMeshes to a defined list of meshes and then only these specified
  33374. * meshes will be tested for the collision.
  33375. *
  33376. * Note: if set to an empty array no collision will happen when this mesh is moved.
  33377. */
  33378. get surroundingMeshes(): Nullable<AbstractMesh[]>;
  33379. set surroundingMeshes(meshes: Nullable<AbstractMesh[]>);
  33380. /**
  33381. * Defines edge width used when edgesRenderer is enabled
  33382. * @see https://www.babylonjs-playground.com/#10OJSG#13
  33383. */
  33384. edgesWidth: number;
  33385. /**
  33386. * Defines edge color used when edgesRenderer is enabled
  33387. * @see https://www.babylonjs-playground.com/#10OJSG#13
  33388. */
  33389. edgesColor: Color4;
  33390. /** @hidden */
  33391. _edgesRenderer: Nullable<IEdgesRenderer>;
  33392. /** @hidden */
  33393. _masterMesh: Nullable<AbstractMesh>;
  33394. /** @hidden */
  33395. _boundingInfo: Nullable<BoundingInfo>;
  33396. /** @hidden */
  33397. _renderId: number;
  33398. /**
  33399. * Gets or sets the list of subMeshes
  33400. * @see https://doc.babylonjs.com/how_to/multi_materials
  33401. */
  33402. subMeshes: SubMesh[];
  33403. /** @hidden */
  33404. _intersectionsInProgress: AbstractMesh[];
  33405. /** @hidden */
  33406. _unIndexed: boolean;
  33407. /** @hidden */
  33408. _lightSources: Light[];
  33409. /** Gets the list of lights affecting that mesh */
  33410. get lightSources(): Light[];
  33411. /** @hidden */
  33412. get _positions(): Nullable<Vector3[]>;
  33413. /** @hidden */
  33414. _waitingData: {
  33415. lods: Nullable<any>;
  33416. actions: Nullable<any>;
  33417. freezeWorldMatrix: Nullable<boolean>;
  33418. };
  33419. /** @hidden */
  33420. _bonesTransformMatrices: Nullable<Float32Array>;
  33421. /** @hidden */
  33422. _transformMatrixTexture: Nullable<RawTexture>;
  33423. /**
  33424. * Gets or sets a skeleton to apply skining transformations
  33425. * @see https://doc.babylonjs.com/how_to/how_to_use_bones_and_skeletons
  33426. */
  33427. set skeleton(value: Nullable<Skeleton>);
  33428. get skeleton(): Nullable<Skeleton>;
  33429. /**
  33430. * An event triggered when the mesh is rebuilt.
  33431. */
  33432. onRebuildObservable: Observable<AbstractMesh>;
  33433. /**
  33434. * Creates a new AbstractMesh
  33435. * @param name defines the name of the mesh
  33436. * @param scene defines the hosting scene
  33437. */
  33438. constructor(name: string, scene?: Nullable<Scene>);
  33439. /**
  33440. * Returns the string "AbstractMesh"
  33441. * @returns "AbstractMesh"
  33442. */
  33443. getClassName(): string;
  33444. /**
  33445. * Gets a string representation of the current mesh
  33446. * @param fullDetails defines a boolean indicating if full details must be included
  33447. * @returns a string representation of the current mesh
  33448. */
  33449. toString(fullDetails?: boolean): string;
  33450. /**
  33451. * @hidden
  33452. */
  33453. protected _getEffectiveParent(): Nullable<Node>;
  33454. /** @hidden */
  33455. _getActionManagerForTrigger(trigger?: number, initialCall?: boolean): Nullable<AbstractActionManager>;
  33456. /** @hidden */
  33457. _rebuild(): void;
  33458. /** @hidden */
  33459. _resyncLightSources(): void;
  33460. /** @hidden */
  33461. _resyncLightSource(light: Light): void;
  33462. /** @hidden */
  33463. _unBindEffect(): void;
  33464. /** @hidden */
  33465. _removeLightSource(light: Light, dispose: boolean): void;
  33466. private _markSubMeshesAsDirty;
  33467. /** @hidden */
  33468. _markSubMeshesAsLightDirty(dispose?: boolean): void;
  33469. /** @hidden */
  33470. _markSubMeshesAsAttributesDirty(): void;
  33471. /** @hidden */
  33472. _markSubMeshesAsMiscDirty(): void;
  33473. /**
  33474. * Gets or sets a Vector3 depicting the mesh scaling along each local axis X, Y, Z. Default is (1.0, 1.0, 1.0)
  33475. */
  33476. get scaling(): Vector3;
  33477. set scaling(newScaling: Vector3);
  33478. /**
  33479. * Returns true if the mesh is blocked. Implemented by child classes
  33480. */
  33481. get isBlocked(): boolean;
  33482. /**
  33483. * Returns the mesh itself by default. Implemented by child classes
  33484. * @param camera defines the camera to use to pick the right LOD level
  33485. * @returns the currentAbstractMesh
  33486. */
  33487. getLOD(camera: Camera): Nullable<AbstractMesh>;
  33488. /**
  33489. * Returns 0 by default. Implemented by child classes
  33490. * @returns an integer
  33491. */
  33492. getTotalVertices(): number;
  33493. /**
  33494. * Returns a positive integer : the total number of indices in this mesh geometry.
  33495. * @returns the numner of indices or zero if the mesh has no geometry.
  33496. */
  33497. getTotalIndices(): number;
  33498. /**
  33499. * Returns null by default. Implemented by child classes
  33500. * @returns null
  33501. */
  33502. getIndices(): Nullable<IndicesArray>;
  33503. /**
  33504. * Returns the array of the requested vertex data kind. Implemented by child classes
  33505. * @param kind defines the vertex data kind to use
  33506. * @returns null
  33507. */
  33508. getVerticesData(kind: string): Nullable<FloatArray>;
  33509. /**
  33510. * Sets the vertex data of the mesh geometry for the requested `kind`.
  33511. * If the mesh has no geometry, a new Geometry object is set to the mesh and then passed this vertex data.
  33512. * Note that a new underlying VertexBuffer object is created each call.
  33513. * If the `kind` is the `PositionKind`, the mesh BoundingInfo is renewed, so the bounding box and sphere, and the mesh World Matrix is recomputed.
  33514. * @param kind defines vertex data kind:
  33515. * * VertexBuffer.PositionKind
  33516. * * VertexBuffer.UVKind
  33517. * * VertexBuffer.UV2Kind
  33518. * * VertexBuffer.UV3Kind
  33519. * * VertexBuffer.UV4Kind
  33520. * * VertexBuffer.UV5Kind
  33521. * * VertexBuffer.UV6Kind
  33522. * * VertexBuffer.ColorKind
  33523. * * VertexBuffer.MatricesIndicesKind
  33524. * * VertexBuffer.MatricesIndicesExtraKind
  33525. * * VertexBuffer.MatricesWeightsKind
  33526. * * VertexBuffer.MatricesWeightsExtraKind
  33527. * @param data defines the data source
  33528. * @param updatable defines if the data must be flagged as updatable (or static)
  33529. * @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
  33530. * @returns the current mesh
  33531. */
  33532. setVerticesData(kind: string, data: FloatArray, updatable?: boolean, stride?: number): AbstractMesh;
  33533. /**
  33534. * Updates the existing vertex data of the mesh geometry for the requested `kind`.
  33535. * If the mesh has no geometry, it is simply returned as it is.
  33536. * @param kind defines vertex data kind:
  33537. * * VertexBuffer.PositionKind
  33538. * * VertexBuffer.UVKind
  33539. * * VertexBuffer.UV2Kind
  33540. * * VertexBuffer.UV3Kind
  33541. * * VertexBuffer.UV4Kind
  33542. * * VertexBuffer.UV5Kind
  33543. * * VertexBuffer.UV6Kind
  33544. * * VertexBuffer.ColorKind
  33545. * * VertexBuffer.MatricesIndicesKind
  33546. * * VertexBuffer.MatricesIndicesExtraKind
  33547. * * VertexBuffer.MatricesWeightsKind
  33548. * * VertexBuffer.MatricesWeightsExtraKind
  33549. * @param data defines the data source
  33550. * @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
  33551. * @param makeItUnique If true, a new global geometry is created from this data and is set to the mesh
  33552. * @returns the current mesh
  33553. */
  33554. updateVerticesData(kind: string, data: FloatArray, updateExtends?: boolean, makeItUnique?: boolean): AbstractMesh;
  33555. /**
  33556. * Sets the mesh indices,
  33557. * If the mesh has no geometry, a new Geometry object is created and set to the mesh.
  33558. * @param indices Expects an array populated with integers or a typed array (Int32Array, Uint32Array, Uint16Array)
  33559. * @param totalVertices Defines the total number of vertices
  33560. * @returns the current mesh
  33561. */
  33562. setIndices(indices: IndicesArray, totalVertices: Nullable<number>): AbstractMesh;
  33563. /**
  33564. * Gets a boolean indicating if specific vertex data is present
  33565. * @param kind defines the vertex data kind to use
  33566. * @returns true is data kind is present
  33567. */
  33568. isVerticesDataPresent(kind: string): boolean;
  33569. /**
  33570. * Returns the mesh BoundingInfo object or creates a new one and returns if it was undefined.
  33571. * Note that it returns a shallow bounding of the mesh (i.e. it does not include children).
  33572. * To get the full bounding of all children, call `getHierarchyBoundingVectors` instead.
  33573. * @returns a BoundingInfo
  33574. */
  33575. getBoundingInfo(): BoundingInfo;
  33576. /**
  33577. * Uniformly scales the mesh to fit inside of a unit cube (1 X 1 X 1 units)
  33578. * @param includeDescendants Use the hierarchy's bounding box instead of the mesh's bounding box. Default is false
  33579. * @param ignoreRotation ignore rotation when computing the scale (ie. object will be axis aligned). Default is false
  33580. * @param predicate predicate that is passed in to getHierarchyBoundingVectors when selecting which object should be included when scaling
  33581. * @returns the current mesh
  33582. */
  33583. normalizeToUnitCube(includeDescendants?: boolean, ignoreRotation?: boolean, predicate?: Nullable<(node: AbstractMesh) => boolean>): AbstractMesh;
  33584. /**
  33585. * Overwrite the current bounding info
  33586. * @param boundingInfo defines the new bounding info
  33587. * @returns the current mesh
  33588. */
  33589. setBoundingInfo(boundingInfo: BoundingInfo): AbstractMesh;
  33590. /** Gets a boolean indicating if this mesh has skinning data and an attached skeleton */
  33591. get useBones(): boolean;
  33592. /** @hidden */
  33593. _preActivate(): void;
  33594. /** @hidden */
  33595. _preActivateForIntermediateRendering(renderId: number): void;
  33596. /** @hidden */
  33597. _activate(renderId: number, intermediateRendering: boolean): boolean;
  33598. /** @hidden */
  33599. _postActivate(): void;
  33600. /** @hidden */
  33601. _freeze(): void;
  33602. /** @hidden */
  33603. _unFreeze(): void;
  33604. /**
  33605. * Gets the current world matrix
  33606. * @returns a Matrix
  33607. */
  33608. getWorldMatrix(): Matrix;
  33609. /** @hidden */
  33610. _getWorldMatrixDeterminant(): number;
  33611. /**
  33612. * Gets a boolean indicating if this mesh is an instance or a regular mesh
  33613. */
  33614. get isAnInstance(): boolean;
  33615. /**
  33616. * Gets a boolean indicating if this mesh has instances
  33617. */
  33618. get hasInstances(): boolean;
  33619. /**
  33620. * Gets a boolean indicating if this mesh has thin instances
  33621. */
  33622. get hasThinInstances(): boolean;
  33623. /**
  33624. * Perform relative position change from the point of view of behind the front of the mesh.
  33625. * This is performed taking into account the meshes current rotation, so you do not have to care.
  33626. * Supports definition of mesh facing forward or backward
  33627. * @param amountRight defines the distance on the right axis
  33628. * @param amountUp defines the distance on the up axis
  33629. * @param amountForward defines the distance on the forward axis
  33630. * @returns the current mesh
  33631. */
  33632. movePOV(amountRight: number, amountUp: number, amountForward: number): AbstractMesh;
  33633. /**
  33634. * Calculate relative position change from the point of view of behind the front of the mesh.
  33635. * This is performed taking into account the meshes current rotation, so you do not have to care.
  33636. * Supports definition of mesh facing forward or backward
  33637. * @param amountRight defines the distance on the right axis
  33638. * @param amountUp defines the distance on the up axis
  33639. * @param amountForward defines the distance on the forward axis
  33640. * @returns the new displacement vector
  33641. */
  33642. calcMovePOV(amountRight: number, amountUp: number, amountForward: number): Vector3;
  33643. /**
  33644. * Perform relative rotation change from the point of view of behind the front of the mesh.
  33645. * Supports definition of mesh facing forward or backward
  33646. * @param flipBack defines the flip
  33647. * @param twirlClockwise defines the twirl
  33648. * @param tiltRight defines the tilt
  33649. * @returns the current mesh
  33650. */
  33651. rotatePOV(flipBack: number, twirlClockwise: number, tiltRight: number): AbstractMesh;
  33652. /**
  33653. * Calculate relative rotation change from the point of view of behind the front of the mesh.
  33654. * Supports definition of mesh facing forward or backward.
  33655. * @param flipBack defines the flip
  33656. * @param twirlClockwise defines the twirl
  33657. * @param tiltRight defines the tilt
  33658. * @returns the new rotation vector
  33659. */
  33660. calcRotatePOV(flipBack: number, twirlClockwise: number, tiltRight: number): Vector3;
  33661. /**
  33662. * This method recomputes and sets a new BoundingInfo to the mesh unless it is locked.
  33663. * This means the mesh underlying bounding box and sphere are recomputed.
  33664. * @param applySkeleton defines whether to apply the skeleton before computing the bounding info
  33665. * @returns the current mesh
  33666. */
  33667. refreshBoundingInfo(applySkeleton?: boolean): AbstractMesh;
  33668. /** @hidden */
  33669. _refreshBoundingInfo(data: Nullable<FloatArray>, bias: Nullable<Vector2>): void;
  33670. /** @hidden */
  33671. _getPositionData(applySkeleton: boolean): Nullable<FloatArray>;
  33672. /** @hidden */
  33673. _updateBoundingInfo(): AbstractMesh;
  33674. /** @hidden */
  33675. _updateSubMeshesBoundingInfo(matrix: DeepImmutable<Matrix>): AbstractMesh;
  33676. /** @hidden */
  33677. protected _afterComputeWorldMatrix(): void;
  33678. /** @hidden */
  33679. get _effectiveMesh(): AbstractMesh;
  33680. /**
  33681. * Returns `true` if the mesh is within the frustum defined by the passed array of planes.
  33682. * A mesh is in the frustum if its bounding box intersects the frustum
  33683. * @param frustumPlanes defines the frustum to test
  33684. * @returns true if the mesh is in the frustum planes
  33685. */
  33686. isInFrustum(frustumPlanes: Plane[]): boolean;
  33687. /**
  33688. * Returns `true` if the mesh is completely in the frustum defined be the passed array of planes.
  33689. * A mesh is completely in the frustum if its bounding box it completely inside the frustum.
  33690. * @param frustumPlanes defines the frustum to test
  33691. * @returns true if the mesh is completely in the frustum planes
  33692. */
  33693. isCompletelyInFrustum(frustumPlanes: Plane[]): boolean;
  33694. /**
  33695. * True if the mesh intersects another mesh or a SolidParticle object
  33696. * @param mesh defines a target mesh or SolidParticle to test
  33697. * @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)
  33698. * @param includeDescendants Can be set to true to test if the mesh defined in parameters intersects with the current mesh or any child meshes
  33699. * @returns true if there is an intersection
  33700. */
  33701. intersectsMesh(mesh: AbstractMesh | SolidParticle, precise?: boolean, includeDescendants?: boolean): boolean;
  33702. /**
  33703. * Returns true if the passed point (Vector3) is inside the mesh bounding box
  33704. * @param point defines the point to test
  33705. * @returns true if there is an intersection
  33706. */
  33707. intersectsPoint(point: Vector3): boolean;
  33708. /**
  33709. * Gets or sets a boolean indicating that this mesh can be used in the collision engine
  33710. * @see https://doc.babylonjs.com/babylon101/cameras,_mesh_collisions_and_gravity
  33711. */
  33712. get checkCollisions(): boolean;
  33713. set checkCollisions(collisionEnabled: boolean);
  33714. /**
  33715. * Gets Collider object used to compute collisions (not physics)
  33716. * @see https://doc.babylonjs.com/babylon101/cameras,_mesh_collisions_and_gravity
  33717. */
  33718. get collider(): Nullable<Collider>;
  33719. /**
  33720. * Move the mesh using collision engine
  33721. * @see https://doc.babylonjs.com/babylon101/cameras,_mesh_collisions_and_gravity
  33722. * @param displacement defines the requested displacement vector
  33723. * @returns the current mesh
  33724. */
  33725. moveWithCollisions(displacement: Vector3): AbstractMesh;
  33726. private _onCollisionPositionChange;
  33727. /** @hidden */
  33728. _collideForSubMesh(subMesh: SubMesh, transformMatrix: Matrix, collider: Collider): AbstractMesh;
  33729. /** @hidden */
  33730. _processCollisionsForSubMeshes(collider: Collider, transformMatrix: Matrix): AbstractMesh;
  33731. /** @hidden */
  33732. _checkCollision(collider: Collider): AbstractMesh;
  33733. /** @hidden */
  33734. _generatePointsArray(): boolean;
  33735. /**
  33736. * Checks if the passed Ray intersects with the mesh
  33737. * @param ray defines the ray to use
  33738. * @param fastCheck defines if fast mode (but less precise) must be used (false by default)
  33739. * @param trianglePredicate defines an optional predicate used to select faces when a mesh intersection is detected
  33740. * @param onlyBoundingInfo defines a boolean indicating if picking should only happen using bounding info (false by default)
  33741. * @param worldToUse defines the world matrix to use to get the world coordinate of the intersection point
  33742. * @returns the picking info
  33743. * @see https://doc.babylonjs.com/babylon101/intersect_collisions_-_mesh
  33744. */
  33745. intersects(ray: Ray, fastCheck?: boolean, trianglePredicate?: TrianglePickingPredicate, onlyBoundingInfo?: boolean, worldToUse?: Matrix): PickingInfo;
  33746. /**
  33747. * Clones the current mesh
  33748. * @param name defines the mesh name
  33749. * @param newParent defines the new mesh parent
  33750. * @param doNotCloneChildren defines a boolean indicating that children must not be cloned (false by default)
  33751. * @returns the new mesh
  33752. */
  33753. clone(name: string, newParent: Nullable<Node>, doNotCloneChildren?: boolean): Nullable<AbstractMesh>;
  33754. /**
  33755. * Disposes all the submeshes of the current meshnp
  33756. * @returns the current mesh
  33757. */
  33758. releaseSubMeshes(): AbstractMesh;
  33759. /**
  33760. * Releases resources associated with this abstract mesh.
  33761. * @param doNotRecurse Set to true to not recurse into each children (recurse into each children by default)
  33762. * @param disposeMaterialAndTextures Set to true to also dispose referenced materials and textures (false by default)
  33763. */
  33764. dispose(doNotRecurse?: boolean, disposeMaterialAndTextures?: boolean): void;
  33765. /**
  33766. * Adds the passed mesh as a child to the current mesh
  33767. * @param mesh defines the child mesh
  33768. * @returns the current mesh
  33769. */
  33770. addChild(mesh: AbstractMesh): AbstractMesh;
  33771. /**
  33772. * Removes the passed mesh from the current mesh children list
  33773. * @param mesh defines the child mesh
  33774. * @returns the current mesh
  33775. */
  33776. removeChild(mesh: AbstractMesh): AbstractMesh;
  33777. /** @hidden */
  33778. private _initFacetData;
  33779. /**
  33780. * Updates the mesh facetData arrays and the internal partitioning when the mesh is morphed or updated.
  33781. * This method can be called within the render loop.
  33782. * 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
  33783. * @returns the current mesh
  33784. * @see https://doc.babylonjs.com/how_to/how_to_use_facetdata
  33785. */
  33786. updateFacetData(): AbstractMesh;
  33787. /**
  33788. * Returns the facetLocalNormals array.
  33789. * The normals are expressed in the mesh local spac
  33790. * @returns an array of Vector3
  33791. * @see https://doc.babylonjs.com/how_to/how_to_use_facetdata
  33792. */
  33793. getFacetLocalNormals(): Vector3[];
  33794. /**
  33795. * Returns the facetLocalPositions array.
  33796. * The facet positions are expressed in the mesh local space
  33797. * @returns an array of Vector3
  33798. * @see https://doc.babylonjs.com/how_to/how_to_use_facetdata
  33799. */
  33800. getFacetLocalPositions(): Vector3[];
  33801. /**
  33802. * Returns the facetLocalPartioning array
  33803. * @returns an array of array of numbers
  33804. * @see https://doc.babylonjs.com/how_to/how_to_use_facetdata
  33805. */
  33806. getFacetLocalPartitioning(): number[][];
  33807. /**
  33808. * Returns the i-th facet position in the world system.
  33809. * This method allocates a new Vector3 per call
  33810. * @param i defines the facet index
  33811. * @returns a new Vector3
  33812. * @see https://doc.babylonjs.com/how_to/how_to_use_facetdata
  33813. */
  33814. getFacetPosition(i: number): Vector3;
  33815. /**
  33816. * Sets the reference Vector3 with the i-th facet position in the world system
  33817. * @param i defines the facet index
  33818. * @param ref defines the target vector
  33819. * @returns the current mesh
  33820. * @see https://doc.babylonjs.com/how_to/how_to_use_facetdata
  33821. */
  33822. getFacetPositionToRef(i: number, ref: Vector3): AbstractMesh;
  33823. /**
  33824. * Returns the i-th facet normal in the world system.
  33825. * This method allocates a new Vector3 per call
  33826. * @param i defines the facet index
  33827. * @returns a new Vector3
  33828. * @see https://doc.babylonjs.com/how_to/how_to_use_facetdata
  33829. */
  33830. getFacetNormal(i: number): Vector3;
  33831. /**
  33832. * Sets the reference Vector3 with the i-th facet normal in the world system
  33833. * @param i defines the facet index
  33834. * @param ref defines the target vector
  33835. * @returns the current mesh
  33836. * @see https://doc.babylonjs.com/how_to/how_to_use_facetdata
  33837. */
  33838. getFacetNormalToRef(i: number, ref: Vector3): this;
  33839. /**
  33840. * 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)
  33841. * @param x defines x coordinate
  33842. * @param y defines y coordinate
  33843. * @param z defines z coordinate
  33844. * @returns the array of facet indexes
  33845. * @see https://doc.babylonjs.com/how_to/how_to_use_facetdata
  33846. */
  33847. getFacetsAtLocalCoordinates(x: number, y: number, z: number): Nullable<number[]>;
  33848. /**
  33849. * Returns the closest mesh facet index at (x,y,z) World coordinates, null if not found
  33850. * @param projected sets as the (x,y,z) world projection on the facet
  33851. * @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
  33852. * @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
  33853. * @param x defines x coordinate
  33854. * @param y defines y coordinate
  33855. * @param z defines z coordinate
  33856. * @returns the face index if found (or null instead)
  33857. * @see https://doc.babylonjs.com/how_to/how_to_use_facetdata
  33858. */
  33859. getClosestFacetAtCoordinates(x: number, y: number, z: number, projected?: Vector3, checkFace?: boolean, facing?: boolean): Nullable<number>;
  33860. /**
  33861. * Returns the closest mesh facet index at (x,y,z) local coordinates, null if not found
  33862. * @param projected sets as the (x,y,z) local projection on the facet
  33863. * @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
  33864. * @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
  33865. * @param x defines x coordinate
  33866. * @param y defines y coordinate
  33867. * @param z defines z coordinate
  33868. * @returns the face index if found (or null instead)
  33869. * @see https://doc.babylonjs.com/how_to/how_to_use_facetdata
  33870. */
  33871. getClosestFacetAtLocalCoordinates(x: number, y: number, z: number, projected?: Vector3, checkFace?: boolean, facing?: boolean): Nullable<number>;
  33872. /**
  33873. * Returns the object "parameter" set with all the expected parameters for facetData computation by ComputeNormals()
  33874. * @returns the parameters
  33875. * @see https://doc.babylonjs.com/how_to/how_to_use_facetdata
  33876. */
  33877. getFacetDataParameters(): any;
  33878. /**
  33879. * Disables the feature FacetData and frees the related memory
  33880. * @returns the current mesh
  33881. * @see https://doc.babylonjs.com/how_to/how_to_use_facetdata
  33882. */
  33883. disableFacetData(): AbstractMesh;
  33884. /**
  33885. * Updates the AbstractMesh indices array
  33886. * @param indices defines the data source
  33887. * @param offset defines the offset in the index buffer where to store the new data (can be null)
  33888. * @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)
  33889. * @returns the current mesh
  33890. */
  33891. updateIndices(indices: IndicesArray, offset?: number, gpuMemoryOnly?: boolean): AbstractMesh;
  33892. /**
  33893. * Creates new normals data for the mesh
  33894. * @param updatable defines if the normal vertex buffer must be flagged as updatable
  33895. * @returns the current mesh
  33896. */
  33897. createNormals(updatable: boolean): AbstractMesh;
  33898. /**
  33899. * Align the mesh with a normal
  33900. * @param normal defines the normal to use
  33901. * @param upDirection can be used to redefined the up vector to use (will use the (0, 1, 0) by default)
  33902. * @returns the current mesh
  33903. */
  33904. alignWithNormal(normal: Vector3, upDirection?: Vector3): AbstractMesh;
  33905. /** @hidden */
  33906. _checkOcclusionQuery(): boolean;
  33907. /**
  33908. * Disables the mesh edge rendering mode
  33909. * @returns the currentAbstractMesh
  33910. */
  33911. disableEdgesRendering(): AbstractMesh;
  33912. /**
  33913. * Enables the edge rendering mode on the mesh.
  33914. * This mode makes the mesh edges visible
  33915. * @param epsilon defines the maximal distance between two angles to detect a face
  33916. * @param checkVerticesInsteadOfIndices indicates that we should check vertex list directly instead of faces
  33917. * @returns the currentAbstractMesh
  33918. * @see https://www.babylonjs-playground.com/#19O9TU#0
  33919. */
  33920. enableEdgesRendering(epsilon?: number, checkVerticesInsteadOfIndices?: boolean): AbstractMesh;
  33921. /**
  33922. * This function returns all of the particle systems in the scene that use the mesh as an emitter.
  33923. * @returns an array of particle systems in the scene that use the mesh as an emitter
  33924. */
  33925. getConnectedParticleSystems(): IParticleSystem[];
  33926. }
  33927. }
  33928. declare module "babylonjs/Actions/actionEvent" {
  33929. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  33930. import { Nullable } from "babylonjs/types";
  33931. import { Sprite } from "babylonjs/Sprites/sprite";
  33932. import { Scene } from "babylonjs/scene";
  33933. import { Vector2 } from "babylonjs/Maths/math.vector";
  33934. /**
  33935. * Interface used to define ActionEvent
  33936. */
  33937. export interface IActionEvent {
  33938. /** The mesh or sprite that triggered the action */
  33939. source: any;
  33940. /** The X mouse cursor position at the time of the event */
  33941. pointerX: number;
  33942. /** The Y mouse cursor position at the time of the event */
  33943. pointerY: number;
  33944. /** The mesh that is currently pointed at (can be null) */
  33945. meshUnderPointer: Nullable<AbstractMesh>;
  33946. /** the original (browser) event that triggered the ActionEvent */
  33947. sourceEvent?: any;
  33948. /** additional data for the event */
  33949. additionalData?: any;
  33950. }
  33951. /**
  33952. * ActionEvent is the event being sent when an action is triggered.
  33953. */
  33954. export class ActionEvent implements IActionEvent {
  33955. /** The mesh or sprite that triggered the action */
  33956. source: any;
  33957. /** The X mouse cursor position at the time of the event */
  33958. pointerX: number;
  33959. /** The Y mouse cursor position at the time of the event */
  33960. pointerY: number;
  33961. /** The mesh that is currently pointed at (can be null) */
  33962. meshUnderPointer: Nullable<AbstractMesh>;
  33963. /** the original (browser) event that triggered the ActionEvent */
  33964. sourceEvent?: any;
  33965. /** additional data for the event */
  33966. additionalData?: any;
  33967. /**
  33968. * Creates a new ActionEvent
  33969. * @param source The mesh or sprite that triggered the action
  33970. * @param pointerX The X mouse cursor position at the time of the event
  33971. * @param pointerY The Y mouse cursor position at the time of the event
  33972. * @param meshUnderPointer The mesh that is currently pointed at (can be null)
  33973. * @param sourceEvent the original (browser) event that triggered the ActionEvent
  33974. * @param additionalData additional data for the event
  33975. */
  33976. constructor(
  33977. /** The mesh or sprite that triggered the action */
  33978. source: any,
  33979. /** The X mouse cursor position at the time of the event */
  33980. pointerX: number,
  33981. /** The Y mouse cursor position at the time of the event */
  33982. pointerY: number,
  33983. /** The mesh that is currently pointed at (can be null) */
  33984. meshUnderPointer: Nullable<AbstractMesh>,
  33985. /** the original (browser) event that triggered the ActionEvent */
  33986. sourceEvent?: any,
  33987. /** additional data for the event */
  33988. additionalData?: any);
  33989. /**
  33990. * Helper function to auto-create an ActionEvent from a source mesh.
  33991. * @param source The source mesh that triggered the event
  33992. * @param evt The original (browser) event
  33993. * @param additionalData additional data for the event
  33994. * @returns the new ActionEvent
  33995. */
  33996. static CreateNew(source: AbstractMesh, evt?: Event, additionalData?: any): ActionEvent;
  33997. /**
  33998. * Helper function to auto-create an ActionEvent from a source sprite
  33999. * @param source The source sprite that triggered the event
  34000. * @param scene Scene associated with the sprite
  34001. * @param evt The original (browser) event
  34002. * @param additionalData additional data for the event
  34003. * @returns the new ActionEvent
  34004. */
  34005. static CreateNewFromSprite(source: Sprite, scene: Scene, evt?: Event, additionalData?: any): ActionEvent;
  34006. /**
  34007. * Helper function to auto-create an ActionEvent from a scene. If triggered by a mesh use ActionEvent.CreateNew
  34008. * @param scene the scene where the event occurred
  34009. * @param evt The original (browser) event
  34010. * @returns the new ActionEvent
  34011. */
  34012. static CreateNewFromScene(scene: Scene, evt: Event): ActionEvent;
  34013. /**
  34014. * Helper function to auto-create an ActionEvent from a primitive
  34015. * @param prim defines the target primitive
  34016. * @param pointerPos defines the pointer position
  34017. * @param evt The original (browser) event
  34018. * @param additionalData additional data for the event
  34019. * @returns the new ActionEvent
  34020. */
  34021. static CreateNewFromPrimitive(prim: any, pointerPos: Vector2, evt?: Event, additionalData?: any): ActionEvent;
  34022. }
  34023. }
  34024. declare module "babylonjs/Actions/abstractActionManager" {
  34025. import { IDisposable } from "babylonjs/scene";
  34026. import { IActionEvent } from "babylonjs/Actions/actionEvent";
  34027. import { IAction } from "babylonjs/Actions/action";
  34028. import { Nullable } from "babylonjs/types";
  34029. /**
  34030. * Abstract class used to decouple action Manager from scene and meshes.
  34031. * Do not instantiate.
  34032. * @see https://doc.babylonjs.com/how_to/how_to_use_actions
  34033. */
  34034. export abstract class AbstractActionManager implements IDisposable {
  34035. /** Gets the list of active triggers */
  34036. static Triggers: {
  34037. [key: string]: number;
  34038. };
  34039. /** Gets the cursor to use when hovering items */
  34040. hoverCursor: string;
  34041. /** Gets the list of actions */
  34042. actions: IAction[];
  34043. /**
  34044. * Gets or sets a boolean indicating that the manager is recursive meaning that it can trigger action from children
  34045. */
  34046. isRecursive: boolean;
  34047. /**
  34048. * Releases all associated resources
  34049. */
  34050. abstract dispose(): void;
  34051. /**
  34052. * Does this action manager has pointer triggers
  34053. */
  34054. abstract get hasPointerTriggers(): boolean;
  34055. /**
  34056. * Does this action manager has pick triggers
  34057. */
  34058. abstract get hasPickTriggers(): boolean;
  34059. /**
  34060. * Process a specific trigger
  34061. * @param trigger defines the trigger to process
  34062. * @param evt defines the event details to be processed
  34063. */
  34064. abstract processTrigger(trigger: number, evt?: IActionEvent): void;
  34065. /**
  34066. * Does this action manager handles actions of any of the given triggers
  34067. * @param triggers defines the triggers to be tested
  34068. * @return a boolean indicating whether one (or more) of the triggers is handled
  34069. */
  34070. abstract hasSpecificTriggers(triggers: number[]): boolean;
  34071. /**
  34072. * Does this action manager handles actions of any of the given triggers. This function takes two arguments for
  34073. * speed.
  34074. * @param triggerA defines the trigger to be tested
  34075. * @param triggerB defines the trigger to be tested
  34076. * @return a boolean indicating whether one (or more) of the triggers is handled
  34077. */
  34078. abstract hasSpecificTriggers2(triggerA: number, triggerB: number): boolean;
  34079. /**
  34080. * Does this action manager handles actions of a given trigger
  34081. * @param trigger defines the trigger to be tested
  34082. * @param parameterPredicate defines an optional predicate to filter triggers by parameter
  34083. * @return whether the trigger is handled
  34084. */
  34085. abstract hasSpecificTrigger(trigger: number, parameterPredicate?: (parameter: any) => boolean): boolean;
  34086. /**
  34087. * Serialize this manager to a JSON object
  34088. * @param name defines the property name to store this manager
  34089. * @returns a JSON representation of this manager
  34090. */
  34091. abstract serialize(name: string): any;
  34092. /**
  34093. * Registers an action to this action manager
  34094. * @param action defines the action to be registered
  34095. * @return the action amended (prepared) after registration
  34096. */
  34097. abstract registerAction(action: IAction): Nullable<IAction>;
  34098. /**
  34099. * Unregisters an action to this action manager
  34100. * @param action defines the action to be unregistered
  34101. * @return a boolean indicating whether the action has been unregistered
  34102. */
  34103. abstract unregisterAction(action: IAction): Boolean;
  34104. /**
  34105. * Does exist one action manager with at least one trigger
  34106. **/
  34107. static get HasTriggers(): boolean;
  34108. /**
  34109. * Does exist one action manager with at least one pick trigger
  34110. **/
  34111. static get HasPickTriggers(): boolean;
  34112. /**
  34113. * Does exist one action manager that handles actions of a given trigger
  34114. * @param trigger defines the trigger to be tested
  34115. * @return a boolean indicating whether the trigger is handeled by at least one action manager
  34116. **/
  34117. static HasSpecificTrigger(trigger: number): boolean;
  34118. }
  34119. }
  34120. declare module "babylonjs/node" {
  34121. import { Scene } from "babylonjs/scene";
  34122. import { Nullable } from "babylonjs/types";
  34123. import { Matrix, Vector3 } from "babylonjs/Maths/math.vector";
  34124. import { Engine } from "babylonjs/Engines/engine";
  34125. import { IBehaviorAware, Behavior } from "babylonjs/Behaviors/behavior";
  34126. import { Observable } from "babylonjs/Misc/observable";
  34127. import { AbstractActionManager } from "babylonjs/Actions/abstractActionManager";
  34128. import { IInspectable } from "babylonjs/Misc/iInspectable";
  34129. import { Animatable } from "babylonjs/Animations/animatable";
  34130. import { AnimationPropertiesOverride } from "babylonjs/Animations/animationPropertiesOverride";
  34131. import { Animation } from "babylonjs/Animations/animation";
  34132. import { AnimationRange } from "babylonjs/Animations/animationRange";
  34133. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  34134. /**
  34135. * Defines how a node can be built from a string name.
  34136. */
  34137. export type NodeConstructor = (name: string, scene: Scene, options?: any) => () => Node;
  34138. /**
  34139. * Node is the basic class for all scene objects (Mesh, Light, Camera.)
  34140. */
  34141. export class Node implements IBehaviorAware<Node> {
  34142. /** @hidden */
  34143. static _AnimationRangeFactory: (name: string, from: number, to: number) => AnimationRange;
  34144. private static _NodeConstructors;
  34145. /**
  34146. * Add a new node constructor
  34147. * @param type defines the type name of the node to construct
  34148. * @param constructorFunc defines the constructor function
  34149. */
  34150. static AddNodeConstructor(type: string, constructorFunc: NodeConstructor): void;
  34151. /**
  34152. * Returns a node constructor based on type name
  34153. * @param type defines the type name
  34154. * @param name defines the new node name
  34155. * @param scene defines the hosting scene
  34156. * @param options defines optional options to transmit to constructors
  34157. * @returns the new constructor or null
  34158. */
  34159. static Construct(type: string, name: string, scene: Scene, options?: any): Nullable<() => Node>;
  34160. /**
  34161. * Gets or sets the name of the node
  34162. */
  34163. name: string;
  34164. /**
  34165. * Gets or sets the id of the node
  34166. */
  34167. id: string;
  34168. /**
  34169. * Gets or sets the unique id of the node
  34170. */
  34171. uniqueId: number;
  34172. /**
  34173. * Gets or sets a string used to store user defined state for the node
  34174. */
  34175. state: string;
  34176. /**
  34177. * Gets or sets an object used to store user defined information for the node
  34178. */
  34179. metadata: any;
  34180. /**
  34181. * For internal use only. Please do not use.
  34182. */
  34183. reservedDataStore: any;
  34184. /**
  34185. * List of inspectable custom properties (used by the Inspector)
  34186. * @see https://doc.babylonjs.com/how_to/debug_layer#extensibility
  34187. */
  34188. inspectableCustomProperties: IInspectable[];
  34189. private _doNotSerialize;
  34190. /**
  34191. * Gets or sets a boolean used to define if the node must be serialized
  34192. */
  34193. get doNotSerialize(): boolean;
  34194. set doNotSerialize(value: boolean);
  34195. /** @hidden */
  34196. _isDisposed: boolean;
  34197. /**
  34198. * Gets a list of Animations associated with the node
  34199. */
  34200. animations: import("babylonjs/Animations/animation").Animation[];
  34201. protected _ranges: {
  34202. [name: string]: Nullable<AnimationRange>;
  34203. };
  34204. /**
  34205. * Callback raised when the node is ready to be used
  34206. */
  34207. onReady: Nullable<(node: Node) => void>;
  34208. private _isEnabled;
  34209. private _isParentEnabled;
  34210. private _isReady;
  34211. /** @hidden */
  34212. _currentRenderId: number;
  34213. private _parentUpdateId;
  34214. /** @hidden */
  34215. _childUpdateId: number;
  34216. /** @hidden */
  34217. _waitingParentId: Nullable<string>;
  34218. /** @hidden */
  34219. _scene: Scene;
  34220. /** @hidden */
  34221. _cache: any;
  34222. private _parentNode;
  34223. private _children;
  34224. /** @hidden */
  34225. _worldMatrix: Matrix;
  34226. /** @hidden */
  34227. _worldMatrixDeterminant: number;
  34228. /** @hidden */
  34229. _worldMatrixDeterminantIsDirty: boolean;
  34230. /** @hidden */
  34231. private _sceneRootNodesIndex;
  34232. /**
  34233. * Gets a boolean indicating if the node has been disposed
  34234. * @returns true if the node was disposed
  34235. */
  34236. isDisposed(): boolean;
  34237. /**
  34238. * Gets or sets the parent of the node (without keeping the current position in the scene)
  34239. * @see https://doc.babylonjs.com/how_to/parenting
  34240. */
  34241. set parent(parent: Nullable<Node>);
  34242. get parent(): Nullable<Node>;
  34243. /** @hidden */
  34244. _addToSceneRootNodes(): void;
  34245. /** @hidden */
  34246. _removeFromSceneRootNodes(): void;
  34247. private _animationPropertiesOverride;
  34248. /**
  34249. * Gets or sets the animation properties override
  34250. */
  34251. get animationPropertiesOverride(): Nullable<AnimationPropertiesOverride>;
  34252. set animationPropertiesOverride(value: Nullable<AnimationPropertiesOverride>);
  34253. /**
  34254. * Gets a string identifying the name of the class
  34255. * @returns "Node" string
  34256. */
  34257. getClassName(): string;
  34258. /** @hidden */
  34259. readonly _isNode: boolean;
  34260. /**
  34261. * An event triggered when the mesh is disposed
  34262. */
  34263. onDisposeObservable: Observable<Node>;
  34264. private _onDisposeObserver;
  34265. /**
  34266. * Sets a callback that will be raised when the node will be disposed
  34267. */
  34268. set onDispose(callback: () => void);
  34269. /**
  34270. * Creates a new Node
  34271. * @param name the name and id to be given to this node
  34272. * @param scene the scene this node will be added to
  34273. */
  34274. constructor(name: string, scene?: Nullable<Scene>);
  34275. /**
  34276. * Gets the scene of the node
  34277. * @returns a scene
  34278. */
  34279. getScene(): Scene;
  34280. /**
  34281. * Gets the engine of the node
  34282. * @returns a Engine
  34283. */
  34284. getEngine(): Engine;
  34285. private _behaviors;
  34286. /**
  34287. * Attach a behavior to the node
  34288. * @see https://doc.babylonjs.com/features/behaviour
  34289. * @param behavior defines the behavior to attach
  34290. * @param attachImmediately defines that the behavior must be attached even if the scene is still loading
  34291. * @returns the current Node
  34292. */
  34293. addBehavior(behavior: Behavior<Node>, attachImmediately?: boolean): Node;
  34294. /**
  34295. * Remove an attached behavior
  34296. * @see https://doc.babylonjs.com/features/behaviour
  34297. * @param behavior defines the behavior to attach
  34298. * @returns the current Node
  34299. */
  34300. removeBehavior(behavior: Behavior<Node>): Node;
  34301. /**
  34302. * Gets the list of attached behaviors
  34303. * @see https://doc.babylonjs.com/features/behaviour
  34304. */
  34305. get behaviors(): Behavior<Node>[];
  34306. /**
  34307. * Gets an attached behavior by name
  34308. * @param name defines the name of the behavior to look for
  34309. * @see https://doc.babylonjs.com/features/behaviour
  34310. * @returns null if behavior was not found else the requested behavior
  34311. */
  34312. getBehaviorByName(name: string): Nullable<Behavior<Node>>;
  34313. /**
  34314. * Returns the latest update of the World matrix
  34315. * @returns a Matrix
  34316. */
  34317. getWorldMatrix(): Matrix;
  34318. /** @hidden */
  34319. _getWorldMatrixDeterminant(): number;
  34320. /**
  34321. * Returns directly the latest state of the mesh World matrix.
  34322. * A Matrix is returned.
  34323. */
  34324. get worldMatrixFromCache(): Matrix;
  34325. /** @hidden */
  34326. _initCache(): void;
  34327. /** @hidden */
  34328. updateCache(force?: boolean): void;
  34329. /** @hidden */
  34330. _getActionManagerForTrigger(trigger?: number, initialCall?: boolean): Nullable<AbstractActionManager>;
  34331. /** @hidden */
  34332. _updateCache(ignoreParentClass?: boolean): void;
  34333. /** @hidden */
  34334. _isSynchronized(): boolean;
  34335. /** @hidden */
  34336. _markSyncedWithParent(): void;
  34337. /** @hidden */
  34338. isSynchronizedWithParent(): boolean;
  34339. /** @hidden */
  34340. isSynchronized(): boolean;
  34341. /**
  34342. * Is this node ready to be used/rendered
  34343. * @param completeCheck defines if a complete check (including materials and lights) has to be done (false by default)
  34344. * @return true if the node is ready
  34345. */
  34346. isReady(completeCheck?: boolean): boolean;
  34347. /**
  34348. * Is this node enabled?
  34349. * 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
  34350. * @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
  34351. * @return whether this node (and its parent) is enabled
  34352. */
  34353. isEnabled(checkAncestors?: boolean): boolean;
  34354. /** @hidden */
  34355. protected _syncParentEnabledState(): void;
  34356. /**
  34357. * Set the enabled state of this node
  34358. * @param value defines the new enabled state
  34359. */
  34360. setEnabled(value: boolean): void;
  34361. /**
  34362. * Is this node a descendant of the given node?
  34363. * The function will iterate up the hierarchy until the ancestor was found or no more parents defined
  34364. * @param ancestor defines the parent node to inspect
  34365. * @returns a boolean indicating if this node is a descendant of the given node
  34366. */
  34367. isDescendantOf(ancestor: Node): boolean;
  34368. /** @hidden */
  34369. _getDescendants(results: Node[], directDescendantsOnly?: boolean, predicate?: (node: Node) => boolean): void;
  34370. /**
  34371. * Will return all nodes that have this node as ascendant
  34372. * @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
  34373. * @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
  34374. * @return all children nodes of all types
  34375. */
  34376. getDescendants(directDescendantsOnly?: boolean, predicate?: (node: Node) => boolean): Node[];
  34377. /**
  34378. * Get all child-meshes of this node
  34379. * @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)
  34380. * @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
  34381. * @returns an array of AbstractMesh
  34382. */
  34383. getChildMeshes(directDescendantsOnly?: boolean, predicate?: (node: Node) => boolean): AbstractMesh[];
  34384. /**
  34385. * Get all direct children of this node
  34386. * @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
  34387. * @param directDescendantsOnly defines if true only direct descendants of 'this' will be considered, if false direct and also indirect (children of children, an so on in a recursive manner) descendants of 'this' will be considered (Default: true)
  34388. * @returns an array of Node
  34389. */
  34390. getChildren(predicate?: (node: Node) => boolean, directDescendantsOnly?: boolean): Node[];
  34391. /** @hidden */
  34392. _setReady(state: boolean): void;
  34393. /**
  34394. * Get an animation by name
  34395. * @param name defines the name of the animation to look for
  34396. * @returns null if not found else the requested animation
  34397. */
  34398. getAnimationByName(name: string): Nullable<Animation>;
  34399. /**
  34400. * Creates an animation range for this node
  34401. * @param name defines the name of the range
  34402. * @param from defines the starting key
  34403. * @param to defines the end key
  34404. */
  34405. createAnimationRange(name: string, from: number, to: number): void;
  34406. /**
  34407. * Delete a specific animation range
  34408. * @param name defines the name of the range to delete
  34409. * @param deleteFrames defines if animation frames from the range must be deleted as well
  34410. */
  34411. deleteAnimationRange(name: string, deleteFrames?: boolean): void;
  34412. /**
  34413. * Get an animation range by name
  34414. * @param name defines the name of the animation range to look for
  34415. * @returns null if not found else the requested animation range
  34416. */
  34417. getAnimationRange(name: string): Nullable<AnimationRange>;
  34418. /**
  34419. * Gets the list of all animation ranges defined on this node
  34420. * @returns an array
  34421. */
  34422. getAnimationRanges(): Nullable<AnimationRange>[];
  34423. /**
  34424. * Will start the animation sequence
  34425. * @param name defines the range frames for animation sequence
  34426. * @param loop defines if the animation should loop (false by default)
  34427. * @param speedRatio defines the speed factor in which to run the animation (1 by default)
  34428. * @param onAnimationEnd defines a function to be executed when the animation ended (undefined by default)
  34429. * @returns the object created for this animation. If range does not exist, it will return null
  34430. */
  34431. beginAnimation(name: string, loop?: boolean, speedRatio?: number, onAnimationEnd?: () => void): Nullable<Animatable>;
  34432. /**
  34433. * Serialize animation ranges into a JSON compatible object
  34434. * @returns serialization object
  34435. */
  34436. serializeAnimationRanges(): any;
  34437. /**
  34438. * Computes the world matrix of the node
  34439. * @param force defines if the cache version should be invalidated forcing the world matrix to be created from scratch
  34440. * @returns the world matrix
  34441. */
  34442. computeWorldMatrix(force?: boolean): Matrix;
  34443. /**
  34444. * Releases resources associated with this node.
  34445. * @param doNotRecurse Set to true to not recurse into each children (recurse into each children by default)
  34446. * @param disposeMaterialAndTextures Set to true to also dispose referenced materials and textures (false by default)
  34447. */
  34448. dispose(doNotRecurse?: boolean, disposeMaterialAndTextures?: boolean): void;
  34449. /**
  34450. * Parse animation range data from a serialization object and store them into a given node
  34451. * @param node defines where to store the animation ranges
  34452. * @param parsedNode defines the serialization object to read data from
  34453. * @param scene defines the hosting scene
  34454. */
  34455. static ParseAnimationRanges(node: Node, parsedNode: any, scene: Scene): void;
  34456. /**
  34457. * Return the minimum and maximum world vectors of the entire hierarchy under current node
  34458. * @param includeDescendants Include bounding info from descendants as well (true by default)
  34459. * @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
  34460. * @returns the new bounding vectors
  34461. */
  34462. getHierarchyBoundingVectors(includeDescendants?: boolean, predicate?: Nullable<(abstractMesh: AbstractMesh) => boolean>): {
  34463. min: Vector3;
  34464. max: Vector3;
  34465. };
  34466. }
  34467. }
  34468. declare module "babylonjs/Animations/animation" {
  34469. import { IEasingFunction, EasingFunction } from "babylonjs/Animations/easing";
  34470. import { Vector3, Quaternion, Vector2, Matrix } from "babylonjs/Maths/math.vector";
  34471. import { Color3, Color4 } from "babylonjs/Maths/math.color";
  34472. import { Nullable } from "babylonjs/types";
  34473. import { Scene } from "babylonjs/scene";
  34474. import { IAnimationKey } from "babylonjs/Animations/animationKey";
  34475. import { AnimationRange } from "babylonjs/Animations/animationRange";
  34476. import { AnimationEvent } from "babylonjs/Animations/animationEvent";
  34477. import { Node } from "babylonjs/node";
  34478. import { IAnimatable } from "babylonjs/Animations/animatable.interface";
  34479. import { Size } from "babylonjs/Maths/math.size";
  34480. import { Animatable } from "babylonjs/Animations/animatable";
  34481. import { RuntimeAnimation } from "babylonjs/Animations/runtimeAnimation";
  34482. /**
  34483. * @hidden
  34484. */
  34485. export class _IAnimationState {
  34486. key: number;
  34487. repeatCount: number;
  34488. workValue?: any;
  34489. loopMode?: number;
  34490. offsetValue?: any;
  34491. highLimitValue?: any;
  34492. }
  34493. /**
  34494. * Class used to store any kind of animation
  34495. */
  34496. export class Animation {
  34497. /**Name of the animation */
  34498. name: string;
  34499. /**Property to animate */
  34500. targetProperty: string;
  34501. /**The frames per second of the animation */
  34502. framePerSecond: number;
  34503. /**The data type of the animation */
  34504. dataType: number;
  34505. /**The loop mode of the animation */
  34506. loopMode?: number | undefined;
  34507. /**Specifies if blending should be enabled */
  34508. enableBlending?: boolean | undefined;
  34509. /**
  34510. * Use matrix interpolation instead of using direct key value when animating matrices
  34511. */
  34512. static AllowMatricesInterpolation: boolean;
  34513. /**
  34514. * When matrix interpolation is enabled, this boolean forces the system to use Matrix.DecomposeLerp instead of Matrix.Lerp. Interpolation is more precise but slower
  34515. */
  34516. static AllowMatrixDecomposeForInterpolation: boolean;
  34517. /** Define the Url to load snippets */
  34518. static SnippetUrl: string;
  34519. /** Snippet ID if the animation was created from the snippet server */
  34520. snippetId: string;
  34521. /**
  34522. * Stores the key frames of the animation
  34523. */
  34524. private _keys;
  34525. /**
  34526. * Stores the easing function of the animation
  34527. */
  34528. private _easingFunction;
  34529. /**
  34530. * @hidden Internal use only
  34531. */
  34532. _runtimeAnimations: import("babylonjs/Animations/runtimeAnimation").RuntimeAnimation[];
  34533. /**
  34534. * The set of event that will be linked to this animation
  34535. */
  34536. private _events;
  34537. /**
  34538. * Stores an array of target property paths
  34539. */
  34540. targetPropertyPath: string[];
  34541. /**
  34542. * Stores the blending speed of the animation
  34543. */
  34544. blendingSpeed: number;
  34545. /**
  34546. * Stores the animation ranges for the animation
  34547. */
  34548. private _ranges;
  34549. /**
  34550. * @hidden Internal use
  34551. */
  34552. static _PrepareAnimation(name: string, targetProperty: string, framePerSecond: number, totalFrame: number, from: any, to: any, loopMode?: number, easingFunction?: EasingFunction): Nullable<Animation>;
  34553. /**
  34554. * Sets up an animation
  34555. * @param property The property to animate
  34556. * @param animationType The animation type to apply
  34557. * @param framePerSecond The frames per second of the animation
  34558. * @param easingFunction The easing function used in the animation
  34559. * @returns The created animation
  34560. */
  34561. static CreateAnimation(property: string, animationType: number, framePerSecond: number, easingFunction: EasingFunction): Animation;
  34562. /**
  34563. * Create and start an animation on a node
  34564. * @param name defines the name of the global animation that will be run on all nodes
  34565. * @param node defines the root node where the animation will take place
  34566. * @param targetProperty defines property to animate
  34567. * @param framePerSecond defines the number of frame per second yo use
  34568. * @param totalFrame defines the number of frames in total
  34569. * @param from defines the initial value
  34570. * @param to defines the final value
  34571. * @param loopMode defines which loop mode you want to use (off by default)
  34572. * @param easingFunction defines the easing function to use (linear by default)
  34573. * @param onAnimationEnd defines the callback to call when animation end
  34574. * @returns the animatable created for this animation
  34575. */
  34576. static CreateAndStartAnimation(name: string, node: Node, targetProperty: string, framePerSecond: number, totalFrame: number, from: any, to: any, loopMode?: number, easingFunction?: EasingFunction, onAnimationEnd?: () => void): Nullable<Animatable>;
  34577. /**
  34578. * Create and start an animation on a node and its descendants
  34579. * @param name defines the name of the global animation that will be run on all nodes
  34580. * @param node defines the root node where the animation will take place
  34581. * @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
  34582. * @param targetProperty defines property to animate
  34583. * @param framePerSecond defines the number of frame per second to use
  34584. * @param totalFrame defines the number of frames in total
  34585. * @param from defines the initial value
  34586. * @param to defines the final value
  34587. * @param loopMode defines which loop mode you want to use (off by default)
  34588. * @param easingFunction defines the easing function to use (linear by default)
  34589. * @param onAnimationEnd defines the callback to call when an animation ends (will be called once per node)
  34590. * @returns the list of animatables created for all nodes
  34591. * @example https://www.babylonjs-playground.com/#MH0VLI
  34592. */
  34593. 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[]>;
  34594. /**
  34595. * Creates a new animation, merges it with the existing animations and starts it
  34596. * @param name Name of the animation
  34597. * @param node Node which contains the scene that begins the animations
  34598. * @param targetProperty Specifies which property to animate
  34599. * @param framePerSecond The frames per second of the animation
  34600. * @param totalFrame The total number of frames
  34601. * @param from The frame at the beginning of the animation
  34602. * @param to The frame at the end of the animation
  34603. * @param loopMode Specifies the loop mode of the animation
  34604. * @param easingFunction (Optional) The easing function of the animation, which allow custom mathematical formulas for animations
  34605. * @param onAnimationEnd Callback to run once the animation is complete
  34606. * @returns Nullable animation
  34607. */
  34608. static CreateMergeAndStartAnimation(name: string, node: Node, targetProperty: string, framePerSecond: number, totalFrame: number, from: any, to: any, loopMode?: number, easingFunction?: EasingFunction, onAnimationEnd?: () => void): Nullable<Animatable>;
  34609. /**
  34610. * Convert the keyframes for all animations belonging to the group to be relative to a given reference frame.
  34611. * @param sourceAnimation defines the Animation containing keyframes to convert
  34612. * @param referenceFrame defines the frame that keyframes in the range will be relative to
  34613. * @param range defines the name of the AnimationRange belonging to the Animation to convert
  34614. * @param cloneOriginal defines whether or not to clone the animation and convert the clone or convert the original animation (default is false)
  34615. * @param clonedName defines the name of the resulting cloned Animation if cloneOriginal is true
  34616. * @returns a new Animation if cloneOriginal is true or the original Animation if cloneOriginal is false
  34617. */
  34618. static MakeAnimationAdditive(sourceAnimation: Animation, referenceFrame?: number, range?: string, cloneOriginal?: boolean, clonedName?: string): Animation;
  34619. /**
  34620. * Transition property of an host to the target Value
  34621. * @param property The property to transition
  34622. * @param targetValue The target Value of the property
  34623. * @param host The object where the property to animate belongs
  34624. * @param scene Scene used to run the animation
  34625. * @param frameRate Framerate (in frame/s) to use
  34626. * @param transition The transition type we want to use
  34627. * @param duration The duration of the animation, in milliseconds
  34628. * @param onAnimationEnd Callback trigger at the end of the animation
  34629. * @returns Nullable animation
  34630. */
  34631. static TransitionTo(property: string, targetValue: any, host: any, scene: Scene, frameRate: number, transition: Animation, duration: number, onAnimationEnd?: Nullable<() => void>): Nullable<Animatable>;
  34632. /**
  34633. * Return the array of runtime animations currently using this animation
  34634. */
  34635. get runtimeAnimations(): RuntimeAnimation[];
  34636. /**
  34637. * Specifies if any of the runtime animations are currently running
  34638. */
  34639. get hasRunningRuntimeAnimations(): boolean;
  34640. /**
  34641. * Initializes the animation
  34642. * @param name Name of the animation
  34643. * @param targetProperty Property to animate
  34644. * @param framePerSecond The frames per second of the animation
  34645. * @param dataType The data type of the animation
  34646. * @param loopMode The loop mode of the animation
  34647. * @param enableBlending Specifies if blending should be enabled
  34648. */
  34649. constructor(
  34650. /**Name of the animation */
  34651. name: string,
  34652. /**Property to animate */
  34653. targetProperty: string,
  34654. /**The frames per second of the animation */
  34655. framePerSecond: number,
  34656. /**The data type of the animation */
  34657. dataType: number,
  34658. /**The loop mode of the animation */
  34659. loopMode?: number | undefined,
  34660. /**Specifies if blending should be enabled */
  34661. enableBlending?: boolean | undefined);
  34662. /**
  34663. * Converts the animation to a string
  34664. * @param fullDetails support for multiple levels of logging within scene loading
  34665. * @returns String form of the animation
  34666. */
  34667. toString(fullDetails?: boolean): string;
  34668. /**
  34669. * Add an event to this animation
  34670. * @param event Event to add
  34671. */
  34672. addEvent(event: AnimationEvent): void;
  34673. /**
  34674. * Remove all events found at the given frame
  34675. * @param frame The frame to remove events from
  34676. */
  34677. removeEvents(frame: number): void;
  34678. /**
  34679. * Retrieves all the events from the animation
  34680. * @returns Events from the animation
  34681. */
  34682. getEvents(): AnimationEvent[];
  34683. /**
  34684. * Creates an animation range
  34685. * @param name Name of the animation range
  34686. * @param from Starting frame of the animation range
  34687. * @param to Ending frame of the animation
  34688. */
  34689. createRange(name: string, from: number, to: number): void;
  34690. /**
  34691. * Deletes an animation range by name
  34692. * @param name Name of the animation range to delete
  34693. * @param deleteFrames Specifies if the key frames for the range should also be deleted (true) or not (false)
  34694. */
  34695. deleteRange(name: string, deleteFrames?: boolean): void;
  34696. /**
  34697. * Gets the animation range by name, or null if not defined
  34698. * @param name Name of the animation range
  34699. * @returns Nullable animation range
  34700. */
  34701. getRange(name: string): Nullable<AnimationRange>;
  34702. /**
  34703. * Gets the key frames from the animation
  34704. * @returns The key frames of the animation
  34705. */
  34706. getKeys(): Array<IAnimationKey>;
  34707. /**
  34708. * Gets the highest frame rate of the animation
  34709. * @returns Highest frame rate of the animation
  34710. */
  34711. getHighestFrame(): number;
  34712. /**
  34713. * Gets the easing function of the animation
  34714. * @returns Easing function of the animation
  34715. */
  34716. getEasingFunction(): IEasingFunction;
  34717. /**
  34718. * Sets the easing function of the animation
  34719. * @param easingFunction A custom mathematical formula for animation
  34720. */
  34721. setEasingFunction(easingFunction: EasingFunction): void;
  34722. /**
  34723. * Interpolates a scalar linearly
  34724. * @param startValue Start value of the animation curve
  34725. * @param endValue End value of the animation curve
  34726. * @param gradient Scalar amount to interpolate
  34727. * @returns Interpolated scalar value
  34728. */
  34729. floatInterpolateFunction(startValue: number, endValue: number, gradient: number): number;
  34730. /**
  34731. * Interpolates a scalar cubically
  34732. * @param startValue Start value of the animation curve
  34733. * @param outTangent End tangent of the animation
  34734. * @param endValue End value of the animation curve
  34735. * @param inTangent Start tangent of the animation curve
  34736. * @param gradient Scalar amount to interpolate
  34737. * @returns Interpolated scalar value
  34738. */
  34739. floatInterpolateFunctionWithTangents(startValue: number, outTangent: number, endValue: number, inTangent: number, gradient: number): number;
  34740. /**
  34741. * Interpolates a quaternion using a spherical linear interpolation
  34742. * @param startValue Start value of the animation curve
  34743. * @param endValue End value of the animation curve
  34744. * @param gradient Scalar amount to interpolate
  34745. * @returns Interpolated quaternion value
  34746. */
  34747. quaternionInterpolateFunction(startValue: Quaternion, endValue: Quaternion, gradient: number): Quaternion;
  34748. /**
  34749. * Interpolates a quaternion cubically
  34750. * @param startValue Start value of the animation curve
  34751. * @param outTangent End tangent of the animation curve
  34752. * @param endValue End value of the animation curve
  34753. * @param inTangent Start tangent of the animation curve
  34754. * @param gradient Scalar amount to interpolate
  34755. * @returns Interpolated quaternion value
  34756. */
  34757. quaternionInterpolateFunctionWithTangents(startValue: Quaternion, outTangent: Quaternion, endValue: Quaternion, inTangent: Quaternion, gradient: number): Quaternion;
  34758. /**
  34759. * Interpolates a Vector3 linearl
  34760. * @param startValue Start value of the animation curve
  34761. * @param endValue End value of the animation curve
  34762. * @param gradient Scalar amount to interpolate
  34763. * @returns Interpolated scalar value
  34764. */
  34765. vector3InterpolateFunction(startValue: Vector3, endValue: Vector3, gradient: number): Vector3;
  34766. /**
  34767. * Interpolates a Vector3 cubically
  34768. * @param startValue Start value of the animation curve
  34769. * @param outTangent End tangent of the animation
  34770. * @param endValue End value of the animation curve
  34771. * @param inTangent Start tangent of the animation curve
  34772. * @param gradient Scalar amount to interpolate
  34773. * @returns InterpolatedVector3 value
  34774. */
  34775. vector3InterpolateFunctionWithTangents(startValue: Vector3, outTangent: Vector3, endValue: Vector3, inTangent: Vector3, gradient: number): Vector3;
  34776. /**
  34777. * Interpolates a Vector2 linearly
  34778. * @param startValue Start value of the animation curve
  34779. * @param endValue End value of the animation curve
  34780. * @param gradient Scalar amount to interpolate
  34781. * @returns Interpolated Vector2 value
  34782. */
  34783. vector2InterpolateFunction(startValue: Vector2, endValue: Vector2, gradient: number): Vector2;
  34784. /**
  34785. * Interpolates a Vector2 cubically
  34786. * @param startValue Start value of the animation curve
  34787. * @param outTangent End tangent of the animation
  34788. * @param endValue End value of the animation curve
  34789. * @param inTangent Start tangent of the animation curve
  34790. * @param gradient Scalar amount to interpolate
  34791. * @returns Interpolated Vector2 value
  34792. */
  34793. vector2InterpolateFunctionWithTangents(startValue: Vector2, outTangent: Vector2, endValue: Vector2, inTangent: Vector2, gradient: number): Vector2;
  34794. /**
  34795. * Interpolates a size linearly
  34796. * @param startValue Start value of the animation curve
  34797. * @param endValue End value of the animation curve
  34798. * @param gradient Scalar amount to interpolate
  34799. * @returns Interpolated Size value
  34800. */
  34801. sizeInterpolateFunction(startValue: Size, endValue: Size, gradient: number): Size;
  34802. /**
  34803. * Interpolates a Color3 linearly
  34804. * @param startValue Start value of the animation curve
  34805. * @param endValue End value of the animation curve
  34806. * @param gradient Scalar amount to interpolate
  34807. * @returns Interpolated Color3 value
  34808. */
  34809. color3InterpolateFunction(startValue: Color3, endValue: Color3, gradient: number): Color3;
  34810. /**
  34811. * Interpolates a Color4 linearly
  34812. * @param startValue Start value of the animation curve
  34813. * @param endValue End value of the animation curve
  34814. * @param gradient Scalar amount to interpolate
  34815. * @returns Interpolated Color3 value
  34816. */
  34817. color4InterpolateFunction(startValue: Color4, endValue: Color4, gradient: number): Color4;
  34818. /**
  34819. * @hidden Internal use only
  34820. */
  34821. _getKeyValue(value: any): any;
  34822. /**
  34823. * @hidden Internal use only
  34824. */
  34825. _interpolate(currentFrame: number, state: _IAnimationState): any;
  34826. /**
  34827. * Defines the function to use to interpolate matrices
  34828. * @param startValue defines the start matrix
  34829. * @param endValue defines the end matrix
  34830. * @param gradient defines the gradient between both matrices
  34831. * @param result defines an optional target matrix where to store the interpolation
  34832. * @returns the interpolated matrix
  34833. */
  34834. matrixInterpolateFunction(startValue: Matrix, endValue: Matrix, gradient: number, result?: Matrix): Matrix;
  34835. /**
  34836. * Makes a copy of the animation
  34837. * @returns Cloned animation
  34838. */
  34839. clone(): Animation;
  34840. /**
  34841. * Sets the key frames of the animation
  34842. * @param values The animation key frames to set
  34843. */
  34844. setKeys(values: Array<IAnimationKey>): void;
  34845. /**
  34846. * Serializes the animation to an object
  34847. * @returns Serialized object
  34848. */
  34849. serialize(): any;
  34850. /**
  34851. * Float animation type
  34852. */
  34853. static readonly ANIMATIONTYPE_FLOAT: number;
  34854. /**
  34855. * Vector3 animation type
  34856. */
  34857. static readonly ANIMATIONTYPE_VECTOR3: number;
  34858. /**
  34859. * Quaternion animation type
  34860. */
  34861. static readonly ANIMATIONTYPE_QUATERNION: number;
  34862. /**
  34863. * Matrix animation type
  34864. */
  34865. static readonly ANIMATIONTYPE_MATRIX: number;
  34866. /**
  34867. * Color3 animation type
  34868. */
  34869. static readonly ANIMATIONTYPE_COLOR3: number;
  34870. /**
  34871. * Color3 animation type
  34872. */
  34873. static readonly ANIMATIONTYPE_COLOR4: number;
  34874. /**
  34875. * Vector2 animation type
  34876. */
  34877. static readonly ANIMATIONTYPE_VECTOR2: number;
  34878. /**
  34879. * Size animation type
  34880. */
  34881. static readonly ANIMATIONTYPE_SIZE: number;
  34882. /**
  34883. * Relative Loop Mode
  34884. */
  34885. static readonly ANIMATIONLOOPMODE_RELATIVE: number;
  34886. /**
  34887. * Cycle Loop Mode
  34888. */
  34889. static readonly ANIMATIONLOOPMODE_CYCLE: number;
  34890. /**
  34891. * Constant Loop Mode
  34892. */
  34893. static readonly ANIMATIONLOOPMODE_CONSTANT: number;
  34894. /** @hidden */
  34895. static _UniversalLerp(left: any, right: any, amount: number): any;
  34896. /**
  34897. * Parses an animation object and creates an animation
  34898. * @param parsedAnimation Parsed animation object
  34899. * @returns Animation object
  34900. */
  34901. static Parse(parsedAnimation: any): Animation;
  34902. /**
  34903. * Appends the serialized animations from the source animations
  34904. * @param source Source containing the animations
  34905. * @param destination Target to store the animations
  34906. */
  34907. static AppendSerializedAnimations(source: IAnimatable, destination: any): void;
  34908. /**
  34909. * Creates a new animation or an array of animations from a snippet saved in a remote file
  34910. * @param name defines the name of the animation to create (can be null or empty to use the one from the json data)
  34911. * @param url defines the url to load from
  34912. * @returns a promise that will resolve to the new animation or an array of animations
  34913. */
  34914. static ParseFromFileAsync(name: Nullable<string>, url: string): Promise<Animation | Array<Animation>>;
  34915. /**
  34916. * Creates an animation or an array of animations from a snippet saved by the Inspector
  34917. * @param snippetId defines the snippet to load
  34918. * @returns a promise that will resolve to the new animation or a new array of animations
  34919. */
  34920. static CreateFromSnippetAsync(snippetId: string): Promise<Animation | Array<Animation>>;
  34921. }
  34922. }
  34923. declare module "babylonjs/Animations/animatable.interface" {
  34924. import { Nullable } from "babylonjs/types";
  34925. import { Animation } from "babylonjs/Animations/animation";
  34926. /**
  34927. * Interface containing an array of animations
  34928. */
  34929. export interface IAnimatable {
  34930. /**
  34931. * Array of animations
  34932. */
  34933. animations: Nullable<Array<Animation>>;
  34934. }
  34935. }
  34936. declare module "babylonjs/Misc/decorators" {
  34937. import { Nullable } from "babylonjs/types";
  34938. import { IAnimatable } from "babylonjs/Animations/animatable.interface";
  34939. import { Scene } from "babylonjs/scene";
  34940. import { ImageProcessingConfiguration } from "babylonjs/Materials/imageProcessingConfiguration";
  34941. import { FresnelParameters } from "babylonjs/Materials/fresnelParameters";
  34942. import { ColorCurves } from "babylonjs/Materials/colorCurves";
  34943. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  34944. export function expandToProperty(callback: string, targetKey?: Nullable<string>): (target: any, propertyKey: string) => void;
  34945. export function serialize(sourceName?: string): (target: any, propertyKey: string | symbol) => void;
  34946. export function serializeAsTexture(sourceName?: string): (target: any, propertyKey: string | symbol) => void;
  34947. export function serializeAsColor3(sourceName?: string): (target: any, propertyKey: string | symbol) => void;
  34948. export function serializeAsFresnelParameters(sourceName?: string): (target: any, propertyKey: string | symbol) => void;
  34949. export function serializeAsVector2(sourceName?: string): (target: any, propertyKey: string | symbol) => void;
  34950. export function serializeAsVector3(sourceName?: string): (target: any, propertyKey: string | symbol) => void;
  34951. export function serializeAsMeshReference(sourceName?: string): (target: any, propertyKey: string | symbol) => void;
  34952. export function serializeAsColorCurves(sourceName?: string): (target: any, propertyKey: string | symbol) => void;
  34953. export function serializeAsColor4(sourceName?: string): (target: any, propertyKey: string | symbol) => void;
  34954. export function serializeAsImageProcessingConfiguration(sourceName?: string): (target: any, propertyKey: string | symbol) => void;
  34955. export function serializeAsQuaternion(sourceName?: string): (target: any, propertyKey: string | symbol) => void;
  34956. export function serializeAsMatrix(sourceName?: string): (target: any, propertyKey: string | symbol) => void;
  34957. /**
  34958. * Decorator used to define property that can be serialized as reference to a camera
  34959. * @param sourceName defines the name of the property to decorate
  34960. */
  34961. export function serializeAsCameraReference(sourceName?: string): (target: any, propertyKey: string | symbol) => void;
  34962. /**
  34963. * Class used to help serialization objects
  34964. */
  34965. export class SerializationHelper {
  34966. /** @hidden */
  34967. static _ImageProcessingConfigurationParser: (sourceProperty: any) => ImageProcessingConfiguration;
  34968. /** @hidden */
  34969. static _FresnelParametersParser: (sourceProperty: any) => FresnelParameters;
  34970. /** @hidden */
  34971. static _ColorCurvesParser: (sourceProperty: any) => ColorCurves;
  34972. /** @hidden */
  34973. static _TextureParser: (sourceProperty: any, scene: Scene, rootUrl: string) => Nullable<BaseTexture>;
  34974. /**
  34975. * Appends the serialized animations from the source animations
  34976. * @param source Source containing the animations
  34977. * @param destination Target to store the animations
  34978. */
  34979. static AppendSerializedAnimations(source: IAnimatable, destination: any): void;
  34980. /**
  34981. * Static function used to serialized a specific entity
  34982. * @param entity defines the entity to serialize
  34983. * @param serializationObject defines the optional target obecjt where serialization data will be stored
  34984. * @returns a JSON compatible object representing the serialization of the entity
  34985. */
  34986. static Serialize<T>(entity: T, serializationObject?: any): any;
  34987. /**
  34988. * Creates a new entity from a serialization data object
  34989. * @param creationFunction defines a function used to instanciated the new entity
  34990. * @param source defines the source serialization data
  34991. * @param scene defines the hosting scene
  34992. * @param rootUrl defines the root url for resources
  34993. * @returns a new entity
  34994. */
  34995. static Parse<T>(creationFunction: () => T, source: any, scene: Nullable<Scene>, rootUrl?: Nullable<string>): T;
  34996. /**
  34997. * Clones an object
  34998. * @param creationFunction defines the function used to instanciate the new object
  34999. * @param source defines the source object
  35000. * @returns the cloned object
  35001. */
  35002. static Clone<T>(creationFunction: () => T, source: T): T;
  35003. /**
  35004. * Instanciates a new object based on a source one (some data will be shared between both object)
  35005. * @param creationFunction defines the function used to instanciate the new object
  35006. * @param source defines the source object
  35007. * @returns the new object
  35008. */
  35009. static Instanciate<T>(creationFunction: () => T, source: T): T;
  35010. }
  35011. }
  35012. declare module "babylonjs/Materials/Textures/baseTexture" {
  35013. import { Observable } from "babylonjs/Misc/observable";
  35014. import { Nullable } from "babylonjs/types";
  35015. import { Scene } from "babylonjs/scene";
  35016. import { Matrix } from "babylonjs/Maths/math.vector";
  35017. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  35018. import { IAnimatable } from "babylonjs/Animations/animatable.interface";
  35019. import { ISize } from "babylonjs/Maths/math.size";
  35020. import "babylonjs/Misc/fileTools";
  35021. import { ThinEngine } from "babylonjs/Engines/thinEngine";
  35022. /**
  35023. * Base class of all the textures in babylon.
  35024. * It groups all the common properties the materials, post process, lights... might need
  35025. * in order to make a correct use of the texture.
  35026. */
  35027. export class BaseTexture implements IAnimatable {
  35028. /**
  35029. * Default anisotropic filtering level for the application.
  35030. * It is set to 4 as a good tradeoff between perf and quality.
  35031. */
  35032. static DEFAULT_ANISOTROPIC_FILTERING_LEVEL: number;
  35033. /**
  35034. * Gets or sets the unique id of the texture
  35035. */
  35036. uniqueId: number;
  35037. /**
  35038. * Define the name of the texture.
  35039. */
  35040. name: string;
  35041. /**
  35042. * Gets or sets an object used to store user defined information.
  35043. */
  35044. metadata: any;
  35045. /**
  35046. * For internal use only. Please do not use.
  35047. */
  35048. reservedDataStore: any;
  35049. private _hasAlpha;
  35050. /**
  35051. * Define if the texture is having a usable alpha value (can be use for transparency or glossiness for instance).
  35052. */
  35053. set hasAlpha(value: boolean);
  35054. get hasAlpha(): boolean;
  35055. /**
  35056. * Defines if the alpha value should be determined via the rgb values.
  35057. * If true the luminance of the pixel might be used to find the corresponding alpha value.
  35058. */
  35059. getAlphaFromRGB: boolean;
  35060. /**
  35061. * Intensity or strength of the texture.
  35062. * It is commonly used by materials to fine tune the intensity of the texture
  35063. */
  35064. level: number;
  35065. /**
  35066. * Define the UV chanel to use starting from 0 and defaulting to 0.
  35067. * This is part of the texture as textures usually maps to one uv set.
  35068. */
  35069. coordinatesIndex: number;
  35070. protected _coordinatesMode: number;
  35071. /**
  35072. * How a texture is mapped.
  35073. *
  35074. * | Value | Type | Description |
  35075. * | ----- | ----------------------------------- | ----------- |
  35076. * | 0 | EXPLICIT_MODE | |
  35077. * | 1 | SPHERICAL_MODE | |
  35078. * | 2 | PLANAR_MODE | |
  35079. * | 3 | CUBIC_MODE | |
  35080. * | 4 | PROJECTION_MODE | |
  35081. * | 5 | SKYBOX_MODE | |
  35082. * | 6 | INVCUBIC_MODE | |
  35083. * | 7 | EQUIRECTANGULAR_MODE | |
  35084. * | 8 | FIXED_EQUIRECTANGULAR_MODE | |
  35085. * | 9 | FIXED_EQUIRECTANGULAR_MIRRORED_MODE | |
  35086. */
  35087. set coordinatesMode(value: number);
  35088. get coordinatesMode(): number;
  35089. private _wrapU;
  35090. /**
  35091. * | Value | Type | Description |
  35092. * | ----- | ------------------ | ----------- |
  35093. * | 0 | CLAMP_ADDRESSMODE | |
  35094. * | 1 | WRAP_ADDRESSMODE | |
  35095. * | 2 | MIRROR_ADDRESSMODE | |
  35096. */
  35097. get wrapU(): number;
  35098. set wrapU(value: number);
  35099. private _wrapV;
  35100. /**
  35101. * | Value | Type | Description |
  35102. * | ----- | ------------------ | ----------- |
  35103. * | 0 | CLAMP_ADDRESSMODE | |
  35104. * | 1 | WRAP_ADDRESSMODE | |
  35105. * | 2 | MIRROR_ADDRESSMODE | |
  35106. */
  35107. get wrapV(): number;
  35108. set wrapV(value: number);
  35109. /**
  35110. * | Value | Type | Description |
  35111. * | ----- | ------------------ | ----------- |
  35112. * | 0 | CLAMP_ADDRESSMODE | |
  35113. * | 1 | WRAP_ADDRESSMODE | |
  35114. * | 2 | MIRROR_ADDRESSMODE | |
  35115. */
  35116. wrapR: number;
  35117. /**
  35118. * With compliant hardware and browser (supporting anisotropic filtering)
  35119. * this defines the level of anisotropic filtering in the texture.
  35120. * The higher the better but the slower. This defaults to 4 as it seems to be the best tradeoff.
  35121. */
  35122. anisotropicFilteringLevel: number;
  35123. /**
  35124. * Define if the texture is a cube texture or if false a 2d texture.
  35125. */
  35126. get isCube(): boolean;
  35127. set isCube(value: boolean);
  35128. /**
  35129. * Define if the texture is a 3d texture (webgl 2) or if false a 2d texture.
  35130. */
  35131. get is3D(): boolean;
  35132. set is3D(value: boolean);
  35133. /**
  35134. * Define if the texture is a 2d array texture (webgl 2) or if false a 2d texture.
  35135. */
  35136. get is2DArray(): boolean;
  35137. set is2DArray(value: boolean);
  35138. /**
  35139. * Define if the texture contains data in gamma space (most of the png/jpg aside bump).
  35140. * HDR texture are usually stored in linear space.
  35141. * This only impacts the PBR and Background materials
  35142. */
  35143. gammaSpace: boolean;
  35144. /**
  35145. * Gets or sets whether or not the texture contains RGBD data.
  35146. */
  35147. get isRGBD(): boolean;
  35148. set isRGBD(value: boolean);
  35149. /**
  35150. * Is Z inverted in the texture (useful in a cube texture).
  35151. */
  35152. invertZ: boolean;
  35153. /**
  35154. * Are mip maps generated for this texture or not.
  35155. */
  35156. get noMipmap(): boolean;
  35157. /**
  35158. * @hidden
  35159. */
  35160. lodLevelInAlpha: boolean;
  35161. /**
  35162. * With prefiltered texture, defined the offset used during the prefiltering steps.
  35163. */
  35164. get lodGenerationOffset(): number;
  35165. set lodGenerationOffset(value: number);
  35166. /**
  35167. * With prefiltered texture, defined the scale used during the prefiltering steps.
  35168. */
  35169. get lodGenerationScale(): number;
  35170. set lodGenerationScale(value: number);
  35171. /**
  35172. * With prefiltered texture, defined if the specular generation is based on a linear ramp.
  35173. * By default we are using a log2 of the linear roughness helping to keep a better resolution for
  35174. * average roughness values.
  35175. */
  35176. get linearSpecularLOD(): boolean;
  35177. set linearSpecularLOD(value: boolean);
  35178. /**
  35179. * In case a better definition than spherical harmonics is required for the diffuse part of the environment.
  35180. * You can set the irradiance texture to rely on a texture instead of the spherical approach.
  35181. * This texture need to have the same characteristics than its parent (Cube vs 2d, coordinates mode, Gamma/Linear, RGBD).
  35182. */
  35183. get irradianceTexture(): Nullable<BaseTexture>;
  35184. set irradianceTexture(value: Nullable<BaseTexture>);
  35185. /**
  35186. * Define if the texture is a render target.
  35187. */
  35188. isRenderTarget: boolean;
  35189. /**
  35190. * Define the unique id of the texture in the scene.
  35191. */
  35192. get uid(): string;
  35193. /** @hidden */
  35194. _prefiltered: boolean;
  35195. /**
  35196. * Return a string representation of the texture.
  35197. * @returns the texture as a string
  35198. */
  35199. toString(): string;
  35200. /**
  35201. * Get the class name of the texture.
  35202. * @returns "BaseTexture"
  35203. */
  35204. getClassName(): string;
  35205. /**
  35206. * Define the list of animation attached to the texture.
  35207. */
  35208. animations: import("babylonjs/Animations/animation").Animation[];
  35209. /**
  35210. * An event triggered when the texture is disposed.
  35211. */
  35212. onDisposeObservable: Observable<BaseTexture>;
  35213. private _onDisposeObserver;
  35214. /**
  35215. * Callback triggered when the texture has been disposed.
  35216. * Kept for back compatibility, you can use the onDisposeObservable instead.
  35217. */
  35218. set onDispose(callback: () => void);
  35219. /**
  35220. * Define the current state of the loading sequence when in delayed load mode.
  35221. */
  35222. delayLoadState: number;
  35223. protected _scene: Nullable<Scene>;
  35224. protected _engine: Nullable<ThinEngine>;
  35225. /** @hidden */
  35226. _texture: Nullable<InternalTexture>;
  35227. private _uid;
  35228. /**
  35229. * Define if the texture is preventinga material to render or not.
  35230. * If not and the texture is not ready, the engine will use a default black texture instead.
  35231. */
  35232. get isBlocking(): boolean;
  35233. /**
  35234. * Instantiates a new BaseTexture.
  35235. * Base class of all the textures in babylon.
  35236. * It groups all the common properties the materials, post process, lights... might need
  35237. * in order to make a correct use of the texture.
  35238. * @param sceneOrEngine Define the scene or engine the texture blongs to
  35239. */
  35240. constructor(sceneOrEngine: Nullable<Scene | ThinEngine>);
  35241. /**
  35242. * Get the scene the texture belongs to.
  35243. * @returns the scene or null if undefined
  35244. */
  35245. getScene(): Nullable<Scene>;
  35246. /** @hidden */
  35247. protected _getEngine(): Nullable<ThinEngine>;
  35248. /**
  35249. * Get the texture transform matrix used to offset tile the texture for istance.
  35250. * @returns the transformation matrix
  35251. */
  35252. getTextureMatrix(): Matrix;
  35253. /**
  35254. * Get the texture reflection matrix used to rotate/transform the reflection.
  35255. * @returns the reflection matrix
  35256. */
  35257. getReflectionTextureMatrix(): Matrix;
  35258. /**
  35259. * Get the underlying lower level texture from Babylon.
  35260. * @returns the insternal texture
  35261. */
  35262. getInternalTexture(): Nullable<InternalTexture>;
  35263. /**
  35264. * Get if the texture is ready to be consumed (either it is ready or it is not blocking)
  35265. * @returns true if ready or not blocking
  35266. */
  35267. isReadyOrNotBlocking(): boolean;
  35268. /**
  35269. * Get if the texture is ready to be used (downloaded, converted, mip mapped...).
  35270. * @returns true if fully ready
  35271. */
  35272. isReady(): boolean;
  35273. private _cachedSize;
  35274. /**
  35275. * Get the size of the texture.
  35276. * @returns the texture size.
  35277. */
  35278. getSize(): ISize;
  35279. /**
  35280. * Get the base size of the texture.
  35281. * It can be different from the size if the texture has been resized for POT for instance
  35282. * @returns the base size
  35283. */
  35284. getBaseSize(): ISize;
  35285. /**
  35286. * Update the sampling mode of the texture.
  35287. * Default is Trilinear mode.
  35288. *
  35289. * | Value | Type | Description |
  35290. * | ----- | ------------------ | ----------- |
  35291. * | 1 | NEAREST_SAMPLINGMODE or NEAREST_NEAREST_MIPLINEAR | Nearest is: mag = nearest, min = nearest, mip = linear |
  35292. * | 2 | BILINEAR_SAMPLINGMODE or LINEAR_LINEAR_MIPNEAREST | Bilinear is: mag = linear, min = linear, mip = nearest |
  35293. * | 3 | TRILINEAR_SAMPLINGMODE or LINEAR_LINEAR_MIPLINEAR | Trilinear is: mag = linear, min = linear, mip = linear |
  35294. * | 4 | NEAREST_NEAREST_MIPNEAREST | |
  35295. * | 5 | NEAREST_LINEAR_MIPNEAREST | |
  35296. * | 6 | NEAREST_LINEAR_MIPLINEAR | |
  35297. * | 7 | NEAREST_LINEAR | |
  35298. * | 8 | NEAREST_NEAREST | |
  35299. * | 9 | LINEAR_NEAREST_MIPNEAREST | |
  35300. * | 10 | LINEAR_NEAREST_MIPLINEAR | |
  35301. * | 11 | LINEAR_LINEAR | |
  35302. * | 12 | LINEAR_NEAREST | |
  35303. *
  35304. * > _mag_: magnification filter (close to the viewer)
  35305. * > _min_: minification filter (far from the viewer)
  35306. * > _mip_: filter used between mip map levels
  35307. *@param samplingMode Define the new sampling mode of the texture
  35308. */
  35309. updateSamplingMode(samplingMode: number): void;
  35310. /**
  35311. * Scales the texture if is `canRescale()`
  35312. * @param ratio the resize factor we want to use to rescale
  35313. */
  35314. scale(ratio: number): void;
  35315. /**
  35316. * Get if the texture can rescale.
  35317. */
  35318. get canRescale(): boolean;
  35319. /** @hidden */
  35320. _getFromCache(url: Nullable<string>, noMipmap: boolean, sampling?: number, invertY?: boolean): Nullable<InternalTexture>;
  35321. /** @hidden */
  35322. _rebuild(): void;
  35323. /**
  35324. * Triggers the load sequence in delayed load mode.
  35325. */
  35326. delayLoad(): void;
  35327. /**
  35328. * Clones the texture.
  35329. * @returns the cloned texture
  35330. */
  35331. clone(): Nullable<BaseTexture>;
  35332. /**
  35333. * Get the texture underlying type (INT, FLOAT...)
  35334. */
  35335. get textureType(): number;
  35336. /**
  35337. * Get the texture underlying format (RGB, RGBA...)
  35338. */
  35339. get textureFormat(): number;
  35340. /**
  35341. * Indicates that textures need to be re-calculated for all materials
  35342. */
  35343. protected _markAllSubMeshesAsTexturesDirty(): void;
  35344. /**
  35345. * Reads the pixels stored in the webgl texture and returns them as an ArrayBuffer.
  35346. * This will returns an RGBA array buffer containing either in values (0-255) or
  35347. * float values (0-1) depending of the underlying buffer type.
  35348. * @param faceIndex defines the face of the texture to read (in case of cube texture)
  35349. * @param level defines the LOD level of the texture to read (in case of Mip Maps)
  35350. * @param buffer defines a user defined buffer to fill with data (can be null)
  35351. * @returns The Array buffer containing the pixels data.
  35352. */
  35353. readPixels(faceIndex?: number, level?: number, buffer?: Nullable<ArrayBufferView>): Nullable<ArrayBufferView>;
  35354. /**
  35355. * Release and destroy the underlying lower level texture aka internalTexture.
  35356. */
  35357. releaseInternalTexture(): void;
  35358. /** @hidden */
  35359. get _lodTextureHigh(): Nullable<BaseTexture>;
  35360. /** @hidden */
  35361. get _lodTextureMid(): Nullable<BaseTexture>;
  35362. /** @hidden */
  35363. get _lodTextureLow(): Nullable<BaseTexture>;
  35364. /**
  35365. * Dispose the texture and release its associated resources.
  35366. */
  35367. dispose(): void;
  35368. /**
  35369. * Serialize the texture into a JSON representation that can be parsed later on.
  35370. * @returns the JSON representation of the texture
  35371. */
  35372. serialize(): any;
  35373. /**
  35374. * Helper function to be called back once a list of texture contains only ready textures.
  35375. * @param textures Define the list of textures to wait for
  35376. * @param callback Define the callback triggered once the entire list will be ready
  35377. */
  35378. static WhenAllReady(textures: BaseTexture[], callback: () => void): void;
  35379. private static _isScene;
  35380. }
  35381. }
  35382. declare module "babylonjs/Materials/effect" {
  35383. import { Observable } from "babylonjs/Misc/observable";
  35384. import { Nullable } from "babylonjs/types";
  35385. import { IDisposable } from "babylonjs/scene";
  35386. import { IPipelineContext } from "babylonjs/Engines/IPipelineContext";
  35387. import { DataBuffer } from "babylonjs/Meshes/dataBuffer";
  35388. import { IMatrixLike, IVector2Like, IVector3Like, IVector4Like, IColor3Like, IColor4Like } from "babylonjs/Maths/math.like";
  35389. import { ThinEngine } from "babylonjs/Engines/thinEngine";
  35390. import { IEffectFallbacks } from "babylonjs/Materials/iEffectFallbacks";
  35391. import { Engine } from "babylonjs/Engines/engine";
  35392. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  35393. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  35394. import { RenderTargetTexture } from "babylonjs/Materials/Textures/renderTargetTexture";
  35395. import { PostProcess } from "babylonjs/PostProcesses/postProcess";
  35396. /**
  35397. * Options to be used when creating an effect.
  35398. */
  35399. export interface IEffectCreationOptions {
  35400. /**
  35401. * Atrributes that will be used in the shader.
  35402. */
  35403. attributes: string[];
  35404. /**
  35405. * Uniform varible names that will be set in the shader.
  35406. */
  35407. uniformsNames: string[];
  35408. /**
  35409. * Uniform buffer variable names that will be set in the shader.
  35410. */
  35411. uniformBuffersNames: string[];
  35412. /**
  35413. * Sampler texture variable names that will be set in the shader.
  35414. */
  35415. samplers: string[];
  35416. /**
  35417. * Define statements that will be set in the shader.
  35418. */
  35419. defines: any;
  35420. /**
  35421. * Possible fallbacks for this effect to improve performance when needed.
  35422. */
  35423. fallbacks: Nullable<IEffectFallbacks>;
  35424. /**
  35425. * Callback that will be called when the shader is compiled.
  35426. */
  35427. onCompiled: Nullable<(effect: Effect) => void>;
  35428. /**
  35429. * Callback that will be called if an error occurs during shader compilation.
  35430. */
  35431. onError: Nullable<(effect: Effect, errors: string) => void>;
  35432. /**
  35433. * Parameters to be used with Babylons include syntax to iterate over an array (eg. {lights: 10})
  35434. */
  35435. indexParameters?: any;
  35436. /**
  35437. * Max number of lights that can be used in the shader.
  35438. */
  35439. maxSimultaneousLights?: number;
  35440. /**
  35441. * See https://developer.mozilla.org/en-US/docs/Web/API/WebGL2RenderingContext/transformFeedbackVaryings
  35442. */
  35443. transformFeedbackVaryings?: Nullable<string[]>;
  35444. /**
  35445. * 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
  35446. */
  35447. processFinalCode?: Nullable<(shaderType: string, code: string) => string>;
  35448. /**
  35449. * Is this effect rendering to several color attachments ?
  35450. */
  35451. multiTarget?: boolean;
  35452. }
  35453. /**
  35454. * Effect containing vertex and fragment shader that can be executed on an object.
  35455. */
  35456. export class Effect implements IDisposable {
  35457. /**
  35458. * Gets or sets the relative url used to load shaders if using the engine in non-minified mode
  35459. */
  35460. static ShadersRepository: string;
  35461. /**
  35462. * Enable logging of the shader code when a compilation error occurs
  35463. */
  35464. static LogShaderCodeOnCompilationError: boolean;
  35465. /**
  35466. * Name of the effect.
  35467. */
  35468. name: any;
  35469. /**
  35470. * String container all the define statements that should be set on the shader.
  35471. */
  35472. defines: string;
  35473. /**
  35474. * Callback that will be called when the shader is compiled.
  35475. */
  35476. onCompiled: Nullable<(effect: Effect) => void>;
  35477. /**
  35478. * Callback that will be called if an error occurs during shader compilation.
  35479. */
  35480. onError: Nullable<(effect: Effect, errors: string) => void>;
  35481. /**
  35482. * Callback that will be called when effect is bound.
  35483. */
  35484. onBind: Nullable<(effect: Effect) => void>;
  35485. /**
  35486. * Unique ID of the effect.
  35487. */
  35488. uniqueId: number;
  35489. /**
  35490. * Observable that will be called when the shader is compiled.
  35491. * It is recommended to use executeWhenCompile() or to make sure that scene.isReady() is called to get this observable raised.
  35492. */
  35493. onCompileObservable: Observable<Effect>;
  35494. /**
  35495. * Observable that will be called if an error occurs during shader compilation.
  35496. */
  35497. onErrorObservable: Observable<Effect>;
  35498. /** @hidden */
  35499. _onBindObservable: Nullable<Observable<Effect>>;
  35500. /**
  35501. * @hidden
  35502. * Specifies if the effect was previously ready
  35503. */
  35504. _wasPreviouslyReady: boolean;
  35505. /**
  35506. * Observable that will be called when effect is bound.
  35507. */
  35508. get onBindObservable(): Observable<Effect>;
  35509. /** @hidden */
  35510. _bonesComputationForcedToCPU: boolean;
  35511. /** @hidden */
  35512. _multiTarget: boolean;
  35513. private static _uniqueIdSeed;
  35514. private _engine;
  35515. private _uniformBuffersNames;
  35516. private _uniformBuffersNamesList;
  35517. private _uniformsNames;
  35518. private _samplerList;
  35519. private _samplers;
  35520. private _isReady;
  35521. private _compilationError;
  35522. private _allFallbacksProcessed;
  35523. private _attributesNames;
  35524. private _attributes;
  35525. private _attributeLocationByName;
  35526. private _uniforms;
  35527. /**
  35528. * Key for the effect.
  35529. * @hidden
  35530. */
  35531. _key: string;
  35532. private _indexParameters;
  35533. private _fallbacks;
  35534. private _vertexSourceCode;
  35535. private _fragmentSourceCode;
  35536. private _vertexSourceCodeOverride;
  35537. private _fragmentSourceCodeOverride;
  35538. private _transformFeedbackVaryings;
  35539. /**
  35540. * Compiled shader to webGL program.
  35541. * @hidden
  35542. */
  35543. _pipelineContext: Nullable<IPipelineContext>;
  35544. private _valueCache;
  35545. private static _baseCache;
  35546. /**
  35547. * Instantiates an effect.
  35548. * An effect can be used to create/manage/execute vertex and fragment shaders.
  35549. * @param baseName Name of the effect.
  35550. * @param attributesNamesOrOptions List of attribute names that will be passed to the shader or set of all options to create the effect.
  35551. * @param uniformsNamesOrEngine List of uniform variable names that will be passed to the shader or the engine that will be used to render effect.
  35552. * @param samplers List of sampler variables that will be passed to the shader.
  35553. * @param engine Engine to be used to render the effect
  35554. * @param defines Define statements to be added to the shader.
  35555. * @param fallbacks Possible fallbacks for this effect to improve performance when needed.
  35556. * @param onCompiled Callback that will be called when the shader is compiled.
  35557. * @param onError Callback that will be called if an error occurs during shader compilation.
  35558. * @param indexParameters Parameters to be used with Babylons include syntax to iterate over an array (eg. {lights: 10})
  35559. */
  35560. 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);
  35561. private _useFinalCode;
  35562. /**
  35563. * Unique key for this effect
  35564. */
  35565. get key(): string;
  35566. /**
  35567. * If the effect has been compiled and prepared.
  35568. * @returns if the effect is compiled and prepared.
  35569. */
  35570. isReady(): boolean;
  35571. private _isReadyInternal;
  35572. /**
  35573. * The engine the effect was initialized with.
  35574. * @returns the engine.
  35575. */
  35576. getEngine(): Engine;
  35577. /**
  35578. * The pipeline context for this effect
  35579. * @returns the associated pipeline context
  35580. */
  35581. getPipelineContext(): Nullable<IPipelineContext>;
  35582. /**
  35583. * The set of names of attribute variables for the shader.
  35584. * @returns An array of attribute names.
  35585. */
  35586. getAttributesNames(): string[];
  35587. /**
  35588. * Returns the attribute at the given index.
  35589. * @param index The index of the attribute.
  35590. * @returns The location of the attribute.
  35591. */
  35592. getAttributeLocation(index: number): number;
  35593. /**
  35594. * Returns the attribute based on the name of the variable.
  35595. * @param name of the attribute to look up.
  35596. * @returns the attribute location.
  35597. */
  35598. getAttributeLocationByName(name: string): number;
  35599. /**
  35600. * The number of attributes.
  35601. * @returns the numnber of attributes.
  35602. */
  35603. getAttributesCount(): number;
  35604. /**
  35605. * Gets the index of a uniform variable.
  35606. * @param uniformName of the uniform to look up.
  35607. * @returns the index.
  35608. */
  35609. getUniformIndex(uniformName: string): number;
  35610. /**
  35611. * Returns the attribute based on the name of the variable.
  35612. * @param uniformName of the uniform to look up.
  35613. * @returns the location of the uniform.
  35614. */
  35615. getUniform(uniformName: string): Nullable<WebGLUniformLocation>;
  35616. /**
  35617. * Returns an array of sampler variable names
  35618. * @returns The array of sampler variable names.
  35619. */
  35620. getSamplers(): string[];
  35621. /**
  35622. * Returns an array of uniform variable names
  35623. * @returns The array of uniform variable names.
  35624. */
  35625. getUniformNames(): string[];
  35626. /**
  35627. * Returns an array of uniform buffer variable names
  35628. * @returns The array of uniform buffer variable names.
  35629. */
  35630. getUniformBuffersNames(): string[];
  35631. /**
  35632. * Returns the index parameters used to create the effect
  35633. * @returns The index parameters object
  35634. */
  35635. getIndexParameters(): any;
  35636. /**
  35637. * The error from the last compilation.
  35638. * @returns the error string.
  35639. */
  35640. getCompilationError(): string;
  35641. /**
  35642. * Gets a boolean indicating that all fallbacks were used during compilation
  35643. * @returns true if all fallbacks were used
  35644. */
  35645. allFallbacksProcessed(): boolean;
  35646. /**
  35647. * Adds a callback to the onCompiled observable and call the callback imediatly if already ready.
  35648. * @param func The callback to be used.
  35649. */
  35650. executeWhenCompiled(func: (effect: Effect) => void): void;
  35651. private _checkIsReady;
  35652. private _loadShader;
  35653. /**
  35654. * Gets the vertex shader source code of this effect
  35655. */
  35656. get vertexSourceCode(): string;
  35657. /**
  35658. * Gets the fragment shader source code of this effect
  35659. */
  35660. get fragmentSourceCode(): string;
  35661. /**
  35662. * Recompiles the webGL program
  35663. * @param vertexSourceCode The source code for the vertex shader.
  35664. * @param fragmentSourceCode The source code for the fragment shader.
  35665. * @param onCompiled Callback called when completed.
  35666. * @param onError Callback called on error.
  35667. * @hidden
  35668. */
  35669. _rebuildProgram(vertexSourceCode: string, fragmentSourceCode: string, onCompiled: (pipelineContext: IPipelineContext) => void, onError: (message: string) => void): void;
  35670. /**
  35671. * Prepares the effect
  35672. * @hidden
  35673. */
  35674. _prepareEffect(): void;
  35675. private _getShaderCodeAndErrorLine;
  35676. private _processCompilationErrors;
  35677. /**
  35678. * Checks if the effect is supported. (Must be called after compilation)
  35679. */
  35680. get isSupported(): boolean;
  35681. /**
  35682. * Binds a texture to the engine to be used as output of the shader.
  35683. * @param channel Name of the output variable.
  35684. * @param texture Texture to bind.
  35685. * @hidden
  35686. */
  35687. _bindTexture(channel: string, texture: Nullable<InternalTexture>): void;
  35688. /**
  35689. * Sets a texture on the engine to be used in the shader.
  35690. * @param channel Name of the sampler variable.
  35691. * @param texture Texture to set.
  35692. */
  35693. setTexture(channel: string, texture: Nullable<BaseTexture>): void;
  35694. /**
  35695. * Sets a depth stencil texture from a render target on the engine to be used in the shader.
  35696. * @param channel Name of the sampler variable.
  35697. * @param texture Texture to set.
  35698. */
  35699. setDepthStencilTexture(channel: string, texture: Nullable<RenderTargetTexture>): void;
  35700. /**
  35701. * Sets an array of textures on the engine to be used in the shader.
  35702. * @param channel Name of the variable.
  35703. * @param textures Textures to set.
  35704. */
  35705. setTextureArray(channel: string, textures: BaseTexture[]): void;
  35706. /**
  35707. * 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)
  35708. * @param channel Name of the sampler variable.
  35709. * @param postProcess Post process to get the input texture from.
  35710. */
  35711. setTextureFromPostProcess(channel: string, postProcess: Nullable<PostProcess>): void;
  35712. /**
  35713. * (Warning! setTextureFromPostProcessOutput may be desired instead)
  35714. * 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)
  35715. * @param channel Name of the sampler variable.
  35716. * @param postProcess Post process to get the output texture from.
  35717. */
  35718. setTextureFromPostProcessOutput(channel: string, postProcess: Nullable<PostProcess>): void;
  35719. /** @hidden */
  35720. _cacheMatrix(uniformName: string, matrix: IMatrixLike): boolean;
  35721. /** @hidden */
  35722. _cacheFloat2(uniformName: string, x: number, y: number): boolean;
  35723. /** @hidden */
  35724. _cacheFloat3(uniformName: string, x: number, y: number, z: number): boolean;
  35725. /** @hidden */
  35726. _cacheFloat4(uniformName: string, x: number, y: number, z: number, w: number): boolean;
  35727. /**
  35728. * Binds a buffer to a uniform.
  35729. * @param buffer Buffer to bind.
  35730. * @param name Name of the uniform variable to bind to.
  35731. */
  35732. bindUniformBuffer(buffer: DataBuffer, name: string): void;
  35733. /**
  35734. * Binds block to a uniform.
  35735. * @param blockName Name of the block to bind.
  35736. * @param index Index to bind.
  35737. */
  35738. bindUniformBlock(blockName: string, index: number): void;
  35739. /**
  35740. * Sets an interger value on a uniform variable.
  35741. * @param uniformName Name of the variable.
  35742. * @param value Value to be set.
  35743. * @returns this effect.
  35744. */
  35745. setInt(uniformName: string, value: number): Effect;
  35746. /**
  35747. * Sets an int array on a uniform variable.
  35748. * @param uniformName Name of the variable.
  35749. * @param array array to be set.
  35750. * @returns this effect.
  35751. */
  35752. setIntArray(uniformName: string, array: Int32Array): Effect;
  35753. /**
  35754. * 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)
  35755. * @param uniformName Name of the variable.
  35756. * @param array array to be set.
  35757. * @returns this effect.
  35758. */
  35759. setIntArray2(uniformName: string, array: Int32Array): Effect;
  35760. /**
  35761. * 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)
  35762. * @param uniformName Name of the variable.
  35763. * @param array array to be set.
  35764. * @returns this effect.
  35765. */
  35766. setIntArray3(uniformName: string, array: Int32Array): Effect;
  35767. /**
  35768. * 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)
  35769. * @param uniformName Name of the variable.
  35770. * @param array array to be set.
  35771. * @returns this effect.
  35772. */
  35773. setIntArray4(uniformName: string, array: Int32Array): Effect;
  35774. /**
  35775. * Sets an float array on a uniform variable.
  35776. * @param uniformName Name of the variable.
  35777. * @param array array to be set.
  35778. * @returns this effect.
  35779. */
  35780. setFloatArray(uniformName: string, array: Float32Array): Effect;
  35781. /**
  35782. * 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)
  35783. * @param uniformName Name of the variable.
  35784. * @param array array to be set.
  35785. * @returns this effect.
  35786. */
  35787. setFloatArray2(uniformName: string, array: Float32Array): Effect;
  35788. /**
  35789. * 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)
  35790. * @param uniformName Name of the variable.
  35791. * @param array array to be set.
  35792. * @returns this effect.
  35793. */
  35794. setFloatArray3(uniformName: string, array: Float32Array): Effect;
  35795. /**
  35796. * 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)
  35797. * @param uniformName Name of the variable.
  35798. * @param array array to be set.
  35799. * @returns this effect.
  35800. */
  35801. setFloatArray4(uniformName: string, array: Float32Array): Effect;
  35802. /**
  35803. * Sets an array on a uniform variable.
  35804. * @param uniformName Name of the variable.
  35805. * @param array array to be set.
  35806. * @returns this effect.
  35807. */
  35808. setArray(uniformName: string, array: number[]): Effect;
  35809. /**
  35810. * 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)
  35811. * @param uniformName Name of the variable.
  35812. * @param array array to be set.
  35813. * @returns this effect.
  35814. */
  35815. setArray2(uniformName: string, array: number[]): Effect;
  35816. /**
  35817. * 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)
  35818. * @param uniformName Name of the variable.
  35819. * @param array array to be set.
  35820. * @returns this effect.
  35821. */
  35822. setArray3(uniformName: string, array: number[]): Effect;
  35823. /**
  35824. * 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)
  35825. * @param uniformName Name of the variable.
  35826. * @param array array to be set.
  35827. * @returns this effect.
  35828. */
  35829. setArray4(uniformName: string, array: number[]): Effect;
  35830. /**
  35831. * Sets matrices on a uniform variable.
  35832. * @param uniformName Name of the variable.
  35833. * @param matrices matrices to be set.
  35834. * @returns this effect.
  35835. */
  35836. setMatrices(uniformName: string, matrices: Float32Array | Array<number>): Effect;
  35837. /**
  35838. * Sets matrix on a uniform variable.
  35839. * @param uniformName Name of the variable.
  35840. * @param matrix matrix to be set.
  35841. * @returns this effect.
  35842. */
  35843. setMatrix(uniformName: string, matrix: IMatrixLike): Effect;
  35844. /**
  35845. * 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)
  35846. * @param uniformName Name of the variable.
  35847. * @param matrix matrix to be set.
  35848. * @returns this effect.
  35849. */
  35850. setMatrix3x3(uniformName: string, matrix: Float32Array | Array<number>): Effect;
  35851. /**
  35852. * Sets a 2x2 matrix on a uniform variable. (Speicified as [1,2,3,4] will result in [1,2][3,4] matrix)
  35853. * @param uniformName Name of the variable.
  35854. * @param matrix matrix to be set.
  35855. * @returns this effect.
  35856. */
  35857. setMatrix2x2(uniformName: string, matrix: Float32Array | Array<number>): Effect;
  35858. /**
  35859. * Sets a float on a uniform variable.
  35860. * @param uniformName Name of the variable.
  35861. * @param value value to be set.
  35862. * @returns this effect.
  35863. */
  35864. setFloat(uniformName: string, value: number): Effect;
  35865. /**
  35866. * Sets a boolean on a uniform variable.
  35867. * @param uniformName Name of the variable.
  35868. * @param bool value to be set.
  35869. * @returns this effect.
  35870. */
  35871. setBool(uniformName: string, bool: boolean): Effect;
  35872. /**
  35873. * Sets a Vector2 on a uniform variable.
  35874. * @param uniformName Name of the variable.
  35875. * @param vector2 vector2 to be set.
  35876. * @returns this effect.
  35877. */
  35878. setVector2(uniformName: string, vector2: IVector2Like): Effect;
  35879. /**
  35880. * Sets a float2 on a uniform variable.
  35881. * @param uniformName Name of the variable.
  35882. * @param x First float in float2.
  35883. * @param y Second float in float2.
  35884. * @returns this effect.
  35885. */
  35886. setFloat2(uniformName: string, x: number, y: number): Effect;
  35887. /**
  35888. * Sets a Vector3 on a uniform variable.
  35889. * @param uniformName Name of the variable.
  35890. * @param vector3 Value to be set.
  35891. * @returns this effect.
  35892. */
  35893. setVector3(uniformName: string, vector3: IVector3Like): Effect;
  35894. /**
  35895. * Sets a float3 on a uniform variable.
  35896. * @param uniformName Name of the variable.
  35897. * @param x First float in float3.
  35898. * @param y Second float in float3.
  35899. * @param z Third float in float3.
  35900. * @returns this effect.
  35901. */
  35902. setFloat3(uniformName: string, x: number, y: number, z: number): Effect;
  35903. /**
  35904. * Sets a Vector4 on a uniform variable.
  35905. * @param uniformName Name of the variable.
  35906. * @param vector4 Value to be set.
  35907. * @returns this effect.
  35908. */
  35909. setVector4(uniformName: string, vector4: IVector4Like): Effect;
  35910. /**
  35911. * Sets a float4 on a uniform variable.
  35912. * @param uniformName Name of the variable.
  35913. * @param x First float in float4.
  35914. * @param y Second float in float4.
  35915. * @param z Third float in float4.
  35916. * @param w Fourth float in float4.
  35917. * @returns this effect.
  35918. */
  35919. setFloat4(uniformName: string, x: number, y: number, z: number, w: number): Effect;
  35920. /**
  35921. * Sets a Color3 on a uniform variable.
  35922. * @param uniformName Name of the variable.
  35923. * @param color3 Value to be set.
  35924. * @returns this effect.
  35925. */
  35926. setColor3(uniformName: string, color3: IColor3Like): Effect;
  35927. /**
  35928. * Sets a Color4 on a uniform variable.
  35929. * @param uniformName Name of the variable.
  35930. * @param color3 Value to be set.
  35931. * @param alpha Alpha value to be set.
  35932. * @returns this effect.
  35933. */
  35934. setColor4(uniformName: string, color3: IColor3Like, alpha: number): Effect;
  35935. /**
  35936. * Sets a Color4 on a uniform variable
  35937. * @param uniformName defines the name of the variable
  35938. * @param color4 defines the value to be set
  35939. * @returns this effect.
  35940. */
  35941. setDirectColor4(uniformName: string, color4: IColor4Like): Effect;
  35942. /** Release all associated resources */
  35943. dispose(): void;
  35944. /**
  35945. * This function will add a new shader to the shader store
  35946. * @param name the name of the shader
  35947. * @param pixelShader optional pixel shader content
  35948. * @param vertexShader optional vertex shader content
  35949. */
  35950. static RegisterShader(name: string, pixelShader?: string, vertexShader?: string): void;
  35951. /**
  35952. * Store of each shader (The can be looked up using effect.key)
  35953. */
  35954. static ShadersStore: {
  35955. [key: string]: string;
  35956. };
  35957. /**
  35958. * Store of each included file for a shader (The can be looked up using effect.key)
  35959. */
  35960. static IncludesShadersStore: {
  35961. [key: string]: string;
  35962. };
  35963. /**
  35964. * Resets the cache of effects.
  35965. */
  35966. static ResetCache(): void;
  35967. }
  35968. }
  35969. declare module "babylonjs/Engines/engineCapabilities" {
  35970. /**
  35971. * Interface used to describe the capabilities of the engine relatively to the current browser
  35972. */
  35973. export interface EngineCapabilities {
  35974. /** Maximum textures units per fragment shader */
  35975. maxTexturesImageUnits: number;
  35976. /** Maximum texture units per vertex shader */
  35977. maxVertexTextureImageUnits: number;
  35978. /** Maximum textures units in the entire pipeline */
  35979. maxCombinedTexturesImageUnits: number;
  35980. /** Maximum texture size */
  35981. maxTextureSize: number;
  35982. /** Maximum texture samples */
  35983. maxSamples?: number;
  35984. /** Maximum cube texture size */
  35985. maxCubemapTextureSize: number;
  35986. /** Maximum render texture size */
  35987. maxRenderTextureSize: number;
  35988. /** Maximum number of vertex attributes */
  35989. maxVertexAttribs: number;
  35990. /** Maximum number of varyings */
  35991. maxVaryingVectors: number;
  35992. /** Maximum number of uniforms per vertex shader */
  35993. maxVertexUniformVectors: number;
  35994. /** Maximum number of uniforms per fragment shader */
  35995. maxFragmentUniformVectors: number;
  35996. /** Defines if standard derivates (dx/dy) are supported */
  35997. standardDerivatives: boolean;
  35998. /** Defines if s3tc texture compression is supported */
  35999. s3tc?: WEBGL_compressed_texture_s3tc;
  36000. /** Defines if pvrtc texture compression is supported */
  36001. pvrtc: any;
  36002. /** Defines if etc1 texture compression is supported */
  36003. etc1: any;
  36004. /** Defines if etc2 texture compression is supported */
  36005. etc2: any;
  36006. /** Defines if astc texture compression is supported */
  36007. astc: any;
  36008. /** Defines if float textures are supported */
  36009. textureFloat: boolean;
  36010. /** Defines if vertex array objects are supported */
  36011. vertexArrayObject: boolean;
  36012. /** Gets the webgl extension for anisotropic filtering (null if not supported) */
  36013. textureAnisotropicFilterExtension?: EXT_texture_filter_anisotropic;
  36014. /** Gets the maximum level of anisotropy supported */
  36015. maxAnisotropy: number;
  36016. /** Defines if instancing is supported */
  36017. instancedArrays: boolean;
  36018. /** Defines if 32 bits indices are supported */
  36019. uintIndices: boolean;
  36020. /** Defines if high precision shaders are supported */
  36021. highPrecisionShaderSupported: boolean;
  36022. /** Defines if depth reading in the fragment shader is supported */
  36023. fragmentDepthSupported: boolean;
  36024. /** Defines if float texture linear filtering is supported*/
  36025. textureFloatLinearFiltering: boolean;
  36026. /** Defines if rendering to float textures is supported */
  36027. textureFloatRender: boolean;
  36028. /** Defines if half float textures are supported*/
  36029. textureHalfFloat: boolean;
  36030. /** Defines if half float texture linear filtering is supported*/
  36031. textureHalfFloatLinearFiltering: boolean;
  36032. /** Defines if rendering to half float textures is supported */
  36033. textureHalfFloatRender: boolean;
  36034. /** Defines if textureLOD shader command is supported */
  36035. textureLOD: boolean;
  36036. /** Defines if draw buffers extension is supported */
  36037. drawBuffersExtension: boolean;
  36038. /** Defines if depth textures are supported */
  36039. depthTextureExtension: boolean;
  36040. /** Defines if float color buffer are supported */
  36041. colorBufferFloat: boolean;
  36042. /** Gets disjoint timer query extension (null if not supported) */
  36043. timerQuery?: EXT_disjoint_timer_query;
  36044. /** Defines if timestamp can be used with timer query */
  36045. canUseTimestampForTimerQuery: boolean;
  36046. /** Defines if multiview is supported (https://www.khronos.org/registry/webgl/extensions/WEBGL_multiview/) */
  36047. multiview?: any;
  36048. /** Defines if oculus multiview is supported (https://developer.oculus.com/documentation/oculus-browser/latest/concepts/browser-multiview/) */
  36049. oculusMultiview?: any;
  36050. /** Function used to let the system compiles shaders in background */
  36051. parallelShaderCompile?: {
  36052. COMPLETION_STATUS_KHR: number;
  36053. };
  36054. /** Max number of texture samples for MSAA */
  36055. maxMSAASamples: number;
  36056. /** Defines if the blend min max extension is supported */
  36057. blendMinMax: boolean;
  36058. }
  36059. }
  36060. declare module "babylonjs/States/depthCullingState" {
  36061. import { Nullable } from "babylonjs/types";
  36062. /**
  36063. * @hidden
  36064. **/
  36065. export class DepthCullingState {
  36066. private _isDepthTestDirty;
  36067. private _isDepthMaskDirty;
  36068. private _isDepthFuncDirty;
  36069. private _isCullFaceDirty;
  36070. private _isCullDirty;
  36071. private _isZOffsetDirty;
  36072. private _isFrontFaceDirty;
  36073. private _depthTest;
  36074. private _depthMask;
  36075. private _depthFunc;
  36076. private _cull;
  36077. private _cullFace;
  36078. private _zOffset;
  36079. private _frontFace;
  36080. /**
  36081. * Initializes the state.
  36082. */
  36083. constructor();
  36084. get isDirty(): boolean;
  36085. get zOffset(): number;
  36086. set zOffset(value: number);
  36087. get cullFace(): Nullable<number>;
  36088. set cullFace(value: Nullable<number>);
  36089. get cull(): Nullable<boolean>;
  36090. set cull(value: Nullable<boolean>);
  36091. get depthFunc(): Nullable<number>;
  36092. set depthFunc(value: Nullable<number>);
  36093. get depthMask(): boolean;
  36094. set depthMask(value: boolean);
  36095. get depthTest(): boolean;
  36096. set depthTest(value: boolean);
  36097. get frontFace(): Nullable<number>;
  36098. set frontFace(value: Nullable<number>);
  36099. reset(): void;
  36100. apply(gl: WebGLRenderingContext): void;
  36101. }
  36102. }
  36103. declare module "babylonjs/States/stencilState" {
  36104. /**
  36105. * @hidden
  36106. **/
  36107. export class StencilState {
  36108. /** 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 */
  36109. static readonly ALWAYS: number;
  36110. /** Passed to stencilOperation to specify that stencil value must be kept */
  36111. static readonly KEEP: number;
  36112. /** Passed to stencilOperation to specify that stencil value must be replaced */
  36113. static readonly REPLACE: number;
  36114. private _isStencilTestDirty;
  36115. private _isStencilMaskDirty;
  36116. private _isStencilFuncDirty;
  36117. private _isStencilOpDirty;
  36118. private _stencilTest;
  36119. private _stencilMask;
  36120. private _stencilFunc;
  36121. private _stencilFuncRef;
  36122. private _stencilFuncMask;
  36123. private _stencilOpStencilFail;
  36124. private _stencilOpDepthFail;
  36125. private _stencilOpStencilDepthPass;
  36126. get isDirty(): boolean;
  36127. get stencilFunc(): number;
  36128. set stencilFunc(value: number);
  36129. get stencilFuncRef(): number;
  36130. set stencilFuncRef(value: number);
  36131. get stencilFuncMask(): number;
  36132. set stencilFuncMask(value: number);
  36133. get stencilOpStencilFail(): number;
  36134. set stencilOpStencilFail(value: number);
  36135. get stencilOpDepthFail(): number;
  36136. set stencilOpDepthFail(value: number);
  36137. get stencilOpStencilDepthPass(): number;
  36138. set stencilOpStencilDepthPass(value: number);
  36139. get stencilMask(): number;
  36140. set stencilMask(value: number);
  36141. get stencilTest(): boolean;
  36142. set stencilTest(value: boolean);
  36143. constructor();
  36144. reset(): void;
  36145. apply(gl: WebGLRenderingContext): void;
  36146. }
  36147. }
  36148. declare module "babylonjs/States/alphaCullingState" {
  36149. /**
  36150. * @hidden
  36151. **/
  36152. export class AlphaState {
  36153. private _isAlphaBlendDirty;
  36154. private _isBlendFunctionParametersDirty;
  36155. private _isBlendEquationParametersDirty;
  36156. private _isBlendConstantsDirty;
  36157. private _alphaBlend;
  36158. private _blendFunctionParameters;
  36159. private _blendEquationParameters;
  36160. private _blendConstants;
  36161. /**
  36162. * Initializes the state.
  36163. */
  36164. constructor();
  36165. get isDirty(): boolean;
  36166. get alphaBlend(): boolean;
  36167. set alphaBlend(value: boolean);
  36168. setAlphaBlendConstants(r: number, g: number, b: number, a: number): void;
  36169. setAlphaBlendFunctionParameters(value0: number, value1: number, value2: number, value3: number): void;
  36170. setAlphaEquationParameters(rgb: number, alpha: number): void;
  36171. reset(): void;
  36172. apply(gl: WebGLRenderingContext): void;
  36173. }
  36174. }
  36175. declare module "babylonjs/Engines/WebGL/webGL2ShaderProcessors" {
  36176. import { IShaderProcessor } from "babylonjs/Engines/Processors/iShaderProcessor";
  36177. /** @hidden */
  36178. export class WebGL2ShaderProcessor implements IShaderProcessor {
  36179. attributeProcessor(attribute: string): string;
  36180. varyingProcessor(varying: string, isFragment: boolean): string;
  36181. postProcessor(code: string, defines: string[], isFragment: boolean): string;
  36182. }
  36183. }
  36184. declare module "babylonjs/Engines/instancingAttributeInfo" {
  36185. /**
  36186. * Interface for attribute information associated with buffer instanciation
  36187. */
  36188. export interface InstancingAttributeInfo {
  36189. /**
  36190. * Name of the GLSL attribute
  36191. * if attribute index is not specified, this is used to retrieve the index from the effect
  36192. */
  36193. attributeName: string;
  36194. /**
  36195. * Index/offset of the attribute in the vertex shader
  36196. * if not specified, this will be computes from the name.
  36197. */
  36198. index?: number;
  36199. /**
  36200. * size of the attribute, 1, 2, 3 or 4
  36201. */
  36202. attributeSize: number;
  36203. /**
  36204. * Offset of the data in the Vertex Buffer acting as the instancing buffer
  36205. */
  36206. offset: number;
  36207. /**
  36208. * Modifies the rate at which generic vertex attributes advance when rendering multiple instances
  36209. * default to 1
  36210. */
  36211. divisor?: number;
  36212. /**
  36213. * type of the attribute, gl.BYTE, gl.UNSIGNED_BYTE, gl.SHORT, gl.UNSIGNED_SHORT, gl.FIXED, gl.FLOAT.
  36214. * default is FLOAT
  36215. */
  36216. attributeType?: number;
  36217. /**
  36218. * normalization of fixed-point data. behavior unclear, use FALSE, default is FALSE
  36219. */
  36220. normalized?: boolean;
  36221. }
  36222. }
  36223. declare module "babylonjs/Engines/Extensions/engine.videoTexture" {
  36224. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  36225. import { Nullable } from "babylonjs/types";
  36226. module "babylonjs/Engines/thinEngine" {
  36227. interface ThinEngine {
  36228. /**
  36229. * Update a video texture
  36230. * @param texture defines the texture to update
  36231. * @param video defines the video element to use
  36232. * @param invertY defines if data must be stored with Y axis inverted
  36233. */
  36234. updateVideoTexture(texture: Nullable<InternalTexture>, video: HTMLVideoElement, invertY: boolean): void;
  36235. }
  36236. }
  36237. }
  36238. declare module "babylonjs/Engines/Extensions/engine.dynamicTexture" {
  36239. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  36240. import { Nullable } from "babylonjs/types";
  36241. module "babylonjs/Engines/thinEngine" {
  36242. interface ThinEngine {
  36243. /**
  36244. * Creates a dynamic texture
  36245. * @param width defines the width of the texture
  36246. * @param height defines the height of the texture
  36247. * @param generateMipMaps defines if the engine should generate the mip levels
  36248. * @param samplingMode defines the required sampling mode (Texture.NEAREST_SAMPLINGMODE by default)
  36249. * @returns the dynamic texture inside an InternalTexture
  36250. */
  36251. createDynamicTexture(width: number, height: number, generateMipMaps: boolean, samplingMode: number): InternalTexture;
  36252. /**
  36253. * Update the content of a dynamic texture
  36254. * @param texture defines the texture to update
  36255. * @param canvas defines the canvas containing the source
  36256. * @param invertY defines if data must be stored with Y axis inverted
  36257. * @param premulAlpha defines if alpha is stored as premultiplied
  36258. * @param format defines the format of the data
  36259. * @param forceBindTexture if the texture should be forced to be bound eg. after a graphics context loss (Default: false)
  36260. */
  36261. updateDynamicTexture(texture: Nullable<InternalTexture>, canvas: HTMLCanvasElement | OffscreenCanvas, invertY: boolean, premulAlpha?: boolean, format?: number, forceBindTexture?: boolean): void;
  36262. }
  36263. }
  36264. }
  36265. declare module "babylonjs/Materials/Textures/videoTexture" {
  36266. import { Observable } from "babylonjs/Misc/observable";
  36267. import { Nullable } from "babylonjs/types";
  36268. import { Scene } from "babylonjs/scene";
  36269. import { Texture } from "babylonjs/Materials/Textures/texture";
  36270. import "babylonjs/Engines/Extensions/engine.videoTexture";
  36271. import "babylonjs/Engines/Extensions/engine.dynamicTexture";
  36272. /**
  36273. * Settings for finer control over video usage
  36274. */
  36275. export interface VideoTextureSettings {
  36276. /**
  36277. * Applies `autoplay` to video, if specified
  36278. */
  36279. autoPlay?: boolean;
  36280. /**
  36281. * Applies `loop` to video, if specified
  36282. */
  36283. loop?: boolean;
  36284. /**
  36285. * Automatically updates internal texture from video at every frame in the render loop
  36286. */
  36287. autoUpdateTexture: boolean;
  36288. /**
  36289. * Image src displayed during the video loading or until the user interacts with the video.
  36290. */
  36291. poster?: string;
  36292. }
  36293. /**
  36294. * If you want to display a video in your scene, this is the special texture for that.
  36295. * This special texture works similar to other textures, with the exception of a few parameters.
  36296. * @see https://doc.babylonjs.com/how_to/video_texture
  36297. */
  36298. export class VideoTexture extends Texture {
  36299. /**
  36300. * Tells whether textures will be updated automatically or user is required to call `updateTexture` manually
  36301. */
  36302. readonly autoUpdateTexture: boolean;
  36303. /**
  36304. * The video instance used by the texture internally
  36305. */
  36306. readonly video: HTMLVideoElement;
  36307. private _onUserActionRequestedObservable;
  36308. /**
  36309. * Event triggerd when a dom action is required by the user to play the video.
  36310. * This happens due to recent changes in browser policies preventing video to auto start.
  36311. */
  36312. get onUserActionRequestedObservable(): Observable<Texture>;
  36313. private _generateMipMaps;
  36314. private _stillImageCaptured;
  36315. private _displayingPosterTexture;
  36316. private _settings;
  36317. private _createInternalTextureOnEvent;
  36318. private _frameId;
  36319. private _currentSrc;
  36320. /**
  36321. * Creates a video texture.
  36322. * If you want to display a video in your scene, this is the special texture for that.
  36323. * This special texture works similar to other textures, with the exception of a few parameters.
  36324. * @see https://doc.babylonjs.com/how_to/video_texture
  36325. * @param name optional name, will detect from video source, if not defined
  36326. * @param src can be used to provide an url, array of urls or an already setup HTML video element.
  36327. * @param scene is obviously the current scene.
  36328. * @param generateMipMaps can be used to turn on mipmaps (Can be expensive for videoTextures because they are often updated).
  36329. * @param invertY is false by default but can be used to invert video on Y axis
  36330. * @param samplingMode controls the sampling method and is set to TRILINEAR_SAMPLINGMODE by default
  36331. * @param settings allows finer control over video usage
  36332. */
  36333. constructor(name: Nullable<string>, src: string | string[] | HTMLVideoElement, scene: Nullable<Scene>, generateMipMaps?: boolean, invertY?: boolean, samplingMode?: number, settings?: VideoTextureSettings);
  36334. private _getName;
  36335. private _getVideo;
  36336. private _createInternalTexture;
  36337. private reset;
  36338. /**
  36339. * @hidden Internal method to initiate `update`.
  36340. */
  36341. _rebuild(): void;
  36342. /**
  36343. * Update Texture in the `auto` mode. Does not do anything if `settings.autoUpdateTexture` is false.
  36344. */
  36345. update(): void;
  36346. /**
  36347. * Update Texture in `manual` mode. Does not do anything if not visible or paused.
  36348. * @param isVisible Visibility state, detected by user using `scene.getActiveMeshes()` or othervise.
  36349. */
  36350. updateTexture(isVisible: boolean): void;
  36351. protected _updateInternalTexture: () => void;
  36352. /**
  36353. * Change video content. Changing video instance or setting multiple urls (as in constructor) is not supported.
  36354. * @param url New url.
  36355. */
  36356. updateURL(url: string): void;
  36357. /**
  36358. * Clones the texture.
  36359. * @returns the cloned texture
  36360. */
  36361. clone(): VideoTexture;
  36362. /**
  36363. * Dispose the texture and release its associated resources.
  36364. */
  36365. dispose(): void;
  36366. /**
  36367. * Creates a video texture straight from a stream.
  36368. * @param scene Define the scene the texture should be created in
  36369. * @param stream Define the stream the texture should be created from
  36370. * @returns The created video texture as a promise
  36371. */
  36372. static CreateFromStreamAsync(scene: Scene, stream: MediaStream): Promise<VideoTexture>;
  36373. /**
  36374. * Creates a video texture straight from your WebCam video feed.
  36375. * @param scene Define the scene the texture should be created in
  36376. * @param constraints Define the constraints to use to create the web cam feed from WebRTC
  36377. * @param audioConstaints Define the audio constraints to use to create the web cam feed from WebRTC
  36378. * @returns The created video texture as a promise
  36379. */
  36380. static CreateFromWebCamAsync(scene: Scene, constraints: {
  36381. minWidth: number;
  36382. maxWidth: number;
  36383. minHeight: number;
  36384. maxHeight: number;
  36385. deviceId: string;
  36386. } & MediaTrackConstraints, audioConstaints?: boolean | MediaTrackConstraints): Promise<VideoTexture>;
  36387. /**
  36388. * Creates a video texture straight from your WebCam video feed.
  36389. * @param scene Define the scene the texture should be created in
  36390. * @param onReady Define a callback to triggered once the texture will be ready
  36391. * @param constraints Define the constraints to use to create the web cam feed from WebRTC
  36392. * @param audioConstaints Define the audio constraints to use to create the web cam feed from WebRTC
  36393. */
  36394. static CreateFromWebCam(scene: Scene, onReady: (videoTexture: VideoTexture) => void, constraints: {
  36395. minWidth: number;
  36396. maxWidth: number;
  36397. minHeight: number;
  36398. maxHeight: number;
  36399. deviceId: string;
  36400. } & MediaTrackConstraints, audioConstaints?: boolean | MediaTrackConstraints): void;
  36401. }
  36402. }
  36403. declare module "babylonjs/Engines/thinEngine" {
  36404. import { IInternalTextureLoader } from "babylonjs/Materials/Textures/internalTextureLoader";
  36405. import { Effect, IEffectCreationOptions } from "babylonjs/Materials/effect";
  36406. import { IShaderProcessor } from "babylonjs/Engines/Processors/iShaderProcessor";
  36407. import { UniformBuffer } from "babylonjs/Materials/uniformBuffer";
  36408. import { Nullable, DataArray, IndicesArray } from "babylonjs/types";
  36409. import { EngineCapabilities } from "babylonjs/Engines/engineCapabilities";
  36410. import { Observable } from "babylonjs/Misc/observable";
  36411. import { DepthCullingState } from "babylonjs/States/depthCullingState";
  36412. import { StencilState } from "babylonjs/States/stencilState";
  36413. import { AlphaState } from "babylonjs/States/alphaCullingState";
  36414. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  36415. import { IViewportLike, IColor4Like } from "babylonjs/Maths/math.like";
  36416. import { DataBuffer } from "babylonjs/Meshes/dataBuffer";
  36417. import { IFileRequest } from "babylonjs/Misc/fileRequest";
  36418. import { IPipelineContext } from "babylonjs/Engines/IPipelineContext";
  36419. import { WebGLPipelineContext } from "babylonjs/Engines/WebGL/webGLPipelineContext";
  36420. import { VertexBuffer } from "babylonjs/Meshes/buffer";
  36421. import { InstancingAttributeInfo } from "babylonjs/Engines/instancingAttributeInfo";
  36422. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  36423. import { IOfflineProvider } from "babylonjs/Offline/IOfflineProvider";
  36424. import { IEffectFallbacks } from "babylonjs/Materials/iEffectFallbacks";
  36425. import { IWebRequest } from "babylonjs/Misc/interfaces/iWebRequest";
  36426. import { WebRequest } from "babylonjs/Misc/webRequest";
  36427. import { LoadFileError } from "babylonjs/Misc/fileTools";
  36428. /**
  36429. * Defines the interface used by objects working like Scene
  36430. * @hidden
  36431. */
  36432. export interface ISceneLike {
  36433. _addPendingData(data: any): void;
  36434. _removePendingData(data: any): void;
  36435. offlineProvider: IOfflineProvider;
  36436. }
  36437. /**
  36438. * Information about the current host
  36439. */
  36440. export interface HostInformation {
  36441. /**
  36442. * Defines if the current host is a mobile
  36443. */
  36444. isMobile: boolean;
  36445. }
  36446. /** Interface defining initialization parameters for Engine class */
  36447. export interface EngineOptions extends WebGLContextAttributes {
  36448. /**
  36449. * Defines if the engine should no exceed a specified device ratio
  36450. * @see https://developer.mozilla.org/en-US/docs/Web/API/Window/devicePixelRatio
  36451. */
  36452. limitDeviceRatio?: number;
  36453. /**
  36454. * Defines if webvr should be enabled automatically
  36455. * @see https://doc.babylonjs.com/how_to/webvr_camera
  36456. */
  36457. autoEnableWebVR?: boolean;
  36458. /**
  36459. * Defines if webgl2 should be turned off even if supported
  36460. * @see https://doc.babylonjs.com/features/webgl2
  36461. */
  36462. disableWebGL2Support?: boolean;
  36463. /**
  36464. * Defines if webaudio should be initialized as well
  36465. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music
  36466. */
  36467. audioEngine?: boolean;
  36468. /**
  36469. * Defines if animations should run using a deterministic lock step
  36470. * @see https://doc.babylonjs.com/babylon101/animations#deterministic-lockstep
  36471. */
  36472. deterministicLockstep?: boolean;
  36473. /** Defines the maximum steps to use with deterministic lock step mode */
  36474. lockstepMaxSteps?: number;
  36475. /** Defines the seconds between each deterministic lock step */
  36476. timeStep?: number;
  36477. /**
  36478. * Defines that engine should ignore context lost events
  36479. * If this event happens when this parameter is true, you will have to reload the page to restore rendering
  36480. */
  36481. doNotHandleContextLost?: boolean;
  36482. /**
  36483. * Defines that engine should ignore modifying touch action attribute and style
  36484. * If not handle, you might need to set it up on your side for expected touch devices behavior.
  36485. */
  36486. doNotHandleTouchAction?: boolean;
  36487. /**
  36488. * Defines that engine should compile shaders with high precision floats (if supported). True by default
  36489. */
  36490. useHighPrecisionFloats?: boolean;
  36491. /**
  36492. * Make the canvas XR Compatible for XR sessions
  36493. */
  36494. xrCompatible?: boolean;
  36495. /**
  36496. * Make the matrix computations to be performed in 64 bits instead of 32 bits. False by default
  36497. */
  36498. useHighPrecisionMatrix?: boolean;
  36499. }
  36500. /**
  36501. * The base engine class (root of all engines)
  36502. */
  36503. export class ThinEngine {
  36504. /** Use this array to turn off some WebGL2 features on known buggy browsers version */
  36505. static ExceptionList: ({
  36506. key: string;
  36507. capture: string;
  36508. captureConstraint: number;
  36509. targets: string[];
  36510. } | {
  36511. key: string;
  36512. capture: null;
  36513. captureConstraint: null;
  36514. targets: string[];
  36515. })[];
  36516. /** @hidden */
  36517. static _TextureLoaders: IInternalTextureLoader[];
  36518. /**
  36519. * Returns the current npm package of the sdk
  36520. */
  36521. static get NpmPackage(): string;
  36522. /**
  36523. * Returns the current version of the framework
  36524. */
  36525. static get Version(): string;
  36526. /**
  36527. * Returns a string describing the current engine
  36528. */
  36529. get description(): string;
  36530. /**
  36531. * Gets or sets the epsilon value used by collision engine
  36532. */
  36533. static CollisionsEpsilon: number;
  36534. /**
  36535. * Gets or sets the relative url used to load shaders if using the engine in non-minified mode
  36536. */
  36537. static get ShadersRepository(): string;
  36538. static set ShadersRepository(value: string);
  36539. /** @hidden */
  36540. _shaderProcessor: IShaderProcessor;
  36541. /**
  36542. * Gets or sets a boolean that indicates if textures must be forced to power of 2 size even if not required
  36543. */
  36544. forcePOTTextures: boolean;
  36545. /**
  36546. * Gets a boolean indicating if the engine is currently rendering in fullscreen mode
  36547. */
  36548. isFullscreen: boolean;
  36549. /**
  36550. * Gets or sets a boolean indicating if back faces must be culled (true by default)
  36551. */
  36552. cullBackFaces: boolean;
  36553. /**
  36554. * Gets or sets a boolean indicating if the engine must keep rendering even if the window is not in foregroun
  36555. */
  36556. renderEvenInBackground: boolean;
  36557. /**
  36558. * Gets or sets a boolean indicating that cache can be kept between frames
  36559. */
  36560. preventCacheWipeBetweenFrames: boolean;
  36561. /** Gets or sets a boolean indicating if the engine should validate programs after compilation */
  36562. validateShaderPrograms: boolean;
  36563. /**
  36564. * Gets or sets a boolean indicating if depth buffer should be reverse, going from far to near.
  36565. * This can provide greater z depth for distant objects.
  36566. */
  36567. useReverseDepthBuffer: boolean;
  36568. /**
  36569. * Gets or sets a boolean indicating that uniform buffers must be disabled even if they are supported
  36570. */
  36571. disableUniformBuffers: boolean;
  36572. /** @hidden */
  36573. _uniformBuffers: UniformBuffer[];
  36574. /**
  36575. * Gets a boolean indicating that the engine supports uniform buffers
  36576. * @see https://doc.babylonjs.com/features/webgl2#uniform-buffer-objets
  36577. */
  36578. get supportsUniformBuffers(): boolean;
  36579. /** @hidden */
  36580. _gl: WebGLRenderingContext;
  36581. /** @hidden */
  36582. _webGLVersion: number;
  36583. protected _renderingCanvas: Nullable<HTMLCanvasElement>;
  36584. protected _windowIsBackground: boolean;
  36585. protected _creationOptions: EngineOptions;
  36586. protected _highPrecisionShadersAllowed: boolean;
  36587. /** @hidden */
  36588. get _shouldUseHighPrecisionShader(): boolean;
  36589. /**
  36590. * Gets a boolean indicating that only power of 2 textures are supported
  36591. * Please note that you can still use non power of 2 textures but in this case the engine will forcefully convert them
  36592. */
  36593. get needPOTTextures(): boolean;
  36594. /** @hidden */
  36595. _badOS: boolean;
  36596. /** @hidden */
  36597. _badDesktopOS: boolean;
  36598. private _hardwareScalingLevel;
  36599. /** @hidden */
  36600. _caps: EngineCapabilities;
  36601. private _isStencilEnable;
  36602. private _glVersion;
  36603. private _glRenderer;
  36604. private _glVendor;
  36605. /** @hidden */
  36606. _videoTextureSupported: boolean;
  36607. protected _renderingQueueLaunched: boolean;
  36608. protected _activeRenderLoops: (() => void)[];
  36609. /**
  36610. * Observable signaled when a context lost event is raised
  36611. */
  36612. onContextLostObservable: Observable<ThinEngine>;
  36613. /**
  36614. * Observable signaled when a context restored event is raised
  36615. */
  36616. onContextRestoredObservable: Observable<ThinEngine>;
  36617. private _onContextLost;
  36618. private _onContextRestored;
  36619. protected _contextWasLost: boolean;
  36620. /** @hidden */
  36621. _doNotHandleContextLost: boolean;
  36622. /**
  36623. * Gets or sets a boolean indicating if resources should be retained to be able to handle context lost events
  36624. * @see https://doc.babylonjs.com/how_to/optimizing_your_scene#handling-webgl-context-lost
  36625. */
  36626. get doNotHandleContextLost(): boolean;
  36627. set doNotHandleContextLost(value: boolean);
  36628. /**
  36629. * Gets or sets a boolean indicating that vertex array object must be disabled even if they are supported
  36630. */
  36631. disableVertexArrayObjects: boolean;
  36632. /** @hidden */
  36633. protected _colorWrite: boolean;
  36634. /** @hidden */
  36635. protected _colorWriteChanged: boolean;
  36636. /** @hidden */
  36637. protected _depthCullingState: DepthCullingState;
  36638. /** @hidden */
  36639. protected _stencilState: StencilState;
  36640. /** @hidden */
  36641. _alphaState: AlphaState;
  36642. /** @hidden */
  36643. _alphaMode: number;
  36644. /** @hidden */
  36645. _alphaEquation: number;
  36646. /** @hidden */
  36647. _internalTexturesCache: InternalTexture[];
  36648. /** @hidden */
  36649. protected _activeChannel: number;
  36650. private _currentTextureChannel;
  36651. /** @hidden */
  36652. protected _boundTexturesCache: {
  36653. [key: string]: Nullable<InternalTexture>;
  36654. };
  36655. /** @hidden */
  36656. protected _currentEffect: Nullable<Effect>;
  36657. /** @hidden */
  36658. protected _currentProgram: Nullable<WebGLProgram>;
  36659. private _compiledEffects;
  36660. private _vertexAttribArraysEnabled;
  36661. /** @hidden */
  36662. protected _cachedViewport: Nullable<IViewportLike>;
  36663. private _cachedVertexArrayObject;
  36664. /** @hidden */
  36665. protected _cachedVertexBuffers: any;
  36666. /** @hidden */
  36667. protected _cachedIndexBuffer: Nullable<DataBuffer>;
  36668. /** @hidden */
  36669. protected _cachedEffectForVertexBuffers: Nullable<Effect>;
  36670. /** @hidden */
  36671. _currentRenderTarget: Nullable<InternalTexture>;
  36672. private _uintIndicesCurrentlySet;
  36673. protected _currentBoundBuffer: Nullable<WebGLBuffer>[];
  36674. /** @hidden */
  36675. _currentFramebuffer: Nullable<WebGLFramebuffer>;
  36676. /** @hidden */
  36677. _dummyFramebuffer: Nullable<WebGLFramebuffer>;
  36678. private _currentBufferPointers;
  36679. private _currentInstanceLocations;
  36680. private _currentInstanceBuffers;
  36681. private _textureUnits;
  36682. /** @hidden */
  36683. _workingCanvas: Nullable<HTMLCanvasElement | OffscreenCanvas>;
  36684. /** @hidden */
  36685. _workingContext: Nullable<CanvasRenderingContext2D | OffscreenCanvasRenderingContext2D>;
  36686. /** @hidden */
  36687. _boundRenderFunction: any;
  36688. private _vaoRecordInProgress;
  36689. private _mustWipeVertexAttributes;
  36690. private _emptyTexture;
  36691. private _emptyCubeTexture;
  36692. private _emptyTexture3D;
  36693. private _emptyTexture2DArray;
  36694. /** @hidden */
  36695. _frameHandler: number;
  36696. private _nextFreeTextureSlots;
  36697. private _maxSimultaneousTextures;
  36698. private _activeRequests;
  36699. /** @hidden */
  36700. _transformTextureUrl: Nullable<(url: string) => string>;
  36701. /**
  36702. * Gets information about the current host
  36703. */
  36704. hostInformation: HostInformation;
  36705. protected get _supportsHardwareTextureRescaling(): boolean;
  36706. private _framebufferDimensionsObject;
  36707. /**
  36708. * sets the object from which width and height will be taken from when getting render width and height
  36709. * Will fallback to the gl object
  36710. * @param dimensions the framebuffer width and height that will be used.
  36711. */
  36712. set framebufferDimensionsObject(dimensions: Nullable<{
  36713. framebufferWidth: number;
  36714. framebufferHeight: number;
  36715. }>);
  36716. /**
  36717. * Gets the current viewport
  36718. */
  36719. get currentViewport(): Nullable<IViewportLike>;
  36720. /**
  36721. * Gets the default empty texture
  36722. */
  36723. get emptyTexture(): InternalTexture;
  36724. /**
  36725. * Gets the default empty 3D texture
  36726. */
  36727. get emptyTexture3D(): InternalTexture;
  36728. /**
  36729. * Gets the default empty 2D array texture
  36730. */
  36731. get emptyTexture2DArray(): InternalTexture;
  36732. /**
  36733. * Gets the default empty cube texture
  36734. */
  36735. get emptyCubeTexture(): InternalTexture;
  36736. /**
  36737. * Defines whether the engine has been created with the premultipliedAlpha option on or not.
  36738. */
  36739. readonly premultipliedAlpha: boolean;
  36740. /**
  36741. * Observable event triggered before each texture is initialized
  36742. */
  36743. onBeforeTextureInitObservable: Observable<import("babylonjs/Materials/Textures/texture").Texture>;
  36744. /**
  36745. * Creates a new engine
  36746. * @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
  36747. * @param antialias defines enable antialiasing (default: false)
  36748. * @param options defines further options to be sent to the getContext() function
  36749. * @param adaptToDeviceRatio defines whether to adapt to the device's viewport characteristics (default: false)
  36750. */
  36751. constructor(canvasOrContext: Nullable<HTMLCanvasElement | WebGLRenderingContext | WebGL2RenderingContext>, antialias?: boolean, options?: EngineOptions, adaptToDeviceRatio?: boolean);
  36752. private _rebuildInternalTextures;
  36753. private _rebuildEffects;
  36754. /**
  36755. * Gets a boolean indicating if all created effects are ready
  36756. * @returns true if all effects are ready
  36757. */
  36758. areAllEffectsReady(): boolean;
  36759. protected _rebuildBuffers(): void;
  36760. protected _initGLContext(): void;
  36761. /**
  36762. * Gets version of the current webGL context
  36763. */
  36764. get webGLVersion(): number;
  36765. /**
  36766. * Gets a string identifying the name of the class
  36767. * @returns "Engine" string
  36768. */
  36769. getClassName(): string;
  36770. /**
  36771. * Returns true if the stencil buffer has been enabled through the creation option of the context.
  36772. */
  36773. get isStencilEnable(): boolean;
  36774. /** @hidden */
  36775. _prepareWorkingCanvas(): void;
  36776. /**
  36777. * Reset the texture cache to empty state
  36778. */
  36779. resetTextureCache(): void;
  36780. /**
  36781. * Gets an object containing information about the current webGL context
  36782. * @returns an object containing the vender, the renderer and the version of the current webGL context
  36783. */
  36784. getGlInfo(): {
  36785. vendor: string;
  36786. renderer: string;
  36787. version: string;
  36788. };
  36789. /**
  36790. * Defines the hardware scaling level.
  36791. * By default the hardware scaling level is computed from the window device ratio.
  36792. * if level = 1 then the engine will render at the exact resolution of the canvas. If level = 0.5 then the engine will render at twice the size of the canvas.
  36793. * @param level defines the level to use
  36794. */
  36795. setHardwareScalingLevel(level: number): void;
  36796. /**
  36797. * Gets the current hardware scaling level.
  36798. * By default the hardware scaling level is computed from the window device ratio.
  36799. * 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.
  36800. * @returns a number indicating the current hardware scaling level
  36801. */
  36802. getHardwareScalingLevel(): number;
  36803. /**
  36804. * Gets the list of loaded textures
  36805. * @returns an array containing all loaded textures
  36806. */
  36807. getLoadedTexturesCache(): InternalTexture[];
  36808. /**
  36809. * Gets the object containing all engine capabilities
  36810. * @returns the EngineCapabilities object
  36811. */
  36812. getCaps(): EngineCapabilities;
  36813. /**
  36814. * stop executing a render loop function and remove it from the execution array
  36815. * @param renderFunction defines the function to be removed. If not provided all functions will be removed.
  36816. */
  36817. stopRenderLoop(renderFunction?: () => void): void;
  36818. /** @hidden */
  36819. _renderLoop(): void;
  36820. /**
  36821. * Gets the HTML canvas attached with the current webGL context
  36822. * @returns a HTML canvas
  36823. */
  36824. getRenderingCanvas(): Nullable<HTMLCanvasElement>;
  36825. /**
  36826. * Gets host window
  36827. * @returns the host window object
  36828. */
  36829. getHostWindow(): Nullable<Window>;
  36830. /**
  36831. * Gets the current render width
  36832. * @param useScreen defines if screen size must be used (or the current render target if any)
  36833. * @returns a number defining the current render width
  36834. */
  36835. getRenderWidth(useScreen?: boolean): number;
  36836. /**
  36837. * Gets the current render height
  36838. * @param useScreen defines if screen size must be used (or the current render target if any)
  36839. * @returns a number defining the current render height
  36840. */
  36841. getRenderHeight(useScreen?: boolean): number;
  36842. /**
  36843. * Can be used to override the current requestAnimationFrame requester.
  36844. * @hidden
  36845. */
  36846. protected _queueNewFrame(bindedRenderFunction: any, requester?: any): number;
  36847. /**
  36848. * Register and execute a render loop. The engine can have more than one render function
  36849. * @param renderFunction defines the function to continuously execute
  36850. */
  36851. runRenderLoop(renderFunction: () => void): void;
  36852. /**
  36853. * Clear the current render buffer or the current render target (if any is set up)
  36854. * @param color defines the color to use
  36855. * @param backBuffer defines if the back buffer must be cleared
  36856. * @param depth defines if the depth buffer must be cleared
  36857. * @param stencil defines if the stencil buffer must be cleared
  36858. */
  36859. clear(color: Nullable<IColor4Like>, backBuffer: boolean, depth: boolean, stencil?: boolean): void;
  36860. private _viewportCached;
  36861. /** @hidden */
  36862. _viewport(x: number, y: number, width: number, height: number): void;
  36863. /**
  36864. * Set the WebGL's viewport
  36865. * @param viewport defines the viewport element to be used
  36866. * @param requiredWidth defines the width required for rendering. If not provided the rendering canvas' width is used
  36867. * @param requiredHeight defines the height required for rendering. If not provided the rendering canvas' height is used
  36868. */
  36869. setViewport(viewport: IViewportLike, requiredWidth?: number, requiredHeight?: number): void;
  36870. /**
  36871. * Begin a new frame
  36872. */
  36873. beginFrame(): void;
  36874. /**
  36875. * Enf the current frame
  36876. */
  36877. endFrame(): void;
  36878. /**
  36879. * Resize the view according to the canvas' size
  36880. */
  36881. resize(): void;
  36882. /**
  36883. * Force a specific size of the canvas
  36884. * @param width defines the new canvas' width
  36885. * @param height defines the new canvas' height
  36886. * @returns true if the size was changed
  36887. */
  36888. setSize(width: number, height: number): boolean;
  36889. /**
  36890. * Binds the frame buffer to the specified texture.
  36891. * @param texture The texture to render to or null for the default canvas
  36892. * @param faceIndex The face of the texture to render to in case of cube texture
  36893. * @param requiredWidth The width of the target to render to
  36894. * @param requiredHeight The height of the target to render to
  36895. * @param forceFullscreenViewport Forces the viewport to be the entire texture/screen if true
  36896. * @param lodLevel defines the lod level to bind to the frame buffer
  36897. * @param layer defines the 2d array index to bind to frame buffer to
  36898. */
  36899. bindFramebuffer(texture: InternalTexture, faceIndex?: number, requiredWidth?: number, requiredHeight?: number, forceFullscreenViewport?: boolean, lodLevel?: number, layer?: number): void;
  36900. /** @hidden */
  36901. _bindUnboundFramebuffer(framebuffer: Nullable<WebGLFramebuffer>): void;
  36902. /**
  36903. * Unbind the current render target texture from the webGL context
  36904. * @param texture defines the render target texture to unbind
  36905. * @param disableGenerateMipMaps defines a boolean indicating that mipmaps must not be generated
  36906. * @param onBeforeUnbind defines a function which will be called before the effective unbind
  36907. */
  36908. unBindFramebuffer(texture: InternalTexture, disableGenerateMipMaps?: boolean, onBeforeUnbind?: () => void): void;
  36909. /**
  36910. * Force a webGL flush (ie. a flush of all waiting webGL commands)
  36911. */
  36912. flushFramebuffer(): void;
  36913. /**
  36914. * Unbind the current render target and bind the default framebuffer
  36915. */
  36916. restoreDefaultFramebuffer(): void;
  36917. /** @hidden */
  36918. protected _resetVertexBufferBinding(): void;
  36919. /**
  36920. * Creates a vertex buffer
  36921. * @param data the data for the vertex buffer
  36922. * @returns the new WebGL static buffer
  36923. */
  36924. createVertexBuffer(data: DataArray): DataBuffer;
  36925. private _createVertexBuffer;
  36926. /**
  36927. * Creates a dynamic vertex buffer
  36928. * @param data the data for the dynamic vertex buffer
  36929. * @returns the new WebGL dynamic buffer
  36930. */
  36931. createDynamicVertexBuffer(data: DataArray): DataBuffer;
  36932. protected _resetIndexBufferBinding(): void;
  36933. /**
  36934. * Creates a new index buffer
  36935. * @param indices defines the content of the index buffer
  36936. * @param updatable defines if the index buffer must be updatable
  36937. * @returns a new webGL buffer
  36938. */
  36939. createIndexBuffer(indices: IndicesArray, updatable?: boolean): DataBuffer;
  36940. protected _normalizeIndexData(indices: IndicesArray): Uint16Array | Uint32Array;
  36941. /**
  36942. * Bind a webGL buffer to the webGL context
  36943. * @param buffer defines the buffer to bind
  36944. */
  36945. bindArrayBuffer(buffer: Nullable<DataBuffer>): void;
  36946. protected bindIndexBuffer(buffer: Nullable<DataBuffer>): void;
  36947. private bindBuffer;
  36948. /**
  36949. * update the bound buffer with the given data
  36950. * @param data defines the data to update
  36951. */
  36952. updateArrayBuffer(data: Float32Array): void;
  36953. private _vertexAttribPointer;
  36954. /** @hidden */
  36955. _bindIndexBufferWithCache(indexBuffer: Nullable<DataBuffer>): void;
  36956. private _bindVertexBuffersAttributes;
  36957. /**
  36958. * Records a vertex array object
  36959. * @see https://doc.babylonjs.com/features/webgl2#vertex-array-objects
  36960. * @param vertexBuffers defines the list of vertex buffers to store
  36961. * @param indexBuffer defines the index buffer to store
  36962. * @param effect defines the effect to store
  36963. * @returns the new vertex array object
  36964. */
  36965. recordVertexArrayObject(vertexBuffers: {
  36966. [key: string]: VertexBuffer;
  36967. }, indexBuffer: Nullable<DataBuffer>, effect: Effect): WebGLVertexArrayObject;
  36968. /**
  36969. * Bind a specific vertex array object
  36970. * @see https://doc.babylonjs.com/features/webgl2#vertex-array-objects
  36971. * @param vertexArrayObject defines the vertex array object to bind
  36972. * @param indexBuffer defines the index buffer to bind
  36973. */
  36974. bindVertexArrayObject(vertexArrayObject: WebGLVertexArrayObject, indexBuffer: Nullable<DataBuffer>): void;
  36975. /**
  36976. * Bind webGl buffers directly to the webGL context
  36977. * @param vertexBuffer defines the vertex buffer to bind
  36978. * @param indexBuffer defines the index buffer to bind
  36979. * @param vertexDeclaration defines the vertex declaration to use with the vertex buffer
  36980. * @param vertexStrideSize defines the vertex stride of the vertex buffer
  36981. * @param effect defines the effect associated with the vertex buffer
  36982. */
  36983. bindBuffersDirectly(vertexBuffer: DataBuffer, indexBuffer: DataBuffer, vertexDeclaration: number[], vertexStrideSize: number, effect: Effect): void;
  36984. private _unbindVertexArrayObject;
  36985. /**
  36986. * Bind a list of vertex buffers to the webGL context
  36987. * @param vertexBuffers defines the list of vertex buffers to bind
  36988. * @param indexBuffer defines the index buffer to bind
  36989. * @param effect defines the effect associated with the vertex buffers
  36990. */
  36991. bindBuffers(vertexBuffers: {
  36992. [key: string]: Nullable<VertexBuffer>;
  36993. }, indexBuffer: Nullable<DataBuffer>, effect: Effect): void;
  36994. /**
  36995. * Unbind all instance attributes
  36996. */
  36997. unbindInstanceAttributes(): void;
  36998. /**
  36999. * Release and free the memory of a vertex array object
  37000. * @param vao defines the vertex array object to delete
  37001. */
  37002. releaseVertexArrayObject(vao: WebGLVertexArrayObject): void;
  37003. /** @hidden */
  37004. _releaseBuffer(buffer: DataBuffer): boolean;
  37005. protected _deleteBuffer(buffer: DataBuffer): void;
  37006. /**
  37007. * Update the content of a webGL buffer used with instanciation and bind it to the webGL context
  37008. * @param instancesBuffer defines the webGL buffer to update and bind
  37009. * @param data defines the data to store in the buffer
  37010. * @param offsetLocations defines the offsets or attributes information used to determine where data must be stored in the buffer
  37011. */
  37012. updateAndBindInstancesBuffer(instancesBuffer: DataBuffer, data: Float32Array, offsetLocations: number[] | InstancingAttributeInfo[]): void;
  37013. /**
  37014. * Bind the content of a webGL buffer used with instantiation
  37015. * @param instancesBuffer defines the webGL buffer to bind
  37016. * @param attributesInfo defines the offsets or attributes information used to determine where data must be stored in the buffer
  37017. * @param computeStride defines Whether to compute the strides from the info or use the default 0
  37018. */
  37019. bindInstancesBuffer(instancesBuffer: DataBuffer, attributesInfo: InstancingAttributeInfo[], computeStride?: boolean): void;
  37020. /**
  37021. * Disable the instance attribute corresponding to the name in parameter
  37022. * @param name defines the name of the attribute to disable
  37023. */
  37024. disableInstanceAttributeByName(name: string): void;
  37025. /**
  37026. * Disable the instance attribute corresponding to the location in parameter
  37027. * @param attributeLocation defines the attribute location of the attribute to disable
  37028. */
  37029. disableInstanceAttribute(attributeLocation: number): void;
  37030. /**
  37031. * Disable the attribute corresponding to the location in parameter
  37032. * @param attributeLocation defines the attribute location of the attribute to disable
  37033. */
  37034. disableAttributeByIndex(attributeLocation: number): void;
  37035. /**
  37036. * Send a draw order
  37037. * @param useTriangles defines if triangles must be used to draw (else wireframe will be used)
  37038. * @param indexStart defines the starting index
  37039. * @param indexCount defines the number of index to draw
  37040. * @param instancesCount defines the number of instances to draw (if instanciation is enabled)
  37041. */
  37042. draw(useTriangles: boolean, indexStart: number, indexCount: number, instancesCount?: number): void;
  37043. /**
  37044. * Draw a list of points
  37045. * @param verticesStart defines the index of first vertex to draw
  37046. * @param verticesCount defines the count of vertices to draw
  37047. * @param instancesCount defines the number of instances to draw (if instanciation is enabled)
  37048. */
  37049. drawPointClouds(verticesStart: number, verticesCount: number, instancesCount?: number): void;
  37050. /**
  37051. * Draw a list of unindexed primitives
  37052. * @param useTriangles defines if triangles must be used to draw (else wireframe will be used)
  37053. * @param verticesStart defines the index of first vertex to draw
  37054. * @param verticesCount defines the count of vertices to draw
  37055. * @param instancesCount defines the number of instances to draw (if instanciation is enabled)
  37056. */
  37057. drawUnIndexed(useTriangles: boolean, verticesStart: number, verticesCount: number, instancesCount?: number): void;
  37058. /**
  37059. * Draw a list of indexed primitives
  37060. * @param fillMode defines the primitive to use
  37061. * @param indexStart defines the starting index
  37062. * @param indexCount defines the number of index to draw
  37063. * @param instancesCount defines the number of instances to draw (if instanciation is enabled)
  37064. */
  37065. drawElementsType(fillMode: number, indexStart: number, indexCount: number, instancesCount?: number): void;
  37066. /**
  37067. * Draw a list of unindexed primitives
  37068. * @param fillMode defines the primitive to use
  37069. * @param verticesStart defines the index of first vertex to draw
  37070. * @param verticesCount defines the count of vertices to draw
  37071. * @param instancesCount defines the number of instances to draw (if instanciation is enabled)
  37072. */
  37073. drawArraysType(fillMode: number, verticesStart: number, verticesCount: number, instancesCount?: number): void;
  37074. private _drawMode;
  37075. /** @hidden */
  37076. protected _reportDrawCall(): void;
  37077. /** @hidden */
  37078. _releaseEffect(effect: Effect): void;
  37079. /** @hidden */
  37080. _deletePipelineContext(pipelineContext: IPipelineContext): void;
  37081. /**
  37082. * Create a new effect (used to store vertex/fragment shaders)
  37083. * @param baseName defines the base name of the effect (The name of file without .fragment.fx or .vertex.fx)
  37084. * @param attributesNamesOrOptions defines either a list of attribute names or an IEffectCreationOptions object
  37085. * @param uniformsNamesOrEngine defines either a list of uniform names or the engine to use
  37086. * @param samplers defines an array of string used to represent textures
  37087. * @param defines defines the string containing the defines to use to compile the shaders
  37088. * @param fallbacks defines the list of potential fallbacks to use if shader conmpilation fails
  37089. * @param onCompiled defines a function to call when the effect creation is successful
  37090. * @param onError defines a function to call when the effect creation has failed
  37091. * @param indexParameters defines an object containing the index values to use to compile shaders (like the maximum number of simultaneous lights)
  37092. * @returns the new Effect
  37093. */
  37094. 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;
  37095. protected static _ConcatenateShader(source: string, defines: Nullable<string>, shaderVersion?: string): string;
  37096. private _compileShader;
  37097. private _compileRawShader;
  37098. /** @hidden */
  37099. _getShaderSource(shader: WebGLShader): Nullable<string>;
  37100. /**
  37101. * Directly creates a webGL program
  37102. * @param pipelineContext defines the pipeline context to attach to
  37103. * @param vertexCode defines the vertex shader code to use
  37104. * @param fragmentCode defines the fragment shader code to use
  37105. * @param context defines the webGL context to use (if not set, the current one will be used)
  37106. * @param transformFeedbackVaryings defines the list of transform feedback varyings to use
  37107. * @returns the new webGL program
  37108. */
  37109. createRawShaderProgram(pipelineContext: IPipelineContext, vertexCode: string, fragmentCode: string, context?: WebGLRenderingContext, transformFeedbackVaryings?: Nullable<string[]>): WebGLProgram;
  37110. /**
  37111. * Creates a webGL program
  37112. * @param pipelineContext defines the pipeline context to attach to
  37113. * @param vertexCode defines the vertex shader code to use
  37114. * @param fragmentCode defines the fragment shader code to use
  37115. * @param defines defines the string containing the defines to use to compile the shaders
  37116. * @param context defines the webGL context to use (if not set, the current one will be used)
  37117. * @param transformFeedbackVaryings defines the list of transform feedback varyings to use
  37118. * @returns the new webGL program
  37119. */
  37120. createShaderProgram(pipelineContext: IPipelineContext, vertexCode: string, fragmentCode: string, defines: Nullable<string>, context?: WebGLRenderingContext, transformFeedbackVaryings?: Nullable<string[]>): WebGLProgram;
  37121. /**
  37122. * Creates a new pipeline context
  37123. * @returns the new pipeline
  37124. */
  37125. createPipelineContext(): IPipelineContext;
  37126. protected _createShaderProgram(pipelineContext: WebGLPipelineContext, vertexShader: WebGLShader, fragmentShader: WebGLShader, context: WebGLRenderingContext, transformFeedbackVaryings?: Nullable<string[]>): WebGLProgram;
  37127. protected _finalizePipelineContext(pipelineContext: WebGLPipelineContext): void;
  37128. /** @hidden */
  37129. _preparePipelineContext(pipelineContext: IPipelineContext, vertexSourceCode: string, fragmentSourceCode: string, createAsRaw: boolean, rebuildRebind: any, defines: Nullable<string>, transformFeedbackVaryings: Nullable<string[]>): void;
  37130. /** @hidden */
  37131. _isRenderingStateCompiled(pipelineContext: IPipelineContext): boolean;
  37132. /** @hidden */
  37133. _executeWhenRenderingStateIsCompiled(pipelineContext: IPipelineContext, action: () => void): void;
  37134. /**
  37135. * Gets the list of webGL uniform locations associated with a specific program based on a list of uniform names
  37136. * @param pipelineContext defines the pipeline context to use
  37137. * @param uniformsNames defines the list of uniform names
  37138. * @returns an array of webGL uniform locations
  37139. */
  37140. getUniforms(pipelineContext: IPipelineContext, uniformsNames: string[]): Nullable<WebGLUniformLocation>[];
  37141. /**
  37142. * Gets the lsit of active attributes for a given webGL program
  37143. * @param pipelineContext defines the pipeline context to use
  37144. * @param attributesNames defines the list of attribute names to get
  37145. * @returns an array of indices indicating the offset of each attribute
  37146. */
  37147. getAttributes(pipelineContext: IPipelineContext, attributesNames: string[]): number[];
  37148. /**
  37149. * Activates an effect, mkaing it the current one (ie. the one used for rendering)
  37150. * @param effect defines the effect to activate
  37151. */
  37152. enableEffect(effect: Nullable<Effect>): void;
  37153. /**
  37154. * Set the value of an uniform to a number (int)
  37155. * @param uniform defines the webGL uniform location where to store the value
  37156. * @param value defines the int number to store
  37157. */
  37158. setInt(uniform: Nullable<WebGLUniformLocation>, value: number): void;
  37159. /**
  37160. * Set the value of an uniform to an array of int32
  37161. * @param uniform defines the webGL uniform location where to store the value
  37162. * @param array defines the array of int32 to store
  37163. */
  37164. setIntArray(uniform: Nullable<WebGLUniformLocation>, array: Int32Array): void;
  37165. /**
  37166. * Set the value of an uniform to an array of int32 (stored as vec2)
  37167. * @param uniform defines the webGL uniform location where to store the value
  37168. * @param array defines the array of int32 to store
  37169. */
  37170. setIntArray2(uniform: Nullable<WebGLUniformLocation>, array: Int32Array): void;
  37171. /**
  37172. * Set the value of an uniform to an array of int32 (stored as vec3)
  37173. * @param uniform defines the webGL uniform location where to store the value
  37174. * @param array defines the array of int32 to store
  37175. */
  37176. setIntArray3(uniform: Nullable<WebGLUniformLocation>, array: Int32Array): void;
  37177. /**
  37178. * Set the value of an uniform to an array of int32 (stored as vec4)
  37179. * @param uniform defines the webGL uniform location where to store the value
  37180. * @param array defines the array of int32 to store
  37181. */
  37182. setIntArray4(uniform: Nullable<WebGLUniformLocation>, array: Int32Array): void;
  37183. /**
  37184. * Set the value of an uniform to an array of number
  37185. * @param uniform defines the webGL uniform location where to store the value
  37186. * @param array defines the array of number to store
  37187. */
  37188. setArray(uniform: Nullable<WebGLUniformLocation>, array: number[] | Float32Array): void;
  37189. /**
  37190. * Set the value of an uniform to an array of number (stored as vec2)
  37191. * @param uniform defines the webGL uniform location where to store the value
  37192. * @param array defines the array of number to store
  37193. */
  37194. setArray2(uniform: Nullable<WebGLUniformLocation>, array: number[] | Float32Array): void;
  37195. /**
  37196. * Set the value of an uniform to an array of number (stored as vec3)
  37197. * @param uniform defines the webGL uniform location where to store the value
  37198. * @param array defines the array of number to store
  37199. */
  37200. setArray3(uniform: Nullable<WebGLUniformLocation>, array: number[] | Float32Array): void;
  37201. /**
  37202. * Set the value of an uniform to an array of number (stored as vec4)
  37203. * @param uniform defines the webGL uniform location where to store the value
  37204. * @param array defines the array of number to store
  37205. */
  37206. setArray4(uniform: Nullable<WebGLUniformLocation>, array: number[] | Float32Array): void;
  37207. /**
  37208. * Set the value of an uniform to an array of float32 (stored as matrices)
  37209. * @param uniform defines the webGL uniform location where to store the value
  37210. * @param matrices defines the array of float32 to store
  37211. */
  37212. setMatrices(uniform: Nullable<WebGLUniformLocation>, matrices: Float32Array): void;
  37213. /**
  37214. * Set the value of an uniform to a matrix (3x3)
  37215. * @param uniform defines the webGL uniform location where to store the value
  37216. * @param matrix defines the Float32Array representing the 3x3 matrix to store
  37217. */
  37218. setMatrix3x3(uniform: Nullable<WebGLUniformLocation>, matrix: Float32Array): void;
  37219. /**
  37220. * Set the value of an uniform to a matrix (2x2)
  37221. * @param uniform defines the webGL uniform location where to store the value
  37222. * @param matrix defines the Float32Array representing the 2x2 matrix to store
  37223. */
  37224. setMatrix2x2(uniform: Nullable<WebGLUniformLocation>, matrix: Float32Array): void;
  37225. /**
  37226. * Set the value of an uniform to a number (float)
  37227. * @param uniform defines the webGL uniform location where to store the value
  37228. * @param value defines the float number to store
  37229. */
  37230. setFloat(uniform: Nullable<WebGLUniformLocation>, value: number): void;
  37231. /**
  37232. * Set the value of an uniform to a vec2
  37233. * @param uniform defines the webGL uniform location where to store the value
  37234. * @param x defines the 1st component of the value
  37235. * @param y defines the 2nd component of the value
  37236. */
  37237. setFloat2(uniform: Nullable<WebGLUniformLocation>, x: number, y: number): void;
  37238. /**
  37239. * Set the value of an uniform to a vec3
  37240. * @param uniform defines the webGL uniform location where to store the value
  37241. * @param x defines the 1st component of the value
  37242. * @param y defines the 2nd component of the value
  37243. * @param z defines the 3rd component of the value
  37244. */
  37245. setFloat3(uniform: Nullable<WebGLUniformLocation>, x: number, y: number, z: number): void;
  37246. /**
  37247. * Set the value of an uniform to a vec4
  37248. * @param uniform defines the webGL uniform location where to store the value
  37249. * @param x defines the 1st component of the value
  37250. * @param y defines the 2nd component of the value
  37251. * @param z defines the 3rd component of the value
  37252. * @param w defines the 4th component of the value
  37253. */
  37254. setFloat4(uniform: Nullable<WebGLUniformLocation>, x: number, y: number, z: number, w: number): void;
  37255. /**
  37256. * Apply all cached states (depth, culling, stencil and alpha)
  37257. */
  37258. applyStates(): void;
  37259. /**
  37260. * Enable or disable color writing
  37261. * @param enable defines the state to set
  37262. */
  37263. setColorWrite(enable: boolean): void;
  37264. /**
  37265. * Gets a boolean indicating if color writing is enabled
  37266. * @returns the current color writing state
  37267. */
  37268. getColorWrite(): boolean;
  37269. /**
  37270. * Gets the depth culling state manager
  37271. */
  37272. get depthCullingState(): DepthCullingState;
  37273. /**
  37274. * Gets the alpha state manager
  37275. */
  37276. get alphaState(): AlphaState;
  37277. /**
  37278. * Gets the stencil state manager
  37279. */
  37280. get stencilState(): StencilState;
  37281. /**
  37282. * Clears the list of texture accessible through engine.
  37283. * This can help preventing texture load conflict due to name collision.
  37284. */
  37285. clearInternalTexturesCache(): void;
  37286. /**
  37287. * Force the entire cache to be cleared
  37288. * You should not have to use this function unless your engine needs to share the webGL context with another engine
  37289. * @param bruteForce defines a boolean to force clearing ALL caches (including stencil, detoh and alpha states)
  37290. */
  37291. wipeCaches(bruteForce?: boolean): void;
  37292. /** @hidden */
  37293. _getSamplingParameters(samplingMode: number, generateMipMaps: boolean): {
  37294. min: number;
  37295. mag: number;
  37296. };
  37297. /** @hidden */
  37298. _createTexture(): WebGLTexture;
  37299. /**
  37300. * Usually called from Texture.ts.
  37301. * Passed information to create a WebGLTexture
  37302. * @param url defines a value which contains one of the following:
  37303. * * A conventional http URL, e.g. 'http://...' or 'file://...'
  37304. * * A base64 string of in-line texture data, e.g. 'data:image/jpg;base64,/...'
  37305. * * An indicator that data being passed using the buffer parameter, e.g. 'data:mytexture.jpg'
  37306. * @param noMipmap defines a boolean indicating that no mipmaps shall be generated. Ignored for compressed textures. They must be in the file
  37307. * @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)
  37308. * @param scene needed for loading to the correct scene
  37309. * @param samplingMode mode with should be used sample / access the texture (Default: Texture.TRILINEAR_SAMPLINGMODE)
  37310. * @param onLoad optional callback to be called upon successful completion
  37311. * @param onError optional callback to be called upon failure
  37312. * @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
  37313. * @param fallback an internal argument in case the function must be called again, due to etc1 not having alpha capabilities
  37314. * @param format internal format. Default: RGB when extension is '.jpg' else RGBA. Ignored for compressed textures
  37315. * @param forcedExtension defines the extension to use to pick the right loader
  37316. * @param mimeType defines an optional mime type
  37317. * @returns a InternalTexture for assignment back into BABYLON.Texture
  37318. */
  37319. 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;
  37320. /**
  37321. * Loads an image as an HTMLImageElement.
  37322. * @param input url string, ArrayBuffer, or Blob to load
  37323. * @param onLoad callback called when the image successfully loads
  37324. * @param onError callback called when the image fails to load
  37325. * @param offlineProvider offline provider for caching
  37326. * @param mimeType optional mime type
  37327. * @returns the HTMLImageElement of the loaded image
  37328. * @hidden
  37329. */
  37330. 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>;
  37331. /**
  37332. * @hidden
  37333. */
  37334. _rescaleTexture(source: InternalTexture, destination: InternalTexture, scene: Nullable<any>, internalFormat: number, onComplete: () => void): void;
  37335. private _unpackFlipYCached;
  37336. /**
  37337. * In case you are sharing the context with other applications, it might
  37338. * be interested to not cache the unpack flip y state to ensure a consistent
  37339. * value would be set.
  37340. */
  37341. enableUnpackFlipYCached: boolean;
  37342. /** @hidden */
  37343. _unpackFlipY(value: boolean): void;
  37344. /** @hidden */
  37345. _getUnpackAlignement(): number;
  37346. private _getTextureTarget;
  37347. /**
  37348. * Update the sampling mode of a given texture
  37349. * @param samplingMode defines the required sampling mode
  37350. * @param texture defines the texture to update
  37351. * @param generateMipMaps defines whether to generate mipmaps for the texture
  37352. */
  37353. updateTextureSamplingMode(samplingMode: number, texture: InternalTexture, generateMipMaps?: boolean): void;
  37354. /**
  37355. * Update the sampling mode of a given texture
  37356. * @param texture defines the texture to update
  37357. * @param wrapU defines the texture wrap mode of the u coordinates
  37358. * @param wrapV defines the texture wrap mode of the v coordinates
  37359. * @param wrapR defines the texture wrap mode of the r coordinates
  37360. */
  37361. updateTextureWrappingMode(texture: InternalTexture, wrapU: Nullable<number>, wrapV?: Nullable<number>, wrapR?: Nullable<number>): void;
  37362. /** @hidden */
  37363. _setupDepthStencilTexture(internalTexture: InternalTexture, size: number | {
  37364. width: number;
  37365. height: number;
  37366. layers?: number;
  37367. }, generateStencil: boolean, bilinearFiltering: boolean, comparisonFunction: number): void;
  37368. /** @hidden */
  37369. _uploadCompressedDataToTextureDirectly(texture: InternalTexture, internalFormat: number, width: number, height: number, data: ArrayBufferView, faceIndex?: number, lod?: number): void;
  37370. /** @hidden */
  37371. _uploadDataToTextureDirectly(texture: InternalTexture, imageData: ArrayBufferView, faceIndex?: number, lod?: number, babylonInternalFormat?: number, useTextureWidthAndHeight?: boolean): void;
  37372. /**
  37373. * Update a portion of an internal texture
  37374. * @param texture defines the texture to update
  37375. * @param imageData defines the data to store into the texture
  37376. * @param xOffset defines the x coordinates of the update rectangle
  37377. * @param yOffset defines the y coordinates of the update rectangle
  37378. * @param width defines the width of the update rectangle
  37379. * @param height defines the height of the update rectangle
  37380. * @param faceIndex defines the face index if texture is a cube (0 by default)
  37381. * @param lod defines the lod level to update (0 by default)
  37382. */
  37383. updateTextureData(texture: InternalTexture, imageData: ArrayBufferView, xOffset: number, yOffset: number, width: number, height: number, faceIndex?: number, lod?: number): void;
  37384. /** @hidden */
  37385. _uploadArrayBufferViewToTexture(texture: InternalTexture, imageData: ArrayBufferView, faceIndex?: number, lod?: number): void;
  37386. protected _prepareWebGLTextureContinuation(texture: InternalTexture, scene: Nullable<ISceneLike>, noMipmap: boolean, isCompressed: boolean, samplingMode: number): void;
  37387. private _prepareWebGLTexture;
  37388. /** @hidden */
  37389. _setupFramebufferDepthAttachments(generateStencilBuffer: boolean, generateDepthBuffer: boolean, width: number, height: number, samples?: number): Nullable<WebGLRenderbuffer>;
  37390. private _getDepthStencilBuffer;
  37391. /** @hidden */
  37392. _releaseFramebufferObjects(texture: InternalTexture): void;
  37393. /** @hidden */
  37394. _releaseTexture(texture: InternalTexture): void;
  37395. protected _deleteTexture(texture: Nullable<WebGLTexture>): void;
  37396. protected _setProgram(program: WebGLProgram): void;
  37397. protected _boundUniforms: {
  37398. [key: number]: WebGLUniformLocation;
  37399. };
  37400. /**
  37401. * Binds an effect to the webGL context
  37402. * @param effect defines the effect to bind
  37403. */
  37404. bindSamplers(effect: Effect): void;
  37405. private _activateCurrentTexture;
  37406. /** @hidden */
  37407. _bindTextureDirectly(target: number, texture: Nullable<InternalTexture>, forTextureDataUpdate?: boolean, force?: boolean): boolean;
  37408. /** @hidden */
  37409. _bindTexture(channel: number, texture: Nullable<InternalTexture>): void;
  37410. /**
  37411. * Unbind all textures from the webGL context
  37412. */
  37413. unbindAllTextures(): void;
  37414. /**
  37415. * Sets a texture to the according uniform.
  37416. * @param channel The texture channel
  37417. * @param uniform The uniform to set
  37418. * @param texture The texture to apply
  37419. */
  37420. setTexture(channel: number, uniform: Nullable<WebGLUniformLocation>, texture: Nullable<BaseTexture>): void;
  37421. private _bindSamplerUniformToChannel;
  37422. private _getTextureWrapMode;
  37423. protected _setTexture(channel: number, texture: Nullable<BaseTexture>, isPartOfTextureArray?: boolean, depthStencilTexture?: boolean): boolean;
  37424. /**
  37425. * Sets an array of texture to the webGL context
  37426. * @param channel defines the channel where the texture array must be set
  37427. * @param uniform defines the associated uniform location
  37428. * @param textures defines the array of textures to bind
  37429. */
  37430. setTextureArray(channel: number, uniform: Nullable<WebGLUniformLocation>, textures: BaseTexture[]): void;
  37431. /** @hidden */
  37432. _setAnisotropicLevel(target: number, internalTexture: InternalTexture, anisotropicFilteringLevel: number): void;
  37433. private _setTextureParameterFloat;
  37434. private _setTextureParameterInteger;
  37435. /**
  37436. * Unbind all vertex attributes from the webGL context
  37437. */
  37438. unbindAllAttributes(): void;
  37439. /**
  37440. * 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
  37441. */
  37442. releaseEffects(): void;
  37443. /**
  37444. * Dispose and release all associated resources
  37445. */
  37446. dispose(): void;
  37447. /**
  37448. * Attach a new callback raised when context lost event is fired
  37449. * @param callback defines the callback to call
  37450. */
  37451. attachContextLostEvent(callback: ((event: WebGLContextEvent) => void)): void;
  37452. /**
  37453. * Attach a new callback raised when context restored event is fired
  37454. * @param callback defines the callback to call
  37455. */
  37456. attachContextRestoredEvent(callback: ((event: WebGLContextEvent) => void)): void;
  37457. /**
  37458. * Get the current error code of the webGL context
  37459. * @returns the error code
  37460. * @see https://developer.mozilla.org/en-US/docs/Web/API/WebGLRenderingContext/getError
  37461. */
  37462. getError(): number;
  37463. private _canRenderToFloatFramebuffer;
  37464. private _canRenderToHalfFloatFramebuffer;
  37465. private _canRenderToFramebuffer;
  37466. /** @hidden */
  37467. _getWebGLTextureType(type: number): number;
  37468. /** @hidden */
  37469. _getInternalFormat(format: number): number;
  37470. /** @hidden */
  37471. _getRGBABufferInternalSizedFormat(type: number, format?: number): number;
  37472. /** @hidden */
  37473. _getRGBAMultiSampleBufferFormat(type: number): number;
  37474. /** @hidden */
  37475. _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;
  37476. /**
  37477. * Loads a file from a url
  37478. * @param url url to load
  37479. * @param onSuccess callback called when the file successfully loads
  37480. * @param onProgress callback called while file is loading (if the server supports this mode)
  37481. * @param offlineProvider defines the offline provider for caching
  37482. * @param useArrayBuffer defines a boolean indicating that date must be returned as ArrayBuffer
  37483. * @param onError callback called when the file fails to load
  37484. * @returns a file request object
  37485. * @hidden
  37486. */
  37487. 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;
  37488. /**
  37489. * Reads pixels from the current frame buffer. Please note that this function can be slow
  37490. * @param x defines the x coordinate of the rectangle where pixels must be read
  37491. * @param y defines the y coordinate of the rectangle where pixels must be read
  37492. * @param width defines the width of the rectangle where pixels must be read
  37493. * @param height defines the height of the rectangle where pixels must be read
  37494. * @param hasAlpha defines whether the output should have alpha or not (defaults to true)
  37495. * @returns a Uint8Array containing RGBA colors
  37496. */
  37497. readPixels(x: number, y: number, width: number, height: number, hasAlpha?: boolean): Uint8Array;
  37498. private static _isSupported;
  37499. /**
  37500. * Gets a boolean indicating if the engine can be instanciated (ie. if a webGL context can be found)
  37501. * @returns true if the engine can be created
  37502. * @ignorenaming
  37503. */
  37504. static isSupported(): boolean;
  37505. /**
  37506. * Find the next highest power of two.
  37507. * @param x Number to start search from.
  37508. * @return Next highest power of two.
  37509. */
  37510. static CeilingPOT(x: number): number;
  37511. /**
  37512. * Find the next lowest power of two.
  37513. * @param x Number to start search from.
  37514. * @return Next lowest power of two.
  37515. */
  37516. static FloorPOT(x: number): number;
  37517. /**
  37518. * Find the nearest power of two.
  37519. * @param x Number to start search from.
  37520. * @return Next nearest power of two.
  37521. */
  37522. static NearestPOT(x: number): number;
  37523. /**
  37524. * Get the closest exponent of two
  37525. * @param value defines the value to approximate
  37526. * @param max defines the maximum value to return
  37527. * @param mode defines how to define the closest value
  37528. * @returns closest exponent of two of the given value
  37529. */
  37530. static GetExponentOfTwo(value: number, max: number, mode?: number): number;
  37531. /**
  37532. * Queue a new function into the requested animation frame pool (ie. this function will be executed byt the browser for the next frame)
  37533. * @param func - the function to be called
  37534. * @param requester - the object that will request the next frame. Falls back to window.
  37535. * @returns frame number
  37536. */
  37537. static QueueNewFrame(func: () => void, requester?: any): number;
  37538. /**
  37539. * Gets host document
  37540. * @returns the host document object
  37541. */
  37542. getHostDocument(): Nullable<Document>;
  37543. }
  37544. }
  37545. declare module "babylonjs/Maths/sphericalPolynomial" {
  37546. import { Vector3 } from "babylonjs/Maths/math.vector";
  37547. import { Color3 } from "babylonjs/Maths/math.color";
  37548. /**
  37549. * Class representing spherical harmonics coefficients to the 3rd degree
  37550. */
  37551. export class SphericalHarmonics {
  37552. /**
  37553. * Defines whether or not the harmonics have been prescaled for rendering.
  37554. */
  37555. preScaled: boolean;
  37556. /**
  37557. * The l0,0 coefficients of the spherical harmonics
  37558. */
  37559. l00: Vector3;
  37560. /**
  37561. * The l1,-1 coefficients of the spherical harmonics
  37562. */
  37563. l1_1: Vector3;
  37564. /**
  37565. * The l1,0 coefficients of the spherical harmonics
  37566. */
  37567. l10: Vector3;
  37568. /**
  37569. * The l1,1 coefficients of the spherical harmonics
  37570. */
  37571. l11: Vector3;
  37572. /**
  37573. * The l2,-2 coefficients of the spherical harmonics
  37574. */
  37575. l2_2: Vector3;
  37576. /**
  37577. * The l2,-1 coefficients of the spherical harmonics
  37578. */
  37579. l2_1: Vector3;
  37580. /**
  37581. * The l2,0 coefficients of the spherical harmonics
  37582. */
  37583. l20: Vector3;
  37584. /**
  37585. * The l2,1 coefficients of the spherical harmonics
  37586. */
  37587. l21: Vector3;
  37588. /**
  37589. * The l2,2 coefficients of the spherical harmonics
  37590. */
  37591. l22: Vector3;
  37592. /**
  37593. * Adds a light to the spherical harmonics
  37594. * @param direction the direction of the light
  37595. * @param color the color of the light
  37596. * @param deltaSolidAngle the delta solid angle of the light
  37597. */
  37598. addLight(direction: Vector3, color: Color3, deltaSolidAngle: number): void;
  37599. /**
  37600. * Scales the spherical harmonics by the given amount
  37601. * @param scale the amount to scale
  37602. */
  37603. scaleInPlace(scale: number): void;
  37604. /**
  37605. * Convert from incident radiance (Li) to irradiance (E) by applying convolution with the cosine-weighted hemisphere.
  37606. *
  37607. * ```
  37608. * E_lm = A_l * L_lm
  37609. * ```
  37610. *
  37611. * In spherical harmonics this convolution amounts to scaling factors for each frequency band.
  37612. * This corresponds to equation 5 in "An Efficient Representation for Irradiance Environment Maps", where
  37613. * the scaling factors are given in equation 9.
  37614. */
  37615. convertIncidentRadianceToIrradiance(): void;
  37616. /**
  37617. * Convert from irradiance to outgoing radiance for Lambertian BDRF, suitable for efficient shader evaluation.
  37618. *
  37619. * ```
  37620. * L = (1/pi) * E * rho
  37621. * ```
  37622. *
  37623. * This is done by an additional scale by 1/pi, so is a fairly trivial operation but important conceptually.
  37624. */
  37625. convertIrradianceToLambertianRadiance(): void;
  37626. /**
  37627. * Integrates the reconstruction coefficients directly in to the SH preventing further
  37628. * required operations at run time.
  37629. *
  37630. * This is simply done by scaling back the SH with Ylm constants parameter.
  37631. * The trigonometric part being applied by the shader at run time.
  37632. */
  37633. preScaleForRendering(): void;
  37634. /**
  37635. * Constructs a spherical harmonics from an array.
  37636. * @param data defines the 9x3 coefficients (l00, l1-1, l10, l11, l2-2, l2-1, l20, l21, l22)
  37637. * @returns the spherical harmonics
  37638. */
  37639. static FromArray(data: ArrayLike<ArrayLike<number>>): SphericalHarmonics;
  37640. /**
  37641. * Gets the spherical harmonics from polynomial
  37642. * @param polynomial the spherical polynomial
  37643. * @returns the spherical harmonics
  37644. */
  37645. static FromPolynomial(polynomial: SphericalPolynomial): SphericalHarmonics;
  37646. }
  37647. /**
  37648. * Class representing spherical polynomial coefficients to the 3rd degree
  37649. */
  37650. export class SphericalPolynomial {
  37651. private _harmonics;
  37652. /**
  37653. * The spherical harmonics used to create the polynomials.
  37654. */
  37655. get preScaledHarmonics(): SphericalHarmonics;
  37656. /**
  37657. * The x coefficients of the spherical polynomial
  37658. */
  37659. x: Vector3;
  37660. /**
  37661. * The y coefficients of the spherical polynomial
  37662. */
  37663. y: Vector3;
  37664. /**
  37665. * The z coefficients of the spherical polynomial
  37666. */
  37667. z: Vector3;
  37668. /**
  37669. * The xx coefficients of the spherical polynomial
  37670. */
  37671. xx: Vector3;
  37672. /**
  37673. * The yy coefficients of the spherical polynomial
  37674. */
  37675. yy: Vector3;
  37676. /**
  37677. * The zz coefficients of the spherical polynomial
  37678. */
  37679. zz: Vector3;
  37680. /**
  37681. * The xy coefficients of the spherical polynomial
  37682. */
  37683. xy: Vector3;
  37684. /**
  37685. * The yz coefficients of the spherical polynomial
  37686. */
  37687. yz: Vector3;
  37688. /**
  37689. * The zx coefficients of the spherical polynomial
  37690. */
  37691. zx: Vector3;
  37692. /**
  37693. * Adds an ambient color to the spherical polynomial
  37694. * @param color the color to add
  37695. */
  37696. addAmbient(color: Color3): void;
  37697. /**
  37698. * Scales the spherical polynomial by the given amount
  37699. * @param scale the amount to scale
  37700. */
  37701. scaleInPlace(scale: number): void;
  37702. /**
  37703. * Gets the spherical polynomial from harmonics
  37704. * @param harmonics the spherical harmonics
  37705. * @returns the spherical polynomial
  37706. */
  37707. static FromHarmonics(harmonics: SphericalHarmonics): SphericalPolynomial;
  37708. /**
  37709. * Constructs a spherical polynomial from an array.
  37710. * @param data defines the 9x3 coefficients (x, y, z, xx, yy, zz, yz, zx, xy)
  37711. * @returns the spherical polynomial
  37712. */
  37713. static FromArray(data: ArrayLike<ArrayLike<number>>): SphericalPolynomial;
  37714. }
  37715. }
  37716. declare module "babylonjs/Materials/Textures/internalTexture" {
  37717. import { Observable } from "babylonjs/Misc/observable";
  37718. import { Nullable, int } from "babylonjs/types";
  37719. import { ThinEngine } from "babylonjs/Engines/thinEngine";
  37720. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  37721. import { SphericalPolynomial } from "babylonjs/Maths/sphericalPolynomial";
  37722. /**
  37723. * Defines the source of the internal texture
  37724. */
  37725. export enum InternalTextureSource {
  37726. /**
  37727. * The source of the texture data is unknown
  37728. */
  37729. Unknown = 0,
  37730. /**
  37731. * Texture data comes from an URL
  37732. */
  37733. Url = 1,
  37734. /**
  37735. * Texture data is only used for temporary storage
  37736. */
  37737. Temp = 2,
  37738. /**
  37739. * Texture data comes from raw data (ArrayBuffer)
  37740. */
  37741. Raw = 3,
  37742. /**
  37743. * Texture content is dynamic (video or dynamic texture)
  37744. */
  37745. Dynamic = 4,
  37746. /**
  37747. * Texture content is generated by rendering to it
  37748. */
  37749. RenderTarget = 5,
  37750. /**
  37751. * Texture content is part of a multi render target process
  37752. */
  37753. MultiRenderTarget = 6,
  37754. /**
  37755. * Texture data comes from a cube data file
  37756. */
  37757. Cube = 7,
  37758. /**
  37759. * Texture data comes from a raw cube data
  37760. */
  37761. CubeRaw = 8,
  37762. /**
  37763. * Texture data come from a prefiltered cube data file
  37764. */
  37765. CubePrefiltered = 9,
  37766. /**
  37767. * Texture content is raw 3D data
  37768. */
  37769. Raw3D = 10,
  37770. /**
  37771. * Texture content is raw 2D array data
  37772. */
  37773. Raw2DArray = 11,
  37774. /**
  37775. * Texture content is a depth texture
  37776. */
  37777. Depth = 12,
  37778. /**
  37779. * Texture data comes from a raw cube data encoded with RGBD
  37780. */
  37781. CubeRawRGBD = 13
  37782. }
  37783. /**
  37784. * Class used to store data associated with WebGL texture data for the engine
  37785. * This class should not be used directly
  37786. */
  37787. export class InternalTexture {
  37788. /** @hidden */
  37789. static _UpdateRGBDAsync: (internalTexture: InternalTexture, data: ArrayBufferView[][], sphericalPolynomial: Nullable<SphericalPolynomial>, lodScale: number, lodOffset: number) => Promise<void>;
  37790. /**
  37791. * Defines if the texture is ready
  37792. */
  37793. isReady: boolean;
  37794. /**
  37795. * Defines if the texture is a cube texture
  37796. */
  37797. isCube: boolean;
  37798. /**
  37799. * Defines if the texture contains 3D data
  37800. */
  37801. is3D: boolean;
  37802. /**
  37803. * Defines if the texture contains 2D array data
  37804. */
  37805. is2DArray: boolean;
  37806. /**
  37807. * Defines if the texture contains multiview data
  37808. */
  37809. isMultiview: boolean;
  37810. /**
  37811. * Gets the URL used to load this texture
  37812. */
  37813. url: string;
  37814. /**
  37815. * Gets the sampling mode of the texture
  37816. */
  37817. samplingMode: number;
  37818. /**
  37819. * Gets a boolean indicating if the texture needs mipmaps generation
  37820. */
  37821. generateMipMaps: boolean;
  37822. /**
  37823. * Gets the number of samples used by the texture (WebGL2+ only)
  37824. */
  37825. samples: number;
  37826. /**
  37827. * Gets the type of the texture (int, float...)
  37828. */
  37829. type: number;
  37830. /**
  37831. * Gets the format of the texture (RGB, RGBA...)
  37832. */
  37833. format: number;
  37834. /**
  37835. * Observable called when the texture is loaded
  37836. */
  37837. onLoadedObservable: Observable<InternalTexture>;
  37838. /**
  37839. * Gets the width of the texture
  37840. */
  37841. width: number;
  37842. /**
  37843. * Gets the height of the texture
  37844. */
  37845. height: number;
  37846. /**
  37847. * Gets the depth of the texture
  37848. */
  37849. depth: number;
  37850. /**
  37851. * Gets the initial width of the texture (It could be rescaled if the current system does not support non power of two textures)
  37852. */
  37853. baseWidth: number;
  37854. /**
  37855. * Gets the initial height of the texture (It could be rescaled if the current system does not support non power of two textures)
  37856. */
  37857. baseHeight: number;
  37858. /**
  37859. * Gets the initial depth of the texture (It could be rescaled if the current system does not support non power of two textures)
  37860. */
  37861. baseDepth: number;
  37862. /**
  37863. * Gets a boolean indicating if the texture is inverted on Y axis
  37864. */
  37865. invertY: boolean;
  37866. /** @hidden */
  37867. _invertVScale: boolean;
  37868. /** @hidden */
  37869. _associatedChannel: number;
  37870. /** @hidden */
  37871. _source: InternalTextureSource;
  37872. /** @hidden */
  37873. _buffer: Nullable<string | ArrayBuffer | ArrayBufferView | HTMLImageElement | Blob | ImageBitmap>;
  37874. /** @hidden */
  37875. _bufferView: Nullable<ArrayBufferView>;
  37876. /** @hidden */
  37877. _bufferViewArray: Nullable<ArrayBufferView[]>;
  37878. /** @hidden */
  37879. _bufferViewArrayArray: Nullable<ArrayBufferView[][]>;
  37880. /** @hidden */
  37881. _size: number;
  37882. /** @hidden */
  37883. _extension: string;
  37884. /** @hidden */
  37885. _files: Nullable<string[]>;
  37886. /** @hidden */
  37887. _workingCanvas: Nullable<HTMLCanvasElement | OffscreenCanvas>;
  37888. /** @hidden */
  37889. _workingContext: Nullable<CanvasRenderingContext2D | OffscreenCanvasRenderingContext2D>;
  37890. /** @hidden */
  37891. _framebuffer: Nullable<WebGLFramebuffer>;
  37892. /** @hidden */
  37893. _depthStencilBuffer: Nullable<WebGLRenderbuffer>;
  37894. /** @hidden */
  37895. _MSAAFramebuffer: Nullable<WebGLFramebuffer>;
  37896. /** @hidden */
  37897. _MSAARenderBuffer: Nullable<WebGLRenderbuffer>;
  37898. /** @hidden */
  37899. _attachments: Nullable<number[]>;
  37900. /** @hidden */
  37901. _textureArray: Nullable<InternalTexture[]>;
  37902. /** @hidden */
  37903. _cachedCoordinatesMode: Nullable<number>;
  37904. /** @hidden */
  37905. _cachedWrapU: Nullable<number>;
  37906. /** @hidden */
  37907. _cachedWrapV: Nullable<number>;
  37908. /** @hidden */
  37909. _cachedWrapR: Nullable<number>;
  37910. /** @hidden */
  37911. _cachedAnisotropicFilteringLevel: Nullable<number>;
  37912. /** @hidden */
  37913. _isDisabled: boolean;
  37914. /** @hidden */
  37915. _compression: Nullable<string>;
  37916. /** @hidden */
  37917. _generateStencilBuffer: boolean;
  37918. /** @hidden */
  37919. _generateDepthBuffer: boolean;
  37920. /** @hidden */
  37921. _comparisonFunction: number;
  37922. /** @hidden */
  37923. _sphericalPolynomial: Nullable<SphericalPolynomial>;
  37924. /** @hidden */
  37925. _lodGenerationScale: number;
  37926. /** @hidden */
  37927. _lodGenerationOffset: number;
  37928. /** @hidden */
  37929. _depthStencilTexture: Nullable<InternalTexture>;
  37930. /** @hidden */
  37931. _colorTextureArray: Nullable<WebGLTexture>;
  37932. /** @hidden */
  37933. _depthStencilTextureArray: Nullable<WebGLTexture>;
  37934. /** @hidden */
  37935. _lodTextureHigh: Nullable<BaseTexture>;
  37936. /** @hidden */
  37937. _lodTextureMid: Nullable<BaseTexture>;
  37938. /** @hidden */
  37939. _lodTextureLow: Nullable<BaseTexture>;
  37940. /** @hidden */
  37941. _isRGBD: boolean;
  37942. /** @hidden */
  37943. _linearSpecularLOD: boolean;
  37944. /** @hidden */
  37945. _irradianceTexture: Nullable<BaseTexture>;
  37946. /** @hidden */
  37947. _webGLTexture: Nullable<WebGLTexture>;
  37948. /** @hidden */
  37949. _references: number;
  37950. private _engine;
  37951. /**
  37952. * Gets the Engine the texture belongs to.
  37953. * @returns The babylon engine
  37954. */
  37955. getEngine(): ThinEngine;
  37956. /**
  37957. * Gets the data source type of the texture
  37958. */
  37959. get source(): InternalTextureSource;
  37960. /**
  37961. * Creates a new InternalTexture
  37962. * @param engine defines the engine to use
  37963. * @param source defines the type of data that will be used
  37964. * @param delayAllocation if the texture allocation should be delayed (default: false)
  37965. */
  37966. constructor(engine: ThinEngine, source: InternalTextureSource, delayAllocation?: boolean);
  37967. /**
  37968. * Increments the number of references (ie. the number of Texture that point to it)
  37969. */
  37970. incrementReferences(): void;
  37971. /**
  37972. * Change the size of the texture (not the size of the content)
  37973. * @param width defines the new width
  37974. * @param height defines the new height
  37975. * @param depth defines the new depth (1 by default)
  37976. */
  37977. updateSize(width: int, height: int, depth?: int): void;
  37978. /** @hidden */
  37979. _rebuild(): void;
  37980. /** @hidden */
  37981. _swapAndDie(target: InternalTexture): void;
  37982. /**
  37983. * Dispose the current allocated resources
  37984. */
  37985. dispose(): void;
  37986. }
  37987. }
  37988. declare module "babylonjs/Audio/analyser" {
  37989. import { Scene } from "babylonjs/scene";
  37990. /**
  37991. * Class used to work with sound analyzer using fast fourier transform (FFT)
  37992. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music
  37993. */
  37994. export class Analyser {
  37995. /**
  37996. * Gets or sets the smoothing
  37997. * @ignorenaming
  37998. */
  37999. SMOOTHING: number;
  38000. /**
  38001. * Gets or sets the FFT table size
  38002. * @ignorenaming
  38003. */
  38004. FFT_SIZE: number;
  38005. /**
  38006. * Gets or sets the bar graph amplitude
  38007. * @ignorenaming
  38008. */
  38009. BARGRAPHAMPLITUDE: number;
  38010. /**
  38011. * Gets or sets the position of the debug canvas
  38012. * @ignorenaming
  38013. */
  38014. DEBUGCANVASPOS: {
  38015. x: number;
  38016. y: number;
  38017. };
  38018. /**
  38019. * Gets or sets the debug canvas size
  38020. * @ignorenaming
  38021. */
  38022. DEBUGCANVASSIZE: {
  38023. width: number;
  38024. height: number;
  38025. };
  38026. private _byteFreqs;
  38027. private _byteTime;
  38028. private _floatFreqs;
  38029. private _webAudioAnalyser;
  38030. private _debugCanvas;
  38031. private _debugCanvasContext;
  38032. private _scene;
  38033. private _registerFunc;
  38034. private _audioEngine;
  38035. /**
  38036. * Creates a new analyser
  38037. * @param scene defines hosting scene
  38038. */
  38039. constructor(scene: Scene);
  38040. /**
  38041. * Get the number of data values you will have to play with for the visualization
  38042. * @see https://developer.mozilla.org/en-US/docs/Web/API/AnalyserNode/frequencyBinCount
  38043. * @returns a number
  38044. */
  38045. getFrequencyBinCount(): number;
  38046. /**
  38047. * Gets the current frequency data as a byte array
  38048. * @see https://developer.mozilla.org/en-US/docs/Web/API/AnalyserNode/getByteFrequencyData
  38049. * @returns a Uint8Array
  38050. */
  38051. getByteFrequencyData(): Uint8Array;
  38052. /**
  38053. * Gets the current waveform as a byte array
  38054. * @see https://developer.mozilla.org/en-US/docs/Web/API/AnalyserNode/getByteTimeDomainData
  38055. * @returns a Uint8Array
  38056. */
  38057. getByteTimeDomainData(): Uint8Array;
  38058. /**
  38059. * Gets the current frequency data as a float array
  38060. * @see https://developer.mozilla.org/en-US/docs/Web/API/AnalyserNode/getByteFrequencyData
  38061. * @returns a Float32Array
  38062. */
  38063. getFloatFrequencyData(): Float32Array;
  38064. /**
  38065. * Renders the debug canvas
  38066. */
  38067. drawDebugCanvas(): void;
  38068. /**
  38069. * Stops rendering the debug canvas and removes it
  38070. */
  38071. stopDebugCanvas(): void;
  38072. /**
  38073. * Connects two audio nodes
  38074. * @param inputAudioNode defines first node to connect
  38075. * @param outputAudioNode defines second node to connect
  38076. */
  38077. connectAudioNodes(inputAudioNode: AudioNode, outputAudioNode: AudioNode): void;
  38078. /**
  38079. * Releases all associated resources
  38080. */
  38081. dispose(): void;
  38082. }
  38083. }
  38084. declare module "babylonjs/Audio/audioEngine" {
  38085. import { IDisposable } from "babylonjs/scene";
  38086. import { Analyser } from "babylonjs/Audio/analyser";
  38087. import { Nullable } from "babylonjs/types";
  38088. import { Observable } from "babylonjs/Misc/observable";
  38089. /**
  38090. * This represents an audio engine and it is responsible
  38091. * to play, synchronize and analyse sounds throughout the application.
  38092. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music
  38093. */
  38094. export interface IAudioEngine extends IDisposable {
  38095. /**
  38096. * Gets whether the current host supports Web Audio and thus could create AudioContexts.
  38097. */
  38098. readonly canUseWebAudio: boolean;
  38099. /**
  38100. * Gets the current AudioContext if available.
  38101. */
  38102. readonly audioContext: Nullable<AudioContext>;
  38103. /**
  38104. * The master gain node defines the global audio volume of your audio engine.
  38105. */
  38106. readonly masterGain: GainNode;
  38107. /**
  38108. * Gets whether or not mp3 are supported by your browser.
  38109. */
  38110. readonly isMP3supported: boolean;
  38111. /**
  38112. * Gets whether or not ogg are supported by your browser.
  38113. */
  38114. readonly isOGGsupported: boolean;
  38115. /**
  38116. * Defines if Babylon should emit a warning if WebAudio is not supported.
  38117. * @ignoreNaming
  38118. */
  38119. WarnedWebAudioUnsupported: boolean;
  38120. /**
  38121. * Defines if the audio engine relies on a custom unlocked button.
  38122. * In this case, the embedded button will not be displayed.
  38123. */
  38124. useCustomUnlockedButton: boolean;
  38125. /**
  38126. * Gets whether or not the audio engine is unlocked (require first a user gesture on some browser).
  38127. */
  38128. readonly unlocked: boolean;
  38129. /**
  38130. * Event raised when audio has been unlocked on the browser.
  38131. */
  38132. onAudioUnlockedObservable: Observable<AudioEngine>;
  38133. /**
  38134. * Event raised when audio has been locked on the browser.
  38135. */
  38136. onAudioLockedObservable: Observable<AudioEngine>;
  38137. /**
  38138. * Flags the audio engine in Locked state.
  38139. * This happens due to new browser policies preventing audio to autoplay.
  38140. */
  38141. lock(): void;
  38142. /**
  38143. * Unlocks the audio engine once a user action has been done on the dom.
  38144. * This is helpful to resume play once browser policies have been satisfied.
  38145. */
  38146. unlock(): void;
  38147. /**
  38148. * Gets the global volume sets on the master gain.
  38149. * @returns the global volume if set or -1 otherwise
  38150. */
  38151. getGlobalVolume(): number;
  38152. /**
  38153. * Sets the global volume of your experience (sets on the master gain).
  38154. * @param newVolume Defines the new global volume of the application
  38155. */
  38156. setGlobalVolume(newVolume: number): void;
  38157. /**
  38158. * Connect the audio engine to an audio analyser allowing some amazing
  38159. * synchornization between the sounds/music and your visualization (VuMeter for instance).
  38160. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music#using-the-analyser
  38161. * @param analyser The analyser to connect to the engine
  38162. */
  38163. connectToAnalyser(analyser: Analyser): void;
  38164. }
  38165. /**
  38166. * This represents the default audio engine used in babylon.
  38167. * It is responsible to play, synchronize and analyse sounds throughout the application.
  38168. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music
  38169. */
  38170. export class AudioEngine implements IAudioEngine {
  38171. private _audioContext;
  38172. private _audioContextInitialized;
  38173. private _muteButton;
  38174. private _hostElement;
  38175. /**
  38176. * Gets whether the current host supports Web Audio and thus could create AudioContexts.
  38177. */
  38178. canUseWebAudio: boolean;
  38179. /**
  38180. * The master gain node defines the global audio volume of your audio engine.
  38181. */
  38182. masterGain: GainNode;
  38183. /**
  38184. * Defines if Babylon should emit a warning if WebAudio is not supported.
  38185. * @ignoreNaming
  38186. */
  38187. WarnedWebAudioUnsupported: boolean;
  38188. /**
  38189. * Gets whether or not mp3 are supported by your browser.
  38190. */
  38191. isMP3supported: boolean;
  38192. /**
  38193. * Gets whether or not ogg are supported by your browser.
  38194. */
  38195. isOGGsupported: boolean;
  38196. /**
  38197. * Gets whether audio has been unlocked on the device.
  38198. * Some Browsers have strong restrictions about Audio and won t autoplay unless
  38199. * a user interaction has happened.
  38200. */
  38201. unlocked: boolean;
  38202. /**
  38203. * Defines if the audio engine relies on a custom unlocked button.
  38204. * In this case, the embedded button will not be displayed.
  38205. */
  38206. useCustomUnlockedButton: boolean;
  38207. /**
  38208. * Event raised when audio has been unlocked on the browser.
  38209. */
  38210. onAudioUnlockedObservable: Observable<AudioEngine>;
  38211. /**
  38212. * Event raised when audio has been locked on the browser.
  38213. */
  38214. onAudioLockedObservable: Observable<AudioEngine>;
  38215. /**
  38216. * Gets the current AudioContext if available.
  38217. */
  38218. get audioContext(): Nullable<AudioContext>;
  38219. private _connectedAnalyser;
  38220. /**
  38221. * Instantiates a new audio engine.
  38222. *
  38223. * There should be only one per page as some browsers restrict the number
  38224. * of audio contexts you can create.
  38225. * @param hostElement defines the host element where to display the mute icon if necessary
  38226. */
  38227. constructor(hostElement?: Nullable<HTMLElement>);
  38228. /**
  38229. * Flags the audio engine in Locked state.
  38230. * This happens due to new browser policies preventing audio to autoplay.
  38231. */
  38232. lock(): void;
  38233. /**
  38234. * Unlocks the audio engine once a user action has been done on the dom.
  38235. * This is helpful to resume play once browser policies have been satisfied.
  38236. */
  38237. unlock(): void;
  38238. private _resumeAudioContext;
  38239. private _initializeAudioContext;
  38240. private _tryToRun;
  38241. private _triggerRunningState;
  38242. private _triggerSuspendedState;
  38243. private _displayMuteButton;
  38244. private _moveButtonToTopLeft;
  38245. private _onResize;
  38246. private _hideMuteButton;
  38247. /**
  38248. * Destroy and release the resources associated with the audio ccontext.
  38249. */
  38250. dispose(): void;
  38251. /**
  38252. * Gets the global volume sets on the master gain.
  38253. * @returns the global volume if set or -1 otherwise
  38254. */
  38255. getGlobalVolume(): number;
  38256. /**
  38257. * Sets the global volume of your experience (sets on the master gain).
  38258. * @param newVolume Defines the new global volume of the application
  38259. */
  38260. setGlobalVolume(newVolume: number): void;
  38261. /**
  38262. * Connect the audio engine to an audio analyser allowing some amazing
  38263. * synchornization between the sounds/music and your visualization (VuMeter for instance).
  38264. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music#using-the-analyser
  38265. * @param analyser The analyser to connect to the engine
  38266. */
  38267. connectToAnalyser(analyser: Analyser): void;
  38268. }
  38269. }
  38270. declare module "babylonjs/Loading/loadingScreen" {
  38271. /**
  38272. * Interface used to present a loading screen while loading a scene
  38273. * @see https://doc.babylonjs.com/how_to/creating_a_custom_loading_screen
  38274. */
  38275. export interface ILoadingScreen {
  38276. /**
  38277. * Function called to display the loading screen
  38278. */
  38279. displayLoadingUI: () => void;
  38280. /**
  38281. * Function called to hide the loading screen
  38282. */
  38283. hideLoadingUI: () => void;
  38284. /**
  38285. * Gets or sets the color to use for the background
  38286. */
  38287. loadingUIBackgroundColor: string;
  38288. /**
  38289. * Gets or sets the text to display while loading
  38290. */
  38291. loadingUIText: string;
  38292. }
  38293. /**
  38294. * Class used for the default loading screen
  38295. * @see https://doc.babylonjs.com/how_to/creating_a_custom_loading_screen
  38296. */
  38297. export class DefaultLoadingScreen implements ILoadingScreen {
  38298. private _renderingCanvas;
  38299. private _loadingText;
  38300. private _loadingDivBackgroundColor;
  38301. private _loadingDiv;
  38302. private _loadingTextDiv;
  38303. /** Gets or sets the logo url to use for the default loading screen */
  38304. static DefaultLogoUrl: string;
  38305. /** Gets or sets the spinner url to use for the default loading screen */
  38306. static DefaultSpinnerUrl: string;
  38307. /**
  38308. * Creates a new default loading screen
  38309. * @param _renderingCanvas defines the canvas used to render the scene
  38310. * @param _loadingText defines the default text to display
  38311. * @param _loadingDivBackgroundColor defines the default background color
  38312. */
  38313. constructor(_renderingCanvas: HTMLCanvasElement, _loadingText?: string, _loadingDivBackgroundColor?: string);
  38314. /**
  38315. * Function called to display the loading screen
  38316. */
  38317. displayLoadingUI(): void;
  38318. /**
  38319. * Function called to hide the loading screen
  38320. */
  38321. hideLoadingUI(): void;
  38322. /**
  38323. * Gets or sets the text to display while loading
  38324. */
  38325. set loadingUIText(text: string);
  38326. get loadingUIText(): string;
  38327. /**
  38328. * Gets or sets the color to use for the background
  38329. */
  38330. get loadingUIBackgroundColor(): string;
  38331. set loadingUIBackgroundColor(color: string);
  38332. private _resizeLoadingUI;
  38333. }
  38334. }
  38335. declare module "babylonjs/Misc/customAnimationFrameRequester" {
  38336. /**
  38337. * Interface for any object that can request an animation frame
  38338. */
  38339. export interface ICustomAnimationFrameRequester {
  38340. /**
  38341. * This function will be called when the render loop is ready. If this is not populated, the engine's renderloop function will be called
  38342. */
  38343. renderFunction?: Function;
  38344. /**
  38345. * Called to request the next frame to render to
  38346. * @see https://developer.mozilla.org/en-US/docs/Web/API/window/requestAnimationFrame
  38347. */
  38348. requestAnimationFrame: Function;
  38349. /**
  38350. * You can pass this value to cancelAnimationFrame() to cancel the refresh callback request
  38351. * @see https://developer.mozilla.org/en-US/docs/Web/API/window/requestAnimationFrame#Return_value
  38352. */
  38353. requestID?: number;
  38354. }
  38355. }
  38356. declare module "babylonjs/Misc/performanceMonitor" {
  38357. /**
  38358. * Performance monitor tracks rolling average frame-time and frame-time variance over a user defined sliding-window
  38359. */
  38360. export class PerformanceMonitor {
  38361. private _enabled;
  38362. private _rollingFrameTime;
  38363. private _lastFrameTimeMs;
  38364. /**
  38365. * constructor
  38366. * @param frameSampleSize The number of samples required to saturate the sliding window
  38367. */
  38368. constructor(frameSampleSize?: number);
  38369. /**
  38370. * Samples current frame
  38371. * @param timeMs A timestamp in milliseconds of the current frame to compare with other frames
  38372. */
  38373. sampleFrame(timeMs?: number): void;
  38374. /**
  38375. * Returns the average frame time in milliseconds over the sliding window (or the subset of frames sampled so far)
  38376. */
  38377. get averageFrameTime(): number;
  38378. /**
  38379. * Returns the variance frame time in milliseconds over the sliding window (or the subset of frames sampled so far)
  38380. */
  38381. get averageFrameTimeVariance(): number;
  38382. /**
  38383. * Returns the frame time of the most recent frame
  38384. */
  38385. get instantaneousFrameTime(): number;
  38386. /**
  38387. * Returns the average framerate in frames per second over the sliding window (or the subset of frames sampled so far)
  38388. */
  38389. get averageFPS(): number;
  38390. /**
  38391. * Returns the average framerate in frames per second using the most recent frame time
  38392. */
  38393. get instantaneousFPS(): number;
  38394. /**
  38395. * Returns true if enough samples have been taken to completely fill the sliding window
  38396. */
  38397. get isSaturated(): boolean;
  38398. /**
  38399. * Enables contributions to the sliding window sample set
  38400. */
  38401. enable(): void;
  38402. /**
  38403. * Disables contributions to the sliding window sample set
  38404. * Samples will not be interpolated over the disabled period
  38405. */
  38406. disable(): void;
  38407. /**
  38408. * Returns true if sampling is enabled
  38409. */
  38410. get isEnabled(): boolean;
  38411. /**
  38412. * Resets performance monitor
  38413. */
  38414. reset(): void;
  38415. }
  38416. /**
  38417. * RollingAverage
  38418. *
  38419. * Utility to efficiently compute the rolling average and variance over a sliding window of samples
  38420. */
  38421. export class RollingAverage {
  38422. /**
  38423. * Current average
  38424. */
  38425. average: number;
  38426. /**
  38427. * Current variance
  38428. */
  38429. variance: number;
  38430. protected _samples: Array<number>;
  38431. protected _sampleCount: number;
  38432. protected _pos: number;
  38433. protected _m2: number;
  38434. /**
  38435. * constructor
  38436. * @param length The number of samples required to saturate the sliding window
  38437. */
  38438. constructor(length: number);
  38439. /**
  38440. * Adds a sample to the sample set
  38441. * @param v The sample value
  38442. */
  38443. add(v: number): void;
  38444. /**
  38445. * Returns previously added values or null if outside of history or outside the sliding window domain
  38446. * @param i Index in history. For example, pass 0 for the most recent value and 1 for the value before that
  38447. * @return Value previously recorded with add() or null if outside of range
  38448. */
  38449. history(i: number): number;
  38450. /**
  38451. * Returns true if enough samples have been taken to completely fill the sliding window
  38452. * @return true if sample-set saturated
  38453. */
  38454. isSaturated(): boolean;
  38455. /**
  38456. * Resets the rolling average (equivalent to 0 samples taken so far)
  38457. */
  38458. reset(): void;
  38459. /**
  38460. * Wraps a value around the sample range boundaries
  38461. * @param i Position in sample range, for example if the sample length is 5, and i is -3, then 2 will be returned.
  38462. * @return Wrapped position in sample range
  38463. */
  38464. protected _wrapPosition(i: number): number;
  38465. }
  38466. }
  38467. declare module "babylonjs/Misc/perfCounter" {
  38468. /**
  38469. * This class is used to track a performance counter which is number based.
  38470. * The user has access to many properties which give statistics of different nature.
  38471. *
  38472. * The implementer can track two kinds of Performance Counter: time and count.
  38473. * 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.
  38474. * 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.
  38475. */
  38476. export class PerfCounter {
  38477. /**
  38478. * Gets or sets a global boolean to turn on and off all the counters
  38479. */
  38480. static Enabled: boolean;
  38481. /**
  38482. * Returns the smallest value ever
  38483. */
  38484. get min(): number;
  38485. /**
  38486. * Returns the biggest value ever
  38487. */
  38488. get max(): number;
  38489. /**
  38490. * Returns the average value since the performance counter is running
  38491. */
  38492. get average(): number;
  38493. /**
  38494. * Returns the average value of the last second the counter was monitored
  38495. */
  38496. get lastSecAverage(): number;
  38497. /**
  38498. * Returns the current value
  38499. */
  38500. get current(): number;
  38501. /**
  38502. * Gets the accumulated total
  38503. */
  38504. get total(): number;
  38505. /**
  38506. * Gets the total value count
  38507. */
  38508. get count(): number;
  38509. /**
  38510. * Creates a new counter
  38511. */
  38512. constructor();
  38513. /**
  38514. * Call this method to start monitoring a new frame.
  38515. * 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.
  38516. */
  38517. fetchNewFrame(): void;
  38518. /**
  38519. * Call this method to monitor a count of something (e.g. mesh drawn in viewport count)
  38520. * @param newCount the count value to add to the monitored count
  38521. * @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.
  38522. */
  38523. addCount(newCount: number, fetchResult: boolean): void;
  38524. /**
  38525. * Start monitoring this performance counter
  38526. */
  38527. beginMonitoring(): void;
  38528. /**
  38529. * Compute the time lapsed since the previous beginMonitoring() call.
  38530. * @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
  38531. */
  38532. endMonitoring(newFrame?: boolean): void;
  38533. private _fetchResult;
  38534. private _startMonitoringTime;
  38535. private _min;
  38536. private _max;
  38537. private _average;
  38538. private _current;
  38539. private _totalValueCount;
  38540. private _totalAccumulated;
  38541. private _lastSecAverage;
  38542. private _lastSecAccumulated;
  38543. private _lastSecTime;
  38544. private _lastSecValueCount;
  38545. }
  38546. }
  38547. declare module "babylonjs/Engines/Extensions/engine.readTexture" {
  38548. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  38549. import { Nullable } from "babylonjs/types";
  38550. module "babylonjs/Engines/thinEngine" {
  38551. interface ThinEngine {
  38552. /** @hidden */
  38553. _readTexturePixels(texture: InternalTexture, width: number, height: number, faceIndex?: number, level?: number, buffer?: Nullable<ArrayBufferView>): ArrayBufferView;
  38554. }
  38555. }
  38556. }
  38557. declare module "babylonjs/Engines/engine" {
  38558. import { Observable } from "babylonjs/Misc/observable";
  38559. import { Nullable } from "babylonjs/types";
  38560. import { Scene } from "babylonjs/scene";
  38561. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  38562. import { IAudioEngine } from "babylonjs/Audio/audioEngine";
  38563. import { IOfflineProvider } from "babylonjs/Offline/IOfflineProvider";
  38564. import { ILoadingScreen } from "babylonjs/Loading/loadingScreen";
  38565. import { WebGLPipelineContext } from "babylonjs/Engines/WebGL/webGLPipelineContext";
  38566. import { IPipelineContext } from "babylonjs/Engines/IPipelineContext";
  38567. import { ICustomAnimationFrameRequester } from "babylonjs/Misc/customAnimationFrameRequester";
  38568. import { ThinEngine, EngineOptions } from "babylonjs/Engines/thinEngine";
  38569. import { IViewportLike, IColor4Like } from "babylonjs/Maths/math.like";
  38570. import { RenderTargetTexture } from "babylonjs/Materials/Textures/renderTargetTexture";
  38571. import { PerformanceMonitor } from "babylonjs/Misc/performanceMonitor";
  38572. import { DataBuffer } from "babylonjs/Meshes/dataBuffer";
  38573. import { PerfCounter } from "babylonjs/Misc/perfCounter";
  38574. import "babylonjs/Engines/Extensions/engine.alpha";
  38575. import "babylonjs/Engines/Extensions/engine.readTexture";
  38576. import "babylonjs/Engines/Extensions/engine.dynamicBuffer";
  38577. import { Material } from "babylonjs/Materials/material";
  38578. import { PostProcess } from "babylonjs/PostProcesses/postProcess";
  38579. /**
  38580. * Defines the interface used by display changed events
  38581. */
  38582. export interface IDisplayChangedEventArgs {
  38583. /** Gets the vrDisplay object (if any) */
  38584. vrDisplay: Nullable<any>;
  38585. /** Gets a boolean indicating if webVR is supported */
  38586. vrSupported: boolean;
  38587. }
  38588. /**
  38589. * Defines the interface used by objects containing a viewport (like a camera)
  38590. */
  38591. interface IViewportOwnerLike {
  38592. /**
  38593. * Gets or sets the viewport
  38594. */
  38595. viewport: IViewportLike;
  38596. }
  38597. /**
  38598. * The engine class is responsible for interfacing with all lower-level APIs such as WebGL and Audio
  38599. */
  38600. export class Engine extends ThinEngine {
  38601. /** Defines that alpha blending is disabled */
  38602. static readonly ALPHA_DISABLE: number;
  38603. /** Defines that alpha blending to SRC ALPHA * SRC + DEST */
  38604. static readonly ALPHA_ADD: number;
  38605. /** Defines that alpha blending to SRC ALPHA * SRC + (1 - SRC ALPHA) * DEST */
  38606. static readonly ALPHA_COMBINE: number;
  38607. /** Defines that alpha blending to DEST - SRC * DEST */
  38608. static readonly ALPHA_SUBTRACT: number;
  38609. /** Defines that alpha blending to SRC * DEST */
  38610. static readonly ALPHA_MULTIPLY: number;
  38611. /** Defines that alpha blending to SRC ALPHA * SRC + (1 - SRC) * DEST */
  38612. static readonly ALPHA_MAXIMIZED: number;
  38613. /** Defines that alpha blending to SRC + DEST */
  38614. static readonly ALPHA_ONEONE: number;
  38615. /** Defines that alpha blending to SRC + (1 - SRC ALPHA) * DEST */
  38616. static readonly ALPHA_PREMULTIPLIED: number;
  38617. /**
  38618. * Defines that alpha blending to SRC + (1 - SRC ALPHA) * DEST
  38619. * Alpha will be set to (1 - SRC ALPHA) * DEST ALPHA
  38620. */
  38621. static readonly ALPHA_PREMULTIPLIED_PORTERDUFF: number;
  38622. /** Defines that alpha blending to CST * SRC + (1 - CST) * DEST */
  38623. static readonly ALPHA_INTERPOLATE: number;
  38624. /**
  38625. * Defines that alpha blending to SRC + (1 - SRC) * DEST
  38626. * Alpha will be set to SRC ALPHA + (1 - SRC ALPHA) * DEST ALPHA
  38627. */
  38628. static readonly ALPHA_SCREENMODE: number;
  38629. /** Defines that the ressource is not delayed*/
  38630. static readonly DELAYLOADSTATE_NONE: number;
  38631. /** Defines that the ressource was successfully delay loaded */
  38632. static readonly DELAYLOADSTATE_LOADED: number;
  38633. /** Defines that the ressource is currently delay loading */
  38634. static readonly DELAYLOADSTATE_LOADING: number;
  38635. /** Defines that the ressource is delayed and has not started loading */
  38636. static readonly DELAYLOADSTATE_NOTLOADED: number;
  38637. /** Passed to depthFunction or stencilFunction to specify depth or stencil tests will never pass. i.e. Nothing will be drawn */
  38638. static readonly NEVER: number;
  38639. /** 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 */
  38640. static readonly ALWAYS: number;
  38641. /** Passed to depthFunction or stencilFunction to specify depth or stencil tests will pass if the new depth value is less than the stored value */
  38642. static readonly LESS: number;
  38643. /** Passed to depthFunction or stencilFunction to specify depth or stencil tests will pass if the new depth value is equals to the stored value */
  38644. static readonly EQUAL: number;
  38645. /** 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 */
  38646. static readonly LEQUAL: number;
  38647. /** Passed to depthFunction or stencilFunction to specify depth or stencil tests will pass if the new depth value is greater than the stored value */
  38648. static readonly GREATER: number;
  38649. /** 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 */
  38650. static readonly GEQUAL: number;
  38651. /** 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 */
  38652. static readonly NOTEQUAL: number;
  38653. /** Passed to stencilOperation to specify that stencil value must be kept */
  38654. static readonly KEEP: number;
  38655. /** Passed to stencilOperation to specify that stencil value must be replaced */
  38656. static readonly REPLACE: number;
  38657. /** Passed to stencilOperation to specify that stencil value must be incremented */
  38658. static readonly INCR: number;
  38659. /** Passed to stencilOperation to specify that stencil value must be decremented */
  38660. static readonly DECR: number;
  38661. /** Passed to stencilOperation to specify that stencil value must be inverted */
  38662. static readonly INVERT: number;
  38663. /** Passed to stencilOperation to specify that stencil value must be incremented with wrapping */
  38664. static readonly INCR_WRAP: number;
  38665. /** Passed to stencilOperation to specify that stencil value must be decremented with wrapping */
  38666. static readonly DECR_WRAP: number;
  38667. /** Texture is not repeating outside of 0..1 UVs */
  38668. static readonly TEXTURE_CLAMP_ADDRESSMODE: number;
  38669. /** Texture is repeating outside of 0..1 UVs */
  38670. static readonly TEXTURE_WRAP_ADDRESSMODE: number;
  38671. /** Texture is repeating and mirrored */
  38672. static readonly TEXTURE_MIRROR_ADDRESSMODE: number;
  38673. /** ALPHA */
  38674. static readonly TEXTUREFORMAT_ALPHA: number;
  38675. /** LUMINANCE */
  38676. static readonly TEXTUREFORMAT_LUMINANCE: number;
  38677. /** LUMINANCE_ALPHA */
  38678. static readonly TEXTUREFORMAT_LUMINANCE_ALPHA: number;
  38679. /** RGB */
  38680. static readonly TEXTUREFORMAT_RGB: number;
  38681. /** RGBA */
  38682. static readonly TEXTUREFORMAT_RGBA: number;
  38683. /** RED */
  38684. static readonly TEXTUREFORMAT_RED: number;
  38685. /** RED (2nd reference) */
  38686. static readonly TEXTUREFORMAT_R: number;
  38687. /** RG */
  38688. static readonly TEXTUREFORMAT_RG: number;
  38689. /** RED_INTEGER */
  38690. static readonly TEXTUREFORMAT_RED_INTEGER: number;
  38691. /** RED_INTEGER (2nd reference) */
  38692. static readonly TEXTUREFORMAT_R_INTEGER: number;
  38693. /** RG_INTEGER */
  38694. static readonly TEXTUREFORMAT_RG_INTEGER: number;
  38695. /** RGB_INTEGER */
  38696. static readonly TEXTUREFORMAT_RGB_INTEGER: number;
  38697. /** RGBA_INTEGER */
  38698. static readonly TEXTUREFORMAT_RGBA_INTEGER: number;
  38699. /** UNSIGNED_BYTE */
  38700. static readonly TEXTURETYPE_UNSIGNED_BYTE: number;
  38701. /** UNSIGNED_BYTE (2nd reference) */
  38702. static readonly TEXTURETYPE_UNSIGNED_INT: number;
  38703. /** FLOAT */
  38704. static readonly TEXTURETYPE_FLOAT: number;
  38705. /** HALF_FLOAT */
  38706. static readonly TEXTURETYPE_HALF_FLOAT: number;
  38707. /** BYTE */
  38708. static readonly TEXTURETYPE_BYTE: number;
  38709. /** SHORT */
  38710. static readonly TEXTURETYPE_SHORT: number;
  38711. /** UNSIGNED_SHORT */
  38712. static readonly TEXTURETYPE_UNSIGNED_SHORT: number;
  38713. /** INT */
  38714. static readonly TEXTURETYPE_INT: number;
  38715. /** UNSIGNED_INT */
  38716. static readonly TEXTURETYPE_UNSIGNED_INTEGER: number;
  38717. /** UNSIGNED_SHORT_4_4_4_4 */
  38718. static readonly TEXTURETYPE_UNSIGNED_SHORT_4_4_4_4: number;
  38719. /** UNSIGNED_SHORT_5_5_5_1 */
  38720. static readonly TEXTURETYPE_UNSIGNED_SHORT_5_5_5_1: number;
  38721. /** UNSIGNED_SHORT_5_6_5 */
  38722. static readonly TEXTURETYPE_UNSIGNED_SHORT_5_6_5: number;
  38723. /** UNSIGNED_INT_2_10_10_10_REV */
  38724. static readonly TEXTURETYPE_UNSIGNED_INT_2_10_10_10_REV: number;
  38725. /** UNSIGNED_INT_24_8 */
  38726. static readonly TEXTURETYPE_UNSIGNED_INT_24_8: number;
  38727. /** UNSIGNED_INT_10F_11F_11F_REV */
  38728. static readonly TEXTURETYPE_UNSIGNED_INT_10F_11F_11F_REV: number;
  38729. /** UNSIGNED_INT_5_9_9_9_REV */
  38730. static readonly TEXTURETYPE_UNSIGNED_INT_5_9_9_9_REV: number;
  38731. /** FLOAT_32_UNSIGNED_INT_24_8_REV */
  38732. static readonly TEXTURETYPE_FLOAT_32_UNSIGNED_INT_24_8_REV: number;
  38733. /** nearest is mag = nearest and min = nearest and mip = linear */
  38734. static readonly TEXTURE_NEAREST_SAMPLINGMODE: number;
  38735. /** Bilinear is mag = linear and min = linear and mip = nearest */
  38736. static readonly TEXTURE_BILINEAR_SAMPLINGMODE: number;
  38737. /** Trilinear is mag = linear and min = linear and mip = linear */
  38738. static readonly TEXTURE_TRILINEAR_SAMPLINGMODE: number;
  38739. /** nearest is mag = nearest and min = nearest and mip = linear */
  38740. static readonly TEXTURE_NEAREST_NEAREST_MIPLINEAR: number;
  38741. /** Bilinear is mag = linear and min = linear and mip = nearest */
  38742. static readonly TEXTURE_LINEAR_LINEAR_MIPNEAREST: number;
  38743. /** Trilinear is mag = linear and min = linear and mip = linear */
  38744. static readonly TEXTURE_LINEAR_LINEAR_MIPLINEAR: number;
  38745. /** mag = nearest and min = nearest and mip = nearest */
  38746. static readonly TEXTURE_NEAREST_NEAREST_MIPNEAREST: number;
  38747. /** mag = nearest and min = linear and mip = nearest */
  38748. static readonly TEXTURE_NEAREST_LINEAR_MIPNEAREST: number;
  38749. /** mag = nearest and min = linear and mip = linear */
  38750. static readonly TEXTURE_NEAREST_LINEAR_MIPLINEAR: number;
  38751. /** mag = nearest and min = linear and mip = none */
  38752. static readonly TEXTURE_NEAREST_LINEAR: number;
  38753. /** mag = nearest and min = nearest and mip = none */
  38754. static readonly TEXTURE_NEAREST_NEAREST: number;
  38755. /** mag = linear and min = nearest and mip = nearest */
  38756. static readonly TEXTURE_LINEAR_NEAREST_MIPNEAREST: number;
  38757. /** mag = linear and min = nearest and mip = linear */
  38758. static readonly TEXTURE_LINEAR_NEAREST_MIPLINEAR: number;
  38759. /** mag = linear and min = linear and mip = none */
  38760. static readonly TEXTURE_LINEAR_LINEAR: number;
  38761. /** mag = linear and min = nearest and mip = none */
  38762. static readonly TEXTURE_LINEAR_NEAREST: number;
  38763. /** Explicit coordinates mode */
  38764. static readonly TEXTURE_EXPLICIT_MODE: number;
  38765. /** Spherical coordinates mode */
  38766. static readonly TEXTURE_SPHERICAL_MODE: number;
  38767. /** Planar coordinates mode */
  38768. static readonly TEXTURE_PLANAR_MODE: number;
  38769. /** Cubic coordinates mode */
  38770. static readonly TEXTURE_CUBIC_MODE: number;
  38771. /** Projection coordinates mode */
  38772. static readonly TEXTURE_PROJECTION_MODE: number;
  38773. /** Skybox coordinates mode */
  38774. static readonly TEXTURE_SKYBOX_MODE: number;
  38775. /** Inverse Cubic coordinates mode */
  38776. static readonly TEXTURE_INVCUBIC_MODE: number;
  38777. /** Equirectangular coordinates mode */
  38778. static readonly TEXTURE_EQUIRECTANGULAR_MODE: number;
  38779. /** Equirectangular Fixed coordinates mode */
  38780. static readonly TEXTURE_FIXED_EQUIRECTANGULAR_MODE: number;
  38781. /** Equirectangular Fixed Mirrored coordinates mode */
  38782. static readonly TEXTURE_FIXED_EQUIRECTANGULAR_MIRRORED_MODE: number;
  38783. /** Defines that texture rescaling will use a floor to find the closer power of 2 size */
  38784. static readonly SCALEMODE_FLOOR: number;
  38785. /** Defines that texture rescaling will look for the nearest power of 2 size */
  38786. static readonly SCALEMODE_NEAREST: number;
  38787. /** Defines that texture rescaling will use a ceil to find the closer power of 2 size */
  38788. static readonly SCALEMODE_CEILING: number;
  38789. /**
  38790. * Returns the current npm package of the sdk
  38791. */
  38792. static get NpmPackage(): string;
  38793. /**
  38794. * Returns the current version of the framework
  38795. */
  38796. static get Version(): string;
  38797. /** Gets the list of created engines */
  38798. static get Instances(): Engine[];
  38799. /**
  38800. * Gets the latest created engine
  38801. */
  38802. static get LastCreatedEngine(): Nullable<Engine>;
  38803. /**
  38804. * Gets the latest created scene
  38805. */
  38806. static get LastCreatedScene(): Nullable<Scene>;
  38807. /**
  38808. * Will flag all materials in all scenes in all engines as dirty to trigger new shader compilation
  38809. * @param flag defines which part of the materials must be marked as dirty
  38810. * @param predicate defines a predicate used to filter which materials should be affected
  38811. */
  38812. static MarkAllMaterialsAsDirty(flag: number, predicate?: (mat: Material) => boolean): void;
  38813. /**
  38814. * Method called to create the default loading screen.
  38815. * This can be overriden in your own app.
  38816. * @param canvas The rendering canvas element
  38817. * @returns The loading screen
  38818. */
  38819. static DefaultLoadingScreenFactory(canvas: HTMLCanvasElement): ILoadingScreen;
  38820. /**
  38821. * Method called to create the default rescale post process on each engine.
  38822. */
  38823. static _RescalePostProcessFactory: Nullable<(engine: Engine) => PostProcess>;
  38824. /**
  38825. * Gets or sets a boolean to enable/disable IndexedDB support and avoid XHR on .manifest
  38826. **/
  38827. enableOfflineSupport: boolean;
  38828. /**
  38829. * 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)
  38830. **/
  38831. disableManifestCheck: boolean;
  38832. /**
  38833. * Gets the list of created scenes
  38834. */
  38835. scenes: Scene[];
  38836. /**
  38837. * Event raised when a new scene is created
  38838. */
  38839. onNewSceneAddedObservable: Observable<Scene>;
  38840. /**
  38841. * Gets the list of created postprocesses
  38842. */
  38843. postProcesses: import("babylonjs/PostProcesses/postProcess").PostProcess[];
  38844. /**
  38845. * Gets a boolean indicating if the pointer is currently locked
  38846. */
  38847. isPointerLock: boolean;
  38848. /**
  38849. * Observable event triggered each time the rendering canvas is resized
  38850. */
  38851. onResizeObservable: Observable<Engine>;
  38852. /**
  38853. * Observable event triggered each time the canvas loses focus
  38854. */
  38855. onCanvasBlurObservable: Observable<Engine>;
  38856. /**
  38857. * Observable event triggered each time the canvas gains focus
  38858. */
  38859. onCanvasFocusObservable: Observable<Engine>;
  38860. /**
  38861. * Observable event triggered each time the canvas receives pointerout event
  38862. */
  38863. onCanvasPointerOutObservable: Observable<PointerEvent>;
  38864. /**
  38865. * Observable raised when the engine begins a new frame
  38866. */
  38867. onBeginFrameObservable: Observable<Engine>;
  38868. /**
  38869. * If set, will be used to request the next animation frame for the render loop
  38870. */
  38871. customAnimationFrameRequester: Nullable<ICustomAnimationFrameRequester>;
  38872. /**
  38873. * Observable raised when the engine ends the current frame
  38874. */
  38875. onEndFrameObservable: Observable<Engine>;
  38876. /**
  38877. * Observable raised when the engine is about to compile a shader
  38878. */
  38879. onBeforeShaderCompilationObservable: Observable<Engine>;
  38880. /**
  38881. * Observable raised when the engine has jsut compiled a shader
  38882. */
  38883. onAfterShaderCompilationObservable: Observable<Engine>;
  38884. /**
  38885. * Gets the audio engine
  38886. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music
  38887. * @ignorenaming
  38888. */
  38889. static audioEngine: IAudioEngine;
  38890. /**
  38891. * Default AudioEngine factory responsible of creating the Audio Engine.
  38892. * By default, this will create a BabylonJS Audio Engine if the workload has been embedded.
  38893. */
  38894. static AudioEngineFactory: (hostElement: Nullable<HTMLElement>) => IAudioEngine;
  38895. /**
  38896. * Default offline support factory responsible of creating a tool used to store data locally.
  38897. * By default, this will create a Database object if the workload has been embedded.
  38898. */
  38899. static OfflineProviderFactory: (urlToScene: string, callbackManifestChecked: (checked: boolean) => any, disableManifestCheck: boolean) => IOfflineProvider;
  38900. private _loadingScreen;
  38901. private _pointerLockRequested;
  38902. private _rescalePostProcess;
  38903. private _deterministicLockstep;
  38904. private _lockstepMaxSteps;
  38905. private _timeStep;
  38906. protected get _supportsHardwareTextureRescaling(): boolean;
  38907. private _fps;
  38908. private _deltaTime;
  38909. /** @hidden */
  38910. _drawCalls: PerfCounter;
  38911. /** 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 */
  38912. canvasTabIndex: number;
  38913. /**
  38914. * Turn this value on if you want to pause FPS computation when in background
  38915. */
  38916. disablePerformanceMonitorInBackground: boolean;
  38917. private _performanceMonitor;
  38918. /**
  38919. * Gets the performance monitor attached to this engine
  38920. * @see https://doc.babylonjs.com/how_to/optimizing_your_scene#engineinstrumentation
  38921. */
  38922. get performanceMonitor(): PerformanceMonitor;
  38923. private _onFocus;
  38924. private _onBlur;
  38925. private _onCanvasPointerOut;
  38926. private _onCanvasBlur;
  38927. private _onCanvasFocus;
  38928. private _onFullscreenChange;
  38929. private _onPointerLockChange;
  38930. /**
  38931. * Gets the HTML element used to attach event listeners
  38932. * @returns a HTML element
  38933. */
  38934. getInputElement(): Nullable<HTMLElement>;
  38935. /**
  38936. * Creates a new engine
  38937. * @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
  38938. * @param antialias defines enable antialiasing (default: false)
  38939. * @param options defines further options to be sent to the getContext() function
  38940. * @param adaptToDeviceRatio defines whether to adapt to the device's viewport characteristics (default: false)
  38941. */
  38942. constructor(canvasOrContext: Nullable<HTMLCanvasElement | WebGLRenderingContext>, antialias?: boolean, options?: EngineOptions, adaptToDeviceRatio?: boolean);
  38943. /**
  38944. * Gets current aspect ratio
  38945. * @param viewportOwner defines the camera to use to get the aspect ratio
  38946. * @param useScreen defines if screen size must be used (or the current render target if any)
  38947. * @returns a number defining the aspect ratio
  38948. */
  38949. getAspectRatio(viewportOwner: IViewportOwnerLike, useScreen?: boolean): number;
  38950. /**
  38951. * Gets current screen aspect ratio
  38952. * @returns a number defining the aspect ratio
  38953. */
  38954. getScreenAspectRatio(): number;
  38955. /**
  38956. * Gets the client rect of the HTML canvas attached with the current webGL context
  38957. * @returns a client rectanglee
  38958. */
  38959. getRenderingCanvasClientRect(): Nullable<ClientRect>;
  38960. /**
  38961. * Gets the client rect of the HTML element used for events
  38962. * @returns a client rectanglee
  38963. */
  38964. getInputElementClientRect(): Nullable<ClientRect>;
  38965. /**
  38966. * Gets a boolean indicating that the engine is running in deterministic lock step mode
  38967. * @see https://doc.babylonjs.com/babylon101/animations#deterministic-lockstep
  38968. * @returns true if engine is in deterministic lock step mode
  38969. */
  38970. isDeterministicLockStep(): boolean;
  38971. /**
  38972. * Gets the max steps when engine is running in deterministic lock step
  38973. * @see https://doc.babylonjs.com/babylon101/animations#deterministic-lockstep
  38974. * @returns the max steps
  38975. */
  38976. getLockstepMaxSteps(): number;
  38977. /**
  38978. * Returns the time in ms between steps when using deterministic lock step.
  38979. * @returns time step in (ms)
  38980. */
  38981. getTimeStep(): number;
  38982. /**
  38983. * Force the mipmap generation for the given render target texture
  38984. * @param texture defines the render target texture to use
  38985. * @param unbind defines whether or not to unbind the texture after generation. Defaults to true.
  38986. */
  38987. generateMipMapsForCubemap(texture: InternalTexture, unbind?: boolean): void;
  38988. /** States */
  38989. /**
  38990. * Set various states to the webGL context
  38991. * @param culling defines backface culling state
  38992. * @param zOffset defines the value to apply to zOffset (0 by default)
  38993. * @param force defines if states must be applied even if cache is up to date
  38994. * @param reverseSide defines if culling must be reversed (CCW instead of CW and CW instead of CCW)
  38995. */
  38996. setState(culling: boolean, zOffset?: number, force?: boolean, reverseSide?: boolean): void;
  38997. /**
  38998. * Set the z offset to apply to current rendering
  38999. * @param value defines the offset to apply
  39000. */
  39001. setZOffset(value: number): void;
  39002. /**
  39003. * Gets the current value of the zOffset
  39004. * @returns the current zOffset state
  39005. */
  39006. getZOffset(): number;
  39007. /**
  39008. * Enable or disable depth buffering
  39009. * @param enable defines the state to set
  39010. */
  39011. setDepthBuffer(enable: boolean): void;
  39012. /**
  39013. * Gets a boolean indicating if depth writing is enabled
  39014. * @returns the current depth writing state
  39015. */
  39016. getDepthWrite(): boolean;
  39017. /**
  39018. * Enable or disable depth writing
  39019. * @param enable defines the state to set
  39020. */
  39021. setDepthWrite(enable: boolean): void;
  39022. /**
  39023. * Gets a boolean indicating if stencil buffer is enabled
  39024. * @returns the current stencil buffer state
  39025. */
  39026. getStencilBuffer(): boolean;
  39027. /**
  39028. * Enable or disable the stencil buffer
  39029. * @param enable defines if the stencil buffer must be enabled or disabled
  39030. */
  39031. setStencilBuffer(enable: boolean): void;
  39032. /**
  39033. * Gets the current stencil mask
  39034. * @returns a number defining the new stencil mask to use
  39035. */
  39036. getStencilMask(): number;
  39037. /**
  39038. * Sets the current stencil mask
  39039. * @param mask defines the new stencil mask to use
  39040. */
  39041. setStencilMask(mask: number): void;
  39042. /**
  39043. * Gets the current stencil function
  39044. * @returns a number defining the stencil function to use
  39045. */
  39046. getStencilFunction(): number;
  39047. /**
  39048. * Gets the current stencil reference value
  39049. * @returns a number defining the stencil reference value to use
  39050. */
  39051. getStencilFunctionReference(): number;
  39052. /**
  39053. * Gets the current stencil mask
  39054. * @returns a number defining the stencil mask to use
  39055. */
  39056. getStencilFunctionMask(): number;
  39057. /**
  39058. * Sets the current stencil function
  39059. * @param stencilFunc defines the new stencil function to use
  39060. */
  39061. setStencilFunction(stencilFunc: number): void;
  39062. /**
  39063. * Sets the current stencil reference
  39064. * @param reference defines the new stencil reference to use
  39065. */
  39066. setStencilFunctionReference(reference: number): void;
  39067. /**
  39068. * Sets the current stencil mask
  39069. * @param mask defines the new stencil mask to use
  39070. */
  39071. setStencilFunctionMask(mask: number): void;
  39072. /**
  39073. * Gets the current stencil operation when stencil fails
  39074. * @returns a number defining stencil operation to use when stencil fails
  39075. */
  39076. getStencilOperationFail(): number;
  39077. /**
  39078. * Gets the current stencil operation when depth fails
  39079. * @returns a number defining stencil operation to use when depth fails
  39080. */
  39081. getStencilOperationDepthFail(): number;
  39082. /**
  39083. * Gets the current stencil operation when stencil passes
  39084. * @returns a number defining stencil operation to use when stencil passes
  39085. */
  39086. getStencilOperationPass(): number;
  39087. /**
  39088. * Sets the stencil operation to use when stencil fails
  39089. * @param operation defines the stencil operation to use when stencil fails
  39090. */
  39091. setStencilOperationFail(operation: number): void;
  39092. /**
  39093. * Sets the stencil operation to use when depth fails
  39094. * @param operation defines the stencil operation to use when depth fails
  39095. */
  39096. setStencilOperationDepthFail(operation: number): void;
  39097. /**
  39098. * Sets the stencil operation to use when stencil passes
  39099. * @param operation defines the stencil operation to use when stencil passes
  39100. */
  39101. setStencilOperationPass(operation: number): void;
  39102. /**
  39103. * Sets a boolean indicating if the dithering state is enabled or disabled
  39104. * @param value defines the dithering state
  39105. */
  39106. setDitheringState(value: boolean): void;
  39107. /**
  39108. * Sets a boolean indicating if the rasterizer state is enabled or disabled
  39109. * @param value defines the rasterizer state
  39110. */
  39111. setRasterizerState(value: boolean): void;
  39112. /**
  39113. * Gets the current depth function
  39114. * @returns a number defining the depth function
  39115. */
  39116. getDepthFunction(): Nullable<number>;
  39117. /**
  39118. * Sets the current depth function
  39119. * @param depthFunc defines the function to use
  39120. */
  39121. setDepthFunction(depthFunc: number): void;
  39122. /**
  39123. * Sets the current depth function to GREATER
  39124. */
  39125. setDepthFunctionToGreater(): void;
  39126. /**
  39127. * Sets the current depth function to GEQUAL
  39128. */
  39129. setDepthFunctionToGreaterOrEqual(): void;
  39130. /**
  39131. * Sets the current depth function to LESS
  39132. */
  39133. setDepthFunctionToLess(): void;
  39134. /**
  39135. * Sets the current depth function to LEQUAL
  39136. */
  39137. setDepthFunctionToLessOrEqual(): void;
  39138. private _cachedStencilBuffer;
  39139. private _cachedStencilFunction;
  39140. private _cachedStencilMask;
  39141. private _cachedStencilOperationPass;
  39142. private _cachedStencilOperationFail;
  39143. private _cachedStencilOperationDepthFail;
  39144. private _cachedStencilReference;
  39145. /**
  39146. * Caches the the state of the stencil buffer
  39147. */
  39148. cacheStencilState(): void;
  39149. /**
  39150. * Restores the state of the stencil buffer
  39151. */
  39152. restoreStencilState(): void;
  39153. /**
  39154. * Directly set the WebGL Viewport
  39155. * @param x defines the x coordinate of the viewport (in screen space)
  39156. * @param y defines the y coordinate of the viewport (in screen space)
  39157. * @param width defines the width of the viewport (in screen space)
  39158. * @param height defines the height of the viewport (in screen space)
  39159. * @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
  39160. */
  39161. setDirectViewport(x: number, y: number, width: number, height: number): Nullable<IViewportLike>;
  39162. /**
  39163. * Executes a scissor clear (ie. a clear on a specific portion of the screen)
  39164. * @param x defines the x-coordinate of the top left corner of the clear rectangle
  39165. * @param y defines the y-coordinate of the corner of the clear rectangle
  39166. * @param width defines the width of the clear rectangle
  39167. * @param height defines the height of the clear rectangle
  39168. * @param clearColor defines the clear color
  39169. */
  39170. scissorClear(x: number, y: number, width: number, height: number, clearColor: IColor4Like): void;
  39171. /**
  39172. * Enable scissor test on a specific rectangle (ie. render will only be executed on a specific portion of the screen)
  39173. * @param x defines the x-coordinate of the top left corner of the clear rectangle
  39174. * @param y defines the y-coordinate of the corner of the clear rectangle
  39175. * @param width defines the width of the clear rectangle
  39176. * @param height defines the height of the clear rectangle
  39177. */
  39178. enableScissor(x: number, y: number, width: number, height: number): void;
  39179. /**
  39180. * Disable previously set scissor test rectangle
  39181. */
  39182. disableScissor(): void;
  39183. protected _reportDrawCall(): void;
  39184. /**
  39185. * Initializes a webVR display and starts listening to display change events
  39186. * The onVRDisplayChangedObservable will be notified upon these changes
  39187. * @returns The onVRDisplayChangedObservable
  39188. */
  39189. initWebVR(): Observable<IDisplayChangedEventArgs>;
  39190. /** @hidden */
  39191. _prepareVRComponent(): void;
  39192. /** @hidden */
  39193. _connectVREvents(canvas?: HTMLCanvasElement, document?: any): void;
  39194. /** @hidden */
  39195. _submitVRFrame(): void;
  39196. /**
  39197. * Call this function to leave webVR mode
  39198. * Will do nothing if webVR is not supported or if there is no webVR device
  39199. * @see https://doc.babylonjs.com/how_to/webvr_camera
  39200. */
  39201. disableVR(): void;
  39202. /**
  39203. * Gets a boolean indicating that the system is in VR mode and is presenting
  39204. * @returns true if VR mode is engaged
  39205. */
  39206. isVRPresenting(): boolean;
  39207. /** @hidden */
  39208. _requestVRFrame(): void;
  39209. /** @hidden */
  39210. _loadFileAsync(url: string, offlineProvider?: IOfflineProvider, useArrayBuffer?: boolean): Promise<string | ArrayBuffer>;
  39211. /**
  39212. * Gets the source code of the vertex shader associated with a specific webGL program
  39213. * @param program defines the program to use
  39214. * @returns a string containing the source code of the vertex shader associated with the program
  39215. */
  39216. getVertexShaderSource(program: WebGLProgram): Nullable<string>;
  39217. /**
  39218. * Gets the source code of the fragment shader associated with a specific webGL program
  39219. * @param program defines the program to use
  39220. * @returns a string containing the source code of the fragment shader associated with the program
  39221. */
  39222. getFragmentShaderSource(program: WebGLProgram): Nullable<string>;
  39223. /**
  39224. * Sets a depth stencil texture from a render target to the according uniform.
  39225. * @param channel The texture channel
  39226. * @param uniform The uniform to set
  39227. * @param texture The render target texture containing the depth stencil texture to apply
  39228. */
  39229. setDepthStencilTexture(channel: number, uniform: Nullable<WebGLUniformLocation>, texture: Nullable<RenderTargetTexture>): void;
  39230. /**
  39231. * Sets a texture to the webGL context from a postprocess
  39232. * @param channel defines the channel to use
  39233. * @param postProcess defines the source postprocess
  39234. */
  39235. setTextureFromPostProcess(channel: number, postProcess: Nullable<PostProcess>): void;
  39236. /**
  39237. * Binds the output of the passed in post process to the texture channel specified
  39238. * @param channel The channel the texture should be bound to
  39239. * @param postProcess The post process which's output should be bound
  39240. */
  39241. setTextureFromPostProcessOutput(channel: number, postProcess: Nullable<PostProcess>): void;
  39242. protected _rebuildBuffers(): void;
  39243. /** @hidden */
  39244. _renderFrame(): void;
  39245. _renderLoop(): void;
  39246. /** @hidden */
  39247. _renderViews(): boolean;
  39248. /**
  39249. * Toggle full screen mode
  39250. * @param requestPointerLock defines if a pointer lock should be requested from the user
  39251. */
  39252. switchFullscreen(requestPointerLock: boolean): void;
  39253. /**
  39254. * Enters full screen mode
  39255. * @param requestPointerLock defines if a pointer lock should be requested from the user
  39256. */
  39257. enterFullscreen(requestPointerLock: boolean): void;
  39258. /**
  39259. * Exits full screen mode
  39260. */
  39261. exitFullscreen(): void;
  39262. /**
  39263. * Enters Pointerlock mode
  39264. */
  39265. enterPointerlock(): void;
  39266. /**
  39267. * Exits Pointerlock mode
  39268. */
  39269. exitPointerlock(): void;
  39270. /**
  39271. * Begin a new frame
  39272. */
  39273. beginFrame(): void;
  39274. /**
  39275. * Enf the current frame
  39276. */
  39277. endFrame(): void;
  39278. resize(): void;
  39279. /**
  39280. * Force a specific size of the canvas
  39281. * @param width defines the new canvas' width
  39282. * @param height defines the new canvas' height
  39283. * @returns true if the size was changed
  39284. */
  39285. setSize(width: number, height: number): boolean;
  39286. _deletePipelineContext(pipelineContext: IPipelineContext): void;
  39287. createShaderProgram(pipelineContext: IPipelineContext, vertexCode: string, fragmentCode: string, defines: Nullable<string>, context?: WebGLRenderingContext, transformFeedbackVaryings?: Nullable<string[]>): WebGLProgram;
  39288. protected _createShaderProgram(pipelineContext: WebGLPipelineContext, vertexShader: WebGLShader, fragmentShader: WebGLShader, context: WebGLRenderingContext, transformFeedbackVaryings?: Nullable<string[]>): WebGLProgram;
  39289. _releaseTexture(texture: InternalTexture): void;
  39290. /**
  39291. * @hidden
  39292. * Rescales a texture
  39293. * @param source input texutre
  39294. * @param destination destination texture
  39295. * @param scene scene to use to render the resize
  39296. * @param internalFormat format to use when resizing
  39297. * @param onComplete callback to be called when resize has completed
  39298. */
  39299. _rescaleTexture(source: InternalTexture, destination: InternalTexture, scene: Nullable<any>, internalFormat: number, onComplete: () => void): void;
  39300. /**
  39301. * Gets the current framerate
  39302. * @returns a number representing the framerate
  39303. */
  39304. getFps(): number;
  39305. /**
  39306. * Gets the time spent between current and previous frame
  39307. * @returns a number representing the delta time in ms
  39308. */
  39309. getDeltaTime(): number;
  39310. private _measureFps;
  39311. /** @hidden */
  39312. _uploadImageToTexture(texture: InternalTexture, image: HTMLImageElement | ImageBitmap, faceIndex?: number, lod?: number): void;
  39313. /**
  39314. * Updates the sample count of a render target texture
  39315. * @see https://doc.babylonjs.com/features/webgl2#multisample-render-targets
  39316. * @param texture defines the texture to update
  39317. * @param samples defines the sample count to set
  39318. * @returns the effective sample count (could be 0 if multisample render targets are not supported)
  39319. */
  39320. updateRenderTargetTextureSampleCount(texture: Nullable<InternalTexture>, samples: number): number;
  39321. /**
  39322. * Updates a depth texture Comparison Mode and Function.
  39323. * If the comparison Function is equal to 0, the mode will be set to none.
  39324. * Otherwise, this only works in webgl 2 and requires a shadow sampler in the shader.
  39325. * @param texture The texture to set the comparison function for
  39326. * @param comparisonFunction The comparison function to set, 0 if no comparison required
  39327. */
  39328. updateTextureComparisonFunction(texture: InternalTexture, comparisonFunction: number): void;
  39329. /**
  39330. * Creates a webGL buffer to use with instanciation
  39331. * @param capacity defines the size of the buffer
  39332. * @returns the webGL buffer
  39333. */
  39334. createInstancesBuffer(capacity: number): DataBuffer;
  39335. /**
  39336. * Delete a webGL buffer used with instanciation
  39337. * @param buffer defines the webGL buffer to delete
  39338. */
  39339. deleteInstancesBuffer(buffer: WebGLBuffer): void;
  39340. private _clientWaitAsync;
  39341. /** @hidden */
  39342. _readPixelsAsync(x: number, y: number, w: number, h: number, format: number, type: number, outputBuffer: ArrayBufferView): Promise<ArrayBufferView> | null;
  39343. dispose(): void;
  39344. private _disableTouchAction;
  39345. /**
  39346. * Display the loading screen
  39347. * @see https://doc.babylonjs.com/how_to/creating_a_custom_loading_screen
  39348. */
  39349. displayLoadingUI(): void;
  39350. /**
  39351. * Hide the loading screen
  39352. * @see https://doc.babylonjs.com/how_to/creating_a_custom_loading_screen
  39353. */
  39354. hideLoadingUI(): void;
  39355. /**
  39356. * Gets the current loading screen object
  39357. * @see https://doc.babylonjs.com/how_to/creating_a_custom_loading_screen
  39358. */
  39359. get loadingScreen(): ILoadingScreen;
  39360. /**
  39361. * Sets the current loading screen object
  39362. * @see https://doc.babylonjs.com/how_to/creating_a_custom_loading_screen
  39363. */
  39364. set loadingScreen(loadingScreen: ILoadingScreen);
  39365. /**
  39366. * Sets the current loading screen text
  39367. * @see https://doc.babylonjs.com/how_to/creating_a_custom_loading_screen
  39368. */
  39369. set loadingUIText(text: string);
  39370. /**
  39371. * Sets the current loading screen background color
  39372. * @see https://doc.babylonjs.com/how_to/creating_a_custom_loading_screen
  39373. */
  39374. set loadingUIBackgroundColor(color: string);
  39375. /** Pointerlock and fullscreen */
  39376. /**
  39377. * Ask the browser to promote the current element to pointerlock mode
  39378. * @param element defines the DOM element to promote
  39379. */
  39380. static _RequestPointerlock(element: HTMLElement): void;
  39381. /**
  39382. * Asks the browser to exit pointerlock mode
  39383. */
  39384. static _ExitPointerlock(): void;
  39385. /**
  39386. * Ask the browser to promote the current element to fullscreen rendering mode
  39387. * @param element defines the DOM element to promote
  39388. */
  39389. static _RequestFullscreen(element: HTMLElement): void;
  39390. /**
  39391. * Asks the browser to exit fullscreen mode
  39392. */
  39393. static _ExitFullscreen(): void;
  39394. }
  39395. }
  39396. declare module "babylonjs/Engines/engineStore" {
  39397. import { Nullable } from "babylonjs/types";
  39398. import { Engine } from "babylonjs/Engines/engine";
  39399. import { Scene } from "babylonjs/scene";
  39400. /**
  39401. * The engine store class is responsible to hold all the instances of Engine and Scene created
  39402. * during the life time of the application.
  39403. */
  39404. export class EngineStore {
  39405. /** Gets the list of created engines */
  39406. static Instances: import("babylonjs/Engines/engine").Engine[];
  39407. /** @hidden */
  39408. static _LastCreatedScene: Nullable<Scene>;
  39409. /**
  39410. * Gets the latest created engine
  39411. */
  39412. static get LastCreatedEngine(): Nullable<Engine>;
  39413. /**
  39414. * Gets the latest created scene
  39415. */
  39416. static get LastCreatedScene(): Nullable<Scene>;
  39417. /**
  39418. * Gets or sets a global variable indicating if fallback texture must be used when a texture cannot be loaded
  39419. * @ignorenaming
  39420. */
  39421. static UseFallbackTexture: boolean;
  39422. /**
  39423. * Texture content used if a texture cannot loaded
  39424. * @ignorenaming
  39425. */
  39426. static FallbackTexture: string;
  39427. }
  39428. }
  39429. declare module "babylonjs/Misc/promise" {
  39430. /**
  39431. * Helper class that provides a small promise polyfill
  39432. */
  39433. export class PromisePolyfill {
  39434. /**
  39435. * Static function used to check if the polyfill is required
  39436. * If this is the case then the function will inject the polyfill to window.Promise
  39437. * @param force defines a boolean used to force the injection (mostly for testing purposes)
  39438. */
  39439. static Apply(force?: boolean): void;
  39440. }
  39441. }
  39442. declare module "babylonjs/Misc/interfaces/screenshotSize" {
  39443. /**
  39444. * Interface for screenshot methods with describe argument called `size` as object with options
  39445. * @link https://doc.babylonjs.com/api/classes/babylon.screenshottools
  39446. */
  39447. export interface IScreenshotSize {
  39448. /**
  39449. * number in pixels for canvas height
  39450. */
  39451. height?: number;
  39452. /**
  39453. * multiplier allowing render at a higher or lower resolution
  39454. * If value is defined then height and width will be ignored and taken from camera
  39455. */
  39456. precision?: number;
  39457. /**
  39458. * number in pixels for canvas width
  39459. */
  39460. width?: number;
  39461. }
  39462. }
  39463. declare module "babylonjs/Misc/tools" {
  39464. import { Nullable, float } from "babylonjs/types";
  39465. import { DomManagement } from "babylonjs/Misc/domManagement";
  39466. import { WebRequest } from "babylonjs/Misc/webRequest";
  39467. import { IFileRequest } from "babylonjs/Misc/fileRequest";
  39468. import { ReadFileError } from "babylonjs/Misc/fileTools";
  39469. import { IOfflineProvider } from "babylonjs/Offline/IOfflineProvider";
  39470. import { IScreenshotSize } from "babylonjs/Misc/interfaces/screenshotSize";
  39471. import { Camera } from "babylonjs/Cameras/camera";
  39472. import { Engine } from "babylonjs/Engines/engine";
  39473. interface IColor4Like {
  39474. r: float;
  39475. g: float;
  39476. b: float;
  39477. a: float;
  39478. }
  39479. /**
  39480. * Class containing a set of static utilities functions
  39481. */
  39482. export class Tools {
  39483. /**
  39484. * Gets or sets the base URL to use to load assets
  39485. */
  39486. static get BaseUrl(): string;
  39487. static set BaseUrl(value: string);
  39488. /**
  39489. * Enable/Disable Custom HTTP Request Headers globally.
  39490. * default = false
  39491. * @see CustomRequestHeaders
  39492. */
  39493. static UseCustomRequestHeaders: boolean;
  39494. /**
  39495. * Custom HTTP Request Headers to be sent with XMLHttpRequests
  39496. * i.e. when loading files, where the server/service expects an Authorization header
  39497. */
  39498. static CustomRequestHeaders: {
  39499. [key: string]: string;
  39500. };
  39501. /**
  39502. * Gets or sets the retry strategy to apply when an error happens while loading an asset
  39503. */
  39504. static get DefaultRetryStrategy(): (url: string, request: WebRequest, retryIndex: number) => number;
  39505. static set DefaultRetryStrategy(strategy: (url: string, request: WebRequest, retryIndex: number) => number);
  39506. /**
  39507. * Default behaviour for cors in the application.
  39508. * It can be a string if the expected behavior is identical in the entire app.
  39509. * Or a callback to be able to set it per url or on a group of them (in case of Video source for instance)
  39510. */
  39511. static get CorsBehavior(): string | ((url: string | string[]) => string);
  39512. static set CorsBehavior(value: string | ((url: string | string[]) => string));
  39513. /**
  39514. * Gets or sets a global variable indicating if fallback texture must be used when a texture cannot be loaded
  39515. * @ignorenaming
  39516. */
  39517. static get UseFallbackTexture(): boolean;
  39518. static set UseFallbackTexture(value: boolean);
  39519. /**
  39520. * Use this object to register external classes like custom textures or material
  39521. * to allow the laoders to instantiate them
  39522. */
  39523. static get RegisteredExternalClasses(): {
  39524. [key: string]: Object;
  39525. };
  39526. static set RegisteredExternalClasses(classes: {
  39527. [key: string]: Object;
  39528. });
  39529. /**
  39530. * Texture content used if a texture cannot loaded
  39531. * @ignorenaming
  39532. */
  39533. static get fallbackTexture(): string;
  39534. static set fallbackTexture(value: string);
  39535. /**
  39536. * Read the content of a byte array at a specified coordinates (taking in account wrapping)
  39537. * @param u defines the coordinate on X axis
  39538. * @param v defines the coordinate on Y axis
  39539. * @param width defines the width of the source data
  39540. * @param height defines the height of the source data
  39541. * @param pixels defines the source byte array
  39542. * @param color defines the output color
  39543. */
  39544. static FetchToRef(u: number, v: number, width: number, height: number, pixels: Uint8Array, color: IColor4Like): void;
  39545. /**
  39546. * Interpolates between a and b via alpha
  39547. * @param a The lower value (returned when alpha = 0)
  39548. * @param b The upper value (returned when alpha = 1)
  39549. * @param alpha The interpolation-factor
  39550. * @return The mixed value
  39551. */
  39552. static Mix(a: number, b: number, alpha: number): number;
  39553. /**
  39554. * Tries to instantiate a new object from a given class name
  39555. * @param className defines the class name to instantiate
  39556. * @returns the new object or null if the system was not able to do the instantiation
  39557. */
  39558. static Instantiate(className: string): any;
  39559. /**
  39560. * Provides a slice function that will work even on IE
  39561. * @param data defines the array to slice
  39562. * @param start defines the start of the data (optional)
  39563. * @param end defines the end of the data (optional)
  39564. * @returns the new sliced array
  39565. */
  39566. static Slice<T>(data: T, start?: number, end?: number): T;
  39567. /**
  39568. * Polyfill for setImmediate
  39569. * @param action defines the action to execute after the current execution block
  39570. */
  39571. static SetImmediate(action: () => void): void;
  39572. /**
  39573. * Function indicating if a number is an exponent of 2
  39574. * @param value defines the value to test
  39575. * @returns true if the value is an exponent of 2
  39576. */
  39577. static IsExponentOfTwo(value: number): boolean;
  39578. private static _tmpFloatArray;
  39579. /**
  39580. * Returns the nearest 32-bit single precision float representation of a Number
  39581. * @param value A Number. If the parameter is of a different type, it will get converted
  39582. * to a number or to NaN if it cannot be converted
  39583. * @returns number
  39584. */
  39585. static FloatRound(value: number): number;
  39586. /**
  39587. * Extracts the filename from a path
  39588. * @param path defines the path to use
  39589. * @returns the filename
  39590. */
  39591. static GetFilename(path: string): string;
  39592. /**
  39593. * Extracts the "folder" part of a path (everything before the filename).
  39594. * @param uri The URI to extract the info from
  39595. * @param returnUnchangedIfNoSlash Do not touch the URI if no slashes are present
  39596. * @returns The "folder" part of the path
  39597. */
  39598. static GetFolderPath(uri: string, returnUnchangedIfNoSlash?: boolean): string;
  39599. /**
  39600. * Extracts text content from a DOM element hierarchy
  39601. * Back Compat only, please use DomManagement.GetDOMTextContent instead.
  39602. */
  39603. static GetDOMTextContent: typeof DomManagement.GetDOMTextContent;
  39604. /**
  39605. * Convert an angle in radians to degrees
  39606. * @param angle defines the angle to convert
  39607. * @returns the angle in degrees
  39608. */
  39609. static ToDegrees(angle: number): number;
  39610. /**
  39611. * Convert an angle in degrees to radians
  39612. * @param angle defines the angle to convert
  39613. * @returns the angle in radians
  39614. */
  39615. static ToRadians(angle: number): number;
  39616. /**
  39617. * Returns an array if obj is not an array
  39618. * @param obj defines the object to evaluate as an array
  39619. * @param allowsNullUndefined defines a boolean indicating if obj is allowed to be null or undefined
  39620. * @returns either obj directly if obj is an array or a new array containing obj
  39621. */
  39622. static MakeArray(obj: any, allowsNullUndefined?: boolean): Nullable<Array<any>>;
  39623. /**
  39624. * Gets the pointer prefix to use
  39625. * @param engine defines the engine we are finding the prefix for
  39626. * @returns "pointer" if touch is enabled. Else returns "mouse"
  39627. */
  39628. static GetPointerPrefix(engine: Engine): string;
  39629. /**
  39630. * Sets the cors behavior on a dom element. This will add the required Tools.CorsBehavior to the element.
  39631. * @param url define the url we are trying
  39632. * @param element define the dom element where to configure the cors policy
  39633. */
  39634. static SetCorsBehavior(url: string | string[], element: {
  39635. crossOrigin: string | null;
  39636. }): void;
  39637. /**
  39638. * Removes unwanted characters from an url
  39639. * @param url defines the url to clean
  39640. * @returns the cleaned url
  39641. */
  39642. static CleanUrl(url: string): string;
  39643. /**
  39644. * Gets or sets a function used to pre-process url before using them to load assets
  39645. */
  39646. static get PreprocessUrl(): (url: string) => string;
  39647. static set PreprocessUrl(processor: (url: string) => string);
  39648. /**
  39649. * Loads an image as an HTMLImageElement.
  39650. * @param input url string, ArrayBuffer, or Blob to load
  39651. * @param onLoad callback called when the image successfully loads
  39652. * @param onError callback called when the image fails to load
  39653. * @param offlineProvider offline provider for caching
  39654. * @param mimeType optional mime type
  39655. * @returns the HTMLImageElement of the loaded image
  39656. */
  39657. static LoadImage(input: string | ArrayBuffer | Blob, onLoad: (img: HTMLImageElement | ImageBitmap) => void, onError: (message?: string, exception?: any) => void, offlineProvider: Nullable<IOfflineProvider>, mimeType?: string): Nullable<HTMLImageElement>;
  39658. /**
  39659. * Loads a file from a url
  39660. * @param url url string, ArrayBuffer, or Blob to load
  39661. * @param onSuccess callback called when the file successfully loads
  39662. * @param onProgress callback called while file is loading (if the server supports this mode)
  39663. * @param offlineProvider defines the offline provider for caching
  39664. * @param useArrayBuffer defines a boolean indicating that date must be returned as ArrayBuffer
  39665. * @param onError callback called when the file fails to load
  39666. * @returns a file request object
  39667. */
  39668. 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;
  39669. /**
  39670. * Loads a file from a url
  39671. * @param url the file url to load
  39672. * @param useArrayBuffer defines a boolean indicating that date must be returned as ArrayBuffer
  39673. * @returns a promise containing an ArrayBuffer corresponding to the loaded file
  39674. */
  39675. static LoadFileAsync(url: string, useArrayBuffer?: boolean): Promise<ArrayBuffer | string>;
  39676. /**
  39677. * Load a script (identified by an url). When the url returns, the
  39678. * content of this file is added into a new script element, attached to the DOM (body element)
  39679. * @param scriptUrl defines the url of the script to laod
  39680. * @param onSuccess defines the callback called when the script is loaded
  39681. * @param onError defines the callback to call if an error occurs
  39682. * @param scriptId defines the id of the script element
  39683. */
  39684. static LoadScript(scriptUrl: string, onSuccess: () => void, onError?: (message?: string, exception?: any) => void, scriptId?: string): void;
  39685. /**
  39686. * Load an asynchronous script (identified by an url). When the url returns, the
  39687. * content of this file is added into a new script element, attached to the DOM (body element)
  39688. * @param scriptUrl defines the url of the script to laod
  39689. * @param scriptId defines the id of the script element
  39690. * @returns a promise request object
  39691. */
  39692. static LoadScriptAsync(scriptUrl: string, scriptId?: string): Promise<void>;
  39693. /**
  39694. * Loads a file from a blob
  39695. * @param fileToLoad defines the blob to use
  39696. * @param callback defines the callback to call when data is loaded
  39697. * @param progressCallback defines the callback to call during loading process
  39698. * @returns a file request object
  39699. */
  39700. static ReadFileAsDataURL(fileToLoad: Blob, callback: (data: any) => void, progressCallback: (ev: ProgressEvent) => any): IFileRequest;
  39701. /**
  39702. * Reads a file from a File object
  39703. * @param file defines the file to load
  39704. * @param onSuccess defines the callback to call when data is loaded
  39705. * @param onProgress defines the callback to call during loading process
  39706. * @param useArrayBuffer defines a boolean indicating that data must be returned as an ArrayBuffer
  39707. * @param onError defines the callback to call when an error occurs
  39708. * @returns a file request object
  39709. */
  39710. static ReadFile(file: File, onSuccess: (data: any) => void, onProgress?: (ev: ProgressEvent) => any, useArrayBuffer?: boolean, onError?: (error: ReadFileError) => void): IFileRequest;
  39711. /**
  39712. * Creates a data url from a given string content
  39713. * @param content defines the content to convert
  39714. * @returns the new data url link
  39715. */
  39716. static FileAsURL(content: string): string;
  39717. /**
  39718. * Format the given number to a specific decimal format
  39719. * @param value defines the number to format
  39720. * @param decimals defines the number of decimals to use
  39721. * @returns the formatted string
  39722. */
  39723. static Format(value: number, decimals?: number): string;
  39724. /**
  39725. * Tries to copy an object by duplicating every property
  39726. * @param source defines the source object
  39727. * @param destination defines the target object
  39728. * @param doNotCopyList defines a list of properties to avoid
  39729. * @param mustCopyList defines a list of properties to copy (even if they start with _)
  39730. */
  39731. static DeepCopy(source: any, destination: any, doNotCopyList?: string[], mustCopyList?: string[]): void;
  39732. /**
  39733. * Gets a boolean indicating if the given object has no own property
  39734. * @param obj defines the object to test
  39735. * @returns true if object has no own property
  39736. */
  39737. static IsEmpty(obj: any): boolean;
  39738. /**
  39739. * Function used to register events at window level
  39740. * @param windowElement defines the Window object to use
  39741. * @param events defines the events to register
  39742. */
  39743. static RegisterTopRootEvents(windowElement: Window, events: {
  39744. name: string;
  39745. handler: Nullable<(e: FocusEvent) => any>;
  39746. }[]): void;
  39747. /**
  39748. * Function used to unregister events from window level
  39749. * @param windowElement defines the Window object to use
  39750. * @param events defines the events to unregister
  39751. */
  39752. static UnregisterTopRootEvents(windowElement: Window, events: {
  39753. name: string;
  39754. handler: Nullable<(e: FocusEvent) => any>;
  39755. }[]): void;
  39756. /**
  39757. * @ignore
  39758. */
  39759. static _ScreenshotCanvas: HTMLCanvasElement;
  39760. /**
  39761. * Dumps the current bound framebuffer
  39762. * @param width defines the rendering width
  39763. * @param height defines the rendering height
  39764. * @param engine defines the hosting engine
  39765. * @param successCallback defines the callback triggered once the data are available
  39766. * @param mimeType defines the mime type of the result
  39767. * @param fileName defines the filename to download. If present, the result will automatically be downloaded
  39768. */
  39769. static DumpFramebuffer(width: number, height: number, engine: Engine, successCallback?: (data: string) => void, mimeType?: string, fileName?: string): void;
  39770. /**
  39771. * Converts the canvas data to blob.
  39772. * This acts as a polyfill for browsers not supporting the to blob function.
  39773. * @param canvas Defines the canvas to extract the data from
  39774. * @param successCallback Defines the callback triggered once the data are available
  39775. * @param mimeType Defines the mime type of the result
  39776. */
  39777. static ToBlob(canvas: HTMLCanvasElement, successCallback: (blob: Nullable<Blob>) => void, mimeType?: string): void;
  39778. /**
  39779. * Encodes the canvas data to base 64 or automatically download the result if filename is defined
  39780. * @param successCallback defines the callback triggered once the data are available
  39781. * @param mimeType defines the mime type of the result
  39782. * @param fileName defines he filename to download. If present, the result will automatically be downloaded
  39783. */
  39784. static EncodeScreenshotCanvasData(successCallback?: (data: string) => void, mimeType?: string, fileName?: string): void;
  39785. /**
  39786. * Downloads a blob in the browser
  39787. * @param blob defines the blob to download
  39788. * @param fileName defines the name of the downloaded file
  39789. */
  39790. static Download(blob: Blob, fileName: string): void;
  39791. /**
  39792. * Captures a screenshot of the current rendering
  39793. * @see https://doc.babylonjs.com/how_to/render_scene_on_a_png
  39794. * @param engine defines the rendering engine
  39795. * @param camera defines the source camera
  39796. * @param size This parameter can be set to a single number or to an object with the
  39797. * following (optional) properties: precision, width, height. If a single number is passed,
  39798. * it will be used for both width and height. If an object is passed, the screenshot size
  39799. * will be derived from the parameters. The precision property is a multiplier allowing
  39800. * rendering at a higher or lower resolution
  39801. * @param successCallback defines the callback receives a single parameter which contains the
  39802. * screenshot as a string of base64-encoded characters. This string can be assigned to the
  39803. * src parameter of an <img> to display it
  39804. * @param mimeType defines the MIME type of the screenshot image (default: image/png).
  39805. * Check your browser for supported MIME types
  39806. */
  39807. static CreateScreenshot(engine: Engine, camera: Camera, size: IScreenshotSize | number, successCallback?: (data: string) => void, mimeType?: string): void;
  39808. /**
  39809. * Captures a screenshot of the current rendering
  39810. * @see https://doc.babylonjs.com/how_to/render_scene_on_a_png
  39811. * @param engine defines the rendering engine
  39812. * @param camera defines the source camera
  39813. * @param size This parameter can be set to a single number or to an object with the
  39814. * following (optional) properties: precision, width, height. If a single number is passed,
  39815. * it will be used for both width and height. If an object is passed, the screenshot size
  39816. * will be derived from the parameters. The precision property is a multiplier allowing
  39817. * rendering at a higher or lower resolution
  39818. * @param mimeType defines the MIME type of the screenshot image (default: image/png).
  39819. * Check your browser for supported MIME types
  39820. * @returns screenshot as a string of base64-encoded characters. This string can be assigned
  39821. * to the src parameter of an <img> to display it
  39822. */
  39823. static CreateScreenshotAsync(engine: Engine, camera: Camera, size: IScreenshotSize | number, mimeType?: string): Promise<string>;
  39824. /**
  39825. * Generates an image screenshot from the specified camera.
  39826. * @see https://doc.babylonjs.com/how_to/render_scene_on_a_png
  39827. * @param engine The engine to use for rendering
  39828. * @param camera The camera to use for rendering
  39829. * @param size This parameter can be set to a single number or to an object with the
  39830. * following (optional) properties: precision, width, height. If a single number is passed,
  39831. * it will be used for both width and height. If an object is passed, the screenshot size
  39832. * will be derived from the parameters. The precision property is a multiplier allowing
  39833. * rendering at a higher or lower resolution
  39834. * @param successCallback The callback receives a single parameter which contains the
  39835. * screenshot as a string of base64-encoded characters. This string can be assigned to the
  39836. * src parameter of an <img> to display it
  39837. * @param mimeType The MIME type of the screenshot image (default: image/png).
  39838. * Check your browser for supported MIME types
  39839. * @param samples Texture samples (default: 1)
  39840. * @param antialiasing Whether antialiasing should be turned on or not (default: false)
  39841. * @param fileName A name for for the downloaded file.
  39842. */
  39843. static CreateScreenshotUsingRenderTarget(engine: Engine, camera: Camera, size: IScreenshotSize | number, successCallback?: (data: string) => void, mimeType?: string, samples?: number, antialiasing?: boolean, fileName?: string): void;
  39844. /**
  39845. * Generates an image screenshot from the specified camera.
  39846. * @see https://doc.babylonjs.com/how_to/render_scene_on_a_png
  39847. * @param engine The engine to use for rendering
  39848. * @param camera The camera to use for rendering
  39849. * @param size This parameter can be set to a single number or to an object with the
  39850. * following (optional) properties: precision, width, height. If a single number is passed,
  39851. * it will be used for both width and height. If an object is passed, the screenshot size
  39852. * will be derived from the parameters. The precision property is a multiplier allowing
  39853. * rendering at a higher or lower resolution
  39854. * @param mimeType The MIME type of the screenshot image (default: image/png).
  39855. * Check your browser for supported MIME types
  39856. * @param samples Texture samples (default: 1)
  39857. * @param antialiasing Whether antialiasing should be turned on or not (default: false)
  39858. * @param fileName A name for for the downloaded file.
  39859. * @returns screenshot as a string of base64-encoded characters. This string can be assigned
  39860. * to the src parameter of an <img> to display it
  39861. */
  39862. static CreateScreenshotUsingRenderTargetAsync(engine: Engine, camera: Camera, size: IScreenshotSize | number, mimeType?: string, samples?: number, antialiasing?: boolean, fileName?: string): Promise<string>;
  39863. /**
  39864. * Implementation from http://stackoverflow.com/questions/105034/how-to-create-a-guid-uuid-in-javascript/2117523#answer-2117523
  39865. * Be aware Math.random() could cause collisions, but:
  39866. * "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"
  39867. * @returns a pseudo random id
  39868. */
  39869. static RandomId(): string;
  39870. /**
  39871. * Test if the given uri is a base64 string
  39872. * @param uri The uri to test
  39873. * @return True if the uri is a base64 string or false otherwise
  39874. */
  39875. static IsBase64(uri: string): boolean;
  39876. /**
  39877. * Decode the given base64 uri.
  39878. * @param uri The uri to decode
  39879. * @return The decoded base64 data.
  39880. */
  39881. static DecodeBase64(uri: string): ArrayBuffer;
  39882. /**
  39883. * Gets the absolute url.
  39884. * @param url the input url
  39885. * @return the absolute url
  39886. */
  39887. static GetAbsoluteUrl(url: string): string;
  39888. /**
  39889. * No log
  39890. */
  39891. static readonly NoneLogLevel: number;
  39892. /**
  39893. * Only message logs
  39894. */
  39895. static readonly MessageLogLevel: number;
  39896. /**
  39897. * Only warning logs
  39898. */
  39899. static readonly WarningLogLevel: number;
  39900. /**
  39901. * Only error logs
  39902. */
  39903. static readonly ErrorLogLevel: number;
  39904. /**
  39905. * All logs
  39906. */
  39907. static readonly AllLogLevel: number;
  39908. /**
  39909. * Gets a value indicating the number of loading errors
  39910. * @ignorenaming
  39911. */
  39912. static get errorsCount(): number;
  39913. /**
  39914. * Callback called when a new log is added
  39915. */
  39916. static OnNewCacheEntry: (entry: string) => void;
  39917. /**
  39918. * Log a message to the console
  39919. * @param message defines the message to log
  39920. */
  39921. static Log(message: string): void;
  39922. /**
  39923. * Write a warning message to the console
  39924. * @param message defines the message to log
  39925. */
  39926. static Warn(message: string): void;
  39927. /**
  39928. * Write an error message to the console
  39929. * @param message defines the message to log
  39930. */
  39931. static Error(message: string): void;
  39932. /**
  39933. * Gets current log cache (list of logs)
  39934. */
  39935. static get LogCache(): string;
  39936. /**
  39937. * Clears the log cache
  39938. */
  39939. static ClearLogCache(): void;
  39940. /**
  39941. * Sets the current log level (MessageLogLevel / WarningLogLevel / ErrorLogLevel)
  39942. */
  39943. static set LogLevels(level: number);
  39944. /**
  39945. * Checks if the window object exists
  39946. * Back Compat only, please use DomManagement.IsWindowObjectExist instead.
  39947. */
  39948. static IsWindowObjectExist: typeof DomManagement.IsWindowObjectExist;
  39949. /**
  39950. * No performance log
  39951. */
  39952. static readonly PerformanceNoneLogLevel: number;
  39953. /**
  39954. * Use user marks to log performance
  39955. */
  39956. static readonly PerformanceUserMarkLogLevel: number;
  39957. /**
  39958. * Log performance to the console
  39959. */
  39960. static readonly PerformanceConsoleLogLevel: number;
  39961. private static _performance;
  39962. /**
  39963. * Sets the current performance log level
  39964. */
  39965. static set PerformanceLogLevel(level: number);
  39966. private static _StartPerformanceCounterDisabled;
  39967. private static _EndPerformanceCounterDisabled;
  39968. private static _StartUserMark;
  39969. private static _EndUserMark;
  39970. private static _StartPerformanceConsole;
  39971. private static _EndPerformanceConsole;
  39972. /**
  39973. * Starts a performance counter
  39974. */
  39975. static StartPerformanceCounter: (counterName: string, condition?: boolean) => void;
  39976. /**
  39977. * Ends a specific performance coutner
  39978. */
  39979. static EndPerformanceCounter: (counterName: string, condition?: boolean) => void;
  39980. /**
  39981. * Gets either window.performance.now() if supported or Date.now() else
  39982. */
  39983. static get Now(): number;
  39984. /**
  39985. * This method will return the name of the class used to create the instance of the given object.
  39986. * It will works only on Javascript basic data types (number, string, ...) and instance of class declared with the @className decorator.
  39987. * @param object the object to get the class name from
  39988. * @param isType defines if the object is actually a type
  39989. * @returns the name of the class, will be "object" for a custom data type not using the @className decorator
  39990. */
  39991. static GetClassName(object: any, isType?: boolean): string;
  39992. /**
  39993. * Gets the first element of an array satisfying a given predicate
  39994. * @param array defines the array to browse
  39995. * @param predicate defines the predicate to use
  39996. * @returns null if not found or the element
  39997. */
  39998. static First<T>(array: Array<T>, predicate: (item: T) => boolean): Nullable<T>;
  39999. /**
  40000. * This method will return the name of the full name of the class, including its owning module (if any).
  40001. * 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).
  40002. * @param object the object to get the class name from
  40003. * @param isType defines if the object is actually a type
  40004. * @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.
  40005. * @ignorenaming
  40006. */
  40007. static getFullClassName(object: any, isType?: boolean): Nullable<string>;
  40008. /**
  40009. * Returns a promise that resolves after the given amount of time.
  40010. * @param delay Number of milliseconds to delay
  40011. * @returns Promise that resolves after the given amount of time
  40012. */
  40013. static DelayAsync(delay: number): Promise<void>;
  40014. /**
  40015. * Utility function to detect if the current user agent is Safari
  40016. * @returns whether or not the current user agent is safari
  40017. */
  40018. static IsSafari(): boolean;
  40019. }
  40020. /**
  40021. * Use this className as a decorator on a given class definition to add it a name and optionally its module.
  40022. * You can then use the Tools.getClassName(obj) on an instance to retrieve its class name.
  40023. * This method is the only way to get it done in all cases, even if the .js file declaring the class is minified
  40024. * @param name The name of the class, case should be preserved
  40025. * @param module The name of the Module hosting the class, optional, but strongly recommended to specify if possible. Case should be preserved.
  40026. */
  40027. export function className(name: string, module?: string): (target: Object) => void;
  40028. /**
  40029. * An implementation of a loop for asynchronous functions.
  40030. */
  40031. export class AsyncLoop {
  40032. /**
  40033. * Defines the number of iterations for the loop
  40034. */
  40035. iterations: number;
  40036. /**
  40037. * Defines the current index of the loop.
  40038. */
  40039. index: number;
  40040. private _done;
  40041. private _fn;
  40042. private _successCallback;
  40043. /**
  40044. * Constructor.
  40045. * @param iterations the number of iterations.
  40046. * @param func the function to run each iteration
  40047. * @param successCallback the callback that will be called upon succesful execution
  40048. * @param offset starting offset.
  40049. */
  40050. constructor(
  40051. /**
  40052. * Defines the number of iterations for the loop
  40053. */
  40054. iterations: number, func: (asyncLoop: AsyncLoop) => void, successCallback: () => void, offset?: number);
  40055. /**
  40056. * Execute the next iteration. Must be called after the last iteration was finished.
  40057. */
  40058. executeNext(): void;
  40059. /**
  40060. * Break the loop and run the success callback.
  40061. */
  40062. breakLoop(): void;
  40063. /**
  40064. * Create and run an async loop.
  40065. * @param iterations the number of iterations.
  40066. * @param fn the function to run each iteration
  40067. * @param successCallback the callback that will be called upon succesful execution
  40068. * @param offset starting offset.
  40069. * @returns the created async loop object
  40070. */
  40071. static Run(iterations: number, fn: (asyncLoop: AsyncLoop) => void, successCallback: () => void, offset?: number): AsyncLoop;
  40072. /**
  40073. * A for-loop that will run a given number of iterations synchronous and the rest async.
  40074. * @param iterations total number of iterations
  40075. * @param syncedIterations number of synchronous iterations in each async iteration.
  40076. * @param fn the function to call each iteration.
  40077. * @param callback a success call back that will be called when iterating stops.
  40078. * @param breakFunction a break condition (optional)
  40079. * @param timeout timeout settings for the setTimeout function. default - 0.
  40080. * @returns the created async loop object
  40081. */
  40082. static SyncAsyncForLoop(iterations: number, syncedIterations: number, fn: (iteration: number) => void, callback: () => void, breakFunction?: () => boolean, timeout?: number): AsyncLoop;
  40083. }
  40084. }
  40085. declare module "babylonjs/Misc/stringDictionary" {
  40086. import { Nullable } from "babylonjs/types";
  40087. /**
  40088. * This class implement a typical dictionary using a string as key and the generic type T as value.
  40089. * The underlying implementation relies on an associative array to ensure the best performances.
  40090. * The value can be anything including 'null' but except 'undefined'
  40091. */
  40092. export class StringDictionary<T> {
  40093. /**
  40094. * This will clear this dictionary and copy the content from the 'source' one.
  40095. * If the T value is a custom object, it won't be copied/cloned, the same object will be used
  40096. * @param source the dictionary to take the content from and copy to this dictionary
  40097. */
  40098. copyFrom(source: StringDictionary<T>): void;
  40099. /**
  40100. * Get a value based from its key
  40101. * @param key the given key to get the matching value from
  40102. * @return the value if found, otherwise undefined is returned
  40103. */
  40104. get(key: string): T | undefined;
  40105. /**
  40106. * Get a value from its key or add it if it doesn't exist.
  40107. * This method will ensure you that a given key/data will be present in the dictionary.
  40108. * @param key the given key to get the matching value from
  40109. * @param factory the factory that will create the value if the key is not present in the dictionary.
  40110. * The factory will only be invoked if there's no data for the given key.
  40111. * @return the value corresponding to the key.
  40112. */
  40113. getOrAddWithFactory(key: string, factory: (key: string) => T): T;
  40114. /**
  40115. * Get a value from its key if present in the dictionary otherwise add it
  40116. * @param key the key to get the value from
  40117. * @param val if there's no such key/value pair in the dictionary add it with this value
  40118. * @return the value corresponding to the key
  40119. */
  40120. getOrAdd(key: string, val: T): T;
  40121. /**
  40122. * Check if there's a given key in the dictionary
  40123. * @param key the key to check for
  40124. * @return true if the key is present, false otherwise
  40125. */
  40126. contains(key: string): boolean;
  40127. /**
  40128. * Add a new key and its corresponding value
  40129. * @param key the key to add
  40130. * @param value the value corresponding to the key
  40131. * @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
  40132. */
  40133. add(key: string, value: T): boolean;
  40134. /**
  40135. * Update a specific value associated to a key
  40136. * @param key defines the key to use
  40137. * @param value defines the value to store
  40138. * @returns true if the value was updated (or false if the key was not found)
  40139. */
  40140. set(key: string, value: T): boolean;
  40141. /**
  40142. * Get the element of the given key and remove it from the dictionary
  40143. * @param key defines the key to search
  40144. * @returns the value associated with the key or null if not found
  40145. */
  40146. getAndRemove(key: string): Nullable<T>;
  40147. /**
  40148. * Remove a key/value from the dictionary.
  40149. * @param key the key to remove
  40150. * @return true if the item was successfully deleted, false if no item with such key exist in the dictionary
  40151. */
  40152. remove(key: string): boolean;
  40153. /**
  40154. * Clear the whole content of the dictionary
  40155. */
  40156. clear(): void;
  40157. /**
  40158. * Gets the current count
  40159. */
  40160. get count(): number;
  40161. /**
  40162. * Execute a callback on each key/val of the dictionary.
  40163. * Note that you can remove any element in this dictionary in the callback implementation
  40164. * @param callback the callback to execute on a given key/value pair
  40165. */
  40166. forEach(callback: (key: string, val: T) => void): void;
  40167. /**
  40168. * Execute a callback on every occurrence of the dictionary until it returns a valid TRes object.
  40169. * If the callback returns null or undefined the method will iterate to the next key/value pair
  40170. * Note that you can remove any element in this dictionary in the callback implementation
  40171. * @param callback the callback to execute, if it return a valid T instanced object the enumeration will stop and the object will be returned
  40172. * @returns the first item
  40173. */
  40174. first<TRes>(callback: (key: string, val: T) => TRes): TRes | null;
  40175. private _count;
  40176. private _data;
  40177. }
  40178. }
  40179. declare module "babylonjs/Collisions/collisionCoordinator" {
  40180. import { Nullable } from "babylonjs/types";
  40181. import { Scene } from "babylonjs/scene";
  40182. import { Vector3 } from "babylonjs/Maths/math.vector";
  40183. import { Collider } from "babylonjs/Collisions/collider";
  40184. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  40185. /** @hidden */
  40186. export interface ICollisionCoordinator {
  40187. createCollider(): Collider;
  40188. getNewPosition(position: Vector3, displacement: Vector3, collider: Collider, maximumRetry: number, excludedMesh: Nullable<AbstractMesh>, onNewPosition: (collisionIndex: number, newPosition: Vector3, collidedMesh: Nullable<AbstractMesh>) => void, collisionIndex: number): void;
  40189. init(scene: Scene): void;
  40190. }
  40191. /** @hidden */
  40192. export class DefaultCollisionCoordinator implements ICollisionCoordinator {
  40193. private _scene;
  40194. private _scaledPosition;
  40195. private _scaledVelocity;
  40196. private _finalPosition;
  40197. getNewPosition(position: Vector3, displacement: Vector3, collider: Collider, maximumRetry: number, excludedMesh: AbstractMesh, onNewPosition: (collisionIndex: number, newPosition: Vector3, collidedMesh: Nullable<AbstractMesh>) => void, collisionIndex: number): void;
  40198. createCollider(): Collider;
  40199. init(scene: Scene): void;
  40200. private _collideWithWorld;
  40201. }
  40202. }
  40203. declare module "babylonjs/Inputs/scene.inputManager" {
  40204. import { Nullable } from "babylonjs/types";
  40205. import { PickingInfo } from "babylonjs/Collisions/pickingInfo";
  40206. import { Vector2 } from "babylonjs/Maths/math.vector";
  40207. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  40208. import { Scene } from "babylonjs/scene";
  40209. /**
  40210. * Class used to manage all inputs for the scene.
  40211. */
  40212. export class InputManager {
  40213. /** The distance in pixel that you have to move to prevent some events */
  40214. static DragMovementThreshold: number;
  40215. /** Time in milliseconds to wait to raise long press events if button is still pressed */
  40216. static LongPressDelay: number;
  40217. /** Time in milliseconds with two consecutive clicks will be considered as a double click */
  40218. static DoubleClickDelay: number;
  40219. /** If you need to check double click without raising a single click at first click, enable this flag */
  40220. static ExclusiveDoubleClickMode: boolean;
  40221. /** 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. */
  40222. private _alreadyAttached;
  40223. private _wheelEventName;
  40224. private _onPointerMove;
  40225. private _onPointerDown;
  40226. private _onPointerUp;
  40227. private _initClickEvent;
  40228. private _initActionManager;
  40229. private _delayedSimpleClick;
  40230. private _delayedSimpleClickTimeout;
  40231. private _previousDelayedSimpleClickTimeout;
  40232. private _meshPickProceed;
  40233. private _previousButtonPressed;
  40234. private _currentPickResult;
  40235. private _previousPickResult;
  40236. private _totalPointersPressed;
  40237. private _doubleClickOccured;
  40238. private _pointerOverMesh;
  40239. private _pickedDownMesh;
  40240. private _pickedUpMesh;
  40241. private _pointerX;
  40242. private _pointerY;
  40243. private _unTranslatedPointerX;
  40244. private _unTranslatedPointerY;
  40245. private _startingPointerPosition;
  40246. private _previousStartingPointerPosition;
  40247. private _startingPointerTime;
  40248. private _previousStartingPointerTime;
  40249. private _pointerCaptures;
  40250. private _onKeyDown;
  40251. private _onKeyUp;
  40252. private _onCanvasFocusObserver;
  40253. private _onCanvasBlurObserver;
  40254. private _scene;
  40255. /**
  40256. * Creates a new InputManager
  40257. * @param scene defines the hosting scene
  40258. */
  40259. constructor(scene: Scene);
  40260. /**
  40261. * Gets the mesh that is currently under the pointer
  40262. */
  40263. get meshUnderPointer(): Nullable<AbstractMesh>;
  40264. /**
  40265. * Gets the pointer coordinates in 2D without any translation (ie. straight out of the pointer event)
  40266. */
  40267. get unTranslatedPointer(): Vector2;
  40268. /**
  40269. * Gets or sets the current on-screen X position of the pointer
  40270. */
  40271. get pointerX(): number;
  40272. set pointerX(value: number);
  40273. /**
  40274. * Gets or sets the current on-screen Y position of the pointer
  40275. */
  40276. get pointerY(): number;
  40277. set pointerY(value: number);
  40278. private _updatePointerPosition;
  40279. private _processPointerMove;
  40280. private _setRayOnPointerInfo;
  40281. private _checkPrePointerObservable;
  40282. /**
  40283. * Use this method to simulate a pointer move on a mesh
  40284. * The pickResult parameter can be obtained from a scene.pick or scene.pickWithRay
  40285. * @param pickResult pickingInfo of the object wished to simulate pointer event on
  40286. * @param pointerEventInit pointer event state to be used when simulating the pointer event (eg. pointer id for multitouch)
  40287. */
  40288. simulatePointerMove(pickResult: PickingInfo, pointerEventInit?: PointerEventInit): void;
  40289. /**
  40290. * Use this method to simulate a pointer down on a mesh
  40291. * The pickResult parameter can be obtained from a scene.pick or scene.pickWithRay
  40292. * @param pickResult pickingInfo of the object wished to simulate pointer event on
  40293. * @param pointerEventInit pointer event state to be used when simulating the pointer event (eg. pointer id for multitouch)
  40294. */
  40295. simulatePointerDown(pickResult: PickingInfo, pointerEventInit?: PointerEventInit): void;
  40296. private _processPointerDown;
  40297. /** @hidden */
  40298. _isPointerSwiping(): boolean;
  40299. /**
  40300. * Use this method to simulate a pointer up on a mesh
  40301. * The pickResult parameter can be obtained from a scene.pick or scene.pickWithRay
  40302. * @param pickResult pickingInfo of the object wished to simulate pointer event on
  40303. * @param pointerEventInit pointer event state to be used when simulating the pointer event (eg. pointer id for multitouch)
  40304. * @param doubleTap indicates that the pointer up event should be considered as part of a double click (false by default)
  40305. */
  40306. simulatePointerUp(pickResult: PickingInfo, pointerEventInit?: PointerEventInit, doubleTap?: boolean): void;
  40307. private _processPointerUp;
  40308. /**
  40309. * Gets a boolean indicating if the current pointer event is captured (meaning that the scene has already handled the pointer down)
  40310. * @param pointerId defines the pointer id to use in a multi-touch scenario (0 by default)
  40311. * @returns true if the pointer was captured
  40312. */
  40313. isPointerCaptured(pointerId?: number): boolean;
  40314. /**
  40315. * Attach events to the canvas (To handle actionManagers triggers and raise onPointerMove, onPointerDown and onPointerUp
  40316. * @param attachUp defines if you want to attach events to pointerup
  40317. * @param attachDown defines if you want to attach events to pointerdown
  40318. * @param attachMove defines if you want to attach events to pointermove
  40319. * @param elementToAttachTo defines the target DOM element to attach to (will use the canvas by default)
  40320. */
  40321. attachControl(attachUp?: boolean, attachDown?: boolean, attachMove?: boolean, elementToAttachTo?: Nullable<HTMLElement>): void;
  40322. /**
  40323. * Detaches all event handlers
  40324. */
  40325. detachControl(): void;
  40326. /**
  40327. * Force the value of meshUnderPointer
  40328. * @param mesh defines the mesh to use
  40329. */
  40330. setPointerOverMesh(mesh: Nullable<AbstractMesh>): void;
  40331. /**
  40332. * Gets the mesh under the pointer
  40333. * @returns a Mesh or null if no mesh is under the pointer
  40334. */
  40335. getPointerOverMesh(): Nullable<AbstractMesh>;
  40336. }
  40337. }
  40338. declare module "babylonjs/Animations/animationGroup" {
  40339. import { Animatable } from "babylonjs/Animations/animatable";
  40340. import { Animation } from "babylonjs/Animations/animation";
  40341. import { Scene, IDisposable } from "babylonjs/scene";
  40342. import { Observable } from "babylonjs/Misc/observable";
  40343. import { Nullable } from "babylonjs/types";
  40344. import "babylonjs/Animations/animatable";
  40345. /**
  40346. * This class defines the direct association between an animation and a target
  40347. */
  40348. export class TargetedAnimation {
  40349. /**
  40350. * Animation to perform
  40351. */
  40352. animation: Animation;
  40353. /**
  40354. * Target to animate
  40355. */
  40356. target: any;
  40357. /**
  40358. * Returns the string "TargetedAnimation"
  40359. * @returns "TargetedAnimation"
  40360. */
  40361. getClassName(): string;
  40362. /**
  40363. * Serialize the object
  40364. * @returns the JSON object representing the current entity
  40365. */
  40366. serialize(): any;
  40367. }
  40368. /**
  40369. * Use this class to create coordinated animations on multiple targets
  40370. */
  40371. export class AnimationGroup implements IDisposable {
  40372. /** The name of the animation group */
  40373. name: string;
  40374. private _scene;
  40375. private _targetedAnimations;
  40376. private _animatables;
  40377. private _from;
  40378. private _to;
  40379. private _isStarted;
  40380. private _isPaused;
  40381. private _speedRatio;
  40382. private _loopAnimation;
  40383. private _isAdditive;
  40384. /**
  40385. * Gets or sets the unique id of the node
  40386. */
  40387. uniqueId: number;
  40388. /**
  40389. * This observable will notify when one animation have ended
  40390. */
  40391. onAnimationEndObservable: Observable<TargetedAnimation>;
  40392. /**
  40393. * Observer raised when one animation loops
  40394. */
  40395. onAnimationLoopObservable: Observable<TargetedAnimation>;
  40396. /**
  40397. * Observer raised when all animations have looped
  40398. */
  40399. onAnimationGroupLoopObservable: Observable<AnimationGroup>;
  40400. /**
  40401. * This observable will notify when all animations have ended.
  40402. */
  40403. onAnimationGroupEndObservable: Observable<AnimationGroup>;
  40404. /**
  40405. * This observable will notify when all animations have paused.
  40406. */
  40407. onAnimationGroupPauseObservable: Observable<AnimationGroup>;
  40408. /**
  40409. * This observable will notify when all animations are playing.
  40410. */
  40411. onAnimationGroupPlayObservable: Observable<AnimationGroup>;
  40412. /**
  40413. * Gets the first frame
  40414. */
  40415. get from(): number;
  40416. /**
  40417. * Gets the last frame
  40418. */
  40419. get to(): number;
  40420. /**
  40421. * Define if the animations are started
  40422. */
  40423. get isStarted(): boolean;
  40424. /**
  40425. * Gets a value indicating that the current group is playing
  40426. */
  40427. get isPlaying(): boolean;
  40428. /**
  40429. * Gets or sets the speed ratio to use for all animations
  40430. */
  40431. get speedRatio(): number;
  40432. /**
  40433. * Gets or sets the speed ratio to use for all animations
  40434. */
  40435. set speedRatio(value: number);
  40436. /**
  40437. * Gets or sets if all animations should loop or not
  40438. */
  40439. get loopAnimation(): boolean;
  40440. set loopAnimation(value: boolean);
  40441. /**
  40442. * Gets or sets if all animations should be evaluated additively
  40443. */
  40444. get isAdditive(): boolean;
  40445. set isAdditive(value: boolean);
  40446. /**
  40447. * Gets the targeted animations for this animation group
  40448. */
  40449. get targetedAnimations(): Array<TargetedAnimation>;
  40450. /**
  40451. * returning the list of animatables controlled by this animation group.
  40452. */
  40453. get animatables(): Array<Animatable>;
  40454. /**
  40455. * Gets the list of target animations
  40456. */
  40457. get children(): TargetedAnimation[];
  40458. /**
  40459. * Instantiates a new Animation Group.
  40460. * This helps managing several animations at once.
  40461. * @see https://doc.babylonjs.com/how_to/group
  40462. * @param name Defines the name of the group
  40463. * @param scene Defines the scene the group belongs to
  40464. */
  40465. constructor(
  40466. /** The name of the animation group */
  40467. name: string, scene?: Nullable<Scene>);
  40468. /**
  40469. * Add an animation (with its target) in the group
  40470. * @param animation defines the animation we want to add
  40471. * @param target defines the target of the animation
  40472. * @returns the TargetedAnimation object
  40473. */
  40474. addTargetedAnimation(animation: Animation, target: any): TargetedAnimation;
  40475. /**
  40476. * This function will normalize every animation in the group to make sure they all go from beginFrame to endFrame
  40477. * It can add constant keys at begin or end
  40478. * @param beginFrame defines the new begin frame for all animations or the smallest begin frame of all animations if null (defaults to null)
  40479. * @param endFrame defines the new end frame for all animations or the largest end frame of all animations if null (defaults to null)
  40480. * @returns the animation group
  40481. */
  40482. normalize(beginFrame?: Nullable<number>, endFrame?: Nullable<number>): AnimationGroup;
  40483. private _animationLoopCount;
  40484. private _animationLoopFlags;
  40485. private _processLoop;
  40486. /**
  40487. * Start all animations on given targets
  40488. * @param loop defines if animations must loop
  40489. * @param speedRatio defines the ratio to apply to animation speed (1 by default)
  40490. * @param from defines the from key (optional)
  40491. * @param to defines the to key (optional)
  40492. * @param isAdditive defines the additive state for the resulting animatables (optional)
  40493. * @returns the current animation group
  40494. */
  40495. start(loop?: boolean, speedRatio?: number, from?: number, to?: number, isAdditive?: boolean): AnimationGroup;
  40496. /**
  40497. * Pause all animations
  40498. * @returns the animation group
  40499. */
  40500. pause(): AnimationGroup;
  40501. /**
  40502. * Play all animations to initial state
  40503. * This function will start() the animations if they were not started or will restart() them if they were paused
  40504. * @param loop defines if animations must loop
  40505. * @returns the animation group
  40506. */
  40507. play(loop?: boolean): AnimationGroup;
  40508. /**
  40509. * Reset all animations to initial state
  40510. * @returns the animation group
  40511. */
  40512. reset(): AnimationGroup;
  40513. /**
  40514. * Restart animations from key 0
  40515. * @returns the animation group
  40516. */
  40517. restart(): AnimationGroup;
  40518. /**
  40519. * Stop all animations
  40520. * @returns the animation group
  40521. */
  40522. stop(): AnimationGroup;
  40523. /**
  40524. * Set animation weight for all animatables
  40525. * @param weight defines the weight to use
  40526. * @return the animationGroup
  40527. * @see https://doc.babylonjs.com/babylon101/animations#animation-weights
  40528. */
  40529. setWeightForAllAnimatables(weight: number): AnimationGroup;
  40530. /**
  40531. * Synchronize and normalize all animatables with a source animatable
  40532. * @param root defines the root animatable to synchronize with
  40533. * @return the animationGroup
  40534. * @see https://doc.babylonjs.com/babylon101/animations#animation-weights
  40535. */
  40536. syncAllAnimationsWith(root: Animatable): AnimationGroup;
  40537. /**
  40538. * Goes to a specific frame in this animation group
  40539. * @param frame the frame number to go to
  40540. * @return the animationGroup
  40541. */
  40542. goToFrame(frame: number): AnimationGroup;
  40543. /**
  40544. * Dispose all associated resources
  40545. */
  40546. dispose(): void;
  40547. private _checkAnimationGroupEnded;
  40548. /**
  40549. * Clone the current animation group and returns a copy
  40550. * @param newName defines the name of the new group
  40551. * @param targetConverter defines an optional function used to convert current animation targets to new ones
  40552. * @returns the new aniamtion group
  40553. */
  40554. clone(newName: string, targetConverter?: (oldTarget: any) => any): AnimationGroup;
  40555. /**
  40556. * Serializes the animationGroup to an object
  40557. * @returns Serialized object
  40558. */
  40559. serialize(): any;
  40560. /**
  40561. * Returns a new AnimationGroup object parsed from the source provided.
  40562. * @param parsedAnimationGroup defines the source
  40563. * @param scene defines the scene that will receive the animationGroup
  40564. * @returns a new AnimationGroup
  40565. */
  40566. static Parse(parsedAnimationGroup: any, scene: Scene): AnimationGroup;
  40567. /**
  40568. * Convert the keyframes for all animations belonging to the group to be relative to a given reference frame.
  40569. * @param sourceAnimationGroup defines the AnimationGroup containing animations to convert
  40570. * @param referenceFrame defines the frame that keyframes in the range will be relative to
  40571. * @param range defines the name of the AnimationRange belonging to the animations in the group to convert
  40572. * @param cloneOriginal defines whether or not to clone the group and convert the clone or convert the original group (default is false)
  40573. * @param clonedName defines the name of the resulting cloned AnimationGroup if cloneOriginal is true
  40574. * @returns a new AnimationGroup if cloneOriginal is true or the original AnimationGroup if cloneOriginal is false
  40575. */
  40576. static MakeAnimationAdditive(sourceAnimationGroup: AnimationGroup, referenceFrame?: number, range?: string, cloneOriginal?: boolean, clonedName?: string): AnimationGroup;
  40577. /**
  40578. * Returns the string "AnimationGroup"
  40579. * @returns "AnimationGroup"
  40580. */
  40581. getClassName(): string;
  40582. /**
  40583. * Creates a detailled string about the object
  40584. * @param fullDetails defines if the output string will support multiple levels of logging within scene loading
  40585. * @returns a string representing the object
  40586. */
  40587. toString(fullDetails?: boolean): string;
  40588. }
  40589. }
  40590. declare module "babylonjs/scene" {
  40591. import { Nullable } from "babylonjs/types";
  40592. import { IAnimatable } from "babylonjs/Animations/animatable.interface";
  40593. import { Observable } from "babylonjs/Misc/observable";
  40594. import { SmartArrayNoDuplicate, SmartArray, ISmartArrayLike } from "babylonjs/Misc/smartArray";
  40595. import { Vector2, Vector3, Matrix } from "babylonjs/Maths/math.vector";
  40596. import { Geometry } from "babylonjs/Meshes/geometry";
  40597. import { TransformNode } from "babylonjs/Meshes/transformNode";
  40598. import { SubMesh } from "babylonjs/Meshes/subMesh";
  40599. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  40600. import { Mesh } from "babylonjs/Meshes/mesh";
  40601. import { IParticleSystem } from "babylonjs/Particles/IParticleSystem";
  40602. import { Bone } from "babylonjs/Bones/bone";
  40603. import { Skeleton } from "babylonjs/Bones/skeleton";
  40604. import { MorphTargetManager } from "babylonjs/Morph/morphTargetManager";
  40605. import { Camera } from "babylonjs/Cameras/camera";
  40606. import { AbstractScene } from "babylonjs/abstractScene";
  40607. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  40608. import { RenderTargetTexture } from "babylonjs/Materials/Textures/renderTargetTexture";
  40609. import { Material } from "babylonjs/Materials/material";
  40610. import { ImageProcessingConfiguration } from "babylonjs/Materials/imageProcessingConfiguration";
  40611. import { Effect } from "babylonjs/Materials/effect";
  40612. import { UniformBuffer } from "babylonjs/Materials/uniformBuffer";
  40613. import { MultiMaterial } from "babylonjs/Materials/multiMaterial";
  40614. import { Light } from "babylonjs/Lights/light";
  40615. import { PickingInfo } from "babylonjs/Collisions/pickingInfo";
  40616. import { ICollisionCoordinator } from "babylonjs/Collisions/collisionCoordinator";
  40617. import { PointerEventTypes, PointerInfoPre, PointerInfo } from "babylonjs/Events/pointerEvents";
  40618. import { KeyboardInfoPre, KeyboardInfo } from "babylonjs/Events/keyboardEvents";
  40619. import { PostProcessManager } from "babylonjs/PostProcesses/postProcessManager";
  40620. import { IOfflineProvider } from "babylonjs/Offline/IOfflineProvider";
  40621. import { RenderingGroupInfo, IRenderingManagerAutoClearSetup } from "babylonjs/Rendering/renderingManager";
  40622. import { ISceneComponent, ISceneSerializableComponent, Stage, SimpleStageAction, RenderTargetsStageAction, RenderTargetStageAction, MeshStageAction, EvaluateSubMeshStageAction, ActiveMeshStageAction, CameraStageAction, RenderingGroupStageAction, RenderingMeshStageAction, PointerMoveStageAction, PointerUpDownStageAction, CameraStageFrameBufferAction } from "babylonjs/sceneComponent";
  40623. import { Engine } from "babylonjs/Engines/engine";
  40624. import { Node } from "babylonjs/node";
  40625. import { MorphTarget } from "babylonjs/Morph/morphTarget";
  40626. import { AbstractActionManager } from "babylonjs/Actions/abstractActionManager";
  40627. import { WebRequest } from "babylonjs/Misc/webRequest";
  40628. import { InputManager } from "babylonjs/Inputs/scene.inputManager";
  40629. import { PerfCounter } from "babylonjs/Misc/perfCounter";
  40630. import { IFileRequest } from "babylonjs/Misc/fileRequest";
  40631. import { Color4, Color3 } from "babylonjs/Maths/math.color";
  40632. import { Plane } from "babylonjs/Maths/math.plane";
  40633. import { LoadFileError, RequestFileError, ReadFileError } from "babylonjs/Misc/fileTools";
  40634. import { IClipPlanesHolder } from "babylonjs/Misc/interfaces/iClipPlanesHolder";
  40635. import { Ray } from "babylonjs/Culling/ray";
  40636. import { TrianglePickingPredicate } from "babylonjs/Culling/ray";
  40637. import { Animation } from "babylonjs/Animations/animation";
  40638. import { Animatable } from "babylonjs/Animations/animatable";
  40639. import { AnimationGroup } from "babylonjs/Animations/animationGroup";
  40640. import { AnimationPropertiesOverride } from "babylonjs/Animations/animationPropertiesOverride";
  40641. import { Collider } from "babylonjs/Collisions/collider";
  40642. import { PostProcess } from "babylonjs/PostProcesses/postProcess";
  40643. /**
  40644. * Define an interface for all classes that will hold resources
  40645. */
  40646. export interface IDisposable {
  40647. /**
  40648. * Releases all held resources
  40649. */
  40650. dispose(): void;
  40651. }
  40652. /** Interface defining initialization parameters for Scene class */
  40653. export interface SceneOptions {
  40654. /**
  40655. * Defines that scene should keep up-to-date a map of geometry to enable fast look-up by uniqueId
  40656. * It will improve performance when the number of geometries becomes important.
  40657. */
  40658. useGeometryUniqueIdsMap?: boolean;
  40659. /**
  40660. * Defines that each material of the scene should keep up-to-date a map of referencing meshes for fast diposing
  40661. * It will improve performance when the number of mesh becomes important, but might consume a bit more memory
  40662. */
  40663. useMaterialMeshMap?: boolean;
  40664. /**
  40665. * Defines that each mesh of the scene should keep up-to-date a map of referencing cloned meshes for fast diposing
  40666. * It will improve performance when the number of mesh becomes important, but might consume a bit more memory
  40667. */
  40668. useClonedMeshMap?: boolean;
  40669. /** Defines if the creation of the scene should impact the engine (Eg. UtilityLayer's scene) */
  40670. virtual?: boolean;
  40671. }
  40672. /**
  40673. * Represents a scene to be rendered by the engine.
  40674. * @see https://doc.babylonjs.com/features/scene
  40675. */
  40676. export class Scene extends AbstractScene implements IAnimatable, IClipPlanesHolder {
  40677. /** The fog is deactivated */
  40678. static readonly FOGMODE_NONE: number;
  40679. /** The fog density is following an exponential function */
  40680. static readonly FOGMODE_EXP: number;
  40681. /** The fog density is following an exponential function faster than FOGMODE_EXP */
  40682. static readonly FOGMODE_EXP2: number;
  40683. /** The fog density is following a linear function. */
  40684. static readonly FOGMODE_LINEAR: number;
  40685. /**
  40686. * Gets or sets the minimum deltatime when deterministic lock step is enabled
  40687. * @see https://doc.babylonjs.com/babylon101/animations#deterministic-lockstep
  40688. */
  40689. static MinDeltaTime: number;
  40690. /**
  40691. * Gets or sets the maximum deltatime when deterministic lock step is enabled
  40692. * @see https://doc.babylonjs.com/babylon101/animations#deterministic-lockstep
  40693. */
  40694. static MaxDeltaTime: number;
  40695. /**
  40696. * Factory used to create the default material.
  40697. * @param name The name of the material to create
  40698. * @param scene The scene to create the material for
  40699. * @returns The default material
  40700. */
  40701. static DefaultMaterialFactory(scene: Scene): Material;
  40702. /**
  40703. * Factory used to create the a collision coordinator.
  40704. * @returns The collision coordinator
  40705. */
  40706. static CollisionCoordinatorFactory(): ICollisionCoordinator;
  40707. /** @hidden */
  40708. _inputManager: InputManager;
  40709. /** Define this parameter if you are using multiple cameras and you want to specify which one should be used for pointer position */
  40710. cameraToUseForPointers: Nullable<Camera>;
  40711. /** @hidden */
  40712. readonly _isScene: boolean;
  40713. /** @hidden */
  40714. _blockEntityCollection: boolean;
  40715. /**
  40716. * Gets or sets a boolean that indicates if the scene must clear the render buffer before rendering a frame
  40717. */
  40718. autoClear: boolean;
  40719. /**
  40720. * Gets or sets a boolean that indicates if the scene must clear the depth and stencil buffers before rendering a frame
  40721. */
  40722. autoClearDepthAndStencil: boolean;
  40723. /**
  40724. * Defines the color used to clear the render buffer (Default is (0.2, 0.2, 0.3, 1.0))
  40725. */
  40726. clearColor: Color4;
  40727. /**
  40728. * Defines the color used to simulate the ambient color (Default is (0, 0, 0))
  40729. */
  40730. ambientColor: Color3;
  40731. /**
  40732. * This is use to store the default BRDF lookup for PBR materials in your scene.
  40733. * It should only be one of the following (if not the default embedded one):
  40734. * * For uncorrelated BRDF (pbr.brdf.useEnergyConservation = false and pbr.brdf.useSmithVisibilityHeightCorrelated = false) : https://assets.babylonjs.com/environments/uncorrelatedBRDF.dds
  40735. * * For correlated BRDF (pbr.brdf.useEnergyConservation = false and pbr.brdf.useSmithVisibilityHeightCorrelated = true) : https://assets.babylonjs.com/environments/correlatedBRDF.dds
  40736. * * For correlated multi scattering BRDF (pbr.brdf.useEnergyConservation = true and pbr.brdf.useSmithVisibilityHeightCorrelated = true) : https://assets.babylonjs.com/environments/correlatedMSBRDF.dds
  40737. * The material properties need to be setup according to the type of texture in use.
  40738. */
  40739. environmentBRDFTexture: BaseTexture;
  40740. /**
  40741. * Texture used in all pbr material as the reflection texture.
  40742. * As in the majority of the scene they are the same (exception for multi room and so on),
  40743. * this is easier to reference from here than from all the materials.
  40744. */
  40745. get environmentTexture(): Nullable<BaseTexture>;
  40746. /**
  40747. * Texture used in all pbr material as the reflection texture.
  40748. * As in the majority of the scene they are the same (exception for multi room and so on),
  40749. * this is easier to set here than in all the materials.
  40750. */
  40751. set environmentTexture(value: Nullable<BaseTexture>);
  40752. /** @hidden */
  40753. protected _environmentIntensity: number;
  40754. /**
  40755. * Intensity of the environment in all pbr material.
  40756. * This dims or reinforces the IBL lighting overall (reflection and diffuse).
  40757. * As in the majority of the scene they are the same (exception for multi room and so on),
  40758. * this is easier to reference from here than from all the materials.
  40759. */
  40760. get environmentIntensity(): number;
  40761. /**
  40762. * Intensity of the environment in all pbr material.
  40763. * This dims or reinforces the IBL lighting overall (reflection and diffuse).
  40764. * As in the majority of the scene they are the same (exception for multi room and so on),
  40765. * this is easier to set here than in all the materials.
  40766. */
  40767. set environmentIntensity(value: number);
  40768. /** @hidden */
  40769. protected _imageProcessingConfiguration: ImageProcessingConfiguration;
  40770. /**
  40771. * Default image processing configuration used either in the rendering
  40772. * Forward main pass or through the imageProcessingPostProcess if present.
  40773. * As in the majority of the scene they are the same (exception for multi camera),
  40774. * this is easier to reference from here than from all the materials and post process.
  40775. *
  40776. * No setter as we it is a shared configuration, you can set the values instead.
  40777. */
  40778. get imageProcessingConfiguration(): ImageProcessingConfiguration;
  40779. private _forceWireframe;
  40780. /**
  40781. * Gets or sets a boolean indicating if all rendering must be done in wireframe
  40782. */
  40783. set forceWireframe(value: boolean);
  40784. get forceWireframe(): boolean;
  40785. private _skipFrustumClipping;
  40786. /**
  40787. * Gets or sets a boolean indicating if we should skip the frustum clipping part of the active meshes selection
  40788. */
  40789. set skipFrustumClipping(value: boolean);
  40790. get skipFrustumClipping(): boolean;
  40791. private _forcePointsCloud;
  40792. /**
  40793. * Gets or sets a boolean indicating if all rendering must be done in point cloud
  40794. */
  40795. set forcePointsCloud(value: boolean);
  40796. get forcePointsCloud(): boolean;
  40797. /**
  40798. * Gets or sets the active clipplane 1
  40799. */
  40800. clipPlane: Nullable<Plane>;
  40801. /**
  40802. * Gets or sets the active clipplane 2
  40803. */
  40804. clipPlane2: Nullable<Plane>;
  40805. /**
  40806. * Gets or sets the active clipplane 3
  40807. */
  40808. clipPlane3: Nullable<Plane>;
  40809. /**
  40810. * Gets or sets the active clipplane 4
  40811. */
  40812. clipPlane4: Nullable<Plane>;
  40813. /**
  40814. * Gets or sets the active clipplane 5
  40815. */
  40816. clipPlane5: Nullable<Plane>;
  40817. /**
  40818. * Gets or sets the active clipplane 6
  40819. */
  40820. clipPlane6: Nullable<Plane>;
  40821. /**
  40822. * Gets or sets a boolean indicating if animations are enabled
  40823. */
  40824. animationsEnabled: boolean;
  40825. private _animationPropertiesOverride;
  40826. /**
  40827. * Gets or sets the animation properties override
  40828. */
  40829. get animationPropertiesOverride(): Nullable<AnimationPropertiesOverride>;
  40830. set animationPropertiesOverride(value: Nullable<AnimationPropertiesOverride>);
  40831. /**
  40832. * Gets or sets a boolean indicating if a constant deltatime has to be used
  40833. * This is mostly useful for testing purposes when you do not want the animations to scale with the framerate
  40834. */
  40835. useConstantAnimationDeltaTime: boolean;
  40836. /**
  40837. * Gets or sets a boolean indicating if the scene must keep the meshUnderPointer property updated
  40838. * Please note that it requires to run a ray cast through the scene on every frame
  40839. */
  40840. constantlyUpdateMeshUnderPointer: boolean;
  40841. /**
  40842. * Defines the HTML cursor to use when hovering over interactive elements
  40843. */
  40844. hoverCursor: string;
  40845. /**
  40846. * Defines the HTML default cursor to use (empty by default)
  40847. */
  40848. defaultCursor: string;
  40849. /**
  40850. * Defines whether cursors are handled by the scene.
  40851. */
  40852. doNotHandleCursors: boolean;
  40853. /**
  40854. * This is used to call preventDefault() on pointer down
  40855. * in order to block unwanted artifacts like system double clicks
  40856. */
  40857. preventDefaultOnPointerDown: boolean;
  40858. /**
  40859. * This is used to call preventDefault() on pointer up
  40860. * in order to block unwanted artifacts like system double clicks
  40861. */
  40862. preventDefaultOnPointerUp: boolean;
  40863. /**
  40864. * Gets or sets user defined metadata
  40865. */
  40866. metadata: any;
  40867. /**
  40868. * For internal use only. Please do not use.
  40869. */
  40870. reservedDataStore: any;
  40871. /**
  40872. * Gets the name of the plugin used to load this scene (null by default)
  40873. */
  40874. loadingPluginName: string;
  40875. /**
  40876. * Use this array to add regular expressions used to disable offline support for specific urls
  40877. */
  40878. disableOfflineSupportExceptionRules: RegExp[];
  40879. /**
  40880. * An event triggered when the scene is disposed.
  40881. */
  40882. onDisposeObservable: Observable<Scene>;
  40883. private _onDisposeObserver;
  40884. /** Sets a function to be executed when this scene is disposed. */
  40885. set onDispose(callback: () => void);
  40886. /**
  40887. * An event triggered before rendering the scene (right after animations and physics)
  40888. */
  40889. onBeforeRenderObservable: Observable<Scene>;
  40890. private _onBeforeRenderObserver;
  40891. /** Sets a function to be executed before rendering this scene */
  40892. set beforeRender(callback: Nullable<() => void>);
  40893. /**
  40894. * An event triggered after rendering the scene
  40895. */
  40896. onAfterRenderObservable: Observable<Scene>;
  40897. /**
  40898. * An event triggered after rendering the scene for an active camera (When scene.render is called this will be called after each camera)
  40899. */
  40900. onAfterRenderCameraObservable: Observable<Camera>;
  40901. private _onAfterRenderObserver;
  40902. /** Sets a function to be executed after rendering this scene */
  40903. set afterRender(callback: Nullable<() => void>);
  40904. /**
  40905. * An event triggered before animating the scene
  40906. */
  40907. onBeforeAnimationsObservable: Observable<Scene>;
  40908. /**
  40909. * An event triggered after animations processing
  40910. */
  40911. onAfterAnimationsObservable: Observable<Scene>;
  40912. /**
  40913. * An event triggered before draw calls are ready to be sent
  40914. */
  40915. onBeforeDrawPhaseObservable: Observable<Scene>;
  40916. /**
  40917. * An event triggered after draw calls have been sent
  40918. */
  40919. onAfterDrawPhaseObservable: Observable<Scene>;
  40920. /**
  40921. * An event triggered when the scene is ready
  40922. */
  40923. onReadyObservable: Observable<Scene>;
  40924. /**
  40925. * An event triggered before rendering a camera
  40926. */
  40927. onBeforeCameraRenderObservable: Observable<Camera>;
  40928. private _onBeforeCameraRenderObserver;
  40929. /** Sets a function to be executed before rendering a camera*/
  40930. set beforeCameraRender(callback: () => void);
  40931. /**
  40932. * An event triggered after rendering a camera
  40933. */
  40934. onAfterCameraRenderObservable: Observable<Camera>;
  40935. private _onAfterCameraRenderObserver;
  40936. /** Sets a function to be executed after rendering a camera*/
  40937. set afterCameraRender(callback: () => void);
  40938. /**
  40939. * An event triggered when active meshes evaluation is about to start
  40940. */
  40941. onBeforeActiveMeshesEvaluationObservable: Observable<Scene>;
  40942. /**
  40943. * An event triggered when active meshes evaluation is done
  40944. */
  40945. onAfterActiveMeshesEvaluationObservable: Observable<Scene>;
  40946. /**
  40947. * An event triggered when particles rendering is about to start
  40948. * Note: This event can be trigger more than once per frame (because particles can be rendered by render target textures as well)
  40949. */
  40950. onBeforeParticlesRenderingObservable: Observable<Scene>;
  40951. /**
  40952. * An event triggered when particles rendering is done
  40953. * Note: This event can be trigger more than once per frame (because particles can be rendered by render target textures as well)
  40954. */
  40955. onAfterParticlesRenderingObservable: Observable<Scene>;
  40956. /**
  40957. * An event triggered when SceneLoader.Append or SceneLoader.Load or SceneLoader.ImportMesh were successfully executed
  40958. */
  40959. onDataLoadedObservable: Observable<Scene>;
  40960. /**
  40961. * An event triggered when a camera is created
  40962. */
  40963. onNewCameraAddedObservable: Observable<Camera>;
  40964. /**
  40965. * An event triggered when a camera is removed
  40966. */
  40967. onCameraRemovedObservable: Observable<Camera>;
  40968. /**
  40969. * An event triggered when a light is created
  40970. */
  40971. onNewLightAddedObservable: Observable<Light>;
  40972. /**
  40973. * An event triggered when a light is removed
  40974. */
  40975. onLightRemovedObservable: Observable<Light>;
  40976. /**
  40977. * An event triggered when a geometry is created
  40978. */
  40979. onNewGeometryAddedObservable: Observable<Geometry>;
  40980. /**
  40981. * An event triggered when a geometry is removed
  40982. */
  40983. onGeometryRemovedObservable: Observable<Geometry>;
  40984. /**
  40985. * An event triggered when a transform node is created
  40986. */
  40987. onNewTransformNodeAddedObservable: Observable<TransformNode>;
  40988. /**
  40989. * An event triggered when a transform node is removed
  40990. */
  40991. onTransformNodeRemovedObservable: Observable<TransformNode>;
  40992. /**
  40993. * An event triggered when a mesh is created
  40994. */
  40995. onNewMeshAddedObservable: Observable<AbstractMesh>;
  40996. /**
  40997. * An event triggered when a mesh is removed
  40998. */
  40999. onMeshRemovedObservable: Observable<AbstractMesh>;
  41000. /**
  41001. * An event triggered when a skeleton is created
  41002. */
  41003. onNewSkeletonAddedObservable: Observable<Skeleton>;
  41004. /**
  41005. * An event triggered when a skeleton is removed
  41006. */
  41007. onSkeletonRemovedObservable: Observable<Skeleton>;
  41008. /**
  41009. * An event triggered when a material is created
  41010. */
  41011. onNewMaterialAddedObservable: Observable<Material>;
  41012. /**
  41013. * An event triggered when a material is removed
  41014. */
  41015. onMaterialRemovedObservable: Observable<Material>;
  41016. /**
  41017. * An event triggered when a texture is created
  41018. */
  41019. onNewTextureAddedObservable: Observable<BaseTexture>;
  41020. /**
  41021. * An event triggered when a texture is removed
  41022. */
  41023. onTextureRemovedObservable: Observable<BaseTexture>;
  41024. /**
  41025. * An event triggered when render targets are about to be rendered
  41026. * Can happen multiple times per frame.
  41027. */
  41028. onBeforeRenderTargetsRenderObservable: Observable<Scene>;
  41029. /**
  41030. * An event triggered when render targets were rendered.
  41031. * Can happen multiple times per frame.
  41032. */
  41033. onAfterRenderTargetsRenderObservable: Observable<Scene>;
  41034. /**
  41035. * An event triggered before calculating deterministic simulation step
  41036. */
  41037. onBeforeStepObservable: Observable<Scene>;
  41038. /**
  41039. * An event triggered after calculating deterministic simulation step
  41040. */
  41041. onAfterStepObservable: Observable<Scene>;
  41042. /**
  41043. * An event triggered when the activeCamera property is updated
  41044. */
  41045. onActiveCameraChanged: Observable<Scene>;
  41046. /**
  41047. * This Observable will be triggered before rendering each renderingGroup of each rendered camera.
  41048. * The RenderinGroupInfo class contains all the information about the context in which the observable is called
  41049. * 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)
  41050. */
  41051. onBeforeRenderingGroupObservable: Observable<RenderingGroupInfo>;
  41052. /**
  41053. * This Observable will be triggered after rendering each renderingGroup of each rendered camera.
  41054. * The RenderinGroupInfo class contains all the information about the context in which the observable is called
  41055. * 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)
  41056. */
  41057. onAfterRenderingGroupObservable: Observable<RenderingGroupInfo>;
  41058. /**
  41059. * This Observable will when a mesh has been imported into the scene.
  41060. */
  41061. onMeshImportedObservable: Observable<AbstractMesh>;
  41062. /**
  41063. * This Observable will when an animation file has been imported into the scene.
  41064. */
  41065. onAnimationFileImportedObservable: Observable<Scene>;
  41066. /**
  41067. * Gets or sets a user defined funtion to select LOD from a mesh and a camera.
  41068. * By default this function is undefined and Babylon.js will select LOD based on distance to camera
  41069. */
  41070. customLODSelector: (mesh: AbstractMesh, camera: Camera) => Nullable<AbstractMesh>;
  41071. /** @hidden */
  41072. _registeredForLateAnimationBindings: SmartArrayNoDuplicate<any>;
  41073. /**
  41074. * Gets or sets a predicate used to select candidate meshes for a pointer down event
  41075. */
  41076. pointerDownPredicate: (Mesh: AbstractMesh) => boolean;
  41077. /**
  41078. * Gets or sets a predicate used to select candidate meshes for a pointer up event
  41079. */
  41080. pointerUpPredicate: (Mesh: AbstractMesh) => boolean;
  41081. /**
  41082. * Gets or sets a predicate used to select candidate meshes for a pointer move event
  41083. */
  41084. pointerMovePredicate: (Mesh: AbstractMesh) => boolean;
  41085. /** Callback called when a pointer move is detected */
  41086. onPointerMove: (evt: PointerEvent, pickInfo: PickingInfo, type: PointerEventTypes) => void;
  41087. /** Callback called when a pointer down is detected */
  41088. onPointerDown: (evt: PointerEvent, pickInfo: PickingInfo, type: PointerEventTypes) => void;
  41089. /** Callback called when a pointer up is detected */
  41090. onPointerUp: (evt: PointerEvent, pickInfo: Nullable<PickingInfo>, type: PointerEventTypes) => void;
  41091. /** Callback called when a pointer pick is detected */
  41092. onPointerPick: (evt: PointerEvent, pickInfo: PickingInfo) => void;
  41093. /**
  41094. * 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).
  41095. * You have the possibility to skip the process and the call to onPointerObservable by setting PointerInfoPre.skipOnPointerObservable to true
  41096. */
  41097. onPrePointerObservable: Observable<PointerInfoPre>;
  41098. /**
  41099. * Observable event triggered each time an input event is received from the rendering canvas
  41100. */
  41101. onPointerObservable: Observable<PointerInfo>;
  41102. /**
  41103. * Gets the pointer coordinates without any translation (ie. straight out of the pointer event)
  41104. */
  41105. get unTranslatedPointer(): Vector2;
  41106. /**
  41107. * Gets or sets the distance in pixel that you have to move to prevent some events. Default is 10 pixels
  41108. */
  41109. static get DragMovementThreshold(): number;
  41110. static set DragMovementThreshold(value: number);
  41111. /**
  41112. * Time in milliseconds to wait to raise long press events if button is still pressed. Default is 500 ms
  41113. */
  41114. static get LongPressDelay(): number;
  41115. static set LongPressDelay(value: number);
  41116. /**
  41117. * Time in milliseconds to wait to raise long press events if button is still pressed. Default is 300 ms
  41118. */
  41119. static get DoubleClickDelay(): number;
  41120. static set DoubleClickDelay(value: number);
  41121. /** If you need to check double click without raising a single click at first click, enable this flag */
  41122. static get ExclusiveDoubleClickMode(): boolean;
  41123. static set ExclusiveDoubleClickMode(value: boolean);
  41124. /** @hidden */
  41125. _mirroredCameraPosition: Nullable<Vector3>;
  41126. /**
  41127. * This observable event is triggered when any keyboard event si raised and registered during Scene.attachControl()
  41128. * You have the possibility to skip the process and the call to onKeyboardObservable by setting KeyboardInfoPre.skipOnPointerObservable to true
  41129. */
  41130. onPreKeyboardObservable: Observable<KeyboardInfoPre>;
  41131. /**
  41132. * Observable event triggered each time an keyboard event is received from the hosting window
  41133. */
  41134. onKeyboardObservable: Observable<KeyboardInfo>;
  41135. private _useRightHandedSystem;
  41136. /**
  41137. * Gets or sets a boolean indicating if the scene must use right-handed coordinates system
  41138. */
  41139. set useRightHandedSystem(value: boolean);
  41140. get useRightHandedSystem(): boolean;
  41141. private _timeAccumulator;
  41142. private _currentStepId;
  41143. private _currentInternalStep;
  41144. /**
  41145. * Sets the step Id used by deterministic lock step
  41146. * @see https://doc.babylonjs.com/babylon101/animations#deterministic-lockstep
  41147. * @param newStepId defines the step Id
  41148. */
  41149. setStepId(newStepId: number): void;
  41150. /**
  41151. * Gets the step Id used by deterministic lock step
  41152. * @see https://doc.babylonjs.com/babylon101/animations#deterministic-lockstep
  41153. * @returns the step Id
  41154. */
  41155. getStepId(): number;
  41156. /**
  41157. * Gets the internal step used by deterministic lock step
  41158. * @see https://doc.babylonjs.com/babylon101/animations#deterministic-lockstep
  41159. * @returns the internal step
  41160. */
  41161. getInternalStep(): number;
  41162. private _fogEnabled;
  41163. /**
  41164. * Gets or sets a boolean indicating if fog is enabled on this scene
  41165. * @see https://doc.babylonjs.com/babylon101/environment#fog
  41166. * (Default is true)
  41167. */
  41168. set fogEnabled(value: boolean);
  41169. get fogEnabled(): boolean;
  41170. private _fogMode;
  41171. /**
  41172. * Gets or sets the fog mode to use
  41173. * @see https://doc.babylonjs.com/babylon101/environment#fog
  41174. * | mode | value |
  41175. * | --- | --- |
  41176. * | FOGMODE_NONE | 0 |
  41177. * | FOGMODE_EXP | 1 |
  41178. * | FOGMODE_EXP2 | 2 |
  41179. * | FOGMODE_LINEAR | 3 |
  41180. */
  41181. set fogMode(value: number);
  41182. get fogMode(): number;
  41183. /**
  41184. * Gets or sets the fog color to use
  41185. * @see https://doc.babylonjs.com/babylon101/environment#fog
  41186. * (Default is Color3(0.2, 0.2, 0.3))
  41187. */
  41188. fogColor: Color3;
  41189. /**
  41190. * Gets or sets the fog density to use
  41191. * @see https://doc.babylonjs.com/babylon101/environment#fog
  41192. * (Default is 0.1)
  41193. */
  41194. fogDensity: number;
  41195. /**
  41196. * Gets or sets the fog start distance to use
  41197. * @see https://doc.babylonjs.com/babylon101/environment#fog
  41198. * (Default is 0)
  41199. */
  41200. fogStart: number;
  41201. /**
  41202. * Gets or sets the fog end distance to use
  41203. * @see https://doc.babylonjs.com/babylon101/environment#fog
  41204. * (Default is 1000)
  41205. */
  41206. fogEnd: number;
  41207. /**
  41208. * Flag indicating that the frame buffer binding is handled by another component
  41209. */
  41210. prePass: boolean;
  41211. private _shadowsEnabled;
  41212. /**
  41213. * Gets or sets a boolean indicating if shadows are enabled on this scene
  41214. */
  41215. set shadowsEnabled(value: boolean);
  41216. get shadowsEnabled(): boolean;
  41217. private _lightsEnabled;
  41218. /**
  41219. * Gets or sets a boolean indicating if lights are enabled on this scene
  41220. */
  41221. set lightsEnabled(value: boolean);
  41222. get lightsEnabled(): boolean;
  41223. /** All of the active cameras added to this scene. */
  41224. activeCameras: Camera[];
  41225. /** @hidden */
  41226. _activeCamera: Nullable<Camera>;
  41227. /** Gets or sets the current active camera */
  41228. get activeCamera(): Nullable<Camera>;
  41229. set activeCamera(value: Nullable<Camera>);
  41230. private _defaultMaterial;
  41231. /** The default material used on meshes when no material is affected */
  41232. get defaultMaterial(): Material;
  41233. /** The default material used on meshes when no material is affected */
  41234. set defaultMaterial(value: Material);
  41235. private _texturesEnabled;
  41236. /**
  41237. * Gets or sets a boolean indicating if textures are enabled on this scene
  41238. */
  41239. set texturesEnabled(value: boolean);
  41240. get texturesEnabled(): boolean;
  41241. /**
  41242. * Gets or sets a boolean indicating if physic engines are enabled on this scene
  41243. */
  41244. physicsEnabled: boolean;
  41245. /**
  41246. * Gets or sets a boolean indicating if particles are enabled on this scene
  41247. */
  41248. particlesEnabled: boolean;
  41249. /**
  41250. * Gets or sets a boolean indicating if sprites are enabled on this scene
  41251. */
  41252. spritesEnabled: boolean;
  41253. private _skeletonsEnabled;
  41254. /**
  41255. * Gets or sets a boolean indicating if skeletons are enabled on this scene
  41256. */
  41257. set skeletonsEnabled(value: boolean);
  41258. get skeletonsEnabled(): boolean;
  41259. /**
  41260. * Gets or sets a boolean indicating if lens flares are enabled on this scene
  41261. */
  41262. lensFlaresEnabled: boolean;
  41263. /**
  41264. * Gets or sets a boolean indicating if collisions are enabled on this scene
  41265. * @see https://doc.babylonjs.com/babylon101/cameras,_mesh_collisions_and_gravity
  41266. */
  41267. collisionsEnabled: boolean;
  41268. private _collisionCoordinator;
  41269. /** @hidden */
  41270. get collisionCoordinator(): ICollisionCoordinator;
  41271. /**
  41272. * Defines the gravity applied to this scene (used only for collisions)
  41273. * @see https://doc.babylonjs.com/babylon101/cameras,_mesh_collisions_and_gravity
  41274. */
  41275. gravity: Vector3;
  41276. /**
  41277. * Gets or sets a boolean indicating if postprocesses are enabled on this scene
  41278. */
  41279. postProcessesEnabled: boolean;
  41280. /**
  41281. * Gets the current postprocess manager
  41282. */
  41283. postProcessManager: PostProcessManager;
  41284. /**
  41285. * Gets or sets a boolean indicating if render targets are enabled on this scene
  41286. */
  41287. renderTargetsEnabled: boolean;
  41288. /**
  41289. * Gets or sets a boolean indicating if next render targets must be dumped as image for debugging purposes
  41290. * We recommend not using it and instead rely on Spector.js: http://spector.babylonjs.com
  41291. */
  41292. dumpNextRenderTargets: boolean;
  41293. /**
  41294. * The list of user defined render targets added to the scene
  41295. */
  41296. customRenderTargets: RenderTargetTexture[];
  41297. /**
  41298. * Defines if texture loading must be delayed
  41299. * If true, textures will only be loaded when they need to be rendered
  41300. */
  41301. useDelayedTextureLoading: boolean;
  41302. /**
  41303. * Gets the list of meshes imported to the scene through SceneLoader
  41304. */
  41305. importedMeshesFiles: String[];
  41306. /**
  41307. * Gets or sets a boolean indicating if probes are enabled on this scene
  41308. */
  41309. probesEnabled: boolean;
  41310. /**
  41311. * Gets or sets the current offline provider to use to store scene data
  41312. * @see https://doc.babylonjs.com/how_to/caching_resources_in_indexeddb
  41313. */
  41314. offlineProvider: IOfflineProvider;
  41315. /**
  41316. * Gets or sets the action manager associated with the scene
  41317. * @see https://doc.babylonjs.com/how_to/how_to_use_actions
  41318. */
  41319. actionManager: AbstractActionManager;
  41320. private _meshesForIntersections;
  41321. /**
  41322. * Gets or sets a boolean indicating if procedural textures are enabled on this scene
  41323. */
  41324. proceduralTexturesEnabled: boolean;
  41325. private _engine;
  41326. private _totalVertices;
  41327. /** @hidden */
  41328. _activeIndices: PerfCounter;
  41329. /** @hidden */
  41330. _activeParticles: PerfCounter;
  41331. /** @hidden */
  41332. _activeBones: PerfCounter;
  41333. private _animationRatio;
  41334. /** @hidden */
  41335. _animationTimeLast: number;
  41336. /** @hidden */
  41337. _animationTime: number;
  41338. /**
  41339. * Gets or sets a general scale for animation speed
  41340. * @see https://www.babylonjs-playground.com/#IBU2W7#3
  41341. */
  41342. animationTimeScale: number;
  41343. /** @hidden */
  41344. _cachedMaterial: Nullable<Material>;
  41345. /** @hidden */
  41346. _cachedEffect: Nullable<Effect>;
  41347. /** @hidden */
  41348. _cachedVisibility: Nullable<number>;
  41349. private _renderId;
  41350. private _frameId;
  41351. private _executeWhenReadyTimeoutId;
  41352. private _intermediateRendering;
  41353. private _viewUpdateFlag;
  41354. private _projectionUpdateFlag;
  41355. /** @hidden */
  41356. _toBeDisposed: Nullable<IDisposable>[];
  41357. private _activeRequests;
  41358. /** @hidden */
  41359. _pendingData: any[];
  41360. private _isDisposed;
  41361. /**
  41362. * Gets or sets a boolean indicating that all submeshes of active meshes must be rendered
  41363. * Use this boolean to avoid computing frustum clipping on submeshes (This could help when you are CPU bound)
  41364. */
  41365. dispatchAllSubMeshesOfActiveMeshes: boolean;
  41366. private _activeMeshes;
  41367. private _processedMaterials;
  41368. private _renderTargets;
  41369. /** @hidden */
  41370. _activeParticleSystems: SmartArray<IParticleSystem>;
  41371. private _activeSkeletons;
  41372. private _softwareSkinnedMeshes;
  41373. private _renderingManager;
  41374. /** @hidden */
  41375. _activeAnimatables: import("babylonjs/Animations/animatable").Animatable[];
  41376. private _transformMatrix;
  41377. private _sceneUbo;
  41378. /** @hidden */
  41379. _viewMatrix: Matrix;
  41380. private _projectionMatrix;
  41381. /** @hidden */
  41382. _forcedViewPosition: Nullable<Vector3>;
  41383. /** @hidden */
  41384. _frustumPlanes: Plane[];
  41385. /**
  41386. * Gets the list of frustum planes (built from the active camera)
  41387. */
  41388. get frustumPlanes(): Plane[];
  41389. /**
  41390. * Gets or sets a boolean indicating if lights must be sorted by priority (off by default)
  41391. * This is useful if there are more lights that the maximum simulteanous authorized
  41392. */
  41393. requireLightSorting: boolean;
  41394. /** @hidden */
  41395. readonly useMaterialMeshMap: boolean;
  41396. /** @hidden */
  41397. readonly useClonedMeshMap: boolean;
  41398. private _externalData;
  41399. private _uid;
  41400. /**
  41401. * @hidden
  41402. * Backing store of defined scene components.
  41403. */
  41404. _components: ISceneComponent[];
  41405. /**
  41406. * @hidden
  41407. * Backing store of defined scene components.
  41408. */
  41409. _serializableComponents: ISceneSerializableComponent[];
  41410. /**
  41411. * List of components to register on the next registration step.
  41412. */
  41413. private _transientComponents;
  41414. /**
  41415. * Registers the transient components if needed.
  41416. */
  41417. private _registerTransientComponents;
  41418. /**
  41419. * @hidden
  41420. * Add a component to the scene.
  41421. * Note that the ccomponent could be registered on th next frame if this is called after
  41422. * the register component stage.
  41423. * @param component Defines the component to add to the scene
  41424. */
  41425. _addComponent(component: ISceneComponent): void;
  41426. /**
  41427. * @hidden
  41428. * Gets a component from the scene.
  41429. * @param name defines the name of the component to retrieve
  41430. * @returns the component or null if not present
  41431. */
  41432. _getComponent(name: string): Nullable<ISceneComponent>;
  41433. /**
  41434. * @hidden
  41435. * Defines the actions happening before camera updates.
  41436. */
  41437. _beforeCameraUpdateStage: Stage<SimpleStageAction>;
  41438. /**
  41439. * @hidden
  41440. * Defines the actions happening before clear the canvas.
  41441. */
  41442. _beforeClearStage: Stage<SimpleStageAction>;
  41443. /**
  41444. * @hidden
  41445. * Defines the actions when collecting render targets for the frame.
  41446. */
  41447. _gatherRenderTargetsStage: Stage<RenderTargetsStageAction>;
  41448. /**
  41449. * @hidden
  41450. * Defines the actions happening for one camera in the frame.
  41451. */
  41452. _gatherActiveCameraRenderTargetsStage: Stage<RenderTargetsStageAction>;
  41453. /**
  41454. * @hidden
  41455. * Defines the actions happening during the per mesh ready checks.
  41456. */
  41457. _isReadyForMeshStage: Stage<MeshStageAction>;
  41458. /**
  41459. * @hidden
  41460. * Defines the actions happening before evaluate active mesh checks.
  41461. */
  41462. _beforeEvaluateActiveMeshStage: Stage<SimpleStageAction>;
  41463. /**
  41464. * @hidden
  41465. * Defines the actions happening during the evaluate sub mesh checks.
  41466. */
  41467. _evaluateSubMeshStage: Stage<EvaluateSubMeshStageAction>;
  41468. /**
  41469. * @hidden
  41470. * Defines the actions happening during the active mesh stage.
  41471. */
  41472. _activeMeshStage: Stage<ActiveMeshStageAction>;
  41473. /**
  41474. * @hidden
  41475. * Defines the actions happening during the per camera render target step.
  41476. */
  41477. _cameraDrawRenderTargetStage: Stage<CameraStageFrameBufferAction>;
  41478. /**
  41479. * @hidden
  41480. * Defines the actions happening just before the active camera is drawing.
  41481. */
  41482. _beforeCameraDrawStage: Stage<CameraStageAction>;
  41483. /**
  41484. * @hidden
  41485. * Defines the actions happening just before a render target is drawing.
  41486. */
  41487. _beforeRenderTargetDrawStage: Stage<RenderTargetStageAction>;
  41488. /**
  41489. * @hidden
  41490. * Defines the actions happening just before a rendering group is drawing.
  41491. */
  41492. _beforeRenderingGroupDrawStage: Stage<RenderingGroupStageAction>;
  41493. /**
  41494. * @hidden
  41495. * Defines the actions happening just before a mesh is drawing.
  41496. */
  41497. _beforeRenderingMeshStage: Stage<RenderingMeshStageAction>;
  41498. /**
  41499. * @hidden
  41500. * Defines the actions happening just after a mesh has been drawn.
  41501. */
  41502. _afterRenderingMeshStage: Stage<RenderingMeshStageAction>;
  41503. /**
  41504. * @hidden
  41505. * Defines the actions happening just after a rendering group has been drawn.
  41506. */
  41507. _afterRenderingGroupDrawStage: Stage<RenderingGroupStageAction>;
  41508. /**
  41509. * @hidden
  41510. * Defines the actions happening just after the active camera has been drawn.
  41511. */
  41512. _afterCameraDrawStage: Stage<CameraStageAction>;
  41513. /**
  41514. * @hidden
  41515. * Defines the actions happening just after a render target has been drawn.
  41516. */
  41517. _afterRenderTargetDrawStage: Stage<RenderTargetStageAction>;
  41518. /**
  41519. * @hidden
  41520. * Defines the actions happening just after rendering all cameras and computing intersections.
  41521. */
  41522. _afterRenderStage: Stage<SimpleStageAction>;
  41523. /**
  41524. * @hidden
  41525. * Defines the actions happening when a pointer move event happens.
  41526. */
  41527. _pointerMoveStage: Stage<PointerMoveStageAction>;
  41528. /**
  41529. * @hidden
  41530. * Defines the actions happening when a pointer down event happens.
  41531. */
  41532. _pointerDownStage: Stage<PointerUpDownStageAction>;
  41533. /**
  41534. * @hidden
  41535. * Defines the actions happening when a pointer up event happens.
  41536. */
  41537. _pointerUpStage: Stage<PointerUpDownStageAction>;
  41538. /**
  41539. * an optional map from Geometry Id to Geometry index in the 'geometries' array
  41540. */
  41541. private geometriesByUniqueId;
  41542. /**
  41543. * Creates a new Scene
  41544. * @param engine defines the engine to use to render this scene
  41545. * @param options defines the scene options
  41546. */
  41547. constructor(engine: Engine, options?: SceneOptions);
  41548. /**
  41549. * Gets a string identifying the name of the class
  41550. * @returns "Scene" string
  41551. */
  41552. getClassName(): string;
  41553. private _defaultMeshCandidates;
  41554. /**
  41555. * @hidden
  41556. */
  41557. _getDefaultMeshCandidates(): ISmartArrayLike<AbstractMesh>;
  41558. private _defaultSubMeshCandidates;
  41559. /**
  41560. * @hidden
  41561. */
  41562. _getDefaultSubMeshCandidates(mesh: AbstractMesh): ISmartArrayLike<SubMesh>;
  41563. /**
  41564. * Sets the default candidate providers for the scene.
  41565. * This sets the getActiveMeshCandidates, getActiveSubMeshCandidates, getIntersectingSubMeshCandidates
  41566. * and getCollidingSubMeshCandidates to their default function
  41567. */
  41568. setDefaultCandidateProviders(): void;
  41569. /**
  41570. * Gets the mesh that is currently under the pointer
  41571. */
  41572. get meshUnderPointer(): Nullable<AbstractMesh>;
  41573. /**
  41574. * Gets or sets the current on-screen X position of the pointer
  41575. */
  41576. get pointerX(): number;
  41577. set pointerX(value: number);
  41578. /**
  41579. * Gets or sets the current on-screen Y position of the pointer
  41580. */
  41581. get pointerY(): number;
  41582. set pointerY(value: number);
  41583. /**
  41584. * Gets the cached material (ie. the latest rendered one)
  41585. * @returns the cached material
  41586. */
  41587. getCachedMaterial(): Nullable<Material>;
  41588. /**
  41589. * Gets the cached effect (ie. the latest rendered one)
  41590. * @returns the cached effect
  41591. */
  41592. getCachedEffect(): Nullable<Effect>;
  41593. /**
  41594. * Gets the cached visibility state (ie. the latest rendered one)
  41595. * @returns the cached visibility state
  41596. */
  41597. getCachedVisibility(): Nullable<number>;
  41598. /**
  41599. * Gets a boolean indicating if the current material / effect / visibility must be bind again
  41600. * @param material defines the current material
  41601. * @param effect defines the current effect
  41602. * @param visibility defines the current visibility state
  41603. * @returns true if one parameter is not cached
  41604. */
  41605. isCachedMaterialInvalid(material: Material, effect: Effect, visibility?: number): boolean;
  41606. /**
  41607. * Gets the engine associated with the scene
  41608. * @returns an Engine
  41609. */
  41610. getEngine(): Engine;
  41611. /**
  41612. * Gets the total number of vertices rendered per frame
  41613. * @returns the total number of vertices rendered per frame
  41614. */
  41615. getTotalVertices(): number;
  41616. /**
  41617. * Gets the performance counter for total vertices
  41618. * @see https://doc.babylonjs.com/how_to/optimizing_your_scene#instrumentation
  41619. */
  41620. get totalVerticesPerfCounter(): PerfCounter;
  41621. /**
  41622. * Gets the total number of active indices rendered per frame (You can deduce the number of rendered triangles by dividing this number by 3)
  41623. * @returns the total number of active indices rendered per frame
  41624. */
  41625. getActiveIndices(): number;
  41626. /**
  41627. * Gets the performance counter for active indices
  41628. * @see https://doc.babylonjs.com/how_to/optimizing_your_scene#instrumentation
  41629. */
  41630. get totalActiveIndicesPerfCounter(): PerfCounter;
  41631. /**
  41632. * Gets the total number of active particles rendered per frame
  41633. * @returns the total number of active particles rendered per frame
  41634. */
  41635. getActiveParticles(): number;
  41636. /**
  41637. * Gets the performance counter for active particles
  41638. * @see https://doc.babylonjs.com/how_to/optimizing_your_scene#instrumentation
  41639. */
  41640. get activeParticlesPerfCounter(): PerfCounter;
  41641. /**
  41642. * Gets the total number of active bones rendered per frame
  41643. * @returns the total number of active bones rendered per frame
  41644. */
  41645. getActiveBones(): number;
  41646. /**
  41647. * Gets the performance counter for active bones
  41648. * @see https://doc.babylonjs.com/how_to/optimizing_your_scene#instrumentation
  41649. */
  41650. get activeBonesPerfCounter(): PerfCounter;
  41651. /**
  41652. * Gets the array of active meshes
  41653. * @returns an array of AbstractMesh
  41654. */
  41655. getActiveMeshes(): SmartArray<AbstractMesh>;
  41656. /**
  41657. * Gets the animation ratio (which is 1.0 is the scene renders at 60fps and 2 if the scene renders at 30fps, etc.)
  41658. * @returns a number
  41659. */
  41660. getAnimationRatio(): number;
  41661. /**
  41662. * Gets an unique Id for the current render phase
  41663. * @returns a number
  41664. */
  41665. getRenderId(): number;
  41666. /**
  41667. * Gets an unique Id for the current frame
  41668. * @returns a number
  41669. */
  41670. getFrameId(): number;
  41671. /** Call this function if you want to manually increment the render Id*/
  41672. incrementRenderId(): void;
  41673. private _createUbo;
  41674. /**
  41675. * Use this method to simulate a pointer move on a mesh
  41676. * The pickResult parameter can be obtained from a scene.pick or scene.pickWithRay
  41677. * @param pickResult pickingInfo of the object wished to simulate pointer event on
  41678. * @param pointerEventInit pointer event state to be used when simulating the pointer event (eg. pointer id for multitouch)
  41679. * @returns the current scene
  41680. */
  41681. simulatePointerMove(pickResult: PickingInfo, pointerEventInit?: PointerEventInit): Scene;
  41682. /**
  41683. * Use this method to simulate a pointer down on a mesh
  41684. * The pickResult parameter can be obtained from a scene.pick or scene.pickWithRay
  41685. * @param pickResult pickingInfo of the object wished to simulate pointer event on
  41686. * @param pointerEventInit pointer event state to be used when simulating the pointer event (eg. pointer id for multitouch)
  41687. * @returns the current scene
  41688. */
  41689. simulatePointerDown(pickResult: PickingInfo, pointerEventInit?: PointerEventInit): Scene;
  41690. /**
  41691. * Use this method to simulate a pointer up on a mesh
  41692. * The pickResult parameter can be obtained from a scene.pick or scene.pickWithRay
  41693. * @param pickResult pickingInfo of the object wished to simulate pointer event on
  41694. * @param pointerEventInit pointer event state to be used when simulating the pointer event (eg. pointer id for multitouch)
  41695. * @param doubleTap indicates that the pointer up event should be considered as part of a double click (false by default)
  41696. * @returns the current scene
  41697. */
  41698. simulatePointerUp(pickResult: PickingInfo, pointerEventInit?: PointerEventInit, doubleTap?: boolean): Scene;
  41699. /**
  41700. * Gets a boolean indicating if the current pointer event is captured (meaning that the scene has already handled the pointer down)
  41701. * @param pointerId defines the pointer id to use in a multi-touch scenario (0 by default)
  41702. * @returns true if the pointer was captured
  41703. */
  41704. isPointerCaptured(pointerId?: number): boolean;
  41705. /**
  41706. * Attach events to the canvas (To handle actionManagers triggers and raise onPointerMove, onPointerDown and onPointerUp
  41707. * @param attachUp defines if you want to attach events to pointerup
  41708. * @param attachDown defines if you want to attach events to pointerdown
  41709. * @param attachMove defines if you want to attach events to pointermove
  41710. */
  41711. attachControl(attachUp?: boolean, attachDown?: boolean, attachMove?: boolean): void;
  41712. /** Detaches all event handlers*/
  41713. detachControl(): void;
  41714. /**
  41715. * This function will check if the scene can be rendered (textures are loaded, shaders are compiled)
  41716. * Delay loaded resources are not taking in account
  41717. * @return true if all required resources are ready
  41718. */
  41719. isReady(): boolean;
  41720. /** Resets all cached information relative to material (including effect and visibility) */
  41721. resetCachedMaterial(): void;
  41722. /**
  41723. * Registers a function to be called before every frame render
  41724. * @param func defines the function to register
  41725. */
  41726. registerBeforeRender(func: () => void): void;
  41727. /**
  41728. * Unregisters a function called before every frame render
  41729. * @param func defines the function to unregister
  41730. */
  41731. unregisterBeforeRender(func: () => void): void;
  41732. /**
  41733. * Registers a function to be called after every frame render
  41734. * @param func defines the function to register
  41735. */
  41736. registerAfterRender(func: () => void): void;
  41737. /**
  41738. * Unregisters a function called after every frame render
  41739. * @param func defines the function to unregister
  41740. */
  41741. unregisterAfterRender(func: () => void): void;
  41742. private _executeOnceBeforeRender;
  41743. /**
  41744. * The provided function will run before render once and will be disposed afterwards.
  41745. * A timeout delay can be provided so that the function will be executed in N ms.
  41746. * The timeout is using the browser's native setTimeout so time percision cannot be guaranteed.
  41747. * @param func The function to be executed.
  41748. * @param timeout optional delay in ms
  41749. */
  41750. executeOnceBeforeRender(func: () => void, timeout?: number): void;
  41751. /** @hidden */
  41752. _addPendingData(data: any): void;
  41753. /** @hidden */
  41754. _removePendingData(data: any): void;
  41755. /**
  41756. * Returns the number of items waiting to be loaded
  41757. * @returns the number of items waiting to be loaded
  41758. */
  41759. getWaitingItemsCount(): number;
  41760. /**
  41761. * Returns a boolean indicating if the scene is still loading data
  41762. */
  41763. get isLoading(): boolean;
  41764. /**
  41765. * Registers a function to be executed when the scene is ready
  41766. * @param {Function} func - the function to be executed
  41767. */
  41768. executeWhenReady(func: () => void): void;
  41769. /**
  41770. * Returns a promise that resolves when the scene is ready
  41771. * @returns A promise that resolves when the scene is ready
  41772. */
  41773. whenReadyAsync(): Promise<void>;
  41774. /** @hidden */
  41775. _checkIsReady(): void;
  41776. /**
  41777. * Gets all animatable attached to the scene
  41778. */
  41779. get animatables(): Animatable[];
  41780. /**
  41781. * Resets the last animation time frame.
  41782. * Useful to override when animations start running when loading a scene for the first time.
  41783. */
  41784. resetLastAnimationTimeFrame(): void;
  41785. /**
  41786. * Gets the current view matrix
  41787. * @returns a Matrix
  41788. */
  41789. getViewMatrix(): Matrix;
  41790. /**
  41791. * Gets the current projection matrix
  41792. * @returns a Matrix
  41793. */
  41794. getProjectionMatrix(): Matrix;
  41795. /**
  41796. * Gets the current transform matrix
  41797. * @returns a Matrix made of View * Projection
  41798. */
  41799. getTransformMatrix(): Matrix;
  41800. /**
  41801. * Sets the current transform matrix
  41802. * @param viewL defines the View matrix to use
  41803. * @param projectionL defines the Projection matrix to use
  41804. * @param viewR defines the right View matrix to use (if provided)
  41805. * @param projectionR defines the right Projection matrix to use (if provided)
  41806. */
  41807. setTransformMatrix(viewL: Matrix, projectionL: Matrix, viewR?: Matrix, projectionR?: Matrix): void;
  41808. /**
  41809. * Gets the uniform buffer used to store scene data
  41810. * @returns a UniformBuffer
  41811. */
  41812. getSceneUniformBuffer(): UniformBuffer;
  41813. /**
  41814. * Gets an unique (relatively to the current scene) Id
  41815. * @returns an unique number for the scene
  41816. */
  41817. getUniqueId(): number;
  41818. /**
  41819. * Add a mesh to the list of scene's meshes
  41820. * @param newMesh defines the mesh to add
  41821. * @param recursive if all child meshes should also be added to the scene
  41822. */
  41823. addMesh(newMesh: AbstractMesh, recursive?: boolean): void;
  41824. /**
  41825. * Remove a mesh for the list of scene's meshes
  41826. * @param toRemove defines the mesh to remove
  41827. * @param recursive if all child meshes should also be removed from the scene
  41828. * @returns the index where the mesh was in the mesh list
  41829. */
  41830. removeMesh(toRemove: AbstractMesh, recursive?: boolean): number;
  41831. /**
  41832. * Add a transform node to the list of scene's transform nodes
  41833. * @param newTransformNode defines the transform node to add
  41834. */
  41835. addTransformNode(newTransformNode: TransformNode): void;
  41836. /**
  41837. * Remove a transform node for the list of scene's transform nodes
  41838. * @param toRemove defines the transform node to remove
  41839. * @returns the index where the transform node was in the transform node list
  41840. */
  41841. removeTransformNode(toRemove: TransformNode): number;
  41842. /**
  41843. * Remove a skeleton for the list of scene's skeletons
  41844. * @param toRemove defines the skeleton to remove
  41845. * @returns the index where the skeleton was in the skeleton list
  41846. */
  41847. removeSkeleton(toRemove: Skeleton): number;
  41848. /**
  41849. * Remove a morph target for the list of scene's morph targets
  41850. * @param toRemove defines the morph target to remove
  41851. * @returns the index where the morph target was in the morph target list
  41852. */
  41853. removeMorphTargetManager(toRemove: MorphTargetManager): number;
  41854. /**
  41855. * Remove a light for the list of scene's lights
  41856. * @param toRemove defines the light to remove
  41857. * @returns the index where the light was in the light list
  41858. */
  41859. removeLight(toRemove: Light): number;
  41860. /**
  41861. * Remove a camera for the list of scene's cameras
  41862. * @param toRemove defines the camera to remove
  41863. * @returns the index where the camera was in the camera list
  41864. */
  41865. removeCamera(toRemove: Camera): number;
  41866. /**
  41867. * Remove a particle system for the list of scene's particle systems
  41868. * @param toRemove defines the particle system to remove
  41869. * @returns the index where the particle system was in the particle system list
  41870. */
  41871. removeParticleSystem(toRemove: IParticleSystem): number;
  41872. /**
  41873. * Remove a animation for the list of scene's animations
  41874. * @param toRemove defines the animation to remove
  41875. * @returns the index where the animation was in the animation list
  41876. */
  41877. removeAnimation(toRemove: Animation): number;
  41878. /**
  41879. * Will stop the animation of the given target
  41880. * @param target - the target
  41881. * @param animationName - the name of the animation to stop (all animations will be stopped if both this and targetMask are empty)
  41882. * @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)
  41883. */
  41884. stopAnimation(target: any, animationName?: string, targetMask?: (target: any) => boolean): void;
  41885. /**
  41886. * Removes the given animation group from this scene.
  41887. * @param toRemove The animation group to remove
  41888. * @returns The index of the removed animation group
  41889. */
  41890. removeAnimationGroup(toRemove: AnimationGroup): number;
  41891. /**
  41892. * Removes the given multi-material from this scene.
  41893. * @param toRemove The multi-material to remove
  41894. * @returns The index of the removed multi-material
  41895. */
  41896. removeMultiMaterial(toRemove: MultiMaterial): number;
  41897. /**
  41898. * Removes the given material from this scene.
  41899. * @param toRemove The material to remove
  41900. * @returns The index of the removed material
  41901. */
  41902. removeMaterial(toRemove: Material): number;
  41903. /**
  41904. * Removes the given action manager from this scene.
  41905. * @param toRemove The action manager to remove
  41906. * @returns The index of the removed action manager
  41907. */
  41908. removeActionManager(toRemove: AbstractActionManager): number;
  41909. /**
  41910. * Removes the given texture from this scene.
  41911. * @param toRemove The texture to remove
  41912. * @returns The index of the removed texture
  41913. */
  41914. removeTexture(toRemove: BaseTexture): number;
  41915. /**
  41916. * Adds the given light to this scene
  41917. * @param newLight The light to add
  41918. */
  41919. addLight(newLight: Light): void;
  41920. /**
  41921. * Sorts the list list based on light priorities
  41922. */
  41923. sortLightsByPriority(): void;
  41924. /**
  41925. * Adds the given camera to this scene
  41926. * @param newCamera The camera to add
  41927. */
  41928. addCamera(newCamera: Camera): void;
  41929. /**
  41930. * Adds the given skeleton to this scene
  41931. * @param newSkeleton The skeleton to add
  41932. */
  41933. addSkeleton(newSkeleton: Skeleton): void;
  41934. /**
  41935. * Adds the given particle system to this scene
  41936. * @param newParticleSystem The particle system to add
  41937. */
  41938. addParticleSystem(newParticleSystem: IParticleSystem): void;
  41939. /**
  41940. * Adds the given animation to this scene
  41941. * @param newAnimation The animation to add
  41942. */
  41943. addAnimation(newAnimation: Animation): void;
  41944. /**
  41945. * Adds the given animation group to this scene.
  41946. * @param newAnimationGroup The animation group to add
  41947. */
  41948. addAnimationGroup(newAnimationGroup: AnimationGroup): void;
  41949. /**
  41950. * Adds the given multi-material to this scene
  41951. * @param newMultiMaterial The multi-material to add
  41952. */
  41953. addMultiMaterial(newMultiMaterial: MultiMaterial): void;
  41954. /**
  41955. * Adds the given material to this scene
  41956. * @param newMaterial The material to add
  41957. */
  41958. addMaterial(newMaterial: Material): void;
  41959. /**
  41960. * Adds the given morph target to this scene
  41961. * @param newMorphTargetManager The morph target to add
  41962. */
  41963. addMorphTargetManager(newMorphTargetManager: MorphTargetManager): void;
  41964. /**
  41965. * Adds the given geometry to this scene
  41966. * @param newGeometry The geometry to add
  41967. */
  41968. addGeometry(newGeometry: Geometry): void;
  41969. /**
  41970. * Adds the given action manager to this scene
  41971. * @param newActionManager The action manager to add
  41972. */
  41973. addActionManager(newActionManager: AbstractActionManager): void;
  41974. /**
  41975. * Adds the given texture to this scene.
  41976. * @param newTexture The texture to add
  41977. */
  41978. addTexture(newTexture: BaseTexture): void;
  41979. /**
  41980. * Switch active camera
  41981. * @param newCamera defines the new active camera
  41982. * @param attachControl defines if attachControl must be called for the new active camera (default: true)
  41983. */
  41984. switchActiveCamera(newCamera: Camera, attachControl?: boolean): void;
  41985. /**
  41986. * sets the active camera of the scene using its ID
  41987. * @param id defines the camera's ID
  41988. * @return the new active camera or null if none found.
  41989. */
  41990. setActiveCameraByID(id: string): Nullable<Camera>;
  41991. /**
  41992. * sets the active camera of the scene using its name
  41993. * @param name defines the camera's name
  41994. * @returns the new active camera or null if none found.
  41995. */
  41996. setActiveCameraByName(name: string): Nullable<Camera>;
  41997. /**
  41998. * get an animation group using its name
  41999. * @param name defines the material's name
  42000. * @return the animation group or null if none found.
  42001. */
  42002. getAnimationGroupByName(name: string): Nullable<AnimationGroup>;
  42003. /**
  42004. * Get a material using its unique id
  42005. * @param uniqueId defines the material's unique id
  42006. * @return the material or null if none found.
  42007. */
  42008. getMaterialByUniqueID(uniqueId: number): Nullable<Material>;
  42009. /**
  42010. * get a material using its id
  42011. * @param id defines the material's ID
  42012. * @return the material or null if none found.
  42013. */
  42014. getMaterialByID(id: string): Nullable<Material>;
  42015. /**
  42016. * Gets a the last added material using a given id
  42017. * @param id defines the material's ID
  42018. * @return the last material with the given id or null if none found.
  42019. */
  42020. getLastMaterialByID(id: string): Nullable<Material>;
  42021. /**
  42022. * Gets a material using its name
  42023. * @param name defines the material's name
  42024. * @return the material or null if none found.
  42025. */
  42026. getMaterialByName(name: string): Nullable<Material>;
  42027. /**
  42028. * Get a texture using its unique id
  42029. * @param uniqueId defines the texture's unique id
  42030. * @return the texture or null if none found.
  42031. */
  42032. getTextureByUniqueID(uniqueId: number): Nullable<BaseTexture>;
  42033. /**
  42034. * Gets a camera using its id
  42035. * @param id defines the id to look for
  42036. * @returns the camera or null if not found
  42037. */
  42038. getCameraByID(id: string): Nullable<Camera>;
  42039. /**
  42040. * Gets a camera using its unique id
  42041. * @param uniqueId defines the unique id to look for
  42042. * @returns the camera or null if not found
  42043. */
  42044. getCameraByUniqueID(uniqueId: number): Nullable<Camera>;
  42045. /**
  42046. * Gets a camera using its name
  42047. * @param name defines the camera's name
  42048. * @return the camera or null if none found.
  42049. */
  42050. getCameraByName(name: string): Nullable<Camera>;
  42051. /**
  42052. * Gets a bone using its id
  42053. * @param id defines the bone's id
  42054. * @return the bone or null if not found
  42055. */
  42056. getBoneByID(id: string): Nullable<Bone>;
  42057. /**
  42058. * Gets a bone using its id
  42059. * @param name defines the bone's name
  42060. * @return the bone or null if not found
  42061. */
  42062. getBoneByName(name: string): Nullable<Bone>;
  42063. /**
  42064. * Gets a light node using its name
  42065. * @param name defines the the light's name
  42066. * @return the light or null if none found.
  42067. */
  42068. getLightByName(name: string): Nullable<Light>;
  42069. /**
  42070. * Gets a light node using its id
  42071. * @param id defines the light's id
  42072. * @return the light or null if none found.
  42073. */
  42074. getLightByID(id: string): Nullable<Light>;
  42075. /**
  42076. * Gets a light node using its scene-generated unique ID
  42077. * @param uniqueId defines the light's unique id
  42078. * @return the light or null if none found.
  42079. */
  42080. getLightByUniqueID(uniqueId: number): Nullable<Light>;
  42081. /**
  42082. * Gets a particle system by id
  42083. * @param id defines the particle system id
  42084. * @return the corresponding system or null if none found
  42085. */
  42086. getParticleSystemByID(id: string): Nullable<IParticleSystem>;
  42087. /**
  42088. * Gets a geometry using its ID
  42089. * @param id defines the geometry's id
  42090. * @return the geometry or null if none found.
  42091. */
  42092. getGeometryByID(id: string): Nullable<Geometry>;
  42093. private _getGeometryByUniqueID;
  42094. /**
  42095. * Add a new geometry to this scene
  42096. * @param geometry defines the geometry to be added to the scene.
  42097. * @param force defines if the geometry must be pushed even if a geometry with this id already exists
  42098. * @return a boolean defining if the geometry was added or not
  42099. */
  42100. pushGeometry(geometry: Geometry, force?: boolean): boolean;
  42101. /**
  42102. * Removes an existing geometry
  42103. * @param geometry defines the geometry to be removed from the scene
  42104. * @return a boolean defining if the geometry was removed or not
  42105. */
  42106. removeGeometry(geometry: Geometry): boolean;
  42107. /**
  42108. * Gets the list of geometries attached to the scene
  42109. * @returns an array of Geometry
  42110. */
  42111. getGeometries(): Geometry[];
  42112. /**
  42113. * Gets the first added mesh found of a given ID
  42114. * @param id defines the id to search for
  42115. * @return the mesh found or null if not found at all
  42116. */
  42117. getMeshByID(id: string): Nullable<AbstractMesh>;
  42118. /**
  42119. * Gets a list of meshes using their id
  42120. * @param id defines the id to search for
  42121. * @returns a list of meshes
  42122. */
  42123. getMeshesByID(id: string): Array<AbstractMesh>;
  42124. /**
  42125. * Gets the first added transform node found of a given ID
  42126. * @param id defines the id to search for
  42127. * @return the found transform node or null if not found at all.
  42128. */
  42129. getTransformNodeByID(id: string): Nullable<TransformNode>;
  42130. /**
  42131. * Gets a transform node with its auto-generated unique id
  42132. * @param uniqueId efines the unique id to search for
  42133. * @return the found transform node or null if not found at all.
  42134. */
  42135. getTransformNodeByUniqueID(uniqueId: number): Nullable<TransformNode>;
  42136. /**
  42137. * Gets a list of transform nodes using their id
  42138. * @param id defines the id to search for
  42139. * @returns a list of transform nodes
  42140. */
  42141. getTransformNodesByID(id: string): Array<TransformNode>;
  42142. /**
  42143. * Gets a mesh with its auto-generated unique id
  42144. * @param uniqueId defines the unique id to search for
  42145. * @return the found mesh or null if not found at all.
  42146. */
  42147. getMeshByUniqueID(uniqueId: number): Nullable<AbstractMesh>;
  42148. /**
  42149. * Gets a the last added mesh using a given id
  42150. * @param id defines the id to search for
  42151. * @return the found mesh or null if not found at all.
  42152. */
  42153. getLastMeshByID(id: string): Nullable<AbstractMesh>;
  42154. /**
  42155. * Gets a the last added node (Mesh, Camera, Light) using a given id
  42156. * @param id defines the id to search for
  42157. * @return the found node or null if not found at all
  42158. */
  42159. getLastEntryByID(id: string): Nullable<Node>;
  42160. /**
  42161. * Gets a node (Mesh, Camera, Light) using a given id
  42162. * @param id defines the id to search for
  42163. * @return the found node or null if not found at all
  42164. */
  42165. getNodeByID(id: string): Nullable<Node>;
  42166. /**
  42167. * Gets a node (Mesh, Camera, Light) using a given name
  42168. * @param name defines the name to search for
  42169. * @return the found node or null if not found at all.
  42170. */
  42171. getNodeByName(name: string): Nullable<Node>;
  42172. /**
  42173. * Gets a mesh using a given name
  42174. * @param name defines the name to search for
  42175. * @return the found mesh or null if not found at all.
  42176. */
  42177. getMeshByName(name: string): Nullable<AbstractMesh>;
  42178. /**
  42179. * Gets a transform node using a given name
  42180. * @param name defines the name to search for
  42181. * @return the found transform node or null if not found at all.
  42182. */
  42183. getTransformNodeByName(name: string): Nullable<TransformNode>;
  42184. /**
  42185. * Gets a skeleton using a given id (if many are found, this function will pick the last one)
  42186. * @param id defines the id to search for
  42187. * @return the found skeleton or null if not found at all.
  42188. */
  42189. getLastSkeletonByID(id: string): Nullable<Skeleton>;
  42190. /**
  42191. * Gets a skeleton using a given auto generated unique id
  42192. * @param uniqueId defines the unique id to search for
  42193. * @return the found skeleton or null if not found at all.
  42194. */
  42195. getSkeletonByUniqueId(uniqueId: number): Nullable<Skeleton>;
  42196. /**
  42197. * Gets a skeleton using a given id (if many are found, this function will pick the first one)
  42198. * @param id defines the id to search for
  42199. * @return the found skeleton or null if not found at all.
  42200. */
  42201. getSkeletonById(id: string): Nullable<Skeleton>;
  42202. /**
  42203. * Gets a skeleton using a given name
  42204. * @param name defines the name to search for
  42205. * @return the found skeleton or null if not found at all.
  42206. */
  42207. getSkeletonByName(name: string): Nullable<Skeleton>;
  42208. /**
  42209. * Gets a morph target manager using a given id (if many are found, this function will pick the last one)
  42210. * @param id defines the id to search for
  42211. * @return the found morph target manager or null if not found at all.
  42212. */
  42213. getMorphTargetManagerById(id: number): Nullable<MorphTargetManager>;
  42214. /**
  42215. * Gets a morph target using a given id (if many are found, this function will pick the first one)
  42216. * @param id defines the id to search for
  42217. * @return the found morph target or null if not found at all.
  42218. */
  42219. getMorphTargetById(id: string): Nullable<MorphTarget>;
  42220. /**
  42221. * Gets a morph target using a given name (if many are found, this function will pick the first one)
  42222. * @param name defines the name to search for
  42223. * @return the found morph target or null if not found at all.
  42224. */
  42225. getMorphTargetByName(name: string): Nullable<MorphTarget>;
  42226. /**
  42227. * Gets a post process using a given name (if many are found, this function will pick the first one)
  42228. * @param name defines the name to search for
  42229. * @return the found post process or null if not found at all.
  42230. */
  42231. getPostProcessByName(name: string): Nullable<PostProcess>;
  42232. /**
  42233. * Gets a boolean indicating if the given mesh is active
  42234. * @param mesh defines the mesh to look for
  42235. * @returns true if the mesh is in the active list
  42236. */
  42237. isActiveMesh(mesh: AbstractMesh): boolean;
  42238. /**
  42239. * Return a unique id as a string which can serve as an identifier for the scene
  42240. */
  42241. get uid(): string;
  42242. /**
  42243. * Add an externaly attached data from its key.
  42244. * This method call will fail and return false, if such key already exists.
  42245. * If you don't care and just want to get the data no matter what, use the more convenient getOrAddExternalDataWithFactory() method.
  42246. * @param key the unique key that identifies the data
  42247. * @param data the data object to associate to the key for this Engine instance
  42248. * @return true if no such key were already present and the data was added successfully, false otherwise
  42249. */
  42250. addExternalData<T>(key: string, data: T): boolean;
  42251. /**
  42252. * Get an externaly attached data from its key
  42253. * @param key the unique key that identifies the data
  42254. * @return the associated data, if present (can be null), or undefined if not present
  42255. */
  42256. getExternalData<T>(key: string): Nullable<T>;
  42257. /**
  42258. * Get an externaly attached data from its key, create it using a factory if it's not already present
  42259. * @param key the unique key that identifies the data
  42260. * @param factory the factory that will be called to create the instance if and only if it doesn't exists
  42261. * @return the associated data, can be null if the factory returned null.
  42262. */
  42263. getOrAddExternalDataWithFactory<T>(key: string, factory: (k: string) => T): T;
  42264. /**
  42265. * Remove an externaly attached data from the Engine instance
  42266. * @param key the unique key that identifies the data
  42267. * @return true if the data was successfully removed, false if it doesn't exist
  42268. */
  42269. removeExternalData(key: string): boolean;
  42270. private _evaluateSubMesh;
  42271. /**
  42272. * Clear the processed materials smart array preventing retention point in material dispose.
  42273. */
  42274. freeProcessedMaterials(): void;
  42275. private _preventFreeActiveMeshesAndRenderingGroups;
  42276. /** Gets or sets a boolean blocking all the calls to freeActiveMeshes and freeRenderingGroups
  42277. * It can be used in order to prevent going through methods freeRenderingGroups and freeActiveMeshes several times to improve performance
  42278. * when disposing several meshes in a row or a hierarchy of meshes.
  42279. * When used, it is the responsability of the user to blockfreeActiveMeshesAndRenderingGroups back to false.
  42280. */
  42281. get blockfreeActiveMeshesAndRenderingGroups(): boolean;
  42282. set blockfreeActiveMeshesAndRenderingGroups(value: boolean);
  42283. /**
  42284. * Clear the active meshes smart array preventing retention point in mesh dispose.
  42285. */
  42286. freeActiveMeshes(): void;
  42287. /**
  42288. * Clear the info related to rendering groups preventing retention points during dispose.
  42289. */
  42290. freeRenderingGroups(): void;
  42291. /** @hidden */
  42292. _isInIntermediateRendering(): boolean;
  42293. /**
  42294. * Lambda returning the list of potentially active meshes.
  42295. */
  42296. getActiveMeshCandidates: () => ISmartArrayLike<AbstractMesh>;
  42297. /**
  42298. * Lambda returning the list of potentially active sub meshes.
  42299. */
  42300. getActiveSubMeshCandidates: (mesh: AbstractMesh) => ISmartArrayLike<SubMesh>;
  42301. /**
  42302. * Lambda returning the list of potentially intersecting sub meshes.
  42303. */
  42304. getIntersectingSubMeshCandidates: (mesh: AbstractMesh, localRay: Ray) => ISmartArrayLike<SubMesh>;
  42305. /**
  42306. * Lambda returning the list of potentially colliding sub meshes.
  42307. */
  42308. getCollidingSubMeshCandidates: (mesh: AbstractMesh, collider: Collider) => ISmartArrayLike<SubMesh>;
  42309. private _activeMeshesFrozen;
  42310. private _skipEvaluateActiveMeshesCompletely;
  42311. /**
  42312. * Use this function to stop evaluating active meshes. The current list will be keep alive between frames
  42313. * @param skipEvaluateActiveMeshes defines an optional boolean indicating that the evaluate active meshes step must be completely skipped
  42314. * @returns the current scene
  42315. */
  42316. freezeActiveMeshes(skipEvaluateActiveMeshes?: boolean): Scene;
  42317. /**
  42318. * Use this function to restart evaluating active meshes on every frame
  42319. * @returns the current scene
  42320. */
  42321. unfreezeActiveMeshes(): Scene;
  42322. private _evaluateActiveMeshes;
  42323. private _activeMesh;
  42324. /**
  42325. * Update the transform matrix to update from the current active camera
  42326. * @param force defines a boolean used to force the update even if cache is up to date
  42327. */
  42328. updateTransformMatrix(force?: boolean): void;
  42329. private _bindFrameBuffer;
  42330. /** @hidden */
  42331. _allowPostProcessClearColor: boolean;
  42332. /** @hidden */
  42333. _renderForCamera(camera: Camera, rigParent?: Camera): void;
  42334. private _processSubCameras;
  42335. private _checkIntersections;
  42336. /** @hidden */
  42337. _advancePhysicsEngineStep(step: number): void;
  42338. /**
  42339. * User updatable function that will return a deterministic frame time when engine is in deterministic lock step mode
  42340. */
  42341. getDeterministicFrameTime: () => number;
  42342. /** @hidden */
  42343. _animate(): void;
  42344. /** Execute all animations (for a frame) */
  42345. animate(): void;
  42346. /**
  42347. * Render the scene
  42348. * @param updateCameras defines a boolean indicating if cameras must update according to their inputs (true by default)
  42349. * @param ignoreAnimations defines a boolean indicating if animations should not be executed (false by default)
  42350. */
  42351. render(updateCameras?: boolean, ignoreAnimations?: boolean): void;
  42352. /**
  42353. * Freeze all materials
  42354. * A frozen material will not be updatable but should be faster to render
  42355. */
  42356. freezeMaterials(): void;
  42357. /**
  42358. * Unfreeze all materials
  42359. * A frozen material will not be updatable but should be faster to render
  42360. */
  42361. unfreezeMaterials(): void;
  42362. /**
  42363. * Releases all held ressources
  42364. */
  42365. dispose(): void;
  42366. /**
  42367. * Gets if the scene is already disposed
  42368. */
  42369. get isDisposed(): boolean;
  42370. /**
  42371. * Call this function to reduce memory footprint of the scene.
  42372. * Vertex buffers will not store CPU data anymore (this will prevent picking, collisions or physics to work correctly)
  42373. */
  42374. clearCachedVertexData(): void;
  42375. /**
  42376. * This function will remove the local cached buffer data from texture.
  42377. * It will save memory but will prevent the texture from being rebuilt
  42378. */
  42379. cleanCachedTextureBuffer(): void;
  42380. /**
  42381. * Get the world extend vectors with an optional filter
  42382. *
  42383. * @param filterPredicate the predicate - which meshes should be included when calculating the world size
  42384. * @returns {{ min: Vector3; max: Vector3 }} min and max vectors
  42385. */
  42386. getWorldExtends(filterPredicate?: (mesh: AbstractMesh) => boolean): {
  42387. min: Vector3;
  42388. max: Vector3;
  42389. };
  42390. /**
  42391. * Creates a ray that can be used to pick in the scene
  42392. * @param x defines the x coordinate of the origin (on-screen)
  42393. * @param y defines the y coordinate of the origin (on-screen)
  42394. * @param world defines the world matrix to use if you want to pick in object space (instead of world space)
  42395. * @param camera defines the camera to use for the picking
  42396. * @param cameraViewSpace defines if picking will be done in view space (false by default)
  42397. * @returns a Ray
  42398. */
  42399. createPickingRay(x: number, y: number, world: Matrix, camera: Nullable<Camera>, cameraViewSpace?: boolean): Ray;
  42400. /**
  42401. * Creates a ray that can be used to pick in the scene
  42402. * @param x defines the x coordinate of the origin (on-screen)
  42403. * @param y defines the y coordinate of the origin (on-screen)
  42404. * @param world defines the world matrix to use if you want to pick in object space (instead of world space)
  42405. * @param result defines the ray where to store the picking ray
  42406. * @param camera defines the camera to use for the picking
  42407. * @param cameraViewSpace defines if picking will be done in view space (false by default)
  42408. * @returns the current scene
  42409. */
  42410. createPickingRayToRef(x: number, y: number, world: Matrix, result: Ray, camera: Nullable<Camera>, cameraViewSpace?: boolean): Scene;
  42411. /**
  42412. * Creates a ray that can be used to pick in the scene
  42413. * @param x defines the x coordinate of the origin (on-screen)
  42414. * @param y defines the y coordinate of the origin (on-screen)
  42415. * @param camera defines the camera to use for the picking
  42416. * @returns a Ray
  42417. */
  42418. createPickingRayInCameraSpace(x: number, y: number, camera?: Camera): Ray;
  42419. /**
  42420. * Creates a ray that can be used to pick in the scene
  42421. * @param x defines the x coordinate of the origin (on-screen)
  42422. * @param y defines the y coordinate of the origin (on-screen)
  42423. * @param result defines the ray where to store the picking ray
  42424. * @param camera defines the camera to use for the picking
  42425. * @returns the current scene
  42426. */
  42427. createPickingRayInCameraSpaceToRef(x: number, y: number, result: Ray, camera?: Camera): Scene;
  42428. /** Launch a ray to try to pick a mesh in the scene
  42429. * @param x position on screen
  42430. * @param y position on screen
  42431. * @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
  42432. * @param fastCheck defines if the first intersection will be used (and not the closest)
  42433. * @param camera to use for computing the picking ray. Can be set to null. In this case, the scene.activeCamera will be used
  42434. * @param trianglePredicate defines an optional predicate used to select faces when a mesh intersection is detected
  42435. * @returns a PickingInfo
  42436. */
  42437. pick(x: number, y: number, predicate?: (mesh: AbstractMesh) => boolean, fastCheck?: boolean, camera?: Nullable<Camera>, trianglePredicate?: TrianglePickingPredicate): Nullable<PickingInfo>;
  42438. /** Launch a ray to try to pick a mesh in the scene using only bounding information of the main mesh (not using submeshes)
  42439. * @param x position on screen
  42440. * @param y position on screen
  42441. * @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
  42442. * @param fastCheck defines if the first intersection will be used (and not the closest)
  42443. * @param camera to use for computing the picking ray. Can be set to null. In this case, the scene.activeCamera will be used
  42444. * @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)
  42445. */
  42446. pickWithBoundingInfo(x: number, y: number, predicate?: (mesh: AbstractMesh) => boolean, fastCheck?: boolean, camera?: Nullable<Camera>): Nullable<PickingInfo>;
  42447. /** Use the given ray to pick a mesh in the scene
  42448. * @param ray The ray to use to pick meshes
  42449. * @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
  42450. * @param fastCheck defines if the first intersection will be used (and not the closest)
  42451. * @param trianglePredicate defines an optional predicate used to select faces when a mesh intersection is detected
  42452. * @returns a PickingInfo
  42453. */
  42454. pickWithRay(ray: Ray, predicate?: (mesh: AbstractMesh) => boolean, fastCheck?: boolean, trianglePredicate?: TrianglePickingPredicate): Nullable<PickingInfo>;
  42455. /**
  42456. * Launch a ray to try to pick a mesh in the scene
  42457. * @param x X position on screen
  42458. * @param y Y position on screen
  42459. * @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
  42460. * @param camera camera to use for computing the picking ray. Can be set to null. In this case, the scene.activeCamera will be used
  42461. * @param trianglePredicate defines an optional predicate used to select faces when a mesh intersection is detected
  42462. * @returns an array of PickingInfo
  42463. */
  42464. multiPick(x: number, y: number, predicate?: (mesh: AbstractMesh) => boolean, camera?: Camera, trianglePredicate?: TrianglePickingPredicate): Nullable<PickingInfo[]>;
  42465. /**
  42466. * Launch a ray to try to pick a mesh in the scene
  42467. * @param ray Ray to use
  42468. * @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
  42469. * @param trianglePredicate defines an optional predicate used to select faces when a mesh intersection is detected
  42470. * @returns an array of PickingInfo
  42471. */
  42472. multiPickWithRay(ray: Ray, predicate: (mesh: AbstractMesh) => boolean, trianglePredicate?: TrianglePickingPredicate): Nullable<PickingInfo[]>;
  42473. /**
  42474. * Force the value of meshUnderPointer
  42475. * @param mesh defines the mesh to use
  42476. */
  42477. setPointerOverMesh(mesh: Nullable<AbstractMesh>): void;
  42478. /**
  42479. * Gets the mesh under the pointer
  42480. * @returns a Mesh or null if no mesh is under the pointer
  42481. */
  42482. getPointerOverMesh(): Nullable<AbstractMesh>;
  42483. /** @hidden */
  42484. _rebuildGeometries(): void;
  42485. /** @hidden */
  42486. _rebuildTextures(): void;
  42487. private _getByTags;
  42488. /**
  42489. * Get a list of meshes by tags
  42490. * @param tagsQuery defines the tags query to use
  42491. * @param forEach defines a predicate used to filter results
  42492. * @returns an array of Mesh
  42493. */
  42494. getMeshesByTags(tagsQuery: string, forEach?: (mesh: AbstractMesh) => void): Mesh[];
  42495. /**
  42496. * Get a list of cameras by tags
  42497. * @param tagsQuery defines the tags query to use
  42498. * @param forEach defines a predicate used to filter results
  42499. * @returns an array of Camera
  42500. */
  42501. getCamerasByTags(tagsQuery: string, forEach?: (camera: Camera) => void): Camera[];
  42502. /**
  42503. * Get a list of lights by tags
  42504. * @param tagsQuery defines the tags query to use
  42505. * @param forEach defines a predicate used to filter results
  42506. * @returns an array of Light
  42507. */
  42508. getLightsByTags(tagsQuery: string, forEach?: (light: Light) => void): Light[];
  42509. /**
  42510. * Get a list of materials by tags
  42511. * @param tagsQuery defines the tags query to use
  42512. * @param forEach defines a predicate used to filter results
  42513. * @returns an array of Material
  42514. */
  42515. getMaterialByTags(tagsQuery: string, forEach?: (material: Material) => void): Material[];
  42516. /**
  42517. * Get a list of transform nodes by tags
  42518. * @param tagsQuery defines the tags query to use
  42519. * @param forEach defines a predicate used to filter results
  42520. * @returns an array of TransformNode
  42521. */
  42522. getTransformNodesByTags(tagsQuery: string, forEach?: (transform: TransformNode) => void): TransformNode[];
  42523. /**
  42524. * Overrides the default sort function applied in the renderging group to prepare the meshes.
  42525. * This allowed control for front to back rendering or reversly depending of the special needs.
  42526. *
  42527. * @param renderingGroupId The rendering group id corresponding to its index
  42528. * @param opaqueSortCompareFn The opaque queue comparison function use to sort.
  42529. * @param alphaTestSortCompareFn The alpha test queue comparison function use to sort.
  42530. * @param transparentSortCompareFn The transparent queue comparison function use to sort.
  42531. */
  42532. 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;
  42533. /**
  42534. * Specifies whether or not the stencil and depth buffer are cleared between two rendering groups.
  42535. *
  42536. * @param renderingGroupId The rendering group id corresponding to its index
  42537. * @param autoClearDepthStencil Automatically clears depth and stencil between groups if true.
  42538. * @param depth Automatically clears depth between groups if true and autoClear is true.
  42539. * @param stencil Automatically clears stencil between groups if true and autoClear is true.
  42540. */
  42541. setRenderingAutoClearDepthStencil(renderingGroupId: number, autoClearDepthStencil: boolean, depth?: boolean, stencil?: boolean): void;
  42542. /**
  42543. * Gets the current auto clear configuration for one rendering group of the rendering
  42544. * manager.
  42545. * @param index the rendering group index to get the information for
  42546. * @returns The auto clear setup for the requested rendering group
  42547. */
  42548. getAutoClearDepthStencilSetup(index: number): IRenderingManagerAutoClearSetup;
  42549. private _blockMaterialDirtyMechanism;
  42550. /** Gets or sets a boolean blocking all the calls to markAllMaterialsAsDirty (ie. the materials won't be updated if they are out of sync) */
  42551. get blockMaterialDirtyMechanism(): boolean;
  42552. set blockMaterialDirtyMechanism(value: boolean);
  42553. /**
  42554. * Will flag all materials as dirty to trigger new shader compilation
  42555. * @param flag defines the flag used to specify which material part must be marked as dirty
  42556. * @param predicate If not null, it will be used to specifiy if a material has to be marked as dirty
  42557. */
  42558. markAllMaterialsAsDirty(flag: number, predicate?: (mat: Material) => boolean): void;
  42559. /** @hidden */
  42560. _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;
  42561. /** @hidden */
  42562. _loadFileAsync(url: string, onProgress?: (data: any) => void, useOfflineSupport?: boolean, useArrayBuffer?: boolean): Promise<string | ArrayBuffer>;
  42563. /** @hidden */
  42564. _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;
  42565. /** @hidden */
  42566. _requestFileAsync(url: string, onProgress?: (ev: ProgressEvent) => void, useOfflineSupport?: boolean, useArrayBuffer?: boolean, onOpened?: (request: WebRequest) => void): Promise<string | ArrayBuffer>;
  42567. /** @hidden */
  42568. _readFile(file: File, onSuccess: (data: string | ArrayBuffer) => void, onProgress?: (ev: ProgressEvent) => any, useArrayBuffer?: boolean, onError?: (error: ReadFileError) => void): IFileRequest;
  42569. /** @hidden */
  42570. _readFileAsync(file: File, onProgress?: (ev: ProgressEvent) => any, useArrayBuffer?: boolean): Promise<string | ArrayBuffer>;
  42571. }
  42572. }
  42573. declare module "babylonjs/assetContainer" {
  42574. import { AbstractScene } from "babylonjs/abstractScene";
  42575. import { Scene } from "babylonjs/scene";
  42576. import { Mesh } from "babylonjs/Meshes/mesh";
  42577. import { TransformNode } from "babylonjs/Meshes/transformNode";
  42578. import { Skeleton } from "babylonjs/Bones/skeleton";
  42579. import { AnimationGroup } from "babylonjs/Animations/animationGroup";
  42580. import { Animatable } from "babylonjs/Animations/animatable";
  42581. import { Nullable } from "babylonjs/types";
  42582. import { Node } from "babylonjs/node";
  42583. /**
  42584. * Set of assets to keep when moving a scene into an asset container.
  42585. */
  42586. export class KeepAssets extends AbstractScene {
  42587. }
  42588. /**
  42589. * Class used to store the output of the AssetContainer.instantiateAllMeshesToScene function
  42590. */
  42591. export class InstantiatedEntries {
  42592. /**
  42593. * List of new root nodes (eg. nodes with no parent)
  42594. */
  42595. rootNodes: TransformNode[];
  42596. /**
  42597. * List of new skeletons
  42598. */
  42599. skeletons: Skeleton[];
  42600. /**
  42601. * List of new animation groups
  42602. */
  42603. animationGroups: AnimationGroup[];
  42604. }
  42605. /**
  42606. * Container with a set of assets that can be added or removed from a scene.
  42607. */
  42608. export class AssetContainer extends AbstractScene {
  42609. private _wasAddedToScene;
  42610. /**
  42611. * The scene the AssetContainer belongs to.
  42612. */
  42613. scene: Scene;
  42614. /**
  42615. * Instantiates an AssetContainer.
  42616. * @param scene The scene the AssetContainer belongs to.
  42617. */
  42618. constructor(scene: Scene);
  42619. /**
  42620. * Instantiate or clone all meshes and add the new ones to the scene.
  42621. * Skeletons and animation groups will all be cloned
  42622. * @param nameFunction defines an optional function used to get new names for clones
  42623. * @param cloneMaterials defines an optional boolean that defines if materials must be cloned as well (false by default)
  42624. * @returns a list of rootNodes, skeletons and aniamtion groups that were duplicated
  42625. */
  42626. instantiateModelsToScene(nameFunction?: (sourceName: string) => string, cloneMaterials?: boolean): InstantiatedEntries;
  42627. /**
  42628. * Adds all the assets from the container to the scene.
  42629. */
  42630. addAllToScene(): void;
  42631. /**
  42632. * Removes all the assets in the container from the scene
  42633. */
  42634. removeAllFromScene(): void;
  42635. /**
  42636. * Disposes all the assets in the container
  42637. */
  42638. dispose(): void;
  42639. private _moveAssets;
  42640. /**
  42641. * Removes all the assets contained in the scene and adds them to the container.
  42642. * @param keepAssets Set of assets to keep in the scene. (default: empty)
  42643. */
  42644. moveAllFromScene(keepAssets?: KeepAssets): void;
  42645. /**
  42646. * 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.
  42647. * @returns the root mesh
  42648. */
  42649. createRootMesh(): Mesh;
  42650. /**
  42651. * Merge animations (direct and animation groups) from this asset container into a scene
  42652. * @param scene is the instance of BABYLON.Scene to append to (default: last created scene)
  42653. * @param animatables set of animatables to retarget to a node from the scene
  42654. * @param targetConverter defines a function used to convert animation targets from the asset container to the scene (default: search node by name)
  42655. * @returns an array of the new AnimationGroup added to the scene (empty array if none)
  42656. */
  42657. mergeAnimationsTo(scene: Scene | null | undefined, animatables: Animatable[], targetConverter?: Nullable<(target: any) => Nullable<Node>>): AnimationGroup[];
  42658. }
  42659. }
  42660. declare module "babylonjs/abstractScene" {
  42661. import { Scene } from "babylonjs/scene";
  42662. import { Nullable } from "babylonjs/types";
  42663. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  42664. import { TransformNode } from "babylonjs/Meshes/transformNode";
  42665. import { Geometry } from "babylonjs/Meshes/geometry";
  42666. import { Skeleton } from "babylonjs/Bones/skeleton";
  42667. import { MorphTargetManager } from "babylonjs/Morph/morphTargetManager";
  42668. import { AssetContainer } from "babylonjs/assetContainer";
  42669. import { IParticleSystem } from "babylonjs/Particles/IParticleSystem";
  42670. import { AnimationGroup } from "babylonjs/Animations/animationGroup";
  42671. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  42672. import { Material } from "babylonjs/Materials/material";
  42673. import { MultiMaterial } from "babylonjs/Materials/multiMaterial";
  42674. import { AbstractActionManager } from "babylonjs/Actions/abstractActionManager";
  42675. import { Camera } from "babylonjs/Cameras/camera";
  42676. import { Light } from "babylonjs/Lights/light";
  42677. import { Node } from "babylonjs/node";
  42678. import { Animation } from "babylonjs/Animations/animation";
  42679. /**
  42680. * Defines how the parser contract is defined.
  42681. * These parsers are used to parse a list of specific assets (like particle systems, etc..)
  42682. */
  42683. export type BabylonFileParser = (parsedData: any, scene: Scene, container: AssetContainer, rootUrl: string) => void;
  42684. /**
  42685. * Defines how the individual parser contract is defined.
  42686. * These parser can parse an individual asset
  42687. */
  42688. export type IndividualBabylonFileParser = (parsedData: any, scene: Scene, rootUrl: string) => any;
  42689. /**
  42690. * Base class of the scene acting as a container for the different elements composing a scene.
  42691. * This class is dynamically extended by the different components of the scene increasing
  42692. * flexibility and reducing coupling
  42693. */
  42694. export abstract class AbstractScene {
  42695. /**
  42696. * Stores the list of available parsers in the application.
  42697. */
  42698. private static _BabylonFileParsers;
  42699. /**
  42700. * Stores the list of available individual parsers in the application.
  42701. */
  42702. private static _IndividualBabylonFileParsers;
  42703. /**
  42704. * Adds a parser in the list of available ones
  42705. * @param name Defines the name of the parser
  42706. * @param parser Defines the parser to add
  42707. */
  42708. static AddParser(name: string, parser: BabylonFileParser): void;
  42709. /**
  42710. * Gets a general parser from the list of avaialble ones
  42711. * @param name Defines the name of the parser
  42712. * @returns the requested parser or null
  42713. */
  42714. static GetParser(name: string): Nullable<BabylonFileParser>;
  42715. /**
  42716. * Adds n individual parser in the list of available ones
  42717. * @param name Defines the name of the parser
  42718. * @param parser Defines the parser to add
  42719. */
  42720. static AddIndividualParser(name: string, parser: IndividualBabylonFileParser): void;
  42721. /**
  42722. * Gets an individual parser from the list of avaialble ones
  42723. * @param name Defines the name of the parser
  42724. * @returns the requested parser or null
  42725. */
  42726. static GetIndividualParser(name: string): Nullable<IndividualBabylonFileParser>;
  42727. /**
  42728. * Parser json data and populate both a scene and its associated container object
  42729. * @param jsonData Defines the data to parse
  42730. * @param scene Defines the scene to parse the data for
  42731. * @param container Defines the container attached to the parsing sequence
  42732. * @param rootUrl Defines the root url of the data
  42733. */
  42734. static Parse(jsonData: any, scene: Scene, container: AssetContainer, rootUrl: string): void;
  42735. /**
  42736. * Gets the list of root nodes (ie. nodes with no parent)
  42737. */
  42738. rootNodes: Node[];
  42739. /** All of the cameras added to this scene
  42740. * @see https://doc.babylonjs.com/babylon101/cameras
  42741. */
  42742. cameras: Camera[];
  42743. /**
  42744. * All of the lights added to this scene
  42745. * @see https://doc.babylonjs.com/babylon101/lights
  42746. */
  42747. lights: Light[];
  42748. /**
  42749. * All of the (abstract) meshes added to this scene
  42750. */
  42751. meshes: AbstractMesh[];
  42752. /**
  42753. * The list of skeletons added to the scene
  42754. * @see https://doc.babylonjs.com/how_to/how_to_use_bones_and_skeletons
  42755. */
  42756. skeletons: Skeleton[];
  42757. /**
  42758. * All of the particle systems added to this scene
  42759. * @see https://doc.babylonjs.com/babylon101/particles
  42760. */
  42761. particleSystems: IParticleSystem[];
  42762. /**
  42763. * Gets a list of Animations associated with the scene
  42764. */
  42765. animations: Animation[];
  42766. /**
  42767. * All of the animation groups added to this scene
  42768. * @see https://doc.babylonjs.com/how_to/group
  42769. */
  42770. animationGroups: AnimationGroup[];
  42771. /**
  42772. * All of the multi-materials added to this scene
  42773. * @see https://doc.babylonjs.com/how_to/multi_materials
  42774. */
  42775. multiMaterials: MultiMaterial[];
  42776. /**
  42777. * All of the materials added to this scene
  42778. * In the context of a Scene, it is not supposed to be modified manually.
  42779. * Any addition or removal should be done using the addMaterial and removeMaterial Scene methods.
  42780. * Note also that the order of the Material within the array is not significant and might change.
  42781. * @see https://doc.babylonjs.com/babylon101/materials
  42782. */
  42783. materials: Material[];
  42784. /**
  42785. * The list of morph target managers added to the scene
  42786. * @see https://doc.babylonjs.com/how_to/how_to_dynamically_morph_a_mesh
  42787. */
  42788. morphTargetManagers: MorphTargetManager[];
  42789. /**
  42790. * The list of geometries used in the scene.
  42791. */
  42792. geometries: Geometry[];
  42793. /**
  42794. * All of the tranform nodes added to this scene
  42795. * In the context of a Scene, it is not supposed to be modified manually.
  42796. * Any addition or removal should be done using the addTransformNode and removeTransformNode Scene methods.
  42797. * Note also that the order of the TransformNode wihin the array is not significant and might change.
  42798. * @see https://doc.babylonjs.com/how_to/transformnode
  42799. */
  42800. transformNodes: TransformNode[];
  42801. /**
  42802. * ActionManagers available on the scene.
  42803. */
  42804. actionManagers: AbstractActionManager[];
  42805. /**
  42806. * Textures to keep.
  42807. */
  42808. textures: BaseTexture[];
  42809. /** @hidden */
  42810. protected _environmentTexture: Nullable<BaseTexture>;
  42811. /**
  42812. * Texture used in all pbr material as the reflection texture.
  42813. * As in the majority of the scene they are the same (exception for multi room and so on),
  42814. * this is easier to reference from here than from all the materials.
  42815. */
  42816. get environmentTexture(): Nullable<BaseTexture>;
  42817. set environmentTexture(value: Nullable<BaseTexture>);
  42818. /**
  42819. * The list of postprocesses added to the scene
  42820. */
  42821. postProcesses: import("babylonjs/PostProcesses/postProcess").PostProcess[];
  42822. /**
  42823. * @returns all meshes, lights, cameras, transformNodes and bones
  42824. */
  42825. getNodes(): Array<Node>;
  42826. }
  42827. }
  42828. declare module "babylonjs/Audio/sound" {
  42829. import { Observable } from "babylonjs/Misc/observable";
  42830. import { Vector3 } from "babylonjs/Maths/math.vector";
  42831. import { Nullable } from "babylonjs/types";
  42832. import { Scene } from "babylonjs/scene";
  42833. import { TransformNode } from "babylonjs/Meshes/transformNode";
  42834. /**
  42835. * Interface used to define options for Sound class
  42836. */
  42837. export interface ISoundOptions {
  42838. /**
  42839. * Does the sound autoplay once loaded.
  42840. */
  42841. autoplay?: boolean;
  42842. /**
  42843. * Does the sound loop after it finishes playing once.
  42844. */
  42845. loop?: boolean;
  42846. /**
  42847. * Sound's volume
  42848. */
  42849. volume?: number;
  42850. /**
  42851. * Is it a spatial sound?
  42852. */
  42853. spatialSound?: boolean;
  42854. /**
  42855. * Maximum distance to hear that sound
  42856. */
  42857. maxDistance?: number;
  42858. /**
  42859. * Uses user defined attenuation function
  42860. */
  42861. useCustomAttenuation?: boolean;
  42862. /**
  42863. * Define the roll off factor of spatial sounds.
  42864. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music#creating-a-spatial-3d-sound
  42865. */
  42866. rolloffFactor?: number;
  42867. /**
  42868. * Define the reference distance the sound should be heard perfectly.
  42869. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music#creating-a-spatial-3d-sound
  42870. */
  42871. refDistance?: number;
  42872. /**
  42873. * Define the distance attenuation model the sound will follow.
  42874. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music#creating-a-spatial-3d-sound
  42875. */
  42876. distanceModel?: string;
  42877. /**
  42878. * Defines the playback speed (1 by default)
  42879. */
  42880. playbackRate?: number;
  42881. /**
  42882. * Defines if the sound is from a streaming source
  42883. */
  42884. streaming?: boolean;
  42885. /**
  42886. * Defines an optional length (in seconds) inside the sound file
  42887. */
  42888. length?: number;
  42889. /**
  42890. * Defines an optional offset (in seconds) inside the sound file
  42891. */
  42892. offset?: number;
  42893. /**
  42894. * If true, URLs will not be required to state the audio file codec to use.
  42895. */
  42896. skipCodecCheck?: boolean;
  42897. }
  42898. /**
  42899. * Defines a sound that can be played in the application.
  42900. * The sound can either be an ambient track or a simple sound played in reaction to a user action.
  42901. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music
  42902. */
  42903. export class Sound {
  42904. /**
  42905. * The name of the sound in the scene.
  42906. */
  42907. name: string;
  42908. /**
  42909. * Does the sound autoplay once loaded.
  42910. */
  42911. autoplay: boolean;
  42912. /**
  42913. * Does the sound loop after it finishes playing once.
  42914. */
  42915. loop: boolean;
  42916. /**
  42917. * Does the sound use a custom attenuation curve to simulate the falloff
  42918. * happening when the source gets further away from the camera.
  42919. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music#creating-your-own-custom-attenuation-function
  42920. */
  42921. useCustomAttenuation: boolean;
  42922. /**
  42923. * The sound track id this sound belongs to.
  42924. */
  42925. soundTrackId: number;
  42926. /**
  42927. * Is this sound currently played.
  42928. */
  42929. isPlaying: boolean;
  42930. /**
  42931. * Is this sound currently paused.
  42932. */
  42933. isPaused: boolean;
  42934. /**
  42935. * Does this sound enables spatial sound.
  42936. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music#creating-a-spatial-3d-sound
  42937. */
  42938. spatialSound: boolean;
  42939. /**
  42940. * Define the reference distance the sound should be heard perfectly.
  42941. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music#creating-a-spatial-3d-sound
  42942. */
  42943. refDistance: number;
  42944. /**
  42945. * Define the roll off factor of spatial sounds.
  42946. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music#creating-a-spatial-3d-sound
  42947. */
  42948. rolloffFactor: number;
  42949. /**
  42950. * Define the max distance the sound should be heard (intensity just became 0 at this point).
  42951. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music#creating-a-spatial-3d-sound
  42952. */
  42953. maxDistance: number;
  42954. /**
  42955. * Define the distance attenuation model the sound will follow.
  42956. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music#creating-a-spatial-3d-sound
  42957. */
  42958. distanceModel: string;
  42959. /**
  42960. * @hidden
  42961. * Back Compat
  42962. **/
  42963. onended: () => any;
  42964. /**
  42965. * Gets or sets an object used to store user defined information for the sound.
  42966. */
  42967. metadata: any;
  42968. /**
  42969. * Observable event when the current playing sound finishes.
  42970. */
  42971. onEndedObservable: Observable<Sound>;
  42972. private _panningModel;
  42973. private _playbackRate;
  42974. private _streaming;
  42975. private _startTime;
  42976. private _startOffset;
  42977. private _position;
  42978. /** @hidden */
  42979. _positionInEmitterSpace: boolean;
  42980. private _localDirection;
  42981. private _volume;
  42982. private _isReadyToPlay;
  42983. private _isDirectional;
  42984. private _readyToPlayCallback;
  42985. private _audioBuffer;
  42986. private _soundSource;
  42987. private _streamingSource;
  42988. private _soundPanner;
  42989. private _soundGain;
  42990. private _inputAudioNode;
  42991. private _outputAudioNode;
  42992. private _coneInnerAngle;
  42993. private _coneOuterAngle;
  42994. private _coneOuterGain;
  42995. private _scene;
  42996. private _connectedTransformNode;
  42997. private _customAttenuationFunction;
  42998. private _registerFunc;
  42999. private _isOutputConnected;
  43000. private _htmlAudioElement;
  43001. private _urlType;
  43002. private _length?;
  43003. private _offset?;
  43004. /** @hidden */
  43005. static _SceneComponentInitialization: (scene: Scene) => void;
  43006. /**
  43007. * Create a sound and attach it to a scene
  43008. * @param name Name of your sound
  43009. * @param urlOrArrayBuffer Url to the sound to load async or ArrayBuffer, it also works with MediaStreams
  43010. * @param scene defines the scene the sound belongs to
  43011. * @param readyToPlayCallback Provide a callback function if you'd like to load your code once the sound is ready to be played
  43012. * @param options Objects to provide with the current available options: autoplay, loop, volume, spatialSound, maxDistance, rolloffFactor, refDistance, distanceModel, panningModel, streaming
  43013. */
  43014. constructor(name: string, urlOrArrayBuffer: any, scene: Scene, readyToPlayCallback?: Nullable<() => void>, options?: ISoundOptions);
  43015. /**
  43016. * Release the sound and its associated resources
  43017. */
  43018. dispose(): void;
  43019. /**
  43020. * Gets if the sounds is ready to be played or not.
  43021. * @returns true if ready, otherwise false
  43022. */
  43023. isReady(): boolean;
  43024. private _soundLoaded;
  43025. /**
  43026. * Sets the data of the sound from an audiobuffer
  43027. * @param audioBuffer The audioBuffer containing the data
  43028. */
  43029. setAudioBuffer(audioBuffer: AudioBuffer): void;
  43030. /**
  43031. * Updates the current sounds options such as maxdistance, loop...
  43032. * @param options A JSON object containing values named as the object properties
  43033. */
  43034. updateOptions(options: ISoundOptions): void;
  43035. private _createSpatialParameters;
  43036. private _updateSpatialParameters;
  43037. /**
  43038. * Switch the panning model to HRTF:
  43039. * Renders a stereo output of higher quality than equalpower — it uses a convolution with measured impulse responses from human subjects.
  43040. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music#creating-a-spatial-3d-sound
  43041. */
  43042. switchPanningModelToHRTF(): void;
  43043. /**
  43044. * Switch the panning model to Equal Power:
  43045. * Represents the equal-power panning algorithm, generally regarded as simple and efficient. equalpower is the default value.
  43046. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music#creating-a-spatial-3d-sound
  43047. */
  43048. switchPanningModelToEqualPower(): void;
  43049. private _switchPanningModel;
  43050. /**
  43051. * Connect this sound to a sound track audio node like gain...
  43052. * @param soundTrackAudioNode the sound track audio node to connect to
  43053. */
  43054. connectToSoundTrackAudioNode(soundTrackAudioNode: AudioNode): void;
  43055. /**
  43056. * Transform this sound into a directional source
  43057. * @param coneInnerAngle Size of the inner cone in degree
  43058. * @param coneOuterAngle Size of the outer cone in degree
  43059. * @param coneOuterGain Volume of the sound outside the outer cone (between 0.0 and 1.0)
  43060. */
  43061. setDirectionalCone(coneInnerAngle: number, coneOuterAngle: number, coneOuterGain: number): void;
  43062. /**
  43063. * Gets or sets the inner angle for the directional cone.
  43064. */
  43065. get directionalConeInnerAngle(): number;
  43066. /**
  43067. * Gets or sets the inner angle for the directional cone.
  43068. */
  43069. set directionalConeInnerAngle(value: number);
  43070. /**
  43071. * Gets or sets the outer angle for the directional cone.
  43072. */
  43073. get directionalConeOuterAngle(): number;
  43074. /**
  43075. * Gets or sets the outer angle for the directional cone.
  43076. */
  43077. set directionalConeOuterAngle(value: number);
  43078. /**
  43079. * Sets the position of the emitter if spatial sound is enabled
  43080. * @param newPosition Defines the new posisiton
  43081. */
  43082. setPosition(newPosition: Vector3): void;
  43083. /**
  43084. * Sets the local direction of the emitter if spatial sound is enabled
  43085. * @param newLocalDirection Defines the new local direction
  43086. */
  43087. setLocalDirectionToMesh(newLocalDirection: Vector3): void;
  43088. private _updateDirection;
  43089. /** @hidden */
  43090. updateDistanceFromListener(): void;
  43091. /**
  43092. * Sets a new custom attenuation function for the sound.
  43093. * @param callback Defines the function used for the attenuation
  43094. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music#creating-your-own-custom-attenuation-function
  43095. */
  43096. setAttenuationFunction(callback: (currentVolume: number, currentDistance: number, maxDistance: number, refDistance: number, rolloffFactor: number) => number): void;
  43097. /**
  43098. * Play the sound
  43099. * @param time (optional) Start the sound after X seconds. Start immediately (0) by default.
  43100. * @param offset (optional) Start the sound at a specific time in seconds
  43101. * @param length (optional) Sound duration (in seconds)
  43102. */
  43103. play(time?: number, offset?: number, length?: number): void;
  43104. private _onended;
  43105. /**
  43106. * Stop the sound
  43107. * @param time (optional) Stop the sound after X seconds. Stop immediately (0) by default.
  43108. */
  43109. stop(time?: number): void;
  43110. /**
  43111. * Put the sound in pause
  43112. */
  43113. pause(): void;
  43114. /**
  43115. * Sets a dedicated volume for this sounds
  43116. * @param newVolume Define the new volume of the sound
  43117. * @param time Define time for gradual change to new volume
  43118. */
  43119. setVolume(newVolume: number, time?: number): void;
  43120. /**
  43121. * Set the sound play back rate
  43122. * @param newPlaybackRate Define the playback rate the sound should be played at
  43123. */
  43124. setPlaybackRate(newPlaybackRate: number): void;
  43125. /**
  43126. * Gets the volume of the sound.
  43127. * @returns the volume of the sound
  43128. */
  43129. getVolume(): number;
  43130. /**
  43131. * Attach the sound to a dedicated mesh
  43132. * @param transformNode The transform node to connect the sound with
  43133. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music#attaching-a-sound-to-a-mesh
  43134. */
  43135. attachToMesh(transformNode: TransformNode): void;
  43136. /**
  43137. * Detach the sound from the previously attached mesh
  43138. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music#attaching-a-sound-to-a-mesh
  43139. */
  43140. detachFromMesh(): void;
  43141. private _onRegisterAfterWorldMatrixUpdate;
  43142. /**
  43143. * Clone the current sound in the scene.
  43144. * @returns the new sound clone
  43145. */
  43146. clone(): Nullable<Sound>;
  43147. /**
  43148. * Gets the current underlying audio buffer containing the data
  43149. * @returns the audio buffer
  43150. */
  43151. getAudioBuffer(): Nullable<AudioBuffer>;
  43152. /**
  43153. * Gets the WebAudio AudioBufferSourceNode, lets you keep track of and stop instances of this Sound.
  43154. * @returns the source node
  43155. */
  43156. getSoundSource(): Nullable<AudioBufferSourceNode>;
  43157. /**
  43158. * Gets the WebAudio GainNode, gives you precise control over the gain of instances of this Sound.
  43159. * @returns the gain node
  43160. */
  43161. getSoundGain(): Nullable<GainNode>;
  43162. /**
  43163. * Serializes the Sound in a JSON representation
  43164. * @returns the JSON representation of the sound
  43165. */
  43166. serialize(): any;
  43167. /**
  43168. * Parse a JSON representation of a sound to innstantiate in a given scene
  43169. * @param parsedSound Define the JSON representation of the sound (usually coming from the serialize method)
  43170. * @param scene Define the scene the new parsed sound should be created in
  43171. * @param rootUrl Define the rooturl of the load in case we need to fetch relative dependencies
  43172. * @param sourceSound Define a cound place holder if do not need to instantiate a new one
  43173. * @returns the newly parsed sound
  43174. */
  43175. static Parse(parsedSound: any, scene: Scene, rootUrl: string, sourceSound?: Sound): Sound;
  43176. }
  43177. }
  43178. declare module "babylonjs/Actions/directAudioActions" {
  43179. import { Action } from "babylonjs/Actions/action";
  43180. import { Condition } from "babylonjs/Actions/condition";
  43181. import { Sound } from "babylonjs/Audio/sound";
  43182. /**
  43183. * This defines an action helpful to play a defined sound on a triggered action.
  43184. */
  43185. export class PlaySoundAction extends Action {
  43186. private _sound;
  43187. /**
  43188. * Instantiate the action
  43189. * @param triggerOptions defines the trigger options
  43190. * @param sound defines the sound to play
  43191. * @param condition defines the trigger related conditions
  43192. */
  43193. constructor(triggerOptions: any, sound: Sound, condition?: Condition);
  43194. /** @hidden */
  43195. _prepare(): void;
  43196. /**
  43197. * Execute the action and play the sound.
  43198. */
  43199. execute(): void;
  43200. /**
  43201. * Serializes the actions and its related information.
  43202. * @param parent defines the object to serialize in
  43203. * @returns the serialized object
  43204. */
  43205. serialize(parent: any): any;
  43206. }
  43207. /**
  43208. * This defines an action helpful to stop a defined sound on a triggered action.
  43209. */
  43210. export class StopSoundAction extends Action {
  43211. private _sound;
  43212. /**
  43213. * Instantiate the action
  43214. * @param triggerOptions defines the trigger options
  43215. * @param sound defines the sound to stop
  43216. * @param condition defines the trigger related conditions
  43217. */
  43218. constructor(triggerOptions: any, sound: Sound, condition?: Condition);
  43219. /** @hidden */
  43220. _prepare(): void;
  43221. /**
  43222. * Execute the action and stop the sound.
  43223. */
  43224. execute(): void;
  43225. /**
  43226. * Serializes the actions and its related information.
  43227. * @param parent defines the object to serialize in
  43228. * @returns the serialized object
  43229. */
  43230. serialize(parent: any): any;
  43231. }
  43232. }
  43233. declare module "babylonjs/Actions/interpolateValueAction" {
  43234. import { Action } from "babylonjs/Actions/action";
  43235. import { Condition } from "babylonjs/Actions/condition";
  43236. import { Observable } from "babylonjs/Misc/observable";
  43237. /**
  43238. * This defines an action responsible to change the value of a property
  43239. * by interpolating between its current value and the newly set one once triggered.
  43240. * @see https://doc.babylonjs.com/how_to/how_to_use_actions
  43241. */
  43242. export class InterpolateValueAction extends Action {
  43243. /**
  43244. * Defines the path of the property where the value should be interpolated
  43245. */
  43246. propertyPath: string;
  43247. /**
  43248. * Defines the target value at the end of the interpolation.
  43249. */
  43250. value: any;
  43251. /**
  43252. * Defines the time it will take for the property to interpolate to the value.
  43253. */
  43254. duration: number;
  43255. /**
  43256. * Defines if the other scene animations should be stopped when the action has been triggered
  43257. */
  43258. stopOtherAnimations?: boolean;
  43259. /**
  43260. * Defines a callback raised once the interpolation animation has been done.
  43261. */
  43262. onInterpolationDone?: () => void;
  43263. /**
  43264. * Observable triggered once the interpolation animation has been done.
  43265. */
  43266. onInterpolationDoneObservable: Observable<InterpolateValueAction>;
  43267. private _target;
  43268. private _effectiveTarget;
  43269. private _property;
  43270. /**
  43271. * Instantiate the action
  43272. * @param triggerOptions defines the trigger options
  43273. * @param target defines the object containing the value to interpolate
  43274. * @param propertyPath defines the path to the property in the target object
  43275. * @param value defines the target value at the end of the interpolation
  43276. * @param duration deines the time it will take for the property to interpolate to the value.
  43277. * @param condition defines the trigger related conditions
  43278. * @param stopOtherAnimations defines if the other scene animations should be stopped when the action has been triggered
  43279. * @param onInterpolationDone defines a callback raised once the interpolation animation has been done
  43280. */
  43281. constructor(triggerOptions: any, target: any, propertyPath: string, value: any, duration?: number, condition?: Condition, stopOtherAnimations?: boolean, onInterpolationDone?: () => void);
  43282. /** @hidden */
  43283. _prepare(): void;
  43284. /**
  43285. * Execute the action starts the value interpolation.
  43286. */
  43287. execute(): void;
  43288. /**
  43289. * Serializes the actions and its related information.
  43290. * @param parent defines the object to serialize in
  43291. * @returns the serialized object
  43292. */
  43293. serialize(parent: any): any;
  43294. }
  43295. }
  43296. declare module "babylonjs/Actions/index" {
  43297. export * from "babylonjs/Actions/abstractActionManager";
  43298. export * from "babylonjs/Actions/action";
  43299. export * from "babylonjs/Actions/actionEvent";
  43300. export * from "babylonjs/Actions/actionManager";
  43301. export * from "babylonjs/Actions/condition";
  43302. export * from "babylonjs/Actions/directActions";
  43303. export * from "babylonjs/Actions/directAudioActions";
  43304. export * from "babylonjs/Actions/interpolateValueAction";
  43305. }
  43306. declare module "babylonjs/Animations/index" {
  43307. export * from "babylonjs/Animations/animatable";
  43308. export * from "babylonjs/Animations/animation";
  43309. export * from "babylonjs/Animations/animationGroup";
  43310. export * from "babylonjs/Animations/animationPropertiesOverride";
  43311. export * from "babylonjs/Animations/easing";
  43312. export * from "babylonjs/Animations/runtimeAnimation";
  43313. export * from "babylonjs/Animations/animationEvent";
  43314. export * from "babylonjs/Animations/animationGroup";
  43315. export * from "babylonjs/Animations/animationKey";
  43316. export * from "babylonjs/Animations/animationRange";
  43317. export * from "babylonjs/Animations/animatable.interface";
  43318. }
  43319. declare module "babylonjs/Audio/soundTrack" {
  43320. import { Sound } from "babylonjs/Audio/sound";
  43321. import { Analyser } from "babylonjs/Audio/analyser";
  43322. import { Scene } from "babylonjs/scene";
  43323. /**
  43324. * Options allowed during the creation of a sound track.
  43325. */
  43326. export interface ISoundTrackOptions {
  43327. /**
  43328. * The volume the sound track should take during creation
  43329. */
  43330. volume?: number;
  43331. /**
  43332. * Define if the sound track is the main sound track of the scene
  43333. */
  43334. mainTrack?: boolean;
  43335. }
  43336. /**
  43337. * It could be useful to isolate your music & sounds on several tracks to better manage volume on a grouped instance of sounds.
  43338. * It will be also used in a future release to apply effects on a specific track.
  43339. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music#using-sound-tracks
  43340. */
  43341. export class SoundTrack {
  43342. /**
  43343. * The unique identifier of the sound track in the scene.
  43344. */
  43345. id: number;
  43346. /**
  43347. * The list of sounds included in the sound track.
  43348. */
  43349. soundCollection: Array<Sound>;
  43350. private _outputAudioNode;
  43351. private _scene;
  43352. private _connectedAnalyser;
  43353. private _options;
  43354. private _isInitialized;
  43355. /**
  43356. * Creates a new sound track.
  43357. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music#using-sound-tracks
  43358. * @param scene Define the scene the sound track belongs to
  43359. * @param options
  43360. */
  43361. constructor(scene: Scene, options?: ISoundTrackOptions);
  43362. private _initializeSoundTrackAudioGraph;
  43363. /**
  43364. * Release the sound track and its associated resources
  43365. */
  43366. dispose(): void;
  43367. /**
  43368. * Adds a sound to this sound track
  43369. * @param sound define the cound to add
  43370. * @ignoreNaming
  43371. */
  43372. AddSound(sound: Sound): void;
  43373. /**
  43374. * Removes a sound to this sound track
  43375. * @param sound define the cound to remove
  43376. * @ignoreNaming
  43377. */
  43378. RemoveSound(sound: Sound): void;
  43379. /**
  43380. * Set a global volume for the full sound track.
  43381. * @param newVolume Define the new volume of the sound track
  43382. */
  43383. setVolume(newVolume: number): void;
  43384. /**
  43385. * Switch the panning model to HRTF:
  43386. * Renders a stereo output of higher quality than equalpower — it uses a convolution with measured impulse responses from human subjects.
  43387. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music#creating-a-spatial-3d-sound
  43388. */
  43389. switchPanningModelToHRTF(): void;
  43390. /**
  43391. * Switch the panning model to Equal Power:
  43392. * Represents the equal-power panning algorithm, generally regarded as simple and efficient. equalpower is the default value.
  43393. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music#creating-a-spatial-3d-sound
  43394. */
  43395. switchPanningModelToEqualPower(): void;
  43396. /**
  43397. * Connect the sound track to an audio analyser allowing some amazing
  43398. * synchornization between the sounds/music and your visualization (VuMeter for instance).
  43399. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music#using-the-analyser
  43400. * @param analyser The analyser to connect to the engine
  43401. */
  43402. connectToAnalyser(analyser: Analyser): void;
  43403. }
  43404. }
  43405. declare module "babylonjs/Audio/audioSceneComponent" {
  43406. import { Sound } from "babylonjs/Audio/sound";
  43407. import { SoundTrack } from "babylonjs/Audio/soundTrack";
  43408. import { Nullable } from "babylonjs/types";
  43409. import { Vector3 } from "babylonjs/Maths/math.vector";
  43410. import { ISceneSerializableComponent } from "babylonjs/sceneComponent";
  43411. import { Scene } from "babylonjs/scene";
  43412. import { AbstractScene } from "babylonjs/abstractScene";
  43413. import "babylonjs/Audio/audioEngine";
  43414. module "babylonjs/abstractScene" {
  43415. interface AbstractScene {
  43416. /**
  43417. * The list of sounds used in the scene.
  43418. */
  43419. sounds: Nullable<Array<Sound>>;
  43420. }
  43421. }
  43422. module "babylonjs/scene" {
  43423. interface Scene {
  43424. /**
  43425. * @hidden
  43426. * Backing field
  43427. */
  43428. _mainSoundTrack: SoundTrack;
  43429. /**
  43430. * The main sound track played by the scene.
  43431. * It cotains your primary collection of sounds.
  43432. */
  43433. mainSoundTrack: SoundTrack;
  43434. /**
  43435. * The list of sound tracks added to the scene
  43436. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music
  43437. */
  43438. soundTracks: Nullable<Array<SoundTrack>>;
  43439. /**
  43440. * Gets a sound using a given name
  43441. * @param name defines the name to search for
  43442. * @return the found sound or null if not found at all.
  43443. */
  43444. getSoundByName(name: string): Nullable<Sound>;
  43445. /**
  43446. * Gets or sets if audio support is enabled
  43447. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music
  43448. */
  43449. audioEnabled: boolean;
  43450. /**
  43451. * Gets or sets if audio will be output to headphones
  43452. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music
  43453. */
  43454. headphone: boolean;
  43455. /**
  43456. * Gets or sets custom audio listener position provider
  43457. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music
  43458. */
  43459. audioListenerPositionProvider: Nullable<() => Vector3>;
  43460. /**
  43461. * Gets or sets a refresh rate when using 3D audio positioning
  43462. */
  43463. audioPositioningRefreshRate: number;
  43464. }
  43465. }
  43466. /**
  43467. * Defines the sound scene component responsible to manage any sounds
  43468. * in a given scene.
  43469. */
  43470. export class AudioSceneComponent implements ISceneSerializableComponent {
  43471. /**
  43472. * The component name helpfull to identify the component in the list of scene components.
  43473. */
  43474. readonly name: string;
  43475. /**
  43476. * The scene the component belongs to.
  43477. */
  43478. scene: Scene;
  43479. private _audioEnabled;
  43480. /**
  43481. * Gets whether audio is enabled or not.
  43482. * Please use related enable/disable method to switch state.
  43483. */
  43484. get audioEnabled(): boolean;
  43485. private _headphone;
  43486. /**
  43487. * Gets whether audio is outputing to headphone or not.
  43488. * Please use the according Switch methods to change output.
  43489. */
  43490. get headphone(): boolean;
  43491. /**
  43492. * Gets or sets a refresh rate when using 3D audio positioning
  43493. */
  43494. audioPositioningRefreshRate: number;
  43495. private _audioListenerPositionProvider;
  43496. /**
  43497. * Gets the current audio listener position provider
  43498. */
  43499. get audioListenerPositionProvider(): Nullable<() => Vector3>;
  43500. /**
  43501. * Sets a custom listener position for all sounds in the scene
  43502. * By default, this is the position of the first active camera
  43503. */
  43504. set audioListenerPositionProvider(value: Nullable<() => Vector3>);
  43505. /**
  43506. * Creates a new instance of the component for the given scene
  43507. * @param scene Defines the scene to register the component in
  43508. */
  43509. constructor(scene: Scene);
  43510. /**
  43511. * Registers the component in a given scene
  43512. */
  43513. register(): void;
  43514. /**
  43515. * Rebuilds the elements related to this component in case of
  43516. * context lost for instance.
  43517. */
  43518. rebuild(): void;
  43519. /**
  43520. * Serializes the component data to the specified json object
  43521. * @param serializationObject The object to serialize to
  43522. */
  43523. serialize(serializationObject: any): void;
  43524. /**
  43525. * Adds all the elements from the container to the scene
  43526. * @param container the container holding the elements
  43527. */
  43528. addFromContainer(container: AbstractScene): void;
  43529. /**
  43530. * Removes all the elements in the container from the scene
  43531. * @param container contains the elements to remove
  43532. * @param dispose if the removed element should be disposed (default: false)
  43533. */
  43534. removeFromContainer(container: AbstractScene, dispose?: boolean): void;
  43535. /**
  43536. * Disposes the component and the associated ressources.
  43537. */
  43538. dispose(): void;
  43539. /**
  43540. * Disables audio in the associated scene.
  43541. */
  43542. disableAudio(): void;
  43543. /**
  43544. * Enables audio in the associated scene.
  43545. */
  43546. enableAudio(): void;
  43547. /**
  43548. * Switch audio to headphone output.
  43549. */
  43550. switchAudioModeForHeadphones(): void;
  43551. /**
  43552. * Switch audio to normal speakers.
  43553. */
  43554. switchAudioModeForNormalSpeakers(): void;
  43555. private _cachedCameraDirection;
  43556. private _cachedCameraPosition;
  43557. private _lastCheck;
  43558. private _afterRender;
  43559. }
  43560. }
  43561. declare module "babylonjs/Audio/weightedsound" {
  43562. import { Sound } from "babylonjs/Audio/sound";
  43563. /**
  43564. * Wraps one or more Sound objects and selects one with random weight for playback.
  43565. */
  43566. export class WeightedSound {
  43567. /** When true a Sound will be selected and played when the current playing Sound completes. */
  43568. loop: boolean;
  43569. private _coneInnerAngle;
  43570. private _coneOuterAngle;
  43571. private _volume;
  43572. /** A Sound is currently playing. */
  43573. isPlaying: boolean;
  43574. /** A Sound is currently paused. */
  43575. isPaused: boolean;
  43576. private _sounds;
  43577. private _weights;
  43578. private _currentIndex?;
  43579. /**
  43580. * Creates a new WeightedSound from the list of sounds given.
  43581. * @param loop When true a Sound will be selected and played when the current playing Sound completes.
  43582. * @param sounds Array of Sounds that will be selected from.
  43583. * @param weights Array of number values for selection weights; length must equal sounds, values will be normalized to 1
  43584. */
  43585. constructor(loop: boolean, sounds: Sound[], weights: number[]);
  43586. /**
  43587. * The size of cone in degrees for a directional sound in which there will be no attenuation.
  43588. */
  43589. get directionalConeInnerAngle(): number;
  43590. /**
  43591. * The size of cone in degress for a directional sound in which there will be no attenuation.
  43592. */
  43593. set directionalConeInnerAngle(value: number);
  43594. /**
  43595. * Size of cone in degrees for a directional sound outside of which there will be no sound.
  43596. * Listener angles between innerAngle and outerAngle will falloff linearly.
  43597. */
  43598. get directionalConeOuterAngle(): number;
  43599. /**
  43600. * Size of cone in degrees for a directional sound outside of which there will be no sound.
  43601. * Listener angles between innerAngle and outerAngle will falloff linearly.
  43602. */
  43603. set directionalConeOuterAngle(value: number);
  43604. /**
  43605. * Playback volume.
  43606. */
  43607. get volume(): number;
  43608. /**
  43609. * Playback volume.
  43610. */
  43611. set volume(value: number);
  43612. private _onended;
  43613. /**
  43614. * Suspend playback
  43615. */
  43616. pause(): void;
  43617. /**
  43618. * Stop playback
  43619. */
  43620. stop(): void;
  43621. /**
  43622. * Start playback.
  43623. * @param startOffset Position the clip head at a specific time in seconds.
  43624. */
  43625. play(startOffset?: number): void;
  43626. }
  43627. }
  43628. declare module "babylonjs/Audio/index" {
  43629. export * from "babylonjs/Audio/analyser";
  43630. export * from "babylonjs/Audio/audioEngine";
  43631. export * from "babylonjs/Audio/audioSceneComponent";
  43632. export * from "babylonjs/Audio/sound";
  43633. export * from "babylonjs/Audio/soundTrack";
  43634. export * from "babylonjs/Audio/weightedsound";
  43635. }
  43636. declare module "babylonjs/Behaviors/Cameras/bouncingBehavior" {
  43637. import { Behavior } from "babylonjs/Behaviors/behavior";
  43638. import { ArcRotateCamera } from "babylonjs/Cameras/arcRotateCamera";
  43639. import { BackEase } from "babylonjs/Animations/easing";
  43640. /**
  43641. * Add a bouncing effect to an ArcRotateCamera when reaching a specified minimum and maximum radius
  43642. * @see https://doc.babylonjs.com/how_to/camera_behaviors#bouncing-behavior
  43643. */
  43644. export class BouncingBehavior implements Behavior<ArcRotateCamera> {
  43645. /**
  43646. * Gets the name of the behavior.
  43647. */
  43648. get name(): string;
  43649. /**
  43650. * The easing function used by animations
  43651. */
  43652. static EasingFunction: BackEase;
  43653. /**
  43654. * The easing mode used by animations
  43655. */
  43656. static EasingMode: number;
  43657. /**
  43658. * The duration of the animation, in milliseconds
  43659. */
  43660. transitionDuration: number;
  43661. /**
  43662. * Length of the distance animated by the transition when lower radius is reached
  43663. */
  43664. lowerRadiusTransitionRange: number;
  43665. /**
  43666. * Length of the distance animated by the transition when upper radius is reached
  43667. */
  43668. upperRadiusTransitionRange: number;
  43669. private _autoTransitionRange;
  43670. /**
  43671. * Gets a value indicating if the lowerRadiusTransitionRange and upperRadiusTransitionRange are defined automatically
  43672. */
  43673. get autoTransitionRange(): boolean;
  43674. /**
  43675. * Sets a value indicating if the lowerRadiusTransitionRange and upperRadiusTransitionRange are defined automatically
  43676. * Transition ranges will be set to 5% of the bounding box diagonal in world space
  43677. */
  43678. set autoTransitionRange(value: boolean);
  43679. private _attachedCamera;
  43680. private _onAfterCheckInputsObserver;
  43681. private _onMeshTargetChangedObserver;
  43682. /**
  43683. * Initializes the behavior.
  43684. */
  43685. init(): void;
  43686. /**
  43687. * Attaches the behavior to its arc rotate camera.
  43688. * @param camera Defines the camera to attach the behavior to
  43689. */
  43690. attach(camera: ArcRotateCamera): void;
  43691. /**
  43692. * Detaches the behavior from its current arc rotate camera.
  43693. */
  43694. detach(): void;
  43695. private _radiusIsAnimating;
  43696. private _radiusBounceTransition;
  43697. private _animatables;
  43698. private _cachedWheelPrecision;
  43699. /**
  43700. * Checks if the camera radius is at the specified limit. Takes into account animation locks.
  43701. * @param radiusLimit The limit to check against.
  43702. * @return Bool to indicate if at limit.
  43703. */
  43704. private _isRadiusAtLimit;
  43705. /**
  43706. * Applies an animation to the radius of the camera, extending by the radiusDelta.
  43707. * @param radiusDelta The delta by which to animate to. Can be negative.
  43708. */
  43709. private _applyBoundRadiusAnimation;
  43710. /**
  43711. * Removes all animation locks. Allows new animations to be added to any of the camera properties.
  43712. */
  43713. protected _clearAnimationLocks(): void;
  43714. /**
  43715. * Stops and removes all animations that have been applied to the camera
  43716. */
  43717. stopAllAnimations(): void;
  43718. }
  43719. }
  43720. declare module "babylonjs/Behaviors/Cameras/framingBehavior" {
  43721. import { Behavior } from "babylonjs/Behaviors/behavior";
  43722. import { ArcRotateCamera } from "babylonjs/Cameras/arcRotateCamera";
  43723. import { ExponentialEase } from "babylonjs/Animations/easing";
  43724. import { Nullable } from "babylonjs/types";
  43725. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  43726. import { Vector3 } from "babylonjs/Maths/math.vector";
  43727. /**
  43728. * 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.
  43729. * @see https://doc.babylonjs.com/how_to/camera_behaviors#framing-behavior
  43730. */
  43731. export class FramingBehavior implements Behavior<ArcRotateCamera> {
  43732. /**
  43733. * Gets the name of the behavior.
  43734. */
  43735. get name(): string;
  43736. private _mode;
  43737. private _radiusScale;
  43738. private _positionScale;
  43739. private _defaultElevation;
  43740. private _elevationReturnTime;
  43741. private _elevationReturnWaitTime;
  43742. private _zoomStopsAnimation;
  43743. private _framingTime;
  43744. /**
  43745. * The easing function used by animations
  43746. */
  43747. static EasingFunction: ExponentialEase;
  43748. /**
  43749. * The easing mode used by animations
  43750. */
  43751. static EasingMode: number;
  43752. /**
  43753. * Sets the current mode used by the behavior
  43754. */
  43755. set mode(mode: number);
  43756. /**
  43757. * Gets current mode used by the behavior.
  43758. */
  43759. get mode(): number;
  43760. /**
  43761. * Sets the scale applied to the radius (1 by default)
  43762. */
  43763. set radiusScale(radius: number);
  43764. /**
  43765. * Gets the scale applied to the radius
  43766. */
  43767. get radiusScale(): number;
  43768. /**
  43769. * Sets the scale to apply on Y axis to position camera focus. 0.5 by default which means the center of the bounding box.
  43770. */
  43771. set positionScale(scale: number);
  43772. /**
  43773. * Gets the scale to apply on Y axis to position camera focus. 0.5 by default which means the center of the bounding box.
  43774. */
  43775. get positionScale(): number;
  43776. /**
  43777. * Sets the angle above/below the horizontal plane to return to when the return to default elevation idle
  43778. * behaviour is triggered, in radians.
  43779. */
  43780. set defaultElevation(elevation: number);
  43781. /**
  43782. * Gets the angle above/below the horizontal plane to return to when the return to default elevation idle
  43783. * behaviour is triggered, in radians.
  43784. */
  43785. get defaultElevation(): number;
  43786. /**
  43787. * Sets the time (in milliseconds) taken to return to the default beta position.
  43788. * Negative value indicates camera should not return to default.
  43789. */
  43790. set elevationReturnTime(speed: number);
  43791. /**
  43792. * Gets the time (in milliseconds) taken to return to the default beta position.
  43793. * Negative value indicates camera should not return to default.
  43794. */
  43795. get elevationReturnTime(): number;
  43796. /**
  43797. * Sets the delay (in milliseconds) taken before the camera returns to the default beta position.
  43798. */
  43799. set elevationReturnWaitTime(time: number);
  43800. /**
  43801. * Gets the delay (in milliseconds) taken before the camera returns to the default beta position.
  43802. */
  43803. get elevationReturnWaitTime(): number;
  43804. /**
  43805. * Sets the flag that indicates if user zooming should stop animation.
  43806. */
  43807. set zoomStopsAnimation(flag: boolean);
  43808. /**
  43809. * Gets the flag that indicates if user zooming should stop animation.
  43810. */
  43811. get zoomStopsAnimation(): boolean;
  43812. /**
  43813. * Sets the transition time when framing the mesh, in milliseconds
  43814. */
  43815. set framingTime(time: number);
  43816. /**
  43817. * Gets the transition time when framing the mesh, in milliseconds
  43818. */
  43819. get framingTime(): number;
  43820. /**
  43821. * Define if the behavior should automatically change the configured
  43822. * camera limits and sensibilities.
  43823. */
  43824. autoCorrectCameraLimitsAndSensibility: boolean;
  43825. private _onPrePointerObservableObserver;
  43826. private _onAfterCheckInputsObserver;
  43827. private _onMeshTargetChangedObserver;
  43828. private _attachedCamera;
  43829. private _isPointerDown;
  43830. private _lastInteractionTime;
  43831. /**
  43832. * Initializes the behavior.
  43833. */
  43834. init(): void;
  43835. /**
  43836. * Attaches the behavior to its arc rotate camera.
  43837. * @param camera Defines the camera to attach the behavior to
  43838. */
  43839. attach(camera: ArcRotateCamera): void;
  43840. /**
  43841. * Detaches the behavior from its current arc rotate camera.
  43842. */
  43843. detach(): void;
  43844. private _animatables;
  43845. private _betaIsAnimating;
  43846. private _betaTransition;
  43847. private _radiusTransition;
  43848. private _vectorTransition;
  43849. /**
  43850. * Targets the given mesh and updates zoom level accordingly.
  43851. * @param mesh The mesh to target.
  43852. * @param focusOnOriginXZ Determines if the camera should focus on 0 in the X and Z axis instead of the mesh
  43853. * @param onAnimationEnd Callback triggered at the end of the framing animation
  43854. */
  43855. zoomOnMesh(mesh: AbstractMesh, focusOnOriginXZ?: boolean, onAnimationEnd?: Nullable<() => void>): void;
  43856. /**
  43857. * Targets the given mesh with its children and updates zoom level accordingly.
  43858. * @param mesh The mesh to target.
  43859. * @param focusOnOriginXZ Determines if the camera should focus on 0 in the X and Z axis instead of the mesh
  43860. * @param onAnimationEnd Callback triggered at the end of the framing animation
  43861. */
  43862. zoomOnMeshHierarchy(mesh: AbstractMesh, focusOnOriginXZ?: boolean, onAnimationEnd?: Nullable<() => void>): void;
  43863. /**
  43864. * Targets the given meshes with their children and updates zoom level accordingly.
  43865. * @param meshes The mesh to target.
  43866. * @param focusOnOriginXZ Determines if the camera should focus on 0 in the X and Z axis instead of the mesh
  43867. * @param onAnimationEnd Callback triggered at the end of the framing animation
  43868. */
  43869. zoomOnMeshesHierarchy(meshes: AbstractMesh[], focusOnOriginXZ?: boolean, onAnimationEnd?: Nullable<() => void>): void;
  43870. /**
  43871. * Targets the bounding box info defined by its extends and updates zoom level accordingly.
  43872. * @param minimumWorld Determines the smaller position of the bounding box extend
  43873. * @param maximumWorld Determines the bigger position of the bounding box extend
  43874. * @param focusOnOriginXZ Determines if the camera should focus on 0 in the X and Z axis instead of the mesh
  43875. * @param onAnimationEnd Callback triggered at the end of the framing animation
  43876. */
  43877. zoomOnBoundingInfo(minimumWorld: Vector3, maximumWorld: Vector3, focusOnOriginXZ?: boolean, onAnimationEnd?: Nullable<() => void>): void;
  43878. /**
  43879. * Calculates the lowest radius for the camera based on the bounding box of the mesh.
  43880. * @param mesh The mesh on which to base the calculation. mesh boundingInfo used to estimate necessary
  43881. * frustum width.
  43882. * @return The minimum distance from the primary mesh's center point at which the camera must be kept in order
  43883. * to fully enclose the mesh in the viewing frustum.
  43884. */
  43885. protected _calculateLowerRadiusFromModelBoundingSphere(minimumWorld: Vector3, maximumWorld: Vector3): number;
  43886. /**
  43887. * Keeps the camera above the ground plane. If the user pulls the camera below the ground plane, the camera
  43888. * is automatically returned to its default position (expected to be above ground plane).
  43889. */
  43890. private _maintainCameraAboveGround;
  43891. /**
  43892. * Returns the frustum slope based on the canvas ratio and camera FOV
  43893. * @returns The frustum slope represented as a Vector2 with X and Y slopes
  43894. */
  43895. private _getFrustumSlope;
  43896. /**
  43897. * Removes all animation locks. Allows new animations to be added to any of the arcCamera properties.
  43898. */
  43899. private _clearAnimationLocks;
  43900. /**
  43901. * Applies any current user interaction to the camera. Takes into account maximum alpha rotation.
  43902. */
  43903. private _applyUserInteraction;
  43904. /**
  43905. * Stops and removes all animations that have been applied to the camera
  43906. */
  43907. stopAllAnimations(): void;
  43908. /**
  43909. * Gets a value indicating if the user is moving the camera
  43910. */
  43911. get isUserIsMoving(): boolean;
  43912. /**
  43913. * The camera can move all the way towards the mesh.
  43914. */
  43915. static IgnoreBoundsSizeMode: number;
  43916. /**
  43917. * The camera is not allowed to zoom closer to the mesh than the point at which the adjusted bounding sphere touches the frustum sides
  43918. */
  43919. static FitFrustumSidesMode: number;
  43920. }
  43921. }
  43922. declare module "babylonjs/Cameras/Inputs/BaseCameraPointersInput" {
  43923. import { Nullable } from "babylonjs/types";
  43924. import { Camera } from "babylonjs/Cameras/camera";
  43925. import { ICameraInput } from "babylonjs/Cameras/cameraInputsManager";
  43926. import { PointerTouch } from "babylonjs/Events/pointerEvents";
  43927. /**
  43928. * Base class for Camera Pointer Inputs.
  43929. * See FollowCameraPointersInput in src/Cameras/Inputs/followCameraPointersInput.ts
  43930. * for example usage.
  43931. */
  43932. export abstract class BaseCameraPointersInput implements ICameraInput<Camera> {
  43933. /**
  43934. * Defines the camera the input is attached to.
  43935. */
  43936. abstract camera: Camera;
  43937. /**
  43938. * Whether keyboard modifier keys are pressed at time of last mouse event.
  43939. */
  43940. protected _altKey: boolean;
  43941. protected _ctrlKey: boolean;
  43942. protected _metaKey: boolean;
  43943. protected _shiftKey: boolean;
  43944. /**
  43945. * Which mouse buttons were pressed at time of last mouse event.
  43946. * https://developer.mozilla.org/en-US/docs/Web/API/MouseEvent/buttons
  43947. */
  43948. protected _buttonsPressed: number;
  43949. /**
  43950. * Defines the buttons associated with the input to handle camera move.
  43951. */
  43952. buttons: number[];
  43953. /**
  43954. * Attach the input controls to a specific dom element to get the input from.
  43955. * @param element Defines the element the controls should be listened from
  43956. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  43957. */
  43958. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  43959. /**
  43960. * Detach the current controls from the specified dom element.
  43961. * @param element Defines the element to stop listening the inputs from
  43962. */
  43963. detachControl(element: Nullable<HTMLElement>): void;
  43964. /**
  43965. * Gets the class name of the current input.
  43966. * @returns the class name
  43967. */
  43968. getClassName(): string;
  43969. /**
  43970. * Get the friendly name associated with the input class.
  43971. * @returns the input friendly name
  43972. */
  43973. getSimpleName(): string;
  43974. /**
  43975. * Called on pointer POINTERDOUBLETAP event.
  43976. * Override this method to provide functionality on POINTERDOUBLETAP event.
  43977. */
  43978. protected onDoubleTap(type: string): void;
  43979. /**
  43980. * Called on pointer POINTERMOVE event if only a single touch is active.
  43981. * Override this method to provide functionality.
  43982. */
  43983. protected onTouch(point: Nullable<PointerTouch>, offsetX: number, offsetY: number): void;
  43984. /**
  43985. * Called on pointer POINTERMOVE event if multiple touches are active.
  43986. * Override this method to provide functionality.
  43987. */
  43988. protected onMultiTouch(pointA: Nullable<PointerTouch>, pointB: Nullable<PointerTouch>, previousPinchSquaredDistance: number, pinchSquaredDistance: number, previousMultiTouchPanPosition: Nullable<PointerTouch>, multiTouchPanPosition: Nullable<PointerTouch>): void;
  43989. /**
  43990. * Called on JS contextmenu event.
  43991. * Override this method to provide functionality.
  43992. */
  43993. protected onContextMenu(evt: PointerEvent): void;
  43994. /**
  43995. * Called each time a new POINTERDOWN event occurs. Ie, for each button
  43996. * press.
  43997. * Override this method to provide functionality.
  43998. */
  43999. protected onButtonDown(evt: PointerEvent): void;
  44000. /**
  44001. * Called each time a new POINTERUP event occurs. Ie, for each button
  44002. * release.
  44003. * Override this method to provide functionality.
  44004. */
  44005. protected onButtonUp(evt: PointerEvent): void;
  44006. /**
  44007. * Called when window becomes inactive.
  44008. * Override this method to provide functionality.
  44009. */
  44010. protected onLostFocus(): void;
  44011. private _pointerInput;
  44012. private _observer;
  44013. private _onLostFocus;
  44014. private pointA;
  44015. private pointB;
  44016. }
  44017. }
  44018. declare module "babylonjs/Cameras/Inputs/arcRotateCameraPointersInput" {
  44019. import { Nullable } from "babylonjs/types";
  44020. import { ArcRotateCamera } from "babylonjs/Cameras/arcRotateCamera";
  44021. import { BaseCameraPointersInput } from "babylonjs/Cameras/Inputs/BaseCameraPointersInput";
  44022. import { PointerTouch } from "babylonjs/Events/pointerEvents";
  44023. /**
  44024. * Manage the pointers inputs to control an arc rotate camera.
  44025. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  44026. */
  44027. export class ArcRotateCameraPointersInput extends BaseCameraPointersInput {
  44028. /**
  44029. * Defines the camera the input is attached to.
  44030. */
  44031. camera: ArcRotateCamera;
  44032. /**
  44033. * Gets the class name of the current input.
  44034. * @returns the class name
  44035. */
  44036. getClassName(): string;
  44037. /**
  44038. * Defines the buttons associated with the input to handle camera move.
  44039. */
  44040. buttons: number[];
  44041. /**
  44042. * Defines the pointer angular sensibility along the X axis or how fast is
  44043. * the camera rotating.
  44044. */
  44045. angularSensibilityX: number;
  44046. /**
  44047. * Defines the pointer angular sensibility along the Y axis or how fast is
  44048. * the camera rotating.
  44049. */
  44050. angularSensibilityY: number;
  44051. /**
  44052. * Defines the pointer pinch precision or how fast is the camera zooming.
  44053. */
  44054. pinchPrecision: number;
  44055. /**
  44056. * pinchDeltaPercentage will be used instead of pinchPrecision if different
  44057. * from 0.
  44058. * It defines the percentage of current camera.radius to use as delta when
  44059. * pinch zoom is used.
  44060. */
  44061. pinchDeltaPercentage: number;
  44062. /**
  44063. * When useNaturalPinchZoom is true, multi touch zoom will zoom in such
  44064. * that any object in the plane at the camera's target point will scale
  44065. * perfectly with finger motion.
  44066. * Overrides pinchDeltaPercentage and pinchPrecision.
  44067. */
  44068. useNaturalPinchZoom: boolean;
  44069. /**
  44070. * Defines the pointer panning sensibility or how fast is the camera moving.
  44071. */
  44072. panningSensibility: number;
  44073. /**
  44074. * Defines whether panning (2 fingers swipe) is enabled through multitouch.
  44075. */
  44076. multiTouchPanning: boolean;
  44077. /**
  44078. * Defines whether panning is enabled for both pan (2 fingers swipe) and
  44079. * zoom (pinch) through multitouch.
  44080. */
  44081. multiTouchPanAndZoom: boolean;
  44082. /**
  44083. * Revers pinch action direction.
  44084. */
  44085. pinchInwards: boolean;
  44086. private _isPanClick;
  44087. private _twoFingerActivityCount;
  44088. private _isPinching;
  44089. /**
  44090. * Called on pointer POINTERMOVE event if only a single touch is active.
  44091. */
  44092. protected onTouch(point: Nullable<PointerTouch>, offsetX: number, offsetY: number): void;
  44093. /**
  44094. * Called on pointer POINTERDOUBLETAP event.
  44095. */
  44096. protected onDoubleTap(type: string): void;
  44097. /**
  44098. * Called on pointer POINTERMOVE event if multiple touches are active.
  44099. */
  44100. protected onMultiTouch(pointA: Nullable<PointerTouch>, pointB: Nullable<PointerTouch>, previousPinchSquaredDistance: number, pinchSquaredDistance: number, previousMultiTouchPanPosition: Nullable<PointerTouch>, multiTouchPanPosition: Nullable<PointerTouch>): void;
  44101. /**
  44102. * Called each time a new POINTERDOWN event occurs. Ie, for each button
  44103. * press.
  44104. */
  44105. protected onButtonDown(evt: PointerEvent): void;
  44106. /**
  44107. * Called each time a new POINTERUP event occurs. Ie, for each button
  44108. * release.
  44109. */
  44110. protected onButtonUp(evt: PointerEvent): void;
  44111. /**
  44112. * Called when window becomes inactive.
  44113. */
  44114. protected onLostFocus(): void;
  44115. }
  44116. }
  44117. declare module "babylonjs/Cameras/Inputs/arcRotateCameraKeyboardMoveInput" {
  44118. import { Nullable } from "babylonjs/types";
  44119. import { ArcRotateCamera } from "babylonjs/Cameras/arcRotateCamera";
  44120. import { ICameraInput } from "babylonjs/Cameras/cameraInputsManager";
  44121. /**
  44122. * Manage the keyboard inputs to control the movement of an arc rotate camera.
  44123. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  44124. */
  44125. export class ArcRotateCameraKeyboardMoveInput implements ICameraInput<ArcRotateCamera> {
  44126. /**
  44127. * Defines the camera the input is attached to.
  44128. */
  44129. camera: ArcRotateCamera;
  44130. /**
  44131. * Defines the list of key codes associated with the up action (increase alpha)
  44132. */
  44133. keysUp: number[];
  44134. /**
  44135. * Defines the list of key codes associated with the down action (decrease alpha)
  44136. */
  44137. keysDown: number[];
  44138. /**
  44139. * Defines the list of key codes associated with the left action (increase beta)
  44140. */
  44141. keysLeft: number[];
  44142. /**
  44143. * Defines the list of key codes associated with the right action (decrease beta)
  44144. */
  44145. keysRight: number[];
  44146. /**
  44147. * Defines the list of key codes associated with the reset action.
  44148. * Those keys reset the camera to its last stored state (with the method camera.storeState())
  44149. */
  44150. keysReset: number[];
  44151. /**
  44152. * Defines the panning sensibility of the inputs.
  44153. * (How fast is the camera panning)
  44154. */
  44155. panningSensibility: number;
  44156. /**
  44157. * Defines the zooming sensibility of the inputs.
  44158. * (How fast is the camera zooming)
  44159. */
  44160. zoomingSensibility: number;
  44161. /**
  44162. * Defines whether maintaining the alt key down switch the movement mode from
  44163. * orientation to zoom.
  44164. */
  44165. useAltToZoom: boolean;
  44166. /**
  44167. * Rotation speed of the camera
  44168. */
  44169. angularSpeed: number;
  44170. private _keys;
  44171. private _ctrlPressed;
  44172. private _altPressed;
  44173. private _onCanvasBlurObserver;
  44174. private _onKeyboardObserver;
  44175. private _engine;
  44176. private _scene;
  44177. /**
  44178. * Attach the input controls to a specific dom element to get the input from.
  44179. * @param element Defines the element the controls should be listened from
  44180. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  44181. */
  44182. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  44183. /**
  44184. * Detach the current controls from the specified dom element.
  44185. * @param element Defines the element to stop listening the inputs from
  44186. */
  44187. detachControl(element: Nullable<HTMLElement>): void;
  44188. /**
  44189. * Update the current camera state depending on the inputs that have been used this frame.
  44190. * This is a dynamically created lambda to avoid the performance penalty of looping for inputs in the render loop.
  44191. */
  44192. checkInputs(): void;
  44193. /**
  44194. * Gets the class name of the current intput.
  44195. * @returns the class name
  44196. */
  44197. getClassName(): string;
  44198. /**
  44199. * Get the friendly name associated with the input class.
  44200. * @returns the input friendly name
  44201. */
  44202. getSimpleName(): string;
  44203. }
  44204. }
  44205. declare module "babylonjs/Cameras/Inputs/arcRotateCameraMouseWheelInput" {
  44206. import { Nullable } from "babylonjs/types";
  44207. import { ArcRotateCamera } from "babylonjs/Cameras/arcRotateCamera";
  44208. import { ICameraInput } from "babylonjs/Cameras/cameraInputsManager";
  44209. /**
  44210. * Manage the mouse wheel inputs to control an arc rotate camera.
  44211. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  44212. */
  44213. export class ArcRotateCameraMouseWheelInput implements ICameraInput<ArcRotateCamera> {
  44214. /**
  44215. * Defines the camera the input is attached to.
  44216. */
  44217. camera: ArcRotateCamera;
  44218. /**
  44219. * Gets or Set the mouse wheel precision or how fast is the camera zooming.
  44220. */
  44221. wheelPrecision: number;
  44222. /**
  44223. * wheelDeltaPercentage will be used instead of wheelPrecision if different from 0.
  44224. * It defines the percentage of current camera.radius to use as delta when wheel is used.
  44225. */
  44226. wheelDeltaPercentage: number;
  44227. private _wheel;
  44228. private _observer;
  44229. private computeDeltaFromMouseWheelLegacyEvent;
  44230. /**
  44231. * Attach the input controls to a specific dom element to get the input from.
  44232. * @param element Defines the element the controls should be listened from
  44233. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  44234. */
  44235. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  44236. /**
  44237. * Detach the current controls from the specified dom element.
  44238. * @param element Defines the element to stop listening the inputs from
  44239. */
  44240. detachControl(element: Nullable<HTMLElement>): void;
  44241. /**
  44242. * Gets the class name of the current intput.
  44243. * @returns the class name
  44244. */
  44245. getClassName(): string;
  44246. /**
  44247. * Get the friendly name associated with the input class.
  44248. * @returns the input friendly name
  44249. */
  44250. getSimpleName(): string;
  44251. }
  44252. }
  44253. declare module "babylonjs/Cameras/arcRotateCameraInputsManager" {
  44254. import { ArcRotateCamera } from "babylonjs/Cameras/arcRotateCamera";
  44255. import { CameraInputsManager } from "babylonjs/Cameras/cameraInputsManager";
  44256. /**
  44257. * Default Inputs manager for the ArcRotateCamera.
  44258. * It groups all the default supported inputs for ease of use.
  44259. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  44260. */
  44261. export class ArcRotateCameraInputsManager extends CameraInputsManager<ArcRotateCamera> {
  44262. /**
  44263. * Instantiates a new ArcRotateCameraInputsManager.
  44264. * @param camera Defines the camera the inputs belong to
  44265. */
  44266. constructor(camera: ArcRotateCamera);
  44267. /**
  44268. * Add mouse wheel input support to the input manager.
  44269. * @returns the current input manager
  44270. */
  44271. addMouseWheel(): ArcRotateCameraInputsManager;
  44272. /**
  44273. * Add pointers input support to the input manager.
  44274. * @returns the current input manager
  44275. */
  44276. addPointers(): ArcRotateCameraInputsManager;
  44277. /**
  44278. * Add keyboard input support to the input manager.
  44279. * @returns the current input manager
  44280. */
  44281. addKeyboard(): ArcRotateCameraInputsManager;
  44282. }
  44283. }
  44284. declare module "babylonjs/Cameras/arcRotateCamera" {
  44285. import { Observable } from "babylonjs/Misc/observable";
  44286. import { Nullable } from "babylonjs/types";
  44287. import { Scene } from "babylonjs/scene";
  44288. import { Matrix, Vector3, Vector2 } from "babylonjs/Maths/math.vector";
  44289. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  44290. import { AutoRotationBehavior } from "babylonjs/Behaviors/Cameras/autoRotationBehavior";
  44291. import { BouncingBehavior } from "babylonjs/Behaviors/Cameras/bouncingBehavior";
  44292. import { FramingBehavior } from "babylonjs/Behaviors/Cameras/framingBehavior";
  44293. import { Camera } from "babylonjs/Cameras/camera";
  44294. import { TargetCamera } from "babylonjs/Cameras/targetCamera";
  44295. import { ArcRotateCameraInputsManager } from "babylonjs/Cameras/arcRotateCameraInputsManager";
  44296. import { Collider } from "babylonjs/Collisions/collider";
  44297. /**
  44298. * This represents an orbital type of camera.
  44299. *
  44300. * 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.
  44301. * 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.
  44302. * @see https://doc.babylonjs.com/babylon101/cameras#arc-rotate-camera
  44303. */
  44304. export class ArcRotateCamera extends TargetCamera {
  44305. /**
  44306. * Defines the rotation angle of the camera along the longitudinal axis.
  44307. */
  44308. alpha: number;
  44309. /**
  44310. * Defines the rotation angle of the camera along the latitudinal axis.
  44311. */
  44312. beta: number;
  44313. /**
  44314. * Defines the radius of the camera from it s target point.
  44315. */
  44316. radius: number;
  44317. protected _target: Vector3;
  44318. protected _targetHost: Nullable<AbstractMesh>;
  44319. /**
  44320. * Defines the target point of the camera.
  44321. * The camera looks towards it form the radius distance.
  44322. * Please note that you can set the target to a mesh and thus the target will be copied from mesh.position
  44323. */
  44324. get target(): Vector3;
  44325. set target(value: Vector3);
  44326. /**
  44327. * Define the current local position of the camera in the scene
  44328. */
  44329. get position(): Vector3;
  44330. set position(newPosition: Vector3);
  44331. protected _upToYMatrix: Matrix;
  44332. protected _YToUpMatrix: Matrix;
  44333. /**
  44334. * The vector the camera should consider as up. (default is Vector3(0, 1, 0) as returned by Vector3.Up())
  44335. * Setting this will copy the given vector to the camera's upVector, and set rotation matrices to and from Y up.
  44336. * DO NOT set the up vector using copyFrom or copyFromFloats, as this bypasses setting the above matrices.
  44337. */
  44338. set upVector(vec: Vector3);
  44339. get upVector(): Vector3;
  44340. /**
  44341. * Sets the Y-up to camera up-vector rotation matrix, and the up-vector to Y-up rotation matrix.
  44342. */
  44343. setMatUp(): void;
  44344. /**
  44345. * Current inertia value on the longitudinal axis.
  44346. * The bigger this number the longer it will take for the camera to stop.
  44347. */
  44348. inertialAlphaOffset: number;
  44349. /**
  44350. * Current inertia value on the latitudinal axis.
  44351. * The bigger this number the longer it will take for the camera to stop.
  44352. */
  44353. inertialBetaOffset: number;
  44354. /**
  44355. * Current inertia value on the radius axis.
  44356. * The bigger this number the longer it will take for the camera to stop.
  44357. */
  44358. inertialRadiusOffset: number;
  44359. /**
  44360. * Minimum allowed angle on the longitudinal axis.
  44361. * This can help limiting how the Camera is able to move in the scene.
  44362. */
  44363. lowerAlphaLimit: Nullable<number>;
  44364. /**
  44365. * Maximum allowed angle on the longitudinal axis.
  44366. * This can help limiting how the Camera is able to move in the scene.
  44367. */
  44368. upperAlphaLimit: Nullable<number>;
  44369. /**
  44370. * Minimum allowed angle on the latitudinal axis.
  44371. * This can help limiting how the Camera is able to move in the scene.
  44372. */
  44373. lowerBetaLimit: number;
  44374. /**
  44375. * Maximum allowed angle on the latitudinal axis.
  44376. * This can help limiting how the Camera is able to move in the scene.
  44377. */
  44378. upperBetaLimit: number;
  44379. /**
  44380. * Minimum allowed distance of the camera to the target (The camera can not get closer).
  44381. * This can help limiting how the Camera is able to move in the scene.
  44382. */
  44383. lowerRadiusLimit: Nullable<number>;
  44384. /**
  44385. * Maximum allowed distance of the camera to the target (The camera can not get further).
  44386. * This can help limiting how the Camera is able to move in the scene.
  44387. */
  44388. upperRadiusLimit: Nullable<number>;
  44389. /**
  44390. * Defines the current inertia value used during panning of the camera along the X axis.
  44391. */
  44392. inertialPanningX: number;
  44393. /**
  44394. * Defines the current inertia value used during panning of the camera along the Y axis.
  44395. */
  44396. inertialPanningY: number;
  44397. /**
  44398. * Defines the distance used to consider the camera in pan mode vs pinch/zoom.
  44399. * Basically if your fingers moves away from more than this distance you will be considered
  44400. * in pinch mode.
  44401. */
  44402. pinchToPanMaxDistance: number;
  44403. /**
  44404. * Defines the maximum distance the camera can pan.
  44405. * This could help keeping the cammera always in your scene.
  44406. */
  44407. panningDistanceLimit: Nullable<number>;
  44408. /**
  44409. * Defines the target of the camera before paning.
  44410. */
  44411. panningOriginTarget: Vector3;
  44412. /**
  44413. * Defines the value of the inertia used during panning.
  44414. * 0 would mean stop inertia and one would mean no decelleration at all.
  44415. */
  44416. panningInertia: number;
  44417. /**
  44418. * Gets or Set the pointer angular sensibility along the X axis or how fast is the camera rotating.
  44419. */
  44420. get angularSensibilityX(): number;
  44421. set angularSensibilityX(value: number);
  44422. /**
  44423. * Gets or Set the pointer angular sensibility along the Y axis or how fast is the camera rotating.
  44424. */
  44425. get angularSensibilityY(): number;
  44426. set angularSensibilityY(value: number);
  44427. /**
  44428. * Gets or Set the pointer pinch precision or how fast is the camera zooming.
  44429. */
  44430. get pinchPrecision(): number;
  44431. set pinchPrecision(value: number);
  44432. /**
  44433. * Gets or Set the pointer pinch delta percentage or how fast is the camera zooming.
  44434. * It will be used instead of pinchDeltaPrecision if different from 0.
  44435. * It defines the percentage of current camera.radius to use as delta when pinch zoom is used.
  44436. */
  44437. get pinchDeltaPercentage(): number;
  44438. set pinchDeltaPercentage(value: number);
  44439. /**
  44440. * Gets or Set the pointer use natural pinch zoom to override the pinch precision
  44441. * and pinch delta percentage.
  44442. * When useNaturalPinchZoom is true, multi touch zoom will zoom in such
  44443. * that any object in the plane at the camera's target point will scale
  44444. * perfectly with finger motion.
  44445. */
  44446. get useNaturalPinchZoom(): boolean;
  44447. set useNaturalPinchZoom(value: boolean);
  44448. /**
  44449. * Gets or Set the pointer panning sensibility or how fast is the camera moving.
  44450. */
  44451. get panningSensibility(): number;
  44452. set panningSensibility(value: number);
  44453. /**
  44454. * Gets or Set the list of keyboard keys used to control beta angle in a positive direction.
  44455. */
  44456. get keysUp(): number[];
  44457. set keysUp(value: number[]);
  44458. /**
  44459. * Gets or Set the list of keyboard keys used to control beta angle in a negative direction.
  44460. */
  44461. get keysDown(): number[];
  44462. set keysDown(value: number[]);
  44463. /**
  44464. * Gets or Set the list of keyboard keys used to control alpha angle in a negative direction.
  44465. */
  44466. get keysLeft(): number[];
  44467. set keysLeft(value: number[]);
  44468. /**
  44469. * Gets or Set the list of keyboard keys used to control alpha angle in a positive direction.
  44470. */
  44471. get keysRight(): number[];
  44472. set keysRight(value: number[]);
  44473. /**
  44474. * Gets or Set the mouse wheel precision or how fast is the camera zooming.
  44475. */
  44476. get wheelPrecision(): number;
  44477. set wheelPrecision(value: number);
  44478. /**
  44479. * Gets or Set the mouse wheel delta percentage or how fast is the camera zooming.
  44480. * It will be used instead of pinchDeltaPrecision if different from 0.
  44481. * It defines the percentage of current camera.radius to use as delta when pinch zoom is used.
  44482. */
  44483. get wheelDeltaPercentage(): number;
  44484. set wheelDeltaPercentage(value: number);
  44485. /**
  44486. * Defines how much the radius should be scaled while zomming on a particular mesh (through the zoomOn function)
  44487. */
  44488. zoomOnFactor: number;
  44489. /**
  44490. * Defines a screen offset for the camera position.
  44491. */
  44492. targetScreenOffset: Vector2;
  44493. /**
  44494. * Allows the camera to be completely reversed.
  44495. * If false the camera can not arrive upside down.
  44496. */
  44497. allowUpsideDown: boolean;
  44498. /**
  44499. * Define if double tap/click is used to restore the previously saved state of the camera.
  44500. */
  44501. useInputToRestoreState: boolean;
  44502. /** @hidden */
  44503. _viewMatrix: Matrix;
  44504. /** @hidden */
  44505. _useCtrlForPanning: boolean;
  44506. /** @hidden */
  44507. _panningMouseButton: number;
  44508. /**
  44509. * Defines the input associated to the camera.
  44510. */
  44511. inputs: ArcRotateCameraInputsManager;
  44512. /** @hidden */
  44513. _reset: () => void;
  44514. /**
  44515. * Defines the allowed panning axis.
  44516. */
  44517. panningAxis: Vector3;
  44518. protected _localDirection: Vector3;
  44519. protected _transformedDirection: Vector3;
  44520. private _bouncingBehavior;
  44521. /**
  44522. * Gets the bouncing behavior of the camera if it has been enabled.
  44523. * @see https://doc.babylonjs.com/how_to/camera_behaviors#bouncing-behavior
  44524. */
  44525. get bouncingBehavior(): Nullable<BouncingBehavior>;
  44526. /**
  44527. * Defines if the bouncing behavior of the camera is enabled on the camera.
  44528. * @see https://doc.babylonjs.com/how_to/camera_behaviors#bouncing-behavior
  44529. */
  44530. get useBouncingBehavior(): boolean;
  44531. set useBouncingBehavior(value: boolean);
  44532. private _framingBehavior;
  44533. /**
  44534. * Gets the framing behavior of the camera if it has been enabled.
  44535. * @see https://doc.babylonjs.com/how_to/camera_behaviors#framing-behavior
  44536. */
  44537. get framingBehavior(): Nullable<FramingBehavior>;
  44538. /**
  44539. * Defines if the framing behavior of the camera is enabled on the camera.
  44540. * @see https://doc.babylonjs.com/how_to/camera_behaviors#framing-behavior
  44541. */
  44542. get useFramingBehavior(): boolean;
  44543. set useFramingBehavior(value: boolean);
  44544. private _autoRotationBehavior;
  44545. /**
  44546. * Gets the auto rotation behavior of the camera if it has been enabled.
  44547. * @see https://doc.babylonjs.com/how_to/camera_behaviors#autorotation-behavior
  44548. */
  44549. get autoRotationBehavior(): Nullable<AutoRotationBehavior>;
  44550. /**
  44551. * Defines if the auto rotation behavior of the camera is enabled on the camera.
  44552. * @see https://doc.babylonjs.com/how_to/camera_behaviors#autorotation-behavior
  44553. */
  44554. get useAutoRotationBehavior(): boolean;
  44555. set useAutoRotationBehavior(value: boolean);
  44556. /**
  44557. * Observable triggered when the mesh target has been changed on the camera.
  44558. */
  44559. onMeshTargetChangedObservable: Observable<Nullable<AbstractMesh>>;
  44560. /**
  44561. * Event raised when the camera is colliding with a mesh.
  44562. */
  44563. onCollide: (collidedMesh: AbstractMesh) => void;
  44564. /**
  44565. * Defines whether the camera should check collision with the objects oh the scene.
  44566. * @see https://doc.babylonjs.com/babylon101/cameras,_mesh_collisions_and_gravity#how-can-i-do-this
  44567. */
  44568. checkCollisions: boolean;
  44569. /**
  44570. * Defines the collision radius of the camera.
  44571. * This simulates a sphere around the camera.
  44572. * @see https://doc.babylonjs.com/babylon101/cameras,_mesh_collisions_and_gravity#arcrotatecamera
  44573. */
  44574. collisionRadius: Vector3;
  44575. protected _collider: Collider;
  44576. protected _previousPosition: Vector3;
  44577. protected _collisionVelocity: Vector3;
  44578. protected _newPosition: Vector3;
  44579. protected _previousAlpha: number;
  44580. protected _previousBeta: number;
  44581. protected _previousRadius: number;
  44582. protected _collisionTriggered: boolean;
  44583. protected _targetBoundingCenter: Nullable<Vector3>;
  44584. private _computationVector;
  44585. /**
  44586. * Instantiates a new ArcRotateCamera in a given scene
  44587. * @param name Defines the name of the camera
  44588. * @param alpha Defines the camera rotation along the logitudinal axis
  44589. * @param beta Defines the camera rotation along the latitudinal axis
  44590. * @param radius Defines the camera distance from its target
  44591. * @param target Defines the camera target
  44592. * @param scene Defines the scene the camera belongs to
  44593. * @param setActiveOnSceneIfNoneActive Defines wheter the camera should be marked as active if not other active cameras have been defined
  44594. */
  44595. constructor(name: string, alpha: number, beta: number, radius: number, target: Vector3, scene: Scene, setActiveOnSceneIfNoneActive?: boolean);
  44596. /** @hidden */
  44597. _initCache(): void;
  44598. /** @hidden */
  44599. _updateCache(ignoreParentClass?: boolean): void;
  44600. protected _getTargetPosition(): Vector3;
  44601. private _storedAlpha;
  44602. private _storedBeta;
  44603. private _storedRadius;
  44604. private _storedTarget;
  44605. private _storedTargetScreenOffset;
  44606. /**
  44607. * Stores the current state of the camera (alpha, beta, radius and target)
  44608. * @returns the camera itself
  44609. */
  44610. storeState(): Camera;
  44611. /**
  44612. * @hidden
  44613. * Restored camera state. You must call storeState() first
  44614. */
  44615. _restoreStateValues(): boolean;
  44616. /** @hidden */
  44617. _isSynchronizedViewMatrix(): boolean;
  44618. /**
  44619. * Attached controls to the current camera.
  44620. * @param element Defines the element the controls should be listened from
  44621. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  44622. * @param useCtrlForPanning Defines whether ctrl is used for paning within the controls
  44623. * @param panningMouseButton Defines whether panning is allowed through mouse click button
  44624. */
  44625. attachControl(element: HTMLElement, noPreventDefault?: boolean, useCtrlForPanning?: boolean, panningMouseButton?: number): void;
  44626. /**
  44627. * Detach the current controls from the camera.
  44628. * The camera will stop reacting to inputs.
  44629. * @param element Defines the element to stop listening the inputs from
  44630. */
  44631. detachControl(element: HTMLElement): void;
  44632. /** @hidden */
  44633. _checkInputs(): void;
  44634. protected _checkLimits(): void;
  44635. /**
  44636. * Rebuilds angles (alpha, beta) and radius from the give position and target
  44637. */
  44638. rebuildAnglesAndRadius(): void;
  44639. /**
  44640. * Use a position to define the current camera related information like alpha, beta and radius
  44641. * @param position Defines the position to set the camera at
  44642. */
  44643. setPosition(position: Vector3): void;
  44644. /**
  44645. * Defines the target the camera should look at.
  44646. * This will automatically adapt alpha beta and radius to fit within the new target.
  44647. * @param target Defines the new target as a Vector or a mesh
  44648. * @param toBoundingCenter In case of a mesh target, defines whether to target the mesh position or its bounding information center
  44649. * @param allowSamePosition If false, prevents reapplying the new computed position if it is identical to the current one (optim)
  44650. */
  44651. setTarget(target: AbstractMesh | Vector3, toBoundingCenter?: boolean, allowSamePosition?: boolean): void;
  44652. /** @hidden */
  44653. _getViewMatrix(): Matrix;
  44654. protected _onCollisionPositionChange: (collisionId: number, newPosition: Vector3, collidedMesh?: Nullable<AbstractMesh>) => void;
  44655. /**
  44656. * Zooms on a mesh to be at the min distance where we could see it fully in the current viewport.
  44657. * @param meshes Defines the mesh to zoom on
  44658. * @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)
  44659. */
  44660. zoomOn(meshes?: AbstractMesh[], doNotUpdateMaxZ?: boolean): void;
  44661. /**
  44662. * Focus on a mesh or a bounding box. This adapts the target and maxRadius if necessary but does not update the current radius.
  44663. * The target will be changed but the radius
  44664. * @param meshesOrMinMaxVectorAndDistance Defines the mesh or bounding info to focus on
  44665. * @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)
  44666. */
  44667. focusOn(meshesOrMinMaxVectorAndDistance: AbstractMesh[] | {
  44668. min: Vector3;
  44669. max: Vector3;
  44670. distance: number;
  44671. }, doNotUpdateMaxZ?: boolean): void;
  44672. /**
  44673. * @override
  44674. * Override Camera.createRigCamera
  44675. */
  44676. createRigCamera(name: string, cameraIndex: number): Camera;
  44677. /**
  44678. * @hidden
  44679. * @override
  44680. * Override Camera._updateRigCameras
  44681. */
  44682. _updateRigCameras(): void;
  44683. /**
  44684. * Destroy the camera and release the current resources hold by it.
  44685. */
  44686. dispose(): void;
  44687. /**
  44688. * Gets the current object class name.
  44689. * @return the class name
  44690. */
  44691. getClassName(): string;
  44692. }
  44693. }
  44694. declare module "babylonjs/Behaviors/Cameras/autoRotationBehavior" {
  44695. import { Behavior } from "babylonjs/Behaviors/behavior";
  44696. import { ArcRotateCamera } from "babylonjs/Cameras/arcRotateCamera";
  44697. /**
  44698. * The autoRotation behavior (AutoRotationBehavior) is designed to create a smooth rotation of an ArcRotateCamera when there is no user interaction.
  44699. * @see https://doc.babylonjs.com/how_to/camera_behaviors#autorotation-behavior
  44700. */
  44701. export class AutoRotationBehavior implements Behavior<ArcRotateCamera> {
  44702. /**
  44703. * Gets the name of the behavior.
  44704. */
  44705. get name(): string;
  44706. private _zoomStopsAnimation;
  44707. private _idleRotationSpeed;
  44708. private _idleRotationWaitTime;
  44709. private _idleRotationSpinupTime;
  44710. /**
  44711. * Sets the flag that indicates if user zooming should stop animation.
  44712. */
  44713. set zoomStopsAnimation(flag: boolean);
  44714. /**
  44715. * Gets the flag that indicates if user zooming should stop animation.
  44716. */
  44717. get zoomStopsAnimation(): boolean;
  44718. /**
  44719. * Sets the default speed at which the camera rotates around the model.
  44720. */
  44721. set idleRotationSpeed(speed: number);
  44722. /**
  44723. * Gets the default speed at which the camera rotates around the model.
  44724. */
  44725. get idleRotationSpeed(): number;
  44726. /**
  44727. * Sets the time (in milliseconds) to wait after user interaction before the camera starts rotating.
  44728. */
  44729. set idleRotationWaitTime(time: number);
  44730. /**
  44731. * Gets the time (milliseconds) to wait after user interaction before the camera starts rotating.
  44732. */
  44733. get idleRotationWaitTime(): number;
  44734. /**
  44735. * Sets the time (milliseconds) to take to spin up to the full idle rotation speed.
  44736. */
  44737. set idleRotationSpinupTime(time: number);
  44738. /**
  44739. * Gets the time (milliseconds) to take to spin up to the full idle rotation speed.
  44740. */
  44741. get idleRotationSpinupTime(): number;
  44742. /**
  44743. * Gets a value indicating if the camera is currently rotating because of this behavior
  44744. */
  44745. get rotationInProgress(): boolean;
  44746. private _onPrePointerObservableObserver;
  44747. private _onAfterCheckInputsObserver;
  44748. private _attachedCamera;
  44749. private _isPointerDown;
  44750. private _lastFrameTime;
  44751. private _lastInteractionTime;
  44752. private _cameraRotationSpeed;
  44753. /**
  44754. * Initializes the behavior.
  44755. */
  44756. init(): void;
  44757. /**
  44758. * Attaches the behavior to its arc rotate camera.
  44759. * @param camera Defines the camera to attach the behavior to
  44760. */
  44761. attach(camera: ArcRotateCamera): void;
  44762. /**
  44763. * Detaches the behavior from its current arc rotate camera.
  44764. */
  44765. detach(): void;
  44766. /**
  44767. * Returns true if user is scrolling.
  44768. * @return true if user is scrolling.
  44769. */
  44770. private _userIsZooming;
  44771. private _lastFrameRadius;
  44772. private _shouldAnimationStopForInteraction;
  44773. /**
  44774. * Applies any current user interaction to the camera. Takes into account maximum alpha rotation.
  44775. */
  44776. private _applyUserInteraction;
  44777. private _userIsMoving;
  44778. }
  44779. }
  44780. declare module "babylonjs/Behaviors/Cameras/index" {
  44781. export * from "babylonjs/Behaviors/Cameras/autoRotationBehavior";
  44782. export * from "babylonjs/Behaviors/Cameras/bouncingBehavior";
  44783. export * from "babylonjs/Behaviors/Cameras/framingBehavior";
  44784. }
  44785. declare module "babylonjs/Behaviors/Meshes/attachToBoxBehavior" {
  44786. import { Mesh } from "babylonjs/Meshes/mesh";
  44787. import { TransformNode } from "babylonjs/Meshes/transformNode";
  44788. import { Behavior } from "babylonjs/Behaviors/behavior";
  44789. /**
  44790. * A behavior that when attached to a mesh will will place a specified node on the meshes face pointing towards the camera
  44791. */
  44792. export class AttachToBoxBehavior implements Behavior<Mesh> {
  44793. private ui;
  44794. /**
  44795. * The name of the behavior
  44796. */
  44797. name: string;
  44798. /**
  44799. * The distance away from the face of the mesh that the UI should be attached to (default: 0.15)
  44800. */
  44801. distanceAwayFromFace: number;
  44802. /**
  44803. * The distance from the bottom of the face that the UI should be attached to (default: 0.15)
  44804. */
  44805. distanceAwayFromBottomOfFace: number;
  44806. private _faceVectors;
  44807. private _target;
  44808. private _scene;
  44809. private _onRenderObserver;
  44810. private _tmpMatrix;
  44811. private _tmpVector;
  44812. /**
  44813. * Creates the AttachToBoxBehavior, used to attach UI to the closest face of the box to a camera
  44814. * @param ui The transform node that should be attched to the mesh
  44815. */
  44816. constructor(ui: TransformNode);
  44817. /**
  44818. * Initializes the behavior
  44819. */
  44820. init(): void;
  44821. private _closestFace;
  44822. private _zeroVector;
  44823. private _lookAtTmpMatrix;
  44824. private _lookAtToRef;
  44825. /**
  44826. * Attaches the AttachToBoxBehavior to the passed in mesh
  44827. * @param target The mesh that the specified node will be attached to
  44828. */
  44829. attach(target: Mesh): void;
  44830. /**
  44831. * Detaches the behavior from the mesh
  44832. */
  44833. detach(): void;
  44834. }
  44835. }
  44836. declare module "babylonjs/Behaviors/Meshes/fadeInOutBehavior" {
  44837. import { Behavior } from "babylonjs/Behaviors/behavior";
  44838. import { Mesh } from "babylonjs/Meshes/mesh";
  44839. /**
  44840. * A behavior that when attached to a mesh will allow the mesh to fade in and out
  44841. */
  44842. export class FadeInOutBehavior implements Behavior<Mesh> {
  44843. /**
  44844. * Time in milliseconds to delay before fading in (Default: 0)
  44845. */
  44846. delay: number;
  44847. /**
  44848. * Time in milliseconds for the mesh to fade in (Default: 300)
  44849. */
  44850. fadeInTime: number;
  44851. private _millisecondsPerFrame;
  44852. private _hovered;
  44853. private _hoverValue;
  44854. private _ownerNode;
  44855. /**
  44856. * Instatiates the FadeInOutBehavior
  44857. */
  44858. constructor();
  44859. /**
  44860. * The name of the behavior
  44861. */
  44862. get name(): string;
  44863. /**
  44864. * Initializes the behavior
  44865. */
  44866. init(): void;
  44867. /**
  44868. * Attaches the fade behavior on the passed in mesh
  44869. * @param ownerNode The mesh that will be faded in/out once attached
  44870. */
  44871. attach(ownerNode: Mesh): void;
  44872. /**
  44873. * Detaches the behavior from the mesh
  44874. */
  44875. detach(): void;
  44876. /**
  44877. * Triggers the mesh to begin fading in or out
  44878. * @param value if the object should fade in or out (true to fade in)
  44879. */
  44880. fadeIn(value: boolean): void;
  44881. private _update;
  44882. private _setAllVisibility;
  44883. }
  44884. }
  44885. declare module "babylonjs/Misc/pivotTools" {
  44886. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  44887. /**
  44888. * Class containing a set of static utilities functions for managing Pivots
  44889. * @hidden
  44890. */
  44891. export class PivotTools {
  44892. private static _PivotCached;
  44893. private static _OldPivotPoint;
  44894. private static _PivotTranslation;
  44895. private static _PivotTmpVector;
  44896. /** @hidden */
  44897. static _RemoveAndStorePivotPoint(mesh: AbstractMesh): void;
  44898. /** @hidden */
  44899. static _RestorePivotPoint(mesh: AbstractMesh): void;
  44900. }
  44901. }
  44902. declare module "babylonjs/Meshes/Builders/planeBuilder" {
  44903. import { Scene } from "babylonjs/scene";
  44904. import { Vector4 } from "babylonjs/Maths/math.vector";
  44905. import { Mesh } from "babylonjs/Meshes/mesh";
  44906. import { Nullable } from "babylonjs/types";
  44907. import { Plane } from "babylonjs/Maths/math.plane";
  44908. /**
  44909. * Class containing static functions to help procedurally build meshes
  44910. */
  44911. export class PlaneBuilder {
  44912. /**
  44913. * Creates a plane mesh
  44914. * * The parameter `size` sets the size (float) of both sides of the plane at once (default 1)
  44915. * * You can set some different plane dimensions by using the parameters `width` and `height` (both by default have the same value of `size`)
  44916. * * The parameter `sourcePlane` is a Plane instance. It builds a mesh plane from a Math plane
  44917. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  44918. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  44919. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  44920. * @param name defines the name of the mesh
  44921. * @param options defines the options used to create the mesh
  44922. * @param scene defines the hosting scene
  44923. * @returns the plane mesh
  44924. * @see https://doc.babylonjs.com/how_to/set_shapes#plane
  44925. */
  44926. static CreatePlane(name: string, options: {
  44927. size?: number;
  44928. width?: number;
  44929. height?: number;
  44930. sideOrientation?: number;
  44931. frontUVs?: Vector4;
  44932. backUVs?: Vector4;
  44933. updatable?: boolean;
  44934. sourcePlane?: Plane;
  44935. }, scene?: Nullable<Scene>): Mesh;
  44936. }
  44937. }
  44938. declare module "babylonjs/Behaviors/Meshes/pointerDragBehavior" {
  44939. import { Behavior } from "babylonjs/Behaviors/behavior";
  44940. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  44941. import { Observable } from "babylonjs/Misc/observable";
  44942. import { Vector3 } from "babylonjs/Maths/math.vector";
  44943. import { Ray } from "babylonjs/Culling/ray";
  44944. import "babylonjs/Meshes/Builders/planeBuilder";
  44945. /**
  44946. * A behavior that when attached to a mesh will allow the mesh to be dragged around the screen based on pointer events
  44947. */
  44948. export class PointerDragBehavior implements Behavior<AbstractMesh> {
  44949. private static _AnyMouseID;
  44950. /**
  44951. * Abstract mesh the behavior is set on
  44952. */
  44953. attachedNode: AbstractMesh;
  44954. private _dragPlane;
  44955. private _scene;
  44956. private _pointerObserver;
  44957. private _beforeRenderObserver;
  44958. private static _planeScene;
  44959. private _useAlternatePickedPointAboveMaxDragAngleDragSpeed;
  44960. /**
  44961. * 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)
  44962. */
  44963. maxDragAngle: number;
  44964. /**
  44965. * @hidden
  44966. */
  44967. _useAlternatePickedPointAboveMaxDragAngle: boolean;
  44968. /**
  44969. * The id of the pointer that is currently interacting with the behavior (-1 when no pointer is active)
  44970. */
  44971. currentDraggingPointerID: number;
  44972. /**
  44973. * The last position where the pointer hit the drag plane in world space
  44974. */
  44975. lastDragPosition: Vector3;
  44976. /**
  44977. * If the behavior is currently in a dragging state
  44978. */
  44979. dragging: boolean;
  44980. /**
  44981. * 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)
  44982. */
  44983. dragDeltaRatio: number;
  44984. /**
  44985. * If the drag plane orientation should be updated during the dragging (Default: true)
  44986. */
  44987. updateDragPlane: boolean;
  44988. private _debugMode;
  44989. private _moving;
  44990. /**
  44991. * Fires each time the attached mesh is dragged with the pointer
  44992. * * delta between last drag position and current drag position in world space
  44993. * * dragDistance along the drag axis
  44994. * * dragPlaneNormal normal of the current drag plane used during the drag
  44995. * * dragPlanePoint in world space where the drag intersects the drag plane
  44996. */
  44997. onDragObservable: Observable<{
  44998. delta: Vector3;
  44999. dragPlanePoint: Vector3;
  45000. dragPlaneNormal: Vector3;
  45001. dragDistance: number;
  45002. pointerId: number;
  45003. }>;
  45004. /**
  45005. * Fires each time a drag begins (eg. mouse down on mesh)
  45006. */
  45007. onDragStartObservable: Observable<{
  45008. dragPlanePoint: Vector3;
  45009. pointerId: number;
  45010. }>;
  45011. /**
  45012. * Fires each time a drag ends (eg. mouse release after drag)
  45013. */
  45014. onDragEndObservable: Observable<{
  45015. dragPlanePoint: Vector3;
  45016. pointerId: number;
  45017. }>;
  45018. /**
  45019. * If the attached mesh should be moved when dragged
  45020. */
  45021. moveAttached: boolean;
  45022. /**
  45023. * If the drag behavior will react to drag events (Default: true)
  45024. */
  45025. enabled: boolean;
  45026. /**
  45027. * If pointer events should start and release the drag (Default: true)
  45028. */
  45029. startAndReleaseDragOnPointerEvents: boolean;
  45030. /**
  45031. * If camera controls should be detached during the drag
  45032. */
  45033. detachCameraControls: boolean;
  45034. /**
  45035. * If set, the drag plane/axis will be rotated based on the attached mesh's world rotation (Default: true)
  45036. */
  45037. useObjectOrientationForDragging: boolean;
  45038. private _options;
  45039. /**
  45040. * Gets the options used by the behavior
  45041. */
  45042. get options(): {
  45043. dragAxis?: Vector3;
  45044. dragPlaneNormal?: Vector3;
  45045. };
  45046. /**
  45047. * Sets the options used by the behavior
  45048. */
  45049. set options(options: {
  45050. dragAxis?: Vector3;
  45051. dragPlaneNormal?: Vector3;
  45052. });
  45053. /**
  45054. * Creates a pointer drag behavior that can be attached to a mesh
  45055. * @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)
  45056. */
  45057. constructor(options?: {
  45058. dragAxis?: Vector3;
  45059. dragPlaneNormal?: Vector3;
  45060. });
  45061. /**
  45062. * Predicate to determine if it is valid to move the object to a new position when it is moved
  45063. */
  45064. validateDrag: (targetPosition: Vector3) => boolean;
  45065. /**
  45066. * The name of the behavior
  45067. */
  45068. get name(): string;
  45069. /**
  45070. * Initializes the behavior
  45071. */
  45072. init(): void;
  45073. private _tmpVector;
  45074. private _alternatePickedPoint;
  45075. private _worldDragAxis;
  45076. private _targetPosition;
  45077. private _attachedElement;
  45078. /**
  45079. * Attaches the drag behavior the passed in mesh
  45080. * @param ownerNode The mesh that will be dragged around once attached
  45081. * @param predicate Predicate to use for pick filtering
  45082. */
  45083. attach(ownerNode: AbstractMesh, predicate?: (m: AbstractMesh) => boolean): void;
  45084. /**
  45085. * Force relase the drag action by code.
  45086. */
  45087. releaseDrag(): void;
  45088. private _startDragRay;
  45089. private _lastPointerRay;
  45090. /**
  45091. * Simulates the start of a pointer drag event on the behavior
  45092. * @param pointerId pointerID of the pointer that should be simulated (Default: Any mouse pointer ID)
  45093. * @param fromRay initial ray of the pointer to be simulated (Default: Ray from camera to attached mesh)
  45094. * @param startPickedPoint picked point of the pointer to be simulated (Default: attached mesh position)
  45095. */
  45096. startDrag(pointerId?: number, fromRay?: Ray, startPickedPoint?: Vector3): void;
  45097. private _startDrag;
  45098. private _dragDelta;
  45099. private _moveDrag;
  45100. private _pickWithRayOnDragPlane;
  45101. private _pointA;
  45102. private _pointC;
  45103. private _localAxis;
  45104. private _lookAt;
  45105. private _updateDragPlanePosition;
  45106. /**
  45107. * Detaches the behavior from the mesh
  45108. */
  45109. detach(): void;
  45110. }
  45111. }
  45112. declare module "babylonjs/Behaviors/Meshes/multiPointerScaleBehavior" {
  45113. import { Mesh } from "babylonjs/Meshes/mesh";
  45114. import { Behavior } from "babylonjs/Behaviors/behavior";
  45115. /**
  45116. * A behavior that when attached to a mesh will allow the mesh to be scaled
  45117. */
  45118. export class MultiPointerScaleBehavior implements Behavior<Mesh> {
  45119. private _dragBehaviorA;
  45120. private _dragBehaviorB;
  45121. private _startDistance;
  45122. private _initialScale;
  45123. private _targetScale;
  45124. private _ownerNode;
  45125. private _sceneRenderObserver;
  45126. /**
  45127. * Instantiate a new behavior that when attached to a mesh will allow the mesh to be scaled
  45128. */
  45129. constructor();
  45130. /**
  45131. * The name of the behavior
  45132. */
  45133. get name(): string;
  45134. /**
  45135. * Initializes the behavior
  45136. */
  45137. init(): void;
  45138. private _getCurrentDistance;
  45139. /**
  45140. * Attaches the scale behavior the passed in mesh
  45141. * @param ownerNode The mesh that will be scaled around once attached
  45142. */
  45143. attach(ownerNode: Mesh): void;
  45144. /**
  45145. * Detaches the behavior from the mesh
  45146. */
  45147. detach(): void;
  45148. }
  45149. }
  45150. declare module "babylonjs/Behaviors/Meshes/sixDofDragBehavior" {
  45151. import { Behavior } from "babylonjs/Behaviors/behavior";
  45152. import { Mesh } from "babylonjs/Meshes/mesh";
  45153. import { Observable } from "babylonjs/Misc/observable";
  45154. /**
  45155. * 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
  45156. */
  45157. export class SixDofDragBehavior implements Behavior<Mesh> {
  45158. private static _virtualScene;
  45159. private _ownerNode;
  45160. private _sceneRenderObserver;
  45161. private _scene;
  45162. private _targetPosition;
  45163. private _virtualOriginMesh;
  45164. private _virtualDragMesh;
  45165. private _pointerObserver;
  45166. private _moving;
  45167. private _startingOrientation;
  45168. private _attachedElement;
  45169. /**
  45170. * 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)
  45171. */
  45172. private zDragFactor;
  45173. /**
  45174. * If the object should rotate to face the drag origin
  45175. */
  45176. rotateDraggedObject: boolean;
  45177. /**
  45178. * If the behavior is currently in a dragging state
  45179. */
  45180. dragging: boolean;
  45181. /**
  45182. * 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)
  45183. */
  45184. dragDeltaRatio: number;
  45185. /**
  45186. * The id of the pointer that is currently interacting with the behavior (-1 when no pointer is active)
  45187. */
  45188. currentDraggingPointerID: number;
  45189. /**
  45190. * If camera controls should be detached during the drag
  45191. */
  45192. detachCameraControls: boolean;
  45193. /**
  45194. * Fires each time a drag starts
  45195. */
  45196. onDragStartObservable: Observable<{}>;
  45197. /**
  45198. * Fires each time a drag ends (eg. mouse release after drag)
  45199. */
  45200. onDragEndObservable: Observable<{}>;
  45201. /**
  45202. * 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
  45203. */
  45204. constructor();
  45205. /**
  45206. * The name of the behavior
  45207. */
  45208. get name(): string;
  45209. /**
  45210. * Initializes the behavior
  45211. */
  45212. init(): void;
  45213. /**
  45214. * In the case of multiplea active cameras, the cameraToUseForPointers should be used if set instead of active camera
  45215. */
  45216. private get _pointerCamera();
  45217. /**
  45218. * Attaches the scale behavior the passed in mesh
  45219. * @param ownerNode The mesh that will be scaled around once attached
  45220. */
  45221. attach(ownerNode: Mesh): void;
  45222. /**
  45223. * Detaches the behavior from the mesh
  45224. */
  45225. detach(): void;
  45226. }
  45227. }
  45228. declare module "babylonjs/Behaviors/Meshes/index" {
  45229. export * from "babylonjs/Behaviors/Meshes/attachToBoxBehavior";
  45230. export * from "babylonjs/Behaviors/Meshes/fadeInOutBehavior";
  45231. export * from "babylonjs/Behaviors/Meshes/multiPointerScaleBehavior";
  45232. export * from "babylonjs/Behaviors/Meshes/pointerDragBehavior";
  45233. export * from "babylonjs/Behaviors/Meshes/sixDofDragBehavior";
  45234. }
  45235. declare module "babylonjs/Behaviors/index" {
  45236. export * from "babylonjs/Behaviors/behavior";
  45237. export * from "babylonjs/Behaviors/Cameras/index";
  45238. export * from "babylonjs/Behaviors/Meshes/index";
  45239. }
  45240. declare module "babylonjs/Bones/boneIKController" {
  45241. import { Bone } from "babylonjs/Bones/bone";
  45242. import { Vector3 } from "babylonjs/Maths/math.vector";
  45243. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  45244. import { Nullable } from "babylonjs/types";
  45245. /**
  45246. * Class used to apply inverse kinematics to bones
  45247. * @see https://doc.babylonjs.com/how_to/how_to_use_bones_and_skeletons#boneikcontroller
  45248. */
  45249. export class BoneIKController {
  45250. private static _tmpVecs;
  45251. private static _tmpQuat;
  45252. private static _tmpMats;
  45253. /**
  45254. * Gets or sets the target mesh
  45255. */
  45256. targetMesh: AbstractMesh;
  45257. /** Gets or sets the mesh used as pole */
  45258. poleTargetMesh: AbstractMesh;
  45259. /**
  45260. * Gets or sets the bone used as pole
  45261. */
  45262. poleTargetBone: Nullable<Bone>;
  45263. /**
  45264. * Gets or sets the target position
  45265. */
  45266. targetPosition: Vector3;
  45267. /**
  45268. * Gets or sets the pole target position
  45269. */
  45270. poleTargetPosition: Vector3;
  45271. /**
  45272. * Gets or sets the pole target local offset
  45273. */
  45274. poleTargetLocalOffset: Vector3;
  45275. /**
  45276. * Gets or sets the pole angle
  45277. */
  45278. poleAngle: number;
  45279. /**
  45280. * Gets or sets the mesh associated with the controller
  45281. */
  45282. mesh: AbstractMesh;
  45283. /**
  45284. * 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)
  45285. */
  45286. slerpAmount: number;
  45287. private _bone1Quat;
  45288. private _bone1Mat;
  45289. private _bone2Ang;
  45290. private _bone1;
  45291. private _bone2;
  45292. private _bone1Length;
  45293. private _bone2Length;
  45294. private _maxAngle;
  45295. private _maxReach;
  45296. private _rightHandedSystem;
  45297. private _bendAxis;
  45298. private _slerping;
  45299. private _adjustRoll;
  45300. /**
  45301. * Gets or sets maximum allowed angle
  45302. */
  45303. get maxAngle(): number;
  45304. set maxAngle(value: number);
  45305. /**
  45306. * Creates a new BoneIKController
  45307. * @param mesh defines the mesh to control
  45308. * @param bone defines the bone to control
  45309. * @param options defines options to set up the controller
  45310. */
  45311. constructor(mesh: AbstractMesh, bone: Bone, options?: {
  45312. targetMesh?: AbstractMesh;
  45313. poleTargetMesh?: AbstractMesh;
  45314. poleTargetBone?: Bone;
  45315. poleTargetLocalOffset?: Vector3;
  45316. poleAngle?: number;
  45317. bendAxis?: Vector3;
  45318. maxAngle?: number;
  45319. slerpAmount?: number;
  45320. });
  45321. private _setMaxAngle;
  45322. /**
  45323. * Force the controller to update the bones
  45324. */
  45325. update(): void;
  45326. }
  45327. }
  45328. declare module "babylonjs/Bones/boneLookController" {
  45329. import { Vector3 } from "babylonjs/Maths/math.vector";
  45330. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  45331. import { Bone } from "babylonjs/Bones/bone";
  45332. import { Space } from "babylonjs/Maths/math.axis";
  45333. /**
  45334. * Class used to make a bone look toward a point in space
  45335. * @see https://doc.babylonjs.com/how_to/how_to_use_bones_and_skeletons#bonelookcontroller
  45336. */
  45337. export class BoneLookController {
  45338. private static _tmpVecs;
  45339. private static _tmpQuat;
  45340. private static _tmpMats;
  45341. /**
  45342. * The target Vector3 that the bone will look at
  45343. */
  45344. target: Vector3;
  45345. /**
  45346. * The mesh that the bone is attached to
  45347. */
  45348. mesh: AbstractMesh;
  45349. /**
  45350. * The bone that will be looking to the target
  45351. */
  45352. bone: Bone;
  45353. /**
  45354. * The up axis of the coordinate system that is used when the bone is rotated
  45355. */
  45356. upAxis: Vector3;
  45357. /**
  45358. * The space that the up axis is in - Space.BONE, Space.LOCAL (default), or Space.WORLD
  45359. */
  45360. upAxisSpace: Space;
  45361. /**
  45362. * Used to make an adjustment to the yaw of the bone
  45363. */
  45364. adjustYaw: number;
  45365. /**
  45366. * Used to make an adjustment to the pitch of the bone
  45367. */
  45368. adjustPitch: number;
  45369. /**
  45370. * Used to make an adjustment to the roll of the bone
  45371. */
  45372. adjustRoll: number;
  45373. /**
  45374. * 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)
  45375. */
  45376. slerpAmount: number;
  45377. private _minYaw;
  45378. private _maxYaw;
  45379. private _minPitch;
  45380. private _maxPitch;
  45381. private _minYawSin;
  45382. private _minYawCos;
  45383. private _maxYawSin;
  45384. private _maxYawCos;
  45385. private _midYawConstraint;
  45386. private _minPitchTan;
  45387. private _maxPitchTan;
  45388. private _boneQuat;
  45389. private _slerping;
  45390. private _transformYawPitch;
  45391. private _transformYawPitchInv;
  45392. private _firstFrameSkipped;
  45393. private _yawRange;
  45394. private _fowardAxis;
  45395. /**
  45396. * Gets or sets the minimum yaw angle that the bone can look to
  45397. */
  45398. get minYaw(): number;
  45399. set minYaw(value: number);
  45400. /**
  45401. * Gets or sets the maximum yaw angle that the bone can look to
  45402. */
  45403. get maxYaw(): number;
  45404. set maxYaw(value: number);
  45405. /**
  45406. * Gets or sets the minimum pitch angle that the bone can look to
  45407. */
  45408. get minPitch(): number;
  45409. set minPitch(value: number);
  45410. /**
  45411. * Gets or sets the maximum pitch angle that the bone can look to
  45412. */
  45413. get maxPitch(): number;
  45414. set maxPitch(value: number);
  45415. /**
  45416. * Create a BoneLookController
  45417. * @param mesh the mesh that the bone belongs to
  45418. * @param bone the bone that will be looking to the target
  45419. * @param target the target Vector3 to look at
  45420. * @param options optional settings:
  45421. * * maxYaw: the maximum angle the bone will yaw to
  45422. * * minYaw: the minimum angle the bone will yaw to
  45423. * * maxPitch: the maximum angle the bone will pitch to
  45424. * * minPitch: the minimum angle the bone will yaw to
  45425. * * slerpAmount: set the between 0 and 1 to make the bone slerp to the target.
  45426. * * upAxis: the up axis of the coordinate system
  45427. * * upAxisSpace: the space that the up axis is in - Space.BONE, Space.LOCAL (default), or Space.WORLD.
  45428. * * yawAxis: set yawAxis if the bone does not yaw on the y axis
  45429. * * pitchAxis: set pitchAxis if the bone does not pitch on the x axis
  45430. * * adjustYaw: used to make an adjustment to the yaw of the bone
  45431. * * adjustPitch: used to make an adjustment to the pitch of the bone
  45432. * * adjustRoll: used to make an adjustment to the roll of the bone
  45433. **/
  45434. constructor(mesh: AbstractMesh, bone: Bone, target: Vector3, options?: {
  45435. maxYaw?: number;
  45436. minYaw?: number;
  45437. maxPitch?: number;
  45438. minPitch?: number;
  45439. slerpAmount?: number;
  45440. upAxis?: Vector3;
  45441. upAxisSpace?: Space;
  45442. yawAxis?: Vector3;
  45443. pitchAxis?: Vector3;
  45444. adjustYaw?: number;
  45445. adjustPitch?: number;
  45446. adjustRoll?: number;
  45447. });
  45448. /**
  45449. * Update the bone to look at the target. This should be called before the scene is rendered (use scene.registerBeforeRender())
  45450. */
  45451. update(): void;
  45452. private _getAngleDiff;
  45453. private _getAngleBetween;
  45454. private _isAngleBetween;
  45455. }
  45456. }
  45457. declare module "babylonjs/Bones/index" {
  45458. export * from "babylonjs/Bones/bone";
  45459. export * from "babylonjs/Bones/boneIKController";
  45460. export * from "babylonjs/Bones/boneLookController";
  45461. export * from "babylonjs/Bones/skeleton";
  45462. }
  45463. declare module "babylonjs/Cameras/Inputs/arcRotateCameraGamepadInput" {
  45464. import { Nullable } from "babylonjs/types";
  45465. import { ArcRotateCamera } from "babylonjs/Cameras/arcRotateCamera";
  45466. import { ICameraInput } from "babylonjs/Cameras/cameraInputsManager";
  45467. import { Gamepad } from "babylonjs/Gamepads/gamepad";
  45468. /**
  45469. * Manage the gamepad inputs to control an arc rotate camera.
  45470. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  45471. */
  45472. export class ArcRotateCameraGamepadInput implements ICameraInput<ArcRotateCamera> {
  45473. /**
  45474. * Defines the camera the input is attached to.
  45475. */
  45476. camera: ArcRotateCamera;
  45477. /**
  45478. * Defines the gamepad the input is gathering event from.
  45479. */
  45480. gamepad: Nullable<Gamepad>;
  45481. /**
  45482. * Defines the gamepad rotation sensiblity.
  45483. * This is the threshold from when rotation starts to be accounted for to prevent jittering.
  45484. */
  45485. gamepadRotationSensibility: number;
  45486. /**
  45487. * Defines the gamepad move sensiblity.
  45488. * This is the threshold from when moving starts to be accounted for for to prevent jittering.
  45489. */
  45490. gamepadMoveSensibility: number;
  45491. private _yAxisScale;
  45492. /**
  45493. * Gets or sets a boolean indicating that Yaxis (for right stick) should be inverted
  45494. */
  45495. get invertYAxis(): boolean;
  45496. set invertYAxis(value: boolean);
  45497. private _onGamepadConnectedObserver;
  45498. private _onGamepadDisconnectedObserver;
  45499. /**
  45500. * Attach the input controls to a specific dom element to get the input from.
  45501. * @param element Defines the element the controls should be listened from
  45502. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  45503. */
  45504. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  45505. /**
  45506. * Detach the current controls from the specified dom element.
  45507. * @param element Defines the element to stop listening the inputs from
  45508. */
  45509. detachControl(element: Nullable<HTMLElement>): void;
  45510. /**
  45511. * Update the current camera state depending on the inputs that have been used this frame.
  45512. * This is a dynamically created lambda to avoid the performance penalty of looping for inputs in the render loop.
  45513. */
  45514. checkInputs(): void;
  45515. /**
  45516. * Gets the class name of the current intput.
  45517. * @returns the class name
  45518. */
  45519. getClassName(): string;
  45520. /**
  45521. * Get the friendly name associated with the input class.
  45522. * @returns the input friendly name
  45523. */
  45524. getSimpleName(): string;
  45525. }
  45526. }
  45527. declare module "babylonjs/Cameras/Inputs/arcRotateCameraVRDeviceOrientationInput" {
  45528. import { Nullable } from "babylonjs/types";
  45529. import { ArcRotateCamera } from "babylonjs/Cameras/arcRotateCamera";
  45530. import { ICameraInput } from "babylonjs/Cameras/cameraInputsManager";
  45531. module "babylonjs/Cameras/arcRotateCameraInputsManager" {
  45532. interface ArcRotateCameraInputsManager {
  45533. /**
  45534. * Add orientation input support to the input manager.
  45535. * @returns the current input manager
  45536. */
  45537. addVRDeviceOrientation(): ArcRotateCameraInputsManager;
  45538. }
  45539. }
  45540. /**
  45541. * Manage the device orientation inputs (gyroscope) to control an arc rotate camera.
  45542. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  45543. */
  45544. export class ArcRotateCameraVRDeviceOrientationInput implements ICameraInput<ArcRotateCamera> {
  45545. /**
  45546. * Defines the camera the input is attached to.
  45547. */
  45548. camera: ArcRotateCamera;
  45549. /**
  45550. * Defines a correction factor applied on the alpha value retrieved from the orientation events.
  45551. */
  45552. alphaCorrection: number;
  45553. /**
  45554. * Defines a correction factor applied on the gamma value retrieved from the orientation events.
  45555. */
  45556. gammaCorrection: number;
  45557. private _alpha;
  45558. private _gamma;
  45559. private _dirty;
  45560. private _deviceOrientationHandler;
  45561. /**
  45562. * Instantiate a new ArcRotateCameraVRDeviceOrientationInput.
  45563. */
  45564. constructor();
  45565. /**
  45566. * Attach the input controls to a specific dom element to get the input from.
  45567. * @param element Defines the element the controls should be listened from
  45568. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  45569. */
  45570. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  45571. /** @hidden */
  45572. _onOrientationEvent(evt: DeviceOrientationEvent): void;
  45573. /**
  45574. * Update the current camera state depending on the inputs that have been used this frame.
  45575. * This is a dynamically created lambda to avoid the performance penalty of looping for inputs in the render loop.
  45576. */
  45577. checkInputs(): void;
  45578. /**
  45579. * Detach the current controls from the specified dom element.
  45580. * @param element Defines the element to stop listening the inputs from
  45581. */
  45582. detachControl(element: Nullable<HTMLElement>): void;
  45583. /**
  45584. * Gets the class name of the current intput.
  45585. * @returns the class name
  45586. */
  45587. getClassName(): string;
  45588. /**
  45589. * Get the friendly name associated with the input class.
  45590. * @returns the input friendly name
  45591. */
  45592. getSimpleName(): string;
  45593. }
  45594. }
  45595. declare module "babylonjs/Cameras/Inputs/flyCameraMouseInput" {
  45596. import { Nullable } from "babylonjs/types";
  45597. import { ICameraInput } from "babylonjs/Cameras/cameraInputsManager";
  45598. import { FlyCamera } from "babylonjs/Cameras/flyCamera";
  45599. /**
  45600. * Listen to mouse events to control the camera.
  45601. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  45602. */
  45603. export class FlyCameraMouseInput implements ICameraInput<FlyCamera> {
  45604. /**
  45605. * Defines the camera the input is attached to.
  45606. */
  45607. camera: FlyCamera;
  45608. /**
  45609. * Defines if touch is enabled. (Default is true.)
  45610. */
  45611. touchEnabled: boolean;
  45612. /**
  45613. * Defines the buttons associated with the input to handle camera rotation.
  45614. */
  45615. buttons: number[];
  45616. /**
  45617. * Assign buttons for Yaw control.
  45618. */
  45619. buttonsYaw: number[];
  45620. /**
  45621. * Assign buttons for Pitch control.
  45622. */
  45623. buttonsPitch: number[];
  45624. /**
  45625. * Assign buttons for Roll control.
  45626. */
  45627. buttonsRoll: number[];
  45628. /**
  45629. * Detect if any button is being pressed while mouse is moved.
  45630. * -1 = Mouse locked.
  45631. * 0 = Left button.
  45632. * 1 = Middle Button.
  45633. * 2 = Right Button.
  45634. */
  45635. activeButton: number;
  45636. /**
  45637. * Defines the pointer's angular sensibility, to control the camera rotation speed.
  45638. * Higher values reduce its sensitivity.
  45639. */
  45640. angularSensibility: number;
  45641. private _mousemoveCallback;
  45642. private _observer;
  45643. private _rollObserver;
  45644. private previousPosition;
  45645. private noPreventDefault;
  45646. private element;
  45647. /**
  45648. * Listen to mouse events to control the camera.
  45649. * @param touchEnabled Define if touch is enabled. (Default is true.)
  45650. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  45651. */
  45652. constructor(touchEnabled?: boolean);
  45653. /**
  45654. * Attach the mouse control to the HTML DOM element.
  45655. * @param element Defines the element that listens to the input events.
  45656. * @param noPreventDefault Defines whether events caught by the controls should call preventdefault().
  45657. */
  45658. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  45659. /**
  45660. * Detach the current controls from the specified dom element.
  45661. * @param element Defines the element to stop listening the inputs from
  45662. */
  45663. detachControl(element: Nullable<HTMLElement>): void;
  45664. /**
  45665. * Gets the class name of the current input.
  45666. * @returns the class name.
  45667. */
  45668. getClassName(): string;
  45669. /**
  45670. * Get the friendly name associated with the input class.
  45671. * @returns the input's friendly name.
  45672. */
  45673. getSimpleName(): string;
  45674. private _pointerInput;
  45675. private _onMouseMove;
  45676. /**
  45677. * Rotate camera by mouse offset.
  45678. */
  45679. private rotateCamera;
  45680. }
  45681. }
  45682. declare module "babylonjs/Cameras/flyCameraInputsManager" {
  45683. import { FlyCamera } from "babylonjs/Cameras/flyCamera";
  45684. import { CameraInputsManager } from "babylonjs/Cameras/cameraInputsManager";
  45685. /**
  45686. * Default Inputs manager for the FlyCamera.
  45687. * It groups all the default supported inputs for ease of use.
  45688. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  45689. */
  45690. export class FlyCameraInputsManager extends CameraInputsManager<FlyCamera> {
  45691. /**
  45692. * Instantiates a new FlyCameraInputsManager.
  45693. * @param camera Defines the camera the inputs belong to.
  45694. */
  45695. constructor(camera: FlyCamera);
  45696. /**
  45697. * Add keyboard input support to the input manager.
  45698. * @returns the new FlyCameraKeyboardMoveInput().
  45699. */
  45700. addKeyboard(): FlyCameraInputsManager;
  45701. /**
  45702. * Add mouse input support to the input manager.
  45703. * @param touchEnabled Enable touch screen support.
  45704. * @returns the new FlyCameraMouseInput().
  45705. */
  45706. addMouse(touchEnabled?: boolean): FlyCameraInputsManager;
  45707. }
  45708. }
  45709. declare module "babylonjs/Cameras/flyCamera" {
  45710. import { Scene } from "babylonjs/scene";
  45711. import { Vector3, Quaternion } from "babylonjs/Maths/math.vector";
  45712. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  45713. import { TargetCamera } from "babylonjs/Cameras/targetCamera";
  45714. import { FlyCameraInputsManager } from "babylonjs/Cameras/flyCameraInputsManager";
  45715. /**
  45716. * This is a flying camera, designed for 3D movement and rotation in all directions,
  45717. * such as in a 3D Space Shooter or a Flight Simulator.
  45718. */
  45719. export class FlyCamera extends TargetCamera {
  45720. /**
  45721. * Define the collision ellipsoid of the camera.
  45722. * This is helpful for simulating a camera body, like a player's body.
  45723. * @see https://doc.babylonjs.com/babylon101/cameras,_mesh_collisions_and_gravity#arcrotatecamera
  45724. */
  45725. ellipsoid: Vector3;
  45726. /**
  45727. * Define an offset for the position of the ellipsoid around the camera.
  45728. * This can be helpful if the camera is attached away from the player's body center,
  45729. * such as at its head.
  45730. */
  45731. ellipsoidOffset: Vector3;
  45732. /**
  45733. * Enable or disable collisions of the camera with the rest of the scene objects.
  45734. */
  45735. checkCollisions: boolean;
  45736. /**
  45737. * Enable or disable gravity on the camera.
  45738. */
  45739. applyGravity: boolean;
  45740. /**
  45741. * Define the current direction the camera is moving to.
  45742. */
  45743. cameraDirection: Vector3;
  45744. /**
  45745. * Define the current local rotation of the camera as a quaternion to prevent Gimbal lock.
  45746. * This overrides and empties cameraRotation.
  45747. */
  45748. rotationQuaternion: Quaternion;
  45749. /**
  45750. * Track Roll to maintain the wanted Rolling when looking around.
  45751. */
  45752. _trackRoll: number;
  45753. /**
  45754. * Slowly correct the Roll to its original value after a Pitch+Yaw rotation.
  45755. */
  45756. rollCorrect: number;
  45757. /**
  45758. * Mimic a banked turn, Rolling the camera when Yawing.
  45759. * It's recommended to use rollCorrect = 10 for faster banking correction.
  45760. */
  45761. bankedTurn: boolean;
  45762. /**
  45763. * Limit in radians for how much Roll banking will add. (Default: 90°)
  45764. */
  45765. bankedTurnLimit: number;
  45766. /**
  45767. * Value of 0 disables the banked Roll.
  45768. * Value of 1 is equal to the Yaw angle in radians.
  45769. */
  45770. bankedTurnMultiplier: number;
  45771. /**
  45772. * The inputs manager loads all the input sources, such as keyboard and mouse.
  45773. */
  45774. inputs: FlyCameraInputsManager;
  45775. /**
  45776. * Gets the input sensibility for mouse input.
  45777. * Higher values reduce sensitivity.
  45778. */
  45779. get angularSensibility(): number;
  45780. /**
  45781. * Sets the input sensibility for a mouse input.
  45782. * Higher values reduce sensitivity.
  45783. */
  45784. set angularSensibility(value: number);
  45785. /**
  45786. * Get the keys for camera movement forward.
  45787. */
  45788. get keysForward(): number[];
  45789. /**
  45790. * Set the keys for camera movement forward.
  45791. */
  45792. set keysForward(value: number[]);
  45793. /**
  45794. * Get the keys for camera movement backward.
  45795. */
  45796. get keysBackward(): number[];
  45797. set keysBackward(value: number[]);
  45798. /**
  45799. * Get the keys for camera movement up.
  45800. */
  45801. get keysUp(): number[];
  45802. /**
  45803. * Set the keys for camera movement up.
  45804. */
  45805. set keysUp(value: number[]);
  45806. /**
  45807. * Get the keys for camera movement down.
  45808. */
  45809. get keysDown(): number[];
  45810. /**
  45811. * Set the keys for camera movement down.
  45812. */
  45813. set keysDown(value: number[]);
  45814. /**
  45815. * Get the keys for camera movement left.
  45816. */
  45817. get keysLeft(): number[];
  45818. /**
  45819. * Set the keys for camera movement left.
  45820. */
  45821. set keysLeft(value: number[]);
  45822. /**
  45823. * Set the keys for camera movement right.
  45824. */
  45825. get keysRight(): number[];
  45826. /**
  45827. * Set the keys for camera movement right.
  45828. */
  45829. set keysRight(value: number[]);
  45830. /**
  45831. * Event raised when the camera collides with a mesh in the scene.
  45832. */
  45833. onCollide: (collidedMesh: AbstractMesh) => void;
  45834. private _collider;
  45835. private _needMoveForGravity;
  45836. private _oldPosition;
  45837. private _diffPosition;
  45838. private _newPosition;
  45839. /** @hidden */
  45840. _localDirection: Vector3;
  45841. /** @hidden */
  45842. _transformedDirection: Vector3;
  45843. /**
  45844. * Instantiates a FlyCamera.
  45845. * This is a flying camera, designed for 3D movement and rotation in all directions,
  45846. * such as in a 3D Space Shooter or a Flight Simulator.
  45847. * @param name Define the name of the camera in the scene.
  45848. * @param position Define the starting position of the camera in the scene.
  45849. * @param scene Define the scene the camera belongs to.
  45850. * @param setActiveOnSceneIfNoneActive Defines wheter the camera should be marked as active, if no other camera has been defined as active.
  45851. */
  45852. constructor(name: string, position: Vector3, scene: Scene, setActiveOnSceneIfNoneActive?: boolean);
  45853. /**
  45854. * Attach a control to the HTML DOM element.
  45855. * @param element Defines the element that listens to the input events.
  45856. * @param noPreventDefault Defines whether events caught by the controls should call preventdefault(). https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault
  45857. */
  45858. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  45859. /**
  45860. * Detach a control from the HTML DOM element.
  45861. * The camera will stop reacting to that input.
  45862. * @param element Defines the element that listens to the input events.
  45863. */
  45864. detachControl(element: HTMLElement): void;
  45865. private _collisionMask;
  45866. /**
  45867. * Get the mask that the camera ignores in collision events.
  45868. */
  45869. get collisionMask(): number;
  45870. /**
  45871. * Set the mask that the camera ignores in collision events.
  45872. */
  45873. set collisionMask(mask: number);
  45874. /** @hidden */
  45875. _collideWithWorld(displacement: Vector3): void;
  45876. /** @hidden */
  45877. private _onCollisionPositionChange;
  45878. /** @hidden */
  45879. _checkInputs(): void;
  45880. /** @hidden */
  45881. _decideIfNeedsToMove(): boolean;
  45882. /** @hidden */
  45883. _updatePosition(): void;
  45884. /**
  45885. * Restore the Roll to its target value at the rate specified.
  45886. * @param rate - Higher means slower restoring.
  45887. * @hidden
  45888. */
  45889. restoreRoll(rate: number): void;
  45890. /**
  45891. * Destroy the camera and release the current resources held by it.
  45892. */
  45893. dispose(): void;
  45894. /**
  45895. * Get the current object class name.
  45896. * @returns the class name.
  45897. */
  45898. getClassName(): string;
  45899. }
  45900. }
  45901. declare module "babylonjs/Cameras/Inputs/flyCameraKeyboardInput" {
  45902. import { Nullable } from "babylonjs/types";
  45903. import { ICameraInput } from "babylonjs/Cameras/cameraInputsManager";
  45904. import { FlyCamera } from "babylonjs/Cameras/flyCamera";
  45905. /**
  45906. * Listen to keyboard events to control the camera.
  45907. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  45908. */
  45909. export class FlyCameraKeyboardInput implements ICameraInput<FlyCamera> {
  45910. /**
  45911. * Defines the camera the input is attached to.
  45912. */
  45913. camera: FlyCamera;
  45914. /**
  45915. * The list of keyboard keys used to control the forward move of the camera.
  45916. */
  45917. keysForward: number[];
  45918. /**
  45919. * The list of keyboard keys used to control the backward move of the camera.
  45920. */
  45921. keysBackward: number[];
  45922. /**
  45923. * The list of keyboard keys used to control the forward move of the camera.
  45924. */
  45925. keysUp: number[];
  45926. /**
  45927. * The list of keyboard keys used to control the backward move of the camera.
  45928. */
  45929. keysDown: number[];
  45930. /**
  45931. * The list of keyboard keys used to control the right strafe move of the camera.
  45932. */
  45933. keysRight: number[];
  45934. /**
  45935. * The list of keyboard keys used to control the left strafe move of the camera.
  45936. */
  45937. keysLeft: number[];
  45938. private _keys;
  45939. private _onCanvasBlurObserver;
  45940. private _onKeyboardObserver;
  45941. private _engine;
  45942. private _scene;
  45943. /**
  45944. * Attach the input controls to a specific dom element to get the input from.
  45945. * @param element Defines the element the controls should be listened from
  45946. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  45947. */
  45948. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  45949. /**
  45950. * Detach the current controls from the specified dom element.
  45951. * @param element Defines the element to stop listening the inputs from
  45952. */
  45953. detachControl(element: Nullable<HTMLElement>): void;
  45954. /**
  45955. * Gets the class name of the current intput.
  45956. * @returns the class name
  45957. */
  45958. getClassName(): string;
  45959. /** @hidden */
  45960. _onLostFocus(e: FocusEvent): void;
  45961. /**
  45962. * Get the friendly name associated with the input class.
  45963. * @returns the input friendly name
  45964. */
  45965. getSimpleName(): string;
  45966. /**
  45967. * Update the current camera state depending on the inputs that have been used this frame.
  45968. * This is a dynamically created lambda to avoid the performance penalty of looping for inputs in the render loop.
  45969. */
  45970. checkInputs(): void;
  45971. }
  45972. }
  45973. declare module "babylonjs/Cameras/Inputs/followCameraMouseWheelInput" {
  45974. import { Nullable } from "babylonjs/types";
  45975. import { FollowCamera } from "babylonjs/Cameras/followCamera";
  45976. import { ICameraInput } from "babylonjs/Cameras/cameraInputsManager";
  45977. /**
  45978. * Manage the mouse wheel inputs to control a follow camera.
  45979. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  45980. */
  45981. export class FollowCameraMouseWheelInput implements ICameraInput<FollowCamera> {
  45982. /**
  45983. * Defines the camera the input is attached to.
  45984. */
  45985. camera: FollowCamera;
  45986. /**
  45987. * Moue wheel controls zoom. (Mouse wheel modifies camera.radius value.)
  45988. */
  45989. axisControlRadius: boolean;
  45990. /**
  45991. * Moue wheel controls height. (Mouse wheel modifies camera.heightOffset value.)
  45992. */
  45993. axisControlHeight: boolean;
  45994. /**
  45995. * Moue wheel controls angle. (Mouse wheel modifies camera.rotationOffset value.)
  45996. */
  45997. axisControlRotation: boolean;
  45998. /**
  45999. * Gets or Set the mouse wheel precision or how fast is the camera moves in
  46000. * relation to mouseWheel events.
  46001. */
  46002. wheelPrecision: number;
  46003. /**
  46004. * wheelDeltaPercentage will be used instead of wheelPrecision if different from 0.
  46005. * It defines the percentage of current camera.radius to use as delta when wheel is used.
  46006. */
  46007. wheelDeltaPercentage: number;
  46008. private _wheel;
  46009. private _observer;
  46010. /**
  46011. * Attach the input controls to a specific dom element to get the input from.
  46012. * @param element Defines the element the controls should be listened from
  46013. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  46014. */
  46015. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  46016. /**
  46017. * Detach the current controls from the specified dom element.
  46018. * @param element Defines the element to stop listening the inputs from
  46019. */
  46020. detachControl(element: Nullable<HTMLElement>): void;
  46021. /**
  46022. * Gets the class name of the current intput.
  46023. * @returns the class name
  46024. */
  46025. getClassName(): string;
  46026. /**
  46027. * Get the friendly name associated with the input class.
  46028. * @returns the input friendly name
  46029. */
  46030. getSimpleName(): string;
  46031. }
  46032. }
  46033. declare module "babylonjs/Cameras/Inputs/followCameraPointersInput" {
  46034. import { Nullable } from "babylonjs/types";
  46035. import { FollowCamera } from "babylonjs/Cameras/followCamera";
  46036. import { BaseCameraPointersInput } from "babylonjs/Cameras/Inputs/BaseCameraPointersInput";
  46037. import { PointerTouch } from "babylonjs/Events/pointerEvents";
  46038. /**
  46039. * Manage the pointers inputs to control an follow camera.
  46040. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  46041. */
  46042. export class FollowCameraPointersInput extends BaseCameraPointersInput {
  46043. /**
  46044. * Defines the camera the input is attached to.
  46045. */
  46046. camera: FollowCamera;
  46047. /**
  46048. * Gets the class name of the current input.
  46049. * @returns the class name
  46050. */
  46051. getClassName(): string;
  46052. /**
  46053. * Defines the pointer angular sensibility along the X axis or how fast is
  46054. * the camera rotating.
  46055. * A negative number will reverse the axis direction.
  46056. */
  46057. angularSensibilityX: number;
  46058. /**
  46059. * Defines the pointer angular sensibility along the Y axis or how fast is
  46060. * the camera rotating.
  46061. * A negative number will reverse the axis direction.
  46062. */
  46063. angularSensibilityY: number;
  46064. /**
  46065. * Defines the pointer pinch precision or how fast is the camera zooming.
  46066. * A negative number will reverse the axis direction.
  46067. */
  46068. pinchPrecision: number;
  46069. /**
  46070. * pinchDeltaPercentage will be used instead of pinchPrecision if different
  46071. * from 0.
  46072. * It defines the percentage of current camera.radius to use as delta when
  46073. * pinch zoom is used.
  46074. */
  46075. pinchDeltaPercentage: number;
  46076. /**
  46077. * Pointer X axis controls zoom. (X axis modifies camera.radius value.)
  46078. */
  46079. axisXControlRadius: boolean;
  46080. /**
  46081. * Pointer X axis controls height. (X axis modifies camera.heightOffset value.)
  46082. */
  46083. axisXControlHeight: boolean;
  46084. /**
  46085. * Pointer X axis controls angle. (X axis modifies camera.rotationOffset value.)
  46086. */
  46087. axisXControlRotation: boolean;
  46088. /**
  46089. * Pointer Y axis controls zoom. (Y axis modifies camera.radius value.)
  46090. */
  46091. axisYControlRadius: boolean;
  46092. /**
  46093. * Pointer Y axis controls height. (Y axis modifies camera.heightOffset value.)
  46094. */
  46095. axisYControlHeight: boolean;
  46096. /**
  46097. * Pointer Y axis controls angle. (Y axis modifies camera.rotationOffset value.)
  46098. */
  46099. axisYControlRotation: boolean;
  46100. /**
  46101. * Pinch controls zoom. (Pinch modifies camera.radius value.)
  46102. */
  46103. axisPinchControlRadius: boolean;
  46104. /**
  46105. * Pinch controls height. (Pinch modifies camera.heightOffset value.)
  46106. */
  46107. axisPinchControlHeight: boolean;
  46108. /**
  46109. * Pinch controls angle. (Pinch modifies camera.rotationOffset value.)
  46110. */
  46111. axisPinchControlRotation: boolean;
  46112. /**
  46113. * Log error messages if basic misconfiguration has occurred.
  46114. */
  46115. warningEnable: boolean;
  46116. protected onTouch(pointA: Nullable<PointerTouch>, offsetX: number, offsetY: number): void;
  46117. protected onMultiTouch(pointA: Nullable<PointerTouch>, pointB: Nullable<PointerTouch>, previousPinchSquaredDistance: number, pinchSquaredDistance: number, previousMultiTouchPanPosition: Nullable<PointerTouch>, multiTouchPanPosition: Nullable<PointerTouch>): void;
  46118. private _warningCounter;
  46119. private _warning;
  46120. }
  46121. }
  46122. declare module "babylonjs/Cameras/followCameraInputsManager" {
  46123. import { CameraInputsManager } from "babylonjs/Cameras/cameraInputsManager";
  46124. import { FollowCamera } from "babylonjs/Cameras/followCamera";
  46125. /**
  46126. * Default Inputs manager for the FollowCamera.
  46127. * It groups all the default supported inputs for ease of use.
  46128. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  46129. */
  46130. export class FollowCameraInputsManager extends CameraInputsManager<FollowCamera> {
  46131. /**
  46132. * Instantiates a new FollowCameraInputsManager.
  46133. * @param camera Defines the camera the inputs belong to
  46134. */
  46135. constructor(camera: FollowCamera);
  46136. /**
  46137. * Add keyboard input support to the input manager.
  46138. * @returns the current input manager
  46139. */
  46140. addKeyboard(): FollowCameraInputsManager;
  46141. /**
  46142. * Add mouse wheel input support to the input manager.
  46143. * @returns the current input manager
  46144. */
  46145. addMouseWheel(): FollowCameraInputsManager;
  46146. /**
  46147. * Add pointers input support to the input manager.
  46148. * @returns the current input manager
  46149. */
  46150. addPointers(): FollowCameraInputsManager;
  46151. /**
  46152. * Add orientation input support to the input manager.
  46153. * @returns the current input manager
  46154. */
  46155. addVRDeviceOrientation(): FollowCameraInputsManager;
  46156. }
  46157. }
  46158. declare module "babylonjs/Cameras/followCamera" {
  46159. import { Nullable } from "babylonjs/types";
  46160. import { TargetCamera } from "babylonjs/Cameras/targetCamera";
  46161. import { Scene } from "babylonjs/scene";
  46162. import { Vector3 } from "babylonjs/Maths/math.vector";
  46163. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  46164. import { FollowCameraInputsManager } from "babylonjs/Cameras/followCameraInputsManager";
  46165. /**
  46166. * A follow camera takes a mesh as a target and follows it as it moves. Both a free camera version followCamera and
  46167. * an arc rotate version arcFollowCamera are available.
  46168. * @see https://doc.babylonjs.com/features/cameras#follow-camera
  46169. */
  46170. export class FollowCamera extends TargetCamera {
  46171. /**
  46172. * Distance the follow camera should follow an object at
  46173. */
  46174. radius: number;
  46175. /**
  46176. * Minimum allowed distance of the camera to the axis of rotation
  46177. * (The camera can not get closer).
  46178. * This can help limiting how the Camera is able to move in the scene.
  46179. */
  46180. lowerRadiusLimit: Nullable<number>;
  46181. /**
  46182. * Maximum allowed distance of the camera to the axis of rotation
  46183. * (The camera can not get further).
  46184. * This can help limiting how the Camera is able to move in the scene.
  46185. */
  46186. upperRadiusLimit: Nullable<number>;
  46187. /**
  46188. * Define a rotation offset between the camera and the object it follows
  46189. */
  46190. rotationOffset: number;
  46191. /**
  46192. * Minimum allowed angle to camera position relative to target object.
  46193. * This can help limiting how the Camera is able to move in the scene.
  46194. */
  46195. lowerRotationOffsetLimit: Nullable<number>;
  46196. /**
  46197. * Maximum allowed angle to camera position relative to target object.
  46198. * This can help limiting how the Camera is able to move in the scene.
  46199. */
  46200. upperRotationOffsetLimit: Nullable<number>;
  46201. /**
  46202. * Define a height offset between the camera and the object it follows.
  46203. * It can help following an object from the top (like a car chaing a plane)
  46204. */
  46205. heightOffset: number;
  46206. /**
  46207. * Minimum allowed height of camera position relative to target object.
  46208. * This can help limiting how the Camera is able to move in the scene.
  46209. */
  46210. lowerHeightOffsetLimit: Nullable<number>;
  46211. /**
  46212. * Maximum allowed height of camera position relative to target object.
  46213. * This can help limiting how the Camera is able to move in the scene.
  46214. */
  46215. upperHeightOffsetLimit: Nullable<number>;
  46216. /**
  46217. * Define how fast the camera can accelerate to follow it s target.
  46218. */
  46219. cameraAcceleration: number;
  46220. /**
  46221. * Define the speed limit of the camera following an object.
  46222. */
  46223. maxCameraSpeed: number;
  46224. /**
  46225. * Define the target of the camera.
  46226. */
  46227. lockedTarget: Nullable<AbstractMesh>;
  46228. /**
  46229. * Defines the input associated with the camera.
  46230. */
  46231. inputs: FollowCameraInputsManager;
  46232. /**
  46233. * Instantiates the follow camera.
  46234. * @see https://doc.babylonjs.com/features/cameras#follow-camera
  46235. * @param name Define the name of the camera in the scene
  46236. * @param position Define the position of the camera
  46237. * @param scene Define the scene the camera belong to
  46238. * @param lockedTarget Define the target of the camera
  46239. */
  46240. constructor(name: string, position: Vector3, scene: Scene, lockedTarget?: Nullable<AbstractMesh>);
  46241. private _follow;
  46242. /**
  46243. * Attached controls to the current camera.
  46244. * @param element Defines the element the controls should be listened from
  46245. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  46246. */
  46247. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  46248. /**
  46249. * Detach the current controls from the camera.
  46250. * The camera will stop reacting to inputs.
  46251. * @param element Defines the element to stop listening the inputs from
  46252. */
  46253. detachControl(element: HTMLElement): void;
  46254. /** @hidden */
  46255. _checkInputs(): void;
  46256. private _checkLimits;
  46257. /**
  46258. * Gets the camera class name.
  46259. * @returns the class name
  46260. */
  46261. getClassName(): string;
  46262. }
  46263. /**
  46264. * Arc Rotate version of the follow camera.
  46265. * It still follows a Defined mesh but in an Arc Rotate Camera fashion.
  46266. * @see https://doc.babylonjs.com/features/cameras#follow-camera
  46267. */
  46268. export class ArcFollowCamera extends TargetCamera {
  46269. /** The longitudinal angle of the camera */
  46270. alpha: number;
  46271. /** The latitudinal angle of the camera */
  46272. beta: number;
  46273. /** The radius of the camera from its target */
  46274. radius: number;
  46275. private _cartesianCoordinates;
  46276. /** Define the camera target (the mesh it should follow) */
  46277. private _meshTarget;
  46278. /**
  46279. * Instantiates a new ArcFollowCamera
  46280. * @see https://doc.babylonjs.com/features/cameras#follow-camera
  46281. * @param name Define the name of the camera
  46282. * @param alpha Define the rotation angle of the camera around the logitudinal axis
  46283. * @param beta Define the rotation angle of the camera around the elevation axis
  46284. * @param radius Define the radius of the camera from its target point
  46285. * @param target Define the target of the camera
  46286. * @param scene Define the scene the camera belongs to
  46287. */
  46288. constructor(name: string,
  46289. /** The longitudinal angle of the camera */
  46290. alpha: number,
  46291. /** The latitudinal angle of the camera */
  46292. beta: number,
  46293. /** The radius of the camera from its target */
  46294. radius: number,
  46295. /** Define the camera target (the mesh it should follow) */
  46296. target: Nullable<AbstractMesh>, scene: Scene);
  46297. private _follow;
  46298. /** @hidden */
  46299. _checkInputs(): void;
  46300. /**
  46301. * Returns the class name of the object.
  46302. * It is mostly used internally for serialization purposes.
  46303. */
  46304. getClassName(): string;
  46305. }
  46306. }
  46307. declare module "babylonjs/Cameras/Inputs/followCameraKeyboardMoveInput" {
  46308. import { ICameraInput } from "babylonjs/Cameras/cameraInputsManager";
  46309. import { FollowCamera } from "babylonjs/Cameras/followCamera";
  46310. import { Nullable } from "babylonjs/types";
  46311. /**
  46312. * Manage the keyboard inputs to control the movement of a follow camera.
  46313. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  46314. */
  46315. export class FollowCameraKeyboardMoveInput implements ICameraInput<FollowCamera> {
  46316. /**
  46317. * Defines the camera the input is attached to.
  46318. */
  46319. camera: FollowCamera;
  46320. /**
  46321. * Defines the list of key codes associated with the up action (increase heightOffset)
  46322. */
  46323. keysHeightOffsetIncr: number[];
  46324. /**
  46325. * Defines the list of key codes associated with the down action (decrease heightOffset)
  46326. */
  46327. keysHeightOffsetDecr: number[];
  46328. /**
  46329. * Defines whether the Alt modifier key is required to move up/down (alter heightOffset)
  46330. */
  46331. keysHeightOffsetModifierAlt: boolean;
  46332. /**
  46333. * Defines whether the Ctrl modifier key is required to move up/down (alter heightOffset)
  46334. */
  46335. keysHeightOffsetModifierCtrl: boolean;
  46336. /**
  46337. * Defines whether the Shift modifier key is required to move up/down (alter heightOffset)
  46338. */
  46339. keysHeightOffsetModifierShift: boolean;
  46340. /**
  46341. * Defines the list of key codes associated with the left action (increase rotationOffset)
  46342. */
  46343. keysRotationOffsetIncr: number[];
  46344. /**
  46345. * Defines the list of key codes associated with the right action (decrease rotationOffset)
  46346. */
  46347. keysRotationOffsetDecr: number[];
  46348. /**
  46349. * Defines whether the Alt modifier key is required to move left/right (alter rotationOffset)
  46350. */
  46351. keysRotationOffsetModifierAlt: boolean;
  46352. /**
  46353. * Defines whether the Ctrl modifier key is required to move left/right (alter rotationOffset)
  46354. */
  46355. keysRotationOffsetModifierCtrl: boolean;
  46356. /**
  46357. * Defines whether the Shift modifier key is required to move left/right (alter rotationOffset)
  46358. */
  46359. keysRotationOffsetModifierShift: boolean;
  46360. /**
  46361. * Defines the list of key codes associated with the zoom-in action (decrease radius)
  46362. */
  46363. keysRadiusIncr: number[];
  46364. /**
  46365. * Defines the list of key codes associated with the zoom-out action (increase radius)
  46366. */
  46367. keysRadiusDecr: number[];
  46368. /**
  46369. * Defines whether the Alt modifier key is required to zoom in/out (alter radius value)
  46370. */
  46371. keysRadiusModifierAlt: boolean;
  46372. /**
  46373. * Defines whether the Ctrl modifier key is required to zoom in/out (alter radius value)
  46374. */
  46375. keysRadiusModifierCtrl: boolean;
  46376. /**
  46377. * Defines whether the Shift modifier key is required to zoom in/out (alter radius value)
  46378. */
  46379. keysRadiusModifierShift: boolean;
  46380. /**
  46381. * Defines the rate of change of heightOffset.
  46382. */
  46383. heightSensibility: number;
  46384. /**
  46385. * Defines the rate of change of rotationOffset.
  46386. */
  46387. rotationSensibility: number;
  46388. /**
  46389. * Defines the rate of change of radius.
  46390. */
  46391. radiusSensibility: number;
  46392. private _keys;
  46393. private _ctrlPressed;
  46394. private _altPressed;
  46395. private _shiftPressed;
  46396. private _onCanvasBlurObserver;
  46397. private _onKeyboardObserver;
  46398. private _engine;
  46399. private _scene;
  46400. /**
  46401. * Attach the input controls to a specific dom element to get the input from.
  46402. * @param element Defines the element the controls should be listened from
  46403. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  46404. */
  46405. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  46406. /**
  46407. * Detach the current controls from the specified dom element.
  46408. * @param element Defines the element to stop listening the inputs from
  46409. */
  46410. detachControl(element: Nullable<HTMLElement>): void;
  46411. /**
  46412. * Update the current camera state depending on the inputs that have been used this frame.
  46413. * This is a dynamically created lambda to avoid the performance penalty of looping for inputs in the render loop.
  46414. */
  46415. checkInputs(): void;
  46416. /**
  46417. * Gets the class name of the current input.
  46418. * @returns the class name
  46419. */
  46420. getClassName(): string;
  46421. /**
  46422. * Get the friendly name associated with the input class.
  46423. * @returns the input friendly name
  46424. */
  46425. getSimpleName(): string;
  46426. /**
  46427. * Check if the pressed modifier keys (Alt/Ctrl/Shift) match those configured to
  46428. * allow modification of the heightOffset value.
  46429. */
  46430. private _modifierHeightOffset;
  46431. /**
  46432. * Check if the pressed modifier keys (Alt/Ctrl/Shift) match those configured to
  46433. * allow modification of the rotationOffset value.
  46434. */
  46435. private _modifierRotationOffset;
  46436. /**
  46437. * Check if the pressed modifier keys (Alt/Ctrl/Shift) match those configured to
  46438. * allow modification of the radius value.
  46439. */
  46440. private _modifierRadius;
  46441. }
  46442. }
  46443. declare module "babylonjs/Cameras/Inputs/freeCameraDeviceOrientationInput" {
  46444. import { Nullable } from "babylonjs/types";
  46445. import { ICameraInput } from "babylonjs/Cameras/cameraInputsManager";
  46446. import { FreeCamera } from "babylonjs/Cameras/freeCamera";
  46447. import { Observable } from "babylonjs/Misc/observable";
  46448. module "babylonjs/Cameras/freeCameraInputsManager" {
  46449. interface FreeCameraInputsManager {
  46450. /**
  46451. * @hidden
  46452. */
  46453. _deviceOrientationInput: Nullable<FreeCameraDeviceOrientationInput>;
  46454. /**
  46455. * Add orientation input support to the input manager.
  46456. * @returns the current input manager
  46457. */
  46458. addDeviceOrientation(): FreeCameraInputsManager;
  46459. }
  46460. }
  46461. /**
  46462. * Takes information about the orientation of the device as reported by the deviceorientation event to orient the camera.
  46463. * Screen rotation is taken into account.
  46464. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  46465. */
  46466. export class FreeCameraDeviceOrientationInput implements ICameraInput<FreeCamera> {
  46467. private _camera;
  46468. private _screenOrientationAngle;
  46469. private _constantTranform;
  46470. private _screenQuaternion;
  46471. private _alpha;
  46472. private _beta;
  46473. private _gamma;
  46474. /**
  46475. * Can be used to detect if a device orientation sensor is available on a device
  46476. * @param timeout amount of time in milliseconds to wait for a response from the sensor (default: infinite)
  46477. * @returns a promise that will resolve on orientation change
  46478. */
  46479. static WaitForOrientationChangeAsync(timeout?: number): Promise<unknown>;
  46480. /**
  46481. * @hidden
  46482. */
  46483. _onDeviceOrientationChangedObservable: Observable<void>;
  46484. /**
  46485. * Instantiates a new input
  46486. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  46487. */
  46488. constructor();
  46489. /**
  46490. * Define the camera controlled by the input.
  46491. */
  46492. get camera(): FreeCamera;
  46493. set camera(camera: FreeCamera);
  46494. /**
  46495. * Attach the input controls to a specific dom element to get the input from.
  46496. * @param element Defines the element the controls should be listened from
  46497. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  46498. */
  46499. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  46500. private _orientationChanged;
  46501. private _deviceOrientation;
  46502. /**
  46503. * Detach the current controls from the specified dom element.
  46504. * @param element Defines the element to stop listening the inputs from
  46505. */
  46506. detachControl(element: Nullable<HTMLElement>): void;
  46507. /**
  46508. * Update the current camera state depending on the inputs that have been used this frame.
  46509. * This is a dynamically created lambda to avoid the performance penalty of looping for inputs in the render loop.
  46510. */
  46511. checkInputs(): void;
  46512. /**
  46513. * Gets the class name of the current intput.
  46514. * @returns the class name
  46515. */
  46516. getClassName(): string;
  46517. /**
  46518. * Get the friendly name associated with the input class.
  46519. * @returns the input friendly name
  46520. */
  46521. getSimpleName(): string;
  46522. }
  46523. }
  46524. declare module "babylonjs/Cameras/Inputs/freeCameraGamepadInput" {
  46525. import { Nullable } from "babylonjs/types";
  46526. import { ICameraInput } from "babylonjs/Cameras/cameraInputsManager";
  46527. import { FreeCamera } from "babylonjs/Cameras/freeCamera";
  46528. import { Gamepad } from "babylonjs/Gamepads/gamepad";
  46529. /**
  46530. * Manage the gamepad inputs to control a free camera.
  46531. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  46532. */
  46533. export class FreeCameraGamepadInput implements ICameraInput<FreeCamera> {
  46534. /**
  46535. * Define the camera the input is attached to.
  46536. */
  46537. camera: FreeCamera;
  46538. /**
  46539. * Define the Gamepad controlling the input
  46540. */
  46541. gamepad: Nullable<Gamepad>;
  46542. /**
  46543. * Defines the gamepad rotation sensiblity.
  46544. * This is the threshold from when rotation starts to be accounted for to prevent jittering.
  46545. */
  46546. gamepadAngularSensibility: number;
  46547. /**
  46548. * Defines the gamepad move sensiblity.
  46549. * This is the threshold from when moving starts to be accounted for for to prevent jittering.
  46550. */
  46551. gamepadMoveSensibility: number;
  46552. private _yAxisScale;
  46553. /**
  46554. * Gets or sets a boolean indicating that Yaxis (for right stick) should be inverted
  46555. */
  46556. get invertYAxis(): boolean;
  46557. set invertYAxis(value: boolean);
  46558. private _onGamepadConnectedObserver;
  46559. private _onGamepadDisconnectedObserver;
  46560. private _cameraTransform;
  46561. private _deltaTransform;
  46562. private _vector3;
  46563. private _vector2;
  46564. /**
  46565. * Attach the input controls to a specific dom element to get the input from.
  46566. * @param element Defines the element the controls should be listened from
  46567. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  46568. */
  46569. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  46570. /**
  46571. * Detach the current controls from the specified dom element.
  46572. * @param element Defines the element to stop listening the inputs from
  46573. */
  46574. detachControl(element: Nullable<HTMLElement>): void;
  46575. /**
  46576. * Update the current camera state depending on the inputs that have been used this frame.
  46577. * This is a dynamically created lambda to avoid the performance penalty of looping for inputs in the render loop.
  46578. */
  46579. checkInputs(): void;
  46580. /**
  46581. * Gets the class name of the current intput.
  46582. * @returns the class name
  46583. */
  46584. getClassName(): string;
  46585. /**
  46586. * Get the friendly name associated with the input class.
  46587. * @returns the input friendly name
  46588. */
  46589. getSimpleName(): string;
  46590. }
  46591. }
  46592. declare module "babylonjs/Misc/virtualJoystick" {
  46593. import { Nullable } from "babylonjs/types";
  46594. import { Vector3 } from "babylonjs/Maths/math.vector";
  46595. /**
  46596. * Defines the potential axis of a Joystick
  46597. */
  46598. export enum JoystickAxis {
  46599. /** X axis */
  46600. X = 0,
  46601. /** Y axis */
  46602. Y = 1,
  46603. /** Z axis */
  46604. Z = 2
  46605. }
  46606. /**
  46607. * Represents the different customization options available
  46608. * for VirtualJoystick
  46609. */
  46610. interface VirtualJoystickCustomizations {
  46611. /**
  46612. * Size of the joystick's puck
  46613. */
  46614. puckSize: number;
  46615. /**
  46616. * Size of the joystick's container
  46617. */
  46618. containerSize: number;
  46619. /**
  46620. * Color of the joystick && puck
  46621. */
  46622. color: string;
  46623. /**
  46624. * Image URL for the joystick's puck
  46625. */
  46626. puckImage?: string;
  46627. /**
  46628. * Image URL for the joystick's container
  46629. */
  46630. containerImage?: string;
  46631. /**
  46632. * Defines the unmoving position of the joystick container
  46633. */
  46634. position?: {
  46635. x: number;
  46636. y: number;
  46637. };
  46638. /**
  46639. * Defines whether or not the joystick container is always visible
  46640. */
  46641. alwaysVisible: boolean;
  46642. /**
  46643. * Defines whether or not to limit the movement of the puck to the joystick's container
  46644. */
  46645. limitToContainer: boolean;
  46646. }
  46647. /**
  46648. * Class used to define virtual joystick (used in touch mode)
  46649. */
  46650. export class VirtualJoystick {
  46651. /**
  46652. * Gets or sets a boolean indicating that left and right values must be inverted
  46653. */
  46654. reverseLeftRight: boolean;
  46655. /**
  46656. * Gets or sets a boolean indicating that up and down values must be inverted
  46657. */
  46658. reverseUpDown: boolean;
  46659. /**
  46660. * Gets the offset value for the position (ie. the change of the position value)
  46661. */
  46662. deltaPosition: Vector3;
  46663. /**
  46664. * Gets a boolean indicating if the virtual joystick was pressed
  46665. */
  46666. pressed: boolean;
  46667. /**
  46668. * Canvas the virtual joystick will render onto, default z-index of this is 5
  46669. */
  46670. static Canvas: Nullable<HTMLCanvasElement>;
  46671. /**
  46672. * boolean indicating whether or not the joystick's puck's movement should be limited to the joystick's container area
  46673. */
  46674. limitToContainer: boolean;
  46675. private static _globalJoystickIndex;
  46676. private static _alwaysVisibleSticks;
  46677. private static vjCanvasContext;
  46678. private static vjCanvasWidth;
  46679. private static vjCanvasHeight;
  46680. private static halfWidth;
  46681. private static _GetDefaultOptions;
  46682. private _action;
  46683. private _axisTargetedByLeftAndRight;
  46684. private _axisTargetedByUpAndDown;
  46685. private _joystickSensibility;
  46686. private _inversedSensibility;
  46687. private _joystickPointerID;
  46688. private _joystickColor;
  46689. private _joystickPointerPos;
  46690. private _joystickPreviousPointerPos;
  46691. private _joystickPointerStartPos;
  46692. private _deltaJoystickVector;
  46693. private _leftJoystick;
  46694. private _touches;
  46695. private _joystickPosition;
  46696. private _alwaysVisible;
  46697. private _puckImage;
  46698. private _containerImage;
  46699. private _joystickPuckSize;
  46700. private _joystickContainerSize;
  46701. private _clearPuckSize;
  46702. private _clearContainerSize;
  46703. private _clearPuckSizeOffset;
  46704. private _clearContainerSizeOffset;
  46705. private _onPointerDownHandlerRef;
  46706. private _onPointerMoveHandlerRef;
  46707. private _onPointerUpHandlerRef;
  46708. private _onResize;
  46709. /**
  46710. * Creates a new virtual joystick
  46711. * @param leftJoystick defines that the joystick is for left hand (false by default)
  46712. * @param customizations Defines the options we want to customize the VirtualJoystick
  46713. */
  46714. constructor(leftJoystick?: boolean, customizations?: Partial<VirtualJoystickCustomizations>);
  46715. /**
  46716. * Defines joystick sensibility (ie. the ratio beteen a physical move and virtual joystick position change)
  46717. * @param newJoystickSensibility defines the new sensibility
  46718. */
  46719. setJoystickSensibility(newJoystickSensibility: number): void;
  46720. private _onPointerDown;
  46721. private _onPointerMove;
  46722. private _onPointerUp;
  46723. /**
  46724. * Change the color of the virtual joystick
  46725. * @param newColor a string that must be a CSS color value (like "red") or the hexa value (like "#FF0000")
  46726. */
  46727. setJoystickColor(newColor: string): void;
  46728. /**
  46729. * Size of the joystick's container
  46730. */
  46731. set containerSize(newSize: number);
  46732. get containerSize(): number;
  46733. /**
  46734. * Size of the joystick's puck
  46735. */
  46736. set puckSize(newSize: number);
  46737. get puckSize(): number;
  46738. /**
  46739. * Clears the set position of the joystick
  46740. */
  46741. clearPosition(): void;
  46742. /**
  46743. * Defines whether or not the joystick container is always visible
  46744. */
  46745. set alwaysVisible(value: boolean);
  46746. get alwaysVisible(): boolean;
  46747. /**
  46748. * Sets the constant position of the Joystick container
  46749. * @param x X axis coordinate
  46750. * @param y Y axis coordinate
  46751. */
  46752. setPosition(x: number, y: number): void;
  46753. /**
  46754. * Defines a callback to call when the joystick is touched
  46755. * @param action defines the callback
  46756. */
  46757. setActionOnTouch(action: () => any): void;
  46758. /**
  46759. * Defines which axis you'd like to control for left & right
  46760. * @param axis defines the axis to use
  46761. */
  46762. setAxisForLeftRight(axis: JoystickAxis): void;
  46763. /**
  46764. * Defines which axis you'd like to control for up & down
  46765. * @param axis defines the axis to use
  46766. */
  46767. setAxisForUpDown(axis: JoystickAxis): void;
  46768. /**
  46769. * Clears the canvas from the previous puck / container draw
  46770. */
  46771. private _clearPreviousDraw;
  46772. /**
  46773. * Loads `urlPath` to be used for the container's image
  46774. * @param urlPath defines the urlPath of an image to use
  46775. */
  46776. setContainerImage(urlPath: string): void;
  46777. /**
  46778. * Loads `urlPath` to be used for the puck's image
  46779. * @param urlPath defines the urlPath of an image to use
  46780. */
  46781. setPuckImage(urlPath: string): void;
  46782. /**
  46783. * Draws the Virtual Joystick's container
  46784. */
  46785. private _drawContainer;
  46786. /**
  46787. * Draws the Virtual Joystick's puck
  46788. */
  46789. private _drawPuck;
  46790. private _drawVirtualJoystick;
  46791. /**
  46792. * Release internal HTML canvas
  46793. */
  46794. releaseCanvas(): void;
  46795. }
  46796. }
  46797. declare module "babylonjs/Cameras/Inputs/freeCameraVirtualJoystickInput" {
  46798. import { VirtualJoystick } from "babylonjs/Misc/virtualJoystick";
  46799. import { Nullable } from "babylonjs/types";
  46800. import { ICameraInput } from "babylonjs/Cameras/cameraInputsManager";
  46801. import { FreeCamera } from "babylonjs/Cameras/freeCamera";
  46802. module "babylonjs/Cameras/freeCameraInputsManager" {
  46803. interface FreeCameraInputsManager {
  46804. /**
  46805. * Add virtual joystick input support to the input manager.
  46806. * @returns the current input manager
  46807. */
  46808. addVirtualJoystick(): FreeCameraInputsManager;
  46809. }
  46810. }
  46811. /**
  46812. * Manage the Virtual Joystick inputs to control the movement of a free camera.
  46813. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  46814. */
  46815. export class FreeCameraVirtualJoystickInput implements ICameraInput<FreeCamera> {
  46816. /**
  46817. * Defines the camera the input is attached to.
  46818. */
  46819. camera: FreeCamera;
  46820. private _leftjoystick;
  46821. private _rightjoystick;
  46822. /**
  46823. * Gets the left stick of the virtual joystick.
  46824. * @returns The virtual Joystick
  46825. */
  46826. getLeftJoystick(): VirtualJoystick;
  46827. /**
  46828. * Gets the right stick of the virtual joystick.
  46829. * @returns The virtual Joystick
  46830. */
  46831. getRightJoystick(): VirtualJoystick;
  46832. /**
  46833. * Update the current camera state depending on the inputs that have been used this frame.
  46834. * This is a dynamically created lambda to avoid the performance penalty of looping for inputs in the render loop.
  46835. */
  46836. checkInputs(): void;
  46837. /**
  46838. * Attach the input controls to a specific dom element to get the input from.
  46839. * @param element Defines the element the controls should be listened from
  46840. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  46841. */
  46842. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  46843. /**
  46844. * Detach the current controls from the specified dom element.
  46845. * @param element Defines the element to stop listening the inputs from
  46846. */
  46847. detachControl(element: Nullable<HTMLElement>): void;
  46848. /**
  46849. * Gets the class name of the current intput.
  46850. * @returns the class name
  46851. */
  46852. getClassName(): string;
  46853. /**
  46854. * Get the friendly name associated with the input class.
  46855. * @returns the input friendly name
  46856. */
  46857. getSimpleName(): string;
  46858. }
  46859. }
  46860. declare module "babylonjs/Cameras/Inputs/index" {
  46861. export * from "babylonjs/Cameras/Inputs/arcRotateCameraGamepadInput";
  46862. export * from "babylonjs/Cameras/Inputs/arcRotateCameraKeyboardMoveInput";
  46863. export * from "babylonjs/Cameras/Inputs/arcRotateCameraMouseWheelInput";
  46864. export * from "babylonjs/Cameras/Inputs/arcRotateCameraPointersInput";
  46865. export * from "babylonjs/Cameras/Inputs/arcRotateCameraVRDeviceOrientationInput";
  46866. export * from "babylonjs/Cameras/Inputs/flyCameraKeyboardInput";
  46867. export * from "babylonjs/Cameras/Inputs/flyCameraMouseInput";
  46868. export * from "babylonjs/Cameras/Inputs/followCameraKeyboardMoveInput";
  46869. export * from "babylonjs/Cameras/Inputs/followCameraMouseWheelInput";
  46870. export * from "babylonjs/Cameras/Inputs/followCameraPointersInput";
  46871. export * from "babylonjs/Cameras/Inputs/freeCameraDeviceOrientationInput";
  46872. export * from "babylonjs/Cameras/Inputs/freeCameraGamepadInput";
  46873. export * from "babylonjs/Cameras/Inputs/freeCameraKeyboardMoveInput";
  46874. export * from "babylonjs/Cameras/Inputs/freeCameraMouseInput";
  46875. export * from "babylonjs/Cameras/Inputs/freeCameraTouchInput";
  46876. export * from "babylonjs/Cameras/Inputs/freeCameraVirtualJoystickInput";
  46877. }
  46878. declare module "babylonjs/Cameras/touchCamera" {
  46879. import { FreeCamera } from "babylonjs/Cameras/freeCamera";
  46880. import { Scene } from "babylonjs/scene";
  46881. import { Vector3 } from "babylonjs/Maths/math.vector";
  46882. /**
  46883. * This represents a FPS type of camera controlled by touch.
  46884. * This is like a universal camera minus the Gamepad controls.
  46885. * @see https://doc.babylonjs.com/features/cameras#universal-camera
  46886. */
  46887. export class TouchCamera extends FreeCamera {
  46888. /**
  46889. * Defines the touch sensibility for rotation.
  46890. * The higher the faster.
  46891. */
  46892. get touchAngularSensibility(): number;
  46893. set touchAngularSensibility(value: number);
  46894. /**
  46895. * Defines the touch sensibility for move.
  46896. * The higher the faster.
  46897. */
  46898. get touchMoveSensibility(): number;
  46899. set touchMoveSensibility(value: number);
  46900. /**
  46901. * Instantiates a new touch camera.
  46902. * This represents a FPS type of camera controlled by touch.
  46903. * This is like a universal camera minus the Gamepad controls.
  46904. * @see https://doc.babylonjs.com/features/cameras#universal-camera
  46905. * @param name Define the name of the camera in the scene
  46906. * @param position Define the start position of the camera in the scene
  46907. * @param scene Define the scene the camera belongs to
  46908. */
  46909. constructor(name: string, position: Vector3, scene: Scene);
  46910. /**
  46911. * Gets the current object class name.
  46912. * @return the class name
  46913. */
  46914. getClassName(): string;
  46915. /** @hidden */
  46916. _setupInputs(): void;
  46917. }
  46918. }
  46919. declare module "babylonjs/Cameras/deviceOrientationCamera" {
  46920. import { FreeCamera } from "babylonjs/Cameras/freeCamera";
  46921. import { Scene } from "babylonjs/scene";
  46922. import { Vector3 } from "babylonjs/Maths/math.vector";
  46923. import "babylonjs/Cameras/Inputs/freeCameraDeviceOrientationInput";
  46924. import { Axis } from "babylonjs/Maths/math.axis";
  46925. /**
  46926. * This is a camera specifically designed to react to device orientation events such as a modern mobile device
  46927. * being tilted forward or back and left or right.
  46928. */
  46929. export class DeviceOrientationCamera extends FreeCamera {
  46930. private _initialQuaternion;
  46931. private _quaternionCache;
  46932. private _tmpDragQuaternion;
  46933. private _disablePointerInputWhenUsingDeviceOrientation;
  46934. /**
  46935. * Creates a new device orientation camera
  46936. * @param name The name of the camera
  46937. * @param position The start position camera
  46938. * @param scene The scene the camera belongs to
  46939. */
  46940. constructor(name: string, position: Vector3, scene: Scene);
  46941. /**
  46942. * Gets or sets a boolean indicating that pointer input must be disabled on first orientation sensor update (Default: true)
  46943. */
  46944. get disablePointerInputWhenUsingDeviceOrientation(): boolean;
  46945. set disablePointerInputWhenUsingDeviceOrientation(value: boolean);
  46946. private _dragFactor;
  46947. /**
  46948. * Enabled turning on the y axis when the orientation sensor is active
  46949. * @param dragFactor the factor that controls the turn speed (default: 1/300)
  46950. */
  46951. enableHorizontalDragging(dragFactor?: number): void;
  46952. /**
  46953. * Gets the current instance class name ("DeviceOrientationCamera").
  46954. * This helps avoiding instanceof at run time.
  46955. * @returns the class name
  46956. */
  46957. getClassName(): string;
  46958. /**
  46959. * @hidden
  46960. * Checks and applies the current values of the inputs to the camera. (Internal use only)
  46961. */
  46962. _checkInputs(): void;
  46963. /**
  46964. * Reset the camera to its default orientation on the specified axis only.
  46965. * @param axis The axis to reset
  46966. */
  46967. resetToCurrentRotation(axis?: Axis): void;
  46968. }
  46969. }
  46970. declare module "babylonjs/Gamepads/xboxGamepad" {
  46971. import { Observable } from "babylonjs/Misc/observable";
  46972. import { Gamepad } from "babylonjs/Gamepads/gamepad";
  46973. /**
  46974. * Defines supported buttons for XBox360 compatible gamepads
  46975. */
  46976. export enum Xbox360Button {
  46977. /** A */
  46978. A = 0,
  46979. /** B */
  46980. B = 1,
  46981. /** X */
  46982. X = 2,
  46983. /** Y */
  46984. Y = 3,
  46985. /** Left button */
  46986. LB = 4,
  46987. /** Right button */
  46988. RB = 5,
  46989. /** Back */
  46990. Back = 8,
  46991. /** Start */
  46992. Start = 9,
  46993. /** Left stick */
  46994. LeftStick = 10,
  46995. /** Right stick */
  46996. RightStick = 11
  46997. }
  46998. /** Defines values for XBox360 DPad */
  46999. export enum Xbox360Dpad {
  47000. /** Up */
  47001. Up = 12,
  47002. /** Down */
  47003. Down = 13,
  47004. /** Left */
  47005. Left = 14,
  47006. /** Right */
  47007. Right = 15
  47008. }
  47009. /**
  47010. * Defines a XBox360 gamepad
  47011. */
  47012. export class Xbox360Pad extends Gamepad {
  47013. private _leftTrigger;
  47014. private _rightTrigger;
  47015. private _onlefttriggerchanged;
  47016. private _onrighttriggerchanged;
  47017. private _onbuttondown;
  47018. private _onbuttonup;
  47019. private _ondpaddown;
  47020. private _ondpadup;
  47021. /** Observable raised when a button is pressed */
  47022. onButtonDownObservable: Observable<Xbox360Button>;
  47023. /** Observable raised when a button is released */
  47024. onButtonUpObservable: Observable<Xbox360Button>;
  47025. /** Observable raised when a pad is pressed */
  47026. onPadDownObservable: Observable<Xbox360Dpad>;
  47027. /** Observable raised when a pad is released */
  47028. onPadUpObservable: Observable<Xbox360Dpad>;
  47029. private _buttonA;
  47030. private _buttonB;
  47031. private _buttonX;
  47032. private _buttonY;
  47033. private _buttonBack;
  47034. private _buttonStart;
  47035. private _buttonLB;
  47036. private _buttonRB;
  47037. private _buttonLeftStick;
  47038. private _buttonRightStick;
  47039. private _dPadUp;
  47040. private _dPadDown;
  47041. private _dPadLeft;
  47042. private _dPadRight;
  47043. private _isXboxOnePad;
  47044. /**
  47045. * Creates a new XBox360 gamepad object
  47046. * @param id defines the id of this gamepad
  47047. * @param index defines its index
  47048. * @param gamepad defines the internal HTML gamepad object
  47049. * @param xboxOne defines if it is a XBox One gamepad
  47050. */
  47051. constructor(id: string, index: number, gamepad: any, xboxOne?: boolean);
  47052. /**
  47053. * Defines the callback to call when left trigger is pressed
  47054. * @param callback defines the callback to use
  47055. */
  47056. onlefttriggerchanged(callback: (value: number) => void): void;
  47057. /**
  47058. * Defines the callback to call when right trigger is pressed
  47059. * @param callback defines the callback to use
  47060. */
  47061. onrighttriggerchanged(callback: (value: number) => void): void;
  47062. /**
  47063. * Gets the left trigger value
  47064. */
  47065. get leftTrigger(): number;
  47066. /**
  47067. * Sets the left trigger value
  47068. */
  47069. set leftTrigger(newValue: number);
  47070. /**
  47071. * Gets the right trigger value
  47072. */
  47073. get rightTrigger(): number;
  47074. /**
  47075. * Sets the right trigger value
  47076. */
  47077. set rightTrigger(newValue: number);
  47078. /**
  47079. * Defines the callback to call when a button is pressed
  47080. * @param callback defines the callback to use
  47081. */
  47082. onbuttondown(callback: (buttonPressed: Xbox360Button) => void): void;
  47083. /**
  47084. * Defines the callback to call when a button is released
  47085. * @param callback defines the callback to use
  47086. */
  47087. onbuttonup(callback: (buttonReleased: Xbox360Button) => void): void;
  47088. /**
  47089. * Defines the callback to call when a pad is pressed
  47090. * @param callback defines the callback to use
  47091. */
  47092. ondpaddown(callback: (dPadPressed: Xbox360Dpad) => void): void;
  47093. /**
  47094. * Defines the callback to call when a pad is released
  47095. * @param callback defines the callback to use
  47096. */
  47097. ondpadup(callback: (dPadReleased: Xbox360Dpad) => void): void;
  47098. private _setButtonValue;
  47099. private _setDPadValue;
  47100. /**
  47101. * Gets the value of the `A` button
  47102. */
  47103. get buttonA(): number;
  47104. /**
  47105. * Sets the value of the `A` button
  47106. */
  47107. set buttonA(value: number);
  47108. /**
  47109. * Gets the value of the `B` button
  47110. */
  47111. get buttonB(): number;
  47112. /**
  47113. * Sets the value of the `B` button
  47114. */
  47115. set buttonB(value: number);
  47116. /**
  47117. * Gets the value of the `X` button
  47118. */
  47119. get buttonX(): number;
  47120. /**
  47121. * Sets the value of the `X` button
  47122. */
  47123. set buttonX(value: number);
  47124. /**
  47125. * Gets the value of the `Y` button
  47126. */
  47127. get buttonY(): number;
  47128. /**
  47129. * Sets the value of the `Y` button
  47130. */
  47131. set buttonY(value: number);
  47132. /**
  47133. * Gets the value of the `Start` button
  47134. */
  47135. get buttonStart(): number;
  47136. /**
  47137. * Sets the value of the `Start` button
  47138. */
  47139. set buttonStart(value: number);
  47140. /**
  47141. * Gets the value of the `Back` button
  47142. */
  47143. get buttonBack(): number;
  47144. /**
  47145. * Sets the value of the `Back` button
  47146. */
  47147. set buttonBack(value: number);
  47148. /**
  47149. * Gets the value of the `Left` button
  47150. */
  47151. get buttonLB(): number;
  47152. /**
  47153. * Sets the value of the `Left` button
  47154. */
  47155. set buttonLB(value: number);
  47156. /**
  47157. * Gets the value of the `Right` button
  47158. */
  47159. get buttonRB(): number;
  47160. /**
  47161. * Sets the value of the `Right` button
  47162. */
  47163. set buttonRB(value: number);
  47164. /**
  47165. * Gets the value of the Left joystick
  47166. */
  47167. get buttonLeftStick(): number;
  47168. /**
  47169. * Sets the value of the Left joystick
  47170. */
  47171. set buttonLeftStick(value: number);
  47172. /**
  47173. * Gets the value of the Right joystick
  47174. */
  47175. get buttonRightStick(): number;
  47176. /**
  47177. * Sets the value of the Right joystick
  47178. */
  47179. set buttonRightStick(value: number);
  47180. /**
  47181. * Gets the value of D-pad up
  47182. */
  47183. get dPadUp(): number;
  47184. /**
  47185. * Sets the value of D-pad up
  47186. */
  47187. set dPadUp(value: number);
  47188. /**
  47189. * Gets the value of D-pad down
  47190. */
  47191. get dPadDown(): number;
  47192. /**
  47193. * Sets the value of D-pad down
  47194. */
  47195. set dPadDown(value: number);
  47196. /**
  47197. * Gets the value of D-pad left
  47198. */
  47199. get dPadLeft(): number;
  47200. /**
  47201. * Sets the value of D-pad left
  47202. */
  47203. set dPadLeft(value: number);
  47204. /**
  47205. * Gets the value of D-pad right
  47206. */
  47207. get dPadRight(): number;
  47208. /**
  47209. * Sets the value of D-pad right
  47210. */
  47211. set dPadRight(value: number);
  47212. /**
  47213. * Force the gamepad to synchronize with device values
  47214. */
  47215. update(): void;
  47216. /**
  47217. * Disposes the gamepad
  47218. */
  47219. dispose(): void;
  47220. }
  47221. }
  47222. declare module "babylonjs/Gamepads/dualShockGamepad" {
  47223. import { Observable } from "babylonjs/Misc/observable";
  47224. import { Gamepad } from "babylonjs/Gamepads/gamepad";
  47225. /**
  47226. * Defines supported buttons for DualShock compatible gamepads
  47227. */
  47228. export enum DualShockButton {
  47229. /** Cross */
  47230. Cross = 0,
  47231. /** Circle */
  47232. Circle = 1,
  47233. /** Square */
  47234. Square = 2,
  47235. /** Triangle */
  47236. Triangle = 3,
  47237. /** L1 */
  47238. L1 = 4,
  47239. /** R1 */
  47240. R1 = 5,
  47241. /** Share */
  47242. Share = 8,
  47243. /** Options */
  47244. Options = 9,
  47245. /** Left stick */
  47246. LeftStick = 10,
  47247. /** Right stick */
  47248. RightStick = 11
  47249. }
  47250. /** Defines values for DualShock DPad */
  47251. export enum DualShockDpad {
  47252. /** Up */
  47253. Up = 12,
  47254. /** Down */
  47255. Down = 13,
  47256. /** Left */
  47257. Left = 14,
  47258. /** Right */
  47259. Right = 15
  47260. }
  47261. /**
  47262. * Defines a DualShock gamepad
  47263. */
  47264. export class DualShockPad extends Gamepad {
  47265. private _leftTrigger;
  47266. private _rightTrigger;
  47267. private _onlefttriggerchanged;
  47268. private _onrighttriggerchanged;
  47269. private _onbuttondown;
  47270. private _onbuttonup;
  47271. private _ondpaddown;
  47272. private _ondpadup;
  47273. /** Observable raised when a button is pressed */
  47274. onButtonDownObservable: Observable<DualShockButton>;
  47275. /** Observable raised when a button is released */
  47276. onButtonUpObservable: Observable<DualShockButton>;
  47277. /** Observable raised when a pad is pressed */
  47278. onPadDownObservable: Observable<DualShockDpad>;
  47279. /** Observable raised when a pad is released */
  47280. onPadUpObservable: Observable<DualShockDpad>;
  47281. private _buttonCross;
  47282. private _buttonCircle;
  47283. private _buttonSquare;
  47284. private _buttonTriangle;
  47285. private _buttonShare;
  47286. private _buttonOptions;
  47287. private _buttonL1;
  47288. private _buttonR1;
  47289. private _buttonLeftStick;
  47290. private _buttonRightStick;
  47291. private _dPadUp;
  47292. private _dPadDown;
  47293. private _dPadLeft;
  47294. private _dPadRight;
  47295. /**
  47296. * Creates a new DualShock gamepad object
  47297. * @param id defines the id of this gamepad
  47298. * @param index defines its index
  47299. * @param gamepad defines the internal HTML gamepad object
  47300. */
  47301. constructor(id: string, index: number, gamepad: any);
  47302. /**
  47303. * Defines the callback to call when left trigger is pressed
  47304. * @param callback defines the callback to use
  47305. */
  47306. onlefttriggerchanged(callback: (value: number) => void): void;
  47307. /**
  47308. * Defines the callback to call when right trigger is pressed
  47309. * @param callback defines the callback to use
  47310. */
  47311. onrighttriggerchanged(callback: (value: number) => void): void;
  47312. /**
  47313. * Gets the left trigger value
  47314. */
  47315. get leftTrigger(): number;
  47316. /**
  47317. * Sets the left trigger value
  47318. */
  47319. set leftTrigger(newValue: number);
  47320. /**
  47321. * Gets the right trigger value
  47322. */
  47323. get rightTrigger(): number;
  47324. /**
  47325. * Sets the right trigger value
  47326. */
  47327. set rightTrigger(newValue: number);
  47328. /**
  47329. * Defines the callback to call when a button is pressed
  47330. * @param callback defines the callback to use
  47331. */
  47332. onbuttondown(callback: (buttonPressed: DualShockButton) => void): void;
  47333. /**
  47334. * Defines the callback to call when a button is released
  47335. * @param callback defines the callback to use
  47336. */
  47337. onbuttonup(callback: (buttonReleased: DualShockButton) => void): void;
  47338. /**
  47339. * Defines the callback to call when a pad is pressed
  47340. * @param callback defines the callback to use
  47341. */
  47342. ondpaddown(callback: (dPadPressed: DualShockDpad) => void): void;
  47343. /**
  47344. * Defines the callback to call when a pad is released
  47345. * @param callback defines the callback to use
  47346. */
  47347. ondpadup(callback: (dPadReleased: DualShockDpad) => void): void;
  47348. private _setButtonValue;
  47349. private _setDPadValue;
  47350. /**
  47351. * Gets the value of the `Cross` button
  47352. */
  47353. get buttonCross(): number;
  47354. /**
  47355. * Sets the value of the `Cross` button
  47356. */
  47357. set buttonCross(value: number);
  47358. /**
  47359. * Gets the value of the `Circle` button
  47360. */
  47361. get buttonCircle(): number;
  47362. /**
  47363. * Sets the value of the `Circle` button
  47364. */
  47365. set buttonCircle(value: number);
  47366. /**
  47367. * Gets the value of the `Square` button
  47368. */
  47369. get buttonSquare(): number;
  47370. /**
  47371. * Sets the value of the `Square` button
  47372. */
  47373. set buttonSquare(value: number);
  47374. /**
  47375. * Gets the value of the `Triangle` button
  47376. */
  47377. get buttonTriangle(): number;
  47378. /**
  47379. * Sets the value of the `Triangle` button
  47380. */
  47381. set buttonTriangle(value: number);
  47382. /**
  47383. * Gets the value of the `Options` button
  47384. */
  47385. get buttonOptions(): number;
  47386. /**
  47387. * Sets the value of the `Options` button
  47388. */
  47389. set buttonOptions(value: number);
  47390. /**
  47391. * Gets the value of the `Share` button
  47392. */
  47393. get buttonShare(): number;
  47394. /**
  47395. * Sets the value of the `Share` button
  47396. */
  47397. set buttonShare(value: number);
  47398. /**
  47399. * Gets the value of the `L1` button
  47400. */
  47401. get buttonL1(): number;
  47402. /**
  47403. * Sets the value of the `L1` button
  47404. */
  47405. set buttonL1(value: number);
  47406. /**
  47407. * Gets the value of the `R1` button
  47408. */
  47409. get buttonR1(): number;
  47410. /**
  47411. * Sets the value of the `R1` button
  47412. */
  47413. set buttonR1(value: number);
  47414. /**
  47415. * Gets the value of the Left joystick
  47416. */
  47417. get buttonLeftStick(): number;
  47418. /**
  47419. * Sets the value of the Left joystick
  47420. */
  47421. set buttonLeftStick(value: number);
  47422. /**
  47423. * Gets the value of the Right joystick
  47424. */
  47425. get buttonRightStick(): number;
  47426. /**
  47427. * Sets the value of the Right joystick
  47428. */
  47429. set buttonRightStick(value: number);
  47430. /**
  47431. * Gets the value of D-pad up
  47432. */
  47433. get dPadUp(): number;
  47434. /**
  47435. * Sets the value of D-pad up
  47436. */
  47437. set dPadUp(value: number);
  47438. /**
  47439. * Gets the value of D-pad down
  47440. */
  47441. get dPadDown(): number;
  47442. /**
  47443. * Sets the value of D-pad down
  47444. */
  47445. set dPadDown(value: number);
  47446. /**
  47447. * Gets the value of D-pad left
  47448. */
  47449. get dPadLeft(): number;
  47450. /**
  47451. * Sets the value of D-pad left
  47452. */
  47453. set dPadLeft(value: number);
  47454. /**
  47455. * Gets the value of D-pad right
  47456. */
  47457. get dPadRight(): number;
  47458. /**
  47459. * Sets the value of D-pad right
  47460. */
  47461. set dPadRight(value: number);
  47462. /**
  47463. * Force the gamepad to synchronize with device values
  47464. */
  47465. update(): void;
  47466. /**
  47467. * Disposes the gamepad
  47468. */
  47469. dispose(): void;
  47470. }
  47471. }
  47472. declare module "babylonjs/Gamepads/gamepadManager" {
  47473. import { Observable } from "babylonjs/Misc/observable";
  47474. import { Nullable } from "babylonjs/types";
  47475. import { Scene } from "babylonjs/scene";
  47476. import { Gamepad } from "babylonjs/Gamepads/gamepad";
  47477. /**
  47478. * Manager for handling gamepads
  47479. */
  47480. export class GamepadManager {
  47481. private _scene?;
  47482. private _babylonGamepads;
  47483. private _oneGamepadConnected;
  47484. /** @hidden */
  47485. _isMonitoring: boolean;
  47486. private _gamepadEventSupported;
  47487. private _gamepadSupport?;
  47488. /**
  47489. * observable to be triggered when the gamepad controller has been connected
  47490. */
  47491. onGamepadConnectedObservable: Observable<Gamepad>;
  47492. /**
  47493. * observable to be triggered when the gamepad controller has been disconnected
  47494. */
  47495. onGamepadDisconnectedObservable: Observable<Gamepad>;
  47496. private _onGamepadConnectedEvent;
  47497. private _onGamepadDisconnectedEvent;
  47498. /**
  47499. * Initializes the gamepad manager
  47500. * @param _scene BabylonJS scene
  47501. */
  47502. constructor(_scene?: Scene | undefined);
  47503. /**
  47504. * The gamepads in the game pad manager
  47505. */
  47506. get gamepads(): Gamepad[];
  47507. /**
  47508. * Get the gamepad controllers based on type
  47509. * @param type The type of gamepad controller
  47510. * @returns Nullable gamepad
  47511. */
  47512. getGamepadByType(type?: number): Nullable<Gamepad>;
  47513. /**
  47514. * Disposes the gamepad manager
  47515. */
  47516. dispose(): void;
  47517. private _addNewGamepad;
  47518. private _startMonitoringGamepads;
  47519. private _stopMonitoringGamepads;
  47520. /** @hidden */
  47521. _checkGamepadsStatus(): void;
  47522. private _updateGamepadObjects;
  47523. }
  47524. }
  47525. declare module "babylonjs/Gamepads/gamepadSceneComponent" {
  47526. import { Nullable } from "babylonjs/types";
  47527. import { Scene } from "babylonjs/scene";
  47528. import { ISceneComponent } from "babylonjs/sceneComponent";
  47529. import { GamepadManager } from "babylonjs/Gamepads/gamepadManager";
  47530. module "babylonjs/scene" {
  47531. interface Scene {
  47532. /** @hidden */
  47533. _gamepadManager: Nullable<GamepadManager>;
  47534. /**
  47535. * Gets the gamepad manager associated with the scene
  47536. * @see https://doc.babylonjs.com/how_to/how_to_use_gamepads
  47537. */
  47538. gamepadManager: GamepadManager;
  47539. }
  47540. }
  47541. module "babylonjs/Cameras/freeCameraInputsManager" {
  47542. /**
  47543. * Interface representing a free camera inputs manager
  47544. */
  47545. interface FreeCameraInputsManager {
  47546. /**
  47547. * Adds gamepad input support to the FreeCameraInputsManager.
  47548. * @returns the FreeCameraInputsManager
  47549. */
  47550. addGamepad(): FreeCameraInputsManager;
  47551. }
  47552. }
  47553. module "babylonjs/Cameras/arcRotateCameraInputsManager" {
  47554. /**
  47555. * Interface representing an arc rotate camera inputs manager
  47556. */
  47557. interface ArcRotateCameraInputsManager {
  47558. /**
  47559. * Adds gamepad input support to the ArcRotateCamera InputManager.
  47560. * @returns the camera inputs manager
  47561. */
  47562. addGamepad(): ArcRotateCameraInputsManager;
  47563. }
  47564. }
  47565. /**
  47566. * Defines the gamepad scene component responsible to manage gamepads in a given scene
  47567. */
  47568. export class GamepadSystemSceneComponent implements ISceneComponent {
  47569. /**
  47570. * The component name helpfull to identify the component in the list of scene components.
  47571. */
  47572. readonly name: string;
  47573. /**
  47574. * The scene the component belongs to.
  47575. */
  47576. scene: Scene;
  47577. /**
  47578. * Creates a new instance of the component for the given scene
  47579. * @param scene Defines the scene to register the component in
  47580. */
  47581. constructor(scene: Scene);
  47582. /**
  47583. * Registers the component in a given scene
  47584. */
  47585. register(): void;
  47586. /**
  47587. * Rebuilds the elements related to this component in case of
  47588. * context lost for instance.
  47589. */
  47590. rebuild(): void;
  47591. /**
  47592. * Disposes the component and the associated ressources
  47593. */
  47594. dispose(): void;
  47595. private _beforeCameraUpdate;
  47596. }
  47597. }
  47598. declare module "babylonjs/Cameras/universalCamera" {
  47599. import { TouchCamera } from "babylonjs/Cameras/touchCamera";
  47600. import { Scene } from "babylonjs/scene";
  47601. import { Vector3 } from "babylonjs/Maths/math.vector";
  47602. import "babylonjs/Gamepads/gamepadSceneComponent";
  47603. /**
  47604. * 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,
  47605. * which still works and will still be found in many Playgrounds.
  47606. * @see https://doc.babylonjs.com/features/cameras#universal-camera
  47607. */
  47608. export class UniversalCamera extends TouchCamera {
  47609. /**
  47610. * Defines the gamepad rotation sensiblity.
  47611. * This is the threshold from when rotation starts to be accounted for to prevent jittering.
  47612. */
  47613. get gamepadAngularSensibility(): number;
  47614. set gamepadAngularSensibility(value: number);
  47615. /**
  47616. * Defines the gamepad move sensiblity.
  47617. * This is the threshold from when moving starts to be accounted for for to prevent jittering.
  47618. */
  47619. get gamepadMoveSensibility(): number;
  47620. set gamepadMoveSensibility(value: number);
  47621. /**
  47622. * 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,
  47623. * which still works and will still be found in many Playgrounds.
  47624. * @see https://doc.babylonjs.com/features/cameras#universal-camera
  47625. * @param name Define the name of the camera in the scene
  47626. * @param position Define the start position of the camera in the scene
  47627. * @param scene Define the scene the camera belongs to
  47628. */
  47629. constructor(name: string, position: Vector3, scene: Scene);
  47630. /**
  47631. * Gets the current object class name.
  47632. * @return the class name
  47633. */
  47634. getClassName(): string;
  47635. }
  47636. }
  47637. declare module "babylonjs/Cameras/gamepadCamera" {
  47638. import { UniversalCamera } from "babylonjs/Cameras/universalCamera";
  47639. import { Scene } from "babylonjs/scene";
  47640. import { Vector3 } from "babylonjs/Maths/math.vector";
  47641. /**
  47642. * This represents a FPS type of camera. This is only here for back compat purpose.
  47643. * Please use the UniversalCamera instead as both are identical.
  47644. * @see https://doc.babylonjs.com/features/cameras#universal-camera
  47645. */
  47646. export class GamepadCamera extends UniversalCamera {
  47647. /**
  47648. * Instantiates a new Gamepad Camera
  47649. * This represents a FPS type of camera. This is only here for back compat purpose.
  47650. * Please use the UniversalCamera instead as both are identical.
  47651. * @see https://doc.babylonjs.com/features/cameras#universal-camera
  47652. * @param name Define the name of the camera in the scene
  47653. * @param position Define the start position of the camera in the scene
  47654. * @param scene Define the scene the camera belongs to
  47655. */
  47656. constructor(name: string, position: Vector3, scene: Scene);
  47657. /**
  47658. * Gets the current object class name.
  47659. * @return the class name
  47660. */
  47661. getClassName(): string;
  47662. }
  47663. }
  47664. declare module "babylonjs/Shaders/pass.fragment" {
  47665. /** @hidden */
  47666. export var passPixelShader: {
  47667. name: string;
  47668. shader: string;
  47669. };
  47670. }
  47671. declare module "babylonjs/Shaders/passCube.fragment" {
  47672. /** @hidden */
  47673. export var passCubePixelShader: {
  47674. name: string;
  47675. shader: string;
  47676. };
  47677. }
  47678. declare module "babylonjs/PostProcesses/passPostProcess" {
  47679. import { Nullable } from "babylonjs/types";
  47680. import { Camera } from "babylonjs/Cameras/camera";
  47681. import { PostProcess, PostProcessOptions } from "babylonjs/PostProcesses/postProcess";
  47682. import { Engine } from "babylonjs/Engines/engine";
  47683. import "babylonjs/Shaders/pass.fragment";
  47684. import "babylonjs/Shaders/passCube.fragment";
  47685. import { Scene } from "babylonjs/scene";
  47686. /**
  47687. * PassPostProcess which produces an output the same as it's input
  47688. */
  47689. export class PassPostProcess extends PostProcess {
  47690. /**
  47691. * Gets a string identifying the name of the class
  47692. * @returns "PassPostProcess" string
  47693. */
  47694. getClassName(): string;
  47695. /**
  47696. * Creates the PassPostProcess
  47697. * @param name The name of the effect.
  47698. * @param options The required width/height ratio to downsize to before computing the render pass.
  47699. * @param camera The camera to apply the render pass to.
  47700. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  47701. * @param engine The engine which the post process will be applied. (default: current engine)
  47702. * @param reusable If the post process can be reused on the same frame. (default: false)
  47703. * @param textureType The type of texture to be used when performing the post processing.
  47704. * @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)
  47705. */
  47706. constructor(name: string, options: number | PostProcessOptions, camera?: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number, blockCompilation?: boolean);
  47707. /** @hidden */
  47708. static _Parse(parsedPostProcess: any, targetCamera: Camera, scene: Scene, rootUrl: string): PassPostProcess;
  47709. }
  47710. /**
  47711. * PassCubePostProcess which produces an output the same as it's input (which must be a cube texture)
  47712. */
  47713. export class PassCubePostProcess extends PostProcess {
  47714. private _face;
  47715. /**
  47716. * Gets or sets the cube face to display.
  47717. * * 0 is +X
  47718. * * 1 is -X
  47719. * * 2 is +Y
  47720. * * 3 is -Y
  47721. * * 4 is +Z
  47722. * * 5 is -Z
  47723. */
  47724. get face(): number;
  47725. set face(value: number);
  47726. /**
  47727. * Gets a string identifying the name of the class
  47728. * @returns "PassCubePostProcess" string
  47729. */
  47730. getClassName(): string;
  47731. /**
  47732. * Creates the PassCubePostProcess
  47733. * @param name The name of the effect.
  47734. * @param options The required width/height ratio to downsize to before computing the render pass.
  47735. * @param camera The camera to apply the render pass to.
  47736. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  47737. * @param engine The engine which the post process will be applied. (default: current engine)
  47738. * @param reusable If the post process can be reused on the same frame. (default: false)
  47739. * @param textureType The type of texture to be used when performing the post processing.
  47740. * @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)
  47741. */
  47742. constructor(name: string, options: number | PostProcessOptions, camera?: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number, blockCompilation?: boolean);
  47743. /** @hidden */
  47744. static _Parse(parsedPostProcess: any, targetCamera: Camera, scene: Scene, rootUrl: string): PassCubePostProcess;
  47745. }
  47746. }
  47747. declare module "babylonjs/Shaders/anaglyph.fragment" {
  47748. /** @hidden */
  47749. export var anaglyphPixelShader: {
  47750. name: string;
  47751. shader: string;
  47752. };
  47753. }
  47754. declare module "babylonjs/PostProcesses/anaglyphPostProcess" {
  47755. import { Engine } from "babylonjs/Engines/engine";
  47756. import { PostProcess, PostProcessOptions } from "babylonjs/PostProcesses/postProcess";
  47757. import { Camera } from "babylonjs/Cameras/camera";
  47758. import "babylonjs/Shaders/anaglyph.fragment";
  47759. /**
  47760. * Postprocess used to generate anaglyphic rendering
  47761. */
  47762. export class AnaglyphPostProcess extends PostProcess {
  47763. private _passedProcess;
  47764. /**
  47765. * Gets a string identifying the name of the class
  47766. * @returns "AnaglyphPostProcess" string
  47767. */
  47768. getClassName(): string;
  47769. /**
  47770. * Creates a new AnaglyphPostProcess
  47771. * @param name defines postprocess name
  47772. * @param options defines creation options or target ratio scale
  47773. * @param rigCameras defines cameras using this postprocess
  47774. * @param samplingMode defines required sampling mode (BABYLON.Texture.NEAREST_SAMPLINGMODE by default)
  47775. * @param engine defines hosting engine
  47776. * @param reusable defines if the postprocess will be reused multiple times per frame
  47777. */
  47778. constructor(name: string, options: number | PostProcessOptions, rigCameras: Camera[], samplingMode?: number, engine?: Engine, reusable?: boolean);
  47779. }
  47780. }
  47781. declare module "babylonjs/Cameras/RigModes/stereoscopicAnaglyphRigMode" { }
  47782. declare module "babylonjs/Cameras/Stereoscopic/anaglyphArcRotateCamera" {
  47783. import { ArcRotateCamera } from "babylonjs/Cameras/arcRotateCamera";
  47784. import { Scene } from "babylonjs/scene";
  47785. import { Vector3 } from "babylonjs/Maths/math.vector";
  47786. import "babylonjs/Cameras/RigModes/stereoscopicAnaglyphRigMode";
  47787. /**
  47788. * Camera used to simulate anaglyphic rendering (based on ArcRotateCamera)
  47789. * @see https://doc.babylonjs.com/features/cameras#anaglyph-cameras
  47790. */
  47791. export class AnaglyphArcRotateCamera extends ArcRotateCamera {
  47792. /**
  47793. * Creates a new AnaglyphArcRotateCamera
  47794. * @param name defines camera name
  47795. * @param alpha defines alpha angle (in radians)
  47796. * @param beta defines beta angle (in radians)
  47797. * @param radius defines radius
  47798. * @param target defines camera target
  47799. * @param interaxialDistance defines distance between each color axis
  47800. * @param scene defines the hosting scene
  47801. */
  47802. constructor(name: string, alpha: number, beta: number, radius: number, target: Vector3, interaxialDistance: number, scene: Scene);
  47803. /**
  47804. * Gets camera class name
  47805. * @returns AnaglyphArcRotateCamera
  47806. */
  47807. getClassName(): string;
  47808. }
  47809. }
  47810. declare module "babylonjs/Cameras/Stereoscopic/anaglyphFreeCamera" {
  47811. import { FreeCamera } from "babylonjs/Cameras/freeCamera";
  47812. import { Scene } from "babylonjs/scene";
  47813. import { Vector3 } from "babylonjs/Maths/math.vector";
  47814. import "babylonjs/Cameras/RigModes/stereoscopicAnaglyphRigMode";
  47815. /**
  47816. * Camera used to simulate anaglyphic rendering (based on FreeCamera)
  47817. * @see https://doc.babylonjs.com/features/cameras#anaglyph-cameras
  47818. */
  47819. export class AnaglyphFreeCamera extends FreeCamera {
  47820. /**
  47821. * Creates a new AnaglyphFreeCamera
  47822. * @param name defines camera name
  47823. * @param position defines initial position
  47824. * @param interaxialDistance defines distance between each color axis
  47825. * @param scene defines the hosting scene
  47826. */
  47827. constructor(name: string, position: Vector3, interaxialDistance: number, scene: Scene);
  47828. /**
  47829. * Gets camera class name
  47830. * @returns AnaglyphFreeCamera
  47831. */
  47832. getClassName(): string;
  47833. }
  47834. }
  47835. declare module "babylonjs/Cameras/Stereoscopic/anaglyphGamepadCamera" {
  47836. import { GamepadCamera } from "babylonjs/Cameras/gamepadCamera";
  47837. import { Scene } from "babylonjs/scene";
  47838. import { Vector3 } from "babylonjs/Maths/math.vector";
  47839. import "babylonjs/Cameras/RigModes/stereoscopicAnaglyphRigMode";
  47840. /**
  47841. * Camera used to simulate anaglyphic rendering (based on GamepadCamera)
  47842. * @see https://doc.babylonjs.com/features/cameras#anaglyph-cameras
  47843. */
  47844. export class AnaglyphGamepadCamera extends GamepadCamera {
  47845. /**
  47846. * Creates a new AnaglyphGamepadCamera
  47847. * @param name defines camera name
  47848. * @param position defines initial position
  47849. * @param interaxialDistance defines distance between each color axis
  47850. * @param scene defines the hosting scene
  47851. */
  47852. constructor(name: string, position: Vector3, interaxialDistance: number, scene: Scene);
  47853. /**
  47854. * Gets camera class name
  47855. * @returns AnaglyphGamepadCamera
  47856. */
  47857. getClassName(): string;
  47858. }
  47859. }
  47860. declare module "babylonjs/Cameras/Stereoscopic/anaglyphUniversalCamera" {
  47861. import { UniversalCamera } from "babylonjs/Cameras/universalCamera";
  47862. import { Scene } from "babylonjs/scene";
  47863. import { Vector3 } from "babylonjs/Maths/math.vector";
  47864. import "babylonjs/Cameras/RigModes/stereoscopicAnaglyphRigMode";
  47865. /**
  47866. * Camera used to simulate anaglyphic rendering (based on UniversalCamera)
  47867. * @see https://doc.babylonjs.com/features/cameras#anaglyph-cameras
  47868. */
  47869. export class AnaglyphUniversalCamera extends UniversalCamera {
  47870. /**
  47871. * Creates a new AnaglyphUniversalCamera
  47872. * @param name defines camera name
  47873. * @param position defines initial position
  47874. * @param interaxialDistance defines distance between each color axis
  47875. * @param scene defines the hosting scene
  47876. */
  47877. constructor(name: string, position: Vector3, interaxialDistance: number, scene: Scene);
  47878. /**
  47879. * Gets camera class name
  47880. * @returns AnaglyphUniversalCamera
  47881. */
  47882. getClassName(): string;
  47883. }
  47884. }
  47885. declare module "babylonjs/Cameras/RigModes/stereoscopicRigMode" { }
  47886. declare module "babylonjs/Cameras/Stereoscopic/stereoscopicArcRotateCamera" {
  47887. import { ArcRotateCamera } from "babylonjs/Cameras/arcRotateCamera";
  47888. import { Scene } from "babylonjs/scene";
  47889. import { Vector3 } from "babylonjs/Maths/math.vector";
  47890. import "babylonjs/Cameras/RigModes/stereoscopicRigMode";
  47891. /**
  47892. * Camera used to simulate stereoscopic rendering (based on ArcRotateCamera)
  47893. * @see https://doc.babylonjs.com/features/cameras
  47894. */
  47895. export class StereoscopicArcRotateCamera extends ArcRotateCamera {
  47896. /**
  47897. * Creates a new StereoscopicArcRotateCamera
  47898. * @param name defines camera name
  47899. * @param alpha defines alpha angle (in radians)
  47900. * @param beta defines beta angle (in radians)
  47901. * @param radius defines radius
  47902. * @param target defines camera target
  47903. * @param interaxialDistance defines distance between each color axis
  47904. * @param isStereoscopicSideBySide defines is stereoscopic is done side by side or over under
  47905. * @param scene defines the hosting scene
  47906. */
  47907. constructor(name: string, alpha: number, beta: number, radius: number, target: Vector3, interaxialDistance: number, isStereoscopicSideBySide: boolean, scene: Scene);
  47908. /**
  47909. * Gets camera class name
  47910. * @returns StereoscopicArcRotateCamera
  47911. */
  47912. getClassName(): string;
  47913. }
  47914. }
  47915. declare module "babylonjs/Cameras/Stereoscopic/stereoscopicFreeCamera" {
  47916. import { FreeCamera } from "babylonjs/Cameras/freeCamera";
  47917. import { Scene } from "babylonjs/scene";
  47918. import { Vector3 } from "babylonjs/Maths/math.vector";
  47919. import "babylonjs/Cameras/RigModes/stereoscopicRigMode";
  47920. /**
  47921. * Camera used to simulate stereoscopic rendering (based on FreeCamera)
  47922. * @see https://doc.babylonjs.com/features/cameras
  47923. */
  47924. export class StereoscopicFreeCamera extends FreeCamera {
  47925. /**
  47926. * Creates a new StereoscopicFreeCamera
  47927. * @param name defines camera name
  47928. * @param position defines initial position
  47929. * @param interaxialDistance defines distance between each color axis
  47930. * @param isStereoscopicSideBySide defines is stereoscopic is done side by side or over under
  47931. * @param scene defines the hosting scene
  47932. */
  47933. constructor(name: string, position: Vector3, interaxialDistance: number, isStereoscopicSideBySide: boolean, scene: Scene);
  47934. /**
  47935. * Gets camera class name
  47936. * @returns StereoscopicFreeCamera
  47937. */
  47938. getClassName(): string;
  47939. }
  47940. }
  47941. declare module "babylonjs/Cameras/Stereoscopic/stereoscopicGamepadCamera" {
  47942. import { GamepadCamera } from "babylonjs/Cameras/gamepadCamera";
  47943. import { Scene } from "babylonjs/scene";
  47944. import { Vector3 } from "babylonjs/Maths/math.vector";
  47945. import "babylonjs/Cameras/RigModes/stereoscopicRigMode";
  47946. /**
  47947. * Camera used to simulate stereoscopic rendering (based on GamepadCamera)
  47948. * @see https://doc.babylonjs.com/features/cameras
  47949. */
  47950. export class StereoscopicGamepadCamera extends GamepadCamera {
  47951. /**
  47952. * Creates a new StereoscopicGamepadCamera
  47953. * @param name defines camera name
  47954. * @param position defines initial position
  47955. * @param interaxialDistance defines distance between each color axis
  47956. * @param isStereoscopicSideBySide defines is stereoscopic is done side by side or over under
  47957. * @param scene defines the hosting scene
  47958. */
  47959. constructor(name: string, position: Vector3, interaxialDistance: number, isStereoscopicSideBySide: boolean, scene: Scene);
  47960. /**
  47961. * Gets camera class name
  47962. * @returns StereoscopicGamepadCamera
  47963. */
  47964. getClassName(): string;
  47965. }
  47966. }
  47967. declare module "babylonjs/Cameras/Stereoscopic/stereoscopicUniversalCamera" {
  47968. import { UniversalCamera } from "babylonjs/Cameras/universalCamera";
  47969. import { Scene } from "babylonjs/scene";
  47970. import { Vector3 } from "babylonjs/Maths/math.vector";
  47971. import "babylonjs/Cameras/RigModes/stereoscopicRigMode";
  47972. /**
  47973. * Camera used to simulate stereoscopic rendering (based on UniversalCamera)
  47974. * @see https://doc.babylonjs.com/features/cameras
  47975. */
  47976. export class StereoscopicUniversalCamera extends UniversalCamera {
  47977. /**
  47978. * Creates a new StereoscopicUniversalCamera
  47979. * @param name defines camera name
  47980. * @param position defines initial position
  47981. * @param interaxialDistance defines distance between each color axis
  47982. * @param isStereoscopicSideBySide defines is stereoscopic is done side by side or over under
  47983. * @param scene defines the hosting scene
  47984. */
  47985. constructor(name: string, position: Vector3, interaxialDistance: number, isStereoscopicSideBySide: boolean, scene: Scene);
  47986. /**
  47987. * Gets camera class name
  47988. * @returns StereoscopicUniversalCamera
  47989. */
  47990. getClassName(): string;
  47991. }
  47992. }
  47993. declare module "babylonjs/Cameras/Stereoscopic/index" {
  47994. export * from "babylonjs/Cameras/Stereoscopic/anaglyphArcRotateCamera";
  47995. export * from "babylonjs/Cameras/Stereoscopic/anaglyphFreeCamera";
  47996. export * from "babylonjs/Cameras/Stereoscopic/anaglyphGamepadCamera";
  47997. export * from "babylonjs/Cameras/Stereoscopic/anaglyphUniversalCamera";
  47998. export * from "babylonjs/Cameras/Stereoscopic/stereoscopicArcRotateCamera";
  47999. export * from "babylonjs/Cameras/Stereoscopic/stereoscopicFreeCamera";
  48000. export * from "babylonjs/Cameras/Stereoscopic/stereoscopicGamepadCamera";
  48001. export * from "babylonjs/Cameras/Stereoscopic/stereoscopicUniversalCamera";
  48002. }
  48003. declare module "babylonjs/Cameras/virtualJoysticksCamera" {
  48004. import { FreeCamera } from "babylonjs/Cameras/freeCamera";
  48005. import { Scene } from "babylonjs/scene";
  48006. import { Vector3 } from "babylonjs/Maths/math.vector";
  48007. import "babylonjs/Cameras/Inputs/freeCameraVirtualJoystickInput";
  48008. /**
  48009. * This represents a free type of camera. It can be useful in First Person Shooter game for instance.
  48010. * It is identical to the Free Camera and simply adds by default a virtual joystick.
  48011. * Virtual Joysticks are on-screen 2D graphics that are used to control the camera or other scene items.
  48012. * @see https://doc.babylonjs.com/features/cameras#virtual-joysticks-camera
  48013. */
  48014. export class VirtualJoysticksCamera extends FreeCamera {
  48015. /**
  48016. * Intantiates a VirtualJoysticksCamera. It can be useful in First Person Shooter game for instance.
  48017. * It is identical to the Free Camera and simply adds by default a virtual joystick.
  48018. * Virtual Joysticks are on-screen 2D graphics that are used to control the camera or other scene items.
  48019. * @see https://doc.babylonjs.com/features/cameras#virtual-joysticks-camera
  48020. * @param name Define the name of the camera in the scene
  48021. * @param position Define the start position of the camera in the scene
  48022. * @param scene Define the scene the camera belongs to
  48023. */
  48024. constructor(name: string, position: Vector3, scene: Scene);
  48025. /**
  48026. * Gets the current object class name.
  48027. * @return the class name
  48028. */
  48029. getClassName(): string;
  48030. }
  48031. }
  48032. declare module "babylonjs/Cameras/VR/vrCameraMetrics" {
  48033. import { Matrix } from "babylonjs/Maths/math.vector";
  48034. /**
  48035. * This represents all the required metrics to create a VR camera.
  48036. * @see https://doc.babylonjs.com/babylon101/cameras#device-orientation-camera
  48037. */
  48038. export class VRCameraMetrics {
  48039. /**
  48040. * Define the horizontal resolution off the screen.
  48041. */
  48042. hResolution: number;
  48043. /**
  48044. * Define the vertical resolution off the screen.
  48045. */
  48046. vResolution: number;
  48047. /**
  48048. * Define the horizontal screen size.
  48049. */
  48050. hScreenSize: number;
  48051. /**
  48052. * Define the vertical screen size.
  48053. */
  48054. vScreenSize: number;
  48055. /**
  48056. * Define the vertical screen center position.
  48057. */
  48058. vScreenCenter: number;
  48059. /**
  48060. * Define the distance of the eyes to the screen.
  48061. */
  48062. eyeToScreenDistance: number;
  48063. /**
  48064. * Define the distance between both lenses
  48065. */
  48066. lensSeparationDistance: number;
  48067. /**
  48068. * Define the distance between both viewer's eyes.
  48069. */
  48070. interpupillaryDistance: number;
  48071. /**
  48072. * Define the distortion factor of the VR postprocess.
  48073. * Please, touch with care.
  48074. */
  48075. distortionK: number[];
  48076. /**
  48077. * Define the chromatic aberration correction factors for the VR post process.
  48078. */
  48079. chromaAbCorrection: number[];
  48080. /**
  48081. * Define the scale factor of the post process.
  48082. * The smaller the better but the slower.
  48083. */
  48084. postProcessScaleFactor: number;
  48085. /**
  48086. * Define an offset for the lens center.
  48087. */
  48088. lensCenterOffset: number;
  48089. /**
  48090. * Define if the current vr camera should compensate the distortion of the lense or not.
  48091. */
  48092. compensateDistortion: boolean;
  48093. /**
  48094. * Defines if multiview should be enabled when rendering (Default: false)
  48095. */
  48096. multiviewEnabled: boolean;
  48097. /**
  48098. * Gets the rendering aspect ratio based on the provided resolutions.
  48099. */
  48100. get aspectRatio(): number;
  48101. /**
  48102. * Gets the aspect ratio based on the FOV, scale factors, and real screen sizes.
  48103. */
  48104. get aspectRatioFov(): number;
  48105. /**
  48106. * @hidden
  48107. */
  48108. get leftHMatrix(): Matrix;
  48109. /**
  48110. * @hidden
  48111. */
  48112. get rightHMatrix(): Matrix;
  48113. /**
  48114. * @hidden
  48115. */
  48116. get leftPreViewMatrix(): Matrix;
  48117. /**
  48118. * @hidden
  48119. */
  48120. get rightPreViewMatrix(): Matrix;
  48121. /**
  48122. * Get the default VRMetrics based on the most generic setup.
  48123. * @returns the default vr metrics
  48124. */
  48125. static GetDefault(): VRCameraMetrics;
  48126. }
  48127. }
  48128. declare module "babylonjs/Shaders/vrDistortionCorrection.fragment" {
  48129. /** @hidden */
  48130. export var vrDistortionCorrectionPixelShader: {
  48131. name: string;
  48132. shader: string;
  48133. };
  48134. }
  48135. declare module "babylonjs/PostProcesses/vrDistortionCorrectionPostProcess" {
  48136. import { Camera } from "babylonjs/Cameras/camera";
  48137. import { VRCameraMetrics } from "babylonjs/Cameras/VR/vrCameraMetrics";
  48138. import { PostProcess } from "babylonjs/PostProcesses/postProcess";
  48139. import "babylonjs/Shaders/vrDistortionCorrection.fragment";
  48140. /**
  48141. * VRDistortionCorrectionPostProcess used for mobile VR
  48142. */
  48143. export class VRDistortionCorrectionPostProcess extends PostProcess {
  48144. private _isRightEye;
  48145. private _distortionFactors;
  48146. private _postProcessScaleFactor;
  48147. private _lensCenterOffset;
  48148. private _scaleIn;
  48149. private _scaleFactor;
  48150. private _lensCenter;
  48151. /**
  48152. * Gets a string identifying the name of the class
  48153. * @returns "VRDistortionCorrectionPostProcess" string
  48154. */
  48155. getClassName(): string;
  48156. /**
  48157. * Initializes the VRDistortionCorrectionPostProcess
  48158. * @param name The name of the effect.
  48159. * @param camera The camera to apply the render pass to.
  48160. * @param isRightEye If this is for the right eye distortion
  48161. * @param vrMetrics All the required metrics for the VR camera
  48162. */
  48163. constructor(name: string, camera: Camera, isRightEye: boolean, vrMetrics: VRCameraMetrics);
  48164. }
  48165. }
  48166. declare module "babylonjs/Cameras/RigModes/vrRigMode" { }
  48167. declare module "babylonjs/Cameras/VR/vrDeviceOrientationArcRotateCamera" {
  48168. import { ArcRotateCamera } from "babylonjs/Cameras/arcRotateCamera";
  48169. import { VRCameraMetrics } from "babylonjs/Cameras/VR/vrCameraMetrics";
  48170. import { Scene } from "babylonjs/scene";
  48171. import { Vector3 } from "babylonjs/Maths/math.vector";
  48172. import "babylonjs/Cameras/Inputs/arcRotateCameraVRDeviceOrientationInput";
  48173. import "babylonjs/Cameras/RigModes/vrRigMode";
  48174. /**
  48175. * Camera used to simulate VR rendering (based on ArcRotateCamera)
  48176. * @see https://doc.babylonjs.com/babylon101/cameras#vr-device-orientation-cameras
  48177. */
  48178. export class VRDeviceOrientationArcRotateCamera extends ArcRotateCamera {
  48179. /**
  48180. * Creates a new VRDeviceOrientationArcRotateCamera
  48181. * @param name defines camera name
  48182. * @param alpha defines the camera rotation along the logitudinal axis
  48183. * @param beta defines the camera rotation along the latitudinal axis
  48184. * @param radius defines the camera distance from its target
  48185. * @param target defines the camera target
  48186. * @param scene defines the scene the camera belongs to
  48187. * @param compensateDistortion defines if the camera needs to compensate the lens distorsion
  48188. * @param vrCameraMetrics defines the vr metrics associated to the camera
  48189. */
  48190. constructor(name: string, alpha: number, beta: number, radius: number, target: Vector3, scene: Scene, compensateDistortion?: boolean, vrCameraMetrics?: VRCameraMetrics);
  48191. /**
  48192. * Gets camera class name
  48193. * @returns VRDeviceOrientationArcRotateCamera
  48194. */
  48195. getClassName(): string;
  48196. }
  48197. }
  48198. declare module "babylonjs/Cameras/VR/vrDeviceOrientationFreeCamera" {
  48199. import { DeviceOrientationCamera } from "babylonjs/Cameras/deviceOrientationCamera";
  48200. import { VRCameraMetrics } from "babylonjs/Cameras/VR/vrCameraMetrics";
  48201. import { Scene } from "babylonjs/scene";
  48202. import { Vector3 } from "babylonjs/Maths/math.vector";
  48203. import "babylonjs/Cameras/RigModes/vrRigMode";
  48204. /**
  48205. * Camera used to simulate VR rendering (based on FreeCamera)
  48206. * @see https://doc.babylonjs.com/babylon101/cameras#vr-device-orientation-cameras
  48207. */
  48208. export class VRDeviceOrientationFreeCamera extends DeviceOrientationCamera {
  48209. /**
  48210. * Creates a new VRDeviceOrientationFreeCamera
  48211. * @param name defines camera name
  48212. * @param position defines the start position of the camera
  48213. * @param scene defines the scene the camera belongs to
  48214. * @param compensateDistortion defines if the camera needs to compensate the lens distorsion
  48215. * @param vrCameraMetrics defines the vr metrics associated to the camera
  48216. */
  48217. constructor(name: string, position: Vector3, scene: Scene, compensateDistortion?: boolean, vrCameraMetrics?: VRCameraMetrics);
  48218. /**
  48219. * Gets camera class name
  48220. * @returns VRDeviceOrientationFreeCamera
  48221. */
  48222. getClassName(): string;
  48223. }
  48224. }
  48225. declare module "babylonjs/Cameras/VR/vrDeviceOrientationGamepadCamera" {
  48226. import { VRDeviceOrientationFreeCamera } from "babylonjs/Cameras/VR/vrDeviceOrientationFreeCamera";
  48227. import { VRCameraMetrics } from "babylonjs/Cameras/VR/vrCameraMetrics";
  48228. import { Scene } from "babylonjs/scene";
  48229. import { Vector3 } from "babylonjs/Maths/math.vector";
  48230. import "babylonjs/Gamepads/gamepadSceneComponent";
  48231. /**
  48232. * Camera used to simulate VR rendering (based on VRDeviceOrientationFreeCamera)
  48233. * @see https://doc.babylonjs.com/babylon101/cameras#vr-device-orientation-cameras
  48234. */
  48235. export class VRDeviceOrientationGamepadCamera extends VRDeviceOrientationFreeCamera {
  48236. /**
  48237. * Creates a new VRDeviceOrientationGamepadCamera
  48238. * @param name defines camera name
  48239. * @param position defines the start position of the camera
  48240. * @param scene defines the scene the camera belongs to
  48241. * @param compensateDistortion defines if the camera needs to compensate the lens distorsion
  48242. * @param vrCameraMetrics defines the vr metrics associated to the camera
  48243. */
  48244. constructor(name: string, position: Vector3, scene: Scene, compensateDistortion?: boolean, vrCameraMetrics?: VRCameraMetrics);
  48245. /**
  48246. * Gets camera class name
  48247. * @returns VRDeviceOrientationGamepadCamera
  48248. */
  48249. getClassName(): string;
  48250. }
  48251. }
  48252. declare module "babylonjs/Materials/Textures/dynamicTexture" {
  48253. import { Scene } from "babylonjs/scene";
  48254. import { Texture } from "babylonjs/Materials/Textures/texture";
  48255. import "babylonjs/Engines/Extensions/engine.dynamicTexture";
  48256. /**
  48257. * A class extending Texture allowing drawing on a texture
  48258. * @see https://doc.babylonjs.com/how_to/dynamictexture
  48259. */
  48260. export class DynamicTexture extends Texture {
  48261. private _generateMipMaps;
  48262. private _canvas;
  48263. private _context;
  48264. /**
  48265. * Creates a DynamicTexture
  48266. * @param name defines the name of the texture
  48267. * @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
  48268. * @param scene defines the scene where you want the texture
  48269. * @param generateMipMaps defines the use of MinMaps or not (default is false)
  48270. * @param samplingMode defines the sampling mode to use (default is Texture.TRILINEAR_SAMPLINGMODE)
  48271. * @param format defines the texture format to use (default is Engine.TEXTUREFORMAT_RGBA)
  48272. */
  48273. constructor(name: string, options: any, scene: Scene | null | undefined, generateMipMaps: boolean, samplingMode?: number, format?: number);
  48274. /**
  48275. * Get the current class name of the texture useful for serialization or dynamic coding.
  48276. * @returns "DynamicTexture"
  48277. */
  48278. getClassName(): string;
  48279. /**
  48280. * Gets the current state of canRescale
  48281. */
  48282. get canRescale(): boolean;
  48283. private _recreate;
  48284. /**
  48285. * Scales the texture
  48286. * @param ratio the scale factor to apply to both width and height
  48287. */
  48288. scale(ratio: number): void;
  48289. /**
  48290. * Resizes the texture
  48291. * @param width the new width
  48292. * @param height the new height
  48293. */
  48294. scaleTo(width: number, height: number): void;
  48295. /**
  48296. * Gets the context of the canvas used by the texture
  48297. * @returns the canvas context of the dynamic texture
  48298. */
  48299. getContext(): CanvasRenderingContext2D;
  48300. /**
  48301. * Clears the texture
  48302. */
  48303. clear(): void;
  48304. /**
  48305. * Updates the texture
  48306. * @param invertY defines the direction for the Y axis (default is true - y increases downwards)
  48307. * @param premulAlpha defines if alpha is stored as premultiplied (default is false)
  48308. */
  48309. update(invertY?: boolean, premulAlpha?: boolean): void;
  48310. /**
  48311. * Draws text onto the texture
  48312. * @param text defines the text to be drawn
  48313. * @param x defines the placement of the text from the left
  48314. * @param y defines the placement of the text from the top when invertY is true and from the bottom when false
  48315. * @param font defines the font to be used with font-style, font-size, font-name
  48316. * @param color defines the color used for the text
  48317. * @param clearColor defines the color for the canvas, use null to not overwrite canvas
  48318. * @param invertY defines the direction for the Y axis (default is true - y increases downwards)
  48319. * @param update defines whether texture is immediately update (default is true)
  48320. */
  48321. drawText(text: string, x: number | null | undefined, y: number | null | undefined, font: string, color: string | null, clearColor: string, invertY?: boolean, update?: boolean): void;
  48322. /**
  48323. * Clones the texture
  48324. * @returns the clone of the texture.
  48325. */
  48326. clone(): DynamicTexture;
  48327. /**
  48328. * Serializes the dynamic texture. The scene should be ready before the dynamic texture is serialized
  48329. * @returns a serialized dynamic texture object
  48330. */
  48331. serialize(): any;
  48332. private _IsCanvasElement;
  48333. /** @hidden */
  48334. _rebuild(): void;
  48335. }
  48336. }
  48337. declare module "babylonjs/Meshes/Builders/groundBuilder" {
  48338. import { Scene } from "babylonjs/scene";
  48339. import { Color3 } from "babylonjs/Maths/math.color";
  48340. import { Mesh } from "babylonjs/Meshes/mesh";
  48341. import { GroundMesh } from "babylonjs/Meshes/groundMesh";
  48342. import { Nullable } from "babylonjs/types";
  48343. /**
  48344. * Class containing static functions to help procedurally build meshes
  48345. */
  48346. export class GroundBuilder {
  48347. /**
  48348. * Creates a ground mesh
  48349. * * The parameters `width` and `height` (floats, default 1) set the width and height sizes of the ground
  48350. * * The parameter `subdivisions` (positive integer) sets the number of subdivisions per side
  48351. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  48352. * @param name defines the name of the mesh
  48353. * @param options defines the options used to create the mesh
  48354. * @param scene defines the hosting scene
  48355. * @returns the ground mesh
  48356. * @see https://doc.babylonjs.com/how_to/set_shapes#ground
  48357. */
  48358. static CreateGround(name: string, options: {
  48359. width?: number;
  48360. height?: number;
  48361. subdivisions?: number;
  48362. subdivisionsX?: number;
  48363. subdivisionsY?: number;
  48364. updatable?: boolean;
  48365. }, scene: any): Mesh;
  48366. /**
  48367. * Creates a tiled ground mesh
  48368. * * The parameters `xmin` and `xmax` (floats, default -1 and 1) set the ground minimum and maximum X coordinates
  48369. * * The parameters `zmin` and `zmax` (floats, default -1 and 1) set the ground minimum and maximum Z coordinates
  48370. * * 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
  48371. * * 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
  48372. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created.
  48373. * @param name defines the name of the mesh
  48374. * @param options defines the options used to create the mesh
  48375. * @param scene defines the hosting scene
  48376. * @returns the tiled ground mesh
  48377. * @see https://doc.babylonjs.com/how_to/set_shapes#tiled-ground
  48378. */
  48379. static CreateTiledGround(name: string, options: {
  48380. xmin: number;
  48381. zmin: number;
  48382. xmax: number;
  48383. zmax: number;
  48384. subdivisions?: {
  48385. w: number;
  48386. h: number;
  48387. };
  48388. precision?: {
  48389. w: number;
  48390. h: number;
  48391. };
  48392. updatable?: boolean;
  48393. }, scene?: Nullable<Scene>): Mesh;
  48394. /**
  48395. * Creates a ground mesh from a height map
  48396. * * The parameter `url` sets the URL of the height map image resource.
  48397. * * The parameters `width` and `height` (positive floats, default 10) set the ground width and height sizes.
  48398. * * The parameter `subdivisions` (positive integer, default 1) sets the number of subdivision per side.
  48399. * * The parameter `minHeight` (float, default 0) is the minimum altitude on the ground.
  48400. * * The parameter `maxHeight` (float, default 1) is the maximum altitude on the ground.
  48401. * * 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.
  48402. * * 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).
  48403. * * The parameter `alphaFilter` will filter any data where the alpha channel is below this value, defaults 0 (all data visible)
  48404. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created.
  48405. * @param name defines the name of the mesh
  48406. * @param url defines the url to the height map
  48407. * @param options defines the options used to create the mesh
  48408. * @param scene defines the hosting scene
  48409. * @returns the ground mesh
  48410. * @see https://doc.babylonjs.com/babylon101/height_map
  48411. * @see https://doc.babylonjs.com/how_to/set_shapes#ground-from-a-height-map
  48412. */
  48413. static CreateGroundFromHeightMap(name: string, url: string, options: {
  48414. width?: number;
  48415. height?: number;
  48416. subdivisions?: number;
  48417. minHeight?: number;
  48418. maxHeight?: number;
  48419. colorFilter?: Color3;
  48420. alphaFilter?: number;
  48421. updatable?: boolean;
  48422. onReady?: (mesh: GroundMesh) => void;
  48423. }, scene?: Nullable<Scene>): GroundMesh;
  48424. }
  48425. }
  48426. declare module "babylonjs/Meshes/Builders/torusBuilder" {
  48427. import { Vector4 } from "babylonjs/Maths/math.vector";
  48428. import { Mesh } from "babylonjs/Meshes/mesh";
  48429. /**
  48430. * Class containing static functions to help procedurally build meshes
  48431. */
  48432. export class TorusBuilder {
  48433. /**
  48434. * Creates a torus mesh
  48435. * * The parameter `diameter` sets the diameter size (float) of the torus (default 1)
  48436. * * The parameter `thickness` sets the diameter size of the tube of the torus (float, default 0.5)
  48437. * * The parameter `tessellation` sets the number of torus sides (postive integer, default 16)
  48438. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  48439. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  48440. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created.
  48441. * @param name defines the name of the mesh
  48442. * @param options defines the options used to create the mesh
  48443. * @param scene defines the hosting scene
  48444. * @returns the torus mesh
  48445. * @see https://doc.babylonjs.com/how_to/set_shapes#torus
  48446. */
  48447. static CreateTorus(name: string, options: {
  48448. diameter?: number;
  48449. thickness?: number;
  48450. tessellation?: number;
  48451. updatable?: boolean;
  48452. sideOrientation?: number;
  48453. frontUVs?: Vector4;
  48454. backUVs?: Vector4;
  48455. }, scene: any): Mesh;
  48456. }
  48457. }
  48458. declare module "babylonjs/Meshes/Builders/cylinderBuilder" {
  48459. import { Vector4 } from "babylonjs/Maths/math.vector";
  48460. import { Color4 } from "babylonjs/Maths/math.color";
  48461. import { Mesh } from "babylonjs/Meshes/mesh";
  48462. /**
  48463. * Class containing static functions to help procedurally build meshes
  48464. */
  48465. export class CylinderBuilder {
  48466. /**
  48467. * Creates a cylinder or a cone mesh
  48468. * * The parameter `height` sets the height size (float) of the cylinder/cone (float, default 2).
  48469. * * The parameter `diameter` sets the diameter of the top and bottom cap at once (float, default 1).
  48470. * * 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.
  48471. * * The parameter `tessellation` sets the number of cylinder sides (positive integer, default 24). Set it to 3 to get a prism for instance.
  48472. * * The parameter `subdivisions` sets the number of rings along the cylinder height (positive integer, default 1).
  48473. * * The parameter `hasRings` (boolean, default false) makes the subdivisions independent from each other, so they become different faces.
  48474. * * The parameter `enclose` (boolean, default false) adds two extra faces per subdivision to a sliced cylinder to close it around its height axis.
  48475. * * 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).
  48476. * * The parameter `arc` (float, default 1) is the ratio (max 1) to apply to the circumference to slice the cylinder.
  48477. * * 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).
  48478. * * 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
  48479. * * Now, if the cylinder has 5 independent subdivisions (hasRings = true), n equals : top face + 5 stripe surfaces + bottom face = 2 + 5 = 7
  48480. * * 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
  48481. * * 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.
  48482. * * If `enclose` is false, a ring surface is one element.
  48483. * * If `enclose` is true, a ring surface is 3 successive elements in the array : the tubular surface, then the two closing faces.
  48484. * * 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
  48485. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  48486. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  48487. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created.
  48488. * @param name defines the name of the mesh
  48489. * @param options defines the options used to create the mesh
  48490. * @param scene defines the hosting scene
  48491. * @returns the cylinder mesh
  48492. * @see https://doc.babylonjs.com/how_to/set_shapes#cylinder-or-cone
  48493. */
  48494. static CreateCylinder(name: string, options: {
  48495. height?: number;
  48496. diameterTop?: number;
  48497. diameterBottom?: number;
  48498. diameter?: number;
  48499. tessellation?: number;
  48500. subdivisions?: number;
  48501. arc?: number;
  48502. faceColors?: Color4[];
  48503. faceUV?: Vector4[];
  48504. updatable?: boolean;
  48505. hasRings?: boolean;
  48506. enclose?: boolean;
  48507. cap?: number;
  48508. sideOrientation?: number;
  48509. frontUVs?: Vector4;
  48510. backUVs?: Vector4;
  48511. }, scene: any): Mesh;
  48512. }
  48513. }
  48514. declare module "babylonjs/XR/webXRTypes" {
  48515. import { Nullable } from "babylonjs/types";
  48516. import { IDisposable } from "babylonjs/scene";
  48517. /**
  48518. * States of the webXR experience
  48519. */
  48520. export enum WebXRState {
  48521. /**
  48522. * Transitioning to being in XR mode
  48523. */
  48524. ENTERING_XR = 0,
  48525. /**
  48526. * Transitioning to non XR mode
  48527. */
  48528. EXITING_XR = 1,
  48529. /**
  48530. * In XR mode and presenting
  48531. */
  48532. IN_XR = 2,
  48533. /**
  48534. * Not entered XR mode
  48535. */
  48536. NOT_IN_XR = 3
  48537. }
  48538. /**
  48539. * Abstraction of the XR render target
  48540. */
  48541. export interface WebXRRenderTarget extends IDisposable {
  48542. /**
  48543. * xrpresent context of the canvas which can be used to display/mirror xr content
  48544. */
  48545. canvasContext: WebGLRenderingContext;
  48546. /**
  48547. * xr layer for the canvas
  48548. */
  48549. xrLayer: Nullable<XRWebGLLayer>;
  48550. /**
  48551. * Initializes the xr layer for the session
  48552. * @param xrSession xr session
  48553. * @returns a promise that will resolve once the XR Layer has been created
  48554. */
  48555. initializeXRLayerAsync(xrSession: XRSession): Promise<XRWebGLLayer>;
  48556. }
  48557. }
  48558. declare module "babylonjs/XR/webXRManagedOutputCanvas" {
  48559. import { Nullable } from "babylonjs/types";
  48560. import { ThinEngine } from "babylonjs/Engines/thinEngine";
  48561. import { WebXRRenderTarget } from "babylonjs/XR/webXRTypes";
  48562. import { WebXRSessionManager } from "babylonjs/XR/webXRSessionManager";
  48563. import { Observable } from "babylonjs/Misc/observable";
  48564. /**
  48565. * COnfiguration object for WebXR output canvas
  48566. */
  48567. export class WebXRManagedOutputCanvasOptions {
  48568. /**
  48569. * An optional canvas in case you wish to create it yourself and provide it here.
  48570. * If not provided, a new canvas will be created
  48571. */
  48572. canvasElement?: HTMLCanvasElement;
  48573. /**
  48574. * Options for this XR Layer output
  48575. */
  48576. canvasOptions?: XRWebGLLayerOptions;
  48577. /**
  48578. * CSS styling for a newly created canvas (if not provided)
  48579. */
  48580. newCanvasCssStyle?: string;
  48581. /**
  48582. * Get the default values of the configuration object
  48583. * @param engine defines the engine to use (can be null)
  48584. * @returns default values of this configuration object
  48585. */
  48586. static GetDefaults(engine?: ThinEngine): WebXRManagedOutputCanvasOptions;
  48587. }
  48588. /**
  48589. * Creates a canvas that is added/removed from the webpage when entering/exiting XR
  48590. */
  48591. export class WebXRManagedOutputCanvas implements WebXRRenderTarget {
  48592. private _options;
  48593. private _canvas;
  48594. private _engine;
  48595. private _originalCanvasSize;
  48596. /**
  48597. * Rendering context of the canvas which can be used to display/mirror xr content
  48598. */
  48599. canvasContext: WebGLRenderingContext;
  48600. /**
  48601. * xr layer for the canvas
  48602. */
  48603. xrLayer: Nullable<XRWebGLLayer>;
  48604. /**
  48605. * Obseervers registered here will be triggered when the xr layer was initialized
  48606. */
  48607. onXRLayerInitObservable: Observable<XRWebGLLayer>;
  48608. /**
  48609. * Initializes the canvas to be added/removed upon entering/exiting xr
  48610. * @param _xrSessionManager The XR Session manager
  48611. * @param _options optional configuration for this canvas output. defaults will be used if not provided
  48612. */
  48613. constructor(_xrSessionManager: WebXRSessionManager, _options?: WebXRManagedOutputCanvasOptions);
  48614. /**
  48615. * Disposes of the object
  48616. */
  48617. dispose(): void;
  48618. /**
  48619. * Initializes the xr layer for the session
  48620. * @param xrSession xr session
  48621. * @returns a promise that will resolve once the XR Layer has been created
  48622. */
  48623. initializeXRLayerAsync(xrSession: XRSession): Promise<XRWebGLLayer>;
  48624. private _addCanvas;
  48625. private _removeCanvas;
  48626. private _setCanvasSize;
  48627. private _setManagedOutputCanvas;
  48628. }
  48629. }
  48630. declare module "babylonjs/XR/webXRSessionManager" {
  48631. import { Observable } from "babylonjs/Misc/observable";
  48632. import { Nullable } from "babylonjs/types";
  48633. import { IDisposable, Scene } from "babylonjs/scene";
  48634. import { RenderTargetTexture } from "babylonjs/Materials/Textures/renderTargetTexture";
  48635. import { WebXRRenderTarget } from "babylonjs/XR/webXRTypes";
  48636. import { WebXRManagedOutputCanvasOptions } from "babylonjs/XR/webXRManagedOutputCanvas";
  48637. /**
  48638. * Manages an XRSession to work with Babylon's engine
  48639. * @see https://doc.babylonjs.com/how_to/webxr_session_manager
  48640. */
  48641. export class WebXRSessionManager implements IDisposable {
  48642. /** The scene which the session should be created for */
  48643. scene: Scene;
  48644. private _referenceSpace;
  48645. private _rttProvider;
  48646. private _sessionEnded;
  48647. private _xrNavigator;
  48648. private baseLayer;
  48649. /**
  48650. * The base reference space from which the session started. good if you want to reset your
  48651. * reference space
  48652. */
  48653. baseReferenceSpace: XRReferenceSpace;
  48654. /**
  48655. * Current XR frame
  48656. */
  48657. currentFrame: Nullable<XRFrame>;
  48658. /** WebXR timestamp updated every frame */
  48659. currentTimestamp: number;
  48660. /**
  48661. * Used just in case of a failure to initialize an immersive session.
  48662. * The viewer reference space is compensated using this height, creating a kind of "viewer-floor" reference space
  48663. */
  48664. defaultHeightCompensation: number;
  48665. /**
  48666. * Fires every time a new xrFrame arrives which can be used to update the camera
  48667. */
  48668. onXRFrameObservable: Observable<XRFrame>;
  48669. /**
  48670. * Fires when the reference space changed
  48671. */
  48672. onXRReferenceSpaceChanged: Observable<XRReferenceSpace>;
  48673. /**
  48674. * Fires when the xr session is ended either by the device or manually done
  48675. */
  48676. onXRSessionEnded: Observable<any>;
  48677. /**
  48678. * Fires when the xr session is ended either by the device or manually done
  48679. */
  48680. onXRSessionInit: Observable<XRSession>;
  48681. /**
  48682. * Underlying xr session
  48683. */
  48684. session: XRSession;
  48685. /**
  48686. * The viewer (head position) reference space. This can be used to get the XR world coordinates
  48687. * or get the offset the player is currently at.
  48688. */
  48689. viewerReferenceSpace: XRReferenceSpace;
  48690. /**
  48691. * Constructs a WebXRSessionManager, this must be initialized within a user action before usage
  48692. * @param scene The scene which the session should be created for
  48693. */
  48694. constructor(
  48695. /** The scene which the session should be created for */
  48696. scene: Scene);
  48697. /**
  48698. * The current reference space used in this session. This reference space can constantly change!
  48699. * It is mainly used to offset the camera's position.
  48700. */
  48701. get referenceSpace(): XRReferenceSpace;
  48702. /**
  48703. * Set a new reference space and triggers the observable
  48704. */
  48705. set referenceSpace(newReferenceSpace: XRReferenceSpace);
  48706. /**
  48707. * Disposes of the session manager
  48708. */
  48709. dispose(): void;
  48710. /**
  48711. * Stops the xrSession and restores the render loop
  48712. * @returns Promise which resolves after it exits XR
  48713. */
  48714. exitXRAsync(): Promise<void>;
  48715. /**
  48716. * Gets the correct render target texture to be rendered this frame for this eye
  48717. * @param eye the eye for which to get the render target
  48718. * @returns the render target for the specified eye
  48719. */
  48720. getRenderTargetTextureForEye(eye: XREye): RenderTargetTexture;
  48721. /**
  48722. * Creates a WebXRRenderTarget object for the XR session
  48723. * @param onStateChangedObservable optional, mechanism for enabling/disabling XR rendering canvas, used only on Web
  48724. * @param options optional options to provide when creating a new render target
  48725. * @returns a WebXR render target to which the session can render
  48726. */
  48727. getWebXRRenderTarget(options?: WebXRManagedOutputCanvasOptions): WebXRRenderTarget;
  48728. /**
  48729. * Initializes the manager
  48730. * After initialization enterXR can be called to start an XR session
  48731. * @returns Promise which resolves after it is initialized
  48732. */
  48733. initializeAsync(): Promise<void>;
  48734. /**
  48735. * Initializes an xr session
  48736. * @param xrSessionMode mode to initialize
  48737. * @param xrSessionInit defines optional and required values to pass to the session builder
  48738. * @returns a promise which will resolve once the session has been initialized
  48739. */
  48740. initializeSessionAsync(xrSessionMode?: XRSessionMode, xrSessionInit?: XRSessionInit): Promise<XRSession>;
  48741. /**
  48742. * Checks if a session would be supported for the creation options specified
  48743. * @param sessionMode session mode to check if supported eg. immersive-vr
  48744. * @returns A Promise that resolves to true if supported and false if not
  48745. */
  48746. isSessionSupportedAsync(sessionMode: XRSessionMode): Promise<boolean>;
  48747. /**
  48748. * Resets the reference space to the one started the session
  48749. */
  48750. resetReferenceSpace(): void;
  48751. /**
  48752. * Starts rendering to the xr layer
  48753. */
  48754. runXRRenderLoop(): void;
  48755. /**
  48756. * Sets the reference space on the xr session
  48757. * @param referenceSpaceType space to set
  48758. * @returns a promise that will resolve once the reference space has been set
  48759. */
  48760. setReferenceSpaceTypeAsync(referenceSpaceType?: XRReferenceSpaceType): Promise<XRReferenceSpace>;
  48761. /**
  48762. * Updates the render state of the session
  48763. * @param state state to set
  48764. * @returns a promise that resolves once the render state has been updated
  48765. */
  48766. updateRenderStateAsync(state: XRRenderState): Promise<void>;
  48767. /**
  48768. * Returns a promise that resolves with a boolean indicating if the provided session mode is supported by this browser
  48769. * @param sessionMode defines the session to test
  48770. * @returns a promise with boolean as final value
  48771. */
  48772. static IsSessionSupportedAsync(sessionMode: XRSessionMode): Promise<boolean>;
  48773. private _createRenderTargetTexture;
  48774. }
  48775. }
  48776. declare module "babylonjs/XR/webXRCamera" {
  48777. import { Vector3 } from "babylonjs/Maths/math.vector";
  48778. import { Scene } from "babylonjs/scene";
  48779. import { Camera } from "babylonjs/Cameras/camera";
  48780. import { FreeCamera } from "babylonjs/Cameras/freeCamera";
  48781. import { WebXRSessionManager } from "babylonjs/XR/webXRSessionManager";
  48782. import { Observable } from "babylonjs/Misc/observable";
  48783. /**
  48784. * WebXR Camera which holds the views for the xrSession
  48785. * @see https://doc.babylonjs.com/how_to/webxr_camera
  48786. */
  48787. export class WebXRCamera extends FreeCamera {
  48788. private _xrSessionManager;
  48789. private _firstFrame;
  48790. private _referenceQuaternion;
  48791. private _referencedPosition;
  48792. private _xrInvPositionCache;
  48793. private _xrInvQuaternionCache;
  48794. /**
  48795. * Observable raised before camera teleportation
  48796. */
  48797. onBeforeCameraTeleport: Observable<Vector3>;
  48798. /**
  48799. * Observable raised after camera teleportation
  48800. */
  48801. onAfterCameraTeleport: Observable<Vector3>;
  48802. /**
  48803. * Should position compensation execute on first frame.
  48804. * This is used when copying the position from a native (non XR) camera
  48805. */
  48806. compensateOnFirstFrame: boolean;
  48807. /**
  48808. * Creates a new webXRCamera, this should only be set at the camera after it has been updated by the xrSessionManager
  48809. * @param name the name of the camera
  48810. * @param scene the scene to add the camera to
  48811. * @param _xrSessionManager a constructed xr session manager
  48812. */
  48813. constructor(name: string, scene: Scene, _xrSessionManager: WebXRSessionManager);
  48814. /**
  48815. * Return the user's height, unrelated to the current ground.
  48816. * This will be the y position of this camera, when ground level is 0.
  48817. */
  48818. get realWorldHeight(): number;
  48819. /** @hidden */
  48820. _updateForDualEyeDebugging(): void;
  48821. /**
  48822. * Sets this camera's transformation based on a non-vr camera
  48823. * @param otherCamera the non-vr camera to copy the transformation from
  48824. * @param resetToBaseReferenceSpace should XR reset to the base reference space
  48825. */
  48826. setTransformationFromNonVRCamera(otherCamera?: Camera, resetToBaseReferenceSpace?: boolean): void;
  48827. /**
  48828. * Gets the current instance class name ("WebXRCamera").
  48829. * @returns the class name
  48830. */
  48831. getClassName(): string;
  48832. private _rotate180;
  48833. private _updateFromXRSession;
  48834. private _updateNumberOfRigCameras;
  48835. private _updateReferenceSpace;
  48836. private _updateReferenceSpaceOffset;
  48837. }
  48838. }
  48839. declare module "babylonjs/XR/webXRFeaturesManager" {
  48840. import { WebXRSessionManager } from "babylonjs/XR/webXRSessionManager";
  48841. import { IDisposable } from "babylonjs/scene";
  48842. /**
  48843. * Defining the interface required for a (webxr) feature
  48844. */
  48845. export interface IWebXRFeature extends IDisposable {
  48846. /**
  48847. * Is this feature attached
  48848. */
  48849. attached: boolean;
  48850. /**
  48851. * Should auto-attach be disabled?
  48852. */
  48853. disableAutoAttach: boolean;
  48854. /**
  48855. * Attach the feature to the session
  48856. * Will usually be called by the features manager
  48857. *
  48858. * @param force should attachment be forced (even when already attached)
  48859. * @returns true if successful.
  48860. */
  48861. attach(force?: boolean): boolean;
  48862. /**
  48863. * Detach the feature from the session
  48864. * Will usually be called by the features manager
  48865. *
  48866. * @returns true if successful.
  48867. */
  48868. detach(): boolean;
  48869. /**
  48870. * This function will be executed during before enabling the feature and can be used to not-allow enabling it.
  48871. * Note that at this point the session has NOT started, so this is purely checking if the browser supports it
  48872. *
  48873. * @returns whether or not the feature is compatible in this environment
  48874. */
  48875. isCompatible(): boolean;
  48876. /**
  48877. * The name of the native xr feature name, if applicable (like anchor, hit-test, or hand-tracking)
  48878. */
  48879. xrNativeFeatureName?: string;
  48880. /**
  48881. * A list of (Babylon WebXR) features this feature depends on
  48882. */
  48883. dependsOn?: string[];
  48884. }
  48885. /**
  48886. * A list of the currently available features without referencing them
  48887. */
  48888. export class WebXRFeatureName {
  48889. /**
  48890. * The name of the anchor system feature
  48891. */
  48892. static readonly ANCHOR_SYSTEM: string;
  48893. /**
  48894. * The name of the background remover feature
  48895. */
  48896. static readonly BACKGROUND_REMOVER: string;
  48897. /**
  48898. * The name of the hit test feature
  48899. */
  48900. static readonly HIT_TEST: string;
  48901. /**
  48902. * physics impostors for xr controllers feature
  48903. */
  48904. static readonly PHYSICS_CONTROLLERS: string;
  48905. /**
  48906. * The name of the plane detection feature
  48907. */
  48908. static readonly PLANE_DETECTION: string;
  48909. /**
  48910. * The name of the pointer selection feature
  48911. */
  48912. static readonly POINTER_SELECTION: string;
  48913. /**
  48914. * The name of the teleportation feature
  48915. */
  48916. static readonly TELEPORTATION: string;
  48917. /**
  48918. * The name of the feature points feature.
  48919. */
  48920. static readonly FEATURE_POINTS: string;
  48921. /**
  48922. * The name of the hand tracking feature.
  48923. */
  48924. static readonly HAND_TRACKING: string;
  48925. }
  48926. /**
  48927. * Defining the constructor of a feature. Used to register the modules.
  48928. */
  48929. export type WebXRFeatureConstructor = (xrSessionManager: WebXRSessionManager, options?: any) => () => IWebXRFeature;
  48930. /**
  48931. * The WebXR features manager is responsible of enabling or disabling features required for the current XR session.
  48932. * It is mainly used in AR sessions.
  48933. *
  48934. * A feature can have a version that is defined by Babylon (and does not correspond with the webxr version).
  48935. */
  48936. export class WebXRFeaturesManager implements IDisposable {
  48937. private _xrSessionManager;
  48938. private static readonly _AvailableFeatures;
  48939. private _features;
  48940. /**
  48941. * constructs a new features manages.
  48942. *
  48943. * @param _xrSessionManager an instance of WebXRSessionManager
  48944. */
  48945. constructor(_xrSessionManager: WebXRSessionManager);
  48946. /**
  48947. * Used to register a module. After calling this function a developer can use this feature in the scene.
  48948. * Mainly used internally.
  48949. *
  48950. * @param featureName the name of the feature to register
  48951. * @param constructorFunction the function used to construct the module
  48952. * @param version the (babylon) version of the module
  48953. * @param stable is that a stable version of this module
  48954. */
  48955. static AddWebXRFeature(featureName: string, constructorFunction: WebXRFeatureConstructor, version?: number, stable?: boolean): void;
  48956. /**
  48957. * Returns a constructor of a specific feature.
  48958. *
  48959. * @param featureName the name of the feature to construct
  48960. * @param version the version of the feature to load
  48961. * @param xrSessionManager the xrSessionManager. Used to construct the module
  48962. * @param options optional options provided to the module.
  48963. * @returns a function that, when called, will return a new instance of this feature
  48964. */
  48965. static ConstructFeature(featureName: string, version: number | undefined, xrSessionManager: WebXRSessionManager, options?: any): () => IWebXRFeature;
  48966. /**
  48967. * Can be used to return the list of features currently registered
  48968. *
  48969. * @returns an Array of available features
  48970. */
  48971. static GetAvailableFeatures(): string[];
  48972. /**
  48973. * Gets the versions available for a specific feature
  48974. * @param featureName the name of the feature
  48975. * @returns an array with the available versions
  48976. */
  48977. static GetAvailableVersions(featureName: string): string[];
  48978. /**
  48979. * Return the latest unstable version of this feature
  48980. * @param featureName the name of the feature to search
  48981. * @returns the version number. if not found will return -1
  48982. */
  48983. static GetLatestVersionOfFeature(featureName: string): number;
  48984. /**
  48985. * Return the latest stable version of this feature
  48986. * @param featureName the name of the feature to search
  48987. * @returns the version number. if not found will return -1
  48988. */
  48989. static GetStableVersionOfFeature(featureName: string): number;
  48990. /**
  48991. * Attach a feature to the current session. Mainly used when session started to start the feature effect.
  48992. * Can be used during a session to start a feature
  48993. * @param featureName the name of feature to attach
  48994. */
  48995. attachFeature(featureName: string): void;
  48996. /**
  48997. * Can be used inside a session or when the session ends to detach a specific feature
  48998. * @param featureName the name of the feature to detach
  48999. */
  49000. detachFeature(featureName: string): void;
  49001. /**
  49002. * Used to disable an already-enabled feature
  49003. * The feature will be disposed and will be recreated once enabled.
  49004. * @param featureName the feature to disable
  49005. * @returns true if disable was successful
  49006. */
  49007. disableFeature(featureName: string | {
  49008. Name: string;
  49009. }): boolean;
  49010. /**
  49011. * dispose this features manager
  49012. */
  49013. dispose(): void;
  49014. /**
  49015. * 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.
  49016. * 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.
  49017. *
  49018. * @param featureName the name of the feature to load or the class of the feature
  49019. * @param version optional version to load. if not provided the latest version will be enabled
  49020. * @param moduleOptions options provided to the module. Ses the module documentation / constructor
  49021. * @param attachIfPossible if set to true (default) the feature will be automatically attached, if it is currently possible
  49022. * @param required is this feature required to the app. If set to true the session init will fail if the feature is not available.
  49023. * @returns a new constructed feature or throws an error if feature not found.
  49024. */
  49025. enableFeature(featureName: string | {
  49026. Name: string;
  49027. }, version?: number | string, moduleOptions?: any, attachIfPossible?: boolean, required?: boolean): IWebXRFeature;
  49028. /**
  49029. * get the implementation of an enabled feature.
  49030. * @param featureName the name of the feature to load
  49031. * @returns the feature class, if found
  49032. */
  49033. getEnabledFeature(featureName: string): IWebXRFeature;
  49034. /**
  49035. * Get the list of enabled features
  49036. * @returns an array of enabled features
  49037. */
  49038. getEnabledFeatures(): string[];
  49039. /**
  49040. * This function will exten the session creation configuration object with enabled features.
  49041. * If, for example, the anchors feature is enabled, it will be automatically added to the optional or required features list,
  49042. * according to the defined "required" variable, provided during enableFeature call
  49043. * @param xrSessionInit the xr Session init object to extend
  49044. *
  49045. * @returns an extended XRSessionInit object
  49046. */
  49047. extendXRSessionInitObject(xrSessionInit: XRSessionInit): XRSessionInit;
  49048. }
  49049. }
  49050. declare module "babylonjs/XR/webXRExperienceHelper" {
  49051. import { Observable } from "babylonjs/Misc/observable";
  49052. import { IDisposable, Scene } from "babylonjs/scene";
  49053. import { WebXRSessionManager } from "babylonjs/XR/webXRSessionManager";
  49054. import { WebXRCamera } from "babylonjs/XR/webXRCamera";
  49055. import { WebXRState, WebXRRenderTarget } from "babylonjs/XR/webXRTypes";
  49056. import { WebXRFeaturesManager } from "babylonjs/XR/webXRFeaturesManager";
  49057. /**
  49058. * Base set of functionality needed to create an XR experience (WebXRSessionManager, Camera, StateManagement, etc.)
  49059. * @see https://doc.babylonjs.com/how_to/webxr_experience_helpers
  49060. */
  49061. export class WebXRExperienceHelper implements IDisposable {
  49062. private scene;
  49063. private _nonVRCamera;
  49064. private _originalSceneAutoClear;
  49065. private _supported;
  49066. /**
  49067. * Camera used to render xr content
  49068. */
  49069. camera: WebXRCamera;
  49070. /** A features manager for this xr session */
  49071. featuresManager: WebXRFeaturesManager;
  49072. /**
  49073. * Observers registered here will be triggered after the camera's initial transformation is set
  49074. * This can be used to set a different ground level or an extra rotation.
  49075. *
  49076. * Note that ground level is considered to be at 0. The height defined by the XR camera will be added
  49077. * to the position set after this observable is done executing.
  49078. */
  49079. onInitialXRPoseSetObservable: Observable<WebXRCamera>;
  49080. /**
  49081. * Fires when the state of the experience helper has changed
  49082. */
  49083. onStateChangedObservable: Observable<WebXRState>;
  49084. /** Session manager used to keep track of xr session */
  49085. sessionManager: WebXRSessionManager;
  49086. /**
  49087. * The current state of the XR experience (eg. transitioning, in XR or not in XR)
  49088. */
  49089. state: WebXRState;
  49090. /**
  49091. * Creates a WebXRExperienceHelper
  49092. * @param scene The scene the helper should be created in
  49093. */
  49094. private constructor();
  49095. /**
  49096. * Creates the experience helper
  49097. * @param scene the scene to attach the experience helper to
  49098. * @returns a promise for the experience helper
  49099. */
  49100. static CreateAsync(scene: Scene): Promise<WebXRExperienceHelper>;
  49101. /**
  49102. * Disposes of the experience helper
  49103. */
  49104. dispose(): void;
  49105. /**
  49106. * Enters XR mode (This must be done within a user interaction in most browsers eg. button click)
  49107. * @param sessionMode options for the XR session
  49108. * @param referenceSpaceType frame of reference of the XR session
  49109. * @param renderTarget the output canvas that will be used to enter XR mode
  49110. * @param sessionCreationOptions optional XRSessionInit object to init the session with
  49111. * @returns promise that resolves after xr mode has entered
  49112. */
  49113. enterXRAsync(sessionMode: XRSessionMode, referenceSpaceType: XRReferenceSpaceType, renderTarget?: WebXRRenderTarget, sessionCreationOptions?: XRSessionInit): Promise<WebXRSessionManager>;
  49114. /**
  49115. * Exits XR mode and returns the scene to its original state
  49116. * @returns promise that resolves after xr mode has exited
  49117. */
  49118. exitXRAsync(): Promise<void>;
  49119. private _nonXRToXRCamera;
  49120. private _setState;
  49121. }
  49122. }
  49123. declare module "babylonjs/XR/motionController/webXRControllerComponent" {
  49124. import { IMinimalMotionControllerObject, MotionControllerComponentType } from "babylonjs/XR/motionController/webXRAbstractMotionController";
  49125. import { Observable } from "babylonjs/Misc/observable";
  49126. import { IDisposable } from "babylonjs/scene";
  49127. /**
  49128. * X-Y values for axes in WebXR
  49129. */
  49130. export interface IWebXRMotionControllerAxesValue {
  49131. /**
  49132. * The value of the x axis
  49133. */
  49134. x: number;
  49135. /**
  49136. * The value of the y-axis
  49137. */
  49138. y: number;
  49139. }
  49140. /**
  49141. * changed / previous values for the values of this component
  49142. */
  49143. export interface IWebXRMotionControllerComponentChangesValues<T> {
  49144. /**
  49145. * current (this frame) value
  49146. */
  49147. current: T;
  49148. /**
  49149. * previous (last change) value
  49150. */
  49151. previous: T;
  49152. }
  49153. /**
  49154. * Represents changes in the component between current frame and last values recorded
  49155. */
  49156. export interface IWebXRMotionControllerComponentChanges {
  49157. /**
  49158. * will be populated with previous and current values if axes changed
  49159. */
  49160. axes?: IWebXRMotionControllerComponentChangesValues<IWebXRMotionControllerAxesValue>;
  49161. /**
  49162. * will be populated with previous and current values if pressed changed
  49163. */
  49164. pressed?: IWebXRMotionControllerComponentChangesValues<boolean>;
  49165. /**
  49166. * will be populated with previous and current values if touched changed
  49167. */
  49168. touched?: IWebXRMotionControllerComponentChangesValues<boolean>;
  49169. /**
  49170. * will be populated with previous and current values if value changed
  49171. */
  49172. value?: IWebXRMotionControllerComponentChangesValues<number>;
  49173. }
  49174. /**
  49175. * This class represents a single component (for example button or thumbstick) of a motion controller
  49176. */
  49177. export class WebXRControllerComponent implements IDisposable {
  49178. /**
  49179. * the id of this component
  49180. */
  49181. id: string;
  49182. /**
  49183. * the type of the component
  49184. */
  49185. type: MotionControllerComponentType;
  49186. private _buttonIndex;
  49187. private _axesIndices;
  49188. private _axes;
  49189. private _changes;
  49190. private _currentValue;
  49191. private _hasChanges;
  49192. private _pressed;
  49193. private _touched;
  49194. /**
  49195. * button component type
  49196. */
  49197. static BUTTON_TYPE: MotionControllerComponentType;
  49198. /**
  49199. * squeeze component type
  49200. */
  49201. static SQUEEZE_TYPE: MotionControllerComponentType;
  49202. /**
  49203. * Thumbstick component type
  49204. */
  49205. static THUMBSTICK_TYPE: MotionControllerComponentType;
  49206. /**
  49207. * Touchpad component type
  49208. */
  49209. static TOUCHPAD_TYPE: MotionControllerComponentType;
  49210. /**
  49211. * trigger component type
  49212. */
  49213. static TRIGGER_TYPE: MotionControllerComponentType;
  49214. /**
  49215. * If axes are available for this component (like a touchpad or thumbstick) the observers will be notified when
  49216. * the axes data changes
  49217. */
  49218. onAxisValueChangedObservable: Observable<{
  49219. x: number;
  49220. y: number;
  49221. }>;
  49222. /**
  49223. * Observers registered here will be triggered when the state of a button changes
  49224. * State change is either pressed / touched / value
  49225. */
  49226. onButtonStateChangedObservable: Observable<WebXRControllerComponent>;
  49227. /**
  49228. * Creates a new component for a motion controller.
  49229. * It is created by the motion controller itself
  49230. *
  49231. * @param id the id of this component
  49232. * @param type the type of the component
  49233. * @param _buttonIndex index in the buttons array of the gamepad
  49234. * @param _axesIndices indices of the values in the axes array of the gamepad
  49235. */
  49236. constructor(
  49237. /**
  49238. * the id of this component
  49239. */
  49240. id: string,
  49241. /**
  49242. * the type of the component
  49243. */
  49244. type: MotionControllerComponentType, _buttonIndex?: number, _axesIndices?: number[]);
  49245. /**
  49246. * The current axes data. If this component has no axes it will still return an object { x: 0, y: 0 }
  49247. */
  49248. get axes(): IWebXRMotionControllerAxesValue;
  49249. /**
  49250. * Get the changes. Elements will be populated only if they changed with their previous and current value
  49251. */
  49252. get changes(): IWebXRMotionControllerComponentChanges;
  49253. /**
  49254. * Return whether or not the component changed the last frame
  49255. */
  49256. get hasChanges(): boolean;
  49257. /**
  49258. * is the button currently pressed
  49259. */
  49260. get pressed(): boolean;
  49261. /**
  49262. * is the button currently touched
  49263. */
  49264. get touched(): boolean;
  49265. /**
  49266. * Get the current value of this component
  49267. */
  49268. get value(): number;
  49269. /**
  49270. * Dispose this component
  49271. */
  49272. dispose(): void;
  49273. /**
  49274. * Are there axes correlating to this component
  49275. * @return true is axes data is available
  49276. */
  49277. isAxes(): boolean;
  49278. /**
  49279. * Is this component a button (hence - pressable)
  49280. * @returns true if can be pressed
  49281. */
  49282. isButton(): boolean;
  49283. /**
  49284. * update this component using the gamepad object it is in. Called on every frame
  49285. * @param nativeController the native gamepad controller object
  49286. */
  49287. update(nativeController: IMinimalMotionControllerObject): void;
  49288. }
  49289. }
  49290. declare module "babylonjs/Loading/sceneLoader" {
  49291. import { Observable } from "babylonjs/Misc/observable";
  49292. import { Nullable } from "babylonjs/types";
  49293. import { Scene } from "babylonjs/scene";
  49294. import { Engine } from "babylonjs/Engines/engine";
  49295. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  49296. import { AnimationGroup } from "babylonjs/Animations/animationGroup";
  49297. import { AssetContainer } from "babylonjs/assetContainer";
  49298. import { IParticleSystem } from "babylonjs/Particles/IParticleSystem";
  49299. import { Skeleton } from "babylonjs/Bones/skeleton";
  49300. import { IFileRequest } from "babylonjs/Misc/fileRequest";
  49301. import { WebRequest } from "babylonjs/Misc/webRequest";
  49302. /**
  49303. * Interface used to represent data loading progression
  49304. */
  49305. export interface ISceneLoaderProgressEvent {
  49306. /**
  49307. * Defines if data length to load can be evaluated
  49308. */
  49309. readonly lengthComputable: boolean;
  49310. /**
  49311. * Defines the loaded data length
  49312. */
  49313. readonly loaded: number;
  49314. /**
  49315. * Defines the data length to load
  49316. */
  49317. readonly total: number;
  49318. }
  49319. /**
  49320. * Interface used by SceneLoader plugins to define supported file extensions
  49321. */
  49322. export interface ISceneLoaderPluginExtensions {
  49323. /**
  49324. * Defines the list of supported extensions
  49325. */
  49326. [extension: string]: {
  49327. isBinary: boolean;
  49328. };
  49329. }
  49330. /**
  49331. * Interface used by SceneLoader plugin factory
  49332. */
  49333. export interface ISceneLoaderPluginFactory {
  49334. /**
  49335. * Defines the name of the factory
  49336. */
  49337. name: string;
  49338. /**
  49339. * Function called to create a new plugin
  49340. * @return the new plugin
  49341. */
  49342. createPlugin(): ISceneLoaderPlugin | ISceneLoaderPluginAsync;
  49343. /**
  49344. * The callback that returns true if the data can be directly loaded.
  49345. * @param data string containing the file data
  49346. * @returns if the data can be loaded directly
  49347. */
  49348. canDirectLoad?(data: string): boolean;
  49349. }
  49350. /**
  49351. * Interface used to define the base of ISceneLoaderPlugin and ISceneLoaderPluginAsync
  49352. */
  49353. export interface ISceneLoaderPluginBase {
  49354. /**
  49355. * The friendly name of this plugin.
  49356. */
  49357. name: string;
  49358. /**
  49359. * The file extensions supported by this plugin.
  49360. */
  49361. extensions: string | ISceneLoaderPluginExtensions;
  49362. /**
  49363. * The callback called when loading from a url.
  49364. * @param scene scene loading this url
  49365. * @param url url to load
  49366. * @param onSuccess callback called when the file successfully loads
  49367. * @param onProgress callback called while file is loading (if the server supports this mode)
  49368. * @param useArrayBuffer defines a boolean indicating that date must be returned as ArrayBuffer
  49369. * @param onError callback called when the file fails to load
  49370. * @returns a file request object
  49371. */
  49372. requestFile?(scene: Scene, url: string, onSuccess: (data: any, request?: WebRequest) => void, onProgress?: (ev: ISceneLoaderProgressEvent) => void, useArrayBuffer?: boolean, onError?: (error: any) => void): IFileRequest;
  49373. /**
  49374. * The callback called when loading from a file object.
  49375. * @param scene scene loading this file
  49376. * @param file defines the file to load
  49377. * @param onSuccess defines the callback to call when data is loaded
  49378. * @param onProgress defines the callback to call during loading process
  49379. * @param useArrayBuffer defines a boolean indicating that data must be returned as an ArrayBuffer
  49380. * @param onError defines the callback to call when an error occurs
  49381. * @returns a file request object
  49382. */
  49383. readFile?(scene: Scene, file: File, onSuccess: (data: any) => void, onProgress?: (ev: ISceneLoaderProgressEvent) => any, useArrayBuffer?: boolean, onError?: (error: any) => void): IFileRequest;
  49384. /**
  49385. * The callback that returns true if the data can be directly loaded.
  49386. * @param data string containing the file data
  49387. * @returns if the data can be loaded directly
  49388. */
  49389. canDirectLoad?(data: string): boolean;
  49390. /**
  49391. * The callback that returns the data to pass to the plugin if the data can be directly loaded.
  49392. * @param scene scene loading this data
  49393. * @param data string containing the data
  49394. * @returns data to pass to the plugin
  49395. */
  49396. directLoad?(scene: Scene, data: string): any;
  49397. /**
  49398. * The callback that allows custom handling of the root url based on the response url.
  49399. * @param rootUrl the original root url
  49400. * @param responseURL the response url if available
  49401. * @returns the new root url
  49402. */
  49403. rewriteRootURL?(rootUrl: string, responseURL?: string): string;
  49404. }
  49405. /**
  49406. * Interface used to define a SceneLoader plugin
  49407. */
  49408. export interface ISceneLoaderPlugin extends ISceneLoaderPluginBase {
  49409. /**
  49410. * Import meshes into a scene.
  49411. * @param meshesNames An array of mesh names, a single mesh name, or empty string for all meshes that filter what meshes are imported
  49412. * @param scene The scene to import into
  49413. * @param data The data to import
  49414. * @param rootUrl The root url for scene and resources
  49415. * @param meshes The meshes array to import into
  49416. * @param particleSystems The particle systems array to import into
  49417. * @param skeletons The skeletons array to import into
  49418. * @param onError The callback when import fails
  49419. * @returns True if successful or false otherwise
  49420. */
  49421. importMesh(meshesNames: any, scene: Scene, data: any, rootUrl: string, meshes: AbstractMesh[], particleSystems: IParticleSystem[], skeletons: Skeleton[], onError?: (message: string, exception?: any) => void): boolean;
  49422. /**
  49423. * Load into a scene.
  49424. * @param scene The scene to load into
  49425. * @param data The data to import
  49426. * @param rootUrl The root url for scene and resources
  49427. * @param onError The callback when import fails
  49428. * @returns True if successful or false otherwise
  49429. */
  49430. load(scene: Scene, data: any, rootUrl: string, onError?: (message: string, exception?: any) => void): boolean;
  49431. /**
  49432. * Load into an asset container.
  49433. * @param scene The scene to load into
  49434. * @param data The data to import
  49435. * @param rootUrl The root url for scene and resources
  49436. * @param onError The callback when import fails
  49437. * @returns The loaded asset container
  49438. */
  49439. loadAssetContainer(scene: Scene, data: any, rootUrl: string, onError?: (message: string, exception?: any) => void): AssetContainer;
  49440. }
  49441. /**
  49442. * Interface used to define an async SceneLoader plugin
  49443. */
  49444. export interface ISceneLoaderPluginAsync extends ISceneLoaderPluginBase {
  49445. /**
  49446. * Import meshes into a scene.
  49447. * @param meshesNames An array of mesh names, a single mesh name, or empty string for all meshes that filter what meshes are imported
  49448. * @param scene The scene to import into
  49449. * @param data The data to import
  49450. * @param rootUrl The root url for scene and resources
  49451. * @param onProgress The callback when the load progresses
  49452. * @param fileName Defines the name of the file to load
  49453. * @returns The loaded meshes, particle systems, skeletons, and animation groups
  49454. */
  49455. importMeshAsync(meshesNames: any, scene: Scene, data: any, rootUrl: string, onProgress?: (event: ISceneLoaderProgressEvent) => void, fileName?: string): Promise<{
  49456. meshes: AbstractMesh[];
  49457. particleSystems: IParticleSystem[];
  49458. skeletons: Skeleton[];
  49459. animationGroups: AnimationGroup[];
  49460. }>;
  49461. /**
  49462. * Load into a scene.
  49463. * @param scene The scene to load into
  49464. * @param data The data to import
  49465. * @param rootUrl The root url for scene and resources
  49466. * @param onProgress The callback when the load progresses
  49467. * @param fileName Defines the name of the file to load
  49468. * @returns Nothing
  49469. */
  49470. loadAsync(scene: Scene, data: any, rootUrl: string, onProgress?: (event: ISceneLoaderProgressEvent) => void, fileName?: string): Promise<void>;
  49471. /**
  49472. * Load into an asset container.
  49473. * @param scene The scene to load into
  49474. * @param data The data to import
  49475. * @param rootUrl The root url for scene and resources
  49476. * @param onProgress The callback when the load progresses
  49477. * @param fileName Defines the name of the file to load
  49478. * @returns The loaded asset container
  49479. */
  49480. loadAssetContainerAsync(scene: Scene, data: any, rootUrl: string, onProgress?: (event: ISceneLoaderProgressEvent) => void, fileName?: string): Promise<AssetContainer>;
  49481. }
  49482. /**
  49483. * Mode that determines how to handle old animation groups before loading new ones.
  49484. */
  49485. export enum SceneLoaderAnimationGroupLoadingMode {
  49486. /**
  49487. * Reset all old animations to initial state then dispose them.
  49488. */
  49489. Clean = 0,
  49490. /**
  49491. * Stop all old animations.
  49492. */
  49493. Stop = 1,
  49494. /**
  49495. * Restart old animations from first frame.
  49496. */
  49497. Sync = 2,
  49498. /**
  49499. * Old animations remains untouched.
  49500. */
  49501. NoSync = 3
  49502. }
  49503. /**
  49504. * Defines a plugin registered by the SceneLoader
  49505. */
  49506. interface IRegisteredPlugin {
  49507. /**
  49508. * Defines the plugin to use
  49509. */
  49510. plugin: ISceneLoaderPlugin | ISceneLoaderPluginAsync | ISceneLoaderPluginFactory;
  49511. /**
  49512. * Defines if the plugin supports binary data
  49513. */
  49514. isBinary: boolean;
  49515. }
  49516. /**
  49517. * Class used to load scene from various file formats using registered plugins
  49518. * @see https://doc.babylonjs.com/how_to/load_from_any_file_type
  49519. */
  49520. export class SceneLoader {
  49521. /**
  49522. * No logging while loading
  49523. */
  49524. static readonly NO_LOGGING: number;
  49525. /**
  49526. * Minimal logging while loading
  49527. */
  49528. static readonly MINIMAL_LOGGING: number;
  49529. /**
  49530. * Summary logging while loading
  49531. */
  49532. static readonly SUMMARY_LOGGING: number;
  49533. /**
  49534. * Detailled logging while loading
  49535. */
  49536. static readonly DETAILED_LOGGING: number;
  49537. /**
  49538. * Gets or sets a boolean indicating if entire scene must be loaded even if scene contains incremental data
  49539. */
  49540. static get ForceFullSceneLoadingForIncremental(): boolean;
  49541. static set ForceFullSceneLoadingForIncremental(value: boolean);
  49542. /**
  49543. * Gets or sets a boolean indicating if loading screen must be displayed while loading a scene
  49544. */
  49545. static get ShowLoadingScreen(): boolean;
  49546. static set ShowLoadingScreen(value: boolean);
  49547. /**
  49548. * Defines the current logging level (while loading the scene)
  49549. * @ignorenaming
  49550. */
  49551. static get loggingLevel(): number;
  49552. static set loggingLevel(value: number);
  49553. /**
  49554. * Gets or set a boolean indicating if matrix weights must be cleaned upon loading
  49555. */
  49556. static get CleanBoneMatrixWeights(): boolean;
  49557. static set CleanBoneMatrixWeights(value: boolean);
  49558. /**
  49559. * Event raised when a plugin is used to load a scene
  49560. */
  49561. static OnPluginActivatedObservable: Observable<ISceneLoaderPlugin | ISceneLoaderPluginAsync>;
  49562. private static _registeredPlugins;
  49563. private static _showingLoadingScreen;
  49564. /**
  49565. * Gets the default plugin (used to load Babylon files)
  49566. * @returns the .babylon plugin
  49567. */
  49568. static GetDefaultPlugin(): IRegisteredPlugin;
  49569. private static _GetPluginForExtension;
  49570. private static _GetPluginForDirectLoad;
  49571. private static _GetPluginForFilename;
  49572. private static _GetDirectLoad;
  49573. private static _LoadData;
  49574. private static _GetFileInfo;
  49575. /**
  49576. * Gets a plugin that can load the given extension
  49577. * @param extension defines the extension to load
  49578. * @returns a plugin or null if none works
  49579. */
  49580. static GetPluginForExtension(extension: string): ISceneLoaderPlugin | ISceneLoaderPluginAsync | ISceneLoaderPluginFactory;
  49581. /**
  49582. * Gets a boolean indicating that the given extension can be loaded
  49583. * @param extension defines the extension to load
  49584. * @returns true if the extension is supported
  49585. */
  49586. static IsPluginForExtensionAvailable(extension: string): boolean;
  49587. /**
  49588. * Adds a new plugin to the list of registered plugins
  49589. * @param plugin defines the plugin to add
  49590. */
  49591. static RegisterPlugin(plugin: ISceneLoaderPlugin | ISceneLoaderPluginAsync): void;
  49592. /**
  49593. * Import meshes into a scene
  49594. * @param meshNames an array of mesh names, a single mesh name, or empty string for all meshes that filter what meshes are imported
  49595. * @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)
  49596. * @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)
  49597. * @param scene the instance of BABYLON.Scene to append to
  49598. * @param onSuccess a callback with a list of imported meshes, particleSystems, and skeletons when import succeeds
  49599. * @param onProgress a callback with a progress event for each file being loaded
  49600. * @param onError a callback with the scene, a message, and possibly an exception when import fails
  49601. * @param pluginExtension the extension used to determine the plugin
  49602. * @returns The loaded plugin
  49603. */
  49604. 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>;
  49605. /**
  49606. * Import meshes into a scene
  49607. * @param meshNames an array of mesh names, a single mesh name, or empty string for all meshes that filter what meshes are imported
  49608. * @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)
  49609. * @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)
  49610. * @param scene the instance of BABYLON.Scene to append to
  49611. * @param onProgress a callback with a progress event for each file being loaded
  49612. * @param pluginExtension the extension used to determine the plugin
  49613. * @returns The loaded list of imported meshes, particle systems, skeletons, and animation groups
  49614. */
  49615. static ImportMeshAsync(meshNames: any, rootUrl: string, sceneFilename?: string | File, scene?: Nullable<Scene>, onProgress?: Nullable<(event: ISceneLoaderProgressEvent) => void>, pluginExtension?: Nullable<string>): Promise<{
  49616. meshes: AbstractMesh[];
  49617. particleSystems: IParticleSystem[];
  49618. skeletons: Skeleton[];
  49619. animationGroups: AnimationGroup[];
  49620. }>;
  49621. /**
  49622. * Load a scene
  49623. * @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)
  49624. * @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)
  49625. * @param engine is the instance of BABYLON.Engine to use to create the scene
  49626. * @param onSuccess a callback with the scene when import succeeds
  49627. * @param onProgress a callback with a progress event for each file being loaded
  49628. * @param onError a callback with the scene, a message, and possibly an exception when import fails
  49629. * @param pluginExtension the extension used to determine the plugin
  49630. * @returns The loaded plugin
  49631. */
  49632. 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>;
  49633. /**
  49634. * Load a scene
  49635. * @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)
  49636. * @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)
  49637. * @param engine is the instance of BABYLON.Engine to use to create the scene
  49638. * @param onProgress a callback with a progress event for each file being loaded
  49639. * @param pluginExtension the extension used to determine the plugin
  49640. * @returns The loaded scene
  49641. */
  49642. static LoadAsync(rootUrl: string, sceneFilename?: string | File, engine?: Nullable<Engine>, onProgress?: Nullable<(event: ISceneLoaderProgressEvent) => void>, pluginExtension?: Nullable<string>): Promise<Scene>;
  49643. /**
  49644. * Append a scene
  49645. * @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)
  49646. * @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)
  49647. * @param scene is the instance of BABYLON.Scene to append to
  49648. * @param onSuccess a callback with the scene when import succeeds
  49649. * @param onProgress a callback with a progress event for each file being loaded
  49650. * @param onError a callback with the scene, a message, and possibly an exception when import fails
  49651. * @param pluginExtension the extension used to determine the plugin
  49652. * @returns The loaded plugin
  49653. */
  49654. 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>;
  49655. /**
  49656. * Append a scene
  49657. * @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)
  49658. * @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)
  49659. * @param scene is the instance of BABYLON.Scene to append to
  49660. * @param onProgress a callback with a progress event for each file being loaded
  49661. * @param pluginExtension the extension used to determine the plugin
  49662. * @returns The given scene
  49663. */
  49664. static AppendAsync(rootUrl: string, sceneFilename?: string | File, scene?: Nullable<Scene>, onProgress?: Nullable<(event: ISceneLoaderProgressEvent) => void>, pluginExtension?: Nullable<string>): Promise<Scene>;
  49665. /**
  49666. * Load a scene into an asset container
  49667. * @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)
  49668. * @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)
  49669. * @param scene is the instance of BABYLON.Scene to append to (default: last created scene)
  49670. * @param onSuccess a callback with the scene when import succeeds
  49671. * @param onProgress a callback with a progress event for each file being loaded
  49672. * @param onError a callback with the scene, a message, and possibly an exception when import fails
  49673. * @param pluginExtension the extension used to determine the plugin
  49674. * @returns The loaded plugin
  49675. */
  49676. 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>;
  49677. /**
  49678. * Load a scene into an asset container
  49679. * @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)
  49680. * @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)
  49681. * @param scene is the instance of Scene to append to
  49682. * @param onProgress a callback with a progress event for each file being loaded
  49683. * @param pluginExtension the extension used to determine the plugin
  49684. * @returns The loaded asset container
  49685. */
  49686. static LoadAssetContainerAsync(rootUrl: string, sceneFilename?: string, scene?: Nullable<Scene>, onProgress?: Nullable<(event: ISceneLoaderProgressEvent) => void>, pluginExtension?: Nullable<string>): Promise<AssetContainer>;
  49687. /**
  49688. * Import animations from a file into a scene
  49689. * @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)
  49690. * @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)
  49691. * @param scene is the instance of BABYLON.Scene to append to (default: last created scene)
  49692. * @param overwriteAnimations when true, animations are cleaned before importing new ones. Animations are appended otherwise
  49693. * @param animationGroupLoadingMode defines how to handle old animations groups before importing new ones
  49694. * @param targetConverter defines a function used to convert animation targets from loaded scene to current scene (default: search node by name)
  49695. * @param onSuccess a callback with the scene when import succeeds
  49696. * @param onProgress a callback with a progress event for each file being loaded
  49697. * @param onError a callback with the scene, a message, and possibly an exception when import fails
  49698. * @param pluginExtension the extension used to determine the plugin
  49699. */
  49700. 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;
  49701. /**
  49702. * Import animations from a file into a scene
  49703. * @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)
  49704. * @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)
  49705. * @param scene is the instance of BABYLON.Scene to append to (default: last created scene)
  49706. * @param overwriteAnimations when true, animations are cleaned before importing new ones. Animations are appended otherwise
  49707. * @param animationGroupLoadingMode defines how to handle old animations groups before importing new ones
  49708. * @param targetConverter defines a function used to convert animation targets from loaded scene to current scene (default: search node by name)
  49709. * @param onSuccess a callback with the scene when import succeeds
  49710. * @param onProgress a callback with a progress event for each file being loaded
  49711. * @param onError a callback with the scene, a message, and possibly an exception when import fails
  49712. * @param pluginExtension the extension used to determine the plugin
  49713. * @returns the updated scene with imported animations
  49714. */
  49715. 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>;
  49716. }
  49717. }
  49718. declare module "babylonjs/XR/motionController/webXRAbstractMotionController" {
  49719. import { IDisposable, Scene } from "babylonjs/scene";
  49720. import { WebXRControllerComponent } from "babylonjs/XR/motionController/webXRControllerComponent";
  49721. import { Observable } from "babylonjs/Misc/observable";
  49722. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  49723. import { Nullable } from "babylonjs/types";
  49724. /**
  49725. * Handedness type in xrInput profiles. These can be used to define layouts in the Layout Map.
  49726. */
  49727. export type MotionControllerHandedness = "none" | "left" | "right";
  49728. /**
  49729. * The type of components available in motion controllers.
  49730. * This is not the name of the component.
  49731. */
  49732. export type MotionControllerComponentType = "trigger" | "squeeze" | "touchpad" | "thumbstick" | "button";
  49733. /**
  49734. * The state of a controller component
  49735. */
  49736. export type MotionControllerComponentStateType = "default" | "touched" | "pressed";
  49737. /**
  49738. * The schema of motion controller layout.
  49739. * No object will be initialized using this interface
  49740. * This is used just to define the profile.
  49741. */
  49742. export interface IMotionControllerLayout {
  49743. /**
  49744. * Path to load the assets. Usually relative to the base path
  49745. */
  49746. assetPath: string;
  49747. /**
  49748. * Available components (unsorted)
  49749. */
  49750. components: {
  49751. /**
  49752. * A map of component Ids
  49753. */
  49754. [componentId: string]: {
  49755. /**
  49756. * The type of input the component outputs
  49757. */
  49758. type: MotionControllerComponentType;
  49759. /**
  49760. * The indices of this component in the gamepad object
  49761. */
  49762. gamepadIndices: {
  49763. /**
  49764. * Index of button
  49765. */
  49766. button?: number;
  49767. /**
  49768. * If available, index of x-axis
  49769. */
  49770. xAxis?: number;
  49771. /**
  49772. * If available, index of y-axis
  49773. */
  49774. yAxis?: number;
  49775. };
  49776. /**
  49777. * The mesh's root node name
  49778. */
  49779. rootNodeName: string;
  49780. /**
  49781. * Animation definitions for this model
  49782. */
  49783. visualResponses: {
  49784. [stateKey: string]: {
  49785. /**
  49786. * What property will be animated
  49787. */
  49788. componentProperty: "xAxis" | "yAxis" | "button" | "state";
  49789. /**
  49790. * What states influence this visual response
  49791. */
  49792. states: MotionControllerComponentStateType[];
  49793. /**
  49794. * Type of animation - movement or visibility
  49795. */
  49796. valueNodeProperty: "transform" | "visibility";
  49797. /**
  49798. * Base node name to move. Its position will be calculated according to the min and max nodes
  49799. */
  49800. valueNodeName?: string;
  49801. /**
  49802. * Minimum movement node
  49803. */
  49804. minNodeName?: string;
  49805. /**
  49806. * Max movement node
  49807. */
  49808. maxNodeName?: string;
  49809. };
  49810. };
  49811. /**
  49812. * If touch enabled, what is the name of node to display user feedback
  49813. */
  49814. touchPointNodeName?: string;
  49815. };
  49816. };
  49817. /**
  49818. * Is it xr standard mapping or not
  49819. */
  49820. gamepadMapping: "" | "xr-standard";
  49821. /**
  49822. * Base root node of this entire model
  49823. */
  49824. rootNodeName: string;
  49825. /**
  49826. * Defines the main button component id
  49827. */
  49828. selectComponentId: string;
  49829. }
  49830. /**
  49831. * A definition for the layout map in the input profile
  49832. */
  49833. export interface IMotionControllerLayoutMap {
  49834. /**
  49835. * Layouts with handedness type as a key
  49836. */
  49837. [handedness: string]: IMotionControllerLayout;
  49838. }
  49839. /**
  49840. * The XR Input profile schema
  49841. * Profiles can be found here:
  49842. * https://github.com/immersive-web/webxr-input-profiles/tree/master/packages/registry/profiles
  49843. */
  49844. export interface IMotionControllerProfile {
  49845. /**
  49846. * fallback profiles for this profileId
  49847. */
  49848. fallbackProfileIds: string[];
  49849. /**
  49850. * The layout map, with handedness as key
  49851. */
  49852. layouts: IMotionControllerLayoutMap;
  49853. /**
  49854. * The id of this profile
  49855. * correlates to the profile(s) in the xrInput.profiles array
  49856. */
  49857. profileId: string;
  49858. }
  49859. /**
  49860. * A helper-interface for the 3 meshes needed for controller button animation
  49861. * The meshes are provided to the _lerpButtonTransform function to calculate the current position of the value mesh
  49862. */
  49863. export interface IMotionControllerButtonMeshMap {
  49864. /**
  49865. * the mesh that defines the pressed value mesh position.
  49866. * This is used to find the max-position of this button
  49867. */
  49868. pressedMesh: AbstractMesh;
  49869. /**
  49870. * the mesh that defines the unpressed value mesh position.
  49871. * This is used to find the min (or initial) position of this button
  49872. */
  49873. unpressedMesh: AbstractMesh;
  49874. /**
  49875. * The mesh that will be changed when value changes
  49876. */
  49877. valueMesh: AbstractMesh;
  49878. }
  49879. /**
  49880. * A helper-interface for the 3 meshes needed for controller axis animation.
  49881. * This will be expanded when touchpad animations are fully supported
  49882. * The meshes are provided to the _lerpAxisTransform function to calculate the current position of the value mesh
  49883. */
  49884. export interface IMotionControllerMeshMap {
  49885. /**
  49886. * the mesh that defines the maximum value mesh position.
  49887. */
  49888. maxMesh?: AbstractMesh;
  49889. /**
  49890. * the mesh that defines the minimum value mesh position.
  49891. */
  49892. minMesh?: AbstractMesh;
  49893. /**
  49894. * The mesh that will be changed when axis value changes
  49895. */
  49896. valueMesh?: AbstractMesh;
  49897. }
  49898. /**
  49899. * The elements needed for change-detection of the gamepad objects in motion controllers
  49900. */
  49901. export interface IMinimalMotionControllerObject {
  49902. /**
  49903. * Available axes of this controller
  49904. */
  49905. axes: number[];
  49906. /**
  49907. * An array of available buttons
  49908. */
  49909. buttons: Array<{
  49910. /**
  49911. * Value of the button/trigger
  49912. */
  49913. value: number;
  49914. /**
  49915. * If the button/trigger is currently touched
  49916. */
  49917. touched: boolean;
  49918. /**
  49919. * If the button/trigger is currently pressed
  49920. */
  49921. pressed: boolean;
  49922. }>;
  49923. /**
  49924. * EXPERIMENTAL haptic support.
  49925. */
  49926. hapticActuators?: Array<{
  49927. pulse: (value: number, duration: number) => Promise<boolean>;
  49928. }>;
  49929. }
  49930. /**
  49931. * An Abstract Motion controller
  49932. * This class receives an xrInput and a profile layout and uses those to initialize the components
  49933. * Each component has an observable to check for changes in value and state
  49934. */
  49935. export abstract class WebXRAbstractMotionController implements IDisposable {
  49936. protected scene: Scene;
  49937. protected layout: IMotionControllerLayout;
  49938. /**
  49939. * The gamepad object correlating to this controller
  49940. */
  49941. gamepadObject: IMinimalMotionControllerObject;
  49942. /**
  49943. * handedness (left/right/none) of this controller
  49944. */
  49945. handedness: MotionControllerHandedness;
  49946. private _initComponent;
  49947. private _modelReady;
  49948. /**
  49949. * A map of components (WebXRControllerComponent) in this motion controller
  49950. * Components have a ComponentType and can also have both button and axis definitions
  49951. */
  49952. readonly components: {
  49953. [id: string]: WebXRControllerComponent;
  49954. };
  49955. /**
  49956. * Disable the model's animation. Can be set at any time.
  49957. */
  49958. disableAnimation: boolean;
  49959. /**
  49960. * Observers registered here will be triggered when the model of this controller is done loading
  49961. */
  49962. onModelLoadedObservable: Observable<WebXRAbstractMotionController>;
  49963. /**
  49964. * The profile id of this motion controller
  49965. */
  49966. abstract profileId: string;
  49967. /**
  49968. * The root mesh of the model. It is null if the model was not yet initialized
  49969. */
  49970. rootMesh: Nullable<AbstractMesh>;
  49971. /**
  49972. * constructs a new abstract motion controller
  49973. * @param scene the scene to which the model of the controller will be added
  49974. * @param layout The profile layout to load
  49975. * @param gamepadObject The gamepad object correlating to this controller
  49976. * @param handedness handedness (left/right/none) of this controller
  49977. * @param _doNotLoadControllerMesh set this flag to ignore the mesh loading
  49978. */
  49979. constructor(scene: Scene, layout: IMotionControllerLayout,
  49980. /**
  49981. * The gamepad object correlating to this controller
  49982. */
  49983. gamepadObject: IMinimalMotionControllerObject,
  49984. /**
  49985. * handedness (left/right/none) of this controller
  49986. */
  49987. handedness: MotionControllerHandedness, _doNotLoadControllerMesh?: boolean);
  49988. /**
  49989. * Dispose this controller, the model mesh and all its components
  49990. */
  49991. dispose(): void;
  49992. /**
  49993. * Returns all components of specific type
  49994. * @param type the type to search for
  49995. * @return an array of components with this type
  49996. */
  49997. getAllComponentsOfType(type: MotionControllerComponentType): WebXRControllerComponent[];
  49998. /**
  49999. * get a component based an its component id as defined in layout.components
  50000. * @param id the id of the component
  50001. * @returns the component correlates to the id or undefined if not found
  50002. */
  50003. getComponent(id: string): WebXRControllerComponent;
  50004. /**
  50005. * Get the list of components available in this motion controller
  50006. * @returns an array of strings correlating to available components
  50007. */
  50008. getComponentIds(): string[];
  50009. /**
  50010. * Get the first component of specific type
  50011. * @param type type of component to find
  50012. * @return a controller component or null if not found
  50013. */
  50014. getComponentOfType(type: MotionControllerComponentType): Nullable<WebXRControllerComponent>;
  50015. /**
  50016. * Get the main (Select) component of this controller as defined in the layout
  50017. * @returns the main component of this controller
  50018. */
  50019. getMainComponent(): WebXRControllerComponent;
  50020. /**
  50021. * Loads the model correlating to this controller
  50022. * When the mesh is loaded, the onModelLoadedObservable will be triggered
  50023. * @returns A promise fulfilled with the result of the model loading
  50024. */
  50025. loadModel(): Promise<boolean>;
  50026. /**
  50027. * Update this model using the current XRFrame
  50028. * @param xrFrame the current xr frame to use and update the model
  50029. */
  50030. updateFromXRFrame(xrFrame: XRFrame): void;
  50031. /**
  50032. * Backwards compatibility due to a deeply-integrated typo
  50033. */
  50034. get handness(): XREye;
  50035. /**
  50036. * Pulse (vibrate) this controller
  50037. * If the controller does not support pulses, this function will fail silently and return Promise<false> directly after called
  50038. * Consecutive calls to this function will cancel the last pulse call
  50039. *
  50040. * @param value the strength of the pulse in 0.0...1.0 range
  50041. * @param duration Duration of the pulse in milliseconds
  50042. * @param hapticActuatorIndex optional index of actuator (will usually be 0)
  50043. * @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
  50044. */
  50045. pulse(value: number, duration: number, hapticActuatorIndex?: number): Promise<boolean>;
  50046. protected _getChildByName(node: AbstractMesh, name: string): AbstractMesh | undefined;
  50047. protected _getImmediateChildByName(node: AbstractMesh, name: string): AbstractMesh | undefined;
  50048. /**
  50049. * Moves the axis on the controller mesh based on its current state
  50050. * @param axis the index of the axis
  50051. * @param axisValue the value of the axis which determines the meshes new position
  50052. * @hidden
  50053. */
  50054. protected _lerpTransform(axisMap: IMotionControllerMeshMap, axisValue: number, fixValueCoordinates?: boolean): void;
  50055. /**
  50056. * Update the model itself with the current frame data
  50057. * @param xrFrame the frame to use for updating the model mesh
  50058. */
  50059. protected updateModel(xrFrame: XRFrame): void;
  50060. /**
  50061. * Get the filename and path for this controller's model
  50062. * @returns a map of filename and path
  50063. */
  50064. protected abstract _getFilenameAndPath(): {
  50065. filename: string;
  50066. path: string;
  50067. };
  50068. /**
  50069. * This function is called before the mesh is loaded. It checks for loading constraints.
  50070. * For example, this function can check if the GLB loader is available
  50071. * If this function returns false, the generic controller will be loaded instead
  50072. * @returns Is the client ready to load the mesh
  50073. */
  50074. protected abstract _getModelLoadingConstraints(): boolean;
  50075. /**
  50076. * This function will be called after the model was successfully loaded and can be used
  50077. * for mesh transformations before it is available for the user
  50078. * @param meshes the loaded meshes
  50079. */
  50080. protected abstract _processLoadedModel(meshes: AbstractMesh[]): void;
  50081. /**
  50082. * Set the root mesh for this controller. Important for the WebXR controller class
  50083. * @param meshes the loaded meshes
  50084. */
  50085. protected abstract _setRootMesh(meshes: AbstractMesh[]): void;
  50086. /**
  50087. * A function executed each frame that updates the mesh (if needed)
  50088. * @param xrFrame the current xrFrame
  50089. */
  50090. protected abstract _updateModel(xrFrame: XRFrame): void;
  50091. private _getGenericFilenameAndPath;
  50092. private _getGenericParentMesh;
  50093. }
  50094. }
  50095. declare module "babylonjs/XR/motionController/webXRGenericMotionController" {
  50096. import { WebXRAbstractMotionController, IMinimalMotionControllerObject, MotionControllerHandedness } from "babylonjs/XR/motionController/webXRAbstractMotionController";
  50097. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  50098. import { Scene } from "babylonjs/scene";
  50099. /**
  50100. * A generic trigger-only motion controller for WebXR
  50101. */
  50102. export class WebXRGenericTriggerMotionController extends WebXRAbstractMotionController {
  50103. /**
  50104. * Static version of the profile id of this controller
  50105. */
  50106. static ProfileId: string;
  50107. profileId: string;
  50108. constructor(scene: Scene, gamepadObject: IMinimalMotionControllerObject, handedness: MotionControllerHandedness);
  50109. protected _getFilenameAndPath(): {
  50110. filename: string;
  50111. path: string;
  50112. };
  50113. protected _getModelLoadingConstraints(): boolean;
  50114. protected _processLoadedModel(meshes: AbstractMesh[]): void;
  50115. protected _setRootMesh(meshes: AbstractMesh[]): void;
  50116. protected _updateModel(): void;
  50117. }
  50118. }
  50119. declare module "babylonjs/Meshes/Builders/sphereBuilder" {
  50120. import { Vector4 } from "babylonjs/Maths/math.vector";
  50121. import { Mesh } from "babylonjs/Meshes/mesh";
  50122. import { Scene } from "babylonjs/scene";
  50123. import { Nullable } from "babylonjs/types";
  50124. /**
  50125. * Class containing static functions to help procedurally build meshes
  50126. */
  50127. export class SphereBuilder {
  50128. /**
  50129. * Creates a sphere mesh
  50130. * * The parameter `diameter` sets the diameter size (float) of the sphere (default 1)
  50131. * * 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`)
  50132. * * The parameter `segments` sets the sphere number of horizontal stripes (positive integer, default 32)
  50133. * * 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
  50134. * * 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)
  50135. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  50136. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  50137. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  50138. * @param name defines the name of the mesh
  50139. * @param options defines the options used to create the mesh
  50140. * @param scene defines the hosting scene
  50141. * @returns the sphere mesh
  50142. * @see https://doc.babylonjs.com/how_to/set_shapes#sphere
  50143. */
  50144. static CreateSphere(name: string, options: {
  50145. segments?: number;
  50146. diameter?: number;
  50147. diameterX?: number;
  50148. diameterY?: number;
  50149. diameterZ?: number;
  50150. arc?: number;
  50151. slice?: number;
  50152. sideOrientation?: number;
  50153. frontUVs?: Vector4;
  50154. backUVs?: Vector4;
  50155. updatable?: boolean;
  50156. }, scene?: Nullable<Scene>): Mesh;
  50157. }
  50158. }
  50159. declare module "babylonjs/XR/motionController/webXRProfiledMotionController" {
  50160. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  50161. import { WebXRAbstractMotionController, IMotionControllerProfile } from "babylonjs/XR/motionController/webXRAbstractMotionController";
  50162. import { Scene } from "babylonjs/scene";
  50163. /**
  50164. * A profiled motion controller has its profile loaded from an online repository.
  50165. * The class is responsible of loading the model, mapping the keys and enabling model-animations
  50166. */
  50167. export class WebXRProfiledMotionController extends WebXRAbstractMotionController {
  50168. private _repositoryUrl;
  50169. private _buttonMeshMapping;
  50170. private _touchDots;
  50171. /**
  50172. * The profile ID of this controller. Will be populated when the controller initializes.
  50173. */
  50174. profileId: string;
  50175. constructor(scene: Scene, xrInput: XRInputSource, _profile: IMotionControllerProfile, _repositoryUrl: string);
  50176. dispose(): void;
  50177. protected _getFilenameAndPath(): {
  50178. filename: string;
  50179. path: string;
  50180. };
  50181. protected _getModelLoadingConstraints(): boolean;
  50182. protected _processLoadedModel(_meshes: AbstractMesh[]): void;
  50183. protected _setRootMesh(meshes: AbstractMesh[]): void;
  50184. protected _updateModel(_xrFrame: XRFrame): void;
  50185. }
  50186. }
  50187. declare module "babylonjs/XR/motionController/webXRMotionControllerManager" {
  50188. import { WebXRAbstractMotionController } from "babylonjs/XR/motionController/webXRAbstractMotionController";
  50189. import { Scene } from "babylonjs/scene";
  50190. /**
  50191. * A construction function type to create a new controller based on an xrInput object
  50192. */
  50193. export type MotionControllerConstructor = (xrInput: XRInputSource, scene: Scene) => WebXRAbstractMotionController;
  50194. /**
  50195. * The MotionController Manager manages all registered motion controllers and loads the right one when needed.
  50196. *
  50197. * When this repository is complete: https://github.com/immersive-web/webxr-input-profiles/tree/master/packages/assets
  50198. * it should be replaced with auto-loaded controllers.
  50199. *
  50200. * When using a model try to stay as generic as possible. Eventually there will be no need in any of the controller classes
  50201. */
  50202. export class WebXRMotionControllerManager {
  50203. private static _AvailableControllers;
  50204. private static _Fallbacks;
  50205. private static _ProfileLoadingPromises;
  50206. private static _ProfilesList;
  50207. /**
  50208. * The base URL of the online controller repository. Can be changed at any time.
  50209. */
  50210. static BaseRepositoryUrl: string;
  50211. /**
  50212. * Which repository gets priority - local or online
  50213. */
  50214. static PrioritizeOnlineRepository: boolean;
  50215. /**
  50216. * Use the online repository, or use only locally-defined controllers
  50217. */
  50218. static UseOnlineRepository: boolean;
  50219. /**
  50220. * Clear the cache used for profile loading and reload when requested again
  50221. */
  50222. static ClearProfilesCache(): void;
  50223. /**
  50224. * Register the default fallbacks.
  50225. * This function is called automatically when this file is imported.
  50226. */
  50227. static DefaultFallbacks(): void;
  50228. /**
  50229. * Find a fallback profile if the profile was not found. There are a few predefined generic profiles.
  50230. * @param profileId the profile to which a fallback needs to be found
  50231. * @return an array with corresponding fallback profiles
  50232. */
  50233. static FindFallbackWithProfileId(profileId: string): string[];
  50234. /**
  50235. * When acquiring a new xrInput object (usually by the WebXRInput class), match it with the correct profile.
  50236. * The order of search:
  50237. *
  50238. * 1) Iterate the profiles array of the xr input and try finding a corresponding motion controller
  50239. * 2) (If not found) search in the gamepad id and try using it (legacy versions only)
  50240. * 3) search for registered fallbacks (should be redundant, nonetheless it makes sense to check)
  50241. * 4) return the generic trigger controller if none were found
  50242. *
  50243. * @param xrInput the xrInput to which a new controller is initialized
  50244. * @param scene the scene to which the model will be added
  50245. * @param forceProfile force a certain profile for this controller
  50246. * @return A promise that fulfils with the motion controller class for this profile id or the generic standard class if none was found
  50247. */
  50248. static GetMotionControllerWithXRInput(xrInput: XRInputSource, scene: Scene, forceProfile?: string): Promise<WebXRAbstractMotionController>;
  50249. /**
  50250. * Register a new controller based on its profile. This function will be called by the controller classes themselves.
  50251. *
  50252. * If you are missing a profile, make sure it is imported in your source, otherwise it will not register.
  50253. *
  50254. * @param type the profile type to register
  50255. * @param constructFunction the function to be called when loading this profile
  50256. */
  50257. static RegisterController(type: string, constructFunction: MotionControllerConstructor): void;
  50258. /**
  50259. * Register a fallback to a specific profile.
  50260. * @param profileId the profileId that will receive the fallbacks
  50261. * @param fallbacks A list of fallback profiles
  50262. */
  50263. static RegisterFallbacksForProfileId(profileId: string, fallbacks: string[]): void;
  50264. /**
  50265. * Will update the list of profiles available in the repository
  50266. * @return a promise that resolves to a map of profiles available online
  50267. */
  50268. static UpdateProfilesList(): Promise<{
  50269. [profile: string]: string;
  50270. }>;
  50271. private static _LoadProfileFromRepository;
  50272. private static _LoadProfilesFromAvailableControllers;
  50273. }
  50274. }
  50275. declare module "babylonjs/XR/webXRInputSource" {
  50276. import { Observable } from "babylonjs/Misc/observable";
  50277. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  50278. import { Ray } from "babylonjs/Culling/ray";
  50279. import { Scene } from "babylonjs/scene";
  50280. import { WebXRAbstractMotionController } from "babylonjs/XR/motionController/webXRAbstractMotionController";
  50281. /**
  50282. * Configuration options for the WebXR controller creation
  50283. */
  50284. export interface IWebXRControllerOptions {
  50285. /**
  50286. * Should the controller mesh be animated when a user interacts with it
  50287. * The pressed buttons / thumbstick and touchpad animations will be disabled
  50288. */
  50289. disableMotionControllerAnimation?: boolean;
  50290. /**
  50291. * Do not load the controller mesh, in case a different mesh needs to be loaded.
  50292. */
  50293. doNotLoadControllerMesh?: boolean;
  50294. /**
  50295. * Force a specific controller type for this controller.
  50296. * This can be used when creating your own profile or when testing different controllers
  50297. */
  50298. forceControllerProfile?: string;
  50299. /**
  50300. * Defines a rendering group ID for meshes that will be loaded.
  50301. * This is for the default controllers only.
  50302. */
  50303. renderingGroupId?: number;
  50304. }
  50305. /**
  50306. * Represents an XR controller
  50307. */
  50308. export class WebXRInputSource {
  50309. private _scene;
  50310. /** The underlying input source for the controller */
  50311. inputSource: XRInputSource;
  50312. private _options;
  50313. private _tmpVector;
  50314. private _uniqueId;
  50315. private _disposed;
  50316. /**
  50317. * 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
  50318. */
  50319. grip?: AbstractMesh;
  50320. /**
  50321. * If available, this is the gamepad object related to this controller.
  50322. * Using this object it is possible to get click events and trackpad changes of the
  50323. * webxr controller that is currently being used.
  50324. */
  50325. motionController?: WebXRAbstractMotionController;
  50326. /**
  50327. * Event that fires when the controller is removed/disposed.
  50328. * The object provided as event data is this controller, after associated assets were disposed.
  50329. * uniqueId is still available.
  50330. */
  50331. onDisposeObservable: Observable<WebXRInputSource>;
  50332. /**
  50333. * Will be triggered when the mesh associated with the motion controller is done loading.
  50334. * It is also possible that this will never trigger (!) if no mesh was loaded, or if the developer decides to load a different mesh
  50335. * A shortened version of controller -> motion controller -> on mesh loaded.
  50336. */
  50337. onMeshLoadedObservable: Observable<AbstractMesh>;
  50338. /**
  50339. * Observers registered here will trigger when a motion controller profile was assigned to this xr controller
  50340. */
  50341. onMotionControllerInitObservable: Observable<WebXRAbstractMotionController>;
  50342. /**
  50343. * Pointer which can be used to select objects or attach a visible laser to
  50344. */
  50345. pointer: AbstractMesh;
  50346. /**
  50347. * Creates the input source object
  50348. * @see https://doc.babylonjs.com/how_to/webxr_controllers_support
  50349. * @param _scene the scene which the controller should be associated to
  50350. * @param inputSource the underlying input source for the controller
  50351. * @param _options options for this controller creation
  50352. */
  50353. constructor(_scene: Scene,
  50354. /** The underlying input source for the controller */
  50355. inputSource: XRInputSource, _options?: IWebXRControllerOptions);
  50356. /**
  50357. * Get this controllers unique id
  50358. */
  50359. get uniqueId(): string;
  50360. /**
  50361. * Disposes of the object
  50362. */
  50363. dispose(): void;
  50364. /**
  50365. * Gets a world space ray coming from the pointer or grip
  50366. * @param result the resulting ray
  50367. * @param gripIfAvailable use the grip mesh instead of the pointer, if available
  50368. */
  50369. getWorldPointerRayToRef(result: Ray, gripIfAvailable?: boolean): void;
  50370. /**
  50371. * Updates the controller pose based on the given XRFrame
  50372. * @param xrFrame xr frame to update the pose with
  50373. * @param referenceSpace reference space to use
  50374. */
  50375. updateFromXRFrame(xrFrame: XRFrame, referenceSpace: XRReferenceSpace): void;
  50376. }
  50377. }
  50378. declare module "babylonjs/XR/webXRInput" {
  50379. import { Observable } from "babylonjs/Misc/observable";
  50380. import { IDisposable } from "babylonjs/scene";
  50381. import { WebXRInputSource, IWebXRControllerOptions } from "babylonjs/XR/webXRInputSource";
  50382. import { WebXRSessionManager } from "babylonjs/XR/webXRSessionManager";
  50383. import { WebXRCamera } from "babylonjs/XR/webXRCamera";
  50384. /**
  50385. * The schema for initialization options of the XR Input class
  50386. */
  50387. export interface IWebXRInputOptions {
  50388. /**
  50389. * If set to true no model will be automatically loaded
  50390. */
  50391. doNotLoadControllerMeshes?: boolean;
  50392. /**
  50393. * If set, this profile will be used for all controllers loaded (for example "microsoft-mixed-reality")
  50394. * If not found, the xr input profile data will be used.
  50395. * Profiles are defined here - https://github.com/immersive-web/webxr-input-profiles/
  50396. */
  50397. forceInputProfile?: string;
  50398. /**
  50399. * Do not send a request to the controller repository to load the profile.
  50400. *
  50401. * Instead, use the controllers available in babylon itself.
  50402. */
  50403. disableOnlineControllerRepository?: boolean;
  50404. /**
  50405. * A custom URL for the controllers repository
  50406. */
  50407. customControllersRepositoryURL?: string;
  50408. /**
  50409. * Should the controller model's components not move according to the user input
  50410. */
  50411. disableControllerAnimation?: boolean;
  50412. /**
  50413. * Optional options to pass to the controller. Will be overridden by the Input options where applicable
  50414. */
  50415. controllerOptions?: IWebXRControllerOptions;
  50416. }
  50417. /**
  50418. * XR input used to track XR inputs such as controllers/rays
  50419. */
  50420. export class WebXRInput implements IDisposable {
  50421. /**
  50422. * the xr session manager for this session
  50423. */
  50424. xrSessionManager: WebXRSessionManager;
  50425. /**
  50426. * the WebXR camera for this session. Mainly used for teleportation
  50427. */
  50428. xrCamera: WebXRCamera;
  50429. private readonly options;
  50430. /**
  50431. * XR controllers being tracked
  50432. */
  50433. controllers: Array<WebXRInputSource>;
  50434. private _frameObserver;
  50435. private _sessionEndedObserver;
  50436. private _sessionInitObserver;
  50437. /**
  50438. * Event when a controller has been connected/added
  50439. */
  50440. onControllerAddedObservable: Observable<WebXRInputSource>;
  50441. /**
  50442. * Event when a controller has been removed/disconnected
  50443. */
  50444. onControllerRemovedObservable: Observable<WebXRInputSource>;
  50445. /**
  50446. * Initializes the WebXRInput
  50447. * @param xrSessionManager the xr session manager for this session
  50448. * @param xrCamera the WebXR camera for this session. Mainly used for teleportation
  50449. * @param options = initialization options for this xr input
  50450. */
  50451. constructor(
  50452. /**
  50453. * the xr session manager for this session
  50454. */
  50455. xrSessionManager: WebXRSessionManager,
  50456. /**
  50457. * the WebXR camera for this session. Mainly used for teleportation
  50458. */
  50459. xrCamera: WebXRCamera, options?: IWebXRInputOptions);
  50460. private _onInputSourcesChange;
  50461. private _addAndRemoveControllers;
  50462. /**
  50463. * Disposes of the object
  50464. */
  50465. dispose(): void;
  50466. }
  50467. }
  50468. declare module "babylonjs/XR/features/WebXRAbstractFeature" {
  50469. import { IWebXRFeature } from "babylonjs/XR/webXRFeaturesManager";
  50470. import { Observable, EventState } from "babylonjs/Misc/observable";
  50471. import { WebXRSessionManager } from "babylonjs/XR/webXRSessionManager";
  50472. /**
  50473. * This is the base class for all WebXR features.
  50474. * Since most features require almost the same resources and callbacks, this class can be used to simplify the development
  50475. * Note that since the features manager is using the `IWebXRFeature` you are in no way obligated to use this class
  50476. */
  50477. export abstract class WebXRAbstractFeature implements IWebXRFeature {
  50478. protected _xrSessionManager: WebXRSessionManager;
  50479. private _attached;
  50480. private _removeOnDetach;
  50481. /**
  50482. * Should auto-attach be disabled?
  50483. */
  50484. disableAutoAttach: boolean;
  50485. /**
  50486. * The name of the native xr feature name (like anchor, hit-test, or hand-tracking)
  50487. */
  50488. xrNativeFeatureName: string;
  50489. /**
  50490. * Construct a new (abstract) WebXR feature
  50491. * @param _xrSessionManager the xr session manager for this feature
  50492. */
  50493. constructor(_xrSessionManager: WebXRSessionManager);
  50494. /**
  50495. * Is this feature attached
  50496. */
  50497. get attached(): boolean;
  50498. /**
  50499. * attach this feature
  50500. *
  50501. * @param force should attachment be forced (even when already attached)
  50502. * @returns true if successful, false is failed or already attached
  50503. */
  50504. attach(force?: boolean): boolean;
  50505. /**
  50506. * detach this feature.
  50507. *
  50508. * @returns true if successful, false if failed or already detached
  50509. */
  50510. detach(): boolean;
  50511. /**
  50512. * Dispose this feature and all of the resources attached
  50513. */
  50514. dispose(): void;
  50515. /**
  50516. * This function will be executed during before enabling the feature and can be used to not-allow enabling it.
  50517. * Note that at this point the session has NOT started, so this is purely checking if the browser supports it
  50518. *
  50519. * @returns whether or not the feature is compatible in this environment
  50520. */
  50521. isCompatible(): boolean;
  50522. /**
  50523. * This is used to register callbacks that will automatically be removed when detach is called.
  50524. * @param observable the observable to which the observer will be attached
  50525. * @param callback the callback to register
  50526. */
  50527. protected _addNewAttachObserver<T>(observable: Observable<T>, callback: (eventData: T, eventState: EventState) => void): void;
  50528. /**
  50529. * Code in this function will be executed on each xrFrame received from the browser.
  50530. * This function will not execute after the feature is detached.
  50531. * @param _xrFrame the current frame
  50532. */
  50533. protected abstract _onXRFrame(_xrFrame: XRFrame): void;
  50534. }
  50535. }
  50536. declare module "babylonjs/Rendering/utilityLayerRenderer" {
  50537. import { IDisposable, Scene } from "babylonjs/scene";
  50538. import { Nullable } from "babylonjs/types";
  50539. import { Observable } from "babylonjs/Misc/observable";
  50540. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  50541. import { HemisphericLight } from "babylonjs/Lights/hemisphericLight";
  50542. import { Camera } from "babylonjs/Cameras/camera";
  50543. /**
  50544. * Renders a layer on top of an existing scene
  50545. */
  50546. export class UtilityLayerRenderer implements IDisposable {
  50547. /** the original scene that will be rendered on top of */
  50548. originalScene: Scene;
  50549. private _pointerCaptures;
  50550. private _lastPointerEvents;
  50551. private static _DefaultUtilityLayer;
  50552. private static _DefaultKeepDepthUtilityLayer;
  50553. private _sharedGizmoLight;
  50554. private _renderCamera;
  50555. /**
  50556. * Gets the camera that is used to render the utility layer (when not set, this will be the last active camera)
  50557. * @param getRigParentIfPossible if the current active camera is a rig camera, should its parent camera be returned
  50558. * @returns the camera that is used when rendering the utility layer
  50559. */
  50560. getRenderCamera(getRigParentIfPossible?: boolean): Camera;
  50561. /**
  50562. * Sets the camera that should be used when rendering the utility layer (If set to null the last active camera will be used)
  50563. * @param cam the camera that should be used when rendering the utility layer
  50564. */
  50565. setRenderCamera(cam: Nullable<Camera>): void;
  50566. /**
  50567. * @hidden
  50568. * Light which used by gizmos to get light shading
  50569. */
  50570. _getSharedGizmoLight(): HemisphericLight;
  50571. /**
  50572. * If the picking should be done on the utility layer prior to the actual scene (Default: true)
  50573. */
  50574. pickUtilitySceneFirst: boolean;
  50575. /**
  50576. * 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)
  50577. */
  50578. static get DefaultUtilityLayer(): UtilityLayerRenderer;
  50579. /**
  50580. * 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)
  50581. */
  50582. static get DefaultKeepDepthUtilityLayer(): UtilityLayerRenderer;
  50583. /**
  50584. * The scene that is rendered on top of the original scene
  50585. */
  50586. utilityLayerScene: Scene;
  50587. /**
  50588. * If the utility layer should automatically be rendered on top of existing scene
  50589. */
  50590. shouldRender: boolean;
  50591. /**
  50592. * If set to true, only pointer down onPointerObservable events will be blocked when picking is occluded by original scene
  50593. */
  50594. onlyCheckPointerDownEvents: boolean;
  50595. /**
  50596. * If set to false, only pointerUp, pointerDown and pointerMove will be sent to the utilityLayerScene (false by default)
  50597. */
  50598. processAllEvents: boolean;
  50599. /**
  50600. * Observable raised when the pointer move from the utility layer scene to the main scene
  50601. */
  50602. onPointerOutObservable: Observable<number>;
  50603. /** Gets or sets a predicate that will be used to indicate utility meshes present in the main scene */
  50604. mainSceneTrackerPredicate: (mesh: Nullable<AbstractMesh>) => boolean;
  50605. private _afterRenderObserver;
  50606. private _sceneDisposeObserver;
  50607. private _originalPointerObserver;
  50608. /**
  50609. * Instantiates a UtilityLayerRenderer
  50610. * @param originalScene the original scene that will be rendered on top of
  50611. * @param handleEvents boolean indicating if the utility layer should handle events
  50612. */
  50613. constructor(
  50614. /** the original scene that will be rendered on top of */
  50615. originalScene: Scene, handleEvents?: boolean);
  50616. private _notifyObservers;
  50617. /**
  50618. * Renders the utility layers scene on top of the original scene
  50619. */
  50620. render(): void;
  50621. /**
  50622. * Disposes of the renderer
  50623. */
  50624. dispose(): void;
  50625. private _updateCamera;
  50626. }
  50627. }
  50628. declare module "babylonjs/XR/features/WebXRControllerPointerSelection" {
  50629. import { WebXRSessionManager } from "babylonjs/XR/webXRSessionManager";
  50630. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  50631. import { WebXRInput } from "babylonjs/XR/webXRInput";
  50632. import { WebXRInputSource } from "babylonjs/XR/webXRInputSource";
  50633. import { Scene } from "babylonjs/scene";
  50634. import { Nullable } from "babylonjs/types";
  50635. import { Color3 } from "babylonjs/Maths/math.color";
  50636. import { WebXRAbstractFeature } from "babylonjs/XR/features/WebXRAbstractFeature";
  50637. import { WebXRCamera } from "babylonjs/XR/webXRCamera";
  50638. /**
  50639. * Options interface for the pointer selection module
  50640. */
  50641. export interface IWebXRControllerPointerSelectionOptions {
  50642. /**
  50643. * if provided, this scene will be used to render meshes.
  50644. */
  50645. customUtilityLayerScene?: Scene;
  50646. /**
  50647. * 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)
  50648. * If not disabled, the last picked point will be used to execute a pointer up event
  50649. * If disabled, pointer up event will be triggered right after the pointer down event.
  50650. * Used in screen and gaze target ray mode only
  50651. */
  50652. disablePointerUpOnTouchOut: boolean;
  50653. /**
  50654. * For gaze mode for tracked-pointer / controllers (time to select instead of button press)
  50655. */
  50656. forceGazeMode: boolean;
  50657. /**
  50658. * 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
  50659. * to start a new countdown to the pointer down event.
  50660. * Defaults to 1.
  50661. */
  50662. gazeModePointerMovedFactor?: number;
  50663. /**
  50664. * Different button type to use instead of the main component
  50665. */
  50666. overrideButtonId?: string;
  50667. /**
  50668. * use this rendering group id for the meshes (optional)
  50669. */
  50670. renderingGroupId?: number;
  50671. /**
  50672. * The amount of time in milliseconds it takes between pick found something to a pointer down event.
  50673. * Used in gaze modes. Tracked pointer uses the trigger, screen uses touch events
  50674. * 3000 means 3 seconds between pointing at something and selecting it
  50675. */
  50676. timeToSelect?: number;
  50677. /**
  50678. * Should meshes created here be added to a utility layer or the main scene
  50679. */
  50680. useUtilityLayer?: boolean;
  50681. /**
  50682. * Optional WebXR camera to be used for gaze selection
  50683. */
  50684. gazeCamera?: WebXRCamera;
  50685. /**
  50686. * the xr input to use with this pointer selection
  50687. */
  50688. xrInput: WebXRInput;
  50689. }
  50690. /**
  50691. * A module that will enable pointer selection for motion controllers of XR Input Sources
  50692. */
  50693. export class WebXRControllerPointerSelection extends WebXRAbstractFeature {
  50694. private readonly _options;
  50695. private static _idCounter;
  50696. private _attachController;
  50697. private _controllers;
  50698. private _scene;
  50699. private _tmpVectorForPickCompare;
  50700. /**
  50701. * The module's name
  50702. */
  50703. static readonly Name: string;
  50704. /**
  50705. * The (Babylon) version of this module.
  50706. * This is an integer representing the implementation version.
  50707. * This number does not correspond to the WebXR specs version
  50708. */
  50709. static readonly Version: number;
  50710. /**
  50711. * Disable lighting on the laser pointer (so it will always be visible)
  50712. */
  50713. disablePointerLighting: boolean;
  50714. /**
  50715. * Disable lighting on the selection mesh (so it will always be visible)
  50716. */
  50717. disableSelectionMeshLighting: boolean;
  50718. /**
  50719. * Should the laser pointer be displayed
  50720. */
  50721. displayLaserPointer: boolean;
  50722. /**
  50723. * Should the selection mesh be displayed (The ring at the end of the laser pointer)
  50724. */
  50725. displaySelectionMesh: boolean;
  50726. /**
  50727. * This color will be set to the laser pointer when selection is triggered
  50728. */
  50729. laserPointerPickedColor: Color3;
  50730. /**
  50731. * Default color of the laser pointer
  50732. */
  50733. laserPointerDefaultColor: Color3;
  50734. /**
  50735. * default color of the selection ring
  50736. */
  50737. selectionMeshDefaultColor: Color3;
  50738. /**
  50739. * This color will be applied to the selection ring when selection is triggered
  50740. */
  50741. selectionMeshPickedColor: Color3;
  50742. /**
  50743. * Optional filter to be used for ray selection. This predicate shares behavior with
  50744. * scene.pointerMovePredicate which takes priority if it is also assigned.
  50745. */
  50746. raySelectionPredicate: (mesh: AbstractMesh) => boolean;
  50747. /**
  50748. * constructs a new background remover module
  50749. * @param _xrSessionManager the session manager for this module
  50750. * @param _options read-only options to be used in this module
  50751. */
  50752. constructor(_xrSessionManager: WebXRSessionManager, _options: IWebXRControllerPointerSelectionOptions);
  50753. /**
  50754. * attach this feature
  50755. * Will usually be called by the features manager
  50756. *
  50757. * @returns true if successful.
  50758. */
  50759. attach(): boolean;
  50760. /**
  50761. * detach this feature.
  50762. * Will usually be called by the features manager
  50763. *
  50764. * @returns true if successful.
  50765. */
  50766. detach(): boolean;
  50767. /**
  50768. * Will get the mesh under a specific pointer.
  50769. * `scene.meshUnderPointer` will only return one mesh - either left or right.
  50770. * @param controllerId the controllerId to check
  50771. * @returns The mesh under pointer or null if no mesh is under the pointer
  50772. */
  50773. getMeshUnderPointer(controllerId: string): Nullable<AbstractMesh>;
  50774. /**
  50775. * Get the xr controller that correlates to the pointer id in the pointer event
  50776. *
  50777. * @param id the pointer id to search for
  50778. * @returns the controller that correlates to this id or null if not found
  50779. */
  50780. getXRControllerByPointerId(id: number): Nullable<WebXRInputSource>;
  50781. protected _onXRFrame(_xrFrame: XRFrame): void;
  50782. private _attachGazeMode;
  50783. private _attachScreenRayMode;
  50784. private _attachTrackedPointerRayMode;
  50785. private _convertNormalToDirectionOfRay;
  50786. private _detachController;
  50787. private _generateNewMeshPair;
  50788. private _pickingMoved;
  50789. private _updatePointerDistance;
  50790. /** @hidden */
  50791. get lasterPointerDefaultColor(): Color3;
  50792. }
  50793. }
  50794. declare module "babylonjs/XR/webXREnterExitUI" {
  50795. import { Nullable } from "babylonjs/types";
  50796. import { Observable } from "babylonjs/Misc/observable";
  50797. import { IDisposable, Scene } from "babylonjs/scene";
  50798. import { WebXRExperienceHelper } from "babylonjs/XR/webXRExperienceHelper";
  50799. import { WebXRRenderTarget } from "babylonjs/XR/webXRTypes";
  50800. /**
  50801. * Button which can be used to enter a different mode of XR
  50802. */
  50803. export class WebXREnterExitUIButton {
  50804. /** button element */
  50805. element: HTMLElement;
  50806. /** XR initialization options for the button */
  50807. sessionMode: XRSessionMode;
  50808. /** Reference space type */
  50809. referenceSpaceType: XRReferenceSpaceType;
  50810. /**
  50811. * Creates a WebXREnterExitUIButton
  50812. * @param element button element
  50813. * @param sessionMode XR initialization session mode
  50814. * @param referenceSpaceType the type of reference space to be used
  50815. */
  50816. constructor(
  50817. /** button element */
  50818. element: HTMLElement,
  50819. /** XR initialization options for the button */
  50820. sessionMode: XRSessionMode,
  50821. /** Reference space type */
  50822. referenceSpaceType: XRReferenceSpaceType);
  50823. /**
  50824. * Extendable function which can be used to update the button's visuals when the state changes
  50825. * @param activeButton the current active button in the UI
  50826. */
  50827. update(activeButton: Nullable<WebXREnterExitUIButton>): void;
  50828. }
  50829. /**
  50830. * Options to create the webXR UI
  50831. */
  50832. export class WebXREnterExitUIOptions {
  50833. /**
  50834. * User provided buttons to enable/disable WebXR. The system will provide default if not set
  50835. */
  50836. customButtons?: Array<WebXREnterExitUIButton>;
  50837. /**
  50838. * A reference space type to use when creating the default button.
  50839. * Default is local-floor
  50840. */
  50841. referenceSpaceType?: XRReferenceSpaceType;
  50842. /**
  50843. * Context to enter xr with
  50844. */
  50845. renderTarget?: Nullable<WebXRRenderTarget>;
  50846. /**
  50847. * A session mode to use when creating the default button.
  50848. * Default is immersive-vr
  50849. */
  50850. sessionMode?: XRSessionMode;
  50851. /**
  50852. * A list of optional features to init the session with
  50853. */
  50854. optionalFeatures?: string[];
  50855. /**
  50856. * A list of optional features to init the session with
  50857. */
  50858. requiredFeatures?: string[];
  50859. }
  50860. /**
  50861. * UI to allow the user to enter/exit XR mode
  50862. */
  50863. export class WebXREnterExitUI implements IDisposable {
  50864. private scene;
  50865. /** version of the options passed to this UI */
  50866. options: WebXREnterExitUIOptions;
  50867. private _activeButton;
  50868. private _buttons;
  50869. /**
  50870. * The HTML Div Element to which buttons are added.
  50871. */
  50872. readonly overlay: HTMLDivElement;
  50873. /**
  50874. * Fired every time the active button is changed.
  50875. *
  50876. * When xr is entered via a button that launches xr that button will be the callback parameter
  50877. *
  50878. * When exiting xr the callback parameter will be null)
  50879. */
  50880. activeButtonChangedObservable: Observable<Nullable<WebXREnterExitUIButton>>;
  50881. /**
  50882. *
  50883. * @param scene babylon scene object to use
  50884. * @param options (read-only) version of the options passed to this UI
  50885. */
  50886. private constructor();
  50887. /**
  50888. * Creates UI to allow the user to enter/exit XR mode
  50889. * @param scene the scene to add the ui to
  50890. * @param helper the xr experience helper to enter/exit xr with
  50891. * @param options options to configure the UI
  50892. * @returns the created ui
  50893. */
  50894. static CreateAsync(scene: Scene, helper: WebXRExperienceHelper, options: WebXREnterExitUIOptions): Promise<WebXREnterExitUI>;
  50895. /**
  50896. * Disposes of the XR UI component
  50897. */
  50898. dispose(): void;
  50899. private _updateButtons;
  50900. }
  50901. }
  50902. declare module "babylonjs/Meshes/Builders/linesBuilder" {
  50903. import { Vector3 } from "babylonjs/Maths/math.vector";
  50904. import { Color4 } from "babylonjs/Maths/math.color";
  50905. import { Nullable } from "babylonjs/types";
  50906. import { LinesMesh } from "babylonjs/Meshes/linesMesh";
  50907. import { Scene } from "babylonjs/scene";
  50908. /**
  50909. * Class containing static functions to help procedurally build meshes
  50910. */
  50911. export class LinesBuilder {
  50912. /**
  50913. * Creates a line system mesh. A line system is a pool of many lines gathered in a single mesh
  50914. * * 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
  50915. * * Like every other parametric shape, it is dynamically updatable by passing an existing instance of LineSystem to this static function
  50916. * * The parameter `lines` is an array of lines, each line being an array of successive Vector3
  50917. * * The optional parameter `instance` is an instance of an existing LineSystem object to be updated with the passed `lines` parameter
  50918. * * The optional parameter `colors` is an array of line colors, each line colors being an array of successive Color4, one per line point
  50919. * * The optional parameter `useVertexAlpha` is to be set to `false` (default `true`) when you don't need the alpha blending (faster)
  50920. * * 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
  50921. * * When updating an instance, remember that only line point positions can change, not the number of points, neither the number of lines
  50922. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  50923. * @see https://doc.babylonjs.com/how_to/parametric_shapes#line-system
  50924. * @param name defines the name of the new line system
  50925. * @param options defines the options used to create the line system
  50926. * @param scene defines the hosting scene
  50927. * @returns a new line system mesh
  50928. */
  50929. static CreateLineSystem(name: string, options: {
  50930. lines: Vector3[][];
  50931. updatable?: boolean;
  50932. instance?: Nullable<LinesMesh>;
  50933. colors?: Nullable<Color4[][]>;
  50934. useVertexAlpha?: boolean;
  50935. }, scene: Nullable<Scene>): LinesMesh;
  50936. /**
  50937. * Creates a line mesh
  50938. * 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
  50939. * * Like every other parametric shape, it is dynamically updatable by passing an existing instance of LineMesh to this static function
  50940. * * The parameter `points` is an array successive Vector3
  50941. * * 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
  50942. * * The optional parameter `colors` is an array of successive Color4, one per line point
  50943. * * The optional parameter `useVertexAlpha` is to be set to `false` (default `true`) when you don't need alpha blending (faster)
  50944. * * When updating an instance, remember that only point positions can change, not the number of points
  50945. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  50946. * @see https://doc.babylonjs.com/how_to/parametric_shapes#lines
  50947. * @param name defines the name of the new line system
  50948. * @param options defines the options used to create the line system
  50949. * @param scene defines the hosting scene
  50950. * @returns a new line mesh
  50951. */
  50952. static CreateLines(name: string, options: {
  50953. points: Vector3[];
  50954. updatable?: boolean;
  50955. instance?: Nullable<LinesMesh>;
  50956. colors?: Color4[];
  50957. useVertexAlpha?: boolean;
  50958. }, scene?: Nullable<Scene>): LinesMesh;
  50959. /**
  50960. * Creates a dashed line mesh
  50961. * * 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
  50962. * * Like every other parametric shape, it is dynamically updatable by passing an existing instance of LineMesh to this static function
  50963. * * The parameter `points` is an array successive Vector3
  50964. * * The parameter `dashNb` is the intended total number of dashes (positive integer, default 200)
  50965. * * The parameter `dashSize` is the size of the dashes relatively the dash number (positive float, default 3)
  50966. * * The parameter `gapSize` is the size of the gap between two successive dashes relatively the dash number (positive float, default 1)
  50967. * * 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
  50968. * * The optional parameter `useVertexAlpha` is to be set to `false` (default `true`) when you don't need the alpha blending (faster)
  50969. * * When updating an instance, remember that only point positions can change, not the number of points
  50970. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  50971. * @param name defines the name of the mesh
  50972. * @param options defines the options used to create the mesh
  50973. * @param scene defines the hosting scene
  50974. * @returns the dashed line mesh
  50975. * @see https://doc.babylonjs.com/how_to/parametric_shapes#dashed-lines
  50976. */
  50977. static CreateDashedLines(name: string, options: {
  50978. points: Vector3[];
  50979. dashSize?: number;
  50980. gapSize?: number;
  50981. dashNb?: number;
  50982. updatable?: boolean;
  50983. instance?: LinesMesh;
  50984. useVertexAlpha?: boolean;
  50985. }, scene?: Nullable<Scene>): LinesMesh;
  50986. }
  50987. }
  50988. declare module "babylonjs/Misc/timer" {
  50989. import { Observable, Observer } from "babylonjs/Misc/observable";
  50990. import { Nullable } from "babylonjs/types";
  50991. import { IDisposable } from "babylonjs/scene";
  50992. /**
  50993. * Construction options for a timer
  50994. */
  50995. export interface ITimerOptions<T> {
  50996. /**
  50997. * Time-to-end
  50998. */
  50999. timeout: number;
  51000. /**
  51001. * The context observable is used to calculate time deltas and provides the context of the timer's callbacks. Will usually be OnBeforeRenderObservable.
  51002. * Countdown calculation is done ONLY when the observable is notifying its observers, meaning that if
  51003. * you choose an observable that doesn't trigger too often, the wait time might extend further than the requested max time
  51004. */
  51005. contextObservable: Observable<T>;
  51006. /**
  51007. * Optional parameters when adding an observer to the observable
  51008. */
  51009. observableParameters?: {
  51010. mask?: number;
  51011. insertFirst?: boolean;
  51012. scope?: any;
  51013. };
  51014. /**
  51015. * An optional break condition that will stop the times prematurely. In this case onEnded will not be triggered!
  51016. */
  51017. breakCondition?: (data?: ITimerData<T>) => boolean;
  51018. /**
  51019. * Will be triggered when the time condition has met
  51020. */
  51021. onEnded?: (data: ITimerData<any>) => void;
  51022. /**
  51023. * Will be triggered when the break condition has met (prematurely ended)
  51024. */
  51025. onAborted?: (data: ITimerData<any>) => void;
  51026. /**
  51027. * Optional function to execute on each tick (or count)
  51028. */
  51029. onTick?: (data: ITimerData<any>) => void;
  51030. }
  51031. /**
  51032. * An interface defining the data sent by the timer
  51033. */
  51034. export interface ITimerData<T> {
  51035. /**
  51036. * When did it start
  51037. */
  51038. startTime: number;
  51039. /**
  51040. * Time now
  51041. */
  51042. currentTime: number;
  51043. /**
  51044. * Time passed since started
  51045. */
  51046. deltaTime: number;
  51047. /**
  51048. * How much is completed, in [0.0...1.0].
  51049. * Note that this CAN be higher than 1 due to the fact that we don't actually measure time but delta between observable calls
  51050. */
  51051. completeRate: number;
  51052. /**
  51053. * What the registered observable sent in the last count
  51054. */
  51055. payload: T;
  51056. }
  51057. /**
  51058. * The current state of the timer
  51059. */
  51060. export enum TimerState {
  51061. /**
  51062. * Timer initialized, not yet started
  51063. */
  51064. INIT = 0,
  51065. /**
  51066. * Timer started and counting
  51067. */
  51068. STARTED = 1,
  51069. /**
  51070. * Timer ended (whether aborted or time reached)
  51071. */
  51072. ENDED = 2
  51073. }
  51074. /**
  51075. * A simple version of the timer. Will take options and start the timer immediately after calling it
  51076. *
  51077. * @param options options with which to initialize this timer
  51078. */
  51079. export function setAndStartTimer(options: ITimerOptions<any>): Nullable<Observer<any>>;
  51080. /**
  51081. * An advanced implementation of a timer class
  51082. */
  51083. export class AdvancedTimer<T = any> implements IDisposable {
  51084. /**
  51085. * Will notify each time the timer calculates the remaining time
  51086. */
  51087. onEachCountObservable: Observable<ITimerData<T>>;
  51088. /**
  51089. * Will trigger when the timer was aborted due to the break condition
  51090. */
  51091. onTimerAbortedObservable: Observable<ITimerData<T>>;
  51092. /**
  51093. * Will trigger when the timer ended successfully
  51094. */
  51095. onTimerEndedObservable: Observable<ITimerData<T>>;
  51096. /**
  51097. * Will trigger when the timer state has changed
  51098. */
  51099. onStateChangedObservable: Observable<TimerState>;
  51100. private _observer;
  51101. private _contextObservable;
  51102. private _observableParameters;
  51103. private _startTime;
  51104. private _timer;
  51105. private _state;
  51106. private _breakCondition;
  51107. private _timeToEnd;
  51108. private _breakOnNextTick;
  51109. /**
  51110. * Will construct a new advanced timer based on the options provided. Timer will not start until start() is called.
  51111. * @param options construction options for this advanced timer
  51112. */
  51113. constructor(options: ITimerOptions<T>);
  51114. /**
  51115. * set a breaking condition for this timer. Default is to never break during count
  51116. * @param predicate the new break condition. Returns true to break, false otherwise
  51117. */
  51118. set breakCondition(predicate: (data: ITimerData<T>) => boolean);
  51119. /**
  51120. * Reset ALL associated observables in this advanced timer
  51121. */
  51122. clearObservables(): void;
  51123. /**
  51124. * Will start a new iteration of this timer. Only one instance of this timer can run at a time.
  51125. *
  51126. * @param timeToEnd how much time to measure until timer ended
  51127. */
  51128. start(timeToEnd?: number): void;
  51129. /**
  51130. * Will force a stop on the next tick.
  51131. */
  51132. stop(): void;
  51133. /**
  51134. * Dispose this timer, clearing all resources
  51135. */
  51136. dispose(): void;
  51137. private _setState;
  51138. private _tick;
  51139. private _stop;
  51140. }
  51141. }
  51142. declare module "babylonjs/XR/features/WebXRControllerTeleportation" {
  51143. import { IWebXRFeature } from "babylonjs/XR/webXRFeaturesManager";
  51144. import { WebXRSessionManager } from "babylonjs/XR/webXRSessionManager";
  51145. import { WebXRInput } from "babylonjs/XR/webXRInput";
  51146. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  51147. import { Vector3 } from "babylonjs/Maths/math.vector";
  51148. import { Material } from "babylonjs/Materials/material";
  51149. import { WebXRAbstractFeature } from "babylonjs/XR/features/WebXRAbstractFeature";
  51150. import { Scene } from "babylonjs/scene";
  51151. /**
  51152. * The options container for the teleportation module
  51153. */
  51154. export interface IWebXRTeleportationOptions {
  51155. /**
  51156. * if provided, this scene will be used to render meshes.
  51157. */
  51158. customUtilityLayerScene?: Scene;
  51159. /**
  51160. * Values to configure the default target mesh
  51161. */
  51162. defaultTargetMeshOptions?: {
  51163. /**
  51164. * Fill color of the teleportation area
  51165. */
  51166. teleportationFillColor?: string;
  51167. /**
  51168. * Border color for the teleportation area
  51169. */
  51170. teleportationBorderColor?: string;
  51171. /**
  51172. * Disable the mesh's animation sequence
  51173. */
  51174. disableAnimation?: boolean;
  51175. /**
  51176. * Disable lighting on the material or the ring and arrow
  51177. */
  51178. disableLighting?: boolean;
  51179. /**
  51180. * Override the default material of the torus and arrow
  51181. */
  51182. torusArrowMaterial?: Material;
  51183. };
  51184. /**
  51185. * A list of meshes to use as floor meshes.
  51186. * Meshes can be added and removed after initializing the feature using the
  51187. * addFloorMesh and removeFloorMesh functions
  51188. * If empty, rotation will still work
  51189. */
  51190. floorMeshes?: AbstractMesh[];
  51191. /**
  51192. * use this rendering group id for the meshes (optional)
  51193. */
  51194. renderingGroupId?: number;
  51195. /**
  51196. * Should teleportation move only to snap points
  51197. */
  51198. snapPointsOnly?: boolean;
  51199. /**
  51200. * An array of points to which the teleportation will snap to.
  51201. * If the teleportation ray is in the proximity of one of those points, it will be corrected to this point.
  51202. */
  51203. snapPositions?: Vector3[];
  51204. /**
  51205. * How close should the teleportation ray be in order to snap to position.
  51206. * Default to 0.8 units (meters)
  51207. */
  51208. snapToPositionRadius?: number;
  51209. /**
  51210. * Provide your own teleportation mesh instead of babylon's wonderful doughnut.
  51211. * If you want to support rotation, make sure your mesh has a direction indicator.
  51212. *
  51213. * When left untouched, the default mesh will be initialized.
  51214. */
  51215. teleportationTargetMesh?: AbstractMesh;
  51216. /**
  51217. * If main component is used (no thumbstick), how long should the "long press" take before teleport
  51218. */
  51219. timeToTeleport?: number;
  51220. /**
  51221. * Disable using the thumbstick and use the main component (usually trigger) on long press.
  51222. * This will be automatically true if the controller doesn't have a thumbstick or touchpad.
  51223. */
  51224. useMainComponentOnly?: boolean;
  51225. /**
  51226. * Should meshes created here be added to a utility layer or the main scene
  51227. */
  51228. useUtilityLayer?: boolean;
  51229. /**
  51230. * Babylon XR Input class for controller
  51231. */
  51232. xrInput: WebXRInput;
  51233. }
  51234. /**
  51235. * This is a teleportation feature to be used with WebXR-enabled motion controllers.
  51236. * When enabled and attached, the feature will allow a user to move around and rotate in the scene using
  51237. * the input of the attached controllers.
  51238. */
  51239. export class WebXRMotionControllerTeleportation extends WebXRAbstractFeature {
  51240. private _options;
  51241. private _controllers;
  51242. private _currentTeleportationControllerId;
  51243. private _floorMeshes;
  51244. private _quadraticBezierCurve;
  51245. private _selectionFeature;
  51246. private _snapToPositions;
  51247. private _snappedToPoint;
  51248. private _teleportationRingMaterial?;
  51249. private _tmpRay;
  51250. private _tmpVector;
  51251. /**
  51252. * The module's name
  51253. */
  51254. static readonly Name: string;
  51255. /**
  51256. * The (Babylon) version of this module.
  51257. * This is an integer representing the implementation version.
  51258. * This number does not correspond to the webxr specs version
  51259. */
  51260. static readonly Version: number;
  51261. /**
  51262. * Is movement backwards enabled
  51263. */
  51264. backwardsMovementEnabled: boolean;
  51265. /**
  51266. * Distance to travel when moving backwards
  51267. */
  51268. backwardsTeleportationDistance: number;
  51269. /**
  51270. * The distance from the user to the inspection point in the direction of the controller
  51271. * A higher number will allow the user to move further
  51272. * defaults to 5 (meters, in xr units)
  51273. */
  51274. parabolicCheckRadius: number;
  51275. /**
  51276. * Should the module support parabolic ray on top of direct ray
  51277. * If enabled, the user will be able to point "at the sky" and move according to predefined radius distance
  51278. * Very helpful when moving between floors / different heights
  51279. */
  51280. parabolicRayEnabled: boolean;
  51281. /**
  51282. * How much rotation should be applied when rotating right and left
  51283. */
  51284. rotationAngle: number;
  51285. /**
  51286. * Is rotation enabled when moving forward?
  51287. * Disabling this feature will prevent the user from deciding the direction when teleporting
  51288. */
  51289. rotationEnabled: boolean;
  51290. /**
  51291. * constructs a new anchor system
  51292. * @param _xrSessionManager an instance of WebXRSessionManager
  51293. * @param _options configuration object for this feature
  51294. */
  51295. constructor(_xrSessionManager: WebXRSessionManager, _options: IWebXRTeleportationOptions);
  51296. /**
  51297. * Get the snapPointsOnly flag
  51298. */
  51299. get snapPointsOnly(): boolean;
  51300. /**
  51301. * Sets the snapPointsOnly flag
  51302. * @param snapToPoints should teleportation be exclusively to snap points
  51303. */
  51304. set snapPointsOnly(snapToPoints: boolean);
  51305. /**
  51306. * Add a new mesh to the floor meshes array
  51307. * @param mesh the mesh to use as floor mesh
  51308. */
  51309. addFloorMesh(mesh: AbstractMesh): void;
  51310. /**
  51311. * Add a new snap-to point to fix teleportation to this position
  51312. * @param newSnapPoint The new Snap-To point
  51313. */
  51314. addSnapPoint(newSnapPoint: Vector3): void;
  51315. attach(): boolean;
  51316. detach(): boolean;
  51317. dispose(): void;
  51318. /**
  51319. * Remove a mesh from the floor meshes array
  51320. * @param mesh the mesh to remove
  51321. */
  51322. removeFloorMesh(mesh: AbstractMesh): void;
  51323. /**
  51324. * Remove a mesh from the floor meshes array using its name
  51325. * @param name the mesh name to remove
  51326. */
  51327. removeFloorMeshByName(name: string): void;
  51328. /**
  51329. * 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
  51330. * @param snapPointToRemove the point (or a clone of it) to be removed from the array
  51331. * @returns was the point found and removed or not
  51332. */
  51333. removeSnapPoint(snapPointToRemove: Vector3): boolean;
  51334. /**
  51335. * This function sets a selection feature that will be disabled when
  51336. * the forward ray is shown and will be reattached when hidden.
  51337. * This is used to remove the selection rays when moving.
  51338. * @param selectionFeature the feature to disable when forward movement is enabled
  51339. */
  51340. setSelectionFeature(selectionFeature: IWebXRFeature): void;
  51341. protected _onXRFrame(_xrFrame: XRFrame): void;
  51342. private _attachController;
  51343. private _createDefaultTargetMesh;
  51344. private _detachController;
  51345. private _findClosestSnapPointWithRadius;
  51346. private _setTargetMeshPosition;
  51347. private _setTargetMeshVisibility;
  51348. private _showParabolicPath;
  51349. private _teleportForward;
  51350. }
  51351. }
  51352. declare module "babylonjs/XR/webXRDefaultExperience" {
  51353. import { WebXRExperienceHelper } from "babylonjs/XR/webXRExperienceHelper";
  51354. import { Scene } from "babylonjs/scene";
  51355. import { WebXRInput, IWebXRInputOptions } from "babylonjs/XR/webXRInput";
  51356. import { WebXRControllerPointerSelection } from "babylonjs/XR/features/WebXRControllerPointerSelection";
  51357. import { WebXRRenderTarget } from "babylonjs/XR/webXRTypes";
  51358. import { WebXREnterExitUI, WebXREnterExitUIOptions } from "babylonjs/XR/webXREnterExitUI";
  51359. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  51360. import { WebXRManagedOutputCanvasOptions } from "babylonjs/XR/webXRManagedOutputCanvas";
  51361. import { WebXRMotionControllerTeleportation } from "babylonjs/XR/features/WebXRControllerTeleportation";
  51362. /**
  51363. * Options for the default xr helper
  51364. */
  51365. export class WebXRDefaultExperienceOptions {
  51366. /**
  51367. * Enable or disable default UI to enter XR
  51368. */
  51369. disableDefaultUI?: boolean;
  51370. /**
  51371. * Should teleportation not initialize. defaults to false.
  51372. */
  51373. disableTeleportation?: boolean;
  51374. /**
  51375. * Floor meshes that will be used for teleport
  51376. */
  51377. floorMeshes?: Array<AbstractMesh>;
  51378. /**
  51379. * If set to true, the first frame will not be used to reset position
  51380. * The first frame is mainly used when copying transformation from the old camera
  51381. * Mainly used in AR
  51382. */
  51383. ignoreNativeCameraTransformation?: boolean;
  51384. /**
  51385. * Disable the controller mesh-loading. Can be used if you want to load your own meshes
  51386. */
  51387. inputOptions?: IWebXRInputOptions;
  51388. /**
  51389. * optional configuration for the output canvas
  51390. */
  51391. outputCanvasOptions?: WebXRManagedOutputCanvasOptions;
  51392. /**
  51393. * optional UI options. This can be used among other to change session mode and reference space type
  51394. */
  51395. uiOptions?: WebXREnterExitUIOptions;
  51396. /**
  51397. * When loading teleportation and pointer select, use stable versions instead of latest.
  51398. */
  51399. useStablePlugins?: boolean;
  51400. /**
  51401. * An optional rendering group id that will be set globally for teleportation, pointer selection and default controller meshes
  51402. */
  51403. renderingGroupId?: number;
  51404. /**
  51405. * A list of optional features to init the session with
  51406. * If set to true, all features we support will be added
  51407. */
  51408. optionalFeatures?: boolean | string[];
  51409. }
  51410. /**
  51411. * Default experience which provides a similar setup to the previous webVRExperience
  51412. */
  51413. export class WebXRDefaultExperience {
  51414. /**
  51415. * Base experience
  51416. */
  51417. baseExperience: WebXRExperienceHelper;
  51418. /**
  51419. * Enables ui for entering/exiting xr
  51420. */
  51421. enterExitUI: WebXREnterExitUI;
  51422. /**
  51423. * Input experience extension
  51424. */
  51425. input: WebXRInput;
  51426. /**
  51427. * Enables laser pointer and selection
  51428. */
  51429. pointerSelection: WebXRControllerPointerSelection;
  51430. /**
  51431. * Default target xr should render to
  51432. */
  51433. renderTarget: WebXRRenderTarget;
  51434. /**
  51435. * Enables teleportation
  51436. */
  51437. teleportation: WebXRMotionControllerTeleportation;
  51438. private constructor();
  51439. /**
  51440. * Creates the default xr experience
  51441. * @param scene scene
  51442. * @param options options for basic configuration
  51443. * @returns resulting WebXRDefaultExperience
  51444. */
  51445. static CreateAsync(scene: Scene, options?: WebXRDefaultExperienceOptions): Promise<WebXRDefaultExperience>;
  51446. /**
  51447. * DIsposes of the experience helper
  51448. */
  51449. dispose(): void;
  51450. }
  51451. }
  51452. declare module "babylonjs/Cameras/VR/vrExperienceHelper" {
  51453. import { Observable } from "babylonjs/Misc/observable";
  51454. import { Nullable } from "babylonjs/types";
  51455. import { Camera } from "babylonjs/Cameras/camera";
  51456. import { DeviceOrientationCamera } from "babylonjs/Cameras/deviceOrientationCamera";
  51457. import { VRDeviceOrientationFreeCamera } from "babylonjs/Cameras/VR/vrDeviceOrientationFreeCamera";
  51458. import { WebVROptions, WebVRFreeCamera } from "babylonjs/Cameras/VR/webVRCamera";
  51459. import { Scene } from "babylonjs/scene";
  51460. import { Vector3 } from "babylonjs/Maths/math.vector";
  51461. import { Color3 } from "babylonjs/Maths/math.color";
  51462. import { WebVRController } from "babylonjs/Gamepads/Controllers/webVRController";
  51463. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  51464. import { Mesh } from "babylonjs/Meshes/mesh";
  51465. import { PickingInfo } from "babylonjs/Collisions/pickingInfo";
  51466. import { EasingFunction } from "babylonjs/Animations/easing";
  51467. import { VRCameraMetrics } from "babylonjs/Cameras/VR/vrCameraMetrics";
  51468. import "babylonjs/Meshes/Builders/groundBuilder";
  51469. import "babylonjs/Meshes/Builders/torusBuilder";
  51470. import "babylonjs/Meshes/Builders/cylinderBuilder";
  51471. import "babylonjs/Gamepads/gamepadSceneComponent";
  51472. import "babylonjs/Animations/animatable";
  51473. import { WebXRDefaultExperience } from "babylonjs/XR/webXRDefaultExperience";
  51474. /**
  51475. * Options to modify the vr teleportation behavior.
  51476. */
  51477. export interface VRTeleportationOptions {
  51478. /**
  51479. * The name of the mesh which should be used as the teleportation floor. (default: null)
  51480. */
  51481. floorMeshName?: string;
  51482. /**
  51483. * A list of meshes to be used as the teleportation floor. (default: empty)
  51484. */
  51485. floorMeshes?: Mesh[];
  51486. /**
  51487. * The teleportation mode. (default: TELEPORTATIONMODE_CONSTANTTIME)
  51488. */
  51489. teleportationMode?: number;
  51490. /**
  51491. * The duration of the animation in ms, apply when animationMode is TELEPORTATIONMODE_CONSTANTTIME. (default 122ms)
  51492. */
  51493. teleportationTime?: number;
  51494. /**
  51495. * The speed of the animation in distance/sec, apply when animationMode is TELEPORTATIONMODE_CONSTANTSPEED. (default 20 units / sec)
  51496. */
  51497. teleportationSpeed?: number;
  51498. /**
  51499. * The easing function used in the animation or null for Linear. (default CircleEase)
  51500. */
  51501. easingFunction?: EasingFunction;
  51502. }
  51503. /**
  51504. * Options to modify the vr experience helper's behavior.
  51505. */
  51506. export interface VRExperienceHelperOptions extends WebVROptions {
  51507. /**
  51508. * Create a DeviceOrientationCamera to be used as your out of vr camera. (default: true)
  51509. */
  51510. createDeviceOrientationCamera?: boolean;
  51511. /**
  51512. * Create a VRDeviceOrientationFreeCamera to be used for VR when no external HMD is found. (default: true)
  51513. */
  51514. createFallbackVRDeviceOrientationFreeCamera?: boolean;
  51515. /**
  51516. * Uses the main button on the controller to toggle the laser casted. (default: true)
  51517. */
  51518. laserToggle?: boolean;
  51519. /**
  51520. * A list of meshes to be used as the teleportation floor. If specified, teleportation will be enabled (default: undefined)
  51521. */
  51522. floorMeshes?: Mesh[];
  51523. /**
  51524. * Distortion metrics for the fallback vrDeviceOrientationCamera (default: VRCameraMetrics.Default)
  51525. */
  51526. vrDeviceOrientationCameraMetrics?: VRCameraMetrics;
  51527. /**
  51528. * Defines if WebXR should be used instead of WebVR (if available)
  51529. */
  51530. useXR?: boolean;
  51531. }
  51532. /**
  51533. * Event containing information after VR has been entered
  51534. */
  51535. export class OnAfterEnteringVRObservableEvent {
  51536. /**
  51537. * If entering vr was successful
  51538. */
  51539. success: boolean;
  51540. }
  51541. /**
  51542. * Helps to quickly add VR support to an existing scene.
  51543. * See https://doc.babylonjs.com/how_to/webvr_helper
  51544. */
  51545. export class VRExperienceHelper {
  51546. /** Options to modify the vr experience helper's behavior. */
  51547. webVROptions: VRExperienceHelperOptions;
  51548. private _scene;
  51549. private _position;
  51550. private _btnVR;
  51551. private _btnVRDisplayed;
  51552. private _webVRsupported;
  51553. private _webVRready;
  51554. private _webVRrequesting;
  51555. private _webVRpresenting;
  51556. private _hasEnteredVR;
  51557. private _fullscreenVRpresenting;
  51558. private _inputElement;
  51559. private _webVRCamera;
  51560. private _vrDeviceOrientationCamera;
  51561. private _deviceOrientationCamera;
  51562. private _existingCamera;
  51563. private _onKeyDown;
  51564. private _onVrDisplayPresentChange;
  51565. private _onVRDisplayChanged;
  51566. private _onVRRequestPresentStart;
  51567. private _onVRRequestPresentComplete;
  51568. /**
  51569. * 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)
  51570. */
  51571. enableGazeEvenWhenNoPointerLock: boolean;
  51572. /**
  51573. * Gets or sets a boolean indicating that the VREXperienceHelper will exit VR if double tap is detected
  51574. */
  51575. exitVROnDoubleTap: boolean;
  51576. /**
  51577. * Observable raised right before entering VR.
  51578. */
  51579. onEnteringVRObservable: Observable<VRExperienceHelper>;
  51580. /**
  51581. * Observable raised when entering VR has completed.
  51582. */
  51583. onAfterEnteringVRObservable: Observable<OnAfterEnteringVRObservableEvent>;
  51584. /**
  51585. * Observable raised when exiting VR.
  51586. */
  51587. onExitingVRObservable: Observable<VRExperienceHelper>;
  51588. /**
  51589. * Observable raised when controller mesh is loaded.
  51590. */
  51591. onControllerMeshLoadedObservable: Observable<WebVRController>;
  51592. /** Return this.onEnteringVRObservable
  51593. * Note: This one is for backward compatibility. Please use onEnteringVRObservable directly
  51594. */
  51595. get onEnteringVR(): Observable<VRExperienceHelper>;
  51596. /** Return this.onExitingVRObservable
  51597. * Note: This one is for backward compatibility. Please use onExitingVRObservable directly
  51598. */
  51599. get onExitingVR(): Observable<VRExperienceHelper>;
  51600. /** Return this.onControllerMeshLoadedObservable
  51601. * Note: This one is for backward compatibility. Please use onControllerMeshLoadedObservable directly
  51602. */
  51603. get onControllerMeshLoaded(): Observable<WebVRController>;
  51604. private _rayLength;
  51605. private _useCustomVRButton;
  51606. private _teleportationRequested;
  51607. private _teleportActive;
  51608. private _floorMeshName;
  51609. private _floorMeshesCollection;
  51610. private _teleportationMode;
  51611. private _teleportationTime;
  51612. private _teleportationSpeed;
  51613. private _teleportationEasing;
  51614. private _rotationAllowed;
  51615. private _teleportBackwardsVector;
  51616. private _teleportationTarget;
  51617. private _isDefaultTeleportationTarget;
  51618. private _postProcessMove;
  51619. private _teleportationFillColor;
  51620. private _teleportationBorderColor;
  51621. private _rotationAngle;
  51622. private _haloCenter;
  51623. private _cameraGazer;
  51624. private _padSensibilityUp;
  51625. private _padSensibilityDown;
  51626. private _leftController;
  51627. private _rightController;
  51628. private _gazeColor;
  51629. private _laserColor;
  51630. private _pickedLaserColor;
  51631. private _pickedGazeColor;
  51632. /**
  51633. * Observable raised when a new mesh is selected based on meshSelectionPredicate
  51634. */
  51635. onNewMeshSelected: Observable<AbstractMesh>;
  51636. /**
  51637. * Observable raised when a new mesh is selected based on meshSelectionPredicate.
  51638. * This observable will provide the mesh and the controller used to select the mesh
  51639. */
  51640. onMeshSelectedWithController: Observable<{
  51641. mesh: AbstractMesh;
  51642. controller: WebVRController;
  51643. }>;
  51644. /**
  51645. * Observable raised when a new mesh is picked based on meshSelectionPredicate
  51646. */
  51647. onNewMeshPicked: Observable<PickingInfo>;
  51648. private _circleEase;
  51649. /**
  51650. * Observable raised before camera teleportation
  51651. */
  51652. onBeforeCameraTeleport: Observable<Vector3>;
  51653. /**
  51654. * Observable raised after camera teleportation
  51655. */
  51656. onAfterCameraTeleport: Observable<Vector3>;
  51657. /**
  51658. * Observable raised when current selected mesh gets unselected
  51659. */
  51660. onSelectedMeshUnselected: Observable<AbstractMesh>;
  51661. private _raySelectionPredicate;
  51662. /**
  51663. * To be optionaly changed by user to define custom ray selection
  51664. */
  51665. raySelectionPredicate: (mesh: AbstractMesh) => boolean;
  51666. /**
  51667. * To be optionaly changed by user to define custom selection logic (after ray selection)
  51668. */
  51669. meshSelectionPredicate: (mesh: AbstractMesh) => boolean;
  51670. /**
  51671. * Set teleportation enabled. If set to false camera teleportation will be disabled but camera rotation will be kept.
  51672. */
  51673. teleportationEnabled: boolean;
  51674. private _defaultHeight;
  51675. private _teleportationInitialized;
  51676. private _interactionsEnabled;
  51677. private _interactionsRequested;
  51678. private _displayGaze;
  51679. private _displayLaserPointer;
  51680. /**
  51681. * The mesh used to display where the user is going to teleport.
  51682. */
  51683. get teleportationTarget(): Mesh;
  51684. /**
  51685. * Sets the mesh to be used to display where the user is going to teleport.
  51686. */
  51687. set teleportationTarget(value: Mesh);
  51688. /**
  51689. * 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
  51690. * when set bakeCurrentTransformIntoVertices will be called on the mesh.
  51691. * See https://doc.babylonjs.com/resources/baking_transformations
  51692. */
  51693. get gazeTrackerMesh(): Mesh;
  51694. set gazeTrackerMesh(value: Mesh);
  51695. /**
  51696. * If the gaze trackers scale should be updated to be constant size when pointing at near/far meshes
  51697. */
  51698. updateGazeTrackerScale: boolean;
  51699. /**
  51700. * If the gaze trackers color should be updated when selecting meshes
  51701. */
  51702. updateGazeTrackerColor: boolean;
  51703. /**
  51704. * If the controller laser color should be updated when selecting meshes
  51705. */
  51706. updateControllerLaserColor: boolean;
  51707. /**
  51708. * The gaze tracking mesh corresponding to the left controller
  51709. */
  51710. get leftControllerGazeTrackerMesh(): Nullable<Mesh>;
  51711. /**
  51712. * The gaze tracking mesh corresponding to the right controller
  51713. */
  51714. get rightControllerGazeTrackerMesh(): Nullable<Mesh>;
  51715. /**
  51716. * If the ray of the gaze should be displayed.
  51717. */
  51718. get displayGaze(): boolean;
  51719. /**
  51720. * Sets if the ray of the gaze should be displayed.
  51721. */
  51722. set displayGaze(value: boolean);
  51723. /**
  51724. * If the ray of the LaserPointer should be displayed.
  51725. */
  51726. get displayLaserPointer(): boolean;
  51727. /**
  51728. * Sets if the ray of the LaserPointer should be displayed.
  51729. */
  51730. set displayLaserPointer(value: boolean);
  51731. /**
  51732. * The deviceOrientationCamera used as the camera when not in VR.
  51733. */
  51734. get deviceOrientationCamera(): Nullable<DeviceOrientationCamera>;
  51735. /**
  51736. * Based on the current WebVR support, returns the current VR camera used.
  51737. */
  51738. get currentVRCamera(): Nullable<Camera>;
  51739. /**
  51740. * The webVRCamera which is used when in VR.
  51741. */
  51742. get webVRCamera(): WebVRFreeCamera;
  51743. /**
  51744. * The deviceOrientationCamera that is used as a fallback when vr device is not connected.
  51745. */
  51746. get vrDeviceOrientationCamera(): Nullable<VRDeviceOrientationFreeCamera>;
  51747. /**
  51748. * The html button that is used to trigger entering into VR.
  51749. */
  51750. get vrButton(): Nullable<HTMLButtonElement>;
  51751. private get _teleportationRequestInitiated();
  51752. /**
  51753. * Defines whether or not Pointer lock should be requested when switching to
  51754. * full screen.
  51755. */
  51756. requestPointerLockOnFullScreen: boolean;
  51757. /**
  51758. * If asking to force XR, this will be populated with the default xr experience
  51759. */
  51760. xr: WebXRDefaultExperience;
  51761. /**
  51762. * Was the XR test done already. If this is true AND this.xr exists, xr is initialized.
  51763. * If this is true and no this.xr, xr exists but is not supported, using WebVR.
  51764. */
  51765. xrTestDone: boolean;
  51766. /**
  51767. * Instantiates a VRExperienceHelper.
  51768. * Helps to quickly add VR support to an existing scene.
  51769. * @param scene The scene the VRExperienceHelper belongs to.
  51770. * @param webVROptions Options to modify the vr experience helper's behavior.
  51771. */
  51772. constructor(scene: Scene,
  51773. /** Options to modify the vr experience helper's behavior. */
  51774. webVROptions?: VRExperienceHelperOptions);
  51775. private completeVRInit;
  51776. private _onDefaultMeshLoaded;
  51777. private _onResize;
  51778. private _onFullscreenChange;
  51779. /**
  51780. * Gets a value indicating if we are currently in VR mode.
  51781. */
  51782. get isInVRMode(): boolean;
  51783. private onVrDisplayPresentChange;
  51784. private onVRDisplayChanged;
  51785. private moveButtonToBottomRight;
  51786. private displayVRButton;
  51787. private updateButtonVisibility;
  51788. private _cachedAngularSensibility;
  51789. /**
  51790. * Attempt to enter VR. If a headset is connected and ready, will request present on that.
  51791. * Otherwise, will use the fullscreen API.
  51792. */
  51793. enterVR(): void;
  51794. /**
  51795. * Attempt to exit VR, or fullscreen.
  51796. */
  51797. exitVR(): void;
  51798. /**
  51799. * The position of the vr experience helper.
  51800. */
  51801. get position(): Vector3;
  51802. /**
  51803. * Sets the position of the vr experience helper.
  51804. */
  51805. set position(value: Vector3);
  51806. /**
  51807. * Enables controllers and user interactions such as selecting and object or clicking on an object.
  51808. */
  51809. enableInteractions(): void;
  51810. private get _noControllerIsActive();
  51811. private beforeRender;
  51812. private _isTeleportationFloor;
  51813. /**
  51814. * Adds a floor mesh to be used for teleportation.
  51815. * @param floorMesh the mesh to be used for teleportation.
  51816. */
  51817. addFloorMesh(floorMesh: Mesh): void;
  51818. /**
  51819. * Removes a floor mesh from being used for teleportation.
  51820. * @param floorMesh the mesh to be removed.
  51821. */
  51822. removeFloorMesh(floorMesh: Mesh): void;
  51823. /**
  51824. * Enables interactions and teleportation using the VR controllers and gaze.
  51825. * @param vrTeleportationOptions options to modify teleportation behavior.
  51826. */
  51827. enableTeleportation(vrTeleportationOptions?: VRTeleportationOptions): void;
  51828. private _onNewGamepadConnected;
  51829. private _tryEnableInteractionOnController;
  51830. private _onNewGamepadDisconnected;
  51831. private _enableInteractionOnController;
  51832. private _checkTeleportWithRay;
  51833. private _checkRotate;
  51834. private _checkTeleportBackwards;
  51835. private _enableTeleportationOnController;
  51836. private _createTeleportationCircles;
  51837. private _displayTeleportationTarget;
  51838. private _hideTeleportationTarget;
  51839. private _rotateCamera;
  51840. private _moveTeleportationSelectorTo;
  51841. private _workingVector;
  51842. private _workingQuaternion;
  51843. private _workingMatrix;
  51844. /**
  51845. * Time Constant Teleportation Mode
  51846. */
  51847. static readonly TELEPORTATIONMODE_CONSTANTTIME: number;
  51848. /**
  51849. * Speed Constant Teleportation Mode
  51850. */
  51851. static readonly TELEPORTATIONMODE_CONSTANTSPEED: number;
  51852. /**
  51853. * Teleports the users feet to the desired location
  51854. * @param location The location where the user's feet should be placed
  51855. */
  51856. teleportCamera(location: Vector3): void;
  51857. private _convertNormalToDirectionOfRay;
  51858. private _castRayAndSelectObject;
  51859. private _notifySelectedMeshUnselected;
  51860. /**
  51861. * Permanently set new colors for the laser pointer
  51862. * @param color the new laser color
  51863. * @param pickedColor the new laser color when picked mesh detected
  51864. */
  51865. setLaserColor(color: Color3, pickedColor?: Color3): void;
  51866. /**
  51867. * Set lighting enabled / disabled on the laser pointer of both controllers
  51868. * @param enabled should the lighting be enabled on the laser pointer
  51869. */
  51870. setLaserLightingState(enabled?: boolean): void;
  51871. /**
  51872. * Permanently set new colors for the gaze pointer
  51873. * @param color the new gaze color
  51874. * @param pickedColor the new gaze color when picked mesh detected
  51875. */
  51876. setGazeColor(color: Color3, pickedColor?: Color3): void;
  51877. /**
  51878. * Sets the color of the laser ray from the vr controllers.
  51879. * @param color new color for the ray.
  51880. */
  51881. changeLaserColor(color: Color3): void;
  51882. /**
  51883. * Sets the color of the ray from the vr headsets gaze.
  51884. * @param color new color for the ray.
  51885. */
  51886. changeGazeColor(color: Color3): void;
  51887. /**
  51888. * Exits VR and disposes of the vr experience helper
  51889. */
  51890. dispose(): void;
  51891. /**
  51892. * Gets the name of the VRExperienceHelper class
  51893. * @returns "VRExperienceHelper"
  51894. */
  51895. getClassName(): string;
  51896. }
  51897. }
  51898. declare module "babylonjs/Cameras/VR/index" {
  51899. export * from "babylonjs/Cameras/VR/vrCameraMetrics";
  51900. export * from "babylonjs/Cameras/VR/vrDeviceOrientationArcRotateCamera";
  51901. export * from "babylonjs/Cameras/VR/vrDeviceOrientationFreeCamera";
  51902. export * from "babylonjs/Cameras/VR/vrDeviceOrientationGamepadCamera";
  51903. export * from "babylonjs/Cameras/VR/vrExperienceHelper";
  51904. export * from "babylonjs/Cameras/VR/webVRCamera";
  51905. }
  51906. declare module "babylonjs/Cameras/RigModes/index" {
  51907. export * from "babylonjs/Cameras/RigModes/stereoscopicAnaglyphRigMode";
  51908. export * from "babylonjs/Cameras/RigModes/stereoscopicRigMode";
  51909. export * from "babylonjs/Cameras/RigModes/vrRigMode";
  51910. export * from "babylonjs/Cameras/RigModes/webVRRigMode";
  51911. }
  51912. declare module "babylonjs/Cameras/index" {
  51913. export * from "babylonjs/Cameras/Inputs/index";
  51914. export * from "babylonjs/Cameras/cameraInputsManager";
  51915. export * from "babylonjs/Cameras/camera";
  51916. export * from "babylonjs/Cameras/targetCamera";
  51917. export * from "babylonjs/Cameras/freeCamera";
  51918. export * from "babylonjs/Cameras/freeCameraInputsManager";
  51919. export * from "babylonjs/Cameras/touchCamera";
  51920. export * from "babylonjs/Cameras/arcRotateCamera";
  51921. export * from "babylonjs/Cameras/arcRotateCameraInputsManager";
  51922. export * from "babylonjs/Cameras/deviceOrientationCamera";
  51923. export * from "babylonjs/Cameras/flyCamera";
  51924. export * from "babylonjs/Cameras/flyCameraInputsManager";
  51925. export * from "babylonjs/Cameras/followCamera";
  51926. export * from "babylonjs/Cameras/followCameraInputsManager";
  51927. export * from "babylonjs/Cameras/gamepadCamera";
  51928. export * from "babylonjs/Cameras/Stereoscopic/index";
  51929. export * from "babylonjs/Cameras/universalCamera";
  51930. export * from "babylonjs/Cameras/virtualJoysticksCamera";
  51931. export * from "babylonjs/Cameras/VR/index";
  51932. export * from "babylonjs/Cameras/RigModes/index";
  51933. }
  51934. declare module "babylonjs/Collisions/index" {
  51935. export * from "babylonjs/Collisions/collider";
  51936. export * from "babylonjs/Collisions/collisionCoordinator";
  51937. export * from "babylonjs/Collisions/pickingInfo";
  51938. export * from "babylonjs/Collisions/intersectionInfo";
  51939. export * from "babylonjs/Collisions/meshCollisionData";
  51940. }
  51941. declare module "babylonjs/Culling/Octrees/octreeBlock" {
  51942. import { SmartArrayNoDuplicate } from "babylonjs/Misc/smartArray";
  51943. import { Vector3 } from "babylonjs/Maths/math.vector";
  51944. import { Ray } from "babylonjs/Culling/ray";
  51945. import { Plane } from "babylonjs/Maths/math.plane";
  51946. /**
  51947. * Contains an array of blocks representing the octree
  51948. */
  51949. export interface IOctreeContainer<T> {
  51950. /**
  51951. * Blocks within the octree
  51952. */
  51953. blocks: Array<OctreeBlock<T>>;
  51954. }
  51955. /**
  51956. * Class used to store a cell in an octree
  51957. * @see https://doc.babylonjs.com/how_to/optimizing_your_scene_with_octrees
  51958. */
  51959. export class OctreeBlock<T> {
  51960. /**
  51961. * Gets the content of the current block
  51962. */
  51963. entries: T[];
  51964. /**
  51965. * Gets the list of block children
  51966. */
  51967. blocks: Array<OctreeBlock<T>>;
  51968. private _depth;
  51969. private _maxDepth;
  51970. private _capacity;
  51971. private _minPoint;
  51972. private _maxPoint;
  51973. private _boundingVectors;
  51974. private _creationFunc;
  51975. /**
  51976. * Creates a new block
  51977. * @param minPoint defines the minimum vector (in world space) of the block's bounding box
  51978. * @param maxPoint defines the maximum vector (in world space) of the block's bounding box
  51979. * @param capacity defines the maximum capacity of this block (if capacity is reached the block will be split into sub blocks)
  51980. * @param depth defines the current depth of this block in the octree
  51981. * @param maxDepth defines the maximal depth allowed (beyond this value, the capacity is ignored)
  51982. * @param creationFunc defines a callback to call when an element is added to the block
  51983. */
  51984. constructor(minPoint: Vector3, maxPoint: Vector3, capacity: number, depth: number, maxDepth: number, creationFunc: (entry: T, block: OctreeBlock<T>) => void);
  51985. /**
  51986. * Gets the maximum capacity of this block (if capacity is reached the block will be split into sub blocks)
  51987. */
  51988. get capacity(): number;
  51989. /**
  51990. * Gets the minimum vector (in world space) of the block's bounding box
  51991. */
  51992. get minPoint(): Vector3;
  51993. /**
  51994. * Gets the maximum vector (in world space) of the block's bounding box
  51995. */
  51996. get maxPoint(): Vector3;
  51997. /**
  51998. * Add a new element to this block
  51999. * @param entry defines the element to add
  52000. */
  52001. addEntry(entry: T): void;
  52002. /**
  52003. * Remove an element from this block
  52004. * @param entry defines the element to remove
  52005. */
  52006. removeEntry(entry: T): void;
  52007. /**
  52008. * Add an array of elements to this block
  52009. * @param entries defines the array of elements to add
  52010. */
  52011. addEntries(entries: T[]): void;
  52012. /**
  52013. * Test if the current block intersects the furstum planes and if yes, then add its content to the selection array
  52014. * @param frustumPlanes defines the frustum planes to test
  52015. * @param selection defines the array to store current content if selection is positive
  52016. * @param allowDuplicate defines if the selection array can contains duplicated entries
  52017. */
  52018. select(frustumPlanes: Plane[], selection: SmartArrayNoDuplicate<T>, allowDuplicate?: boolean): void;
  52019. /**
  52020. * Test if the current block intersect with the given bounding sphere and if yes, then add its content to the selection array
  52021. * @param sphereCenter defines the bounding sphere center
  52022. * @param sphereRadius defines the bounding sphere radius
  52023. * @param selection defines the array to store current content if selection is positive
  52024. * @param allowDuplicate defines if the selection array can contains duplicated entries
  52025. */
  52026. intersects(sphereCenter: Vector3, sphereRadius: number, selection: SmartArrayNoDuplicate<T>, allowDuplicate?: boolean): void;
  52027. /**
  52028. * Test if the current block intersect with the given ray and if yes, then add its content to the selection array
  52029. * @param ray defines the ray to test with
  52030. * @param selection defines the array to store current content if selection is positive
  52031. */
  52032. intersectsRay(ray: Ray, selection: SmartArrayNoDuplicate<T>): void;
  52033. /**
  52034. * Subdivide the content into child blocks (this block will then be empty)
  52035. */
  52036. createInnerBlocks(): void;
  52037. /**
  52038. * @hidden
  52039. */
  52040. 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;
  52041. }
  52042. }
  52043. declare module "babylonjs/Culling/Octrees/octree" {
  52044. import { SmartArray } from "babylonjs/Misc/smartArray";
  52045. import { Vector3 } from "babylonjs/Maths/math.vector";
  52046. import { SubMesh } from "babylonjs/Meshes/subMesh";
  52047. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  52048. import { Ray } from "babylonjs/Culling/ray";
  52049. import { OctreeBlock } from "babylonjs/Culling/Octrees/octreeBlock";
  52050. import { Plane } from "babylonjs/Maths/math.plane";
  52051. /**
  52052. * Octrees are a really powerful data structure that can quickly select entities based on space coordinates.
  52053. * @see https://doc.babylonjs.com/how_to/optimizing_your_scene_with_octrees
  52054. */
  52055. export class Octree<T> {
  52056. /** 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.) */
  52057. maxDepth: number;
  52058. /**
  52059. * Blocks within the octree containing objects
  52060. */
  52061. blocks: Array<OctreeBlock<T>>;
  52062. /**
  52063. * Content stored in the octree
  52064. */
  52065. dynamicContent: T[];
  52066. private _maxBlockCapacity;
  52067. private _selectionContent;
  52068. private _creationFunc;
  52069. /**
  52070. * Creates a octree
  52071. * @see https://doc.babylonjs.com/how_to/optimizing_your_scene_with_octrees
  52072. * @param creationFunc function to be used to instatiate the octree
  52073. * @param maxBlockCapacity defines the maximum number of meshes you want on your octree's leaves (default: 64)
  52074. * @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.)
  52075. */
  52076. constructor(creationFunc: (entry: T, block: OctreeBlock<T>) => void, maxBlockCapacity?: number,
  52077. /** 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.) */
  52078. maxDepth?: number);
  52079. /**
  52080. * Updates the octree by adding blocks for the passed in meshes within the min and max world parameters
  52081. * @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);
  52082. * @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);
  52083. * @param entries meshes to be added to the octree blocks
  52084. */
  52085. update(worldMin: Vector3, worldMax: Vector3, entries: T[]): void;
  52086. /**
  52087. * Adds a mesh to the octree
  52088. * @param entry Mesh to add to the octree
  52089. */
  52090. addMesh(entry: T): void;
  52091. /**
  52092. * Remove an element from the octree
  52093. * @param entry defines the element to remove
  52094. */
  52095. removeMesh(entry: T): void;
  52096. /**
  52097. * Selects an array of meshes within the frustum
  52098. * @param frustumPlanes The frustum planes to use which will select all meshes within it
  52099. * @param allowDuplicate If duplicate objects are allowed in the resulting object array
  52100. * @returns array of meshes within the frustum
  52101. */
  52102. select(frustumPlanes: Plane[], allowDuplicate?: boolean): SmartArray<T>;
  52103. /**
  52104. * Test if the octree intersect with the given bounding sphere and if yes, then add its content to the selection array
  52105. * @param sphereCenter defines the bounding sphere center
  52106. * @param sphereRadius defines the bounding sphere radius
  52107. * @param allowDuplicate defines if the selection array can contains duplicated entries
  52108. * @returns an array of objects that intersect the sphere
  52109. */
  52110. intersects(sphereCenter: Vector3, sphereRadius: number, allowDuplicate?: boolean): SmartArray<T>;
  52111. /**
  52112. * Test if the octree intersect with the given ray and if yes, then add its content to resulting array
  52113. * @param ray defines the ray to test with
  52114. * @returns array of intersected objects
  52115. */
  52116. intersectsRay(ray: Ray): SmartArray<T>;
  52117. /**
  52118. * Adds a mesh into the octree block if it intersects the block
  52119. */
  52120. static CreationFuncForMeshes: (entry: AbstractMesh, block: OctreeBlock<AbstractMesh>) => void;
  52121. /**
  52122. * Adds a submesh into the octree block if it intersects the block
  52123. */
  52124. static CreationFuncForSubMeshes: (entry: SubMesh, block: OctreeBlock<SubMesh>) => void;
  52125. }
  52126. }
  52127. declare module "babylonjs/Culling/Octrees/octreeSceneComponent" {
  52128. import { ISmartArrayLike } from "babylonjs/Misc/smartArray";
  52129. import { Scene } from "babylonjs/scene";
  52130. import { SubMesh } from "babylonjs/Meshes/subMesh";
  52131. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  52132. import { Ray } from "babylonjs/Culling/ray";
  52133. import { Octree } from "babylonjs/Culling/Octrees/octree";
  52134. import { Collider } from "babylonjs/Collisions/collider";
  52135. module "babylonjs/scene" {
  52136. interface Scene {
  52137. /**
  52138. * @hidden
  52139. * Backing Filed
  52140. */
  52141. _selectionOctree: Octree<AbstractMesh>;
  52142. /**
  52143. * Gets the octree used to boost mesh selection (picking)
  52144. * @see https://doc.babylonjs.com/how_to/optimizing_your_scene_with_octrees
  52145. */
  52146. selectionOctree: Octree<AbstractMesh>;
  52147. /**
  52148. * Creates or updates the octree used to boost selection (picking)
  52149. * @see https://doc.babylonjs.com/how_to/optimizing_your_scene_with_octrees
  52150. * @param maxCapacity defines the maximum capacity per leaf
  52151. * @param maxDepth defines the maximum depth of the octree
  52152. * @returns an octree of AbstractMesh
  52153. */
  52154. createOrUpdateSelectionOctree(maxCapacity?: number, maxDepth?: number): Octree<AbstractMesh>;
  52155. }
  52156. }
  52157. module "babylonjs/Meshes/abstractMesh" {
  52158. interface AbstractMesh {
  52159. /**
  52160. * @hidden
  52161. * Backing Field
  52162. */
  52163. _submeshesOctree: Octree<SubMesh>;
  52164. /**
  52165. * This function will create an octree to help to select the right submeshes for rendering, picking and collision computations.
  52166. * Please note that you must have a decent number of submeshes to get performance improvements when using an octree
  52167. * @param maxCapacity defines the maximum size of each block (64 by default)
  52168. * @param maxDepth defines the maximum depth to use (no more than 2 levels by default)
  52169. * @returns the new octree
  52170. * @see https://www.babylonjs-playground.com/#NA4OQ#12
  52171. * @see https://doc.babylonjs.com/how_to/optimizing_your_scene_with_octrees
  52172. */
  52173. createOrUpdateSubmeshesOctree(maxCapacity?: number, maxDepth?: number): Octree<SubMesh>;
  52174. }
  52175. }
  52176. /**
  52177. * Defines the octree scene component responsible to manage any octrees
  52178. * in a given scene.
  52179. */
  52180. export class OctreeSceneComponent {
  52181. /**
  52182. * The component name help to identify the component in the list of scene components.
  52183. */
  52184. readonly name: string;
  52185. /**
  52186. * The scene the component belongs to.
  52187. */
  52188. scene: Scene;
  52189. /**
  52190. * Indicates if the meshes have been checked to make sure they are isEnabled()
  52191. */
  52192. readonly checksIsEnabled: boolean;
  52193. /**
  52194. * Creates a new instance of the component for the given scene
  52195. * @param scene Defines the scene to register the component in
  52196. */
  52197. constructor(scene: Scene);
  52198. /**
  52199. * Registers the component in a given scene
  52200. */
  52201. register(): void;
  52202. /**
  52203. * Return the list of active meshes
  52204. * @returns the list of active meshes
  52205. */
  52206. getActiveMeshCandidates(): ISmartArrayLike<AbstractMesh>;
  52207. /**
  52208. * Return the list of active sub meshes
  52209. * @param mesh The mesh to get the candidates sub meshes from
  52210. * @returns the list of active sub meshes
  52211. */
  52212. getActiveSubMeshCandidates(mesh: AbstractMesh): ISmartArrayLike<SubMesh>;
  52213. private _tempRay;
  52214. /**
  52215. * Return the list of sub meshes intersecting with a given local ray
  52216. * @param mesh defines the mesh to find the submesh for
  52217. * @param localRay defines the ray in local space
  52218. * @returns the list of intersecting sub meshes
  52219. */
  52220. getIntersectingSubMeshCandidates(mesh: AbstractMesh, localRay: Ray): ISmartArrayLike<SubMesh>;
  52221. /**
  52222. * Return the list of sub meshes colliding with a collider
  52223. * @param mesh defines the mesh to find the submesh for
  52224. * @param collider defines the collider to evaluate the collision against
  52225. * @returns the list of colliding sub meshes
  52226. */
  52227. getCollidingSubMeshCandidates(mesh: AbstractMesh, collider: Collider): ISmartArrayLike<SubMesh>;
  52228. /**
  52229. * Rebuilds the elements related to this component in case of
  52230. * context lost for instance.
  52231. */
  52232. rebuild(): void;
  52233. /**
  52234. * Disposes the component and the associated ressources.
  52235. */
  52236. dispose(): void;
  52237. }
  52238. }
  52239. declare module "babylonjs/Culling/Octrees/index" {
  52240. export * from "babylonjs/Culling/Octrees/octree";
  52241. export * from "babylonjs/Culling/Octrees/octreeBlock";
  52242. export * from "babylonjs/Culling/Octrees/octreeSceneComponent";
  52243. }
  52244. declare module "babylonjs/Culling/index" {
  52245. export * from "babylonjs/Culling/boundingBox";
  52246. export * from "babylonjs/Culling/boundingInfo";
  52247. export * from "babylonjs/Culling/boundingSphere";
  52248. export * from "babylonjs/Culling/Octrees/index";
  52249. export * from "babylonjs/Culling/ray";
  52250. }
  52251. declare module "babylonjs/Gizmos/gizmo" {
  52252. import { Nullable } from "babylonjs/types";
  52253. import { IDisposable } from "babylonjs/scene";
  52254. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  52255. import { Mesh } from "babylonjs/Meshes/mesh";
  52256. import { Node } from "babylonjs/node";
  52257. import { UtilityLayerRenderer } from "babylonjs/Rendering/utilityLayerRenderer";
  52258. /**
  52259. * Renders gizmos on top of an existing scene which provide controls for position, rotation, etc.
  52260. */
  52261. export class Gizmo implements IDisposable {
  52262. /** The utility layer the gizmo will be added to */
  52263. gizmoLayer: UtilityLayerRenderer;
  52264. /**
  52265. * The root mesh of the gizmo
  52266. */
  52267. _rootMesh: Mesh;
  52268. private _attachedMesh;
  52269. private _attachedNode;
  52270. /**
  52271. * Ratio for the scale of the gizmo (Default: 1)
  52272. */
  52273. protected _scaleRatio: number;
  52274. /**
  52275. * Ratio for the scale of the gizmo (Default: 1)
  52276. */
  52277. set scaleRatio(value: number);
  52278. get scaleRatio(): number;
  52279. /**
  52280. * If a custom mesh has been set (Default: false)
  52281. */
  52282. protected _customMeshSet: boolean;
  52283. /**
  52284. * Mesh that the gizmo will be attached to. (eg. on a drag gizmo the mesh that will be dragged)
  52285. * * When set, interactions will be enabled
  52286. */
  52287. get attachedMesh(): Nullable<AbstractMesh>;
  52288. set attachedMesh(value: Nullable<AbstractMesh>);
  52289. /**
  52290. * Node that the gizmo will be attached to. (eg. on a drag gizmo the mesh, bone or NodeTransform that will be dragged)
  52291. * * When set, interactions will be enabled
  52292. */
  52293. get attachedNode(): Nullable<Node>;
  52294. set attachedNode(value: Nullable<Node>);
  52295. /**
  52296. * Disposes and replaces the current meshes in the gizmo with the specified mesh
  52297. * @param mesh The mesh to replace the default mesh of the gizmo
  52298. */
  52299. setCustomMesh(mesh: Mesh): void;
  52300. protected _updateGizmoRotationToMatchAttachedMesh: boolean;
  52301. /**
  52302. * If set the gizmo's rotation will be updated to match the attached mesh each frame (Default: true)
  52303. */
  52304. set updateGizmoRotationToMatchAttachedMesh(value: boolean);
  52305. get updateGizmoRotationToMatchAttachedMesh(): boolean;
  52306. /**
  52307. * If set the gizmo's position will be updated to match the attached mesh each frame (Default: true)
  52308. */
  52309. updateGizmoPositionToMatchAttachedMesh: boolean;
  52310. /**
  52311. * When set, the gizmo will always appear the same size no matter where the camera is (default: true)
  52312. */
  52313. updateScale: boolean;
  52314. protected _interactionsEnabled: boolean;
  52315. protected _attachedNodeChanged(value: Nullable<Node>): void;
  52316. private _beforeRenderObserver;
  52317. private _tempQuaternion;
  52318. private _tempVector;
  52319. private _tempVector2;
  52320. /**
  52321. * Creates a gizmo
  52322. * @param gizmoLayer The utility layer the gizmo will be added to
  52323. */
  52324. constructor(
  52325. /** The utility layer the gizmo will be added to */
  52326. gizmoLayer?: UtilityLayerRenderer);
  52327. /**
  52328. * Updates the gizmo to match the attached mesh's position/rotation
  52329. */
  52330. protected _update(): void;
  52331. /**
  52332. * computes the rotation/scaling/position of the transform once the Node world matrix has changed.
  52333. * @param value Node, TransformNode or mesh
  52334. */
  52335. protected _matrixChanged(): void;
  52336. /**
  52337. * Disposes of the gizmo
  52338. */
  52339. dispose(): void;
  52340. }
  52341. }
  52342. declare module "babylonjs/Gizmos/planeDragGizmo" {
  52343. import { Observable } from "babylonjs/Misc/observable";
  52344. import { Nullable } from "babylonjs/types";
  52345. import { Vector3 } from "babylonjs/Maths/math.vector";
  52346. import { Color3 } from "babylonjs/Maths/math.color";
  52347. import { TransformNode } from "babylonjs/Meshes/transformNode";
  52348. import { Node } from "babylonjs/node";
  52349. import { PointerDragBehavior } from "babylonjs/Behaviors/Meshes/pointerDragBehavior";
  52350. import { Gizmo } from "babylonjs/Gizmos/gizmo";
  52351. import { UtilityLayerRenderer } from "babylonjs/Rendering/utilityLayerRenderer";
  52352. import { StandardMaterial } from "babylonjs/Materials/standardMaterial";
  52353. import { Scene } from "babylonjs/scene";
  52354. import { PositionGizmo } from "babylonjs/Gizmos/positionGizmo";
  52355. /**
  52356. * Single plane drag gizmo
  52357. */
  52358. export class PlaneDragGizmo extends Gizmo {
  52359. /**
  52360. * Drag behavior responsible for the gizmos dragging interactions
  52361. */
  52362. dragBehavior: PointerDragBehavior;
  52363. private _pointerObserver;
  52364. /**
  52365. * Drag distance in babylon units that the gizmo will snap to when dragged (Default: 0)
  52366. */
  52367. snapDistance: number;
  52368. /**
  52369. * Event that fires each time the gizmo snaps to a new location.
  52370. * * snapDistance is the the change in distance
  52371. */
  52372. onSnapObservable: Observable<{
  52373. snapDistance: number;
  52374. }>;
  52375. private _plane;
  52376. private _coloredMaterial;
  52377. private _hoverMaterial;
  52378. private _isEnabled;
  52379. private _parent;
  52380. /** @hidden */
  52381. static _CreatePlane(scene: Scene, material: StandardMaterial): TransformNode;
  52382. /** @hidden */
  52383. static _CreateArrowInstance(scene: Scene, arrow: TransformNode): TransformNode;
  52384. /**
  52385. * Creates a PlaneDragGizmo
  52386. * @param gizmoLayer The utility layer the gizmo will be added to
  52387. * @param dragPlaneNormal The axis normal to which the gizmo will be able to drag on
  52388. * @param color The color of the gizmo
  52389. */
  52390. constructor(dragPlaneNormal: Vector3, color?: Color3, gizmoLayer?: UtilityLayerRenderer, parent?: Nullable<PositionGizmo>);
  52391. protected _attachedNodeChanged(value: Nullable<Node>): void;
  52392. /**
  52393. * If the gizmo is enabled
  52394. */
  52395. set isEnabled(value: boolean);
  52396. get isEnabled(): boolean;
  52397. /**
  52398. * Disposes of the gizmo
  52399. */
  52400. dispose(): void;
  52401. }
  52402. }
  52403. declare module "babylonjs/Gizmos/positionGizmo" {
  52404. import { Observable } from "babylonjs/Misc/observable";
  52405. import { Nullable } from "babylonjs/types";
  52406. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  52407. import { Node } from "babylonjs/node";
  52408. import { Mesh } from "babylonjs/Meshes/mesh";
  52409. import { Gizmo } from "babylonjs/Gizmos/gizmo";
  52410. import { AxisDragGizmo } from "babylonjs/Gizmos/axisDragGizmo";
  52411. import { PlaneDragGizmo } from "babylonjs/Gizmos/planeDragGizmo";
  52412. import { UtilityLayerRenderer } from "babylonjs/Rendering/utilityLayerRenderer";
  52413. /**
  52414. * Gizmo that enables dragging a mesh along 3 axis
  52415. */
  52416. export class PositionGizmo extends Gizmo {
  52417. /**
  52418. * Internal gizmo used for interactions on the x axis
  52419. */
  52420. xGizmo: AxisDragGizmo;
  52421. /**
  52422. * Internal gizmo used for interactions on the y axis
  52423. */
  52424. yGizmo: AxisDragGizmo;
  52425. /**
  52426. * Internal gizmo used for interactions on the z axis
  52427. */
  52428. zGizmo: AxisDragGizmo;
  52429. /**
  52430. * Internal gizmo used for interactions on the yz plane
  52431. */
  52432. xPlaneGizmo: PlaneDragGizmo;
  52433. /**
  52434. * Internal gizmo used for interactions on the xz plane
  52435. */
  52436. yPlaneGizmo: PlaneDragGizmo;
  52437. /**
  52438. * Internal gizmo used for interactions on the xy plane
  52439. */
  52440. zPlaneGizmo: PlaneDragGizmo;
  52441. /**
  52442. * private variables
  52443. */
  52444. private _meshAttached;
  52445. private _nodeAttached;
  52446. private _snapDistance;
  52447. /** Fires an event when any of it's sub gizmos are dragged */
  52448. onDragStartObservable: Observable<unknown>;
  52449. /** Fires an event when any of it's sub gizmos are released from dragging */
  52450. onDragEndObservable: Observable<unknown>;
  52451. /**
  52452. * If set to true, planar drag is enabled
  52453. */
  52454. private _planarGizmoEnabled;
  52455. get attachedMesh(): Nullable<AbstractMesh>;
  52456. set attachedMesh(mesh: Nullable<AbstractMesh>);
  52457. get attachedNode(): Nullable<Node>;
  52458. set attachedNode(node: Nullable<Node>);
  52459. /**
  52460. * Creates a PositionGizmo
  52461. * @param gizmoLayer The utility layer the gizmo will be added to
  52462. @param thickness display gizmo axis thickness
  52463. */
  52464. constructor(gizmoLayer?: UtilityLayerRenderer, thickness?: number);
  52465. /**
  52466. * If the planar drag gizmo is enabled
  52467. * setting this will enable/disable XY, XZ and YZ planes regardless of individual gizmo settings.
  52468. */
  52469. set planarGizmoEnabled(value: boolean);
  52470. get planarGizmoEnabled(): boolean;
  52471. set updateGizmoRotationToMatchAttachedMesh(value: boolean);
  52472. get updateGizmoRotationToMatchAttachedMesh(): boolean;
  52473. /**
  52474. * Drag distance in babylon units that the gizmo will snap to when dragged (Default: 0)
  52475. */
  52476. set snapDistance(value: number);
  52477. get snapDistance(): number;
  52478. /**
  52479. * Ratio for the scale of the gizmo (Default: 1)
  52480. */
  52481. set scaleRatio(value: number);
  52482. get scaleRatio(): number;
  52483. /**
  52484. * Disposes of the gizmo
  52485. */
  52486. dispose(): void;
  52487. /**
  52488. * CustomMeshes are not supported by this gizmo
  52489. * @param mesh The mesh to replace the default mesh of the gizmo
  52490. */
  52491. setCustomMesh(mesh: Mesh): void;
  52492. }
  52493. }
  52494. declare module "babylonjs/Gizmos/axisDragGizmo" {
  52495. import { Observable } from "babylonjs/Misc/observable";
  52496. import { Nullable } from "babylonjs/types";
  52497. import { Vector3 } from "babylonjs/Maths/math.vector";
  52498. import { TransformNode } from "babylonjs/Meshes/transformNode";
  52499. import { Node } from "babylonjs/node";
  52500. import { PointerDragBehavior } from "babylonjs/Behaviors/Meshes/pointerDragBehavior";
  52501. import { Gizmo } from "babylonjs/Gizmos/gizmo";
  52502. import { UtilityLayerRenderer } from "babylonjs/Rendering/utilityLayerRenderer";
  52503. import { StandardMaterial } from "babylonjs/Materials/standardMaterial";
  52504. import { Scene } from "babylonjs/scene";
  52505. import { PositionGizmo } from "babylonjs/Gizmos/positionGizmo";
  52506. import { Color3 } from "babylonjs/Maths/math.color";
  52507. /**
  52508. * Single axis drag gizmo
  52509. */
  52510. export class AxisDragGizmo extends Gizmo {
  52511. /**
  52512. * Drag behavior responsible for the gizmos dragging interactions
  52513. */
  52514. dragBehavior: PointerDragBehavior;
  52515. private _pointerObserver;
  52516. /**
  52517. * Drag distance in babylon units that the gizmo will snap to when dragged (Default: 0)
  52518. */
  52519. snapDistance: number;
  52520. /**
  52521. * Event that fires each time the gizmo snaps to a new location.
  52522. * * snapDistance is the the change in distance
  52523. */
  52524. onSnapObservable: Observable<{
  52525. snapDistance: number;
  52526. }>;
  52527. private _isEnabled;
  52528. private _parent;
  52529. private _arrow;
  52530. private _coloredMaterial;
  52531. private _hoverMaterial;
  52532. /** @hidden */
  52533. static _CreateArrow(scene: Scene, material: StandardMaterial, thickness?: number): TransformNode;
  52534. /** @hidden */
  52535. static _CreateArrowInstance(scene: Scene, arrow: TransformNode): TransformNode;
  52536. /**
  52537. * Creates an AxisDragGizmo
  52538. * @param gizmoLayer The utility layer the gizmo will be added to
  52539. * @param dragAxis The axis which the gizmo will be able to drag on
  52540. * @param color The color of the gizmo
  52541. * @param thickness display gizmo axis thickness
  52542. */
  52543. constructor(dragAxis: Vector3, color?: Color3, gizmoLayer?: UtilityLayerRenderer, parent?: Nullable<PositionGizmo>, thickness?: number);
  52544. protected _attachedNodeChanged(value: Nullable<Node>): void;
  52545. /**
  52546. * If the gizmo is enabled
  52547. */
  52548. set isEnabled(value: boolean);
  52549. get isEnabled(): boolean;
  52550. /**
  52551. * Disposes of the gizmo
  52552. */
  52553. dispose(): void;
  52554. }
  52555. }
  52556. declare module "babylonjs/Debug/axesViewer" {
  52557. import { Vector3 } from "babylonjs/Maths/math.vector";
  52558. import { Nullable } from "babylonjs/types";
  52559. import { Scene } from "babylonjs/scene";
  52560. import { TransformNode } from "babylonjs/Meshes/transformNode";
  52561. /**
  52562. * The Axes viewer will show 3 axes in a specific point in space
  52563. */
  52564. export class AxesViewer {
  52565. private _xAxis;
  52566. private _yAxis;
  52567. private _zAxis;
  52568. private _scaleLinesFactor;
  52569. private _instanced;
  52570. /**
  52571. * Gets the hosting scene
  52572. */
  52573. scene: Nullable<Scene>;
  52574. /**
  52575. * Gets or sets a number used to scale line length
  52576. */
  52577. scaleLines: number;
  52578. /** Gets the node hierarchy used to render x-axis */
  52579. get xAxis(): TransformNode;
  52580. /** Gets the node hierarchy used to render y-axis */
  52581. get yAxis(): TransformNode;
  52582. /** Gets the node hierarchy used to render z-axis */
  52583. get zAxis(): TransformNode;
  52584. /**
  52585. * Creates a new AxesViewer
  52586. * @param scene defines the hosting scene
  52587. * @param scaleLines defines a number used to scale line length (1 by default)
  52588. * @param renderingGroupId defines a number used to set the renderingGroupId of the meshes (2 by default)
  52589. * @param xAxis defines the node hierarchy used to render the x-axis
  52590. * @param yAxis defines the node hierarchy used to render the y-axis
  52591. * @param zAxis defines the node hierarchy used to render the z-axis
  52592. */
  52593. constructor(scene: Scene, scaleLines?: number, renderingGroupId?: Nullable<number>, xAxis?: TransformNode, yAxis?: TransformNode, zAxis?: TransformNode);
  52594. /**
  52595. * Force the viewer to update
  52596. * @param position defines the position of the viewer
  52597. * @param xaxis defines the x axis of the viewer
  52598. * @param yaxis defines the y axis of the viewer
  52599. * @param zaxis defines the z axis of the viewer
  52600. */
  52601. update(position: Vector3, xaxis: Vector3, yaxis: Vector3, zaxis: Vector3): void;
  52602. /**
  52603. * Creates an instance of this axes viewer.
  52604. * @returns a new axes viewer with instanced meshes
  52605. */
  52606. createInstance(): AxesViewer;
  52607. /** Releases resources */
  52608. dispose(): void;
  52609. private static _SetRenderingGroupId;
  52610. }
  52611. }
  52612. declare module "babylonjs/Debug/boneAxesViewer" {
  52613. import { Nullable } from "babylonjs/types";
  52614. import { AxesViewer } from "babylonjs/Debug/axesViewer";
  52615. import { Vector3 } from "babylonjs/Maths/math.vector";
  52616. import { Mesh } from "babylonjs/Meshes/mesh";
  52617. import { Bone } from "babylonjs/Bones/bone";
  52618. import { Scene } from "babylonjs/scene";
  52619. /**
  52620. * The BoneAxesViewer will attach 3 axes to a specific bone of a specific mesh
  52621. * @see demo here: https://www.babylonjs-playground.com/#0DE8F4#8
  52622. */
  52623. export class BoneAxesViewer extends AxesViewer {
  52624. /**
  52625. * Gets or sets the target mesh where to display the axes viewer
  52626. */
  52627. mesh: Nullable<Mesh>;
  52628. /**
  52629. * Gets or sets the target bone where to display the axes viewer
  52630. */
  52631. bone: Nullable<Bone>;
  52632. /** Gets current position */
  52633. pos: Vector3;
  52634. /** Gets direction of X axis */
  52635. xaxis: Vector3;
  52636. /** Gets direction of Y axis */
  52637. yaxis: Vector3;
  52638. /** Gets direction of Z axis */
  52639. zaxis: Vector3;
  52640. /**
  52641. * Creates a new BoneAxesViewer
  52642. * @param scene defines the hosting scene
  52643. * @param bone defines the target bone
  52644. * @param mesh defines the target mesh
  52645. * @param scaleLines defines a scaling factor for line length (1 by default)
  52646. */
  52647. constructor(scene: Scene, bone: Bone, mesh: Mesh, scaleLines?: number);
  52648. /**
  52649. * Force the viewer to update
  52650. */
  52651. update(): void;
  52652. /** Releases resources */
  52653. dispose(): void;
  52654. }
  52655. }
  52656. declare module "babylonjs/Debug/debugLayer" {
  52657. import { Scene } from "babylonjs/scene";
  52658. /**
  52659. * Interface used to define scene explorer extensibility option
  52660. */
  52661. export interface IExplorerExtensibilityOption {
  52662. /**
  52663. * Define the option label
  52664. */
  52665. label: string;
  52666. /**
  52667. * Defines the action to execute on click
  52668. */
  52669. action: (entity: any) => void;
  52670. }
  52671. /**
  52672. * Defines a group of actions associated with a predicate to use when extending the Inspector scene explorer
  52673. */
  52674. export interface IExplorerExtensibilityGroup {
  52675. /**
  52676. * Defines a predicate to test if a given type mut be extended
  52677. */
  52678. predicate: (entity: any) => boolean;
  52679. /**
  52680. * Gets the list of options added to a type
  52681. */
  52682. entries: IExplorerExtensibilityOption[];
  52683. }
  52684. /**
  52685. * Interface used to define the options to use to create the Inspector
  52686. */
  52687. export interface IInspectorOptions {
  52688. /**
  52689. * Display in overlay mode (default: false)
  52690. */
  52691. overlay?: boolean;
  52692. /**
  52693. * HTML element to use as root (the parent of the rendering canvas will be used as default value)
  52694. */
  52695. globalRoot?: HTMLElement;
  52696. /**
  52697. * Display the Scene explorer
  52698. */
  52699. showExplorer?: boolean;
  52700. /**
  52701. * Display the property inspector
  52702. */
  52703. showInspector?: boolean;
  52704. /**
  52705. * Display in embed mode (both panes on the right)
  52706. */
  52707. embedMode?: boolean;
  52708. /**
  52709. * let the Inspector handles resize of the canvas when panes are resized (default to true)
  52710. */
  52711. handleResize?: boolean;
  52712. /**
  52713. * Allow the panes to popup (default: true)
  52714. */
  52715. enablePopup?: boolean;
  52716. /**
  52717. * Allow the panes to be closed by users (default: true)
  52718. */
  52719. enableClose?: boolean;
  52720. /**
  52721. * Optional list of extensibility entries
  52722. */
  52723. explorerExtensibility?: IExplorerExtensibilityGroup[];
  52724. /**
  52725. * Optional URL to get the inspector script from (by default it uses the babylonjs CDN).
  52726. */
  52727. inspectorURL?: string;
  52728. /**
  52729. * Optional initial tab (default to DebugLayerTab.Properties)
  52730. */
  52731. initialTab?: DebugLayerTab;
  52732. }
  52733. module "babylonjs/scene" {
  52734. interface Scene {
  52735. /**
  52736. * @hidden
  52737. * Backing field
  52738. */
  52739. _debugLayer: DebugLayer;
  52740. /**
  52741. * Gets the debug layer (aka Inspector) associated with the scene
  52742. * @see https://doc.babylonjs.com/features/playground_debuglayer
  52743. */
  52744. debugLayer: DebugLayer;
  52745. }
  52746. }
  52747. /**
  52748. * Enum of inspector action tab
  52749. */
  52750. export enum DebugLayerTab {
  52751. /**
  52752. * Properties tag (default)
  52753. */
  52754. Properties = 0,
  52755. /**
  52756. * Debug tab
  52757. */
  52758. Debug = 1,
  52759. /**
  52760. * Statistics tab
  52761. */
  52762. Statistics = 2,
  52763. /**
  52764. * Tools tab
  52765. */
  52766. Tools = 3,
  52767. /**
  52768. * Settings tab
  52769. */
  52770. Settings = 4
  52771. }
  52772. /**
  52773. * The debug layer (aka Inspector) is the go to tool in order to better understand
  52774. * what is happening in your scene
  52775. * @see https://doc.babylonjs.com/features/playground_debuglayer
  52776. */
  52777. export class DebugLayer {
  52778. /**
  52779. * Define the url to get the inspector script from.
  52780. * By default it uses the babylonjs CDN.
  52781. * @ignoreNaming
  52782. */
  52783. static InspectorURL: string;
  52784. private _scene;
  52785. private BJSINSPECTOR;
  52786. private _onPropertyChangedObservable?;
  52787. /**
  52788. * Observable triggered when a property is changed through the inspector.
  52789. */
  52790. get onPropertyChangedObservable(): any;
  52791. /**
  52792. * Instantiates a new debug layer.
  52793. * The debug layer (aka Inspector) is the go to tool in order to better understand
  52794. * what is happening in your scene
  52795. * @see https://doc.babylonjs.com/features/playground_debuglayer
  52796. * @param scene Defines the scene to inspect
  52797. */
  52798. constructor(scene: Scene);
  52799. /** Creates the inspector window. */
  52800. private _createInspector;
  52801. /**
  52802. * Select a specific entity in the scene explorer and highlight a specific block in that entity property grid
  52803. * @param entity defines the entity to select
  52804. * @param lineContainerTitles defines the specific blocks to highlight (could be a string or an array of strings)
  52805. */
  52806. select(entity: any, lineContainerTitles?: string | string[]): void;
  52807. /** Get the inspector from bundle or global */
  52808. private _getGlobalInspector;
  52809. /**
  52810. * Get if the inspector is visible or not.
  52811. * @returns true if visible otherwise, false
  52812. */
  52813. isVisible(): boolean;
  52814. /**
  52815. * Hide the inspector and close its window.
  52816. */
  52817. hide(): void;
  52818. /**
  52819. * Update the scene in the inspector
  52820. */
  52821. setAsActiveScene(): void;
  52822. /**
  52823. * Launch the debugLayer.
  52824. * @param config Define the configuration of the inspector
  52825. * @return a promise fulfilled when the debug layer is visible
  52826. */
  52827. show(config?: IInspectorOptions): Promise<DebugLayer>;
  52828. }
  52829. }
  52830. declare module "babylonjs/Meshes/Builders/boxBuilder" {
  52831. import { Nullable } from "babylonjs/types";
  52832. import { Scene } from "babylonjs/scene";
  52833. import { Vector4 } from "babylonjs/Maths/math.vector";
  52834. import { Color4 } from "babylonjs/Maths/math.color";
  52835. import { Mesh } from "babylonjs/Meshes/mesh";
  52836. /**
  52837. * Class containing static functions to help procedurally build meshes
  52838. */
  52839. export class BoxBuilder {
  52840. /**
  52841. * Creates a box mesh
  52842. * * The parameter `size` sets the size (float) of each box side (default 1)
  52843. * * You can set some different box dimensions by using the parameters `width`, `height` and `depth` (all by default have the same value of `size`)
  52844. * * 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)
  52845. * * Please read this tutorial : https://doc.babylonjs.com/how_to/createbox_per_face_textures_and_colors
  52846. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  52847. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  52848. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  52849. * @see https://doc.babylonjs.com/how_to/set_shapes#box
  52850. * @param name defines the name of the mesh
  52851. * @param options defines the options used to create the mesh
  52852. * @param scene defines the hosting scene
  52853. * @returns the box mesh
  52854. */
  52855. static CreateBox(name: string, options: {
  52856. size?: number;
  52857. width?: number;
  52858. height?: number;
  52859. depth?: number;
  52860. faceUV?: Vector4[];
  52861. faceColors?: Color4[];
  52862. sideOrientation?: number;
  52863. frontUVs?: Vector4;
  52864. backUVs?: Vector4;
  52865. wrap?: boolean;
  52866. topBaseAt?: number;
  52867. bottomBaseAt?: number;
  52868. updatable?: boolean;
  52869. }, scene?: Nullable<Scene>): Mesh;
  52870. }
  52871. }
  52872. declare module "babylonjs/Debug/physicsViewer" {
  52873. import { Nullable } from "babylonjs/types";
  52874. import { Scene } from "babylonjs/scene";
  52875. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  52876. import { Mesh } from "babylonjs/Meshes/mesh";
  52877. import { IPhysicsEnginePlugin } from "babylonjs/Physics/IPhysicsEngine";
  52878. import { PhysicsImpostor } from "babylonjs/Physics/physicsImpostor";
  52879. /**
  52880. * Used to show the physics impostor around the specific mesh
  52881. */
  52882. export class PhysicsViewer {
  52883. /** @hidden */
  52884. protected _impostors: Array<Nullable<PhysicsImpostor>>;
  52885. /** @hidden */
  52886. protected _meshes: Array<Nullable<AbstractMesh>>;
  52887. /** @hidden */
  52888. protected _scene: Nullable<Scene>;
  52889. /** @hidden */
  52890. protected _numMeshes: number;
  52891. /** @hidden */
  52892. protected _physicsEnginePlugin: Nullable<IPhysicsEnginePlugin>;
  52893. private _renderFunction;
  52894. private _utilityLayer;
  52895. private _debugBoxMesh;
  52896. private _debugSphereMesh;
  52897. private _debugCylinderMesh;
  52898. private _debugMaterial;
  52899. private _debugMeshMeshes;
  52900. /**
  52901. * Creates a new PhysicsViewer
  52902. * @param scene defines the hosting scene
  52903. */
  52904. constructor(scene: Scene);
  52905. /** @hidden */
  52906. protected _updateDebugMeshes(): void;
  52907. /**
  52908. * Renders a specified physic impostor
  52909. * @param impostor defines the impostor to render
  52910. * @param targetMesh defines the mesh represented by the impostor
  52911. * @returns the new debug mesh used to render the impostor
  52912. */
  52913. showImpostor(impostor: PhysicsImpostor, targetMesh?: Mesh): Nullable<AbstractMesh>;
  52914. /**
  52915. * Hides a specified physic impostor
  52916. * @param impostor defines the impostor to hide
  52917. */
  52918. hideImpostor(impostor: Nullable<PhysicsImpostor>): void;
  52919. private _getDebugMaterial;
  52920. private _getDebugBoxMesh;
  52921. private _getDebugSphereMesh;
  52922. private _getDebugCylinderMesh;
  52923. private _getDebugMeshMesh;
  52924. private _getDebugMesh;
  52925. /** Releases all resources */
  52926. dispose(): void;
  52927. }
  52928. }
  52929. declare module "babylonjs/Debug/rayHelper" {
  52930. import { Nullable } from "babylonjs/types";
  52931. import { Ray } from "babylonjs/Culling/ray";
  52932. import { Vector3 } from "babylonjs/Maths/math.vector";
  52933. import { Color3 } from "babylonjs/Maths/math.color";
  52934. import { Scene } from "babylonjs/scene";
  52935. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  52936. import "babylonjs/Meshes/Builders/linesBuilder";
  52937. /**
  52938. * As raycast might be hard to debug, the RayHelper can help rendering the different rays
  52939. * in order to better appreciate the issue one might have.
  52940. * @see https://doc.babylonjs.com/babylon101/raycasts#debugging
  52941. */
  52942. export class RayHelper {
  52943. /**
  52944. * Defines the ray we are currently tryin to visualize.
  52945. */
  52946. ray: Nullable<Ray>;
  52947. private _renderPoints;
  52948. private _renderLine;
  52949. private _renderFunction;
  52950. private _scene;
  52951. private _onAfterRenderObserver;
  52952. private _onAfterStepObserver;
  52953. private _attachedToMesh;
  52954. private _meshSpaceDirection;
  52955. private _meshSpaceOrigin;
  52956. /**
  52957. * Helper function to create a colored helper in a scene in one line.
  52958. * @param ray Defines the ray we are currently tryin to visualize
  52959. * @param scene Defines the scene the ray is used in
  52960. * @param color Defines the color we want to see the ray in
  52961. * @returns The newly created ray helper.
  52962. */
  52963. static CreateAndShow(ray: Ray, scene: Scene, color: Color3): RayHelper;
  52964. /**
  52965. * Instantiate a new ray helper.
  52966. * As raycast might be hard to debug, the RayHelper can help rendering the different rays
  52967. * in order to better appreciate the issue one might have.
  52968. * @see https://doc.babylonjs.com/babylon101/raycasts#debugging
  52969. * @param ray Defines the ray we are currently tryin to visualize
  52970. */
  52971. constructor(ray: Ray);
  52972. /**
  52973. * Shows the ray we are willing to debug.
  52974. * @param scene Defines the scene the ray needs to be rendered in
  52975. * @param color Defines the color the ray needs to be rendered in
  52976. */
  52977. show(scene: Scene, color?: Color3): void;
  52978. /**
  52979. * Hides the ray we are debugging.
  52980. */
  52981. hide(): void;
  52982. private _render;
  52983. /**
  52984. * Attach a ray helper to a mesh so that we can easily see its orientation for instance or information like its normals.
  52985. * @param mesh Defines the mesh we want the helper attached to
  52986. * @param meshSpaceDirection Defines the direction of the Ray in mesh space (local space of the mesh node)
  52987. * @param meshSpaceOrigin Defines the origin of the Ray in mesh space (local space of the mesh node)
  52988. * @param length Defines the length of the ray
  52989. */
  52990. attachToMesh(mesh: AbstractMesh, meshSpaceDirection?: Vector3, meshSpaceOrigin?: Vector3, length?: number): void;
  52991. /**
  52992. * Detach the ray helper from the mesh it has previously been attached to.
  52993. */
  52994. detachFromMesh(): void;
  52995. private _updateToMesh;
  52996. /**
  52997. * Dispose the helper and release its associated resources.
  52998. */
  52999. dispose(): void;
  53000. }
  53001. }
  53002. declare module "babylonjs/Debug/ISkeletonViewer" {
  53003. /**
  53004. * Defines the options associated with the creation of a SkeletonViewer.
  53005. */
  53006. export interface ISkeletonViewerOptions {
  53007. /** Should the system pause animations before building the Viewer? */
  53008. pauseAnimations: boolean;
  53009. /** Should the system return the skeleton to rest before building? */
  53010. returnToRest: boolean;
  53011. /** public Display Mode of the Viewer */
  53012. displayMode: number;
  53013. /** Flag to toggle if the Viewer should use the CPU for animations or not? */
  53014. displayOptions: ISkeletonViewerDisplayOptions;
  53015. /** Flag to toggle if the Viewer should use the CPU for animations or not? */
  53016. computeBonesUsingShaders: boolean;
  53017. }
  53018. /**
  53019. * Defines how to display the various bone meshes for the viewer.
  53020. */
  53021. export interface ISkeletonViewerDisplayOptions {
  53022. /** How far down to start tapering the bone spurs */
  53023. midStep?: number;
  53024. /** How big is the midStep? */
  53025. midStepFactor?: number;
  53026. /** Base for the Sphere Size */
  53027. sphereBaseSize?: number;
  53028. /** The ratio of the sphere to the longest bone in units */
  53029. sphereScaleUnit?: number;
  53030. /** Ratio for the Sphere Size */
  53031. sphereFactor?: number;
  53032. }
  53033. }
  53034. declare module "babylonjs/Meshes/Builders/ribbonBuilder" {
  53035. import { Nullable } from "babylonjs/types";
  53036. import { Scene } from "babylonjs/scene";
  53037. import { Vector3, Vector2, Vector4 } from "babylonjs/Maths/math.vector";
  53038. import { Color4 } from "babylonjs/Maths/math.color";
  53039. import { Mesh } from "babylonjs/Meshes/mesh";
  53040. /**
  53041. * Class containing static functions to help procedurally build meshes
  53042. */
  53043. export class RibbonBuilder {
  53044. /**
  53045. * Creates a ribbon mesh. The ribbon is a parametric shape. It has no predefined shape. Its final shape will depend on the input parameters
  53046. * * The parameter `pathArray` is a required array of paths, what are each an array of successive Vector3. The pathArray parameter depicts the ribbon geometry
  53047. * * The parameter `closeArray` (boolean, default false) creates a seam between the first and the last paths of the path array
  53048. * * The parameter `closePath` (boolean, default false) creates a seam between the first and the last points of each path of the path array
  53049. * * 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
  53050. * * 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
  53051. * * 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
  53052. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  53053. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  53054. * * The optional parameter `invertUV` (boolean, default false) swaps in the geometry the U and V coordinates to apply a texture
  53055. * * 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
  53056. * * The parameters `colors` is an optional flat array of `Color4` to set/update each ribbon vertex with its own custom color values
  53057. * * 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
  53058. * * Moreover, you can use the parameter `color` with `instance` (to update the ribbon), only if you previously used it at creation time
  53059. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  53060. * @param name defines the name of the mesh
  53061. * @param options defines the options used to create the mesh
  53062. * @param scene defines the hosting scene
  53063. * @returns the ribbon mesh
  53064. * @see https://doc.babylonjs.com/how_to/ribbon_tutorial
  53065. * @see https://doc.babylonjs.com/how_to/parametric_shapes
  53066. */
  53067. static CreateRibbon(name: string, options: {
  53068. pathArray: Vector3[][];
  53069. closeArray?: boolean;
  53070. closePath?: boolean;
  53071. offset?: number;
  53072. updatable?: boolean;
  53073. sideOrientation?: number;
  53074. frontUVs?: Vector4;
  53075. backUVs?: Vector4;
  53076. instance?: Mesh;
  53077. invertUV?: boolean;
  53078. uvs?: Vector2[];
  53079. colors?: Color4[];
  53080. }, scene?: Nullable<Scene>): Mesh;
  53081. }
  53082. }
  53083. declare module "babylonjs/Meshes/Builders/shapeBuilder" {
  53084. import { Nullable } from "babylonjs/types";
  53085. import { Scene } from "babylonjs/scene";
  53086. import { Vector3, Vector4 } from "babylonjs/Maths/math.vector";
  53087. import { Mesh } from "babylonjs/Meshes/mesh";
  53088. /**
  53089. * Class containing static functions to help procedurally build meshes
  53090. */
  53091. export class ShapeBuilder {
  53092. /**
  53093. * 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.
  53094. * * 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.
  53095. * * The parameter `path` is a required array of successive Vector3. This is the axis curve the shape is extruded along.
  53096. * * 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.
  53097. * * The parameter `scale` (float, default 1) is the value to scale the shape.
  53098. * * 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
  53099. * * 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
  53100. * * Remember you can only change the shape or path point positions, not their number when updating an extruded shape.
  53101. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  53102. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  53103. * * The optional parameter `invertUV` (boolean, default false) swaps in the geometry the U and V coordinates to apply a texture.
  53104. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created.
  53105. * @param name defines the name of the mesh
  53106. * @param options defines the options used to create the mesh
  53107. * @param scene defines the hosting scene
  53108. * @returns the extruded shape mesh
  53109. * @see https://doc.babylonjs.com/how_to/parametric_shapes
  53110. * @see https://doc.babylonjs.com/how_to/parametric_shapes#extruded-shapes
  53111. */
  53112. static ExtrudeShape(name: string, options: {
  53113. shape: Vector3[];
  53114. path: Vector3[];
  53115. scale?: number;
  53116. rotation?: number;
  53117. cap?: number;
  53118. updatable?: boolean;
  53119. sideOrientation?: number;
  53120. frontUVs?: Vector4;
  53121. backUVs?: Vector4;
  53122. instance?: Mesh;
  53123. invertUV?: boolean;
  53124. }, scene?: Nullable<Scene>): Mesh;
  53125. /**
  53126. * Creates an custom extruded shape mesh.
  53127. * The custom extrusion is a parametric shape. It has no predefined shape. Its final shape will depend on the input parameters.
  53128. * * 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.
  53129. * * The parameter `path` is a required array of successive Vector3. This is the axis curve the shape is extruded along.
  53130. * * 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
  53131. * * It must returns a float value that will be the rotation in radians applied to the shape on each path point.
  53132. * * 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
  53133. * * It must returns a float value that will be the scale value applied to the shape on each path point
  53134. * * The parameter `ribbonClosePath` (boolean, default false) forces the extrusion underlying ribbon to close all the paths in its `pathArray`
  53135. * * The parameter `ribbonCloseArray` (boolean, default false) forces the extrusion underlying ribbon to close its `pathArray`
  53136. * * 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
  53137. * * 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
  53138. * * Remember you can only change the shape or path point positions, not their number when updating an extruded shape
  53139. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  53140. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  53141. * * The optional parameter `invertUV` (boolean, default false) swaps in the geometry the U and V coordinates to apply a texture
  53142. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  53143. * @param name defines the name of the mesh
  53144. * @param options defines the options used to create the mesh
  53145. * @param scene defines the hosting scene
  53146. * @returns the custom extruded shape mesh
  53147. * @see https://doc.babylonjs.com/how_to/parametric_shapes#custom-extruded-shapes
  53148. * @see https://doc.babylonjs.com/how_to/parametric_shapes
  53149. * @see https://doc.babylonjs.com/how_to/parametric_shapes#extruded-shapes
  53150. */
  53151. static ExtrudeShapeCustom(name: string, options: {
  53152. shape: Vector3[];
  53153. path: Vector3[];
  53154. scaleFunction?: any;
  53155. rotationFunction?: any;
  53156. ribbonCloseArray?: boolean;
  53157. ribbonClosePath?: boolean;
  53158. cap?: number;
  53159. updatable?: boolean;
  53160. sideOrientation?: number;
  53161. frontUVs?: Vector4;
  53162. backUVs?: Vector4;
  53163. instance?: Mesh;
  53164. invertUV?: boolean;
  53165. }, scene?: Nullable<Scene>): Mesh;
  53166. private static _ExtrudeShapeGeneric;
  53167. }
  53168. }
  53169. declare module "babylonjs/Debug/skeletonViewer" {
  53170. import { Color3 } from "babylonjs/Maths/math.color";
  53171. import { Scene } from "babylonjs/scene";
  53172. import { Nullable } from "babylonjs/types";
  53173. import { Skeleton } from "babylonjs/Bones/skeleton";
  53174. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  53175. import { LinesMesh } from "babylonjs/Meshes/linesMesh";
  53176. import { UtilityLayerRenderer } from "babylonjs/Rendering/utilityLayerRenderer";
  53177. import { StandardMaterial } from "babylonjs/Materials/standardMaterial";
  53178. import { ISkeletonViewerOptions } from "babylonjs/Debug/ISkeletonViewer";
  53179. /**
  53180. * Class used to render a debug view of a given skeleton
  53181. * @see http://www.babylonjs-playground.com/#1BZJVJ#8
  53182. */
  53183. export class SkeletonViewer {
  53184. /** defines the skeleton to render */
  53185. skeleton: Skeleton;
  53186. /** defines the mesh attached to the skeleton */
  53187. mesh: AbstractMesh;
  53188. /** defines a boolean indicating if bones matrices must be forced to update before rendering (true by default) */
  53189. autoUpdateBonesMatrices: boolean;
  53190. /** defines the rendering group id to use with the viewer */
  53191. renderingGroupId: number;
  53192. /** is the options for the viewer */
  53193. options: Partial<ISkeletonViewerOptions>;
  53194. /** public Display constants BABYLON.SkeletonViewer.DISPLAY_LINES */
  53195. static readonly DISPLAY_LINES: number;
  53196. /** public Display constants BABYLON.SkeletonViewer.DISPLAY_SPHERES */
  53197. static readonly DISPLAY_SPHERES: number;
  53198. /** public Display constants BABYLON.SkeletonViewer.DISPLAY_SPHERE_AND_SPURS */
  53199. static readonly DISPLAY_SPHERE_AND_SPURS: number;
  53200. /** If SkeletonViewer scene scope. */
  53201. private _scene;
  53202. /** Gets or sets the color used to render the skeleton */
  53203. color: Color3;
  53204. /** Array of the points of the skeleton fo the line view. */
  53205. private _debugLines;
  53206. /** The SkeletonViewers Mesh. */
  53207. private _debugMesh;
  53208. /** If SkeletonViewer is enabled. */
  53209. private _isEnabled;
  53210. /** If SkeletonViewer is ready. */
  53211. private _ready;
  53212. /** SkeletonViewer render observable. */
  53213. private _obs;
  53214. /** The Utility Layer to render the gizmos in. */
  53215. private _utilityLayer;
  53216. private _boneIndices;
  53217. /** Gets the Scene. */
  53218. get scene(): Scene;
  53219. /** Gets the utilityLayer. */
  53220. get utilityLayer(): Nullable<UtilityLayerRenderer>;
  53221. /** Checks Ready Status. */
  53222. get isReady(): Boolean;
  53223. /** Sets Ready Status. */
  53224. set ready(value: boolean);
  53225. /** Gets the debugMesh */
  53226. get debugMesh(): Nullable<AbstractMesh> | Nullable<LinesMesh>;
  53227. /** Sets the debugMesh */
  53228. set debugMesh(value: Nullable<AbstractMesh> | Nullable<LinesMesh>);
  53229. /** Gets the material */
  53230. get material(): StandardMaterial;
  53231. /** Sets the material */
  53232. set material(value: StandardMaterial);
  53233. /** Gets the material */
  53234. get displayMode(): number;
  53235. /** Sets the material */
  53236. set displayMode(value: number);
  53237. /**
  53238. * Creates a new SkeletonViewer
  53239. * @param skeleton defines the skeleton to render
  53240. * @param mesh defines the mesh attached to the skeleton
  53241. * @param scene defines the hosting scene
  53242. * @param autoUpdateBonesMatrices defines a boolean indicating if bones matrices must be forced to update before rendering (true by default)
  53243. * @param renderingGroupId defines the rendering group id to use with the viewer
  53244. * @param options All of the extra constructor options for the SkeletonViewer
  53245. */
  53246. constructor(
  53247. /** defines the skeleton to render */
  53248. skeleton: Skeleton,
  53249. /** defines the mesh attached to the skeleton */
  53250. mesh: AbstractMesh,
  53251. /** The Scene scope*/
  53252. scene: Scene,
  53253. /** defines a boolean indicating if bones matrices must be forced to update before rendering (true by default) */
  53254. autoUpdateBonesMatrices?: boolean,
  53255. /** defines the rendering group id to use with the viewer */
  53256. renderingGroupId?: number,
  53257. /** is the options for the viewer */
  53258. options?: Partial<ISkeletonViewerOptions>);
  53259. /** The Dynamic bindings for the update functions */
  53260. private _bindObs;
  53261. /** Update the viewer to sync with current skeleton state, only used to manually update. */
  53262. update(): void;
  53263. /** Gets or sets a boolean indicating if the viewer is enabled */
  53264. set isEnabled(value: boolean);
  53265. get isEnabled(): boolean;
  53266. private _getBonePosition;
  53267. private _getLinesForBonesWithLength;
  53268. private _getLinesForBonesNoLength;
  53269. /** function to revert the mesh and scene back to the initial state. */
  53270. private _revert;
  53271. /** function to build and bind sphere joint points and spur bone representations. */
  53272. private _buildSpheresAndSpurs;
  53273. /** Update the viewer to sync with current skeleton state, only used for the line display. */
  53274. private _displayLinesUpdate;
  53275. /** Changes the displayMode of the skeleton viewer
  53276. * @param mode The displayMode numerical value
  53277. */
  53278. changeDisplayMode(mode: number): void;
  53279. /** Changes the displayMode of the skeleton viewer
  53280. * @param option String of the option name
  53281. * @param value The numerical option value
  53282. */
  53283. changeDisplayOptions(option: string, value: number): void;
  53284. /** Release associated resources */
  53285. dispose(): void;
  53286. }
  53287. }
  53288. declare module "babylonjs/Debug/index" {
  53289. export * from "babylonjs/Debug/axesViewer";
  53290. export * from "babylonjs/Debug/boneAxesViewer";
  53291. export * from "babylonjs/Debug/debugLayer";
  53292. export * from "babylonjs/Debug/physicsViewer";
  53293. export * from "babylonjs/Debug/rayHelper";
  53294. export * from "babylonjs/Debug/skeletonViewer";
  53295. export * from "babylonjs/Debug/ISkeletonViewer";
  53296. }
  53297. declare module "babylonjs/DeviceInput/InputDevices/deviceEnums" {
  53298. /**
  53299. * Enum for Device Types
  53300. */
  53301. export enum DeviceType {
  53302. /** Generic */
  53303. Generic = 0,
  53304. /** Keyboard */
  53305. Keyboard = 1,
  53306. /** Mouse */
  53307. Mouse = 2,
  53308. /** Touch Pointers */
  53309. Touch = 3,
  53310. /** PS4 Dual Shock */
  53311. DualShock = 4,
  53312. /** Xbox */
  53313. Xbox = 5,
  53314. /** Switch Controller */
  53315. Switch = 6
  53316. }
  53317. /**
  53318. * Enum for All Pointers (Touch/Mouse)
  53319. */
  53320. export enum PointerInput {
  53321. /** Horizontal Axis */
  53322. Horizontal = 0,
  53323. /** Vertical Axis */
  53324. Vertical = 1,
  53325. /** Left Click or Touch */
  53326. LeftClick = 2,
  53327. /** Middle Click */
  53328. MiddleClick = 3,
  53329. /** Right Click */
  53330. RightClick = 4,
  53331. /** Browser Back */
  53332. BrowserBack = 5,
  53333. /** Browser Forward */
  53334. BrowserForward = 6
  53335. }
  53336. /**
  53337. * Enum for Dual Shock Gamepad
  53338. */
  53339. export enum DualShockInput {
  53340. /** Cross */
  53341. Cross = 0,
  53342. /** Circle */
  53343. Circle = 1,
  53344. /** Square */
  53345. Square = 2,
  53346. /** Triangle */
  53347. Triangle = 3,
  53348. /** L1 */
  53349. L1 = 4,
  53350. /** R1 */
  53351. R1 = 5,
  53352. /** L2 */
  53353. L2 = 6,
  53354. /** R2 */
  53355. R2 = 7,
  53356. /** Share */
  53357. Share = 8,
  53358. /** Options */
  53359. Options = 9,
  53360. /** L3 */
  53361. L3 = 10,
  53362. /** R3 */
  53363. R3 = 11,
  53364. /** DPadUp */
  53365. DPadUp = 12,
  53366. /** DPadDown */
  53367. DPadDown = 13,
  53368. /** DPadLeft */
  53369. DPadLeft = 14,
  53370. /** DRight */
  53371. DPadRight = 15,
  53372. /** Home */
  53373. Home = 16,
  53374. /** TouchPad */
  53375. TouchPad = 17,
  53376. /** LStickXAxis */
  53377. LStickXAxis = 18,
  53378. /** LStickYAxis */
  53379. LStickYAxis = 19,
  53380. /** RStickXAxis */
  53381. RStickXAxis = 20,
  53382. /** RStickYAxis */
  53383. RStickYAxis = 21
  53384. }
  53385. /**
  53386. * Enum for Xbox Gamepad
  53387. */
  53388. export enum XboxInput {
  53389. /** A */
  53390. A = 0,
  53391. /** B */
  53392. B = 1,
  53393. /** X */
  53394. X = 2,
  53395. /** Y */
  53396. Y = 3,
  53397. /** LB */
  53398. LB = 4,
  53399. /** RB */
  53400. RB = 5,
  53401. /** LT */
  53402. LT = 6,
  53403. /** RT */
  53404. RT = 7,
  53405. /** Back */
  53406. Back = 8,
  53407. /** Start */
  53408. Start = 9,
  53409. /** LS */
  53410. LS = 10,
  53411. /** RS */
  53412. RS = 11,
  53413. /** DPadUp */
  53414. DPadUp = 12,
  53415. /** DPadDown */
  53416. DPadDown = 13,
  53417. /** DPadLeft */
  53418. DPadLeft = 14,
  53419. /** DRight */
  53420. DPadRight = 15,
  53421. /** Home */
  53422. Home = 16,
  53423. /** LStickXAxis */
  53424. LStickXAxis = 17,
  53425. /** LStickYAxis */
  53426. LStickYAxis = 18,
  53427. /** RStickXAxis */
  53428. RStickXAxis = 19,
  53429. /** RStickYAxis */
  53430. RStickYAxis = 20
  53431. }
  53432. /**
  53433. * Enum for Switch (Pro/JoyCon L+R) Gamepad
  53434. */
  53435. export enum SwitchInput {
  53436. /** B */
  53437. B = 0,
  53438. /** A */
  53439. A = 1,
  53440. /** Y */
  53441. Y = 2,
  53442. /** X */
  53443. X = 3,
  53444. /** L */
  53445. L = 4,
  53446. /** R */
  53447. R = 5,
  53448. /** ZL */
  53449. ZL = 6,
  53450. /** ZR */
  53451. ZR = 7,
  53452. /** Minus */
  53453. Minus = 8,
  53454. /** Plus */
  53455. Plus = 9,
  53456. /** LS */
  53457. LS = 10,
  53458. /** RS */
  53459. RS = 11,
  53460. /** DPadUp */
  53461. DPadUp = 12,
  53462. /** DPadDown */
  53463. DPadDown = 13,
  53464. /** DPadLeft */
  53465. DPadLeft = 14,
  53466. /** DRight */
  53467. DPadRight = 15,
  53468. /** Home */
  53469. Home = 16,
  53470. /** Capture */
  53471. Capture = 17,
  53472. /** LStickXAxis */
  53473. LStickXAxis = 18,
  53474. /** LStickYAxis */
  53475. LStickYAxis = 19,
  53476. /** RStickXAxis */
  53477. RStickXAxis = 20,
  53478. /** RStickYAxis */
  53479. RStickYAxis = 21
  53480. }
  53481. }
  53482. declare module "babylonjs/DeviceInput/deviceInputSystem" {
  53483. import { Engine } from "babylonjs/Engines/engine";
  53484. import { IDisposable } from "babylonjs/scene";
  53485. import { Nullable } from "babylonjs/types";
  53486. import { DeviceType } from "babylonjs/DeviceInput/InputDevices/deviceEnums";
  53487. /**
  53488. * This class will take all inputs from Keyboard, Pointer, and
  53489. * any Gamepads and provide a polling system that all devices
  53490. * will use. This class assumes that there will only be one
  53491. * pointer device and one keyboard.
  53492. */
  53493. export class DeviceInputSystem implements IDisposable {
  53494. /**
  53495. * Callback to be triggered when a device is connected
  53496. */
  53497. onDeviceConnected: (deviceType: DeviceType, deviceSlot: number) => void;
  53498. /**
  53499. * Callback to be triggered when a device is disconnected
  53500. */
  53501. onDeviceDisconnected: (deviceType: DeviceType, deviceSlot: number) => void;
  53502. /**
  53503. * Callback to be triggered when event driven input is updated
  53504. */
  53505. onInputChanged: (deviceType: DeviceType, deviceSlot: number, inputIndex: number, previousState: Nullable<number>, currentState: Nullable<number>) => void;
  53506. private _inputs;
  53507. private _gamepads;
  53508. private _keyboardActive;
  53509. private _pointerActive;
  53510. private _elementToAttachTo;
  53511. private _keyboardDownEvent;
  53512. private _keyboardUpEvent;
  53513. private _pointerMoveEvent;
  53514. private _pointerDownEvent;
  53515. private _pointerUpEvent;
  53516. private _gamepadConnectedEvent;
  53517. private _gamepadDisconnectedEvent;
  53518. private static _MAX_KEYCODES;
  53519. private static _MAX_POINTER_INPUTS;
  53520. private constructor();
  53521. /**
  53522. * Creates a new DeviceInputSystem instance
  53523. * @param engine Engine to pull input element from
  53524. * @returns The new instance
  53525. */
  53526. static Create(engine: Engine): DeviceInputSystem;
  53527. /**
  53528. * Checks for current device input value, given an id and input index
  53529. * @param deviceName Id of connected device
  53530. * @param inputIndex Index of device input
  53531. * @returns Current value of input
  53532. */
  53533. /**
  53534. * Checks for current device input value, given an id and input index. Throws exception if requested device not initialized.
  53535. * @param deviceType Enum specifiying device type
  53536. * @param deviceSlot "Slot" or index that device is referenced in
  53537. * @param inputIndex Id of input to be checked
  53538. * @returns Current value of input
  53539. */
  53540. pollInput(deviceType: DeviceType, deviceSlot: number, inputIndex: number): number;
  53541. /**
  53542. * Dispose of all the eventlisteners
  53543. */
  53544. dispose(): void;
  53545. /**
  53546. * Add device and inputs to device array
  53547. * @param deviceType Enum specifiying device type
  53548. * @param deviceSlot "Slot" or index that device is referenced in
  53549. * @param numberOfInputs Number of input entries to create for given device
  53550. */
  53551. private _registerDevice;
  53552. /**
  53553. * Given a specific device name, remove that device from the device map
  53554. * @param deviceType Enum specifiying device type
  53555. * @param deviceSlot "Slot" or index that device is referenced in
  53556. */
  53557. private _unregisterDevice;
  53558. /**
  53559. * Handle all actions that come from keyboard interaction
  53560. */
  53561. private _handleKeyActions;
  53562. /**
  53563. * Handle all actions that come from pointer interaction
  53564. */
  53565. private _handlePointerActions;
  53566. /**
  53567. * Handle all actions that come from gamepad interaction
  53568. */
  53569. private _handleGamepadActions;
  53570. /**
  53571. * Update all non-event based devices with each frame
  53572. * @param deviceType Enum specifiying device type
  53573. * @param deviceSlot "Slot" or index that device is referenced in
  53574. * @param inputIndex Id of input to be checked
  53575. */
  53576. private _updateDevice;
  53577. /**
  53578. * Gets DeviceType from the device name
  53579. * @param deviceName Name of Device from DeviceInputSystem
  53580. * @returns DeviceType enum value
  53581. */
  53582. private _getGamepadDeviceType;
  53583. }
  53584. }
  53585. declare module "babylonjs/DeviceInput/InputDevices/deviceTypes" {
  53586. import { DeviceType, PointerInput, DualShockInput, XboxInput, SwitchInput } from "babylonjs/DeviceInput/InputDevices/deviceEnums";
  53587. /**
  53588. * Type to handle enforcement of inputs
  53589. */
  53590. 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;
  53591. }
  53592. declare module "babylonjs/DeviceInput/InputDevices/deviceSourceManager" {
  53593. import { DeviceInputSystem } from "babylonjs/DeviceInput/deviceInputSystem";
  53594. import { Engine } from "babylonjs/Engines/engine";
  53595. import { IDisposable } from "babylonjs/scene";
  53596. import { DeviceType } from "babylonjs/DeviceInput/InputDevices/deviceEnums";
  53597. import { Nullable } from "babylonjs/types";
  53598. import { Observable } from "babylonjs/Misc/observable";
  53599. import { DeviceInput } from "babylonjs/DeviceInput/InputDevices/deviceTypes";
  53600. /**
  53601. * Class that handles all input for a specific device
  53602. */
  53603. export class DeviceSource<T extends DeviceType> {
  53604. /** Type of device */
  53605. readonly deviceType: DeviceType;
  53606. /** "Slot" or index that device is referenced in */
  53607. readonly deviceSlot: number;
  53608. /**
  53609. * Observable to handle device input changes per device
  53610. */
  53611. readonly onInputChangedObservable: Observable<{
  53612. inputIndex: DeviceInput<T>;
  53613. previousState: Nullable<number>;
  53614. currentState: Nullable<number>;
  53615. }>;
  53616. private readonly _deviceInputSystem;
  53617. /**
  53618. * Default Constructor
  53619. * @param deviceInputSystem Reference to DeviceInputSystem
  53620. * @param deviceType Type of device
  53621. * @param deviceSlot "Slot" or index that device is referenced in
  53622. */
  53623. constructor(deviceInputSystem: DeviceInputSystem,
  53624. /** Type of device */
  53625. deviceType: DeviceType,
  53626. /** "Slot" or index that device is referenced in */
  53627. deviceSlot?: number);
  53628. /**
  53629. * Get input for specific input
  53630. * @param inputIndex index of specific input on device
  53631. * @returns Input value from DeviceInputSystem
  53632. */
  53633. getInput(inputIndex: DeviceInput<T>): Nullable<number>;
  53634. }
  53635. /**
  53636. * Class to keep track of devices
  53637. */
  53638. export class DeviceSourceManager implements IDisposable {
  53639. /**
  53640. * Observable to be triggered when before a device is connected
  53641. */
  53642. readonly onBeforeDeviceConnectedObservable: Observable<{
  53643. deviceType: DeviceType;
  53644. deviceSlot: number;
  53645. }>;
  53646. /**
  53647. * Observable to be triggered when before a device is disconnected
  53648. */
  53649. readonly onBeforeDeviceDisconnectedObservable: Observable<{
  53650. deviceType: DeviceType;
  53651. deviceSlot: number;
  53652. }>;
  53653. /**
  53654. * Observable to be triggered when after a device is connected
  53655. */
  53656. readonly onAfterDeviceConnectedObservable: Observable<{
  53657. deviceType: DeviceType;
  53658. deviceSlot: number;
  53659. }>;
  53660. /**
  53661. * Observable to be triggered when after a device is disconnected
  53662. */
  53663. readonly onAfterDeviceDisconnectedObservable: Observable<{
  53664. deviceType: DeviceType;
  53665. deviceSlot: number;
  53666. }>;
  53667. private readonly _devices;
  53668. private readonly _firstDevice;
  53669. private readonly _deviceInputSystem;
  53670. /**
  53671. * Default Constructor
  53672. * @param engine engine to pull input element from
  53673. */
  53674. constructor(engine: Engine);
  53675. /**
  53676. * Gets a DeviceSource, given a type and slot
  53677. * @param deviceType Enum specifying device type
  53678. * @param deviceSlot "Slot" or index that device is referenced in
  53679. * @returns DeviceSource object
  53680. */
  53681. getDeviceSource<T extends DeviceType>(deviceType: T, deviceSlot?: number): Nullable<DeviceSource<T>>;
  53682. /**
  53683. * Gets an array of DeviceSource objects for a given device type
  53684. * @param deviceType Enum specifying device type
  53685. * @returns Array of DeviceSource objects
  53686. */
  53687. getDeviceSources<T extends DeviceType>(deviceType: T): ReadonlyArray<DeviceSource<T>>;
  53688. /**
  53689. * Dispose of DeviceInputSystem and other parts
  53690. */
  53691. dispose(): void;
  53692. /**
  53693. * Function to add device name to device list
  53694. * @param deviceType Enum specifying device type
  53695. * @param deviceSlot "Slot" or index that device is referenced in
  53696. */
  53697. private _addDevice;
  53698. /**
  53699. * Function to remove device name to device list
  53700. * @param deviceType Enum specifying device type
  53701. * @param deviceSlot "Slot" or index that device is referenced in
  53702. */
  53703. private _removeDevice;
  53704. /**
  53705. * Updates array storing first connected device of each type
  53706. * @param type Type of Device
  53707. */
  53708. private _updateFirstDevices;
  53709. }
  53710. }
  53711. declare module "babylonjs/DeviceInput/index" {
  53712. export * from "babylonjs/DeviceInput/deviceInputSystem";
  53713. export * from "babylonjs/DeviceInput/InputDevices/deviceEnums";
  53714. export * from "babylonjs/DeviceInput/InputDevices/deviceTypes";
  53715. import "babylonjs/DeviceInput/InputDevices/deviceSourceManager";
  53716. export * from "babylonjs/DeviceInput/InputDevices/deviceSourceManager";
  53717. }
  53718. declare module "babylonjs/Engines/nullEngine" {
  53719. import { Nullable, FloatArray, IndicesArray } from "babylonjs/types";
  53720. import { Engine } from "babylonjs/Engines/engine";
  53721. import { RenderTargetCreationOptions } from "babylonjs/Materials/Textures/renderTargetCreationOptions";
  53722. import { VertexBuffer } from "babylonjs/Meshes/buffer";
  53723. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  53724. import { Effect } from "babylonjs/Materials/effect";
  53725. import { IPipelineContext } from "babylonjs/Engines/IPipelineContext";
  53726. import { DataBuffer } from "babylonjs/Meshes/dataBuffer";
  53727. import { IColor4Like, IViewportLike } from "babylonjs/Maths/math.like";
  53728. import { ISceneLike } from "babylonjs/Engines/thinEngine";
  53729. /**
  53730. * Options to create the null engine
  53731. */
  53732. export class NullEngineOptions {
  53733. /**
  53734. * Render width (Default: 512)
  53735. */
  53736. renderWidth: number;
  53737. /**
  53738. * Render height (Default: 256)
  53739. */
  53740. renderHeight: number;
  53741. /**
  53742. * Texture size (Default: 512)
  53743. */
  53744. textureSize: number;
  53745. /**
  53746. * If delta time between frames should be constant
  53747. * @see https://doc.babylonjs.com/babylon101/animations#deterministic-lockstep
  53748. */
  53749. deterministicLockstep: boolean;
  53750. /**
  53751. * Maximum about of steps between frames (Default: 4)
  53752. * @see https://doc.babylonjs.com/babylon101/animations#deterministic-lockstep
  53753. */
  53754. lockstepMaxSteps: number;
  53755. /**
  53756. * Make the matrix computations to be performed in 64 bits instead of 32 bits. False by default
  53757. */
  53758. useHighPrecisionMatrix?: boolean;
  53759. }
  53760. /**
  53761. * The null engine class provides support for headless version of babylon.js.
  53762. * This can be used in server side scenario or for testing purposes
  53763. */
  53764. export class NullEngine extends Engine {
  53765. private _options;
  53766. /**
  53767. * Gets a boolean indicating that the engine is running in deterministic lock step mode
  53768. * @see https://doc.babylonjs.com/babylon101/animations#deterministic-lockstep
  53769. * @returns true if engine is in deterministic lock step mode
  53770. */
  53771. isDeterministicLockStep(): boolean;
  53772. /**
  53773. * Gets the max steps when engine is running in deterministic lock step
  53774. * @see https://doc.babylonjs.com/babylon101/animations#deterministic-lockstep
  53775. * @returns the max steps
  53776. */
  53777. getLockstepMaxSteps(): number;
  53778. /**
  53779. * Gets the current hardware scaling level.
  53780. * By default the hardware scaling level is computed from the window device ratio.
  53781. * 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.
  53782. * @returns a number indicating the current hardware scaling level
  53783. */
  53784. getHardwareScalingLevel(): number;
  53785. constructor(options?: NullEngineOptions);
  53786. /**
  53787. * Creates a vertex buffer
  53788. * @param vertices the data for the vertex buffer
  53789. * @returns the new WebGL static buffer
  53790. */
  53791. createVertexBuffer(vertices: FloatArray): DataBuffer;
  53792. /**
  53793. * Creates a new index buffer
  53794. * @param indices defines the content of the index buffer
  53795. * @param updatable defines if the index buffer must be updatable
  53796. * @returns a new webGL buffer
  53797. */
  53798. createIndexBuffer(indices: IndicesArray): DataBuffer;
  53799. /**
  53800. * Clear the current render buffer or the current render target (if any is set up)
  53801. * @param color defines the color to use
  53802. * @param backBuffer defines if the back buffer must be cleared
  53803. * @param depth defines if the depth buffer must be cleared
  53804. * @param stencil defines if the stencil buffer must be cleared
  53805. */
  53806. clear(color: IColor4Like, backBuffer: boolean, depth: boolean, stencil?: boolean): void;
  53807. /**
  53808. * Gets the current render width
  53809. * @param useScreen defines if screen size must be used (or the current render target if any)
  53810. * @returns a number defining the current render width
  53811. */
  53812. getRenderWidth(useScreen?: boolean): number;
  53813. /**
  53814. * Gets the current render height
  53815. * @param useScreen defines if screen size must be used (or the current render target if any)
  53816. * @returns a number defining the current render height
  53817. */
  53818. getRenderHeight(useScreen?: boolean): number;
  53819. /**
  53820. * Set the WebGL's viewport
  53821. * @param viewport defines the viewport element to be used
  53822. * @param requiredWidth defines the width required for rendering. If not provided the rendering canvas' width is used
  53823. * @param requiredHeight defines the height required for rendering. If not provided the rendering canvas' height is used
  53824. */
  53825. setViewport(viewport: IViewportLike, requiredWidth?: number, requiredHeight?: number): void;
  53826. createShaderProgram(pipelineContext: IPipelineContext, vertexCode: string, fragmentCode: string, defines: string, context?: WebGLRenderingContext): WebGLProgram;
  53827. /**
  53828. * Gets the list of webGL uniform locations associated with a specific program based on a list of uniform names
  53829. * @param pipelineContext defines the pipeline context to use
  53830. * @param uniformsNames defines the list of uniform names
  53831. * @returns an array of webGL uniform locations
  53832. */
  53833. getUniforms(pipelineContext: IPipelineContext, uniformsNames: string[]): Nullable<WebGLUniformLocation>[];
  53834. /**
  53835. * Gets the lsit of active attributes for a given webGL program
  53836. * @param pipelineContext defines the pipeline context to use
  53837. * @param attributesNames defines the list of attribute names to get
  53838. * @returns an array of indices indicating the offset of each attribute
  53839. */
  53840. getAttributes(pipelineContext: IPipelineContext, attributesNames: string[]): number[];
  53841. /**
  53842. * Binds an effect to the webGL context
  53843. * @param effect defines the effect to bind
  53844. */
  53845. bindSamplers(effect: Effect): void;
  53846. /**
  53847. * Activates an effect, mkaing it the current one (ie. the one used for rendering)
  53848. * @param effect defines the effect to activate
  53849. */
  53850. enableEffect(effect: Effect): void;
  53851. /**
  53852. * Set various states to the webGL context
  53853. * @param culling defines backface culling state
  53854. * @param zOffset defines the value to apply to zOffset (0 by default)
  53855. * @param force defines if states must be applied even if cache is up to date
  53856. * @param reverseSide defines if culling must be reversed (CCW instead of CW and CW instead of CCW)
  53857. */
  53858. setState(culling: boolean, zOffset?: number, force?: boolean, reverseSide?: boolean): void;
  53859. /**
  53860. * Set the value of an uniform to an array of int32
  53861. * @param uniform defines the webGL uniform location where to store the value
  53862. * @param array defines the array of int32 to store
  53863. */
  53864. setIntArray(uniform: WebGLUniformLocation, array: Int32Array): void;
  53865. /**
  53866. * Set the value of an uniform to an array of int32 (stored as vec2)
  53867. * @param uniform defines the webGL uniform location where to store the value
  53868. * @param array defines the array of int32 to store
  53869. */
  53870. setIntArray2(uniform: WebGLUniformLocation, array: Int32Array): void;
  53871. /**
  53872. * Set the value of an uniform to an array of int32 (stored as vec3)
  53873. * @param uniform defines the webGL uniform location where to store the value
  53874. * @param array defines the array of int32 to store
  53875. */
  53876. setIntArray3(uniform: WebGLUniformLocation, array: Int32Array): void;
  53877. /**
  53878. * Set the value of an uniform to an array of int32 (stored as vec4)
  53879. * @param uniform defines the webGL uniform location where to store the value
  53880. * @param array defines the array of int32 to store
  53881. */
  53882. setIntArray4(uniform: WebGLUniformLocation, array: Int32Array): void;
  53883. /**
  53884. * Set the value of an uniform to an array of float32
  53885. * @param uniform defines the webGL uniform location where to store the value
  53886. * @param array defines the array of float32 to store
  53887. */
  53888. setFloatArray(uniform: WebGLUniformLocation, array: Float32Array): void;
  53889. /**
  53890. * Set the value of an uniform to an array of float32 (stored as vec2)
  53891. * @param uniform defines the webGL uniform location where to store the value
  53892. * @param array defines the array of float32 to store
  53893. */
  53894. setFloatArray2(uniform: WebGLUniformLocation, array: Float32Array): void;
  53895. /**
  53896. * Set the value of an uniform to an array of float32 (stored as vec3)
  53897. * @param uniform defines the webGL uniform location where to store the value
  53898. * @param array defines the array of float32 to store
  53899. */
  53900. setFloatArray3(uniform: WebGLUniformLocation, array: Float32Array): void;
  53901. /**
  53902. * Set the value of an uniform to an array of float32 (stored as vec4)
  53903. * @param uniform defines the webGL uniform location where to store the value
  53904. * @param array defines the array of float32 to store
  53905. */
  53906. setFloatArray4(uniform: WebGLUniformLocation, array: Float32Array): void;
  53907. /**
  53908. * Set the value of an uniform to an array of number
  53909. * @param uniform defines the webGL uniform location where to store the value
  53910. * @param array defines the array of number to store
  53911. */
  53912. setArray(uniform: WebGLUniformLocation, array: number[]): void;
  53913. /**
  53914. * Set the value of an uniform to an array of number (stored as vec2)
  53915. * @param uniform defines the webGL uniform location where to store the value
  53916. * @param array defines the array of number to store
  53917. */
  53918. setArray2(uniform: WebGLUniformLocation, array: number[]): void;
  53919. /**
  53920. * Set the value of an uniform to an array of number (stored as vec3)
  53921. * @param uniform defines the webGL uniform location where to store the value
  53922. * @param array defines the array of number to store
  53923. */
  53924. setArray3(uniform: WebGLUniformLocation, array: number[]): void;
  53925. /**
  53926. * Set the value of an uniform to an array of number (stored as vec4)
  53927. * @param uniform defines the webGL uniform location where to store the value
  53928. * @param array defines the array of number to store
  53929. */
  53930. setArray4(uniform: WebGLUniformLocation, array: number[]): void;
  53931. /**
  53932. * Set the value of an uniform to an array of float32 (stored as matrices)
  53933. * @param uniform defines the webGL uniform location where to store the value
  53934. * @param matrices defines the array of float32 to store
  53935. */
  53936. setMatrices(uniform: WebGLUniformLocation, matrices: Float32Array): void;
  53937. /**
  53938. * Set the value of an uniform to a matrix (3x3)
  53939. * @param uniform defines the webGL uniform location where to store the value
  53940. * @param matrix defines the Float32Array representing the 3x3 matrix to store
  53941. */
  53942. setMatrix3x3(uniform: WebGLUniformLocation, matrix: Float32Array): void;
  53943. /**
  53944. * Set the value of an uniform to a matrix (2x2)
  53945. * @param uniform defines the webGL uniform location where to store the value
  53946. * @param matrix defines the Float32Array representing the 2x2 matrix to store
  53947. */
  53948. setMatrix2x2(uniform: WebGLUniformLocation, matrix: Float32Array): void;
  53949. /**
  53950. * Set the value of an uniform to a number (float)
  53951. * @param uniform defines the webGL uniform location where to store the value
  53952. * @param value defines the float number to store
  53953. */
  53954. setFloat(uniform: WebGLUniformLocation, value: number): void;
  53955. /**
  53956. * Set the value of an uniform to a vec2
  53957. * @param uniform defines the webGL uniform location where to store the value
  53958. * @param x defines the 1st component of the value
  53959. * @param y defines the 2nd component of the value
  53960. */
  53961. setFloat2(uniform: WebGLUniformLocation, x: number, y: number): void;
  53962. /**
  53963. * Set the value of an uniform to a vec3
  53964. * @param uniform defines the webGL uniform location where to store the value
  53965. * @param x defines the 1st component of the value
  53966. * @param y defines the 2nd component of the value
  53967. * @param z defines the 3rd component of the value
  53968. */
  53969. setFloat3(uniform: WebGLUniformLocation, x: number, y: number, z: number): void;
  53970. /**
  53971. * Set the value of an uniform to a boolean
  53972. * @param uniform defines the webGL uniform location where to store the value
  53973. * @param bool defines the boolean to store
  53974. */
  53975. setBool(uniform: WebGLUniformLocation, bool: number): void;
  53976. /**
  53977. * Set the value of an uniform to a vec4
  53978. * @param uniform defines the webGL uniform location where to store the value
  53979. * @param x defines the 1st component of the value
  53980. * @param y defines the 2nd component of the value
  53981. * @param z defines the 3rd component of the value
  53982. * @param w defines the 4th component of the value
  53983. */
  53984. setFloat4(uniform: WebGLUniformLocation, x: number, y: number, z: number, w: number): void;
  53985. /**
  53986. * Sets the current alpha mode
  53987. * @param mode defines the mode to use (one of the Engine.ALPHA_XXX)
  53988. * @param noDepthWriteChange defines if depth writing state should remains unchanged (false by default)
  53989. * @see https://doc.babylonjs.com/resources/transparency_and_how_meshes_are_rendered
  53990. */
  53991. setAlphaMode(mode: number, noDepthWriteChange?: boolean): void;
  53992. /**
  53993. * Bind webGl buffers directly to the webGL context
  53994. * @param vertexBuffers defines the vertex buffer to bind
  53995. * @param indexBuffer defines the index buffer to bind
  53996. * @param vertexDeclaration defines the vertex declaration to use with the vertex buffer
  53997. * @param vertexStrideSize defines the vertex stride of the vertex buffer
  53998. * @param effect defines the effect associated with the vertex buffer
  53999. */
  54000. bindBuffers(vertexBuffers: {
  54001. [key: string]: VertexBuffer;
  54002. }, indexBuffer: DataBuffer, effect: Effect): void;
  54003. /**
  54004. * Force the entire cache to be cleared
  54005. * You should not have to use this function unless your engine needs to share the webGL context with another engine
  54006. * @param bruteForce defines a boolean to force clearing ALL caches (including stencil, detoh and alpha states)
  54007. */
  54008. wipeCaches(bruteForce?: boolean): void;
  54009. /**
  54010. * Send a draw order
  54011. * @param useTriangles defines if triangles must be used to draw (else wireframe will be used)
  54012. * @param indexStart defines the starting index
  54013. * @param indexCount defines the number of index to draw
  54014. * @param instancesCount defines the number of instances to draw (if instanciation is enabled)
  54015. */
  54016. draw(useTriangles: boolean, indexStart: number, indexCount: number, instancesCount?: number): void;
  54017. /**
  54018. * Draw a list of indexed primitives
  54019. * @param fillMode defines the primitive to use
  54020. * @param indexStart defines the starting index
  54021. * @param indexCount defines the number of index to draw
  54022. * @param instancesCount defines the number of instances to draw (if instanciation is enabled)
  54023. */
  54024. drawElementsType(fillMode: number, indexStart: number, indexCount: number, instancesCount?: number): void;
  54025. /**
  54026. * Draw a list of unindexed primitives
  54027. * @param fillMode defines the primitive to use
  54028. * @param verticesStart defines the index of first vertex to draw
  54029. * @param verticesCount defines the count of vertices to draw
  54030. * @param instancesCount defines the number of instances to draw (if instanciation is enabled)
  54031. */
  54032. drawArraysType(fillMode: number, verticesStart: number, verticesCount: number, instancesCount?: number): void;
  54033. /** @hidden */
  54034. _createTexture(): WebGLTexture;
  54035. /** @hidden */
  54036. _releaseTexture(texture: InternalTexture): void;
  54037. /**
  54038. * Usually called from Texture.ts.
  54039. * Passed information to create a WebGLTexture
  54040. * @param urlArg defines a value which contains one of the following:
  54041. * * A conventional http URL, e.g. 'http://...' or 'file://...'
  54042. * * A base64 string of in-line texture data, e.g. 'data:image/jpg;base64,/...'
  54043. * * An indicator that data being passed using the buffer parameter, e.g. 'data:mytexture.jpg'
  54044. * @param noMipmap defines a boolean indicating that no mipmaps shall be generated. Ignored for compressed textures. They must be in the file
  54045. * @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)
  54046. * @param scene needed for loading to the correct scene
  54047. * @param samplingMode mode with should be used sample / access the texture (Default: Texture.TRILINEAR_SAMPLINGMODE)
  54048. * @param onLoad optional callback to be called upon successful completion
  54049. * @param onError optional callback to be called upon failure
  54050. * @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
  54051. * @param fallback an internal argument in case the function must be called again, due to etc1 not having alpha capabilities
  54052. * @param format internal format. Default: RGB when extension is '.jpg' else RGBA. Ignored for compressed textures
  54053. * @param forcedExtension defines the extension to use to pick the right loader
  54054. * @param mimeType defines an optional mime type
  54055. * @returns a InternalTexture for assignment back into BABYLON.Texture
  54056. */
  54057. 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;
  54058. /**
  54059. * Creates a new render target texture
  54060. * @param size defines the size of the texture
  54061. * @param options defines the options used to create the texture
  54062. * @returns a new render target texture stored in an InternalTexture
  54063. */
  54064. createRenderTargetTexture(size: any, options: boolean | RenderTargetCreationOptions): InternalTexture;
  54065. /**
  54066. * Update the sampling mode of a given texture
  54067. * @param samplingMode defines the required sampling mode
  54068. * @param texture defines the texture to update
  54069. */
  54070. updateTextureSamplingMode(samplingMode: number, texture: InternalTexture): void;
  54071. /**
  54072. * Binds the frame buffer to the specified texture.
  54073. * @param texture The texture to render to or null for the default canvas
  54074. * @param faceIndex The face of the texture to render to in case of cube texture
  54075. * @param requiredWidth The width of the target to render to
  54076. * @param requiredHeight The height of the target to render to
  54077. * @param forceFullscreenViewport Forces the viewport to be the entire texture/screen if true
  54078. * @param lodLevel defines le lod level to bind to the frame buffer
  54079. */
  54080. bindFramebuffer(texture: InternalTexture, faceIndex?: number, requiredWidth?: number, requiredHeight?: number, forceFullscreenViewport?: boolean): void;
  54081. /**
  54082. * Unbind the current render target texture from the webGL context
  54083. * @param texture defines the render target texture to unbind
  54084. * @param disableGenerateMipMaps defines a boolean indicating that mipmaps must not be generated
  54085. * @param onBeforeUnbind defines a function which will be called before the effective unbind
  54086. */
  54087. unBindFramebuffer(texture: InternalTexture, disableGenerateMipMaps?: boolean, onBeforeUnbind?: () => void): void;
  54088. /**
  54089. * Creates a dynamic vertex buffer
  54090. * @param vertices the data for the dynamic vertex buffer
  54091. * @returns the new WebGL dynamic buffer
  54092. */
  54093. createDynamicVertexBuffer(vertices: FloatArray): DataBuffer;
  54094. /**
  54095. * Update the content of a dynamic texture
  54096. * @param texture defines the texture to update
  54097. * @param canvas defines the canvas containing the source
  54098. * @param invertY defines if data must be stored with Y axis inverted
  54099. * @param premulAlpha defines if alpha is stored as premultiplied
  54100. * @param format defines the format of the data
  54101. * @param forceBindTexture if the texture should be forced to be bound eg. after a graphics context loss (Default: false)
  54102. */
  54103. updateDynamicTexture(texture: Nullable<InternalTexture>, canvas: HTMLCanvasElement, invertY: boolean, premulAlpha?: boolean, format?: number): void;
  54104. /**
  54105. * Gets a boolean indicating if all created effects are ready
  54106. * @returns true if all effects are ready
  54107. */
  54108. areAllEffectsReady(): boolean;
  54109. /**
  54110. * @hidden
  54111. * Get the current error code of the webGL context
  54112. * @returns the error code
  54113. * @see https://developer.mozilla.org/en-US/docs/Web/API/WebGLRenderingContext/getError
  54114. */
  54115. getError(): number;
  54116. /** @hidden */
  54117. _getUnpackAlignement(): number;
  54118. /** @hidden */
  54119. _unpackFlipY(value: boolean): void;
  54120. /**
  54121. * Update a dynamic index buffer
  54122. * @param indexBuffer defines the target index buffer
  54123. * @param indices defines the data to update
  54124. * @param offset defines the offset in the target index buffer where update should start
  54125. */
  54126. updateDynamicIndexBuffer(indexBuffer: WebGLBuffer, indices: IndicesArray, offset?: number): void;
  54127. /**
  54128. * Updates a dynamic vertex buffer.
  54129. * @param vertexBuffer the vertex buffer to update
  54130. * @param vertices the data used to update the vertex buffer
  54131. * @param byteOffset the byte offset of the data (optional)
  54132. * @param byteLength the byte length of the data (optional)
  54133. */
  54134. updateDynamicVertexBuffer(vertexBuffer: WebGLBuffer, vertices: FloatArray, byteOffset?: number, byteLength?: number): void;
  54135. /** @hidden */
  54136. _bindTextureDirectly(target: number, texture: InternalTexture): boolean;
  54137. /** @hidden */
  54138. _bindTexture(channel: number, texture: InternalTexture): void;
  54139. protected _deleteBuffer(buffer: WebGLBuffer): void;
  54140. /**
  54141. * 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
  54142. */
  54143. releaseEffects(): void;
  54144. displayLoadingUI(): void;
  54145. hideLoadingUI(): void;
  54146. /** @hidden */
  54147. _uploadCompressedDataToTextureDirectly(texture: InternalTexture, internalFormat: number, width: number, height: number, data: ArrayBufferView, faceIndex?: number, lod?: number): void;
  54148. /** @hidden */
  54149. _uploadDataToTextureDirectly(texture: InternalTexture, imageData: ArrayBufferView, faceIndex?: number, lod?: number): void;
  54150. /** @hidden */
  54151. _uploadArrayBufferViewToTexture(texture: InternalTexture, imageData: ArrayBufferView, faceIndex?: number, lod?: number): void;
  54152. /** @hidden */
  54153. _uploadImageToTexture(texture: InternalTexture, image: HTMLImageElement, faceIndex?: number, lod?: number): void;
  54154. }
  54155. }
  54156. declare module "babylonjs/Instrumentation/timeToken" {
  54157. import { Nullable } from "babylonjs/types";
  54158. /**
  54159. * @hidden
  54160. **/
  54161. export class _TimeToken {
  54162. _startTimeQuery: Nullable<WebGLQuery>;
  54163. _endTimeQuery: Nullable<WebGLQuery>;
  54164. _timeElapsedQuery: Nullable<WebGLQuery>;
  54165. _timeElapsedQueryEnded: boolean;
  54166. }
  54167. }
  54168. declare module "babylonjs/Engines/Extensions/engine.occlusionQuery" {
  54169. import { Nullable, int } from "babylonjs/types";
  54170. import { _TimeToken } from "babylonjs/Instrumentation/timeToken";
  54171. /** @hidden */
  54172. export class _OcclusionDataStorage {
  54173. /** @hidden */
  54174. occlusionInternalRetryCounter: number;
  54175. /** @hidden */
  54176. isOcclusionQueryInProgress: boolean;
  54177. /** @hidden */
  54178. isOccluded: boolean;
  54179. /** @hidden */
  54180. occlusionRetryCount: number;
  54181. /** @hidden */
  54182. occlusionType: number;
  54183. /** @hidden */
  54184. occlusionQueryAlgorithmType: number;
  54185. }
  54186. module "babylonjs/Engines/engine" {
  54187. interface Engine {
  54188. /**
  54189. * Create a new webGL query (you must be sure that queries are supported by checking getCaps() function)
  54190. * @return the new query
  54191. */
  54192. createQuery(): WebGLQuery;
  54193. /**
  54194. * Delete and release a webGL query
  54195. * @param query defines the query to delete
  54196. * @return the current engine
  54197. */
  54198. deleteQuery(query: WebGLQuery): Engine;
  54199. /**
  54200. * Check if a given query has resolved and got its value
  54201. * @param query defines the query to check
  54202. * @returns true if the query got its value
  54203. */
  54204. isQueryResultAvailable(query: WebGLQuery): boolean;
  54205. /**
  54206. * Gets the value of a given query
  54207. * @param query defines the query to check
  54208. * @returns the value of the query
  54209. */
  54210. getQueryResult(query: WebGLQuery): number;
  54211. /**
  54212. * Initiates an occlusion query
  54213. * @param algorithmType defines the algorithm to use
  54214. * @param query defines the query to use
  54215. * @returns the current engine
  54216. * @see https://doc.babylonjs.com/features/occlusionquery
  54217. */
  54218. beginOcclusionQuery(algorithmType: number, query: WebGLQuery): Engine;
  54219. /**
  54220. * Ends an occlusion query
  54221. * @see https://doc.babylonjs.com/features/occlusionquery
  54222. * @param algorithmType defines the algorithm to use
  54223. * @returns the current engine
  54224. */
  54225. endOcclusionQuery(algorithmType: number): Engine;
  54226. /**
  54227. * Starts a time query (used to measure time spent by the GPU on a specific frame)
  54228. * Please note that only one query can be issued at a time
  54229. * @returns a time token used to track the time span
  54230. */
  54231. startTimeQuery(): Nullable<_TimeToken>;
  54232. /**
  54233. * Ends a time query
  54234. * @param token defines the token used to measure the time span
  54235. * @returns the time spent (in ns)
  54236. */
  54237. endTimeQuery(token: _TimeToken): int;
  54238. /** @hidden */
  54239. _currentNonTimestampToken: Nullable<_TimeToken>;
  54240. /** @hidden */
  54241. _createTimeQuery(): WebGLQuery;
  54242. /** @hidden */
  54243. _deleteTimeQuery(query: WebGLQuery): void;
  54244. /** @hidden */
  54245. _getGlAlgorithmType(algorithmType: number): number;
  54246. /** @hidden */
  54247. _getTimeQueryResult(query: WebGLQuery): any;
  54248. /** @hidden */
  54249. _getTimeQueryAvailability(query: WebGLQuery): any;
  54250. }
  54251. }
  54252. module "babylonjs/Meshes/abstractMesh" {
  54253. interface AbstractMesh {
  54254. /**
  54255. * Backing filed
  54256. * @hidden
  54257. */
  54258. __occlusionDataStorage: _OcclusionDataStorage;
  54259. /**
  54260. * Access property
  54261. * @hidden
  54262. */
  54263. _occlusionDataStorage: _OcclusionDataStorage;
  54264. /**
  54265. * 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.
  54266. * The default value is -1 which means don't break the query and wait till the result
  54267. * @see https://doc.babylonjs.com/features/occlusionquery
  54268. */
  54269. occlusionRetryCount: number;
  54270. /**
  54271. * 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:
  54272. * * OCCLUSION_TYPE_NONE (Default Value): this option means no occlusion query whith the Mesh.
  54273. * * OCCLUSION_TYPE_OPTIMISTIC: this option is means use occlusion query and if occlusionRetryCount is reached and the query is broken show the mesh.
  54274. * * 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.
  54275. * @see https://doc.babylonjs.com/features/occlusionquery
  54276. */
  54277. occlusionType: number;
  54278. /**
  54279. * This property determines the type of occlusion query algorithm to run in WebGl, you can use:
  54280. * * AbstractMesh.OCCLUSION_ALGORITHM_TYPE_ACCURATE which is mapped to GL_ANY_SAMPLES_PASSED.
  54281. * * 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.
  54282. * @see https://doc.babylonjs.com/features/occlusionquery
  54283. */
  54284. occlusionQueryAlgorithmType: number;
  54285. /**
  54286. * 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
  54287. * @see https://doc.babylonjs.com/features/occlusionquery
  54288. */
  54289. isOccluded: boolean;
  54290. /**
  54291. * Flag to check the progress status of the query
  54292. * @see https://doc.babylonjs.com/features/occlusionquery
  54293. */
  54294. isOcclusionQueryInProgress: boolean;
  54295. }
  54296. }
  54297. }
  54298. declare module "babylonjs/Engines/Extensions/engine.transformFeedback" {
  54299. import { Nullable } from "babylonjs/types";
  54300. import { DataBuffer } from "babylonjs/Meshes/dataBuffer";
  54301. /** @hidden */
  54302. export var _forceTransformFeedbackToBundle: boolean;
  54303. module "babylonjs/Engines/engine" {
  54304. interface Engine {
  54305. /**
  54306. * Creates a webGL transform feedback object
  54307. * Please makes sure to check webGLVersion property to check if you are running webGL 2+
  54308. * @returns the webGL transform feedback object
  54309. */
  54310. createTransformFeedback(): WebGLTransformFeedback;
  54311. /**
  54312. * Delete a webGL transform feedback object
  54313. * @param value defines the webGL transform feedback object to delete
  54314. */
  54315. deleteTransformFeedback(value: WebGLTransformFeedback): void;
  54316. /**
  54317. * Bind a webGL transform feedback object to the webgl context
  54318. * @param value defines the webGL transform feedback object to bind
  54319. */
  54320. bindTransformFeedback(value: Nullable<WebGLTransformFeedback>): void;
  54321. /**
  54322. * Begins a transform feedback operation
  54323. * @param usePoints defines if points or triangles must be used
  54324. */
  54325. beginTransformFeedback(usePoints: boolean): void;
  54326. /**
  54327. * Ends a transform feedback operation
  54328. */
  54329. endTransformFeedback(): void;
  54330. /**
  54331. * Specify the varyings to use with transform feedback
  54332. * @param program defines the associated webGL program
  54333. * @param value defines the list of strings representing the varying names
  54334. */
  54335. setTranformFeedbackVaryings(program: WebGLProgram, value: string[]): void;
  54336. /**
  54337. * Bind a webGL buffer for a transform feedback operation
  54338. * @param value defines the webGL buffer to bind
  54339. */
  54340. bindTransformFeedbackBuffer(value: Nullable<DataBuffer>): void;
  54341. }
  54342. }
  54343. }
  54344. declare module "babylonjs/Engines/Extensions/engine.views" {
  54345. import { Camera } from "babylonjs/Cameras/camera";
  54346. import { Nullable } from "babylonjs/types";
  54347. /**
  54348. * Class used to define an additional view for the engine
  54349. * @see https://doc.babylonjs.com/how_to/multi_canvases
  54350. */
  54351. export class EngineView {
  54352. /** Defines the canvas where to render the view */
  54353. target: HTMLCanvasElement;
  54354. /** Defines an optional camera used to render the view (will use active camera else) */
  54355. camera?: Camera;
  54356. }
  54357. module "babylonjs/Engines/engine" {
  54358. interface Engine {
  54359. /**
  54360. * Gets or sets the HTML element to use for attaching events
  54361. */
  54362. inputElement: Nullable<HTMLElement>;
  54363. /**
  54364. * Gets the current engine view
  54365. * @see https://doc.babylonjs.com/how_to/multi_canvases
  54366. */
  54367. activeView: Nullable<EngineView>;
  54368. /** Gets or sets the list of views */
  54369. views: EngineView[];
  54370. /**
  54371. * Register a new child canvas
  54372. * @param canvas defines the canvas to register
  54373. * @param camera defines an optional camera to use with this canvas (it will overwrite the scene.camera for this view)
  54374. * @returns the associated view
  54375. */
  54376. registerView(canvas: HTMLCanvasElement, camera?: Camera): EngineView;
  54377. /**
  54378. * Remove a registered child canvas
  54379. * @param canvas defines the canvas to remove
  54380. * @returns the current engine
  54381. */
  54382. unRegisterView(canvas: HTMLCanvasElement): Engine;
  54383. }
  54384. }
  54385. }
  54386. declare module "babylonjs/Engines/Extensions/engine.textureSelector" {
  54387. import { Nullable } from "babylonjs/types";
  54388. module "babylonjs/Engines/engine" {
  54389. interface Engine {
  54390. /** @hidden */
  54391. _excludedCompressedTextures: string[];
  54392. /** @hidden */
  54393. _textureFormatInUse: string;
  54394. /**
  54395. * Gets the list of texture formats supported
  54396. */
  54397. readonly texturesSupported: Array<string>;
  54398. /**
  54399. * Gets the texture format in use
  54400. */
  54401. readonly textureFormatInUse: Nullable<string>;
  54402. /**
  54403. * Set the compressed texture extensions or file names to skip.
  54404. *
  54405. * @param skippedFiles defines the list of those texture files you want to skip
  54406. * Example: [".dds", ".env", "myfile.png"]
  54407. */
  54408. setCompressedTextureExclusions(skippedFiles: Array<string>): void;
  54409. /**
  54410. * Set the compressed texture format to use, based on the formats you have, and the formats
  54411. * supported by the hardware / browser.
  54412. *
  54413. * Khronos Texture Container (.ktx) files are used to support this. This format has the
  54414. * advantage of being specifically designed for OpenGL. Header elements directly correspond
  54415. * to API arguments needed to compressed textures. This puts the burden on the container
  54416. * generator to house the arcane code for determining these for current & future formats.
  54417. *
  54418. * for description see https://www.khronos.org/opengles/sdk/tools/KTX/
  54419. * for file layout see https://www.khronos.org/opengles/sdk/tools/KTX/file_format_spec/
  54420. *
  54421. * Note: The result of this call is not taken into account when a texture is base64.
  54422. *
  54423. * @param formatsAvailable defines the list of those format families you have created
  54424. * on your server. Syntax: '-' + format family + '.ktx'. (Case and order do not matter.)
  54425. *
  54426. * Current families are astc, dxt, pvrtc, etc2, & etc1.
  54427. * @returns The extension selected.
  54428. */
  54429. setTextureFormatToUse(formatsAvailable: Array<string>): Nullable<string>;
  54430. }
  54431. }
  54432. }
  54433. declare module "babylonjs/Engines/Extensions/index" {
  54434. export * from "babylonjs/Engines/Extensions/engine.alpha";
  54435. export * from "babylonjs/Engines/Extensions/engine.occlusionQuery";
  54436. export * from "babylonjs/Engines/Extensions/engine.transformFeedback";
  54437. export * from "babylonjs/Engines/Extensions/engine.multiview";
  54438. export * from "babylonjs/Engines/Extensions/engine.rawTexture";
  54439. export * from "babylonjs/Engines/Extensions/engine.dynamicTexture";
  54440. export * from "babylonjs/Engines/Extensions/engine.videoTexture";
  54441. export * from "babylonjs/Engines/Extensions/engine.multiRender";
  54442. export * from "babylonjs/Engines/Extensions/engine.cubeTexture";
  54443. export * from "babylonjs/Engines/Extensions/engine.renderTarget";
  54444. export * from "babylonjs/Engines/Extensions/engine.renderTargetCube";
  54445. export * from "babylonjs/Engines/Extensions/engine.webVR";
  54446. export * from "babylonjs/Engines/Extensions/engine.uniformBuffer";
  54447. export * from "babylonjs/Engines/Extensions/engine.dynamicBuffer";
  54448. export * from "babylonjs/Engines/Extensions/engine.views";
  54449. export * from "babylonjs/Engines/Extensions/engine.readTexture";
  54450. import "babylonjs/Engines/Extensions/engine.textureSelector";
  54451. export * from "babylonjs/Engines/Extensions/engine.textureSelector";
  54452. }
  54453. declare module "babylonjs/Misc/HighDynamicRange/panoramaToCubemap" {
  54454. import { Nullable } from "babylonjs/types";
  54455. /**
  54456. * CubeMap information grouping all the data for each faces as well as the cubemap size.
  54457. */
  54458. export interface CubeMapInfo {
  54459. /**
  54460. * The pixel array for the front face.
  54461. * This is stored in format, left to right, up to down format.
  54462. */
  54463. front: Nullable<ArrayBufferView>;
  54464. /**
  54465. * The pixel array for the back face.
  54466. * This is stored in format, left to right, up to down format.
  54467. */
  54468. back: Nullable<ArrayBufferView>;
  54469. /**
  54470. * The pixel array for the left face.
  54471. * This is stored in format, left to right, up to down format.
  54472. */
  54473. left: Nullable<ArrayBufferView>;
  54474. /**
  54475. * The pixel array for the right face.
  54476. * This is stored in format, left to right, up to down format.
  54477. */
  54478. right: Nullable<ArrayBufferView>;
  54479. /**
  54480. * The pixel array for the up face.
  54481. * This is stored in format, left to right, up to down format.
  54482. */
  54483. up: Nullable<ArrayBufferView>;
  54484. /**
  54485. * The pixel array for the down face.
  54486. * This is stored in format, left to right, up to down format.
  54487. */
  54488. down: Nullable<ArrayBufferView>;
  54489. /**
  54490. * The size of the cubemap stored.
  54491. *
  54492. * Each faces will be size * size pixels.
  54493. */
  54494. size: number;
  54495. /**
  54496. * The format of the texture.
  54497. *
  54498. * RGBA, RGB.
  54499. */
  54500. format: number;
  54501. /**
  54502. * The type of the texture data.
  54503. *
  54504. * UNSIGNED_INT, FLOAT.
  54505. */
  54506. type: number;
  54507. /**
  54508. * Specifies whether the texture is in gamma space.
  54509. */
  54510. gammaSpace: boolean;
  54511. }
  54512. /**
  54513. * Helper class useful to convert panorama picture to their cubemap representation in 6 faces.
  54514. */
  54515. export class PanoramaToCubeMapTools {
  54516. private static FACE_LEFT;
  54517. private static FACE_RIGHT;
  54518. private static FACE_FRONT;
  54519. private static FACE_BACK;
  54520. private static FACE_DOWN;
  54521. private static FACE_UP;
  54522. /**
  54523. * Converts a panorma stored in RGB right to left up to down format into a cubemap (6 faces).
  54524. *
  54525. * @param float32Array The source data.
  54526. * @param inputWidth The width of the input panorama.
  54527. * @param inputHeight The height of the input panorama.
  54528. * @param size The willing size of the generated cubemap (each faces will be size * size pixels)
  54529. * @return The cubemap data
  54530. */
  54531. static ConvertPanoramaToCubemap(float32Array: Float32Array, inputWidth: number, inputHeight: number, size: number): CubeMapInfo;
  54532. private static CreateCubemapTexture;
  54533. private static CalcProjectionSpherical;
  54534. }
  54535. }
  54536. declare module "babylonjs/Misc/HighDynamicRange/cubemapToSphericalPolynomial" {
  54537. import { SphericalPolynomial } from "babylonjs/Maths/sphericalPolynomial";
  54538. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  54539. import { Nullable } from "babylonjs/types";
  54540. import { CubeMapInfo } from "babylonjs/Misc/HighDynamicRange/panoramaToCubemap";
  54541. /**
  54542. * Helper class dealing with the extraction of spherical polynomial dataArray
  54543. * from a cube map.
  54544. */
  54545. export class CubeMapToSphericalPolynomialTools {
  54546. private static FileFaces;
  54547. /**
  54548. * Converts a texture to the according Spherical Polynomial data.
  54549. * This extracts the first 3 orders only as they are the only one used in the lighting.
  54550. *
  54551. * @param texture The texture to extract the information from.
  54552. * @return The Spherical Polynomial data.
  54553. */
  54554. static ConvertCubeMapTextureToSphericalPolynomial(texture: BaseTexture): Nullable<SphericalPolynomial>;
  54555. /**
  54556. * Converts a cubemap to the according Spherical Polynomial data.
  54557. * This extracts the first 3 orders only as they are the only one used in the lighting.
  54558. *
  54559. * @param cubeInfo The Cube map to extract the information from.
  54560. * @return The Spherical Polynomial data.
  54561. */
  54562. static ConvertCubeMapToSphericalPolynomial(cubeInfo: CubeMapInfo): SphericalPolynomial;
  54563. }
  54564. }
  54565. declare module "babylonjs/Materials/Textures/baseTexture.polynomial" {
  54566. import { Nullable } from "babylonjs/types";
  54567. import { SphericalPolynomial } from "babylonjs/Maths/sphericalPolynomial";
  54568. module "babylonjs/Materials/Textures/baseTexture" {
  54569. interface BaseTexture {
  54570. /**
  54571. * Get the polynomial representation of the texture data.
  54572. * This is mainly use as a fast way to recover IBL Diffuse irradiance data.
  54573. * @see https://learnopengl.com/PBR/IBL/Diffuse-irradiance
  54574. */
  54575. sphericalPolynomial: Nullable<SphericalPolynomial>;
  54576. }
  54577. }
  54578. }
  54579. declare module "babylonjs/Shaders/rgbdEncode.fragment" {
  54580. import "babylonjs/Shaders/ShadersInclude/helperFunctions";
  54581. /** @hidden */
  54582. export var rgbdEncodePixelShader: {
  54583. name: string;
  54584. shader: string;
  54585. };
  54586. }
  54587. declare module "babylonjs/Shaders/rgbdDecode.fragment" {
  54588. import "babylonjs/Shaders/ShadersInclude/helperFunctions";
  54589. /** @hidden */
  54590. export var rgbdDecodePixelShader: {
  54591. name: string;
  54592. shader: string;
  54593. };
  54594. }
  54595. declare module "babylonjs/Misc/environmentTextureTools" {
  54596. import { Nullable } from "babylonjs/types";
  54597. import { SphericalPolynomial } from "babylonjs/Maths/sphericalPolynomial";
  54598. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  54599. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  54600. import "babylonjs/Engines/Extensions/engine.renderTargetCube";
  54601. import "babylonjs/Engines/Extensions/engine.readTexture";
  54602. import "babylonjs/Materials/Textures/baseTexture.polynomial";
  54603. import "babylonjs/Shaders/rgbdEncode.fragment";
  54604. import "babylonjs/Shaders/rgbdDecode.fragment";
  54605. /**
  54606. * Raw texture data and descriptor sufficient for WebGL texture upload
  54607. */
  54608. export interface EnvironmentTextureInfo {
  54609. /**
  54610. * Version of the environment map
  54611. */
  54612. version: number;
  54613. /**
  54614. * Width of image
  54615. */
  54616. width: number;
  54617. /**
  54618. * Irradiance information stored in the file.
  54619. */
  54620. irradiance: any;
  54621. /**
  54622. * Specular information stored in the file.
  54623. */
  54624. specular: any;
  54625. }
  54626. /**
  54627. * Defines One Image in the file. It requires only the position in the file
  54628. * as well as the length.
  54629. */
  54630. interface BufferImageData {
  54631. /**
  54632. * Length of the image data.
  54633. */
  54634. length: number;
  54635. /**
  54636. * Position of the data from the null terminator delimiting the end of the JSON.
  54637. */
  54638. position: number;
  54639. }
  54640. /**
  54641. * Defines the specular data enclosed in the file.
  54642. * This corresponds to the version 1 of the data.
  54643. */
  54644. export interface EnvironmentTextureSpecularInfoV1 {
  54645. /**
  54646. * Defines where the specular Payload is located. It is a runtime value only not stored in the file.
  54647. */
  54648. specularDataPosition?: number;
  54649. /**
  54650. * This contains all the images data needed to reconstruct the cubemap.
  54651. */
  54652. mipmaps: Array<BufferImageData>;
  54653. /**
  54654. * Defines the scale applied to environment texture. This manages the range of LOD level used for IBL according to the roughness.
  54655. */
  54656. lodGenerationScale: number;
  54657. }
  54658. /**
  54659. * Sets of helpers addressing the serialization and deserialization of environment texture
  54660. * stored in a BabylonJS env file.
  54661. * Those files are usually stored as .env files.
  54662. */
  54663. export class EnvironmentTextureTools {
  54664. /**
  54665. * Magic number identifying the env file.
  54666. */
  54667. private static _MagicBytes;
  54668. /**
  54669. * Gets the environment info from an env file.
  54670. * @param data The array buffer containing the .env bytes.
  54671. * @returns the environment file info (the json header) if successfully parsed.
  54672. */
  54673. static GetEnvInfo(data: ArrayBufferView): Nullable<EnvironmentTextureInfo>;
  54674. /**
  54675. * Creates an environment texture from a loaded cube texture.
  54676. * @param texture defines the cube texture to convert in env file
  54677. * @return a promise containing the environment data if succesfull.
  54678. */
  54679. static CreateEnvTextureAsync(texture: BaseTexture): Promise<ArrayBuffer>;
  54680. /**
  54681. * Creates a JSON representation of the spherical data.
  54682. * @param texture defines the texture containing the polynomials
  54683. * @return the JSON representation of the spherical info
  54684. */
  54685. private static _CreateEnvTextureIrradiance;
  54686. /**
  54687. * Creates the ArrayBufferViews used for initializing environment texture image data.
  54688. * @param data the image data
  54689. * @param info parameters that determine what views will be created for accessing the underlying buffer
  54690. * @return the views described by info providing access to the underlying buffer
  54691. */
  54692. static CreateImageDataArrayBufferViews(data: ArrayBufferView, info: EnvironmentTextureInfo): Array<Array<ArrayBufferView>>;
  54693. /**
  54694. * Uploads the texture info contained in the env file to the GPU.
  54695. * @param texture defines the internal texture to upload to
  54696. * @param data defines the data to load
  54697. * @param info defines the texture info retrieved through the GetEnvInfo method
  54698. * @returns a promise
  54699. */
  54700. static UploadEnvLevelsAsync(texture: InternalTexture, data: ArrayBufferView, info: EnvironmentTextureInfo): Promise<void>;
  54701. private static _OnImageReadyAsync;
  54702. /**
  54703. * Uploads the levels of image data to the GPU.
  54704. * @param texture defines the internal texture to upload to
  54705. * @param imageData defines the array buffer views of image data [mipmap][face]
  54706. * @returns a promise
  54707. */
  54708. static UploadLevelsAsync(texture: InternalTexture, imageData: ArrayBufferView[][]): Promise<void>;
  54709. /**
  54710. * Uploads spherical polynomials information to the texture.
  54711. * @param texture defines the texture we are trying to upload the information to
  54712. * @param info defines the environment texture info retrieved through the GetEnvInfo method
  54713. */
  54714. static UploadEnvSpherical(texture: InternalTexture, info: EnvironmentTextureInfo): void;
  54715. /** @hidden */
  54716. static _UpdateRGBDAsync(internalTexture: InternalTexture, data: ArrayBufferView[][], sphericalPolynomial: Nullable<SphericalPolynomial>, lodScale: number, lodOffset: number): Promise<void>;
  54717. }
  54718. }
  54719. declare module "babylonjs/Engines/Processors/shaderCodeInliner" {
  54720. /**
  54721. * Class used to inline functions in shader code
  54722. */
  54723. export class ShaderCodeInliner {
  54724. private static readonly _RegexpFindFunctionNameAndType;
  54725. private _sourceCode;
  54726. private _functionDescr;
  54727. private _numMaxIterations;
  54728. /** Gets or sets the token used to mark the functions to inline */
  54729. inlineToken: string;
  54730. /** Gets or sets the debug mode */
  54731. debug: boolean;
  54732. /** Gets the code after the inlining process */
  54733. get code(): string;
  54734. /**
  54735. * Initializes the inliner
  54736. * @param sourceCode shader code source to inline
  54737. * @param numMaxIterations maximum number of iterations (used to detect recursive calls)
  54738. */
  54739. constructor(sourceCode: string, numMaxIterations?: number);
  54740. /**
  54741. * Start the processing of the shader code
  54742. */
  54743. processCode(): void;
  54744. private _collectFunctions;
  54745. private _processInlining;
  54746. private _extractBetweenMarkers;
  54747. private _skipWhitespaces;
  54748. private _removeComments;
  54749. private _replaceFunctionCallsByCode;
  54750. private _findBackward;
  54751. private _escapeRegExp;
  54752. private _replaceNames;
  54753. }
  54754. }
  54755. declare module "babylonjs/Engines/nativeEngine" {
  54756. import { Nullable, IndicesArray, DataArray } from "babylonjs/types";
  54757. import { Engine } from "babylonjs/Engines/engine";
  54758. import { VertexBuffer } from "babylonjs/Meshes/buffer";
  54759. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  54760. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  54761. import { Effect } from "babylonjs/Materials/effect";
  54762. import { DataBuffer } from "babylonjs/Meshes/dataBuffer";
  54763. import { Matrix, Viewport, Color3 } from "babylonjs/Maths/math";
  54764. import { IColor4Like } from "babylonjs/Maths/math.like";
  54765. import { Scene } from "babylonjs/scene";
  54766. import { RenderTargetCreationOptions } from "babylonjs/Materials/Textures/renderTargetCreationOptions";
  54767. import { IPipelineContext } from "babylonjs/Engines/IPipelineContext";
  54768. import { ISceneLike } from "babylonjs/Engines/thinEngine";
  54769. /**
  54770. * Container for accessors for natively-stored mesh data buffers.
  54771. */
  54772. class NativeDataBuffer extends DataBuffer {
  54773. /**
  54774. * Accessor value used to identify/retrieve a natively-stored index buffer.
  54775. */
  54776. nativeIndexBuffer?: any;
  54777. /**
  54778. * Accessor value used to identify/retrieve a natively-stored vertex buffer.
  54779. */
  54780. nativeVertexBuffer?: any;
  54781. }
  54782. /** @hidden */
  54783. class NativeTexture extends InternalTexture {
  54784. getInternalTexture(): InternalTexture;
  54785. getViewCount(): number;
  54786. }
  54787. /** @hidden */
  54788. export class NativeEngine extends Engine {
  54789. private readonly _native;
  54790. /** Defines the invalid handle returned by bgfx when resource creation goes wrong */
  54791. private readonly INVALID_HANDLE;
  54792. private _boundBuffersVertexArray;
  54793. getHardwareScalingLevel(): number;
  54794. constructor();
  54795. dispose(): void;
  54796. /**
  54797. * Can be used to override the current requestAnimationFrame requester.
  54798. * @hidden
  54799. */
  54800. protected _queueNewFrame(bindedRenderFunction: any, requester?: any): number;
  54801. /**
  54802. * Override default engine behavior.
  54803. * @param color
  54804. * @param backBuffer
  54805. * @param depth
  54806. * @param stencil
  54807. */
  54808. _bindUnboundFramebuffer(framebuffer: Nullable<WebGLFramebuffer>): void;
  54809. /**
  54810. * Gets host document
  54811. * @returns the host document object
  54812. */
  54813. getHostDocument(): Nullable<Document>;
  54814. clear(color: Nullable<IColor4Like>, backBuffer: boolean, depth: boolean, stencil?: boolean): void;
  54815. createIndexBuffer(indices: IndicesArray, updateable?: boolean): NativeDataBuffer;
  54816. createVertexBuffer(data: DataArray, updateable?: boolean): NativeDataBuffer;
  54817. protected _recordVertexArrayObject(vertexArray: any, vertexBuffers: {
  54818. [key: string]: VertexBuffer;
  54819. }, indexBuffer: Nullable<NativeDataBuffer>, effect: Effect): void;
  54820. bindBuffers(vertexBuffers: {
  54821. [key: string]: VertexBuffer;
  54822. }, indexBuffer: Nullable<NativeDataBuffer>, effect: Effect): void;
  54823. recordVertexArrayObject(vertexBuffers: {
  54824. [key: string]: VertexBuffer;
  54825. }, indexBuffer: Nullable<NativeDataBuffer>, effect: Effect): WebGLVertexArrayObject;
  54826. bindVertexArrayObject(vertexArray: WebGLVertexArrayObject): void;
  54827. releaseVertexArrayObject(vertexArray: WebGLVertexArrayObject): void;
  54828. getAttributes(pipelineContext: IPipelineContext, attributesNames: string[]): number[];
  54829. /**
  54830. * Draw a list of indexed primitives
  54831. * @param fillMode defines the primitive to use
  54832. * @param indexStart defines the starting index
  54833. * @param indexCount defines the number of index to draw
  54834. * @param instancesCount defines the number of instances to draw (if instanciation is enabled)
  54835. */
  54836. drawElementsType(fillMode: number, indexStart: number, indexCount: number, instancesCount?: number): void;
  54837. /**
  54838. * Draw a list of unindexed primitives
  54839. * @param fillMode defines the primitive to use
  54840. * @param verticesStart defines the index of first vertex to draw
  54841. * @param verticesCount defines the count of vertices to draw
  54842. * @param instancesCount defines the number of instances to draw (if instanciation is enabled)
  54843. */
  54844. drawArraysType(fillMode: number, verticesStart: number, verticesCount: number, instancesCount?: number): void;
  54845. createPipelineContext(): IPipelineContext;
  54846. _preparePipelineContext(pipelineContext: IPipelineContext, vertexSourceCode: string, fragmentSourceCode: string, createAsRaw: boolean, rebuildRebind: any, defines: Nullable<string>, transformFeedbackVaryings: Nullable<string[]>): void;
  54847. /** @hidden */
  54848. _isRenderingStateCompiled(pipelineContext: IPipelineContext): boolean;
  54849. /** @hidden */
  54850. _executeWhenRenderingStateIsCompiled(pipelineContext: IPipelineContext, action: () => void): void;
  54851. createRawShaderProgram(pipelineContext: IPipelineContext, vertexCode: string, fragmentCode: string, context?: WebGLRenderingContext, transformFeedbackVaryings?: Nullable<string[]>): any;
  54852. createShaderProgram(pipelineContext: IPipelineContext, vertexCode: string, fragmentCode: string, defines: Nullable<string>, context?: WebGLRenderingContext, transformFeedbackVaryings?: Nullable<string[]>): any;
  54853. protected _setProgram(program: WebGLProgram): void;
  54854. _releaseEffect(effect: Effect): void;
  54855. _deletePipelineContext(pipelineContext: IPipelineContext): void;
  54856. getUniforms(pipelineContext: IPipelineContext, uniformsNames: string[]): WebGLUniformLocation[];
  54857. bindUniformBlock(pipelineContext: IPipelineContext, blockName: string, index: number): void;
  54858. bindSamplers(effect: Effect): void;
  54859. setMatrix(uniform: WebGLUniformLocation, matrix: Matrix): void;
  54860. getRenderWidth(useScreen?: boolean): number;
  54861. getRenderHeight(useScreen?: boolean): number;
  54862. setViewport(viewport: Viewport, requiredWidth?: number, requiredHeight?: number): void;
  54863. setState(culling: boolean, zOffset?: number, force?: boolean, reverseSide?: boolean): void;
  54864. /**
  54865. * Set the z offset to apply to current rendering
  54866. * @param value defines the offset to apply
  54867. */
  54868. setZOffset(value: number): void;
  54869. /**
  54870. * Gets the current value of the zOffset
  54871. * @returns the current zOffset state
  54872. */
  54873. getZOffset(): number;
  54874. /**
  54875. * Enable or disable depth buffering
  54876. * @param enable defines the state to set
  54877. */
  54878. setDepthBuffer(enable: boolean): void;
  54879. /**
  54880. * Gets a boolean indicating if depth writing is enabled
  54881. * @returns the current depth writing state
  54882. */
  54883. getDepthWrite(): boolean;
  54884. /**
  54885. * Enable or disable depth writing
  54886. * @param enable defines the state to set
  54887. */
  54888. setDepthWrite(enable: boolean): void;
  54889. /**
  54890. * Enable or disable color writing
  54891. * @param enable defines the state to set
  54892. */
  54893. setColorWrite(enable: boolean): void;
  54894. /**
  54895. * Gets a boolean indicating if color writing is enabled
  54896. * @returns the current color writing state
  54897. */
  54898. getColorWrite(): boolean;
  54899. /**
  54900. * Sets alpha constants used by some alpha blending modes
  54901. * @param r defines the red component
  54902. * @param g defines the green component
  54903. * @param b defines the blue component
  54904. * @param a defines the alpha component
  54905. */
  54906. setAlphaConstants(r: number, g: number, b: number, a: number): void;
  54907. /**
  54908. * Sets the current alpha mode
  54909. * @param mode defines the mode to use (one of the BABYLON.Constants.ALPHA_XXX)
  54910. * @param noDepthWriteChange defines if depth writing state should remains unchanged (false by default)
  54911. * @see https://doc.babylonjs.com/resources/transparency_and_how_meshes_are_rendered
  54912. */
  54913. setAlphaMode(mode: number, noDepthWriteChange?: boolean): void;
  54914. /**
  54915. * Gets the current alpha mode
  54916. * @see https://doc.babylonjs.com/resources/transparency_and_how_meshes_are_rendered
  54917. * @returns the current alpha mode
  54918. */
  54919. getAlphaMode(): number;
  54920. setInt(uniform: WebGLUniformLocation, int: number): void;
  54921. setIntArray(uniform: WebGLUniformLocation, array: Int32Array): void;
  54922. setIntArray2(uniform: WebGLUniformLocation, array: Int32Array): void;
  54923. setIntArray3(uniform: WebGLUniformLocation, array: Int32Array): void;
  54924. setIntArray4(uniform: WebGLUniformLocation, array: Int32Array): void;
  54925. setFloatArray(uniform: WebGLUniformLocation, array: Float32Array): void;
  54926. setFloatArray2(uniform: WebGLUniformLocation, array: Float32Array): void;
  54927. setFloatArray3(uniform: WebGLUniformLocation, array: Float32Array): void;
  54928. setFloatArray4(uniform: WebGLUniformLocation, array: Float32Array): void;
  54929. setArray(uniform: WebGLUniformLocation, array: number[]): void;
  54930. setArray2(uniform: WebGLUniformLocation, array: number[]): void;
  54931. setArray3(uniform: WebGLUniformLocation, array: number[]): void;
  54932. setArray4(uniform: WebGLUniformLocation, array: number[]): void;
  54933. setMatrices(uniform: WebGLUniformLocation, matrices: Float32Array): void;
  54934. setMatrix3x3(uniform: WebGLUniformLocation, matrix: Float32Array): void;
  54935. setMatrix2x2(uniform: WebGLUniformLocation, matrix: Float32Array): void;
  54936. setFloat(uniform: WebGLUniformLocation, value: number): void;
  54937. setFloat2(uniform: WebGLUniformLocation, x: number, y: number): void;
  54938. setFloat3(uniform: WebGLUniformLocation, x: number, y: number, z: number): void;
  54939. setFloat4(uniform: WebGLUniformLocation, x: number, y: number, z: number, w: number): void;
  54940. setColor3(uniform: WebGLUniformLocation, color3: Color3): void;
  54941. setColor4(uniform: WebGLUniformLocation, color3: Color3, alpha: number): void;
  54942. wipeCaches(bruteForce?: boolean): void;
  54943. _createTexture(): WebGLTexture;
  54944. protected _deleteTexture(texture: Nullable<WebGLTexture>): void;
  54945. /**
  54946. * Usually called from Texture.ts.
  54947. * Passed information to create a WebGLTexture
  54948. * @param url defines a value which contains one of the following:
  54949. * * A conventional http URL, e.g. 'http://...' or 'file://...'
  54950. * * A base64 string of in-line texture data, e.g. 'data:image/jpg;base64,/...'
  54951. * * An indicator that data being passed using the buffer parameter, e.g. 'data:mytexture.jpg'
  54952. * @param noMipmap defines a boolean indicating that no mipmaps shall be generated. Ignored for compressed textures. They must be in the file
  54953. * @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)
  54954. * @param scene needed for loading to the correct scene
  54955. * @param samplingMode mode with should be used sample / access the texture (Default: Texture.TRILINEAR_SAMPLINGMODE)
  54956. * @param onLoad optional callback to be called upon successful completion
  54957. * @param onError optional callback to be called upon failure
  54958. * @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
  54959. * @param fallback an internal argument in case the function must be called again, due to etc1 not having alpha capabilities
  54960. * @param format internal format. Default: RGB when extension is '.jpg' else RGBA. Ignored for compressed textures
  54961. * @param forcedExtension defines the extension to use to pick the right loader
  54962. * @param mimeType defines an optional mime type
  54963. * @returns a InternalTexture for assignment back into BABYLON.Texture
  54964. */
  54965. 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;
  54966. /**
  54967. * Creates a cube texture
  54968. * @param rootUrl defines the url where the files to load is located
  54969. * @param scene defines the current scene
  54970. * @param files defines the list of files to load (1 per face)
  54971. * @param noMipmap defines a boolean indicating that no mipmaps shall be generated (false by default)
  54972. * @param onLoad defines an optional callback raised when the texture is loaded
  54973. * @param onError defines an optional callback raised if there is an issue to load the texture
  54974. * @param format defines the format of the data
  54975. * @param forcedExtension defines the extension to use to pick the right loader
  54976. * @param createPolynomials if a polynomial sphere should be created for the cube texture
  54977. * @param lodScale defines the scale applied to environment texture. This manages the range of LOD level used for IBL according to the roughness
  54978. * @param lodOffset defines the offset applied to environment texture. This manages first LOD level used for IBL according to the roughness
  54979. * @param fallback defines texture to use while falling back when (compressed) texture file not found.
  54980. * @returns the cube texture as an InternalTexture
  54981. */
  54982. 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;
  54983. private _getSamplingFilter;
  54984. private static _GetNativeTextureFormat;
  54985. createRenderTargetTexture(size: number | {
  54986. width: number;
  54987. height: number;
  54988. }, options: boolean | RenderTargetCreationOptions): NativeTexture;
  54989. updateTextureSamplingMode(samplingMode: number, texture: InternalTexture): void;
  54990. bindFramebuffer(texture: InternalTexture, faceIndex?: number, requiredWidth?: number, requiredHeight?: number, forceFullscreenViewport?: boolean): void;
  54991. unBindFramebuffer(texture: InternalTexture, disableGenerateMipMaps?: boolean, onBeforeUnbind?: () => void): void;
  54992. createDynamicVertexBuffer(data: DataArray): DataBuffer;
  54993. updateDynamicIndexBuffer(indexBuffer: DataBuffer, indices: IndicesArray, offset?: number): void;
  54994. /**
  54995. * Updates a dynamic vertex buffer.
  54996. * @param vertexBuffer the vertex buffer to update
  54997. * @param data the data used to update the vertex buffer
  54998. * @param byteOffset the byte offset of the data (optional)
  54999. * @param byteLength the byte length of the data (optional)
  55000. */
  55001. updateDynamicVertexBuffer(vertexBuffer: DataBuffer, data: DataArray, byteOffset?: number, byteLength?: number): void;
  55002. protected _setTexture(channel: number, texture: Nullable<BaseTexture>, isPartOfTextureArray?: boolean, depthStencilTexture?: boolean): boolean;
  55003. private _updateAnisotropicLevel;
  55004. private _getAddressMode;
  55005. /** @hidden */
  55006. _bindTexture(channel: number, texture: InternalTexture): void;
  55007. protected _deleteBuffer(buffer: NativeDataBuffer): void;
  55008. releaseEffects(): void;
  55009. /** @hidden */
  55010. _uploadCompressedDataToTextureDirectly(texture: InternalTexture, internalFormat: number, width: number, height: number, data: ArrayBufferView, faceIndex?: number, lod?: number): void;
  55011. /** @hidden */
  55012. _uploadDataToTextureDirectly(texture: InternalTexture, imageData: ArrayBufferView, faceIndex?: number, lod?: number): void;
  55013. /** @hidden */
  55014. _uploadArrayBufferViewToTexture(texture: InternalTexture, imageData: ArrayBufferView, faceIndex?: number, lod?: number): void;
  55015. /** @hidden */
  55016. _uploadImageToTexture(texture: InternalTexture, image: HTMLImageElement, faceIndex?: number, lod?: number): void;
  55017. }
  55018. }
  55019. declare module "babylonjs/Engines/index" {
  55020. export * from "babylonjs/Engines/constants";
  55021. export * from "babylonjs/Engines/engineCapabilities";
  55022. export * from "babylonjs/Engines/instancingAttributeInfo";
  55023. export * from "babylonjs/Engines/thinEngine";
  55024. export * from "babylonjs/Engines/engine";
  55025. export * from "babylonjs/Engines/engineStore";
  55026. export * from "babylonjs/Engines/nullEngine";
  55027. export * from "babylonjs/Engines/Extensions/index";
  55028. export * from "babylonjs/Engines/IPipelineContext";
  55029. export * from "babylonjs/Engines/WebGL/webGLPipelineContext";
  55030. export * from "babylonjs/Engines/WebGL/webGL2ShaderProcessors";
  55031. export * from "babylonjs/Engines/nativeEngine";
  55032. export * from "babylonjs/Engines/Processors/shaderCodeInliner";
  55033. export * from "babylonjs/Engines/performanceConfigurator";
  55034. }
  55035. declare module "babylonjs/Events/clipboardEvents" {
  55036. /**
  55037. * Gather the list of clipboard event types as constants.
  55038. */
  55039. export class ClipboardEventTypes {
  55040. /**
  55041. * The clipboard event is fired when a copy command is active (pressed).
  55042. */
  55043. static readonly COPY: number;
  55044. /**
  55045. * The clipboard event is fired when a cut command is active (pressed).
  55046. */
  55047. static readonly CUT: number;
  55048. /**
  55049. * The clipboard event is fired when a paste command is active (pressed).
  55050. */
  55051. static readonly PASTE: number;
  55052. }
  55053. /**
  55054. * This class is used to store clipboard related info for the onClipboardObservable event.
  55055. */
  55056. export class ClipboardInfo {
  55057. /**
  55058. * Defines the type of event (BABYLON.ClipboardEventTypes)
  55059. */
  55060. type: number;
  55061. /**
  55062. * Defines the related dom event
  55063. */
  55064. event: ClipboardEvent;
  55065. /**
  55066. *Creates an instance of ClipboardInfo.
  55067. * @param type Defines the type of event (BABYLON.ClipboardEventTypes)
  55068. * @param event Defines the related dom event
  55069. */
  55070. constructor(
  55071. /**
  55072. * Defines the type of event (BABYLON.ClipboardEventTypes)
  55073. */
  55074. type: number,
  55075. /**
  55076. * Defines the related dom event
  55077. */
  55078. event: ClipboardEvent);
  55079. /**
  55080. * Get the clipboard event's type from the keycode.
  55081. * @param keyCode Defines the keyCode for the current keyboard event.
  55082. * @return {number}
  55083. */
  55084. static GetTypeFromCharacter(keyCode: number): number;
  55085. }
  55086. }
  55087. declare module "babylonjs/Events/index" {
  55088. export * from "babylonjs/Events/keyboardEvents";
  55089. export * from "babylonjs/Events/pointerEvents";
  55090. export * from "babylonjs/Events/clipboardEvents";
  55091. }
  55092. declare module "babylonjs/Gamepads/Controllers/daydreamController" {
  55093. import { Scene } from "babylonjs/scene";
  55094. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  55095. import { GamepadButtonChanges } from "babylonjs/Gamepads/gamepad";
  55096. import { WebVRController } from "babylonjs/Gamepads/Controllers/webVRController";
  55097. import { ExtendedGamepadButton } from "babylonjs/Gamepads/Controllers/poseEnabledController";
  55098. /**
  55099. * Google Daydream controller
  55100. */
  55101. export class DaydreamController extends WebVRController {
  55102. /**
  55103. * Base Url for the controller model.
  55104. */
  55105. static MODEL_BASE_URL: string;
  55106. /**
  55107. * File name for the controller model.
  55108. */
  55109. static MODEL_FILENAME: string;
  55110. /**
  55111. * Gamepad Id prefix used to identify Daydream Controller.
  55112. */
  55113. static readonly GAMEPAD_ID_PREFIX: string;
  55114. /**
  55115. * Creates a new DaydreamController from a gamepad
  55116. * @param vrGamepad the gamepad that the controller should be created from
  55117. */
  55118. constructor(vrGamepad: any);
  55119. /**
  55120. * Implements abstract method on WebVRController class, loading controller meshes and calling this.attachToMesh if successful.
  55121. * @param scene scene in which to add meshes
  55122. * @param meshLoaded optional callback function that will be called if the mesh loads successfully.
  55123. */
  55124. initControllerMesh(scene: Scene, meshLoaded?: (mesh: AbstractMesh) => void): void;
  55125. /**
  55126. * Called once for each button that changed state since the last frame
  55127. * @param buttonIdx Which button index changed
  55128. * @param state New state of the button
  55129. * @param changes Which properties on the state changed since last frame
  55130. */
  55131. protected _handleButtonChange(buttonIdx: number, state: ExtendedGamepadButton, changes: GamepadButtonChanges): void;
  55132. }
  55133. }
  55134. declare module "babylonjs/Gamepads/Controllers/gearVRController" {
  55135. import { Scene } from "babylonjs/scene";
  55136. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  55137. import { GamepadButtonChanges } from "babylonjs/Gamepads/gamepad";
  55138. import { WebVRController } from "babylonjs/Gamepads/Controllers/webVRController";
  55139. import { ExtendedGamepadButton } from "babylonjs/Gamepads/Controllers/poseEnabledController";
  55140. /**
  55141. * Gear VR Controller
  55142. */
  55143. export class GearVRController extends WebVRController {
  55144. /**
  55145. * Base Url for the controller model.
  55146. */
  55147. static MODEL_BASE_URL: string;
  55148. /**
  55149. * File name for the controller model.
  55150. */
  55151. static MODEL_FILENAME: string;
  55152. /**
  55153. * Gamepad Id prefix used to identify this controller.
  55154. */
  55155. static readonly GAMEPAD_ID_PREFIX: string;
  55156. private readonly _buttonIndexToObservableNameMap;
  55157. /**
  55158. * Creates a new GearVRController from a gamepad
  55159. * @param vrGamepad the gamepad that the controller should be created from
  55160. */
  55161. constructor(vrGamepad: any);
  55162. /**
  55163. * Implements abstract method on WebVRController class, loading controller meshes and calling this.attachToMesh if successful.
  55164. * @param scene scene in which to add meshes
  55165. * @param meshLoaded optional callback function that will be called if the mesh loads successfully.
  55166. */
  55167. initControllerMesh(scene: Scene, meshLoaded?: (mesh: AbstractMesh) => void): void;
  55168. /**
  55169. * Called once for each button that changed state since the last frame
  55170. * @param buttonIdx Which button index changed
  55171. * @param state New state of the button
  55172. * @param changes Which properties on the state changed since last frame
  55173. */
  55174. protected _handleButtonChange(buttonIdx: number, state: ExtendedGamepadButton, changes: GamepadButtonChanges): void;
  55175. }
  55176. }
  55177. declare module "babylonjs/Gamepads/Controllers/genericController" {
  55178. import { Scene } from "babylonjs/scene";
  55179. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  55180. import { WebVRController } from "babylonjs/Gamepads/Controllers/webVRController";
  55181. import { ExtendedGamepadButton } from "babylonjs/Gamepads/Controllers/poseEnabledController";
  55182. import { GamepadButtonChanges } from "babylonjs/Gamepads/gamepad";
  55183. /**
  55184. * Generic Controller
  55185. */
  55186. export class GenericController extends WebVRController {
  55187. /**
  55188. * Base Url for the controller model.
  55189. */
  55190. static readonly MODEL_BASE_URL: string;
  55191. /**
  55192. * File name for the controller model.
  55193. */
  55194. static readonly MODEL_FILENAME: string;
  55195. /**
  55196. * Creates a new GenericController from a gamepad
  55197. * @param vrGamepad the gamepad that the controller should be created from
  55198. */
  55199. constructor(vrGamepad: any);
  55200. /**
  55201. * Implements abstract method on WebVRController class, loading controller meshes and calling this.attachToMesh if successful.
  55202. * @param scene scene in which to add meshes
  55203. * @param meshLoaded optional callback function that will be called if the mesh loads successfully.
  55204. */
  55205. initControllerMesh(scene: Scene, meshLoaded?: (mesh: AbstractMesh) => void): void;
  55206. /**
  55207. * Called once for each button that changed state since the last frame
  55208. * @param buttonIdx Which button index changed
  55209. * @param state New state of the button
  55210. * @param changes Which properties on the state changed since last frame
  55211. */
  55212. protected _handleButtonChange(buttonIdx: number, state: ExtendedGamepadButton, changes: GamepadButtonChanges): void;
  55213. }
  55214. }
  55215. declare module "babylonjs/Gamepads/Controllers/oculusTouchController" {
  55216. import { Observable } from "babylonjs/Misc/observable";
  55217. import { Scene } from "babylonjs/scene";
  55218. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  55219. import { WebVRController } from "babylonjs/Gamepads/Controllers/webVRController";
  55220. import { ExtendedGamepadButton } from "babylonjs/Gamepads/Controllers/poseEnabledController";
  55221. import { GamepadButtonChanges } from "babylonjs/Gamepads/gamepad";
  55222. /**
  55223. * Oculus Touch Controller
  55224. */
  55225. export class OculusTouchController extends WebVRController {
  55226. /**
  55227. * Base Url for the controller model.
  55228. */
  55229. static MODEL_BASE_URL: string;
  55230. /**
  55231. * File name for the left controller model.
  55232. */
  55233. static MODEL_LEFT_FILENAME: string;
  55234. /**
  55235. * File name for the right controller model.
  55236. */
  55237. static MODEL_RIGHT_FILENAME: string;
  55238. /**
  55239. * Base Url for the Quest controller model.
  55240. */
  55241. static QUEST_MODEL_BASE_URL: string;
  55242. /**
  55243. * @hidden
  55244. * If the controllers are running on a device that needs the updated Quest controller models
  55245. */
  55246. static _IsQuest: boolean;
  55247. /**
  55248. * Fired when the secondary trigger on this controller is modified
  55249. */
  55250. onSecondaryTriggerStateChangedObservable: Observable<ExtendedGamepadButton>;
  55251. /**
  55252. * Fired when the thumb rest on this controller is modified
  55253. */
  55254. onThumbRestChangedObservable: Observable<ExtendedGamepadButton>;
  55255. /**
  55256. * Creates a new OculusTouchController from a gamepad
  55257. * @param vrGamepad the gamepad that the controller should be created from
  55258. */
  55259. constructor(vrGamepad: any);
  55260. /**
  55261. * Implements abstract method on WebVRController class, loading controller meshes and calling this.attachToMesh if successful.
  55262. * @param scene scene in which to add meshes
  55263. * @param meshLoaded optional callback function that will be called if the mesh loads successfully.
  55264. */
  55265. initControllerMesh(scene: Scene, meshLoaded?: (mesh: AbstractMesh) => void): void;
  55266. /**
  55267. * Fired when the A button on this controller is modified
  55268. */
  55269. get onAButtonStateChangedObservable(): Observable<ExtendedGamepadButton>;
  55270. /**
  55271. * Fired when the B button on this controller is modified
  55272. */
  55273. get onBButtonStateChangedObservable(): Observable<ExtendedGamepadButton>;
  55274. /**
  55275. * Fired when the X button on this controller is modified
  55276. */
  55277. get onXButtonStateChangedObservable(): Observable<ExtendedGamepadButton>;
  55278. /**
  55279. * Fired when the Y button on this controller is modified
  55280. */
  55281. get onYButtonStateChangedObservable(): Observable<ExtendedGamepadButton>;
  55282. /**
  55283. * Called once for each button that changed state since the last frame
  55284. * 0) thumb stick (touch, press, value = pressed (0,1)). value is in this.leftStick
  55285. * 1) index trigger (touch (?), press (only when value > 0.1), value 0 to 1)
  55286. * 2) secondary trigger (same)
  55287. * 3) A (right) X (left), touch, pressed = value
  55288. * 4) B / Y
  55289. * 5) thumb rest
  55290. * @param buttonIdx Which button index changed
  55291. * @param state New state of the button
  55292. * @param changes Which properties on the state changed since last frame
  55293. */
  55294. protected _handleButtonChange(buttonIdx: number, state: ExtendedGamepadButton, changes: GamepadButtonChanges): void;
  55295. }
  55296. }
  55297. declare module "babylonjs/Gamepads/Controllers/viveController" {
  55298. import { Scene } from "babylonjs/scene";
  55299. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  55300. import { WebVRController } from "babylonjs/Gamepads/Controllers/webVRController";
  55301. import { ExtendedGamepadButton } from "babylonjs/Gamepads/Controllers/poseEnabledController";
  55302. import { GamepadButtonChanges } from "babylonjs/Gamepads/gamepad";
  55303. import { Observable } from "babylonjs/Misc/observable";
  55304. /**
  55305. * Vive Controller
  55306. */
  55307. export class ViveController extends WebVRController {
  55308. /**
  55309. * Base Url for the controller model.
  55310. */
  55311. static MODEL_BASE_URL: string;
  55312. /**
  55313. * File name for the controller model.
  55314. */
  55315. static MODEL_FILENAME: string;
  55316. /**
  55317. * Creates a new ViveController from a gamepad
  55318. * @param vrGamepad the gamepad that the controller should be created from
  55319. */
  55320. constructor(vrGamepad: any);
  55321. /**
  55322. * Implements abstract method on WebVRController class, loading controller meshes and calling this.attachToMesh if successful.
  55323. * @param scene scene in which to add meshes
  55324. * @param meshLoaded optional callback function that will be called if the mesh loads successfully.
  55325. */
  55326. initControllerMesh(scene: Scene, meshLoaded?: (mesh: AbstractMesh) => void): void;
  55327. /**
  55328. * Fired when the left button on this controller is modified
  55329. */
  55330. get onLeftButtonStateChangedObservable(): Observable<ExtendedGamepadButton>;
  55331. /**
  55332. * Fired when the right button on this controller is modified
  55333. */
  55334. get onRightButtonStateChangedObservable(): Observable<ExtendedGamepadButton>;
  55335. /**
  55336. * Fired when the menu button on this controller is modified
  55337. */
  55338. get onMenuButtonStateChangedObservable(): Observable<ExtendedGamepadButton>;
  55339. /**
  55340. * Called once for each button that changed state since the last frame
  55341. * Vive mapping:
  55342. * 0: touchpad
  55343. * 1: trigger
  55344. * 2: left AND right buttons
  55345. * 3: menu button
  55346. * @param buttonIdx Which button index changed
  55347. * @param state New state of the button
  55348. * @param changes Which properties on the state changed since last frame
  55349. */
  55350. protected _handleButtonChange(buttonIdx: number, state: ExtendedGamepadButton, changes: GamepadButtonChanges): void;
  55351. }
  55352. }
  55353. declare module "babylonjs/Gamepads/Controllers/windowsMotionController" {
  55354. import { Observable } from "babylonjs/Misc/observable";
  55355. import { Scene } from "babylonjs/scene";
  55356. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  55357. import { Ray } from "babylonjs/Culling/ray";
  55358. import { WebVRController } from "babylonjs/Gamepads/Controllers/webVRController";
  55359. import { ExtendedGamepadButton } from "babylonjs/Gamepads/Controllers/poseEnabledController";
  55360. import { StickValues, GamepadButtonChanges } from "babylonjs/Gamepads/gamepad";
  55361. /**
  55362. * Defines the WindowsMotionController object that the state of the windows motion controller
  55363. */
  55364. export class WindowsMotionController extends WebVRController {
  55365. /**
  55366. * The base url used to load the left and right controller models
  55367. */
  55368. static MODEL_BASE_URL: string;
  55369. /**
  55370. * The name of the left controller model file
  55371. */
  55372. static MODEL_LEFT_FILENAME: string;
  55373. /**
  55374. * The name of the right controller model file
  55375. */
  55376. static MODEL_RIGHT_FILENAME: string;
  55377. /**
  55378. * The controller name prefix for this controller type
  55379. */
  55380. static readonly GAMEPAD_ID_PREFIX: string;
  55381. /**
  55382. * The controller id pattern for this controller type
  55383. */
  55384. private static readonly GAMEPAD_ID_PATTERN;
  55385. private _loadedMeshInfo;
  55386. protected readonly _mapping: {
  55387. buttons: string[];
  55388. buttonMeshNames: {
  55389. trigger: string;
  55390. menu: string;
  55391. grip: string;
  55392. thumbstick: string;
  55393. trackpad: string;
  55394. };
  55395. buttonObservableNames: {
  55396. trigger: string;
  55397. menu: string;
  55398. grip: string;
  55399. thumbstick: string;
  55400. trackpad: string;
  55401. };
  55402. axisMeshNames: string[];
  55403. pointingPoseMeshName: string;
  55404. };
  55405. /**
  55406. * Fired when the trackpad on this controller is clicked
  55407. */
  55408. onTrackpadChangedObservable: Observable<ExtendedGamepadButton>;
  55409. /**
  55410. * Fired when the trackpad on this controller is modified
  55411. */
  55412. onTrackpadValuesChangedObservable: Observable<StickValues>;
  55413. /**
  55414. * The current x and y values of this controller's trackpad
  55415. */
  55416. trackpad: StickValues;
  55417. /**
  55418. * Creates a new WindowsMotionController from a gamepad
  55419. * @param vrGamepad the gamepad that the controller should be created from
  55420. */
  55421. constructor(vrGamepad: any);
  55422. /**
  55423. * Fired when the trigger on this controller is modified
  55424. */
  55425. get onTriggerButtonStateChangedObservable(): Observable<ExtendedGamepadButton>;
  55426. /**
  55427. * Fired when the menu button on this controller is modified
  55428. */
  55429. get onMenuButtonStateChangedObservable(): Observable<ExtendedGamepadButton>;
  55430. /**
  55431. * Fired when the grip button on this controller is modified
  55432. */
  55433. get onGripButtonStateChangedObservable(): Observable<ExtendedGamepadButton>;
  55434. /**
  55435. * Fired when the thumbstick button on this controller is modified
  55436. */
  55437. get onThumbstickButtonStateChangedObservable(): Observable<ExtendedGamepadButton>;
  55438. /**
  55439. * Fired when the touchpad button on this controller is modified
  55440. */
  55441. get onTouchpadButtonStateChangedObservable(): Observable<ExtendedGamepadButton>;
  55442. /**
  55443. * Fired when the touchpad values on this controller are modified
  55444. */
  55445. get onTouchpadValuesChangedObservable(): Observable<StickValues>;
  55446. protected _updateTrackpad(): void;
  55447. /**
  55448. * Called once per frame by the engine.
  55449. */
  55450. update(): void;
  55451. /**
  55452. * Called once for each button that changed state since the last frame
  55453. * @param buttonIdx Which button index changed
  55454. * @param state New state of the button
  55455. * @param changes Which properties on the state changed since last frame
  55456. */
  55457. protected _handleButtonChange(buttonIdx: number, state: ExtendedGamepadButton, changes: GamepadButtonChanges): void;
  55458. /**
  55459. * Moves the buttons on the controller mesh based on their current state
  55460. * @param buttonName the name of the button to move
  55461. * @param buttonValue the value of the button which determines the buttons new position
  55462. */
  55463. protected _lerpButtonTransform(buttonName: string, buttonValue: number): void;
  55464. /**
  55465. * Moves the axis on the controller mesh based on its current state
  55466. * @param axis the index of the axis
  55467. * @param axisValue the value of the axis which determines the meshes new position
  55468. * @hidden
  55469. */
  55470. protected _lerpAxisTransform(axis: number, axisValue: number): void;
  55471. /**
  55472. * Implements abstract method on WebVRController class, loading controller meshes and calling this.attachToMesh if successful.
  55473. * @param scene scene in which to add meshes
  55474. * @param meshLoaded optional callback function that will be called if the mesh loads successfully.
  55475. */
  55476. initControllerMesh(scene: Scene, meshLoaded?: (mesh: AbstractMesh) => void, forceDefault?: boolean): void;
  55477. /**
  55478. * Takes a list of meshes (as loaded from the glTF file) and finds the root node, as well as nodes that
  55479. * can be transformed by button presses and axes values, based on this._mapping.
  55480. *
  55481. * @param scene scene in which the meshes exist
  55482. * @param meshes list of meshes that make up the controller model to process
  55483. * @return structured view of the given meshes, with mapping of buttons and axes to meshes that can be transformed.
  55484. */
  55485. private processModel;
  55486. private createMeshInfo;
  55487. /**
  55488. * Gets the ray of the controller in the direction the controller is pointing
  55489. * @param length the length the resulting ray should be
  55490. * @returns a ray in the direction the controller is pointing
  55491. */
  55492. getForwardRay(length?: number): Ray;
  55493. /**
  55494. * Disposes of the controller
  55495. */
  55496. dispose(): void;
  55497. }
  55498. /**
  55499. * This class represents a new windows motion controller in XR.
  55500. */
  55501. export class XRWindowsMotionController extends WindowsMotionController {
  55502. /**
  55503. * Changing the original WIndowsMotionController mapping to fir the new mapping
  55504. */
  55505. protected readonly _mapping: {
  55506. buttons: string[];
  55507. buttonMeshNames: {
  55508. trigger: string;
  55509. menu: string;
  55510. grip: string;
  55511. thumbstick: string;
  55512. trackpad: string;
  55513. };
  55514. buttonObservableNames: {
  55515. trigger: string;
  55516. menu: string;
  55517. grip: string;
  55518. thumbstick: string;
  55519. trackpad: string;
  55520. };
  55521. axisMeshNames: string[];
  55522. pointingPoseMeshName: string;
  55523. };
  55524. /**
  55525. * Construct a new XR-Based windows motion controller
  55526. *
  55527. * @param gamepadInfo the gamepad object from the browser
  55528. */
  55529. constructor(gamepadInfo: any);
  55530. /**
  55531. * holds the thumbstick values (X,Y)
  55532. */
  55533. thumbstickValues: StickValues;
  55534. /**
  55535. * Fired when the thumbstick on this controller is clicked
  55536. */
  55537. onThumbstickStateChangedObservable: Observable<ExtendedGamepadButton>;
  55538. /**
  55539. * Fired when the thumbstick on this controller is modified
  55540. */
  55541. onThumbstickValuesChangedObservable: Observable<StickValues>;
  55542. /**
  55543. * Fired when the touchpad button on this controller is modified
  55544. */
  55545. onTrackpadChangedObservable: Observable<ExtendedGamepadButton>;
  55546. /**
  55547. * Fired when the touchpad values on this controller are modified
  55548. */
  55549. onTrackpadValuesChangedObservable: Observable<StickValues>;
  55550. /**
  55551. * Fired when the thumbstick button on this controller is modified
  55552. * here to prevent breaking changes
  55553. */
  55554. get onThumbstickButtonStateChangedObservable(): Observable<ExtendedGamepadButton>;
  55555. /**
  55556. * updating the thumbstick(!) and not the trackpad.
  55557. * This is named this way due to the difference between WebVR and XR and to avoid
  55558. * changing the parent class.
  55559. */
  55560. protected _updateTrackpad(): void;
  55561. /**
  55562. * Disposes the class with joy
  55563. */
  55564. dispose(): void;
  55565. }
  55566. }
  55567. declare module "babylonjs/Gamepads/Controllers/index" {
  55568. export * from "babylonjs/Gamepads/Controllers/daydreamController";
  55569. export * from "babylonjs/Gamepads/Controllers/gearVRController";
  55570. export * from "babylonjs/Gamepads/Controllers/genericController";
  55571. export * from "babylonjs/Gamepads/Controllers/oculusTouchController";
  55572. export * from "babylonjs/Gamepads/Controllers/poseEnabledController";
  55573. export * from "babylonjs/Gamepads/Controllers/viveController";
  55574. export * from "babylonjs/Gamepads/Controllers/webVRController";
  55575. export * from "babylonjs/Gamepads/Controllers/windowsMotionController";
  55576. }
  55577. declare module "babylonjs/Gamepads/index" {
  55578. export * from "babylonjs/Gamepads/Controllers/index";
  55579. export * from "babylonjs/Gamepads/gamepad";
  55580. export * from "babylonjs/Gamepads/gamepadManager";
  55581. export * from "babylonjs/Gamepads/gamepadSceneComponent";
  55582. export * from "babylonjs/Gamepads/xboxGamepad";
  55583. export * from "babylonjs/Gamepads/dualShockGamepad";
  55584. }
  55585. declare module "babylonjs/Meshes/Builders/polyhedronBuilder" {
  55586. import { Scene } from "babylonjs/scene";
  55587. import { Vector4 } from "babylonjs/Maths/math.vector";
  55588. import { Color4 } from "babylonjs/Maths/math.color";
  55589. import { Mesh } from "babylonjs/Meshes/mesh";
  55590. import { Nullable } from "babylonjs/types";
  55591. /**
  55592. * Class containing static functions to help procedurally build meshes
  55593. */
  55594. export class PolyhedronBuilder {
  55595. /**
  55596. * Creates a polyhedron mesh
  55597. * * 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
  55598. * * The parameter `size` (positive float, default 1) sets the polygon size
  55599. * * You can overwrite the `size` on each dimension bu using the parameters `sizeX`, `sizeY` or `sizeZ` (positive floats, default to `size` value)
  55600. * * 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`
  55601. * * 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
  55602. * * 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)`)
  55603. * * 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
  55604. * * 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
  55605. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  55606. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  55607. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  55608. * @param name defines the name of the mesh
  55609. * @param options defines the options used to create the mesh
  55610. * @param scene defines the hosting scene
  55611. * @returns the polyhedron mesh
  55612. * @see https://doc.babylonjs.com/how_to/polyhedra_shapes
  55613. */
  55614. static CreatePolyhedron(name: string, options: {
  55615. type?: number;
  55616. size?: number;
  55617. sizeX?: number;
  55618. sizeY?: number;
  55619. sizeZ?: number;
  55620. custom?: any;
  55621. faceUV?: Vector4[];
  55622. faceColors?: Color4[];
  55623. flat?: boolean;
  55624. updatable?: boolean;
  55625. sideOrientation?: number;
  55626. frontUVs?: Vector4;
  55627. backUVs?: Vector4;
  55628. }, scene?: Nullable<Scene>): Mesh;
  55629. }
  55630. }
  55631. declare module "babylonjs/Gizmos/scaleGizmo" {
  55632. import { Observable } from "babylonjs/Misc/observable";
  55633. import { Nullable } from "babylonjs/types";
  55634. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  55635. import { Gizmo } from "babylonjs/Gizmos/gizmo";
  55636. import { AxisScaleGizmo } from "babylonjs/Gizmos/axisScaleGizmo";
  55637. import { UtilityLayerRenderer } from "babylonjs/Rendering/utilityLayerRenderer";
  55638. import { Node } from "babylonjs/node";
  55639. /**
  55640. * Gizmo that enables scaling a mesh along 3 axis
  55641. */
  55642. export class ScaleGizmo extends Gizmo {
  55643. /**
  55644. * Internal gizmo used for interactions on the x axis
  55645. */
  55646. xGizmo: AxisScaleGizmo;
  55647. /**
  55648. * Internal gizmo used for interactions on the y axis
  55649. */
  55650. yGizmo: AxisScaleGizmo;
  55651. /**
  55652. * Internal gizmo used for interactions on the z axis
  55653. */
  55654. zGizmo: AxisScaleGizmo;
  55655. /**
  55656. * Internal gizmo used to scale all axis equally
  55657. */
  55658. uniformScaleGizmo: AxisScaleGizmo;
  55659. private _meshAttached;
  55660. private _nodeAttached;
  55661. private _snapDistance;
  55662. private _uniformScalingMesh;
  55663. private _octahedron;
  55664. private _sensitivity;
  55665. /** Fires an event when any of it's sub gizmos are dragged */
  55666. onDragStartObservable: Observable<unknown>;
  55667. /** Fires an event when any of it's sub gizmos are released from dragging */
  55668. onDragEndObservable: Observable<unknown>;
  55669. get attachedMesh(): Nullable<AbstractMesh>;
  55670. set attachedMesh(mesh: Nullable<AbstractMesh>);
  55671. get attachedNode(): Nullable<Node>;
  55672. set attachedNode(node: Nullable<Node>);
  55673. /**
  55674. * Creates a ScaleGizmo
  55675. * @param gizmoLayer The utility layer the gizmo will be added to
  55676. * @param thickness display gizmo axis thickness
  55677. */
  55678. constructor(gizmoLayer?: UtilityLayerRenderer, thickness?: number);
  55679. set updateGizmoRotationToMatchAttachedMesh(value: boolean);
  55680. get updateGizmoRotationToMatchAttachedMesh(): boolean;
  55681. /**
  55682. * Drag distance in babylon units that the gizmo will snap to when dragged (Default: 0)
  55683. */
  55684. set snapDistance(value: number);
  55685. get snapDistance(): number;
  55686. /**
  55687. * Ratio for the scale of the gizmo (Default: 1)
  55688. */
  55689. set scaleRatio(value: number);
  55690. get scaleRatio(): number;
  55691. /**
  55692. * Sensitivity factor for dragging (Default: 1)
  55693. */
  55694. set sensitivity(value: number);
  55695. get sensitivity(): number;
  55696. /**
  55697. * Disposes of the gizmo
  55698. */
  55699. dispose(): void;
  55700. }
  55701. }
  55702. declare module "babylonjs/Gizmos/axisScaleGizmo" {
  55703. import { Observable } from "babylonjs/Misc/observable";
  55704. import { Nullable } from "babylonjs/types";
  55705. import { Vector3 } from "babylonjs/Maths/math.vector";
  55706. import { Node } from "babylonjs/node";
  55707. import { Mesh } from "babylonjs/Meshes/mesh";
  55708. import { PointerDragBehavior } from "babylonjs/Behaviors/Meshes/pointerDragBehavior";
  55709. import { Gizmo } from "babylonjs/Gizmos/gizmo";
  55710. import { UtilityLayerRenderer } from "babylonjs/Rendering/utilityLayerRenderer";
  55711. import { ScaleGizmo } from "babylonjs/Gizmos/scaleGizmo";
  55712. import { Color3 } from "babylonjs/Maths/math.color";
  55713. /**
  55714. * Single axis scale gizmo
  55715. */
  55716. export class AxisScaleGizmo extends Gizmo {
  55717. /**
  55718. * Drag behavior responsible for the gizmos dragging interactions
  55719. */
  55720. dragBehavior: PointerDragBehavior;
  55721. private _pointerObserver;
  55722. /**
  55723. * Scale distance in babylon units that the gizmo will snap to when dragged (Default: 0)
  55724. */
  55725. snapDistance: number;
  55726. /**
  55727. * Event that fires each time the gizmo snaps to a new location.
  55728. * * snapDistance is the the change in distance
  55729. */
  55730. onSnapObservable: Observable<{
  55731. snapDistance: number;
  55732. }>;
  55733. /**
  55734. * If the scaling operation should be done on all axis (default: false)
  55735. */
  55736. uniformScaling: boolean;
  55737. /**
  55738. * Custom sensitivity value for the drag strength
  55739. */
  55740. sensitivity: number;
  55741. private _isEnabled;
  55742. private _parent;
  55743. private _arrow;
  55744. private _coloredMaterial;
  55745. private _hoverMaterial;
  55746. /**
  55747. * Creates an AxisScaleGizmo
  55748. * @param gizmoLayer The utility layer the gizmo will be added to
  55749. * @param dragAxis The axis which the gizmo will be able to scale on
  55750. * @param color The color of the gizmo
  55751. * @param thickness display gizmo axis thickness
  55752. */
  55753. constructor(dragAxis: Vector3, color?: Color3, gizmoLayer?: UtilityLayerRenderer, parent?: Nullable<ScaleGizmo>, thickness?: number);
  55754. protected _attachedNodeChanged(value: Nullable<Node>): void;
  55755. /**
  55756. * If the gizmo is enabled
  55757. */
  55758. set isEnabled(value: boolean);
  55759. get isEnabled(): boolean;
  55760. /**
  55761. * Disposes of the gizmo
  55762. */
  55763. dispose(): void;
  55764. /**
  55765. * Disposes and replaces the current meshes in the gizmo with the specified mesh
  55766. * @param mesh The mesh to replace the default mesh of the gizmo
  55767. * @param useGizmoMaterial If the gizmo's default material should be used (default: false)
  55768. */
  55769. setCustomMesh(mesh: Mesh, useGizmoMaterial?: boolean): void;
  55770. }
  55771. }
  55772. declare module "babylonjs/Gizmos/boundingBoxGizmo" {
  55773. import { Observable } from "babylonjs/Misc/observable";
  55774. import { Nullable } from "babylonjs/types";
  55775. import { Vector3 } from "babylonjs/Maths/math.vector";
  55776. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  55777. import { Mesh } from "babylonjs/Meshes/mesh";
  55778. import { Gizmo } from "babylonjs/Gizmos/gizmo";
  55779. import { UtilityLayerRenderer } from "babylonjs/Rendering/utilityLayerRenderer";
  55780. import { Color3 } from "babylonjs/Maths/math.color";
  55781. import "babylonjs/Meshes/Builders/boxBuilder";
  55782. /**
  55783. * Bounding box gizmo
  55784. */
  55785. export class BoundingBoxGizmo extends Gizmo {
  55786. private _lineBoundingBox;
  55787. private _rotateSpheresParent;
  55788. private _scaleBoxesParent;
  55789. private _boundingDimensions;
  55790. private _renderObserver;
  55791. private _pointerObserver;
  55792. private _scaleDragSpeed;
  55793. private _tmpQuaternion;
  55794. private _tmpVector;
  55795. private _tmpRotationMatrix;
  55796. /**
  55797. * 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)
  55798. */
  55799. ignoreChildren: boolean;
  55800. /**
  55801. * 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)
  55802. */
  55803. includeChildPredicate: Nullable<(abstractMesh: AbstractMesh) => boolean>;
  55804. /**
  55805. * The size of the rotation spheres attached to the bounding box (Default: 0.1)
  55806. */
  55807. rotationSphereSize: number;
  55808. /**
  55809. * The size of the scale boxes attached to the bounding box (Default: 0.1)
  55810. */
  55811. scaleBoxSize: number;
  55812. /**
  55813. * 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)
  55814. */
  55815. fixedDragMeshScreenSize: boolean;
  55816. /**
  55817. * The distance away from the object which the draggable meshes should appear world sized when fixedDragMeshScreenSize is set to true (default: 10)
  55818. */
  55819. fixedDragMeshScreenSizeDistanceFactor: number;
  55820. /**
  55821. * Fired when a rotation sphere or scale box is dragged
  55822. */
  55823. onDragStartObservable: Observable<{}>;
  55824. /**
  55825. * Fired when a scale box is dragged
  55826. */
  55827. onScaleBoxDragObservable: Observable<{}>;
  55828. /**
  55829. * Fired when a scale box drag is ended
  55830. */
  55831. onScaleBoxDragEndObservable: Observable<{}>;
  55832. /**
  55833. * Fired when a rotation sphere is dragged
  55834. */
  55835. onRotationSphereDragObservable: Observable<{}>;
  55836. /**
  55837. * Fired when a rotation sphere drag is ended
  55838. */
  55839. onRotationSphereDragEndObservable: Observable<{}>;
  55840. /**
  55841. * 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)
  55842. */
  55843. scalePivot: Nullable<Vector3>;
  55844. /**
  55845. * Mesh used as a pivot to rotate the attached node
  55846. */
  55847. private _anchorMesh;
  55848. private _existingMeshScale;
  55849. private _dragMesh;
  55850. private pointerDragBehavior;
  55851. private coloredMaterial;
  55852. private hoverColoredMaterial;
  55853. /**
  55854. * Sets the color of the bounding box gizmo
  55855. * @param color the color to set
  55856. */
  55857. setColor(color: Color3): void;
  55858. /**
  55859. * Creates an BoundingBoxGizmo
  55860. * @param gizmoLayer The utility layer the gizmo will be added to
  55861. * @param color The color of the gizmo
  55862. */
  55863. constructor(color?: Color3, gizmoLayer?: UtilityLayerRenderer);
  55864. protected _attachedNodeChanged(value: Nullable<AbstractMesh>): void;
  55865. private _selectNode;
  55866. /**
  55867. * Updates the bounding box information for the Gizmo
  55868. */
  55869. updateBoundingBox(): void;
  55870. private _updateRotationSpheres;
  55871. private _updateScaleBoxes;
  55872. /**
  55873. * Enables rotation on the specified axis and disables rotation on the others
  55874. * @param axis The list of axis that should be enabled (eg. "xy" or "xyz")
  55875. */
  55876. setEnabledRotationAxis(axis: string): void;
  55877. /**
  55878. * Enables/disables scaling
  55879. * @param enable if scaling should be enabled
  55880. * @param homogeneousScaling defines if scaling should only be homogeneous
  55881. */
  55882. setEnabledScaling(enable: boolean, homogeneousScaling?: boolean): void;
  55883. private _updateDummy;
  55884. /**
  55885. * Enables a pointer drag behavior on the bounding box of the gizmo
  55886. */
  55887. enableDragBehavior(): void;
  55888. /**
  55889. * Disposes of the gizmo
  55890. */
  55891. dispose(): void;
  55892. /**
  55893. * 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)
  55894. * @param mesh the mesh to wrap in the bounding box mesh and make not pickable
  55895. * @returns the bounding box mesh with the passed in mesh as a child
  55896. */
  55897. static MakeNotPickableAndWrapInBoundingBox(mesh: Mesh): Mesh;
  55898. /**
  55899. * CustomMeshes are not supported by this gizmo
  55900. * @param mesh The mesh to replace the default mesh of the gizmo
  55901. */
  55902. setCustomMesh(mesh: Mesh): void;
  55903. }
  55904. }
  55905. declare module "babylonjs/Gizmos/planeRotationGizmo" {
  55906. import { Observable } from "babylonjs/Misc/observable";
  55907. import { Nullable } from "babylonjs/types";
  55908. import { Vector3 } from "babylonjs/Maths/math.vector";
  55909. import { Color3 } from "babylonjs/Maths/math.color";
  55910. import { Node } from "babylonjs/node";
  55911. import { PointerDragBehavior } from "babylonjs/Behaviors/Meshes/pointerDragBehavior";
  55912. import { Gizmo } from "babylonjs/Gizmos/gizmo";
  55913. import { UtilityLayerRenderer } from "babylonjs/Rendering/utilityLayerRenderer";
  55914. import "babylonjs/Meshes/Builders/linesBuilder";
  55915. import { RotationGizmo } from "babylonjs/Gizmos/rotationGizmo";
  55916. /**
  55917. * Single plane rotation gizmo
  55918. */
  55919. export class PlaneRotationGizmo extends Gizmo {
  55920. /**
  55921. * Drag behavior responsible for the gizmos dragging interactions
  55922. */
  55923. dragBehavior: PointerDragBehavior;
  55924. private _pointerObserver;
  55925. /**
  55926. * Rotation distance in radians that the gizmo will snap to (Default: 0)
  55927. */
  55928. snapDistance: number;
  55929. /**
  55930. * Event that fires each time the gizmo snaps to a new location.
  55931. * * snapDistance is the the change in distance
  55932. */
  55933. onSnapObservable: Observable<{
  55934. snapDistance: number;
  55935. }>;
  55936. private _isEnabled;
  55937. private _parent;
  55938. /**
  55939. * Creates a PlaneRotationGizmo
  55940. * @param gizmoLayer The utility layer the gizmo will be added to
  55941. * @param planeNormal The normal of the plane which the gizmo will be able to rotate on
  55942. * @param color The color of the gizmo
  55943. * @param tessellation Amount of tessellation to be used when creating rotation circles
  55944. * @param useEulerRotation Use and update Euler angle instead of quaternion
  55945. * @param thickness display gizmo axis thickness
  55946. */
  55947. constructor(planeNormal: Vector3, color?: Color3, gizmoLayer?: UtilityLayerRenderer, tessellation?: number, parent?: Nullable<RotationGizmo>, useEulerRotation?: boolean, thickness?: number);
  55948. protected _attachedNodeChanged(value: Nullable<Node>): void;
  55949. /**
  55950. * If the gizmo is enabled
  55951. */
  55952. set isEnabled(value: boolean);
  55953. get isEnabled(): boolean;
  55954. /**
  55955. * Disposes of the gizmo
  55956. */
  55957. dispose(): void;
  55958. }
  55959. }
  55960. declare module "babylonjs/Gizmos/rotationGizmo" {
  55961. import { Observable } from "babylonjs/Misc/observable";
  55962. import { Nullable } from "babylonjs/types";
  55963. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  55964. import { Mesh } from "babylonjs/Meshes/mesh";
  55965. import { Gizmo } from "babylonjs/Gizmos/gizmo";
  55966. import { PlaneRotationGizmo } from "babylonjs/Gizmos/planeRotationGizmo";
  55967. import { UtilityLayerRenderer } from "babylonjs/Rendering/utilityLayerRenderer";
  55968. import { Node } from "babylonjs/node";
  55969. /**
  55970. * Gizmo that enables rotating a mesh along 3 axis
  55971. */
  55972. export class RotationGizmo extends Gizmo {
  55973. /**
  55974. * Internal gizmo used for interactions on the x axis
  55975. */
  55976. xGizmo: PlaneRotationGizmo;
  55977. /**
  55978. * Internal gizmo used for interactions on the y axis
  55979. */
  55980. yGizmo: PlaneRotationGizmo;
  55981. /**
  55982. * Internal gizmo used for interactions on the z axis
  55983. */
  55984. zGizmo: PlaneRotationGizmo;
  55985. /** Fires an event when any of it's sub gizmos are dragged */
  55986. onDragStartObservable: Observable<unknown>;
  55987. /** Fires an event when any of it's sub gizmos are released from dragging */
  55988. onDragEndObservable: Observable<unknown>;
  55989. private _meshAttached;
  55990. private _nodeAttached;
  55991. get attachedMesh(): Nullable<AbstractMesh>;
  55992. set attachedMesh(mesh: Nullable<AbstractMesh>);
  55993. get attachedNode(): Nullable<Node>;
  55994. set attachedNode(node: Nullable<Node>);
  55995. /**
  55996. * Creates a RotationGizmo
  55997. * @param gizmoLayer The utility layer the gizmo will be added to
  55998. * @param tessellation Amount of tessellation to be used when creating rotation circles
  55999. * @param useEulerRotation Use and update Euler angle instead of quaternion
  56000. * @param thickness display gizmo axis thickness
  56001. */
  56002. constructor(gizmoLayer?: UtilityLayerRenderer, tessellation?: number, useEulerRotation?: boolean, thickness?: number);
  56003. set updateGizmoRotationToMatchAttachedMesh(value: boolean);
  56004. get updateGizmoRotationToMatchAttachedMesh(): boolean;
  56005. /**
  56006. * Drag distance in babylon units that the gizmo will snap to when dragged (Default: 0)
  56007. */
  56008. set snapDistance(value: number);
  56009. get snapDistance(): number;
  56010. /**
  56011. * Ratio for the scale of the gizmo (Default: 1)
  56012. */
  56013. set scaleRatio(value: number);
  56014. get scaleRatio(): number;
  56015. /**
  56016. * Disposes of the gizmo
  56017. */
  56018. dispose(): void;
  56019. /**
  56020. * CustomMeshes are not supported by this gizmo
  56021. * @param mesh The mesh to replace the default mesh of the gizmo
  56022. */
  56023. setCustomMesh(mesh: Mesh): void;
  56024. }
  56025. }
  56026. declare module "babylonjs/Gizmos/gizmoManager" {
  56027. import { Observable } from "babylonjs/Misc/observable";
  56028. import { Nullable } from "babylonjs/types";
  56029. import { Scene, IDisposable } from "babylonjs/scene";
  56030. import { Node } from "babylonjs/node";
  56031. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  56032. import { UtilityLayerRenderer } from "babylonjs/Rendering/utilityLayerRenderer";
  56033. import { SixDofDragBehavior } from "babylonjs/Behaviors/Meshes/sixDofDragBehavior";
  56034. import { RotationGizmo } from "babylonjs/Gizmos/rotationGizmo";
  56035. import { PositionGizmo } from "babylonjs/Gizmos/positionGizmo";
  56036. import { ScaleGizmo } from "babylonjs/Gizmos/scaleGizmo";
  56037. import { BoundingBoxGizmo } from "babylonjs/Gizmos/boundingBoxGizmo";
  56038. /**
  56039. * Helps setup gizmo's in the scene to rotate/scale/position nodes
  56040. */
  56041. export class GizmoManager implements IDisposable {
  56042. private scene;
  56043. /**
  56044. * Gizmo's created by the gizmo manager, gizmo will be null until gizmo has been enabled for the first time
  56045. */
  56046. gizmos: {
  56047. positionGizmo: Nullable<PositionGizmo>;
  56048. rotationGizmo: Nullable<RotationGizmo>;
  56049. scaleGizmo: Nullable<ScaleGizmo>;
  56050. boundingBoxGizmo: Nullable<BoundingBoxGizmo>;
  56051. };
  56052. /** When true, the gizmo will be detached from the current object when a pointer down occurs with an empty picked mesh */
  56053. clearGizmoOnEmptyPointerEvent: boolean;
  56054. /** Fires an event when the manager is attached to a mesh */
  56055. onAttachedToMeshObservable: Observable<Nullable<AbstractMesh>>;
  56056. /** Fires an event when the manager is attached to a node */
  56057. onAttachedToNodeObservable: Observable<Nullable<Node>>;
  56058. private _gizmosEnabled;
  56059. private _pointerObserver;
  56060. private _attachedMesh;
  56061. private _attachedNode;
  56062. private _boundingBoxColor;
  56063. private _defaultUtilityLayer;
  56064. private _defaultKeepDepthUtilityLayer;
  56065. private _thickness;
  56066. /**
  56067. * When bounding box gizmo is enabled, this can be used to track drag/end events
  56068. */
  56069. boundingBoxDragBehavior: SixDofDragBehavior;
  56070. /**
  56071. * Array of meshes which will have the gizmo attached when a pointer selected them. If null, all meshes are attachable. (Default: null)
  56072. */
  56073. attachableMeshes: Nullable<Array<AbstractMesh>>;
  56074. /**
  56075. * Array of nodes which will have the gizmo attached when a pointer selected them. If null, all nodes are attachable. (Default: null)
  56076. */
  56077. attachableNodes: Nullable<Array<Node>>;
  56078. /**
  56079. * If pointer events should perform attaching/detaching a gizmo, if false this can be done manually via attachToMesh/attachToNode. (Default: true)
  56080. */
  56081. usePointerToAttachGizmos: boolean;
  56082. /**
  56083. * Utility layer that the bounding box gizmo belongs to
  56084. */
  56085. get keepDepthUtilityLayer(): UtilityLayerRenderer;
  56086. /**
  56087. * Utility layer that all gizmos besides bounding box belong to
  56088. */
  56089. get utilityLayer(): UtilityLayerRenderer;
  56090. /**
  56091. * Instatiates a gizmo manager
  56092. * @param scene the scene to overlay the gizmos on top of
  56093. * @param thickness display gizmo axis thickness
  56094. */
  56095. constructor(scene: Scene, thickness?: number);
  56096. /**
  56097. * Attaches a set of gizmos to the specified mesh
  56098. * @param mesh The mesh the gizmo's should be attached to
  56099. */
  56100. attachToMesh(mesh: Nullable<AbstractMesh>): void;
  56101. /**
  56102. * Attaches a set of gizmos to the specified node
  56103. * @param node The node the gizmo's should be attached to
  56104. */
  56105. attachToNode(node: Nullable<Node>): void;
  56106. /**
  56107. * If the position gizmo is enabled
  56108. */
  56109. set positionGizmoEnabled(value: boolean);
  56110. get positionGizmoEnabled(): boolean;
  56111. /**
  56112. * If the rotation gizmo is enabled
  56113. */
  56114. set rotationGizmoEnabled(value: boolean);
  56115. get rotationGizmoEnabled(): boolean;
  56116. /**
  56117. * If the scale gizmo is enabled
  56118. */
  56119. set scaleGizmoEnabled(value: boolean);
  56120. get scaleGizmoEnabled(): boolean;
  56121. /**
  56122. * If the boundingBox gizmo is enabled
  56123. */
  56124. set boundingBoxGizmoEnabled(value: boolean);
  56125. get boundingBoxGizmoEnabled(): boolean;
  56126. /**
  56127. * Disposes of the gizmo manager
  56128. */
  56129. dispose(): void;
  56130. }
  56131. }
  56132. declare module "babylonjs/Lights/directionalLight" {
  56133. import { Camera } from "babylonjs/Cameras/camera";
  56134. import { Scene } from "babylonjs/scene";
  56135. import { Matrix, Vector3 } from "babylonjs/Maths/math.vector";
  56136. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  56137. import { Light } from "babylonjs/Lights/light";
  56138. import { ShadowLight } from "babylonjs/Lights/shadowLight";
  56139. import { Effect } from "babylonjs/Materials/effect";
  56140. /**
  56141. * A directional light is defined by a direction (what a surprise!).
  56142. * The light is emitted from everywhere in the specified direction, and has an infinite range.
  56143. * 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.
  56144. * Documentation: https://doc.babylonjs.com/babylon101/lights
  56145. */
  56146. export class DirectionalLight extends ShadowLight {
  56147. private _shadowFrustumSize;
  56148. /**
  56149. * Fix frustum size for the shadow generation. This is disabled if the value is 0.
  56150. */
  56151. get shadowFrustumSize(): number;
  56152. /**
  56153. * Specifies a fix frustum size for the shadow generation.
  56154. */
  56155. set shadowFrustumSize(value: number);
  56156. private _shadowOrthoScale;
  56157. /**
  56158. * Gets the shadow projection scale against the optimal computed one.
  56159. * 0.1 by default which means that the projection window is increase by 10% from the optimal size.
  56160. * This does not impact in fixed frustum size (shadowFrustumSize being set)
  56161. */
  56162. get shadowOrthoScale(): number;
  56163. /**
  56164. * Sets the shadow projection scale against the optimal computed one.
  56165. * 0.1 by default which means that the projection window is increase by 10% from the optimal size.
  56166. * This does not impact in fixed frustum size (shadowFrustumSize being set)
  56167. */
  56168. set shadowOrthoScale(value: number);
  56169. /**
  56170. * Automatically compute the projection matrix to best fit (including all the casters)
  56171. * on each frame.
  56172. */
  56173. autoUpdateExtends: boolean;
  56174. /**
  56175. * Automatically compute the shadowMinZ and shadowMaxZ for the projection matrix to best fit (including all the casters)
  56176. * on each frame. autoUpdateExtends must be set to true for this to work
  56177. */
  56178. autoCalcShadowZBounds: boolean;
  56179. private _orthoLeft;
  56180. private _orthoRight;
  56181. private _orthoTop;
  56182. private _orthoBottom;
  56183. /**
  56184. * Creates a DirectionalLight object in the scene, oriented towards the passed direction (Vector3).
  56185. * The directional light is emitted from everywhere in the given direction.
  56186. * It can cast shadows.
  56187. * Documentation : https://doc.babylonjs.com/babylon101/lights
  56188. * @param name The friendly name of the light
  56189. * @param direction The direction of the light
  56190. * @param scene The scene the light belongs to
  56191. */
  56192. constructor(name: string, direction: Vector3, scene: Scene);
  56193. /**
  56194. * Returns the string "DirectionalLight".
  56195. * @return The class name
  56196. */
  56197. getClassName(): string;
  56198. /**
  56199. * Returns the integer 1.
  56200. * @return The light Type id as a constant defines in Light.LIGHTTYPEID_x
  56201. */
  56202. getTypeID(): number;
  56203. /**
  56204. * Sets the passed matrix "matrix" as projection matrix for the shadows cast by the light according to the passed view matrix.
  56205. * Returns the DirectionalLight Shadow projection matrix.
  56206. */
  56207. protected _setDefaultShadowProjectionMatrix(matrix: Matrix, viewMatrix: Matrix, renderList: Array<AbstractMesh>): void;
  56208. /**
  56209. * Sets the passed matrix "matrix" as fixed frustum projection matrix for the shadows cast by the light according to the passed view matrix.
  56210. * Returns the DirectionalLight Shadow projection matrix.
  56211. */
  56212. protected _setDefaultFixedFrustumShadowProjectionMatrix(matrix: Matrix): void;
  56213. /**
  56214. * Sets the passed matrix "matrix" as auto extend projection matrix for the shadows cast by the light according to the passed view matrix.
  56215. * Returns the DirectionalLight Shadow projection matrix.
  56216. */
  56217. protected _setDefaultAutoExtendShadowProjectionMatrix(matrix: Matrix, viewMatrix: Matrix, renderList: Array<AbstractMesh>): void;
  56218. protected _buildUniformLayout(): void;
  56219. /**
  56220. * Sets the passed Effect object with the DirectionalLight transformed position (or position if not parented) and the passed name.
  56221. * @param effect The effect to update
  56222. * @param lightIndex The index of the light in the effect to update
  56223. * @returns The directional light
  56224. */
  56225. transferToEffect(effect: Effect, lightIndex: string): DirectionalLight;
  56226. transferToNodeMaterialEffect(effect: Effect, lightDataUniformName: string): Light;
  56227. /**
  56228. * Gets the minZ used for shadow according to both the scene and the light.
  56229. *
  56230. * Values are fixed on directional lights as it relies on an ortho projection hence the need to convert being
  56231. * -1 and 1 to 0 and 1 doing (depth + min) / (min + max) -> (depth + 1) / (1 + 1) -> (depth * 0.5) + 0.5.
  56232. * @param activeCamera The camera we are returning the min for
  56233. * @returns the depth min z
  56234. */
  56235. getDepthMinZ(activeCamera: Camera): number;
  56236. /**
  56237. * Gets the maxZ used for shadow according to both the scene and the light.
  56238. *
  56239. * Values are fixed on directional lights as it relies on an ortho projection hence the need to convert being
  56240. * -1 and 1 to 0 and 1 doing (depth + min) / (min + max) -> (depth + 1) / (1 + 1) -> (depth * 0.5) + 0.5.
  56241. * @param activeCamera The camera we are returning the max for
  56242. * @returns the depth max z
  56243. */
  56244. getDepthMaxZ(activeCamera: Camera): number;
  56245. /**
  56246. * Prepares the list of defines specific to the light type.
  56247. * @param defines the list of defines
  56248. * @param lightIndex defines the index of the light for the effect
  56249. */
  56250. prepareLightSpecificDefines(defines: any, lightIndex: number): void;
  56251. }
  56252. }
  56253. declare module "babylonjs/Meshes/Builders/hemisphereBuilder" {
  56254. import { Mesh } from "babylonjs/Meshes/mesh";
  56255. /**
  56256. * Class containing static functions to help procedurally build meshes
  56257. */
  56258. export class HemisphereBuilder {
  56259. /**
  56260. * Creates a hemisphere mesh
  56261. * @param name defines the name of the mesh
  56262. * @param options defines the options used to create the mesh
  56263. * @param scene defines the hosting scene
  56264. * @returns the hemisphere mesh
  56265. */
  56266. static CreateHemisphere(name: string, options: {
  56267. segments?: number;
  56268. diameter?: number;
  56269. sideOrientation?: number;
  56270. }, scene: any): Mesh;
  56271. }
  56272. }
  56273. declare module "babylonjs/Lights/spotLight" {
  56274. import { Nullable } from "babylonjs/types";
  56275. import { Scene } from "babylonjs/scene";
  56276. import { Matrix, Vector3 } from "babylonjs/Maths/math.vector";
  56277. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  56278. import { Effect } from "babylonjs/Materials/effect";
  56279. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  56280. import { Light } from "babylonjs/Lights/light";
  56281. import { ShadowLight } from "babylonjs/Lights/shadowLight";
  56282. /**
  56283. * A spot light is defined by a position, a direction, an angle, and an exponent.
  56284. * These values define a cone of light starting from the position, emitting toward the direction.
  56285. * The angle, in radians, defines the size (field of illumination) of the spotlight's conical beam,
  56286. * and the exponent defines the speed of the decay of the light with distance (reach).
  56287. * Documentation: https://doc.babylonjs.com/babylon101/lights
  56288. */
  56289. export class SpotLight extends ShadowLight {
  56290. private _angle;
  56291. private _innerAngle;
  56292. private _cosHalfAngle;
  56293. private _lightAngleScale;
  56294. private _lightAngleOffset;
  56295. /**
  56296. * Gets the cone angle of the spot light in Radians.
  56297. */
  56298. get angle(): number;
  56299. /**
  56300. * Sets the cone angle of the spot light in Radians.
  56301. */
  56302. set angle(value: number);
  56303. /**
  56304. * Only used in gltf falloff mode, this defines the angle where
  56305. * the directional falloff will start before cutting at angle which could be seen
  56306. * as outer angle.
  56307. */
  56308. get innerAngle(): number;
  56309. /**
  56310. * Only used in gltf falloff mode, this defines the angle where
  56311. * the directional falloff will start before cutting at angle which could be seen
  56312. * as outer angle.
  56313. */
  56314. set innerAngle(value: number);
  56315. private _shadowAngleScale;
  56316. /**
  56317. * Allows scaling the angle of the light for shadow generation only.
  56318. */
  56319. get shadowAngleScale(): number;
  56320. /**
  56321. * Allows scaling the angle of the light for shadow generation only.
  56322. */
  56323. set shadowAngleScale(value: number);
  56324. /**
  56325. * The light decay speed with the distance from the emission spot.
  56326. */
  56327. exponent: number;
  56328. private _projectionTextureMatrix;
  56329. /**
  56330. * Allows reading the projecton texture
  56331. */
  56332. get projectionTextureMatrix(): Matrix;
  56333. protected _projectionTextureLightNear: number;
  56334. /**
  56335. * Gets the near clip of the Spotlight for texture projection.
  56336. */
  56337. get projectionTextureLightNear(): number;
  56338. /**
  56339. * Sets the near clip of the Spotlight for texture projection.
  56340. */
  56341. set projectionTextureLightNear(value: number);
  56342. protected _projectionTextureLightFar: number;
  56343. /**
  56344. * Gets the far clip of the Spotlight for texture projection.
  56345. */
  56346. get projectionTextureLightFar(): number;
  56347. /**
  56348. * Sets the far clip of the Spotlight for texture projection.
  56349. */
  56350. set projectionTextureLightFar(value: number);
  56351. protected _projectionTextureUpDirection: Vector3;
  56352. /**
  56353. * Gets the Up vector of the Spotlight for texture projection.
  56354. */
  56355. get projectionTextureUpDirection(): Vector3;
  56356. /**
  56357. * Sets the Up vector of the Spotlight for texture projection.
  56358. */
  56359. set projectionTextureUpDirection(value: Vector3);
  56360. private _projectionTexture;
  56361. /**
  56362. * Gets the projection texture of the light.
  56363. */
  56364. get projectionTexture(): Nullable<BaseTexture>;
  56365. /**
  56366. * Sets the projection texture of the light.
  56367. */
  56368. set projectionTexture(value: Nullable<BaseTexture>);
  56369. private _projectionTextureViewLightDirty;
  56370. private _projectionTextureProjectionLightDirty;
  56371. private _projectionTextureDirty;
  56372. private _projectionTextureViewTargetVector;
  56373. private _projectionTextureViewLightMatrix;
  56374. private _projectionTextureProjectionLightMatrix;
  56375. private _projectionTextureScalingMatrix;
  56376. /**
  56377. * Creates a SpotLight object in the scene. A spot light is a simply light oriented cone.
  56378. * It can cast shadows.
  56379. * Documentation : https://doc.babylonjs.com/babylon101/lights
  56380. * @param name The light friendly name
  56381. * @param position The position of the spot light in the scene
  56382. * @param direction The direction of the light in the scene
  56383. * @param angle The cone angle of the light in Radians
  56384. * @param exponent The light decay speed with the distance from the emission spot
  56385. * @param scene The scene the lights belongs to
  56386. */
  56387. constructor(name: string, position: Vector3, direction: Vector3, angle: number, exponent: number, scene: Scene);
  56388. /**
  56389. * Returns the string "SpotLight".
  56390. * @returns the class name
  56391. */
  56392. getClassName(): string;
  56393. /**
  56394. * Returns the integer 2.
  56395. * @returns The light Type id as a constant defines in Light.LIGHTTYPEID_x
  56396. */
  56397. getTypeID(): number;
  56398. /**
  56399. * Overrides the direction setter to recompute the projection texture view light Matrix.
  56400. */
  56401. protected _setDirection(value: Vector3): void;
  56402. /**
  56403. * Overrides the position setter to recompute the projection texture view light Matrix.
  56404. */
  56405. protected _setPosition(value: Vector3): void;
  56406. /**
  56407. * 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.
  56408. * Returns the SpotLight.
  56409. */
  56410. protected _setDefaultShadowProjectionMatrix(matrix: Matrix, viewMatrix: Matrix, renderList: Array<AbstractMesh>): void;
  56411. protected _computeProjectionTextureViewLightMatrix(): void;
  56412. protected _computeProjectionTextureProjectionLightMatrix(): void;
  56413. /**
  56414. * Main function for light texture projection matrix computing.
  56415. */
  56416. protected _computeProjectionTextureMatrix(): void;
  56417. protected _buildUniformLayout(): void;
  56418. private _computeAngleValues;
  56419. /**
  56420. * Sets the passed Effect "effect" with the Light textures.
  56421. * @param effect The effect to update
  56422. * @param lightIndex The index of the light in the effect to update
  56423. * @returns The light
  56424. */
  56425. transferTexturesToEffect(effect: Effect, lightIndex: string): Light;
  56426. /**
  56427. * Sets the passed Effect object with the SpotLight transfomed position (or position if not parented) and normalized direction.
  56428. * @param effect The effect to update
  56429. * @param lightIndex The index of the light in the effect to update
  56430. * @returns The spot light
  56431. */
  56432. transferToEffect(effect: Effect, lightIndex: string): SpotLight;
  56433. transferToNodeMaterialEffect(effect: Effect, lightDataUniformName: string): this;
  56434. /**
  56435. * Disposes the light and the associated resources.
  56436. */
  56437. dispose(): void;
  56438. /**
  56439. * Prepares the list of defines specific to the light type.
  56440. * @param defines the list of defines
  56441. * @param lightIndex defines the index of the light for the effect
  56442. */
  56443. prepareLightSpecificDefines(defines: any, lightIndex: number): void;
  56444. }
  56445. }
  56446. declare module "babylonjs/Gizmos/lightGizmo" {
  56447. import { Nullable } from "babylonjs/types";
  56448. import { Gizmo } from "babylonjs/Gizmos/gizmo";
  56449. import { UtilityLayerRenderer } from "babylonjs/Rendering/utilityLayerRenderer";
  56450. import { StandardMaterial } from "babylonjs/Materials/standardMaterial";
  56451. import { Light } from "babylonjs/Lights/light";
  56452. /**
  56453. * Gizmo that enables viewing a light
  56454. */
  56455. export class LightGizmo extends Gizmo {
  56456. private _lightMesh;
  56457. private _material;
  56458. private _cachedPosition;
  56459. private _cachedForward;
  56460. private _attachedMeshParent;
  56461. /**
  56462. * Creates a LightGizmo
  56463. * @param gizmoLayer The utility layer the gizmo will be added to
  56464. */
  56465. constructor(gizmoLayer?: UtilityLayerRenderer);
  56466. private _light;
  56467. /**
  56468. * The light that the gizmo is attached to
  56469. */
  56470. set light(light: Nullable<Light>);
  56471. get light(): Nullable<Light>;
  56472. /**
  56473. * Gets the material used to render the light gizmo
  56474. */
  56475. get material(): StandardMaterial;
  56476. /**
  56477. * @hidden
  56478. * Updates the gizmo to match the attached mesh's position/rotation
  56479. */
  56480. protected _update(): void;
  56481. private static _Scale;
  56482. /**
  56483. * Creates the lines for a light mesh
  56484. */
  56485. private static _CreateLightLines;
  56486. /**
  56487. * Disposes of the light gizmo
  56488. */
  56489. dispose(): void;
  56490. private static _CreateHemisphericLightMesh;
  56491. private static _CreatePointLightMesh;
  56492. private static _CreateSpotLightMesh;
  56493. private static _CreateDirectionalLightMesh;
  56494. }
  56495. }
  56496. declare module "babylonjs/Gizmos/cameraGizmo" {
  56497. import { Nullable } from "babylonjs/types";
  56498. import { Gizmo } from "babylonjs/Gizmos/gizmo";
  56499. import { UtilityLayerRenderer } from "babylonjs/Rendering/utilityLayerRenderer";
  56500. import { StandardMaterial } from "babylonjs/Materials/standardMaterial";
  56501. import { Camera } from "babylonjs/Cameras/camera";
  56502. /**
  56503. * Gizmo that enables viewing a camera
  56504. */
  56505. export class CameraGizmo extends Gizmo {
  56506. private _cameraMesh;
  56507. private _cameraLinesMesh;
  56508. private _material;
  56509. /**
  56510. * Creates a CameraGizmo
  56511. * @param gizmoLayer The utility layer the gizmo will be added to
  56512. */
  56513. constructor(gizmoLayer?: UtilityLayerRenderer);
  56514. private _camera;
  56515. /** Gets or sets a boolean indicating if frustum lines must be rendered (true by default)) */
  56516. get displayFrustum(): boolean;
  56517. set displayFrustum(value: boolean);
  56518. /**
  56519. * The camera that the gizmo is attached to
  56520. */
  56521. set camera(camera: Nullable<Camera>);
  56522. get camera(): Nullable<Camera>;
  56523. /**
  56524. * Gets the material used to render the camera gizmo
  56525. */
  56526. get material(): StandardMaterial;
  56527. /**
  56528. * @hidden
  56529. * Updates the gizmo to match the attached mesh's position/rotation
  56530. */
  56531. protected _update(): void;
  56532. private static _Scale;
  56533. private _invProjection;
  56534. /**
  56535. * Disposes of the camera gizmo
  56536. */
  56537. dispose(): void;
  56538. private static _CreateCameraMesh;
  56539. private static _CreateCameraFrustum;
  56540. }
  56541. }
  56542. declare module "babylonjs/Gizmos/index" {
  56543. export * from "babylonjs/Gizmos/axisDragGizmo";
  56544. export * from "babylonjs/Gizmos/axisScaleGizmo";
  56545. export * from "babylonjs/Gizmos/boundingBoxGizmo";
  56546. export * from "babylonjs/Gizmos/gizmo";
  56547. export * from "babylonjs/Gizmos/gizmoManager";
  56548. export * from "babylonjs/Gizmos/planeRotationGizmo";
  56549. export * from "babylonjs/Gizmos/positionGizmo";
  56550. export * from "babylonjs/Gizmos/rotationGizmo";
  56551. export * from "babylonjs/Gizmos/scaleGizmo";
  56552. export * from "babylonjs/Gizmos/lightGizmo";
  56553. export * from "babylonjs/Gizmos/cameraGizmo";
  56554. export * from "babylonjs/Gizmos/planeDragGizmo";
  56555. }
  56556. declare module "babylonjs/Shaders/ShadersInclude/backgroundFragmentDeclaration" {
  56557. /** @hidden */
  56558. export var backgroundFragmentDeclaration: {
  56559. name: string;
  56560. shader: string;
  56561. };
  56562. }
  56563. declare module "babylonjs/Shaders/ShadersInclude/backgroundUboDeclaration" {
  56564. /** @hidden */
  56565. export var backgroundUboDeclaration: {
  56566. name: string;
  56567. shader: string;
  56568. };
  56569. }
  56570. declare module "babylonjs/Shaders/background.fragment" {
  56571. import "babylonjs/Shaders/ShadersInclude/backgroundFragmentDeclaration";
  56572. import "babylonjs/Shaders/ShadersInclude/backgroundUboDeclaration";
  56573. import "babylonjs/Shaders/ShadersInclude/reflectionFunction";
  56574. import "babylonjs/Shaders/ShadersInclude/imageProcessingDeclaration";
  56575. import "babylonjs/Shaders/ShadersInclude/lightFragmentDeclaration";
  56576. import "babylonjs/Shaders/ShadersInclude/lightUboDeclaration";
  56577. import "babylonjs/Shaders/ShadersInclude/helperFunctions";
  56578. import "babylonjs/Shaders/ShadersInclude/lightsFragmentFunctions";
  56579. import "babylonjs/Shaders/ShadersInclude/shadowsFragmentFunctions";
  56580. import "babylonjs/Shaders/ShadersInclude/imageProcessingFunctions";
  56581. import "babylonjs/Shaders/ShadersInclude/clipPlaneFragmentDeclaration";
  56582. import "babylonjs/Shaders/ShadersInclude/fogFragmentDeclaration";
  56583. import "babylonjs/Shaders/ShadersInclude/clipPlaneFragment";
  56584. import "babylonjs/Shaders/ShadersInclude/lightFragment";
  56585. import "babylonjs/Shaders/ShadersInclude/fogFragment";
  56586. /** @hidden */
  56587. export var backgroundPixelShader: {
  56588. name: string;
  56589. shader: string;
  56590. };
  56591. }
  56592. declare module "babylonjs/Shaders/ShadersInclude/backgroundVertexDeclaration" {
  56593. /** @hidden */
  56594. export var backgroundVertexDeclaration: {
  56595. name: string;
  56596. shader: string;
  56597. };
  56598. }
  56599. declare module "babylonjs/Shaders/background.vertex" {
  56600. import "babylonjs/Shaders/ShadersInclude/backgroundVertexDeclaration";
  56601. import "babylonjs/Shaders/ShadersInclude/backgroundUboDeclaration";
  56602. import "babylonjs/Shaders/ShadersInclude/helperFunctions";
  56603. import "babylonjs/Shaders/ShadersInclude/bonesDeclaration";
  56604. import "babylonjs/Shaders/ShadersInclude/instancesDeclaration";
  56605. import "babylonjs/Shaders/ShadersInclude/clipPlaneVertexDeclaration";
  56606. import "babylonjs/Shaders/ShadersInclude/fogVertexDeclaration";
  56607. import "babylonjs/Shaders/ShadersInclude/lightFragmentDeclaration";
  56608. import "babylonjs/Shaders/ShadersInclude/lightUboDeclaration";
  56609. import "babylonjs/Shaders/ShadersInclude/instancesVertex";
  56610. import "babylonjs/Shaders/ShadersInclude/bonesVertex";
  56611. import "babylonjs/Shaders/ShadersInclude/clipPlaneVertex";
  56612. import "babylonjs/Shaders/ShadersInclude/fogVertex";
  56613. import "babylonjs/Shaders/ShadersInclude/shadowsVertex";
  56614. /** @hidden */
  56615. export var backgroundVertexShader: {
  56616. name: string;
  56617. shader: string;
  56618. };
  56619. }
  56620. declare module "babylonjs/Materials/Background/backgroundMaterial" {
  56621. import { Nullable, int, float } from "babylonjs/types";
  56622. import { Scene } from "babylonjs/scene";
  56623. import { Matrix, Vector3 } from "babylonjs/Maths/math.vector";
  56624. import { SubMesh } from "babylonjs/Meshes/subMesh";
  56625. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  56626. import { Mesh } from "babylonjs/Meshes/mesh";
  56627. import { PushMaterial } from "babylonjs/Materials/pushMaterial";
  56628. import { ColorCurves } from "babylonjs/Materials/colorCurves";
  56629. import { ImageProcessingConfiguration } from "babylonjs/Materials/imageProcessingConfiguration";
  56630. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  56631. import { IShadowLight } from "babylonjs/Lights/shadowLight";
  56632. import { Color3 } from "babylonjs/Maths/math.color";
  56633. import "babylonjs/Shaders/background.fragment";
  56634. import "babylonjs/Shaders/background.vertex";
  56635. /**
  56636. * Background material used to create an efficient environement around your scene.
  56637. */
  56638. export class BackgroundMaterial extends PushMaterial {
  56639. /**
  56640. * Standard reflectance value at parallel view angle.
  56641. */
  56642. static StandardReflectance0: number;
  56643. /**
  56644. * Standard reflectance value at grazing angle.
  56645. */
  56646. static StandardReflectance90: number;
  56647. protected _primaryColor: Color3;
  56648. /**
  56649. * Key light Color (multiply against the environement texture)
  56650. */
  56651. primaryColor: Color3;
  56652. protected __perceptualColor: Nullable<Color3>;
  56653. /**
  56654. * Experimental Internal Use Only.
  56655. *
  56656. * Key light Color in "perceptual value" meaning the color you would like to see on screen.
  56657. * This acts as a helper to set the primary color to a more "human friendly" value.
  56658. * Conversion to linear space as well as exposure and tone mapping correction will be applied to keep the
  56659. * output color as close as possible from the chosen value.
  56660. * (This does not account for contrast color grading and color curves as they are considered post effect and not directly
  56661. * part of lighting setup.)
  56662. */
  56663. get _perceptualColor(): Nullable<Color3>;
  56664. set _perceptualColor(value: Nullable<Color3>);
  56665. protected _primaryColorShadowLevel: float;
  56666. /**
  56667. * Defines the level of the shadows (dark area of the reflection map) in order to help scaling the colors.
  56668. * The color opposite to the primary color is used at the level chosen to define what the black area would look.
  56669. */
  56670. get primaryColorShadowLevel(): float;
  56671. set primaryColorShadowLevel(value: float);
  56672. protected _primaryColorHighlightLevel: float;
  56673. /**
  56674. * Defines the level of the highliights (highlight area of the reflection map) in order to help scaling the colors.
  56675. * The primary color is used at the level chosen to define what the white area would look.
  56676. */
  56677. get primaryColorHighlightLevel(): float;
  56678. set primaryColorHighlightLevel(value: float);
  56679. protected _reflectionTexture: Nullable<BaseTexture>;
  56680. /**
  56681. * Reflection Texture used in the material.
  56682. * Should be author in a specific way for the best result (refer to the documentation).
  56683. */
  56684. reflectionTexture: Nullable<BaseTexture>;
  56685. protected _reflectionBlur: float;
  56686. /**
  56687. * Reflection Texture level of blur.
  56688. *
  56689. * Can be use to reuse an existing HDR Texture and target a specific LOD to prevent authoring the
  56690. * texture twice.
  56691. */
  56692. reflectionBlur: float;
  56693. protected _diffuseTexture: Nullable<BaseTexture>;
  56694. /**
  56695. * Diffuse Texture used in the material.
  56696. * Should be author in a specific way for the best result (refer to the documentation).
  56697. */
  56698. diffuseTexture: Nullable<BaseTexture>;
  56699. protected _shadowLights: Nullable<IShadowLight[]>;
  56700. /**
  56701. * Specify the list of lights casting shadow on the material.
  56702. * All scene shadow lights will be included if null.
  56703. */
  56704. shadowLights: Nullable<IShadowLight[]>;
  56705. protected _shadowLevel: float;
  56706. /**
  56707. * Helps adjusting the shadow to a softer level if required.
  56708. * 0 means black shadows and 1 means no shadows.
  56709. */
  56710. shadowLevel: float;
  56711. protected _sceneCenter: Vector3;
  56712. /**
  56713. * In case of opacity Fresnel or reflection falloff, this is use as a scene center.
  56714. * It is usually zero but might be interesting to modify according to your setup.
  56715. */
  56716. sceneCenter: Vector3;
  56717. protected _opacityFresnel: boolean;
  56718. /**
  56719. * This helps specifying that the material is falling off to the sky box at grazing angle.
  56720. * This helps ensuring a nice transition when the camera goes under the ground.
  56721. */
  56722. opacityFresnel: boolean;
  56723. protected _reflectionFresnel: boolean;
  56724. /**
  56725. * This helps specifying that the material is falling off from diffuse to the reflection texture at grazing angle.
  56726. * This helps adding a mirror texture on the ground.
  56727. */
  56728. reflectionFresnel: boolean;
  56729. protected _reflectionFalloffDistance: number;
  56730. /**
  56731. * This helps specifying the falloff radius off the reflection texture from the sceneCenter.
  56732. * This helps adding a nice falloff effect to the reflection if used as a mirror for instance.
  56733. */
  56734. reflectionFalloffDistance: number;
  56735. protected _reflectionAmount: number;
  56736. /**
  56737. * This specifies the weight of the reflection against the background in case of reflection Fresnel.
  56738. */
  56739. reflectionAmount: number;
  56740. protected _reflectionReflectance0: number;
  56741. /**
  56742. * This specifies the weight of the reflection at grazing angle.
  56743. */
  56744. reflectionReflectance0: number;
  56745. protected _reflectionReflectance90: number;
  56746. /**
  56747. * This specifies the weight of the reflection at a perpendicular point of view.
  56748. */
  56749. reflectionReflectance90: number;
  56750. /**
  56751. * Sets the reflection reflectance fresnel values according to the default standard
  56752. * empirically know to work well :-)
  56753. */
  56754. set reflectionStandardFresnelWeight(value: number);
  56755. protected _useRGBColor: boolean;
  56756. /**
  56757. * Helps to directly use the maps channels instead of their level.
  56758. */
  56759. useRGBColor: boolean;
  56760. protected _enableNoise: boolean;
  56761. /**
  56762. * This helps reducing the banding effect that could occur on the background.
  56763. */
  56764. enableNoise: boolean;
  56765. /**
  56766. * The current fov(field of view) multiplier, 0.0 - 2.0. Defaults to 1.0. Lower values "zoom in" and higher values "zoom out".
  56767. * Best used when trying to implement visual zoom effects like fish-eye or binoculars while not adjusting camera fov.
  56768. * Recommended to be keep at 1.0 except for special cases.
  56769. */
  56770. get fovMultiplier(): number;
  56771. set fovMultiplier(value: number);
  56772. private _fovMultiplier;
  56773. /**
  56774. * Enable the FOV adjustment feature controlled by fovMultiplier.
  56775. */
  56776. useEquirectangularFOV: boolean;
  56777. private _maxSimultaneousLights;
  56778. /**
  56779. * Number of Simultaneous lights allowed on the material.
  56780. */
  56781. maxSimultaneousLights: int;
  56782. private _shadowOnly;
  56783. /**
  56784. * Make the material only render shadows
  56785. */
  56786. shadowOnly: boolean;
  56787. /**
  56788. * Default configuration related to image processing available in the Background Material.
  56789. */
  56790. protected _imageProcessingConfiguration: ImageProcessingConfiguration;
  56791. /**
  56792. * Keep track of the image processing observer to allow dispose and replace.
  56793. */
  56794. private _imageProcessingObserver;
  56795. /**
  56796. * Attaches a new image processing configuration to the PBR Material.
  56797. * @param configuration (if null the scene configuration will be use)
  56798. */
  56799. protected _attachImageProcessingConfiguration(configuration: Nullable<ImageProcessingConfiguration>): void;
  56800. /**
  56801. * Gets the image processing configuration used either in this material.
  56802. */
  56803. get imageProcessingConfiguration(): Nullable<ImageProcessingConfiguration>;
  56804. /**
  56805. * Sets the Default image processing configuration used either in the this material.
  56806. *
  56807. * If sets to null, the scene one is in use.
  56808. */
  56809. set imageProcessingConfiguration(value: Nullable<ImageProcessingConfiguration>);
  56810. /**
  56811. * Gets wether the color curves effect is enabled.
  56812. */
  56813. get cameraColorCurvesEnabled(): boolean;
  56814. /**
  56815. * Sets wether the color curves effect is enabled.
  56816. */
  56817. set cameraColorCurvesEnabled(value: boolean);
  56818. /**
  56819. * Gets wether the color grading effect is enabled.
  56820. */
  56821. get cameraColorGradingEnabled(): boolean;
  56822. /**
  56823. * Gets wether the color grading effect is enabled.
  56824. */
  56825. set cameraColorGradingEnabled(value: boolean);
  56826. /**
  56827. * Gets wether tonemapping is enabled or not.
  56828. */
  56829. get cameraToneMappingEnabled(): boolean;
  56830. /**
  56831. * Sets wether tonemapping is enabled or not
  56832. */
  56833. set cameraToneMappingEnabled(value: boolean);
  56834. /**
  56835. * The camera exposure used on this material.
  56836. * This property is here and not in the camera to allow controlling exposure without full screen post process.
  56837. * This corresponds to a photographic exposure.
  56838. */
  56839. get cameraExposure(): float;
  56840. /**
  56841. * The camera exposure used on this material.
  56842. * This property is here and not in the camera to allow controlling exposure without full screen post process.
  56843. * This corresponds to a photographic exposure.
  56844. */
  56845. set cameraExposure(value: float);
  56846. /**
  56847. * Gets The camera contrast used on this material.
  56848. */
  56849. get cameraContrast(): float;
  56850. /**
  56851. * Sets The camera contrast used on this material.
  56852. */
  56853. set cameraContrast(value: float);
  56854. /**
  56855. * Gets the Color Grading 2D Lookup Texture.
  56856. */
  56857. get cameraColorGradingTexture(): Nullable<BaseTexture>;
  56858. /**
  56859. * Sets the Color Grading 2D Lookup Texture.
  56860. */
  56861. set cameraColorGradingTexture(value: Nullable<BaseTexture>);
  56862. /**
  56863. * The color grading curves provide additional color adjustmnent that is applied after any color grading transform (3D LUT).
  56864. * They allow basic adjustment of saturation and small exposure adjustments, along with color filter tinting to provide white balance adjustment or more stylistic effects.
  56865. * 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;
  56866. * corresponding to low luminance, medium luminance, and high luminance areas respectively.
  56867. */
  56868. get cameraColorCurves(): Nullable<ColorCurves>;
  56869. /**
  56870. * The color grading curves provide additional color adjustmnent that is applied after any color grading transform (3D LUT).
  56871. * They allow basic adjustment of saturation and small exposure adjustments, along with color filter tinting to provide white balance adjustment or more stylistic effects.
  56872. * 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;
  56873. * corresponding to low luminance, medium luminance, and high luminance areas respectively.
  56874. */
  56875. set cameraColorCurves(value: Nullable<ColorCurves>);
  56876. /**
  56877. * Due to a bug in iOS10, video tags (which are using the background material) are in BGR and not RGB.
  56878. * Setting this flag to true (not done automatically!) will convert it back to RGB.
  56879. */
  56880. switchToBGR: boolean;
  56881. private _renderTargets;
  56882. private _reflectionControls;
  56883. private _white;
  56884. private _primaryShadowColor;
  56885. private _primaryHighlightColor;
  56886. /**
  56887. * Instantiates a Background Material in the given scene
  56888. * @param name The friendly name of the material
  56889. * @param scene The scene to add the material to
  56890. */
  56891. constructor(name: string, scene: Scene);
  56892. /**
  56893. * Gets a boolean indicating that current material needs to register RTT
  56894. */
  56895. get hasRenderTargetTextures(): boolean;
  56896. /**
  56897. * The entire material has been created in order to prevent overdraw.
  56898. * @returns false
  56899. */
  56900. needAlphaTesting(): boolean;
  56901. /**
  56902. * The entire material has been created in order to prevent overdraw.
  56903. * @returns true if blending is enable
  56904. */
  56905. needAlphaBlending(): boolean;
  56906. /**
  56907. * Checks wether the material is ready to be rendered for a given mesh.
  56908. * @param mesh The mesh to render
  56909. * @param subMesh The submesh to check against
  56910. * @param useInstances Specify wether or not the material is used with instances
  56911. * @returns true if all the dependencies are ready (Textures, Effects...)
  56912. */
  56913. isReadyForSubMesh(mesh: AbstractMesh, subMesh: SubMesh, useInstances?: boolean): boolean;
  56914. /**
  56915. * Compute the primary color according to the chosen perceptual color.
  56916. */
  56917. private _computePrimaryColorFromPerceptualColor;
  56918. /**
  56919. * Compute the highlights and shadow colors according to their chosen levels.
  56920. */
  56921. private _computePrimaryColors;
  56922. /**
  56923. * Build the uniform buffer used in the material.
  56924. */
  56925. buildUniformLayout(): void;
  56926. /**
  56927. * Unbind the material.
  56928. */
  56929. unbind(): void;
  56930. /**
  56931. * Bind only the world matrix to the material.
  56932. * @param world The world matrix to bind.
  56933. */
  56934. bindOnlyWorldMatrix(world: Matrix): void;
  56935. /**
  56936. * Bind the material for a dedicated submeh (every used meshes will be considered opaque).
  56937. * @param world The world matrix to bind.
  56938. * @param subMesh The submesh to bind for.
  56939. */
  56940. bindForSubMesh(world: Matrix, mesh: Mesh, subMesh: SubMesh): void;
  56941. /**
  56942. * Checks to see if a texture is used in the material.
  56943. * @param texture - Base texture to use.
  56944. * @returns - Boolean specifying if a texture is used in the material.
  56945. */
  56946. hasTexture(texture: BaseTexture): boolean;
  56947. /**
  56948. * Dispose the material.
  56949. * @param forceDisposeEffect Force disposal of the associated effect.
  56950. * @param forceDisposeTextures Force disposal of the associated textures.
  56951. */
  56952. dispose(forceDisposeEffect?: boolean, forceDisposeTextures?: boolean): void;
  56953. /**
  56954. * Clones the material.
  56955. * @param name The cloned name.
  56956. * @returns The cloned material.
  56957. */
  56958. clone(name: string): BackgroundMaterial;
  56959. /**
  56960. * Serializes the current material to its JSON representation.
  56961. * @returns The JSON representation.
  56962. */
  56963. serialize(): any;
  56964. /**
  56965. * Gets the class name of the material
  56966. * @returns "BackgroundMaterial"
  56967. */
  56968. getClassName(): string;
  56969. /**
  56970. * Parse a JSON input to create back a background material.
  56971. * @param source The JSON data to parse
  56972. * @param scene The scene to create the parsed material in
  56973. * @param rootUrl The root url of the assets the material depends upon
  56974. * @returns the instantiated BackgroundMaterial.
  56975. */
  56976. static Parse(source: any, scene: Scene, rootUrl: string): BackgroundMaterial;
  56977. }
  56978. }
  56979. declare module "babylonjs/Helpers/environmentHelper" {
  56980. import { Observable } from "babylonjs/Misc/observable";
  56981. import { Nullable } from "babylonjs/types";
  56982. import { Scene } from "babylonjs/scene";
  56983. import { Vector3 } from "babylonjs/Maths/math.vector";
  56984. import { Color3 } from "babylonjs/Maths/math.color";
  56985. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  56986. import { Mesh } from "babylonjs/Meshes/mesh";
  56987. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  56988. import { MirrorTexture } from "babylonjs/Materials/Textures/mirrorTexture";
  56989. import { BackgroundMaterial } from "babylonjs/Materials/Background/backgroundMaterial";
  56990. import "babylonjs/Meshes/Builders/planeBuilder";
  56991. import "babylonjs/Meshes/Builders/boxBuilder";
  56992. /**
  56993. * Represents the different options available during the creation of
  56994. * a Environment helper.
  56995. *
  56996. * This can control the default ground, skybox and image processing setup of your scene.
  56997. */
  56998. export interface IEnvironmentHelperOptions {
  56999. /**
  57000. * Specifies whether or not to create a ground.
  57001. * True by default.
  57002. */
  57003. createGround: boolean;
  57004. /**
  57005. * Specifies the ground size.
  57006. * 15 by default.
  57007. */
  57008. groundSize: number;
  57009. /**
  57010. * The texture used on the ground for the main color.
  57011. * Comes from the BabylonJS CDN by default.
  57012. *
  57013. * Remarks: Can be either a texture or a url.
  57014. */
  57015. groundTexture: string | BaseTexture;
  57016. /**
  57017. * The color mixed in the ground texture by default.
  57018. * BabylonJS clearColor by default.
  57019. */
  57020. groundColor: Color3;
  57021. /**
  57022. * Specifies the ground opacity.
  57023. * 1 by default.
  57024. */
  57025. groundOpacity: number;
  57026. /**
  57027. * Enables the ground to receive shadows.
  57028. * True by default.
  57029. */
  57030. enableGroundShadow: boolean;
  57031. /**
  57032. * Helps preventing the shadow to be fully black on the ground.
  57033. * 0.5 by default.
  57034. */
  57035. groundShadowLevel: number;
  57036. /**
  57037. * Creates a mirror texture attach to the ground.
  57038. * false by default.
  57039. */
  57040. enableGroundMirror: boolean;
  57041. /**
  57042. * Specifies the ground mirror size ratio.
  57043. * 0.3 by default as the default kernel is 64.
  57044. */
  57045. groundMirrorSizeRatio: number;
  57046. /**
  57047. * Specifies the ground mirror blur kernel size.
  57048. * 64 by default.
  57049. */
  57050. groundMirrorBlurKernel: number;
  57051. /**
  57052. * Specifies the ground mirror visibility amount.
  57053. * 1 by default
  57054. */
  57055. groundMirrorAmount: number;
  57056. /**
  57057. * Specifies the ground mirror reflectance weight.
  57058. * This uses the standard weight of the background material to setup the fresnel effect
  57059. * of the mirror.
  57060. * 1 by default.
  57061. */
  57062. groundMirrorFresnelWeight: number;
  57063. /**
  57064. * Specifies the ground mirror Falloff distance.
  57065. * This can helps reducing the size of the reflection.
  57066. * 0 by Default.
  57067. */
  57068. groundMirrorFallOffDistance: number;
  57069. /**
  57070. * Specifies the ground mirror texture type.
  57071. * Unsigned Int by Default.
  57072. */
  57073. groundMirrorTextureType: number;
  57074. /**
  57075. * Specifies a bias applied to the ground vertical position to prevent z-fighting with
  57076. * the shown objects.
  57077. */
  57078. groundYBias: number;
  57079. /**
  57080. * Specifies whether or not to create a skybox.
  57081. * True by default.
  57082. */
  57083. createSkybox: boolean;
  57084. /**
  57085. * Specifies the skybox size.
  57086. * 20 by default.
  57087. */
  57088. skyboxSize: number;
  57089. /**
  57090. * The texture used on the skybox for the main color.
  57091. * Comes from the BabylonJS CDN by default.
  57092. *
  57093. * Remarks: Can be either a texture or a url.
  57094. */
  57095. skyboxTexture: string | BaseTexture;
  57096. /**
  57097. * The color mixed in the skybox texture by default.
  57098. * BabylonJS clearColor by default.
  57099. */
  57100. skyboxColor: Color3;
  57101. /**
  57102. * The background rotation around the Y axis of the scene.
  57103. * This helps aligning the key lights of your scene with the background.
  57104. * 0 by default.
  57105. */
  57106. backgroundYRotation: number;
  57107. /**
  57108. * Compute automatically the size of the elements to best fit with the scene.
  57109. */
  57110. sizeAuto: boolean;
  57111. /**
  57112. * Default position of the rootMesh if autoSize is not true.
  57113. */
  57114. rootPosition: Vector3;
  57115. /**
  57116. * Sets up the image processing in the scene.
  57117. * true by default.
  57118. */
  57119. setupImageProcessing: boolean;
  57120. /**
  57121. * The texture used as your environment texture in the scene.
  57122. * Comes from the BabylonJS CDN by default and in use if setupImageProcessing is true.
  57123. *
  57124. * Remarks: Can be either a texture or a url.
  57125. */
  57126. environmentTexture: string | BaseTexture;
  57127. /**
  57128. * The value of the exposure to apply to the scene.
  57129. * 0.6 by default if setupImageProcessing is true.
  57130. */
  57131. cameraExposure: number;
  57132. /**
  57133. * The value of the contrast to apply to the scene.
  57134. * 1.6 by default if setupImageProcessing is true.
  57135. */
  57136. cameraContrast: number;
  57137. /**
  57138. * Specifies whether or not tonemapping should be enabled in the scene.
  57139. * true by default if setupImageProcessing is true.
  57140. */
  57141. toneMappingEnabled: boolean;
  57142. }
  57143. /**
  57144. * The Environment helper class can be used to add a fully featuread none expensive background to your scene.
  57145. * It includes by default a skybox and a ground relying on the BackgroundMaterial.
  57146. * It also helps with the default setup of your imageProcessing configuration.
  57147. */
  57148. export class EnvironmentHelper {
  57149. /**
  57150. * Default ground texture URL.
  57151. */
  57152. private static _groundTextureCDNUrl;
  57153. /**
  57154. * Default skybox texture URL.
  57155. */
  57156. private static _skyboxTextureCDNUrl;
  57157. /**
  57158. * Default environment texture URL.
  57159. */
  57160. private static _environmentTextureCDNUrl;
  57161. /**
  57162. * Creates the default options for the helper.
  57163. */
  57164. private static _getDefaultOptions;
  57165. private _rootMesh;
  57166. /**
  57167. * Gets the root mesh created by the helper.
  57168. */
  57169. get rootMesh(): Mesh;
  57170. private _skybox;
  57171. /**
  57172. * Gets the skybox created by the helper.
  57173. */
  57174. get skybox(): Nullable<Mesh>;
  57175. private _skyboxTexture;
  57176. /**
  57177. * Gets the skybox texture created by the helper.
  57178. */
  57179. get skyboxTexture(): Nullable<BaseTexture>;
  57180. private _skyboxMaterial;
  57181. /**
  57182. * Gets the skybox material created by the helper.
  57183. */
  57184. get skyboxMaterial(): Nullable<BackgroundMaterial>;
  57185. private _ground;
  57186. /**
  57187. * Gets the ground mesh created by the helper.
  57188. */
  57189. get ground(): Nullable<Mesh>;
  57190. private _groundTexture;
  57191. /**
  57192. * Gets the ground texture created by the helper.
  57193. */
  57194. get groundTexture(): Nullable<BaseTexture>;
  57195. private _groundMirror;
  57196. /**
  57197. * Gets the ground mirror created by the helper.
  57198. */
  57199. get groundMirror(): Nullable<MirrorTexture>;
  57200. /**
  57201. * Gets the ground mirror render list to helps pushing the meshes
  57202. * you wish in the ground reflection.
  57203. */
  57204. get groundMirrorRenderList(): Nullable<AbstractMesh[]>;
  57205. private _groundMaterial;
  57206. /**
  57207. * Gets the ground material created by the helper.
  57208. */
  57209. get groundMaterial(): Nullable<BackgroundMaterial>;
  57210. /**
  57211. * Stores the creation options.
  57212. */
  57213. private readonly _scene;
  57214. private _options;
  57215. /**
  57216. * This observable will be notified with any error during the creation of the environment,
  57217. * mainly texture creation errors.
  57218. */
  57219. onErrorObservable: Observable<{
  57220. message?: string;
  57221. exception?: any;
  57222. }>;
  57223. /**
  57224. * constructor
  57225. * @param options Defines the options we want to customize the helper
  57226. * @param scene The scene to add the material to
  57227. */
  57228. constructor(options: Partial<IEnvironmentHelperOptions>, scene: Scene);
  57229. /**
  57230. * Updates the background according to the new options
  57231. * @param options
  57232. */
  57233. updateOptions(options: Partial<IEnvironmentHelperOptions>): void;
  57234. /**
  57235. * Sets the primary color of all the available elements.
  57236. * @param color the main color to affect to the ground and the background
  57237. */
  57238. setMainColor(color: Color3): void;
  57239. /**
  57240. * Setup the image processing according to the specified options.
  57241. */
  57242. private _setupImageProcessing;
  57243. /**
  57244. * Setup the environment texture according to the specified options.
  57245. */
  57246. private _setupEnvironmentTexture;
  57247. /**
  57248. * Setup the background according to the specified options.
  57249. */
  57250. private _setupBackground;
  57251. /**
  57252. * Get the scene sizes according to the setup.
  57253. */
  57254. private _getSceneSize;
  57255. /**
  57256. * Setup the ground according to the specified options.
  57257. */
  57258. private _setupGround;
  57259. /**
  57260. * Setup the ground material according to the specified options.
  57261. */
  57262. private _setupGroundMaterial;
  57263. /**
  57264. * Setup the ground diffuse texture according to the specified options.
  57265. */
  57266. private _setupGroundDiffuseTexture;
  57267. /**
  57268. * Setup the ground mirror texture according to the specified options.
  57269. */
  57270. private _setupGroundMirrorTexture;
  57271. /**
  57272. * Setup the ground to receive the mirror texture.
  57273. */
  57274. private _setupMirrorInGroundMaterial;
  57275. /**
  57276. * Setup the skybox according to the specified options.
  57277. */
  57278. private _setupSkybox;
  57279. /**
  57280. * Setup the skybox material according to the specified options.
  57281. */
  57282. private _setupSkyboxMaterial;
  57283. /**
  57284. * Setup the skybox reflection texture according to the specified options.
  57285. */
  57286. private _setupSkyboxReflectionTexture;
  57287. private _errorHandler;
  57288. /**
  57289. * Dispose all the elements created by the Helper.
  57290. */
  57291. dispose(): void;
  57292. }
  57293. }
  57294. declare module "babylonjs/Helpers/textureDome" {
  57295. import { Scene } from "babylonjs/scene";
  57296. import { TransformNode } from "babylonjs/Meshes/transformNode";
  57297. import { Mesh } from "babylonjs/Meshes/mesh";
  57298. import { Texture } from "babylonjs/Materials/Textures/texture";
  57299. import { BackgroundMaterial } from "babylonjs/Materials/Background/backgroundMaterial";
  57300. import "babylonjs/Meshes/Builders/sphereBuilder";
  57301. import { Nullable } from "babylonjs/types";
  57302. import { Observable } from "babylonjs/Misc/observable";
  57303. /**
  57304. * Display a 360/180 degree texture on an approximately spherical surface, useful for VR applications or skyboxes.
  57305. * As a subclass of TransformNode, this allow parenting to the camera or multiple textures with different locations in the scene.
  57306. * This class achieves its effect with a Texture and a correctly configured BackgroundMaterial on an inverted sphere.
  57307. * Potential additions to this helper include zoom and and non-infinite distance rendering effects.
  57308. */
  57309. export abstract class TextureDome<T extends Texture> extends TransformNode {
  57310. protected onError: Nullable<(message?: string, exception?: any) => void>;
  57311. /**
  57312. * Define the source as a Monoscopic panoramic 360/180.
  57313. */
  57314. static readonly MODE_MONOSCOPIC: number;
  57315. /**
  57316. * Define the source as a Stereoscopic TopBottom/OverUnder panoramic 360/180.
  57317. */
  57318. static readonly MODE_TOPBOTTOM: number;
  57319. /**
  57320. * Define the source as a Stereoscopic Side by Side panoramic 360/180.
  57321. */
  57322. static readonly MODE_SIDEBYSIDE: number;
  57323. private _halfDome;
  57324. protected _useDirectMapping: boolean;
  57325. /**
  57326. * The texture being displayed on the sphere
  57327. */
  57328. protected _texture: T;
  57329. /**
  57330. * Gets the texture being displayed on the sphere
  57331. */
  57332. get texture(): T;
  57333. /**
  57334. * Sets the texture being displayed on the sphere
  57335. */
  57336. set texture(newTexture: T);
  57337. /**
  57338. * The skybox material
  57339. */
  57340. protected _material: BackgroundMaterial;
  57341. /**
  57342. * The surface used for the dome
  57343. */
  57344. protected _mesh: Mesh;
  57345. /**
  57346. * Gets the mesh used for the dome.
  57347. */
  57348. get mesh(): Mesh;
  57349. /**
  57350. * A mesh that will be used to mask the back of the dome in case it is a 180 degree movie.
  57351. */
  57352. private _halfDomeMask;
  57353. /**
  57354. * The current fov(field of view) multiplier, 0.0 - 2.0. Defaults to 1.0. Lower values "zoom in" and higher values "zoom out".
  57355. * Also see the options.resolution property.
  57356. */
  57357. get fovMultiplier(): number;
  57358. set fovMultiplier(value: number);
  57359. protected _textureMode: number;
  57360. /**
  57361. * Gets or set the current texture mode for the texture. It can be:
  57362. * * TextureDome.MODE_MONOSCOPIC : Define the texture source as a Monoscopic panoramic 360.
  57363. * * TextureDome.MODE_TOPBOTTOM : Define the texture source as a Stereoscopic TopBottom/OverUnder panoramic 360.
  57364. * * TextureDome.MODE_SIDEBYSIDE : Define the texture source as a Stereoscopic Side by Side panoramic 360.
  57365. */
  57366. get textureMode(): number;
  57367. /**
  57368. * Sets the current texture mode for the texture. It can be:
  57369. * * TextureDome.MODE_MONOSCOPIC : Define the texture source as a Monoscopic panoramic 360.
  57370. * * TextureDome.MODE_TOPBOTTOM : Define the texture source as a Stereoscopic TopBottom/OverUnder panoramic 360.
  57371. * * TextureDome.MODE_SIDEBYSIDE : Define the texture source as a Stereoscopic Side by Side panoramic 360.
  57372. */
  57373. set textureMode(value: number);
  57374. /**
  57375. * Is it a 180 degrees dome (half dome) or 360 texture (full dome)
  57376. */
  57377. get halfDome(): boolean;
  57378. /**
  57379. * Set the halfDome mode. If set, only the front (180 degrees) will be displayed and the back will be blacked out.
  57380. */
  57381. set halfDome(enabled: boolean);
  57382. /**
  57383. * Oberserver used in Stereoscopic VR Mode.
  57384. */
  57385. private _onBeforeCameraRenderObserver;
  57386. /**
  57387. * Observable raised when an error occured while loading the 360 image
  57388. */
  57389. onLoadErrorObservable: Observable<string>;
  57390. /**
  57391. * Create an instance of this class and pass through the parameters to the relevant classes- Texture, StandardMaterial, and Mesh.
  57392. * @param name Element's name, child elements will append suffixes for their own names.
  57393. * @param textureUrlOrElement defines the url(s) or the (video) HTML element to use
  57394. * @param options An object containing optional or exposed sub element properties
  57395. */
  57396. constructor(name: string, textureUrlOrElement: string | string[] | HTMLVideoElement, options: {
  57397. resolution?: number;
  57398. clickToPlay?: boolean;
  57399. autoPlay?: boolean;
  57400. loop?: boolean;
  57401. size?: number;
  57402. poster?: string;
  57403. faceForward?: boolean;
  57404. useDirectMapping?: boolean;
  57405. halfDomeMode?: boolean;
  57406. }, scene: Scene, onError?: Nullable<(message?: string, exception?: any) => void>);
  57407. protected abstract _initTexture(urlsOrElement: string | string[] | HTMLElement, scene: Scene, options: any): T;
  57408. protected _changeTextureMode(value: number): void;
  57409. /**
  57410. * Releases resources associated with this node.
  57411. * @param doNotRecurse Set to true to not recurse into each children (recurse into each children by default)
  57412. * @param disposeMaterialAndTextures Set to true to also dispose referenced materials and textures (false by default)
  57413. */
  57414. dispose(doNotRecurse?: boolean, disposeMaterialAndTextures?: boolean): void;
  57415. }
  57416. }
  57417. declare module "babylonjs/Helpers/photoDome" {
  57418. import { Scene } from "babylonjs/scene";
  57419. import { Texture } from "babylonjs/Materials/Textures/texture";
  57420. import { TextureDome } from "babylonjs/Helpers/textureDome";
  57421. /**
  57422. * Display a 360 degree photo on an approximately spherical surface, useful for VR applications or skyboxes.
  57423. * As a subclass of TransformNode, this allow parenting to the camera with different locations in the scene.
  57424. * This class achieves its effect with a Texture and a correctly configured BackgroundMaterial on an inverted sphere.
  57425. * Potential additions to this helper include zoom and and non-infinite distance rendering effects.
  57426. */
  57427. export class PhotoDome extends TextureDome<Texture> {
  57428. /**
  57429. * Define the image as a Monoscopic panoramic 360 image.
  57430. */
  57431. static readonly MODE_MONOSCOPIC: number;
  57432. /**
  57433. * Define the image as a Stereoscopic TopBottom/OverUnder panoramic 360 image.
  57434. */
  57435. static readonly MODE_TOPBOTTOM: number;
  57436. /**
  57437. * Define the image as a Stereoscopic Side by Side panoramic 360 image.
  57438. */
  57439. static readonly MODE_SIDEBYSIDE: number;
  57440. /**
  57441. * Gets or sets the texture being displayed on the sphere
  57442. */
  57443. get photoTexture(): Texture;
  57444. /**
  57445. * sets the texture being displayed on the sphere
  57446. */
  57447. set photoTexture(value: Texture);
  57448. /**
  57449. * Gets the current video mode for the video. It can be:
  57450. * * TextureDome.MODE_MONOSCOPIC : Define the texture source as a Monoscopic panoramic 360.
  57451. * * TextureDome.MODE_TOPBOTTOM : Define the texture source as a Stereoscopic TopBottom/OverUnder panoramic 360.
  57452. * * TextureDome.MODE_SIDEBYSIDE : Define the texture source as a Stereoscopic Side by Side panoramic 360.
  57453. */
  57454. get imageMode(): number;
  57455. /**
  57456. * Sets the current video mode for the video. It can be:
  57457. * * TextureDome.MODE_MONOSCOPIC : Define the texture source as a Monoscopic panoramic 360.
  57458. * * TextureDome.MODE_TOPBOTTOM : Define the texture source as a Stereoscopic TopBottom/OverUnder panoramic 360.
  57459. * * TextureDome.MODE_SIDEBYSIDE : Define the texture source as a Stereoscopic Side by Side panoramic 360.
  57460. */
  57461. set imageMode(value: number);
  57462. protected _initTexture(urlsOrElement: string, scene: Scene, options: any): Texture;
  57463. }
  57464. }
  57465. declare module "babylonjs/Misc/rgbdTextureTools" {
  57466. import "babylonjs/Shaders/rgbdDecode.fragment";
  57467. import "babylonjs/Engines/Extensions/engine.renderTarget";
  57468. import { Texture } from "babylonjs/Materials/Textures/texture";
  57469. /**
  57470. * Class used to host RGBD texture specific utilities
  57471. */
  57472. export class RGBDTextureTools {
  57473. /**
  57474. * Expand the RGBD Texture from RGBD to Half Float if possible.
  57475. * @param texture the texture to expand.
  57476. */
  57477. static ExpandRGBDTexture(texture: Texture): void;
  57478. }
  57479. }
  57480. declare module "babylonjs/Misc/brdfTextureTools" {
  57481. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  57482. import { Scene } from "babylonjs/scene";
  57483. /**
  57484. * Class used to host texture specific utilities
  57485. */
  57486. export class BRDFTextureTools {
  57487. /**
  57488. * Prevents texture cache collision
  57489. */
  57490. private static _instanceNumber;
  57491. /**
  57492. * Gets a default environment BRDF for MS-BRDF Height Correlated BRDF
  57493. * @param scene defines the hosting scene
  57494. * @returns the environment BRDF texture
  57495. */
  57496. static GetEnvironmentBRDFTexture(scene: Scene): BaseTexture;
  57497. private static _environmentBRDFBase64Texture;
  57498. }
  57499. }
  57500. declare module "babylonjs/Materials/PBR/pbrClearCoatConfiguration" {
  57501. import { Nullable } from "babylonjs/types";
  57502. import { Color3 } from "babylonjs/Maths/math.color";
  57503. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  57504. import { UniformBuffer } from "babylonjs/Materials/uniformBuffer";
  57505. import { IAnimatable } from "babylonjs/Animations/animatable.interface";
  57506. import { EffectFallbacks } from "babylonjs/Materials/effectFallbacks";
  57507. import { Engine } from "babylonjs/Engines/engine";
  57508. import { Scene } from "babylonjs/scene";
  57509. /**
  57510. * @hidden
  57511. */
  57512. export interface IMaterialClearCoatDefines {
  57513. CLEARCOAT: boolean;
  57514. CLEARCOAT_DEFAULTIOR: boolean;
  57515. CLEARCOAT_TEXTURE: boolean;
  57516. CLEARCOAT_TEXTUREDIRECTUV: number;
  57517. CLEARCOAT_BUMP: boolean;
  57518. CLEARCOAT_BUMPDIRECTUV: number;
  57519. CLEARCOAT_TINT: boolean;
  57520. CLEARCOAT_TINT_TEXTURE: boolean;
  57521. CLEARCOAT_TINT_TEXTUREDIRECTUV: number;
  57522. /** @hidden */
  57523. _areTexturesDirty: boolean;
  57524. }
  57525. /**
  57526. * Define the code related to the clear coat parameters of the pbr material.
  57527. */
  57528. export class PBRClearCoatConfiguration {
  57529. /**
  57530. * This defaults to 1.5 corresponding to a 0.04 f0 or a 4% reflectance at normal incidence
  57531. * The default fits with a polyurethane material.
  57532. */
  57533. private static readonly _DefaultIndexOfRefraction;
  57534. private _isEnabled;
  57535. /**
  57536. * Defines if the clear coat is enabled in the material.
  57537. */
  57538. isEnabled: boolean;
  57539. /**
  57540. * Defines the clear coat layer strength (between 0 and 1) it defaults to 1.
  57541. */
  57542. intensity: number;
  57543. /**
  57544. * Defines the clear coat layer roughness.
  57545. */
  57546. roughness: number;
  57547. private _indexOfRefraction;
  57548. /**
  57549. * Defines the index of refraction of the clear coat.
  57550. * This defaults to 1.5 corresponding to a 0.04 f0 or a 4% reflectance at normal incidence
  57551. * The default fits with a polyurethane material.
  57552. * Changing the default value is more performance intensive.
  57553. */
  57554. indexOfRefraction: number;
  57555. private _texture;
  57556. /**
  57557. * Stores the clear coat values in a texture.
  57558. */
  57559. texture: Nullable<BaseTexture>;
  57560. private _bumpTexture;
  57561. /**
  57562. * Define the clear coat specific bump texture.
  57563. */
  57564. bumpTexture: Nullable<BaseTexture>;
  57565. private _isTintEnabled;
  57566. /**
  57567. * Defines if the clear coat tint is enabled in the material.
  57568. */
  57569. isTintEnabled: boolean;
  57570. /**
  57571. * Defines the clear coat tint of the material.
  57572. * This is only use if tint is enabled
  57573. */
  57574. tintColor: Color3;
  57575. /**
  57576. * Defines the distance at which the tint color should be found in the
  57577. * clear coat media.
  57578. * This is only use if tint is enabled
  57579. */
  57580. tintColorAtDistance: number;
  57581. /**
  57582. * Defines the clear coat layer thickness.
  57583. * This is only use if tint is enabled
  57584. */
  57585. tintThickness: number;
  57586. private _tintTexture;
  57587. /**
  57588. * Stores the clear tint values in a texture.
  57589. * rgb is tint
  57590. * a is a thickness factor
  57591. */
  57592. tintTexture: Nullable<BaseTexture>;
  57593. /** @hidden */
  57594. private _internalMarkAllSubMeshesAsTexturesDirty;
  57595. /** @hidden */
  57596. _markAllSubMeshesAsTexturesDirty(): void;
  57597. /**
  57598. * Instantiate a new istance of clear coat configuration.
  57599. * @param markAllSubMeshesAsTexturesDirty Callback to flag the material to dirty
  57600. */
  57601. constructor(markAllSubMeshesAsTexturesDirty: () => void);
  57602. /**
  57603. * Gets wehter the submesh is ready to be used or not.
  57604. * @param defines the list of "defines" to update.
  57605. * @param scene defines the scene the material belongs to.
  57606. * @param engine defines the engine the material belongs to.
  57607. * @param disableBumpMap defines wether the material disables bump or not.
  57608. * @returns - boolean indicating that the submesh is ready or not.
  57609. */
  57610. isReadyForSubMesh(defines: IMaterialClearCoatDefines, scene: Scene, engine: Engine, disableBumpMap: boolean): boolean;
  57611. /**
  57612. * Checks to see if a texture is used in the material.
  57613. * @param defines the list of "defines" to update.
  57614. * @param scene defines the scene to the material belongs to.
  57615. */
  57616. prepareDefines(defines: IMaterialClearCoatDefines, scene: Scene): void;
  57617. /**
  57618. * Binds the material data.
  57619. * @param uniformBuffer defines the Uniform buffer to fill in.
  57620. * @param scene defines the scene the material belongs to.
  57621. * @param engine defines the engine the material belongs to.
  57622. * @param disableBumpMap defines wether the material disables bump or not.
  57623. * @param isFrozen defines wether the material is frozen or not.
  57624. * @param invertNormalMapX If sets to true, x component of normal map value will be inverted (x = 1.0 - x).
  57625. * @param invertNormalMapY If sets to true, y component of normal map value will be inverted (y = 1.0 - y).
  57626. */
  57627. bindForSubMesh(uniformBuffer: UniformBuffer, scene: Scene, engine: Engine, disableBumpMap: boolean, isFrozen: boolean, invertNormalMapX: boolean, invertNormalMapY: boolean): void;
  57628. /**
  57629. * Checks to see if a texture is used in the material.
  57630. * @param texture - Base texture to use.
  57631. * @returns - Boolean specifying if a texture is used in the material.
  57632. */
  57633. hasTexture(texture: BaseTexture): boolean;
  57634. /**
  57635. * Returns an array of the actively used textures.
  57636. * @param activeTextures Array of BaseTextures
  57637. */
  57638. getActiveTextures(activeTextures: BaseTexture[]): void;
  57639. /**
  57640. * Returns the animatable textures.
  57641. * @param animatables Array of animatable textures.
  57642. */
  57643. getAnimatables(animatables: IAnimatable[]): void;
  57644. /**
  57645. * Disposes the resources of the material.
  57646. * @param forceDisposeTextures - Forces the disposal of all textures.
  57647. */
  57648. dispose(forceDisposeTextures?: boolean): void;
  57649. /**
  57650. * Get the current class name of the texture useful for serialization or dynamic coding.
  57651. * @returns "PBRClearCoatConfiguration"
  57652. */
  57653. getClassName(): string;
  57654. /**
  57655. * Add fallbacks to the effect fallbacks list.
  57656. * @param defines defines the Base texture to use.
  57657. * @param fallbacks defines the current fallback list.
  57658. * @param currentRank defines the current fallback rank.
  57659. * @returns the new fallback rank.
  57660. */
  57661. static AddFallbacks(defines: IMaterialClearCoatDefines, fallbacks: EffectFallbacks, currentRank: number): number;
  57662. /**
  57663. * Add the required uniforms to the current list.
  57664. * @param uniforms defines the current uniform list.
  57665. */
  57666. static AddUniforms(uniforms: string[]): void;
  57667. /**
  57668. * Add the required samplers to the current list.
  57669. * @param samplers defines the current sampler list.
  57670. */
  57671. static AddSamplers(samplers: string[]): void;
  57672. /**
  57673. * Add the required uniforms to the current buffer.
  57674. * @param uniformBuffer defines the current uniform buffer.
  57675. */
  57676. static PrepareUniformBuffer(uniformBuffer: UniformBuffer): void;
  57677. /**
  57678. * Makes a duplicate of the current configuration into another one.
  57679. * @param clearCoatConfiguration define the config where to copy the info
  57680. */
  57681. copyTo(clearCoatConfiguration: PBRClearCoatConfiguration): void;
  57682. /**
  57683. * Serializes this clear coat configuration.
  57684. * @returns - An object with the serialized config.
  57685. */
  57686. serialize(): any;
  57687. /**
  57688. * Parses a anisotropy Configuration from a serialized object.
  57689. * @param source - Serialized object.
  57690. * @param scene Defines the scene we are parsing for
  57691. * @param rootUrl Defines the rootUrl to load from
  57692. */
  57693. parse(source: any, scene: Scene, rootUrl: string): void;
  57694. }
  57695. }
  57696. declare module "babylonjs/Materials/PBR/pbrAnisotropicConfiguration" {
  57697. import { UniformBuffer } from "babylonjs/Materials/uniformBuffer";
  57698. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  57699. import { Vector2 } from "babylonjs/Maths/math.vector";
  57700. import { Scene } from "babylonjs/scene";
  57701. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  57702. import { Nullable } from "babylonjs/types";
  57703. import { IAnimatable } from "babylonjs/Animations/animatable.interface";
  57704. import { EffectFallbacks } from "babylonjs/Materials/effectFallbacks";
  57705. /**
  57706. * @hidden
  57707. */
  57708. export interface IMaterialAnisotropicDefines {
  57709. ANISOTROPIC: boolean;
  57710. ANISOTROPIC_TEXTURE: boolean;
  57711. ANISOTROPIC_TEXTUREDIRECTUV: number;
  57712. MAINUV1: boolean;
  57713. _areTexturesDirty: boolean;
  57714. _needUVs: boolean;
  57715. }
  57716. /**
  57717. * Define the code related to the anisotropic parameters of the pbr material.
  57718. */
  57719. export class PBRAnisotropicConfiguration {
  57720. private _isEnabled;
  57721. /**
  57722. * Defines if the anisotropy is enabled in the material.
  57723. */
  57724. isEnabled: boolean;
  57725. /**
  57726. * Defines the anisotropy strength (between 0 and 1) it defaults to 1.
  57727. */
  57728. intensity: number;
  57729. /**
  57730. * Defines if the effect is along the tangents, bitangents or in between.
  57731. * By default, the effect is "strectching" the highlights along the tangents.
  57732. */
  57733. direction: Vector2;
  57734. private _texture;
  57735. /**
  57736. * Stores the anisotropy values in a texture.
  57737. * rg is direction (like normal from -1 to 1)
  57738. * b is a intensity
  57739. */
  57740. texture: Nullable<BaseTexture>;
  57741. /** @hidden */
  57742. private _internalMarkAllSubMeshesAsTexturesDirty;
  57743. /** @hidden */
  57744. _markAllSubMeshesAsTexturesDirty(): void;
  57745. /**
  57746. * Instantiate a new istance of anisotropy configuration.
  57747. * @param markAllSubMeshesAsTexturesDirty Callback to flag the material to dirty
  57748. */
  57749. constructor(markAllSubMeshesAsTexturesDirty: () => void);
  57750. /**
  57751. * Specifies that the submesh is ready to be used.
  57752. * @param defines the list of "defines" to update.
  57753. * @param scene defines the scene the material belongs to.
  57754. * @returns - boolean indicating that the submesh is ready or not.
  57755. */
  57756. isReadyForSubMesh(defines: IMaterialAnisotropicDefines, scene: Scene): boolean;
  57757. /**
  57758. * Checks to see if a texture is used in the material.
  57759. * @param defines the list of "defines" to update.
  57760. * @param mesh the mesh we are preparing the defines for.
  57761. * @param scene defines the scene the material belongs to.
  57762. */
  57763. prepareDefines(defines: IMaterialAnisotropicDefines, mesh: AbstractMesh, scene: Scene): void;
  57764. /**
  57765. * Binds the material data.
  57766. * @param uniformBuffer defines the Uniform buffer to fill in.
  57767. * @param scene defines the scene the material belongs to.
  57768. * @param isFrozen defines wether the material is frozen or not.
  57769. */
  57770. bindForSubMesh(uniformBuffer: UniformBuffer, scene: Scene, isFrozen: boolean): void;
  57771. /**
  57772. * Checks to see if a texture is used in the material.
  57773. * @param texture - Base texture to use.
  57774. * @returns - Boolean specifying if a texture is used in the material.
  57775. */
  57776. hasTexture(texture: BaseTexture): boolean;
  57777. /**
  57778. * Returns an array of the actively used textures.
  57779. * @param activeTextures Array of BaseTextures
  57780. */
  57781. getActiveTextures(activeTextures: BaseTexture[]): void;
  57782. /**
  57783. * Returns the animatable textures.
  57784. * @param animatables Array of animatable textures.
  57785. */
  57786. getAnimatables(animatables: IAnimatable[]): void;
  57787. /**
  57788. * Disposes the resources of the material.
  57789. * @param forceDisposeTextures - Forces the disposal of all textures.
  57790. */
  57791. dispose(forceDisposeTextures?: boolean): void;
  57792. /**
  57793. * Get the current class name of the texture useful for serialization or dynamic coding.
  57794. * @returns "PBRAnisotropicConfiguration"
  57795. */
  57796. getClassName(): string;
  57797. /**
  57798. * Add fallbacks to the effect fallbacks list.
  57799. * @param defines defines the Base texture to use.
  57800. * @param fallbacks defines the current fallback list.
  57801. * @param currentRank defines the current fallback rank.
  57802. * @returns the new fallback rank.
  57803. */
  57804. static AddFallbacks(defines: IMaterialAnisotropicDefines, fallbacks: EffectFallbacks, currentRank: number): number;
  57805. /**
  57806. * Add the required uniforms to the current list.
  57807. * @param uniforms defines the current uniform list.
  57808. */
  57809. static AddUniforms(uniforms: string[]): void;
  57810. /**
  57811. * Add the required uniforms to the current buffer.
  57812. * @param uniformBuffer defines the current uniform buffer.
  57813. */
  57814. static PrepareUniformBuffer(uniformBuffer: UniformBuffer): void;
  57815. /**
  57816. * Add the required samplers to the current list.
  57817. * @param samplers defines the current sampler list.
  57818. */
  57819. static AddSamplers(samplers: string[]): void;
  57820. /**
  57821. * Makes a duplicate of the current configuration into another one.
  57822. * @param anisotropicConfiguration define the config where to copy the info
  57823. */
  57824. copyTo(anisotropicConfiguration: PBRAnisotropicConfiguration): void;
  57825. /**
  57826. * Serializes this anisotropy configuration.
  57827. * @returns - An object with the serialized config.
  57828. */
  57829. serialize(): any;
  57830. /**
  57831. * Parses a anisotropy Configuration from a serialized object.
  57832. * @param source - Serialized object.
  57833. * @param scene Defines the scene we are parsing for
  57834. * @param rootUrl Defines the rootUrl to load from
  57835. */
  57836. parse(source: any, scene: Scene, rootUrl: string): void;
  57837. }
  57838. }
  57839. declare module "babylonjs/Materials/PBR/pbrBRDFConfiguration" {
  57840. import { Scene } from "babylonjs/scene";
  57841. /**
  57842. * @hidden
  57843. */
  57844. export interface IMaterialBRDFDefines {
  57845. BRDF_V_HEIGHT_CORRELATED: boolean;
  57846. MS_BRDF_ENERGY_CONSERVATION: boolean;
  57847. SPHERICAL_HARMONICS: boolean;
  57848. SPECULAR_GLOSSINESS_ENERGY_CONSERVATION: boolean;
  57849. /** @hidden */
  57850. _areMiscDirty: boolean;
  57851. }
  57852. /**
  57853. * Define the code related to the BRDF parameters of the pbr material.
  57854. */
  57855. export class PBRBRDFConfiguration {
  57856. /**
  57857. * Default value used for the energy conservation.
  57858. * This should only be changed to adapt to the type of texture in scene.environmentBRDFTexture.
  57859. */
  57860. static DEFAULT_USE_ENERGY_CONSERVATION: boolean;
  57861. /**
  57862. * Default value used for the Smith Visibility Height Correlated mode.
  57863. * This should only be changed to adapt to the type of texture in scene.environmentBRDFTexture.
  57864. */
  57865. static DEFAULT_USE_SMITH_VISIBILITY_HEIGHT_CORRELATED: boolean;
  57866. /**
  57867. * Default value used for the IBL diffuse part.
  57868. * This can help switching back to the polynomials mode globally which is a tiny bit
  57869. * less GPU intensive at the drawback of a lower quality.
  57870. */
  57871. static DEFAULT_USE_SPHERICAL_HARMONICS: boolean;
  57872. /**
  57873. * Default value used for activating energy conservation for the specular workflow.
  57874. * If activated, the albedo color is multiplied with (1. - maxChannel(specular color)).
  57875. * If deactivated, a material is only physically plausible, when (albedo color + specular color) < 1.
  57876. */
  57877. static DEFAULT_USE_SPECULAR_GLOSSINESS_INPUT_ENERGY_CONSERVATION: boolean;
  57878. private _useEnergyConservation;
  57879. /**
  57880. * Defines if the material uses energy conservation.
  57881. */
  57882. useEnergyConservation: boolean;
  57883. private _useSmithVisibilityHeightCorrelated;
  57884. /**
  57885. * LEGACY Mode set to false
  57886. * Defines if the material uses height smith correlated visibility term.
  57887. * If you intent to not use our default BRDF, you need to load a separate BRDF Texture for the PBR
  57888. * You can either load https://assets.babylonjs.com/environments/uncorrelatedBRDF.png
  57889. * or https://assets.babylonjs.com/environments/uncorrelatedBRDF.dds to have more precision
  57890. * Not relying on height correlated will also disable energy conservation.
  57891. */
  57892. useSmithVisibilityHeightCorrelated: boolean;
  57893. private _useSphericalHarmonics;
  57894. /**
  57895. * LEGACY Mode set to false
  57896. * Defines if the material uses spherical harmonics vs spherical polynomials for the
  57897. * diffuse part of the IBL.
  57898. * The harmonics despite a tiny bigger cost has been proven to provide closer results
  57899. * to the ground truth.
  57900. */
  57901. useSphericalHarmonics: boolean;
  57902. private _useSpecularGlossinessInputEnergyConservation;
  57903. /**
  57904. * Defines if the material uses energy conservation, when the specular workflow is active.
  57905. * If activated, the albedo color is multiplied with (1. - maxChannel(specular color)).
  57906. * If deactivated, a material is only physically plausible, when (albedo color + specular color) < 1.
  57907. * In the deactivated case, the material author has to ensure energy conservation, for a physically plausible rendering.
  57908. */
  57909. useSpecularGlossinessInputEnergyConservation: boolean;
  57910. /** @hidden */
  57911. private _internalMarkAllSubMeshesAsMiscDirty;
  57912. /** @hidden */
  57913. _markAllSubMeshesAsMiscDirty(): void;
  57914. /**
  57915. * Instantiate a new istance of clear coat configuration.
  57916. * @param markAllSubMeshesAsMiscDirty Callback to flag the material to dirty
  57917. */
  57918. constructor(markAllSubMeshesAsMiscDirty: () => void);
  57919. /**
  57920. * Checks to see if a texture is used in the material.
  57921. * @param defines the list of "defines" to update.
  57922. */
  57923. prepareDefines(defines: IMaterialBRDFDefines): void;
  57924. /**
  57925. * Get the current class name of the texture useful for serialization or dynamic coding.
  57926. * @returns "PBRClearCoatConfiguration"
  57927. */
  57928. getClassName(): string;
  57929. /**
  57930. * Makes a duplicate of the current configuration into another one.
  57931. * @param brdfConfiguration define the config where to copy the info
  57932. */
  57933. copyTo(brdfConfiguration: PBRBRDFConfiguration): void;
  57934. /**
  57935. * Serializes this BRDF configuration.
  57936. * @returns - An object with the serialized config.
  57937. */
  57938. serialize(): any;
  57939. /**
  57940. * Parses a anisotropy Configuration from a serialized object.
  57941. * @param source - Serialized object.
  57942. * @param scene Defines the scene we are parsing for
  57943. * @param rootUrl Defines the rootUrl to load from
  57944. */
  57945. parse(source: any, scene: Scene, rootUrl: string): void;
  57946. }
  57947. }
  57948. declare module "babylonjs/Materials/PBR/pbrSheenConfiguration" {
  57949. import { UniformBuffer } from "babylonjs/Materials/uniformBuffer";
  57950. import { Color3 } from "babylonjs/Maths/math.color";
  57951. import { Scene } from "babylonjs/scene";
  57952. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  57953. import { Nullable } from "babylonjs/types";
  57954. import { IAnimatable } from "babylonjs/Animations/animatable.interface";
  57955. import { EffectFallbacks } from "babylonjs/Materials/effectFallbacks";
  57956. /**
  57957. * @hidden
  57958. */
  57959. export interface IMaterialSheenDefines {
  57960. SHEEN: boolean;
  57961. SHEEN_TEXTURE: boolean;
  57962. SHEEN_TEXTUREDIRECTUV: number;
  57963. SHEEN_LINKWITHALBEDO: boolean;
  57964. SHEEN_ROUGHNESS: boolean;
  57965. SHEEN_ALBEDOSCALING: boolean;
  57966. /** @hidden */
  57967. _areTexturesDirty: boolean;
  57968. }
  57969. /**
  57970. * Define the code related to the Sheen parameters of the pbr material.
  57971. */
  57972. export class PBRSheenConfiguration {
  57973. private _isEnabled;
  57974. /**
  57975. * Defines if the material uses sheen.
  57976. */
  57977. isEnabled: boolean;
  57978. private _linkSheenWithAlbedo;
  57979. /**
  57980. * Defines if the sheen is linked to the sheen color.
  57981. */
  57982. linkSheenWithAlbedo: boolean;
  57983. /**
  57984. * Defines the sheen intensity.
  57985. */
  57986. intensity: number;
  57987. /**
  57988. * Defines the sheen color.
  57989. */
  57990. color: Color3;
  57991. private _texture;
  57992. /**
  57993. * Stores the sheen tint values in a texture.
  57994. * rgb is tint
  57995. * a is a intensity or roughness if roughness has been defined
  57996. */
  57997. texture: Nullable<BaseTexture>;
  57998. private _roughness;
  57999. /**
  58000. * Defines the sheen roughness.
  58001. * It is not taken into account if linkSheenWithAlbedo is true.
  58002. * To stay backward compatible, material roughness is used instead if sheen roughness = null
  58003. */
  58004. roughness: Nullable<number>;
  58005. private _albedoScaling;
  58006. /**
  58007. * If true, the sheen effect is layered above the base BRDF with the albedo-scaling technique.
  58008. * It allows the strength of the sheen effect to not depend on the base color of the material,
  58009. * making it easier to setup and tweak the effect
  58010. */
  58011. albedoScaling: boolean;
  58012. /** @hidden */
  58013. private _internalMarkAllSubMeshesAsTexturesDirty;
  58014. /** @hidden */
  58015. _markAllSubMeshesAsTexturesDirty(): void;
  58016. /**
  58017. * Instantiate a new istance of clear coat configuration.
  58018. * @param markAllSubMeshesAsTexturesDirty Callback to flag the material to dirty
  58019. */
  58020. constructor(markAllSubMeshesAsTexturesDirty: () => void);
  58021. /**
  58022. * Specifies that the submesh is ready to be used.
  58023. * @param defines the list of "defines" to update.
  58024. * @param scene defines the scene the material belongs to.
  58025. * @returns - boolean indicating that the submesh is ready or not.
  58026. */
  58027. isReadyForSubMesh(defines: IMaterialSheenDefines, scene: Scene): boolean;
  58028. /**
  58029. * Checks to see if a texture is used in the material.
  58030. * @param defines the list of "defines" to update.
  58031. * @param scene defines the scene the material belongs to.
  58032. */
  58033. prepareDefines(defines: IMaterialSheenDefines, scene: Scene): void;
  58034. /**
  58035. * Binds the material data.
  58036. * @param uniformBuffer defines the Uniform buffer to fill in.
  58037. * @param scene defines the scene the material belongs to.
  58038. * @param isFrozen defines wether the material is frozen or not.
  58039. */
  58040. bindForSubMesh(uniformBuffer: UniformBuffer, scene: Scene, isFrozen: boolean): void;
  58041. /**
  58042. * Checks to see if a texture is used in the material.
  58043. * @param texture - Base texture to use.
  58044. * @returns - Boolean specifying if a texture is used in the material.
  58045. */
  58046. hasTexture(texture: BaseTexture): boolean;
  58047. /**
  58048. * Returns an array of the actively used textures.
  58049. * @param activeTextures Array of BaseTextures
  58050. */
  58051. getActiveTextures(activeTextures: BaseTexture[]): void;
  58052. /**
  58053. * Returns the animatable textures.
  58054. * @param animatables Array of animatable textures.
  58055. */
  58056. getAnimatables(animatables: IAnimatable[]): void;
  58057. /**
  58058. * Disposes the resources of the material.
  58059. * @param forceDisposeTextures - Forces the disposal of all textures.
  58060. */
  58061. dispose(forceDisposeTextures?: boolean): void;
  58062. /**
  58063. * Get the current class name of the texture useful for serialization or dynamic coding.
  58064. * @returns "PBRSheenConfiguration"
  58065. */
  58066. getClassName(): string;
  58067. /**
  58068. * Add fallbacks to the effect fallbacks list.
  58069. * @param defines defines the Base texture to use.
  58070. * @param fallbacks defines the current fallback list.
  58071. * @param currentRank defines the current fallback rank.
  58072. * @returns the new fallback rank.
  58073. */
  58074. static AddFallbacks(defines: IMaterialSheenDefines, fallbacks: EffectFallbacks, currentRank: number): number;
  58075. /**
  58076. * Add the required uniforms to the current list.
  58077. * @param uniforms defines the current uniform list.
  58078. */
  58079. static AddUniforms(uniforms: string[]): void;
  58080. /**
  58081. * Add the required uniforms to the current buffer.
  58082. * @param uniformBuffer defines the current uniform buffer.
  58083. */
  58084. static PrepareUniformBuffer(uniformBuffer: UniformBuffer): void;
  58085. /**
  58086. * Add the required samplers to the current list.
  58087. * @param samplers defines the current sampler list.
  58088. */
  58089. static AddSamplers(samplers: string[]): void;
  58090. /**
  58091. * Makes a duplicate of the current configuration into another one.
  58092. * @param sheenConfiguration define the config where to copy the info
  58093. */
  58094. copyTo(sheenConfiguration: PBRSheenConfiguration): void;
  58095. /**
  58096. * Serializes this BRDF configuration.
  58097. * @returns - An object with the serialized config.
  58098. */
  58099. serialize(): any;
  58100. /**
  58101. * Parses a anisotropy Configuration from a serialized object.
  58102. * @param source - Serialized object.
  58103. * @param scene Defines the scene we are parsing for
  58104. * @param rootUrl Defines the rootUrl to load from
  58105. */
  58106. parse(source: any, scene: Scene, rootUrl: string): void;
  58107. }
  58108. }
  58109. declare module "babylonjs/Materials/PBR/pbrSubSurfaceConfiguration" {
  58110. import { Nullable } from "babylonjs/types";
  58111. import { IAnimatable } from "babylonjs/Animations/animatable.interface";
  58112. import { Color3 } from "babylonjs/Maths/math.color";
  58113. import { SmartArray } from "babylonjs/Misc/smartArray";
  58114. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  58115. import { RenderTargetTexture } from "babylonjs/Materials/Textures/renderTargetTexture";
  58116. import { Effect } from "babylonjs/Materials/effect";
  58117. import { UniformBuffer } from "babylonjs/Materials/uniformBuffer";
  58118. import { EffectFallbacks } from "babylonjs/Materials/effectFallbacks";
  58119. import { Engine } from "babylonjs/Engines/engine";
  58120. import { Scene } from "babylonjs/scene";
  58121. /**
  58122. * @hidden
  58123. */
  58124. export interface IMaterialSubSurfaceDefines {
  58125. SUBSURFACE: boolean;
  58126. SS_REFRACTION: boolean;
  58127. SS_TRANSLUCENCY: boolean;
  58128. SS_SCATTERING: boolean;
  58129. SS_THICKNESSANDMASK_TEXTURE: boolean;
  58130. SS_THICKNESSANDMASK_TEXTUREDIRECTUV: number;
  58131. SS_REFRACTIONMAP_3D: boolean;
  58132. SS_REFRACTIONMAP_OPPOSITEZ: boolean;
  58133. SS_LODINREFRACTIONALPHA: boolean;
  58134. SS_GAMMAREFRACTION: boolean;
  58135. SS_RGBDREFRACTION: boolean;
  58136. SS_LINEARSPECULARREFRACTION: boolean;
  58137. SS_LINKREFRACTIONTOTRANSPARENCY: boolean;
  58138. SS_ALBEDOFORREFRACTIONTINT: boolean;
  58139. SS_MASK_FROM_THICKNESS_TEXTURE: boolean;
  58140. /** @hidden */
  58141. _areTexturesDirty: boolean;
  58142. }
  58143. /**
  58144. * Define the code related to the sub surface parameters of the pbr material.
  58145. */
  58146. export class PBRSubSurfaceConfiguration {
  58147. private _isRefractionEnabled;
  58148. /**
  58149. * Defines if the refraction is enabled in the material.
  58150. */
  58151. isRefractionEnabled: boolean;
  58152. private _isTranslucencyEnabled;
  58153. /**
  58154. * Defines if the translucency is enabled in the material.
  58155. */
  58156. isTranslucencyEnabled: boolean;
  58157. private _isScatteringEnabled;
  58158. /**
  58159. * Defines if the sub surface scattering is enabled in the material.
  58160. */
  58161. isScatteringEnabled: boolean;
  58162. private _scatteringDiffusionProfileIndex;
  58163. /**
  58164. * Diffusion profile for subsurface scattering.
  58165. * Useful for better scattering in the skins or foliages.
  58166. */
  58167. get scatteringDiffusionProfile(): Nullable<Color3>;
  58168. set scatteringDiffusionProfile(c: Nullable<Color3>);
  58169. /**
  58170. * Defines the refraction intensity of the material.
  58171. * The refraction when enabled replaces the Diffuse part of the material.
  58172. * The intensity helps transitionning between diffuse and refraction.
  58173. */
  58174. refractionIntensity: number;
  58175. /**
  58176. * Defines the translucency intensity of the material.
  58177. * When translucency has been enabled, this defines how much of the "translucency"
  58178. * is addded to the diffuse part of the material.
  58179. */
  58180. translucencyIntensity: number;
  58181. /**
  58182. * When enabled, transparent surfaces will be tinted with the albedo colour (independent of thickness)
  58183. */
  58184. useAlbedoToTintRefraction: boolean;
  58185. private _thicknessTexture;
  58186. /**
  58187. * Stores the average thickness of a mesh in a texture (The texture is holding the values linearly).
  58188. * The red channel of the texture should contain the thickness remapped between 0 and 1.
  58189. * 0 would mean minimumThickness
  58190. * 1 would mean maximumThickness
  58191. * The other channels might be use as a mask to vary the different effects intensity.
  58192. */
  58193. thicknessTexture: Nullable<BaseTexture>;
  58194. private _refractionTexture;
  58195. /**
  58196. * Defines the texture to use for refraction.
  58197. */
  58198. refractionTexture: Nullable<BaseTexture>;
  58199. private _indexOfRefraction;
  58200. /**
  58201. * Index of refraction of the material base layer.
  58202. * https://en.wikipedia.org/wiki/List_of_refractive_indices
  58203. *
  58204. * This does not only impact refraction but also the Base F0 of Dielectric Materials.
  58205. *
  58206. * From dielectric fresnel rules: F0 = square((iorT - iorI) / (iorT + iorI))
  58207. */
  58208. indexOfRefraction: number;
  58209. private _volumeIndexOfRefraction;
  58210. /**
  58211. * Index of refraction of the material's volume.
  58212. * https://en.wikipedia.org/wiki/List_of_refractive_indices
  58213. *
  58214. * This ONLY impacts refraction. If not provided or given a non-valid value,
  58215. * the volume will use the same IOR as the surface.
  58216. */
  58217. get volumeIndexOfRefraction(): number;
  58218. set volumeIndexOfRefraction(value: number);
  58219. private _invertRefractionY;
  58220. /**
  58221. * Controls if refraction needs to be inverted on Y. This could be useful for procedural texture.
  58222. */
  58223. invertRefractionY: boolean;
  58224. private _linkRefractionWithTransparency;
  58225. /**
  58226. * This parameters will make the material used its opacity to control how much it is refracting aginst not.
  58227. * Materials half opaque for instance using refraction could benefit from this control.
  58228. */
  58229. linkRefractionWithTransparency: boolean;
  58230. /**
  58231. * Defines the minimum thickness stored in the thickness map.
  58232. * If no thickness map is defined, this value will be used to simulate thickness.
  58233. */
  58234. minimumThickness: number;
  58235. /**
  58236. * Defines the maximum thickness stored in the thickness map.
  58237. */
  58238. maximumThickness: number;
  58239. /**
  58240. * Defines the volume tint of the material.
  58241. * This is used for both translucency and scattering.
  58242. */
  58243. tintColor: Color3;
  58244. /**
  58245. * Defines the distance at which the tint color should be found in the media.
  58246. * This is used for refraction only.
  58247. */
  58248. tintColorAtDistance: number;
  58249. /**
  58250. * Defines how far each channel transmit through the media.
  58251. * It is defined as a color to simplify it selection.
  58252. */
  58253. diffusionDistance: Color3;
  58254. private _useMaskFromThicknessTexture;
  58255. /**
  58256. * Stores the intensity of the different subsurface effects in the thickness texture.
  58257. * * the green channel is the translucency intensity.
  58258. * * the blue channel is the scattering intensity.
  58259. * * the alpha channel is the refraction intensity.
  58260. */
  58261. useMaskFromThicknessTexture: boolean;
  58262. private _scene;
  58263. /** @hidden */
  58264. private _internalMarkAllSubMeshesAsTexturesDirty;
  58265. private _internalMarkScenePrePassDirty;
  58266. /** @hidden */
  58267. _markAllSubMeshesAsTexturesDirty(): void;
  58268. /** @hidden */
  58269. _markScenePrePassDirty(): void;
  58270. /**
  58271. * Instantiate a new istance of sub surface configuration.
  58272. * @param markAllSubMeshesAsTexturesDirty Callback to flag the material to dirty
  58273. * @param markScenePrePassDirty Callback to flag the scene as prepass dirty
  58274. * @param scene The scene
  58275. */
  58276. constructor(markAllSubMeshesAsTexturesDirty: () => void, markScenePrePassDirty: () => void, scene: Scene);
  58277. /**
  58278. * Gets wehter the submesh is ready to be used or not.
  58279. * @param defines the list of "defines" to update.
  58280. * @param scene defines the scene the material belongs to.
  58281. * @returns - boolean indicating that the submesh is ready or not.
  58282. */
  58283. isReadyForSubMesh(defines: IMaterialSubSurfaceDefines, scene: Scene): boolean;
  58284. /**
  58285. * Checks to see if a texture is used in the material.
  58286. * @param defines the list of "defines" to update.
  58287. * @param scene defines the scene to the material belongs to.
  58288. */
  58289. prepareDefines(defines: IMaterialSubSurfaceDefines, scene: Scene): void;
  58290. /**
  58291. * Binds the material data.
  58292. * @param uniformBuffer defines the Uniform buffer to fill in.
  58293. * @param scene defines the scene the material belongs to.
  58294. * @param engine defines the engine the material belongs to.
  58295. * @param isFrozen defines whether the material is frozen or not.
  58296. * @param lodBasedMicrosurface defines whether the material relies on lod based microsurface or not.
  58297. * @param realTimeFiltering defines whether the textures should be filtered on the fly.
  58298. */
  58299. bindForSubMesh(uniformBuffer: UniformBuffer, scene: Scene, engine: Engine, isFrozen: boolean, lodBasedMicrosurface: boolean, realTimeFiltering: boolean): void;
  58300. /**
  58301. * Unbinds the material from the mesh.
  58302. * @param activeEffect defines the effect that should be unbound from.
  58303. * @returns true if unbound, otherwise false
  58304. */
  58305. unbind(activeEffect: Effect): boolean;
  58306. /**
  58307. * Returns the texture used for refraction or null if none is used.
  58308. * @param scene defines the scene the material belongs to.
  58309. * @returns - Refraction texture if present. If no refraction texture and refraction
  58310. * is linked with transparency, returns environment texture. Otherwise, returns null.
  58311. */
  58312. private _getRefractionTexture;
  58313. /**
  58314. * Returns true if alpha blending should be disabled.
  58315. */
  58316. get disableAlphaBlending(): boolean;
  58317. /**
  58318. * Fills the list of render target textures.
  58319. * @param renderTargets the list of render targets to update
  58320. */
  58321. fillRenderTargetTextures(renderTargets: SmartArray<RenderTargetTexture>): void;
  58322. /**
  58323. * Checks to see if a texture is used in the material.
  58324. * @param texture - Base texture to use.
  58325. * @returns - Boolean specifying if a texture is used in the material.
  58326. */
  58327. hasTexture(texture: BaseTexture): boolean;
  58328. /**
  58329. * Gets a boolean indicating that current material needs to register RTT
  58330. * @returns true if this uses a render target otherwise false.
  58331. */
  58332. hasRenderTargetTextures(): boolean;
  58333. /**
  58334. * Returns an array of the actively used textures.
  58335. * @param activeTextures Array of BaseTextures
  58336. */
  58337. getActiveTextures(activeTextures: BaseTexture[]): void;
  58338. /**
  58339. * Returns the animatable textures.
  58340. * @param animatables Array of animatable textures.
  58341. */
  58342. getAnimatables(animatables: IAnimatable[]): void;
  58343. /**
  58344. * Disposes the resources of the material.
  58345. * @param forceDisposeTextures - Forces the disposal of all textures.
  58346. */
  58347. dispose(forceDisposeTextures?: boolean): void;
  58348. /**
  58349. * Get the current class name of the texture useful for serialization or dynamic coding.
  58350. * @returns "PBRSubSurfaceConfiguration"
  58351. */
  58352. getClassName(): string;
  58353. /**
  58354. * Add fallbacks to the effect fallbacks list.
  58355. * @param defines defines the Base texture to use.
  58356. * @param fallbacks defines the current fallback list.
  58357. * @param currentRank defines the current fallback rank.
  58358. * @returns the new fallback rank.
  58359. */
  58360. static AddFallbacks(defines: IMaterialSubSurfaceDefines, fallbacks: EffectFallbacks, currentRank: number): number;
  58361. /**
  58362. * Add the required uniforms to the current list.
  58363. * @param uniforms defines the current uniform list.
  58364. */
  58365. static AddUniforms(uniforms: string[]): void;
  58366. /**
  58367. * Add the required samplers to the current list.
  58368. * @param samplers defines the current sampler list.
  58369. */
  58370. static AddSamplers(samplers: string[]): void;
  58371. /**
  58372. * Add the required uniforms to the current buffer.
  58373. * @param uniformBuffer defines the current uniform buffer.
  58374. */
  58375. static PrepareUniformBuffer(uniformBuffer: UniformBuffer): void;
  58376. /**
  58377. * Makes a duplicate of the current configuration into another one.
  58378. * @param configuration define the config where to copy the info
  58379. */
  58380. copyTo(configuration: PBRSubSurfaceConfiguration): void;
  58381. /**
  58382. * Serializes this Sub Surface configuration.
  58383. * @returns - An object with the serialized config.
  58384. */
  58385. serialize(): any;
  58386. /**
  58387. * Parses a anisotropy Configuration from a serialized object.
  58388. * @param source - Serialized object.
  58389. * @param scene Defines the scene we are parsing for
  58390. * @param rootUrl Defines the rootUrl to load from
  58391. */
  58392. parse(source: any, scene: Scene, rootUrl: string): void;
  58393. }
  58394. }
  58395. declare module "babylonjs/Shaders/ShadersInclude/pbrFragmentDeclaration" {
  58396. /** @hidden */
  58397. export var pbrFragmentDeclaration: {
  58398. name: string;
  58399. shader: string;
  58400. };
  58401. }
  58402. declare module "babylonjs/Shaders/ShadersInclude/pbrUboDeclaration" {
  58403. /** @hidden */
  58404. export var pbrUboDeclaration: {
  58405. name: string;
  58406. shader: string;
  58407. };
  58408. }
  58409. declare module "babylonjs/Shaders/ShadersInclude/pbrFragmentExtraDeclaration" {
  58410. /** @hidden */
  58411. export var pbrFragmentExtraDeclaration: {
  58412. name: string;
  58413. shader: string;
  58414. };
  58415. }
  58416. declare module "babylonjs/Shaders/ShadersInclude/pbrFragmentSamplersDeclaration" {
  58417. /** @hidden */
  58418. export var pbrFragmentSamplersDeclaration: {
  58419. name: string;
  58420. shader: string;
  58421. };
  58422. }
  58423. declare module "babylonjs/Shaders/ShadersInclude/importanceSampling" {
  58424. /** @hidden */
  58425. export var importanceSampling: {
  58426. name: string;
  58427. shader: string;
  58428. };
  58429. }
  58430. declare module "babylonjs/Shaders/ShadersInclude/pbrHelperFunctions" {
  58431. /** @hidden */
  58432. export var pbrHelperFunctions: {
  58433. name: string;
  58434. shader: string;
  58435. };
  58436. }
  58437. declare module "babylonjs/Shaders/ShadersInclude/harmonicsFunctions" {
  58438. /** @hidden */
  58439. export var harmonicsFunctions: {
  58440. name: string;
  58441. shader: string;
  58442. };
  58443. }
  58444. declare module "babylonjs/Shaders/ShadersInclude/pbrDirectLightingSetupFunctions" {
  58445. /** @hidden */
  58446. export var pbrDirectLightingSetupFunctions: {
  58447. name: string;
  58448. shader: string;
  58449. };
  58450. }
  58451. declare module "babylonjs/Shaders/ShadersInclude/pbrDirectLightingFalloffFunctions" {
  58452. /** @hidden */
  58453. export var pbrDirectLightingFalloffFunctions: {
  58454. name: string;
  58455. shader: string;
  58456. };
  58457. }
  58458. declare module "babylonjs/Shaders/ShadersInclude/pbrBRDFFunctions" {
  58459. /** @hidden */
  58460. export var pbrBRDFFunctions: {
  58461. name: string;
  58462. shader: string;
  58463. };
  58464. }
  58465. declare module "babylonjs/Shaders/ShadersInclude/hdrFilteringFunctions" {
  58466. /** @hidden */
  58467. export var hdrFilteringFunctions: {
  58468. name: string;
  58469. shader: string;
  58470. };
  58471. }
  58472. declare module "babylonjs/Shaders/ShadersInclude/pbrDirectLightingFunctions" {
  58473. /** @hidden */
  58474. export var pbrDirectLightingFunctions: {
  58475. name: string;
  58476. shader: string;
  58477. };
  58478. }
  58479. declare module "babylonjs/Shaders/ShadersInclude/pbrIBLFunctions" {
  58480. /** @hidden */
  58481. export var pbrIBLFunctions: {
  58482. name: string;
  58483. shader: string;
  58484. };
  58485. }
  58486. declare module "babylonjs/Shaders/ShadersInclude/pbrBlockAlbedoOpacity" {
  58487. /** @hidden */
  58488. export var pbrBlockAlbedoOpacity: {
  58489. name: string;
  58490. shader: string;
  58491. };
  58492. }
  58493. declare module "babylonjs/Shaders/ShadersInclude/pbrBlockReflectivity" {
  58494. /** @hidden */
  58495. export var pbrBlockReflectivity: {
  58496. name: string;
  58497. shader: string;
  58498. };
  58499. }
  58500. declare module "babylonjs/Shaders/ShadersInclude/pbrBlockAmbientOcclusion" {
  58501. /** @hidden */
  58502. export var pbrBlockAmbientOcclusion: {
  58503. name: string;
  58504. shader: string;
  58505. };
  58506. }
  58507. declare module "babylonjs/Shaders/ShadersInclude/pbrBlockAlphaFresnel" {
  58508. /** @hidden */
  58509. export var pbrBlockAlphaFresnel: {
  58510. name: string;
  58511. shader: string;
  58512. };
  58513. }
  58514. declare module "babylonjs/Shaders/ShadersInclude/pbrBlockAnisotropic" {
  58515. /** @hidden */
  58516. export var pbrBlockAnisotropic: {
  58517. name: string;
  58518. shader: string;
  58519. };
  58520. }
  58521. declare module "babylonjs/Shaders/ShadersInclude/pbrBlockReflection" {
  58522. /** @hidden */
  58523. export var pbrBlockReflection: {
  58524. name: string;
  58525. shader: string;
  58526. };
  58527. }
  58528. declare module "babylonjs/Shaders/ShadersInclude/pbrBlockSheen" {
  58529. /** @hidden */
  58530. export var pbrBlockSheen: {
  58531. name: string;
  58532. shader: string;
  58533. };
  58534. }
  58535. declare module "babylonjs/Shaders/ShadersInclude/pbrBlockClearcoat" {
  58536. /** @hidden */
  58537. export var pbrBlockClearcoat: {
  58538. name: string;
  58539. shader: string;
  58540. };
  58541. }
  58542. declare module "babylonjs/Shaders/ShadersInclude/pbrBlockSubSurface" {
  58543. /** @hidden */
  58544. export var pbrBlockSubSurface: {
  58545. name: string;
  58546. shader: string;
  58547. };
  58548. }
  58549. declare module "babylonjs/Shaders/ShadersInclude/pbrBlockNormalGeometric" {
  58550. /** @hidden */
  58551. export var pbrBlockNormalGeometric: {
  58552. name: string;
  58553. shader: string;
  58554. };
  58555. }
  58556. declare module "babylonjs/Shaders/ShadersInclude/pbrBlockNormalFinal" {
  58557. /** @hidden */
  58558. export var pbrBlockNormalFinal: {
  58559. name: string;
  58560. shader: string;
  58561. };
  58562. }
  58563. declare module "babylonjs/Shaders/ShadersInclude/pbrBlockLightmapInit" {
  58564. /** @hidden */
  58565. export var pbrBlockLightmapInit: {
  58566. name: string;
  58567. shader: string;
  58568. };
  58569. }
  58570. declare module "babylonjs/Shaders/ShadersInclude/pbrBlockGeometryInfo" {
  58571. /** @hidden */
  58572. export var pbrBlockGeometryInfo: {
  58573. name: string;
  58574. shader: string;
  58575. };
  58576. }
  58577. declare module "babylonjs/Shaders/ShadersInclude/pbrBlockReflectance0" {
  58578. /** @hidden */
  58579. export var pbrBlockReflectance0: {
  58580. name: string;
  58581. shader: string;
  58582. };
  58583. }
  58584. declare module "babylonjs/Shaders/ShadersInclude/pbrBlockReflectance" {
  58585. /** @hidden */
  58586. export var pbrBlockReflectance: {
  58587. name: string;
  58588. shader: string;
  58589. };
  58590. }
  58591. declare module "babylonjs/Shaders/ShadersInclude/pbrBlockDirectLighting" {
  58592. /** @hidden */
  58593. export var pbrBlockDirectLighting: {
  58594. name: string;
  58595. shader: string;
  58596. };
  58597. }
  58598. declare module "babylonjs/Shaders/ShadersInclude/pbrBlockFinalLitComponents" {
  58599. /** @hidden */
  58600. export var pbrBlockFinalLitComponents: {
  58601. name: string;
  58602. shader: string;
  58603. };
  58604. }
  58605. declare module "babylonjs/Shaders/ShadersInclude/pbrBlockFinalUnlitComponents" {
  58606. /** @hidden */
  58607. export var pbrBlockFinalUnlitComponents: {
  58608. name: string;
  58609. shader: string;
  58610. };
  58611. }
  58612. declare module "babylonjs/Shaders/ShadersInclude/pbrBlockFinalColorComposition" {
  58613. /** @hidden */
  58614. export var pbrBlockFinalColorComposition: {
  58615. name: string;
  58616. shader: string;
  58617. };
  58618. }
  58619. declare module "babylonjs/Shaders/ShadersInclude/pbrBlockImageProcessing" {
  58620. /** @hidden */
  58621. export var pbrBlockImageProcessing: {
  58622. name: string;
  58623. shader: string;
  58624. };
  58625. }
  58626. declare module "babylonjs/Shaders/ShadersInclude/pbrDebug" {
  58627. /** @hidden */
  58628. export var pbrDebug: {
  58629. name: string;
  58630. shader: string;
  58631. };
  58632. }
  58633. declare module "babylonjs/Shaders/pbr.fragment" {
  58634. import "babylonjs/Shaders/ShadersInclude/prePassDeclaration";
  58635. import "babylonjs/Shaders/ShadersInclude/pbrFragmentDeclaration";
  58636. import "babylonjs/Shaders/ShadersInclude/pbrUboDeclaration";
  58637. import "babylonjs/Shaders/ShadersInclude/pbrFragmentExtraDeclaration";
  58638. import "babylonjs/Shaders/ShadersInclude/lightFragmentDeclaration";
  58639. import "babylonjs/Shaders/ShadersInclude/lightUboDeclaration";
  58640. import "babylonjs/Shaders/ShadersInclude/pbrFragmentSamplersDeclaration";
  58641. import "babylonjs/Shaders/ShadersInclude/imageProcessingDeclaration";
  58642. import "babylonjs/Shaders/ShadersInclude/clipPlaneFragmentDeclaration";
  58643. import "babylonjs/Shaders/ShadersInclude/logDepthDeclaration";
  58644. import "babylonjs/Shaders/ShadersInclude/fogFragmentDeclaration";
  58645. import "babylonjs/Shaders/ShadersInclude/helperFunctions";
  58646. import "babylonjs/Shaders/ShadersInclude/subSurfaceScatteringFunctions";
  58647. import "babylonjs/Shaders/ShadersInclude/importanceSampling";
  58648. import "babylonjs/Shaders/ShadersInclude/pbrHelperFunctions";
  58649. import "babylonjs/Shaders/ShadersInclude/imageProcessingFunctions";
  58650. import "babylonjs/Shaders/ShadersInclude/shadowsFragmentFunctions";
  58651. import "babylonjs/Shaders/ShadersInclude/harmonicsFunctions";
  58652. import "babylonjs/Shaders/ShadersInclude/pbrDirectLightingSetupFunctions";
  58653. import "babylonjs/Shaders/ShadersInclude/pbrDirectLightingFalloffFunctions";
  58654. import "babylonjs/Shaders/ShadersInclude/pbrBRDFFunctions";
  58655. import "babylonjs/Shaders/ShadersInclude/hdrFilteringFunctions";
  58656. import "babylonjs/Shaders/ShadersInclude/pbrDirectLightingFunctions";
  58657. import "babylonjs/Shaders/ShadersInclude/pbrIBLFunctions";
  58658. import "babylonjs/Shaders/ShadersInclude/bumpFragmentMainFunctions";
  58659. import "babylonjs/Shaders/ShadersInclude/bumpFragmentFunctions";
  58660. import "babylonjs/Shaders/ShadersInclude/reflectionFunction";
  58661. import "babylonjs/Shaders/ShadersInclude/pbrBlockAlbedoOpacity";
  58662. import "babylonjs/Shaders/ShadersInclude/pbrBlockReflectivity";
  58663. import "babylonjs/Shaders/ShadersInclude/pbrBlockAmbientOcclusion";
  58664. import "babylonjs/Shaders/ShadersInclude/pbrBlockAlphaFresnel";
  58665. import "babylonjs/Shaders/ShadersInclude/pbrBlockAnisotropic";
  58666. import "babylonjs/Shaders/ShadersInclude/pbrBlockReflection";
  58667. import "babylonjs/Shaders/ShadersInclude/pbrBlockSheen";
  58668. import "babylonjs/Shaders/ShadersInclude/pbrBlockClearcoat";
  58669. import "babylonjs/Shaders/ShadersInclude/pbrBlockSubSurface";
  58670. import "babylonjs/Shaders/ShadersInclude/clipPlaneFragment";
  58671. import "babylonjs/Shaders/ShadersInclude/pbrBlockNormalGeometric";
  58672. import "babylonjs/Shaders/ShadersInclude/bumpFragment";
  58673. import "babylonjs/Shaders/ShadersInclude/pbrBlockNormalFinal";
  58674. import "babylonjs/Shaders/ShadersInclude/depthPrePass";
  58675. import "babylonjs/Shaders/ShadersInclude/pbrBlockLightmapInit";
  58676. import "babylonjs/Shaders/ShadersInclude/pbrBlockGeometryInfo";
  58677. import "babylonjs/Shaders/ShadersInclude/pbrBlockReflectance0";
  58678. import "babylonjs/Shaders/ShadersInclude/pbrBlockReflectance";
  58679. import "babylonjs/Shaders/ShadersInclude/pbrBlockDirectLighting";
  58680. import "babylonjs/Shaders/ShadersInclude/lightFragment";
  58681. import "babylonjs/Shaders/ShadersInclude/pbrBlockFinalLitComponents";
  58682. import "babylonjs/Shaders/ShadersInclude/pbrBlockFinalUnlitComponents";
  58683. import "babylonjs/Shaders/ShadersInclude/pbrBlockFinalColorComposition";
  58684. import "babylonjs/Shaders/ShadersInclude/logDepthFragment";
  58685. import "babylonjs/Shaders/ShadersInclude/fogFragment";
  58686. import "babylonjs/Shaders/ShadersInclude/pbrBlockImageProcessing";
  58687. import "babylonjs/Shaders/ShadersInclude/pbrDebug";
  58688. /** @hidden */
  58689. export var pbrPixelShader: {
  58690. name: string;
  58691. shader: string;
  58692. };
  58693. }
  58694. declare module "babylonjs/Shaders/ShadersInclude/pbrVertexDeclaration" {
  58695. /** @hidden */
  58696. export var pbrVertexDeclaration: {
  58697. name: string;
  58698. shader: string;
  58699. };
  58700. }
  58701. declare module "babylonjs/Shaders/pbr.vertex" {
  58702. import "babylonjs/Shaders/ShadersInclude/pbrVertexDeclaration";
  58703. import "babylonjs/Shaders/ShadersInclude/pbrUboDeclaration";
  58704. import "babylonjs/Shaders/ShadersInclude/helperFunctions";
  58705. import "babylonjs/Shaders/ShadersInclude/bonesDeclaration";
  58706. import "babylonjs/Shaders/ShadersInclude/instancesDeclaration";
  58707. import "babylonjs/Shaders/ShadersInclude/harmonicsFunctions";
  58708. import "babylonjs/Shaders/ShadersInclude/bumpVertexDeclaration";
  58709. import "babylonjs/Shaders/ShadersInclude/clipPlaneVertexDeclaration";
  58710. import "babylonjs/Shaders/ShadersInclude/fogVertexDeclaration";
  58711. import "babylonjs/Shaders/ShadersInclude/lightFragmentDeclaration";
  58712. import "babylonjs/Shaders/ShadersInclude/lightUboDeclaration";
  58713. import "babylonjs/Shaders/ShadersInclude/morphTargetsVertexGlobalDeclaration";
  58714. import "babylonjs/Shaders/ShadersInclude/morphTargetsVertexDeclaration";
  58715. import "babylonjs/Shaders/ShadersInclude/logDepthDeclaration";
  58716. import "babylonjs/Shaders/ShadersInclude/morphTargetsVertex";
  58717. import "babylonjs/Shaders/ShadersInclude/instancesVertex";
  58718. import "babylonjs/Shaders/ShadersInclude/bonesVertex";
  58719. import "babylonjs/Shaders/ShadersInclude/bumpVertex";
  58720. import "babylonjs/Shaders/ShadersInclude/clipPlaneVertex";
  58721. import "babylonjs/Shaders/ShadersInclude/fogVertex";
  58722. import "babylonjs/Shaders/ShadersInclude/shadowsVertex";
  58723. import "babylonjs/Shaders/ShadersInclude/logDepthVertex";
  58724. /** @hidden */
  58725. export var pbrVertexShader: {
  58726. name: string;
  58727. shader: string;
  58728. };
  58729. }
  58730. declare module "babylonjs/Materials/PBR/pbrBaseMaterial" {
  58731. import { Nullable } from "babylonjs/types";
  58732. import { Scene } from "babylonjs/scene";
  58733. import { Matrix } from "babylonjs/Maths/math.vector";
  58734. import { SubMesh } from "babylonjs/Meshes/subMesh";
  58735. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  58736. import { Mesh } from "babylonjs/Meshes/mesh";
  58737. import { IMaterialClearCoatDefines, PBRClearCoatConfiguration } from "babylonjs/Materials/PBR/pbrClearCoatConfiguration";
  58738. import { IMaterialAnisotropicDefines, PBRAnisotropicConfiguration } from "babylonjs/Materials/PBR/pbrAnisotropicConfiguration";
  58739. import { IMaterialBRDFDefines, PBRBRDFConfiguration } from "babylonjs/Materials/PBR/pbrBRDFConfiguration";
  58740. import { IMaterialSheenDefines, PBRSheenConfiguration } from "babylonjs/Materials/PBR/pbrSheenConfiguration";
  58741. import { IMaterialSubSurfaceDefines, PBRSubSurfaceConfiguration } from "babylonjs/Materials/PBR/pbrSubSurfaceConfiguration";
  58742. import { Color3 } from "babylonjs/Maths/math.color";
  58743. import { ImageProcessingConfiguration, IImageProcessingConfigurationDefines } from "babylonjs/Materials/imageProcessingConfiguration";
  58744. import { Material, IMaterialCompilationOptions } from "babylonjs/Materials/material";
  58745. import { MaterialDefines } from "babylonjs/Materials/materialDefines";
  58746. import { PushMaterial } from "babylonjs/Materials/pushMaterial";
  58747. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  58748. import { IAnimatable } from "babylonjs/Animations/animatable.interface";
  58749. import "babylonjs/Materials/Textures/baseTexture.polynomial";
  58750. import "babylonjs/Shaders/pbr.fragment";
  58751. import "babylonjs/Shaders/pbr.vertex";
  58752. import { IMaterialDetailMapDefines, DetailMapConfiguration } from "babylonjs/Materials/material.detailMapConfiguration";
  58753. import { PrePassRenderer } from "babylonjs/Rendering/prePassRenderer";
  58754. /**
  58755. * Manages the defines for the PBR Material.
  58756. * @hidden
  58757. */
  58758. export class PBRMaterialDefines extends MaterialDefines implements IImageProcessingConfigurationDefines, IMaterialClearCoatDefines, IMaterialAnisotropicDefines, IMaterialBRDFDefines, IMaterialSheenDefines, IMaterialSubSurfaceDefines, IMaterialDetailMapDefines {
  58759. PBR: boolean;
  58760. NUM_SAMPLES: string;
  58761. REALTIME_FILTERING: boolean;
  58762. MAINUV1: boolean;
  58763. MAINUV2: boolean;
  58764. UV1: boolean;
  58765. UV2: boolean;
  58766. ALBEDO: boolean;
  58767. GAMMAALBEDO: boolean;
  58768. ALBEDODIRECTUV: number;
  58769. VERTEXCOLOR: boolean;
  58770. DETAIL: boolean;
  58771. DETAILDIRECTUV: number;
  58772. DETAIL_NORMALBLENDMETHOD: number;
  58773. AMBIENT: boolean;
  58774. AMBIENTDIRECTUV: number;
  58775. AMBIENTINGRAYSCALE: boolean;
  58776. OPACITY: boolean;
  58777. VERTEXALPHA: boolean;
  58778. OPACITYDIRECTUV: number;
  58779. OPACITYRGB: boolean;
  58780. ALPHATEST: boolean;
  58781. DEPTHPREPASS: boolean;
  58782. ALPHABLEND: boolean;
  58783. ALPHAFROMALBEDO: boolean;
  58784. ALPHATESTVALUE: string;
  58785. SPECULAROVERALPHA: boolean;
  58786. RADIANCEOVERALPHA: boolean;
  58787. ALPHAFRESNEL: boolean;
  58788. LINEARALPHAFRESNEL: boolean;
  58789. PREMULTIPLYALPHA: boolean;
  58790. EMISSIVE: boolean;
  58791. EMISSIVEDIRECTUV: number;
  58792. REFLECTIVITY: boolean;
  58793. REFLECTIVITYDIRECTUV: number;
  58794. SPECULARTERM: boolean;
  58795. MICROSURFACEFROMREFLECTIVITYMAP: boolean;
  58796. MICROSURFACEAUTOMATIC: boolean;
  58797. LODBASEDMICROSFURACE: boolean;
  58798. MICROSURFACEMAP: boolean;
  58799. MICROSURFACEMAPDIRECTUV: number;
  58800. METALLICWORKFLOW: boolean;
  58801. ROUGHNESSSTOREINMETALMAPALPHA: boolean;
  58802. ROUGHNESSSTOREINMETALMAPGREEN: boolean;
  58803. METALLNESSSTOREINMETALMAPBLUE: boolean;
  58804. AOSTOREINMETALMAPRED: boolean;
  58805. METALLIC_REFLECTANCE: boolean;
  58806. METALLIC_REFLECTANCEDIRECTUV: number;
  58807. ENVIRONMENTBRDF: boolean;
  58808. ENVIRONMENTBRDF_RGBD: boolean;
  58809. NORMAL: boolean;
  58810. TANGENT: boolean;
  58811. BUMP: boolean;
  58812. BUMPDIRECTUV: number;
  58813. OBJECTSPACE_NORMALMAP: boolean;
  58814. PARALLAX: boolean;
  58815. PARALLAXOCCLUSION: boolean;
  58816. NORMALXYSCALE: boolean;
  58817. LIGHTMAP: boolean;
  58818. LIGHTMAPDIRECTUV: number;
  58819. USELIGHTMAPASSHADOWMAP: boolean;
  58820. GAMMALIGHTMAP: boolean;
  58821. RGBDLIGHTMAP: boolean;
  58822. REFLECTION: boolean;
  58823. REFLECTIONMAP_3D: boolean;
  58824. REFLECTIONMAP_SPHERICAL: boolean;
  58825. REFLECTIONMAP_PLANAR: boolean;
  58826. REFLECTIONMAP_CUBIC: boolean;
  58827. USE_LOCAL_REFLECTIONMAP_CUBIC: boolean;
  58828. REFLECTIONMAP_PROJECTION: boolean;
  58829. REFLECTIONMAP_SKYBOX: boolean;
  58830. REFLECTIONMAP_EXPLICIT: boolean;
  58831. REFLECTIONMAP_EQUIRECTANGULAR: boolean;
  58832. REFLECTIONMAP_EQUIRECTANGULAR_FIXED: boolean;
  58833. REFLECTIONMAP_MIRROREDEQUIRECTANGULAR_FIXED: boolean;
  58834. INVERTCUBICMAP: boolean;
  58835. USESPHERICALFROMREFLECTIONMAP: boolean;
  58836. USEIRRADIANCEMAP: boolean;
  58837. SPHERICAL_HARMONICS: boolean;
  58838. USESPHERICALINVERTEX: boolean;
  58839. REFLECTIONMAP_OPPOSITEZ: boolean;
  58840. LODINREFLECTIONALPHA: boolean;
  58841. GAMMAREFLECTION: boolean;
  58842. RGBDREFLECTION: boolean;
  58843. LINEARSPECULARREFLECTION: boolean;
  58844. RADIANCEOCCLUSION: boolean;
  58845. HORIZONOCCLUSION: boolean;
  58846. INSTANCES: boolean;
  58847. THIN_INSTANCES: boolean;
  58848. PREPASS: boolean;
  58849. SCENE_MRT_COUNT: number;
  58850. NUM_BONE_INFLUENCERS: number;
  58851. BonesPerMesh: number;
  58852. BONETEXTURE: boolean;
  58853. NONUNIFORMSCALING: boolean;
  58854. MORPHTARGETS: boolean;
  58855. MORPHTARGETS_NORMAL: boolean;
  58856. MORPHTARGETS_TANGENT: boolean;
  58857. MORPHTARGETS_UV: boolean;
  58858. NUM_MORPH_INFLUENCERS: number;
  58859. IMAGEPROCESSING: boolean;
  58860. VIGNETTE: boolean;
  58861. VIGNETTEBLENDMODEMULTIPLY: boolean;
  58862. VIGNETTEBLENDMODEOPAQUE: boolean;
  58863. TONEMAPPING: boolean;
  58864. TONEMAPPING_ACES: boolean;
  58865. CONTRAST: boolean;
  58866. COLORCURVES: boolean;
  58867. COLORGRADING: boolean;
  58868. COLORGRADING3D: boolean;
  58869. SAMPLER3DGREENDEPTH: boolean;
  58870. SAMPLER3DBGRMAP: boolean;
  58871. IMAGEPROCESSINGPOSTPROCESS: boolean;
  58872. EXPOSURE: boolean;
  58873. MULTIVIEW: boolean;
  58874. USEPHYSICALLIGHTFALLOFF: boolean;
  58875. USEGLTFLIGHTFALLOFF: boolean;
  58876. TWOSIDEDLIGHTING: boolean;
  58877. SHADOWFLOAT: boolean;
  58878. CLIPPLANE: boolean;
  58879. CLIPPLANE2: boolean;
  58880. CLIPPLANE3: boolean;
  58881. CLIPPLANE4: boolean;
  58882. CLIPPLANE5: boolean;
  58883. CLIPPLANE6: boolean;
  58884. POINTSIZE: boolean;
  58885. FOG: boolean;
  58886. LOGARITHMICDEPTH: boolean;
  58887. FORCENORMALFORWARD: boolean;
  58888. SPECULARAA: boolean;
  58889. CLEARCOAT: boolean;
  58890. CLEARCOAT_DEFAULTIOR: boolean;
  58891. CLEARCOAT_TEXTURE: boolean;
  58892. CLEARCOAT_TEXTUREDIRECTUV: number;
  58893. CLEARCOAT_BUMP: boolean;
  58894. CLEARCOAT_BUMPDIRECTUV: number;
  58895. CLEARCOAT_TINT: boolean;
  58896. CLEARCOAT_TINT_TEXTURE: boolean;
  58897. CLEARCOAT_TINT_TEXTUREDIRECTUV: number;
  58898. ANISOTROPIC: boolean;
  58899. ANISOTROPIC_TEXTURE: boolean;
  58900. ANISOTROPIC_TEXTUREDIRECTUV: number;
  58901. BRDF_V_HEIGHT_CORRELATED: boolean;
  58902. MS_BRDF_ENERGY_CONSERVATION: boolean;
  58903. SPECULAR_GLOSSINESS_ENERGY_CONSERVATION: boolean;
  58904. SHEEN: boolean;
  58905. SHEEN_TEXTURE: boolean;
  58906. SHEEN_TEXTUREDIRECTUV: number;
  58907. SHEEN_LINKWITHALBEDO: boolean;
  58908. SHEEN_ROUGHNESS: boolean;
  58909. SHEEN_ALBEDOSCALING: boolean;
  58910. SUBSURFACE: boolean;
  58911. SS_REFRACTION: boolean;
  58912. SS_TRANSLUCENCY: boolean;
  58913. SS_SCATTERING: boolean;
  58914. SS_THICKNESSANDMASK_TEXTURE: boolean;
  58915. SS_THICKNESSANDMASK_TEXTUREDIRECTUV: number;
  58916. SS_REFRACTIONMAP_3D: boolean;
  58917. SS_REFRACTIONMAP_OPPOSITEZ: boolean;
  58918. SS_LODINREFRACTIONALPHA: boolean;
  58919. SS_GAMMAREFRACTION: boolean;
  58920. SS_RGBDREFRACTION: boolean;
  58921. SS_LINEARSPECULARREFRACTION: boolean;
  58922. SS_LINKREFRACTIONTOTRANSPARENCY: boolean;
  58923. SS_ALBEDOFORREFRACTIONTINT: boolean;
  58924. SS_MASK_FROM_THICKNESS_TEXTURE: boolean;
  58925. UNLIT: boolean;
  58926. DEBUGMODE: number;
  58927. /**
  58928. * Initializes the PBR Material defines.
  58929. */
  58930. constructor();
  58931. /**
  58932. * Resets the PBR Material defines.
  58933. */
  58934. reset(): void;
  58935. }
  58936. /**
  58937. * The Physically based material base class of BJS.
  58938. *
  58939. * This offers the main features of a standard PBR material.
  58940. * For more information, please refer to the documentation :
  58941. * https://doc.babylonjs.com/how_to/physically_based_rendering
  58942. */
  58943. export abstract class PBRBaseMaterial extends PushMaterial {
  58944. /**
  58945. * PBRMaterialTransparencyMode: No transparency mode, Alpha channel is not use.
  58946. */
  58947. static readonly PBRMATERIAL_OPAQUE: number;
  58948. /**
  58949. * PBRMaterialTransparencyMode: Alpha Test mode, pixel are discarded below a certain threshold defined by the alpha cutoff value.
  58950. */
  58951. static readonly PBRMATERIAL_ALPHATEST: number;
  58952. /**
  58953. * PBRMaterialTransparencyMode: Pixels are blended (according to the alpha mode) with the already drawn pixels in the current frame buffer.
  58954. */
  58955. static readonly PBRMATERIAL_ALPHABLEND: number;
  58956. /**
  58957. * PBRMaterialTransparencyMode: Pixels are blended (according to the alpha mode) with the already drawn pixels in the current frame buffer.
  58958. * They are also discarded below the alpha cutoff threshold to improve performances.
  58959. */
  58960. static readonly PBRMATERIAL_ALPHATESTANDBLEND: number;
  58961. /**
  58962. * Defines the default value of how much AO map is occluding the analytical lights
  58963. * (point spot...).
  58964. */
  58965. static DEFAULT_AO_ON_ANALYTICAL_LIGHTS: number;
  58966. /**
  58967. * PBRMaterialLightFalloff Physical: light is falling off following the inverse squared distance law.
  58968. */
  58969. static readonly LIGHTFALLOFF_PHYSICAL: number;
  58970. /**
  58971. * PBRMaterialLightFalloff gltf: light is falling off as described in the gltf moving to PBR document
  58972. * to enhance interoperability with other engines.
  58973. */
  58974. static readonly LIGHTFALLOFF_GLTF: number;
  58975. /**
  58976. * PBRMaterialLightFalloff Standard: light is falling off like in the standard material
  58977. * to enhance interoperability with other materials.
  58978. */
  58979. static readonly LIGHTFALLOFF_STANDARD: number;
  58980. /**
  58981. * Intensity of the direct lights e.g. the four lights available in your scene.
  58982. * This impacts both the direct diffuse and specular highlights.
  58983. */
  58984. protected _directIntensity: number;
  58985. /**
  58986. * Intensity of the emissive part of the material.
  58987. * This helps controlling the emissive effect without modifying the emissive color.
  58988. */
  58989. protected _emissiveIntensity: number;
  58990. /**
  58991. * Intensity of the environment e.g. how much the environment will light the object
  58992. * either through harmonics for rough material or through the refelction for shiny ones.
  58993. */
  58994. protected _environmentIntensity: number;
  58995. /**
  58996. * This is a special control allowing the reduction of the specular highlights coming from the
  58997. * four lights of the scene. Those highlights may not be needed in full environment lighting.
  58998. */
  58999. protected _specularIntensity: number;
  59000. /**
  59001. * This stores the direct, emissive, environment, and specular light intensities into a Vector4.
  59002. */
  59003. private _lightingInfos;
  59004. /**
  59005. * Debug Control allowing disabling the bump map on this material.
  59006. */
  59007. protected _disableBumpMap: boolean;
  59008. /**
  59009. * AKA Diffuse Texture in standard nomenclature.
  59010. */
  59011. protected _albedoTexture: Nullable<BaseTexture>;
  59012. /**
  59013. * AKA Occlusion Texture in other nomenclature.
  59014. */
  59015. protected _ambientTexture: Nullable<BaseTexture>;
  59016. /**
  59017. * AKA Occlusion Texture Intensity in other nomenclature.
  59018. */
  59019. protected _ambientTextureStrength: number;
  59020. /**
  59021. * Defines how much the AO map is occluding the analytical lights (point spot...).
  59022. * 1 means it completely occludes it
  59023. * 0 mean it has no impact
  59024. */
  59025. protected _ambientTextureImpactOnAnalyticalLights: number;
  59026. /**
  59027. * Stores the alpha values in a texture.
  59028. */
  59029. protected _opacityTexture: Nullable<BaseTexture>;
  59030. /**
  59031. * Stores the reflection values in a texture.
  59032. */
  59033. protected _reflectionTexture: Nullable<BaseTexture>;
  59034. /**
  59035. * Stores the emissive values in a texture.
  59036. */
  59037. protected _emissiveTexture: Nullable<BaseTexture>;
  59038. /**
  59039. * AKA Specular texture in other nomenclature.
  59040. */
  59041. protected _reflectivityTexture: Nullable<BaseTexture>;
  59042. /**
  59043. * Used to switch from specular/glossiness to metallic/roughness workflow.
  59044. */
  59045. protected _metallicTexture: Nullable<BaseTexture>;
  59046. /**
  59047. * Specifies the metallic scalar of the metallic/roughness workflow.
  59048. * Can also be used to scale the metalness values of the metallic texture.
  59049. */
  59050. protected _metallic: Nullable<number>;
  59051. /**
  59052. * Specifies the roughness scalar of the metallic/roughness workflow.
  59053. * Can also be used to scale the roughness values of the metallic texture.
  59054. */
  59055. protected _roughness: Nullable<number>;
  59056. /**
  59057. * In metallic workflow, specifies an F0 factor to help configuring the material F0.
  59058. * By default the indexOfrefraction is used to compute F0;
  59059. *
  59060. * This is used as a factor against the default reflectance at normal incidence to tweak it.
  59061. *
  59062. * F0 = defaultF0 * metallicF0Factor * metallicReflectanceColor;
  59063. * F90 = metallicReflectanceColor;
  59064. */
  59065. protected _metallicF0Factor: number;
  59066. /**
  59067. * In metallic workflow, specifies an F90 color to help configuring the material F90.
  59068. * By default the F90 is always 1;
  59069. *
  59070. * Please note that this factor is also used as a factor against the default reflectance at normal incidence.
  59071. *
  59072. * F0 = defaultF0 * metallicF0Factor * metallicReflectanceColor
  59073. * F90 = metallicReflectanceColor;
  59074. */
  59075. protected _metallicReflectanceColor: Color3;
  59076. /**
  59077. * Defines to store metallicReflectanceColor in RGB and metallicF0Factor in A
  59078. * This is multiply against the scalar values defined in the material.
  59079. */
  59080. protected _metallicReflectanceTexture: Nullable<BaseTexture>;
  59081. /**
  59082. * Used to enable roughness/glossiness fetch from a separate channel depending on the current mode.
  59083. * Gray Scale represents roughness in metallic mode and glossiness in specular mode.
  59084. */
  59085. protected _microSurfaceTexture: Nullable<BaseTexture>;
  59086. /**
  59087. * Stores surface normal data used to displace a mesh in a texture.
  59088. */
  59089. protected _bumpTexture: Nullable<BaseTexture>;
  59090. /**
  59091. * Stores the pre-calculated light information of a mesh in a texture.
  59092. */
  59093. protected _lightmapTexture: Nullable<BaseTexture>;
  59094. /**
  59095. * The color of a material in ambient lighting.
  59096. */
  59097. protected _ambientColor: Color3;
  59098. /**
  59099. * AKA Diffuse Color in other nomenclature.
  59100. */
  59101. protected _albedoColor: Color3;
  59102. /**
  59103. * AKA Specular Color in other nomenclature.
  59104. */
  59105. protected _reflectivityColor: Color3;
  59106. /**
  59107. * The color applied when light is reflected from a material.
  59108. */
  59109. protected _reflectionColor: Color3;
  59110. /**
  59111. * The color applied when light is emitted from a material.
  59112. */
  59113. protected _emissiveColor: Color3;
  59114. /**
  59115. * AKA Glossiness in other nomenclature.
  59116. */
  59117. protected _microSurface: number;
  59118. /**
  59119. * Specifies that the material will use the light map as a show map.
  59120. */
  59121. protected _useLightmapAsShadowmap: boolean;
  59122. /**
  59123. * This parameters will enable/disable Horizon occlusion to prevent normal maps to look shiny when the normal
  59124. * makes the reflect vector face the model (under horizon).
  59125. */
  59126. protected _useHorizonOcclusion: boolean;
  59127. /**
  59128. * This parameters will enable/disable radiance occlusion by preventing the radiance to lit
  59129. * too much the area relying on ambient texture to define their ambient occlusion.
  59130. */
  59131. protected _useRadianceOcclusion: boolean;
  59132. /**
  59133. * Specifies that the alpha is coming form the albedo channel alpha channel for alpha blending.
  59134. */
  59135. protected _useAlphaFromAlbedoTexture: boolean;
  59136. /**
  59137. * Specifies that the material will keeps the specular highlights over a transparent surface (only the most limunous ones).
  59138. * A car glass is a good exemple of that. When sun reflects on it you can not see what is behind.
  59139. */
  59140. protected _useSpecularOverAlpha: boolean;
  59141. /**
  59142. * Specifies if the reflectivity texture contains the glossiness information in its alpha channel.
  59143. */
  59144. protected _useMicroSurfaceFromReflectivityMapAlpha: boolean;
  59145. /**
  59146. * Specifies if the metallic texture contains the roughness information in its alpha channel.
  59147. */
  59148. protected _useRoughnessFromMetallicTextureAlpha: boolean;
  59149. /**
  59150. * Specifies if the metallic texture contains the roughness information in its green channel.
  59151. */
  59152. protected _useRoughnessFromMetallicTextureGreen: boolean;
  59153. /**
  59154. * Specifies if the metallic texture contains the metallness information in its blue channel.
  59155. */
  59156. protected _useMetallnessFromMetallicTextureBlue: boolean;
  59157. /**
  59158. * Specifies if the metallic texture contains the ambient occlusion information in its red channel.
  59159. */
  59160. protected _useAmbientOcclusionFromMetallicTextureRed: boolean;
  59161. /**
  59162. * Specifies if the ambient texture contains the ambient occlusion information in its red channel only.
  59163. */
  59164. protected _useAmbientInGrayScale: boolean;
  59165. /**
  59166. * In case the reflectivity map does not contain the microsurface information in its alpha channel,
  59167. * The material will try to infer what glossiness each pixel should be.
  59168. */
  59169. protected _useAutoMicroSurfaceFromReflectivityMap: boolean;
  59170. /**
  59171. * Defines the falloff type used in this material.
  59172. * It by default is Physical.
  59173. */
  59174. protected _lightFalloff: number;
  59175. /**
  59176. * Specifies that the material will keeps the reflection highlights over a transparent surface (only the most limunous ones).
  59177. * A car glass is a good exemple of that. When the street lights reflects on it you can not see what is behind.
  59178. */
  59179. protected _useRadianceOverAlpha: boolean;
  59180. /**
  59181. * Allows using an object space normal map (instead of tangent space).
  59182. */
  59183. protected _useObjectSpaceNormalMap: boolean;
  59184. /**
  59185. * Allows using the bump map in parallax mode.
  59186. */
  59187. protected _useParallax: boolean;
  59188. /**
  59189. * Allows using the bump map in parallax occlusion mode.
  59190. */
  59191. protected _useParallaxOcclusion: boolean;
  59192. /**
  59193. * Controls the scale bias of the parallax mode.
  59194. */
  59195. protected _parallaxScaleBias: number;
  59196. /**
  59197. * If sets to true, disables all the lights affecting the material.
  59198. */
  59199. protected _disableLighting: boolean;
  59200. /**
  59201. * Number of Simultaneous lights allowed on the material.
  59202. */
  59203. protected _maxSimultaneousLights: number;
  59204. /**
  59205. * If sets to true, x component of normal map value will be inverted (x = 1.0 - x).
  59206. */
  59207. protected _invertNormalMapX: boolean;
  59208. /**
  59209. * If sets to true, y component of normal map value will be inverted (y = 1.0 - y).
  59210. */
  59211. protected _invertNormalMapY: boolean;
  59212. /**
  59213. * If sets to true and backfaceCulling is false, normals will be flipped on the backside.
  59214. */
  59215. protected _twoSidedLighting: boolean;
  59216. /**
  59217. * Defines the alpha limits in alpha test mode.
  59218. */
  59219. protected _alphaCutOff: number;
  59220. /**
  59221. * Enforces alpha test in opaque or blend mode in order to improve the performances of some situations.
  59222. */
  59223. protected _forceAlphaTest: boolean;
  59224. /**
  59225. * A fresnel is applied to the alpha of the model to ensure grazing angles edges are not alpha tested.
  59226. * And/Or occlude the blended part. (alpha is converted to gamma to compute the fresnel)
  59227. */
  59228. protected _useAlphaFresnel: boolean;
  59229. /**
  59230. * A fresnel is applied to the alpha of the model to ensure grazing angles edges are not alpha tested.
  59231. * And/Or occlude the blended part. (alpha stays linear to compute the fresnel)
  59232. */
  59233. protected _useLinearAlphaFresnel: boolean;
  59234. /**
  59235. * Specifies the environment BRDF texture used to comput the scale and offset roughness values
  59236. * from cos thetav and roughness:
  59237. * http://blog.selfshadow.com/publications/s2013-shading-course/karis/s2013_pbs_epic_notes_v2.pdf
  59238. */
  59239. protected _environmentBRDFTexture: Nullable<BaseTexture>;
  59240. /**
  59241. * Force the shader to compute irradiance in the fragment shader in order to take bump in account.
  59242. */
  59243. protected _forceIrradianceInFragment: boolean;
  59244. private _realTimeFiltering;
  59245. /**
  59246. * Enables realtime filtering on the texture.
  59247. */
  59248. get realTimeFiltering(): boolean;
  59249. set realTimeFiltering(b: boolean);
  59250. private _realTimeFilteringQuality;
  59251. /**
  59252. * Quality switch for realtime filtering
  59253. */
  59254. get realTimeFilteringQuality(): number;
  59255. set realTimeFilteringQuality(n: number);
  59256. /**
  59257. * Can this material render to several textures at once
  59258. */
  59259. get canRenderToMRT(): boolean;
  59260. /**
  59261. * Force normal to face away from face.
  59262. */
  59263. protected _forceNormalForward: boolean;
  59264. /**
  59265. * Enables specular anti aliasing in the PBR shader.
  59266. * It will both interacts on the Geometry for analytical and IBL lighting.
  59267. * It also prefilter the roughness map based on the bump values.
  59268. */
  59269. protected _enableSpecularAntiAliasing: boolean;
  59270. /**
  59271. * Default configuration related to image processing available in the PBR Material.
  59272. */
  59273. protected _imageProcessingConfiguration: ImageProcessingConfiguration;
  59274. /**
  59275. * Keep track of the image processing observer to allow dispose and replace.
  59276. */
  59277. private _imageProcessingObserver;
  59278. /**
  59279. * Attaches a new image processing configuration to the PBR Material.
  59280. * @param configuration
  59281. */
  59282. protected _attachImageProcessingConfiguration(configuration: Nullable<ImageProcessingConfiguration>): void;
  59283. /**
  59284. * Stores the available render targets.
  59285. */
  59286. private _renderTargets;
  59287. /**
  59288. * Sets the global ambient color for the material used in lighting calculations.
  59289. */
  59290. private _globalAmbientColor;
  59291. /**
  59292. * Enables the use of logarithmic depth buffers, which is good for wide depth buffers.
  59293. */
  59294. private _useLogarithmicDepth;
  59295. /**
  59296. * If set to true, no lighting calculations will be applied.
  59297. */
  59298. private _unlit;
  59299. private _debugMode;
  59300. /**
  59301. * @hidden
  59302. * This is reserved for the inspector.
  59303. * Defines the material debug mode.
  59304. * It helps seeing only some components of the material while troubleshooting.
  59305. */
  59306. debugMode: number;
  59307. /**
  59308. * @hidden
  59309. * This is reserved for the inspector.
  59310. * Specify from where on screen the debug mode should start.
  59311. * The value goes from -1 (full screen) to 1 (not visible)
  59312. * It helps with side by side comparison against the final render
  59313. * This defaults to -1
  59314. */
  59315. private debugLimit;
  59316. /**
  59317. * @hidden
  59318. * This is reserved for the inspector.
  59319. * As the default viewing range might not be enough (if the ambient is really small for instance)
  59320. * You can use the factor to better multiply the final value.
  59321. */
  59322. private debugFactor;
  59323. /**
  59324. * Defines the clear coat layer parameters for the material.
  59325. */
  59326. readonly clearCoat: PBRClearCoatConfiguration;
  59327. /**
  59328. * Defines the anisotropic parameters for the material.
  59329. */
  59330. readonly anisotropy: PBRAnisotropicConfiguration;
  59331. /**
  59332. * Defines the BRDF parameters for the material.
  59333. */
  59334. readonly brdf: PBRBRDFConfiguration;
  59335. /**
  59336. * Defines the Sheen parameters for the material.
  59337. */
  59338. readonly sheen: PBRSheenConfiguration;
  59339. /**
  59340. * Defines the SubSurface parameters for the material.
  59341. */
  59342. readonly subSurface: PBRSubSurfaceConfiguration;
  59343. /**
  59344. * Defines the detail map parameters for the material.
  59345. */
  59346. readonly detailMap: DetailMapConfiguration;
  59347. protected _rebuildInParallel: boolean;
  59348. /**
  59349. * Instantiates a new PBRMaterial instance.
  59350. *
  59351. * @param name The material name
  59352. * @param scene The scene the material will be use in.
  59353. */
  59354. constructor(name: string, scene: Scene);
  59355. /**
  59356. * Gets a boolean indicating that current material needs to register RTT
  59357. */
  59358. get hasRenderTargetTextures(): boolean;
  59359. /**
  59360. * Gets the name of the material class.
  59361. */
  59362. getClassName(): string;
  59363. /**
  59364. * Enabled the use of logarithmic depth buffers, which is good for wide depth buffers.
  59365. */
  59366. get useLogarithmicDepth(): boolean;
  59367. /**
  59368. * Enabled the use of logarithmic depth buffers, which is good for wide depth buffers.
  59369. */
  59370. set useLogarithmicDepth(value: boolean);
  59371. /**
  59372. * Returns true if alpha blending should be disabled.
  59373. */
  59374. protected get _disableAlphaBlending(): boolean;
  59375. /**
  59376. * Specifies whether or not this material should be rendered in alpha blend mode.
  59377. */
  59378. needAlphaBlending(): boolean;
  59379. /**
  59380. * Specifies whether or not this material should be rendered in alpha test mode.
  59381. */
  59382. needAlphaTesting(): boolean;
  59383. /**
  59384. * Specifies whether or not the alpha value of the albedo texture should be used for alpha blending.
  59385. */
  59386. protected _shouldUseAlphaFromAlbedoTexture(): boolean;
  59387. /**
  59388. * Gets the texture used for the alpha test.
  59389. */
  59390. getAlphaTestTexture(): Nullable<BaseTexture>;
  59391. /**
  59392. * Specifies that the submesh is ready to be used.
  59393. * @param mesh - BJS mesh.
  59394. * @param subMesh - A submesh of the BJS mesh. Used to check if it is ready.
  59395. * @param useInstances - Specifies that instances should be used.
  59396. * @returns - boolean indicating that the submesh is ready or not.
  59397. */
  59398. isReadyForSubMesh(mesh: AbstractMesh, subMesh: SubMesh, useInstances?: boolean): boolean;
  59399. /**
  59400. * Specifies if the material uses metallic roughness workflow.
  59401. * @returns boolean specifiying if the material uses metallic roughness workflow.
  59402. */
  59403. isMetallicWorkflow(): boolean;
  59404. private _prepareEffect;
  59405. private _prepareDefines;
  59406. /**
  59407. * Force shader compilation
  59408. */
  59409. forceCompilation(mesh: AbstractMesh, onCompiled?: (material: Material) => void, options?: Partial<IMaterialCompilationOptions>): void;
  59410. /**
  59411. * Initializes the uniform buffer layout for the shader.
  59412. */
  59413. buildUniformLayout(): void;
  59414. /**
  59415. * Unbinds the material from the mesh
  59416. */
  59417. unbind(): void;
  59418. /**
  59419. * Binds the submesh data.
  59420. * @param world - The world matrix.
  59421. * @param mesh - The BJS mesh.
  59422. * @param subMesh - A submesh of the BJS mesh.
  59423. */
  59424. bindForSubMesh(world: Matrix, mesh: Mesh, subMesh: SubMesh): void;
  59425. /**
  59426. * Returns the animatable textures.
  59427. * @returns - Array of animatable textures.
  59428. */
  59429. getAnimatables(): IAnimatable[];
  59430. /**
  59431. * Returns the texture used for reflections.
  59432. * @returns - Reflection texture if present. Otherwise, returns the environment texture.
  59433. */
  59434. private _getReflectionTexture;
  59435. /**
  59436. * Returns an array of the actively used textures.
  59437. * @returns - Array of BaseTextures
  59438. */
  59439. getActiveTextures(): BaseTexture[];
  59440. /**
  59441. * Checks to see if a texture is used in the material.
  59442. * @param texture - Base texture to use.
  59443. * @returns - Boolean specifying if a texture is used in the material.
  59444. */
  59445. hasTexture(texture: BaseTexture): boolean;
  59446. /**
  59447. * Sets the required values to the prepass renderer.
  59448. * @param prePassRenderer defines the prepass renderer to setup
  59449. */
  59450. setPrePassRenderer(prePassRenderer: PrePassRenderer): boolean;
  59451. /**
  59452. * Disposes the resources of the material.
  59453. * @param forceDisposeEffect - Forces the disposal of effects.
  59454. * @param forceDisposeTextures - Forces the disposal of all textures.
  59455. */
  59456. dispose(forceDisposeEffect?: boolean, forceDisposeTextures?: boolean): void;
  59457. }
  59458. }
  59459. declare module "babylonjs/Materials/PBR/pbrMaterial" {
  59460. import { Nullable } from "babylonjs/types";
  59461. import { Scene } from "babylonjs/scene";
  59462. import { Color3 } from "babylonjs/Maths/math.color";
  59463. import { ImageProcessingConfiguration } from "babylonjs/Materials/imageProcessingConfiguration";
  59464. import { ColorCurves } from "babylonjs/Materials/colorCurves";
  59465. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  59466. import { PBRBaseMaterial } from "babylonjs/Materials/PBR/pbrBaseMaterial";
  59467. /**
  59468. * The Physically based material of BJS.
  59469. *
  59470. * This offers the main features of a standard PBR material.
  59471. * For more information, please refer to the documentation :
  59472. * https://doc.babylonjs.com/how_to/physically_based_rendering
  59473. */
  59474. export class PBRMaterial extends PBRBaseMaterial {
  59475. /**
  59476. * PBRMaterialTransparencyMode: No transparency mode, Alpha channel is not use.
  59477. */
  59478. static readonly PBRMATERIAL_OPAQUE: number;
  59479. /**
  59480. * PBRMaterialTransparencyMode: Alpha Test mode, pixel are discarded below a certain threshold defined by the alpha cutoff value.
  59481. */
  59482. static readonly PBRMATERIAL_ALPHATEST: number;
  59483. /**
  59484. * PBRMaterialTransparencyMode: Pixels are blended (according to the alpha mode) with the already drawn pixels in the current frame buffer.
  59485. */
  59486. static readonly PBRMATERIAL_ALPHABLEND: number;
  59487. /**
  59488. * PBRMaterialTransparencyMode: Pixels are blended (according to the alpha mode) with the already drawn pixels in the current frame buffer.
  59489. * They are also discarded below the alpha cutoff threshold to improve performances.
  59490. */
  59491. static readonly PBRMATERIAL_ALPHATESTANDBLEND: number;
  59492. /**
  59493. * Defines the default value of how much AO map is occluding the analytical lights
  59494. * (point spot...).
  59495. */
  59496. static DEFAULT_AO_ON_ANALYTICAL_LIGHTS: number;
  59497. /**
  59498. * Intensity of the direct lights e.g. the four lights available in your scene.
  59499. * This impacts both the direct diffuse and specular highlights.
  59500. */
  59501. directIntensity: number;
  59502. /**
  59503. * Intensity of the emissive part of the material.
  59504. * This helps controlling the emissive effect without modifying the emissive color.
  59505. */
  59506. emissiveIntensity: number;
  59507. /**
  59508. * Intensity of the environment e.g. how much the environment will light the object
  59509. * either through harmonics for rough material or through the refelction for shiny ones.
  59510. */
  59511. environmentIntensity: number;
  59512. /**
  59513. * This is a special control allowing the reduction of the specular highlights coming from the
  59514. * four lights of the scene. Those highlights may not be needed in full environment lighting.
  59515. */
  59516. specularIntensity: number;
  59517. /**
  59518. * Debug Control allowing disabling the bump map on this material.
  59519. */
  59520. disableBumpMap: boolean;
  59521. /**
  59522. * AKA Diffuse Texture in standard nomenclature.
  59523. */
  59524. albedoTexture: BaseTexture;
  59525. /**
  59526. * AKA Occlusion Texture in other nomenclature.
  59527. */
  59528. ambientTexture: BaseTexture;
  59529. /**
  59530. * AKA Occlusion Texture Intensity in other nomenclature.
  59531. */
  59532. ambientTextureStrength: number;
  59533. /**
  59534. * Defines how much the AO map is occluding the analytical lights (point spot...).
  59535. * 1 means it completely occludes it
  59536. * 0 mean it has no impact
  59537. */
  59538. ambientTextureImpactOnAnalyticalLights: number;
  59539. /**
  59540. * Stores the alpha values in a texture. Use luminance if texture.getAlphaFromRGB is true.
  59541. */
  59542. opacityTexture: BaseTexture;
  59543. /**
  59544. * Stores the reflection values in a texture.
  59545. */
  59546. reflectionTexture: Nullable<BaseTexture>;
  59547. /**
  59548. * Stores the emissive values in a texture.
  59549. */
  59550. emissiveTexture: BaseTexture;
  59551. /**
  59552. * AKA Specular texture in other nomenclature.
  59553. */
  59554. reflectivityTexture: BaseTexture;
  59555. /**
  59556. * Used to switch from specular/glossiness to metallic/roughness workflow.
  59557. */
  59558. metallicTexture: BaseTexture;
  59559. /**
  59560. * Specifies the metallic scalar of the metallic/roughness workflow.
  59561. * Can also be used to scale the metalness values of the metallic texture.
  59562. */
  59563. metallic: Nullable<number>;
  59564. /**
  59565. * Specifies the roughness scalar of the metallic/roughness workflow.
  59566. * Can also be used to scale the roughness values of the metallic texture.
  59567. */
  59568. roughness: Nullable<number>;
  59569. /**
  59570. * In metallic workflow, specifies an F0 factor to help configuring the material F0.
  59571. * By default the indexOfrefraction is used to compute F0;
  59572. *
  59573. * This is used as a factor against the default reflectance at normal incidence to tweak it.
  59574. *
  59575. * F0 = defaultF0 * metallicF0Factor * metallicReflectanceColor;
  59576. * F90 = metallicReflectanceColor;
  59577. */
  59578. metallicF0Factor: number;
  59579. /**
  59580. * In metallic workflow, specifies an F90 color to help configuring the material F90.
  59581. * By default the F90 is always 1;
  59582. *
  59583. * Please note that this factor is also used as a factor against the default reflectance at normal incidence.
  59584. *
  59585. * F0 = defaultF0 * metallicF0Factor * metallicReflectanceColor
  59586. * F90 = metallicReflectanceColor;
  59587. */
  59588. metallicReflectanceColor: Color3;
  59589. /**
  59590. * Defines to store metallicReflectanceColor in RGB and metallicF0Factor in A
  59591. * This is multiply against the scalar values defined in the material.
  59592. */
  59593. metallicReflectanceTexture: Nullable<BaseTexture>;
  59594. /**
  59595. * Used to enable roughness/glossiness fetch from a separate channel depending on the current mode.
  59596. * Gray Scale represents roughness in metallic mode and glossiness in specular mode.
  59597. */
  59598. microSurfaceTexture: BaseTexture;
  59599. /**
  59600. * Stores surface normal data used to displace a mesh in a texture.
  59601. */
  59602. bumpTexture: BaseTexture;
  59603. /**
  59604. * Stores the pre-calculated light information of a mesh in a texture.
  59605. */
  59606. lightmapTexture: BaseTexture;
  59607. /**
  59608. * Stores the refracted light information in a texture.
  59609. */
  59610. get refractionTexture(): Nullable<BaseTexture>;
  59611. set refractionTexture(value: Nullable<BaseTexture>);
  59612. /**
  59613. * The color of a material in ambient lighting.
  59614. */
  59615. ambientColor: Color3;
  59616. /**
  59617. * AKA Diffuse Color in other nomenclature.
  59618. */
  59619. albedoColor: Color3;
  59620. /**
  59621. * AKA Specular Color in other nomenclature.
  59622. */
  59623. reflectivityColor: Color3;
  59624. /**
  59625. * The color reflected from the material.
  59626. */
  59627. reflectionColor: Color3;
  59628. /**
  59629. * The color emitted from the material.
  59630. */
  59631. emissiveColor: Color3;
  59632. /**
  59633. * AKA Glossiness in other nomenclature.
  59634. */
  59635. microSurface: number;
  59636. /**
  59637. * Index of refraction of the material base layer.
  59638. * https://en.wikipedia.org/wiki/List_of_refractive_indices
  59639. *
  59640. * This does not only impact refraction but also the Base F0 of Dielectric Materials.
  59641. *
  59642. * From dielectric fresnel rules: F0 = square((iorT - iorI) / (iorT + iorI))
  59643. */
  59644. get indexOfRefraction(): number;
  59645. set indexOfRefraction(value: number);
  59646. /**
  59647. * Controls if refraction needs to be inverted on Y. This could be useful for procedural texture.
  59648. */
  59649. get invertRefractionY(): boolean;
  59650. set invertRefractionY(value: boolean);
  59651. /**
  59652. * This parameters will make the material used its opacity to control how much it is refracting aginst not.
  59653. * Materials half opaque for instance using refraction could benefit from this control.
  59654. */
  59655. get linkRefractionWithTransparency(): boolean;
  59656. set linkRefractionWithTransparency(value: boolean);
  59657. /**
  59658. * If true, the light map contains occlusion information instead of lighting info.
  59659. */
  59660. useLightmapAsShadowmap: boolean;
  59661. /**
  59662. * Specifies that the alpha is coming form the albedo channel alpha channel for alpha blending.
  59663. */
  59664. useAlphaFromAlbedoTexture: boolean;
  59665. /**
  59666. * Enforces alpha test in opaque or blend mode in order to improve the performances of some situations.
  59667. */
  59668. forceAlphaTest: boolean;
  59669. /**
  59670. * Defines the alpha limits in alpha test mode.
  59671. */
  59672. alphaCutOff: number;
  59673. /**
  59674. * Specifies that the material will keep the specular highlights over a transparent surface (only the most limunous ones).
  59675. * A car glass is a good exemple of that. When sun reflects on it you can not see what is behind.
  59676. */
  59677. useSpecularOverAlpha: boolean;
  59678. /**
  59679. * Specifies if the reflectivity texture contains the glossiness information in its alpha channel.
  59680. */
  59681. useMicroSurfaceFromReflectivityMapAlpha: boolean;
  59682. /**
  59683. * Specifies if the metallic texture contains the roughness information in its alpha channel.
  59684. */
  59685. useRoughnessFromMetallicTextureAlpha: boolean;
  59686. /**
  59687. * Specifies if the metallic texture contains the roughness information in its green channel.
  59688. */
  59689. useRoughnessFromMetallicTextureGreen: boolean;
  59690. /**
  59691. * Specifies if the metallic texture contains the metallness information in its blue channel.
  59692. */
  59693. useMetallnessFromMetallicTextureBlue: boolean;
  59694. /**
  59695. * Specifies if the metallic texture contains the ambient occlusion information in its red channel.
  59696. */
  59697. useAmbientOcclusionFromMetallicTextureRed: boolean;
  59698. /**
  59699. * Specifies if the ambient texture contains the ambient occlusion information in its red channel only.
  59700. */
  59701. useAmbientInGrayScale: boolean;
  59702. /**
  59703. * In case the reflectivity map does not contain the microsurface information in its alpha channel,
  59704. * The material will try to infer what glossiness each pixel should be.
  59705. */
  59706. useAutoMicroSurfaceFromReflectivityMap: boolean;
  59707. /**
  59708. * BJS is using an harcoded light falloff based on a manually sets up range.
  59709. * In PBR, one way to represents the fallof is to use the inverse squared root algorythm.
  59710. * This parameter can help you switch back to the BJS mode in order to create scenes using both materials.
  59711. */
  59712. get usePhysicalLightFalloff(): boolean;
  59713. /**
  59714. * BJS is using an harcoded light falloff based on a manually sets up range.
  59715. * In PBR, one way to represents the fallof is to use the inverse squared root algorythm.
  59716. * This parameter can help you switch back to the BJS mode in order to create scenes using both materials.
  59717. */
  59718. set usePhysicalLightFalloff(value: boolean);
  59719. /**
  59720. * In order to support the falloff compatibility with gltf, a special mode has been added
  59721. * to reproduce the gltf light falloff.
  59722. */
  59723. get useGLTFLightFalloff(): boolean;
  59724. /**
  59725. * In order to support the falloff compatibility with gltf, a special mode has been added
  59726. * to reproduce the gltf light falloff.
  59727. */
  59728. set useGLTFLightFalloff(value: boolean);
  59729. /**
  59730. * Specifies that the material will keeps the reflection highlights over a transparent surface (only the most limunous ones).
  59731. * A car glass is a good exemple of that. When the street lights reflects on it you can not see what is behind.
  59732. */
  59733. useRadianceOverAlpha: boolean;
  59734. /**
  59735. * Allows using an object space normal map (instead of tangent space).
  59736. */
  59737. useObjectSpaceNormalMap: boolean;
  59738. /**
  59739. * Allows using the bump map in parallax mode.
  59740. */
  59741. useParallax: boolean;
  59742. /**
  59743. * Allows using the bump map in parallax occlusion mode.
  59744. */
  59745. useParallaxOcclusion: boolean;
  59746. /**
  59747. * Controls the scale bias of the parallax mode.
  59748. */
  59749. parallaxScaleBias: number;
  59750. /**
  59751. * If sets to true, disables all the lights affecting the material.
  59752. */
  59753. disableLighting: boolean;
  59754. /**
  59755. * Force the shader to compute irradiance in the fragment shader in order to take bump in account.
  59756. */
  59757. forceIrradianceInFragment: boolean;
  59758. /**
  59759. * Number of Simultaneous lights allowed on the material.
  59760. */
  59761. maxSimultaneousLights: number;
  59762. /**
  59763. * If sets to true, x component of normal map value will invert (x = 1.0 - x).
  59764. */
  59765. invertNormalMapX: boolean;
  59766. /**
  59767. * If sets to true, y component of normal map value will invert (y = 1.0 - y).
  59768. */
  59769. invertNormalMapY: boolean;
  59770. /**
  59771. * If sets to true and backfaceCulling is false, normals will be flipped on the backside.
  59772. */
  59773. twoSidedLighting: boolean;
  59774. /**
  59775. * A fresnel is applied to the alpha of the model to ensure grazing angles edges are not alpha tested.
  59776. * And/Or occlude the blended part. (alpha is converted to gamma to compute the fresnel)
  59777. */
  59778. useAlphaFresnel: boolean;
  59779. /**
  59780. * A fresnel is applied to the alpha of the model to ensure grazing angles edges are not alpha tested.
  59781. * And/Or occlude the blended part. (alpha stays linear to compute the fresnel)
  59782. */
  59783. useLinearAlphaFresnel: boolean;
  59784. /**
  59785. * Let user defines the brdf lookup texture used for IBL.
  59786. * A default 8bit version is embedded but you could point at :
  59787. * * Default texture: https://assets.babylonjs.com/environments/correlatedMSBRDF_RGBD.png
  59788. * * Default 16bit pixel depth texture: https://assets.babylonjs.com/environments/correlatedMSBRDF.dds
  59789. * * LEGACY Default None correlated https://assets.babylonjs.com/environments/uncorrelatedBRDF_RGBD.png
  59790. * * LEGACY Default None correlated 16bit pixel depth https://assets.babylonjs.com/environments/uncorrelatedBRDF.dds
  59791. */
  59792. environmentBRDFTexture: Nullable<BaseTexture>;
  59793. /**
  59794. * Force normal to face away from face.
  59795. */
  59796. forceNormalForward: boolean;
  59797. /**
  59798. * Enables specular anti aliasing in the PBR shader.
  59799. * It will both interacts on the Geometry for analytical and IBL lighting.
  59800. * It also prefilter the roughness map based on the bump values.
  59801. */
  59802. enableSpecularAntiAliasing: boolean;
  59803. /**
  59804. * This parameters will enable/disable Horizon occlusion to prevent normal maps to look shiny when the normal
  59805. * makes the reflect vector face the model (under horizon).
  59806. */
  59807. useHorizonOcclusion: boolean;
  59808. /**
  59809. * This parameters will enable/disable radiance occlusion by preventing the radiance to lit
  59810. * too much the area relying on ambient texture to define their ambient occlusion.
  59811. */
  59812. useRadianceOcclusion: boolean;
  59813. /**
  59814. * If set to true, no lighting calculations will be applied.
  59815. */
  59816. unlit: boolean;
  59817. /**
  59818. * Gets the image processing configuration used either in this material.
  59819. */
  59820. get imageProcessingConfiguration(): ImageProcessingConfiguration;
  59821. /**
  59822. * Sets the Default image processing configuration used either in the this material.
  59823. *
  59824. * If sets to null, the scene one is in use.
  59825. */
  59826. set imageProcessingConfiguration(value: ImageProcessingConfiguration);
  59827. /**
  59828. * Gets wether the color curves effect is enabled.
  59829. */
  59830. get cameraColorCurvesEnabled(): boolean;
  59831. /**
  59832. * Sets wether the color curves effect is enabled.
  59833. */
  59834. set cameraColorCurvesEnabled(value: boolean);
  59835. /**
  59836. * Gets wether the color grading effect is enabled.
  59837. */
  59838. get cameraColorGradingEnabled(): boolean;
  59839. /**
  59840. * Gets wether the color grading effect is enabled.
  59841. */
  59842. set cameraColorGradingEnabled(value: boolean);
  59843. /**
  59844. * Gets wether tonemapping is enabled or not.
  59845. */
  59846. get cameraToneMappingEnabled(): boolean;
  59847. /**
  59848. * Sets wether tonemapping is enabled or not
  59849. */
  59850. set cameraToneMappingEnabled(value: boolean);
  59851. /**
  59852. * The camera exposure used on this material.
  59853. * This property is here and not in the camera to allow controlling exposure without full screen post process.
  59854. * This corresponds to a photographic exposure.
  59855. */
  59856. get cameraExposure(): number;
  59857. /**
  59858. * The camera exposure used on this material.
  59859. * This property is here and not in the camera to allow controlling exposure without full screen post process.
  59860. * This corresponds to a photographic exposure.
  59861. */
  59862. set cameraExposure(value: number);
  59863. /**
  59864. * Gets The camera contrast used on this material.
  59865. */
  59866. get cameraContrast(): number;
  59867. /**
  59868. * Sets The camera contrast used on this material.
  59869. */
  59870. set cameraContrast(value: number);
  59871. /**
  59872. * Gets the Color Grading 2D Lookup Texture.
  59873. */
  59874. get cameraColorGradingTexture(): Nullable<BaseTexture>;
  59875. /**
  59876. * Sets the Color Grading 2D Lookup Texture.
  59877. */
  59878. set cameraColorGradingTexture(value: Nullable<BaseTexture>);
  59879. /**
  59880. * The color grading curves provide additional color adjustmnent that is applied after any color grading transform (3D LUT).
  59881. * They allow basic adjustment of saturation and small exposure adjustments, along with color filter tinting to provide white balance adjustment or more stylistic effects.
  59882. * 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;
  59883. * corresponding to low luminance, medium luminance, and high luminance areas respectively.
  59884. */
  59885. get cameraColorCurves(): Nullable<ColorCurves>;
  59886. /**
  59887. * The color grading curves provide additional color adjustmnent that is applied after any color grading transform (3D LUT).
  59888. * They allow basic adjustment of saturation and small exposure adjustments, along with color filter tinting to provide white balance adjustment or more stylistic effects.
  59889. * 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;
  59890. * corresponding to low luminance, medium luminance, and high luminance areas respectively.
  59891. */
  59892. set cameraColorCurves(value: Nullable<ColorCurves>);
  59893. /**
  59894. * Instantiates a new PBRMaterial instance.
  59895. *
  59896. * @param name The material name
  59897. * @param scene The scene the material will be use in.
  59898. */
  59899. constructor(name: string, scene: Scene);
  59900. /**
  59901. * Returns the name of this material class.
  59902. */
  59903. getClassName(): string;
  59904. /**
  59905. * Makes a duplicate of the current material.
  59906. * @param name - name to use for the new material.
  59907. */
  59908. clone(name: string): PBRMaterial;
  59909. /**
  59910. * Serializes this PBR Material.
  59911. * @returns - An object with the serialized material.
  59912. */
  59913. serialize(): any;
  59914. /**
  59915. * Parses a PBR Material from a serialized object.
  59916. * @param source - Serialized object.
  59917. * @param scene - BJS scene instance.
  59918. * @param rootUrl - url for the scene object
  59919. * @returns - PBRMaterial
  59920. */
  59921. static Parse(source: any, scene: Scene, rootUrl: string): PBRMaterial;
  59922. }
  59923. }
  59924. declare module "babylonjs/Misc/dds" {
  59925. import { SphericalPolynomial } from "babylonjs/Maths/sphericalPolynomial";
  59926. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  59927. import { Nullable } from "babylonjs/types";
  59928. import { Scene } from "babylonjs/scene";
  59929. import "babylonjs/Engines/Extensions/engine.cubeTexture";
  59930. import { ThinEngine } from "babylonjs/Engines/thinEngine";
  59931. /**
  59932. * Direct draw surface info
  59933. * @see https://docs.microsoft.com/en-us/windows/desktop/direct3ddds/dx-graphics-dds-pguide
  59934. */
  59935. export interface DDSInfo {
  59936. /**
  59937. * Width of the texture
  59938. */
  59939. width: number;
  59940. /**
  59941. * Width of the texture
  59942. */
  59943. height: number;
  59944. /**
  59945. * Number of Mipmaps for the texture
  59946. * @see https://en.wikipedia.org/wiki/Mipmap
  59947. */
  59948. mipmapCount: number;
  59949. /**
  59950. * If the textures format is a known fourCC format
  59951. * @see https://www.fourcc.org/
  59952. */
  59953. isFourCC: boolean;
  59954. /**
  59955. * If the texture is an RGB format eg. DXGI_FORMAT_B8G8R8X8_UNORM format
  59956. */
  59957. isRGB: boolean;
  59958. /**
  59959. * If the texture is a lumincance format
  59960. */
  59961. isLuminance: boolean;
  59962. /**
  59963. * If this is a cube texture
  59964. * @see https://docs.microsoft.com/en-us/windows/desktop/direct3ddds/dds-file-layout-for-cubic-environment-maps
  59965. */
  59966. isCube: boolean;
  59967. /**
  59968. * If the texture is a compressed format eg. FOURCC_DXT1
  59969. */
  59970. isCompressed: boolean;
  59971. /**
  59972. * The dxgiFormat of the texture
  59973. * @see https://docs.microsoft.com/en-us/windows/desktop/api/dxgiformat/ne-dxgiformat-dxgi_format
  59974. */
  59975. dxgiFormat: number;
  59976. /**
  59977. * Texture type eg. Engine.TEXTURETYPE_UNSIGNED_INT, Engine.TEXTURETYPE_FLOAT
  59978. */
  59979. textureType: number;
  59980. /**
  59981. * Sphericle polynomial created for the dds texture
  59982. */
  59983. sphericalPolynomial?: SphericalPolynomial;
  59984. }
  59985. /**
  59986. * Class used to provide DDS decompression tools
  59987. */
  59988. export class DDSTools {
  59989. /**
  59990. * Gets or sets a boolean indicating that LOD info is stored in alpha channel (false by default)
  59991. */
  59992. static StoreLODInAlphaChannel: boolean;
  59993. /**
  59994. * Gets DDS information from an array buffer
  59995. * @param data defines the array buffer view to read data from
  59996. * @returns the DDS information
  59997. */
  59998. static GetDDSInfo(data: ArrayBufferView): DDSInfo;
  59999. private static _FloatView;
  60000. private static _Int32View;
  60001. private static _ToHalfFloat;
  60002. private static _FromHalfFloat;
  60003. private static _GetHalfFloatAsFloatRGBAArrayBuffer;
  60004. private static _GetHalfFloatRGBAArrayBuffer;
  60005. private static _GetFloatRGBAArrayBuffer;
  60006. private static _GetFloatAsUIntRGBAArrayBuffer;
  60007. private static _GetHalfFloatAsUIntRGBAArrayBuffer;
  60008. private static _GetRGBAArrayBuffer;
  60009. private static _ExtractLongWordOrder;
  60010. private static _GetRGBArrayBuffer;
  60011. private static _GetLuminanceArrayBuffer;
  60012. /**
  60013. * Uploads DDS Levels to a Babylon Texture
  60014. * @hidden
  60015. */
  60016. static UploadDDSLevels(engine: ThinEngine, texture: InternalTexture, data: ArrayBufferView, info: DDSInfo, loadMipmaps: boolean, faces: number, lodIndex?: number, currentFace?: number): void;
  60017. }
  60018. module "babylonjs/Engines/thinEngine" {
  60019. interface ThinEngine {
  60020. /**
  60021. * Create a cube texture from prefiltered data (ie. the mipmaps contain ready to use data for PBR reflection)
  60022. * @param rootUrl defines the url where the file to load is located
  60023. * @param scene defines the current scene
  60024. * @param lodScale defines scale to apply to the mip map selection
  60025. * @param lodOffset defines offset to apply to the mip map selection
  60026. * @param onLoad defines an optional callback raised when the texture is loaded
  60027. * @param onError defines an optional callback raised if there is an issue to load the texture
  60028. * @param format defines the format of the data
  60029. * @param forcedExtension defines the extension to use to pick the right loader
  60030. * @param createPolynomials defines wheter or not to create polynomails harmonics for the texture
  60031. * @returns the cube texture as an InternalTexture
  60032. */
  60033. 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;
  60034. }
  60035. }
  60036. }
  60037. declare module "babylonjs/Materials/Textures/Loaders/ddsTextureLoader" {
  60038. import { Nullable } from "babylonjs/types";
  60039. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  60040. import { IInternalTextureLoader } from "babylonjs/Materials/Textures/internalTextureLoader";
  60041. /**
  60042. * Implementation of the DDS Texture Loader.
  60043. * @hidden
  60044. */
  60045. export class _DDSTextureLoader implements IInternalTextureLoader {
  60046. /**
  60047. * Defines wether the loader supports cascade loading the different faces.
  60048. */
  60049. readonly supportCascades: boolean;
  60050. /**
  60051. * This returns if the loader support the current file information.
  60052. * @param extension defines the file extension of the file being loaded
  60053. * @returns true if the loader can load the specified file
  60054. */
  60055. canLoad(extension: string): boolean;
  60056. /**
  60057. * Uploads the cube texture data to the WebGL texture. It has already been bound.
  60058. * @param data contains the texture data
  60059. * @param texture defines the BabylonJS internal texture
  60060. * @param createPolynomials will be true if polynomials have been requested
  60061. * @param onLoad defines the callback to trigger once the texture is ready
  60062. * @param onError defines the callback to trigger in case of error
  60063. */
  60064. loadCubeData(imgs: ArrayBufferView | ArrayBufferView[], texture: InternalTexture, createPolynomials: boolean, onLoad: Nullable<(data?: any) => void>, onError: Nullable<(message?: string, exception?: any) => void>): void;
  60065. /**
  60066. * Uploads the 2D texture data to the WebGL texture. It has already been bound once in the callback.
  60067. * @param data contains the texture data
  60068. * @param texture defines the BabylonJS internal texture
  60069. * @param callback defines the method to call once ready to upload
  60070. */
  60071. loadData(data: ArrayBufferView, texture: InternalTexture, callback: (width: number, height: number, loadMipmap: boolean, isCompressed: boolean, done: () => void) => void): void;
  60072. }
  60073. }
  60074. declare module "babylonjs/Materials/Textures/Loaders/envTextureLoader" {
  60075. import { Nullable } from "babylonjs/types";
  60076. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  60077. import { IInternalTextureLoader } from "babylonjs/Materials/Textures/internalTextureLoader";
  60078. /**
  60079. * Implementation of the ENV Texture Loader.
  60080. * @hidden
  60081. */
  60082. export class _ENVTextureLoader implements IInternalTextureLoader {
  60083. /**
  60084. * Defines wether the loader supports cascade loading the different faces.
  60085. */
  60086. readonly supportCascades: boolean;
  60087. /**
  60088. * This returns if the loader support the current file information.
  60089. * @param extension defines the file extension of the file being loaded
  60090. * @returns true if the loader can load the specified file
  60091. */
  60092. canLoad(extension: string): boolean;
  60093. /**
  60094. * Uploads the cube texture data to the WebGL texture. It has already been bound.
  60095. * @param data contains the texture data
  60096. * @param texture defines the BabylonJS internal texture
  60097. * @param createPolynomials will be true if polynomials have been requested
  60098. * @param onLoad defines the callback to trigger once the texture is ready
  60099. * @param onError defines the callback to trigger in case of error
  60100. */
  60101. loadCubeData(data: ArrayBufferView | ArrayBufferView[], texture: InternalTexture, createPolynomials: boolean, onLoad: Nullable<(data?: any) => void>, onError: Nullable<(message?: string, exception?: any) => void>): void;
  60102. /**
  60103. * Uploads the 2D texture data to the WebGL texture. It has already been bound once in the callback.
  60104. * @param data contains the texture data
  60105. * @param texture defines the BabylonJS internal texture
  60106. * @param callback defines the method to call once ready to upload
  60107. */
  60108. loadData(data: ArrayBufferView, texture: InternalTexture, callback: (width: number, height: number, loadMipmap: boolean, isCompressed: boolean, done: () => void) => void): void;
  60109. }
  60110. }
  60111. declare module "babylonjs/Misc/khronosTextureContainer" {
  60112. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  60113. /**
  60114. * for description see https://www.khronos.org/opengles/sdk/tools/KTX/
  60115. * for file layout see https://www.khronos.org/opengles/sdk/tools/KTX/file_format_spec/
  60116. */
  60117. export class KhronosTextureContainer {
  60118. /** contents of the KTX container file */
  60119. data: ArrayBufferView;
  60120. private static HEADER_LEN;
  60121. private static COMPRESSED_2D;
  60122. private static COMPRESSED_3D;
  60123. private static TEX_2D;
  60124. private static TEX_3D;
  60125. /**
  60126. * Gets the openGL type
  60127. */
  60128. glType: number;
  60129. /**
  60130. * Gets the openGL type size
  60131. */
  60132. glTypeSize: number;
  60133. /**
  60134. * Gets the openGL format
  60135. */
  60136. glFormat: number;
  60137. /**
  60138. * Gets the openGL internal format
  60139. */
  60140. glInternalFormat: number;
  60141. /**
  60142. * Gets the base internal format
  60143. */
  60144. glBaseInternalFormat: number;
  60145. /**
  60146. * Gets image width in pixel
  60147. */
  60148. pixelWidth: number;
  60149. /**
  60150. * Gets image height in pixel
  60151. */
  60152. pixelHeight: number;
  60153. /**
  60154. * Gets image depth in pixels
  60155. */
  60156. pixelDepth: number;
  60157. /**
  60158. * Gets the number of array elements
  60159. */
  60160. numberOfArrayElements: number;
  60161. /**
  60162. * Gets the number of faces
  60163. */
  60164. numberOfFaces: number;
  60165. /**
  60166. * Gets the number of mipmap levels
  60167. */
  60168. numberOfMipmapLevels: number;
  60169. /**
  60170. * Gets the bytes of key value data
  60171. */
  60172. bytesOfKeyValueData: number;
  60173. /**
  60174. * Gets the load type
  60175. */
  60176. loadType: number;
  60177. /**
  60178. * If the container has been made invalid (eg. constructor failed to correctly load array buffer)
  60179. */
  60180. isInvalid: boolean;
  60181. /**
  60182. * Creates a new KhronosTextureContainer
  60183. * @param data contents of the KTX container file
  60184. * @param facesExpected should be either 1 or 6, based whether a cube texture or or
  60185. * @param threeDExpected provision for indicating that data should be a 3D texture, not implemented
  60186. * @param textureArrayExpected provision for indicating that data should be a texture array, not implemented
  60187. */
  60188. constructor(
  60189. /** contents of the KTX container file */
  60190. data: ArrayBufferView, facesExpected: number, threeDExpected?: boolean, textureArrayExpected?: boolean);
  60191. /**
  60192. * Uploads KTX content to a Babylon Texture.
  60193. * It is assumed that the texture has already been created & is currently bound
  60194. * @hidden
  60195. */
  60196. uploadLevels(texture: InternalTexture, loadMipmaps: boolean): void;
  60197. private _upload2DCompressedLevels;
  60198. /**
  60199. * Checks if the given data starts with a KTX file identifier.
  60200. * @param data the data to check
  60201. * @returns true if the data is a KTX file or false otherwise
  60202. */
  60203. static IsValid(data: ArrayBufferView): boolean;
  60204. }
  60205. }
  60206. declare module "babylonjs/Misc/khronosTextureContainer2" {
  60207. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  60208. import { ThinEngine } from "babylonjs/Engines/thinEngine";
  60209. /**
  60210. * Class for loading KTX2 files
  60211. * !!! Experimental Extension Subject to Changes !!!
  60212. * @hidden
  60213. */
  60214. export class KhronosTextureContainer2 {
  60215. private static _ModulePromise;
  60216. private static _TranscodeFormat;
  60217. constructor(engine: ThinEngine);
  60218. uploadAsync(data: ArrayBufferView, internalTexture: InternalTexture): Promise<void>;
  60219. private _determineTranscodeFormat;
  60220. /**
  60221. * Checks if the given data starts with a KTX2 file identifier.
  60222. * @param data the data to check
  60223. * @returns true if the data is a KTX2 file or false otherwise
  60224. */
  60225. static IsValid(data: ArrayBufferView): boolean;
  60226. }
  60227. }
  60228. declare module "babylonjs/Materials/Textures/Loaders/ktxTextureLoader" {
  60229. import { Nullable } from "babylonjs/types";
  60230. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  60231. import { IInternalTextureLoader } from "babylonjs/Materials/Textures/internalTextureLoader";
  60232. /**
  60233. * Implementation of the KTX Texture Loader.
  60234. * @hidden
  60235. */
  60236. export class _KTXTextureLoader implements IInternalTextureLoader {
  60237. /**
  60238. * Defines wether the loader supports cascade loading the different faces.
  60239. */
  60240. readonly supportCascades: boolean;
  60241. /**
  60242. * This returns if the loader support the current file information.
  60243. * @param extension defines the file extension of the file being loaded
  60244. * @param mimeType defines the optional mime type of the file being loaded
  60245. * @returns true if the loader can load the specified file
  60246. */
  60247. canLoad(extension: string, mimeType?: string): boolean;
  60248. /**
  60249. * Uploads the cube texture data to the WebGL texture. It has already been bound.
  60250. * @param data contains the texture data
  60251. * @param texture defines the BabylonJS internal texture
  60252. * @param createPolynomials will be true if polynomials have been requested
  60253. * @param onLoad defines the callback to trigger once the texture is ready
  60254. * @param onError defines the callback to trigger in case of error
  60255. */
  60256. loadCubeData(data: ArrayBufferView | ArrayBufferView[], texture: InternalTexture, createPolynomials: boolean, onLoad: Nullable<(data?: any) => void>, onError: Nullable<(message?: string, exception?: any) => void>): void;
  60257. /**
  60258. * Uploads the 2D texture data to the WebGL texture. It has already been bound once in the callback.
  60259. * @param data contains the texture data
  60260. * @param texture defines the BabylonJS internal texture
  60261. * @param callback defines the method to call once ready to upload
  60262. */
  60263. loadData(data: ArrayBufferView, texture: InternalTexture, callback: (width: number, height: number, loadMipmap: boolean, isCompressed: boolean, done: () => void, loadFailed: boolean) => void): void;
  60264. }
  60265. }
  60266. declare module "babylonjs/Helpers/sceneHelpers" {
  60267. import { Nullable } from "babylonjs/types";
  60268. import { Mesh } from "babylonjs/Meshes/mesh";
  60269. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  60270. import { IEnvironmentHelperOptions, EnvironmentHelper } from "babylonjs/Helpers/environmentHelper";
  60271. import { VRExperienceHelperOptions, VRExperienceHelper } from "babylonjs/Cameras/VR/vrExperienceHelper";
  60272. import "babylonjs/Materials/Textures/Loaders/ddsTextureLoader";
  60273. import "babylonjs/Materials/Textures/Loaders/envTextureLoader";
  60274. import "babylonjs/Materials/Textures/Loaders/ktxTextureLoader";
  60275. import "babylonjs/Meshes/Builders/boxBuilder";
  60276. import { WebXRDefaultExperience, WebXRDefaultExperienceOptions } from "babylonjs/XR/webXRDefaultExperience";
  60277. /** @hidden */
  60278. export var _forceSceneHelpersToBundle: boolean;
  60279. module "babylonjs/scene" {
  60280. interface Scene {
  60281. /**
  60282. * Creates a default light for the scene.
  60283. * @see https://doc.babylonjs.com/How_To/Fast_Build#create-default-light
  60284. * @param replace has the default false, when true replaces the existing lights in the scene with a hemispheric light
  60285. */
  60286. createDefaultLight(replace?: boolean): void;
  60287. /**
  60288. * Creates a default camera for the scene.
  60289. * @see https://doc.babylonjs.com/How_To/Fast_Build#create-default-camera
  60290. * @param createArcRotateCamera has the default false which creates a free camera, when true creates an arc rotate camera
  60291. * @param replace has default false, when true replaces the active camera in the scene
  60292. * @param attachCameraControls has default false, when true attaches camera controls to the canvas.
  60293. */
  60294. createDefaultCamera(createArcRotateCamera?: boolean, replace?: boolean, attachCameraControls?: boolean): void;
  60295. /**
  60296. * Creates a default camera and a default light.
  60297. * @see https://doc.babylonjs.com/how_to/Fast_Build#create-default-camera-or-light
  60298. * @param createArcRotateCamera has the default false which creates a free camera, when true creates an arc rotate camera
  60299. * @param replace has the default false, when true replaces the active camera/light in the scene
  60300. * @param attachCameraControls has the default false, when true attaches camera controls to the canvas.
  60301. */
  60302. createDefaultCameraOrLight(createArcRotateCamera?: boolean, replace?: boolean, attachCameraControls?: boolean): void;
  60303. /**
  60304. * Creates a new sky box
  60305. * @see https://doc.babylonjs.com/how_to/Fast_Build#create-default-skybox
  60306. * @param environmentTexture defines the texture to use as environment texture
  60307. * @param pbr has default false which requires the StandardMaterial to be used, when true PBRMaterial must be used
  60308. * @param scale defines the overall scale of the skybox
  60309. * @param blur is only available when pbr is true, default is 0, no blur, maximum value is 1
  60310. * @param setGlobalEnvTexture has default true indicating that scene.environmentTexture must match the current skybox texture
  60311. * @returns a new mesh holding the sky box
  60312. */
  60313. createDefaultSkybox(environmentTexture?: BaseTexture, pbr?: boolean, scale?: number, blur?: number, setGlobalEnvTexture?: boolean): Nullable<Mesh>;
  60314. /**
  60315. * Creates a new environment
  60316. * @see https://doc.babylonjs.com/How_To/Fast_Build#create-default-environment
  60317. * @param options defines the options you can use to configure the environment
  60318. * @returns the new EnvironmentHelper
  60319. */
  60320. createDefaultEnvironment(options?: Partial<IEnvironmentHelperOptions>): Nullable<EnvironmentHelper>;
  60321. /**
  60322. * Creates a new VREXperienceHelper
  60323. * @see https://doc.babylonjs.com/how_to/webvr_helper
  60324. * @param webVROptions defines the options used to create the new VREXperienceHelper
  60325. * @returns a new VREXperienceHelper
  60326. */
  60327. createDefaultVRExperience(webVROptions?: VRExperienceHelperOptions): VRExperienceHelper;
  60328. /**
  60329. * Creates a new WebXRDefaultExperience
  60330. * @see https://doc.babylonjs.com/how_to/introduction_to_webxr
  60331. * @param options experience options
  60332. * @returns a promise for a new WebXRDefaultExperience
  60333. */
  60334. createDefaultXRExperienceAsync(options: WebXRDefaultExperienceOptions): Promise<WebXRDefaultExperience>;
  60335. }
  60336. }
  60337. }
  60338. declare module "babylonjs/Helpers/videoDome" {
  60339. import { Scene } from "babylonjs/scene";
  60340. import { VideoTexture } from "babylonjs/Materials/Textures/videoTexture";
  60341. import { TextureDome } from "babylonjs/Helpers/textureDome";
  60342. /**
  60343. * Display a 360/180 degree video on an approximately spherical surface, useful for VR applications or skyboxes.
  60344. * As a subclass of TransformNode, this allow parenting to the camera or multiple videos with different locations in the scene.
  60345. * This class achieves its effect with a VideoTexture and a correctly configured BackgroundMaterial on an inverted sphere.
  60346. * Potential additions to this helper include zoom and and non-infinite distance rendering effects.
  60347. */
  60348. export class VideoDome extends TextureDome<VideoTexture> {
  60349. /**
  60350. * Define the video source as a Monoscopic panoramic 360 video.
  60351. */
  60352. static readonly MODE_MONOSCOPIC: number;
  60353. /**
  60354. * Define the video source as a Stereoscopic TopBottom/OverUnder panoramic 360 video.
  60355. */
  60356. static readonly MODE_TOPBOTTOM: number;
  60357. /**
  60358. * Define the video source as a Stereoscopic Side by Side panoramic 360 video.
  60359. */
  60360. static readonly MODE_SIDEBYSIDE: number;
  60361. /**
  60362. * Get the video texture associated with this video dome
  60363. */
  60364. get videoTexture(): VideoTexture;
  60365. /**
  60366. * Get the video mode of this dome
  60367. */
  60368. get videoMode(): number;
  60369. /**
  60370. * Set the video mode of this dome.
  60371. * @see textureMode
  60372. */
  60373. set videoMode(value: number);
  60374. protected _initTexture(urlsOrElement: string | string[] | HTMLVideoElement, scene: Scene, options: any): VideoTexture;
  60375. }
  60376. }
  60377. declare module "babylonjs/Helpers/index" {
  60378. export * from "babylonjs/Helpers/environmentHelper";
  60379. export * from "babylonjs/Helpers/photoDome";
  60380. export * from "babylonjs/Helpers/sceneHelpers";
  60381. export * from "babylonjs/Helpers/videoDome";
  60382. }
  60383. declare module "babylonjs/Instrumentation/engineInstrumentation" {
  60384. import { PerfCounter } from "babylonjs/Misc/perfCounter";
  60385. import { IDisposable } from "babylonjs/scene";
  60386. import { Engine } from "babylonjs/Engines/engine";
  60387. /**
  60388. * This class can be used to get instrumentation data from a Babylon engine
  60389. * @see https://doc.babylonjs.com/how_to/optimizing_your_scene#engineinstrumentation
  60390. */
  60391. export class EngineInstrumentation implements IDisposable {
  60392. /**
  60393. * Define the instrumented engine.
  60394. */
  60395. engine: Engine;
  60396. private _captureGPUFrameTime;
  60397. private _gpuFrameTimeToken;
  60398. private _gpuFrameTime;
  60399. private _captureShaderCompilationTime;
  60400. private _shaderCompilationTime;
  60401. private _onBeginFrameObserver;
  60402. private _onEndFrameObserver;
  60403. private _onBeforeShaderCompilationObserver;
  60404. private _onAfterShaderCompilationObserver;
  60405. /**
  60406. * Gets the perf counter used for GPU frame time
  60407. */
  60408. get gpuFrameTimeCounter(): PerfCounter;
  60409. /**
  60410. * Gets the GPU frame time capture status
  60411. */
  60412. get captureGPUFrameTime(): boolean;
  60413. /**
  60414. * Enable or disable the GPU frame time capture
  60415. */
  60416. set captureGPUFrameTime(value: boolean);
  60417. /**
  60418. * Gets the perf counter used for shader compilation time
  60419. */
  60420. get shaderCompilationTimeCounter(): PerfCounter;
  60421. /**
  60422. * Gets the shader compilation time capture status
  60423. */
  60424. get captureShaderCompilationTime(): boolean;
  60425. /**
  60426. * Enable or disable the shader compilation time capture
  60427. */
  60428. set captureShaderCompilationTime(value: boolean);
  60429. /**
  60430. * Instantiates a new engine instrumentation.
  60431. * This class can be used to get instrumentation data from a Babylon engine
  60432. * @see https://doc.babylonjs.com/how_to/optimizing_your_scene#engineinstrumentation
  60433. * @param engine Defines the engine to instrument
  60434. */
  60435. constructor(
  60436. /**
  60437. * Define the instrumented engine.
  60438. */
  60439. engine: Engine);
  60440. /**
  60441. * Dispose and release associated resources.
  60442. */
  60443. dispose(): void;
  60444. }
  60445. }
  60446. declare module "babylonjs/Instrumentation/sceneInstrumentation" {
  60447. import { Scene, IDisposable } from "babylonjs/scene";
  60448. import { PerfCounter } from "babylonjs/Misc/perfCounter";
  60449. /**
  60450. * This class can be used to get instrumentation data from a Babylon engine
  60451. * @see https://doc.babylonjs.com/how_to/optimizing_your_scene#sceneinstrumentation
  60452. */
  60453. export class SceneInstrumentation implements IDisposable {
  60454. /**
  60455. * Defines the scene to instrument
  60456. */
  60457. scene: Scene;
  60458. private _captureActiveMeshesEvaluationTime;
  60459. private _activeMeshesEvaluationTime;
  60460. private _captureRenderTargetsRenderTime;
  60461. private _renderTargetsRenderTime;
  60462. private _captureFrameTime;
  60463. private _frameTime;
  60464. private _captureRenderTime;
  60465. private _renderTime;
  60466. private _captureInterFrameTime;
  60467. private _interFrameTime;
  60468. private _captureParticlesRenderTime;
  60469. private _particlesRenderTime;
  60470. private _captureSpritesRenderTime;
  60471. private _spritesRenderTime;
  60472. private _capturePhysicsTime;
  60473. private _physicsTime;
  60474. private _captureAnimationsTime;
  60475. private _animationsTime;
  60476. private _captureCameraRenderTime;
  60477. private _cameraRenderTime;
  60478. private _onBeforeActiveMeshesEvaluationObserver;
  60479. private _onAfterActiveMeshesEvaluationObserver;
  60480. private _onBeforeRenderTargetsRenderObserver;
  60481. private _onAfterRenderTargetsRenderObserver;
  60482. private _onAfterRenderObserver;
  60483. private _onBeforeDrawPhaseObserver;
  60484. private _onAfterDrawPhaseObserver;
  60485. private _onBeforeAnimationsObserver;
  60486. private _onBeforeParticlesRenderingObserver;
  60487. private _onAfterParticlesRenderingObserver;
  60488. private _onBeforeSpritesRenderingObserver;
  60489. private _onAfterSpritesRenderingObserver;
  60490. private _onBeforePhysicsObserver;
  60491. private _onAfterPhysicsObserver;
  60492. private _onAfterAnimationsObserver;
  60493. private _onBeforeCameraRenderObserver;
  60494. private _onAfterCameraRenderObserver;
  60495. /**
  60496. * Gets the perf counter used for active meshes evaluation time
  60497. */
  60498. get activeMeshesEvaluationTimeCounter(): PerfCounter;
  60499. /**
  60500. * Gets the active meshes evaluation time capture status
  60501. */
  60502. get captureActiveMeshesEvaluationTime(): boolean;
  60503. /**
  60504. * Enable or disable the active meshes evaluation time capture
  60505. */
  60506. set captureActiveMeshesEvaluationTime(value: boolean);
  60507. /**
  60508. * Gets the perf counter used for render targets render time
  60509. */
  60510. get renderTargetsRenderTimeCounter(): PerfCounter;
  60511. /**
  60512. * Gets the render targets render time capture status
  60513. */
  60514. get captureRenderTargetsRenderTime(): boolean;
  60515. /**
  60516. * Enable or disable the render targets render time capture
  60517. */
  60518. set captureRenderTargetsRenderTime(value: boolean);
  60519. /**
  60520. * Gets the perf counter used for particles render time
  60521. */
  60522. get particlesRenderTimeCounter(): PerfCounter;
  60523. /**
  60524. * Gets the particles render time capture status
  60525. */
  60526. get captureParticlesRenderTime(): boolean;
  60527. /**
  60528. * Enable or disable the particles render time capture
  60529. */
  60530. set captureParticlesRenderTime(value: boolean);
  60531. /**
  60532. * Gets the perf counter used for sprites render time
  60533. */
  60534. get spritesRenderTimeCounter(): PerfCounter;
  60535. /**
  60536. * Gets the sprites render time capture status
  60537. */
  60538. get captureSpritesRenderTime(): boolean;
  60539. /**
  60540. * Enable or disable the sprites render time capture
  60541. */
  60542. set captureSpritesRenderTime(value: boolean);
  60543. /**
  60544. * Gets the perf counter used for physics time
  60545. */
  60546. get physicsTimeCounter(): PerfCounter;
  60547. /**
  60548. * Gets the physics time capture status
  60549. */
  60550. get capturePhysicsTime(): boolean;
  60551. /**
  60552. * Enable or disable the physics time capture
  60553. */
  60554. set capturePhysicsTime(value: boolean);
  60555. /**
  60556. * Gets the perf counter used for animations time
  60557. */
  60558. get animationsTimeCounter(): PerfCounter;
  60559. /**
  60560. * Gets the animations time capture status
  60561. */
  60562. get captureAnimationsTime(): boolean;
  60563. /**
  60564. * Enable or disable the animations time capture
  60565. */
  60566. set captureAnimationsTime(value: boolean);
  60567. /**
  60568. * Gets the perf counter used for frame time capture
  60569. */
  60570. get frameTimeCounter(): PerfCounter;
  60571. /**
  60572. * Gets the frame time capture status
  60573. */
  60574. get captureFrameTime(): boolean;
  60575. /**
  60576. * Enable or disable the frame time capture
  60577. */
  60578. set captureFrameTime(value: boolean);
  60579. /**
  60580. * Gets the perf counter used for inter-frames time capture
  60581. */
  60582. get interFrameTimeCounter(): PerfCounter;
  60583. /**
  60584. * Gets the inter-frames time capture status
  60585. */
  60586. get captureInterFrameTime(): boolean;
  60587. /**
  60588. * Enable or disable the inter-frames time capture
  60589. */
  60590. set captureInterFrameTime(value: boolean);
  60591. /**
  60592. * Gets the perf counter used for render time capture
  60593. */
  60594. get renderTimeCounter(): PerfCounter;
  60595. /**
  60596. * Gets the render time capture status
  60597. */
  60598. get captureRenderTime(): boolean;
  60599. /**
  60600. * Enable or disable the render time capture
  60601. */
  60602. set captureRenderTime(value: boolean);
  60603. /**
  60604. * Gets the perf counter used for camera render time capture
  60605. */
  60606. get cameraRenderTimeCounter(): PerfCounter;
  60607. /**
  60608. * Gets the camera render time capture status
  60609. */
  60610. get captureCameraRenderTime(): boolean;
  60611. /**
  60612. * Enable or disable the camera render time capture
  60613. */
  60614. set captureCameraRenderTime(value: boolean);
  60615. /**
  60616. * Gets the perf counter used for draw calls
  60617. */
  60618. get drawCallsCounter(): PerfCounter;
  60619. /**
  60620. * Instantiates a new scene instrumentation.
  60621. * This class can be used to get instrumentation data from a Babylon engine
  60622. * @see https://doc.babylonjs.com/how_to/optimizing_your_scene#sceneinstrumentation
  60623. * @param scene Defines the scene to instrument
  60624. */
  60625. constructor(
  60626. /**
  60627. * Defines the scene to instrument
  60628. */
  60629. scene: Scene);
  60630. /**
  60631. * Dispose and release associated resources.
  60632. */
  60633. dispose(): void;
  60634. }
  60635. }
  60636. declare module "babylonjs/Instrumentation/index" {
  60637. export * from "babylonjs/Instrumentation/engineInstrumentation";
  60638. export * from "babylonjs/Instrumentation/sceneInstrumentation";
  60639. export * from "babylonjs/Instrumentation/timeToken";
  60640. }
  60641. declare module "babylonjs/Shaders/glowMapGeneration.fragment" {
  60642. /** @hidden */
  60643. export var glowMapGenerationPixelShader: {
  60644. name: string;
  60645. shader: string;
  60646. };
  60647. }
  60648. declare module "babylonjs/Shaders/glowMapGeneration.vertex" {
  60649. import "babylonjs/Shaders/ShadersInclude/bonesDeclaration";
  60650. import "babylonjs/Shaders/ShadersInclude/morphTargetsVertexGlobalDeclaration";
  60651. import "babylonjs/Shaders/ShadersInclude/morphTargetsVertexDeclaration";
  60652. import "babylonjs/Shaders/ShadersInclude/instancesDeclaration";
  60653. import "babylonjs/Shaders/ShadersInclude/morphTargetsVertex";
  60654. import "babylonjs/Shaders/ShadersInclude/instancesVertex";
  60655. import "babylonjs/Shaders/ShadersInclude/bonesVertex";
  60656. /** @hidden */
  60657. export var glowMapGenerationVertexShader: {
  60658. name: string;
  60659. shader: string;
  60660. };
  60661. }
  60662. declare module "babylonjs/Layers/effectLayer" {
  60663. import { Observable } from "babylonjs/Misc/observable";
  60664. import { Nullable } from "babylonjs/types";
  60665. import { Camera } from "babylonjs/Cameras/camera";
  60666. import { Scene } from "babylonjs/scene";
  60667. import { ISize } from "babylonjs/Maths/math.size";
  60668. import { Color4 } from "babylonjs/Maths/math.color";
  60669. import { Engine } from "babylonjs/Engines/engine";
  60670. import { SubMesh } from "babylonjs/Meshes/subMesh";
  60671. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  60672. import { Mesh } from "babylonjs/Meshes/mesh";
  60673. import { PostProcess } from "babylonjs/PostProcesses/postProcess";
  60674. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  60675. import { RenderTargetTexture } from "babylonjs/Materials/Textures/renderTargetTexture";
  60676. import { Effect } from "babylonjs/Materials/effect";
  60677. import { Material } from "babylonjs/Materials/material";
  60678. import "babylonjs/Shaders/glowMapGeneration.fragment";
  60679. import "babylonjs/Shaders/glowMapGeneration.vertex";
  60680. /**
  60681. * Effect layer options. This helps customizing the behaviour
  60682. * of the effect layer.
  60683. */
  60684. export interface IEffectLayerOptions {
  60685. /**
  60686. * Multiplication factor apply to the canvas size to compute the render target size
  60687. * used to generated the objects (the smaller the faster).
  60688. */
  60689. mainTextureRatio: number;
  60690. /**
  60691. * Enforces a fixed size texture to ensure effect stability across devices.
  60692. */
  60693. mainTextureFixedSize?: number;
  60694. /**
  60695. * Alpha blending mode used to apply the blur. Default depends of the implementation.
  60696. */
  60697. alphaBlendingMode: number;
  60698. /**
  60699. * The camera attached to the layer.
  60700. */
  60701. camera: Nullable<Camera>;
  60702. /**
  60703. * The rendering group to draw the layer in.
  60704. */
  60705. renderingGroupId: number;
  60706. }
  60707. /**
  60708. * The effect layer Helps adding post process effect blended with the main pass.
  60709. *
  60710. * This can be for instance use to generate glow or higlight effects on the scene.
  60711. *
  60712. * The effect layer class can not be used directly and is intented to inherited from to be
  60713. * customized per effects.
  60714. */
  60715. export abstract class EffectLayer {
  60716. private _vertexBuffers;
  60717. private _indexBuffer;
  60718. private _cachedDefines;
  60719. private _effectLayerMapGenerationEffect;
  60720. private _effectLayerOptions;
  60721. private _mergeEffect;
  60722. protected _scene: Scene;
  60723. protected _engine: Engine;
  60724. protected _maxSize: number;
  60725. protected _mainTextureDesiredSize: ISize;
  60726. protected _mainTexture: RenderTargetTexture;
  60727. protected _shouldRender: boolean;
  60728. protected _postProcesses: PostProcess[];
  60729. protected _textures: BaseTexture[];
  60730. protected _emissiveTextureAndColor: {
  60731. texture: Nullable<BaseTexture>;
  60732. color: Color4;
  60733. };
  60734. /**
  60735. * The name of the layer
  60736. */
  60737. name: string;
  60738. /**
  60739. * The clear color of the texture used to generate the glow map.
  60740. */
  60741. neutralColor: Color4;
  60742. /**
  60743. * Specifies whether the highlight layer is enabled or not.
  60744. */
  60745. isEnabled: boolean;
  60746. /**
  60747. * Gets the camera attached to the layer.
  60748. */
  60749. get camera(): Nullable<Camera>;
  60750. /**
  60751. * Gets the rendering group id the layer should render in.
  60752. */
  60753. get renderingGroupId(): number;
  60754. set renderingGroupId(renderingGroupId: number);
  60755. /**
  60756. * An event triggered when the effect layer has been disposed.
  60757. */
  60758. onDisposeObservable: Observable<EffectLayer>;
  60759. /**
  60760. * An event triggered when the effect layer is about rendering the main texture with the glowy parts.
  60761. */
  60762. onBeforeRenderMainTextureObservable: Observable<EffectLayer>;
  60763. /**
  60764. * An event triggered when the generated texture is being merged in the scene.
  60765. */
  60766. onBeforeComposeObservable: Observable<EffectLayer>;
  60767. /**
  60768. * An event triggered when the mesh is rendered into the effect render target.
  60769. */
  60770. onBeforeRenderMeshToEffect: Observable<AbstractMesh>;
  60771. /**
  60772. * An event triggered after the mesh has been rendered into the effect render target.
  60773. */
  60774. onAfterRenderMeshToEffect: Observable<AbstractMesh>;
  60775. /**
  60776. * An event triggered when the generated texture has been merged in the scene.
  60777. */
  60778. onAfterComposeObservable: Observable<EffectLayer>;
  60779. /**
  60780. * An event triggered when the efffect layer changes its size.
  60781. */
  60782. onSizeChangedObservable: Observable<EffectLayer>;
  60783. /** @hidden */
  60784. static _SceneComponentInitialization: (scene: Scene) => void;
  60785. /**
  60786. * Instantiates a new effect Layer and references it in the scene.
  60787. * @param name The name of the layer
  60788. * @param scene The scene to use the layer in
  60789. */
  60790. constructor(
  60791. /** The Friendly of the effect in the scene */
  60792. name: string, scene: Scene);
  60793. /**
  60794. * Get the effect name of the layer.
  60795. * @return The effect name
  60796. */
  60797. abstract getEffectName(): string;
  60798. /**
  60799. * Checks for the readiness of the element composing the layer.
  60800. * @param subMesh the mesh to check for
  60801. * @param useInstances specify whether or not to use instances to render the mesh
  60802. * @return true if ready otherwise, false
  60803. */
  60804. abstract isReady(subMesh: SubMesh, useInstances: boolean): boolean;
  60805. /**
  60806. * Returns whether or nood the layer needs stencil enabled during the mesh rendering.
  60807. * @returns true if the effect requires stencil during the main canvas render pass.
  60808. */
  60809. abstract needStencil(): boolean;
  60810. /**
  60811. * Create the merge effect. This is the shader use to blit the information back
  60812. * to the main canvas at the end of the scene rendering.
  60813. * @returns The effect containing the shader used to merge the effect on the main canvas
  60814. */
  60815. protected abstract _createMergeEffect(): Effect;
  60816. /**
  60817. * Creates the render target textures and post processes used in the effect layer.
  60818. */
  60819. protected abstract _createTextureAndPostProcesses(): void;
  60820. /**
  60821. * Implementation specific of rendering the generating effect on the main canvas.
  60822. * @param effect The effect used to render through
  60823. */
  60824. protected abstract _internalRender(effect: Effect): void;
  60825. /**
  60826. * Sets the required values for both the emissive texture and and the main color.
  60827. */
  60828. protected abstract _setEmissiveTextureAndColor(mesh: Mesh, subMesh: SubMesh, material: Material): void;
  60829. /**
  60830. * Free any resources and references associated to a mesh.
  60831. * Internal use
  60832. * @param mesh The mesh to free.
  60833. */
  60834. abstract _disposeMesh(mesh: Mesh): void;
  60835. /**
  60836. * Serializes this layer (Glow or Highlight for example)
  60837. * @returns a serialized layer object
  60838. */
  60839. abstract serialize?(): any;
  60840. /**
  60841. * Initializes the effect layer with the required options.
  60842. * @param options Sets of none mandatory options to use with the layer (see IEffectLayerOptions for more information)
  60843. */
  60844. protected _init(options: Partial<IEffectLayerOptions>): void;
  60845. /**
  60846. * Generates the index buffer of the full screen quad blending to the main canvas.
  60847. */
  60848. private _generateIndexBuffer;
  60849. /**
  60850. * Generates the vertex buffer of the full screen quad blending to the main canvas.
  60851. */
  60852. private _generateVertexBuffer;
  60853. /**
  60854. * Sets the main texture desired size which is the closest power of two
  60855. * of the engine canvas size.
  60856. */
  60857. private _setMainTextureSize;
  60858. /**
  60859. * Creates the main texture for the effect layer.
  60860. */
  60861. protected _createMainTexture(): void;
  60862. /**
  60863. * Adds specific effects defines.
  60864. * @param defines The defines to add specifics to.
  60865. */
  60866. protected _addCustomEffectDefines(defines: string[]): void;
  60867. /**
  60868. * Checks for the readiness of the element composing the layer.
  60869. * @param subMesh the mesh to check for
  60870. * @param useInstances specify whether or not to use instances to render the mesh
  60871. * @param emissiveTexture the associated emissive texture used to generate the glow
  60872. * @return true if ready otherwise, false
  60873. */
  60874. protected _isReady(subMesh: SubMesh, useInstances: boolean, emissiveTexture: Nullable<BaseTexture>): boolean;
  60875. /**
  60876. * Renders the glowing part of the scene by blending the blurred glowing meshes on top of the rendered scene.
  60877. */
  60878. render(): void;
  60879. /**
  60880. * Determine if a given mesh will be used in the current effect.
  60881. * @param mesh mesh to test
  60882. * @returns true if the mesh will be used
  60883. */
  60884. hasMesh(mesh: AbstractMesh): boolean;
  60885. /**
  60886. * Returns true if the layer contains information to display, otherwise false.
  60887. * @returns true if the glow layer should be rendered
  60888. */
  60889. shouldRender(): boolean;
  60890. /**
  60891. * Returns true if the mesh should render, otherwise false.
  60892. * @param mesh The mesh to render
  60893. * @returns true if it should render otherwise false
  60894. */
  60895. protected _shouldRenderMesh(mesh: AbstractMesh): boolean;
  60896. /**
  60897. * Returns true if the mesh can be rendered, otherwise false.
  60898. * @param mesh The mesh to render
  60899. * @param material The material used on the mesh
  60900. * @returns true if it can be rendered otherwise false
  60901. */
  60902. protected _canRenderMesh(mesh: AbstractMesh, material: Material): boolean;
  60903. /**
  60904. * Returns true if the mesh should render, otherwise false.
  60905. * @param mesh The mesh to render
  60906. * @returns true if it should render otherwise false
  60907. */
  60908. protected _shouldRenderEmissiveTextureForMesh(): boolean;
  60909. /**
  60910. * Renders the submesh passed in parameter to the generation map.
  60911. */
  60912. protected _renderSubMesh(subMesh: SubMesh, enableAlphaMode?: boolean): void;
  60913. /**
  60914. * Defines whether the current material of the mesh should be use to render the effect.
  60915. * @param mesh defines the current mesh to render
  60916. */
  60917. protected _useMeshMaterial(mesh: AbstractMesh): boolean;
  60918. /**
  60919. * Rebuild the required buffers.
  60920. * @hidden Internal use only.
  60921. */
  60922. _rebuild(): void;
  60923. /**
  60924. * Dispose only the render target textures and post process.
  60925. */
  60926. private _disposeTextureAndPostProcesses;
  60927. /**
  60928. * Dispose the highlight layer and free resources.
  60929. */
  60930. dispose(): void;
  60931. /**
  60932. * Gets the class name of the effect layer
  60933. * @returns the string with the class name of the effect layer
  60934. */
  60935. getClassName(): string;
  60936. /**
  60937. * Creates an effect layer from parsed effect layer data
  60938. * @param parsedEffectLayer defines effect layer data
  60939. * @param scene defines the current scene
  60940. * @param rootUrl defines the root URL containing the effect layer information
  60941. * @returns a parsed effect Layer
  60942. */
  60943. static Parse(parsedEffectLayer: any, scene: Scene, rootUrl: string): EffectLayer;
  60944. }
  60945. }
  60946. declare module "babylonjs/Layers/effectLayerSceneComponent" {
  60947. import { Scene } from "babylonjs/scene";
  60948. import { ISceneSerializableComponent } from "babylonjs/sceneComponent";
  60949. import { EffectLayer } from "babylonjs/Layers/effectLayer";
  60950. import { AbstractScene } from "babylonjs/abstractScene";
  60951. module "babylonjs/abstractScene" {
  60952. interface AbstractScene {
  60953. /**
  60954. * The list of effect layers (highlights/glow) added to the scene
  60955. * @see https://doc.babylonjs.com/how_to/highlight_layer
  60956. * @see https://doc.babylonjs.com/how_to/glow_layer
  60957. */
  60958. effectLayers: Array<EffectLayer>;
  60959. /**
  60960. * Removes the given effect layer from this scene.
  60961. * @param toRemove defines the effect layer to remove
  60962. * @returns the index of the removed effect layer
  60963. */
  60964. removeEffectLayer(toRemove: EffectLayer): number;
  60965. /**
  60966. * Adds the given effect layer to this scene
  60967. * @param newEffectLayer defines the effect layer to add
  60968. */
  60969. addEffectLayer(newEffectLayer: EffectLayer): void;
  60970. }
  60971. }
  60972. /**
  60973. * Defines the layer scene component responsible to manage any effect layers
  60974. * in a given scene.
  60975. */
  60976. export class EffectLayerSceneComponent implements ISceneSerializableComponent {
  60977. /**
  60978. * The component name helpfull to identify the component in the list of scene components.
  60979. */
  60980. readonly name: string;
  60981. /**
  60982. * The scene the component belongs to.
  60983. */
  60984. scene: Scene;
  60985. private _engine;
  60986. private _renderEffects;
  60987. private _needStencil;
  60988. private _previousStencilState;
  60989. /**
  60990. * Creates a new instance of the component for the given scene
  60991. * @param scene Defines the scene to register the component in
  60992. */
  60993. constructor(scene: Scene);
  60994. /**
  60995. * Registers the component in a given scene
  60996. */
  60997. register(): void;
  60998. /**
  60999. * Rebuilds the elements related to this component in case of
  61000. * context lost for instance.
  61001. */
  61002. rebuild(): void;
  61003. /**
  61004. * Serializes the component data to the specified json object
  61005. * @param serializationObject The object to serialize to
  61006. */
  61007. serialize(serializationObject: any): void;
  61008. /**
  61009. * Adds all the elements from the container to the scene
  61010. * @param container the container holding the elements
  61011. */
  61012. addFromContainer(container: AbstractScene): void;
  61013. /**
  61014. * Removes all the elements in the container from the scene
  61015. * @param container contains the elements to remove
  61016. * @param dispose if the removed element should be disposed (default: false)
  61017. */
  61018. removeFromContainer(container: AbstractScene, dispose?: boolean): void;
  61019. /**
  61020. * Disposes the component and the associated ressources.
  61021. */
  61022. dispose(): void;
  61023. private _isReadyForMesh;
  61024. private _renderMainTexture;
  61025. private _setStencil;
  61026. private _setStencilBack;
  61027. private _draw;
  61028. private _drawCamera;
  61029. private _drawRenderingGroup;
  61030. }
  61031. }
  61032. declare module "babylonjs/Shaders/glowMapMerge.fragment" {
  61033. /** @hidden */
  61034. export var glowMapMergePixelShader: {
  61035. name: string;
  61036. shader: string;
  61037. };
  61038. }
  61039. declare module "babylonjs/Shaders/glowMapMerge.vertex" {
  61040. /** @hidden */
  61041. export var glowMapMergeVertexShader: {
  61042. name: string;
  61043. shader: string;
  61044. };
  61045. }
  61046. declare module "babylonjs/Layers/glowLayer" {
  61047. import { Nullable } from "babylonjs/types";
  61048. import { Camera } from "babylonjs/Cameras/camera";
  61049. import { Scene } from "babylonjs/scene";
  61050. import { SubMesh } from "babylonjs/Meshes/subMesh";
  61051. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  61052. import { Mesh } from "babylonjs/Meshes/mesh";
  61053. import { Texture } from "babylonjs/Materials/Textures/texture";
  61054. import { Effect } from "babylonjs/Materials/effect";
  61055. import { Material } from "babylonjs/Materials/material";
  61056. import { EffectLayer } from "babylonjs/Layers/effectLayer";
  61057. import { Color4 } from "babylonjs/Maths/math.color";
  61058. import "babylonjs/Shaders/glowMapMerge.fragment";
  61059. import "babylonjs/Shaders/glowMapMerge.vertex";
  61060. import "babylonjs/Layers/effectLayerSceneComponent";
  61061. module "babylonjs/abstractScene" {
  61062. interface AbstractScene {
  61063. /**
  61064. * Return a the first highlight layer of the scene with a given name.
  61065. * @param name The name of the highlight layer to look for.
  61066. * @return The highlight layer if found otherwise null.
  61067. */
  61068. getGlowLayerByName(name: string): Nullable<GlowLayer>;
  61069. }
  61070. }
  61071. /**
  61072. * Glow layer options. This helps customizing the behaviour
  61073. * of the glow layer.
  61074. */
  61075. export interface IGlowLayerOptions {
  61076. /**
  61077. * Multiplication factor apply to the canvas size to compute the render target size
  61078. * used to generated the glowing objects (the smaller the faster).
  61079. */
  61080. mainTextureRatio: number;
  61081. /**
  61082. * Enforces a fixed size texture to ensure resize independant blur.
  61083. */
  61084. mainTextureFixedSize?: number;
  61085. /**
  61086. * How big is the kernel of the blur texture.
  61087. */
  61088. blurKernelSize: number;
  61089. /**
  61090. * The camera attached to the layer.
  61091. */
  61092. camera: Nullable<Camera>;
  61093. /**
  61094. * Enable MSAA by chosing the number of samples.
  61095. */
  61096. mainTextureSamples?: number;
  61097. /**
  61098. * The rendering group to draw the layer in.
  61099. */
  61100. renderingGroupId: number;
  61101. }
  61102. /**
  61103. * The glow layer Helps adding a glow effect around the emissive parts of a mesh.
  61104. *
  61105. * Once instantiated in a scene, by default, all the emissive meshes will glow.
  61106. *
  61107. * Documentation: https://doc.babylonjs.com/how_to/glow_layer
  61108. */
  61109. export class GlowLayer extends EffectLayer {
  61110. /**
  61111. * Effect Name of the layer.
  61112. */
  61113. static readonly EffectName: string;
  61114. /**
  61115. * The default blur kernel size used for the glow.
  61116. */
  61117. static DefaultBlurKernelSize: number;
  61118. /**
  61119. * The default texture size ratio used for the glow.
  61120. */
  61121. static DefaultTextureRatio: number;
  61122. /**
  61123. * Sets the kernel size of the blur.
  61124. */
  61125. set blurKernelSize(value: number);
  61126. /**
  61127. * Gets the kernel size of the blur.
  61128. */
  61129. get blurKernelSize(): number;
  61130. /**
  61131. * Sets the glow intensity.
  61132. */
  61133. set intensity(value: number);
  61134. /**
  61135. * Gets the glow intensity.
  61136. */
  61137. get intensity(): number;
  61138. private _options;
  61139. private _intensity;
  61140. private _horizontalBlurPostprocess1;
  61141. private _verticalBlurPostprocess1;
  61142. private _horizontalBlurPostprocess2;
  61143. private _verticalBlurPostprocess2;
  61144. private _blurTexture1;
  61145. private _blurTexture2;
  61146. private _postProcesses1;
  61147. private _postProcesses2;
  61148. private _includedOnlyMeshes;
  61149. private _excludedMeshes;
  61150. private _meshesUsingTheirOwnMaterials;
  61151. /**
  61152. * Callback used to let the user override the color selection on a per mesh basis
  61153. */
  61154. customEmissiveColorSelector: (mesh: Mesh, subMesh: SubMesh, material: Material, result: Color4) => void;
  61155. /**
  61156. * Callback used to let the user override the texture selection on a per mesh basis
  61157. */
  61158. customEmissiveTextureSelector: (mesh: Mesh, subMesh: SubMesh, material: Material) => Texture;
  61159. /**
  61160. * Instantiates a new glow Layer and references it to the scene.
  61161. * @param name The name of the layer
  61162. * @param scene The scene to use the layer in
  61163. * @param options Sets of none mandatory options to use with the layer (see IGlowLayerOptions for more information)
  61164. */
  61165. constructor(name: string, scene: Scene, options?: Partial<IGlowLayerOptions>);
  61166. /**
  61167. * Get the effect name of the layer.
  61168. * @return The effect name
  61169. */
  61170. getEffectName(): string;
  61171. /**
  61172. * Create the merge effect. This is the shader use to blit the information back
  61173. * to the main canvas at the end of the scene rendering.
  61174. */
  61175. protected _createMergeEffect(): Effect;
  61176. /**
  61177. * Creates the render target textures and post processes used in the glow layer.
  61178. */
  61179. protected _createTextureAndPostProcesses(): void;
  61180. /**
  61181. * Checks for the readiness of the element composing the layer.
  61182. * @param subMesh the mesh to check for
  61183. * @param useInstances specify wether or not to use instances to render the mesh
  61184. * @param emissiveTexture the associated emissive texture used to generate the glow
  61185. * @return true if ready otherwise, false
  61186. */
  61187. isReady(subMesh: SubMesh, useInstances: boolean): boolean;
  61188. /**
  61189. * Returns whether or nood the layer needs stencil enabled during the mesh rendering.
  61190. */
  61191. needStencil(): boolean;
  61192. /**
  61193. * Returns true if the mesh can be rendered, otherwise false.
  61194. * @param mesh The mesh to render
  61195. * @param material The material used on the mesh
  61196. * @returns true if it can be rendered otherwise false
  61197. */
  61198. protected _canRenderMesh(mesh: AbstractMesh, material: Material): boolean;
  61199. /**
  61200. * Implementation specific of rendering the generating effect on the main canvas.
  61201. * @param effect The effect used to render through
  61202. */
  61203. protected _internalRender(effect: Effect): void;
  61204. /**
  61205. * Sets the required values for both the emissive texture and and the main color.
  61206. */
  61207. protected _setEmissiveTextureAndColor(mesh: Mesh, subMesh: SubMesh, material: Material): void;
  61208. /**
  61209. * Returns true if the mesh should render, otherwise false.
  61210. * @param mesh The mesh to render
  61211. * @returns true if it should render otherwise false
  61212. */
  61213. protected _shouldRenderMesh(mesh: Mesh): boolean;
  61214. /**
  61215. * Adds specific effects defines.
  61216. * @param defines The defines to add specifics to.
  61217. */
  61218. protected _addCustomEffectDefines(defines: string[]): void;
  61219. /**
  61220. * Add a mesh in the exclusion list to prevent it to impact or being impacted by the glow layer.
  61221. * @param mesh The mesh to exclude from the glow layer
  61222. */
  61223. addExcludedMesh(mesh: Mesh): void;
  61224. /**
  61225. * Remove a mesh from the exclusion list to let it impact or being impacted by the glow layer.
  61226. * @param mesh The mesh to remove
  61227. */
  61228. removeExcludedMesh(mesh: Mesh): void;
  61229. /**
  61230. * Add a mesh in the inclusion list to impact or being impacted by the glow layer.
  61231. * @param mesh The mesh to include in the glow layer
  61232. */
  61233. addIncludedOnlyMesh(mesh: Mesh): void;
  61234. /**
  61235. * Remove a mesh from the Inclusion list to prevent it to impact or being impacted by the glow layer.
  61236. * @param mesh The mesh to remove
  61237. */
  61238. removeIncludedOnlyMesh(mesh: Mesh): void;
  61239. /**
  61240. * Determine if a given mesh will be used in the glow layer
  61241. * @param mesh The mesh to test
  61242. * @returns true if the mesh will be highlighted by the current glow layer
  61243. */
  61244. hasMesh(mesh: AbstractMesh): boolean;
  61245. /**
  61246. * Defines whether the current material of the mesh should be use to render the effect.
  61247. * @param mesh defines the current mesh to render
  61248. */
  61249. protected _useMeshMaterial(mesh: AbstractMesh): boolean;
  61250. /**
  61251. * Add a mesh to be rendered through its own material and not with emissive only.
  61252. * @param mesh The mesh for which we need to use its material
  61253. */
  61254. referenceMeshToUseItsOwnMaterial(mesh: AbstractMesh): void;
  61255. /**
  61256. * Remove a mesh from being rendered through its own material and not with emissive only.
  61257. * @param mesh The mesh for which we need to not use its material
  61258. */
  61259. unReferenceMeshFromUsingItsOwnMaterial(mesh: AbstractMesh): void;
  61260. /**
  61261. * Free any resources and references associated to a mesh.
  61262. * Internal use
  61263. * @param mesh The mesh to free.
  61264. * @hidden
  61265. */
  61266. _disposeMesh(mesh: Mesh): void;
  61267. /**
  61268. * Gets the class name of the effect layer
  61269. * @returns the string with the class name of the effect layer
  61270. */
  61271. getClassName(): string;
  61272. /**
  61273. * Serializes this glow layer
  61274. * @returns a serialized glow layer object
  61275. */
  61276. serialize(): any;
  61277. /**
  61278. * Creates a Glow Layer from parsed glow layer data
  61279. * @param parsedGlowLayer defines glow layer data
  61280. * @param scene defines the current scene
  61281. * @param rootUrl defines the root URL containing the glow layer information
  61282. * @returns a parsed Glow Layer
  61283. */
  61284. static Parse(parsedGlowLayer: any, scene: Scene, rootUrl: string): GlowLayer;
  61285. }
  61286. }
  61287. declare module "babylonjs/Shaders/glowBlurPostProcess.fragment" {
  61288. /** @hidden */
  61289. export var glowBlurPostProcessPixelShader: {
  61290. name: string;
  61291. shader: string;
  61292. };
  61293. }
  61294. declare module "babylonjs/Layers/highlightLayer" {
  61295. import { Observable } from "babylonjs/Misc/observable";
  61296. import { Nullable } from "babylonjs/types";
  61297. import { Camera } from "babylonjs/Cameras/camera";
  61298. import { Scene } from "babylonjs/scene";
  61299. import { SubMesh } from "babylonjs/Meshes/subMesh";
  61300. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  61301. import { Mesh } from "babylonjs/Meshes/mesh";
  61302. import { Effect } from "babylonjs/Materials/effect";
  61303. import { Material } from "babylonjs/Materials/material";
  61304. import { EffectLayer } from "babylonjs/Layers/effectLayer";
  61305. import { Color4, Color3 } from "babylonjs/Maths/math.color";
  61306. import "babylonjs/Shaders/glowMapMerge.fragment";
  61307. import "babylonjs/Shaders/glowMapMerge.vertex";
  61308. import "babylonjs/Shaders/glowBlurPostProcess.fragment";
  61309. module "babylonjs/abstractScene" {
  61310. interface AbstractScene {
  61311. /**
  61312. * Return a the first highlight layer of the scene with a given name.
  61313. * @param name The name of the highlight layer to look for.
  61314. * @return The highlight layer if found otherwise null.
  61315. */
  61316. getHighlightLayerByName(name: string): Nullable<HighlightLayer>;
  61317. }
  61318. }
  61319. /**
  61320. * Highlight layer options. This helps customizing the behaviour
  61321. * of the highlight layer.
  61322. */
  61323. export interface IHighlightLayerOptions {
  61324. /**
  61325. * Multiplication factor apply to the canvas size to compute the render target size
  61326. * used to generated the glowing objects (the smaller the faster).
  61327. */
  61328. mainTextureRatio: number;
  61329. /**
  61330. * Enforces a fixed size texture to ensure resize independant blur.
  61331. */
  61332. mainTextureFixedSize?: number;
  61333. /**
  61334. * Multiplication factor apply to the main texture size in the first step of the blur to reduce the size
  61335. * of the picture to blur (the smaller the faster).
  61336. */
  61337. blurTextureSizeRatio: number;
  61338. /**
  61339. * How big in texel of the blur texture is the vertical blur.
  61340. */
  61341. blurVerticalSize: number;
  61342. /**
  61343. * How big in texel of the blur texture is the horizontal blur.
  61344. */
  61345. blurHorizontalSize: number;
  61346. /**
  61347. * Alpha blending mode used to apply the blur. Default is combine.
  61348. */
  61349. alphaBlendingMode: number;
  61350. /**
  61351. * The camera attached to the layer.
  61352. */
  61353. camera: Nullable<Camera>;
  61354. /**
  61355. * Should we display highlight as a solid stroke?
  61356. */
  61357. isStroke?: boolean;
  61358. /**
  61359. * The rendering group to draw the layer in.
  61360. */
  61361. renderingGroupId: number;
  61362. }
  61363. /**
  61364. * The highlight layer Helps adding a glow effect around a mesh.
  61365. *
  61366. * Once instantiated in a scene, simply use the addMesh or removeMesh method to add or remove
  61367. * glowy meshes to your scene.
  61368. *
  61369. * !!! THIS REQUIRES AN ACTIVE STENCIL BUFFER ON THE CANVAS !!!
  61370. */
  61371. export class HighlightLayer extends EffectLayer {
  61372. name: string;
  61373. /**
  61374. * Effect Name of the highlight layer.
  61375. */
  61376. static readonly EffectName: string;
  61377. /**
  61378. * The neutral color used during the preparation of the glow effect.
  61379. * This is black by default as the blend operation is a blend operation.
  61380. */
  61381. static NeutralColor: Color4;
  61382. /**
  61383. * Stencil value used for glowing meshes.
  61384. */
  61385. static GlowingMeshStencilReference: number;
  61386. /**
  61387. * Stencil value used for the other meshes in the scene.
  61388. */
  61389. static NormalMeshStencilReference: number;
  61390. /**
  61391. * Specifies whether or not the inner glow is ACTIVE in the layer.
  61392. */
  61393. innerGlow: boolean;
  61394. /**
  61395. * Specifies whether or not the outer glow is ACTIVE in the layer.
  61396. */
  61397. outerGlow: boolean;
  61398. /**
  61399. * Specifies the horizontal size of the blur.
  61400. */
  61401. set blurHorizontalSize(value: number);
  61402. /**
  61403. * Specifies the vertical size of the blur.
  61404. */
  61405. set blurVerticalSize(value: number);
  61406. /**
  61407. * Gets the horizontal size of the blur.
  61408. */
  61409. get blurHorizontalSize(): number;
  61410. /**
  61411. * Gets the vertical size of the blur.
  61412. */
  61413. get blurVerticalSize(): number;
  61414. /**
  61415. * An event triggered when the highlight layer is being blurred.
  61416. */
  61417. onBeforeBlurObservable: Observable<HighlightLayer>;
  61418. /**
  61419. * An event triggered when the highlight layer has been blurred.
  61420. */
  61421. onAfterBlurObservable: Observable<HighlightLayer>;
  61422. private _instanceGlowingMeshStencilReference;
  61423. private _options;
  61424. private _downSamplePostprocess;
  61425. private _horizontalBlurPostprocess;
  61426. private _verticalBlurPostprocess;
  61427. private _blurTexture;
  61428. private _meshes;
  61429. private _excludedMeshes;
  61430. /**
  61431. * Instantiates a new highlight Layer and references it to the scene..
  61432. * @param name The name of the layer
  61433. * @param scene The scene to use the layer in
  61434. * @param options Sets of none mandatory options to use with the layer (see IHighlightLayerOptions for more information)
  61435. */
  61436. constructor(name: string, scene: Scene, options?: Partial<IHighlightLayerOptions>);
  61437. /**
  61438. * Get the effect name of the layer.
  61439. * @return The effect name
  61440. */
  61441. getEffectName(): string;
  61442. /**
  61443. * Create the merge effect. This is the shader use to blit the information back
  61444. * to the main canvas at the end of the scene rendering.
  61445. */
  61446. protected _createMergeEffect(): Effect;
  61447. /**
  61448. * Creates the render target textures and post processes used in the highlight layer.
  61449. */
  61450. protected _createTextureAndPostProcesses(): void;
  61451. /**
  61452. * Returns wether or nood the layer needs stencil enabled during the mesh rendering.
  61453. */
  61454. needStencil(): boolean;
  61455. /**
  61456. * Checks for the readiness of the element composing the layer.
  61457. * @param subMesh the mesh to check for
  61458. * @param useInstances specify wether or not to use instances to render the mesh
  61459. * @param emissiveTexture the associated emissive texture used to generate the glow
  61460. * @return true if ready otherwise, false
  61461. */
  61462. isReady(subMesh: SubMesh, useInstances: boolean): boolean;
  61463. /**
  61464. * Implementation specific of rendering the generating effect on the main canvas.
  61465. * @param effect The effect used to render through
  61466. */
  61467. protected _internalRender(effect: Effect): void;
  61468. /**
  61469. * Returns true if the layer contains information to display, otherwise false.
  61470. */
  61471. shouldRender(): boolean;
  61472. /**
  61473. * Returns true if the mesh should render, otherwise false.
  61474. * @param mesh The mesh to render
  61475. * @returns true if it should render otherwise false
  61476. */
  61477. protected _shouldRenderMesh(mesh: Mesh): boolean;
  61478. /**
  61479. * Returns true if the mesh can be rendered, otherwise false.
  61480. * @param mesh The mesh to render
  61481. * @param material The material used on the mesh
  61482. * @returns true if it can be rendered otherwise false
  61483. */
  61484. protected _canRenderMesh(mesh: AbstractMesh, material: Material): boolean;
  61485. /**
  61486. * Adds specific effects defines.
  61487. * @param defines The defines to add specifics to.
  61488. */
  61489. protected _addCustomEffectDefines(defines: string[]): void;
  61490. /**
  61491. * Sets the required values for both the emissive texture and and the main color.
  61492. */
  61493. protected _setEmissiveTextureAndColor(mesh: Mesh, subMesh: SubMesh, material: Material): void;
  61494. /**
  61495. * Add a mesh in the exclusion list to prevent it to impact or being impacted by the highlight layer.
  61496. * @param mesh The mesh to exclude from the highlight layer
  61497. */
  61498. addExcludedMesh(mesh: Mesh): void;
  61499. /**
  61500. * Remove a mesh from the exclusion list to let it impact or being impacted by the highlight layer.
  61501. * @param mesh The mesh to highlight
  61502. */
  61503. removeExcludedMesh(mesh: Mesh): void;
  61504. /**
  61505. * Determine if a given mesh will be highlighted by the current HighlightLayer
  61506. * @param mesh mesh to test
  61507. * @returns true if the mesh will be highlighted by the current HighlightLayer
  61508. */
  61509. hasMesh(mesh: AbstractMesh): boolean;
  61510. /**
  61511. * Add a mesh in the highlight layer in order to make it glow with the chosen color.
  61512. * @param mesh The mesh to highlight
  61513. * @param color The color of the highlight
  61514. * @param glowEmissiveOnly Extract the glow from the emissive texture
  61515. */
  61516. addMesh(mesh: Mesh, color: Color3, glowEmissiveOnly?: boolean): void;
  61517. /**
  61518. * Remove a mesh from the highlight layer in order to make it stop glowing.
  61519. * @param mesh The mesh to highlight
  61520. */
  61521. removeMesh(mesh: Mesh): void;
  61522. /**
  61523. * Remove all the meshes currently referenced in the highlight layer
  61524. */
  61525. removeAllMeshes(): void;
  61526. /**
  61527. * Force the stencil to the normal expected value for none glowing parts
  61528. */
  61529. private _defaultStencilReference;
  61530. /**
  61531. * Free any resources and references associated to a mesh.
  61532. * Internal use
  61533. * @param mesh The mesh to free.
  61534. * @hidden
  61535. */
  61536. _disposeMesh(mesh: Mesh): void;
  61537. /**
  61538. * Dispose the highlight layer and free resources.
  61539. */
  61540. dispose(): void;
  61541. /**
  61542. * Gets the class name of the effect layer
  61543. * @returns the string with the class name of the effect layer
  61544. */
  61545. getClassName(): string;
  61546. /**
  61547. * Serializes this Highlight layer
  61548. * @returns a serialized Highlight layer object
  61549. */
  61550. serialize(): any;
  61551. /**
  61552. * Creates a Highlight layer from parsed Highlight layer data
  61553. * @param parsedHightlightLayer defines the Highlight layer data
  61554. * @param scene defines the current scene
  61555. * @param rootUrl defines the root URL containing the Highlight layer information
  61556. * @returns a parsed Highlight layer
  61557. */
  61558. static Parse(parsedHightlightLayer: any, scene: Scene, rootUrl: string): HighlightLayer;
  61559. }
  61560. }
  61561. declare module "babylonjs/Layers/layerSceneComponent" {
  61562. import { Scene } from "babylonjs/scene";
  61563. import { ISceneComponent } from "babylonjs/sceneComponent";
  61564. import { Layer } from "babylonjs/Layers/layer";
  61565. import { AbstractScene } from "babylonjs/abstractScene";
  61566. module "babylonjs/abstractScene" {
  61567. interface AbstractScene {
  61568. /**
  61569. * The list of layers (background and foreground) of the scene
  61570. */
  61571. layers: Array<Layer>;
  61572. }
  61573. }
  61574. /**
  61575. * Defines the layer scene component responsible to manage any layers
  61576. * in a given scene.
  61577. */
  61578. export class LayerSceneComponent implements ISceneComponent {
  61579. /**
  61580. * The component name helpfull to identify the component in the list of scene components.
  61581. */
  61582. readonly name: string;
  61583. /**
  61584. * The scene the component belongs to.
  61585. */
  61586. scene: Scene;
  61587. private _engine;
  61588. /**
  61589. * Creates a new instance of the component for the given scene
  61590. * @param scene Defines the scene to register the component in
  61591. */
  61592. constructor(scene: Scene);
  61593. /**
  61594. * Registers the component in a given scene
  61595. */
  61596. register(): void;
  61597. /**
  61598. * Rebuilds the elements related to this component in case of
  61599. * context lost for instance.
  61600. */
  61601. rebuild(): void;
  61602. /**
  61603. * Disposes the component and the associated ressources.
  61604. */
  61605. dispose(): void;
  61606. private _draw;
  61607. private _drawCameraPredicate;
  61608. private _drawCameraBackground;
  61609. private _drawCameraForeground;
  61610. private _drawRenderTargetPredicate;
  61611. private _drawRenderTargetBackground;
  61612. private _drawRenderTargetForeground;
  61613. /**
  61614. * Adds all the elements from the container to the scene
  61615. * @param container the container holding the elements
  61616. */
  61617. addFromContainer(container: AbstractScene): void;
  61618. /**
  61619. * Removes all the elements in the container from the scene
  61620. * @param container contains the elements to remove
  61621. * @param dispose if the removed element should be disposed (default: false)
  61622. */
  61623. removeFromContainer(container: AbstractScene, dispose?: boolean): void;
  61624. }
  61625. }
  61626. declare module "babylonjs/Shaders/layer.fragment" {
  61627. import "babylonjs/Shaders/ShadersInclude/helperFunctions";
  61628. /** @hidden */
  61629. export var layerPixelShader: {
  61630. name: string;
  61631. shader: string;
  61632. };
  61633. }
  61634. declare module "babylonjs/Shaders/layer.vertex" {
  61635. /** @hidden */
  61636. export var layerVertexShader: {
  61637. name: string;
  61638. shader: string;
  61639. };
  61640. }
  61641. declare module "babylonjs/Layers/layer" {
  61642. import { Observable } from "babylonjs/Misc/observable";
  61643. import { Nullable } from "babylonjs/types";
  61644. import { Scene } from "babylonjs/scene";
  61645. import { Vector2 } from "babylonjs/Maths/math.vector";
  61646. import { Color4 } from "babylonjs/Maths/math.color";
  61647. import { Texture } from "babylonjs/Materials/Textures/texture";
  61648. import { RenderTargetTexture } from "babylonjs/Materials/Textures/renderTargetTexture";
  61649. import "babylonjs/Shaders/layer.fragment";
  61650. import "babylonjs/Shaders/layer.vertex";
  61651. /**
  61652. * This represents a full screen 2d layer.
  61653. * This can be useful to display a picture in the background of your scene for instance.
  61654. * @see https://www.babylonjs-playground.com/#08A2BS#1
  61655. */
  61656. export class Layer {
  61657. /**
  61658. * Define the name of the layer.
  61659. */
  61660. name: string;
  61661. /**
  61662. * Define the texture the layer should display.
  61663. */
  61664. texture: Nullable<Texture>;
  61665. /**
  61666. * Is the layer in background or foreground.
  61667. */
  61668. isBackground: boolean;
  61669. /**
  61670. * Define the color of the layer (instead of texture).
  61671. */
  61672. color: Color4;
  61673. /**
  61674. * Define the scale of the layer in order to zoom in out of the texture.
  61675. */
  61676. scale: Vector2;
  61677. /**
  61678. * Define an offset for the layer in order to shift the texture.
  61679. */
  61680. offset: Vector2;
  61681. /**
  61682. * Define the alpha blending mode used in the layer in case the texture or color has an alpha.
  61683. */
  61684. alphaBlendingMode: number;
  61685. /**
  61686. * Define if the layer should alpha test or alpha blend with the rest of the scene.
  61687. * Alpha test will not mix with the background color in case of transparency.
  61688. * It will either use the texture color or the background depending on the alpha value of the current pixel.
  61689. */
  61690. alphaTest: boolean;
  61691. /**
  61692. * Define a mask to restrict the layer to only some of the scene cameras.
  61693. */
  61694. layerMask: number;
  61695. /**
  61696. * Define the list of render target the layer is visible into.
  61697. */
  61698. renderTargetTextures: RenderTargetTexture[];
  61699. /**
  61700. * Define if the layer is only used in renderTarget or if it also
  61701. * renders in the main frame buffer of the canvas.
  61702. */
  61703. renderOnlyInRenderTargetTextures: boolean;
  61704. private _scene;
  61705. private _vertexBuffers;
  61706. private _indexBuffer;
  61707. private _effect;
  61708. private _previousDefines;
  61709. /**
  61710. * An event triggered when the layer is disposed.
  61711. */
  61712. onDisposeObservable: Observable<Layer>;
  61713. private _onDisposeObserver;
  61714. /**
  61715. * Back compatibility with callback before the onDisposeObservable existed.
  61716. * The set callback will be triggered when the layer has been disposed.
  61717. */
  61718. set onDispose(callback: () => void);
  61719. /**
  61720. * An event triggered before rendering the scene
  61721. */
  61722. onBeforeRenderObservable: Observable<Layer>;
  61723. private _onBeforeRenderObserver;
  61724. /**
  61725. * Back compatibility with callback before the onBeforeRenderObservable existed.
  61726. * The set callback will be triggered just before rendering the layer.
  61727. */
  61728. set onBeforeRender(callback: () => void);
  61729. /**
  61730. * An event triggered after rendering the scene
  61731. */
  61732. onAfterRenderObservable: Observable<Layer>;
  61733. private _onAfterRenderObserver;
  61734. /**
  61735. * Back compatibility with callback before the onAfterRenderObservable existed.
  61736. * The set callback will be triggered just after rendering the layer.
  61737. */
  61738. set onAfterRender(callback: () => void);
  61739. /**
  61740. * Instantiates a new layer.
  61741. * This represents a full screen 2d layer.
  61742. * This can be useful to display a picture in the background of your scene for instance.
  61743. * @see https://www.babylonjs-playground.com/#08A2BS#1
  61744. * @param name Define the name of the layer in the scene
  61745. * @param imgUrl Define the url of the texture to display in the layer
  61746. * @param scene Define the scene the layer belongs to
  61747. * @param isBackground Defines whether the layer is displayed in front or behind the scene
  61748. * @param color Defines a color for the layer
  61749. */
  61750. constructor(
  61751. /**
  61752. * Define the name of the layer.
  61753. */
  61754. name: string, imgUrl: Nullable<string>, scene: Nullable<Scene>, isBackground?: boolean, color?: Color4);
  61755. private _createIndexBuffer;
  61756. /** @hidden */
  61757. _rebuild(): void;
  61758. /**
  61759. * Renders the layer in the scene.
  61760. */
  61761. render(): void;
  61762. /**
  61763. * Disposes and releases the associated ressources.
  61764. */
  61765. dispose(): void;
  61766. }
  61767. }
  61768. declare module "babylonjs/Layers/index" {
  61769. export * from "babylonjs/Layers/effectLayer";
  61770. export * from "babylonjs/Layers/effectLayerSceneComponent";
  61771. export * from "babylonjs/Layers/glowLayer";
  61772. export * from "babylonjs/Layers/highlightLayer";
  61773. export * from "babylonjs/Layers/layer";
  61774. export * from "babylonjs/Layers/layerSceneComponent";
  61775. }
  61776. declare module "babylonjs/Shaders/lensFlare.fragment" {
  61777. /** @hidden */
  61778. export var lensFlarePixelShader: {
  61779. name: string;
  61780. shader: string;
  61781. };
  61782. }
  61783. declare module "babylonjs/Shaders/lensFlare.vertex" {
  61784. /** @hidden */
  61785. export var lensFlareVertexShader: {
  61786. name: string;
  61787. shader: string;
  61788. };
  61789. }
  61790. declare module "babylonjs/LensFlares/lensFlareSystem" {
  61791. import { Scene } from "babylonjs/scene";
  61792. import { Vector3 } from "babylonjs/Maths/math.vector";
  61793. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  61794. import { LensFlare } from "babylonjs/LensFlares/lensFlare";
  61795. import "babylonjs/Shaders/lensFlare.fragment";
  61796. import "babylonjs/Shaders/lensFlare.vertex";
  61797. import { Viewport } from "babylonjs/Maths/math.viewport";
  61798. /**
  61799. * This represents a Lens Flare System or the shiny effect created by the light reflection on the camera lenses.
  61800. * It is usually composed of several `lensFlare`.
  61801. * @see https://doc.babylonjs.com/how_to/how_to_use_lens_flares
  61802. */
  61803. export class LensFlareSystem {
  61804. /**
  61805. * Define the name of the lens flare system
  61806. */
  61807. name: string;
  61808. /**
  61809. * List of lens flares used in this system.
  61810. */
  61811. lensFlares: LensFlare[];
  61812. /**
  61813. * Define a limit from the border the lens flare can be visible.
  61814. */
  61815. borderLimit: number;
  61816. /**
  61817. * Define a viewport border we do not want to see the lens flare in.
  61818. */
  61819. viewportBorder: number;
  61820. /**
  61821. * Define a predicate which could limit the list of meshes able to occlude the effect.
  61822. */
  61823. meshesSelectionPredicate: (mesh: AbstractMesh) => boolean;
  61824. /**
  61825. * Restricts the rendering of the effect to only the camera rendering this layer mask.
  61826. */
  61827. layerMask: number;
  61828. /**
  61829. * Define the id of the lens flare system in the scene.
  61830. * (equal to name by default)
  61831. */
  61832. id: string;
  61833. private _scene;
  61834. private _emitter;
  61835. private _vertexBuffers;
  61836. private _indexBuffer;
  61837. private _effect;
  61838. private _positionX;
  61839. private _positionY;
  61840. private _isEnabled;
  61841. /** @hidden */
  61842. static _SceneComponentInitialization: (scene: Scene) => void;
  61843. /**
  61844. * Instantiates a lens flare system.
  61845. * This represents a Lens Flare System or the shiny effect created by the light reflection on the camera lenses.
  61846. * It is usually composed of several `lensFlare`.
  61847. * @see https://doc.babylonjs.com/how_to/how_to_use_lens_flares
  61848. * @param name Define the name of the lens flare system in the scene
  61849. * @param emitter Define the source (the emitter) of the lens flares (it can be a camera, a light or a mesh).
  61850. * @param scene Define the scene the lens flare system belongs to
  61851. */
  61852. constructor(
  61853. /**
  61854. * Define the name of the lens flare system
  61855. */
  61856. name: string, emitter: any, scene: Scene);
  61857. /**
  61858. * Define if the lens flare system is enabled.
  61859. */
  61860. get isEnabled(): boolean;
  61861. set isEnabled(value: boolean);
  61862. /**
  61863. * Get the scene the effects belongs to.
  61864. * @returns the scene holding the lens flare system
  61865. */
  61866. getScene(): Scene;
  61867. /**
  61868. * Get the emitter of the lens flare system.
  61869. * It defines the source of the lens flares (it can be a camera, a light or a mesh).
  61870. * @returns the emitter of the lens flare system
  61871. */
  61872. getEmitter(): any;
  61873. /**
  61874. * Set the emitter of the lens flare system.
  61875. * It defines the source of the lens flares (it can be a camera, a light or a mesh).
  61876. * @param newEmitter Define the new emitter of the system
  61877. */
  61878. setEmitter(newEmitter: any): void;
  61879. /**
  61880. * Get the lens flare system emitter position.
  61881. * The emitter defines the source of the lens flares (it can be a camera, a light or a mesh).
  61882. * @returns the position
  61883. */
  61884. getEmitterPosition(): Vector3;
  61885. /**
  61886. * @hidden
  61887. */
  61888. computeEffectivePosition(globalViewport: Viewport): boolean;
  61889. /** @hidden */
  61890. _isVisible(): boolean;
  61891. /**
  61892. * @hidden
  61893. */
  61894. render(): boolean;
  61895. /**
  61896. * Dispose and release the lens flare with its associated resources.
  61897. */
  61898. dispose(): void;
  61899. /**
  61900. * Parse a lens flare system from a JSON repressentation
  61901. * @param parsedLensFlareSystem Define the JSON to parse
  61902. * @param scene Define the scene the parsed system should be instantiated in
  61903. * @param rootUrl Define the rootUrl of the load sequence to easily find a load relative dependencies such as textures
  61904. * @returns the parsed system
  61905. */
  61906. static Parse(parsedLensFlareSystem: any, scene: Scene, rootUrl: string): LensFlareSystem;
  61907. /**
  61908. * Serialize the current Lens Flare System into a JSON representation.
  61909. * @returns the serialized JSON
  61910. */
  61911. serialize(): any;
  61912. }
  61913. }
  61914. declare module "babylonjs/LensFlares/lensFlare" {
  61915. import { Nullable } from "babylonjs/types";
  61916. import { Color3 } from "babylonjs/Maths/math.color";
  61917. import { Texture } from "babylonjs/Materials/Textures/texture";
  61918. import { LensFlareSystem } from "babylonjs/LensFlares/lensFlareSystem";
  61919. /**
  61920. * This represents one of the lens effect in a `lensFlareSystem`.
  61921. * It controls one of the indiviual texture used in the effect.
  61922. * @see https://doc.babylonjs.com/how_to/how_to_use_lens_flares
  61923. */
  61924. export class LensFlare {
  61925. /**
  61926. * Define the size of the lens flare in the system (a floating value between 0 and 1)
  61927. */
  61928. size: number;
  61929. /**
  61930. * 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.
  61931. */
  61932. position: number;
  61933. /**
  61934. * Define the lens color.
  61935. */
  61936. color: Color3;
  61937. /**
  61938. * Define the lens texture.
  61939. */
  61940. texture: Nullable<Texture>;
  61941. /**
  61942. * Define the alpha mode to render this particular lens.
  61943. */
  61944. alphaMode: number;
  61945. private _system;
  61946. /**
  61947. * Creates a new Lens Flare.
  61948. * This represents one of the lens effect in a `lensFlareSystem`.
  61949. * It controls one of the indiviual texture used in the effect.
  61950. * @see https://doc.babylonjs.com/how_to/how_to_use_lens_flares
  61951. * @param size Define the size of the lens flare (a floating value between 0 and 1)
  61952. * @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.
  61953. * @param color Define the lens color
  61954. * @param imgUrl Define the lens texture url
  61955. * @param system Define the `lensFlareSystem` this flare is part of
  61956. * @returns The newly created Lens Flare
  61957. */
  61958. static AddFlare(size: number, position: number, color: Color3, imgUrl: string, system: LensFlareSystem): LensFlare;
  61959. /**
  61960. * Instantiates a new Lens Flare.
  61961. * This represents one of the lens effect in a `lensFlareSystem`.
  61962. * It controls one of the indiviual texture used in the effect.
  61963. * @see https://doc.babylonjs.com/how_to/how_to_use_lens_flares
  61964. * @param size Define the size of the lens flare in the system (a floating value between 0 and 1)
  61965. * @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.
  61966. * @param color Define the lens color
  61967. * @param imgUrl Define the lens texture url
  61968. * @param system Define the `lensFlareSystem` this flare is part of
  61969. */
  61970. constructor(
  61971. /**
  61972. * Define the size of the lens flare in the system (a floating value between 0 and 1)
  61973. */
  61974. size: number,
  61975. /**
  61976. * 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.
  61977. */
  61978. position: number, color: Color3, imgUrl: string, system: LensFlareSystem);
  61979. /**
  61980. * Dispose and release the lens flare with its associated resources.
  61981. */
  61982. dispose(): void;
  61983. }
  61984. }
  61985. declare module "babylonjs/LensFlares/lensFlareSystemSceneComponent" {
  61986. import { Nullable } from "babylonjs/types";
  61987. import { Scene } from "babylonjs/scene";
  61988. import { ISceneSerializableComponent } from "babylonjs/sceneComponent";
  61989. import { AbstractScene } from "babylonjs/abstractScene";
  61990. import { LensFlareSystem } from "babylonjs/LensFlares/lensFlareSystem";
  61991. module "babylonjs/abstractScene" {
  61992. interface AbstractScene {
  61993. /**
  61994. * The list of lens flare system added to the scene
  61995. * @see https://doc.babylonjs.com/how_to/how_to_use_lens_flares
  61996. */
  61997. lensFlareSystems: Array<LensFlareSystem>;
  61998. /**
  61999. * Removes the given lens flare system from this scene.
  62000. * @param toRemove The lens flare system to remove
  62001. * @returns The index of the removed lens flare system
  62002. */
  62003. removeLensFlareSystem(toRemove: LensFlareSystem): number;
  62004. /**
  62005. * Adds the given lens flare system to this scene
  62006. * @param newLensFlareSystem The lens flare system to add
  62007. */
  62008. addLensFlareSystem(newLensFlareSystem: LensFlareSystem): void;
  62009. /**
  62010. * Gets a lens flare system using its name
  62011. * @param name defines the name to look for
  62012. * @returns the lens flare system or null if not found
  62013. */
  62014. getLensFlareSystemByName(name: string): Nullable<LensFlareSystem>;
  62015. /**
  62016. * Gets a lens flare system using its id
  62017. * @param id defines the id to look for
  62018. * @returns the lens flare system or null if not found
  62019. */
  62020. getLensFlareSystemByID(id: string): Nullable<LensFlareSystem>;
  62021. }
  62022. }
  62023. /**
  62024. * Defines the lens flare scene component responsible to manage any lens flares
  62025. * in a given scene.
  62026. */
  62027. export class LensFlareSystemSceneComponent implements ISceneSerializableComponent {
  62028. /**
  62029. * The component name helpfull to identify the component in the list of scene components.
  62030. */
  62031. readonly name: string;
  62032. /**
  62033. * The scene the component belongs to.
  62034. */
  62035. scene: Scene;
  62036. /**
  62037. * Creates a new instance of the component for the given scene
  62038. * @param scene Defines the scene to register the component in
  62039. */
  62040. constructor(scene: Scene);
  62041. /**
  62042. * Registers the component in a given scene
  62043. */
  62044. register(): void;
  62045. /**
  62046. * Rebuilds the elements related to this component in case of
  62047. * context lost for instance.
  62048. */
  62049. rebuild(): void;
  62050. /**
  62051. * Adds all the elements from the container to the scene
  62052. * @param container the container holding the elements
  62053. */
  62054. addFromContainer(container: AbstractScene): void;
  62055. /**
  62056. * Removes all the elements in the container from the scene
  62057. * @param container contains the elements to remove
  62058. * @param dispose if the removed element should be disposed (default: false)
  62059. */
  62060. removeFromContainer(container: AbstractScene, dispose?: boolean): void;
  62061. /**
  62062. * Serializes the component data to the specified json object
  62063. * @param serializationObject The object to serialize to
  62064. */
  62065. serialize(serializationObject: any): void;
  62066. /**
  62067. * Disposes the component and the associated ressources.
  62068. */
  62069. dispose(): void;
  62070. private _draw;
  62071. }
  62072. }
  62073. declare module "babylonjs/LensFlares/index" {
  62074. export * from "babylonjs/LensFlares/lensFlare";
  62075. export * from "babylonjs/LensFlares/lensFlareSystem";
  62076. export * from "babylonjs/LensFlares/lensFlareSystemSceneComponent";
  62077. }
  62078. declare module "babylonjs/Shaders/depth.fragment" {
  62079. import "babylonjs/Shaders/ShadersInclude/packingFunctions";
  62080. /** @hidden */
  62081. export var depthPixelShader: {
  62082. name: string;
  62083. shader: string;
  62084. };
  62085. }
  62086. declare module "babylonjs/Shaders/depth.vertex" {
  62087. import "babylonjs/Shaders/ShadersInclude/bonesDeclaration";
  62088. import "babylonjs/Shaders/ShadersInclude/morphTargetsVertexGlobalDeclaration";
  62089. import "babylonjs/Shaders/ShadersInclude/morphTargetsVertexDeclaration";
  62090. import "babylonjs/Shaders/ShadersInclude/instancesDeclaration";
  62091. import "babylonjs/Shaders/ShadersInclude/morphTargetsVertex";
  62092. import "babylonjs/Shaders/ShadersInclude/instancesVertex";
  62093. import "babylonjs/Shaders/ShadersInclude/bonesVertex";
  62094. /** @hidden */
  62095. export var depthVertexShader: {
  62096. name: string;
  62097. shader: string;
  62098. };
  62099. }
  62100. declare module "babylonjs/Rendering/depthRenderer" {
  62101. import { Nullable } from "babylonjs/types";
  62102. import { SubMesh } from "babylonjs/Meshes/subMesh";
  62103. import { Scene } from "babylonjs/scene";
  62104. import { RenderTargetTexture } from "babylonjs/Materials/Textures/renderTargetTexture";
  62105. import { Camera } from "babylonjs/Cameras/camera";
  62106. import "babylonjs/Shaders/depth.fragment";
  62107. import "babylonjs/Shaders/depth.vertex";
  62108. /**
  62109. * This represents a depth renderer in Babylon.
  62110. * A depth renderer will render to it's depth map every frame which can be displayed or used in post processing
  62111. */
  62112. export class DepthRenderer {
  62113. private _scene;
  62114. private _depthMap;
  62115. private _effect;
  62116. private readonly _storeNonLinearDepth;
  62117. private readonly _clearColor;
  62118. /** Get if the depth renderer is using packed depth or not */
  62119. readonly isPacked: boolean;
  62120. private _cachedDefines;
  62121. private _camera;
  62122. /** Enable or disable the depth renderer. When disabled, the depth texture is not updated */
  62123. enabled: boolean;
  62124. /**
  62125. * Specifiess that the depth renderer will only be used within
  62126. * the camera it is created for.
  62127. * This can help forcing its rendering during the camera processing.
  62128. */
  62129. useOnlyInActiveCamera: boolean;
  62130. /** @hidden */
  62131. static _SceneComponentInitialization: (scene: Scene) => void;
  62132. /**
  62133. * Instantiates a depth renderer
  62134. * @param scene The scene the renderer belongs to
  62135. * @param type The texture type of the depth map (default: Engine.TEXTURETYPE_FLOAT)
  62136. * @param camera The camera to be used to render the depth map (default: scene's active camera)
  62137. * @param storeNonLinearDepth Defines whether the depth is stored linearly like in Babylon Shadows or directly like glFragCoord.z
  62138. */
  62139. constructor(scene: Scene, type?: number, camera?: Nullable<Camera>, storeNonLinearDepth?: boolean);
  62140. /**
  62141. * Creates the depth rendering effect and checks if the effect is ready.
  62142. * @param subMesh The submesh to be used to render the depth map of
  62143. * @param useInstances If multiple world instances should be used
  62144. * @returns if the depth renderer is ready to render the depth map
  62145. */
  62146. isReady(subMesh: SubMesh, useInstances: boolean): boolean;
  62147. /**
  62148. * Gets the texture which the depth map will be written to.
  62149. * @returns The depth map texture
  62150. */
  62151. getDepthMap(): RenderTargetTexture;
  62152. /**
  62153. * Disposes of the depth renderer.
  62154. */
  62155. dispose(): void;
  62156. }
  62157. }
  62158. declare module "babylonjs/Shaders/minmaxRedux.fragment" {
  62159. /** @hidden */
  62160. export var minmaxReduxPixelShader: {
  62161. name: string;
  62162. shader: string;
  62163. };
  62164. }
  62165. declare module "babylonjs/Misc/minMaxReducer" {
  62166. import { Nullable } from "babylonjs/types";
  62167. import { RenderTargetTexture } from "babylonjs/Materials/Textures/renderTargetTexture";
  62168. import { Camera } from "babylonjs/Cameras/camera";
  62169. import { Observer } from "babylonjs/Misc/observable";
  62170. import { PostProcess } from "babylonjs/PostProcesses/postProcess";
  62171. import { PostProcessManager } from "babylonjs/PostProcesses/postProcessManager";
  62172. import { Observable } from "babylonjs/Misc/observable";
  62173. import "babylonjs/Shaders/minmaxRedux.fragment";
  62174. /**
  62175. * This class computes a min/max reduction from a texture: it means it computes the minimum
  62176. * and maximum values from all values of the texture.
  62177. * It is performed on the GPU for better performances, thanks to a succession of post processes.
  62178. * The source values are read from the red channel of the texture.
  62179. */
  62180. export class MinMaxReducer {
  62181. /**
  62182. * Observable triggered when the computation has been performed
  62183. */
  62184. onAfterReductionPerformed: Observable<{
  62185. min: number;
  62186. max: number;
  62187. }>;
  62188. protected _camera: Camera;
  62189. protected _sourceTexture: Nullable<RenderTargetTexture>;
  62190. protected _reductionSteps: Nullable<Array<PostProcess>>;
  62191. protected _postProcessManager: PostProcessManager;
  62192. protected _onAfterUnbindObserver: Nullable<Observer<RenderTargetTexture>>;
  62193. protected _forceFullscreenViewport: boolean;
  62194. /**
  62195. * Creates a min/max reducer
  62196. * @param camera The camera to use for the post processes
  62197. */
  62198. constructor(camera: Camera);
  62199. /**
  62200. * Gets the texture used to read the values from.
  62201. */
  62202. get sourceTexture(): Nullable<RenderTargetTexture>;
  62203. /**
  62204. * Sets the source texture to read the values from.
  62205. * One must indicate if the texture is a depth texture or not through the depthRedux parameter
  62206. * because in such textures '1' value must not be taken into account to compute the maximum
  62207. * as this value is used to clear the texture.
  62208. * Note that the computation is not activated by calling this function, you must call activate() for that!
  62209. * @param sourceTexture The texture to read the values from. The values should be in the red channel.
  62210. * @param depthRedux Indicates if the texture is a depth texture or not
  62211. * @param type The type of the textures created for the reduction (defaults to TEXTURETYPE_HALF_FLOAT)
  62212. * @param forceFullscreenViewport Forces the post processes used for the reduction to be applied without taking into account viewport (defaults to true)
  62213. */
  62214. setSourceTexture(sourceTexture: RenderTargetTexture, depthRedux: boolean, type?: number, forceFullscreenViewport?: boolean): void;
  62215. /**
  62216. * Defines the refresh rate of the computation.
  62217. * Use 0 to compute just once, 1 to compute on every frame, 2 to compute every two frames and so on...
  62218. */
  62219. get refreshRate(): number;
  62220. set refreshRate(value: number);
  62221. protected _activated: boolean;
  62222. /**
  62223. * Gets the activation status of the reducer
  62224. */
  62225. get activated(): boolean;
  62226. /**
  62227. * Activates the reduction computation.
  62228. * When activated, the observers registered in onAfterReductionPerformed are
  62229. * called after the compuation is performed
  62230. */
  62231. activate(): void;
  62232. /**
  62233. * Deactivates the reduction computation.
  62234. */
  62235. deactivate(): void;
  62236. /**
  62237. * Disposes the min/max reducer
  62238. * @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.
  62239. */
  62240. dispose(disposeAll?: boolean): void;
  62241. }
  62242. }
  62243. declare module "babylonjs/Misc/depthReducer" {
  62244. import { Nullable } from "babylonjs/types";
  62245. import { RenderTargetTexture } from "babylonjs/Materials/Textures/renderTargetTexture";
  62246. import { Camera } from "babylonjs/Cameras/camera";
  62247. import { DepthRenderer } from "babylonjs/Rendering/depthRenderer";
  62248. import { MinMaxReducer } from "babylonjs/Misc/minMaxReducer";
  62249. /**
  62250. * This class is a small wrapper around the MinMaxReducer class to compute the min/max values of a depth texture
  62251. */
  62252. export class DepthReducer extends MinMaxReducer {
  62253. private _depthRenderer;
  62254. private _depthRendererId;
  62255. /**
  62256. * Gets the depth renderer used for the computation.
  62257. * Note that the result is null if you provide your own renderer when calling setDepthRenderer.
  62258. */
  62259. get depthRenderer(): Nullable<DepthRenderer>;
  62260. /**
  62261. * Creates a depth reducer
  62262. * @param camera The camera used to render the depth texture
  62263. */
  62264. constructor(camera: Camera);
  62265. /**
  62266. * Sets the depth renderer to use to generate the depth map
  62267. * @param depthRenderer The depth renderer to use. If not provided, a new one will be created automatically
  62268. * @param type The texture type of the depth map (default: TEXTURETYPE_HALF_FLOAT)
  62269. * @param forceFullscreenViewport Forces the post processes used for the reduction to be applied without taking into account viewport (defaults to true)
  62270. */
  62271. setDepthRenderer(depthRenderer?: Nullable<DepthRenderer>, type?: number, forceFullscreenViewport?: boolean): void;
  62272. /** @hidden */
  62273. setSourceTexture(sourceTexture: RenderTargetTexture, depthRedux: boolean, type?: number, forceFullscreenViewport?: boolean): void;
  62274. /**
  62275. * Activates the reduction computation.
  62276. * When activated, the observers registered in onAfterReductionPerformed are
  62277. * called after the compuation is performed
  62278. */
  62279. activate(): void;
  62280. /**
  62281. * Deactivates the reduction computation.
  62282. */
  62283. deactivate(): void;
  62284. /**
  62285. * Disposes the depth reducer
  62286. * @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.
  62287. */
  62288. dispose(disposeAll?: boolean): void;
  62289. }
  62290. }
  62291. declare module "babylonjs/Lights/Shadows/cascadedShadowGenerator" {
  62292. import { Nullable } from "babylonjs/types";
  62293. import { Scene } from "babylonjs/scene";
  62294. import { Matrix, Vector3 } from "babylonjs/Maths/math.vector";
  62295. import { SubMesh } from "babylonjs/Meshes/subMesh";
  62296. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  62297. import { Effect } from "babylonjs/Materials/effect";
  62298. import "babylonjs/Shaders/shadowMap.fragment";
  62299. import "babylonjs/Shaders/shadowMap.vertex";
  62300. import "babylonjs/Shaders/depthBoxBlur.fragment";
  62301. import { ShadowGenerator } from "babylonjs/Lights/Shadows/shadowGenerator";
  62302. import { DirectionalLight } from "babylonjs/Lights/directionalLight";
  62303. import { BoundingInfo } from "babylonjs/Culling/boundingInfo";
  62304. import { DepthRenderer } from "babylonjs/Rendering/depthRenderer";
  62305. /**
  62306. * A CSM implementation allowing casting shadows on large scenes.
  62307. * Documentation : https://doc.babylonjs.com/babylon101/cascadedShadows
  62308. * Based on: https://github.com/TheRealMJP/Shadows and https://johanmedestrom.wordpress.com/2016/03/18/opengl-cascaded-shadow-maps/
  62309. */
  62310. export class CascadedShadowGenerator extends ShadowGenerator {
  62311. private static readonly frustumCornersNDCSpace;
  62312. /**
  62313. * Name of the CSM class
  62314. */
  62315. static CLASSNAME: string;
  62316. /**
  62317. * Defines the default number of cascades used by the CSM.
  62318. */
  62319. static readonly DEFAULT_CASCADES_COUNT: number;
  62320. /**
  62321. * Defines the minimum number of cascades used by the CSM.
  62322. */
  62323. static readonly MIN_CASCADES_COUNT: number;
  62324. /**
  62325. * Defines the maximum number of cascades used by the CSM.
  62326. */
  62327. static readonly MAX_CASCADES_COUNT: number;
  62328. protected _validateFilter(filter: number): number;
  62329. /**
  62330. * Gets or sets the actual darkness of the soft shadows while using PCSS filtering (value between 0. and 1.)
  62331. */
  62332. penumbraDarkness: number;
  62333. private _numCascades;
  62334. /**
  62335. * Gets or set the number of cascades used by the CSM.
  62336. */
  62337. get numCascades(): number;
  62338. set numCascades(value: number);
  62339. /**
  62340. * Sets this to true if you want that the edges of the shadows don't "swimm" / "shimmer" when rotating the camera.
  62341. * The trade off is that you lose some precision in the shadow rendering when enabling this setting.
  62342. */
  62343. stabilizeCascades: boolean;
  62344. private _freezeShadowCastersBoundingInfo;
  62345. private _freezeShadowCastersBoundingInfoObservable;
  62346. /**
  62347. * Enables or disables the shadow casters bounding info computation.
  62348. * If your shadow casters don't move, you can disable this feature.
  62349. * If it is enabled, the bounding box computation is done every frame.
  62350. */
  62351. get freezeShadowCastersBoundingInfo(): boolean;
  62352. set freezeShadowCastersBoundingInfo(freeze: boolean);
  62353. private _scbiMin;
  62354. private _scbiMax;
  62355. protected _computeShadowCastersBoundingInfo(): void;
  62356. protected _shadowCastersBoundingInfo: BoundingInfo;
  62357. /**
  62358. * Gets or sets the shadow casters bounding info.
  62359. * If you provide your own shadow casters bounding info, first enable freezeShadowCastersBoundingInfo
  62360. * so that the system won't overwrite the bounds you provide
  62361. */
  62362. get shadowCastersBoundingInfo(): BoundingInfo;
  62363. set shadowCastersBoundingInfo(boundingInfo: BoundingInfo);
  62364. protected _breaksAreDirty: boolean;
  62365. protected _minDistance: number;
  62366. protected _maxDistance: number;
  62367. /**
  62368. * Sets the minimal and maximal distances to use when computing the cascade breaks.
  62369. *
  62370. * The values of min / max are typically the depth zmin and zmax values of your scene, for a given frame.
  62371. * If you don't know these values, simply leave them to their defaults and don't call this function.
  62372. * @param min minimal distance for the breaks (default to 0.)
  62373. * @param max maximal distance for the breaks (default to 1.)
  62374. */
  62375. setMinMaxDistance(min: number, max: number): void;
  62376. /** Gets the minimal distance used in the cascade break computation */
  62377. get minDistance(): number;
  62378. /** Gets the maximal distance used in the cascade break computation */
  62379. get maxDistance(): number;
  62380. /**
  62381. * Gets the class name of that object
  62382. * @returns "CascadedShadowGenerator"
  62383. */
  62384. getClassName(): string;
  62385. private _cascadeMinExtents;
  62386. private _cascadeMaxExtents;
  62387. /**
  62388. * Gets a cascade minimum extents
  62389. * @param cascadeIndex index of the cascade
  62390. * @returns the minimum cascade extents
  62391. */
  62392. getCascadeMinExtents(cascadeIndex: number): Nullable<Vector3>;
  62393. /**
  62394. * Gets a cascade maximum extents
  62395. * @param cascadeIndex index of the cascade
  62396. * @returns the maximum cascade extents
  62397. */
  62398. getCascadeMaxExtents(cascadeIndex: number): Nullable<Vector3>;
  62399. private _cascades;
  62400. private _currentLayer;
  62401. private _viewSpaceFrustumsZ;
  62402. private _viewMatrices;
  62403. private _projectionMatrices;
  62404. private _transformMatrices;
  62405. private _transformMatricesAsArray;
  62406. private _frustumLengths;
  62407. private _lightSizeUVCorrection;
  62408. private _depthCorrection;
  62409. private _frustumCornersWorldSpace;
  62410. private _frustumCenter;
  62411. private _shadowCameraPos;
  62412. private _shadowMaxZ;
  62413. /**
  62414. * Gets the shadow max z distance. It's the limit beyond which shadows are not displayed.
  62415. * It defaults to camera.maxZ
  62416. */
  62417. get shadowMaxZ(): number;
  62418. /**
  62419. * Sets the shadow max z distance.
  62420. */
  62421. set shadowMaxZ(value: number);
  62422. protected _debug: boolean;
  62423. /**
  62424. * Gets or sets the debug flag.
  62425. * When enabled, the cascades are materialized by different colors on the screen.
  62426. */
  62427. get debug(): boolean;
  62428. set debug(dbg: boolean);
  62429. private _depthClamp;
  62430. /**
  62431. * Gets or sets the depth clamping value.
  62432. *
  62433. * When enabled, it improves the shadow quality because the near z plane of the light frustum don't need to be adjusted
  62434. * to account for the shadow casters far away.
  62435. *
  62436. * Note that this property is incompatible with PCSS filtering, so it won't be used in that case.
  62437. */
  62438. get depthClamp(): boolean;
  62439. set depthClamp(value: boolean);
  62440. private _cascadeBlendPercentage;
  62441. /**
  62442. * Gets or sets the percentage of blending between two cascades (value between 0. and 1.).
  62443. * It defaults to 0.1 (10% blending).
  62444. */
  62445. get cascadeBlendPercentage(): number;
  62446. set cascadeBlendPercentage(value: number);
  62447. private _lambda;
  62448. /**
  62449. * Gets or set the lambda parameter.
  62450. * This parameter is used to split the camera frustum and create the cascades.
  62451. * 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.
  62452. * For all values in-between, it's a linear combination of the uniform and logarithm split algorithm.
  62453. */
  62454. get lambda(): number;
  62455. set lambda(value: number);
  62456. /**
  62457. * Gets the view matrix corresponding to a given cascade
  62458. * @param cascadeNum cascade to retrieve the view matrix from
  62459. * @returns the cascade view matrix
  62460. */
  62461. getCascadeViewMatrix(cascadeNum: number): Nullable<Matrix>;
  62462. /**
  62463. * Gets the projection matrix corresponding to a given cascade
  62464. * @param cascadeNum cascade to retrieve the projection matrix from
  62465. * @returns the cascade projection matrix
  62466. */
  62467. getCascadeProjectionMatrix(cascadeNum: number): Nullable<Matrix>;
  62468. /**
  62469. * Gets the transformation matrix corresponding to a given cascade
  62470. * @param cascadeNum cascade to retrieve the transformation matrix from
  62471. * @returns the cascade transformation matrix
  62472. */
  62473. getCascadeTransformMatrix(cascadeNum: number): Nullable<Matrix>;
  62474. private _depthRenderer;
  62475. /**
  62476. * Sets the depth renderer to use when autoCalcDepthBounds is enabled.
  62477. *
  62478. * Note that if no depth renderer is set, a new one will be automatically created internally when necessary.
  62479. *
  62480. * You should call this function if you already have a depth renderer enabled in your scene, to avoid
  62481. * doing multiple depth rendering each frame. If you provide your own depth renderer, make sure it stores linear depth!
  62482. * @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
  62483. */
  62484. setDepthRenderer(depthRenderer: Nullable<DepthRenderer>): void;
  62485. private _depthReducer;
  62486. private _autoCalcDepthBounds;
  62487. /**
  62488. * Gets or sets the autoCalcDepthBounds property.
  62489. *
  62490. * When enabled, a depth rendering pass is first performed (with an internally created depth renderer or with the one
  62491. * you provide by calling setDepthRenderer). Then, a min/max reducing is applied on the depth map to compute the
  62492. * minimal and maximal depth of the map and those values are used as inputs for the setMinMaxDistance() function.
  62493. * It can greatly enhance the shadow quality, at the expense of more GPU works.
  62494. * When using this option, you should increase the value of the lambda parameter, and even set it to 1 for best results.
  62495. */
  62496. get autoCalcDepthBounds(): boolean;
  62497. set autoCalcDepthBounds(value: boolean);
  62498. /**
  62499. * Defines the refresh rate of the min/max computation used when autoCalcDepthBounds is set to true
  62500. * Use 0 to compute just once, 1 to compute on every frame, 2 to compute every two frames and so on...
  62501. * Note that if you provided your own depth renderer through a call to setDepthRenderer, you are responsible
  62502. * for setting the refresh rate on the renderer yourself!
  62503. */
  62504. get autoCalcDepthBoundsRefreshRate(): number;
  62505. set autoCalcDepthBoundsRefreshRate(value: number);
  62506. /**
  62507. * Create the cascade breaks according to the lambda, shadowMaxZ and min/max distance properties, as well as the camera near and far planes.
  62508. * This function is automatically called when updating lambda, shadowMaxZ and min/max distances, however you should call it yourself if
  62509. * you change the camera near/far planes!
  62510. */
  62511. splitFrustum(): void;
  62512. private _splitFrustum;
  62513. private _computeMatrices;
  62514. private _computeFrustumInWorldSpace;
  62515. private _computeCascadeFrustum;
  62516. /**
  62517. * Support test.
  62518. */
  62519. static get IsSupported(): boolean;
  62520. /** @hidden */
  62521. static _SceneComponentInitialization: (scene: Scene) => void;
  62522. /**
  62523. * Creates a Cascaded Shadow Generator object.
  62524. * A ShadowGenerator is the required tool to use the shadows.
  62525. * Each directional light casting shadows needs to use its own ShadowGenerator.
  62526. * Documentation : https://doc.babylonjs.com/babylon101/cascadedShadows
  62527. * @param mapSize The size of the texture what stores the shadows. Example : 1024.
  62528. * @param light The directional light object generating the shadows.
  62529. * @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.
  62530. */
  62531. constructor(mapSize: number, light: DirectionalLight, usefulFloatFirst?: boolean);
  62532. protected _initializeGenerator(): void;
  62533. protected _createTargetRenderTexture(): void;
  62534. protected _initializeShadowMap(): void;
  62535. protected _bindCustomEffectForRenderSubMeshForShadowMap(subMesh: SubMesh, effect: Effect, matriceNames: any, mesh: AbstractMesh): void;
  62536. protected _isReadyCustomDefines(defines: any, subMesh: SubMesh, useInstances: boolean): void;
  62537. /**
  62538. * Prepare all the defines in a material relying on a shadow map at the specified light index.
  62539. * @param defines Defines of the material we want to update
  62540. * @param lightIndex Index of the light in the enabled light list of the material
  62541. */
  62542. prepareDefines(defines: any, lightIndex: number): void;
  62543. /**
  62544. * Binds the shadow related information inside of an effect (information like near, far, darkness...
  62545. * defined in the generator but impacting the effect).
  62546. * @param lightIndex Index of the light in the enabled light list of the material owning the effect
  62547. * @param effect The effect we are binfing the information for
  62548. */
  62549. bindShadowLight(lightIndex: string, effect: Effect): void;
  62550. /**
  62551. * Gets the transformation matrix of the first cascade used to project the meshes into the map from the light point of view.
  62552. * (eq to view projection * shadow projection matrices)
  62553. * @returns The transform matrix used to create the shadow map
  62554. */
  62555. getTransformMatrix(): Matrix;
  62556. /**
  62557. * Disposes the ShadowGenerator.
  62558. * Returns nothing.
  62559. */
  62560. dispose(): void;
  62561. /**
  62562. * Serializes the shadow generator setup to a json object.
  62563. * @returns The serialized JSON object
  62564. */
  62565. serialize(): any;
  62566. /**
  62567. * Parses a serialized ShadowGenerator and returns a new ShadowGenerator.
  62568. * @param parsedShadowGenerator The JSON object to parse
  62569. * @param scene The scene to create the shadow map for
  62570. * @returns The parsed shadow generator
  62571. */
  62572. static Parse(parsedShadowGenerator: any, scene: Scene): ShadowGenerator;
  62573. }
  62574. }
  62575. declare module "babylonjs/Lights/Shadows/shadowGeneratorSceneComponent" {
  62576. import { Scene } from "babylonjs/scene";
  62577. import { ISceneSerializableComponent } from "babylonjs/sceneComponent";
  62578. import { AbstractScene } from "babylonjs/abstractScene";
  62579. /**
  62580. * Defines the shadow generator component responsible to manage any shadow generators
  62581. * in a given scene.
  62582. */
  62583. export class ShadowGeneratorSceneComponent implements ISceneSerializableComponent {
  62584. /**
  62585. * The component name helpfull to identify the component in the list of scene components.
  62586. */
  62587. readonly name: string;
  62588. /**
  62589. * The scene the component belongs to.
  62590. */
  62591. scene: Scene;
  62592. /**
  62593. * Creates a new instance of the component for the given scene
  62594. * @param scene Defines the scene to register the component in
  62595. */
  62596. constructor(scene: Scene);
  62597. /**
  62598. * Registers the component in a given scene
  62599. */
  62600. register(): void;
  62601. /**
  62602. * Rebuilds the elements related to this component in case of
  62603. * context lost for instance.
  62604. */
  62605. rebuild(): void;
  62606. /**
  62607. * Serializes the component data to the specified json object
  62608. * @param serializationObject The object to serialize to
  62609. */
  62610. serialize(serializationObject: any): void;
  62611. /**
  62612. * Adds all the elements from the container to the scene
  62613. * @param container the container holding the elements
  62614. */
  62615. addFromContainer(container: AbstractScene): void;
  62616. /**
  62617. * Removes all the elements in the container from the scene
  62618. * @param container contains the elements to remove
  62619. * @param dispose if the removed element should be disposed (default: false)
  62620. */
  62621. removeFromContainer(container: AbstractScene, dispose?: boolean): void;
  62622. /**
  62623. * Rebuilds the elements related to this component in case of
  62624. * context lost for instance.
  62625. */
  62626. dispose(): void;
  62627. private _gatherRenderTargets;
  62628. }
  62629. }
  62630. declare module "babylonjs/Lights/Shadows/index" {
  62631. export * from "babylonjs/Lights/Shadows/shadowGenerator";
  62632. export * from "babylonjs/Lights/Shadows/cascadedShadowGenerator";
  62633. export * from "babylonjs/Lights/Shadows/shadowGeneratorSceneComponent";
  62634. }
  62635. declare module "babylonjs/Lights/pointLight" {
  62636. import { Scene } from "babylonjs/scene";
  62637. import { Matrix, Vector3 } from "babylonjs/Maths/math.vector";
  62638. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  62639. import { ShadowLight } from "babylonjs/Lights/shadowLight";
  62640. import { Effect } from "babylonjs/Materials/effect";
  62641. /**
  62642. * A point light is a light defined by an unique point in world space.
  62643. * The light is emitted in every direction from this point.
  62644. * A good example of a point light is a standard light bulb.
  62645. * Documentation: https://doc.babylonjs.com/babylon101/lights
  62646. */
  62647. export class PointLight extends ShadowLight {
  62648. private _shadowAngle;
  62649. /**
  62650. * Getter: In case of direction provided, the shadow will not use a cube texture but simulate a spot shadow as a fallback
  62651. * This specifies what angle the shadow will use to be created.
  62652. *
  62653. * It default to 90 degrees to work nicely with the cube texture generation for point lights shadow maps.
  62654. */
  62655. get shadowAngle(): number;
  62656. /**
  62657. * Setter: In case of direction provided, the shadow will not use a cube texture but simulate a spot shadow as a fallback
  62658. * This specifies what angle the shadow will use to be created.
  62659. *
  62660. * It default to 90 degrees to work nicely with the cube texture generation for point lights shadow maps.
  62661. */
  62662. set shadowAngle(value: number);
  62663. /**
  62664. * Gets the direction if it has been set.
  62665. * In case of direction provided, the shadow will not use a cube texture but simulate a spot shadow as a fallback
  62666. */
  62667. get direction(): Vector3;
  62668. /**
  62669. * In case of direction provided, the shadow will not use a cube texture but simulate a spot shadow as a fallback
  62670. */
  62671. set direction(value: Vector3);
  62672. /**
  62673. * Creates a PointLight object from the passed name and position (Vector3) and adds it in the scene.
  62674. * A PointLight emits the light in every direction.
  62675. * It can cast shadows.
  62676. * If the scene camera is already defined and you want to set your PointLight at the camera position, just set it :
  62677. * ```javascript
  62678. * var pointLight = new PointLight("pl", camera.position, scene);
  62679. * ```
  62680. * Documentation : https://doc.babylonjs.com/babylon101/lights
  62681. * @param name The light friendly name
  62682. * @param position The position of the point light in the scene
  62683. * @param scene The scene the lights belongs to
  62684. */
  62685. constructor(name: string, position: Vector3, scene: Scene);
  62686. /**
  62687. * Returns the string "PointLight"
  62688. * @returns the class name
  62689. */
  62690. getClassName(): string;
  62691. /**
  62692. * Returns the integer 0.
  62693. * @returns The light Type id as a constant defines in Light.LIGHTTYPEID_x
  62694. */
  62695. getTypeID(): number;
  62696. /**
  62697. * Specifies wether or not the shadowmap should be a cube texture.
  62698. * @returns true if the shadowmap needs to be a cube texture.
  62699. */
  62700. needCube(): boolean;
  62701. /**
  62702. * Returns a new Vector3 aligned with the PointLight cube system according to the passed cube face index (integer).
  62703. * @param faceIndex The index of the face we are computed the direction to generate shadow
  62704. * @returns The set direction in 2d mode otherwise the direction to the cubemap face if needCube() is true
  62705. */
  62706. getShadowDirection(faceIndex?: number): Vector3;
  62707. /**
  62708. * Sets the passed matrix "matrix" as a left-handed perspective projection matrix with the following settings :
  62709. * - fov = PI / 2
  62710. * - aspect ratio : 1.0
  62711. * - z-near and far equal to the active camera minZ and maxZ.
  62712. * Returns the PointLight.
  62713. */
  62714. protected _setDefaultShadowProjectionMatrix(matrix: Matrix, viewMatrix: Matrix, renderList: Array<AbstractMesh>): void;
  62715. protected _buildUniformLayout(): void;
  62716. /**
  62717. * Sets the passed Effect "effect" with the PointLight transformed position (or position, if none) and passed name (string).
  62718. * @param effect The effect to update
  62719. * @param lightIndex The index of the light in the effect to update
  62720. * @returns The point light
  62721. */
  62722. transferToEffect(effect: Effect, lightIndex: string): PointLight;
  62723. transferToNodeMaterialEffect(effect: Effect, lightDataUniformName: string): this;
  62724. /**
  62725. * Prepares the list of defines specific to the light type.
  62726. * @param defines the list of defines
  62727. * @param lightIndex defines the index of the light for the effect
  62728. */
  62729. prepareLightSpecificDefines(defines: any, lightIndex: number): void;
  62730. }
  62731. }
  62732. declare module "babylonjs/Lights/index" {
  62733. export * from "babylonjs/Lights/light";
  62734. export * from "babylonjs/Lights/shadowLight";
  62735. export * from "babylonjs/Lights/Shadows/index";
  62736. export * from "babylonjs/Lights/directionalLight";
  62737. export * from "babylonjs/Lights/hemisphericLight";
  62738. export * from "babylonjs/Lights/pointLight";
  62739. export * from "babylonjs/Lights/spotLight";
  62740. }
  62741. declare module "babylonjs/Misc/HighDynamicRange/hdr" {
  62742. import { CubeMapInfo } from "babylonjs/Misc/HighDynamicRange/panoramaToCubemap";
  62743. /**
  62744. * Header information of HDR texture files.
  62745. */
  62746. export interface HDRInfo {
  62747. /**
  62748. * The height of the texture in pixels.
  62749. */
  62750. height: number;
  62751. /**
  62752. * The width of the texture in pixels.
  62753. */
  62754. width: number;
  62755. /**
  62756. * The index of the beginning of the data in the binary file.
  62757. */
  62758. dataPosition: number;
  62759. }
  62760. /**
  62761. * This groups tools to convert HDR texture to native colors array.
  62762. */
  62763. export class HDRTools {
  62764. private static Ldexp;
  62765. private static Rgbe2float;
  62766. private static readStringLine;
  62767. /**
  62768. * Reads header information from an RGBE texture stored in a native array.
  62769. * More information on this format are available here:
  62770. * https://en.wikipedia.org/wiki/RGBE_image_format
  62771. *
  62772. * @param uint8array The binary file stored in native array.
  62773. * @return The header information.
  62774. */
  62775. static RGBE_ReadHeader(uint8array: Uint8Array): HDRInfo;
  62776. /**
  62777. * Returns the cubemap information (each faces texture data) extracted from an RGBE texture.
  62778. * This RGBE texture needs to store the information as a panorama.
  62779. *
  62780. * More information on this format are available here:
  62781. * https://en.wikipedia.org/wiki/RGBE_image_format
  62782. *
  62783. * @param buffer The binary file stored in an array buffer.
  62784. * @param size The expected size of the extracted cubemap.
  62785. * @return The Cube Map information.
  62786. */
  62787. static GetCubeMapTextureData(buffer: ArrayBuffer, size: number): CubeMapInfo;
  62788. /**
  62789. * Returns the pixels data extracted from an RGBE texture.
  62790. * This pixels will be stored left to right up to down in the R G B order in one array.
  62791. *
  62792. * More information on this format are available here:
  62793. * https://en.wikipedia.org/wiki/RGBE_image_format
  62794. *
  62795. * @param uint8array The binary file stored in an array buffer.
  62796. * @param hdrInfo The header information of the file.
  62797. * @return The pixels data in RGB right to left up to down order.
  62798. */
  62799. static RGBE_ReadPixels(uint8array: Uint8Array, hdrInfo: HDRInfo): Float32Array;
  62800. private static RGBE_ReadPixels_RLE;
  62801. private static RGBE_ReadPixels_NOT_RLE;
  62802. }
  62803. }
  62804. declare module "babylonjs/Materials/effectRenderer" {
  62805. import { Nullable } from "babylonjs/types";
  62806. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  62807. import { RenderTargetTexture } from "babylonjs/Materials/Textures/renderTargetTexture";
  62808. import { ThinEngine } from "babylonjs/Engines/thinEngine";
  62809. import { Viewport } from "babylonjs/Maths/math.viewport";
  62810. import { Observable } from "babylonjs/Misc/observable";
  62811. import { Effect } from "babylonjs/Materials/effect";
  62812. import "babylonjs/Shaders/postprocess.vertex";
  62813. /**
  62814. * Effect Render Options
  62815. */
  62816. export interface IEffectRendererOptions {
  62817. /**
  62818. * Defines the vertices positions.
  62819. */
  62820. positions?: number[];
  62821. /**
  62822. * Defines the indices.
  62823. */
  62824. indices?: number[];
  62825. }
  62826. /**
  62827. * Helper class to render one or more effects.
  62828. * You can access the previous rendering in your shader by declaring a sampler named textureSampler
  62829. */
  62830. export class EffectRenderer {
  62831. private engine;
  62832. private static _DefaultOptions;
  62833. private _vertexBuffers;
  62834. private _indexBuffer;
  62835. private _fullscreenViewport;
  62836. /**
  62837. * Creates an effect renderer
  62838. * @param engine the engine to use for rendering
  62839. * @param options defines the options of the effect renderer
  62840. */
  62841. constructor(engine: ThinEngine, options?: IEffectRendererOptions);
  62842. /**
  62843. * Sets the current viewport in normalized coordinates 0-1
  62844. * @param viewport Defines the viewport to set (defaults to 0 0 1 1)
  62845. */
  62846. setViewport(viewport?: Viewport): void;
  62847. /**
  62848. * Binds the embedded attributes buffer to the effect.
  62849. * @param effect Defines the effect to bind the attributes for
  62850. */
  62851. bindBuffers(effect: Effect): void;
  62852. /**
  62853. * Sets the current effect wrapper to use during draw.
  62854. * The effect needs to be ready before calling this api.
  62855. * This also sets the default full screen position attribute.
  62856. * @param effectWrapper Defines the effect to draw with
  62857. */
  62858. applyEffectWrapper(effectWrapper: EffectWrapper): void;
  62859. /**
  62860. * Restores engine states
  62861. */
  62862. restoreStates(): void;
  62863. /**
  62864. * Draws a full screen quad.
  62865. */
  62866. draw(): void;
  62867. private isRenderTargetTexture;
  62868. /**
  62869. * renders one or more effects to a specified texture
  62870. * @param effectWrapper the effect to renderer
  62871. * @param outputTexture texture to draw to, if null it will render to the screen.
  62872. */
  62873. render(effectWrapper: EffectWrapper, outputTexture?: Nullable<InternalTexture | RenderTargetTexture>): void;
  62874. /**
  62875. * Disposes of the effect renderer
  62876. */
  62877. dispose(): void;
  62878. }
  62879. /**
  62880. * Options to create an EffectWrapper
  62881. */
  62882. interface EffectWrapperCreationOptions {
  62883. /**
  62884. * Engine to use to create the effect
  62885. */
  62886. engine: ThinEngine;
  62887. /**
  62888. * Fragment shader for the effect
  62889. */
  62890. fragmentShader: string;
  62891. /**
  62892. * Use the shader store instead of direct source code
  62893. */
  62894. useShaderStore?: boolean;
  62895. /**
  62896. * Vertex shader for the effect
  62897. */
  62898. vertexShader?: string;
  62899. /**
  62900. * Attributes to use in the shader
  62901. */
  62902. attributeNames?: Array<string>;
  62903. /**
  62904. * Uniforms to use in the shader
  62905. */
  62906. uniformNames?: Array<string>;
  62907. /**
  62908. * Texture sampler names to use in the shader
  62909. */
  62910. samplerNames?: Array<string>;
  62911. /**
  62912. * Defines to use in the shader
  62913. */
  62914. defines?: Array<string>;
  62915. /**
  62916. * Callback when effect is compiled
  62917. */
  62918. onCompiled?: Nullable<(effect: Effect) => void>;
  62919. /**
  62920. * The friendly name of the effect displayed in Spector.
  62921. */
  62922. name?: string;
  62923. }
  62924. /**
  62925. * Wraps an effect to be used for rendering
  62926. */
  62927. export class EffectWrapper {
  62928. /**
  62929. * Event that is fired right before the effect is drawn (should be used to update uniforms)
  62930. */
  62931. onApplyObservable: Observable<{}>;
  62932. /**
  62933. * The underlying effect
  62934. */
  62935. effect: Effect;
  62936. /**
  62937. * Creates an effect to be renderer
  62938. * @param creationOptions options to create the effect
  62939. */
  62940. constructor(creationOptions: EffectWrapperCreationOptions);
  62941. /**
  62942. * Disposes of the effect wrapper
  62943. */
  62944. dispose(): void;
  62945. }
  62946. }
  62947. declare module "babylonjs/Shaders/hdrFiltering.vertex" {
  62948. /** @hidden */
  62949. export var hdrFilteringVertexShader: {
  62950. name: string;
  62951. shader: string;
  62952. };
  62953. }
  62954. declare module "babylonjs/Shaders/hdrFiltering.fragment" {
  62955. import "babylonjs/Shaders/ShadersInclude/helperFunctions";
  62956. import "babylonjs/Shaders/ShadersInclude/importanceSampling";
  62957. import "babylonjs/Shaders/ShadersInclude/pbrBRDFFunctions";
  62958. import "babylonjs/Shaders/ShadersInclude/hdrFilteringFunctions";
  62959. /** @hidden */
  62960. export var hdrFilteringPixelShader: {
  62961. name: string;
  62962. shader: string;
  62963. };
  62964. }
  62965. declare module "babylonjs/Materials/Textures/Filtering/hdrFiltering" {
  62966. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  62967. import { ThinEngine } from "babylonjs/Engines/thinEngine";
  62968. import { Nullable } from "babylonjs/types";
  62969. import "babylonjs/Shaders/hdrFiltering.vertex";
  62970. import "babylonjs/Shaders/hdrFiltering.fragment";
  62971. /**
  62972. * Options for texture filtering
  62973. */
  62974. interface IHDRFilteringOptions {
  62975. /**
  62976. * Scales pixel intensity for the input HDR map.
  62977. */
  62978. hdrScale?: number;
  62979. /**
  62980. * Quality of the filter. Should be `Constants.TEXTURE_FILTERING_QUALITY_OFFLINE` for prefiltering
  62981. */
  62982. quality?: number;
  62983. }
  62984. /**
  62985. * Filters HDR maps to get correct renderings of PBR reflections
  62986. */
  62987. export class HDRFiltering {
  62988. private _engine;
  62989. private _effectRenderer;
  62990. private _effectWrapper;
  62991. private _lodGenerationOffset;
  62992. private _lodGenerationScale;
  62993. /**
  62994. * Quality switch for prefiltering. Should be set to `Constants.TEXTURE_FILTERING_QUALITY_OFFLINE` unless
  62995. * you care about baking speed.
  62996. */
  62997. quality: number;
  62998. /**
  62999. * Scales pixel intensity for the input HDR map.
  63000. */
  63001. hdrScale: number;
  63002. /**
  63003. * Instantiates HDR filter for reflection maps
  63004. *
  63005. * @param engine Thin engine
  63006. * @param options Options
  63007. */
  63008. constructor(engine: ThinEngine, options?: IHDRFilteringOptions);
  63009. private _createRenderTarget;
  63010. private _prefilterInternal;
  63011. private _createEffect;
  63012. /**
  63013. * Get a value indicating if the filter is ready to be used
  63014. * @param texture Texture to filter
  63015. * @returns true if the filter is ready
  63016. */
  63017. isReady(texture: BaseTexture): boolean;
  63018. /**
  63019. * Prefilters a cube texture to have mipmap levels representing roughness values.
  63020. * Prefiltering will be invoked at the end of next rendering pass.
  63021. * This has to be done once the map is loaded, and has not been prefiltered by a third party software.
  63022. * See http://blog.selfshadow.com/publications/s2013-shading-course/karis/s2013_pbs_epic_notes_v2.pdf for more information
  63023. * @param texture Texture to filter
  63024. * @param onFinished Callback when filtering is done
  63025. * @return Promise called when prefiltering is done
  63026. */
  63027. prefilter(texture: BaseTexture, onFinished?: Nullable<() => void>): Promise<unknown> | undefined;
  63028. }
  63029. }
  63030. declare module "babylonjs/Materials/Textures/hdrCubeTexture" {
  63031. import { Nullable } from "babylonjs/types";
  63032. import { Scene } from "babylonjs/scene";
  63033. import { Matrix, Vector3 } from "babylonjs/Maths/math.vector";
  63034. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  63035. import { ThinEngine } from "babylonjs/Engines/thinEngine";
  63036. import "babylonjs/Engines/Extensions/engine.rawTexture";
  63037. import "babylonjs/Materials/Textures/baseTexture.polynomial";
  63038. /**
  63039. * This represents a texture coming from an HDR input.
  63040. *
  63041. * The only supported format is currently panorama picture stored in RGBE format.
  63042. * Example of such files can be found on HDRLib: http://hdrlib.com/
  63043. */
  63044. export class HDRCubeTexture extends BaseTexture {
  63045. private static _facesMapping;
  63046. private _generateHarmonics;
  63047. private _noMipmap;
  63048. private _prefilterOnLoad;
  63049. private _textureMatrix;
  63050. private _size;
  63051. private _onLoad;
  63052. private _onError;
  63053. /**
  63054. * The texture URL.
  63055. */
  63056. url: string;
  63057. protected _isBlocking: boolean;
  63058. /**
  63059. * Sets wether or not the texture is blocking during loading.
  63060. */
  63061. set isBlocking(value: boolean);
  63062. /**
  63063. * Gets wether or not the texture is blocking during loading.
  63064. */
  63065. get isBlocking(): boolean;
  63066. protected _rotationY: number;
  63067. /**
  63068. * Sets texture matrix rotation angle around Y axis in radians.
  63069. */
  63070. set rotationY(value: number);
  63071. /**
  63072. * Gets texture matrix rotation angle around Y axis radians.
  63073. */
  63074. get rotationY(): number;
  63075. /**
  63076. * Gets or sets the center of the bounding box associated with the cube texture
  63077. * It must define where the camera used to render the texture was set
  63078. */
  63079. boundingBoxPosition: Vector3;
  63080. private _boundingBoxSize;
  63081. /**
  63082. * Gets or sets the size of the bounding box associated with the cube texture
  63083. * When defined, the cubemap will switch to local mode
  63084. * @see https://community.arm.com/graphics/b/blog/posts/reflections-based-on-local-cubemaps-in-unity
  63085. * @example https://www.babylonjs-playground.com/#RNASML
  63086. */
  63087. set boundingBoxSize(value: Vector3);
  63088. get boundingBoxSize(): Vector3;
  63089. /**
  63090. * Instantiates an HDRTexture from the following parameters.
  63091. *
  63092. * @param url The location of the HDR raw data (Panorama stored in RGBE format)
  63093. * @param sceneOrEngine The scene or engine the texture will be used in
  63094. * @param size The cubemap desired size (the more it increases the longer the generation will be)
  63095. * @param noMipmap Forces to not generate the mipmap if true
  63096. * @param generateHarmonics Specifies whether you want to extract the polynomial harmonics during the generation process
  63097. * @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)
  63098. * @param prefilterOnLoad Prefilters HDR texture to allow use of this texture as a PBR reflection texture.
  63099. */
  63100. 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>);
  63101. /**
  63102. * Get the current class name of the texture useful for serialization or dynamic coding.
  63103. * @returns "HDRCubeTexture"
  63104. */
  63105. getClassName(): string;
  63106. /**
  63107. * Occurs when the file is raw .hdr file.
  63108. */
  63109. private loadTexture;
  63110. clone(): HDRCubeTexture;
  63111. delayLoad(): void;
  63112. /**
  63113. * Get the texture reflection matrix used to rotate/transform the reflection.
  63114. * @returns the reflection matrix
  63115. */
  63116. getReflectionTextureMatrix(): Matrix;
  63117. /**
  63118. * Set the texture reflection matrix used to rotate/transform the reflection.
  63119. * @param value Define the reflection matrix to set
  63120. */
  63121. setReflectionTextureMatrix(value: Matrix): void;
  63122. /**
  63123. * Parses a JSON representation of an HDR Texture in order to create the texture
  63124. * @param parsedTexture Define the JSON representation
  63125. * @param scene Define the scene the texture should be created in
  63126. * @param rootUrl Define the root url in case we need to load relative dependencies
  63127. * @returns the newly created texture after parsing
  63128. */
  63129. static Parse(parsedTexture: any, scene: Scene, rootUrl: string): Nullable<HDRCubeTexture>;
  63130. serialize(): any;
  63131. }
  63132. }
  63133. declare module "babylonjs/Physics/physicsEngine" {
  63134. import { Nullable } from "babylonjs/types";
  63135. import { Vector3 } from "babylonjs/Maths/math.vector";
  63136. import { IPhysicsEngine, IPhysicsEnginePlugin } from "babylonjs/Physics/IPhysicsEngine";
  63137. import { PhysicsImpostor, IPhysicsEnabledObject } from "babylonjs/Physics/physicsImpostor";
  63138. import { PhysicsJoint } from "babylonjs/Physics/physicsJoint";
  63139. import { PhysicsRaycastResult } from "babylonjs/Physics/physicsRaycastResult";
  63140. /**
  63141. * Class used to control physics engine
  63142. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  63143. */
  63144. export class PhysicsEngine implements IPhysicsEngine {
  63145. private _physicsPlugin;
  63146. /**
  63147. * Global value used to control the smallest number supported by the simulation
  63148. */
  63149. static Epsilon: number;
  63150. private _impostors;
  63151. private _joints;
  63152. private _subTimeStep;
  63153. /**
  63154. * Gets the gravity vector used by the simulation
  63155. */
  63156. gravity: Vector3;
  63157. /**
  63158. * Factory used to create the default physics plugin.
  63159. * @returns The default physics plugin
  63160. */
  63161. static DefaultPluginFactory(): IPhysicsEnginePlugin;
  63162. /**
  63163. * Creates a new Physics Engine
  63164. * @param gravity defines the gravity vector used by the simulation
  63165. * @param _physicsPlugin defines the plugin to use (CannonJS by default)
  63166. */
  63167. constructor(gravity: Nullable<Vector3>, _physicsPlugin?: IPhysicsEnginePlugin);
  63168. /**
  63169. * Sets the gravity vector used by the simulation
  63170. * @param gravity defines the gravity vector to use
  63171. */
  63172. setGravity(gravity: Vector3): void;
  63173. /**
  63174. * Set the time step of the physics engine.
  63175. * Default is 1/60.
  63176. * To slow it down, enter 1/600 for example.
  63177. * To speed it up, 1/30
  63178. * @param newTimeStep defines the new timestep to apply to this world.
  63179. */
  63180. setTimeStep(newTimeStep?: number): void;
  63181. /**
  63182. * Get the time step of the physics engine.
  63183. * @returns the current time step
  63184. */
  63185. getTimeStep(): number;
  63186. /**
  63187. * Set the sub time step of the physics engine.
  63188. * Default is 0 meaning there is no sub steps
  63189. * To increase physics resolution precision, set a small value (like 1 ms)
  63190. * @param subTimeStep defines the new sub timestep used for physics resolution.
  63191. */
  63192. setSubTimeStep(subTimeStep?: number): void;
  63193. /**
  63194. * Get the sub time step of the physics engine.
  63195. * @returns the current sub time step
  63196. */
  63197. getSubTimeStep(): number;
  63198. /**
  63199. * Release all resources
  63200. */
  63201. dispose(): void;
  63202. /**
  63203. * Gets the name of the current physics plugin
  63204. * @returns the name of the plugin
  63205. */
  63206. getPhysicsPluginName(): string;
  63207. /**
  63208. * Adding a new impostor for the impostor tracking.
  63209. * This will be done by the impostor itself.
  63210. * @param impostor the impostor to add
  63211. */
  63212. addImpostor(impostor: PhysicsImpostor): void;
  63213. /**
  63214. * Remove an impostor from the engine.
  63215. * This impostor and its mesh will not longer be updated by the physics engine.
  63216. * @param impostor the impostor to remove
  63217. */
  63218. removeImpostor(impostor: PhysicsImpostor): void;
  63219. /**
  63220. * Add a joint to the physics engine
  63221. * @param mainImpostor defines the main impostor to which the joint is added.
  63222. * @param connectedImpostor defines the impostor that is connected to the main impostor using this joint
  63223. * @param joint defines the joint that will connect both impostors.
  63224. */
  63225. addJoint(mainImpostor: PhysicsImpostor, connectedImpostor: PhysicsImpostor, joint: PhysicsJoint): void;
  63226. /**
  63227. * Removes a joint from the simulation
  63228. * @param mainImpostor defines the impostor used with the joint
  63229. * @param connectedImpostor defines the other impostor connected to the main one by the joint
  63230. * @param joint defines the joint to remove
  63231. */
  63232. removeJoint(mainImpostor: PhysicsImpostor, connectedImpostor: PhysicsImpostor, joint: PhysicsJoint): void;
  63233. /**
  63234. * Called by the scene. No need to call it.
  63235. * @param delta defines the timespam between frames
  63236. */
  63237. _step(delta: number): void;
  63238. /**
  63239. * Gets the current plugin used to run the simulation
  63240. * @returns current plugin
  63241. */
  63242. getPhysicsPlugin(): IPhysicsEnginePlugin;
  63243. /**
  63244. * Gets the list of physic impostors
  63245. * @returns an array of PhysicsImpostor
  63246. */
  63247. getImpostors(): Array<PhysicsImpostor>;
  63248. /**
  63249. * Gets the impostor for a physics enabled object
  63250. * @param object defines the object impersonated by the impostor
  63251. * @returns the PhysicsImpostor or null if not found
  63252. */
  63253. getImpostorForPhysicsObject(object: IPhysicsEnabledObject): Nullable<PhysicsImpostor>;
  63254. /**
  63255. * Gets the impostor for a physics body object
  63256. * @param body defines physics body used by the impostor
  63257. * @returns the PhysicsImpostor or null if not found
  63258. */
  63259. getImpostorWithPhysicsBody(body: any): Nullable<PhysicsImpostor>;
  63260. /**
  63261. * Does a raycast in the physics world
  63262. * @param from when should the ray start?
  63263. * @param to when should the ray end?
  63264. * @returns PhysicsRaycastResult
  63265. */
  63266. raycast(from: Vector3, to: Vector3): PhysicsRaycastResult;
  63267. }
  63268. }
  63269. declare module "babylonjs/Physics/Plugins/cannonJSPlugin" {
  63270. import { Nullable } from "babylonjs/types";
  63271. import { Vector3, Quaternion } from "babylonjs/Maths/math.vector";
  63272. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  63273. import { IPhysicsEnginePlugin, PhysicsImpostorJoint } from "babylonjs/Physics/IPhysicsEngine";
  63274. import { PhysicsImpostor } from "babylonjs/Physics/physicsImpostor";
  63275. import { PhysicsJoint, IMotorEnabledJoint } from "babylonjs/Physics/physicsJoint";
  63276. import { PhysicsRaycastResult } from "babylonjs/Physics/physicsRaycastResult";
  63277. /** @hidden */
  63278. export class CannonJSPlugin implements IPhysicsEnginePlugin {
  63279. private _useDeltaForWorldStep;
  63280. world: any;
  63281. name: string;
  63282. private _physicsMaterials;
  63283. private _fixedTimeStep;
  63284. private _cannonRaycastResult;
  63285. private _raycastResult;
  63286. private _physicsBodysToRemoveAfterStep;
  63287. private _firstFrame;
  63288. BJSCANNON: any;
  63289. constructor(_useDeltaForWorldStep?: boolean, iterations?: number, cannonInjection?: any);
  63290. setGravity(gravity: Vector3): void;
  63291. setTimeStep(timeStep: number): void;
  63292. getTimeStep(): number;
  63293. executeStep(delta: number, impostors: Array<PhysicsImpostor>): void;
  63294. private _removeMarkedPhysicsBodiesFromWorld;
  63295. applyImpulse(impostor: PhysicsImpostor, force: Vector3, contactPoint: Vector3): void;
  63296. applyForce(impostor: PhysicsImpostor, force: Vector3, contactPoint: Vector3): void;
  63297. generatePhysicsBody(impostor: PhysicsImpostor): void;
  63298. private _processChildMeshes;
  63299. removePhysicsBody(impostor: PhysicsImpostor): void;
  63300. generateJoint(impostorJoint: PhysicsImpostorJoint): void;
  63301. removeJoint(impostorJoint: PhysicsImpostorJoint): void;
  63302. private _addMaterial;
  63303. private _checkWithEpsilon;
  63304. private _createShape;
  63305. private _createHeightmap;
  63306. private _minus90X;
  63307. private _plus90X;
  63308. private _tmpPosition;
  63309. private _tmpDeltaPosition;
  63310. private _tmpUnityRotation;
  63311. private _updatePhysicsBodyTransformation;
  63312. setTransformationFromPhysicsBody(impostor: PhysicsImpostor): void;
  63313. setPhysicsBodyTransformation(impostor: PhysicsImpostor, newPosition: Vector3, newRotation: Quaternion): void;
  63314. isSupported(): boolean;
  63315. setLinearVelocity(impostor: PhysicsImpostor, velocity: Vector3): void;
  63316. setAngularVelocity(impostor: PhysicsImpostor, velocity: Vector3): void;
  63317. getLinearVelocity(impostor: PhysicsImpostor): Nullable<Vector3>;
  63318. getAngularVelocity(impostor: PhysicsImpostor): Nullable<Vector3>;
  63319. setBodyMass(impostor: PhysicsImpostor, mass: number): void;
  63320. getBodyMass(impostor: PhysicsImpostor): number;
  63321. getBodyFriction(impostor: PhysicsImpostor): number;
  63322. setBodyFriction(impostor: PhysicsImpostor, friction: number): void;
  63323. getBodyRestitution(impostor: PhysicsImpostor): number;
  63324. setBodyRestitution(impostor: PhysicsImpostor, restitution: number): void;
  63325. sleepBody(impostor: PhysicsImpostor): void;
  63326. wakeUpBody(impostor: PhysicsImpostor): void;
  63327. updateDistanceJoint(joint: PhysicsJoint, maxDistance: number): void;
  63328. setMotor(joint: IMotorEnabledJoint, speed?: number, maxForce?: number, motorIndex?: number): void;
  63329. setLimit(joint: IMotorEnabledJoint, upperLimit: number, lowerLimit?: number): void;
  63330. syncMeshWithImpostor(mesh: AbstractMesh, impostor: PhysicsImpostor): void;
  63331. getRadius(impostor: PhysicsImpostor): number;
  63332. getBoxSizeToRef(impostor: PhysicsImpostor, result: Vector3): void;
  63333. dispose(): void;
  63334. private _extendNamespace;
  63335. /**
  63336. * Does a raycast in the physics world
  63337. * @param from when should the ray start?
  63338. * @param to when should the ray end?
  63339. * @returns PhysicsRaycastResult
  63340. */
  63341. raycast(from: Vector3, to: Vector3): PhysicsRaycastResult;
  63342. }
  63343. }
  63344. declare module "babylonjs/Physics/Plugins/oimoJSPlugin" {
  63345. import { IPhysicsEnginePlugin, PhysicsImpostorJoint } from "babylonjs/Physics/IPhysicsEngine";
  63346. import { PhysicsImpostor } from "babylonjs/Physics/physicsImpostor";
  63347. import { PhysicsJoint, IMotorEnabledJoint } from "babylonjs/Physics/physicsJoint";
  63348. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  63349. import { Vector3, Quaternion } from "babylonjs/Maths/math.vector";
  63350. import { Nullable } from "babylonjs/types";
  63351. import { PhysicsRaycastResult } from "babylonjs/Physics/physicsRaycastResult";
  63352. /** @hidden */
  63353. export class OimoJSPlugin implements IPhysicsEnginePlugin {
  63354. private _useDeltaForWorldStep;
  63355. world: any;
  63356. name: string;
  63357. BJSOIMO: any;
  63358. private _raycastResult;
  63359. private _fixedTimeStep;
  63360. constructor(_useDeltaForWorldStep?: boolean, iterations?: number, oimoInjection?: any);
  63361. setGravity(gravity: Vector3): void;
  63362. setTimeStep(timeStep: number): void;
  63363. getTimeStep(): number;
  63364. private _tmpImpostorsArray;
  63365. executeStep(delta: number, impostors: Array<PhysicsImpostor>): void;
  63366. applyImpulse(impostor: PhysicsImpostor, force: Vector3, contactPoint: Vector3): void;
  63367. applyForce(impostor: PhysicsImpostor, force: Vector3, contactPoint: Vector3): void;
  63368. generatePhysicsBody(impostor: PhysicsImpostor): void;
  63369. private _tmpPositionVector;
  63370. removePhysicsBody(impostor: PhysicsImpostor): void;
  63371. generateJoint(impostorJoint: PhysicsImpostorJoint): void;
  63372. removeJoint(impostorJoint: PhysicsImpostorJoint): void;
  63373. isSupported(): boolean;
  63374. setTransformationFromPhysicsBody(impostor: PhysicsImpostor): void;
  63375. setPhysicsBodyTransformation(impostor: PhysicsImpostor, newPosition: Vector3, newRotation: Quaternion): void;
  63376. setLinearVelocity(impostor: PhysicsImpostor, velocity: Vector3): void;
  63377. setAngularVelocity(impostor: PhysicsImpostor, velocity: Vector3): void;
  63378. getLinearVelocity(impostor: PhysicsImpostor): Nullable<Vector3>;
  63379. getAngularVelocity(impostor: PhysicsImpostor): Nullable<Vector3>;
  63380. setBodyMass(impostor: PhysicsImpostor, mass: number): void;
  63381. getBodyMass(impostor: PhysicsImpostor): number;
  63382. getBodyFriction(impostor: PhysicsImpostor): number;
  63383. setBodyFriction(impostor: PhysicsImpostor, friction: number): void;
  63384. getBodyRestitution(impostor: PhysicsImpostor): number;
  63385. setBodyRestitution(impostor: PhysicsImpostor, restitution: number): void;
  63386. sleepBody(impostor: PhysicsImpostor): void;
  63387. wakeUpBody(impostor: PhysicsImpostor): void;
  63388. updateDistanceJoint(joint: PhysicsJoint, maxDistance: number, minDistance?: number): void;
  63389. setMotor(joint: IMotorEnabledJoint, speed: number, force?: number, motorIndex?: number): void;
  63390. setLimit(joint: IMotorEnabledJoint, upperLimit: number, lowerLimit?: number, motorIndex?: number): void;
  63391. syncMeshWithImpostor(mesh: AbstractMesh, impostor: PhysicsImpostor): void;
  63392. getRadius(impostor: PhysicsImpostor): number;
  63393. getBoxSizeToRef(impostor: PhysicsImpostor, result: Vector3): void;
  63394. dispose(): void;
  63395. /**
  63396. * Does a raycast in the physics world
  63397. * @param from when should the ray start?
  63398. * @param to when should the ray end?
  63399. * @returns PhysicsRaycastResult
  63400. */
  63401. raycast(from: Vector3, to: Vector3): PhysicsRaycastResult;
  63402. }
  63403. }
  63404. declare module "babylonjs/Physics/Plugins/ammoJSPlugin" {
  63405. import { Quaternion, Vector3 } from "babylonjs/Maths/math.vector";
  63406. import { IPhysicsEnginePlugin, PhysicsImpostorJoint } from "babylonjs/Physics/IPhysicsEngine";
  63407. import { PhysicsImpostor } from "babylonjs/Physics/physicsImpostor";
  63408. import { PhysicsJoint, IMotorEnabledJoint } from "babylonjs/Physics/physicsJoint";
  63409. import { Nullable } from "babylonjs/types";
  63410. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  63411. import { PhysicsRaycastResult } from "babylonjs/Physics/physicsRaycastResult";
  63412. /**
  63413. * AmmoJS Physics plugin
  63414. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  63415. * @see https://github.com/kripken/ammo.js/
  63416. */
  63417. export class AmmoJSPlugin implements IPhysicsEnginePlugin {
  63418. private _useDeltaForWorldStep;
  63419. /**
  63420. * Reference to the Ammo library
  63421. */
  63422. bjsAMMO: any;
  63423. /**
  63424. * Created ammoJS world which physics bodies are added to
  63425. */
  63426. world: any;
  63427. /**
  63428. * Name of the plugin
  63429. */
  63430. name: string;
  63431. private _timeStep;
  63432. private _fixedTimeStep;
  63433. private _maxSteps;
  63434. private _tmpQuaternion;
  63435. private _tmpAmmoTransform;
  63436. private _tmpAmmoQuaternion;
  63437. private _tmpAmmoConcreteContactResultCallback;
  63438. private _collisionConfiguration;
  63439. private _dispatcher;
  63440. private _overlappingPairCache;
  63441. private _solver;
  63442. private _softBodySolver;
  63443. private _tmpAmmoVectorA;
  63444. private _tmpAmmoVectorB;
  63445. private _tmpAmmoVectorC;
  63446. private _tmpAmmoVectorD;
  63447. private _tmpContactCallbackResult;
  63448. private _tmpAmmoVectorRCA;
  63449. private _tmpAmmoVectorRCB;
  63450. private _raycastResult;
  63451. private static readonly DISABLE_COLLISION_FLAG;
  63452. private static readonly KINEMATIC_FLAG;
  63453. private static readonly DISABLE_DEACTIVATION_FLAG;
  63454. /**
  63455. * Initializes the ammoJS plugin
  63456. * @param _useDeltaForWorldStep if the time between frames should be used when calculating physics steps (Default: true)
  63457. * @param ammoInjection can be used to inject your own ammo reference
  63458. * @param overlappingPairCache can be used to specify your own overlapping pair cache
  63459. */
  63460. constructor(_useDeltaForWorldStep?: boolean, ammoInjection?: any, overlappingPairCache?: any);
  63461. /**
  63462. * Sets the gravity of the physics world (m/(s^2))
  63463. * @param gravity Gravity to set
  63464. */
  63465. setGravity(gravity: Vector3): void;
  63466. /**
  63467. * Amount of time to step forward on each frame (only used if useDeltaForWorldStep is false in the constructor)
  63468. * @param timeStep timestep to use in seconds
  63469. */
  63470. setTimeStep(timeStep: number): void;
  63471. /**
  63472. * 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)
  63473. * @param fixedTimeStep fixedTimeStep to use in seconds
  63474. */
  63475. setFixedTimeStep(fixedTimeStep: number): void;
  63476. /**
  63477. * Sets the maximum number of steps by the physics engine per frame (Default: 5)
  63478. * @param maxSteps the maximum number of steps by the physics engine per frame
  63479. */
  63480. setMaxSteps(maxSteps: number): void;
  63481. /**
  63482. * Gets the current timestep (only used if useDeltaForWorldStep is false in the constructor)
  63483. * @returns the current timestep in seconds
  63484. */
  63485. getTimeStep(): number;
  63486. /**
  63487. * The create custom shape handler function to be called when using BABYLON.PhysicsImposter.CustomImpostor
  63488. */
  63489. onCreateCustomShape: (impostor: PhysicsImpostor) => any;
  63490. private _isImpostorInContact;
  63491. private _isImpostorPairInContact;
  63492. private _stepSimulation;
  63493. /**
  63494. * Moves the physics simulation forward delta seconds and updates the given physics imposters
  63495. * Prior to the step the imposters physics location is set to the position of the babylon meshes
  63496. * After the step the babylon meshes are set to the position of the physics imposters
  63497. * @param delta amount of time to step forward
  63498. * @param impostors array of imposters to update before/after the step
  63499. */
  63500. executeStep(delta: number, impostors: Array<PhysicsImpostor>): void;
  63501. /**
  63502. * Update babylon mesh to match physics world object
  63503. * @param impostor imposter to match
  63504. */
  63505. private _afterSoftStep;
  63506. /**
  63507. * Update babylon mesh vertices vertices to match physics world softbody or cloth
  63508. * @param impostor imposter to match
  63509. */
  63510. private _ropeStep;
  63511. /**
  63512. * Update babylon mesh vertices vertices to match physics world softbody or cloth
  63513. * @param impostor imposter to match
  63514. */
  63515. private _softbodyOrClothStep;
  63516. private _tmpMatrix;
  63517. /**
  63518. * Applies an impulse on the imposter
  63519. * @param impostor imposter to apply impulse to
  63520. * @param force amount of force to be applied to the imposter
  63521. * @param contactPoint the location to apply the impulse on the imposter
  63522. */
  63523. applyImpulse(impostor: PhysicsImpostor, force: Vector3, contactPoint: Vector3): void;
  63524. /**
  63525. * Applies a force on the imposter
  63526. * @param impostor imposter to apply force
  63527. * @param force amount of force to be applied to the imposter
  63528. * @param contactPoint the location to apply the force on the imposter
  63529. */
  63530. applyForce(impostor: PhysicsImpostor, force: Vector3, contactPoint: Vector3): void;
  63531. /**
  63532. * Creates a physics body using the plugin
  63533. * @param impostor the imposter to create the physics body on
  63534. */
  63535. generatePhysicsBody(impostor: PhysicsImpostor): void;
  63536. /**
  63537. * Removes the physics body from the imposter and disposes of the body's memory
  63538. * @param impostor imposter to remove the physics body from
  63539. */
  63540. removePhysicsBody(impostor: PhysicsImpostor): void;
  63541. /**
  63542. * Generates a joint
  63543. * @param impostorJoint the imposter joint to create the joint with
  63544. */
  63545. generateJoint(impostorJoint: PhysicsImpostorJoint): void;
  63546. /**
  63547. * Removes a joint
  63548. * @param impostorJoint the imposter joint to remove the joint from
  63549. */
  63550. removeJoint(impostorJoint: PhysicsImpostorJoint): void;
  63551. private _addMeshVerts;
  63552. /**
  63553. * Initialise the soft body vertices to match its object's (mesh) vertices
  63554. * Softbody vertices (nodes) are in world space and to match this
  63555. * The object's position and rotation is set to zero and so its vertices are also then set in world space
  63556. * @param impostor to create the softbody for
  63557. */
  63558. private _softVertexData;
  63559. /**
  63560. * Create an impostor's soft body
  63561. * @param impostor to create the softbody for
  63562. */
  63563. private _createSoftbody;
  63564. /**
  63565. * Create cloth for an impostor
  63566. * @param impostor to create the softbody for
  63567. */
  63568. private _createCloth;
  63569. /**
  63570. * Create rope for an impostor
  63571. * @param impostor to create the softbody for
  63572. */
  63573. private _createRope;
  63574. /**
  63575. * Create a custom physics impostor shape using the plugin's onCreateCustomShape handler
  63576. * @param impostor to create the custom physics shape for
  63577. */
  63578. private _createCustom;
  63579. private _addHullVerts;
  63580. private _createShape;
  63581. /**
  63582. * Sets the physics body position/rotation from the babylon mesh's position/rotation
  63583. * @param impostor imposter containing the physics body and babylon object
  63584. */
  63585. setTransformationFromPhysicsBody(impostor: PhysicsImpostor): void;
  63586. /**
  63587. * Sets the babylon object's position/rotation from the physics body's position/rotation
  63588. * @param impostor imposter containing the physics body and babylon object
  63589. * @param newPosition new position
  63590. * @param newRotation new rotation
  63591. */
  63592. setPhysicsBodyTransformation(impostor: PhysicsImpostor, newPosition: Vector3, newRotation: Quaternion): void;
  63593. /**
  63594. * If this plugin is supported
  63595. * @returns true if its supported
  63596. */
  63597. isSupported(): boolean;
  63598. /**
  63599. * Sets the linear velocity of the physics body
  63600. * @param impostor imposter to set the velocity on
  63601. * @param velocity velocity to set
  63602. */
  63603. setLinearVelocity(impostor: PhysicsImpostor, velocity: Vector3): void;
  63604. /**
  63605. * Sets the angular velocity of the physics body
  63606. * @param impostor imposter to set the velocity on
  63607. * @param velocity velocity to set
  63608. */
  63609. setAngularVelocity(impostor: PhysicsImpostor, velocity: Vector3): void;
  63610. /**
  63611. * gets the linear velocity
  63612. * @param impostor imposter to get linear velocity from
  63613. * @returns linear velocity
  63614. */
  63615. getLinearVelocity(impostor: PhysicsImpostor): Nullable<Vector3>;
  63616. /**
  63617. * gets the angular velocity
  63618. * @param impostor imposter to get angular velocity from
  63619. * @returns angular velocity
  63620. */
  63621. getAngularVelocity(impostor: PhysicsImpostor): Nullable<Vector3>;
  63622. /**
  63623. * Sets the mass of physics body
  63624. * @param impostor imposter to set the mass on
  63625. * @param mass mass to set
  63626. */
  63627. setBodyMass(impostor: PhysicsImpostor, mass: number): void;
  63628. /**
  63629. * Gets the mass of the physics body
  63630. * @param impostor imposter to get the mass from
  63631. * @returns mass
  63632. */
  63633. getBodyMass(impostor: PhysicsImpostor): number;
  63634. /**
  63635. * Gets friction of the impostor
  63636. * @param impostor impostor to get friction from
  63637. * @returns friction value
  63638. */
  63639. getBodyFriction(impostor: PhysicsImpostor): number;
  63640. /**
  63641. * Sets friction of the impostor
  63642. * @param impostor impostor to set friction on
  63643. * @param friction friction value
  63644. */
  63645. setBodyFriction(impostor: PhysicsImpostor, friction: number): void;
  63646. /**
  63647. * Gets restitution of the impostor
  63648. * @param impostor impostor to get restitution from
  63649. * @returns restitution value
  63650. */
  63651. getBodyRestitution(impostor: PhysicsImpostor): number;
  63652. /**
  63653. * Sets resitution of the impostor
  63654. * @param impostor impostor to set resitution on
  63655. * @param restitution resitution value
  63656. */
  63657. setBodyRestitution(impostor: PhysicsImpostor, restitution: number): void;
  63658. /**
  63659. * Gets pressure inside the impostor
  63660. * @param impostor impostor to get pressure from
  63661. * @returns pressure value
  63662. */
  63663. getBodyPressure(impostor: PhysicsImpostor): number;
  63664. /**
  63665. * Sets pressure inside a soft body impostor
  63666. * Cloth and rope must remain 0 pressure
  63667. * @param impostor impostor to set pressure on
  63668. * @param pressure pressure value
  63669. */
  63670. setBodyPressure(impostor: PhysicsImpostor, pressure: number): void;
  63671. /**
  63672. * Gets stiffness of the impostor
  63673. * @param impostor impostor to get stiffness from
  63674. * @returns pressure value
  63675. */
  63676. getBodyStiffness(impostor: PhysicsImpostor): number;
  63677. /**
  63678. * Sets stiffness of the impostor
  63679. * @param impostor impostor to set stiffness on
  63680. * @param stiffness stiffness value from 0 to 1
  63681. */
  63682. setBodyStiffness(impostor: PhysicsImpostor, stiffness: number): void;
  63683. /**
  63684. * Gets velocityIterations of the impostor
  63685. * @param impostor impostor to get velocity iterations from
  63686. * @returns velocityIterations value
  63687. */
  63688. getBodyVelocityIterations(impostor: PhysicsImpostor): number;
  63689. /**
  63690. * Sets velocityIterations of the impostor
  63691. * @param impostor impostor to set velocity iterations on
  63692. * @param velocityIterations velocityIterations value
  63693. */
  63694. setBodyVelocityIterations(impostor: PhysicsImpostor, velocityIterations: number): void;
  63695. /**
  63696. * Gets positionIterations of the impostor
  63697. * @param impostor impostor to get position iterations from
  63698. * @returns positionIterations value
  63699. */
  63700. getBodyPositionIterations(impostor: PhysicsImpostor): number;
  63701. /**
  63702. * Sets positionIterations of the impostor
  63703. * @param impostor impostor to set position on
  63704. * @param positionIterations positionIterations value
  63705. */
  63706. setBodyPositionIterations(impostor: PhysicsImpostor, positionIterations: number): void;
  63707. /**
  63708. * Append an anchor to a cloth object
  63709. * @param impostor is the cloth impostor to add anchor to
  63710. * @param otherImpostor is the rigid impostor to anchor to
  63711. * @param width ratio across width from 0 to 1
  63712. * @param height ratio up height from 0 to 1
  63713. * @param influence the elasticity between cloth impostor and anchor from 0, very stretchy to 1, little strech
  63714. * @param noCollisionBetweenLinkedBodies when true collisions between soft impostor and anchor are ignored; default false
  63715. */
  63716. appendAnchor(impostor: PhysicsImpostor, otherImpostor: PhysicsImpostor, width: number, height: number, influence?: number, noCollisionBetweenLinkedBodies?: boolean): void;
  63717. /**
  63718. * Append an hook to a rope object
  63719. * @param impostor is the rope impostor to add hook to
  63720. * @param otherImpostor is the rigid impostor to hook to
  63721. * @param length ratio along the rope from 0 to 1
  63722. * @param influence the elasticity between soft impostor and anchor from 0, very stretchy to 1, little strech
  63723. * @param noCollisionBetweenLinkedBodies when true collisions between soft impostor and anchor are ignored; default false
  63724. */
  63725. appendHook(impostor: PhysicsImpostor, otherImpostor: PhysicsImpostor, length: number, influence?: number, noCollisionBetweenLinkedBodies?: boolean): void;
  63726. /**
  63727. * Sleeps the physics body and stops it from being active
  63728. * @param impostor impostor to sleep
  63729. */
  63730. sleepBody(impostor: PhysicsImpostor): void;
  63731. /**
  63732. * Activates the physics body
  63733. * @param impostor impostor to activate
  63734. */
  63735. wakeUpBody(impostor: PhysicsImpostor): void;
  63736. /**
  63737. * Updates the distance parameters of the joint
  63738. * @param joint joint to update
  63739. * @param maxDistance maximum distance of the joint
  63740. * @param minDistance minimum distance of the joint
  63741. */
  63742. updateDistanceJoint(joint: PhysicsJoint, maxDistance: number, minDistance?: number): void;
  63743. /**
  63744. * Sets a motor on the joint
  63745. * @param joint joint to set motor on
  63746. * @param speed speed of the motor
  63747. * @param maxForce maximum force of the motor
  63748. * @param motorIndex index of the motor
  63749. */
  63750. setMotor(joint: IMotorEnabledJoint, speed?: number, maxForce?: number, motorIndex?: number): void;
  63751. /**
  63752. * Sets the motors limit
  63753. * @param joint joint to set limit on
  63754. * @param upperLimit upper limit
  63755. * @param lowerLimit lower limit
  63756. */
  63757. setLimit(joint: IMotorEnabledJoint, upperLimit: number, lowerLimit?: number): void;
  63758. /**
  63759. * Syncs the position and rotation of a mesh with the impostor
  63760. * @param mesh mesh to sync
  63761. * @param impostor impostor to update the mesh with
  63762. */
  63763. syncMeshWithImpostor(mesh: AbstractMesh, impostor: PhysicsImpostor): void;
  63764. /**
  63765. * Gets the radius of the impostor
  63766. * @param impostor impostor to get radius from
  63767. * @returns the radius
  63768. */
  63769. getRadius(impostor: PhysicsImpostor): number;
  63770. /**
  63771. * Gets the box size of the impostor
  63772. * @param impostor impostor to get box size from
  63773. * @param result the resulting box size
  63774. */
  63775. getBoxSizeToRef(impostor: PhysicsImpostor, result: Vector3): void;
  63776. /**
  63777. * Disposes of the impostor
  63778. */
  63779. dispose(): void;
  63780. /**
  63781. * Does a raycast in the physics world
  63782. * @param from when should the ray start?
  63783. * @param to when should the ray end?
  63784. * @returns PhysicsRaycastResult
  63785. */
  63786. raycast(from: Vector3, to: Vector3): PhysicsRaycastResult;
  63787. }
  63788. }
  63789. declare module "babylonjs/Probes/reflectionProbe" {
  63790. import { RenderTargetTexture } from "babylonjs/Materials/Textures/renderTargetTexture";
  63791. import { Vector3 } from "babylonjs/Maths/math.vector";
  63792. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  63793. import { Nullable } from "babylonjs/types";
  63794. import { Scene } from "babylonjs/scene";
  63795. module "babylonjs/abstractScene" {
  63796. interface AbstractScene {
  63797. /**
  63798. * The list of reflection probes added to the scene
  63799. * @see https://doc.babylonjs.com/how_to/how_to_use_reflection_probes
  63800. */
  63801. reflectionProbes: Array<ReflectionProbe>;
  63802. /**
  63803. * Removes the given reflection probe from this scene.
  63804. * @param toRemove The reflection probe to remove
  63805. * @returns The index of the removed reflection probe
  63806. */
  63807. removeReflectionProbe(toRemove: ReflectionProbe): number;
  63808. /**
  63809. * Adds the given reflection probe to this scene.
  63810. * @param newReflectionProbe The reflection probe to add
  63811. */
  63812. addReflectionProbe(newReflectionProbe: ReflectionProbe): void;
  63813. }
  63814. }
  63815. /**
  63816. * Class used to generate realtime reflection / refraction cube textures
  63817. * @see https://doc.babylonjs.com/how_to/how_to_use_reflection_probes
  63818. */
  63819. export class ReflectionProbe {
  63820. /** defines the name of the probe */
  63821. name: string;
  63822. private _scene;
  63823. private _renderTargetTexture;
  63824. private _projectionMatrix;
  63825. private _viewMatrix;
  63826. private _target;
  63827. private _add;
  63828. private _attachedMesh;
  63829. private _invertYAxis;
  63830. /** Gets or sets probe position (center of the cube map) */
  63831. position: Vector3;
  63832. /**
  63833. * Creates a new reflection probe
  63834. * @param name defines the name of the probe
  63835. * @param size defines the texture resolution (for each face)
  63836. * @param scene defines the hosting scene
  63837. * @param generateMipMaps defines if mip maps should be generated automatically (true by default)
  63838. * @param useFloat defines if HDR data (flaot data) should be used to store colors (false by default)
  63839. */
  63840. constructor(
  63841. /** defines the name of the probe */
  63842. name: string, size: number, scene: Scene, generateMipMaps?: boolean, useFloat?: boolean);
  63843. /** Gets or sets the number of samples to use for multi-sampling (0 by default). Required WebGL2 */
  63844. get samples(): number;
  63845. set samples(value: number);
  63846. /** Gets or sets the refresh rate to use (on every frame by default) */
  63847. get refreshRate(): number;
  63848. set refreshRate(value: number);
  63849. /**
  63850. * Gets the hosting scene
  63851. * @returns a Scene
  63852. */
  63853. getScene(): Scene;
  63854. /** Gets the internal CubeTexture used to render to */
  63855. get cubeTexture(): RenderTargetTexture;
  63856. /** Gets the list of meshes to render */
  63857. get renderList(): Nullable<AbstractMesh[]>;
  63858. /**
  63859. * Attach the probe to a specific mesh (Rendering will be done from attached mesh's position)
  63860. * @param mesh defines the mesh to attach to
  63861. */
  63862. attachToMesh(mesh: Nullable<AbstractMesh>): void;
  63863. /**
  63864. * Specifies whether or not the stencil and depth buffer are cleared between two rendering groups
  63865. * @param renderingGroupId The rendering group id corresponding to its index
  63866. * @param autoClearDepthStencil Automatically clears depth and stencil between groups if true.
  63867. */
  63868. setRenderingAutoClearDepthStencil(renderingGroupId: number, autoClearDepthStencil: boolean): void;
  63869. /**
  63870. * Clean all associated resources
  63871. */
  63872. dispose(): void;
  63873. /**
  63874. * Converts the reflection probe information to a readable string for debug purpose.
  63875. * @param fullDetails Supports for multiple levels of logging within scene loading
  63876. * @returns the human readable reflection probe info
  63877. */
  63878. toString(fullDetails?: boolean): string;
  63879. /**
  63880. * Get the class name of the relfection probe.
  63881. * @returns "ReflectionProbe"
  63882. */
  63883. getClassName(): string;
  63884. /**
  63885. * Serialize the reflection probe to a JSON representation we can easily use in the resepective Parse function.
  63886. * @returns The JSON representation of the texture
  63887. */
  63888. serialize(): any;
  63889. /**
  63890. * Parse the JSON representation of a reflection probe in order to recreate the reflection probe in the given scene.
  63891. * @param parsedReflectionProbe Define the JSON representation of the reflection probe
  63892. * @param scene Define the scene the parsed reflection probe should be instantiated in
  63893. * @param rootUrl Define the root url of the parsing sequence in the case of relative dependencies
  63894. * @returns The parsed reflection probe if successful
  63895. */
  63896. static Parse(parsedReflectionProbe: any, scene: Scene, rootUrl: string): Nullable<ReflectionProbe>;
  63897. }
  63898. }
  63899. declare module "babylonjs/Loading/Plugins/babylonFileLoader" {
  63900. /** @hidden */
  63901. export var _BabylonLoaderRegistered: boolean;
  63902. /**
  63903. * Helps setting up some configuration for the babylon file loader.
  63904. */
  63905. export class BabylonFileLoaderConfiguration {
  63906. /**
  63907. * The loader does not allow injecting custom physix engine into the plugins.
  63908. * Unfortunately in ES6, we need to manually inject them into the plugin.
  63909. * So you could set this variable to your engine import to make it work.
  63910. */
  63911. static LoaderInjectedPhysicsEngine: any;
  63912. }
  63913. }
  63914. declare module "babylonjs/Loading/Plugins/index" {
  63915. export * from "babylonjs/Loading/Plugins/babylonFileLoader";
  63916. }
  63917. declare module "babylonjs/Loading/index" {
  63918. export * from "babylonjs/Loading/loadingScreen";
  63919. export * from "babylonjs/Loading/Plugins/index";
  63920. export * from "babylonjs/Loading/sceneLoader";
  63921. export * from "babylonjs/Loading/sceneLoaderFlags";
  63922. }
  63923. declare module "babylonjs/Materials/Background/index" {
  63924. export * from "babylonjs/Materials/Background/backgroundMaterial";
  63925. }
  63926. declare module "babylonjs/Materials/PBR/pbrBaseSimpleMaterial" {
  63927. import { Scene } from "babylonjs/scene";
  63928. import { Color3 } from "babylonjs/Maths/math.color";
  63929. import { PBRBaseMaterial } from "babylonjs/Materials/PBR/pbrBaseMaterial";
  63930. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  63931. /**
  63932. * The Physically based simple base material of BJS.
  63933. *
  63934. * This enables better naming and convention enforcements on top of the pbrMaterial.
  63935. * It is used as the base class for both the specGloss and metalRough conventions.
  63936. */
  63937. export abstract class PBRBaseSimpleMaterial extends PBRBaseMaterial {
  63938. /**
  63939. * Number of Simultaneous lights allowed on the material.
  63940. */
  63941. maxSimultaneousLights: number;
  63942. /**
  63943. * If sets to true, disables all the lights affecting the material.
  63944. */
  63945. disableLighting: boolean;
  63946. /**
  63947. * Environment Texture used in the material (this is use for both reflection and environment lighting).
  63948. */
  63949. environmentTexture: BaseTexture;
  63950. /**
  63951. * If sets to true, x component of normal map value will invert (x = 1.0 - x).
  63952. */
  63953. invertNormalMapX: boolean;
  63954. /**
  63955. * If sets to true, y component of normal map value will invert (y = 1.0 - y).
  63956. */
  63957. invertNormalMapY: boolean;
  63958. /**
  63959. * Normal map used in the model.
  63960. */
  63961. normalTexture: BaseTexture;
  63962. /**
  63963. * Emissivie color used to self-illuminate the model.
  63964. */
  63965. emissiveColor: Color3;
  63966. /**
  63967. * Emissivie texture used to self-illuminate the model.
  63968. */
  63969. emissiveTexture: BaseTexture;
  63970. /**
  63971. * Occlusion Channel Strenght.
  63972. */
  63973. occlusionStrength: number;
  63974. /**
  63975. * Occlusion Texture of the material (adding extra occlusion effects).
  63976. */
  63977. occlusionTexture: BaseTexture;
  63978. /**
  63979. * Defines the alpha limits in alpha test mode.
  63980. */
  63981. alphaCutOff: number;
  63982. /**
  63983. * Gets the current double sided mode.
  63984. */
  63985. get doubleSided(): boolean;
  63986. /**
  63987. * If sets to true and backfaceCulling is false, normals will be flipped on the backside.
  63988. */
  63989. set doubleSided(value: boolean);
  63990. /**
  63991. * Stores the pre-calculated light information of a mesh in a texture.
  63992. */
  63993. lightmapTexture: BaseTexture;
  63994. /**
  63995. * If true, the light map contains occlusion information instead of lighting info.
  63996. */
  63997. useLightmapAsShadowmap: boolean;
  63998. /**
  63999. * Instantiates a new PBRMaterial instance.
  64000. *
  64001. * @param name The material name
  64002. * @param scene The scene the material will be use in.
  64003. */
  64004. constructor(name: string, scene: Scene);
  64005. getClassName(): string;
  64006. }
  64007. }
  64008. declare module "babylonjs/Materials/PBR/pbrMetallicRoughnessMaterial" {
  64009. import { Scene } from "babylonjs/scene";
  64010. import { Color3 } from "babylonjs/Maths/math.color";
  64011. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  64012. import { PBRBaseSimpleMaterial } from "babylonjs/Materials/PBR/pbrBaseSimpleMaterial";
  64013. /**
  64014. * The PBR material of BJS following the metal roughness convention.
  64015. *
  64016. * This fits to the PBR convention in the GLTF definition:
  64017. * https://github.com/KhronosGroup/glTF/tree/2.0/specification/2.0
  64018. */
  64019. export class PBRMetallicRoughnessMaterial extends PBRBaseSimpleMaterial {
  64020. /**
  64021. * The base color has two different interpretations depending on the value of metalness.
  64022. * When the material is a metal, the base color is the specific measured reflectance value
  64023. * at normal incidence (F0). For a non-metal the base color represents the reflected diffuse color
  64024. * of the material.
  64025. */
  64026. baseColor: Color3;
  64027. /**
  64028. * Base texture of the metallic workflow. It contains both the baseColor information in RGB as
  64029. * well as opacity information in the alpha channel.
  64030. */
  64031. baseTexture: BaseTexture;
  64032. /**
  64033. * Specifies the metallic scalar value of the material.
  64034. * Can also be used to scale the metalness values of the metallic texture.
  64035. */
  64036. metallic: number;
  64037. /**
  64038. * Specifies the roughness scalar value of the material.
  64039. * Can also be used to scale the roughness values of the metallic texture.
  64040. */
  64041. roughness: number;
  64042. /**
  64043. * Texture containing both the metallic value in the B channel and the
  64044. * roughness value in the G channel to keep better precision.
  64045. */
  64046. metallicRoughnessTexture: BaseTexture;
  64047. /**
  64048. * Instantiates a new PBRMetalRoughnessMaterial instance.
  64049. *
  64050. * @param name The material name
  64051. * @param scene The scene the material will be use in.
  64052. */
  64053. constructor(name: string, scene: Scene);
  64054. /**
  64055. * Return the currrent class name of the material.
  64056. */
  64057. getClassName(): string;
  64058. /**
  64059. * Makes a duplicate of the current material.
  64060. * @param name - name to use for the new material.
  64061. */
  64062. clone(name: string): PBRMetallicRoughnessMaterial;
  64063. /**
  64064. * Serialize the material to a parsable JSON object.
  64065. */
  64066. serialize(): any;
  64067. /**
  64068. * Parses a JSON object correponding to the serialize function.
  64069. */
  64070. static Parse(source: any, scene: Scene, rootUrl: string): PBRMetallicRoughnessMaterial;
  64071. }
  64072. }
  64073. declare module "babylonjs/Materials/PBR/pbrSpecularGlossinessMaterial" {
  64074. import { Scene } from "babylonjs/scene";
  64075. import { Color3 } from "babylonjs/Maths/math.color";
  64076. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  64077. import { PBRBaseSimpleMaterial } from "babylonjs/Materials/PBR/pbrBaseSimpleMaterial";
  64078. /**
  64079. * The PBR material of BJS following the specular glossiness convention.
  64080. *
  64081. * This fits to the PBR convention in the GLTF definition:
  64082. * https://github.com/KhronosGroup/glTF/tree/2.0/extensions/Khronos/KHR_materials_pbrSpecularGlossiness
  64083. */
  64084. export class PBRSpecularGlossinessMaterial extends PBRBaseSimpleMaterial {
  64085. /**
  64086. * Specifies the diffuse color of the material.
  64087. */
  64088. diffuseColor: Color3;
  64089. /**
  64090. * Specifies the diffuse texture of the material. This can also contains the opcity value in its alpha
  64091. * channel.
  64092. */
  64093. diffuseTexture: BaseTexture;
  64094. /**
  64095. * Specifies the specular color of the material. This indicates how reflective is the material (none to mirror).
  64096. */
  64097. specularColor: Color3;
  64098. /**
  64099. * Specifies the glossiness of the material. This indicates "how sharp is the reflection".
  64100. */
  64101. glossiness: number;
  64102. /**
  64103. * Specifies both the specular color RGB and the glossiness A of the material per pixels.
  64104. */
  64105. specularGlossinessTexture: BaseTexture;
  64106. /**
  64107. * Instantiates a new PBRSpecularGlossinessMaterial instance.
  64108. *
  64109. * @param name The material name
  64110. * @param scene The scene the material will be use in.
  64111. */
  64112. constructor(name: string, scene: Scene);
  64113. /**
  64114. * Return the currrent class name of the material.
  64115. */
  64116. getClassName(): string;
  64117. /**
  64118. * Makes a duplicate of the current material.
  64119. * @param name - name to use for the new material.
  64120. */
  64121. clone(name: string): PBRSpecularGlossinessMaterial;
  64122. /**
  64123. * Serialize the material to a parsable JSON object.
  64124. */
  64125. serialize(): any;
  64126. /**
  64127. * Parses a JSON object correponding to the serialize function.
  64128. */
  64129. static Parse(source: any, scene: Scene, rootUrl: string): PBRSpecularGlossinessMaterial;
  64130. }
  64131. }
  64132. declare module "babylonjs/Materials/PBR/index" {
  64133. export * from "babylonjs/Materials/PBR/pbrBaseMaterial";
  64134. export * from "babylonjs/Materials/PBR/pbrBaseSimpleMaterial";
  64135. export * from "babylonjs/Materials/PBR/pbrMaterial";
  64136. export * from "babylonjs/Materials/PBR/pbrMetallicRoughnessMaterial";
  64137. export * from "babylonjs/Materials/PBR/pbrSpecularGlossinessMaterial";
  64138. }
  64139. declare module "babylonjs/Materials/Textures/colorGradingTexture" {
  64140. import { Nullable } from "babylonjs/types";
  64141. import { Scene } from "babylonjs/scene";
  64142. import { Matrix } from "babylonjs/Maths/math.vector";
  64143. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  64144. import { ThinEngine } from "babylonjs/Engines/thinEngine";
  64145. import "babylonjs/Engines/Extensions/engine.rawTexture";
  64146. /**
  64147. * This represents a color grading texture. This acts as a lookup table LUT, useful during post process
  64148. * It can help converting any input color in a desired output one. This can then be used to create effects
  64149. * from sepia, black and white to sixties or futuristic rendering...
  64150. *
  64151. * The only supported format is currently 3dl.
  64152. * More information on LUT: https://en.wikipedia.org/wiki/3D_lookup_table
  64153. */
  64154. export class ColorGradingTexture extends BaseTexture {
  64155. /**
  64156. * The texture URL.
  64157. */
  64158. url: string;
  64159. /**
  64160. * Empty line regex stored for GC.
  64161. */
  64162. private static _noneEmptyLineRegex;
  64163. private _textureMatrix;
  64164. private _onLoad;
  64165. /**
  64166. * Instantiates a ColorGradingTexture from the following parameters.
  64167. *
  64168. * @param url The location of the color gradind data (currently only supporting 3dl)
  64169. * @param sceneOrEngine The scene or engine the texture will be used in
  64170. * @param onLoad defines a callback triggered when the texture has been loaded
  64171. */
  64172. constructor(url: string, sceneOrEngine: Scene | ThinEngine, onLoad?: Nullable<() => void>);
  64173. /**
  64174. * Fires the onload event from the constructor if requested.
  64175. */
  64176. private _triggerOnLoad;
  64177. /**
  64178. * Returns the texture matrix used in most of the material.
  64179. * This is not used in color grading but keep for troubleshooting purpose (easily swap diffuse by colorgrading to look in).
  64180. */
  64181. getTextureMatrix(): Matrix;
  64182. /**
  64183. * Occurs when the file being loaded is a .3dl LUT file.
  64184. */
  64185. private load3dlTexture;
  64186. /**
  64187. * Starts the loading process of the texture.
  64188. */
  64189. private loadTexture;
  64190. /**
  64191. * Clones the color gradind texture.
  64192. */
  64193. clone(): ColorGradingTexture;
  64194. /**
  64195. * Called during delayed load for textures.
  64196. */
  64197. delayLoad(): void;
  64198. /**
  64199. * Parses a color grading texture serialized by Babylon.
  64200. * @param parsedTexture The texture information being parsedTexture
  64201. * @param scene The scene to load the texture in
  64202. * @param rootUrl The root url of the data assets to load
  64203. * @return A color gradind texture
  64204. */
  64205. static Parse(parsedTexture: any, scene: Scene): Nullable<ColorGradingTexture>;
  64206. /**
  64207. * Serializes the LUT texture to json format.
  64208. */
  64209. serialize(): any;
  64210. }
  64211. }
  64212. declare module "babylonjs/Materials/Textures/equiRectangularCubeTexture" {
  64213. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  64214. import { Scene } from "babylonjs/scene";
  64215. import { Nullable } from "babylonjs/types";
  64216. import "babylonjs/Engines/Extensions/engine.rawTexture";
  64217. /**
  64218. * This represents a texture coming from an equirectangular image supported by the web browser canvas.
  64219. */
  64220. export class EquiRectangularCubeTexture extends BaseTexture {
  64221. /** The six faces of the cube. */
  64222. private static _FacesMapping;
  64223. private _noMipmap;
  64224. private _onLoad;
  64225. private _onError;
  64226. /** The size of the cubemap. */
  64227. private _size;
  64228. /** The buffer of the image. */
  64229. private _buffer;
  64230. /** The width of the input image. */
  64231. private _width;
  64232. /** The height of the input image. */
  64233. private _height;
  64234. /** The URL to the image. */
  64235. url: string;
  64236. /**
  64237. * Instantiates an EquiRectangularCubeTexture from the following parameters.
  64238. * @param url The location of the image
  64239. * @param scene The scene the texture will be used in
  64240. * @param size The cubemap desired size (the more it increases the longer the generation will be)
  64241. * @param noMipmap Forces to not generate the mipmap if true
  64242. * @param gammaSpace Specifies if the texture will be used in gamma or linear space
  64243. * (the PBR material requires those textures in linear space, but the standard material would require them in Gamma space)
  64244. * @param onLoad — defines a callback called when texture is loaded
  64245. * @param onError — defines a callback called if there is an error
  64246. */
  64247. constructor(url: string, scene: Scene, size: number, noMipmap?: boolean, gammaSpace?: boolean, onLoad?: Nullable<() => void>, onError?: Nullable<(message?: string, exception?: any) => void>);
  64248. /**
  64249. * Load the image data, by putting the image on a canvas and extracting its buffer.
  64250. */
  64251. private loadImage;
  64252. /**
  64253. * Convert the image buffer into a cubemap and create a CubeTexture.
  64254. */
  64255. private loadTexture;
  64256. /**
  64257. * Convert the ArrayBuffer into a Float32Array and drop the transparency channel.
  64258. * @param buffer The ArrayBuffer that should be converted.
  64259. * @returns The buffer as Float32Array.
  64260. */
  64261. private getFloat32ArrayFromArrayBuffer;
  64262. /**
  64263. * Get the current class name of the texture useful for serialization or dynamic coding.
  64264. * @returns "EquiRectangularCubeTexture"
  64265. */
  64266. getClassName(): string;
  64267. /**
  64268. * Create a clone of the current EquiRectangularCubeTexture and return it.
  64269. * @returns A clone of the current EquiRectangularCubeTexture.
  64270. */
  64271. clone(): EquiRectangularCubeTexture;
  64272. }
  64273. }
  64274. declare module "babylonjs/Materials/Textures/htmlElementTexture" {
  64275. import { Nullable } from "babylonjs/types";
  64276. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  64277. import { Matrix } from "babylonjs/Maths/math.vector";
  64278. import "babylonjs/Engines/Extensions/engine.dynamicTexture";
  64279. import "babylonjs/Engines/Extensions/engine.videoTexture";
  64280. import { ThinEngine } from "babylonjs/Engines/thinEngine";
  64281. import { Scene } from "babylonjs/scene";
  64282. /**
  64283. * Defines the options related to the creation of an HtmlElementTexture
  64284. */
  64285. export interface IHtmlElementTextureOptions {
  64286. /**
  64287. * Defines wether mip maps should be created or not.
  64288. */
  64289. generateMipMaps?: boolean;
  64290. /**
  64291. * Defines the sampling mode of the texture.
  64292. */
  64293. samplingMode?: number;
  64294. /**
  64295. * Defines the engine instance to use the texture with. It is not mandatory if you define a scene.
  64296. */
  64297. engine: Nullable<ThinEngine>;
  64298. /**
  64299. * Defines the scene the texture belongs to. It is not mandatory if you define an engine.
  64300. */
  64301. scene: Nullable<Scene>;
  64302. }
  64303. /**
  64304. * This represents the smallest workload to use an already existing element (Canvas or Video) as a texture.
  64305. * To be as efficient as possible depending on your constraints nothing aside the first upload
  64306. * is automatically managed.
  64307. * It is a cheap VideoTexture or DynamicTexture if you prefer to keep full control of the elements
  64308. * in your application.
  64309. *
  64310. * As the update is not automatic, you need to call them manually.
  64311. */
  64312. export class HtmlElementTexture extends BaseTexture {
  64313. /**
  64314. * The texture URL.
  64315. */
  64316. element: HTMLVideoElement | HTMLCanvasElement;
  64317. private static readonly DefaultOptions;
  64318. private _textureMatrix;
  64319. private _isVideo;
  64320. private _generateMipMaps;
  64321. private _samplingMode;
  64322. /**
  64323. * Instantiates a HtmlElementTexture from the following parameters.
  64324. *
  64325. * @param name Defines the name of the texture
  64326. * @param element Defines the video or canvas the texture is filled with
  64327. * @param options Defines the other none mandatory texture creation options
  64328. */
  64329. constructor(name: string, element: HTMLVideoElement | HTMLCanvasElement, options: IHtmlElementTextureOptions);
  64330. private _createInternalTexture;
  64331. /**
  64332. * Returns the texture matrix used in most of the material.
  64333. */
  64334. getTextureMatrix(): Matrix;
  64335. /**
  64336. * Updates the content of the texture.
  64337. * @param invertY Defines wether the texture should be inverted on Y (false by default on video and true on canvas)
  64338. */
  64339. update(invertY?: Nullable<boolean>): void;
  64340. }
  64341. }
  64342. declare module "babylonjs/Misc/tga" {
  64343. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  64344. /**
  64345. * Based on jsTGALoader - Javascript loader for TGA file
  64346. * By Vincent Thibault
  64347. * @see http://blog.robrowser.com/javascript-tga-loader.html
  64348. */
  64349. export class TGATools {
  64350. private static _TYPE_INDEXED;
  64351. private static _TYPE_RGB;
  64352. private static _TYPE_GREY;
  64353. private static _TYPE_RLE_INDEXED;
  64354. private static _TYPE_RLE_RGB;
  64355. private static _TYPE_RLE_GREY;
  64356. private static _ORIGIN_MASK;
  64357. private static _ORIGIN_SHIFT;
  64358. private static _ORIGIN_BL;
  64359. private static _ORIGIN_BR;
  64360. private static _ORIGIN_UL;
  64361. private static _ORIGIN_UR;
  64362. /**
  64363. * Gets the header of a TGA file
  64364. * @param data defines the TGA data
  64365. * @returns the header
  64366. */
  64367. static GetTGAHeader(data: Uint8Array): any;
  64368. /**
  64369. * Uploads TGA content to a Babylon Texture
  64370. * @hidden
  64371. */
  64372. static UploadContent(texture: InternalTexture, data: Uint8Array): void;
  64373. /** @hidden */
  64374. 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;
  64375. /** @hidden */
  64376. 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;
  64377. /** @hidden */
  64378. 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;
  64379. /** @hidden */
  64380. 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;
  64381. /** @hidden */
  64382. 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;
  64383. /** @hidden */
  64384. 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;
  64385. }
  64386. }
  64387. declare module "babylonjs/Materials/Textures/Loaders/tgaTextureLoader" {
  64388. import { Nullable } from "babylonjs/types";
  64389. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  64390. import { IInternalTextureLoader } from "babylonjs/Materials/Textures/internalTextureLoader";
  64391. /**
  64392. * Implementation of the TGA Texture Loader.
  64393. * @hidden
  64394. */
  64395. export class _TGATextureLoader implements IInternalTextureLoader {
  64396. /**
  64397. * Defines wether the loader supports cascade loading the different faces.
  64398. */
  64399. readonly supportCascades: boolean;
  64400. /**
  64401. * This returns if the loader support the current file information.
  64402. * @param extension defines the file extension of the file being loaded
  64403. * @returns true if the loader can load the specified file
  64404. */
  64405. canLoad(extension: string): boolean;
  64406. /**
  64407. * Uploads the cube texture data to the WebGL texture. It has already been bound.
  64408. * @param data contains the texture data
  64409. * @param texture defines the BabylonJS internal texture
  64410. * @param createPolynomials will be true if polynomials have been requested
  64411. * @param onLoad defines the callback to trigger once the texture is ready
  64412. * @param onError defines the callback to trigger in case of error
  64413. */
  64414. loadCubeData(data: ArrayBufferView | ArrayBufferView[], texture: InternalTexture, createPolynomials: boolean, onLoad: Nullable<(data?: any) => void>, onError: Nullable<(message?: string, exception?: any) => void>): void;
  64415. /**
  64416. * Uploads the 2D texture data to the WebGL texture. It has already been bound once in the callback.
  64417. * @param data contains the texture data
  64418. * @param texture defines the BabylonJS internal texture
  64419. * @param callback defines the method to call once ready to upload
  64420. */
  64421. loadData(data: ArrayBufferView, texture: InternalTexture, callback: (width: number, height: number, loadMipmap: boolean, isCompressed: boolean, done: () => void) => void): void;
  64422. }
  64423. }
  64424. declare module "babylonjs/Misc/basis" {
  64425. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  64426. /**
  64427. * Info about the .basis files
  64428. */
  64429. class BasisFileInfo {
  64430. /**
  64431. * If the file has alpha
  64432. */
  64433. hasAlpha: boolean;
  64434. /**
  64435. * Info about each image of the basis file
  64436. */
  64437. images: Array<{
  64438. levels: Array<{
  64439. width: number;
  64440. height: number;
  64441. transcodedPixels: ArrayBufferView;
  64442. }>;
  64443. }>;
  64444. }
  64445. /**
  64446. * Result of transcoding a basis file
  64447. */
  64448. class TranscodeResult {
  64449. /**
  64450. * Info about the .basis file
  64451. */
  64452. fileInfo: BasisFileInfo;
  64453. /**
  64454. * Format to use when loading the file
  64455. */
  64456. format: number;
  64457. }
  64458. /**
  64459. * Configuration options for the Basis transcoder
  64460. */
  64461. export class BasisTranscodeConfiguration {
  64462. /**
  64463. * Supported compression formats used to determine the supported output format of the transcoder
  64464. */
  64465. supportedCompressionFormats?: {
  64466. /**
  64467. * etc1 compression format
  64468. */
  64469. etc1?: boolean;
  64470. /**
  64471. * s3tc compression format
  64472. */
  64473. s3tc?: boolean;
  64474. /**
  64475. * pvrtc compression format
  64476. */
  64477. pvrtc?: boolean;
  64478. /**
  64479. * etc2 compression format
  64480. */
  64481. etc2?: boolean;
  64482. };
  64483. /**
  64484. * If mipmap levels should be loaded for transcoded images (Default: true)
  64485. */
  64486. loadMipmapLevels?: boolean;
  64487. /**
  64488. * Index of a single image to load (Default: all images)
  64489. */
  64490. loadSingleImage?: number;
  64491. }
  64492. /**
  64493. * Used to load .Basis files
  64494. * See https://github.com/BinomialLLC/basis_universal/tree/master/webgl
  64495. */
  64496. export class BasisTools {
  64497. private static _IgnoreSupportedFormats;
  64498. /**
  64499. * URL to use when loading the basis transcoder
  64500. */
  64501. static JSModuleURL: string;
  64502. /**
  64503. * URL to use when loading the wasm module for the transcoder
  64504. */
  64505. static WasmModuleURL: string;
  64506. /**
  64507. * Get the internal format to be passed to texImage2D corresponding to the .basis format value
  64508. * @param basisFormat format chosen from GetSupportedTranscodeFormat
  64509. * @returns internal format corresponding to the Basis format
  64510. */
  64511. static GetInternalFormatFromBasisFormat(basisFormat: number): number;
  64512. private static _WorkerPromise;
  64513. private static _Worker;
  64514. private static _actionId;
  64515. private static _CreateWorkerAsync;
  64516. /**
  64517. * Transcodes a loaded image file to compressed pixel data
  64518. * @param data image data to transcode
  64519. * @param config configuration options for the transcoding
  64520. * @returns a promise resulting in the transcoded image
  64521. */
  64522. static TranscodeAsync(data: ArrayBuffer | ArrayBufferView, config: BasisTranscodeConfiguration): Promise<TranscodeResult>;
  64523. /**
  64524. * Loads a texture from the transcode result
  64525. * @param texture texture load to
  64526. * @param transcodeResult the result of transcoding the basis file to load from
  64527. */
  64528. static LoadTextureFromTranscodeResult(texture: InternalTexture, transcodeResult: TranscodeResult): void;
  64529. }
  64530. }
  64531. declare module "babylonjs/Materials/Textures/Loaders/basisTextureLoader" {
  64532. import { Nullable } from "babylonjs/types";
  64533. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  64534. import { IInternalTextureLoader } from "babylonjs/Materials/Textures/internalTextureLoader";
  64535. /**
  64536. * Loader for .basis file format
  64537. */
  64538. export class _BasisTextureLoader implements IInternalTextureLoader {
  64539. /**
  64540. * Defines whether the loader supports cascade loading the different faces.
  64541. */
  64542. readonly supportCascades: boolean;
  64543. /**
  64544. * This returns if the loader support the current file information.
  64545. * @param extension defines the file extension of the file being loaded
  64546. * @returns true if the loader can load the specified file
  64547. */
  64548. canLoad(extension: string): boolean;
  64549. /**
  64550. * Uploads the cube texture data to the WebGL texture. It has already been bound.
  64551. * @param data contains the texture data
  64552. * @param texture defines the BabylonJS internal texture
  64553. * @param createPolynomials will be true if polynomials have been requested
  64554. * @param onLoad defines the callback to trigger once the texture is ready
  64555. * @param onError defines the callback to trigger in case of error
  64556. */
  64557. loadCubeData(data: ArrayBufferView | ArrayBufferView[], texture: InternalTexture, createPolynomials: boolean, onLoad: Nullable<(data?: any) => void>, onError: Nullable<(message?: string, exception?: any) => void>): void;
  64558. /**
  64559. * Uploads the 2D texture data to the WebGL texture. It has already been bound once in the callback.
  64560. * @param data contains the texture data
  64561. * @param texture defines the BabylonJS internal texture
  64562. * @param callback defines the method to call once ready to upload
  64563. */
  64564. loadData(data: ArrayBufferView, texture: InternalTexture, callback: (width: number, height: number, loadMipmap: boolean, isCompressed: boolean, done: () => void) => void): void;
  64565. }
  64566. }
  64567. declare module "babylonjs/Materials/Textures/Loaders/index" {
  64568. export * from "babylonjs/Materials/Textures/Loaders/ddsTextureLoader";
  64569. export * from "babylonjs/Materials/Textures/Loaders/envTextureLoader";
  64570. export * from "babylonjs/Materials/Textures/Loaders/ktxTextureLoader";
  64571. export * from "babylonjs/Materials/Textures/Loaders/tgaTextureLoader";
  64572. export * from "babylonjs/Materials/Textures/Loaders/basisTextureLoader";
  64573. }
  64574. declare module "babylonjs/Materials/Textures/Packer/frame" {
  64575. import { Vector2 } from "babylonjs/Maths/math.vector";
  64576. /**
  64577. * Defines the basic options interface of a TexturePacker Frame
  64578. */
  64579. export interface ITexturePackerFrame {
  64580. /**
  64581. * The frame ID
  64582. */
  64583. id: number;
  64584. /**
  64585. * The frames Scale
  64586. */
  64587. scale: Vector2;
  64588. /**
  64589. * The Frames offset
  64590. */
  64591. offset: Vector2;
  64592. }
  64593. /**
  64594. * This is a support class for frame Data on texture packer sets.
  64595. */
  64596. export class TexturePackerFrame implements ITexturePackerFrame {
  64597. /**
  64598. * The frame ID
  64599. */
  64600. id: number;
  64601. /**
  64602. * The frames Scale
  64603. */
  64604. scale: Vector2;
  64605. /**
  64606. * The Frames offset
  64607. */
  64608. offset: Vector2;
  64609. /**
  64610. * Initializes a texture package frame.
  64611. * @param id The numerical frame identifier
  64612. * @param scale Scalar Vector2 for UV frame
  64613. * @param offset Vector2 for the frame position in UV units.
  64614. * @returns TexturePackerFrame
  64615. */
  64616. constructor(id: number, scale: Vector2, offset: Vector2);
  64617. }
  64618. }
  64619. declare module "babylonjs/Materials/Textures/Packer/packer" {
  64620. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  64621. import { Scene } from "babylonjs/scene";
  64622. import { Nullable } from "babylonjs/types";
  64623. import { Color3, Color4 } from "babylonjs/Maths/math.color";
  64624. import { TexturePackerFrame } from "babylonjs/Materials/Textures/Packer/frame";
  64625. /**
  64626. * Defines the basic options interface of a TexturePacker
  64627. */
  64628. export interface ITexturePackerOptions {
  64629. /**
  64630. * Custom targets for the channels of a texture packer. Default is all the channels of the Standard Material
  64631. */
  64632. map?: string[];
  64633. /**
  64634. * the UV input targets, as a single value for all meshes. Defaults to VertexBuffer.UVKind
  64635. */
  64636. uvsIn?: string;
  64637. /**
  64638. * the UV output targets, as a single value for all meshes. Defaults to VertexBuffer.UVKind
  64639. */
  64640. uvsOut?: string;
  64641. /**
  64642. * number representing the layout style. Defaults to LAYOUT_STRIP
  64643. */
  64644. layout?: number;
  64645. /**
  64646. * number of columns if using custom column count layout(2). This defaults to 4.
  64647. */
  64648. colnum?: number;
  64649. /**
  64650. * flag to update the input meshes to the new packed texture after compilation. Defaults to true.
  64651. */
  64652. updateInputMeshes?: boolean;
  64653. /**
  64654. * boolean flag to dispose all the source textures. Defaults to true.
  64655. */
  64656. disposeSources?: boolean;
  64657. /**
  64658. * Fills the blank cells in a set to the customFillColor. Defaults to true.
  64659. */
  64660. fillBlanks?: boolean;
  64661. /**
  64662. * string value representing the context fill style color. Defaults to 'black'.
  64663. */
  64664. customFillColor?: string;
  64665. /**
  64666. * Width and Height Value of each Frame in the TexturePacker Sets
  64667. */
  64668. frameSize?: number;
  64669. /**
  64670. * Ratio of the value to add padding wise to each cell. Defaults to 0.0115
  64671. */
  64672. paddingRatio?: number;
  64673. /**
  64674. * Number that declares the fill method for the padding gutter.
  64675. */
  64676. paddingMode?: number;
  64677. /**
  64678. * If in SUBUV_COLOR padding mode what color to use.
  64679. */
  64680. paddingColor?: Color3 | Color4;
  64681. }
  64682. /**
  64683. * Defines the basic interface of a TexturePacker JSON File
  64684. */
  64685. export interface ITexturePackerJSON {
  64686. /**
  64687. * The frame ID
  64688. */
  64689. name: string;
  64690. /**
  64691. * The base64 channel data
  64692. */
  64693. sets: any;
  64694. /**
  64695. * The options of the Packer
  64696. */
  64697. options: ITexturePackerOptions;
  64698. /**
  64699. * The frame data of the Packer
  64700. */
  64701. frames: Array<number>;
  64702. }
  64703. /**
  64704. * This is a support class that generates a series of packed texture sets.
  64705. * @see https://doc.babylonjs.com/babylon101/materials
  64706. */
  64707. export class TexturePacker {
  64708. /** Packer Layout Constant 0 */
  64709. static readonly LAYOUT_STRIP: number;
  64710. /** Packer Layout Constant 1 */
  64711. static readonly LAYOUT_POWER2: number;
  64712. /** Packer Layout Constant 2 */
  64713. static readonly LAYOUT_COLNUM: number;
  64714. /** Packer Layout Constant 0 */
  64715. static readonly SUBUV_WRAP: number;
  64716. /** Packer Layout Constant 1 */
  64717. static readonly SUBUV_EXTEND: number;
  64718. /** Packer Layout Constant 2 */
  64719. static readonly SUBUV_COLOR: number;
  64720. /** The Name of the Texture Package */
  64721. name: string;
  64722. /** The scene scope of the TexturePacker */
  64723. scene: Scene;
  64724. /** The Meshes to target */
  64725. meshes: AbstractMesh[];
  64726. /** Arguments passed with the Constructor */
  64727. options: ITexturePackerOptions;
  64728. /** The promise that is started upon initialization */
  64729. promise: Nullable<Promise<TexturePacker | string>>;
  64730. /** The Container object for the channel sets that are generated */
  64731. sets: object;
  64732. /** The Container array for the frames that are generated */
  64733. frames: TexturePackerFrame[];
  64734. /** The expected number of textures the system is parsing. */
  64735. private _expecting;
  64736. /** The padding value from Math.ceil(frameSize * paddingRatio) */
  64737. private _paddingValue;
  64738. /**
  64739. * Initializes a texture package series from an array of meshes or a single mesh.
  64740. * @param name The name of the package
  64741. * @param meshes The target meshes to compose the package from
  64742. * @param options The arguments that texture packer should follow while building.
  64743. * @param scene The scene which the textures are scoped to.
  64744. * @returns TexturePacker
  64745. */
  64746. constructor(name: string, meshes: AbstractMesh[], options: ITexturePackerOptions, scene: Scene);
  64747. /**
  64748. * Starts the package process
  64749. * @param resolve The promises resolution function
  64750. * @returns TexturePacker
  64751. */
  64752. private _createFrames;
  64753. /**
  64754. * Calculates the Size of the Channel Sets
  64755. * @returns Vector2
  64756. */
  64757. private _calculateSize;
  64758. /**
  64759. * Calculates the UV data for the frames.
  64760. * @param baseSize the base frameSize
  64761. * @param padding the base frame padding
  64762. * @param dtSize size of the Dynamic Texture for that channel
  64763. * @param dtUnits is 1/dtSize
  64764. * @param update flag to update the input meshes
  64765. */
  64766. private _calculateMeshUVFrames;
  64767. /**
  64768. * Calculates the frames Offset.
  64769. * @param index of the frame
  64770. * @returns Vector2
  64771. */
  64772. private _getFrameOffset;
  64773. /**
  64774. * Updates a Mesh to the frame data
  64775. * @param mesh that is the target
  64776. * @param frameID or the frame index
  64777. */
  64778. private _updateMeshUV;
  64779. /**
  64780. * Updates a Meshes materials to use the texture packer channels
  64781. * @param m is the mesh to target
  64782. * @param force all channels on the packer to be set.
  64783. */
  64784. private _updateTextureReferences;
  64785. /**
  64786. * Public method to set a Mesh to a frame
  64787. * @param m that is the target
  64788. * @param frameID or the frame index
  64789. * @param updateMaterial trigger for if the Meshes attached Material be updated?
  64790. */
  64791. setMeshToFrame(m: AbstractMesh, frameID: number, updateMaterial?: boolean): void;
  64792. /**
  64793. * Starts the async promise to compile the texture packer.
  64794. * @returns Promise<void>
  64795. */
  64796. processAsync(): Promise<void>;
  64797. /**
  64798. * Disposes all textures associated with this packer
  64799. */
  64800. dispose(): void;
  64801. /**
  64802. * Starts the download process for all the channels converting them to base64 data and embedding it all in a JSON file.
  64803. * @param imageType is the image type to use.
  64804. * @param quality of the image if downloading as jpeg, Ranges from >0 to 1.
  64805. */
  64806. download(imageType?: string, quality?: number): void;
  64807. /**
  64808. * Public method to load a texturePacker JSON file.
  64809. * @param data of the JSON file in string format.
  64810. */
  64811. updateFromJSON(data: string): void;
  64812. }
  64813. }
  64814. declare module "babylonjs/Materials/Textures/Packer/index" {
  64815. export * from "babylonjs/Materials/Textures/Packer/packer";
  64816. export * from "babylonjs/Materials/Textures/Packer/frame";
  64817. }
  64818. declare module "babylonjs/Materials/Textures/Procedurals/customProceduralTexture" {
  64819. import { Scene } from "babylonjs/scene";
  64820. import { Texture } from "babylonjs/Materials/Textures/texture";
  64821. import { ProceduralTexture } from "babylonjs/Materials/Textures/Procedurals/proceduralTexture";
  64822. /**
  64823. * 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.
  64824. * Custom Procedural textures are the easiest way to create your own procedural in your application.
  64825. * @see https://doc.babylonjs.com/how_to/how_to_use_procedural_textures#creating-custom-procedural-textures
  64826. */
  64827. export class CustomProceduralTexture extends ProceduralTexture {
  64828. private _animate;
  64829. private _time;
  64830. private _config;
  64831. private _texturePath;
  64832. /**
  64833. * Instantiates a new Custom Procedural Texture.
  64834. * 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.
  64835. * Custom Procedural textures are the easiest way to create your own procedural in your application.
  64836. * @see https://doc.babylonjs.com/how_to/how_to_use_procedural_textures#creating-custom-procedural-textures
  64837. * @param name Define the name of the texture
  64838. * @param texturePath Define the folder path containing all the cutom texture related files (config, shaders...)
  64839. * @param size Define the size of the texture to create
  64840. * @param scene Define the scene the texture belongs to
  64841. * @param fallbackTexture Define a fallback texture in case there were issues to create the custom texture
  64842. * @param generateMipMaps Define if the texture should creates mip maps or not
  64843. */
  64844. constructor(name: string, texturePath: string, size: number, scene: Scene, fallbackTexture?: Texture, generateMipMaps?: boolean);
  64845. private _loadJson;
  64846. /**
  64847. * Is the texture ready to be used ? (rendered at least once)
  64848. * @returns true if ready, otherwise, false.
  64849. */
  64850. isReady(): boolean;
  64851. /**
  64852. * Render the texture to its associated render target.
  64853. * @param useCameraPostProcess Define if camera post process should be applied to the texture
  64854. */
  64855. render(useCameraPostProcess?: boolean): void;
  64856. /**
  64857. * Update the list of dependant textures samplers in the shader.
  64858. */
  64859. updateTextures(): void;
  64860. /**
  64861. * Update the uniform values of the procedural texture in the shader.
  64862. */
  64863. updateShaderUniforms(): void;
  64864. /**
  64865. * Define if the texture animates or not.
  64866. */
  64867. get animate(): boolean;
  64868. set animate(value: boolean);
  64869. }
  64870. }
  64871. declare module "babylonjs/Shaders/noise.fragment" {
  64872. /** @hidden */
  64873. export var noisePixelShader: {
  64874. name: string;
  64875. shader: string;
  64876. };
  64877. }
  64878. declare module "babylonjs/Materials/Textures/Procedurals/noiseProceduralTexture" {
  64879. import { Nullable } from "babylonjs/types";
  64880. import { Scene } from "babylonjs/scene";
  64881. import { Texture } from "babylonjs/Materials/Textures/texture";
  64882. import { ProceduralTexture } from "babylonjs/Materials/Textures/Procedurals/proceduralTexture";
  64883. import "babylonjs/Shaders/noise.fragment";
  64884. /**
  64885. * Class used to generate noise procedural textures
  64886. */
  64887. export class NoiseProceduralTexture extends ProceduralTexture {
  64888. private _time;
  64889. /** Gets or sets a value between 0 and 1 indicating the overall brightness of the texture (default is 0.2) */
  64890. brightness: number;
  64891. /** Defines the number of octaves to process */
  64892. octaves: number;
  64893. /** Defines the level of persistence (0.8 by default) */
  64894. persistence: number;
  64895. /** Gets or sets animation speed factor (default is 1) */
  64896. animationSpeedFactor: number;
  64897. /**
  64898. * Creates a new NoiseProceduralTexture
  64899. * @param name defines the name fo the texture
  64900. * @param size defines the size of the texture (default is 256)
  64901. * @param scene defines the hosting scene
  64902. * @param fallbackTexture defines the texture to use if the NoiseProceduralTexture can't be created
  64903. * @param generateMipMaps defines if mipmaps must be generated (true by default)
  64904. */
  64905. constructor(name: string, size?: number, scene?: Nullable<Scene>, fallbackTexture?: Texture, generateMipMaps?: boolean);
  64906. private _updateShaderUniforms;
  64907. protected _getDefines(): string;
  64908. /** Generate the current state of the procedural texture */
  64909. render(useCameraPostProcess?: boolean): void;
  64910. /**
  64911. * Serializes this noise procedural texture
  64912. * @returns a serialized noise procedural texture object
  64913. */
  64914. serialize(): any;
  64915. /**
  64916. * Clone the texture.
  64917. * @returns the cloned texture
  64918. */
  64919. clone(): NoiseProceduralTexture;
  64920. /**
  64921. * Creates a NoiseProceduralTexture from parsed noise procedural texture data
  64922. * @param parsedTexture defines parsed texture data
  64923. * @param scene defines the current scene
  64924. * @param rootUrl defines the root URL containing noise procedural texture information
  64925. * @returns a parsed NoiseProceduralTexture
  64926. */
  64927. static Parse(parsedTexture: any, scene: Scene): NoiseProceduralTexture;
  64928. }
  64929. }
  64930. declare module "babylonjs/Materials/Textures/Procedurals/index" {
  64931. export * from "babylonjs/Materials/Textures/Procedurals/customProceduralTexture";
  64932. export * from "babylonjs/Materials/Textures/Procedurals/noiseProceduralTexture";
  64933. export * from "babylonjs/Materials/Textures/Procedurals/proceduralTexture";
  64934. export * from "babylonjs/Materials/Textures/Procedurals/proceduralTextureSceneComponent";
  64935. }
  64936. declare module "babylonjs/Materials/Textures/rawCubeTexture" {
  64937. import { Nullable } from "babylonjs/types";
  64938. import { Scene } from "babylonjs/scene";
  64939. import { SphericalPolynomial } from "babylonjs/Maths/sphericalPolynomial";
  64940. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  64941. import { CubeTexture } from "babylonjs/Materials/Textures/cubeTexture";
  64942. import "babylonjs/Engines/Extensions/engine.rawTexture";
  64943. /**
  64944. * Raw cube texture where the raw buffers are passed in
  64945. */
  64946. export class RawCubeTexture extends CubeTexture {
  64947. /**
  64948. * Creates a cube texture where the raw buffers are passed in.
  64949. * @param scene defines the scene the texture is attached to
  64950. * @param data defines the array of data to use to create each face
  64951. * @param size defines the size of the textures
  64952. * @param format defines the format of the data
  64953. * @param type defines the type of the data (like Engine.TEXTURETYPE_UNSIGNED_INT)
  64954. * @param generateMipMaps defines if the engine should generate the mip levels
  64955. * @param invertY defines if data must be stored with Y axis inverted
  64956. * @param samplingMode defines the required sampling mode (like Texture.NEAREST_SAMPLINGMODE)
  64957. * @param compression defines the compression used (null by default)
  64958. */
  64959. constructor(scene: Scene, data: Nullable<ArrayBufferView[]>, size: number, format?: number, type?: number, generateMipMaps?: boolean, invertY?: boolean, samplingMode?: number, compression?: Nullable<string>);
  64960. /**
  64961. * Updates the raw cube texture.
  64962. * @param data defines the data to store
  64963. * @param format defines the data format
  64964. * @param type defines the type fo the data (Engine.TEXTURETYPE_UNSIGNED_INT by default)
  64965. * @param invertY defines if data must be stored with Y axis inverted
  64966. * @param compression defines the compression used (null by default)
  64967. * @param level defines which level of the texture to update
  64968. */
  64969. update(data: ArrayBufferView[], format: number, type: number, invertY: boolean, compression?: Nullable<string>): void;
  64970. /**
  64971. * Updates a raw cube texture with RGBD encoded data.
  64972. * @param data defines the array of data [mipmap][face] to use to create each face
  64973. * @param sphericalPolynomial defines the spherical polynomial for irradiance
  64974. * @param lodScale defines the scale applied to environment texture. This manages the range of LOD level used for IBL according to the roughness
  64975. * @param lodOffset defines the offset applied to environment texture. This manages first LOD level used for IBL according to the roughness
  64976. * @returns a promsie that resolves when the operation is complete
  64977. */
  64978. updateRGBDAsync(data: ArrayBufferView[][], sphericalPolynomial?: Nullable<SphericalPolynomial>, lodScale?: number, lodOffset?: number): Promise<void>;
  64979. /**
  64980. * Clones the raw cube texture.
  64981. * @return a new cube texture
  64982. */
  64983. clone(): CubeTexture;
  64984. /** @hidden */
  64985. static _UpdateRGBDAsync(internalTexture: InternalTexture, data: ArrayBufferView[][], sphericalPolynomial: Nullable<SphericalPolynomial>, lodScale: number, lodOffset: number): Promise<void>;
  64986. }
  64987. }
  64988. declare module "babylonjs/Materials/Textures/rawTexture2DArray" {
  64989. import { Scene } from "babylonjs/scene";
  64990. import { Texture } from "babylonjs/Materials/Textures/texture";
  64991. import "babylonjs/Engines/Extensions/engine.rawTexture";
  64992. /**
  64993. * Class used to store 2D array textures containing user data
  64994. */
  64995. export class RawTexture2DArray extends Texture {
  64996. /** Gets or sets the texture format to use */
  64997. format: number;
  64998. /**
  64999. * Create a new RawTexture2DArray
  65000. * @param data defines the data of the texture
  65001. * @param width defines the width of the texture
  65002. * @param height defines the height of the texture
  65003. * @param depth defines the number of layers of the texture
  65004. * @param format defines the texture format to use
  65005. * @param scene defines the hosting scene
  65006. * @param generateMipMaps defines a boolean indicating if mip levels should be generated (true by default)
  65007. * @param invertY defines if texture must be stored with Y axis inverted
  65008. * @param samplingMode defines the sampling mode to use (Texture.TRILINEAR_SAMPLINGMODE by default)
  65009. * @param textureType defines the texture Type (Engine.TEXTURETYPE_UNSIGNED_INT, Engine.TEXTURETYPE_FLOAT...)
  65010. */
  65011. constructor(data: ArrayBufferView, width: number, height: number, depth: number,
  65012. /** Gets or sets the texture format to use */
  65013. format: number, scene: Scene, generateMipMaps?: boolean, invertY?: boolean, samplingMode?: number, textureType?: number);
  65014. /**
  65015. * Update the texture with new data
  65016. * @param data defines the data to store in the texture
  65017. */
  65018. update(data: ArrayBufferView): void;
  65019. }
  65020. }
  65021. declare module "babylonjs/Materials/Textures/rawTexture3D" {
  65022. import { Scene } from "babylonjs/scene";
  65023. import { Texture } from "babylonjs/Materials/Textures/texture";
  65024. import "babylonjs/Engines/Extensions/engine.rawTexture";
  65025. /**
  65026. * Class used to store 3D textures containing user data
  65027. */
  65028. export class RawTexture3D extends Texture {
  65029. /** Gets or sets the texture format to use */
  65030. format: number;
  65031. /**
  65032. * Create a new RawTexture3D
  65033. * @param data defines the data of the texture
  65034. * @param width defines the width of the texture
  65035. * @param height defines the height of the texture
  65036. * @param depth defines the depth of the texture
  65037. * @param format defines the texture format to use
  65038. * @param scene defines the hosting scene
  65039. * @param generateMipMaps defines a boolean indicating if mip levels should be generated (true by default)
  65040. * @param invertY defines if texture must be stored with Y axis inverted
  65041. * @param samplingMode defines the sampling mode to use (Texture.TRILINEAR_SAMPLINGMODE by default)
  65042. * @param textureType defines the texture Type (Engine.TEXTURETYPE_UNSIGNED_INT, Engine.TEXTURETYPE_FLOAT...)
  65043. */
  65044. constructor(data: ArrayBufferView, width: number, height: number, depth: number,
  65045. /** Gets or sets the texture format to use */
  65046. format: number, scene: Scene, generateMipMaps?: boolean, invertY?: boolean, samplingMode?: number, textureType?: number);
  65047. /**
  65048. * Update the texture with new data
  65049. * @param data defines the data to store in the texture
  65050. */
  65051. update(data: ArrayBufferView): void;
  65052. }
  65053. }
  65054. declare module "babylonjs/Materials/Textures/refractionTexture" {
  65055. import { Scene } from "babylonjs/scene";
  65056. import { Plane } from "babylonjs/Maths/math.plane";
  65057. import { RenderTargetTexture } from "babylonjs/Materials/Textures/renderTargetTexture";
  65058. /**
  65059. * Creates a refraction texture used by refraction channel of the standard material.
  65060. * It is like a mirror but to see through a material.
  65061. * @see https://doc.babylonjs.com/how_to/reflect#refraction
  65062. */
  65063. export class RefractionTexture extends RenderTargetTexture {
  65064. /**
  65065. * Define the reflection plane we want to use. The refractionPlane is usually set to the constructed refractor.
  65066. * 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.
  65067. * @see https://doc.babylonjs.com/how_to/reflect#refraction
  65068. */
  65069. refractionPlane: Plane;
  65070. /**
  65071. * Define how deep under the surface we should see.
  65072. */
  65073. depth: number;
  65074. /**
  65075. * Creates a refraction texture used by refraction channel of the standard material.
  65076. * It is like a mirror but to see through a material.
  65077. * @see https://doc.babylonjs.com/how_to/reflect#refraction
  65078. * @param name Define the texture name
  65079. * @param size Define the size of the underlying texture
  65080. * @param scene Define the scene the refraction belongs to
  65081. * @param generateMipMaps Define if we need to generate mips level for the refraction
  65082. */
  65083. constructor(name: string, size: number, scene: Scene, generateMipMaps?: boolean);
  65084. /**
  65085. * Clone the refraction texture.
  65086. * @returns the cloned texture
  65087. */
  65088. clone(): RefractionTexture;
  65089. /**
  65090. * Serialize the texture to a JSON representation you could use in Parse later on
  65091. * @returns the serialized JSON representation
  65092. */
  65093. serialize(): any;
  65094. }
  65095. }
  65096. declare module "babylonjs/Materials/Textures/index" {
  65097. export * from "babylonjs/Materials/Textures/baseTexture";
  65098. export * from "babylonjs/Materials/Textures/baseTexture.polynomial";
  65099. export * from "babylonjs/Materials/Textures/colorGradingTexture";
  65100. export * from "babylonjs/Materials/Textures/cubeTexture";
  65101. export * from "babylonjs/Materials/Textures/dynamicTexture";
  65102. export * from "babylonjs/Materials/Textures/equiRectangularCubeTexture";
  65103. export * from "babylonjs/Materials/Textures/Filtering/hdrFiltering";
  65104. export * from "babylonjs/Materials/Textures/hdrCubeTexture";
  65105. export * from "babylonjs/Materials/Textures/htmlElementTexture";
  65106. export * from "babylonjs/Materials/Textures/internalTexture";
  65107. export * from "babylonjs/Materials/Textures/internalTextureLoader";
  65108. export * from "babylonjs/Materials/Textures/Loaders/index";
  65109. export * from "babylonjs/Materials/Textures/mirrorTexture";
  65110. export * from "babylonjs/Materials/Textures/multiRenderTarget";
  65111. export * from "babylonjs/Materials/Textures/Packer/index";
  65112. export * from "babylonjs/Materials/Textures/Procedurals/index";
  65113. export * from "babylonjs/Materials/Textures/rawCubeTexture";
  65114. export * from "babylonjs/Materials/Textures/rawTexture";
  65115. export * from "babylonjs/Materials/Textures/rawTexture2DArray";
  65116. export * from "babylonjs/Materials/Textures/rawTexture3D";
  65117. export * from "babylonjs/Materials/Textures/refractionTexture";
  65118. export * from "babylonjs/Materials/Textures/renderTargetTexture";
  65119. export * from "babylonjs/Materials/Textures/texture";
  65120. export * from "babylonjs/Materials/Textures/videoTexture";
  65121. }
  65122. declare module "babylonjs/Materials/Node/Enums/index" {
  65123. export * from "babylonjs/Materials/Node/Enums/nodeMaterialBlockTargets";
  65124. export * from "babylonjs/Materials/Node/Enums/nodeMaterialBlockConnectionPointTypes";
  65125. export * from "babylonjs/Materials/Node/Enums/nodeMaterialBlockConnectionPointMode";
  65126. export * from "babylonjs/Materials/Node/Enums/nodeMaterialSystemValues";
  65127. export * from "babylonjs/Materials/Node/Enums/nodeMaterialModes";
  65128. }
  65129. declare module "babylonjs/Materials/Node/Blocks/Vertex/bonesBlock" {
  65130. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  65131. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  65132. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  65133. import { Mesh } from "babylonjs/Meshes/mesh";
  65134. import { Effect } from "babylonjs/Materials/effect";
  65135. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  65136. import { NodeMaterial, NodeMaterialDefines } from "babylonjs/Materials/Node/nodeMaterial";
  65137. import "babylonjs/Shaders/ShadersInclude/bonesDeclaration";
  65138. import "babylonjs/Shaders/ShadersInclude/bonesVertex";
  65139. import { EffectFallbacks } from "babylonjs/Materials/effectFallbacks";
  65140. /**
  65141. * Block used to add support for vertex skinning (bones)
  65142. */
  65143. export class BonesBlock extends NodeMaterialBlock {
  65144. /**
  65145. * Creates a new BonesBlock
  65146. * @param name defines the block name
  65147. */
  65148. constructor(name: string);
  65149. /**
  65150. * Initialize the block and prepare the context for build
  65151. * @param state defines the state that will be used for the build
  65152. */
  65153. initialize(state: NodeMaterialBuildState): void;
  65154. /**
  65155. * Gets the current class name
  65156. * @returns the class name
  65157. */
  65158. getClassName(): string;
  65159. /**
  65160. * Gets the matrix indices input component
  65161. */
  65162. get matricesIndices(): NodeMaterialConnectionPoint;
  65163. /**
  65164. * Gets the matrix weights input component
  65165. */
  65166. get matricesWeights(): NodeMaterialConnectionPoint;
  65167. /**
  65168. * Gets the extra matrix indices input component
  65169. */
  65170. get matricesIndicesExtra(): NodeMaterialConnectionPoint;
  65171. /**
  65172. * Gets the extra matrix weights input component
  65173. */
  65174. get matricesWeightsExtra(): NodeMaterialConnectionPoint;
  65175. /**
  65176. * Gets the world input component
  65177. */
  65178. get world(): NodeMaterialConnectionPoint;
  65179. /**
  65180. * Gets the output component
  65181. */
  65182. get output(): NodeMaterialConnectionPoint;
  65183. autoConfigure(material: NodeMaterial): void;
  65184. provideFallbacks(mesh: AbstractMesh, fallbacks: EffectFallbacks): void;
  65185. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh): void;
  65186. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  65187. protected _buildBlock(state: NodeMaterialBuildState): this;
  65188. }
  65189. }
  65190. declare module "babylonjs/Materials/Node/Blocks/Vertex/instancesBlock" {
  65191. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  65192. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  65193. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  65194. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  65195. import { NodeMaterial, NodeMaterialDefines } from "babylonjs/Materials/Node/nodeMaterial";
  65196. import { SubMesh } from "babylonjs/Meshes/subMesh";
  65197. /**
  65198. * Block used to add support for instances
  65199. * @see https://doc.babylonjs.com/how_to/how_to_use_instances
  65200. */
  65201. export class InstancesBlock extends NodeMaterialBlock {
  65202. /**
  65203. * Creates a new InstancesBlock
  65204. * @param name defines the block name
  65205. */
  65206. constructor(name: string);
  65207. /**
  65208. * Gets the current class name
  65209. * @returns the class name
  65210. */
  65211. getClassName(): string;
  65212. /**
  65213. * Gets the first world row input component
  65214. */
  65215. get world0(): NodeMaterialConnectionPoint;
  65216. /**
  65217. * Gets the second world row input component
  65218. */
  65219. get world1(): NodeMaterialConnectionPoint;
  65220. /**
  65221. * Gets the third world row input component
  65222. */
  65223. get world2(): NodeMaterialConnectionPoint;
  65224. /**
  65225. * Gets the forth world row input component
  65226. */
  65227. get world3(): NodeMaterialConnectionPoint;
  65228. /**
  65229. * Gets the world input component
  65230. */
  65231. get world(): NodeMaterialConnectionPoint;
  65232. /**
  65233. * Gets the output component
  65234. */
  65235. get output(): NodeMaterialConnectionPoint;
  65236. /**
  65237. * Gets the isntanceID component
  65238. */
  65239. get instanceID(): NodeMaterialConnectionPoint;
  65240. autoConfigure(material: NodeMaterial): void;
  65241. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines, useInstances?: boolean, subMesh?: SubMesh): void;
  65242. protected _buildBlock(state: NodeMaterialBuildState): this;
  65243. }
  65244. }
  65245. declare module "babylonjs/Materials/Node/Blocks/Vertex/morphTargetsBlock" {
  65246. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  65247. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  65248. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  65249. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  65250. import { NodeMaterial, NodeMaterialDefines } from "babylonjs/Materials/Node/nodeMaterial";
  65251. import { Effect } from "babylonjs/Materials/effect";
  65252. import { Mesh } from "babylonjs/Meshes/mesh";
  65253. import "babylonjs/Shaders/ShadersInclude/morphTargetsVertexDeclaration";
  65254. import "babylonjs/Shaders/ShadersInclude/morphTargetsVertexGlobalDeclaration";
  65255. /**
  65256. * Block used to add morph targets support to vertex shader
  65257. */
  65258. export class MorphTargetsBlock extends NodeMaterialBlock {
  65259. private _repeatableContentAnchor;
  65260. /**
  65261. * Create a new MorphTargetsBlock
  65262. * @param name defines the block name
  65263. */
  65264. constructor(name: string);
  65265. /**
  65266. * Gets the current class name
  65267. * @returns the class name
  65268. */
  65269. getClassName(): string;
  65270. /**
  65271. * Gets the position input component
  65272. */
  65273. get position(): NodeMaterialConnectionPoint;
  65274. /**
  65275. * Gets the normal input component
  65276. */
  65277. get normal(): NodeMaterialConnectionPoint;
  65278. /**
  65279. * Gets the tangent input component
  65280. */
  65281. get tangent(): NodeMaterialConnectionPoint;
  65282. /**
  65283. * Gets the tangent input component
  65284. */
  65285. get uv(): NodeMaterialConnectionPoint;
  65286. /**
  65287. * Gets the position output component
  65288. */
  65289. get positionOutput(): NodeMaterialConnectionPoint;
  65290. /**
  65291. * Gets the normal output component
  65292. */
  65293. get normalOutput(): NodeMaterialConnectionPoint;
  65294. /**
  65295. * Gets the tangent output component
  65296. */
  65297. get tangentOutput(): NodeMaterialConnectionPoint;
  65298. /**
  65299. * Gets the tangent output component
  65300. */
  65301. get uvOutput(): NodeMaterialConnectionPoint;
  65302. initialize(state: NodeMaterialBuildState): void;
  65303. autoConfigure(material: NodeMaterial): void;
  65304. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  65305. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh): void;
  65306. replaceRepeatableContent(vertexShaderState: NodeMaterialBuildState, fragmentShaderState: NodeMaterialBuildState, mesh: AbstractMesh, defines: NodeMaterialDefines): void;
  65307. protected _buildBlock(state: NodeMaterialBuildState): this;
  65308. }
  65309. }
  65310. declare module "babylonjs/Materials/Node/Blocks/Vertex/lightInformationBlock" {
  65311. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  65312. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  65313. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  65314. import { Nullable } from "babylonjs/types";
  65315. import { Scene } from "babylonjs/scene";
  65316. import { Effect } from "babylonjs/Materials/effect";
  65317. import { NodeMaterial, NodeMaterialDefines } from "babylonjs/Materials/Node/nodeMaterial";
  65318. import { Mesh } from "babylonjs/Meshes/mesh";
  65319. import { Light } from "babylonjs/Lights/light";
  65320. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  65321. /**
  65322. * Block used to get data information from a light
  65323. */
  65324. export class LightInformationBlock extends NodeMaterialBlock {
  65325. private _lightDataUniformName;
  65326. private _lightColorUniformName;
  65327. private _lightTypeDefineName;
  65328. /**
  65329. * Gets or sets the light associated with this block
  65330. */
  65331. light: Nullable<Light>;
  65332. /**
  65333. * Creates a new LightInformationBlock
  65334. * @param name defines the block name
  65335. */
  65336. constructor(name: string);
  65337. /**
  65338. * Gets the current class name
  65339. * @returns the class name
  65340. */
  65341. getClassName(): string;
  65342. /**
  65343. * Gets the world position input component
  65344. */
  65345. get worldPosition(): NodeMaterialConnectionPoint;
  65346. /**
  65347. * Gets the direction output component
  65348. */
  65349. get direction(): NodeMaterialConnectionPoint;
  65350. /**
  65351. * Gets the direction output component
  65352. */
  65353. get color(): NodeMaterialConnectionPoint;
  65354. /**
  65355. * Gets the direction output component
  65356. */
  65357. get intensity(): NodeMaterialConnectionPoint;
  65358. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh): void;
  65359. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  65360. protected _buildBlock(state: NodeMaterialBuildState): this;
  65361. serialize(): any;
  65362. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  65363. }
  65364. }
  65365. declare module "babylonjs/Materials/Node/Blocks/Vertex/index" {
  65366. export * from "babylonjs/Materials/Node/Blocks/Vertex/vertexOutputBlock";
  65367. export * from "babylonjs/Materials/Node/Blocks/Vertex/bonesBlock";
  65368. export * from "babylonjs/Materials/Node/Blocks/Vertex/instancesBlock";
  65369. export * from "babylonjs/Materials/Node/Blocks/Vertex/morphTargetsBlock";
  65370. export * from "babylonjs/Materials/Node/Blocks/Vertex/lightInformationBlock";
  65371. }
  65372. declare module "babylonjs/Materials/Node/Blocks/Fragment/imageProcessingBlock" {
  65373. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  65374. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  65375. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  65376. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  65377. import { NodeMaterial, NodeMaterialDefines } from "babylonjs/Materials/Node/nodeMaterial";
  65378. import { Effect } from "babylonjs/Materials/effect";
  65379. import { Mesh } from "babylonjs/Meshes/mesh";
  65380. import "babylonjs/Shaders/ShadersInclude/helperFunctions";
  65381. import "babylonjs/Shaders/ShadersInclude/imageProcessingDeclaration";
  65382. import "babylonjs/Shaders/ShadersInclude/imageProcessingFunctions";
  65383. /**
  65384. * Block used to add image processing support to fragment shader
  65385. */
  65386. export class ImageProcessingBlock extends NodeMaterialBlock {
  65387. /**
  65388. * Create a new ImageProcessingBlock
  65389. * @param name defines the block name
  65390. */
  65391. constructor(name: string);
  65392. /**
  65393. * Gets the current class name
  65394. * @returns the class name
  65395. */
  65396. getClassName(): string;
  65397. /**
  65398. * Gets the color input component
  65399. */
  65400. get color(): NodeMaterialConnectionPoint;
  65401. /**
  65402. * Gets the output component
  65403. */
  65404. get output(): NodeMaterialConnectionPoint;
  65405. /**
  65406. * Initialize the block and prepare the context for build
  65407. * @param state defines the state that will be used for the build
  65408. */
  65409. initialize(state: NodeMaterialBuildState): void;
  65410. isReady(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): boolean;
  65411. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  65412. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh): void;
  65413. protected _buildBlock(state: NodeMaterialBuildState): this;
  65414. }
  65415. }
  65416. declare module "babylonjs/Materials/Node/Blocks/Fragment/perturbNormalBlock" {
  65417. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  65418. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  65419. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  65420. import { NodeMaterial, NodeMaterialDefines } from "babylonjs/Materials/Node/nodeMaterial";
  65421. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  65422. import { Effect } from "babylonjs/Materials/effect";
  65423. import { Mesh } from "babylonjs/Meshes/mesh";
  65424. import { Scene } from "babylonjs/scene";
  65425. import "babylonjs/Shaders/ShadersInclude/bumpFragmentMainFunctions";
  65426. import "babylonjs/Shaders/ShadersInclude/bumpFragmentFunctions";
  65427. import "babylonjs/Shaders/ShadersInclude/bumpFragment";
  65428. /**
  65429. * Block used to pertub normals based on a normal map
  65430. */
  65431. export class PerturbNormalBlock extends NodeMaterialBlock {
  65432. private _tangentSpaceParameterName;
  65433. /** Gets or sets a boolean indicating that normal should be inverted on X axis */
  65434. invertX: boolean;
  65435. /** Gets or sets a boolean indicating that normal should be inverted on Y axis */
  65436. invertY: boolean;
  65437. /**
  65438. * Create a new PerturbNormalBlock
  65439. * @param name defines the block name
  65440. */
  65441. constructor(name: string);
  65442. /**
  65443. * Gets the current class name
  65444. * @returns the class name
  65445. */
  65446. getClassName(): string;
  65447. /**
  65448. * Gets the world position input component
  65449. */
  65450. get worldPosition(): NodeMaterialConnectionPoint;
  65451. /**
  65452. * Gets the world normal input component
  65453. */
  65454. get worldNormal(): NodeMaterialConnectionPoint;
  65455. /**
  65456. * Gets the world tangent input component
  65457. */
  65458. get worldTangent(): NodeMaterialConnectionPoint;
  65459. /**
  65460. * Gets the uv input component
  65461. */
  65462. get uv(): NodeMaterialConnectionPoint;
  65463. /**
  65464. * Gets the normal map color input component
  65465. */
  65466. get normalMapColor(): NodeMaterialConnectionPoint;
  65467. /**
  65468. * Gets the strength input component
  65469. */
  65470. get strength(): NodeMaterialConnectionPoint;
  65471. /**
  65472. * Gets the output component
  65473. */
  65474. get output(): NodeMaterialConnectionPoint;
  65475. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  65476. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh): void;
  65477. autoConfigure(material: NodeMaterial): void;
  65478. protected _buildBlock(state: NodeMaterialBuildState): this;
  65479. protected _dumpPropertiesCode(): string;
  65480. serialize(): any;
  65481. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  65482. }
  65483. }
  65484. declare module "babylonjs/Materials/Node/Blocks/Fragment/discardBlock" {
  65485. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  65486. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  65487. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  65488. /**
  65489. * Block used to discard a pixel if a value is smaller than a cutoff
  65490. */
  65491. export class DiscardBlock extends NodeMaterialBlock {
  65492. /**
  65493. * Create a new DiscardBlock
  65494. * @param name defines the block name
  65495. */
  65496. constructor(name: string);
  65497. /**
  65498. * Gets the current class name
  65499. * @returns the class name
  65500. */
  65501. getClassName(): string;
  65502. /**
  65503. * Gets the color input component
  65504. */
  65505. get value(): NodeMaterialConnectionPoint;
  65506. /**
  65507. * Gets the cutoff input component
  65508. */
  65509. get cutoff(): NodeMaterialConnectionPoint;
  65510. protected _buildBlock(state: NodeMaterialBuildState): this;
  65511. }
  65512. }
  65513. declare module "babylonjs/Materials/Node/Blocks/Fragment/frontFacingBlock" {
  65514. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  65515. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  65516. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  65517. /**
  65518. * Block used to test if the fragment shader is front facing
  65519. */
  65520. export class FrontFacingBlock extends NodeMaterialBlock {
  65521. /**
  65522. * Creates a new FrontFacingBlock
  65523. * @param name defines the block name
  65524. */
  65525. constructor(name: string);
  65526. /**
  65527. * Gets the current class name
  65528. * @returns the class name
  65529. */
  65530. getClassName(): string;
  65531. /**
  65532. * Gets the output component
  65533. */
  65534. get output(): NodeMaterialConnectionPoint;
  65535. protected _buildBlock(state: NodeMaterialBuildState): this;
  65536. }
  65537. }
  65538. declare module "babylonjs/Materials/Node/Blocks/Fragment/derivativeBlock" {
  65539. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  65540. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  65541. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  65542. /**
  65543. * Block used to get the derivative value on x and y of a given input
  65544. */
  65545. export class DerivativeBlock extends NodeMaterialBlock {
  65546. /**
  65547. * Create a new DerivativeBlock
  65548. * @param name defines the block name
  65549. */
  65550. constructor(name: string);
  65551. /**
  65552. * Gets the current class name
  65553. * @returns the class name
  65554. */
  65555. getClassName(): string;
  65556. /**
  65557. * Gets the input component
  65558. */
  65559. get input(): NodeMaterialConnectionPoint;
  65560. /**
  65561. * Gets the derivative output on x
  65562. */
  65563. get dx(): NodeMaterialConnectionPoint;
  65564. /**
  65565. * Gets the derivative output on y
  65566. */
  65567. get dy(): NodeMaterialConnectionPoint;
  65568. protected _buildBlock(state: NodeMaterialBuildState): this;
  65569. }
  65570. }
  65571. declare module "babylonjs/Materials/Node/Blocks/Fragment/fragCoordBlock" {
  65572. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  65573. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  65574. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  65575. /**
  65576. * Block used to make gl_FragCoord available
  65577. */
  65578. export class FragCoordBlock extends NodeMaterialBlock {
  65579. /**
  65580. * Creates a new FragCoordBlock
  65581. * @param name defines the block name
  65582. */
  65583. constructor(name: string);
  65584. /**
  65585. * Gets the current class name
  65586. * @returns the class name
  65587. */
  65588. getClassName(): string;
  65589. /**
  65590. * Gets the xy component
  65591. */
  65592. get xy(): NodeMaterialConnectionPoint;
  65593. /**
  65594. * Gets the xyz component
  65595. */
  65596. get xyz(): NodeMaterialConnectionPoint;
  65597. /**
  65598. * Gets the xyzw component
  65599. */
  65600. get xyzw(): NodeMaterialConnectionPoint;
  65601. /**
  65602. * Gets the x component
  65603. */
  65604. get x(): NodeMaterialConnectionPoint;
  65605. /**
  65606. * Gets the y component
  65607. */
  65608. get y(): NodeMaterialConnectionPoint;
  65609. /**
  65610. * Gets the z component
  65611. */
  65612. get z(): NodeMaterialConnectionPoint;
  65613. /**
  65614. * Gets the w component
  65615. */
  65616. get output(): NodeMaterialConnectionPoint;
  65617. protected writeOutputs(state: NodeMaterialBuildState): string;
  65618. protected _buildBlock(state: NodeMaterialBuildState): this;
  65619. }
  65620. }
  65621. declare module "babylonjs/Materials/Node/Blocks/Fragment/screenSizeBlock" {
  65622. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  65623. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  65624. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  65625. import { Effect } from "babylonjs/Materials/effect";
  65626. import { NodeMaterial } from "babylonjs/Materials/Node/nodeMaterial";
  65627. import { Mesh } from "babylonjs/Meshes/mesh";
  65628. /**
  65629. * Block used to get the screen sizes
  65630. */
  65631. export class ScreenSizeBlock extends NodeMaterialBlock {
  65632. private _varName;
  65633. private _scene;
  65634. /**
  65635. * Creates a new ScreenSizeBlock
  65636. * @param name defines the block name
  65637. */
  65638. constructor(name: string);
  65639. /**
  65640. * Gets the current class name
  65641. * @returns the class name
  65642. */
  65643. getClassName(): string;
  65644. /**
  65645. * Gets the xy component
  65646. */
  65647. get xy(): NodeMaterialConnectionPoint;
  65648. /**
  65649. * Gets the x component
  65650. */
  65651. get x(): NodeMaterialConnectionPoint;
  65652. /**
  65653. * Gets the y component
  65654. */
  65655. get y(): NodeMaterialConnectionPoint;
  65656. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh): void;
  65657. protected writeOutputs(state: NodeMaterialBuildState, varName: string): string;
  65658. protected _buildBlock(state: NodeMaterialBuildState): this;
  65659. }
  65660. }
  65661. declare module "babylonjs/Materials/Node/Blocks/Fragment/index" {
  65662. export * from "babylonjs/Materials/Node/Blocks/Fragment/fragmentOutputBlock";
  65663. export * from "babylonjs/Materials/Node/Blocks/Fragment/imageProcessingBlock";
  65664. export * from "babylonjs/Materials/Node/Blocks/Fragment/perturbNormalBlock";
  65665. export * from "babylonjs/Materials/Node/Blocks/Fragment/discardBlock";
  65666. export * from "babylonjs/Materials/Node/Blocks/Fragment/frontFacingBlock";
  65667. export * from "babylonjs/Materials/Node/Blocks/Fragment/derivativeBlock";
  65668. export * from "babylonjs/Materials/Node/Blocks/Fragment/fragCoordBlock";
  65669. export * from "babylonjs/Materials/Node/Blocks/Fragment/screenSizeBlock";
  65670. }
  65671. declare module "babylonjs/Materials/Node/Blocks/Dual/fogBlock" {
  65672. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  65673. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  65674. import { Mesh } from "babylonjs/Meshes/mesh";
  65675. import { Effect } from "babylonjs/Materials/effect";
  65676. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  65677. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  65678. import { NodeMaterial, NodeMaterialDefines } from "babylonjs/Materials/Node/nodeMaterial";
  65679. import "babylonjs/Shaders/ShadersInclude/fogFragmentDeclaration";
  65680. /**
  65681. * Block used to add support for scene fog
  65682. */
  65683. export class FogBlock extends NodeMaterialBlock {
  65684. private _fogDistanceName;
  65685. private _fogParameters;
  65686. /**
  65687. * Create a new FogBlock
  65688. * @param name defines the block name
  65689. */
  65690. constructor(name: string);
  65691. /**
  65692. * Gets the current class name
  65693. * @returns the class name
  65694. */
  65695. getClassName(): string;
  65696. /**
  65697. * Gets the world position input component
  65698. */
  65699. get worldPosition(): NodeMaterialConnectionPoint;
  65700. /**
  65701. * Gets the view input component
  65702. */
  65703. get view(): NodeMaterialConnectionPoint;
  65704. /**
  65705. * Gets the color input component
  65706. */
  65707. get input(): NodeMaterialConnectionPoint;
  65708. /**
  65709. * Gets the fog color input component
  65710. */
  65711. get fogColor(): NodeMaterialConnectionPoint;
  65712. /**
  65713. * Gets the output component
  65714. */
  65715. get output(): NodeMaterialConnectionPoint;
  65716. autoConfigure(material: NodeMaterial): void;
  65717. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  65718. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh): void;
  65719. protected _buildBlock(state: NodeMaterialBuildState): this;
  65720. }
  65721. }
  65722. declare module "babylonjs/Materials/Node/Blocks/Dual/lightBlock" {
  65723. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  65724. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  65725. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  65726. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  65727. import { NodeMaterial, NodeMaterialDefines } from "babylonjs/Materials/Node/nodeMaterial";
  65728. import { Effect } from "babylonjs/Materials/effect";
  65729. import { Mesh } from "babylonjs/Meshes/mesh";
  65730. import { Light } from "babylonjs/Lights/light";
  65731. import { Nullable } from "babylonjs/types";
  65732. import { Scene } from "babylonjs/scene";
  65733. import "babylonjs/Shaders/ShadersInclude/lightFragmentDeclaration";
  65734. import "babylonjs/Shaders/ShadersInclude/lightUboDeclaration";
  65735. import "babylonjs/Shaders/ShadersInclude/lightFragment";
  65736. import "babylonjs/Shaders/ShadersInclude/helperFunctions";
  65737. import "babylonjs/Shaders/ShadersInclude/lightsFragmentFunctions";
  65738. import "babylonjs/Shaders/ShadersInclude/shadowsFragmentFunctions";
  65739. import "babylonjs/Shaders/ShadersInclude/shadowsVertex";
  65740. /**
  65741. * Block used to add light in the fragment shader
  65742. */
  65743. export class LightBlock extends NodeMaterialBlock {
  65744. private _lightId;
  65745. /**
  65746. * Gets or sets the light associated with this block
  65747. */
  65748. light: Nullable<Light>;
  65749. /**
  65750. * Create a new LightBlock
  65751. * @param name defines the block name
  65752. */
  65753. constructor(name: string);
  65754. /**
  65755. * Gets the current class name
  65756. * @returns the class name
  65757. */
  65758. getClassName(): string;
  65759. /**
  65760. * Gets the world position input component
  65761. */
  65762. get worldPosition(): NodeMaterialConnectionPoint;
  65763. /**
  65764. * Gets the world normal input component
  65765. */
  65766. get worldNormal(): NodeMaterialConnectionPoint;
  65767. /**
  65768. * Gets the camera (or eye) position component
  65769. */
  65770. get cameraPosition(): NodeMaterialConnectionPoint;
  65771. /**
  65772. * Gets the glossiness component
  65773. */
  65774. get glossiness(): NodeMaterialConnectionPoint;
  65775. /**
  65776. * Gets the glossinness power component
  65777. */
  65778. get glossPower(): NodeMaterialConnectionPoint;
  65779. /**
  65780. * Gets the diffuse color component
  65781. */
  65782. get diffuseColor(): NodeMaterialConnectionPoint;
  65783. /**
  65784. * Gets the specular color component
  65785. */
  65786. get specularColor(): NodeMaterialConnectionPoint;
  65787. /**
  65788. * Gets the diffuse output component
  65789. */
  65790. get diffuseOutput(): NodeMaterialConnectionPoint;
  65791. /**
  65792. * Gets the specular output component
  65793. */
  65794. get specularOutput(): NodeMaterialConnectionPoint;
  65795. /**
  65796. * Gets the shadow output component
  65797. */
  65798. get shadow(): NodeMaterialConnectionPoint;
  65799. autoConfigure(material: NodeMaterial): void;
  65800. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  65801. updateUniformsAndSamples(state: NodeMaterialBuildState, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines, uniformBuffers: string[]): void;
  65802. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh): void;
  65803. private _injectVertexCode;
  65804. protected _buildBlock(state: NodeMaterialBuildState): this | undefined;
  65805. serialize(): any;
  65806. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  65807. }
  65808. }
  65809. declare module "babylonjs/Materials/Node/Blocks/Dual/reflectionTextureBlock" {
  65810. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  65811. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  65812. import { NodeMaterial } from "babylonjs/Materials/Node/nodeMaterial";
  65813. import { ReflectionTextureBaseBlock } from "babylonjs/Materials/Node/Blocks/Dual/reflectionTextureBaseBlock";
  65814. /**
  65815. * Block used to read a reflection texture from a sampler
  65816. */
  65817. export class ReflectionTextureBlock extends ReflectionTextureBaseBlock {
  65818. /**
  65819. * Create a new ReflectionTextureBlock
  65820. * @param name defines the block name
  65821. */
  65822. constructor(name: string);
  65823. /**
  65824. * Gets the current class name
  65825. * @returns the class name
  65826. */
  65827. getClassName(): string;
  65828. /**
  65829. * Gets the world position input component
  65830. */
  65831. get position(): NodeMaterialConnectionPoint;
  65832. /**
  65833. * Gets the world position input component
  65834. */
  65835. get worldPosition(): NodeMaterialConnectionPoint;
  65836. /**
  65837. * Gets the world normal input component
  65838. */
  65839. get worldNormal(): NodeMaterialConnectionPoint;
  65840. /**
  65841. * Gets the world input component
  65842. */
  65843. get world(): NodeMaterialConnectionPoint;
  65844. /**
  65845. * Gets the camera (or eye) position component
  65846. */
  65847. get cameraPosition(): NodeMaterialConnectionPoint;
  65848. /**
  65849. * Gets the view input component
  65850. */
  65851. get view(): NodeMaterialConnectionPoint;
  65852. /**
  65853. * Gets the rgb output component
  65854. */
  65855. get rgb(): NodeMaterialConnectionPoint;
  65856. /**
  65857. * Gets the rgba output component
  65858. */
  65859. get rgba(): NodeMaterialConnectionPoint;
  65860. /**
  65861. * Gets the r output component
  65862. */
  65863. get r(): NodeMaterialConnectionPoint;
  65864. /**
  65865. * Gets the g output component
  65866. */
  65867. get g(): NodeMaterialConnectionPoint;
  65868. /**
  65869. * Gets the b output component
  65870. */
  65871. get b(): NodeMaterialConnectionPoint;
  65872. /**
  65873. * Gets the a output component
  65874. */
  65875. get a(): NodeMaterialConnectionPoint;
  65876. autoConfigure(material: NodeMaterial): void;
  65877. protected _buildBlock(state: NodeMaterialBuildState): this;
  65878. }
  65879. }
  65880. declare module "babylonjs/Materials/Node/Blocks/Dual/index" {
  65881. export * from "babylonjs/Materials/Node/Blocks/Dual/fogBlock";
  65882. export * from "babylonjs/Materials/Node/Blocks/Dual/lightBlock";
  65883. export * from "babylonjs/Materials/Node/Blocks/Dual/textureBlock";
  65884. export * from "babylonjs/Materials/Node/Blocks/Dual/reflectionTextureBlock";
  65885. export * from "babylonjs/Materials/Node/Blocks/Dual/currentScreenBlock";
  65886. }
  65887. declare module "babylonjs/Materials/Node/Blocks/Input/index" {
  65888. export * from "babylonjs/Materials/Node/Blocks/Input/inputBlock";
  65889. export * from "babylonjs/Materials/Node/Blocks/Input/animatedInputBlockTypes";
  65890. }
  65891. declare module "babylonjs/Materials/Node/Blocks/addBlock" {
  65892. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  65893. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  65894. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  65895. /**
  65896. * Block used to add 2 vectors
  65897. */
  65898. export class AddBlock extends NodeMaterialBlock {
  65899. /**
  65900. * Creates a new AddBlock
  65901. * @param name defines the block name
  65902. */
  65903. constructor(name: string);
  65904. /**
  65905. * Gets the current class name
  65906. * @returns the class name
  65907. */
  65908. getClassName(): string;
  65909. /**
  65910. * Gets the left operand input component
  65911. */
  65912. get left(): NodeMaterialConnectionPoint;
  65913. /**
  65914. * Gets the right operand input component
  65915. */
  65916. get right(): NodeMaterialConnectionPoint;
  65917. /**
  65918. * Gets the output component
  65919. */
  65920. get output(): NodeMaterialConnectionPoint;
  65921. protected _buildBlock(state: NodeMaterialBuildState): this;
  65922. }
  65923. }
  65924. declare module "babylonjs/Materials/Node/Blocks/scaleBlock" {
  65925. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  65926. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  65927. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  65928. /**
  65929. * Block used to scale a vector by a float
  65930. */
  65931. export class ScaleBlock extends NodeMaterialBlock {
  65932. /**
  65933. * Creates a new ScaleBlock
  65934. * @param name defines the block name
  65935. */
  65936. constructor(name: string);
  65937. /**
  65938. * Gets the current class name
  65939. * @returns the class name
  65940. */
  65941. getClassName(): string;
  65942. /**
  65943. * Gets the input component
  65944. */
  65945. get input(): NodeMaterialConnectionPoint;
  65946. /**
  65947. * Gets the factor input component
  65948. */
  65949. get factor(): NodeMaterialConnectionPoint;
  65950. /**
  65951. * Gets the output component
  65952. */
  65953. get output(): NodeMaterialConnectionPoint;
  65954. protected _buildBlock(state: NodeMaterialBuildState): this;
  65955. }
  65956. }
  65957. declare module "babylonjs/Materials/Node/Blocks/clampBlock" {
  65958. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  65959. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  65960. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  65961. import { Scene } from "babylonjs/scene";
  65962. /**
  65963. * Block used to clamp a float
  65964. */
  65965. export class ClampBlock extends NodeMaterialBlock {
  65966. /** Gets or sets the minimum range */
  65967. minimum: number;
  65968. /** Gets or sets the maximum range */
  65969. maximum: number;
  65970. /**
  65971. * Creates a new ClampBlock
  65972. * @param name defines the block name
  65973. */
  65974. constructor(name: string);
  65975. /**
  65976. * Gets the current class name
  65977. * @returns the class name
  65978. */
  65979. getClassName(): string;
  65980. /**
  65981. * Gets the value input component
  65982. */
  65983. get value(): NodeMaterialConnectionPoint;
  65984. /**
  65985. * Gets the output component
  65986. */
  65987. get output(): NodeMaterialConnectionPoint;
  65988. protected _buildBlock(state: NodeMaterialBuildState): this;
  65989. protected _dumpPropertiesCode(): string;
  65990. serialize(): any;
  65991. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  65992. }
  65993. }
  65994. declare module "babylonjs/Materials/Node/Blocks/crossBlock" {
  65995. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  65996. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  65997. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  65998. /**
  65999. * Block used to apply a cross product between 2 vectors
  66000. */
  66001. export class CrossBlock extends NodeMaterialBlock {
  66002. /**
  66003. * Creates a new CrossBlock
  66004. * @param name defines the block name
  66005. */
  66006. constructor(name: string);
  66007. /**
  66008. * Gets the current class name
  66009. * @returns the class name
  66010. */
  66011. getClassName(): string;
  66012. /**
  66013. * Gets the left operand input component
  66014. */
  66015. get left(): NodeMaterialConnectionPoint;
  66016. /**
  66017. * Gets the right operand input component
  66018. */
  66019. get right(): NodeMaterialConnectionPoint;
  66020. /**
  66021. * Gets the output component
  66022. */
  66023. get output(): NodeMaterialConnectionPoint;
  66024. protected _buildBlock(state: NodeMaterialBuildState): this;
  66025. }
  66026. }
  66027. declare module "babylonjs/Materials/Node/Blocks/dotBlock" {
  66028. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  66029. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  66030. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  66031. /**
  66032. * Block used to apply a dot product between 2 vectors
  66033. */
  66034. export class DotBlock extends NodeMaterialBlock {
  66035. /**
  66036. * Creates a new DotBlock
  66037. * @param name defines the block name
  66038. */
  66039. constructor(name: string);
  66040. /**
  66041. * Gets the current class name
  66042. * @returns the class name
  66043. */
  66044. getClassName(): string;
  66045. /**
  66046. * Gets the left operand input component
  66047. */
  66048. get left(): NodeMaterialConnectionPoint;
  66049. /**
  66050. * Gets the right operand input component
  66051. */
  66052. get right(): NodeMaterialConnectionPoint;
  66053. /**
  66054. * Gets the output component
  66055. */
  66056. get output(): NodeMaterialConnectionPoint;
  66057. protected _buildBlock(state: NodeMaterialBuildState): this;
  66058. }
  66059. }
  66060. declare module "babylonjs/Materials/Node/Blocks/normalizeBlock" {
  66061. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  66062. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  66063. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  66064. /**
  66065. * Block used to normalize a vector
  66066. */
  66067. export class NormalizeBlock extends NodeMaterialBlock {
  66068. /**
  66069. * Creates a new NormalizeBlock
  66070. * @param name defines the block name
  66071. */
  66072. constructor(name: string);
  66073. /**
  66074. * Gets the current class name
  66075. * @returns the class name
  66076. */
  66077. getClassName(): string;
  66078. /**
  66079. * Gets the input component
  66080. */
  66081. get input(): NodeMaterialConnectionPoint;
  66082. /**
  66083. * Gets the output component
  66084. */
  66085. get output(): NodeMaterialConnectionPoint;
  66086. protected _buildBlock(state: NodeMaterialBuildState): this;
  66087. }
  66088. }
  66089. declare module "babylonjs/Materials/Node/Blocks/trigonometryBlock" {
  66090. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  66091. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  66092. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  66093. import { Scene } from "babylonjs/scene";
  66094. /**
  66095. * Operations supported by the Trigonometry block
  66096. */
  66097. export enum TrigonometryBlockOperations {
  66098. /** Cos */
  66099. Cos = 0,
  66100. /** Sin */
  66101. Sin = 1,
  66102. /** Abs */
  66103. Abs = 2,
  66104. /** Exp */
  66105. Exp = 3,
  66106. /** Exp2 */
  66107. Exp2 = 4,
  66108. /** Round */
  66109. Round = 5,
  66110. /** Floor */
  66111. Floor = 6,
  66112. /** Ceiling */
  66113. Ceiling = 7,
  66114. /** Square root */
  66115. Sqrt = 8,
  66116. /** Log */
  66117. Log = 9,
  66118. /** Tangent */
  66119. Tan = 10,
  66120. /** Arc tangent */
  66121. ArcTan = 11,
  66122. /** Arc cosinus */
  66123. ArcCos = 12,
  66124. /** Arc sinus */
  66125. ArcSin = 13,
  66126. /** Fraction */
  66127. Fract = 14,
  66128. /** Sign */
  66129. Sign = 15,
  66130. /** To radians (from degrees) */
  66131. Radians = 16,
  66132. /** To degrees (from radians) */
  66133. Degrees = 17
  66134. }
  66135. /**
  66136. * Block used to apply trigonometry operation to floats
  66137. */
  66138. export class TrigonometryBlock extends NodeMaterialBlock {
  66139. /**
  66140. * Gets or sets the operation applied by the block
  66141. */
  66142. operation: TrigonometryBlockOperations;
  66143. /**
  66144. * Creates a new TrigonometryBlock
  66145. * @param name defines the block name
  66146. */
  66147. constructor(name: string);
  66148. /**
  66149. * Gets the current class name
  66150. * @returns the class name
  66151. */
  66152. getClassName(): string;
  66153. /**
  66154. * Gets the input component
  66155. */
  66156. get input(): NodeMaterialConnectionPoint;
  66157. /**
  66158. * Gets the output component
  66159. */
  66160. get output(): NodeMaterialConnectionPoint;
  66161. protected _buildBlock(state: NodeMaterialBuildState): this;
  66162. serialize(): any;
  66163. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  66164. protected _dumpPropertiesCode(): string;
  66165. }
  66166. }
  66167. declare module "babylonjs/Materials/Node/Blocks/colorMergerBlock" {
  66168. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  66169. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  66170. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  66171. /**
  66172. * Block used to create a Color3/4 out of individual inputs (one for each component)
  66173. */
  66174. export class ColorMergerBlock extends NodeMaterialBlock {
  66175. /**
  66176. * Create a new ColorMergerBlock
  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 rgb component (input)
  66187. */
  66188. get rgbIn(): NodeMaterialConnectionPoint;
  66189. /**
  66190. * Gets the r component (input)
  66191. */
  66192. get r(): NodeMaterialConnectionPoint;
  66193. /**
  66194. * Gets the g component (input)
  66195. */
  66196. get g(): NodeMaterialConnectionPoint;
  66197. /**
  66198. * Gets the b component (input)
  66199. */
  66200. get b(): NodeMaterialConnectionPoint;
  66201. /**
  66202. * Gets the a component (input)
  66203. */
  66204. get a(): NodeMaterialConnectionPoint;
  66205. /**
  66206. * Gets the rgba component (output)
  66207. */
  66208. get rgba(): NodeMaterialConnectionPoint;
  66209. /**
  66210. * Gets the rgb component (output)
  66211. */
  66212. get rgbOut(): NodeMaterialConnectionPoint;
  66213. /**
  66214. * Gets the rgb component (output)
  66215. * @deprecated Please use rgbOut instead.
  66216. */
  66217. get rgb(): NodeMaterialConnectionPoint;
  66218. protected _buildBlock(state: NodeMaterialBuildState): this;
  66219. }
  66220. }
  66221. declare module "babylonjs/Materials/Node/Blocks/vectorSplitterBlock" {
  66222. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  66223. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  66224. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  66225. /**
  66226. * Block used to expand a Vector3/4 into 4 outputs (one for each component)
  66227. */
  66228. export class VectorSplitterBlock extends NodeMaterialBlock {
  66229. /**
  66230. * Create a new VectorSplitterBlock
  66231. * @param name defines the block name
  66232. */
  66233. constructor(name: string);
  66234. /**
  66235. * Gets the current class name
  66236. * @returns the class name
  66237. */
  66238. getClassName(): string;
  66239. /**
  66240. * Gets the xyzw component (input)
  66241. */
  66242. get xyzw(): NodeMaterialConnectionPoint;
  66243. /**
  66244. * Gets the xyz component (input)
  66245. */
  66246. get xyzIn(): NodeMaterialConnectionPoint;
  66247. /**
  66248. * Gets the xy component (input)
  66249. */
  66250. get xyIn(): NodeMaterialConnectionPoint;
  66251. /**
  66252. * Gets the xyz component (output)
  66253. */
  66254. get xyzOut(): NodeMaterialConnectionPoint;
  66255. /**
  66256. * Gets the xy component (output)
  66257. */
  66258. get xyOut(): NodeMaterialConnectionPoint;
  66259. /**
  66260. * Gets the x component (output)
  66261. */
  66262. get x(): NodeMaterialConnectionPoint;
  66263. /**
  66264. * Gets the y component (output)
  66265. */
  66266. get y(): NodeMaterialConnectionPoint;
  66267. /**
  66268. * Gets the z component (output)
  66269. */
  66270. get z(): NodeMaterialConnectionPoint;
  66271. /**
  66272. * Gets the w component (output)
  66273. */
  66274. get w(): NodeMaterialConnectionPoint;
  66275. protected _inputRename(name: string): string;
  66276. protected _outputRename(name: string): string;
  66277. protected _buildBlock(state: NodeMaterialBuildState): this;
  66278. }
  66279. }
  66280. declare module "babylonjs/Materials/Node/Blocks/lerpBlock" {
  66281. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  66282. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  66283. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  66284. /**
  66285. * Block used to lerp between 2 values
  66286. */
  66287. export class LerpBlock extends NodeMaterialBlock {
  66288. /**
  66289. * Creates a new LerpBlock
  66290. * @param name defines the block name
  66291. */
  66292. constructor(name: string);
  66293. /**
  66294. * Gets the current class name
  66295. * @returns the class name
  66296. */
  66297. getClassName(): string;
  66298. /**
  66299. * Gets the left operand input component
  66300. */
  66301. get left(): NodeMaterialConnectionPoint;
  66302. /**
  66303. * Gets the right operand input component
  66304. */
  66305. get right(): NodeMaterialConnectionPoint;
  66306. /**
  66307. * Gets the gradient operand input component
  66308. */
  66309. get gradient(): NodeMaterialConnectionPoint;
  66310. /**
  66311. * Gets the output component
  66312. */
  66313. get output(): NodeMaterialConnectionPoint;
  66314. protected _buildBlock(state: NodeMaterialBuildState): this;
  66315. }
  66316. }
  66317. declare module "babylonjs/Materials/Node/Blocks/divideBlock" {
  66318. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  66319. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  66320. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  66321. /**
  66322. * Block used to divide 2 vectors
  66323. */
  66324. export class DivideBlock extends NodeMaterialBlock {
  66325. /**
  66326. * Creates a new DivideBlock
  66327. * @param name defines the block name
  66328. */
  66329. constructor(name: string);
  66330. /**
  66331. * Gets the current class name
  66332. * @returns the class name
  66333. */
  66334. getClassName(): string;
  66335. /**
  66336. * Gets the left operand input component
  66337. */
  66338. get left(): NodeMaterialConnectionPoint;
  66339. /**
  66340. * Gets the right operand input component
  66341. */
  66342. get right(): NodeMaterialConnectionPoint;
  66343. /**
  66344. * Gets the output component
  66345. */
  66346. get output(): NodeMaterialConnectionPoint;
  66347. protected _buildBlock(state: NodeMaterialBuildState): this;
  66348. }
  66349. }
  66350. declare module "babylonjs/Materials/Node/Blocks/subtractBlock" {
  66351. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  66352. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  66353. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  66354. /**
  66355. * Block used to subtract 2 vectors
  66356. */
  66357. export class SubtractBlock extends NodeMaterialBlock {
  66358. /**
  66359. * Creates a new SubtractBlock
  66360. * @param name defines the block name
  66361. */
  66362. constructor(name: string);
  66363. /**
  66364. * Gets the current class name
  66365. * @returns the class name
  66366. */
  66367. getClassName(): string;
  66368. /**
  66369. * Gets the left operand input component
  66370. */
  66371. get left(): NodeMaterialConnectionPoint;
  66372. /**
  66373. * Gets the right operand input component
  66374. */
  66375. get right(): NodeMaterialConnectionPoint;
  66376. /**
  66377. * Gets the output component
  66378. */
  66379. get output(): NodeMaterialConnectionPoint;
  66380. protected _buildBlock(state: NodeMaterialBuildState): this;
  66381. }
  66382. }
  66383. declare module "babylonjs/Materials/Node/Blocks/stepBlock" {
  66384. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  66385. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  66386. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  66387. /**
  66388. * Block used to step a value
  66389. */
  66390. export class StepBlock extends NodeMaterialBlock {
  66391. /**
  66392. * Creates a new StepBlock
  66393. * @param name defines the block name
  66394. */
  66395. constructor(name: string);
  66396. /**
  66397. * Gets the current class name
  66398. * @returns the class name
  66399. */
  66400. getClassName(): string;
  66401. /**
  66402. * Gets the value operand input component
  66403. */
  66404. get value(): NodeMaterialConnectionPoint;
  66405. /**
  66406. * Gets the edge operand input component
  66407. */
  66408. get edge(): NodeMaterialConnectionPoint;
  66409. /**
  66410. * Gets the output component
  66411. */
  66412. get output(): NodeMaterialConnectionPoint;
  66413. protected _buildBlock(state: NodeMaterialBuildState): this;
  66414. }
  66415. }
  66416. declare module "babylonjs/Materials/Node/Blocks/oneMinusBlock" {
  66417. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  66418. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  66419. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  66420. /**
  66421. * Block used to get the opposite (1 - x) of a value
  66422. */
  66423. export class OneMinusBlock extends NodeMaterialBlock {
  66424. /**
  66425. * Creates a new OneMinusBlock
  66426. * @param name defines the block name
  66427. */
  66428. constructor(name: string);
  66429. /**
  66430. * Gets the current class name
  66431. * @returns the class name
  66432. */
  66433. getClassName(): string;
  66434. /**
  66435. * Gets the input component
  66436. */
  66437. get input(): NodeMaterialConnectionPoint;
  66438. /**
  66439. * Gets the output component
  66440. */
  66441. get output(): NodeMaterialConnectionPoint;
  66442. protected _buildBlock(state: NodeMaterialBuildState): this;
  66443. }
  66444. }
  66445. declare module "babylonjs/Materials/Node/Blocks/viewDirectionBlock" {
  66446. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  66447. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  66448. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  66449. import { NodeMaterial } from "babylonjs/Materials/Node/nodeMaterial";
  66450. /**
  66451. * Block used to get the view direction
  66452. */
  66453. export class ViewDirectionBlock extends NodeMaterialBlock {
  66454. /**
  66455. * Creates a new ViewDirectionBlock
  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 world position component
  66466. */
  66467. get worldPosition(): NodeMaterialConnectionPoint;
  66468. /**
  66469. * Gets the camera position component
  66470. */
  66471. get cameraPosition(): NodeMaterialConnectionPoint;
  66472. /**
  66473. * Gets the output component
  66474. */
  66475. get output(): NodeMaterialConnectionPoint;
  66476. autoConfigure(material: NodeMaterial): void;
  66477. protected _buildBlock(state: NodeMaterialBuildState): this;
  66478. }
  66479. }
  66480. declare module "babylonjs/Materials/Node/Blocks/fresnelBlock" {
  66481. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  66482. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  66483. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  66484. import { NodeMaterial } from "babylonjs/Materials/Node/nodeMaterial";
  66485. import "babylonjs/Shaders/ShadersInclude/fresnelFunction";
  66486. /**
  66487. * Block used to compute fresnel value
  66488. */
  66489. export class FresnelBlock extends NodeMaterialBlock {
  66490. /**
  66491. * Create a new FresnelBlock
  66492. * @param name defines the block name
  66493. */
  66494. constructor(name: string);
  66495. /**
  66496. * Gets the current class name
  66497. * @returns the class name
  66498. */
  66499. getClassName(): string;
  66500. /**
  66501. * Gets the world normal input component
  66502. */
  66503. get worldNormal(): NodeMaterialConnectionPoint;
  66504. /**
  66505. * Gets the view direction input component
  66506. */
  66507. get viewDirection(): NodeMaterialConnectionPoint;
  66508. /**
  66509. * Gets the bias input component
  66510. */
  66511. get bias(): NodeMaterialConnectionPoint;
  66512. /**
  66513. * Gets the camera (or eye) position component
  66514. */
  66515. get power(): NodeMaterialConnectionPoint;
  66516. /**
  66517. * Gets the fresnel output component
  66518. */
  66519. get fresnel(): NodeMaterialConnectionPoint;
  66520. autoConfigure(material: NodeMaterial): void;
  66521. protected _buildBlock(state: NodeMaterialBuildState): this;
  66522. }
  66523. }
  66524. declare module "babylonjs/Materials/Node/Blocks/maxBlock" {
  66525. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  66526. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  66527. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  66528. /**
  66529. * Block used to get the max of 2 values
  66530. */
  66531. export class MaxBlock extends NodeMaterialBlock {
  66532. /**
  66533. * Creates a new MaxBlock
  66534. * @param name defines the block name
  66535. */
  66536. constructor(name: string);
  66537. /**
  66538. * Gets the current class name
  66539. * @returns the class name
  66540. */
  66541. getClassName(): string;
  66542. /**
  66543. * Gets the left operand input component
  66544. */
  66545. get left(): NodeMaterialConnectionPoint;
  66546. /**
  66547. * Gets the right operand input component
  66548. */
  66549. get right(): NodeMaterialConnectionPoint;
  66550. /**
  66551. * Gets the output component
  66552. */
  66553. get output(): NodeMaterialConnectionPoint;
  66554. protected _buildBlock(state: NodeMaterialBuildState): this;
  66555. }
  66556. }
  66557. declare module "babylonjs/Materials/Node/Blocks/minBlock" {
  66558. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  66559. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  66560. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  66561. /**
  66562. * Block used to get the min of 2 values
  66563. */
  66564. export class MinBlock extends NodeMaterialBlock {
  66565. /**
  66566. * Creates a new MinBlock
  66567. * @param name defines the block name
  66568. */
  66569. constructor(name: string);
  66570. /**
  66571. * Gets the current class name
  66572. * @returns the class name
  66573. */
  66574. getClassName(): string;
  66575. /**
  66576. * Gets the left operand input component
  66577. */
  66578. get left(): NodeMaterialConnectionPoint;
  66579. /**
  66580. * Gets the right operand input component
  66581. */
  66582. get right(): NodeMaterialConnectionPoint;
  66583. /**
  66584. * Gets the output component
  66585. */
  66586. get output(): NodeMaterialConnectionPoint;
  66587. protected _buildBlock(state: NodeMaterialBuildState): this;
  66588. }
  66589. }
  66590. declare module "babylonjs/Materials/Node/Blocks/distanceBlock" {
  66591. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  66592. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  66593. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  66594. /**
  66595. * Block used to get the distance between 2 values
  66596. */
  66597. export class DistanceBlock extends NodeMaterialBlock {
  66598. /**
  66599. * Creates a new DistanceBlock
  66600. * @param name defines the block name
  66601. */
  66602. constructor(name: string);
  66603. /**
  66604. * Gets the current class name
  66605. * @returns the class name
  66606. */
  66607. getClassName(): string;
  66608. /**
  66609. * Gets the left operand input component
  66610. */
  66611. get left(): NodeMaterialConnectionPoint;
  66612. /**
  66613. * Gets the right operand input component
  66614. */
  66615. get right(): NodeMaterialConnectionPoint;
  66616. /**
  66617. * Gets the output component
  66618. */
  66619. get output(): NodeMaterialConnectionPoint;
  66620. protected _buildBlock(state: NodeMaterialBuildState): this;
  66621. }
  66622. }
  66623. declare module "babylonjs/Materials/Node/Blocks/lengthBlock" {
  66624. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  66625. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  66626. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  66627. /**
  66628. * Block used to get the length of a vector
  66629. */
  66630. export class LengthBlock extends NodeMaterialBlock {
  66631. /**
  66632. * Creates a new LengthBlock
  66633. * @param name defines the block name
  66634. */
  66635. constructor(name: string);
  66636. /**
  66637. * Gets the current class name
  66638. * @returns the class name
  66639. */
  66640. getClassName(): string;
  66641. /**
  66642. * Gets the value input component
  66643. */
  66644. get value(): NodeMaterialConnectionPoint;
  66645. /**
  66646. * Gets the output component
  66647. */
  66648. get output(): NodeMaterialConnectionPoint;
  66649. protected _buildBlock(state: NodeMaterialBuildState): this;
  66650. }
  66651. }
  66652. declare module "babylonjs/Materials/Node/Blocks/negateBlock" {
  66653. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  66654. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  66655. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  66656. /**
  66657. * Block used to get negative version of a value (i.e. x * -1)
  66658. */
  66659. export class NegateBlock extends NodeMaterialBlock {
  66660. /**
  66661. * Creates a new NegateBlock
  66662. * @param name defines the block name
  66663. */
  66664. constructor(name: string);
  66665. /**
  66666. * Gets the current class name
  66667. * @returns the class name
  66668. */
  66669. getClassName(): string;
  66670. /**
  66671. * Gets the value input component
  66672. */
  66673. get value(): NodeMaterialConnectionPoint;
  66674. /**
  66675. * Gets the output component
  66676. */
  66677. get output(): NodeMaterialConnectionPoint;
  66678. protected _buildBlock(state: NodeMaterialBuildState): this;
  66679. }
  66680. }
  66681. declare module "babylonjs/Materials/Node/Blocks/powBlock" {
  66682. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  66683. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  66684. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  66685. /**
  66686. * Block used to get the value of the first parameter raised to the power of the second
  66687. */
  66688. export class PowBlock extends NodeMaterialBlock {
  66689. /**
  66690. * Creates a new PowBlock
  66691. * @param name defines the block name
  66692. */
  66693. constructor(name: string);
  66694. /**
  66695. * Gets the current class name
  66696. * @returns the class name
  66697. */
  66698. getClassName(): string;
  66699. /**
  66700. * Gets the value operand input component
  66701. */
  66702. get value(): NodeMaterialConnectionPoint;
  66703. /**
  66704. * Gets the power operand input component
  66705. */
  66706. get power(): NodeMaterialConnectionPoint;
  66707. /**
  66708. * Gets the output component
  66709. */
  66710. get output(): NodeMaterialConnectionPoint;
  66711. protected _buildBlock(state: NodeMaterialBuildState): this;
  66712. }
  66713. }
  66714. declare module "babylonjs/Materials/Node/Blocks/randomNumberBlock" {
  66715. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  66716. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  66717. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  66718. import "babylonjs/Shaders/ShadersInclude/helperFunctions";
  66719. /**
  66720. * Block used to get a random number
  66721. */
  66722. export class RandomNumberBlock extends NodeMaterialBlock {
  66723. /**
  66724. * Creates a new RandomNumberBlock
  66725. * @param name defines the block name
  66726. */
  66727. constructor(name: string);
  66728. /**
  66729. * Gets the current class name
  66730. * @returns the class name
  66731. */
  66732. getClassName(): string;
  66733. /**
  66734. * Gets the seed input component
  66735. */
  66736. get seed(): NodeMaterialConnectionPoint;
  66737. /**
  66738. * Gets the output component
  66739. */
  66740. get output(): NodeMaterialConnectionPoint;
  66741. protected _buildBlock(state: NodeMaterialBuildState): this;
  66742. }
  66743. }
  66744. declare module "babylonjs/Materials/Node/Blocks/arcTan2Block" {
  66745. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  66746. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  66747. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  66748. /**
  66749. * Block used to compute arc tangent of 2 values
  66750. */
  66751. export class ArcTan2Block extends NodeMaterialBlock {
  66752. /**
  66753. * Creates a new ArcTan2Block
  66754. * @param name defines the block name
  66755. */
  66756. constructor(name: string);
  66757. /**
  66758. * Gets the current class name
  66759. * @returns the class name
  66760. */
  66761. getClassName(): string;
  66762. /**
  66763. * Gets the x operand input component
  66764. */
  66765. get x(): NodeMaterialConnectionPoint;
  66766. /**
  66767. * Gets the y operand input component
  66768. */
  66769. get y(): NodeMaterialConnectionPoint;
  66770. /**
  66771. * Gets the output component
  66772. */
  66773. get output(): NodeMaterialConnectionPoint;
  66774. protected _buildBlock(state: NodeMaterialBuildState): this;
  66775. }
  66776. }
  66777. declare module "babylonjs/Materials/Node/Blocks/smoothStepBlock" {
  66778. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  66779. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  66780. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  66781. /**
  66782. * Block used to smooth step a value
  66783. */
  66784. export class SmoothStepBlock extends NodeMaterialBlock {
  66785. /**
  66786. * Creates a new SmoothStepBlock
  66787. * @param name defines the block name
  66788. */
  66789. constructor(name: string);
  66790. /**
  66791. * Gets the current class name
  66792. * @returns the class name
  66793. */
  66794. getClassName(): string;
  66795. /**
  66796. * Gets the value operand input component
  66797. */
  66798. get value(): NodeMaterialConnectionPoint;
  66799. /**
  66800. * Gets the first edge operand input component
  66801. */
  66802. get edge0(): NodeMaterialConnectionPoint;
  66803. /**
  66804. * Gets the second edge operand input component
  66805. */
  66806. get edge1(): NodeMaterialConnectionPoint;
  66807. /**
  66808. * Gets the output component
  66809. */
  66810. get output(): NodeMaterialConnectionPoint;
  66811. protected _buildBlock(state: NodeMaterialBuildState): this;
  66812. }
  66813. }
  66814. declare module "babylonjs/Materials/Node/Blocks/reciprocalBlock" {
  66815. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  66816. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  66817. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  66818. /**
  66819. * Block used to get the reciprocal (1 / x) of a value
  66820. */
  66821. export class ReciprocalBlock extends NodeMaterialBlock {
  66822. /**
  66823. * Creates a new ReciprocalBlock
  66824. * @param name defines the block name
  66825. */
  66826. constructor(name: string);
  66827. /**
  66828. * Gets the current class name
  66829. * @returns the class name
  66830. */
  66831. getClassName(): string;
  66832. /**
  66833. * Gets the input component
  66834. */
  66835. get input(): NodeMaterialConnectionPoint;
  66836. /**
  66837. * Gets the output component
  66838. */
  66839. get output(): NodeMaterialConnectionPoint;
  66840. protected _buildBlock(state: NodeMaterialBuildState): this;
  66841. }
  66842. }
  66843. declare module "babylonjs/Materials/Node/Blocks/replaceColorBlock" {
  66844. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  66845. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  66846. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  66847. /**
  66848. * Block used to replace a color by another one
  66849. */
  66850. export class ReplaceColorBlock extends NodeMaterialBlock {
  66851. /**
  66852. * Creates a new ReplaceColorBlock
  66853. * @param name defines the block name
  66854. */
  66855. constructor(name: string);
  66856. /**
  66857. * Gets the current class name
  66858. * @returns the class name
  66859. */
  66860. getClassName(): string;
  66861. /**
  66862. * Gets the value input component
  66863. */
  66864. get value(): NodeMaterialConnectionPoint;
  66865. /**
  66866. * Gets the reference input component
  66867. */
  66868. get reference(): NodeMaterialConnectionPoint;
  66869. /**
  66870. * Gets the distance input component
  66871. */
  66872. get distance(): NodeMaterialConnectionPoint;
  66873. /**
  66874. * Gets the replacement input component
  66875. */
  66876. get replacement(): NodeMaterialConnectionPoint;
  66877. /**
  66878. * Gets the output component
  66879. */
  66880. get output(): NodeMaterialConnectionPoint;
  66881. protected _buildBlock(state: NodeMaterialBuildState): this;
  66882. }
  66883. }
  66884. declare module "babylonjs/Materials/Node/Blocks/posterizeBlock" {
  66885. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  66886. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  66887. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  66888. /**
  66889. * Block used to posterize a value
  66890. * @see https://en.wikipedia.org/wiki/Posterization
  66891. */
  66892. export class PosterizeBlock extends NodeMaterialBlock {
  66893. /**
  66894. * Creates a new PosterizeBlock
  66895. * @param name defines the block name
  66896. */
  66897. constructor(name: string);
  66898. /**
  66899. * Gets the current class name
  66900. * @returns the class name
  66901. */
  66902. getClassName(): string;
  66903. /**
  66904. * Gets the value input component
  66905. */
  66906. get value(): NodeMaterialConnectionPoint;
  66907. /**
  66908. * Gets the steps input component
  66909. */
  66910. get steps(): NodeMaterialConnectionPoint;
  66911. /**
  66912. * Gets the output component
  66913. */
  66914. get output(): NodeMaterialConnectionPoint;
  66915. protected _buildBlock(state: NodeMaterialBuildState): this;
  66916. }
  66917. }
  66918. declare module "babylonjs/Materials/Node/Blocks/waveBlock" {
  66919. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  66920. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  66921. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  66922. import { Scene } from "babylonjs/scene";
  66923. /**
  66924. * Operations supported by the Wave block
  66925. */
  66926. export enum WaveBlockKind {
  66927. /** SawTooth */
  66928. SawTooth = 0,
  66929. /** Square */
  66930. Square = 1,
  66931. /** Triangle */
  66932. Triangle = 2
  66933. }
  66934. /**
  66935. * Block used to apply wave operation to floats
  66936. */
  66937. export class WaveBlock extends NodeMaterialBlock {
  66938. /**
  66939. * Gets or sets the kibnd of wave to be applied by the block
  66940. */
  66941. kind: WaveBlockKind;
  66942. /**
  66943. * Creates a new WaveBlock
  66944. * @param name defines the block name
  66945. */
  66946. constructor(name: string);
  66947. /**
  66948. * Gets the current class name
  66949. * @returns the class name
  66950. */
  66951. getClassName(): string;
  66952. /**
  66953. * Gets the input component
  66954. */
  66955. get input(): NodeMaterialConnectionPoint;
  66956. /**
  66957. * Gets the output component
  66958. */
  66959. get output(): NodeMaterialConnectionPoint;
  66960. protected _buildBlock(state: NodeMaterialBuildState): this;
  66961. serialize(): any;
  66962. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  66963. }
  66964. }
  66965. declare module "babylonjs/Materials/Node/Blocks/gradientBlock" {
  66966. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  66967. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  66968. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  66969. import { Color3 } from "babylonjs/Maths/math.color";
  66970. import { Scene } from "babylonjs/scene";
  66971. /**
  66972. * Class used to store a color step for the GradientBlock
  66973. */
  66974. export class GradientBlockColorStep {
  66975. /**
  66976. * Gets or sets a value indicating which step this color is associated with (between 0 and 1)
  66977. */
  66978. step: number;
  66979. /**
  66980. * Gets or sets the color associated with this step
  66981. */
  66982. color: Color3;
  66983. /**
  66984. * Creates a new GradientBlockColorStep
  66985. * @param step defines a value indicating which step this color is associated with (between 0 and 1)
  66986. * @param color defines the color associated with this step
  66987. */
  66988. constructor(
  66989. /**
  66990. * Gets or sets a value indicating which step this color is associated with (between 0 and 1)
  66991. */
  66992. step: number,
  66993. /**
  66994. * Gets or sets the color associated with this step
  66995. */
  66996. color: Color3);
  66997. }
  66998. /**
  66999. * Block used to return a color from a gradient based on an input value between 0 and 1
  67000. */
  67001. export class GradientBlock extends NodeMaterialBlock {
  67002. /**
  67003. * Gets or sets the list of color steps
  67004. */
  67005. colorSteps: GradientBlockColorStep[];
  67006. /**
  67007. * Creates a new GradientBlock
  67008. * @param name defines the block name
  67009. */
  67010. constructor(name: string);
  67011. /**
  67012. * Gets the current class name
  67013. * @returns the class name
  67014. */
  67015. getClassName(): string;
  67016. /**
  67017. * Gets the gradient input component
  67018. */
  67019. get gradient(): NodeMaterialConnectionPoint;
  67020. /**
  67021. * Gets the output component
  67022. */
  67023. get output(): NodeMaterialConnectionPoint;
  67024. private _writeColorConstant;
  67025. protected _buildBlock(state: NodeMaterialBuildState): this | undefined;
  67026. serialize(): any;
  67027. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  67028. protected _dumpPropertiesCode(): string;
  67029. }
  67030. }
  67031. declare module "babylonjs/Materials/Node/Blocks/nLerpBlock" {
  67032. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  67033. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  67034. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  67035. /**
  67036. * Block used to normalize lerp between 2 values
  67037. */
  67038. export class NLerpBlock extends NodeMaterialBlock {
  67039. /**
  67040. * Creates a new NLerpBlock
  67041. * @param name defines the block name
  67042. */
  67043. constructor(name: string);
  67044. /**
  67045. * Gets the current class name
  67046. * @returns the class name
  67047. */
  67048. getClassName(): string;
  67049. /**
  67050. * Gets the left operand input component
  67051. */
  67052. get left(): NodeMaterialConnectionPoint;
  67053. /**
  67054. * Gets the right operand input component
  67055. */
  67056. get right(): NodeMaterialConnectionPoint;
  67057. /**
  67058. * Gets the gradient operand input component
  67059. */
  67060. get gradient(): NodeMaterialConnectionPoint;
  67061. /**
  67062. * Gets the output component
  67063. */
  67064. get output(): NodeMaterialConnectionPoint;
  67065. protected _buildBlock(state: NodeMaterialBuildState): this;
  67066. }
  67067. }
  67068. declare module "babylonjs/Materials/Node/Blocks/worleyNoise3DBlock" {
  67069. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  67070. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  67071. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  67072. import { Scene } from "babylonjs/scene";
  67073. /**
  67074. * block used to Generate a Worley Noise 3D Noise Pattern
  67075. */
  67076. export class WorleyNoise3DBlock extends NodeMaterialBlock {
  67077. /** Gets or sets a boolean indicating that normal should be inverted on X axis */
  67078. manhattanDistance: boolean;
  67079. /**
  67080. * Creates a new WorleyNoise3DBlock
  67081. * @param name defines the block name
  67082. */
  67083. constructor(name: string);
  67084. /**
  67085. * Gets the current class name
  67086. * @returns the class name
  67087. */
  67088. getClassName(): string;
  67089. /**
  67090. * Gets the seed input component
  67091. */
  67092. get seed(): NodeMaterialConnectionPoint;
  67093. /**
  67094. * Gets the jitter input component
  67095. */
  67096. get jitter(): NodeMaterialConnectionPoint;
  67097. /**
  67098. * Gets the output component
  67099. */
  67100. get output(): NodeMaterialConnectionPoint;
  67101. protected _buildBlock(state: NodeMaterialBuildState): this | undefined;
  67102. /**
  67103. * Exposes the properties to the UI?
  67104. */
  67105. protected _dumpPropertiesCode(): string;
  67106. /**
  67107. * Exposes the properties to the Seralize?
  67108. */
  67109. serialize(): any;
  67110. /**
  67111. * Exposes the properties to the deseralize?
  67112. */
  67113. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  67114. }
  67115. }
  67116. declare module "babylonjs/Materials/Node/Blocks/simplexPerlin3DBlock" {
  67117. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  67118. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  67119. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  67120. /**
  67121. * block used to Generate a Simplex Perlin 3d Noise Pattern
  67122. */
  67123. export class SimplexPerlin3DBlock extends NodeMaterialBlock {
  67124. /**
  67125. * Creates a new SimplexPerlin3DBlock
  67126. * @param name defines the block name
  67127. */
  67128. constructor(name: string);
  67129. /**
  67130. * Gets the current class name
  67131. * @returns the class name
  67132. */
  67133. getClassName(): string;
  67134. /**
  67135. * Gets the seed operand input component
  67136. */
  67137. get seed(): NodeMaterialConnectionPoint;
  67138. /**
  67139. * Gets the output component
  67140. */
  67141. get output(): NodeMaterialConnectionPoint;
  67142. protected _buildBlock(state: NodeMaterialBuildState): this | undefined;
  67143. }
  67144. }
  67145. declare module "babylonjs/Materials/Node/Blocks/normalBlendBlock" {
  67146. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  67147. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  67148. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  67149. /**
  67150. * Block used to blend normals
  67151. */
  67152. export class NormalBlendBlock extends NodeMaterialBlock {
  67153. /**
  67154. * Creates a new NormalBlendBlock
  67155. * @param name defines the block name
  67156. */
  67157. constructor(name: string);
  67158. /**
  67159. * Gets the current class name
  67160. * @returns the class name
  67161. */
  67162. getClassName(): string;
  67163. /**
  67164. * Gets the first input component
  67165. */
  67166. get normalMap0(): NodeMaterialConnectionPoint;
  67167. /**
  67168. * Gets the second input component
  67169. */
  67170. get normalMap1(): NodeMaterialConnectionPoint;
  67171. /**
  67172. * Gets the output component
  67173. */
  67174. get output(): NodeMaterialConnectionPoint;
  67175. protected _buildBlock(state: NodeMaterialBuildState): this;
  67176. }
  67177. }
  67178. declare module "babylonjs/Materials/Node/Blocks/rotate2dBlock" {
  67179. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  67180. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  67181. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  67182. import { NodeMaterial } from "babylonjs/Materials/Node/nodeMaterial";
  67183. /**
  67184. * Block used to rotate a 2d vector by a given angle
  67185. */
  67186. export class Rotate2dBlock extends NodeMaterialBlock {
  67187. /**
  67188. * Creates a new Rotate2dBlock
  67189. * @param name defines the block name
  67190. */
  67191. constructor(name: string);
  67192. /**
  67193. * Gets the current class name
  67194. * @returns the class name
  67195. */
  67196. getClassName(): string;
  67197. /**
  67198. * Gets the input vector
  67199. */
  67200. get input(): NodeMaterialConnectionPoint;
  67201. /**
  67202. * Gets the input angle
  67203. */
  67204. get angle(): NodeMaterialConnectionPoint;
  67205. /**
  67206. * Gets the output component
  67207. */
  67208. get output(): NodeMaterialConnectionPoint;
  67209. autoConfigure(material: NodeMaterial): void;
  67210. protected _buildBlock(state: NodeMaterialBuildState): this;
  67211. }
  67212. }
  67213. declare module "babylonjs/Materials/Node/Blocks/reflectBlock" {
  67214. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  67215. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  67216. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  67217. /**
  67218. * Block used to get the reflected vector from a direction and a normal
  67219. */
  67220. export class ReflectBlock extends NodeMaterialBlock {
  67221. /**
  67222. * Creates a new ReflectBlock
  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 incident component
  67233. */
  67234. get incident(): NodeMaterialConnectionPoint;
  67235. /**
  67236. * Gets the normal component
  67237. */
  67238. get normal(): NodeMaterialConnectionPoint;
  67239. /**
  67240. * Gets the output component
  67241. */
  67242. get output(): NodeMaterialConnectionPoint;
  67243. protected _buildBlock(state: NodeMaterialBuildState): this;
  67244. }
  67245. }
  67246. declare module "babylonjs/Materials/Node/Blocks/refractBlock" {
  67247. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  67248. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  67249. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  67250. /**
  67251. * Block used to get the refracted vector from a direction and a normal
  67252. */
  67253. export class RefractBlock extends NodeMaterialBlock {
  67254. /**
  67255. * Creates a new RefractBlock
  67256. * @param name defines the block name
  67257. */
  67258. constructor(name: string);
  67259. /**
  67260. * Gets the current class name
  67261. * @returns the class name
  67262. */
  67263. getClassName(): string;
  67264. /**
  67265. * Gets the incident component
  67266. */
  67267. get incident(): NodeMaterialConnectionPoint;
  67268. /**
  67269. * Gets the normal component
  67270. */
  67271. get normal(): NodeMaterialConnectionPoint;
  67272. /**
  67273. * Gets the index of refraction component
  67274. */
  67275. get ior(): NodeMaterialConnectionPoint;
  67276. /**
  67277. * Gets the output component
  67278. */
  67279. get output(): NodeMaterialConnectionPoint;
  67280. protected _buildBlock(state: NodeMaterialBuildState): this;
  67281. }
  67282. }
  67283. declare module "babylonjs/Materials/Node/Blocks/desaturateBlock" {
  67284. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  67285. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  67286. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  67287. /**
  67288. * Block used to desaturate a color
  67289. */
  67290. export class DesaturateBlock extends NodeMaterialBlock {
  67291. /**
  67292. * Creates a new DesaturateBlock
  67293. * @param name defines the block name
  67294. */
  67295. constructor(name: string);
  67296. /**
  67297. * Gets the current class name
  67298. * @returns the class name
  67299. */
  67300. getClassName(): string;
  67301. /**
  67302. * Gets the color operand input component
  67303. */
  67304. get color(): NodeMaterialConnectionPoint;
  67305. /**
  67306. * Gets the level operand input component
  67307. */
  67308. get level(): NodeMaterialConnectionPoint;
  67309. /**
  67310. * Gets the output component
  67311. */
  67312. get output(): NodeMaterialConnectionPoint;
  67313. protected _buildBlock(state: NodeMaterialBuildState): this;
  67314. }
  67315. }
  67316. declare module "babylonjs/Materials/Node/Blocks/PBR/ambientOcclusionBlock" {
  67317. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  67318. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  67319. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  67320. import { NodeMaterial, NodeMaterialDefines } from "babylonjs/Materials/Node/nodeMaterial";
  67321. import { Nullable } from "babylonjs/types";
  67322. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  67323. import { Scene } from "babylonjs/scene";
  67324. /**
  67325. * Block used to implement the ambient occlusion module of the PBR material
  67326. */
  67327. export class AmbientOcclusionBlock extends NodeMaterialBlock {
  67328. /**
  67329. * Create a new AmbientOcclusionBlock
  67330. * @param name defines the block name
  67331. */
  67332. constructor(name: string);
  67333. /**
  67334. * Specifies if the ambient texture contains the ambient occlusion information in its red channel only.
  67335. */
  67336. useAmbientInGrayScale: boolean;
  67337. /**
  67338. * Initialize the block and prepare the context for build
  67339. * @param state defines the state that will be used for the build
  67340. */
  67341. initialize(state: NodeMaterialBuildState): void;
  67342. /**
  67343. * Gets the current class name
  67344. * @returns the class name
  67345. */
  67346. getClassName(): string;
  67347. /**
  67348. * Gets the texture input component
  67349. */
  67350. get texture(): NodeMaterialConnectionPoint;
  67351. /**
  67352. * Gets the texture intensity component
  67353. */
  67354. get intensity(): NodeMaterialConnectionPoint;
  67355. /**
  67356. * Gets the direct light intensity input component
  67357. */
  67358. get directLightIntensity(): NodeMaterialConnectionPoint;
  67359. /**
  67360. * Gets the ambient occlusion object output component
  67361. */
  67362. get ambientOcclusion(): NodeMaterialConnectionPoint;
  67363. /**
  67364. * Gets the main code of the block (fragment side)
  67365. * @param block instance of an AmbientOcclusionBlock or null if the code must be generated without an active ambient occlusion module
  67366. * @returns the shader code
  67367. */
  67368. static GetCode(block: Nullable<AmbientOcclusionBlock>): string;
  67369. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  67370. protected _buildBlock(state: NodeMaterialBuildState): this;
  67371. protected _dumpPropertiesCode(): string;
  67372. serialize(): any;
  67373. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  67374. }
  67375. }
  67376. declare module "babylonjs/Materials/Node/Blocks/PBR/reflectionBlock" {
  67377. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  67378. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  67379. import { NodeMaterial, NodeMaterialDefines } from "babylonjs/Materials/Node/nodeMaterial";
  67380. import { ReflectionTextureBaseBlock } from "babylonjs/Materials/Node/Blocks/Dual/reflectionTextureBaseBlock";
  67381. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  67382. import { Nullable } from "babylonjs/types";
  67383. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  67384. import { Mesh } from "babylonjs/Meshes/mesh";
  67385. import { SubMesh } from "babylonjs/Meshes/subMesh";
  67386. import { Effect } from "babylonjs/Materials/effect";
  67387. import { Scene } from "babylonjs/scene";
  67388. /**
  67389. * Block used to implement the reflection module of the PBR material
  67390. */
  67391. export class ReflectionBlock extends ReflectionTextureBaseBlock {
  67392. /** @hidden */
  67393. _defineLODReflectionAlpha: string;
  67394. /** @hidden */
  67395. _defineLinearSpecularReflection: string;
  67396. private _vEnvironmentIrradianceName;
  67397. /** @hidden */
  67398. _vReflectionMicrosurfaceInfosName: string;
  67399. /** @hidden */
  67400. _vReflectionInfosName: string;
  67401. /** @hidden */
  67402. _vReflectionFilteringInfoName: string;
  67403. private _scene;
  67404. /**
  67405. * The three properties below are set by the main PBR block prior to calling methods of this class.
  67406. * This is to avoid having to add them as inputs here whereas they are already inputs of the main block, so already known.
  67407. * It's less burden on the user side in the editor part.
  67408. */
  67409. /** @hidden */
  67410. worldPositionConnectionPoint: NodeMaterialConnectionPoint;
  67411. /** @hidden */
  67412. worldNormalConnectionPoint: NodeMaterialConnectionPoint;
  67413. /** @hidden */
  67414. cameraPositionConnectionPoint: NodeMaterialConnectionPoint;
  67415. /**
  67416. * Defines if the material uses spherical harmonics vs spherical polynomials for the
  67417. * diffuse part of the IBL.
  67418. */
  67419. useSphericalHarmonics: boolean;
  67420. /**
  67421. * Force the shader to compute irradiance in the fragment shader in order to take bump in account.
  67422. */
  67423. forceIrradianceInFragment: boolean;
  67424. /**
  67425. * Create a new ReflectionBlock
  67426. * @param name defines the block name
  67427. */
  67428. constructor(name: string);
  67429. /**
  67430. * Gets the current class name
  67431. * @returns the class name
  67432. */
  67433. getClassName(): string;
  67434. /**
  67435. * Gets the position input component
  67436. */
  67437. get position(): NodeMaterialConnectionPoint;
  67438. /**
  67439. * Gets the world position input component
  67440. */
  67441. get worldPosition(): NodeMaterialConnectionPoint;
  67442. /**
  67443. * Gets the world normal input component
  67444. */
  67445. get worldNormal(): NodeMaterialConnectionPoint;
  67446. /**
  67447. * Gets the world input component
  67448. */
  67449. get world(): NodeMaterialConnectionPoint;
  67450. /**
  67451. * Gets the camera (or eye) position component
  67452. */
  67453. get cameraPosition(): NodeMaterialConnectionPoint;
  67454. /**
  67455. * Gets the view input component
  67456. */
  67457. get view(): NodeMaterialConnectionPoint;
  67458. /**
  67459. * Gets the color input component
  67460. */
  67461. get color(): NodeMaterialConnectionPoint;
  67462. /**
  67463. * Gets the reflection object output component
  67464. */
  67465. get reflection(): NodeMaterialConnectionPoint;
  67466. /**
  67467. * Returns true if the block has a texture (either its own texture or the environment texture from the scene, if set)
  67468. */
  67469. get hasTexture(): boolean;
  67470. /**
  67471. * Gets the reflection color (either the name of the variable if the color input is connected, else a default value)
  67472. */
  67473. get reflectionColor(): string;
  67474. protected _getTexture(): Nullable<BaseTexture>;
  67475. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  67476. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh, subMesh?: SubMesh): void;
  67477. /**
  67478. * Gets the code to inject in the vertex shader
  67479. * @param state current state of the node material building
  67480. * @returns the shader code
  67481. */
  67482. handleVertexSide(state: NodeMaterialBuildState): string;
  67483. /**
  67484. * Gets the main code of the block (fragment side)
  67485. * @param state current state of the node material building
  67486. * @param normalVarName name of the existing variable corresponding to the normal
  67487. * @returns the shader code
  67488. */
  67489. getCode(state: NodeMaterialBuildState, normalVarName: string): string;
  67490. protected _buildBlock(state: NodeMaterialBuildState): this;
  67491. protected _dumpPropertiesCode(): string;
  67492. serialize(): any;
  67493. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  67494. }
  67495. }
  67496. declare module "babylonjs/Materials/Node/Blocks/PBR/sheenBlock" {
  67497. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  67498. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  67499. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  67500. import { NodeMaterial, NodeMaterialDefines } from "babylonjs/Materials/Node/nodeMaterial";
  67501. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  67502. import { ReflectionBlock } from "babylonjs/Materials/Node/Blocks/PBR/reflectionBlock";
  67503. import { Scene } from "babylonjs/scene";
  67504. import { Nullable } from "babylonjs/types";
  67505. /**
  67506. * Block used to implement the sheen module of the PBR material
  67507. */
  67508. export class SheenBlock extends NodeMaterialBlock {
  67509. /**
  67510. * Create a new SheenBlock
  67511. * @param name defines the block name
  67512. */
  67513. constructor(name: string);
  67514. /**
  67515. * If true, the sheen effect is layered above the base BRDF with the albedo-scaling technique.
  67516. * It allows the strength of the sheen effect to not depend on the base color of the material,
  67517. * making it easier to setup and tweak the effect
  67518. */
  67519. albedoScaling: boolean;
  67520. /**
  67521. * Defines if the sheen is linked to the sheen color.
  67522. */
  67523. linkSheenWithAlbedo: boolean;
  67524. /**
  67525. * Initialize the block and prepare the context for build
  67526. * @param state defines the state that will be used for the build
  67527. */
  67528. initialize(state: NodeMaterialBuildState): void;
  67529. /**
  67530. * Gets the current class name
  67531. * @returns the class name
  67532. */
  67533. getClassName(): string;
  67534. /**
  67535. * Gets the intensity input component
  67536. */
  67537. get intensity(): NodeMaterialConnectionPoint;
  67538. /**
  67539. * Gets the color input component
  67540. */
  67541. get color(): NodeMaterialConnectionPoint;
  67542. /**
  67543. * Gets the roughness input component
  67544. */
  67545. get roughness(): NodeMaterialConnectionPoint;
  67546. /**
  67547. * Gets the sheen object output component
  67548. */
  67549. get sheen(): NodeMaterialConnectionPoint;
  67550. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  67551. /**
  67552. * Gets the main code of the block (fragment side)
  67553. * @param reflectionBlock instance of a ReflectionBlock null if the code must be generated without an active reflection module
  67554. * @returns the shader code
  67555. */
  67556. getCode(reflectionBlock: Nullable<ReflectionBlock>): string;
  67557. protected _buildBlock(state: NodeMaterialBuildState): this;
  67558. protected _dumpPropertiesCode(): string;
  67559. serialize(): any;
  67560. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  67561. }
  67562. }
  67563. declare module "babylonjs/Materials/Node/Blocks/PBR/reflectivityBlock" {
  67564. import { NodeMaterial, NodeMaterialDefines } from "babylonjs/Materials/Node/nodeMaterial";
  67565. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  67566. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  67567. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  67568. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  67569. import { Scene } from "babylonjs/scene";
  67570. import { Nullable } from "babylonjs/types";
  67571. import { Mesh } from "babylonjs/Meshes/mesh";
  67572. import { SubMesh } from "babylonjs/Meshes/subMesh";
  67573. import { Effect } from "babylonjs/Materials/effect";
  67574. /**
  67575. * Block used to implement the reflectivity module of the PBR material
  67576. */
  67577. export class ReflectivityBlock extends NodeMaterialBlock {
  67578. private _metallicReflectanceColor;
  67579. private _metallicF0Factor;
  67580. /** @hidden */
  67581. _vMetallicReflectanceFactorsName: string;
  67582. /**
  67583. * The property below is set by the main PBR block prior to calling methods of this class.
  67584. */
  67585. /** @hidden */
  67586. indexOfRefractionConnectionPoint: Nullable<NodeMaterialConnectionPoint>;
  67587. /**
  67588. * Specifies if the metallic texture contains the ambient occlusion information in its red channel.
  67589. */
  67590. useAmbientOcclusionFromMetallicTextureRed: boolean;
  67591. /**
  67592. * Specifies if the metallic texture contains the metallness information in its blue channel.
  67593. */
  67594. useMetallnessFromMetallicTextureBlue: boolean;
  67595. /**
  67596. * Specifies if the metallic texture contains the roughness information in its alpha channel.
  67597. */
  67598. useRoughnessFromMetallicTextureAlpha: boolean;
  67599. /**
  67600. * Specifies if the metallic texture contains the roughness information in its green channel.
  67601. */
  67602. useRoughnessFromMetallicTextureGreen: boolean;
  67603. /**
  67604. * Create a new ReflectivityBlock
  67605. * @param name defines the block name
  67606. */
  67607. constructor(name: string);
  67608. /**
  67609. * Initialize the block and prepare the context for build
  67610. * @param state defines the state that will be used for the build
  67611. */
  67612. initialize(state: NodeMaterialBuildState): void;
  67613. /**
  67614. * Gets the current class name
  67615. * @returns the class name
  67616. */
  67617. getClassName(): string;
  67618. /**
  67619. * Gets the metallic input component
  67620. */
  67621. get metallic(): NodeMaterialConnectionPoint;
  67622. /**
  67623. * Gets the roughness input component
  67624. */
  67625. get roughness(): NodeMaterialConnectionPoint;
  67626. /**
  67627. * Gets the texture input component
  67628. */
  67629. get texture(): NodeMaterialConnectionPoint;
  67630. /**
  67631. * Gets the reflectivity object output component
  67632. */
  67633. get reflectivity(): NodeMaterialConnectionPoint;
  67634. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh, subMesh?: SubMesh): void;
  67635. /**
  67636. * Gets the main code of the block (fragment side)
  67637. * @param state current state of the node material building
  67638. * @param aoIntensityVarName name of the variable with the ambient occlusion intensity
  67639. * @returns the shader code
  67640. */
  67641. getCode(state: NodeMaterialBuildState, aoIntensityVarName: string): string;
  67642. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  67643. protected _buildBlock(state: NodeMaterialBuildState): this;
  67644. protected _dumpPropertiesCode(): string;
  67645. serialize(): any;
  67646. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  67647. }
  67648. }
  67649. declare module "babylonjs/Materials/Node/Blocks/PBR/anisotropyBlock" {
  67650. import { NodeMaterial, NodeMaterialDefines } from "babylonjs/Materials/Node/nodeMaterial";
  67651. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  67652. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  67653. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  67654. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  67655. /**
  67656. * Block used to implement the anisotropy module of the PBR material
  67657. */
  67658. export class AnisotropyBlock extends NodeMaterialBlock {
  67659. /**
  67660. * The two properties below are set by the main PBR block prior to calling methods of this class.
  67661. * This is to avoid having to add them as inputs here whereas they are already inputs of the main block, so already known.
  67662. * It's less burden on the user side in the editor part.
  67663. */
  67664. /** @hidden */
  67665. worldPositionConnectionPoint: NodeMaterialConnectionPoint;
  67666. /** @hidden */
  67667. worldNormalConnectionPoint: NodeMaterialConnectionPoint;
  67668. /**
  67669. * Create a new AnisotropyBlock
  67670. * @param name defines the block name
  67671. */
  67672. constructor(name: string);
  67673. /**
  67674. * Initialize the block and prepare the context for build
  67675. * @param state defines the state that will be used for the build
  67676. */
  67677. initialize(state: NodeMaterialBuildState): void;
  67678. /**
  67679. * Gets the current class name
  67680. * @returns the class name
  67681. */
  67682. getClassName(): string;
  67683. /**
  67684. * Gets the intensity input component
  67685. */
  67686. get intensity(): NodeMaterialConnectionPoint;
  67687. /**
  67688. * Gets the direction input component
  67689. */
  67690. get direction(): NodeMaterialConnectionPoint;
  67691. /**
  67692. * Gets the texture input component
  67693. */
  67694. get texture(): NodeMaterialConnectionPoint;
  67695. /**
  67696. * Gets the uv input component
  67697. */
  67698. get uv(): NodeMaterialConnectionPoint;
  67699. /**
  67700. * Gets the worldTangent input component
  67701. */
  67702. get worldTangent(): NodeMaterialConnectionPoint;
  67703. /**
  67704. * Gets the anisotropy object output component
  67705. */
  67706. get anisotropy(): NodeMaterialConnectionPoint;
  67707. private _generateTBNSpace;
  67708. /**
  67709. * Gets the main code of the block (fragment side)
  67710. * @param state current state of the node material building
  67711. * @param generateTBNSpace if true, the code needed to create the TBN coordinate space is generated
  67712. * @returns the shader code
  67713. */
  67714. getCode(state: NodeMaterialBuildState, generateTBNSpace?: boolean): string;
  67715. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  67716. protected _buildBlock(state: NodeMaterialBuildState): this;
  67717. }
  67718. }
  67719. declare module "babylonjs/Materials/Node/Blocks/PBR/clearCoatBlock" {
  67720. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  67721. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  67722. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  67723. import { NodeMaterial, NodeMaterialDefines } from "babylonjs/Materials/Node/nodeMaterial";
  67724. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  67725. import { ReflectionBlock } from "babylonjs/Materials/Node/Blocks/PBR/reflectionBlock";
  67726. import { Nullable } from "babylonjs/types";
  67727. import { Mesh } from "babylonjs/Meshes/mesh";
  67728. import { SubMesh } from "babylonjs/Meshes/subMesh";
  67729. import { Effect } from "babylonjs/Materials/effect";
  67730. /**
  67731. * Block used to implement the clear coat module of the PBR material
  67732. */
  67733. export class ClearCoatBlock extends NodeMaterialBlock {
  67734. private _scene;
  67735. /**
  67736. * Create a new ClearCoatBlock
  67737. * @param name defines the block name
  67738. */
  67739. constructor(name: string);
  67740. /**
  67741. * Initialize the block and prepare the context for build
  67742. * @param state defines the state that will be used for the build
  67743. */
  67744. initialize(state: NodeMaterialBuildState): void;
  67745. /**
  67746. * Gets the current class name
  67747. * @returns the class name
  67748. */
  67749. getClassName(): string;
  67750. /**
  67751. * Gets the intensity input component
  67752. */
  67753. get intensity(): NodeMaterialConnectionPoint;
  67754. /**
  67755. * Gets the roughness input component
  67756. */
  67757. get roughness(): NodeMaterialConnectionPoint;
  67758. /**
  67759. * Gets the ior input component
  67760. */
  67761. get ior(): NodeMaterialConnectionPoint;
  67762. /**
  67763. * Gets the texture input component
  67764. */
  67765. get texture(): NodeMaterialConnectionPoint;
  67766. /**
  67767. * Gets the bump texture input component
  67768. */
  67769. get bumpTexture(): NodeMaterialConnectionPoint;
  67770. /**
  67771. * Gets the uv input component
  67772. */
  67773. get uv(): NodeMaterialConnectionPoint;
  67774. /**
  67775. * Gets the tint color input component
  67776. */
  67777. get tintColor(): NodeMaterialConnectionPoint;
  67778. /**
  67779. * Gets the tint "at distance" input component
  67780. */
  67781. get tintAtDistance(): NodeMaterialConnectionPoint;
  67782. /**
  67783. * Gets the tint thickness input component
  67784. */
  67785. get tintThickness(): NodeMaterialConnectionPoint;
  67786. /**
  67787. * Gets the world tangent input component
  67788. */
  67789. get worldTangent(): NodeMaterialConnectionPoint;
  67790. /**
  67791. * Gets the clear coat object output component
  67792. */
  67793. get clearcoat(): NodeMaterialConnectionPoint;
  67794. autoConfigure(material: NodeMaterial): void;
  67795. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  67796. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh, subMesh?: SubMesh): void;
  67797. private _generateTBNSpace;
  67798. /**
  67799. * Gets the main code of the block (fragment side)
  67800. * @param state current state of the node material building
  67801. * @param ccBlock instance of a ClearCoatBlock or null if the code must be generated without an active clear coat module
  67802. * @param reflectionBlock instance of a ReflectionBlock null if the code must be generated without an active reflection module
  67803. * @param worldPosVarName name of the variable holding the world position
  67804. * @param generateTBNSpace if true, the code needed to create the TBN coordinate space is generated
  67805. * @param vTBNAvailable indicate that the vTBN variable is already existing because it has already been generated by another block (PerturbNormal or Anisotropy)
  67806. * @param worldNormalVarName name of the variable holding the world normal
  67807. * @returns the shader code
  67808. */
  67809. static GetCode(state: NodeMaterialBuildState, ccBlock: Nullable<ClearCoatBlock>, reflectionBlock: Nullable<ReflectionBlock>, worldPosVarName: string, generateTBNSpace: boolean, vTBNAvailable: boolean, worldNormalVarName: string): string;
  67810. protected _buildBlock(state: NodeMaterialBuildState): this;
  67811. }
  67812. }
  67813. declare module "babylonjs/Materials/Node/Blocks/PBR/subSurfaceBlock" {
  67814. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  67815. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  67816. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  67817. import { NodeMaterial, NodeMaterialDefines } from "babylonjs/Materials/Node/nodeMaterial";
  67818. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  67819. import { ReflectionBlock } from "babylonjs/Materials/Node/Blocks/PBR/reflectionBlock";
  67820. import { Nullable } from "babylonjs/types";
  67821. /**
  67822. * Block used to implement the sub surface module of the PBR material
  67823. */
  67824. export class SubSurfaceBlock extends NodeMaterialBlock {
  67825. /**
  67826. * Create a new SubSurfaceBlock
  67827. * @param name defines the block name
  67828. */
  67829. constructor(name: string);
  67830. /**
  67831. * Stores the intensity of the different subsurface effects in the thickness texture.
  67832. * * the green channel is the translucency intensity.
  67833. * * the blue channel is the scattering intensity.
  67834. * * the alpha channel is the refraction intensity.
  67835. */
  67836. useMaskFromThicknessTexture: boolean;
  67837. /**
  67838. * Initialize the block and prepare the context for build
  67839. * @param state defines the state that will be used for the build
  67840. */
  67841. initialize(state: NodeMaterialBuildState): void;
  67842. /**
  67843. * Gets the current class name
  67844. * @returns the class name
  67845. */
  67846. getClassName(): string;
  67847. /**
  67848. * Gets the min thickness input component
  67849. */
  67850. get minThickness(): NodeMaterialConnectionPoint;
  67851. /**
  67852. * Gets the max thickness input component
  67853. */
  67854. get maxThickness(): NodeMaterialConnectionPoint;
  67855. /**
  67856. * Gets the thickness texture component
  67857. */
  67858. get thicknessTexture(): NodeMaterialConnectionPoint;
  67859. /**
  67860. * Gets the tint color input component
  67861. */
  67862. get tintColor(): NodeMaterialConnectionPoint;
  67863. /**
  67864. * Gets the translucency intensity input component
  67865. */
  67866. get translucencyIntensity(): NodeMaterialConnectionPoint;
  67867. /**
  67868. * Gets the translucency diffusion distance input component
  67869. */
  67870. get translucencyDiffusionDistance(): NodeMaterialConnectionPoint;
  67871. /**
  67872. * Gets the refraction object parameters
  67873. */
  67874. get refraction(): NodeMaterialConnectionPoint;
  67875. /**
  67876. * Gets the sub surface object output component
  67877. */
  67878. get subsurface(): NodeMaterialConnectionPoint;
  67879. autoConfigure(material: NodeMaterial): void;
  67880. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  67881. /**
  67882. * Gets the main code of the block (fragment side)
  67883. * @param state current state of the node material building
  67884. * @param ssBlock instance of a SubSurfaceBlock or null if the code must be generated without an active sub surface module
  67885. * @param reflectionBlock instance of a ReflectionBlock null if the code must be generated without an active reflection module
  67886. * @param worldPosVarName name of the variable holding the world position
  67887. * @returns the shader code
  67888. */
  67889. static GetCode(state: NodeMaterialBuildState, ssBlock: Nullable<SubSurfaceBlock>, reflectionBlock: Nullable<ReflectionBlock>, worldPosVarName: string): string;
  67890. protected _buildBlock(state: NodeMaterialBuildState): this;
  67891. }
  67892. }
  67893. declare module "babylonjs/Materials/Node/Blocks/PBR/pbrMetallicRoughnessBlock" {
  67894. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  67895. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  67896. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  67897. import { NodeMaterial, NodeMaterialDefines } from "babylonjs/Materials/Node/nodeMaterial";
  67898. import { Light } from "babylonjs/Lights/light";
  67899. import { Nullable } from "babylonjs/types";
  67900. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  67901. import { Effect } from "babylonjs/Materials/effect";
  67902. import { Mesh } from "babylonjs/Meshes/mesh";
  67903. import { Scene } from "babylonjs/scene";
  67904. /**
  67905. * Block used to implement the PBR metallic/roughness model
  67906. */
  67907. export class PBRMetallicRoughnessBlock extends NodeMaterialBlock {
  67908. /**
  67909. * Gets or sets the light associated with this block
  67910. */
  67911. light: Nullable<Light>;
  67912. private _lightId;
  67913. private _scene;
  67914. private _environmentBRDFTexture;
  67915. private _environmentBrdfSamplerName;
  67916. private _vNormalWName;
  67917. private _invertNormalName;
  67918. /**
  67919. * Create a new ReflectionBlock
  67920. * @param name defines the block name
  67921. */
  67922. constructor(name: string);
  67923. /**
  67924. * Intensity of the direct lights e.g. the four lights available in your scene.
  67925. * This impacts both the direct diffuse and specular highlights.
  67926. */
  67927. directIntensity: number;
  67928. /**
  67929. * Intensity of the environment e.g. how much the environment will light the object
  67930. * either through harmonics for rough material or through the refelction for shiny ones.
  67931. */
  67932. environmentIntensity: number;
  67933. /**
  67934. * This is a special control allowing the reduction of the specular highlights coming from the
  67935. * four lights of the scene. Those highlights may not be needed in full environment lighting.
  67936. */
  67937. specularIntensity: number;
  67938. /**
  67939. * Defines the falloff type used in this material.
  67940. * It by default is Physical.
  67941. */
  67942. lightFalloff: number;
  67943. /**
  67944. * Specifies that the alpha is coming form the albedo channel alpha channel for alpha blending.
  67945. */
  67946. useAlphaFromAlbedoTexture: boolean;
  67947. /**
  67948. * Specifies that alpha test should be used
  67949. */
  67950. useAlphaTest: boolean;
  67951. /**
  67952. * Defines the alpha limits in alpha test mode.
  67953. */
  67954. alphaTestCutoff: number;
  67955. /**
  67956. * Specifies that alpha blending should be used
  67957. */
  67958. useAlphaBlending: boolean;
  67959. /**
  67960. * Defines if the alpha value should be determined via the rgb values.
  67961. * If true the luminance of the pixel might be used to find the corresponding alpha value.
  67962. */
  67963. opacityRGB: boolean;
  67964. /**
  67965. * Specifies that the material will keeps the reflection highlights over a transparent surface (only the most luminous ones).
  67966. * A car glass is a good exemple of that. When the street lights reflects on it you can not see what is behind.
  67967. */
  67968. useRadianceOverAlpha: boolean;
  67969. /**
  67970. * Specifies that the material will keeps the specular highlights over a transparent surface (only the most luminous ones).
  67971. * A car glass is a good exemple of that. When sun reflects on it you can not see what is behind.
  67972. */
  67973. useSpecularOverAlpha: boolean;
  67974. /**
  67975. * Enables specular anti aliasing in the PBR shader.
  67976. * It will both interacts on the Geometry for analytical and IBL lighting.
  67977. * It also prefilter the roughness map based on the bump values.
  67978. */
  67979. enableSpecularAntiAliasing: boolean;
  67980. /**
  67981. * Enables realtime filtering on the texture.
  67982. */
  67983. realTimeFiltering: boolean;
  67984. /**
  67985. * Quality switch for realtime filtering
  67986. */
  67987. realTimeFilteringQuality: number;
  67988. /**
  67989. * Defines if the material uses energy conservation.
  67990. */
  67991. useEnergyConservation: boolean;
  67992. /**
  67993. * This parameters will enable/disable radiance occlusion by preventing the radiance to lit
  67994. * too much the area relying on ambient texture to define their ambient occlusion.
  67995. */
  67996. useRadianceOcclusion: boolean;
  67997. /**
  67998. * This parameters will enable/disable Horizon occlusion to prevent normal maps to look shiny when the normal
  67999. * makes the reflect vector face the model (under horizon).
  68000. */
  68001. useHorizonOcclusion: boolean;
  68002. /**
  68003. * If set to true, no lighting calculations will be applied.
  68004. */
  68005. unlit: boolean;
  68006. /**
  68007. * Force normal to face away from face.
  68008. */
  68009. forceNormalForward: boolean;
  68010. /**
  68011. * Defines the material debug mode.
  68012. * It helps seeing only some components of the material while troubleshooting.
  68013. */
  68014. debugMode: number;
  68015. /**
  68016. * Specify from where on screen the debug mode should start.
  68017. * The value goes from -1 (full screen) to 1 (not visible)
  68018. * It helps with side by side comparison against the final render
  68019. * This defaults to 0
  68020. */
  68021. debugLimit: number;
  68022. /**
  68023. * As the default viewing range might not be enough (if the ambient is really small for instance)
  68024. * You can use the factor to better multiply the final value.
  68025. */
  68026. debugFactor: number;
  68027. /**
  68028. * Initialize the block and prepare the context for build
  68029. * @param state defines the state that will be used for the build
  68030. */
  68031. initialize(state: NodeMaterialBuildState): void;
  68032. /**
  68033. * Gets the current class name
  68034. * @returns the class name
  68035. */
  68036. getClassName(): string;
  68037. /**
  68038. * Gets the world position input component
  68039. */
  68040. get worldPosition(): NodeMaterialConnectionPoint;
  68041. /**
  68042. * Gets the world normal input component
  68043. */
  68044. get worldNormal(): NodeMaterialConnectionPoint;
  68045. /**
  68046. * Gets the perturbed normal input component
  68047. */
  68048. get perturbedNormal(): NodeMaterialConnectionPoint;
  68049. /**
  68050. * Gets the camera position input component
  68051. */
  68052. get cameraPosition(): NodeMaterialConnectionPoint;
  68053. /**
  68054. * Gets the base color input component
  68055. */
  68056. get baseColor(): NodeMaterialConnectionPoint;
  68057. /**
  68058. * Gets the opacity texture input component
  68059. */
  68060. get opacityTexture(): NodeMaterialConnectionPoint;
  68061. /**
  68062. * Gets the ambient color input component
  68063. */
  68064. get ambientColor(): NodeMaterialConnectionPoint;
  68065. /**
  68066. * Gets the reflectivity object parameters
  68067. */
  68068. get reflectivity(): NodeMaterialConnectionPoint;
  68069. /**
  68070. * Gets the ambient occlusion object parameters
  68071. */
  68072. get ambientOcclusion(): NodeMaterialConnectionPoint;
  68073. /**
  68074. * Gets the reflection object parameters
  68075. */
  68076. get reflection(): NodeMaterialConnectionPoint;
  68077. /**
  68078. * Gets the sheen object parameters
  68079. */
  68080. get sheen(): NodeMaterialConnectionPoint;
  68081. /**
  68082. * Gets the clear coat object parameters
  68083. */
  68084. get clearcoat(): NodeMaterialConnectionPoint;
  68085. /**
  68086. * Gets the sub surface object parameters
  68087. */
  68088. get subsurface(): NodeMaterialConnectionPoint;
  68089. /**
  68090. * Gets the anisotropy object parameters
  68091. */
  68092. get anisotropy(): NodeMaterialConnectionPoint;
  68093. /**
  68094. * Gets the ambient output component
  68095. */
  68096. get ambient(): NodeMaterialConnectionPoint;
  68097. /**
  68098. * Gets the diffuse output component
  68099. */
  68100. get diffuse(): NodeMaterialConnectionPoint;
  68101. /**
  68102. * Gets the specular output component
  68103. */
  68104. get specular(): NodeMaterialConnectionPoint;
  68105. /**
  68106. * Gets the sheen output component
  68107. */
  68108. get sheenDir(): NodeMaterialConnectionPoint;
  68109. /**
  68110. * Gets the clear coat output component
  68111. */
  68112. get clearcoatDir(): NodeMaterialConnectionPoint;
  68113. /**
  68114. * Gets the indirect diffuse output component
  68115. */
  68116. get diffuseIndirect(): NodeMaterialConnectionPoint;
  68117. /**
  68118. * Gets the indirect specular output component
  68119. */
  68120. get specularIndirect(): NodeMaterialConnectionPoint;
  68121. /**
  68122. * Gets the indirect sheen output component
  68123. */
  68124. get sheenIndirect(): NodeMaterialConnectionPoint;
  68125. /**
  68126. * Gets the indirect clear coat output component
  68127. */
  68128. get clearcoatIndirect(): NodeMaterialConnectionPoint;
  68129. /**
  68130. * Gets the refraction output component
  68131. */
  68132. get refraction(): NodeMaterialConnectionPoint;
  68133. /**
  68134. * Gets the global lighting output component
  68135. */
  68136. get lighting(): NodeMaterialConnectionPoint;
  68137. /**
  68138. * Gets the shadow output component
  68139. */
  68140. get shadow(): NodeMaterialConnectionPoint;
  68141. /**
  68142. * Gets the alpha output component
  68143. */
  68144. get alpha(): NodeMaterialConnectionPoint;
  68145. autoConfigure(material: NodeMaterial): void;
  68146. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  68147. updateUniformsAndSamples(state: NodeMaterialBuildState, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines, uniformBuffers: string[]): void;
  68148. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh): void;
  68149. private _injectVertexCode;
  68150. /**
  68151. * Gets the code corresponding to the albedo/opacity module
  68152. * @returns the shader code
  68153. */
  68154. getAlbedoOpacityCode(): string;
  68155. protected _buildBlock(state: NodeMaterialBuildState): this;
  68156. protected _dumpPropertiesCode(): string;
  68157. serialize(): any;
  68158. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  68159. }
  68160. }
  68161. declare module "babylonjs/Materials/Node/Blocks/PBR/index" {
  68162. export * from "babylonjs/Materials/Node/Blocks/PBR/pbrMetallicRoughnessBlock";
  68163. export * from "babylonjs/Materials/Node/Blocks/PBR/sheenBlock";
  68164. export * from "babylonjs/Materials/Node/Blocks/PBR/ambientOcclusionBlock";
  68165. export * from "babylonjs/Materials/Node/Blocks/PBR/reflectivityBlock";
  68166. export * from "babylonjs/Materials/Node/Blocks/PBR/anisotropyBlock";
  68167. export * from "babylonjs/Materials/Node/Blocks/PBR/reflectionBlock";
  68168. export * from "babylonjs/Materials/Node/Blocks/PBR/clearCoatBlock";
  68169. export * from "babylonjs/Materials/Node/Blocks/PBR/refractionBlock";
  68170. export * from "babylonjs/Materials/Node/Blocks/PBR/subSurfaceBlock";
  68171. }
  68172. declare module "babylonjs/Materials/Node/Blocks/Particle/index" {
  68173. export * from "babylonjs/Materials/Node/Blocks/Particle/particleTextureBlock";
  68174. export * from "babylonjs/Materials/Node/Blocks/Particle/particleRampGradientBlock";
  68175. export * from "babylonjs/Materials/Node/Blocks/Particle/particleBlendMultiplyBlock";
  68176. }
  68177. declare module "babylonjs/Materials/Node/Blocks/modBlock" {
  68178. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  68179. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  68180. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  68181. /**
  68182. * Block used to compute value of one parameter modulo another
  68183. */
  68184. export class ModBlock extends NodeMaterialBlock {
  68185. /**
  68186. * Creates a new ModBlock
  68187. * @param name defines the block name
  68188. */
  68189. constructor(name: string);
  68190. /**
  68191. * Gets the current class name
  68192. * @returns the class name
  68193. */
  68194. getClassName(): string;
  68195. /**
  68196. * Gets the left operand input component
  68197. */
  68198. get left(): NodeMaterialConnectionPoint;
  68199. /**
  68200. * Gets the right operand input component
  68201. */
  68202. get right(): NodeMaterialConnectionPoint;
  68203. /**
  68204. * Gets the output component
  68205. */
  68206. get output(): NodeMaterialConnectionPoint;
  68207. protected _buildBlock(state: NodeMaterialBuildState): this;
  68208. }
  68209. }
  68210. declare module "babylonjs/Materials/Node/Blocks/index" {
  68211. export * from "babylonjs/Materials/Node/Blocks/Vertex/index";
  68212. export * from "babylonjs/Materials/Node/Blocks/Fragment/index";
  68213. export * from "babylonjs/Materials/Node/Blocks/Dual/index";
  68214. export * from "babylonjs/Materials/Node/Blocks/Input/index";
  68215. export * from "babylonjs/Materials/Node/Blocks/multiplyBlock";
  68216. export * from "babylonjs/Materials/Node/Blocks/addBlock";
  68217. export * from "babylonjs/Materials/Node/Blocks/scaleBlock";
  68218. export * from "babylonjs/Materials/Node/Blocks/clampBlock";
  68219. export * from "babylonjs/Materials/Node/Blocks/crossBlock";
  68220. export * from "babylonjs/Materials/Node/Blocks/dotBlock";
  68221. export * from "babylonjs/Materials/Node/Blocks/transformBlock";
  68222. export * from "babylonjs/Materials/Node/Blocks/remapBlock";
  68223. export * from "babylonjs/Materials/Node/Blocks/normalizeBlock";
  68224. export * from "babylonjs/Materials/Node/Blocks/trigonometryBlock";
  68225. export * from "babylonjs/Materials/Node/Blocks/colorMergerBlock";
  68226. export * from "babylonjs/Materials/Node/Blocks/vectorMergerBlock";
  68227. export * from "babylonjs/Materials/Node/Blocks/colorSplitterBlock";
  68228. export * from "babylonjs/Materials/Node/Blocks/vectorSplitterBlock";
  68229. export * from "babylonjs/Materials/Node/Blocks/lerpBlock";
  68230. export * from "babylonjs/Materials/Node/Blocks/divideBlock";
  68231. export * from "babylonjs/Materials/Node/Blocks/subtractBlock";
  68232. export * from "babylonjs/Materials/Node/Blocks/stepBlock";
  68233. export * from "babylonjs/Materials/Node/Blocks/oneMinusBlock";
  68234. export * from "babylonjs/Materials/Node/Blocks/viewDirectionBlock";
  68235. export * from "babylonjs/Materials/Node/Blocks/fresnelBlock";
  68236. export * from "babylonjs/Materials/Node/Blocks/maxBlock";
  68237. export * from "babylonjs/Materials/Node/Blocks/minBlock";
  68238. export * from "babylonjs/Materials/Node/Blocks/distanceBlock";
  68239. export * from "babylonjs/Materials/Node/Blocks/lengthBlock";
  68240. export * from "babylonjs/Materials/Node/Blocks/negateBlock";
  68241. export * from "babylonjs/Materials/Node/Blocks/powBlock";
  68242. export * from "babylonjs/Materials/Node/Blocks/randomNumberBlock";
  68243. export * from "babylonjs/Materials/Node/Blocks/arcTan2Block";
  68244. export * from "babylonjs/Materials/Node/Blocks/smoothStepBlock";
  68245. export * from "babylonjs/Materials/Node/Blocks/reciprocalBlock";
  68246. export * from "babylonjs/Materials/Node/Blocks/replaceColorBlock";
  68247. export * from "babylonjs/Materials/Node/Blocks/posterizeBlock";
  68248. export * from "babylonjs/Materials/Node/Blocks/waveBlock";
  68249. export * from "babylonjs/Materials/Node/Blocks/gradientBlock";
  68250. export * from "babylonjs/Materials/Node/Blocks/nLerpBlock";
  68251. export * from "babylonjs/Materials/Node/Blocks/worleyNoise3DBlock";
  68252. export * from "babylonjs/Materials/Node/Blocks/simplexPerlin3DBlock";
  68253. export * from "babylonjs/Materials/Node/Blocks/normalBlendBlock";
  68254. export * from "babylonjs/Materials/Node/Blocks/rotate2dBlock";
  68255. export * from "babylonjs/Materials/Node/Blocks/reflectBlock";
  68256. export * from "babylonjs/Materials/Node/Blocks/refractBlock";
  68257. export * from "babylonjs/Materials/Node/Blocks/desaturateBlock";
  68258. export * from "babylonjs/Materials/Node/Blocks/PBR/index";
  68259. export * from "babylonjs/Materials/Node/Blocks/Particle/index";
  68260. export * from "babylonjs/Materials/Node/Blocks/modBlock";
  68261. }
  68262. declare module "babylonjs/Materials/Node/Optimizers/index" {
  68263. export * from "babylonjs/Materials/Node/Optimizers/nodeMaterialOptimizer";
  68264. }
  68265. declare module "babylonjs/Materials/Node/index" {
  68266. export * from "babylonjs/Materials/Node/Enums/index";
  68267. export * from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  68268. export * from "babylonjs/Materials/Node/nodeMaterialBlock";
  68269. export * from "babylonjs/Materials/Node/nodeMaterial";
  68270. export * from "babylonjs/Materials/Node/Blocks/index";
  68271. export * from "babylonjs/Materials/Node/Optimizers/index";
  68272. export * from "babylonjs/Materials/Node/nodeMaterialDecorator";
  68273. }
  68274. declare module "babylonjs/Materials/index" {
  68275. export * from "babylonjs/Materials/Background/index";
  68276. export * from "babylonjs/Materials/colorCurves";
  68277. export * from "babylonjs/Materials/iEffectFallbacks";
  68278. export * from "babylonjs/Materials/effectFallbacks";
  68279. export * from "babylonjs/Materials/effect";
  68280. export * from "babylonjs/Materials/fresnelParameters";
  68281. export * from "babylonjs/Materials/imageProcessingConfiguration";
  68282. export * from "babylonjs/Materials/material";
  68283. export * from "babylonjs/Materials/materialDefines";
  68284. export * from "babylonjs/Materials/thinMaterialHelper";
  68285. export * from "babylonjs/Materials/materialHelper";
  68286. export * from "babylonjs/Materials/multiMaterial";
  68287. export * from "babylonjs/Materials/PBR/index";
  68288. export * from "babylonjs/Materials/pushMaterial";
  68289. export * from "babylonjs/Materials/shaderMaterial";
  68290. export * from "babylonjs/Materials/standardMaterial";
  68291. export * from "babylonjs/Materials/Textures/index";
  68292. export * from "babylonjs/Materials/uniformBuffer";
  68293. export * from "babylonjs/Materials/materialFlags";
  68294. export * from "babylonjs/Materials/Node/index";
  68295. export * from "babylonjs/Materials/effectRenderer";
  68296. export * from "babylonjs/Materials/shadowDepthWrapper";
  68297. }
  68298. declare module "babylonjs/Maths/index" {
  68299. export * from "babylonjs/Maths/math.scalar";
  68300. export * from "babylonjs/Maths/math";
  68301. export * from "babylonjs/Maths/sphericalPolynomial";
  68302. }
  68303. declare module "babylonjs/Misc/workerPool" {
  68304. import { IDisposable } from "babylonjs/scene";
  68305. /**
  68306. * Helper class to push actions to a pool of workers.
  68307. */
  68308. export class WorkerPool implements IDisposable {
  68309. private _workerInfos;
  68310. private _pendingActions;
  68311. /**
  68312. * Constructor
  68313. * @param workers Array of workers to use for actions
  68314. */
  68315. constructor(workers: Array<Worker>);
  68316. /**
  68317. * Terminates all workers and clears any pending actions.
  68318. */
  68319. dispose(): void;
  68320. /**
  68321. * Pushes an action to the worker pool. If all the workers are active, the action will be
  68322. * pended until a worker has completed its action.
  68323. * @param action The action to perform. Call onComplete when the action is complete.
  68324. */
  68325. push(action: (worker: Worker, onComplete: () => void) => void): void;
  68326. private _execute;
  68327. }
  68328. }
  68329. declare module "babylonjs/Meshes/Compression/dracoCompression" {
  68330. import { IDisposable } from "babylonjs/scene";
  68331. import { VertexData } from "babylonjs/Meshes/mesh.vertexData";
  68332. /**
  68333. * Configuration for Draco compression
  68334. */
  68335. export interface IDracoCompressionConfiguration {
  68336. /**
  68337. * Configuration for the decoder.
  68338. */
  68339. decoder: {
  68340. /**
  68341. * The url to the WebAssembly module.
  68342. */
  68343. wasmUrl?: string;
  68344. /**
  68345. * The url to the WebAssembly binary.
  68346. */
  68347. wasmBinaryUrl?: string;
  68348. /**
  68349. * The url to the fallback JavaScript module.
  68350. */
  68351. fallbackUrl?: string;
  68352. };
  68353. }
  68354. /**
  68355. * Draco compression (https://google.github.io/draco/)
  68356. *
  68357. * This class wraps the Draco module.
  68358. *
  68359. * **Encoder**
  68360. *
  68361. * The encoder is not currently implemented.
  68362. *
  68363. * **Decoder**
  68364. *
  68365. * 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.
  68366. *
  68367. * To update the configuration, use the following code:
  68368. * ```javascript
  68369. * DracoCompression.Configuration = {
  68370. * decoder: {
  68371. * wasmUrl: "<url to the WebAssembly library>",
  68372. * wasmBinaryUrl: "<url to the WebAssembly binary>",
  68373. * fallbackUrl: "<url to the fallback JavaScript library>",
  68374. * }
  68375. * };
  68376. * ```
  68377. *
  68378. * 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.
  68379. * Decoding will automatically fallback to the JavaScript version if WebAssembly version is not configured or if WebAssembly is not supported by the browser.
  68380. * Use `DracoCompression.DecoderAvailable` to determine if the decoder configuration is available for the current context.
  68381. *
  68382. * To decode Draco compressed data, get the default DracoCompression object and call decodeMeshAsync:
  68383. * ```javascript
  68384. * var vertexData = await DracoCompression.Default.decodeMeshAsync(data);
  68385. * ```
  68386. *
  68387. * @see https://www.babylonjs-playground.com/#N3EK4B#0
  68388. */
  68389. export class DracoCompression implements IDisposable {
  68390. private _workerPoolPromise?;
  68391. private _decoderModulePromise?;
  68392. /**
  68393. * The configuration. Defaults to the following urls:
  68394. * - wasmUrl: "https://preview.babylonjs.com/draco_wasm_wrapper_gltf.js"
  68395. * - wasmBinaryUrl: "https://preview.babylonjs.com/draco_decoder_gltf.wasm"
  68396. * - fallbackUrl: "https://preview.babylonjs.com/draco_decoder_gltf.js"
  68397. */
  68398. static Configuration: IDracoCompressionConfiguration;
  68399. /**
  68400. * Returns true if the decoder configuration is available.
  68401. */
  68402. static get DecoderAvailable(): boolean;
  68403. /**
  68404. * Default number of workers to create when creating the draco compression object.
  68405. */
  68406. static DefaultNumWorkers: number;
  68407. private static GetDefaultNumWorkers;
  68408. private static _Default;
  68409. /**
  68410. * Default instance for the draco compression object.
  68411. */
  68412. static get Default(): DracoCompression;
  68413. /**
  68414. * Constructor
  68415. * @param numWorkers The number of workers for async operations. Specify `0` to disable web workers and run synchronously in the current context.
  68416. */
  68417. constructor(numWorkers?: number);
  68418. /**
  68419. * Stop all async operations and release resources.
  68420. */
  68421. dispose(): void;
  68422. /**
  68423. * Returns a promise that resolves when ready. Call this manually to ensure draco compression is ready before use.
  68424. * @returns a promise that resolves when ready
  68425. */
  68426. whenReadyAsync(): Promise<void>;
  68427. /**
  68428. * Decode Draco compressed mesh data to vertex data.
  68429. * @param data The ArrayBuffer or ArrayBufferView for the Draco compression data
  68430. * @param attributes A map of attributes from vertex buffer kinds to Draco unique ids
  68431. * @returns A promise that resolves with the decoded vertex data
  68432. */
  68433. decodeMeshAsync(data: ArrayBuffer | ArrayBufferView, attributes?: {
  68434. [kind: string]: number;
  68435. }): Promise<VertexData>;
  68436. }
  68437. }
  68438. declare module "babylonjs/Meshes/Compression/index" {
  68439. export * from "babylonjs/Meshes/Compression/dracoCompression";
  68440. }
  68441. declare module "babylonjs/Meshes/csg" {
  68442. import { Nullable } from "babylonjs/types";
  68443. import { Scene } from "babylonjs/scene";
  68444. import { Quaternion, Matrix, Vector3 } from "babylonjs/Maths/math.vector";
  68445. import { Mesh } from "babylonjs/Meshes/mesh";
  68446. import { Material } from "babylonjs/Materials/material";
  68447. /**
  68448. * Class for building Constructive Solid Geometry
  68449. */
  68450. export class CSG {
  68451. private polygons;
  68452. /**
  68453. * The world matrix
  68454. */
  68455. matrix: Matrix;
  68456. /**
  68457. * Stores the position
  68458. */
  68459. position: Vector3;
  68460. /**
  68461. * Stores the rotation
  68462. */
  68463. rotation: Vector3;
  68464. /**
  68465. * Stores the rotation quaternion
  68466. */
  68467. rotationQuaternion: Nullable<Quaternion>;
  68468. /**
  68469. * Stores the scaling vector
  68470. */
  68471. scaling: Vector3;
  68472. /**
  68473. * Convert the Mesh to CSG
  68474. * @param mesh The Mesh to convert to CSG
  68475. * @returns A new CSG from the Mesh
  68476. */
  68477. static FromMesh(mesh: Mesh): CSG;
  68478. /**
  68479. * Construct a CSG solid from a list of `CSG.Polygon` instances.
  68480. * @param polygons Polygons used to construct a CSG solid
  68481. */
  68482. private static FromPolygons;
  68483. /**
  68484. * Clones, or makes a deep copy, of the CSG
  68485. * @returns A new CSG
  68486. */
  68487. clone(): CSG;
  68488. /**
  68489. * Unions this CSG with another CSG
  68490. * @param csg The CSG to union against this CSG
  68491. * @returns The unioned CSG
  68492. */
  68493. union(csg: CSG): CSG;
  68494. /**
  68495. * Unions this CSG with another CSG in place
  68496. * @param csg The CSG to union against this CSG
  68497. */
  68498. unionInPlace(csg: CSG): void;
  68499. /**
  68500. * Subtracts this CSG with another CSG
  68501. * @param csg The CSG to subtract against this CSG
  68502. * @returns A new CSG
  68503. */
  68504. subtract(csg: CSG): CSG;
  68505. /**
  68506. * Subtracts this CSG with another CSG in place
  68507. * @param csg The CSG to subtact against this CSG
  68508. */
  68509. subtractInPlace(csg: CSG): void;
  68510. /**
  68511. * Intersect this CSG with another CSG
  68512. * @param csg The CSG to intersect against this CSG
  68513. * @returns A new CSG
  68514. */
  68515. intersect(csg: CSG): CSG;
  68516. /**
  68517. * Intersects this CSG with another CSG in place
  68518. * @param csg The CSG to intersect against this CSG
  68519. */
  68520. intersectInPlace(csg: CSG): void;
  68521. /**
  68522. * Return a new CSG solid with solid and empty space switched. This solid is
  68523. * not modified.
  68524. * @returns A new CSG solid with solid and empty space switched
  68525. */
  68526. inverse(): CSG;
  68527. /**
  68528. * Inverses the CSG in place
  68529. */
  68530. inverseInPlace(): void;
  68531. /**
  68532. * This is used to keep meshes transformations so they can be restored
  68533. * when we build back a Babylon Mesh
  68534. * NB : All CSG operations are performed in world coordinates
  68535. * @param csg The CSG to copy the transform attributes from
  68536. * @returns This CSG
  68537. */
  68538. copyTransformAttributes(csg: CSG): CSG;
  68539. /**
  68540. * Build Raw mesh from CSG
  68541. * Coordinates here are in world space
  68542. * @param name The name of the mesh geometry
  68543. * @param scene The Scene
  68544. * @param keepSubMeshes Specifies if the submeshes should be kept
  68545. * @returns A new Mesh
  68546. */
  68547. buildMeshGeometry(name: string, scene?: Scene, keepSubMeshes?: boolean): Mesh;
  68548. /**
  68549. * Build Mesh from CSG taking material and transforms into account
  68550. * @param name The name of the Mesh
  68551. * @param material The material of the Mesh
  68552. * @param scene The Scene
  68553. * @param keepSubMeshes Specifies if submeshes should be kept
  68554. * @returns The new Mesh
  68555. */
  68556. toMesh(name: string, material?: Nullable<Material>, scene?: Scene, keepSubMeshes?: boolean): Mesh;
  68557. }
  68558. }
  68559. declare module "babylonjs/Meshes/trailMesh" {
  68560. import { Mesh } from "babylonjs/Meshes/mesh";
  68561. import { Scene } from "babylonjs/scene";
  68562. import { TransformNode } from "babylonjs/Meshes/transformNode";
  68563. /**
  68564. * Class used to create a trail following a mesh
  68565. */
  68566. export class TrailMesh extends Mesh {
  68567. private _generator;
  68568. private _autoStart;
  68569. private _running;
  68570. private _diameter;
  68571. private _length;
  68572. private _sectionPolygonPointsCount;
  68573. private _sectionVectors;
  68574. private _sectionNormalVectors;
  68575. private _beforeRenderObserver;
  68576. /**
  68577. * @constructor
  68578. * @param name The value used by scene.getMeshByName() to do a lookup.
  68579. * @param generator The mesh or transform node to generate a trail.
  68580. * @param scene The scene to add this mesh to.
  68581. * @param diameter Diameter of trailing mesh. Default is 1.
  68582. * @param length Length of trailing mesh. Default is 60.
  68583. * @param autoStart Automatically start trailing mesh. Default true.
  68584. */
  68585. constructor(name: string, generator: TransformNode, scene: Scene, diameter?: number, length?: number, autoStart?: boolean);
  68586. /**
  68587. * "TrailMesh"
  68588. * @returns "TrailMesh"
  68589. */
  68590. getClassName(): string;
  68591. private _createMesh;
  68592. /**
  68593. * Start trailing mesh.
  68594. */
  68595. start(): void;
  68596. /**
  68597. * Stop trailing mesh.
  68598. */
  68599. stop(): void;
  68600. /**
  68601. * Update trailing mesh geometry.
  68602. */
  68603. update(): void;
  68604. /**
  68605. * Returns a new TrailMesh object.
  68606. * @param name is a string, the name given to the new mesh
  68607. * @param newGenerator use new generator object for cloned trail mesh
  68608. * @returns a new mesh
  68609. */
  68610. clone(name: string | undefined, newGenerator: TransformNode): TrailMesh;
  68611. /**
  68612. * Serializes this trail mesh
  68613. * @param serializationObject object to write serialization to
  68614. */
  68615. serialize(serializationObject: any): void;
  68616. /**
  68617. * Parses a serialized trail mesh
  68618. * @param parsedMesh the serialized mesh
  68619. * @param scene the scene to create the trail mesh in
  68620. * @returns the created trail mesh
  68621. */
  68622. static Parse(parsedMesh: any, scene: Scene): TrailMesh;
  68623. }
  68624. }
  68625. declare module "babylonjs/Meshes/Builders/tiledBoxBuilder" {
  68626. import { Nullable } from "babylonjs/types";
  68627. import { Scene } from "babylonjs/scene";
  68628. import { Vector4 } from "babylonjs/Maths/math.vector";
  68629. import { Color4 } from "babylonjs/Maths/math.color";
  68630. import { Mesh } from "babylonjs/Meshes/mesh";
  68631. /**
  68632. * Class containing static functions to help procedurally build meshes
  68633. */
  68634. export class TiledBoxBuilder {
  68635. /**
  68636. * Creates a box mesh
  68637. * 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)
  68638. * * Please read this tutorial : https://doc.babylonjs.com/how_to/createbox_per_face_textures_and_colors
  68639. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  68640. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  68641. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  68642. * @param name defines the name of the mesh
  68643. * @param options defines the options used to create the mesh
  68644. * @param scene defines the hosting scene
  68645. * @returns the box mesh
  68646. */
  68647. static CreateTiledBox(name: string, options: {
  68648. pattern?: number;
  68649. width?: number;
  68650. height?: number;
  68651. depth?: number;
  68652. tileSize?: number;
  68653. tileWidth?: number;
  68654. tileHeight?: number;
  68655. alignHorizontal?: number;
  68656. alignVertical?: number;
  68657. faceUV?: Vector4[];
  68658. faceColors?: Color4[];
  68659. sideOrientation?: number;
  68660. updatable?: boolean;
  68661. }, scene?: Nullable<Scene>): Mesh;
  68662. }
  68663. }
  68664. declare module "babylonjs/Meshes/Builders/torusKnotBuilder" {
  68665. import { Vector4 } from "babylonjs/Maths/math.vector";
  68666. import { Mesh } from "babylonjs/Meshes/mesh";
  68667. /**
  68668. * Class containing static functions to help procedurally build meshes
  68669. */
  68670. export class TorusKnotBuilder {
  68671. /**
  68672. * Creates a torus knot mesh
  68673. * * The parameter `radius` sets the global radius size (float) of the torus knot (default 2)
  68674. * * The parameter `radialSegments` sets the number of sides on each tube segments (positive integer, default 32)
  68675. * * The parameter `tubularSegments` sets the number of tubes to decompose the knot into (positive integer, default 32)
  68676. * * The parameters `p` and `q` are the number of windings on each axis (positive integers, default 2 and 3)
  68677. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  68678. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  68679. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created.
  68680. * @param name defines the name of the mesh
  68681. * @param options defines the options used to create the mesh
  68682. * @param scene defines the hosting scene
  68683. * @returns the torus knot mesh
  68684. * @see https://doc.babylonjs.com/how_to/set_shapes#torus-knot
  68685. */
  68686. static CreateTorusKnot(name: string, options: {
  68687. radius?: number;
  68688. tube?: number;
  68689. radialSegments?: number;
  68690. tubularSegments?: number;
  68691. p?: number;
  68692. q?: number;
  68693. updatable?: boolean;
  68694. sideOrientation?: number;
  68695. frontUVs?: Vector4;
  68696. backUVs?: Vector4;
  68697. }, scene: any): Mesh;
  68698. }
  68699. }
  68700. declare module "babylonjs/Meshes/polygonMesh" {
  68701. import { Scene } from "babylonjs/scene";
  68702. import { Vector2 } from "babylonjs/Maths/math.vector";
  68703. import { Mesh } from "babylonjs/Meshes/mesh";
  68704. import { VertexData } from "babylonjs/Meshes/mesh.vertexData";
  68705. import { Path2 } from "babylonjs/Maths/math.path";
  68706. /**
  68707. * Polygon
  68708. * @see https://doc.babylonjs.com/how_to/parametric_shapes#non-regular-polygon
  68709. */
  68710. export class Polygon {
  68711. /**
  68712. * Creates a rectangle
  68713. * @param xmin bottom X coord
  68714. * @param ymin bottom Y coord
  68715. * @param xmax top X coord
  68716. * @param ymax top Y coord
  68717. * @returns points that make the resulting rectation
  68718. */
  68719. static Rectangle(xmin: number, ymin: number, xmax: number, ymax: number): Vector2[];
  68720. /**
  68721. * Creates a circle
  68722. * @param radius radius of circle
  68723. * @param cx scale in x
  68724. * @param cy scale in y
  68725. * @param numberOfSides number of sides that make up the circle
  68726. * @returns points that make the resulting circle
  68727. */
  68728. static Circle(radius: number, cx?: number, cy?: number, numberOfSides?: number): Vector2[];
  68729. /**
  68730. * Creates a polygon from input string
  68731. * @param input Input polygon data
  68732. * @returns the parsed points
  68733. */
  68734. static Parse(input: string): Vector2[];
  68735. /**
  68736. * Starts building a polygon from x and y coordinates
  68737. * @param x x coordinate
  68738. * @param y y coordinate
  68739. * @returns the started path2
  68740. */
  68741. static StartingAt(x: number, y: number): Path2;
  68742. }
  68743. /**
  68744. * Builds a polygon
  68745. * @see https://doc.babylonjs.com/how_to/polygonmeshbuilder
  68746. */
  68747. export class PolygonMeshBuilder {
  68748. private _points;
  68749. private _outlinepoints;
  68750. private _holes;
  68751. private _name;
  68752. private _scene;
  68753. private _epoints;
  68754. private _eholes;
  68755. private _addToepoint;
  68756. /**
  68757. * Babylon reference to the earcut plugin.
  68758. */
  68759. bjsEarcut: any;
  68760. /**
  68761. * Creates a PolygonMeshBuilder
  68762. * @param name name of the builder
  68763. * @param contours Path of the polygon
  68764. * @param scene scene to add to when creating the mesh
  68765. * @param earcutInjection can be used to inject your own earcut reference
  68766. */
  68767. constructor(name: string, contours: Path2 | Vector2[] | any, scene?: Scene, earcutInjection?: any);
  68768. /**
  68769. * Adds a whole within the polygon
  68770. * @param hole Array of points defining the hole
  68771. * @returns this
  68772. */
  68773. addHole(hole: Vector2[]): PolygonMeshBuilder;
  68774. /**
  68775. * Creates the polygon
  68776. * @param updatable If the mesh should be updatable
  68777. * @param depth The depth of the mesh created
  68778. * @returns the created mesh
  68779. */
  68780. build(updatable?: boolean, depth?: number): Mesh;
  68781. /**
  68782. * Creates the polygon
  68783. * @param depth The depth of the mesh created
  68784. * @returns the created VertexData
  68785. */
  68786. buildVertexData(depth?: number): VertexData;
  68787. /**
  68788. * Adds a side to the polygon
  68789. * @param positions points that make the polygon
  68790. * @param normals normals of the polygon
  68791. * @param uvs uvs of the polygon
  68792. * @param indices indices of the polygon
  68793. * @param bounds bounds of the polygon
  68794. * @param points points of the polygon
  68795. * @param depth depth of the polygon
  68796. * @param flip flip of the polygon
  68797. */
  68798. private addSide;
  68799. }
  68800. }
  68801. declare module "babylonjs/Meshes/Builders/polygonBuilder" {
  68802. import { Scene } from "babylonjs/scene";
  68803. import { Vector3, Vector4 } from "babylonjs/Maths/math.vector";
  68804. import { Color4 } from "babylonjs/Maths/math.color";
  68805. import { Mesh } from "babylonjs/Meshes/mesh";
  68806. import { Nullable } from "babylonjs/types";
  68807. /**
  68808. * Class containing static functions to help procedurally build meshes
  68809. */
  68810. export class PolygonBuilder {
  68811. /**
  68812. * Creates a polygon mesh
  68813. * The polygon's shape will depend on the input parameters and is constructed parallel to a ground mesh
  68814. * * 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
  68815. * * You can set the mesh side orientation with the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  68816. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  68817. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4)
  68818. * * Remember you can only change the shape positions, not their number when updating a polygon
  68819. * @param name defines the name of the mesh
  68820. * @param options defines the options used to create the mesh
  68821. * @param scene defines the hosting scene
  68822. * @param earcutInjection can be used to inject your own earcut reference
  68823. * @returns the polygon mesh
  68824. */
  68825. static CreatePolygon(name: string, options: {
  68826. shape: Vector3[];
  68827. holes?: Vector3[][];
  68828. depth?: number;
  68829. faceUV?: Vector4[];
  68830. faceColors?: Color4[];
  68831. updatable?: boolean;
  68832. sideOrientation?: number;
  68833. frontUVs?: Vector4;
  68834. backUVs?: Vector4;
  68835. wrap?: boolean;
  68836. }, scene?: Nullable<Scene>, earcutInjection?: any): Mesh;
  68837. /**
  68838. * Creates an extruded polygon mesh, with depth in the Y direction.
  68839. * * 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)
  68840. * @see https://doc.babylonjs.com/how_to/createbox_per_face_textures_and_colors
  68841. * @param name defines the name of the mesh
  68842. * @param options defines the options used to create the mesh
  68843. * @param scene defines the hosting scene
  68844. * @param earcutInjection can be used to inject your own earcut reference
  68845. * @returns the polygon mesh
  68846. */
  68847. static ExtrudePolygon(name: string, options: {
  68848. shape: Vector3[];
  68849. holes?: Vector3[][];
  68850. depth?: number;
  68851. faceUV?: Vector4[];
  68852. faceColors?: Color4[];
  68853. updatable?: boolean;
  68854. sideOrientation?: number;
  68855. frontUVs?: Vector4;
  68856. backUVs?: Vector4;
  68857. wrap?: boolean;
  68858. }, scene?: Nullable<Scene>, earcutInjection?: any): Mesh;
  68859. }
  68860. }
  68861. declare module "babylonjs/Meshes/Builders/latheBuilder" {
  68862. import { Scene } from "babylonjs/scene";
  68863. import { Vector3, Vector4 } from "babylonjs/Maths/math.vector";
  68864. import { Mesh } from "babylonjs/Meshes/mesh";
  68865. import { Nullable } from "babylonjs/types";
  68866. /**
  68867. * Class containing static functions to help procedurally build meshes
  68868. */
  68869. export class LatheBuilder {
  68870. /**
  68871. * Creates lathe mesh.
  68872. * The lathe is a shape with a symetry axis : a 2D model shape is rotated around this axis to design the lathe
  68873. * * 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
  68874. * * The parameter `radius` (positive float, default 1) is the radius value of the lathe
  68875. * * The parameter `tessellation` (positive integer, default 64) is the side number of the lathe
  68876. * * The parameter `clip` (positive integer, default 0) is the number of sides to not create without effecting the general shape of the sides
  68877. * * 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
  68878. * * The parameter `closed` (boolean, default true) opens/closes the lathe circumference. This should be set to false when used with the parameter "arc"
  68879. * * 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
  68880. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  68881. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  68882. * * The optional parameter `invertUV` (boolean, default false) swaps in the geometry the U and V coordinates to apply a texture
  68883. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  68884. * @param name defines the name of the mesh
  68885. * @param options defines the options used to create the mesh
  68886. * @param scene defines the hosting scene
  68887. * @returns the lathe mesh
  68888. * @see https://doc.babylonjs.com/how_to/parametric_shapes#lathe
  68889. */
  68890. static CreateLathe(name: string, options: {
  68891. shape: Vector3[];
  68892. radius?: number;
  68893. tessellation?: number;
  68894. clip?: number;
  68895. arc?: number;
  68896. closed?: boolean;
  68897. updatable?: boolean;
  68898. sideOrientation?: number;
  68899. frontUVs?: Vector4;
  68900. backUVs?: Vector4;
  68901. cap?: number;
  68902. invertUV?: boolean;
  68903. }, scene?: Nullable<Scene>): Mesh;
  68904. }
  68905. }
  68906. declare module "babylonjs/Meshes/Builders/tiledPlaneBuilder" {
  68907. import { Nullable } from "babylonjs/types";
  68908. import { Scene } from "babylonjs/scene";
  68909. import { Vector4 } from "babylonjs/Maths/math.vector";
  68910. import { Mesh } from "babylonjs/Meshes/mesh";
  68911. /**
  68912. * Class containing static functions to help procedurally build meshes
  68913. */
  68914. export class TiledPlaneBuilder {
  68915. /**
  68916. * Creates a tiled plane mesh
  68917. * * The parameter `pattern` will, depending on value, do nothing or
  68918. * * * flip (reflect about central vertical) alternate tiles across and up
  68919. * * * flip every tile on alternate rows
  68920. * * * rotate (180 degs) alternate tiles across and up
  68921. * * * rotate every tile on alternate rows
  68922. * * * flip and rotate alternate tiles across and up
  68923. * * * flip and rotate every tile on alternate rows
  68924. * * The parameter `tileSize` sets the size (float) of each tile side (default 1)
  68925. * * You can set some different tile dimensions by using the parameters `tileWidth` and `tileHeight` (both by default have the same value of `tileSize`)
  68926. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  68927. * * sideOrientation optional and takes the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  68928. * * 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)
  68929. * * 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)
  68930. * @see https://doc.babylonjs.com/how_to/set_shapes#box
  68931. * @param name defines the name of the mesh
  68932. * @param options defines the options used to create the mesh
  68933. * @param scene defines the hosting scene
  68934. * @returns the box mesh
  68935. */
  68936. static CreateTiledPlane(name: string, options: {
  68937. pattern?: number;
  68938. tileSize?: number;
  68939. tileWidth?: number;
  68940. tileHeight?: number;
  68941. size?: number;
  68942. width?: number;
  68943. height?: number;
  68944. alignHorizontal?: number;
  68945. alignVertical?: number;
  68946. sideOrientation?: number;
  68947. frontUVs?: Vector4;
  68948. backUVs?: Vector4;
  68949. updatable?: boolean;
  68950. }, scene?: Nullable<Scene>): Mesh;
  68951. }
  68952. }
  68953. declare module "babylonjs/Meshes/Builders/tubeBuilder" {
  68954. import { Nullable } from "babylonjs/types";
  68955. import { Scene } from "babylonjs/scene";
  68956. import { Vector3, Vector4 } from "babylonjs/Maths/math.vector";
  68957. import { Mesh } from "babylonjs/Meshes/mesh";
  68958. /**
  68959. * Class containing static functions to help procedurally build meshes
  68960. */
  68961. export class TubeBuilder {
  68962. /**
  68963. * Creates a tube mesh.
  68964. * The tube is a parametric shape. It has no predefined shape. Its final shape will depend on the input parameters
  68965. * * The parameter `path` is a required array of successive Vector3. It is the curve used as the axis of the tube
  68966. * * The parameter `radius` (positive float, default 1) sets the tube radius size
  68967. * * The parameter `tessellation` (positive float, default 64) is the number of sides on the tubular surface
  68968. * * The parameter `radiusFunction` (javascript function, default null) is a vanilla javascript function. If it is not null, it overwrittes the parameter `radius`
  68969. * * 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)
  68970. * * The parameter `arc` (positive float, maximum 1, default 1) is the ratio to apply to the tube circumference : 2 x PI x arc
  68971. * * 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
  68972. * * 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
  68973. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  68974. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  68975. * * The optional parameter `invertUV` (boolean, default false) swaps in the geometry the U and V coordinates to apply a texture
  68976. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  68977. * @param name defines the name of the mesh
  68978. * @param options defines the options used to create the mesh
  68979. * @param scene defines the hosting scene
  68980. * @returns the tube mesh
  68981. * @see https://doc.babylonjs.com/how_to/parametric_shapes
  68982. * @see https://doc.babylonjs.com/how_to/set_shapes#tube
  68983. */
  68984. static CreateTube(name: string, options: {
  68985. path: Vector3[];
  68986. radius?: number;
  68987. tessellation?: number;
  68988. radiusFunction?: {
  68989. (i: number, distance: number): number;
  68990. };
  68991. cap?: number;
  68992. arc?: number;
  68993. updatable?: boolean;
  68994. sideOrientation?: number;
  68995. frontUVs?: Vector4;
  68996. backUVs?: Vector4;
  68997. instance?: Mesh;
  68998. invertUV?: boolean;
  68999. }, scene?: Nullable<Scene>): Mesh;
  69000. }
  69001. }
  69002. declare module "babylonjs/Meshes/Builders/icoSphereBuilder" {
  69003. import { Scene } from "babylonjs/scene";
  69004. import { Vector4 } from "babylonjs/Maths/math.vector";
  69005. import { Mesh } from "babylonjs/Meshes/mesh";
  69006. import { Nullable } from "babylonjs/types";
  69007. /**
  69008. * Class containing static functions to help procedurally build meshes
  69009. */
  69010. export class IcoSphereBuilder {
  69011. /**
  69012. * Creates a sphere based upon an icosahedron with 20 triangular faces which can be subdivided
  69013. * * The parameter `radius` sets the radius size (float) of the icosphere (default 1)
  69014. * * 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`)
  69015. * * The parameter `subdivisions` sets the number of subdivisions (postive integer, default 4). The more subdivisions, the more faces on the icosphere whatever its size
  69016. * * 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
  69017. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  69018. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  69019. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  69020. * @param name defines the name of the mesh
  69021. * @param options defines the options used to create the mesh
  69022. * @param scene defines the hosting scene
  69023. * @returns the icosahedron mesh
  69024. * @see https://doc.babylonjs.com/how_to/polyhedra_shapes#icosphere
  69025. */
  69026. static CreateIcoSphere(name: string, options: {
  69027. radius?: number;
  69028. radiusX?: number;
  69029. radiusY?: number;
  69030. radiusZ?: number;
  69031. flat?: boolean;
  69032. subdivisions?: number;
  69033. sideOrientation?: number;
  69034. frontUVs?: Vector4;
  69035. backUVs?: Vector4;
  69036. updatable?: boolean;
  69037. }, scene?: Nullable<Scene>): Mesh;
  69038. }
  69039. }
  69040. declare module "babylonjs/Meshes/Builders/decalBuilder" {
  69041. import { Vector3 } from "babylonjs/Maths/math.vector";
  69042. import { Mesh } from "babylonjs/Meshes/mesh";
  69043. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  69044. /**
  69045. * Class containing static functions to help procedurally build meshes
  69046. */
  69047. export class DecalBuilder {
  69048. /**
  69049. * Creates a decal mesh.
  69050. * 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
  69051. * * The parameter `position` (Vector3, default `(0, 0, 0)`) sets the position of the decal in World coordinates
  69052. * * The parameter `normal` (Vector3, default `Vector3.Up`) sets the normal of the mesh where the decal is applied onto in World coordinates
  69053. * * The parameter `size` (Vector3, default `(1, 1, 1)`) sets the decal scaling
  69054. * * The parameter `angle` (float in radian, default 0) sets the angle to rotate the decal
  69055. * @param name defines the name of the mesh
  69056. * @param sourceMesh defines the mesh where the decal must be applied
  69057. * @param options defines the options used to create the mesh
  69058. * @param scene defines the hosting scene
  69059. * @returns the decal mesh
  69060. * @see https://doc.babylonjs.com/how_to/decals
  69061. */
  69062. static CreateDecal(name: string, sourceMesh: AbstractMesh, options: {
  69063. position?: Vector3;
  69064. normal?: Vector3;
  69065. size?: Vector3;
  69066. angle?: number;
  69067. }): Mesh;
  69068. }
  69069. }
  69070. declare module "babylonjs/Meshes/meshBuilder" {
  69071. import { Vector4, Vector3, Vector2 } from "babylonjs/Maths/math.vector";
  69072. import { Nullable } from "babylonjs/types";
  69073. import { Scene } from "babylonjs/scene";
  69074. import { Mesh } from "babylonjs/Meshes/mesh";
  69075. import { LinesMesh } from "babylonjs/Meshes/linesMesh";
  69076. import { GroundMesh } from "babylonjs/Meshes/groundMesh";
  69077. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  69078. import { Color4, Color3 } from "babylonjs/Maths/math.color";
  69079. import { Plane } from "babylonjs/Maths/math.plane";
  69080. /**
  69081. * Class containing static functions to help procedurally build meshes
  69082. */
  69083. export class MeshBuilder {
  69084. /**
  69085. * Creates a box mesh
  69086. * * The parameter `size` sets the size (float) of each box side (default 1)
  69087. * * You can set some different box dimensions by using the parameters `width`, `height` and `depth` (all by default have the same value of `size`)
  69088. * * 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)
  69089. * * Please read this tutorial : https://doc.babylonjs.com/how_to/createbox_per_face_textures_and_colors
  69090. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  69091. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  69092. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  69093. * @see https://doc.babylonjs.com/how_to/set_shapes#box
  69094. * @param name defines the name of the mesh
  69095. * @param options defines the options used to create the mesh
  69096. * @param scene defines the hosting scene
  69097. * @returns the box mesh
  69098. */
  69099. static CreateBox(name: string, options: {
  69100. size?: number;
  69101. width?: number;
  69102. height?: number;
  69103. depth?: number;
  69104. faceUV?: Vector4[];
  69105. faceColors?: Color4[];
  69106. sideOrientation?: number;
  69107. frontUVs?: Vector4;
  69108. backUVs?: Vector4;
  69109. wrap?: boolean;
  69110. topBaseAt?: number;
  69111. bottomBaseAt?: number;
  69112. updatable?: boolean;
  69113. }, scene?: Nullable<Scene>): Mesh;
  69114. /**
  69115. * Creates a tiled box mesh
  69116. * * faceTiles sets the pattern, tile size and number of tiles for a face
  69117. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  69118. * @param name defines the name of the mesh
  69119. * @param options defines the options used to create the mesh
  69120. * @param scene defines the hosting scene
  69121. * @returns the tiled box mesh
  69122. */
  69123. static CreateTiledBox(name: string, options: {
  69124. pattern?: number;
  69125. size?: number;
  69126. width?: number;
  69127. height?: number;
  69128. depth: number;
  69129. tileSize?: number;
  69130. tileWidth?: number;
  69131. tileHeight?: number;
  69132. faceUV?: Vector4[];
  69133. faceColors?: Color4[];
  69134. alignHorizontal?: number;
  69135. alignVertical?: number;
  69136. sideOrientation?: number;
  69137. updatable?: boolean;
  69138. }, scene?: Nullable<Scene>): Mesh;
  69139. /**
  69140. * Creates a sphere mesh
  69141. * * The parameter `diameter` sets the diameter size (float) of the sphere (default 1)
  69142. * * 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`)
  69143. * * The parameter `segments` sets the sphere number of horizontal stripes (positive integer, default 32)
  69144. * * 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
  69145. * * 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)
  69146. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  69147. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  69148. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  69149. * @param name defines the name of the mesh
  69150. * @param options defines the options used to create the mesh
  69151. * @param scene defines the hosting scene
  69152. * @returns the sphere mesh
  69153. * @see https://doc.babylonjs.com/how_to/set_shapes#sphere
  69154. */
  69155. static CreateSphere(name: string, options: {
  69156. segments?: number;
  69157. diameter?: number;
  69158. diameterX?: number;
  69159. diameterY?: number;
  69160. diameterZ?: number;
  69161. arc?: number;
  69162. slice?: number;
  69163. sideOrientation?: number;
  69164. frontUVs?: Vector4;
  69165. backUVs?: Vector4;
  69166. updatable?: boolean;
  69167. }, scene?: Nullable<Scene>): Mesh;
  69168. /**
  69169. * Creates a plane polygonal mesh. By default, this is a disc
  69170. * * The parameter `radius` sets the radius size (float) of the polygon (default 0.5)
  69171. * * 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
  69172. * * 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
  69173. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  69174. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  69175. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  69176. * @param name defines the name of the mesh
  69177. * @param options defines the options used to create the mesh
  69178. * @param scene defines the hosting scene
  69179. * @returns the plane polygonal mesh
  69180. * @see https://doc.babylonjs.com/how_to/set_shapes#disc-or-regular-polygon
  69181. */
  69182. static CreateDisc(name: string, options: {
  69183. radius?: number;
  69184. tessellation?: number;
  69185. arc?: number;
  69186. updatable?: boolean;
  69187. sideOrientation?: number;
  69188. frontUVs?: Vector4;
  69189. backUVs?: Vector4;
  69190. }, scene?: Nullable<Scene>): Mesh;
  69191. /**
  69192. * Creates a sphere based upon an icosahedron with 20 triangular faces which can be subdivided
  69193. * * The parameter `radius` sets the radius size (float) of the icosphere (default 1)
  69194. * * 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`)
  69195. * * The parameter `subdivisions` sets the number of subdivisions (postive integer, default 4). The more subdivisions, the more faces on the icosphere whatever its size
  69196. * * 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
  69197. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  69198. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  69199. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  69200. * @param name defines the name of the mesh
  69201. * @param options defines the options used to create the mesh
  69202. * @param scene defines the hosting scene
  69203. * @returns the icosahedron mesh
  69204. * @see https://doc.babylonjs.com/how_to/polyhedra_shapes#icosphere
  69205. */
  69206. static CreateIcoSphere(name: string, options: {
  69207. radius?: number;
  69208. radiusX?: number;
  69209. radiusY?: number;
  69210. radiusZ?: number;
  69211. flat?: boolean;
  69212. subdivisions?: number;
  69213. sideOrientation?: number;
  69214. frontUVs?: Vector4;
  69215. backUVs?: Vector4;
  69216. updatable?: boolean;
  69217. }, scene?: Nullable<Scene>): Mesh;
  69218. /**
  69219. * Creates a ribbon mesh. The ribbon is a parametric shape. It has no predefined shape. Its final shape will depend on the input parameters
  69220. * * The parameter `pathArray` is a required array of paths, what are each an array of successive Vector3. The pathArray parameter depicts the ribbon geometry
  69221. * * The parameter `closeArray` (boolean, default false) creates a seam between the first and the last paths of the path array
  69222. * * The parameter `closePath` (boolean, default false) creates a seam between the first and the last points of each path of the path array
  69223. * * 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
  69224. * * 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
  69225. * * 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
  69226. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  69227. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  69228. * * The optional parameter `invertUV` (boolean, default false) swaps in the geometry the U and V coordinates to apply a texture
  69229. * * 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
  69230. * * The parameters `colors` is an optional flat array of `Color4` to set/update each ribbon vertex with its own custom color values
  69231. * * 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
  69232. * * Moreover, you can use the parameter `color` with `instance` (to update the ribbon), only if you previously used it at creation time
  69233. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  69234. * @param name defines the name of the mesh
  69235. * @param options defines the options used to create the mesh
  69236. * @param scene defines the hosting scene
  69237. * @returns the ribbon mesh
  69238. * @see https://doc.babylonjs.com/how_to/ribbon_tutorial
  69239. * @see https://doc.babylonjs.com/how_to/parametric_shapes
  69240. */
  69241. static CreateRibbon(name: string, options: {
  69242. pathArray: Vector3[][];
  69243. closeArray?: boolean;
  69244. closePath?: boolean;
  69245. offset?: number;
  69246. updatable?: boolean;
  69247. sideOrientation?: number;
  69248. frontUVs?: Vector4;
  69249. backUVs?: Vector4;
  69250. instance?: Mesh;
  69251. invertUV?: boolean;
  69252. uvs?: Vector2[];
  69253. colors?: Color4[];
  69254. }, scene?: Nullable<Scene>): Mesh;
  69255. /**
  69256. * Creates a cylinder or a cone mesh
  69257. * * The parameter `height` sets the height size (float) of the cylinder/cone (float, default 2).
  69258. * * The parameter `diameter` sets the diameter of the top and bottom cap at once (float, default 1).
  69259. * * 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.
  69260. * * The parameter `tessellation` sets the number of cylinder sides (positive integer, default 24). Set it to 3 to get a prism for instance.
  69261. * * The parameter `subdivisions` sets the number of rings along the cylinder height (positive integer, default 1).
  69262. * * The parameter `hasRings` (boolean, default false) makes the subdivisions independent from each other, so they become different faces.
  69263. * * The parameter `enclose` (boolean, default false) adds two extra faces per subdivision to a sliced cylinder to close it around its height axis.
  69264. * * 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).
  69265. * * The parameter `arc` (float, default 1) is the ratio (max 1) to apply to the circumference to slice the cylinder.
  69266. * * 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).
  69267. * * 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
  69268. * * Now, if the cylinder has 5 independent subdivisions (hasRings = true), n equals : top face + 5 stripe surfaces + bottom face = 2 + 5 = 7
  69269. * * 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
  69270. * * 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.
  69271. * * If `enclose` is false, a ring surface is one element.
  69272. * * If `enclose` is true, a ring surface is 3 successive elements in the array : the tubular surface, then the two closing faces.
  69273. * * 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
  69274. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  69275. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  69276. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created.
  69277. * @param name defines the name of the mesh
  69278. * @param options defines the options used to create the mesh
  69279. * @param scene defines the hosting scene
  69280. * @returns the cylinder mesh
  69281. * @see https://doc.babylonjs.com/how_to/set_shapes#cylinder-or-cone
  69282. */
  69283. static CreateCylinder(name: string, options: {
  69284. height?: number;
  69285. diameterTop?: number;
  69286. diameterBottom?: number;
  69287. diameter?: number;
  69288. tessellation?: number;
  69289. subdivisions?: number;
  69290. arc?: number;
  69291. faceColors?: Color4[];
  69292. faceUV?: Vector4[];
  69293. updatable?: boolean;
  69294. hasRings?: boolean;
  69295. enclose?: boolean;
  69296. cap?: number;
  69297. sideOrientation?: number;
  69298. frontUVs?: Vector4;
  69299. backUVs?: Vector4;
  69300. }, scene?: Nullable<Scene>): Mesh;
  69301. /**
  69302. * Creates a torus mesh
  69303. * * The parameter `diameter` sets the diameter size (float) of the torus (default 1)
  69304. * * The parameter `thickness` sets the diameter size of the tube of the torus (float, default 0.5)
  69305. * * The parameter `tessellation` sets the number of torus sides (postive integer, default 16)
  69306. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  69307. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  69308. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created.
  69309. * @param name defines the name of the mesh
  69310. * @param options defines the options used to create the mesh
  69311. * @param scene defines the hosting scene
  69312. * @returns the torus mesh
  69313. * @see https://doc.babylonjs.com/how_to/set_shapes#torus
  69314. */
  69315. static CreateTorus(name: string, options: {
  69316. diameter?: number;
  69317. thickness?: number;
  69318. tessellation?: number;
  69319. updatable?: boolean;
  69320. sideOrientation?: number;
  69321. frontUVs?: Vector4;
  69322. backUVs?: Vector4;
  69323. }, scene?: Nullable<Scene>): Mesh;
  69324. /**
  69325. * Creates a torus knot mesh
  69326. * * The parameter `radius` sets the global radius size (float) of the torus knot (default 2)
  69327. * * The parameter `radialSegments` sets the number of sides on each tube segments (positive integer, default 32)
  69328. * * The parameter `tubularSegments` sets the number of tubes to decompose the knot into (positive integer, default 32)
  69329. * * The parameters `p` and `q` are the number of windings on each axis (positive integers, default 2 and 3)
  69330. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  69331. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  69332. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created.
  69333. * @param name defines the name of the mesh
  69334. * @param options defines the options used to create the mesh
  69335. * @param scene defines the hosting scene
  69336. * @returns the torus knot mesh
  69337. * @see https://doc.babylonjs.com/how_to/set_shapes#torus-knot
  69338. */
  69339. static CreateTorusKnot(name: string, options: {
  69340. radius?: number;
  69341. tube?: number;
  69342. radialSegments?: number;
  69343. tubularSegments?: number;
  69344. p?: number;
  69345. q?: number;
  69346. updatable?: boolean;
  69347. sideOrientation?: number;
  69348. frontUVs?: Vector4;
  69349. backUVs?: Vector4;
  69350. }, scene?: Nullable<Scene>): Mesh;
  69351. /**
  69352. * Creates a line system mesh. A line system is a pool of many lines gathered in a single mesh
  69353. * * 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
  69354. * * Like every other parametric shape, it is dynamically updatable by passing an existing instance of LineSystem to this static function
  69355. * * The parameter `lines` is an array of lines, each line being an array of successive Vector3
  69356. * * The optional parameter `instance` is an instance of an existing LineSystem object to be updated with the passed `lines` parameter
  69357. * * The optional parameter `colors` is an array of line colors, each line colors being an array of successive Color4, one per line point
  69358. * * The optional parameter `useVertexAlpha` is to be set to `false` (default `true`) when you don't need the alpha blending (faster)
  69359. * * 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
  69360. * * When updating an instance, remember that only line point positions can change, not the number of points, neither the number of lines
  69361. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  69362. * @see https://doc.babylonjs.com/how_to/parametric_shapes#line-system
  69363. * @param name defines the name of the new line system
  69364. * @param options defines the options used to create the line system
  69365. * @param scene defines the hosting scene
  69366. * @returns a new line system mesh
  69367. */
  69368. static CreateLineSystem(name: string, options: {
  69369. lines: Vector3[][];
  69370. updatable?: boolean;
  69371. instance?: Nullable<LinesMesh>;
  69372. colors?: Nullable<Color4[][]>;
  69373. useVertexAlpha?: boolean;
  69374. }, scene: Nullable<Scene>): LinesMesh;
  69375. /**
  69376. * Creates a line mesh
  69377. * 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
  69378. * * Like every other parametric shape, it is dynamically updatable by passing an existing instance of LineMesh to this static function
  69379. * * The parameter `points` is an array successive Vector3
  69380. * * 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
  69381. * * The optional parameter `colors` is an array of successive Color4, one per line point
  69382. * * The optional parameter `useVertexAlpha` is to be set to `false` (default `true`) when you don't need alpha blending (faster)
  69383. * * When updating an instance, remember that only point positions can change, not the number of points
  69384. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  69385. * @see https://doc.babylonjs.com/how_to/parametric_shapes#lines
  69386. * @param name defines the name of the new line system
  69387. * @param options defines the options used to create the line system
  69388. * @param scene defines the hosting scene
  69389. * @returns a new line mesh
  69390. */
  69391. static CreateLines(name: string, options: {
  69392. points: Vector3[];
  69393. updatable?: boolean;
  69394. instance?: Nullable<LinesMesh>;
  69395. colors?: Color4[];
  69396. useVertexAlpha?: boolean;
  69397. }, scene?: Nullable<Scene>): LinesMesh;
  69398. /**
  69399. * Creates a dashed line mesh
  69400. * * 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
  69401. * * Like every other parametric shape, it is dynamically updatable by passing an existing instance of LineMesh to this static function
  69402. * * The parameter `points` is an array successive Vector3
  69403. * * The parameter `dashNb` is the intended total number of dashes (positive integer, default 200)
  69404. * * The parameter `dashSize` is the size of the dashes relatively the dash number (positive float, default 3)
  69405. * * The parameter `gapSize` is the size of the gap between two successive dashes relatively the dash number (positive float, default 1)
  69406. * * 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
  69407. * * When updating an instance, remember that only point positions can change, not the number of points
  69408. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  69409. * @param name defines the name of the mesh
  69410. * @param options defines the options used to create the mesh
  69411. * @param scene defines the hosting scene
  69412. * @returns the dashed line mesh
  69413. * @see https://doc.babylonjs.com/how_to/parametric_shapes#dashed-lines
  69414. */
  69415. static CreateDashedLines(name: string, options: {
  69416. points: Vector3[];
  69417. dashSize?: number;
  69418. gapSize?: number;
  69419. dashNb?: number;
  69420. updatable?: boolean;
  69421. instance?: LinesMesh;
  69422. }, scene?: Nullable<Scene>): LinesMesh;
  69423. /**
  69424. * 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.
  69425. * * 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.
  69426. * * The parameter `path` is a required array of successive Vector3. This is the axis curve the shape is extruded along.
  69427. * * 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.
  69428. * * The parameter `scale` (float, default 1) is the value to scale the shape.
  69429. * * 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
  69430. * * 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
  69431. * * Remember you can only change the shape or path point positions, not their number when updating an extruded shape.
  69432. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  69433. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  69434. * * The optional parameter `invertUV` (boolean, default false) swaps in the geometry the U and V coordinates to apply a texture.
  69435. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created.
  69436. * @param name defines the name of the mesh
  69437. * @param options defines the options used to create the mesh
  69438. * @param scene defines the hosting scene
  69439. * @returns the extruded shape mesh
  69440. * @see https://doc.babylonjs.com/how_to/parametric_shapes
  69441. * @see https://doc.babylonjs.com/how_to/parametric_shapes#extruded-shapes
  69442. */
  69443. static ExtrudeShape(name: string, options: {
  69444. shape: Vector3[];
  69445. path: Vector3[];
  69446. scale?: number;
  69447. rotation?: number;
  69448. cap?: number;
  69449. updatable?: boolean;
  69450. sideOrientation?: number;
  69451. frontUVs?: Vector4;
  69452. backUVs?: Vector4;
  69453. instance?: Mesh;
  69454. invertUV?: boolean;
  69455. }, scene?: Nullable<Scene>): Mesh;
  69456. /**
  69457. * Creates an custom extruded shape mesh.
  69458. * The custom extrusion is a parametric shape. It has no predefined shape. Its final shape will depend on the input parameters.
  69459. * * 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.
  69460. * * The parameter `path` is a required array of successive Vector3. This is the axis curve the shape is extruded along.
  69461. * * 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
  69462. * * It must returns a float value that will be the rotation in radians applied to the shape on each path point.
  69463. * * 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
  69464. * * It must returns a float value that will be the scale value applied to the shape on each path point
  69465. * * The parameter `ribbonClosePath` (boolean, default false) forces the extrusion underlying ribbon to close all the paths in its `pathArray`
  69466. * * The parameter `ribbonCloseArray` (boolean, default false) forces the extrusion underlying ribbon to close its `pathArray`
  69467. * * The parameter `cap` sets the way the extruded shape is capped. Possible values : BABYLON.Mesh.NO_CAP (default), BABYLON.Mesh.CAP_START, BABYLON.Mesh.CAP_END, BABYLON.Mesh.CAP_ALL
  69468. * * 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
  69469. * * Remember you can only change the shape or path point positions, not their number when updating an extruded shape
  69470. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  69471. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  69472. * * The optional parameter `invertUV` (boolean, default false) swaps in the geometry the U and V coordinates to apply a texture
  69473. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  69474. * @param name defines the name of the mesh
  69475. * @param options defines the options used to create the mesh
  69476. * @param scene defines the hosting scene
  69477. * @returns the custom extruded shape mesh
  69478. * @see https://doc.babylonjs.com/how_to/parametric_shapes#custom-extruded-shapes
  69479. * @see https://doc.babylonjs.com/how_to/parametric_shapes
  69480. * @see https://doc.babylonjs.com/how_to/parametric_shapes#extruded-shapes
  69481. */
  69482. static ExtrudeShapeCustom(name: string, options: {
  69483. shape: Vector3[];
  69484. path: Vector3[];
  69485. scaleFunction?: any;
  69486. rotationFunction?: any;
  69487. ribbonCloseArray?: boolean;
  69488. ribbonClosePath?: boolean;
  69489. cap?: number;
  69490. updatable?: boolean;
  69491. sideOrientation?: number;
  69492. frontUVs?: Vector4;
  69493. backUVs?: Vector4;
  69494. instance?: Mesh;
  69495. invertUV?: boolean;
  69496. }, scene?: Nullable<Scene>): Mesh;
  69497. /**
  69498. * Creates lathe mesh.
  69499. * The lathe is a shape with a symetry axis : a 2D model shape is rotated around this axis to design the lathe
  69500. * * 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
  69501. * * The parameter `radius` (positive float, default 1) is the radius value of the lathe
  69502. * * The parameter `tessellation` (positive integer, default 64) is the side number of the lathe
  69503. * * The parameter `clip` (positive integer, default 0) is the number of sides to not create without effecting the general shape of the sides
  69504. * * 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
  69505. * * The parameter `closed` (boolean, default true) opens/closes the lathe circumference. This should be set to false when used with the parameter "arc"
  69506. * * 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
  69507. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  69508. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  69509. * * The optional parameter `invertUV` (boolean, default false) swaps in the geometry the U and V coordinates to apply a texture
  69510. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  69511. * @param name defines the name of the mesh
  69512. * @param options defines the options used to create the mesh
  69513. * @param scene defines the hosting scene
  69514. * @returns the lathe mesh
  69515. * @see https://doc.babylonjs.com/how_to/parametric_shapes#lathe
  69516. */
  69517. static CreateLathe(name: string, options: {
  69518. shape: Vector3[];
  69519. radius?: number;
  69520. tessellation?: number;
  69521. clip?: number;
  69522. arc?: number;
  69523. closed?: boolean;
  69524. updatable?: boolean;
  69525. sideOrientation?: number;
  69526. frontUVs?: Vector4;
  69527. backUVs?: Vector4;
  69528. cap?: number;
  69529. invertUV?: boolean;
  69530. }, scene?: Nullable<Scene>): Mesh;
  69531. /**
  69532. * Creates a tiled plane mesh
  69533. * * You can set a limited pattern arrangement with the tiles
  69534. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  69535. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  69536. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  69537. * @param name defines the name of the mesh
  69538. * @param options defines the options used to create the mesh
  69539. * @param scene defines the hosting scene
  69540. * @returns the plane mesh
  69541. * @see https://doc.babylonjs.com/how_to/set_shapes#plane
  69542. */
  69543. static CreateTiledPlane(name: string, options: {
  69544. pattern?: number;
  69545. tileSize?: number;
  69546. tileWidth?: number;
  69547. tileHeight?: number;
  69548. size?: number;
  69549. width?: number;
  69550. height?: number;
  69551. alignHorizontal?: number;
  69552. alignVertical?: number;
  69553. sideOrientation?: number;
  69554. frontUVs?: Vector4;
  69555. backUVs?: Vector4;
  69556. updatable?: boolean;
  69557. }, scene?: Nullable<Scene>): Mesh;
  69558. /**
  69559. * Creates a plane mesh
  69560. * * The parameter `size` sets the size (float) of both sides of the plane at once (default 1)
  69561. * * You can set some different plane dimensions by using the parameters `width` and `height` (both by default have the same value of `size`)
  69562. * * The parameter `sourcePlane` is a Plane instance. It builds a mesh plane from a Math plane
  69563. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  69564. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  69565. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  69566. * @param name defines the name of the mesh
  69567. * @param options defines the options used to create the mesh
  69568. * @param scene defines the hosting scene
  69569. * @returns the plane mesh
  69570. * @see https://doc.babylonjs.com/how_to/set_shapes#plane
  69571. */
  69572. static CreatePlane(name: string, options: {
  69573. size?: number;
  69574. width?: number;
  69575. height?: number;
  69576. sideOrientation?: number;
  69577. frontUVs?: Vector4;
  69578. backUVs?: Vector4;
  69579. updatable?: boolean;
  69580. sourcePlane?: Plane;
  69581. }, scene?: Nullable<Scene>): Mesh;
  69582. /**
  69583. * Creates a ground mesh
  69584. * * The parameters `width` and `height` (floats, default 1) set the width and height sizes of the ground
  69585. * * The parameter `subdivisions` (positive integer) sets the number of subdivisions per side
  69586. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  69587. * @param name defines the name of the mesh
  69588. * @param options defines the options used to create the mesh
  69589. * @param scene defines the hosting scene
  69590. * @returns the ground mesh
  69591. * @see https://doc.babylonjs.com/how_to/set_shapes#ground
  69592. */
  69593. static CreateGround(name: string, options: {
  69594. width?: number;
  69595. height?: number;
  69596. subdivisions?: number;
  69597. subdivisionsX?: number;
  69598. subdivisionsY?: number;
  69599. updatable?: boolean;
  69600. }, scene?: Nullable<Scene>): Mesh;
  69601. /**
  69602. * Creates a tiled ground mesh
  69603. * * The parameters `xmin` and `xmax` (floats, default -1 and 1) set the ground minimum and maximum X coordinates
  69604. * * The parameters `zmin` and `zmax` (floats, default -1 and 1) set the ground minimum and maximum Z coordinates
  69605. * * 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
  69606. * * 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
  69607. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created.
  69608. * @param name defines the name of the mesh
  69609. * @param options defines the options used to create the mesh
  69610. * @param scene defines the hosting scene
  69611. * @returns the tiled ground mesh
  69612. * @see https://doc.babylonjs.com/how_to/set_shapes#tiled-ground
  69613. */
  69614. static CreateTiledGround(name: string, options: {
  69615. xmin: number;
  69616. zmin: number;
  69617. xmax: number;
  69618. zmax: number;
  69619. subdivisions?: {
  69620. w: number;
  69621. h: number;
  69622. };
  69623. precision?: {
  69624. w: number;
  69625. h: number;
  69626. };
  69627. updatable?: boolean;
  69628. }, scene?: Nullable<Scene>): Mesh;
  69629. /**
  69630. * Creates a ground mesh from a height map
  69631. * * The parameter `url` sets the URL of the height map image resource.
  69632. * * The parameters `width` and `height` (positive floats, default 10) set the ground width and height sizes.
  69633. * * The parameter `subdivisions` (positive integer, default 1) sets the number of subdivision per side.
  69634. * * The parameter `minHeight` (float, default 0) is the minimum altitude on the ground.
  69635. * * The parameter `maxHeight` (float, default 1) is the maximum altitude on the ground.
  69636. * * 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.
  69637. * * 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).
  69638. * * The parameter `alphaFilter` will filter any data where the alpha channel is below this value, defaults 0 (all data visible)
  69639. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created.
  69640. * @param name defines the name of the mesh
  69641. * @param url defines the url to the height map
  69642. * @param options defines the options used to create the mesh
  69643. * @param scene defines the hosting scene
  69644. * @returns the ground mesh
  69645. * @see https://doc.babylonjs.com/babylon101/height_map
  69646. * @see https://doc.babylonjs.com/how_to/set_shapes#ground-from-a-height-map
  69647. */
  69648. static CreateGroundFromHeightMap(name: string, url: string, options: {
  69649. width?: number;
  69650. height?: number;
  69651. subdivisions?: number;
  69652. minHeight?: number;
  69653. maxHeight?: number;
  69654. colorFilter?: Color3;
  69655. alphaFilter?: number;
  69656. updatable?: boolean;
  69657. onReady?: (mesh: GroundMesh) => void;
  69658. }, scene?: Nullable<Scene>): GroundMesh;
  69659. /**
  69660. * Creates a polygon mesh
  69661. * The polygon's shape will depend on the input parameters and is constructed parallel to a ground mesh
  69662. * * 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
  69663. * * You can set the mesh side orientation with the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  69664. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  69665. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4)
  69666. * * Remember you can only change the shape positions, not their number when updating a polygon
  69667. * @param name defines the name of the mesh
  69668. * @param options defines the options used to create the mesh
  69669. * @param scene defines the hosting scene
  69670. * @param earcutInjection can be used to inject your own earcut reference
  69671. * @returns the polygon mesh
  69672. */
  69673. static CreatePolygon(name: string, options: {
  69674. shape: Vector3[];
  69675. holes?: Vector3[][];
  69676. depth?: number;
  69677. faceUV?: Vector4[];
  69678. faceColors?: Color4[];
  69679. updatable?: boolean;
  69680. sideOrientation?: number;
  69681. frontUVs?: Vector4;
  69682. backUVs?: Vector4;
  69683. }, scene?: Nullable<Scene>, earcutInjection?: any): Mesh;
  69684. /**
  69685. * Creates an extruded polygon mesh, with depth in the Y direction.
  69686. * * 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)
  69687. * @see https://doc.babylonjs.com/how_to/createbox_per_face_textures_and_colors
  69688. * @param name defines the name of the mesh
  69689. * @param options defines the options used to create the mesh
  69690. * @param scene defines the hosting scene
  69691. * @param earcutInjection can be used to inject your own earcut reference
  69692. * @returns the polygon mesh
  69693. */
  69694. static ExtrudePolygon(name: string, options: {
  69695. shape: Vector3[];
  69696. holes?: Vector3[][];
  69697. depth?: number;
  69698. faceUV?: Vector4[];
  69699. faceColors?: Color4[];
  69700. updatable?: boolean;
  69701. sideOrientation?: number;
  69702. frontUVs?: Vector4;
  69703. backUVs?: Vector4;
  69704. }, scene?: Nullable<Scene>, earcutInjection?: any): Mesh;
  69705. /**
  69706. * Creates a tube mesh.
  69707. * The tube is a parametric shape. It has no predefined shape. Its final shape will depend on the input parameters
  69708. * * The parameter `path` is a required array of successive Vector3. It is the curve used as the axis of the tube
  69709. * * The parameter `radius` (positive float, default 1) sets the tube radius size
  69710. * * The parameter `tessellation` (positive float, default 64) is the number of sides on the tubular surface
  69711. * * The parameter `radiusFunction` (javascript function, default null) is a vanilla javascript function. If it is not null, it overwrittes the parameter `radius`
  69712. * * 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)
  69713. * * The parameter `arc` (positive float, maximum 1, default 1) is the ratio to apply to the tube circumference : 2 x PI x arc
  69714. * * 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
  69715. * * 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
  69716. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  69717. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  69718. * * The optional parameter `invertUV` (boolean, default false) swaps in the geometry the U and V coordinates to apply a texture
  69719. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  69720. * @param name defines the name of the mesh
  69721. * @param options defines the options used to create the mesh
  69722. * @param scene defines the hosting scene
  69723. * @returns the tube mesh
  69724. * @see https://doc.babylonjs.com/how_to/parametric_shapes
  69725. * @see https://doc.babylonjs.com/how_to/set_shapes#tube
  69726. */
  69727. static CreateTube(name: string, options: {
  69728. path: Vector3[];
  69729. radius?: number;
  69730. tessellation?: number;
  69731. radiusFunction?: {
  69732. (i: number, distance: number): number;
  69733. };
  69734. cap?: number;
  69735. arc?: number;
  69736. updatable?: boolean;
  69737. sideOrientation?: number;
  69738. frontUVs?: Vector4;
  69739. backUVs?: Vector4;
  69740. instance?: Mesh;
  69741. invertUV?: boolean;
  69742. }, scene?: Nullable<Scene>): Mesh;
  69743. /**
  69744. * Creates a polyhedron mesh
  69745. * * 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
  69746. * * The parameter `size` (positive float, default 1) sets the polygon size
  69747. * * You can overwrite the `size` on each dimension bu using the parameters `sizeX`, `sizeY` or `sizeZ` (positive floats, default to `size` value)
  69748. * * 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`
  69749. * * 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
  69750. * * 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)`)
  69751. * * 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
  69752. * * 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
  69753. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  69754. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  69755. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  69756. * @param name defines the name of the mesh
  69757. * @param options defines the options used to create the mesh
  69758. * @param scene defines the hosting scene
  69759. * @returns the polyhedron mesh
  69760. * @see https://doc.babylonjs.com/how_to/polyhedra_shapes
  69761. */
  69762. static CreatePolyhedron(name: string, options: {
  69763. type?: number;
  69764. size?: number;
  69765. sizeX?: number;
  69766. sizeY?: number;
  69767. sizeZ?: number;
  69768. custom?: any;
  69769. faceUV?: Vector4[];
  69770. faceColors?: Color4[];
  69771. flat?: boolean;
  69772. updatable?: boolean;
  69773. sideOrientation?: number;
  69774. frontUVs?: Vector4;
  69775. backUVs?: Vector4;
  69776. }, scene?: Nullable<Scene>): Mesh;
  69777. /**
  69778. * Creates a decal mesh.
  69779. * 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
  69780. * * The parameter `position` (Vector3, default `(0, 0, 0)`) sets the position of the decal in World coordinates
  69781. * * The parameter `normal` (Vector3, default `Vector3.Up`) sets the normal of the mesh where the decal is applied onto in World coordinates
  69782. * * The parameter `size` (Vector3, default `(1, 1, 1)`) sets the decal scaling
  69783. * * The parameter `angle` (float in radian, default 0) sets the angle to rotate the decal
  69784. * @param name defines the name of the mesh
  69785. * @param sourceMesh defines the mesh where the decal must be applied
  69786. * @param options defines the options used to create the mesh
  69787. * @param scene defines the hosting scene
  69788. * @returns the decal mesh
  69789. * @see https://doc.babylonjs.com/how_to/decals
  69790. */
  69791. static CreateDecal(name: string, sourceMesh: AbstractMesh, options: {
  69792. position?: Vector3;
  69793. normal?: Vector3;
  69794. size?: Vector3;
  69795. angle?: number;
  69796. }): Mesh;
  69797. }
  69798. }
  69799. declare module "babylonjs/Meshes/meshSimplification" {
  69800. import { Mesh } from "babylonjs/Meshes/mesh";
  69801. /**
  69802. * A simplifier interface for future simplification implementations
  69803. * @see https://doc.babylonjs.com/how_to/in-browser_mesh_simplification
  69804. */
  69805. export interface ISimplifier {
  69806. /**
  69807. * Simplification of a given mesh according to the given settings.
  69808. * Since this requires computation, it is assumed that the function runs async.
  69809. * @param settings The settings of the simplification, including quality and distance
  69810. * @param successCallback A callback that will be called after the mesh was simplified.
  69811. * @param errorCallback in case of an error, this callback will be called. optional.
  69812. */
  69813. simplify(settings: ISimplificationSettings, successCallback: (simplifiedMeshes: Mesh) => void, errorCallback?: () => void): void;
  69814. }
  69815. /**
  69816. * Expected simplification settings.
  69817. * Quality should be between 0 and 1 (1 being 100%, 0 being 0%)
  69818. * @see https://doc.babylonjs.com/how_to/in-browser_mesh_simplification
  69819. */
  69820. export interface ISimplificationSettings {
  69821. /**
  69822. * Gets or sets the expected quality
  69823. */
  69824. quality: number;
  69825. /**
  69826. * Gets or sets the distance when this optimized version should be used
  69827. */
  69828. distance: number;
  69829. /**
  69830. * Gets an already optimized mesh
  69831. */
  69832. optimizeMesh?: boolean;
  69833. }
  69834. /**
  69835. * Class used to specify simplification options
  69836. * @see https://doc.babylonjs.com/how_to/in-browser_mesh_simplification
  69837. */
  69838. export class SimplificationSettings implements ISimplificationSettings {
  69839. /** expected quality */
  69840. quality: number;
  69841. /** distance when this optimized version should be used */
  69842. distance: number;
  69843. /** already optimized mesh */
  69844. optimizeMesh?: boolean | undefined;
  69845. /**
  69846. * Creates a SimplificationSettings
  69847. * @param quality expected quality
  69848. * @param distance distance when this optimized version should be used
  69849. * @param optimizeMesh already optimized mesh
  69850. */
  69851. constructor(
  69852. /** expected quality */
  69853. quality: number,
  69854. /** distance when this optimized version should be used */
  69855. distance: number,
  69856. /** already optimized mesh */
  69857. optimizeMesh?: boolean | undefined);
  69858. }
  69859. /**
  69860. * Interface used to define a simplification task
  69861. */
  69862. export interface ISimplificationTask {
  69863. /**
  69864. * Array of settings
  69865. */
  69866. settings: Array<ISimplificationSettings>;
  69867. /**
  69868. * Simplification type
  69869. */
  69870. simplificationType: SimplificationType;
  69871. /**
  69872. * Mesh to simplify
  69873. */
  69874. mesh: Mesh;
  69875. /**
  69876. * Callback called on success
  69877. */
  69878. successCallback?: () => void;
  69879. /**
  69880. * Defines if parallel processing can be used
  69881. */
  69882. parallelProcessing: boolean;
  69883. }
  69884. /**
  69885. * Queue used to order the simplification tasks
  69886. * @see https://doc.babylonjs.com/how_to/in-browser_mesh_simplification
  69887. */
  69888. export class SimplificationQueue {
  69889. private _simplificationArray;
  69890. /**
  69891. * Gets a boolean indicating that the process is still running
  69892. */
  69893. running: boolean;
  69894. /**
  69895. * Creates a new queue
  69896. */
  69897. constructor();
  69898. /**
  69899. * Adds a new simplification task
  69900. * @param task defines a task to add
  69901. */
  69902. addTask(task: ISimplificationTask): void;
  69903. /**
  69904. * Execute next task
  69905. */
  69906. executeNext(): void;
  69907. /**
  69908. * Execute a simplification task
  69909. * @param task defines the task to run
  69910. */
  69911. runSimplification(task: ISimplificationTask): void;
  69912. private getSimplifier;
  69913. }
  69914. /**
  69915. * The implemented types of simplification
  69916. * At the moment only Quadratic Error Decimation is implemented
  69917. * @see https://doc.babylonjs.com/how_to/in-browser_mesh_simplification
  69918. */
  69919. export enum SimplificationType {
  69920. /** Quadratic error decimation */
  69921. QUADRATIC = 0
  69922. }
  69923. /**
  69924. * An implementation of the Quadratic Error simplification algorithm.
  69925. * Original paper : http://www1.cs.columbia.edu/~cs4162/html05s/garland97.pdf
  69926. * Ported mostly from QSlim and http://voxels.blogspot.de/2014/05/quadric-mesh-simplification-with-source.html to babylon JS
  69927. * @author RaananW
  69928. * @see https://doc.babylonjs.com/how_to/in-browser_mesh_simplification
  69929. */
  69930. export class QuadraticErrorSimplification implements ISimplifier {
  69931. private _mesh;
  69932. private triangles;
  69933. private vertices;
  69934. private references;
  69935. private _reconstructedMesh;
  69936. /** Gets or sets the number pf sync interations */
  69937. syncIterations: number;
  69938. /** Gets or sets the aggressiveness of the simplifier */
  69939. aggressiveness: number;
  69940. /** Gets or sets the number of allowed iterations for decimation */
  69941. decimationIterations: number;
  69942. /** Gets or sets the espilon to use for bounding box computation */
  69943. boundingBoxEpsilon: number;
  69944. /**
  69945. * Creates a new QuadraticErrorSimplification
  69946. * @param _mesh defines the target mesh
  69947. */
  69948. constructor(_mesh: Mesh);
  69949. /**
  69950. * Simplification of a given mesh according to the given settings.
  69951. * Since this requires computation, it is assumed that the function runs async.
  69952. * @param settings The settings of the simplification, including quality and distance
  69953. * @param successCallback A callback that will be called after the mesh was simplified.
  69954. */
  69955. simplify(settings: ISimplificationSettings, successCallback: (simplifiedMesh: Mesh) => void): void;
  69956. private runDecimation;
  69957. private initWithMesh;
  69958. private init;
  69959. private reconstructMesh;
  69960. private initDecimatedMesh;
  69961. private isFlipped;
  69962. private updateTriangles;
  69963. private identifyBorder;
  69964. private updateMesh;
  69965. private vertexError;
  69966. private calculateError;
  69967. }
  69968. }
  69969. declare module "babylonjs/Meshes/meshSimplificationSceneComponent" {
  69970. import { Scene } from "babylonjs/scene";
  69971. import { SimplificationQueue, ISimplificationSettings, SimplificationType } from "babylonjs/Meshes/meshSimplification";
  69972. import { ISceneComponent } from "babylonjs/sceneComponent";
  69973. module "babylonjs/scene" {
  69974. interface Scene {
  69975. /** @hidden (Backing field) */
  69976. _simplificationQueue: SimplificationQueue;
  69977. /**
  69978. * Gets or sets the simplification queue attached to the scene
  69979. * @see https://doc.babylonjs.com/how_to/in-browser_mesh_simplification
  69980. */
  69981. simplificationQueue: SimplificationQueue;
  69982. }
  69983. }
  69984. module "babylonjs/Meshes/mesh" {
  69985. interface Mesh {
  69986. /**
  69987. * Simplify the mesh according to the given array of settings.
  69988. * Function will return immediately and will simplify async
  69989. * @param settings a collection of simplification settings
  69990. * @param parallelProcessing should all levels calculate parallel or one after the other
  69991. * @param simplificationType the type of simplification to run
  69992. * @param successCallback optional success callback to be called after the simplification finished processing all settings
  69993. * @returns the current mesh
  69994. */
  69995. simplify(settings: Array<ISimplificationSettings>, parallelProcessing?: boolean, simplificationType?: SimplificationType, successCallback?: (mesh?: Mesh, submeshIndex?: number) => void): Mesh;
  69996. }
  69997. }
  69998. /**
  69999. * Defines the simplification queue scene component responsible to help scheduling the various simplification task
  70000. * created in a scene
  70001. */
  70002. export class SimplicationQueueSceneComponent implements ISceneComponent {
  70003. /**
  70004. * The component name helpfull to identify the component in the list of scene components.
  70005. */
  70006. readonly name: string;
  70007. /**
  70008. * The scene the component belongs to.
  70009. */
  70010. scene: Scene;
  70011. /**
  70012. * Creates a new instance of the component for the given scene
  70013. * @param scene Defines the scene to register the component in
  70014. */
  70015. constructor(scene: Scene);
  70016. /**
  70017. * Registers the component in a given scene
  70018. */
  70019. register(): void;
  70020. /**
  70021. * Rebuilds the elements related to this component in case of
  70022. * context lost for instance.
  70023. */
  70024. rebuild(): void;
  70025. /**
  70026. * Disposes the component and the associated ressources
  70027. */
  70028. dispose(): void;
  70029. private _beforeCameraUpdate;
  70030. }
  70031. }
  70032. declare module "babylonjs/Meshes/Builders/index" {
  70033. export * from "babylonjs/Meshes/Builders/boxBuilder";
  70034. export * from "babylonjs/Meshes/Builders/tiledBoxBuilder";
  70035. export * from "babylonjs/Meshes/Builders/discBuilder";
  70036. export * from "babylonjs/Meshes/Builders/ribbonBuilder";
  70037. export * from "babylonjs/Meshes/Builders/sphereBuilder";
  70038. export * from "babylonjs/Meshes/Builders/hemisphereBuilder";
  70039. export * from "babylonjs/Meshes/Builders/cylinderBuilder";
  70040. export * from "babylonjs/Meshes/Builders/torusBuilder";
  70041. export * from "babylonjs/Meshes/Builders/torusKnotBuilder";
  70042. export * from "babylonjs/Meshes/Builders/linesBuilder";
  70043. export * from "babylonjs/Meshes/Builders/polygonBuilder";
  70044. export * from "babylonjs/Meshes/Builders/shapeBuilder";
  70045. export * from "babylonjs/Meshes/Builders/latheBuilder";
  70046. export * from "babylonjs/Meshes/Builders/planeBuilder";
  70047. export * from "babylonjs/Meshes/Builders/tiledPlaneBuilder";
  70048. export * from "babylonjs/Meshes/Builders/groundBuilder";
  70049. export * from "babylonjs/Meshes/Builders/tubeBuilder";
  70050. export * from "babylonjs/Meshes/Builders/polyhedronBuilder";
  70051. export * from "babylonjs/Meshes/Builders/icoSphereBuilder";
  70052. export * from "babylonjs/Meshes/Builders/decalBuilder";
  70053. }
  70054. declare module "babylonjs/Meshes/thinInstanceMesh" {
  70055. import { Nullable, DeepImmutableObject } from "babylonjs/types";
  70056. import { VertexBuffer } from "babylonjs/Meshes/buffer";
  70057. import { Matrix } from "babylonjs/Maths/math.vector";
  70058. module "babylonjs/Meshes/mesh" {
  70059. interface Mesh {
  70060. /**
  70061. * Gets or sets a boolean defining if we want picking to pick thin instances as well
  70062. */
  70063. thinInstanceEnablePicking: boolean;
  70064. /**
  70065. * Creates a new thin instance
  70066. * @param matrix the matrix or array of matrices (position, rotation, scale) of the thin instance(s) to create
  70067. * @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
  70068. * @returns the thin instance index number. If you pass an array of matrices, other instance indexes are index+1, index+2, etc
  70069. */
  70070. thinInstanceAdd(matrix: DeepImmutableObject<Matrix> | Array<DeepImmutableObject<Matrix>>, refresh: boolean): number;
  70071. /**
  70072. * Adds the transformation (matrix) of the current mesh as a thin instance
  70073. * @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
  70074. * @returns the thin instance index number
  70075. */
  70076. thinInstanceAddSelf(refresh: boolean): number;
  70077. /**
  70078. * Registers a custom attribute to be used with thin instances
  70079. * @param kind name of the attribute
  70080. * @param stride size in floats of the attribute
  70081. */
  70082. thinInstanceRegisterAttribute(kind: string, stride: number): void;
  70083. /**
  70084. * Sets the matrix of a thin instance
  70085. * @param index index of the thin instance
  70086. * @param matrix matrix to set
  70087. * @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
  70088. */
  70089. thinInstanceSetMatrixAt(index: number, matrix: DeepImmutableObject<Matrix>, refresh: boolean): void;
  70090. /**
  70091. * Sets the value of a custom attribute for a thin instance
  70092. * @param kind name of the attribute
  70093. * @param index index of the thin instance
  70094. * @param value value to set
  70095. * @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
  70096. */
  70097. thinInstanceSetAttributeAt(kind: string, index: number, value: Array<number>, refresh: boolean): void;
  70098. /**
  70099. * 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.
  70100. */
  70101. thinInstanceCount: number;
  70102. /**
  70103. * Sets a buffer to be used with thin instances. This method is a faster way to setup multiple instances than calling thinInstanceAdd repeatedly
  70104. * @param kind name of the attribute. Use "matrix" to setup the buffer of matrices
  70105. * @param buffer buffer to set
  70106. * @param stride size in floats of each value of the buffer
  70107. * @param staticBuffer indicates that the buffer is static, so that you won't change it after it is set (better performances - false by default)
  70108. */
  70109. thinInstanceSetBuffer(kind: string, buffer: Nullable<Float32Array>, stride: number, staticBuffer: boolean): void;
  70110. /**
  70111. * Gets the list of world matrices
  70112. * @return an array containing all the world matrices from the thin instances
  70113. */
  70114. thinInstanceGetWorldMatrices(): Matrix[];
  70115. /**
  70116. * Synchronize the gpu buffers with a thin instance buffer. Call this method if you update later on the buffers passed to thinInstanceSetBuffer
  70117. * @param kind name of the attribute to update. Use "matrix" to update the buffer of matrices
  70118. */
  70119. thinInstanceBufferUpdated(kind: string): void;
  70120. /**
  70121. * Refreshes the bounding info, taking into account all the thin instances defined
  70122. * @param forceRefreshParentInfo true to force recomputing the mesh bounding info and use it to compute the aggregated bounding info
  70123. */
  70124. thinInstanceRefreshBoundingInfo(forceRefreshParentInfo: boolean): void;
  70125. /** @hidden */
  70126. _thinInstanceInitializeUserStorage(): void;
  70127. /** @hidden */
  70128. _thinInstanceUpdateBufferSize(kind: string, numInstances: number): void;
  70129. /** @hidden */
  70130. _userThinInstanceBuffersStorage: {
  70131. data: {
  70132. [key: string]: Float32Array;
  70133. };
  70134. sizes: {
  70135. [key: string]: number;
  70136. };
  70137. vertexBuffers: {
  70138. [key: string]: Nullable<VertexBuffer>;
  70139. };
  70140. strides: {
  70141. [key: string]: number;
  70142. };
  70143. };
  70144. }
  70145. }
  70146. }
  70147. declare module "babylonjs/Meshes/index" {
  70148. export * from "babylonjs/Meshes/abstractMesh";
  70149. export * from "babylonjs/Meshes/buffer";
  70150. export * from "babylonjs/Meshes/Compression/index";
  70151. export * from "babylonjs/Meshes/csg";
  70152. export * from "babylonjs/Meshes/geometry";
  70153. export * from "babylonjs/Meshes/groundMesh";
  70154. export * from "babylonjs/Meshes/trailMesh";
  70155. export * from "babylonjs/Meshes/instancedMesh";
  70156. export * from "babylonjs/Meshes/linesMesh";
  70157. export * from "babylonjs/Meshes/mesh";
  70158. export * from "babylonjs/Meshes/mesh.vertexData";
  70159. export * from "babylonjs/Meshes/meshBuilder";
  70160. export * from "babylonjs/Meshes/meshSimplification";
  70161. export * from "babylonjs/Meshes/meshSimplificationSceneComponent";
  70162. export * from "babylonjs/Meshes/polygonMesh";
  70163. export * from "babylonjs/Meshes/subMesh";
  70164. export * from "babylonjs/Meshes/meshLODLevel";
  70165. export * from "babylonjs/Meshes/transformNode";
  70166. export * from "babylonjs/Meshes/Builders/index";
  70167. export * from "babylonjs/Meshes/dataBuffer";
  70168. export * from "babylonjs/Meshes/WebGL/webGLDataBuffer";
  70169. import "babylonjs/Meshes/thinInstanceMesh";
  70170. export * from "babylonjs/Meshes/thinInstanceMesh";
  70171. }
  70172. declare module "babylonjs/Morph/index" {
  70173. export * from "babylonjs/Morph/morphTarget";
  70174. export * from "babylonjs/Morph/morphTargetManager";
  70175. }
  70176. declare module "babylonjs/Navigation/INavigationEngine" {
  70177. import { TransformNode } from "babylonjs/Meshes/transformNode";
  70178. import { Vector3 } from "babylonjs/Maths/math";
  70179. import { Mesh } from "babylonjs/Meshes/mesh";
  70180. import { Scene } from "babylonjs/scene";
  70181. /**
  70182. * Navigation plugin interface to add navigation constrained by a navigation mesh
  70183. */
  70184. export interface INavigationEnginePlugin {
  70185. /**
  70186. * plugin name
  70187. */
  70188. name: string;
  70189. /**
  70190. * Creates a navigation mesh
  70191. * @param meshes array of all the geometry used to compute the navigatio mesh
  70192. * @param parameters bunch of parameters used to filter geometry
  70193. */
  70194. createNavMesh(meshes: Array<Mesh>, parameters: INavMeshParameters): void;
  70195. /**
  70196. * Create a navigation mesh debug mesh
  70197. * @param scene is where the mesh will be added
  70198. * @returns debug display mesh
  70199. */
  70200. createDebugNavMesh(scene: Scene): Mesh;
  70201. /**
  70202. * Get a navigation mesh constrained position, closest to the parameter position
  70203. * @param position world position
  70204. * @returns the closest point to position constrained by the navigation mesh
  70205. */
  70206. getClosestPoint(position: Vector3): Vector3;
  70207. /**
  70208. * Get a navigation mesh constrained position, closest to the parameter position
  70209. * @param position world position
  70210. * @param result output the closest point to position constrained by the navigation mesh
  70211. */
  70212. getClosestPointToRef(position: Vector3, result: Vector3): void;
  70213. /**
  70214. * Get a navigation mesh constrained position, within a particular radius
  70215. * @param position world position
  70216. * @param maxRadius the maximum distance to the constrained world position
  70217. * @returns the closest point to position constrained by the navigation mesh
  70218. */
  70219. getRandomPointAround(position: Vector3, maxRadius: number): Vector3;
  70220. /**
  70221. * Get a navigation mesh constrained position, within a particular radius
  70222. * @param position world position
  70223. * @param maxRadius the maximum distance to the constrained world position
  70224. * @param result output the closest point to position constrained by the navigation mesh
  70225. */
  70226. getRandomPointAroundToRef(position: Vector3, maxRadius: number, result: Vector3): void;
  70227. /**
  70228. * Compute the final position from a segment made of destination-position
  70229. * @param position world position
  70230. * @param destination world position
  70231. * @returns the resulting point along the navmesh
  70232. */
  70233. moveAlong(position: Vector3, destination: Vector3): Vector3;
  70234. /**
  70235. * Compute the final position from a segment made of destination-position
  70236. * @param position world position
  70237. * @param destination world position
  70238. * @param result output the resulting point along the navmesh
  70239. */
  70240. moveAlongToRef(position: Vector3, destination: Vector3, result: Vector3): void;
  70241. /**
  70242. * Compute a navigation path from start to end. Returns an empty array if no path can be computed
  70243. * @param start world position
  70244. * @param end world position
  70245. * @returns array containing world position composing the path
  70246. */
  70247. computePath(start: Vector3, end: Vector3): Vector3[];
  70248. /**
  70249. * If this plugin is supported
  70250. * @returns true if plugin is supported
  70251. */
  70252. isSupported(): boolean;
  70253. /**
  70254. * Create a new Crowd so you can add agents
  70255. * @param maxAgents the maximum agent count in the crowd
  70256. * @param maxAgentRadius the maximum radius an agent can have
  70257. * @param scene to attach the crowd to
  70258. * @returns the crowd you can add agents to
  70259. */
  70260. createCrowd(maxAgents: number, maxAgentRadius: number, scene: Scene): ICrowd;
  70261. /**
  70262. * Set the Bounding box extent for doing spatial queries (getClosestPoint, getRandomPointAround, ...)
  70263. * The queries will try to find a solution within those bounds
  70264. * default is (1,1,1)
  70265. * @param extent x,y,z value that define the extent around the queries point of reference
  70266. */
  70267. setDefaultQueryExtent(extent: Vector3): void;
  70268. /**
  70269. * Get the Bounding box extent specified by setDefaultQueryExtent
  70270. * @returns the box extent values
  70271. */
  70272. getDefaultQueryExtent(): Vector3;
  70273. /**
  70274. * build the navmesh from a previously saved state using getNavmeshData
  70275. * @param data the Uint8Array returned by getNavmeshData
  70276. */
  70277. buildFromNavmeshData(data: Uint8Array): void;
  70278. /**
  70279. * returns the navmesh data that can be used later. The navmesh must be built before retrieving the data
  70280. * @returns data the Uint8Array that can be saved and reused
  70281. */
  70282. getNavmeshData(): Uint8Array;
  70283. /**
  70284. * Get the Bounding box extent result specified by setDefaultQueryExtent
  70285. * @param result output the box extent values
  70286. */
  70287. getDefaultQueryExtentToRef(result: Vector3): void;
  70288. /**
  70289. * Release all resources
  70290. */
  70291. dispose(): void;
  70292. }
  70293. /**
  70294. * Crowd Interface. A Crowd is a collection of moving agents constrained by a navigation mesh
  70295. */
  70296. export interface ICrowd {
  70297. /**
  70298. * Add a new agent to the crowd with the specified parameter a corresponding transformNode.
  70299. * You can attach anything to that node. The node position is updated in the scene update tick.
  70300. * @param pos world position that will be constrained by the navigation mesh
  70301. * @param parameters agent parameters
  70302. * @param transform hooked to the agent that will be update by the scene
  70303. * @returns agent index
  70304. */
  70305. addAgent(pos: Vector3, parameters: IAgentParameters, transform: TransformNode): number;
  70306. /**
  70307. * Returns the agent position in world space
  70308. * @param index agent index returned by addAgent
  70309. * @returns world space position
  70310. */
  70311. getAgentPosition(index: number): Vector3;
  70312. /**
  70313. * Gets the agent position result in world space
  70314. * @param index agent index returned by addAgent
  70315. * @param result output world space position
  70316. */
  70317. getAgentPositionToRef(index: number, result: Vector3): void;
  70318. /**
  70319. * Gets the agent velocity in world space
  70320. * @param index agent index returned by addAgent
  70321. * @returns world space velocity
  70322. */
  70323. getAgentVelocity(index: number): Vector3;
  70324. /**
  70325. * Gets the agent velocity result in world space
  70326. * @param index agent index returned by addAgent
  70327. * @param result output world space velocity
  70328. */
  70329. getAgentVelocityToRef(index: number, result: Vector3): void;
  70330. /**
  70331. * remove a particular agent previously created
  70332. * @param index agent index returned by addAgent
  70333. */
  70334. removeAgent(index: number): void;
  70335. /**
  70336. * get the list of all agents attached to this crowd
  70337. * @returns list of agent indices
  70338. */
  70339. getAgents(): number[];
  70340. /**
  70341. * Tick update done by the Scene. Agent position/velocity/acceleration is updated by this function
  70342. * @param deltaTime in seconds
  70343. */
  70344. update(deltaTime: number): void;
  70345. /**
  70346. * Asks a particular agent to go to a destination. That destination is constrained by the navigation mesh
  70347. * @param index agent index returned by addAgent
  70348. * @param destination targeted world position
  70349. */
  70350. agentGoto(index: number, destination: Vector3): void;
  70351. /**
  70352. * Teleport the agent to a new position
  70353. * @param index agent index returned by addAgent
  70354. * @param destination targeted world position
  70355. */
  70356. agentTeleport(index: number, destination: Vector3): void;
  70357. /**
  70358. * Update agent parameters
  70359. * @param index agent index returned by addAgent
  70360. * @param parameters agent parameters
  70361. */
  70362. updateAgentParameters(index: number, parameters: IAgentParameters): void;
  70363. /**
  70364. * Set the Bounding box extent for doing spatial queries (getClosestPoint, getRandomPointAround, ...)
  70365. * The queries will try to find a solution within those bounds
  70366. * default is (1,1,1)
  70367. * @param extent x,y,z value that define the extent around the queries point of reference
  70368. */
  70369. setDefaultQueryExtent(extent: Vector3): void;
  70370. /**
  70371. * Get the Bounding box extent specified by setDefaultQueryExtent
  70372. * @returns the box extent values
  70373. */
  70374. getDefaultQueryExtent(): Vector3;
  70375. /**
  70376. * Get the Bounding box extent result specified by setDefaultQueryExtent
  70377. * @param result output the box extent values
  70378. */
  70379. getDefaultQueryExtentToRef(result: Vector3): void;
  70380. /**
  70381. * Release all resources
  70382. */
  70383. dispose(): void;
  70384. }
  70385. /**
  70386. * Configures an agent
  70387. */
  70388. export interface IAgentParameters {
  70389. /**
  70390. * Agent radius. [Limit: >= 0]
  70391. */
  70392. radius: number;
  70393. /**
  70394. * Agent height. [Limit: > 0]
  70395. */
  70396. height: number;
  70397. /**
  70398. * Maximum allowed acceleration. [Limit: >= 0]
  70399. */
  70400. maxAcceleration: number;
  70401. /**
  70402. * Maximum allowed speed. [Limit: >= 0]
  70403. */
  70404. maxSpeed: number;
  70405. /**
  70406. * Defines how close a collision element must be before it is considered for steering behaviors. [Limits: > 0]
  70407. */
  70408. collisionQueryRange: number;
  70409. /**
  70410. * The path visibility optimization range. [Limit: > 0]
  70411. */
  70412. pathOptimizationRange: number;
  70413. /**
  70414. * How aggresive the agent manager should be at avoiding collisions with this agent. [Limit: >= 0]
  70415. */
  70416. separationWeight: number;
  70417. }
  70418. /**
  70419. * Configures the navigation mesh creation
  70420. */
  70421. export interface INavMeshParameters {
  70422. /**
  70423. * The xz-plane cell size to use for fields. [Limit: > 0] [Units: wu]
  70424. */
  70425. cs: number;
  70426. /**
  70427. * The y-axis cell size to use for fields. [Limit: > 0] [Units: wu]
  70428. */
  70429. ch: number;
  70430. /**
  70431. * The maximum slope that is considered walkable. [Limits: 0 <= value < 90] [Units: Degrees]
  70432. */
  70433. walkableSlopeAngle: number;
  70434. /**
  70435. * Minimum floor to 'ceiling' height that will still allow the floor area to
  70436. * be considered walkable. [Limit: >= 3] [Units: vx]
  70437. */
  70438. walkableHeight: number;
  70439. /**
  70440. * Maximum ledge height that is considered to still be traversable. [Limit: >=0] [Units: vx]
  70441. */
  70442. walkableClimb: number;
  70443. /**
  70444. * The distance to erode/shrink the walkable area of the heightfield away from
  70445. * obstructions. [Limit: >=0] [Units: vx]
  70446. */
  70447. walkableRadius: number;
  70448. /**
  70449. * The maximum allowed length for contour edges along the border of the mesh. [Limit: >=0] [Units: vx]
  70450. */
  70451. maxEdgeLen: number;
  70452. /**
  70453. * The maximum distance a simplfied contour's border edges should deviate
  70454. * the original raw contour. [Limit: >=0] [Units: vx]
  70455. */
  70456. maxSimplificationError: number;
  70457. /**
  70458. * The minimum number of cells allowed to form isolated island areas. [Limit: >=0] [Units: vx]
  70459. */
  70460. minRegionArea: number;
  70461. /**
  70462. * Any regions with a span count smaller than this value will, if possible,
  70463. * be merged with larger regions. [Limit: >=0] [Units: vx]
  70464. */
  70465. mergeRegionArea: number;
  70466. /**
  70467. * The maximum number of vertices allowed for polygons generated during the
  70468. * contour to polygon conversion process. [Limit: >= 3]
  70469. */
  70470. maxVertsPerPoly: number;
  70471. /**
  70472. * Sets the sampling distance to use when generating the detail mesh.
  70473. * (For height detail only.) [Limits: 0 or >= 0.9] [Units: wu]
  70474. */
  70475. detailSampleDist: number;
  70476. /**
  70477. * The maximum distance the detail mesh surface should deviate from heightfield
  70478. * data. (For height detail only.) [Limit: >=0] [Units: wu]
  70479. */
  70480. detailSampleMaxError: number;
  70481. }
  70482. }
  70483. declare module "babylonjs/Navigation/Plugins/recastJSPlugin" {
  70484. import { INavigationEnginePlugin, ICrowd, IAgentParameters, INavMeshParameters } from "babylonjs/Navigation/INavigationEngine";
  70485. import { Mesh } from "babylonjs/Meshes/mesh";
  70486. import { Scene } from "babylonjs/scene";
  70487. import { Vector3 } from "babylonjs/Maths/math";
  70488. import { TransformNode } from "babylonjs/Meshes/transformNode";
  70489. /**
  70490. * RecastJS navigation plugin
  70491. */
  70492. export class RecastJSPlugin implements INavigationEnginePlugin {
  70493. /**
  70494. * Reference to the Recast library
  70495. */
  70496. bjsRECAST: any;
  70497. /**
  70498. * plugin name
  70499. */
  70500. name: string;
  70501. /**
  70502. * the first navmesh created. We might extend this to support multiple navmeshes
  70503. */
  70504. navMesh: any;
  70505. /**
  70506. * Initializes the recastJS plugin
  70507. * @param recastInjection can be used to inject your own recast reference
  70508. */
  70509. constructor(recastInjection?: any);
  70510. /**
  70511. * Creates a navigation mesh
  70512. * @param meshes array of all the geometry used to compute the navigatio mesh
  70513. * @param parameters bunch of parameters used to filter geometry
  70514. */
  70515. createNavMesh(meshes: Array<Mesh>, parameters: INavMeshParameters): void;
  70516. /**
  70517. * Create a navigation mesh debug mesh
  70518. * @param scene is where the mesh will be added
  70519. * @returns debug display mesh
  70520. */
  70521. createDebugNavMesh(scene: Scene): Mesh;
  70522. /**
  70523. * Get a navigation mesh constrained position, closest to the parameter position
  70524. * @param position world position
  70525. * @returns the closest point to position constrained by the navigation mesh
  70526. */
  70527. getClosestPoint(position: Vector3): Vector3;
  70528. /**
  70529. * Get a navigation mesh constrained position, closest to the parameter position
  70530. * @param position world position
  70531. * @param result output the closest point to position constrained by the navigation mesh
  70532. */
  70533. getClosestPointToRef(position: Vector3, result: Vector3): void;
  70534. /**
  70535. * Get a navigation mesh constrained position, within a particular radius
  70536. * @param position world position
  70537. * @param maxRadius the maximum distance to the constrained world position
  70538. * @returns the closest point to position constrained by the navigation mesh
  70539. */
  70540. getRandomPointAround(position: Vector3, maxRadius: number): Vector3;
  70541. /**
  70542. * Get a navigation mesh constrained position, within a particular radius
  70543. * @param position world position
  70544. * @param maxRadius the maximum distance to the constrained world position
  70545. * @param result output the closest point to position constrained by the navigation mesh
  70546. */
  70547. getRandomPointAroundToRef(position: Vector3, maxRadius: number, result: Vector3): void;
  70548. /**
  70549. * Compute the final position from a segment made of destination-position
  70550. * @param position world position
  70551. * @param destination world position
  70552. * @returns the resulting point along the navmesh
  70553. */
  70554. moveAlong(position: Vector3, destination: Vector3): Vector3;
  70555. /**
  70556. * Compute the final position from a segment made of destination-position
  70557. * @param position world position
  70558. * @param destination world position
  70559. * @param result output the resulting point along the navmesh
  70560. */
  70561. moveAlongToRef(position: Vector3, destination: Vector3, result: Vector3): void;
  70562. /**
  70563. * Compute a navigation path from start to end. Returns an empty array if no path can be computed
  70564. * @param start world position
  70565. * @param end world position
  70566. * @returns array containing world position composing the path
  70567. */
  70568. computePath(start: Vector3, end: Vector3): Vector3[];
  70569. /**
  70570. * Create a new Crowd so you can add agents
  70571. * @param maxAgents the maximum agent count in the crowd
  70572. * @param maxAgentRadius the maximum radius an agent can have
  70573. * @param scene to attach the crowd to
  70574. * @returns the crowd you can add agents to
  70575. */
  70576. createCrowd(maxAgents: number, maxAgentRadius: number, scene: Scene): ICrowd;
  70577. /**
  70578. * Set the Bounding box extent for doing spatial queries (getClosestPoint, getRandomPointAround, ...)
  70579. * The queries will try to find a solution within those bounds
  70580. * default is (1,1,1)
  70581. * @param extent x,y,z value that define the extent around the queries point of reference
  70582. */
  70583. setDefaultQueryExtent(extent: Vector3): void;
  70584. /**
  70585. * Get the Bounding box extent specified by setDefaultQueryExtent
  70586. * @returns the box extent values
  70587. */
  70588. getDefaultQueryExtent(): Vector3;
  70589. /**
  70590. * build the navmesh from a previously saved state using getNavmeshData
  70591. * @param data the Uint8Array returned by getNavmeshData
  70592. */
  70593. buildFromNavmeshData(data: Uint8Array): void;
  70594. /**
  70595. * returns the navmesh data that can be used later. The navmesh must be built before retrieving the data
  70596. * @returns data the Uint8Array that can be saved and reused
  70597. */
  70598. getNavmeshData(): Uint8Array;
  70599. /**
  70600. * Get the Bounding box extent result specified by setDefaultQueryExtent
  70601. * @param result output the box extent values
  70602. */
  70603. getDefaultQueryExtentToRef(result: Vector3): void;
  70604. /**
  70605. * Disposes
  70606. */
  70607. dispose(): void;
  70608. /**
  70609. * If this plugin is supported
  70610. * @returns true if plugin is supported
  70611. */
  70612. isSupported(): boolean;
  70613. }
  70614. /**
  70615. * Recast detour crowd implementation
  70616. */
  70617. export class RecastJSCrowd implements ICrowd {
  70618. /**
  70619. * Recast/detour plugin
  70620. */
  70621. bjsRECASTPlugin: RecastJSPlugin;
  70622. /**
  70623. * Link to the detour crowd
  70624. */
  70625. recastCrowd: any;
  70626. /**
  70627. * One transform per agent
  70628. */
  70629. transforms: TransformNode[];
  70630. /**
  70631. * All agents created
  70632. */
  70633. agents: number[];
  70634. /**
  70635. * Link to the scene is kept to unregister the crowd from the scene
  70636. */
  70637. private _scene;
  70638. /**
  70639. * Observer for crowd updates
  70640. */
  70641. private _onBeforeAnimationsObserver;
  70642. /**
  70643. * Constructor
  70644. * @param plugin recastJS plugin
  70645. * @param maxAgents the maximum agent count in the crowd
  70646. * @param maxAgentRadius the maximum radius an agent can have
  70647. * @param scene to attach the crowd to
  70648. * @returns the crowd you can add agents to
  70649. */
  70650. constructor(plugin: RecastJSPlugin, maxAgents: number, maxAgentRadius: number, scene: Scene);
  70651. /**
  70652. * Add a new agent to the crowd with the specified parameter a corresponding transformNode.
  70653. * You can attach anything to that node. The node position is updated in the scene update tick.
  70654. * @param pos world position that will be constrained by the navigation mesh
  70655. * @param parameters agent parameters
  70656. * @param transform hooked to the agent that will be update by the scene
  70657. * @returns agent index
  70658. */
  70659. addAgent(pos: Vector3, parameters: IAgentParameters, transform: TransformNode): number;
  70660. /**
  70661. * Returns the agent position in world space
  70662. * @param index agent index returned by addAgent
  70663. * @returns world space position
  70664. */
  70665. getAgentPosition(index: number): Vector3;
  70666. /**
  70667. * Returns the agent position result in world space
  70668. * @param index agent index returned by addAgent
  70669. * @param result output world space position
  70670. */
  70671. getAgentPositionToRef(index: number, result: Vector3): void;
  70672. /**
  70673. * Returns the agent velocity in world space
  70674. * @param index agent index returned by addAgent
  70675. * @returns world space velocity
  70676. */
  70677. getAgentVelocity(index: number): Vector3;
  70678. /**
  70679. * Returns the agent velocity result in world space
  70680. * @param index agent index returned by addAgent
  70681. * @param result output world space velocity
  70682. */
  70683. getAgentVelocityToRef(index: number, result: Vector3): void;
  70684. /**
  70685. * Asks a particular agent to go to a destination. That destination is constrained by the navigation mesh
  70686. * @param index agent index returned by addAgent
  70687. * @param destination targeted world position
  70688. */
  70689. agentGoto(index: number, destination: Vector3): void;
  70690. /**
  70691. * Teleport the agent to a new position
  70692. * @param index agent index returned by addAgent
  70693. * @param destination targeted world position
  70694. */
  70695. agentTeleport(index: number, destination: Vector3): void;
  70696. /**
  70697. * Update agent parameters
  70698. * @param index agent index returned by addAgent
  70699. * @param parameters agent parameters
  70700. */
  70701. updateAgentParameters(index: number, parameters: IAgentParameters): void;
  70702. /**
  70703. * remove a particular agent previously created
  70704. * @param index agent index returned by addAgent
  70705. */
  70706. removeAgent(index: number): void;
  70707. /**
  70708. * get the list of all agents attached to this crowd
  70709. * @returns list of agent indices
  70710. */
  70711. getAgents(): number[];
  70712. /**
  70713. * Tick update done by the Scene. Agent position/velocity/acceleration is updated by this function
  70714. * @param deltaTime in seconds
  70715. */
  70716. update(deltaTime: number): void;
  70717. /**
  70718. * Set the Bounding box extent for doing spatial queries (getClosestPoint, getRandomPointAround, ...)
  70719. * The queries will try to find a solution within those bounds
  70720. * default is (1,1,1)
  70721. * @param extent x,y,z value that define the extent around the queries point of reference
  70722. */
  70723. setDefaultQueryExtent(extent: Vector3): void;
  70724. /**
  70725. * Get the Bounding box extent specified by setDefaultQueryExtent
  70726. * @returns the box extent values
  70727. */
  70728. getDefaultQueryExtent(): Vector3;
  70729. /**
  70730. * Get the Bounding box extent result specified by setDefaultQueryExtent
  70731. * @param result output the box extent values
  70732. */
  70733. getDefaultQueryExtentToRef(result: Vector3): void;
  70734. /**
  70735. * Release all resources
  70736. */
  70737. dispose(): void;
  70738. }
  70739. }
  70740. declare module "babylonjs/Navigation/Plugins/index" {
  70741. export * from "babylonjs/Navigation/Plugins/recastJSPlugin";
  70742. }
  70743. declare module "babylonjs/Navigation/index" {
  70744. export * from "babylonjs/Navigation/INavigationEngine";
  70745. export * from "babylonjs/Navigation/Plugins/index";
  70746. }
  70747. declare module "babylonjs/Offline/database" {
  70748. import { IOfflineProvider } from "babylonjs/Offline/IOfflineProvider";
  70749. /**
  70750. * Class used to enable access to IndexedDB
  70751. * @see https://doc.babylonjs.com/how_to/caching_resources_in_indexeddb
  70752. */
  70753. export class Database implements IOfflineProvider {
  70754. private _callbackManifestChecked;
  70755. private _currentSceneUrl;
  70756. private _db;
  70757. private _enableSceneOffline;
  70758. private _enableTexturesOffline;
  70759. private _manifestVersionFound;
  70760. private _mustUpdateRessources;
  70761. private _hasReachedQuota;
  70762. private _isSupported;
  70763. private _idbFactory;
  70764. /** Gets a boolean indicating if the user agent supports blob storage (this value will be updated after creating the first Database object) */
  70765. private static IsUASupportingBlobStorage;
  70766. /**
  70767. * Gets a boolean indicating if Database storate is enabled (off by default)
  70768. */
  70769. static IDBStorageEnabled: boolean;
  70770. /**
  70771. * Gets a boolean indicating if scene must be saved in the database
  70772. */
  70773. get enableSceneOffline(): boolean;
  70774. /**
  70775. * Gets a boolean indicating if textures must be saved in the database
  70776. */
  70777. get enableTexturesOffline(): boolean;
  70778. /**
  70779. * Creates a new Database
  70780. * @param urlToScene defines the url to load the scene
  70781. * @param callbackManifestChecked defines the callback to use when manifest is checked
  70782. * @param disableManifestCheck defines a boolean indicating that we want to skip the manifest validation (it will be considered validated and up to date)
  70783. */
  70784. constructor(urlToScene: string, callbackManifestChecked: (checked: boolean) => any, disableManifestCheck?: boolean);
  70785. private static _ParseURL;
  70786. private static _ReturnFullUrlLocation;
  70787. private _checkManifestFile;
  70788. /**
  70789. * Open the database and make it available
  70790. * @param successCallback defines the callback to call on success
  70791. * @param errorCallback defines the callback to call on error
  70792. */
  70793. open(successCallback: () => void, errorCallback: () => void): void;
  70794. /**
  70795. * Loads an image from the database
  70796. * @param url defines the url to load from
  70797. * @param image defines the target DOM image
  70798. */
  70799. loadImage(url: string, image: HTMLImageElement): void;
  70800. private _loadImageFromDBAsync;
  70801. private _saveImageIntoDBAsync;
  70802. private _checkVersionFromDB;
  70803. private _loadVersionFromDBAsync;
  70804. private _saveVersionIntoDBAsync;
  70805. /**
  70806. * Loads a file from database
  70807. * @param url defines the URL to load from
  70808. * @param sceneLoaded defines a callback to call on success
  70809. * @param progressCallBack defines a callback to call when progress changed
  70810. * @param errorCallback defines a callback to call on error
  70811. * @param useArrayBuffer defines a boolean to use array buffer instead of text string
  70812. */
  70813. loadFile(url: string, sceneLoaded: (data: any) => void, progressCallBack?: (data: any) => void, errorCallback?: () => void, useArrayBuffer?: boolean): void;
  70814. private _loadFileAsync;
  70815. private _saveFileAsync;
  70816. /**
  70817. * Validates if xhr data is correct
  70818. * @param xhr defines the request to validate
  70819. * @param dataType defines the expected data type
  70820. * @returns true if data is correct
  70821. */
  70822. private static _ValidateXHRData;
  70823. }
  70824. }
  70825. declare module "babylonjs/Offline/index" {
  70826. export * from "babylonjs/Offline/database";
  70827. export * from "babylonjs/Offline/IOfflineProvider";
  70828. }
  70829. declare module "babylonjs/Shaders/gpuUpdateParticles.fragment" {
  70830. /** @hidden */
  70831. export var gpuUpdateParticlesPixelShader: {
  70832. name: string;
  70833. shader: string;
  70834. };
  70835. }
  70836. declare module "babylonjs/Shaders/gpuUpdateParticles.vertex" {
  70837. /** @hidden */
  70838. export var gpuUpdateParticlesVertexShader: {
  70839. name: string;
  70840. shader: string;
  70841. };
  70842. }
  70843. declare module "babylonjs/Shaders/ShadersInclude/clipPlaneFragmentDeclaration2" {
  70844. /** @hidden */
  70845. export var clipPlaneFragmentDeclaration2: {
  70846. name: string;
  70847. shader: string;
  70848. };
  70849. }
  70850. declare module "babylonjs/Shaders/gpuRenderParticles.fragment" {
  70851. import "babylonjs/Shaders/ShadersInclude/clipPlaneFragmentDeclaration2";
  70852. import "babylonjs/Shaders/ShadersInclude/imageProcessingDeclaration";
  70853. import "babylonjs/Shaders/ShadersInclude/helperFunctions";
  70854. import "babylonjs/Shaders/ShadersInclude/imageProcessingFunctions";
  70855. import "babylonjs/Shaders/ShadersInclude/clipPlaneFragment";
  70856. /** @hidden */
  70857. export var gpuRenderParticlesPixelShader: {
  70858. name: string;
  70859. shader: string;
  70860. };
  70861. }
  70862. declare module "babylonjs/Shaders/ShadersInclude/clipPlaneVertexDeclaration2" {
  70863. /** @hidden */
  70864. export var clipPlaneVertexDeclaration2: {
  70865. name: string;
  70866. shader: string;
  70867. };
  70868. }
  70869. declare module "babylonjs/Shaders/gpuRenderParticles.vertex" {
  70870. import "babylonjs/Shaders/ShadersInclude/clipPlaneVertexDeclaration2";
  70871. import "babylonjs/Shaders/ShadersInclude/clipPlaneVertex";
  70872. /** @hidden */
  70873. export var gpuRenderParticlesVertexShader: {
  70874. name: string;
  70875. shader: string;
  70876. };
  70877. }
  70878. declare module "babylonjs/Particles/gpuParticleSystem" {
  70879. import { Nullable } from "babylonjs/types";
  70880. import { Color3Gradient, IValueGradient } from "babylonjs/Misc/gradients";
  70881. import { Observable } from "babylonjs/Misc/observable";
  70882. import { Matrix } from "babylonjs/Maths/math.vector";
  70883. import { Color4, Color3 } from "babylonjs/Maths/math.color";
  70884. import { IParticleSystem } from "babylonjs/Particles/IParticleSystem";
  70885. import { BaseParticleSystem } from "babylonjs/Particles/baseParticleSystem";
  70886. import { IDisposable } from "babylonjs/scene";
  70887. import { Effect } from "babylonjs/Materials/effect";
  70888. import { RawTexture } from "babylonjs/Materials/Textures/rawTexture";
  70889. import { IAnimatable } from "babylonjs/Animations/animatable.interface";
  70890. import { ThinEngine } from "babylonjs/Engines/thinEngine";
  70891. import { Scene } from "babylonjs/scene";
  70892. import "babylonjs/Shaders/gpuUpdateParticles.fragment";
  70893. import "babylonjs/Shaders/gpuUpdateParticles.vertex";
  70894. import "babylonjs/Shaders/gpuRenderParticles.fragment";
  70895. import "babylonjs/Shaders/gpuRenderParticles.vertex";
  70896. /**
  70897. * This represents a GPU particle system in Babylon
  70898. * This is the fastest particle system in Babylon as it uses the GPU to update the individual particle data
  70899. * @see https://www.babylonjs-playground.com/#PU4WYI#4
  70900. */
  70901. export class GPUParticleSystem extends BaseParticleSystem implements IDisposable, IParticleSystem, IAnimatable {
  70902. /**
  70903. * The layer mask we are rendering the particles through.
  70904. */
  70905. layerMask: number;
  70906. private _capacity;
  70907. private _activeCount;
  70908. private _currentActiveCount;
  70909. private _accumulatedCount;
  70910. private _renderEffect;
  70911. private _updateEffect;
  70912. private _buffer0;
  70913. private _buffer1;
  70914. private _spriteBuffer;
  70915. private _updateVAO;
  70916. private _renderVAO;
  70917. private _targetIndex;
  70918. private _sourceBuffer;
  70919. private _targetBuffer;
  70920. private _currentRenderId;
  70921. private _started;
  70922. private _stopped;
  70923. private _timeDelta;
  70924. private _randomTexture;
  70925. private _randomTexture2;
  70926. private _attributesStrideSize;
  70927. private _updateEffectOptions;
  70928. private _randomTextureSize;
  70929. private _actualFrame;
  70930. private _customEffect;
  70931. private readonly _rawTextureWidth;
  70932. /**
  70933. * Gets a boolean indicating if the GPU particles can be rendered on current browser
  70934. */
  70935. static get IsSupported(): boolean;
  70936. /**
  70937. * An event triggered when the system is disposed.
  70938. */
  70939. onDisposeObservable: Observable<IParticleSystem>;
  70940. /**
  70941. * Gets the maximum number of particles active at the same time.
  70942. * @returns The max number of active particles.
  70943. */
  70944. getCapacity(): number;
  70945. /**
  70946. * Forces the particle to write their depth information to the depth buffer. This can help preventing other draw calls
  70947. * to override the particles.
  70948. */
  70949. forceDepthWrite: boolean;
  70950. /**
  70951. * Gets or set the number of active particles
  70952. */
  70953. get activeParticleCount(): number;
  70954. set activeParticleCount(value: number);
  70955. private _preWarmDone;
  70956. /**
  70957. * Specifies if the particles are updated in emitter local space or world space.
  70958. */
  70959. isLocal: boolean;
  70960. /** Gets or sets a matrix to use to compute projection */
  70961. defaultProjectionMatrix: Matrix;
  70962. /**
  70963. * Is this system ready to be used/rendered
  70964. * @return true if the system is ready
  70965. */
  70966. isReady(): boolean;
  70967. /**
  70968. * Gets if the system has been started. (Note: this will still be true after stop is called)
  70969. * @returns True if it has been started, otherwise false.
  70970. */
  70971. isStarted(): boolean;
  70972. /**
  70973. * Gets if the system has been stopped. (Note: rendering is still happening but the system is frozen)
  70974. * @returns True if it has been stopped, otherwise false.
  70975. */
  70976. isStopped(): boolean;
  70977. /**
  70978. * Gets a boolean indicating that the system is stopping
  70979. * @returns true if the system is currently stopping
  70980. */
  70981. isStopping(): boolean;
  70982. /**
  70983. * Gets the number of particles active at the same time.
  70984. * @returns The number of active particles.
  70985. */
  70986. getActiveCount(): number;
  70987. /**
  70988. * Starts the particle system and begins to emit
  70989. * @param delay defines the delay in milliseconds before starting the system (this.startDelay by default)
  70990. */
  70991. start(delay?: number): void;
  70992. /**
  70993. * Stops the particle system.
  70994. */
  70995. stop(): void;
  70996. /**
  70997. * Remove all active particles
  70998. */
  70999. reset(): void;
  71000. /**
  71001. * Returns the string "GPUParticleSystem"
  71002. * @returns a string containing the class name
  71003. */
  71004. getClassName(): string;
  71005. /**
  71006. * Gets the custom effect used to render the particles
  71007. * @param blendMode Blend mode for which the effect should be retrieved
  71008. * @returns The effect
  71009. */
  71010. getCustomEffect(blendMode?: number): Nullable<Effect>;
  71011. /**
  71012. * Sets the custom effect used to render the particles
  71013. * @param effect The effect to set
  71014. * @param blendMode Blend mode for which the effect should be set
  71015. */
  71016. setCustomEffect(effect: Nullable<Effect>, blendMode?: number): void;
  71017. /** @hidden */
  71018. protected _onBeforeDrawParticlesObservable: Nullable<Observable<Nullable<Effect>>>;
  71019. /**
  71020. * Observable that will be called just before the particles are drawn
  71021. */
  71022. get onBeforeDrawParticlesObservable(): Observable<Nullable<Effect>>;
  71023. /**
  71024. * Gets the name of the particle vertex shader
  71025. */
  71026. get vertexShaderName(): string;
  71027. private _colorGradientsTexture;
  71028. protected _removeGradientAndTexture(gradient: number, gradients: Nullable<IValueGradient[]>, texture: RawTexture): BaseParticleSystem;
  71029. /**
  71030. * Adds a new color gradient
  71031. * @param gradient defines the gradient to use (between 0 and 1)
  71032. * @param color1 defines the color to affect to the specified gradient
  71033. * @param color2 defines an additional color used to define a range ([color, color2]) with main color to pick the final color from
  71034. * @returns the current particle system
  71035. */
  71036. addColorGradient(gradient: number, color1: Color4, color2?: Color4): GPUParticleSystem;
  71037. private _refreshColorGradient;
  71038. /** Force the system to rebuild all gradients that need to be resync */
  71039. forceRefreshGradients(): void;
  71040. /**
  71041. * Remove a specific color gradient
  71042. * @param gradient defines the gradient to remove
  71043. * @returns the current particle system
  71044. */
  71045. removeColorGradient(gradient: number): GPUParticleSystem;
  71046. private _angularSpeedGradientsTexture;
  71047. private _sizeGradientsTexture;
  71048. private _velocityGradientsTexture;
  71049. private _limitVelocityGradientsTexture;
  71050. private _dragGradientsTexture;
  71051. private _addFactorGradient;
  71052. /**
  71053. * Adds a new size gradient
  71054. * @param gradient defines the gradient to use (between 0 and 1)
  71055. * @param factor defines the size factor to affect to the specified gradient
  71056. * @returns the current particle system
  71057. */
  71058. addSizeGradient(gradient: number, factor: number): GPUParticleSystem;
  71059. /**
  71060. * Remove a specific size gradient
  71061. * @param gradient defines the gradient to remove
  71062. * @returns the current particle system
  71063. */
  71064. removeSizeGradient(gradient: number): GPUParticleSystem;
  71065. private _refreshFactorGradient;
  71066. /**
  71067. * Adds a new angular speed gradient
  71068. * @param gradient defines the gradient to use (between 0 and 1)
  71069. * @param factor defines the angular speed to affect to the specified gradient
  71070. * @returns the current particle system
  71071. */
  71072. addAngularSpeedGradient(gradient: number, factor: number): GPUParticleSystem;
  71073. /**
  71074. * Remove a specific angular speed gradient
  71075. * @param gradient defines the gradient to remove
  71076. * @returns the current particle system
  71077. */
  71078. removeAngularSpeedGradient(gradient: number): GPUParticleSystem;
  71079. /**
  71080. * Adds a new velocity gradient
  71081. * @param gradient defines the gradient to use (between 0 and 1)
  71082. * @param factor defines the velocity to affect to the specified gradient
  71083. * @returns the current particle system
  71084. */
  71085. addVelocityGradient(gradient: number, factor: number): GPUParticleSystem;
  71086. /**
  71087. * Remove a specific velocity gradient
  71088. * @param gradient defines the gradient to remove
  71089. * @returns the current particle system
  71090. */
  71091. removeVelocityGradient(gradient: number): GPUParticleSystem;
  71092. /**
  71093. * Adds a new limit velocity gradient
  71094. * @param gradient defines the gradient to use (between 0 and 1)
  71095. * @param factor defines the limit velocity value to affect to the specified gradient
  71096. * @returns the current particle system
  71097. */
  71098. addLimitVelocityGradient(gradient: number, factor: number): GPUParticleSystem;
  71099. /**
  71100. * Remove a specific limit velocity gradient
  71101. * @param gradient defines the gradient to remove
  71102. * @returns the current particle system
  71103. */
  71104. removeLimitVelocityGradient(gradient: number): GPUParticleSystem;
  71105. /**
  71106. * Adds a new drag gradient
  71107. * @param gradient defines the gradient to use (between 0 and 1)
  71108. * @param factor defines the drag value to affect to the specified gradient
  71109. * @returns the current particle system
  71110. */
  71111. addDragGradient(gradient: number, factor: number): GPUParticleSystem;
  71112. /**
  71113. * Remove a specific drag gradient
  71114. * @param gradient defines the gradient to remove
  71115. * @returns the current particle system
  71116. */
  71117. removeDragGradient(gradient: number): GPUParticleSystem;
  71118. /**
  71119. * Not supported by GPUParticleSystem
  71120. * @param gradient defines the gradient to use (between 0 and 1)
  71121. * @param factor defines the emit rate value to affect to the specified gradient
  71122. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  71123. * @returns the current particle system
  71124. */
  71125. addEmitRateGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  71126. /**
  71127. * Not supported by GPUParticleSystem
  71128. * @param gradient defines the gradient to remove
  71129. * @returns the current particle system
  71130. */
  71131. removeEmitRateGradient(gradient: number): IParticleSystem;
  71132. /**
  71133. * Not supported by GPUParticleSystem
  71134. * @param gradient defines the gradient to use (between 0 and 1)
  71135. * @param factor defines the start size value to affect to the specified gradient
  71136. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  71137. * @returns the current particle system
  71138. */
  71139. addStartSizeGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  71140. /**
  71141. * Not supported by GPUParticleSystem
  71142. * @param gradient defines the gradient to remove
  71143. * @returns the current particle system
  71144. */
  71145. removeStartSizeGradient(gradient: number): IParticleSystem;
  71146. /**
  71147. * Not supported by GPUParticleSystem
  71148. * @param gradient defines the gradient to use (between 0 and 1)
  71149. * @param min defines the color remap minimal range
  71150. * @param max defines the color remap maximal range
  71151. * @returns the current particle system
  71152. */
  71153. addColorRemapGradient(gradient: number, min: number, max: number): IParticleSystem;
  71154. /**
  71155. * Not supported by GPUParticleSystem
  71156. * @param gradient defines the gradient to remove
  71157. * @returns the current particle system
  71158. */
  71159. removeColorRemapGradient(): IParticleSystem;
  71160. /**
  71161. * Not supported by GPUParticleSystem
  71162. * @param gradient defines the gradient to use (between 0 and 1)
  71163. * @param min defines the alpha remap minimal range
  71164. * @param max defines the alpha remap maximal range
  71165. * @returns the current particle system
  71166. */
  71167. addAlphaRemapGradient(gradient: number, min: number, max: number): IParticleSystem;
  71168. /**
  71169. * Not supported by GPUParticleSystem
  71170. * @param gradient defines the gradient to remove
  71171. * @returns the current particle system
  71172. */
  71173. removeAlphaRemapGradient(): IParticleSystem;
  71174. /**
  71175. * Not supported by GPUParticleSystem
  71176. * @param gradient defines the gradient to use (between 0 and 1)
  71177. * @param color defines the color to affect to the specified gradient
  71178. * @returns the current particle system
  71179. */
  71180. addRampGradient(gradient: number, color: Color3): IParticleSystem;
  71181. /**
  71182. * Not supported by GPUParticleSystem
  71183. * @param gradient defines the gradient to remove
  71184. * @returns the current particle system
  71185. */
  71186. removeRampGradient(): IParticleSystem;
  71187. /**
  71188. * Not supported by GPUParticleSystem
  71189. * @returns the list of ramp gradients
  71190. */
  71191. getRampGradients(): Nullable<Array<Color3Gradient>>;
  71192. /**
  71193. * Not supported by GPUParticleSystem
  71194. * Gets or sets a boolean indicating that ramp gradients must be used
  71195. * @see https://doc.babylonjs.com/babylon101/particles#ramp-gradients
  71196. */
  71197. get useRampGradients(): boolean;
  71198. set useRampGradients(value: boolean);
  71199. /**
  71200. * Not supported by GPUParticleSystem
  71201. * @param gradient defines the gradient to use (between 0 and 1)
  71202. * @param factor defines the life time factor to affect to the specified gradient
  71203. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  71204. * @returns the current particle system
  71205. */
  71206. addLifeTimeGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  71207. /**
  71208. * Not supported by GPUParticleSystem
  71209. * @param gradient defines the gradient to remove
  71210. * @returns the current particle system
  71211. */
  71212. removeLifeTimeGradient(gradient: number): IParticleSystem;
  71213. /**
  71214. * Instantiates a GPU particle system.
  71215. * 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.
  71216. * @param name The name of the particle system
  71217. * @param options The options used to create the system
  71218. * @param sceneOrEngine The scene the particle system belongs to or the engine to use if no scene
  71219. * @param isAnimationSheetEnabled Must be true if using a spritesheet to animate the particles texture
  71220. * @param customEffect a custom effect used to change the way particles are rendered by default
  71221. */
  71222. constructor(name: string, options: Partial<{
  71223. capacity: number;
  71224. randomTextureSize: number;
  71225. }>, sceneOrEngine: Scene | ThinEngine, isAnimationSheetEnabled?: boolean, customEffect?: Nullable<Effect>);
  71226. protected _reset(): void;
  71227. private _createUpdateVAO;
  71228. private _createRenderVAO;
  71229. private _initialize;
  71230. /** @hidden */
  71231. _recreateUpdateEffect(): void;
  71232. private _getEffect;
  71233. /**
  71234. * Fill the defines array according to the current settings of the particle system
  71235. * @param defines Array to be updated
  71236. * @param blendMode blend mode to take into account when updating the array
  71237. */
  71238. fillDefines(defines: Array<string>, blendMode?: number): void;
  71239. /**
  71240. * Fill the uniforms, attributes and samplers arrays according to the current settings of the particle system
  71241. * @param uniforms Uniforms array to fill
  71242. * @param attributes Attributes array to fill
  71243. * @param samplers Samplers array to fill
  71244. */
  71245. fillUniformsAttributesAndSamplerNames(uniforms: Array<string>, attributes: Array<string>, samplers: Array<string>): void;
  71246. /** @hidden */
  71247. _recreateRenderEffect(): Effect;
  71248. /**
  71249. * Animates the particle system for the current frame by emitting new particles and or animating the living ones.
  71250. * @param preWarm defines if we are in the pre-warmimg phase
  71251. */
  71252. animate(preWarm?: boolean): void;
  71253. private _createFactorGradientTexture;
  71254. private _createSizeGradientTexture;
  71255. private _createAngularSpeedGradientTexture;
  71256. private _createVelocityGradientTexture;
  71257. private _createLimitVelocityGradientTexture;
  71258. private _createDragGradientTexture;
  71259. private _createColorGradientTexture;
  71260. /**
  71261. * Renders the particle system in its current state
  71262. * @param preWarm defines if the system should only update the particles but not render them
  71263. * @returns the current number of particles
  71264. */
  71265. render(preWarm?: boolean): number;
  71266. /**
  71267. * Rebuilds the particle system
  71268. */
  71269. rebuild(): void;
  71270. private _releaseBuffers;
  71271. private _releaseVAOs;
  71272. /**
  71273. * Disposes the particle system and free the associated resources
  71274. * @param disposeTexture defines if the particule texture must be disposed as well (true by default)
  71275. */
  71276. dispose(disposeTexture?: boolean): void;
  71277. /**
  71278. * Clones the particle system.
  71279. * @param name The name of the cloned object
  71280. * @param newEmitter The new emitter to use
  71281. * @returns the cloned particle system
  71282. */
  71283. clone(name: string, newEmitter: any): GPUParticleSystem;
  71284. /**
  71285. * Serializes the particle system to a JSON object
  71286. * @param serializeTexture defines if the texture must be serialized as well
  71287. * @returns the JSON object
  71288. */
  71289. serialize(serializeTexture?: boolean): any;
  71290. /**
  71291. * Parses a JSON object to create a GPU particle system.
  71292. * @param parsedParticleSystem The JSON object to parse
  71293. * @param sceneOrEngine The scene or the engine to create the particle system in
  71294. * @param rootUrl The root url to use to load external dependencies like texture
  71295. * @param doNotStart Ignore the preventAutoStart attribute and does not start
  71296. * @returns the parsed GPU particle system
  71297. */
  71298. static Parse(parsedParticleSystem: any, sceneOrEngine: Scene | ThinEngine, rootUrl: string, doNotStart?: boolean): GPUParticleSystem;
  71299. }
  71300. }
  71301. declare module "babylonjs/Particles/particleSystemSet" {
  71302. import { Nullable } from "babylonjs/types";
  71303. import { Color3 } from "babylonjs/Maths/math.color";
  71304. import { TransformNode } from "babylonjs/Meshes/transformNode";
  71305. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  71306. import { IParticleSystem } from "babylonjs/Particles/IParticleSystem";
  71307. import { Scene, IDisposable } from "babylonjs/scene";
  71308. /**
  71309. * Represents a set of particle systems working together to create a specific effect
  71310. */
  71311. export class ParticleSystemSet implements IDisposable {
  71312. /**
  71313. * Gets or sets base Assets URL
  71314. */
  71315. static BaseAssetsUrl: string;
  71316. private _emitterCreationOptions;
  71317. private _emitterNode;
  71318. /**
  71319. * Gets the particle system list
  71320. */
  71321. systems: IParticleSystem[];
  71322. /**
  71323. * Gets the emitter node used with this set
  71324. */
  71325. get emitterNode(): Nullable<TransformNode>;
  71326. /**
  71327. * Creates a new emitter mesh as a sphere
  71328. * @param options defines the options used to create the sphere
  71329. * @param renderingGroupId defines the renderingGroupId to use for the sphere
  71330. * @param scene defines the hosting scene
  71331. */
  71332. setEmitterAsSphere(options: {
  71333. diameter: number;
  71334. segments: number;
  71335. color: Color3;
  71336. }, renderingGroupId: number, scene: Scene): void;
  71337. /**
  71338. * Starts all particle systems of the set
  71339. * @param emitter defines an optional mesh to use as emitter for the particle systems
  71340. */
  71341. start(emitter?: AbstractMesh): void;
  71342. /**
  71343. * Release all associated resources
  71344. */
  71345. dispose(): void;
  71346. /**
  71347. * Serialize the set into a JSON compatible object
  71348. * @param serializeTexture defines if the texture must be serialized as well
  71349. * @returns a JSON compatible representation of the set
  71350. */
  71351. serialize(serializeTexture?: boolean): any;
  71352. /**
  71353. * Parse a new ParticleSystemSet from a serialized source
  71354. * @param data defines a JSON compatible representation of the set
  71355. * @param scene defines the hosting scene
  71356. * @param gpu defines if we want GPU particles or CPU particles
  71357. * @returns a new ParticleSystemSet
  71358. */
  71359. static Parse(data: any, scene: Scene, gpu?: boolean): ParticleSystemSet;
  71360. }
  71361. }
  71362. declare module "babylonjs/Particles/particleHelper" {
  71363. import { Nullable } from "babylonjs/types";
  71364. import { Scene } from "babylonjs/scene";
  71365. import { Vector3 } from "babylonjs/Maths/math.vector";
  71366. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  71367. import { IParticleSystem } from "babylonjs/Particles/IParticleSystem";
  71368. import { ParticleSystemSet } from "babylonjs/Particles/particleSystemSet";
  71369. /**
  71370. * This class is made for on one-liner static method to help creating particle system set.
  71371. */
  71372. export class ParticleHelper {
  71373. /**
  71374. * Gets or sets base Assets URL
  71375. */
  71376. static BaseAssetsUrl: string;
  71377. /** Define the Url to load snippets */
  71378. static SnippetUrl: string;
  71379. /**
  71380. * Create a default particle system that you can tweak
  71381. * @param emitter defines the emitter to use
  71382. * @param capacity defines the system capacity (default is 500 particles)
  71383. * @param scene defines the hosting scene
  71384. * @param useGPU defines if a GPUParticleSystem must be created (default is false)
  71385. * @returns the new Particle system
  71386. */
  71387. static CreateDefault(emitter: Nullable<AbstractMesh | Vector3>, capacity?: number, scene?: Scene, useGPU?: boolean): IParticleSystem;
  71388. /**
  71389. * This is the main static method (one-liner) of this helper to create different particle systems
  71390. * @param type This string represents the type to the particle system to create
  71391. * @param scene The scene where the particle system should live
  71392. * @param gpu If the system will use gpu
  71393. * @returns the ParticleSystemSet created
  71394. */
  71395. static CreateAsync(type: string, scene: Nullable<Scene>, gpu?: boolean): Promise<ParticleSystemSet>;
  71396. /**
  71397. * Static function used to export a particle system to a ParticleSystemSet variable.
  71398. * Please note that the emitter shape is not exported
  71399. * @param systems defines the particle systems to export
  71400. * @returns the created particle system set
  71401. */
  71402. static ExportSet(systems: IParticleSystem[]): ParticleSystemSet;
  71403. /**
  71404. * Creates a particle system from a snippet saved in a remote file
  71405. * @param name defines the name of the particle system to create (can be null or empty to use the one from the json data)
  71406. * @param url defines the url to load from
  71407. * @param scene defines the hosting scene
  71408. * @param gpu If the system will use gpu
  71409. * @param rootUrl defines the root URL to use to load textures and relative dependencies
  71410. * @returns a promise that will resolve to the new particle system
  71411. */
  71412. static ParseFromFileAsync(name: Nullable<string>, url: string, scene: Scene, gpu?: boolean, rootUrl?: string): Promise<IParticleSystem>;
  71413. /**
  71414. * Creates a particle system from a snippet saved by the particle system editor
  71415. * @param snippetId defines the snippet to load (can be set to _BLANK to create a default one)
  71416. * @param scene defines the hosting scene
  71417. * @param gpu If the system will use gpu
  71418. * @param rootUrl defines the root URL to use to load textures and relative dependencies
  71419. * @returns a promise that will resolve to the new particle system
  71420. */
  71421. static CreateFromSnippetAsync(snippetId: string, scene: Scene, gpu?: boolean, rootUrl?: string): Promise<IParticleSystem>;
  71422. }
  71423. }
  71424. declare module "babylonjs/Particles/particleSystemComponent" {
  71425. import { IParticleSystem } from "babylonjs/Particles/IParticleSystem";
  71426. import { Effect } from "babylonjs/Materials/effect";
  71427. import "babylonjs/Shaders/particles.vertex";
  71428. import { EffectFallbacks } from "babylonjs/Materials/effectFallbacks";
  71429. module "babylonjs/Engines/engine" {
  71430. interface Engine {
  71431. /**
  71432. * Create an effect to use with particle systems.
  71433. * Please note that some parameters like animation sheets or not being billboard are not supported in this configuration, except if you pass
  71434. * the particle system for which you want to create a custom effect in the last parameter
  71435. * @param fragmentName defines the base name of the effect (The name of file without .fragment.fx)
  71436. * @param uniformsNames defines a list of attribute names
  71437. * @param samplers defines an array of string used to represent textures
  71438. * @param defines defines the string containing the defines to use to compile the shaders
  71439. * @param fallbacks defines the list of potential fallbacks to use if shader conmpilation fails
  71440. * @param onCompiled defines a function to call when the effect creation is successful
  71441. * @param onError defines a function to call when the effect creation has failed
  71442. * @param particleSystem the particle system you want to create the effect for
  71443. * @returns the new Effect
  71444. */
  71445. createEffectForParticles(fragmentName: string, uniformsNames: string[], samplers: string[], defines: string, fallbacks?: EffectFallbacks, onCompiled?: (effect: Effect) => void, onError?: (effect: Effect, errors: string) => void, particleSystem?: IParticleSystem): Effect;
  71446. }
  71447. }
  71448. module "babylonjs/Meshes/mesh" {
  71449. interface Mesh {
  71450. /**
  71451. * Returns an array populated with IParticleSystem objects whose the mesh is the emitter
  71452. * @returns an array of IParticleSystem
  71453. */
  71454. getEmittedParticleSystems(): IParticleSystem[];
  71455. /**
  71456. * Returns an array populated with IParticleSystem objects whose the mesh or its children are the emitter
  71457. * @returns an array of IParticleSystem
  71458. */
  71459. getHierarchyEmittedParticleSystems(): IParticleSystem[];
  71460. }
  71461. }
  71462. }
  71463. declare module "babylonjs/Particles/pointsCloudSystem" {
  71464. import { Color4 } from "babylonjs/Maths/math";
  71465. import { Mesh } from "babylonjs/Meshes/mesh";
  71466. import { Scene, IDisposable } from "babylonjs/scene";
  71467. import { CloudPoint } from "babylonjs/Particles/cloudPoint";
  71468. /** Defines the 4 color options */
  71469. export enum PointColor {
  71470. /** color value */
  71471. Color = 2,
  71472. /** uv value */
  71473. UV = 1,
  71474. /** random value */
  71475. Random = 0,
  71476. /** stated value */
  71477. Stated = 3
  71478. }
  71479. /**
  71480. * The PointCloudSystem (PCS) is a single updatable mesh. The points corresponding to the vertices of this big mesh.
  71481. * 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.
  71482. * The PointCloudSytem is also a particle system, with each point being a particle. It provides some methods to manage the particles.
  71483. * However it is behavior agnostic. This means it has no emitter, no particle physics, no particle recycler. You have to implement your own behavior.
  71484. *
  71485. * Full documentation here : TO BE ENTERED
  71486. */
  71487. export class PointsCloudSystem implements IDisposable {
  71488. /**
  71489. * The PCS array of cloud point objects. Just access each particle as with any classic array.
  71490. * Example : var p = SPS.particles[i];
  71491. */
  71492. particles: CloudPoint[];
  71493. /**
  71494. * The PCS total number of particles. Read only. Use PCS.counter instead if you need to set your own value.
  71495. */
  71496. nbParticles: number;
  71497. /**
  71498. * This a counter for your own usage. It's not set by any SPS functions.
  71499. */
  71500. counter: number;
  71501. /**
  71502. * The PCS name. This name is also given to the underlying mesh.
  71503. */
  71504. name: string;
  71505. /**
  71506. * The PCS mesh. It's a standard BJS Mesh, so all the methods from the Mesh class are avalaible.
  71507. */
  71508. mesh: Mesh;
  71509. /**
  71510. * This empty object is intended to store some PCS specific or temporary values in order to lower the Garbage Collector activity.
  71511. * Please read :
  71512. */
  71513. vars: any;
  71514. /**
  71515. * @hidden
  71516. */
  71517. _size: number;
  71518. private _scene;
  71519. private _promises;
  71520. private _positions;
  71521. private _indices;
  71522. private _normals;
  71523. private _colors;
  71524. private _uvs;
  71525. private _indices32;
  71526. private _positions32;
  71527. private _colors32;
  71528. private _uvs32;
  71529. private _updatable;
  71530. private _isVisibilityBoxLocked;
  71531. private _alwaysVisible;
  71532. private _groups;
  71533. private _groupCounter;
  71534. private _computeParticleColor;
  71535. private _computeParticleTexture;
  71536. private _computeParticleRotation;
  71537. private _computeBoundingBox;
  71538. private _isReady;
  71539. /**
  71540. * Creates a PCS (Points Cloud System) object
  71541. * @param name (String) is the PCS name, this will be the underlying mesh name
  71542. * @param pointSize (number) is the size for each point
  71543. * @param scene (Scene) is the scene in which the PCS is added
  71544. * @param options defines the options of the PCS e.g.
  71545. * * updatable (optional boolean, default true) : if the PCS must be updatable or immutable
  71546. */
  71547. constructor(name: string, pointSize: number, scene: Scene, options?: {
  71548. updatable?: boolean;
  71549. });
  71550. /**
  71551. * Builds the PCS underlying mesh. Returns a standard Mesh.
  71552. * If no points were added to the PCS, the returned mesh is just a single point.
  71553. * @returns a promise for the created mesh
  71554. */
  71555. buildMeshAsync(): Promise<Mesh>;
  71556. /**
  71557. * @hidden
  71558. */
  71559. private _buildMesh;
  71560. private _addParticle;
  71561. private _randomUnitVector;
  71562. private _getColorIndicesForCoord;
  71563. private _setPointsColorOrUV;
  71564. private _colorFromTexture;
  71565. private _calculateDensity;
  71566. /**
  71567. * Adds points to the PCS in random positions within a unit sphere
  71568. * @param nb (positive integer) the number of particles to be created from this model
  71569. * @param pointFunction is an optional javascript function to be called for each particle on PCS creation
  71570. * @returns the number of groups in the system
  71571. */
  71572. addPoints(nb: number, pointFunction?: any): number;
  71573. /**
  71574. * Adds points to the PCS from the surface of the model shape
  71575. * @param mesh is any Mesh object that will be used as a surface model for the points
  71576. * @param nb (positive integer) the number of particles to be created from this model
  71577. * @param colorWith determines whether a point is colored using color (default), uv, random, stated or none (invisible)
  71578. * @param color (color4) to be used when colorWith is stated or color (number) when used to specify texture position
  71579. * @param range (number from 0 to 1) to determine the variation in shape and tone for a stated color
  71580. * @returns the number of groups in the system
  71581. */
  71582. addSurfacePoints(mesh: Mesh, nb: number, colorWith?: number, color?: Color4 | number, range?: number): number;
  71583. /**
  71584. * Adds points to the PCS inside the model shape
  71585. * @param mesh is any Mesh object that will be used as a surface model for the points
  71586. * @param nb (positive integer) the number of particles to be created from this model
  71587. * @param colorWith determines whether a point is colored using color (default), uv, random, stated or none (invisible)
  71588. * @param color (color4) to be used when colorWith is stated or color (number) when used to specify texture position
  71589. * @param range (number from 0 to 1) to determine the variation in shape and tone for a stated color
  71590. * @returns the number of groups in the system
  71591. */
  71592. addVolumePoints(mesh: Mesh, nb: number, colorWith?: number, color?: Color4 | number, range?: number): number;
  71593. /**
  71594. * Sets all the particles : this method actually really updates the mesh according to the particle positions, rotations, colors, textures, etc.
  71595. * This method calls `updateParticle()` for each particle of the SPS.
  71596. * For an animated SPS, it is usually called within the render loop.
  71597. * @param start The particle index in the particle array where to start to compute the particle property values _(default 0)_
  71598. * @param end The particle index in the particle array where to stop to compute the particle property values _(default nbParticle - 1)_
  71599. * @param update If the mesh must be finally updated on this call after all the particle computations _(default true)_
  71600. * @returns the PCS.
  71601. */
  71602. setParticles(start?: number, end?: number, update?: boolean): PointsCloudSystem;
  71603. /**
  71604. * Disposes the PCS.
  71605. */
  71606. dispose(): void;
  71607. /**
  71608. * Visibilty helper : Recomputes the visible size according to the mesh bounding box
  71609. * doc :
  71610. * @returns the PCS.
  71611. */
  71612. refreshVisibleSize(): PointsCloudSystem;
  71613. /**
  71614. * Visibility helper : Sets the size of a visibility box, this sets the underlying mesh bounding box.
  71615. * @param size the size (float) of the visibility box
  71616. * note : this doesn't lock the PCS mesh bounding box.
  71617. * doc :
  71618. */
  71619. setVisibilityBox(size: number): void;
  71620. /**
  71621. * Gets whether the PCS is always visible or not
  71622. * doc :
  71623. */
  71624. get isAlwaysVisible(): boolean;
  71625. /**
  71626. * Sets the PCS as always visible or not
  71627. * doc :
  71628. */
  71629. set isAlwaysVisible(val: boolean);
  71630. /**
  71631. * Tells to `setParticles()` to compute the particle rotations or not
  71632. * Default value : false. The PCS is faster when it's set to false
  71633. * Note : particle rotations are only applied to parent particles
  71634. * Note : the particle rotations aren't stored values, so setting `computeParticleRotation` to false will prevents the particle to rotate
  71635. */
  71636. set computeParticleRotation(val: boolean);
  71637. /**
  71638. * Tells to `setParticles()` to compute the particle colors or not.
  71639. * Default value : true. The PCS is faster when it's set to false.
  71640. * Note : the particle colors are stored values, so setting `computeParticleColor` to false will keep yet the last colors set.
  71641. */
  71642. set computeParticleColor(val: boolean);
  71643. set computeParticleTexture(val: boolean);
  71644. /**
  71645. * Gets if `setParticles()` computes the particle colors or not.
  71646. * Default value : false. The PCS is faster when it's set to false.
  71647. * Note : the particle colors are stored values, so setting `computeParticleColor` to false will keep yet the last colors set.
  71648. */
  71649. get computeParticleColor(): boolean;
  71650. /**
  71651. * Gets if `setParticles()` computes the particle textures or not.
  71652. * Default value : false. The PCS is faster when it's set to false.
  71653. * Note : the particle textures are stored values, so setting `computeParticleTexture` to false will keep yet the last colors set.
  71654. */
  71655. get computeParticleTexture(): boolean;
  71656. /**
  71657. * Tells to `setParticles()` to compute or not the mesh bounding box when computing the particle positions.
  71658. */
  71659. set computeBoundingBox(val: boolean);
  71660. /**
  71661. * Gets if `setParticles()` computes or not the mesh bounding box when computing the particle positions.
  71662. */
  71663. get computeBoundingBox(): boolean;
  71664. /**
  71665. * This function does nothing. It may be overwritten to set all the particle first values.
  71666. * The PCS doesn't call this function, you may have to call it by your own.
  71667. * doc :
  71668. */
  71669. initParticles(): void;
  71670. /**
  71671. * This function does nothing. It may be overwritten to recycle a particle
  71672. * The PCS doesn't call this function, you can to call it
  71673. * doc :
  71674. * @param particle The particle to recycle
  71675. * @returns the recycled particle
  71676. */
  71677. recycleParticle(particle: CloudPoint): CloudPoint;
  71678. /**
  71679. * Updates a particle : this function should be overwritten by the user.
  71680. * It is called on each particle by `setParticles()`. This is the place to code each particle behavior.
  71681. * doc :
  71682. * @example : just set a particle position or velocity and recycle conditions
  71683. * @param particle The particle to update
  71684. * @returns the updated particle
  71685. */
  71686. updateParticle(particle: CloudPoint): CloudPoint;
  71687. /**
  71688. * This will be called before any other treatment by `setParticles()` and will be passed three parameters.
  71689. * This does nothing and may be overwritten by the user.
  71690. * @param start the particle index in the particle array where to start to iterate, same than the value passed to setParticle()
  71691. * @param stop the particle index in the particle array where to stop to iterate, same than the value passed to setParticle()
  71692. * @param update the boolean update value actually passed to setParticles()
  71693. */
  71694. beforeUpdateParticles(start?: number, stop?: number, update?: boolean): void;
  71695. /**
  71696. * This will be called by `setParticles()` after all the other treatments and just before the actual mesh update.
  71697. * This will be passed three parameters.
  71698. * This does nothing and may be overwritten by the user.
  71699. * @param start the particle index in the particle array where to start to iterate, same than the value passed to setParticle()
  71700. * @param stop the particle index in the particle array where to stop to iterate, same than the value passed to setParticle()
  71701. * @param update the boolean update value actually passed to setParticles()
  71702. */
  71703. afterUpdateParticles(start?: number, stop?: number, update?: boolean): void;
  71704. }
  71705. }
  71706. declare module "babylonjs/Particles/cloudPoint" {
  71707. import { Nullable } from "babylonjs/types";
  71708. import { Color4, Vector2, Vector3, Matrix, Quaternion } from "babylonjs/Maths/math";
  71709. import { Mesh } from "babylonjs/Meshes/mesh";
  71710. import { BoundingInfo } from "babylonjs/Culling/boundingInfo";
  71711. import { PointsCloudSystem } from "babylonjs/Particles/pointsCloudSystem";
  71712. /**
  71713. * Represents one particle of a points cloud system.
  71714. */
  71715. export class CloudPoint {
  71716. /**
  71717. * particle global index
  71718. */
  71719. idx: number;
  71720. /**
  71721. * The color of the particle
  71722. */
  71723. color: Nullable<Color4>;
  71724. /**
  71725. * The world space position of the particle.
  71726. */
  71727. position: Vector3;
  71728. /**
  71729. * The world space rotation of the particle. (Not use if rotationQuaternion is set)
  71730. */
  71731. rotation: Vector3;
  71732. /**
  71733. * The world space rotation quaternion of the particle.
  71734. */
  71735. rotationQuaternion: Nullable<Quaternion>;
  71736. /**
  71737. * The uv of the particle.
  71738. */
  71739. uv: Nullable<Vector2>;
  71740. /**
  71741. * The current speed of the particle.
  71742. */
  71743. velocity: Vector3;
  71744. /**
  71745. * The pivot point in the particle local space.
  71746. */
  71747. pivot: Vector3;
  71748. /**
  71749. * Must the particle be translated from its pivot point in its local space ?
  71750. * In this case, the pivot point is set at the origin of the particle local space and the particle is translated.
  71751. * Default : false
  71752. */
  71753. translateFromPivot: boolean;
  71754. /**
  71755. * Index of this particle in the global "positions" array (Internal use)
  71756. * @hidden
  71757. */
  71758. _pos: number;
  71759. /**
  71760. * @hidden Index of this particle in the global "indices" array (Internal use)
  71761. */
  71762. _ind: number;
  71763. /**
  71764. * Group this particle belongs to
  71765. */
  71766. _group: PointsGroup;
  71767. /**
  71768. * Group id of this particle
  71769. */
  71770. groupId: number;
  71771. /**
  71772. * Index of the particle in its group id (Internal use)
  71773. */
  71774. idxInGroup: number;
  71775. /**
  71776. * @hidden Particle BoundingInfo object (Internal use)
  71777. */
  71778. _boundingInfo: BoundingInfo;
  71779. /**
  71780. * @hidden Reference to the PCS that the particle belongs to (Internal use)
  71781. */
  71782. _pcs: PointsCloudSystem;
  71783. /**
  71784. * @hidden Still set as invisible in order to skip useless computations (Internal use)
  71785. */
  71786. _stillInvisible: boolean;
  71787. /**
  71788. * @hidden Last computed particle rotation matrix
  71789. */
  71790. _rotationMatrix: number[];
  71791. /**
  71792. * Parent particle Id, if any.
  71793. * Default null.
  71794. */
  71795. parentId: Nullable<number>;
  71796. /**
  71797. * @hidden Internal global position in the PCS.
  71798. */
  71799. _globalPosition: Vector3;
  71800. /**
  71801. * Creates a Point Cloud object.
  71802. * Don't create particles manually, use instead the PCS internal tools like _addParticle()
  71803. * @param particleIndex (integer) is the particle index in the PCS pool. It's also the particle identifier.
  71804. * @param group (PointsGroup) is the group the particle belongs to
  71805. * @param groupId (integer) is the group identifier in the PCS.
  71806. * @param idxInGroup (integer) is the index of the particle in the current point group (ex: the 10th point of addPoints(30))
  71807. * @param pcs defines the PCS it is associated to
  71808. */
  71809. constructor(particleIndex: number, group: PointsGroup, groupId: number, idxInGroup: number, pcs: PointsCloudSystem);
  71810. /**
  71811. * get point size
  71812. */
  71813. get size(): Vector3;
  71814. /**
  71815. * Set point size
  71816. */
  71817. set size(scale: Vector3);
  71818. /**
  71819. * Legacy support, changed quaternion to rotationQuaternion
  71820. */
  71821. get quaternion(): Nullable<Quaternion>;
  71822. /**
  71823. * Legacy support, changed quaternion to rotationQuaternion
  71824. */
  71825. set quaternion(q: Nullable<Quaternion>);
  71826. /**
  71827. * Returns a boolean. True if the particle intersects a mesh, else false
  71828. * The intersection is computed on the particle position and Axis Aligned Bounding Box (AABB) or Sphere
  71829. * @param target is the object (point or mesh) what the intersection is computed against
  71830. * @param isSphere is boolean flag when false (default) bounding box of mesh is used, when true the bouding sphere is used
  71831. * @returns true if it intersects
  71832. */
  71833. intersectsMesh(target: Mesh, isSphere: boolean): boolean;
  71834. /**
  71835. * get the rotation matrix of the particle
  71836. * @hidden
  71837. */
  71838. getRotationMatrix(m: Matrix): void;
  71839. }
  71840. /**
  71841. * Represents a group of points in a points cloud system
  71842. * * PCS internal tool, don't use it manually.
  71843. */
  71844. export class PointsGroup {
  71845. /**
  71846. * The group id
  71847. * @hidden
  71848. */
  71849. groupID: number;
  71850. /**
  71851. * image data for group (internal use)
  71852. * @hidden
  71853. */
  71854. _groupImageData: Nullable<ArrayBufferView>;
  71855. /**
  71856. * Image Width (internal use)
  71857. * @hidden
  71858. */
  71859. _groupImgWidth: number;
  71860. /**
  71861. * Image Height (internal use)
  71862. * @hidden
  71863. */
  71864. _groupImgHeight: number;
  71865. /**
  71866. * Custom position function (internal use)
  71867. * @hidden
  71868. */
  71869. _positionFunction: Nullable<(particle: CloudPoint, i?: number, s?: number) => void>;
  71870. /**
  71871. * density per facet for surface points
  71872. * @hidden
  71873. */
  71874. _groupDensity: number[];
  71875. /**
  71876. * Only when points are colored by texture carries pointer to texture list array
  71877. * @hidden
  71878. */
  71879. _textureNb: number;
  71880. /**
  71881. * Creates a points group object. This is an internal reference to produce particles for the PCS.
  71882. * PCS internal tool, don't use it manually.
  71883. * @hidden
  71884. */
  71885. constructor(id: number, posFunction: Nullable<(particle: CloudPoint, i?: number, s?: number) => void>);
  71886. }
  71887. }
  71888. declare module "babylonjs/Particles/index" {
  71889. export * from "babylonjs/Particles/baseParticleSystem";
  71890. export * from "babylonjs/Particles/EmitterTypes/index";
  71891. export * from "babylonjs/Particles/gpuParticleSystem";
  71892. export * from "babylonjs/Particles/IParticleSystem";
  71893. export * from "babylonjs/Particles/particle";
  71894. export * from "babylonjs/Particles/particleHelper";
  71895. export * from "babylonjs/Particles/particleSystem";
  71896. import "babylonjs/Particles/particleSystemComponent";
  71897. export * from "babylonjs/Particles/particleSystemComponent";
  71898. export * from "babylonjs/Particles/particleSystemSet";
  71899. export * from "babylonjs/Particles/solidParticle";
  71900. export * from "babylonjs/Particles/solidParticleSystem";
  71901. export * from "babylonjs/Particles/cloudPoint";
  71902. export * from "babylonjs/Particles/pointsCloudSystem";
  71903. export * from "babylonjs/Particles/subEmitter";
  71904. }
  71905. declare module "babylonjs/Physics/physicsEngineComponent" {
  71906. import { Nullable } from "babylonjs/types";
  71907. import { Observable, Observer } from "babylonjs/Misc/observable";
  71908. import { Vector3 } from "babylonjs/Maths/math.vector";
  71909. import { Mesh } from "babylonjs/Meshes/mesh";
  71910. import { ISceneComponent } from "babylonjs/sceneComponent";
  71911. import { Scene } from "babylonjs/scene";
  71912. import { Node } from "babylonjs/node";
  71913. import { IPhysicsEngine, IPhysicsEnginePlugin } from "babylonjs/Physics/IPhysicsEngine";
  71914. import { PhysicsImpostor } from "babylonjs/Physics/physicsImpostor";
  71915. module "babylonjs/scene" {
  71916. interface Scene {
  71917. /** @hidden (Backing field) */
  71918. _physicsEngine: Nullable<IPhysicsEngine>;
  71919. /** @hidden */
  71920. _physicsTimeAccumulator: number;
  71921. /**
  71922. * Gets the current physics engine
  71923. * @returns a IPhysicsEngine or null if none attached
  71924. */
  71925. getPhysicsEngine(): Nullable<IPhysicsEngine>;
  71926. /**
  71927. * Enables physics to the current scene
  71928. * @param gravity defines the scene's gravity for the physics engine
  71929. * @param plugin defines the physics engine to be used. defaults to OimoJS.
  71930. * @return a boolean indicating if the physics engine was initialized
  71931. */
  71932. enablePhysics(gravity: Nullable<Vector3>, plugin?: IPhysicsEnginePlugin): boolean;
  71933. /**
  71934. * Disables and disposes the physics engine associated with the scene
  71935. */
  71936. disablePhysicsEngine(): void;
  71937. /**
  71938. * Gets a boolean indicating if there is an active physics engine
  71939. * @returns a boolean indicating if there is an active physics engine
  71940. */
  71941. isPhysicsEnabled(): boolean;
  71942. /**
  71943. * Deletes a physics compound impostor
  71944. * @param compound defines the compound to delete
  71945. */
  71946. deleteCompoundImpostor(compound: any): void;
  71947. /**
  71948. * An event triggered when physic simulation is about to be run
  71949. */
  71950. onBeforePhysicsObservable: Observable<Scene>;
  71951. /**
  71952. * An event triggered when physic simulation has been done
  71953. */
  71954. onAfterPhysicsObservable: Observable<Scene>;
  71955. }
  71956. }
  71957. module "babylonjs/Meshes/abstractMesh" {
  71958. interface AbstractMesh {
  71959. /** @hidden */
  71960. _physicsImpostor: Nullable<PhysicsImpostor>;
  71961. /**
  71962. * Gets or sets impostor used for physic simulation
  71963. * @see https://doc.babylonjs.com/features/physics_engine
  71964. */
  71965. physicsImpostor: Nullable<PhysicsImpostor>;
  71966. /**
  71967. * Gets the current physics impostor
  71968. * @see https://doc.babylonjs.com/features/physics_engine
  71969. * @returns a physics impostor or null
  71970. */
  71971. getPhysicsImpostor(): Nullable<PhysicsImpostor>;
  71972. /** Apply a physic impulse to the mesh
  71973. * @param force defines the force to apply
  71974. * @param contactPoint defines where to apply the force
  71975. * @returns the current mesh
  71976. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  71977. */
  71978. applyImpulse(force: Vector3, contactPoint: Vector3): AbstractMesh;
  71979. /**
  71980. * Creates a physic joint between two meshes
  71981. * @param otherMesh defines the other mesh to use
  71982. * @param pivot1 defines the pivot to use on this mesh
  71983. * @param pivot2 defines the pivot to use on the other mesh
  71984. * @param options defines additional options (can be plugin dependent)
  71985. * @returns the current mesh
  71986. * @see https://www.babylonjs-playground.com/#0BS5U0#0
  71987. */
  71988. setPhysicsLinkWith(otherMesh: Mesh, pivot1: Vector3, pivot2: Vector3, options?: any): AbstractMesh;
  71989. /** @hidden */
  71990. _disposePhysicsObserver: Nullable<Observer<Node>>;
  71991. }
  71992. }
  71993. /**
  71994. * Defines the physics engine scene component responsible to manage a physics engine
  71995. */
  71996. export class PhysicsEngineSceneComponent implements ISceneComponent {
  71997. /**
  71998. * The component name helpful to identify the component in the list of scene components.
  71999. */
  72000. readonly name: string;
  72001. /**
  72002. * The scene the component belongs to.
  72003. */
  72004. scene: Scene;
  72005. /**
  72006. * Creates a new instance of the component for the given scene
  72007. * @param scene Defines the scene to register the component in
  72008. */
  72009. constructor(scene: Scene);
  72010. /**
  72011. * Registers the component in a given scene
  72012. */
  72013. register(): void;
  72014. /**
  72015. * Rebuilds the elements related to this component in case of
  72016. * context lost for instance.
  72017. */
  72018. rebuild(): void;
  72019. /**
  72020. * Disposes the component and the associated ressources
  72021. */
  72022. dispose(): void;
  72023. }
  72024. }
  72025. declare module "babylonjs/Physics/physicsHelper" {
  72026. import { Nullable } from "babylonjs/types";
  72027. import { Vector3 } from "babylonjs/Maths/math.vector";
  72028. import { Mesh } from "babylonjs/Meshes/mesh";
  72029. import { Scene } from "babylonjs/scene";
  72030. import { PhysicsImpostor } from "babylonjs/Physics/physicsImpostor";
  72031. /**
  72032. * A helper for physics simulations
  72033. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine#further-functionality-of-the-impostor-class
  72034. */
  72035. export class PhysicsHelper {
  72036. private _scene;
  72037. private _physicsEngine;
  72038. /**
  72039. * Initializes the Physics helper
  72040. * @param scene Babylon.js scene
  72041. */
  72042. constructor(scene: Scene);
  72043. /**
  72044. * Applies a radial explosion impulse
  72045. * @param origin the origin of the explosion
  72046. * @param radiusOrEventOptions the radius or the options of radial explosion
  72047. * @param strength the explosion strength
  72048. * @param falloff possible options: Constant & Linear. Defaults to Constant
  72049. * @returns A physics radial explosion event, or null
  72050. */
  72051. applyRadialExplosionImpulse(origin: Vector3, radiusOrEventOptions: number | PhysicsRadialExplosionEventOptions, strength?: number, falloff?: PhysicsRadialImpulseFalloff): Nullable<PhysicsRadialExplosionEvent>;
  72052. /**
  72053. * Applies a radial explosion force
  72054. * @param origin the origin of the explosion
  72055. * @param radiusOrEventOptions the radius or the options of radial explosion
  72056. * @param strength the explosion strength
  72057. * @param falloff possible options: Constant & Linear. Defaults to Constant
  72058. * @returns A physics radial explosion event, or null
  72059. */
  72060. applyRadialExplosionForce(origin: Vector3, radiusOrEventOptions: number | PhysicsRadialExplosionEventOptions, strength?: number, falloff?: PhysicsRadialImpulseFalloff): Nullable<PhysicsRadialExplosionEvent>;
  72061. /**
  72062. * Creates a gravitational field
  72063. * @param origin the origin of the explosion
  72064. * @param radiusOrEventOptions the radius or the options of radial explosion
  72065. * @param strength the explosion strength
  72066. * @param falloff possible options: Constant & Linear. Defaults to Constant
  72067. * @returns A physics gravitational field event, or null
  72068. */
  72069. gravitationalField(origin: Vector3, radiusOrEventOptions: number | PhysicsRadialExplosionEventOptions, strength?: number, falloff?: PhysicsRadialImpulseFalloff): Nullable<PhysicsGravitationalFieldEvent>;
  72070. /**
  72071. * Creates a physics updraft event
  72072. * @param origin the origin of the updraft
  72073. * @param radiusOrEventOptions the radius or the options of the updraft
  72074. * @param strength the strength of the updraft
  72075. * @param height the height of the updraft
  72076. * @param updraftMode possible options: Center & Perpendicular. Defaults to Center
  72077. * @returns A physics updraft event, or null
  72078. */
  72079. updraft(origin: Vector3, radiusOrEventOptions: number | PhysicsUpdraftEventOptions, strength?: number, height?: number, updraftMode?: PhysicsUpdraftMode): Nullable<PhysicsUpdraftEvent>;
  72080. /**
  72081. * Creates a physics vortex event
  72082. * @param origin the of the vortex
  72083. * @param radiusOrEventOptions the radius or the options of the vortex
  72084. * @param strength the strength of the vortex
  72085. * @param height the height of the vortex
  72086. * @returns a Physics vortex event, or null
  72087. * A physics vortex event or null
  72088. */
  72089. vortex(origin: Vector3, radiusOrEventOptions: number | PhysicsVortexEventOptions, strength?: number, height?: number): Nullable<PhysicsVortexEvent>;
  72090. }
  72091. /**
  72092. * Represents a physics radial explosion event
  72093. */
  72094. class PhysicsRadialExplosionEvent {
  72095. private _scene;
  72096. private _options;
  72097. private _sphere;
  72098. private _dataFetched;
  72099. /**
  72100. * Initializes a radial explosioin event
  72101. * @param _scene BabylonJS scene
  72102. * @param _options The options for the vortex event
  72103. */
  72104. constructor(_scene: Scene, _options: PhysicsRadialExplosionEventOptions);
  72105. /**
  72106. * Returns the data related to the radial explosion event (sphere).
  72107. * @returns The radial explosion event data
  72108. */
  72109. getData(): PhysicsRadialExplosionEventData;
  72110. /**
  72111. * Returns the force and contact point of the impostor or false, if the impostor is not affected by the force/impulse.
  72112. * @param impostor A physics imposter
  72113. * @param origin the origin of the explosion
  72114. * @returns {Nullable<PhysicsHitData>} A physics force and contact point, or null
  72115. */
  72116. getImpostorHitData(impostor: PhysicsImpostor, origin: Vector3): Nullable<PhysicsHitData>;
  72117. /**
  72118. * Triggers affecterd impostors callbacks
  72119. * @param affectedImpostorsWithData defines the list of affected impostors (including associated data)
  72120. */
  72121. triggerAffectedImpostorsCallback(affectedImpostorsWithData: Array<PhysicsAffectedImpostorWithData>): void;
  72122. /**
  72123. * Disposes the sphere.
  72124. * @param force Specifies if the sphere should be disposed by force
  72125. */
  72126. dispose(force?: boolean): void;
  72127. /*** Helpers ***/
  72128. private _prepareSphere;
  72129. private _intersectsWithSphere;
  72130. }
  72131. /**
  72132. * Represents a gravitational field event
  72133. */
  72134. class PhysicsGravitationalFieldEvent {
  72135. private _physicsHelper;
  72136. private _scene;
  72137. private _origin;
  72138. private _options;
  72139. private _tickCallback;
  72140. private _sphere;
  72141. private _dataFetched;
  72142. /**
  72143. * Initializes the physics gravitational field event
  72144. * @param _physicsHelper A physics helper
  72145. * @param _scene BabylonJS scene
  72146. * @param _origin The origin position of the gravitational field event
  72147. * @param _options The options for the vortex event
  72148. */
  72149. constructor(_physicsHelper: PhysicsHelper, _scene: Scene, _origin: Vector3, _options: PhysicsRadialExplosionEventOptions);
  72150. /**
  72151. * Returns the data related to the gravitational field event (sphere).
  72152. * @returns A gravitational field event
  72153. */
  72154. getData(): PhysicsGravitationalFieldEventData;
  72155. /**
  72156. * Enables the gravitational field.
  72157. */
  72158. enable(): void;
  72159. /**
  72160. * Disables the gravitational field.
  72161. */
  72162. disable(): void;
  72163. /**
  72164. * Disposes the sphere.
  72165. * @param force The force to dispose from the gravitational field event
  72166. */
  72167. dispose(force?: boolean): void;
  72168. private _tick;
  72169. }
  72170. /**
  72171. * Represents a physics updraft event
  72172. */
  72173. class PhysicsUpdraftEvent {
  72174. private _scene;
  72175. private _origin;
  72176. private _options;
  72177. private _physicsEngine;
  72178. private _originTop;
  72179. private _originDirection;
  72180. private _tickCallback;
  72181. private _cylinder;
  72182. private _cylinderPosition;
  72183. private _dataFetched;
  72184. /**
  72185. * Initializes the physics updraft event
  72186. * @param _scene BabylonJS scene
  72187. * @param _origin The origin position of the updraft
  72188. * @param _options The options for the updraft event
  72189. */
  72190. constructor(_scene: Scene, _origin: Vector3, _options: PhysicsUpdraftEventOptions);
  72191. /**
  72192. * Returns the data related to the updraft event (cylinder).
  72193. * @returns A physics updraft event
  72194. */
  72195. getData(): PhysicsUpdraftEventData;
  72196. /**
  72197. * Enables the updraft.
  72198. */
  72199. enable(): void;
  72200. /**
  72201. * Disables the updraft.
  72202. */
  72203. disable(): void;
  72204. /**
  72205. * Disposes the cylinder.
  72206. * @param force Specifies if the updraft should be disposed by force
  72207. */
  72208. dispose(force?: boolean): void;
  72209. private getImpostorHitData;
  72210. private _tick;
  72211. /*** Helpers ***/
  72212. private _prepareCylinder;
  72213. private _intersectsWithCylinder;
  72214. }
  72215. /**
  72216. * Represents a physics vortex event
  72217. */
  72218. class PhysicsVortexEvent {
  72219. private _scene;
  72220. private _origin;
  72221. private _options;
  72222. private _physicsEngine;
  72223. private _originTop;
  72224. private _tickCallback;
  72225. private _cylinder;
  72226. private _cylinderPosition;
  72227. private _dataFetched;
  72228. /**
  72229. * Initializes the physics vortex event
  72230. * @param _scene The BabylonJS scene
  72231. * @param _origin The origin position of the vortex
  72232. * @param _options The options for the vortex event
  72233. */
  72234. constructor(_scene: Scene, _origin: Vector3, _options: PhysicsVortexEventOptions);
  72235. /**
  72236. * Returns the data related to the vortex event (cylinder).
  72237. * @returns The physics vortex event data
  72238. */
  72239. getData(): PhysicsVortexEventData;
  72240. /**
  72241. * Enables the vortex.
  72242. */
  72243. enable(): void;
  72244. /**
  72245. * Disables the cortex.
  72246. */
  72247. disable(): void;
  72248. /**
  72249. * Disposes the sphere.
  72250. * @param force
  72251. */
  72252. dispose(force?: boolean): void;
  72253. private getImpostorHitData;
  72254. private _tick;
  72255. /*** Helpers ***/
  72256. private _prepareCylinder;
  72257. private _intersectsWithCylinder;
  72258. }
  72259. /**
  72260. * Options fot the radial explosion event
  72261. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine#further-functionality-of-the-impostor-class
  72262. */
  72263. export class PhysicsRadialExplosionEventOptions {
  72264. /**
  72265. * The radius of the sphere for the radial explosion.
  72266. */
  72267. radius: number;
  72268. /**
  72269. * The strenth of the explosion.
  72270. */
  72271. strength: number;
  72272. /**
  72273. * The strenght of the force in correspondence to the distance of the affected object
  72274. */
  72275. falloff: PhysicsRadialImpulseFalloff;
  72276. /**
  72277. * Sphere options for the radial explosion.
  72278. */
  72279. sphere: {
  72280. segments: number;
  72281. diameter: number;
  72282. };
  72283. /**
  72284. * Sphere options for the radial explosion.
  72285. */
  72286. affectedImpostorsCallback: (affectedImpostorsWithData: Array<PhysicsAffectedImpostorWithData>) => void;
  72287. }
  72288. /**
  72289. * Options fot the updraft event
  72290. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine#further-functionality-of-the-impostor-class
  72291. */
  72292. export class PhysicsUpdraftEventOptions {
  72293. /**
  72294. * The radius of the cylinder for the vortex
  72295. */
  72296. radius: number;
  72297. /**
  72298. * The strenth of the updraft.
  72299. */
  72300. strength: number;
  72301. /**
  72302. * The height of the cylinder for the updraft.
  72303. */
  72304. height: number;
  72305. /**
  72306. * The mode for the the updraft.
  72307. */
  72308. updraftMode: PhysicsUpdraftMode;
  72309. }
  72310. /**
  72311. * Options fot the vortex event
  72312. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine#further-functionality-of-the-impostor-class
  72313. */
  72314. export class PhysicsVortexEventOptions {
  72315. /**
  72316. * The radius of the cylinder for the vortex
  72317. */
  72318. radius: number;
  72319. /**
  72320. * The strenth of the vortex.
  72321. */
  72322. strength: number;
  72323. /**
  72324. * The height of the cylinder for the vortex.
  72325. */
  72326. height: number;
  72327. /**
  72328. * At which distance, relative to the radius the centripetal forces should kick in? Range: 0-1
  72329. */
  72330. centripetalForceThreshold: number;
  72331. /**
  72332. * This multiplier determines with how much force the objects will be pushed sideways/around the vortex, when below the treshold.
  72333. */
  72334. centripetalForceMultiplier: number;
  72335. /**
  72336. * This multiplier determines with how much force the objects will be pushed sideways/around the vortex, when above the treshold.
  72337. */
  72338. centrifugalForceMultiplier: number;
  72339. /**
  72340. * This multiplier determines with how much force the objects will be pushed upwards, when in the vortex.
  72341. */
  72342. updraftForceMultiplier: number;
  72343. }
  72344. /**
  72345. * The strenght of the force in correspondence to the distance of the affected object
  72346. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine#further-functionality-of-the-impostor-class
  72347. */
  72348. export enum PhysicsRadialImpulseFalloff {
  72349. /** Defines that impulse is constant in strength across it's whole radius */
  72350. Constant = 0,
  72351. /** Defines that impulse gets weaker if it's further from the origin */
  72352. Linear = 1
  72353. }
  72354. /**
  72355. * The strength of the force in correspondence to the distance of the affected object
  72356. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine#further-functionality-of-the-impostor-class
  72357. */
  72358. export enum PhysicsUpdraftMode {
  72359. /** Defines that the upstream forces will pull towards the top center of the cylinder */
  72360. Center = 0,
  72361. /** Defines that once a impostor is inside the cylinder, it will shoot out perpendicular from the ground of the cylinder */
  72362. Perpendicular = 1
  72363. }
  72364. /**
  72365. * Interface for a physics hit data
  72366. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine#further-functionality-of-the-impostor-class
  72367. */
  72368. export interface PhysicsHitData {
  72369. /**
  72370. * The force applied at the contact point
  72371. */
  72372. force: Vector3;
  72373. /**
  72374. * The contact point
  72375. */
  72376. contactPoint: Vector3;
  72377. /**
  72378. * The distance from the origin to the contact point
  72379. */
  72380. distanceFromOrigin: number;
  72381. }
  72382. /**
  72383. * Interface for radial explosion event data
  72384. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine#further-functionality-of-the-impostor-class
  72385. */
  72386. export interface PhysicsRadialExplosionEventData {
  72387. /**
  72388. * A sphere used for the radial explosion event
  72389. */
  72390. sphere: Mesh;
  72391. }
  72392. /**
  72393. * Interface for gravitational field event data
  72394. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine#further-functionality-of-the-impostor-class
  72395. */
  72396. export interface PhysicsGravitationalFieldEventData {
  72397. /**
  72398. * A sphere mesh used for the gravitational field event
  72399. */
  72400. sphere: Mesh;
  72401. }
  72402. /**
  72403. * Interface for updraft event data
  72404. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine#further-functionality-of-the-impostor-class
  72405. */
  72406. export interface PhysicsUpdraftEventData {
  72407. /**
  72408. * A cylinder used for the updraft event
  72409. */
  72410. cylinder: Mesh;
  72411. }
  72412. /**
  72413. * Interface for vortex event data
  72414. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine#further-functionality-of-the-impostor-class
  72415. */
  72416. export interface PhysicsVortexEventData {
  72417. /**
  72418. * A cylinder used for the vortex event
  72419. */
  72420. cylinder: Mesh;
  72421. }
  72422. /**
  72423. * Interface for an affected physics impostor
  72424. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine#further-functionality-of-the-impostor-class
  72425. */
  72426. export interface PhysicsAffectedImpostorWithData {
  72427. /**
  72428. * The impostor affected by the effect
  72429. */
  72430. impostor: PhysicsImpostor;
  72431. /**
  72432. * The data about the hit/horce from the explosion
  72433. */
  72434. hitData: PhysicsHitData;
  72435. }
  72436. }
  72437. declare module "babylonjs/Physics/Plugins/index" {
  72438. export * from "babylonjs/Physics/Plugins/cannonJSPlugin";
  72439. export * from "babylonjs/Physics/Plugins/ammoJSPlugin";
  72440. export * from "babylonjs/Physics/Plugins/oimoJSPlugin";
  72441. }
  72442. declare module "babylonjs/Physics/index" {
  72443. export * from "babylonjs/Physics/IPhysicsEngine";
  72444. export * from "babylonjs/Physics/physicsEngine";
  72445. export * from "babylonjs/Physics/physicsEngineComponent";
  72446. export * from "babylonjs/Physics/physicsHelper";
  72447. export * from "babylonjs/Physics/physicsImpostor";
  72448. export * from "babylonjs/Physics/physicsJoint";
  72449. export * from "babylonjs/Physics/Plugins/index";
  72450. }
  72451. declare module "babylonjs/Shaders/blackAndWhite.fragment" {
  72452. /** @hidden */
  72453. export var blackAndWhitePixelShader: {
  72454. name: string;
  72455. shader: string;
  72456. };
  72457. }
  72458. declare module "babylonjs/PostProcesses/blackAndWhitePostProcess" {
  72459. import { PostProcess, PostProcessOptions } from "babylonjs/PostProcesses/postProcess";
  72460. import { Camera } from "babylonjs/Cameras/camera";
  72461. import { Engine } from "babylonjs/Engines/engine";
  72462. import "babylonjs/Shaders/blackAndWhite.fragment";
  72463. import { Nullable } from "babylonjs/types";
  72464. import { Scene } from "babylonjs/scene";
  72465. /**
  72466. * Post process used to render in black and white
  72467. */
  72468. export class BlackAndWhitePostProcess extends PostProcess {
  72469. /**
  72470. * Linear about to convert he result to black and white (default: 1)
  72471. */
  72472. degree: number;
  72473. /**
  72474. * Gets a string identifying the name of the class
  72475. * @returns "BlackAndWhitePostProcess" string
  72476. */
  72477. getClassName(): string;
  72478. /**
  72479. * Creates a black and white post process
  72480. * @see https://doc.babylonjs.com/how_to/how_to_use_postprocesses#black-and-white
  72481. * @param name The name of the effect.
  72482. * @param options The required width/height ratio to downsize to before computing the render pass.
  72483. * @param camera The camera to apply the render pass to.
  72484. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  72485. * @param engine The engine which the post process will be applied. (default: current engine)
  72486. * @param reusable If the post process can be reused on the same frame. (default: false)
  72487. */
  72488. constructor(name: string, options: number | PostProcessOptions, camera: Camera, samplingMode?: number, engine?: Engine, reusable?: boolean);
  72489. /** @hidden */
  72490. static _Parse(parsedPostProcess: any, targetCamera: Camera, scene: Scene, rootUrl: string): Nullable<BlackAndWhitePostProcess>;
  72491. }
  72492. }
  72493. declare module "babylonjs/PostProcesses/RenderPipeline/postProcessRenderEffect" {
  72494. import { Nullable } from "babylonjs/types";
  72495. import { Camera } from "babylonjs/Cameras/camera";
  72496. import { PostProcess } from "babylonjs/PostProcesses/postProcess";
  72497. import { Engine } from "babylonjs/Engines/engine";
  72498. /**
  72499. * This represents a set of one or more post processes in Babylon.
  72500. * A post process can be used to apply a shader to a texture after it is rendered.
  72501. * @example https://doc.babylonjs.com/how_to/how_to_use_postprocessrenderpipeline
  72502. */
  72503. export class PostProcessRenderEffect {
  72504. private _postProcesses;
  72505. private _getPostProcesses;
  72506. private _singleInstance;
  72507. private _cameras;
  72508. private _indicesForCamera;
  72509. /**
  72510. * Name of the effect
  72511. * @hidden
  72512. */
  72513. _name: string;
  72514. /**
  72515. * Instantiates a post process render effect.
  72516. * A post process can be used to apply a shader to a texture after it is rendered.
  72517. * @param engine The engine the effect is tied to
  72518. * @param name The name of the effect
  72519. * @param getPostProcesses A function that returns a set of post processes which the effect will run in order to be run.
  72520. * @param singleInstance False if this post process can be run on multiple cameras. (default: true)
  72521. */
  72522. constructor(engine: Engine, name: string, getPostProcesses: () => Nullable<PostProcess | Array<PostProcess>>, singleInstance?: boolean);
  72523. /**
  72524. * Checks if all the post processes in the effect are supported.
  72525. */
  72526. get isSupported(): boolean;
  72527. /**
  72528. * Updates the current state of the effect
  72529. * @hidden
  72530. */
  72531. _update(): void;
  72532. /**
  72533. * Attaches the effect on cameras
  72534. * @param cameras The camera to attach to.
  72535. * @hidden
  72536. */
  72537. _attachCameras(cameras: Camera): void;
  72538. /**
  72539. * Attaches the effect on cameras
  72540. * @param cameras The camera to attach to.
  72541. * @hidden
  72542. */
  72543. _attachCameras(cameras: Camera[]): void;
  72544. /**
  72545. * Detaches the effect on cameras
  72546. * @param cameras The camera to detatch from.
  72547. * @hidden
  72548. */
  72549. _detachCameras(cameras: Camera): void;
  72550. /**
  72551. * Detatches the effect on cameras
  72552. * @param cameras The camera to detatch from.
  72553. * @hidden
  72554. */
  72555. _detachCameras(cameras: Camera[]): void;
  72556. /**
  72557. * Enables the effect on given cameras
  72558. * @param cameras The camera to enable.
  72559. * @hidden
  72560. */
  72561. _enable(cameras: Camera): void;
  72562. /**
  72563. * Enables the effect on given cameras
  72564. * @param cameras The camera to enable.
  72565. * @hidden
  72566. */
  72567. _enable(cameras: Nullable<Camera[]>): void;
  72568. /**
  72569. * Disables the effect on the given cameras
  72570. * @param cameras The camera to disable.
  72571. * @hidden
  72572. */
  72573. _disable(cameras: Camera): void;
  72574. /**
  72575. * Disables the effect on the given cameras
  72576. * @param cameras The camera to disable.
  72577. * @hidden
  72578. */
  72579. _disable(cameras: Nullable<Camera[]>): void;
  72580. /**
  72581. * Gets a list of the post processes contained in the effect.
  72582. * @param camera The camera to get the post processes on.
  72583. * @returns The list of the post processes in the effect.
  72584. */
  72585. getPostProcesses(camera?: Camera): Nullable<Array<PostProcess>>;
  72586. }
  72587. }
  72588. declare module "babylonjs/Shaders/extractHighlights.fragment" {
  72589. import "babylonjs/Shaders/ShadersInclude/helperFunctions";
  72590. /** @hidden */
  72591. export var extractHighlightsPixelShader: {
  72592. name: string;
  72593. shader: string;
  72594. };
  72595. }
  72596. declare module "babylonjs/PostProcesses/extractHighlightsPostProcess" {
  72597. import { Nullable } from "babylonjs/types";
  72598. import { Camera } from "babylonjs/Cameras/camera";
  72599. import { PostProcess, PostProcessOptions } from "babylonjs/PostProcesses/postProcess";
  72600. import { Engine } from "babylonjs/Engines/engine";
  72601. import "babylonjs/Shaders/extractHighlights.fragment";
  72602. /**
  72603. * 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.
  72604. */
  72605. export class ExtractHighlightsPostProcess extends PostProcess {
  72606. /**
  72607. * The luminance threshold, pixels below this value will be set to black.
  72608. */
  72609. threshold: number;
  72610. /** @hidden */
  72611. _exposure: number;
  72612. /**
  72613. * Post process which has the input texture to be used when performing highlight extraction
  72614. * @hidden
  72615. */
  72616. _inputPostProcess: Nullable<PostProcess>;
  72617. /**
  72618. * Gets a string identifying the name of the class
  72619. * @returns "ExtractHighlightsPostProcess" string
  72620. */
  72621. getClassName(): string;
  72622. constructor(name: string, options: number | PostProcessOptions, camera: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number, blockCompilation?: boolean);
  72623. }
  72624. }
  72625. declare module "babylonjs/Shaders/bloomMerge.fragment" {
  72626. /** @hidden */
  72627. export var bloomMergePixelShader: {
  72628. name: string;
  72629. shader: string;
  72630. };
  72631. }
  72632. declare module "babylonjs/PostProcesses/bloomMergePostProcess" {
  72633. import { PostProcess, PostProcessOptions } from "babylonjs/PostProcesses/postProcess";
  72634. import { Nullable } from "babylonjs/types";
  72635. import { Engine } from "babylonjs/Engines/engine";
  72636. import { Camera } from "babylonjs/Cameras/camera";
  72637. import "babylonjs/Shaders/bloomMerge.fragment";
  72638. /**
  72639. * The BloomMergePostProcess merges blurred images with the original based on the values of the circle of confusion.
  72640. */
  72641. export class BloomMergePostProcess extends PostProcess {
  72642. /** Weight of the bloom to be added to the original input. */
  72643. weight: number;
  72644. /**
  72645. * Gets a string identifying the name of the class
  72646. * @returns "BloomMergePostProcess" string
  72647. */
  72648. getClassName(): string;
  72649. /**
  72650. * Creates a new instance of @see BloomMergePostProcess
  72651. * @param name The name of the effect.
  72652. * @param originalFromInput Post process which's input will be used for the merge.
  72653. * @param blurred Blurred highlights post process which's output will be used.
  72654. * @param weight Weight of the bloom to be added to the original input.
  72655. * @param options The required width/height ratio to downsize to before computing the render pass.
  72656. * @param camera The camera to apply the render pass to.
  72657. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  72658. * @param engine The engine which the post process will be applied. (default: current engine)
  72659. * @param reusable If the post process can be reused on the same frame. (default: false)
  72660. * @param textureType Type of textures used when performing the post process. (default: 0)
  72661. * @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)
  72662. */
  72663. constructor(name: string, originalFromInput: PostProcess, blurred: PostProcess,
  72664. /** Weight of the bloom to be added to the original input. */
  72665. weight: number, options: number | PostProcessOptions, camera: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number, blockCompilation?: boolean);
  72666. }
  72667. }
  72668. declare module "babylonjs/PostProcesses/bloomEffect" {
  72669. import { PostProcessRenderEffect } from "babylonjs/PostProcesses/RenderPipeline/postProcessRenderEffect";
  72670. import { PostProcess } from "babylonjs/PostProcesses/postProcess";
  72671. import { ExtractHighlightsPostProcess } from "babylonjs/PostProcesses/extractHighlightsPostProcess";
  72672. import { Camera } from "babylonjs/Cameras/camera";
  72673. import { Scene } from "babylonjs/scene";
  72674. /**
  72675. * The bloom effect spreads bright areas of an image to simulate artifacts seen in cameras
  72676. */
  72677. export class BloomEffect extends PostProcessRenderEffect {
  72678. private bloomScale;
  72679. /**
  72680. * @hidden Internal
  72681. */
  72682. _effects: Array<PostProcess>;
  72683. /**
  72684. * @hidden Internal
  72685. */
  72686. _downscale: ExtractHighlightsPostProcess;
  72687. private _blurX;
  72688. private _blurY;
  72689. private _merge;
  72690. /**
  72691. * The luminance threshold to find bright areas of the image to bloom.
  72692. */
  72693. get threshold(): number;
  72694. set threshold(value: number);
  72695. /**
  72696. * The strength of the bloom.
  72697. */
  72698. get weight(): number;
  72699. set weight(value: number);
  72700. /**
  72701. * Specifies the size of the bloom blur kernel, relative to the final output size
  72702. */
  72703. get kernel(): number;
  72704. set kernel(value: number);
  72705. /**
  72706. * Creates a new instance of @see BloomEffect
  72707. * @param scene The scene the effect belongs to.
  72708. * @param bloomScale The ratio of the blur texture to the input texture that should be used to compute the bloom.
  72709. * @param bloomKernel The size of the kernel to be used when applying the blur.
  72710. * @param bloomWeight The the strength of bloom.
  72711. * @param pipelineTextureType The type of texture to be used when performing the post processing.
  72712. * @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)
  72713. */
  72714. constructor(scene: Scene, bloomScale: number, bloomWeight: number, bloomKernel: number, pipelineTextureType?: number, blockCompilation?: boolean);
  72715. /**
  72716. * Disposes each of the internal effects for a given camera.
  72717. * @param camera The camera to dispose the effect on.
  72718. */
  72719. disposeEffects(camera: Camera): void;
  72720. /**
  72721. * @hidden Internal
  72722. */
  72723. _updateEffects(): void;
  72724. /**
  72725. * Internal
  72726. * @returns if all the contained post processes are ready.
  72727. * @hidden
  72728. */
  72729. _isReady(): boolean;
  72730. }
  72731. }
  72732. declare module "babylonjs/Shaders/chromaticAberration.fragment" {
  72733. /** @hidden */
  72734. export var chromaticAberrationPixelShader: {
  72735. name: string;
  72736. shader: string;
  72737. };
  72738. }
  72739. declare module "babylonjs/PostProcesses/chromaticAberrationPostProcess" {
  72740. import { Vector2 } from "babylonjs/Maths/math.vector";
  72741. import { Nullable } from "babylonjs/types";
  72742. import { PostProcess, PostProcessOptions } from "babylonjs/PostProcesses/postProcess";
  72743. import { Camera } from "babylonjs/Cameras/camera";
  72744. import { Engine } from "babylonjs/Engines/engine";
  72745. import "babylonjs/Shaders/chromaticAberration.fragment";
  72746. import { Scene } from "babylonjs/scene";
  72747. /**
  72748. * The ChromaticAberrationPostProcess separates the rgb channels in an image to produce chromatic distortion around the edges of the screen
  72749. */
  72750. export class ChromaticAberrationPostProcess extends PostProcess {
  72751. /**
  72752. * The amount of seperation of rgb channels (default: 30)
  72753. */
  72754. aberrationAmount: number;
  72755. /**
  72756. * The amount the effect will increase for pixels closer to the edge of the screen. (default: 0)
  72757. */
  72758. radialIntensity: number;
  72759. /**
  72760. * 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))
  72761. */
  72762. direction: Vector2;
  72763. /**
  72764. * 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))
  72765. */
  72766. centerPosition: Vector2;
  72767. /** The width of the screen to apply the effect on */
  72768. screenWidth: number;
  72769. /** The height of the screen to apply the effect on */
  72770. screenHeight: number;
  72771. /**
  72772. * Gets a string identifying the name of the class
  72773. * @returns "ChromaticAberrationPostProcess" string
  72774. */
  72775. getClassName(): string;
  72776. /**
  72777. * Creates a new instance ChromaticAberrationPostProcess
  72778. * @param name The name of the effect.
  72779. * @param screenWidth The width of the screen to apply the effect on.
  72780. * @param screenHeight The height of the screen to apply the effect on.
  72781. * @param options The required width/height ratio to downsize to before computing the render pass.
  72782. * @param camera The camera to apply the render pass to.
  72783. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  72784. * @param engine The engine which the post process will be applied. (default: current engine)
  72785. * @param reusable If the post process can be reused on the same frame. (default: false)
  72786. * @param textureType Type of textures used when performing the post process. (default: 0)
  72787. * @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)
  72788. */
  72789. constructor(name: string, screenWidth: number, screenHeight: number, options: number | PostProcessOptions, camera: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number, blockCompilation?: boolean);
  72790. /** @hidden */
  72791. static _Parse(parsedPostProcess: any, targetCamera: Camera, scene: Scene, rootUrl: string): Nullable<ChromaticAberrationPostProcess>;
  72792. }
  72793. }
  72794. declare module "babylonjs/Shaders/circleOfConfusion.fragment" {
  72795. /** @hidden */
  72796. export var circleOfConfusionPixelShader: {
  72797. name: string;
  72798. shader: string;
  72799. };
  72800. }
  72801. declare module "babylonjs/PostProcesses/circleOfConfusionPostProcess" {
  72802. import { Nullable } from "babylonjs/types";
  72803. import { Engine } from "babylonjs/Engines/engine";
  72804. import { PostProcess, PostProcessOptions } from "babylonjs/PostProcesses/postProcess";
  72805. import { RenderTargetTexture } from "babylonjs/Materials/Textures/renderTargetTexture";
  72806. import { Camera } from "babylonjs/Cameras/camera";
  72807. import "babylonjs/Shaders/circleOfConfusion.fragment";
  72808. /**
  72809. * The CircleOfConfusionPostProcess computes the circle of confusion value for each pixel given required lens parameters. See https://en.wikipedia.org/wiki/Circle_of_confusion
  72810. */
  72811. export class CircleOfConfusionPostProcess extends PostProcess {
  72812. /**
  72813. * 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.
  72814. */
  72815. lensSize: number;
  72816. /**
  72817. * F-Stop of the effect's camera. The diamater of the resulting aperture can be computed by lensSize/fStop. (default: 1.4)
  72818. */
  72819. fStop: number;
  72820. /**
  72821. * Distance away from the camera to focus on in scene units/1000 (eg. millimeter). (default: 2000)
  72822. */
  72823. focusDistance: number;
  72824. /**
  72825. * Focal length of the effect's camera in scene units/1000 (eg. millimeter). (default: 50)
  72826. */
  72827. focalLength: number;
  72828. /**
  72829. * Gets a string identifying the name of the class
  72830. * @returns "CircleOfConfusionPostProcess" string
  72831. */
  72832. getClassName(): string;
  72833. private _depthTexture;
  72834. /**
  72835. * Creates a new instance CircleOfConfusionPostProcess
  72836. * @param name The name of the effect.
  72837. * @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.
  72838. * @param options The required width/height ratio to downsize to before computing the render pass.
  72839. * @param camera The camera to apply the render pass to.
  72840. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  72841. * @param engine The engine which the post process will be applied. (default: current engine)
  72842. * @param reusable If the post process can be reused on the same frame. (default: false)
  72843. * @param textureType Type of textures used when performing the post process. (default: 0)
  72844. * @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)
  72845. */
  72846. constructor(name: string, depthTexture: Nullable<RenderTargetTexture>, options: number | PostProcessOptions, camera: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number, blockCompilation?: boolean);
  72847. /**
  72848. * 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.
  72849. */
  72850. set depthTexture(value: RenderTargetTexture);
  72851. }
  72852. }
  72853. declare module "babylonjs/Shaders/colorCorrection.fragment" {
  72854. /** @hidden */
  72855. export var colorCorrectionPixelShader: {
  72856. name: string;
  72857. shader: string;
  72858. };
  72859. }
  72860. declare module "babylonjs/PostProcesses/colorCorrectionPostProcess" {
  72861. import { PostProcess, PostProcessOptions } from "babylonjs/PostProcesses/postProcess";
  72862. import { Engine } from "babylonjs/Engines/engine";
  72863. import { Camera } from "babylonjs/Cameras/camera";
  72864. import "babylonjs/Shaders/colorCorrection.fragment";
  72865. import { Nullable } from "babylonjs/types";
  72866. import { Scene } from "babylonjs/scene";
  72867. /**
  72868. *
  72869. * This post-process allows the modification of rendered colors by using
  72870. * a 'look-up table' (LUT). This effect is also called Color Grading.
  72871. *
  72872. * The object needs to be provided an url to a texture containing the color
  72873. * look-up table: the texture must be 256 pixels wide and 16 pixels high.
  72874. * Use an image editing software to tweak the LUT to match your needs.
  72875. *
  72876. * For an example of a color LUT, see here:
  72877. * @see http://udn.epicgames.com/Three/rsrc/Three/ColorGrading/RGBTable16x1.png
  72878. * For explanations on color grading, see here:
  72879. * @see http://udn.epicgames.com/Three/ColorGrading.html
  72880. *
  72881. */
  72882. export class ColorCorrectionPostProcess extends PostProcess {
  72883. private _colorTableTexture;
  72884. /**
  72885. * Gets the color table url used to create the LUT texture
  72886. */
  72887. colorTableUrl: string;
  72888. /**
  72889. * Gets a string identifying the name of the class
  72890. * @returns "ColorCorrectionPostProcess" string
  72891. */
  72892. getClassName(): string;
  72893. constructor(name: string, colorTableUrl: string, options: number | PostProcessOptions, camera: Camera, samplingMode?: number, engine?: Engine, reusable?: boolean);
  72894. /** @hidden */
  72895. static _Parse(parsedPostProcess: any, targetCamera: Camera, scene: Scene, rootUrl: string): Nullable<ColorCorrectionPostProcess>;
  72896. }
  72897. }
  72898. declare module "babylonjs/Shaders/convolution.fragment" {
  72899. /** @hidden */
  72900. export var convolutionPixelShader: {
  72901. name: string;
  72902. shader: string;
  72903. };
  72904. }
  72905. declare module "babylonjs/PostProcesses/convolutionPostProcess" {
  72906. import { PostProcess, PostProcessOptions } from "babylonjs/PostProcesses/postProcess";
  72907. import { Nullable } from "babylonjs/types";
  72908. import { Camera } from "babylonjs/Cameras/camera";
  72909. import { Engine } from "babylonjs/Engines/engine";
  72910. import "babylonjs/Shaders/convolution.fragment";
  72911. import { Scene } from "babylonjs/scene";
  72912. /**
  72913. * The ConvolutionPostProcess applies a 3x3 kernel to every pixel of the
  72914. * input texture to perform effects such as edge detection or sharpening
  72915. * See http://en.wikipedia.org/wiki/Kernel_(image_processing)
  72916. */
  72917. export class ConvolutionPostProcess extends PostProcess {
  72918. /** Array of 9 values corresponding to the 3x3 kernel to be applied */
  72919. kernel: number[];
  72920. /**
  72921. * Gets a string identifying the name of the class
  72922. * @returns "ConvolutionPostProcess" string
  72923. */
  72924. getClassName(): string;
  72925. /**
  72926. * Creates a new instance ConvolutionPostProcess
  72927. * @param name The name of the effect.
  72928. * @param kernel Array of 9 values corresponding to the 3x3 kernel to be applied
  72929. * @param options The required width/height ratio to downsize to before computing the render pass.
  72930. * @param camera The camera to apply the render pass to.
  72931. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  72932. * @param engine The engine which the post process will be applied. (default: current engine)
  72933. * @param reusable If the post process can be reused on the same frame. (default: false)
  72934. * @param textureType Type of textures used when performing the post process. (default: 0)
  72935. */
  72936. constructor(name: string, kernel: number[], options: number | PostProcessOptions, camera: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number);
  72937. /** @hidden */
  72938. static _Parse(parsedPostProcess: any, targetCamera: Camera, scene: Scene, rootUrl: string): Nullable<ConvolutionPostProcess>;
  72939. /**
  72940. * Edge detection 0 see https://en.wikipedia.org/wiki/Kernel_(image_processing)
  72941. */
  72942. static EdgeDetect0Kernel: number[];
  72943. /**
  72944. * Edge detection 1 see https://en.wikipedia.org/wiki/Kernel_(image_processing)
  72945. */
  72946. static EdgeDetect1Kernel: number[];
  72947. /**
  72948. * Edge detection 2 see https://en.wikipedia.org/wiki/Kernel_(image_processing)
  72949. */
  72950. static EdgeDetect2Kernel: number[];
  72951. /**
  72952. * Kernel to sharpen an image see https://en.wikipedia.org/wiki/Kernel_(image_processing)
  72953. */
  72954. static SharpenKernel: number[];
  72955. /**
  72956. * Kernel to emboss an image see https://en.wikipedia.org/wiki/Kernel_(image_processing)
  72957. */
  72958. static EmbossKernel: number[];
  72959. /**
  72960. * Kernel to blur an image see https://en.wikipedia.org/wiki/Kernel_(image_processing)
  72961. */
  72962. static GaussianKernel: number[];
  72963. }
  72964. }
  72965. declare module "babylonjs/PostProcesses/depthOfFieldBlurPostProcess" {
  72966. import { Nullable } from "babylonjs/types";
  72967. import { Vector2 } from "babylonjs/Maths/math.vector";
  72968. import { Camera } from "babylonjs/Cameras/camera";
  72969. import { PostProcess, PostProcessOptions } from "babylonjs/PostProcesses/postProcess";
  72970. import { BlurPostProcess } from "babylonjs/PostProcesses/blurPostProcess";
  72971. import { Engine } from "babylonjs/Engines/engine";
  72972. import { Scene } from "babylonjs/scene";
  72973. /**
  72974. * The DepthOfFieldBlurPostProcess applied a blur in a give direction.
  72975. * This blur differs from the standard BlurPostProcess as it attempts to avoid blurring pixels
  72976. * based on samples that have a large difference in distance than the center pixel.
  72977. * See section 2.6.2 http://fileadmin.cs.lth.se/cs/education/edan35/lectures/12dof.pdf
  72978. */
  72979. export class DepthOfFieldBlurPostProcess extends BlurPostProcess {
  72980. /**
  72981. * The direction the blur should be applied
  72982. */
  72983. direction: Vector2;
  72984. /**
  72985. * Gets a string identifying the name of the class
  72986. * @returns "DepthOfFieldBlurPostProcess" string
  72987. */
  72988. getClassName(): string;
  72989. /**
  72990. * Creates a new instance CircleOfConfusionPostProcess
  72991. * @param name The name of the effect.
  72992. * @param scene The scene the effect belongs to.
  72993. * @param direction The direction the blur should be applied.
  72994. * @param kernel The size of the kernel used to blur.
  72995. * @param options The required width/height ratio to downsize to before computing the render pass.
  72996. * @param camera The camera to apply the render pass to.
  72997. * @param circleOfConfusion The circle of confusion + depth map to be used to avoid blurring accross edges
  72998. * @param imageToBlur The image to apply the blur to (default: Current rendered frame)
  72999. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  73000. * @param engine The engine which the post process will be applied. (default: current engine)
  73001. * @param reusable If the post process can be reused on the same frame. (default: false)
  73002. * @param textureType Type of textures used when performing the post process. (default: 0)
  73003. * @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)
  73004. */
  73005. 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);
  73006. }
  73007. }
  73008. declare module "babylonjs/Shaders/depthOfFieldMerge.fragment" {
  73009. /** @hidden */
  73010. export var depthOfFieldMergePixelShader: {
  73011. name: string;
  73012. shader: string;
  73013. };
  73014. }
  73015. declare module "babylonjs/PostProcesses/depthOfFieldMergePostProcess" {
  73016. import { Nullable } from "babylonjs/types";
  73017. import { Camera } from "babylonjs/Cameras/camera";
  73018. import { Effect } from "babylonjs/Materials/effect";
  73019. import { PostProcess, PostProcessOptions } from "babylonjs/PostProcesses/postProcess";
  73020. import { Engine } from "babylonjs/Engines/engine";
  73021. import "babylonjs/Shaders/depthOfFieldMerge.fragment";
  73022. /**
  73023. * Options to be set when merging outputs from the default pipeline.
  73024. */
  73025. export class DepthOfFieldMergePostProcessOptions {
  73026. /**
  73027. * The original image to merge on top of
  73028. */
  73029. originalFromInput: PostProcess;
  73030. /**
  73031. * Parameters to perform the merge of the depth of field effect
  73032. */
  73033. depthOfField?: {
  73034. circleOfConfusion: PostProcess;
  73035. blurSteps: Array<PostProcess>;
  73036. };
  73037. /**
  73038. * Parameters to perform the merge of bloom effect
  73039. */
  73040. bloom?: {
  73041. blurred: PostProcess;
  73042. weight: number;
  73043. };
  73044. }
  73045. /**
  73046. * The DepthOfFieldMergePostProcess merges blurred images with the original based on the values of the circle of confusion.
  73047. */
  73048. export class DepthOfFieldMergePostProcess extends PostProcess {
  73049. private blurSteps;
  73050. /**
  73051. * Gets a string identifying the name of the class
  73052. * @returns "DepthOfFieldMergePostProcess" string
  73053. */
  73054. getClassName(): string;
  73055. /**
  73056. * Creates a new instance of DepthOfFieldMergePostProcess
  73057. * @param name The name of the effect.
  73058. * @param originalFromInput Post process which's input will be used for the merge.
  73059. * @param circleOfConfusion Circle of confusion post process which's output will be used to blur each pixel.
  73060. * @param blurSteps Blur post processes from low to high which will be mixed with the original image.
  73061. * @param options The required width/height ratio to downsize to before computing the render pass.
  73062. * @param camera The camera to apply the render pass to.
  73063. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  73064. * @param engine The engine which the post process will be applied. (default: current engine)
  73065. * @param reusable If the post process can be reused on the same frame. (default: false)
  73066. * @param textureType Type of textures used when performing the post process. (default: 0)
  73067. * @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)
  73068. */
  73069. 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);
  73070. /**
  73071. * Updates the effect with the current post process compile time values and recompiles the shader.
  73072. * @param defines Define statements that should be added at the beginning of the shader. (default: null)
  73073. * @param uniforms Set of uniform variables that will be passed to the shader. (default: null)
  73074. * @param samplers Set of Texture2D variables that will be passed to the shader. (default: null)
  73075. * @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
  73076. * @param onCompiled Called when the shader has been compiled.
  73077. * @param onError Called if there is an error when compiling a shader.
  73078. */
  73079. updateEffect(defines?: Nullable<string>, uniforms?: Nullable<string[]>, samplers?: Nullable<string[]>, indexParameters?: any, onCompiled?: (effect: Effect) => void, onError?: (effect: Effect, errors: string) => void): void;
  73080. }
  73081. }
  73082. declare module "babylonjs/PostProcesses/depthOfFieldEffect" {
  73083. import { Nullable } from "babylonjs/types";
  73084. import { Camera } from "babylonjs/Cameras/camera";
  73085. import { RenderTargetTexture } from "babylonjs/Materials/Textures/renderTargetTexture";
  73086. import { PostProcess } from "babylonjs/PostProcesses/postProcess";
  73087. import { PostProcessRenderEffect } from "babylonjs/PostProcesses/RenderPipeline/postProcessRenderEffect";
  73088. import { DepthOfFieldBlurPostProcess } from "babylonjs/PostProcesses/depthOfFieldBlurPostProcess";
  73089. import { Scene } from "babylonjs/scene";
  73090. /**
  73091. * Specifies the level of max blur that should be applied when using the depth of field effect
  73092. */
  73093. export enum DepthOfFieldEffectBlurLevel {
  73094. /**
  73095. * Subtle blur
  73096. */
  73097. Low = 0,
  73098. /**
  73099. * Medium blur
  73100. */
  73101. Medium = 1,
  73102. /**
  73103. * Large blur
  73104. */
  73105. High = 2
  73106. }
  73107. /**
  73108. * The depth of field effect applies a blur to objects that are closer or further from where the camera is focusing.
  73109. */
  73110. export class DepthOfFieldEffect extends PostProcessRenderEffect {
  73111. private _circleOfConfusion;
  73112. /**
  73113. * @hidden Internal, blurs from high to low
  73114. */
  73115. _depthOfFieldBlurX: Array<DepthOfFieldBlurPostProcess>;
  73116. private _depthOfFieldBlurY;
  73117. private _dofMerge;
  73118. /**
  73119. * @hidden Internal post processes in depth of field effect
  73120. */
  73121. _effects: Array<PostProcess>;
  73122. /**
  73123. * The focal the length of the camera used in the effect in scene units/1000 (eg. millimeter)
  73124. */
  73125. set focalLength(value: number);
  73126. get focalLength(): number;
  73127. /**
  73128. * F-Stop of the effect's camera. The diameter of the resulting aperture can be computed by lensSize/fStop. (default: 1.4)
  73129. */
  73130. set fStop(value: number);
  73131. get fStop(): number;
  73132. /**
  73133. * Distance away from the camera to focus on in scene units/1000 (eg. millimeter). (default: 2000)
  73134. */
  73135. set focusDistance(value: number);
  73136. get focusDistance(): number;
  73137. /**
  73138. * 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.
  73139. */
  73140. set lensSize(value: number);
  73141. get lensSize(): number;
  73142. /**
  73143. * Creates a new instance DepthOfFieldEffect
  73144. * @param scene The scene the effect belongs to.
  73145. * @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.
  73146. * @param pipelineTextureType The type of texture to be used when performing the post processing.
  73147. * @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)
  73148. */
  73149. constructor(scene: Scene, depthTexture: Nullable<RenderTargetTexture>, blurLevel?: DepthOfFieldEffectBlurLevel, pipelineTextureType?: number, blockCompilation?: boolean);
  73150. /**
  73151. * Get the current class name of the current effet
  73152. * @returns "DepthOfFieldEffect"
  73153. */
  73154. getClassName(): string;
  73155. /**
  73156. * 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.
  73157. */
  73158. set depthTexture(value: RenderTargetTexture);
  73159. /**
  73160. * Disposes each of the internal effects for a given camera.
  73161. * @param camera The camera to dispose the effect on.
  73162. */
  73163. disposeEffects(camera: Camera): void;
  73164. /**
  73165. * @hidden Internal
  73166. */
  73167. _updateEffects(): void;
  73168. /**
  73169. * Internal
  73170. * @returns if all the contained post processes are ready.
  73171. * @hidden
  73172. */
  73173. _isReady(): boolean;
  73174. }
  73175. }
  73176. declare module "babylonjs/Shaders/displayPass.fragment" {
  73177. /** @hidden */
  73178. export var displayPassPixelShader: {
  73179. name: string;
  73180. shader: string;
  73181. };
  73182. }
  73183. declare module "babylonjs/PostProcesses/displayPassPostProcess" {
  73184. import { Nullable } from "babylonjs/types";
  73185. import { Camera } from "babylonjs/Cameras/camera";
  73186. import { PostProcess, PostProcessOptions } from "babylonjs/PostProcesses/postProcess";
  73187. import { Engine } from "babylonjs/Engines/engine";
  73188. import "babylonjs/Shaders/displayPass.fragment";
  73189. import { Scene } from "babylonjs/scene";
  73190. /**
  73191. * DisplayPassPostProcess which produces an output the same as it's input
  73192. */
  73193. export class DisplayPassPostProcess extends PostProcess {
  73194. /**
  73195. * Gets a string identifying the name of the class
  73196. * @returns "DisplayPassPostProcess" string
  73197. */
  73198. getClassName(): string;
  73199. /**
  73200. * Creates the DisplayPassPostProcess
  73201. * @param name The name of the effect.
  73202. * @param options The required width/height ratio to downsize to before computing the render pass.
  73203. * @param camera The camera to apply the render pass to.
  73204. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  73205. * @param engine The engine which the post process will be applied. (default: current engine)
  73206. * @param reusable If the post process can be reused on the same frame. (default: false)
  73207. */
  73208. constructor(name: string, options: number | PostProcessOptions, camera: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean);
  73209. /** @hidden */
  73210. static _Parse(parsedPostProcess: any, targetCamera: Camera, scene: Scene, rootUrl: string): Nullable<DisplayPassPostProcess>;
  73211. }
  73212. }
  73213. declare module "babylonjs/Shaders/filter.fragment" {
  73214. /** @hidden */
  73215. export var filterPixelShader: {
  73216. name: string;
  73217. shader: string;
  73218. };
  73219. }
  73220. declare module "babylonjs/PostProcesses/filterPostProcess" {
  73221. import { Nullable } from "babylonjs/types";
  73222. import { Matrix } from "babylonjs/Maths/math.vector";
  73223. import { Camera } from "babylonjs/Cameras/camera";
  73224. import { PostProcess, PostProcessOptions } from "babylonjs/PostProcesses/postProcess";
  73225. import { Engine } from "babylonjs/Engines/engine";
  73226. import "babylonjs/Shaders/filter.fragment";
  73227. import { Scene } from "babylonjs/scene";
  73228. /**
  73229. * Applies a kernel filter to the image
  73230. */
  73231. export class FilterPostProcess extends PostProcess {
  73232. /** The matrix to be applied to the image */
  73233. kernelMatrix: Matrix;
  73234. /**
  73235. * Gets a string identifying the name of the class
  73236. * @returns "FilterPostProcess" string
  73237. */
  73238. getClassName(): string;
  73239. /**
  73240. *
  73241. * @param name The name of the effect.
  73242. * @param kernelMatrix The matrix to be applied to the image
  73243. * @param options The required width/height ratio to downsize to before computing the render pass.
  73244. * @param camera The camera to apply the render pass to.
  73245. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  73246. * @param engine The engine which the post process will be applied. (default: current engine)
  73247. * @param reusable If the post process can be reused on the same frame. (default: false)
  73248. */
  73249. constructor(name: string, kernelMatrix: Matrix, options: number | PostProcessOptions, camera: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean);
  73250. /** @hidden */
  73251. static _Parse(parsedPostProcess: any, targetCamera: Camera, scene: Scene, rootUrl: string): Nullable<FilterPostProcess>;
  73252. }
  73253. }
  73254. declare module "babylonjs/Shaders/fxaa.fragment" {
  73255. /** @hidden */
  73256. export var fxaaPixelShader: {
  73257. name: string;
  73258. shader: string;
  73259. };
  73260. }
  73261. declare module "babylonjs/Shaders/fxaa.vertex" {
  73262. /** @hidden */
  73263. export var fxaaVertexShader: {
  73264. name: string;
  73265. shader: string;
  73266. };
  73267. }
  73268. declare module "babylonjs/PostProcesses/fxaaPostProcess" {
  73269. import { Nullable } from "babylonjs/types";
  73270. import { Camera } from "babylonjs/Cameras/camera";
  73271. import { PostProcess, PostProcessOptions } from "babylonjs/PostProcesses/postProcess";
  73272. import { Engine } from "babylonjs/Engines/engine";
  73273. import "babylonjs/Shaders/fxaa.fragment";
  73274. import "babylonjs/Shaders/fxaa.vertex";
  73275. import { Scene } from "babylonjs/scene";
  73276. /**
  73277. * Fxaa post process
  73278. * @see https://doc.babylonjs.com/how_to/how_to_use_postprocesses#fxaa
  73279. */
  73280. export class FxaaPostProcess extends PostProcess {
  73281. /**
  73282. * Gets a string identifying the name of the class
  73283. * @returns "FxaaPostProcess" string
  73284. */
  73285. getClassName(): string;
  73286. constructor(name: string, options: number | PostProcessOptions, camera?: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number);
  73287. private _getDefines;
  73288. /** @hidden */
  73289. static _Parse(parsedPostProcess: any, targetCamera: Camera, scene: Scene, rootUrl: string): FxaaPostProcess;
  73290. }
  73291. }
  73292. declare module "babylonjs/Shaders/grain.fragment" {
  73293. import "babylonjs/Shaders/ShadersInclude/helperFunctions";
  73294. /** @hidden */
  73295. export var grainPixelShader: {
  73296. name: string;
  73297. shader: string;
  73298. };
  73299. }
  73300. declare module "babylonjs/PostProcesses/grainPostProcess" {
  73301. import { Nullable } from "babylonjs/types";
  73302. import { Camera } from "babylonjs/Cameras/camera";
  73303. import { PostProcess, PostProcessOptions } from "babylonjs/PostProcesses/postProcess";
  73304. import { Engine } from "babylonjs/Engines/engine";
  73305. import "babylonjs/Shaders/grain.fragment";
  73306. import { Scene } from "babylonjs/scene";
  73307. /**
  73308. * The GrainPostProcess adds noise to the image at mid luminance levels
  73309. */
  73310. export class GrainPostProcess extends PostProcess {
  73311. /**
  73312. * The intensity of the grain added (default: 30)
  73313. */
  73314. intensity: number;
  73315. /**
  73316. * If the grain should be randomized on every frame
  73317. */
  73318. animated: boolean;
  73319. /**
  73320. * Gets a string identifying the name of the class
  73321. * @returns "GrainPostProcess" string
  73322. */
  73323. getClassName(): string;
  73324. /**
  73325. * Creates a new instance of @see GrainPostProcess
  73326. * @param name The name of the effect.
  73327. * @param options The required width/height ratio to downsize to before computing the render pass.
  73328. * @param camera The camera to apply the render pass to.
  73329. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  73330. * @param engine The engine which the post process will be applied. (default: current engine)
  73331. * @param reusable If the post process can be reused on the same frame. (default: false)
  73332. * @param textureType Type of textures used when performing the post process. (default: 0)
  73333. * @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)
  73334. */
  73335. constructor(name: string, options: number | PostProcessOptions, camera: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number, blockCompilation?: boolean);
  73336. /** @hidden */
  73337. static _Parse(parsedPostProcess: any, targetCamera: Camera, scene: Scene, rootUrl: string): GrainPostProcess;
  73338. }
  73339. }
  73340. declare module "babylonjs/Shaders/highlights.fragment" {
  73341. /** @hidden */
  73342. export var highlightsPixelShader: {
  73343. name: string;
  73344. shader: string;
  73345. };
  73346. }
  73347. declare module "babylonjs/PostProcesses/highlightsPostProcess" {
  73348. import { Nullable } from "babylonjs/types";
  73349. import { Camera } from "babylonjs/Cameras/camera";
  73350. import { PostProcess, PostProcessOptions } from "babylonjs/PostProcesses/postProcess";
  73351. import { Engine } from "babylonjs/Engines/engine";
  73352. import "babylonjs/Shaders/highlights.fragment";
  73353. /**
  73354. * Extracts highlights from the image
  73355. * @see https://doc.babylonjs.com/how_to/how_to_use_postprocesses
  73356. */
  73357. export class HighlightsPostProcess extends PostProcess {
  73358. /**
  73359. * Gets a string identifying the name of the class
  73360. * @returns "HighlightsPostProcess" string
  73361. */
  73362. getClassName(): string;
  73363. /**
  73364. * Extracts highlights from the image
  73365. * @see https://doc.babylonjs.com/how_to/how_to_use_postprocesses
  73366. * @param name The name of the effect.
  73367. * @param options The required width/height ratio to downsize to before computing the render pass.
  73368. * @param camera The camera to apply the render pass to.
  73369. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  73370. * @param engine The engine which the post process will be applied. (default: current engine)
  73371. * @param reusable If the post process can be reused on the same frame. (default: false)
  73372. * @param textureType Type of texture for the post process (default: Engine.TEXTURETYPE_UNSIGNED_INT)
  73373. */
  73374. constructor(name: string, options: number | PostProcessOptions, camera: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number);
  73375. }
  73376. }
  73377. declare module "babylonjs/Shaders/ShadersInclude/mrtFragmentDeclaration" {
  73378. /** @hidden */
  73379. export var mrtFragmentDeclaration: {
  73380. name: string;
  73381. shader: string;
  73382. };
  73383. }
  73384. declare module "babylonjs/Shaders/geometry.fragment" {
  73385. import "babylonjs/Shaders/ShadersInclude/mrtFragmentDeclaration";
  73386. import "babylonjs/Shaders/ShadersInclude/bumpFragmentMainFunctions";
  73387. import "babylonjs/Shaders/ShadersInclude/bumpFragmentFunctions";
  73388. import "babylonjs/Shaders/ShadersInclude/bumpFragment";
  73389. /** @hidden */
  73390. export var geometryPixelShader: {
  73391. name: string;
  73392. shader: string;
  73393. };
  73394. }
  73395. declare module "babylonjs/Shaders/geometry.vertex" {
  73396. import "babylonjs/Shaders/ShadersInclude/bonesDeclaration";
  73397. import "babylonjs/Shaders/ShadersInclude/morphTargetsVertexGlobalDeclaration";
  73398. import "babylonjs/Shaders/ShadersInclude/morphTargetsVertexDeclaration";
  73399. import "babylonjs/Shaders/ShadersInclude/instancesDeclaration";
  73400. import "babylonjs/Shaders/ShadersInclude/morphTargetsVertex";
  73401. import "babylonjs/Shaders/ShadersInclude/instancesVertex";
  73402. import "babylonjs/Shaders/ShadersInclude/bonesVertex";
  73403. import "babylonjs/Shaders/ShadersInclude/bumpVertex";
  73404. /** @hidden */
  73405. export var geometryVertexShader: {
  73406. name: string;
  73407. shader: string;
  73408. };
  73409. }
  73410. declare module "babylonjs/Rendering/geometryBufferRenderer" {
  73411. import { Matrix } from "babylonjs/Maths/math.vector";
  73412. import { SubMesh } from "babylonjs/Meshes/subMesh";
  73413. import { Mesh } from "babylonjs/Meshes/mesh";
  73414. import { MultiRenderTarget } from "babylonjs/Materials/Textures/multiRenderTarget";
  73415. import { Effect } from "babylonjs/Materials/effect";
  73416. import { Scene } from "babylonjs/scene";
  73417. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  73418. import "babylonjs/Shaders/geometry.fragment";
  73419. import "babylonjs/Shaders/geometry.vertex";
  73420. /** @hidden */
  73421. interface ISavedTransformationMatrix {
  73422. world: Matrix;
  73423. viewProjection: Matrix;
  73424. }
  73425. /**
  73426. * This renderer is helpfull to fill one of the render target with a geometry buffer.
  73427. */
  73428. export class GeometryBufferRenderer {
  73429. /**
  73430. * Constant used to retrieve the position texture index in the G-Buffer textures array
  73431. * using getIndex(GeometryBufferRenderer.POSITION_TEXTURE_INDEX)
  73432. */
  73433. static readonly POSITION_TEXTURE_TYPE: number;
  73434. /**
  73435. * Constant used to retrieve the velocity texture index in the G-Buffer textures array
  73436. * using getIndex(GeometryBufferRenderer.VELOCITY_TEXTURE_INDEX)
  73437. */
  73438. static readonly VELOCITY_TEXTURE_TYPE: number;
  73439. /**
  73440. * Constant used to retrieve the reflectivity texture index in the G-Buffer textures array
  73441. * using the getIndex(GeometryBufferRenderer.REFLECTIVITY_TEXTURE_TYPE)
  73442. */
  73443. static readonly REFLECTIVITY_TEXTURE_TYPE: number;
  73444. /**
  73445. * Dictionary used to store the previous transformation matrices of each rendered mesh
  73446. * in order to compute objects velocities when enableVelocity is set to "true"
  73447. * @hidden
  73448. */
  73449. _previousTransformationMatrices: {
  73450. [index: number]: ISavedTransformationMatrix;
  73451. };
  73452. /**
  73453. * Dictionary used to store the previous bones transformation matrices of each rendered mesh
  73454. * in order to compute objects velocities when enableVelocity is set to "true"
  73455. * @hidden
  73456. */
  73457. _previousBonesTransformationMatrices: {
  73458. [index: number]: Float32Array;
  73459. };
  73460. /**
  73461. * Array used to store the ignored skinned meshes while computing velocity map (typically used by the motion blur post-process).
  73462. * Avoids computing bones velocities and computes only mesh's velocity itself (position, rotation, scaling).
  73463. */
  73464. excludedSkinnedMeshesFromVelocity: AbstractMesh[];
  73465. /** Gets or sets a boolean indicating if transparent meshes should be rendered */
  73466. renderTransparentMeshes: boolean;
  73467. private _scene;
  73468. private _resizeObserver;
  73469. private _multiRenderTarget;
  73470. private _ratio;
  73471. private _enablePosition;
  73472. private _enableVelocity;
  73473. private _enableReflectivity;
  73474. private _positionIndex;
  73475. private _velocityIndex;
  73476. private _reflectivityIndex;
  73477. protected _effect: Effect;
  73478. protected _cachedDefines: string;
  73479. /**
  73480. * Set the render list (meshes to be rendered) used in the G buffer.
  73481. */
  73482. set renderList(meshes: Mesh[]);
  73483. /**
  73484. * Gets wether or not G buffer are supported by the running hardware.
  73485. * This requires draw buffer supports
  73486. */
  73487. get isSupported(): boolean;
  73488. /**
  73489. * Returns the index of the given texture type in the G-Buffer textures array
  73490. * @param textureType The texture type constant. For example GeometryBufferRenderer.POSITION_TEXTURE_INDEX
  73491. * @returns the index of the given texture type in the G-Buffer textures array
  73492. */
  73493. getTextureIndex(textureType: number): number;
  73494. /**
  73495. * Gets a boolean indicating if objects positions are enabled for the G buffer.
  73496. */
  73497. get enablePosition(): boolean;
  73498. /**
  73499. * Sets whether or not objects positions are enabled for the G buffer.
  73500. */
  73501. set enablePosition(enable: boolean);
  73502. /**
  73503. * Gets a boolean indicating if objects velocities are enabled for the G buffer.
  73504. */
  73505. get enableVelocity(): boolean;
  73506. /**
  73507. * Sets wether or not objects velocities are enabled for the G buffer.
  73508. */
  73509. set enableVelocity(enable: boolean);
  73510. /**
  73511. * Gets a boolean indicating if objects roughness are enabled in the G buffer.
  73512. */
  73513. get enableReflectivity(): boolean;
  73514. /**
  73515. * Sets wether or not objects roughness are enabled for the G buffer.
  73516. */
  73517. set enableReflectivity(enable: boolean);
  73518. /**
  73519. * Gets the scene associated with the buffer.
  73520. */
  73521. get scene(): Scene;
  73522. /**
  73523. * Gets the ratio used by the buffer during its creation.
  73524. * How big is the buffer related to the main canvas.
  73525. */
  73526. get ratio(): number;
  73527. /** @hidden */
  73528. static _SceneComponentInitialization: (scene: Scene) => void;
  73529. /**
  73530. * Creates a new G Buffer for the scene
  73531. * @param scene The scene the buffer belongs to
  73532. * @param ratio How big is the buffer related to the main canvas.
  73533. */
  73534. constructor(scene: Scene, ratio?: number);
  73535. /**
  73536. * Checks wether everything is ready to render a submesh to the G buffer.
  73537. * @param subMesh the submesh to check readiness for
  73538. * @param useInstances is the mesh drawn using instance or not
  73539. * @returns true if ready otherwise false
  73540. */
  73541. isReady(subMesh: SubMesh, useInstances: boolean): boolean;
  73542. /**
  73543. * Gets the current underlying G Buffer.
  73544. * @returns the buffer
  73545. */
  73546. getGBuffer(): MultiRenderTarget;
  73547. /**
  73548. * Gets the number of samples used to render the buffer (anti aliasing).
  73549. */
  73550. get samples(): number;
  73551. /**
  73552. * Sets the number of samples used to render the buffer (anti aliasing).
  73553. */
  73554. set samples(value: number);
  73555. /**
  73556. * Disposes the renderer and frees up associated resources.
  73557. */
  73558. dispose(): void;
  73559. protected _createRenderTargets(): void;
  73560. private _copyBonesTransformationMatrices;
  73561. }
  73562. }
  73563. declare module "babylonjs/Rendering/geometryBufferRendererSceneComponent" {
  73564. import { Nullable } from "babylonjs/types";
  73565. import { Scene } from "babylonjs/scene";
  73566. import { ISceneComponent } from "babylonjs/sceneComponent";
  73567. import { GeometryBufferRenderer } from "babylonjs/Rendering/geometryBufferRenderer";
  73568. module "babylonjs/scene" {
  73569. interface Scene {
  73570. /** @hidden (Backing field) */
  73571. _geometryBufferRenderer: Nullable<GeometryBufferRenderer>;
  73572. /**
  73573. * Gets or Sets the current geometry buffer associated to the scene.
  73574. */
  73575. geometryBufferRenderer: Nullable<GeometryBufferRenderer>;
  73576. /**
  73577. * Enables a GeometryBufferRender and associates it with the scene
  73578. * @param ratio defines the scaling ratio to apply to the renderer (1 by default which means same resolution)
  73579. * @returns the GeometryBufferRenderer
  73580. */
  73581. enableGeometryBufferRenderer(ratio?: number): Nullable<GeometryBufferRenderer>;
  73582. /**
  73583. * Disables the GeometryBufferRender associated with the scene
  73584. */
  73585. disableGeometryBufferRenderer(): void;
  73586. }
  73587. }
  73588. /**
  73589. * Defines the Geometry Buffer scene component responsible to manage a G-Buffer useful
  73590. * in several rendering techniques.
  73591. */
  73592. export class GeometryBufferRendererSceneComponent implements ISceneComponent {
  73593. /**
  73594. * The component name helpful to identify the component in the list of scene components.
  73595. */
  73596. readonly name: string;
  73597. /**
  73598. * The scene the component belongs to.
  73599. */
  73600. scene: Scene;
  73601. /**
  73602. * Creates a new instance of the component for the given scene
  73603. * @param scene Defines the scene to register the component in
  73604. */
  73605. constructor(scene: Scene);
  73606. /**
  73607. * Registers the component in a given scene
  73608. */
  73609. register(): void;
  73610. /**
  73611. * Rebuilds the elements related to this component in case of
  73612. * context lost for instance.
  73613. */
  73614. rebuild(): void;
  73615. /**
  73616. * Disposes the component and the associated ressources
  73617. */
  73618. dispose(): void;
  73619. private _gatherRenderTargets;
  73620. }
  73621. }
  73622. declare module "babylonjs/Shaders/motionBlur.fragment" {
  73623. /** @hidden */
  73624. export var motionBlurPixelShader: {
  73625. name: string;
  73626. shader: string;
  73627. };
  73628. }
  73629. declare module "babylonjs/PostProcesses/motionBlurPostProcess" {
  73630. import { Nullable } from "babylonjs/types";
  73631. import { Camera } from "babylonjs/Cameras/camera";
  73632. import { PostProcess, PostProcessOptions } from "babylonjs/PostProcesses/postProcess";
  73633. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  73634. import "babylonjs/Animations/animatable";
  73635. import "babylonjs/Rendering/geometryBufferRendererSceneComponent";
  73636. import "babylonjs/Shaders/motionBlur.fragment";
  73637. import { Engine } from "babylonjs/Engines/engine";
  73638. import { Scene } from "babylonjs/scene";
  73639. /**
  73640. * The Motion Blur Post Process which blurs an image based on the objects velocity in scene.
  73641. * Velocity can be affected by each object's rotation, position and scale depending on the transformation speed.
  73642. * As an example, all you have to do is to create the post-process:
  73643. * var mb = new BABYLON.MotionBlurPostProcess(
  73644. * 'mb', // The name of the effect.
  73645. * scene, // The scene containing the objects to blur according to their velocity.
  73646. * 1.0, // The required width/height ratio to downsize to before computing the render pass.
  73647. * camera // The camera to apply the render pass to.
  73648. * );
  73649. * Then, all objects moving, rotating and/or scaling will be blurred depending on the transformation speed.
  73650. */
  73651. export class MotionBlurPostProcess extends PostProcess {
  73652. /**
  73653. * Defines how much the image is blurred by the movement. Default value is equal to 1
  73654. */
  73655. motionStrength: number;
  73656. /**
  73657. * Gets the number of iterations are used for motion blur quality. Default value is equal to 32
  73658. */
  73659. get motionBlurSamples(): number;
  73660. /**
  73661. * Sets the number of iterations to be used for motion blur quality
  73662. */
  73663. set motionBlurSamples(samples: number);
  73664. private _motionBlurSamples;
  73665. private _geometryBufferRenderer;
  73666. /**
  73667. * Gets a string identifying the name of the class
  73668. * @returns "MotionBlurPostProcess" string
  73669. */
  73670. getClassName(): string;
  73671. /**
  73672. * Creates a new instance MotionBlurPostProcess
  73673. * @param name The name of the effect.
  73674. * @param scene The scene containing the objects to blur according to their velocity.
  73675. * @param options The required width/height ratio to downsize to before computing the render pass.
  73676. * @param camera The camera to apply the render pass to.
  73677. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  73678. * @param engine The engine which the post process will be applied. (default: current engine)
  73679. * @param reusable If the post process can be reused on the same frame. (default: false)
  73680. * @param textureType Type of textures used when performing the post process. (default: 0)
  73681. * @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)
  73682. */
  73683. constructor(name: string, scene: Scene, options: number | PostProcessOptions, camera: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number, blockCompilation?: boolean);
  73684. /**
  73685. * Excludes the given skinned mesh from computing bones velocities.
  73686. * 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.
  73687. * @param skinnedMesh The mesh containing the skeleton to ignore when computing the velocity map.
  73688. */
  73689. excludeSkinnedMesh(skinnedMesh: AbstractMesh): void;
  73690. /**
  73691. * Removes the given skinned mesh from the excluded meshes to integrate bones velocities while rendering the velocity map.
  73692. * @param skinnedMesh The mesh containing the skeleton that has been ignored previously.
  73693. * @see excludeSkinnedMesh to exclude a skinned mesh from bones velocity computation.
  73694. */
  73695. removeExcludedSkinnedMesh(skinnedMesh: AbstractMesh): void;
  73696. /**
  73697. * Disposes the post process.
  73698. * @param camera The camera to dispose the post process on.
  73699. */
  73700. dispose(camera?: Camera): void;
  73701. /** @hidden */
  73702. static _Parse(parsedPostProcess: any, targetCamera: Camera, scene: Scene, rootUrl: string): Nullable<MotionBlurPostProcess>;
  73703. }
  73704. }
  73705. declare module "babylonjs/Shaders/refraction.fragment" {
  73706. /** @hidden */
  73707. export var refractionPixelShader: {
  73708. name: string;
  73709. shader: string;
  73710. };
  73711. }
  73712. declare module "babylonjs/PostProcesses/refractionPostProcess" {
  73713. import { Color3 } from "babylonjs/Maths/math.color";
  73714. import { Camera } from "babylonjs/Cameras/camera";
  73715. import { Texture } from "babylonjs/Materials/Textures/texture";
  73716. import { PostProcess, PostProcessOptions } from "babylonjs/PostProcesses/postProcess";
  73717. import { Engine } from "babylonjs/Engines/engine";
  73718. import "babylonjs/Shaders/refraction.fragment";
  73719. import { Scene } from "babylonjs/scene";
  73720. /**
  73721. * Post process which applies a refractin texture
  73722. * @see https://doc.babylonjs.com/how_to/how_to_use_postprocesses#refraction
  73723. */
  73724. export class RefractionPostProcess extends PostProcess {
  73725. private _refTexture;
  73726. private _ownRefractionTexture;
  73727. /** the base color of the refraction (used to taint the rendering) */
  73728. color: Color3;
  73729. /** simulated refraction depth */
  73730. depth: number;
  73731. /** the coefficient of the base color (0 to remove base color tainting) */
  73732. colorLevel: number;
  73733. /** Gets the url used to load the refraction texture */
  73734. refractionTextureUrl: string;
  73735. /**
  73736. * Gets or sets the refraction texture
  73737. * Please note that you are responsible for disposing the texture if you set it manually
  73738. */
  73739. get refractionTexture(): Texture;
  73740. set refractionTexture(value: Texture);
  73741. /**
  73742. * Gets a string identifying the name of the class
  73743. * @returns "RefractionPostProcess" string
  73744. */
  73745. getClassName(): string;
  73746. /**
  73747. * Initializes the RefractionPostProcess
  73748. * @see https://doc.babylonjs.com/how_to/how_to_use_postprocesses#refraction
  73749. * @param name The name of the effect.
  73750. * @param refractionTextureUrl Url of the refraction texture to use
  73751. * @param color the base color of the refraction (used to taint the rendering)
  73752. * @param depth simulated refraction depth
  73753. * @param colorLevel the coefficient of the base color (0 to remove base color tainting)
  73754. * @param camera The camera to apply the render pass to.
  73755. * @param options The required width/height ratio to downsize to before computing the render pass.
  73756. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  73757. * @param engine The engine which the post process will be applied. (default: current engine)
  73758. * @param reusable If the post process can be reused on the same frame. (default: false)
  73759. */
  73760. constructor(name: string, refractionTextureUrl: string, color: Color3, depth: number, colorLevel: number, options: number | PostProcessOptions, camera: Camera, samplingMode?: number, engine?: Engine, reusable?: boolean);
  73761. /**
  73762. * Disposes of the post process
  73763. * @param camera Camera to dispose post process on
  73764. */
  73765. dispose(camera: Camera): void;
  73766. /** @hidden */
  73767. static _Parse(parsedPostProcess: any, targetCamera: Camera, scene: Scene, rootUrl: string): RefractionPostProcess;
  73768. }
  73769. }
  73770. declare module "babylonjs/Shaders/sharpen.fragment" {
  73771. /** @hidden */
  73772. export var sharpenPixelShader: {
  73773. name: string;
  73774. shader: string;
  73775. };
  73776. }
  73777. declare module "babylonjs/PostProcesses/sharpenPostProcess" {
  73778. import { Nullable } from "babylonjs/types";
  73779. import { Camera } from "babylonjs/Cameras/camera";
  73780. import { PostProcess, PostProcessOptions } from "babylonjs/PostProcesses/postProcess";
  73781. import "babylonjs/Shaders/sharpen.fragment";
  73782. import { Engine } from "babylonjs/Engines/engine";
  73783. import { Scene } from "babylonjs/scene";
  73784. /**
  73785. * The SharpenPostProcess applies a sharpen kernel to every pixel
  73786. * See http://en.wikipedia.org/wiki/Kernel_(image_processing)
  73787. */
  73788. export class SharpenPostProcess extends PostProcess {
  73789. /**
  73790. * How much of the original color should be applied. Setting this to 0 will display edge detection. (default: 1)
  73791. */
  73792. colorAmount: number;
  73793. /**
  73794. * How much sharpness should be applied (default: 0.3)
  73795. */
  73796. edgeAmount: number;
  73797. /**
  73798. * Gets a string identifying the name of the class
  73799. * @returns "SharpenPostProcess" string
  73800. */
  73801. getClassName(): string;
  73802. /**
  73803. * Creates a new instance ConvolutionPostProcess
  73804. * @param name The name of the effect.
  73805. * @param options The required width/height ratio to downsize to before computing the render pass.
  73806. * @param camera The camera to apply the render pass to.
  73807. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  73808. * @param engine The engine which the post process will be applied. (default: current engine)
  73809. * @param reusable If the post process can be reused on the same frame. (default: false)
  73810. * @param textureType Type of textures used when performing the post process. (default: 0)
  73811. * @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)
  73812. */
  73813. constructor(name: string, options: number | PostProcessOptions, camera: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number, blockCompilation?: boolean);
  73814. /** @hidden */
  73815. static _Parse(parsedPostProcess: any, targetCamera: Camera, scene: Scene, rootUrl: string): SharpenPostProcess;
  73816. }
  73817. }
  73818. declare module "babylonjs/PostProcesses/RenderPipeline/postProcessRenderPipeline" {
  73819. import { Nullable } from "babylonjs/types";
  73820. import { Camera } from "babylonjs/Cameras/camera";
  73821. import { Engine } from "babylonjs/Engines/engine";
  73822. import { PostProcessRenderEffect } from "babylonjs/PostProcesses/RenderPipeline/postProcessRenderEffect";
  73823. import { IInspectable } from "babylonjs/Misc/iInspectable";
  73824. import { PrePassRenderer } from "babylonjs/Rendering/prePassRenderer";
  73825. /**
  73826. * PostProcessRenderPipeline
  73827. * @see https://doc.babylonjs.com/how_to/how_to_use_postprocessrenderpipeline
  73828. */
  73829. export class PostProcessRenderPipeline {
  73830. private engine;
  73831. private _renderEffects;
  73832. private _renderEffectsForIsolatedPass;
  73833. /**
  73834. * List of inspectable custom properties (used by the Inspector)
  73835. * @see https://doc.babylonjs.com/how_to/debug_layer#extensibility
  73836. */
  73837. inspectableCustomProperties: IInspectable[];
  73838. /**
  73839. * @hidden
  73840. */
  73841. protected _cameras: Camera[];
  73842. /** @hidden */
  73843. _name: string;
  73844. /**
  73845. * Gets pipeline name
  73846. */
  73847. get name(): string;
  73848. /** Gets the list of attached cameras */
  73849. get cameras(): Camera[];
  73850. /**
  73851. * Initializes a PostProcessRenderPipeline
  73852. * @param engine engine to add the pipeline to
  73853. * @param name name of the pipeline
  73854. */
  73855. constructor(engine: Engine, name: string);
  73856. /**
  73857. * Gets the class name
  73858. * @returns "PostProcessRenderPipeline"
  73859. */
  73860. getClassName(): string;
  73861. /**
  73862. * If all the render effects in the pipeline are supported
  73863. */
  73864. get isSupported(): boolean;
  73865. /**
  73866. * Adds an effect to the pipeline
  73867. * @param renderEffect the effect to add
  73868. */
  73869. addEffect(renderEffect: PostProcessRenderEffect): void;
  73870. /** @hidden */
  73871. _rebuild(): void;
  73872. /** @hidden */
  73873. _enableEffect(renderEffectName: string, cameras: Camera): void;
  73874. /** @hidden */
  73875. _enableEffect(renderEffectName: string, cameras: Camera[]): void;
  73876. /** @hidden */
  73877. _disableEffect(renderEffectName: string, cameras: Nullable<Camera[]>): void;
  73878. /** @hidden */
  73879. _disableEffect(renderEffectName: string, cameras: Nullable<Camera[]>): void;
  73880. /** @hidden */
  73881. _attachCameras(cameras: Camera, unique: boolean): void;
  73882. /** @hidden */
  73883. _attachCameras(cameras: Camera[], unique: boolean): void;
  73884. /** @hidden */
  73885. _detachCameras(cameras: Camera): void;
  73886. /** @hidden */
  73887. _detachCameras(cameras: Nullable<Camera[]>): void;
  73888. /** @hidden */
  73889. _update(): void;
  73890. /** @hidden */
  73891. _reset(): void;
  73892. protected _enableMSAAOnFirstPostProcess(sampleCount: number): boolean;
  73893. /**
  73894. * Sets the required values to the prepass renderer.
  73895. * @param prePassRenderer defines the prepass renderer to setup.
  73896. * @returns true if the pre pass is needed.
  73897. */
  73898. setPrePassRenderer(prePassRenderer: PrePassRenderer): boolean;
  73899. /**
  73900. * Disposes of the pipeline
  73901. */
  73902. dispose(): void;
  73903. }
  73904. }
  73905. declare module "babylonjs/PostProcesses/RenderPipeline/postProcessRenderPipelineManager" {
  73906. import { Camera } from "babylonjs/Cameras/camera";
  73907. import { PostProcessRenderPipeline } from "babylonjs/PostProcesses/RenderPipeline/postProcessRenderPipeline";
  73908. /**
  73909. * PostProcessRenderPipelineManager class
  73910. * @see https://doc.babylonjs.com/how_to/how_to_use_postprocessrenderpipeline
  73911. */
  73912. export class PostProcessRenderPipelineManager {
  73913. private _renderPipelines;
  73914. /**
  73915. * Initializes a PostProcessRenderPipelineManager
  73916. * @see https://doc.babylonjs.com/how_to/how_to_use_postprocessrenderpipeline
  73917. */
  73918. constructor();
  73919. /**
  73920. * Gets the list of supported render pipelines
  73921. */
  73922. get supportedPipelines(): PostProcessRenderPipeline[];
  73923. /**
  73924. * Adds a pipeline to the manager
  73925. * @param renderPipeline The pipeline to add
  73926. */
  73927. addPipeline(renderPipeline: PostProcessRenderPipeline): void;
  73928. /**
  73929. * Attaches a camera to the pipeline
  73930. * @param renderPipelineName The name of the pipeline to attach to
  73931. * @param cameras the camera to attach
  73932. * @param unique if the camera can be attached multiple times to the pipeline
  73933. */
  73934. attachCamerasToRenderPipeline(renderPipelineName: string, cameras: any | Camera[] | Camera, unique?: boolean): void;
  73935. /**
  73936. * Detaches a camera from the pipeline
  73937. * @param renderPipelineName The name of the pipeline to detach from
  73938. * @param cameras the camera to detach
  73939. */
  73940. detachCamerasFromRenderPipeline(renderPipelineName: string, cameras: any | Camera[] | Camera): void;
  73941. /**
  73942. * Enables an effect by name on a pipeline
  73943. * @param renderPipelineName the name of the pipeline to enable the effect in
  73944. * @param renderEffectName the name of the effect to enable
  73945. * @param cameras the cameras that the effect should be enabled on
  73946. */
  73947. enableEffectInPipeline(renderPipelineName: string, renderEffectName: string, cameras: any | Camera[] | Camera): void;
  73948. /**
  73949. * Disables an effect by name on a pipeline
  73950. * @param renderPipelineName the name of the pipeline to disable the effect in
  73951. * @param renderEffectName the name of the effect to disable
  73952. * @param cameras the cameras that the effect should be disabled on
  73953. */
  73954. disableEffectInPipeline(renderPipelineName: string, renderEffectName: string, cameras: any | Camera[] | Camera): void;
  73955. /**
  73956. * Updates the state of all contained render pipelines and disposes of any non supported pipelines
  73957. */
  73958. update(): void;
  73959. /** @hidden */
  73960. _rebuild(): void;
  73961. /**
  73962. * Disposes of the manager and pipelines
  73963. */
  73964. dispose(): void;
  73965. }
  73966. }
  73967. declare module "babylonjs/PostProcesses/RenderPipeline/postProcessRenderPipelineManagerSceneComponent" {
  73968. import { ISceneComponent } from "babylonjs/sceneComponent";
  73969. import { PostProcessRenderPipelineManager } from "babylonjs/PostProcesses/RenderPipeline/postProcessRenderPipelineManager";
  73970. import { Scene } from "babylonjs/scene";
  73971. module "babylonjs/scene" {
  73972. interface Scene {
  73973. /** @hidden (Backing field) */
  73974. _postProcessRenderPipelineManager: PostProcessRenderPipelineManager;
  73975. /**
  73976. * Gets the postprocess render pipeline manager
  73977. * @see https://doc.babylonjs.com/how_to/how_to_use_postprocessrenderpipeline
  73978. * @see https://doc.babylonjs.com/how_to/using_default_rendering_pipeline
  73979. */
  73980. readonly postProcessRenderPipelineManager: PostProcessRenderPipelineManager;
  73981. }
  73982. }
  73983. /**
  73984. * Defines the Render Pipeline scene component responsible to rendering pipelines
  73985. */
  73986. export class PostProcessRenderPipelineManagerSceneComponent implements ISceneComponent {
  73987. /**
  73988. * The component name helpfull to identify the component in the list of scene components.
  73989. */
  73990. readonly name: string;
  73991. /**
  73992. * The scene the component belongs to.
  73993. */
  73994. scene: Scene;
  73995. /**
  73996. * Creates a new instance of the component for the given scene
  73997. * @param scene Defines the scene to register the component in
  73998. */
  73999. constructor(scene: Scene);
  74000. /**
  74001. * Registers the component in a given scene
  74002. */
  74003. register(): void;
  74004. /**
  74005. * Rebuilds the elements related to this component in case of
  74006. * context lost for instance.
  74007. */
  74008. rebuild(): void;
  74009. /**
  74010. * Disposes the component and the associated ressources
  74011. */
  74012. dispose(): void;
  74013. private _gatherRenderTargets;
  74014. }
  74015. }
  74016. declare module "babylonjs/PostProcesses/RenderPipeline/Pipelines/defaultRenderingPipeline" {
  74017. import { Nullable } from "babylonjs/types";
  74018. import { IAnimatable } from "babylonjs/Animations/animatable.interface";
  74019. import { Camera } from "babylonjs/Cameras/camera";
  74020. import { IDisposable } from "babylonjs/scene";
  74021. import { GlowLayer } from "babylonjs/Layers/glowLayer";
  74022. import { Scene } from "babylonjs/scene";
  74023. import { SharpenPostProcess } from "babylonjs/PostProcesses/sharpenPostProcess";
  74024. import { ImageProcessingPostProcess } from "babylonjs/PostProcesses/imageProcessingPostProcess";
  74025. import { ChromaticAberrationPostProcess } from "babylonjs/PostProcesses/chromaticAberrationPostProcess";
  74026. import { GrainPostProcess } from "babylonjs/PostProcesses/grainPostProcess";
  74027. import { FxaaPostProcess } from "babylonjs/PostProcesses/fxaaPostProcess";
  74028. import { PostProcessRenderPipeline } from "babylonjs/PostProcesses/RenderPipeline/postProcessRenderPipeline";
  74029. import { DepthOfFieldEffect, DepthOfFieldEffectBlurLevel } from "babylonjs/PostProcesses/depthOfFieldEffect";
  74030. import "babylonjs/PostProcesses/RenderPipeline/postProcessRenderPipelineManagerSceneComponent";
  74031. import { Animation } from "babylonjs/Animations/animation";
  74032. /**
  74033. * The default rendering pipeline can be added to a scene to apply common post processing effects such as anti-aliasing or depth of field.
  74034. * See https://doc.babylonjs.com/how_to/using_default_rendering_pipeline
  74035. */
  74036. export class DefaultRenderingPipeline extends PostProcessRenderPipeline implements IDisposable, IAnimatable {
  74037. private _scene;
  74038. private _camerasToBeAttached;
  74039. /**
  74040. * ID of the sharpen post process,
  74041. */
  74042. private readonly SharpenPostProcessId;
  74043. /**
  74044. * @ignore
  74045. * ID of the image processing post process;
  74046. */
  74047. readonly ImageProcessingPostProcessId: string;
  74048. /**
  74049. * @ignore
  74050. * ID of the Fast Approximate Anti-Aliasing post process;
  74051. */
  74052. readonly FxaaPostProcessId: string;
  74053. /**
  74054. * ID of the chromatic aberration post process,
  74055. */
  74056. private readonly ChromaticAberrationPostProcessId;
  74057. /**
  74058. * ID of the grain post process
  74059. */
  74060. private readonly GrainPostProcessId;
  74061. /**
  74062. * Sharpen post process which will apply a sharpen convolution to enhance edges
  74063. */
  74064. sharpen: SharpenPostProcess;
  74065. private _sharpenEffect;
  74066. private bloom;
  74067. /**
  74068. * Depth of field effect, applies a blur based on how far away objects are from the focus distance.
  74069. */
  74070. depthOfField: DepthOfFieldEffect;
  74071. /**
  74072. * The Fast Approximate Anti-Aliasing post process which attemps to remove aliasing from an image.
  74073. */
  74074. fxaa: FxaaPostProcess;
  74075. /**
  74076. * Image post processing pass used to perform operations such as tone mapping or color grading.
  74077. */
  74078. imageProcessing: ImageProcessingPostProcess;
  74079. /**
  74080. * Chromatic aberration post process which will shift rgb colors in the image
  74081. */
  74082. chromaticAberration: ChromaticAberrationPostProcess;
  74083. private _chromaticAberrationEffect;
  74084. /**
  74085. * Grain post process which add noise to the image
  74086. */
  74087. grain: GrainPostProcess;
  74088. private _grainEffect;
  74089. /**
  74090. * Glow post process which adds a glow to emissive areas of the image
  74091. */
  74092. private _glowLayer;
  74093. /**
  74094. * Animations which can be used to tweak settings over a period of time
  74095. */
  74096. animations: Animation[];
  74097. private _imageProcessingConfigurationObserver;
  74098. private _sharpenEnabled;
  74099. private _bloomEnabled;
  74100. private _depthOfFieldEnabled;
  74101. private _depthOfFieldBlurLevel;
  74102. private _fxaaEnabled;
  74103. private _imageProcessingEnabled;
  74104. private _defaultPipelineTextureType;
  74105. private _bloomScale;
  74106. private _chromaticAberrationEnabled;
  74107. private _grainEnabled;
  74108. private _buildAllowed;
  74109. /**
  74110. * Gets active scene
  74111. */
  74112. get scene(): Scene;
  74113. /**
  74114. * Enable or disable the sharpen process from the pipeline
  74115. */
  74116. set sharpenEnabled(enabled: boolean);
  74117. get sharpenEnabled(): boolean;
  74118. private _resizeObserver;
  74119. private _hardwareScaleLevel;
  74120. private _bloomKernel;
  74121. /**
  74122. * Specifies the size of the bloom blur kernel, relative to the final output size
  74123. */
  74124. get bloomKernel(): number;
  74125. set bloomKernel(value: number);
  74126. /**
  74127. * Specifies the weight of the bloom in the final rendering
  74128. */
  74129. private _bloomWeight;
  74130. /**
  74131. * Specifies the luma threshold for the area that will be blurred by the bloom
  74132. */
  74133. private _bloomThreshold;
  74134. private _hdr;
  74135. /**
  74136. * The strength of the bloom.
  74137. */
  74138. set bloomWeight(value: number);
  74139. get bloomWeight(): number;
  74140. /**
  74141. * The strength of the bloom.
  74142. */
  74143. set bloomThreshold(value: number);
  74144. get bloomThreshold(): number;
  74145. /**
  74146. * The scale of the bloom, lower value will provide better performance.
  74147. */
  74148. set bloomScale(value: number);
  74149. get bloomScale(): number;
  74150. /**
  74151. * Enable or disable the bloom from the pipeline
  74152. */
  74153. set bloomEnabled(enabled: boolean);
  74154. get bloomEnabled(): boolean;
  74155. private _rebuildBloom;
  74156. /**
  74157. * If the depth of field is enabled.
  74158. */
  74159. get depthOfFieldEnabled(): boolean;
  74160. set depthOfFieldEnabled(enabled: boolean);
  74161. /**
  74162. * Blur level of the depth of field effect. (Higher blur will effect performance)
  74163. */
  74164. get depthOfFieldBlurLevel(): DepthOfFieldEffectBlurLevel;
  74165. set depthOfFieldBlurLevel(value: DepthOfFieldEffectBlurLevel);
  74166. /**
  74167. * If the anti aliasing is enabled.
  74168. */
  74169. set fxaaEnabled(enabled: boolean);
  74170. get fxaaEnabled(): boolean;
  74171. private _samples;
  74172. /**
  74173. * MSAA sample count, setting this to 4 will provide 4x anti aliasing. (default: 1)
  74174. */
  74175. set samples(sampleCount: number);
  74176. get samples(): number;
  74177. /**
  74178. * If image processing is enabled.
  74179. */
  74180. set imageProcessingEnabled(enabled: boolean);
  74181. get imageProcessingEnabled(): boolean;
  74182. /**
  74183. * If glow layer is enabled. (Adds a glow effect to emmissive materials)
  74184. */
  74185. set glowLayerEnabled(enabled: boolean);
  74186. get glowLayerEnabled(): boolean;
  74187. /**
  74188. * Gets the glow layer (or null if not defined)
  74189. */
  74190. get glowLayer(): Nullable<GlowLayer>;
  74191. /**
  74192. * Enable or disable the chromaticAberration process from the pipeline
  74193. */
  74194. set chromaticAberrationEnabled(enabled: boolean);
  74195. get chromaticAberrationEnabled(): boolean;
  74196. /**
  74197. * Enable or disable the grain process from the pipeline
  74198. */
  74199. set grainEnabled(enabled: boolean);
  74200. get grainEnabled(): boolean;
  74201. /**
  74202. * @constructor
  74203. * @param name - The rendering pipeline name (default: "")
  74204. * @param hdr - If high dynamic range textures should be used (default: true)
  74205. * @param scene - The scene linked to this pipeline (default: the last created scene)
  74206. * @param cameras - The array of cameras that the rendering pipeline will be attached to (default: scene.cameras)
  74207. * @param automaticBuild - if false, you will have to manually call prepare() to update the pipeline (default: true)
  74208. */
  74209. constructor(name?: string, hdr?: boolean, scene?: Scene, cameras?: Camera[], automaticBuild?: boolean);
  74210. /**
  74211. * Get the class name
  74212. * @returns "DefaultRenderingPipeline"
  74213. */
  74214. getClassName(): string;
  74215. /**
  74216. * Force the compilation of the entire pipeline.
  74217. */
  74218. prepare(): void;
  74219. private _hasCleared;
  74220. private _prevPostProcess;
  74221. private _prevPrevPostProcess;
  74222. private _setAutoClearAndTextureSharing;
  74223. private _depthOfFieldSceneObserver;
  74224. private _buildPipeline;
  74225. private _disposePostProcesses;
  74226. /**
  74227. * Adds a camera to the pipeline
  74228. * @param camera the camera to be added
  74229. */
  74230. addCamera(camera: Camera): void;
  74231. /**
  74232. * Removes a camera from the pipeline
  74233. * @param camera the camera to remove
  74234. */
  74235. removeCamera(camera: Camera): void;
  74236. /**
  74237. * Dispose of the pipeline and stop all post processes
  74238. */
  74239. dispose(): void;
  74240. /**
  74241. * Serialize the rendering pipeline (Used when exporting)
  74242. * @returns the serialized object
  74243. */
  74244. serialize(): any;
  74245. /**
  74246. * Parse the serialized pipeline
  74247. * @param source Source pipeline.
  74248. * @param scene The scene to load the pipeline to.
  74249. * @param rootUrl The URL of the serialized pipeline.
  74250. * @returns An instantiated pipeline from the serialized object.
  74251. */
  74252. static Parse(source: any, scene: Scene, rootUrl: string): DefaultRenderingPipeline;
  74253. }
  74254. }
  74255. declare module "babylonjs/Shaders/lensHighlights.fragment" {
  74256. /** @hidden */
  74257. export var lensHighlightsPixelShader: {
  74258. name: string;
  74259. shader: string;
  74260. };
  74261. }
  74262. declare module "babylonjs/Shaders/depthOfField.fragment" {
  74263. /** @hidden */
  74264. export var depthOfFieldPixelShader: {
  74265. name: string;
  74266. shader: string;
  74267. };
  74268. }
  74269. declare module "babylonjs/PostProcesses/RenderPipeline/Pipelines/lensRenderingPipeline" {
  74270. import { Camera } from "babylonjs/Cameras/camera";
  74271. import { PostProcessRenderPipeline } from "babylonjs/PostProcesses/RenderPipeline/postProcessRenderPipeline";
  74272. import { Scene } from "babylonjs/scene";
  74273. import "babylonjs/PostProcesses/RenderPipeline/postProcessRenderPipelineManagerSceneComponent";
  74274. import "babylonjs/Shaders/chromaticAberration.fragment";
  74275. import "babylonjs/Shaders/lensHighlights.fragment";
  74276. import "babylonjs/Shaders/depthOfField.fragment";
  74277. /**
  74278. * BABYLON.JS Chromatic Aberration GLSL Shader
  74279. * Author: Olivier Guyot
  74280. * Separates very slightly R, G and B colors on the edges of the screen
  74281. * Inspired by Francois Tarlier & Martins Upitis
  74282. */
  74283. export class LensRenderingPipeline extends PostProcessRenderPipeline {
  74284. /**
  74285. * @ignore
  74286. * The chromatic aberration PostProcess id in the pipeline
  74287. */
  74288. LensChromaticAberrationEffect: string;
  74289. /**
  74290. * @ignore
  74291. * The highlights enhancing PostProcess id in the pipeline
  74292. */
  74293. HighlightsEnhancingEffect: string;
  74294. /**
  74295. * @ignore
  74296. * The depth-of-field PostProcess id in the pipeline
  74297. */
  74298. LensDepthOfFieldEffect: string;
  74299. private _scene;
  74300. private _depthTexture;
  74301. private _grainTexture;
  74302. private _chromaticAberrationPostProcess;
  74303. private _highlightsPostProcess;
  74304. private _depthOfFieldPostProcess;
  74305. private _edgeBlur;
  74306. private _grainAmount;
  74307. private _chromaticAberration;
  74308. private _distortion;
  74309. private _highlightsGain;
  74310. private _highlightsThreshold;
  74311. private _dofDistance;
  74312. private _dofAperture;
  74313. private _dofDarken;
  74314. private _dofPentagon;
  74315. private _blurNoise;
  74316. /**
  74317. * @constructor
  74318. *
  74319. * Effect parameters are as follow:
  74320. * {
  74321. * chromatic_aberration: number; // from 0 to x (1 for realism)
  74322. * edge_blur: number; // from 0 to x (1 for realism)
  74323. * distortion: number; // from 0 to x (1 for realism)
  74324. * grain_amount: number; // from 0 to 1
  74325. * grain_texture: BABYLON.Texture; // texture to use for grain effect; if unset, use random B&W noise
  74326. * dof_focus_distance: number; // depth-of-field: focus distance; unset to disable (disabled by default)
  74327. * dof_aperture: number; // depth-of-field: focus blur bias (default: 1)
  74328. * dof_darken: number; // depth-of-field: darken that which is out of focus (from 0 to 1, disabled by default)
  74329. * dof_pentagon: boolean; // depth-of-field: makes a pentagon-like "bokeh" effect
  74330. * dof_gain: number; // depth-of-field: highlights gain; unset to disable (disabled by default)
  74331. * dof_threshold: number; // depth-of-field: highlights threshold (default: 1)
  74332. * blur_noise: boolean; // add a little bit of noise to the blur (default: true)
  74333. * }
  74334. * Note: if an effect parameter is unset, effect is disabled
  74335. *
  74336. * @param name The rendering pipeline name
  74337. * @param parameters - An object containing all parameters (see above)
  74338. * @param scene The scene linked to this pipeline
  74339. * @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)
  74340. * @param cameras The array of cameras that the rendering pipeline will be attached to
  74341. */
  74342. constructor(name: string, parameters: any, scene: Scene, ratio?: number, cameras?: Camera[]);
  74343. /**
  74344. * Get the class name
  74345. * @returns "LensRenderingPipeline"
  74346. */
  74347. getClassName(): string;
  74348. /**
  74349. * Gets associated scene
  74350. */
  74351. get scene(): Scene;
  74352. /**
  74353. * Gets or sets the edge blur
  74354. */
  74355. get edgeBlur(): number;
  74356. set edgeBlur(value: number);
  74357. /**
  74358. * Gets or sets the grain amount
  74359. */
  74360. get grainAmount(): number;
  74361. set grainAmount(value: number);
  74362. /**
  74363. * Gets or sets the chromatic aberration amount
  74364. */
  74365. get chromaticAberration(): number;
  74366. set chromaticAberration(value: number);
  74367. /**
  74368. * Gets or sets the depth of field aperture
  74369. */
  74370. get dofAperture(): number;
  74371. set dofAperture(value: number);
  74372. /**
  74373. * Gets or sets the edge distortion
  74374. */
  74375. get edgeDistortion(): number;
  74376. set edgeDistortion(value: number);
  74377. /**
  74378. * Gets or sets the depth of field distortion
  74379. */
  74380. get dofDistortion(): number;
  74381. set dofDistortion(value: number);
  74382. /**
  74383. * Gets or sets the darken out of focus amount
  74384. */
  74385. get darkenOutOfFocus(): number;
  74386. set darkenOutOfFocus(value: number);
  74387. /**
  74388. * Gets or sets a boolean indicating if blur noise is enabled
  74389. */
  74390. get blurNoise(): boolean;
  74391. set blurNoise(value: boolean);
  74392. /**
  74393. * Gets or sets a boolean indicating if pentagon bokeh is enabled
  74394. */
  74395. get pentagonBokeh(): boolean;
  74396. set pentagonBokeh(value: boolean);
  74397. /**
  74398. * Gets or sets the highlight grain amount
  74399. */
  74400. get highlightsGain(): number;
  74401. set highlightsGain(value: number);
  74402. /**
  74403. * Gets or sets the highlight threshold
  74404. */
  74405. get highlightsThreshold(): number;
  74406. set highlightsThreshold(value: number);
  74407. /**
  74408. * Sets the amount of blur at the edges
  74409. * @param amount blur amount
  74410. */
  74411. setEdgeBlur(amount: number): void;
  74412. /**
  74413. * Sets edge blur to 0
  74414. */
  74415. disableEdgeBlur(): void;
  74416. /**
  74417. * Sets the amout of grain
  74418. * @param amount Amount of grain
  74419. */
  74420. setGrainAmount(amount: number): void;
  74421. /**
  74422. * Set grain amount to 0
  74423. */
  74424. disableGrain(): void;
  74425. /**
  74426. * Sets the chromatic aberration amount
  74427. * @param amount amount of chromatic aberration
  74428. */
  74429. setChromaticAberration(amount: number): void;
  74430. /**
  74431. * Sets chromatic aberration amount to 0
  74432. */
  74433. disableChromaticAberration(): void;
  74434. /**
  74435. * Sets the EdgeDistortion amount
  74436. * @param amount amount of EdgeDistortion
  74437. */
  74438. setEdgeDistortion(amount: number): void;
  74439. /**
  74440. * Sets edge distortion to 0
  74441. */
  74442. disableEdgeDistortion(): void;
  74443. /**
  74444. * Sets the FocusDistance amount
  74445. * @param amount amount of FocusDistance
  74446. */
  74447. setFocusDistance(amount: number): void;
  74448. /**
  74449. * Disables depth of field
  74450. */
  74451. disableDepthOfField(): void;
  74452. /**
  74453. * Sets the Aperture amount
  74454. * @param amount amount of Aperture
  74455. */
  74456. setAperture(amount: number): void;
  74457. /**
  74458. * Sets the DarkenOutOfFocus amount
  74459. * @param amount amount of DarkenOutOfFocus
  74460. */
  74461. setDarkenOutOfFocus(amount: number): void;
  74462. private _pentagonBokehIsEnabled;
  74463. /**
  74464. * Creates a pentagon bokeh effect
  74465. */
  74466. enablePentagonBokeh(): void;
  74467. /**
  74468. * Disables the pentagon bokeh effect
  74469. */
  74470. disablePentagonBokeh(): void;
  74471. /**
  74472. * Enables noise blur
  74473. */
  74474. enableNoiseBlur(): void;
  74475. /**
  74476. * Disables noise blur
  74477. */
  74478. disableNoiseBlur(): void;
  74479. /**
  74480. * Sets the HighlightsGain amount
  74481. * @param amount amount of HighlightsGain
  74482. */
  74483. setHighlightsGain(amount: number): void;
  74484. /**
  74485. * Sets the HighlightsThreshold amount
  74486. * @param amount amount of HighlightsThreshold
  74487. */
  74488. setHighlightsThreshold(amount: number): void;
  74489. /**
  74490. * Disables highlights
  74491. */
  74492. disableHighlights(): void;
  74493. /**
  74494. * Removes the internal pipeline assets and detaches the pipeline from the scene cameras
  74495. * @param disableDepthRender If the scens depth rendering should be disabled (default: false)
  74496. */
  74497. dispose(disableDepthRender?: boolean): void;
  74498. private _createChromaticAberrationPostProcess;
  74499. private _createHighlightsPostProcess;
  74500. private _createDepthOfFieldPostProcess;
  74501. private _createGrainTexture;
  74502. }
  74503. }
  74504. declare module "babylonjs/Shaders/ssao2.fragment" {
  74505. /** @hidden */
  74506. export var ssao2PixelShader: {
  74507. name: string;
  74508. shader: string;
  74509. };
  74510. }
  74511. declare module "babylonjs/Shaders/ssaoCombine.fragment" {
  74512. /** @hidden */
  74513. export var ssaoCombinePixelShader: {
  74514. name: string;
  74515. shader: string;
  74516. };
  74517. }
  74518. declare module "babylonjs/PostProcesses/RenderPipeline/Pipelines/ssao2RenderingPipeline" {
  74519. import { Camera } from "babylonjs/Cameras/camera";
  74520. import { PostProcessRenderPipeline } from "babylonjs/PostProcesses/RenderPipeline/postProcessRenderPipeline";
  74521. import { Scene } from "babylonjs/scene";
  74522. import "babylonjs/PostProcesses/RenderPipeline/postProcessRenderPipelineManagerSceneComponent";
  74523. import "babylonjs/Shaders/ssao2.fragment";
  74524. import "babylonjs/Shaders/ssaoCombine.fragment";
  74525. import { PrePassRenderer } from "babylonjs/Rendering/prePassRenderer";
  74526. /**
  74527. * Render pipeline to produce ssao effect
  74528. */
  74529. export class SSAO2RenderingPipeline extends PostProcessRenderPipeline {
  74530. /**
  74531. * @ignore
  74532. * The PassPostProcess id in the pipeline that contains the original scene color
  74533. */
  74534. SSAOOriginalSceneColorEffect: string;
  74535. /**
  74536. * @ignore
  74537. * The SSAO PostProcess id in the pipeline
  74538. */
  74539. SSAORenderEffect: string;
  74540. /**
  74541. * @ignore
  74542. * The horizontal blur PostProcess id in the pipeline
  74543. */
  74544. SSAOBlurHRenderEffect: string;
  74545. /**
  74546. * @ignore
  74547. * The vertical blur PostProcess id in the pipeline
  74548. */
  74549. SSAOBlurVRenderEffect: string;
  74550. /**
  74551. * @ignore
  74552. * The PostProcess id in the pipeline that combines the SSAO-Blur output with the original scene color (SSAOOriginalSceneColorEffect)
  74553. */
  74554. SSAOCombineRenderEffect: string;
  74555. /**
  74556. * The output strength of the SSAO post-process. Default value is 1.0.
  74557. */
  74558. totalStrength: number;
  74559. /**
  74560. * Maximum depth value to still render AO. A smooth falloff makes the dimming more natural, so there will be no abrupt shading change.
  74561. */
  74562. maxZ: number;
  74563. /**
  74564. * In order to save performances, SSAO radius is clamped on close geometry. This ratio changes by how much
  74565. */
  74566. minZAspect: number;
  74567. private _samples;
  74568. /**
  74569. * Number of samples used for the SSAO calculations. Default value is 8
  74570. */
  74571. set samples(n: number);
  74572. get samples(): number;
  74573. private _textureSamples;
  74574. /**
  74575. * Number of samples to use for antialiasing
  74576. */
  74577. set textureSamples(n: number);
  74578. get textureSamples(): number;
  74579. /**
  74580. * Force rendering the geometry through geometry buffer
  74581. */
  74582. private _forceGeometryBuffer;
  74583. /**
  74584. * Ratio object used for SSAO ratio and blur ratio
  74585. */
  74586. private _ratio;
  74587. /**
  74588. * Dynamically generated sphere sampler.
  74589. */
  74590. private _sampleSphere;
  74591. /**
  74592. * Blur filter offsets
  74593. */
  74594. private _samplerOffsets;
  74595. private _expensiveBlur;
  74596. /**
  74597. * If bilateral blur should be used
  74598. */
  74599. set expensiveBlur(b: boolean);
  74600. get expensiveBlur(): boolean;
  74601. /**
  74602. * The radius around the analyzed pixel used by the SSAO post-process. Default value is 2.0
  74603. */
  74604. radius: number;
  74605. /**
  74606. * The base color of the SSAO post-process
  74607. * The final result is "base + ssao" between [0, 1]
  74608. */
  74609. base: number;
  74610. /**
  74611. * Support test.
  74612. */
  74613. static get IsSupported(): boolean;
  74614. private _scene;
  74615. private _randomTexture;
  74616. private _originalColorPostProcess;
  74617. private _ssaoPostProcess;
  74618. private _blurHPostProcess;
  74619. private _blurVPostProcess;
  74620. private _ssaoCombinePostProcess;
  74621. private _prePassRenderer;
  74622. /**
  74623. * Gets active scene
  74624. */
  74625. get scene(): Scene;
  74626. /**
  74627. * @constructor
  74628. * @param name The rendering pipeline name
  74629. * @param scene The scene linked to this pipeline
  74630. * @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 }
  74631. * @param cameras The array of cameras that the rendering pipeline will be attached to
  74632. * @param forceGeometryBuffer Set to true if you want to use the legacy geometry buffer renderer
  74633. */
  74634. constructor(name: string, scene: Scene, ratio: any, cameras?: Camera[], forceGeometryBuffer?: boolean);
  74635. /**
  74636. * Get the class name
  74637. * @returns "SSAO2RenderingPipeline"
  74638. */
  74639. getClassName(): string;
  74640. /**
  74641. * Removes the internal pipeline assets and detatches the pipeline from the scene cameras
  74642. */
  74643. dispose(disableGeometryBufferRenderer?: boolean): void;
  74644. private _createBlurPostProcess;
  74645. /** @hidden */
  74646. _rebuild(): void;
  74647. private _bits;
  74648. private _radicalInverse_VdC;
  74649. private _hammersley;
  74650. private _hemisphereSample_uniform;
  74651. private _generateHemisphere;
  74652. private _getDefinesForSSAO;
  74653. private _createSSAOPostProcess;
  74654. private _createSSAOCombinePostProcess;
  74655. private _createRandomTexture;
  74656. /**
  74657. * Serialize the rendering pipeline (Used when exporting)
  74658. * @returns the serialized object
  74659. */
  74660. serialize(): any;
  74661. /**
  74662. * Parse the serialized pipeline
  74663. * @param source Source pipeline.
  74664. * @param scene The scene to load the pipeline to.
  74665. * @param rootUrl The URL of the serialized pipeline.
  74666. * @returns An instantiated pipeline from the serialized object.
  74667. */
  74668. static Parse(source: any, scene: Scene, rootUrl: string): SSAO2RenderingPipeline;
  74669. /**
  74670. * Sets the required values to the prepass renderer.
  74671. * @param prePassRenderer defines the prepass renderer to setup
  74672. * @returns true if the pre pass is needed.
  74673. */
  74674. setPrePassRenderer(prePassRenderer: PrePassRenderer): boolean;
  74675. }
  74676. }
  74677. declare module "babylonjs/Shaders/ssao.fragment" {
  74678. /** @hidden */
  74679. export var ssaoPixelShader: {
  74680. name: string;
  74681. shader: string;
  74682. };
  74683. }
  74684. declare module "babylonjs/PostProcesses/RenderPipeline/Pipelines/ssaoRenderingPipeline" {
  74685. import { Camera } from "babylonjs/Cameras/camera";
  74686. import { PostProcessRenderPipeline } from "babylonjs/PostProcesses/RenderPipeline/postProcessRenderPipeline";
  74687. import { Scene } from "babylonjs/scene";
  74688. import "babylonjs/PostProcesses/RenderPipeline/postProcessRenderPipelineManagerSceneComponent";
  74689. import "babylonjs/Shaders/ssao.fragment";
  74690. import "babylonjs/Shaders/ssaoCombine.fragment";
  74691. /**
  74692. * Render pipeline to produce ssao effect
  74693. */
  74694. export class SSAORenderingPipeline extends PostProcessRenderPipeline {
  74695. /**
  74696. * @ignore
  74697. * The PassPostProcess id in the pipeline that contains the original scene color
  74698. */
  74699. SSAOOriginalSceneColorEffect: string;
  74700. /**
  74701. * @ignore
  74702. * The SSAO PostProcess id in the pipeline
  74703. */
  74704. SSAORenderEffect: string;
  74705. /**
  74706. * @ignore
  74707. * The horizontal blur PostProcess id in the pipeline
  74708. */
  74709. SSAOBlurHRenderEffect: string;
  74710. /**
  74711. * @ignore
  74712. * The vertical blur PostProcess id in the pipeline
  74713. */
  74714. SSAOBlurVRenderEffect: string;
  74715. /**
  74716. * @ignore
  74717. * The PostProcess id in the pipeline that combines the SSAO-Blur output with the original scene color (SSAOOriginalSceneColorEffect)
  74718. */
  74719. SSAOCombineRenderEffect: string;
  74720. /**
  74721. * The output strength of the SSAO post-process. Default value is 1.0.
  74722. */
  74723. totalStrength: number;
  74724. /**
  74725. * The radius around the analyzed pixel used by the SSAO post-process. Default value is 0.0006
  74726. */
  74727. radius: number;
  74728. /**
  74729. * Related to fallOff, used to interpolate SSAO samples (first interpolate function input) based on the occlusion difference of each pixel
  74730. * Must not be equal to fallOff and superior to fallOff.
  74731. * Default value is 0.0075
  74732. */
  74733. area: number;
  74734. /**
  74735. * Related to area, used to interpolate SSAO samples (second interpolate function input) based on the occlusion difference of each pixel
  74736. * Must not be equal to area and inferior to area.
  74737. * Default value is 0.000001
  74738. */
  74739. fallOff: number;
  74740. /**
  74741. * The base color of the SSAO post-process
  74742. * The final result is "base + ssao" between [0, 1]
  74743. */
  74744. base: number;
  74745. private _scene;
  74746. private _depthTexture;
  74747. private _randomTexture;
  74748. private _originalColorPostProcess;
  74749. private _ssaoPostProcess;
  74750. private _blurHPostProcess;
  74751. private _blurVPostProcess;
  74752. private _ssaoCombinePostProcess;
  74753. private _firstUpdate;
  74754. /**
  74755. * Gets active scene
  74756. */
  74757. get scene(): Scene;
  74758. /**
  74759. * @constructor
  74760. * @param name - The rendering pipeline name
  74761. * @param scene - The scene linked to this pipeline
  74762. * @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 }
  74763. * @param cameras - The array of cameras that the rendering pipeline will be attached to
  74764. */
  74765. constructor(name: string, scene: Scene, ratio: any, cameras?: Camera[]);
  74766. /**
  74767. * Get the class name
  74768. * @returns "SSAORenderingPipeline"
  74769. */
  74770. getClassName(): string;
  74771. /**
  74772. * Removes the internal pipeline assets and detatches the pipeline from the scene cameras
  74773. */
  74774. dispose(disableDepthRender?: boolean): void;
  74775. private _createBlurPostProcess;
  74776. /** @hidden */
  74777. _rebuild(): void;
  74778. private _createSSAOPostProcess;
  74779. private _createSSAOCombinePostProcess;
  74780. private _createRandomTexture;
  74781. }
  74782. }
  74783. declare module "babylonjs/Shaders/screenSpaceReflection.fragment" {
  74784. /** @hidden */
  74785. export var screenSpaceReflectionPixelShader: {
  74786. name: string;
  74787. shader: string;
  74788. };
  74789. }
  74790. declare module "babylonjs/PostProcesses/screenSpaceReflectionPostProcess" {
  74791. import { Nullable } from "babylonjs/types";
  74792. import { Camera } from "babylonjs/Cameras/camera";
  74793. import { PostProcess, PostProcessOptions } from "babylonjs/PostProcesses/postProcess";
  74794. import "babylonjs/Shaders/screenSpaceReflection.fragment";
  74795. import { Engine } from "babylonjs/Engines/engine";
  74796. import { Scene } from "babylonjs/scene";
  74797. /**
  74798. * The ScreenSpaceReflectionPostProcess performs realtime reflections using only and only the available informations on the screen (positions and normals).
  74799. * Basically, the screen space reflection post-process will compute reflections according the material's reflectivity.
  74800. */
  74801. export class ScreenSpaceReflectionPostProcess extends PostProcess {
  74802. /**
  74803. * Gets or sets a reflection threshold mainly used to adjust the reflection's height.
  74804. */
  74805. threshold: number;
  74806. /**
  74807. * Gets or sets the current reflection strength. 1.0 is an ideal value but can be increased/decreased for particular results.
  74808. */
  74809. strength: number;
  74810. /**
  74811. * Gets or sets the falloff exponent used while computing fresnel. More the exponent is high, more the reflections will be discrete.
  74812. */
  74813. reflectionSpecularFalloffExponent: number;
  74814. /**
  74815. * 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]
  74816. */
  74817. step: number;
  74818. /**
  74819. * Gets or sets the factor applied when computing roughness. Default value is 0.2.
  74820. */
  74821. roughnessFactor: number;
  74822. private _geometryBufferRenderer;
  74823. private _enableSmoothReflections;
  74824. private _reflectionSamples;
  74825. private _smoothSteps;
  74826. /**
  74827. * Gets a string identifying the name of the class
  74828. * @returns "ScreenSpaceReflectionPostProcess" string
  74829. */
  74830. getClassName(): string;
  74831. /**
  74832. * Creates a new instance of ScreenSpaceReflectionPostProcess.
  74833. * @param name The name of the effect.
  74834. * @param scene The scene containing the objects to calculate reflections.
  74835. * @param options The required width/height ratio to downsize to before computing the render pass.
  74836. * @param camera The camera to apply the render pass to.
  74837. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  74838. * @param engine The engine which the post process will be applied. (default: current engine)
  74839. * @param reusable If the post process can be reused on the same frame. (default: false)
  74840. * @param textureType Type of textures used when performing the post process. (default: 0)
  74841. * @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)
  74842. */
  74843. constructor(name: string, scene: Scene, options: number | PostProcessOptions, camera: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number, blockCompilation?: boolean);
  74844. /**
  74845. * Gets wether or not smoothing reflections is enabled.
  74846. * Enabling smoothing will require more GPU power and can generate a drop in FPS.
  74847. */
  74848. get enableSmoothReflections(): boolean;
  74849. /**
  74850. * Sets wether or not smoothing reflections is enabled.
  74851. * Enabling smoothing will require more GPU power and can generate a drop in FPS.
  74852. */
  74853. set enableSmoothReflections(enabled: boolean);
  74854. /**
  74855. * Gets the number of samples taken while computing reflections. More samples count is high,
  74856. * more the post-process wil require GPU power and can generate a drop in FPS. Basically in interval [25, 100].
  74857. */
  74858. get reflectionSamples(): number;
  74859. /**
  74860. * Sets the number of samples taken while computing reflections. More samples count is high,
  74861. * more the post-process wil require GPU power and can generate a drop in FPS. Basically in interval [25, 100].
  74862. */
  74863. set reflectionSamples(samples: number);
  74864. /**
  74865. * Gets the number of samples taken while smoothing reflections. More samples count is high,
  74866. * more the post-process will require GPU power and can generate a drop in FPS.
  74867. * Default value (5.0) work pretty well in all cases but can be adjusted.
  74868. */
  74869. get smoothSteps(): number;
  74870. set smoothSteps(steps: number);
  74871. private _updateEffectDefines;
  74872. /** @hidden */
  74873. static _Parse(parsedPostProcess: any, targetCamera: Camera, scene: Scene, rootUrl: string): ScreenSpaceReflectionPostProcess;
  74874. }
  74875. }
  74876. declare module "babylonjs/Shaders/standard.fragment" {
  74877. import "babylonjs/Shaders/ShadersInclude/packingFunctions";
  74878. /** @hidden */
  74879. export var standardPixelShader: {
  74880. name: string;
  74881. shader: string;
  74882. };
  74883. }
  74884. declare module "babylonjs/PostProcesses/RenderPipeline/Pipelines/standardRenderingPipeline" {
  74885. import { Nullable } from "babylonjs/types";
  74886. import { IAnimatable } from "babylonjs/Animations/animatable.interface";
  74887. import { Camera } from "babylonjs/Cameras/camera";
  74888. import { Texture } from "babylonjs/Materials/Textures/texture";
  74889. import { PostProcess } from "babylonjs/PostProcesses/postProcess";
  74890. import { PostProcessRenderPipeline } from "babylonjs/PostProcesses/RenderPipeline/postProcessRenderPipeline";
  74891. import { BlurPostProcess } from "babylonjs/PostProcesses/blurPostProcess";
  74892. import { FxaaPostProcess } from "babylonjs/PostProcesses/fxaaPostProcess";
  74893. import { IDisposable } from "babylonjs/scene";
  74894. import { SpotLight } from "babylonjs/Lights/spotLight";
  74895. import { DirectionalLight } from "babylonjs/Lights/directionalLight";
  74896. import { Scene } from "babylonjs/scene";
  74897. import { ScreenSpaceReflectionPostProcess } from "babylonjs/PostProcesses/screenSpaceReflectionPostProcess";
  74898. import { Animation } from "babylonjs/Animations/animation";
  74899. import "babylonjs/PostProcesses/RenderPipeline/postProcessRenderPipelineManagerSceneComponent";
  74900. import "babylonjs/Shaders/standard.fragment";
  74901. /**
  74902. * Standard rendering pipeline
  74903. * Default pipeline should be used going forward but the standard pipeline will be kept for backwards compatibility.
  74904. * @see https://doc.babylonjs.com/how_to/using_standard_rendering_pipeline
  74905. */
  74906. export class StandardRenderingPipeline extends PostProcessRenderPipeline implements IDisposable, IAnimatable {
  74907. /**
  74908. * Public members
  74909. */
  74910. /**
  74911. * Post-process which contains the original scene color before the pipeline applies all the effects
  74912. */
  74913. originalPostProcess: Nullable<PostProcess>;
  74914. /**
  74915. * Post-process used to down scale an image x4
  74916. */
  74917. downSampleX4PostProcess: Nullable<PostProcess>;
  74918. /**
  74919. * Post-process used to calculate the illuminated surfaces controlled by a threshold
  74920. */
  74921. brightPassPostProcess: Nullable<PostProcess>;
  74922. /**
  74923. * Post-process array storing all the horizontal blur post-processes used by the pipeline
  74924. */
  74925. blurHPostProcesses: PostProcess[];
  74926. /**
  74927. * Post-process array storing all the vertical blur post-processes used by the pipeline
  74928. */
  74929. blurVPostProcesses: PostProcess[];
  74930. /**
  74931. * Post-process used to add colors of 2 textures (typically brightness + real scene color)
  74932. */
  74933. textureAdderPostProcess: Nullable<PostProcess>;
  74934. /**
  74935. * Post-process used to create volumetric lighting effect
  74936. */
  74937. volumetricLightPostProcess: Nullable<PostProcess>;
  74938. /**
  74939. * Post-process used to smooth the previous volumetric light post-process on the X axis
  74940. */
  74941. volumetricLightSmoothXPostProcess: Nullable<BlurPostProcess>;
  74942. /**
  74943. * Post-process used to smooth the previous volumetric light post-process on the Y axis
  74944. */
  74945. volumetricLightSmoothYPostProcess: Nullable<BlurPostProcess>;
  74946. /**
  74947. * Post-process used to merge the volumetric light effect and the real scene color
  74948. */
  74949. volumetricLightMergePostProces: Nullable<PostProcess>;
  74950. /**
  74951. * Post-process used to store the final volumetric light post-process (attach/detach for debug purpose)
  74952. */
  74953. volumetricLightFinalPostProcess: Nullable<PostProcess>;
  74954. /**
  74955. * Base post-process used to calculate the average luminance of the final image for HDR
  74956. */
  74957. luminancePostProcess: Nullable<PostProcess>;
  74958. /**
  74959. * Post-processes used to create down sample post-processes in order to get
  74960. * the average luminance of the final image for HDR
  74961. * Array of length "StandardRenderingPipeline.LuminanceSteps"
  74962. */
  74963. luminanceDownSamplePostProcesses: PostProcess[];
  74964. /**
  74965. * Post-process used to create a HDR effect (light adaptation)
  74966. */
  74967. hdrPostProcess: Nullable<PostProcess>;
  74968. /**
  74969. * Post-process used to store the final texture adder post-process (attach/detach for debug purpose)
  74970. */
  74971. textureAdderFinalPostProcess: Nullable<PostProcess>;
  74972. /**
  74973. * Post-process used to store the final lens flare post-process (attach/detach for debug purpose)
  74974. */
  74975. lensFlareFinalPostProcess: Nullable<PostProcess>;
  74976. /**
  74977. * Post-process used to merge the final HDR post-process and the real scene color
  74978. */
  74979. hdrFinalPostProcess: Nullable<PostProcess>;
  74980. /**
  74981. * Post-process used to create a lens flare effect
  74982. */
  74983. lensFlarePostProcess: Nullable<PostProcess>;
  74984. /**
  74985. * Post-process that merges the result of the lens flare post-process and the real scene color
  74986. */
  74987. lensFlareComposePostProcess: Nullable<PostProcess>;
  74988. /**
  74989. * Post-process used to create a motion blur effect
  74990. */
  74991. motionBlurPostProcess: Nullable<PostProcess>;
  74992. /**
  74993. * Post-process used to create a depth of field effect
  74994. */
  74995. depthOfFieldPostProcess: Nullable<PostProcess>;
  74996. /**
  74997. * The Fast Approximate Anti-Aliasing post process which attemps to remove aliasing from an image.
  74998. */
  74999. fxaaPostProcess: Nullable<FxaaPostProcess>;
  75000. /**
  75001. * Post-process used to simulate realtime reflections using the screen space and geometry renderer.
  75002. */
  75003. screenSpaceReflectionPostProcess: Nullable<ScreenSpaceReflectionPostProcess>;
  75004. /**
  75005. * Represents the brightness threshold in order to configure the illuminated surfaces
  75006. */
  75007. brightThreshold: number;
  75008. /**
  75009. * Configures the blur intensity used for surexposed surfaces are highlighted surfaces (light halo)
  75010. */
  75011. blurWidth: number;
  75012. /**
  75013. * Sets if the blur for highlighted surfaces must be only horizontal
  75014. */
  75015. horizontalBlur: boolean;
  75016. /**
  75017. * Gets the overall exposure used by the pipeline
  75018. */
  75019. get exposure(): number;
  75020. /**
  75021. * Sets the overall exposure used by the pipeline
  75022. */
  75023. set exposure(value: number);
  75024. /**
  75025. * Texture used typically to simulate "dirty" on camera lens
  75026. */
  75027. lensTexture: Nullable<Texture>;
  75028. /**
  75029. * Represents the offset coefficient based on Rayleigh principle. Typically in interval [-0.2, 0.2]
  75030. */
  75031. volumetricLightCoefficient: number;
  75032. /**
  75033. * The overall power of volumetric lights, typically in interval [0, 10] maximum
  75034. */
  75035. volumetricLightPower: number;
  75036. /**
  75037. * Used the set the blur intensity to smooth the volumetric lights
  75038. */
  75039. volumetricLightBlurScale: number;
  75040. /**
  75041. * Light (spot or directional) used to generate the volumetric lights rays
  75042. * The source light must have a shadow generate so the pipeline can get its
  75043. * depth map
  75044. */
  75045. sourceLight: Nullable<SpotLight | DirectionalLight>;
  75046. /**
  75047. * For eye adaptation, represents the minimum luminance the eye can see
  75048. */
  75049. hdrMinimumLuminance: number;
  75050. /**
  75051. * For eye adaptation, represents the decrease luminance speed
  75052. */
  75053. hdrDecreaseRate: number;
  75054. /**
  75055. * For eye adaptation, represents the increase luminance speed
  75056. */
  75057. hdrIncreaseRate: number;
  75058. /**
  75059. * Gets wether or not the exposure of the overall pipeline should be automatically adjusted by the HDR post-process
  75060. */
  75061. get hdrAutoExposure(): boolean;
  75062. /**
  75063. * Sets wether or not the exposure of the overall pipeline should be automatically adjusted by the HDR post-process
  75064. */
  75065. set hdrAutoExposure(value: boolean);
  75066. /**
  75067. * Lens color texture used by the lens flare effect. Mandatory if lens flare effect enabled
  75068. */
  75069. lensColorTexture: Nullable<Texture>;
  75070. /**
  75071. * The overall strengh for the lens flare effect
  75072. */
  75073. lensFlareStrength: number;
  75074. /**
  75075. * Dispersion coefficient for lens flare ghosts
  75076. */
  75077. lensFlareGhostDispersal: number;
  75078. /**
  75079. * Main lens flare halo width
  75080. */
  75081. lensFlareHaloWidth: number;
  75082. /**
  75083. * Based on the lens distortion effect, defines how much the lens flare result
  75084. * is distorted
  75085. */
  75086. lensFlareDistortionStrength: number;
  75087. /**
  75088. * Configures the blur intensity used for for lens flare (halo)
  75089. */
  75090. lensFlareBlurWidth: number;
  75091. /**
  75092. * Lens star texture must be used to simulate rays on the flares and is available
  75093. * in the documentation
  75094. */
  75095. lensStarTexture: Nullable<Texture>;
  75096. /**
  75097. * As the "lensTexture" (can be the same texture or different), it is used to apply the lens
  75098. * flare effect by taking account of the dirt texture
  75099. */
  75100. lensFlareDirtTexture: Nullable<Texture>;
  75101. /**
  75102. * Represents the focal length for the depth of field effect
  75103. */
  75104. depthOfFieldDistance: number;
  75105. /**
  75106. * Represents the blur intensity for the blurred part of the depth of field effect
  75107. */
  75108. depthOfFieldBlurWidth: number;
  75109. /**
  75110. * Gets how much the image is blurred by the movement while using the motion blur post-process
  75111. */
  75112. get motionStrength(): number;
  75113. /**
  75114. * Sets how much the image is blurred by the movement while using the motion blur post-process
  75115. */
  75116. set motionStrength(strength: number);
  75117. /**
  75118. * Gets wether or not the motion blur post-process is object based or screen based.
  75119. */
  75120. get objectBasedMotionBlur(): boolean;
  75121. /**
  75122. * Sets wether or not the motion blur post-process should be object based or screen based
  75123. */
  75124. set objectBasedMotionBlur(value: boolean);
  75125. /**
  75126. * List of animations for the pipeline (IAnimatable implementation)
  75127. */
  75128. animations: Animation[];
  75129. /**
  75130. * Private members
  75131. */
  75132. private _scene;
  75133. private _currentDepthOfFieldSource;
  75134. private _basePostProcess;
  75135. private _fixedExposure;
  75136. private _currentExposure;
  75137. private _hdrAutoExposure;
  75138. private _hdrCurrentLuminance;
  75139. private _motionStrength;
  75140. private _isObjectBasedMotionBlur;
  75141. private _floatTextureType;
  75142. private _camerasToBeAttached;
  75143. private _ratio;
  75144. private _bloomEnabled;
  75145. private _depthOfFieldEnabled;
  75146. private _vlsEnabled;
  75147. private _lensFlareEnabled;
  75148. private _hdrEnabled;
  75149. private _motionBlurEnabled;
  75150. private _fxaaEnabled;
  75151. private _screenSpaceReflectionsEnabled;
  75152. private _motionBlurSamples;
  75153. private _volumetricLightStepsCount;
  75154. private _samples;
  75155. /**
  75156. * @ignore
  75157. * Specifies if the bloom pipeline is enabled
  75158. */
  75159. get BloomEnabled(): boolean;
  75160. set BloomEnabled(enabled: boolean);
  75161. /**
  75162. * @ignore
  75163. * Specifies if the depth of field pipeline is enabed
  75164. */
  75165. get DepthOfFieldEnabled(): boolean;
  75166. set DepthOfFieldEnabled(enabled: boolean);
  75167. /**
  75168. * @ignore
  75169. * Specifies if the lens flare pipeline is enabed
  75170. */
  75171. get LensFlareEnabled(): boolean;
  75172. set LensFlareEnabled(enabled: boolean);
  75173. /**
  75174. * @ignore
  75175. * Specifies if the HDR pipeline is enabled
  75176. */
  75177. get HDREnabled(): boolean;
  75178. set HDREnabled(enabled: boolean);
  75179. /**
  75180. * @ignore
  75181. * Specifies if the volumetric lights scattering effect is enabled
  75182. */
  75183. get VLSEnabled(): boolean;
  75184. set VLSEnabled(enabled: boolean);
  75185. /**
  75186. * @ignore
  75187. * Specifies if the motion blur effect is enabled
  75188. */
  75189. get MotionBlurEnabled(): boolean;
  75190. set MotionBlurEnabled(enabled: boolean);
  75191. /**
  75192. * Specifies if anti-aliasing is enabled
  75193. */
  75194. get fxaaEnabled(): boolean;
  75195. set fxaaEnabled(enabled: boolean);
  75196. /**
  75197. * Specifies if screen space reflections are enabled.
  75198. */
  75199. get screenSpaceReflectionsEnabled(): boolean;
  75200. set screenSpaceReflectionsEnabled(enabled: boolean);
  75201. /**
  75202. * Specifies the number of steps used to calculate the volumetric lights
  75203. * Typically in interval [50, 200]
  75204. */
  75205. get volumetricLightStepsCount(): number;
  75206. set volumetricLightStepsCount(count: number);
  75207. /**
  75208. * Specifies the number of samples used for the motion blur effect
  75209. * Typically in interval [16, 64]
  75210. */
  75211. get motionBlurSamples(): number;
  75212. set motionBlurSamples(samples: number);
  75213. /**
  75214. * Specifies MSAA sample count, setting this to 4 will provide 4x anti aliasing. (default: 1)
  75215. */
  75216. get samples(): number;
  75217. set samples(sampleCount: number);
  75218. /**
  75219. * Default pipeline should be used going forward but the standard pipeline will be kept for backwards compatibility.
  75220. * @constructor
  75221. * @param name The rendering pipeline name
  75222. * @param scene The scene linked to this pipeline
  75223. * @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)
  75224. * @param originalPostProcess the custom original color post-process. Must be "reusable". Can be null.
  75225. * @param cameras The array of cameras that the rendering pipeline will be attached to
  75226. */
  75227. constructor(name: string, scene: Scene, ratio: number, originalPostProcess?: Nullable<PostProcess>, cameras?: Camera[]);
  75228. private _buildPipeline;
  75229. private _createDownSampleX4PostProcess;
  75230. private _createBrightPassPostProcess;
  75231. private _createBlurPostProcesses;
  75232. private _createTextureAdderPostProcess;
  75233. private _createVolumetricLightPostProcess;
  75234. private _createLuminancePostProcesses;
  75235. private _createHdrPostProcess;
  75236. private _createLensFlarePostProcess;
  75237. private _createDepthOfFieldPostProcess;
  75238. private _createMotionBlurPostProcess;
  75239. private _getDepthTexture;
  75240. private _disposePostProcesses;
  75241. /**
  75242. * Dispose of the pipeline and stop all post processes
  75243. */
  75244. dispose(): void;
  75245. /**
  75246. * Serialize the rendering pipeline (Used when exporting)
  75247. * @returns the serialized object
  75248. */
  75249. serialize(): any;
  75250. /**
  75251. * Parse the serialized pipeline
  75252. * @param source Source pipeline.
  75253. * @param scene The scene to load the pipeline to.
  75254. * @param rootUrl The URL of the serialized pipeline.
  75255. * @returns An instantiated pipeline from the serialized object.
  75256. */
  75257. static Parse(source: any, scene: Scene, rootUrl: string): StandardRenderingPipeline;
  75258. /**
  75259. * Luminance steps
  75260. */
  75261. static LuminanceSteps: number;
  75262. }
  75263. }
  75264. declare module "babylonjs/PostProcesses/RenderPipeline/Pipelines/index" {
  75265. export * from "babylonjs/PostProcesses/RenderPipeline/Pipelines/defaultRenderingPipeline";
  75266. export * from "babylonjs/PostProcesses/RenderPipeline/Pipelines/lensRenderingPipeline";
  75267. export * from "babylonjs/PostProcesses/RenderPipeline/Pipelines/ssao2RenderingPipeline";
  75268. export * from "babylonjs/PostProcesses/RenderPipeline/Pipelines/ssaoRenderingPipeline";
  75269. export * from "babylonjs/PostProcesses/RenderPipeline/Pipelines/standardRenderingPipeline";
  75270. }
  75271. declare module "babylonjs/PostProcesses/RenderPipeline/index" {
  75272. export * from "babylonjs/PostProcesses/RenderPipeline/Pipelines/index";
  75273. export * from "babylonjs/PostProcesses/RenderPipeline/postProcessRenderEffect";
  75274. export * from "babylonjs/PostProcesses/RenderPipeline/postProcessRenderPipeline";
  75275. export * from "babylonjs/PostProcesses/RenderPipeline/postProcessRenderPipelineManager";
  75276. export * from "babylonjs/PostProcesses/RenderPipeline/postProcessRenderPipelineManagerSceneComponent";
  75277. }
  75278. declare module "babylonjs/Shaders/stereoscopicInterlace.fragment" {
  75279. /** @hidden */
  75280. export var stereoscopicInterlacePixelShader: {
  75281. name: string;
  75282. shader: string;
  75283. };
  75284. }
  75285. declare module "babylonjs/PostProcesses/stereoscopicInterlacePostProcess" {
  75286. import { Camera } from "babylonjs/Cameras/camera";
  75287. import { PostProcess } from "babylonjs/PostProcesses/postProcess";
  75288. import { Engine } from "babylonjs/Engines/engine";
  75289. import "babylonjs/Shaders/stereoscopicInterlace.fragment";
  75290. /**
  75291. * StereoscopicInterlacePostProcessI used to render stereo views from a rigged camera with support for alternate line interlacing
  75292. */
  75293. export class StereoscopicInterlacePostProcessI extends PostProcess {
  75294. private _stepSize;
  75295. private _passedProcess;
  75296. /**
  75297. * Gets a string identifying the name of the class
  75298. * @returns "StereoscopicInterlacePostProcessI" string
  75299. */
  75300. getClassName(): string;
  75301. /**
  75302. * Initializes a StereoscopicInterlacePostProcessI
  75303. * @param name The name of the effect.
  75304. * @param rigCameras The rig cameras to be appled to the post process
  75305. * @param isStereoscopicHoriz If the rendered results are horizontal or vertical
  75306. * @param isStereoscopicInterlaced If the rendered results are alternate line interlaced
  75307. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  75308. * @param engine The engine which the post process will be applied. (default: current engine)
  75309. * @param reusable If the post process can be reused on the same frame. (default: false)
  75310. */
  75311. constructor(name: string, rigCameras: Camera[], isStereoscopicHoriz: boolean, isStereoscopicInterlaced: boolean, samplingMode?: number, engine?: Engine, reusable?: boolean);
  75312. }
  75313. /**
  75314. * StereoscopicInterlacePostProcess used to render stereo views from a rigged camera
  75315. */
  75316. export class StereoscopicInterlacePostProcess extends PostProcess {
  75317. private _stepSize;
  75318. private _passedProcess;
  75319. /**
  75320. * Gets a string identifying the name of the class
  75321. * @returns "StereoscopicInterlacePostProcess" string
  75322. */
  75323. getClassName(): string;
  75324. /**
  75325. * Initializes a StereoscopicInterlacePostProcess
  75326. * @param name The name of the effect.
  75327. * @param rigCameras The rig cameras to be appled to the post process
  75328. * @param isStereoscopicHoriz If the rendered results are horizontal or verticle
  75329. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  75330. * @param engine The engine which the post process will be applied. (default: current engine)
  75331. * @param reusable If the post process can be reused on the same frame. (default: false)
  75332. */
  75333. constructor(name: string, rigCameras: Camera[], isStereoscopicHoriz: boolean, samplingMode?: number, engine?: Engine, reusable?: boolean);
  75334. }
  75335. }
  75336. declare module "babylonjs/Shaders/tonemap.fragment" {
  75337. /** @hidden */
  75338. export var tonemapPixelShader: {
  75339. name: string;
  75340. shader: string;
  75341. };
  75342. }
  75343. declare module "babylonjs/PostProcesses/tonemapPostProcess" {
  75344. import { Camera } from "babylonjs/Cameras/camera";
  75345. import { PostProcess } from "babylonjs/PostProcesses/postProcess";
  75346. import "babylonjs/Shaders/tonemap.fragment";
  75347. import { Engine } from "babylonjs/Engines/engine";
  75348. /** Defines operator used for tonemapping */
  75349. export enum TonemappingOperator {
  75350. /** Hable */
  75351. Hable = 0,
  75352. /** Reinhard */
  75353. Reinhard = 1,
  75354. /** HejiDawson */
  75355. HejiDawson = 2,
  75356. /** Photographic */
  75357. Photographic = 3
  75358. }
  75359. /**
  75360. * Defines a post process to apply tone mapping
  75361. */
  75362. export class TonemapPostProcess extends PostProcess {
  75363. private _operator;
  75364. /** Defines the required exposure adjustement */
  75365. exposureAdjustment: number;
  75366. /**
  75367. * Gets a string identifying the name of the class
  75368. * @returns "TonemapPostProcess" string
  75369. */
  75370. getClassName(): string;
  75371. /**
  75372. * Creates a new TonemapPostProcess
  75373. * @param name defines the name of the postprocess
  75374. * @param _operator defines the operator to use
  75375. * @param exposureAdjustment defines the required exposure adjustement
  75376. * @param camera defines the camera to use (can be null)
  75377. * @param samplingMode defines the required sampling mode (BABYLON.Texture.BILINEAR_SAMPLINGMODE by default)
  75378. * @param engine defines the hosting engine (can be ignore if camera is set)
  75379. * @param textureFormat defines the texture format to use (BABYLON.Engine.TEXTURETYPE_UNSIGNED_INT by default)
  75380. */
  75381. constructor(name: string, _operator: TonemappingOperator,
  75382. /** Defines the required exposure adjustement */
  75383. exposureAdjustment: number, camera: Camera, samplingMode?: number, engine?: Engine, textureFormat?: number);
  75384. }
  75385. }
  75386. declare module "babylonjs/Shaders/volumetricLightScattering.fragment" {
  75387. /** @hidden */
  75388. export var volumetricLightScatteringPixelShader: {
  75389. name: string;
  75390. shader: string;
  75391. };
  75392. }
  75393. declare module "babylonjs/Shaders/volumetricLightScatteringPass.vertex" {
  75394. import "babylonjs/Shaders/ShadersInclude/bonesDeclaration";
  75395. import "babylonjs/Shaders/ShadersInclude/morphTargetsVertexGlobalDeclaration";
  75396. import "babylonjs/Shaders/ShadersInclude/morphTargetsVertexDeclaration";
  75397. import "babylonjs/Shaders/ShadersInclude/instancesDeclaration";
  75398. import "babylonjs/Shaders/ShadersInclude/morphTargetsVertex";
  75399. import "babylonjs/Shaders/ShadersInclude/instancesVertex";
  75400. import "babylonjs/Shaders/ShadersInclude/bonesVertex";
  75401. /** @hidden */
  75402. export var volumetricLightScatteringPassVertexShader: {
  75403. name: string;
  75404. shader: string;
  75405. };
  75406. }
  75407. declare module "babylonjs/Shaders/volumetricLightScatteringPass.fragment" {
  75408. /** @hidden */
  75409. export var volumetricLightScatteringPassPixelShader: {
  75410. name: string;
  75411. shader: string;
  75412. };
  75413. }
  75414. declare module "babylonjs/PostProcesses/volumetricLightScatteringPostProcess" {
  75415. import { Vector3 } from "babylonjs/Maths/math.vector";
  75416. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  75417. import { Mesh } from "babylonjs/Meshes/mesh";
  75418. import { Camera } from "babylonjs/Cameras/camera";
  75419. import { RenderTargetTexture } from "babylonjs/Materials/Textures/renderTargetTexture";
  75420. import { PostProcess } from "babylonjs/PostProcesses/postProcess";
  75421. import { Scene } from "babylonjs/scene";
  75422. import "babylonjs/Meshes/Builders/planeBuilder";
  75423. import "babylonjs/Shaders/depth.vertex";
  75424. import "babylonjs/Shaders/volumetricLightScattering.fragment";
  75425. import "babylonjs/Shaders/volumetricLightScatteringPass.vertex";
  75426. import "babylonjs/Shaders/volumetricLightScatteringPass.fragment";
  75427. import { Engine } from "babylonjs/Engines/engine";
  75428. /**
  75429. * Inspired by http://http.developer.nvidia.com/GPUGems3/gpugems3_ch13.html
  75430. */
  75431. export class VolumetricLightScatteringPostProcess extends PostProcess {
  75432. private _volumetricLightScatteringPass;
  75433. private _volumetricLightScatteringRTT;
  75434. private _viewPort;
  75435. private _screenCoordinates;
  75436. private _cachedDefines;
  75437. /**
  75438. * If not undefined, the mesh position is computed from the attached node position
  75439. */
  75440. attachedNode: {
  75441. position: Vector3;
  75442. };
  75443. /**
  75444. * Custom position of the mesh. Used if "useCustomMeshPosition" is set to "true"
  75445. */
  75446. customMeshPosition: Vector3;
  75447. /**
  75448. * Set if the post-process should use a custom position for the light source (true) or the internal mesh position (false)
  75449. */
  75450. useCustomMeshPosition: boolean;
  75451. /**
  75452. * If the post-process should inverse the light scattering direction
  75453. */
  75454. invert: boolean;
  75455. /**
  75456. * The internal mesh used by the post-process
  75457. */
  75458. mesh: Mesh;
  75459. /**
  75460. * @hidden
  75461. * VolumetricLightScatteringPostProcess.useDiffuseColor is no longer used, use the mesh material directly instead
  75462. */
  75463. get useDiffuseColor(): boolean;
  75464. set useDiffuseColor(useDiffuseColor: boolean);
  75465. /**
  75466. * Array containing the excluded meshes not rendered in the internal pass
  75467. */
  75468. excludedMeshes: AbstractMesh[];
  75469. /**
  75470. * Controls the overall intensity of the post-process
  75471. */
  75472. exposure: number;
  75473. /**
  75474. * Dissipates each sample's contribution in range [0, 1]
  75475. */
  75476. decay: number;
  75477. /**
  75478. * Controls the overall intensity of each sample
  75479. */
  75480. weight: number;
  75481. /**
  75482. * Controls the density of each sample
  75483. */
  75484. density: number;
  75485. /**
  75486. * @constructor
  75487. * @param name The post-process name
  75488. * @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)
  75489. * @param camera The camera that the post-process will be attached to
  75490. * @param mesh The mesh used to create the light scattering
  75491. * @param samples The post-process quality, default 100
  75492. * @param samplingModeThe post-process filtering mode
  75493. * @param engine The babylon engine
  75494. * @param reusable If the post-process is reusable
  75495. * @param scene The constructor needs a scene reference to initialize internal components. If "camera" is null a "scene" must be provided
  75496. */
  75497. constructor(name: string, ratio: any, camera: Camera, mesh?: Mesh, samples?: number, samplingMode?: number, engine?: Engine, reusable?: boolean, scene?: Scene);
  75498. /**
  75499. * Returns the string "VolumetricLightScatteringPostProcess"
  75500. * @returns "VolumetricLightScatteringPostProcess"
  75501. */
  75502. getClassName(): string;
  75503. private _isReady;
  75504. /**
  75505. * Sets the new light position for light scattering effect
  75506. * @param position The new custom light position
  75507. */
  75508. setCustomMeshPosition(position: Vector3): void;
  75509. /**
  75510. * Returns the light position for light scattering effect
  75511. * @return Vector3 The custom light position
  75512. */
  75513. getCustomMeshPosition(): Vector3;
  75514. /**
  75515. * Disposes the internal assets and detaches the post-process from the camera
  75516. */
  75517. dispose(camera: Camera): void;
  75518. /**
  75519. * Returns the render target texture used by the post-process
  75520. * @return the render target texture used by the post-process
  75521. */
  75522. getPass(): RenderTargetTexture;
  75523. private _meshExcluded;
  75524. private _createPass;
  75525. private _updateMeshScreenCoordinates;
  75526. /**
  75527. * Creates a default mesh for the Volumeric Light Scattering post-process
  75528. * @param name The mesh name
  75529. * @param scene The scene where to create the mesh
  75530. * @return the default mesh
  75531. */
  75532. static CreateDefaultMesh(name: string, scene: Scene): Mesh;
  75533. }
  75534. }
  75535. declare module "babylonjs/Shaders/screenSpaceCurvature.fragment" {
  75536. /** @hidden */
  75537. export var screenSpaceCurvaturePixelShader: {
  75538. name: string;
  75539. shader: string;
  75540. };
  75541. }
  75542. declare module "babylonjs/PostProcesses/screenSpaceCurvaturePostProcess" {
  75543. import { Nullable } from "babylonjs/types";
  75544. import { Camera } from "babylonjs/Cameras/camera";
  75545. import { PostProcess, PostProcessOptions } from "babylonjs/PostProcesses/postProcess";
  75546. import "babylonjs/Rendering/geometryBufferRendererSceneComponent";
  75547. import "babylonjs/Shaders/screenSpaceCurvature.fragment";
  75548. import { Engine } from "babylonjs/Engines/engine";
  75549. import { Scene } from "babylonjs/scene";
  75550. /**
  75551. * The Screen Space curvature effect can help highlighting ridge and valley of a model.
  75552. */
  75553. export class ScreenSpaceCurvaturePostProcess extends PostProcess {
  75554. /**
  75555. * Defines how much ridge the curvature effect displays.
  75556. */
  75557. ridge: number;
  75558. /**
  75559. * Defines how much valley the curvature effect displays.
  75560. */
  75561. valley: number;
  75562. private _geometryBufferRenderer;
  75563. /**
  75564. * Gets a string identifying the name of the class
  75565. * @returns "ScreenSpaceCurvaturePostProcess" string
  75566. */
  75567. getClassName(): string;
  75568. /**
  75569. * Creates a new instance ScreenSpaceCurvaturePostProcess
  75570. * @param name The name of the effect.
  75571. * @param scene The scene containing the objects to blur according to their velocity.
  75572. * @param options The required width/height ratio to downsize to before computing the render pass.
  75573. * @param camera The camera to apply the render pass to.
  75574. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  75575. * @param engine The engine which the post process will be applied. (default: current engine)
  75576. * @param reusable If the post process can be reused on the same frame. (default: false)
  75577. * @param textureType Type of textures used when performing the post process. (default: 0)
  75578. * @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)
  75579. */
  75580. constructor(name: string, scene: Scene, options: number | PostProcessOptions, camera: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number, blockCompilation?: boolean);
  75581. /**
  75582. * Support test.
  75583. */
  75584. static get IsSupported(): boolean;
  75585. /** @hidden */
  75586. static _Parse(parsedPostProcess: any, targetCamera: Camera, scene: Scene, rootUrl: string): ScreenSpaceCurvaturePostProcess;
  75587. }
  75588. }
  75589. declare module "babylonjs/PostProcesses/index" {
  75590. export * from "babylonjs/PostProcesses/anaglyphPostProcess";
  75591. export * from "babylonjs/PostProcesses/blackAndWhitePostProcess";
  75592. export * from "babylonjs/PostProcesses/bloomEffect";
  75593. export * from "babylonjs/PostProcesses/bloomMergePostProcess";
  75594. export * from "babylonjs/PostProcesses/blurPostProcess";
  75595. export * from "babylonjs/PostProcesses/chromaticAberrationPostProcess";
  75596. export * from "babylonjs/PostProcesses/circleOfConfusionPostProcess";
  75597. export * from "babylonjs/PostProcesses/colorCorrectionPostProcess";
  75598. export * from "babylonjs/PostProcesses/convolutionPostProcess";
  75599. export * from "babylonjs/PostProcesses/depthOfFieldBlurPostProcess";
  75600. export * from "babylonjs/PostProcesses/depthOfFieldEffect";
  75601. export * from "babylonjs/PostProcesses/depthOfFieldMergePostProcess";
  75602. export * from "babylonjs/PostProcesses/displayPassPostProcess";
  75603. export * from "babylonjs/PostProcesses/extractHighlightsPostProcess";
  75604. export * from "babylonjs/PostProcesses/filterPostProcess";
  75605. export * from "babylonjs/PostProcesses/fxaaPostProcess";
  75606. export * from "babylonjs/PostProcesses/grainPostProcess";
  75607. export * from "babylonjs/PostProcesses/highlightsPostProcess";
  75608. export * from "babylonjs/PostProcesses/imageProcessingPostProcess";
  75609. export * from "babylonjs/PostProcesses/motionBlurPostProcess";
  75610. export * from "babylonjs/PostProcesses/passPostProcess";
  75611. export * from "babylonjs/PostProcesses/postProcess";
  75612. export * from "babylonjs/PostProcesses/postProcessManager";
  75613. export * from "babylonjs/PostProcesses/refractionPostProcess";
  75614. export * from "babylonjs/PostProcesses/RenderPipeline/index";
  75615. export * from "babylonjs/PostProcesses/sharpenPostProcess";
  75616. export * from "babylonjs/PostProcesses/stereoscopicInterlacePostProcess";
  75617. export * from "babylonjs/PostProcesses/tonemapPostProcess";
  75618. export * from "babylonjs/PostProcesses/volumetricLightScatteringPostProcess";
  75619. export * from "babylonjs/PostProcesses/vrDistortionCorrectionPostProcess";
  75620. export * from "babylonjs/PostProcesses/vrMultiviewToSingleviewPostProcess";
  75621. export * from "babylonjs/PostProcesses/screenSpaceReflectionPostProcess";
  75622. export * from "babylonjs/PostProcesses/screenSpaceCurvaturePostProcess";
  75623. }
  75624. declare module "babylonjs/Probes/index" {
  75625. export * from "babylonjs/Probes/reflectionProbe";
  75626. }
  75627. declare module "babylonjs/Rendering/boundingBoxRenderer" {
  75628. import { Scene } from "babylonjs/scene";
  75629. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  75630. import { SmartArray } from "babylonjs/Misc/smartArray";
  75631. import { ISceneComponent } from "babylonjs/sceneComponent";
  75632. import { BoundingBox } from "babylonjs/Culling/boundingBox";
  75633. import "babylonjs/Meshes/Builders/boxBuilder";
  75634. import "babylonjs/Shaders/color.fragment";
  75635. import "babylonjs/Shaders/color.vertex";
  75636. import { Color3 } from "babylonjs/Maths/math.color";
  75637. import { Observable } from "babylonjs/Misc/observable";
  75638. module "babylonjs/scene" {
  75639. interface Scene {
  75640. /** @hidden (Backing field) */
  75641. _boundingBoxRenderer: BoundingBoxRenderer;
  75642. /** @hidden (Backing field) */
  75643. _forceShowBoundingBoxes: boolean;
  75644. /**
  75645. * Gets or sets a boolean indicating if all bounding boxes must be rendered
  75646. */
  75647. forceShowBoundingBoxes: boolean;
  75648. /**
  75649. * Gets the bounding box renderer associated with the scene
  75650. * @returns a BoundingBoxRenderer
  75651. */
  75652. getBoundingBoxRenderer(): BoundingBoxRenderer;
  75653. }
  75654. }
  75655. module "babylonjs/Meshes/abstractMesh" {
  75656. interface AbstractMesh {
  75657. /** @hidden (Backing field) */
  75658. _showBoundingBox: boolean;
  75659. /**
  75660. * Gets or sets a boolean indicating if the bounding box must be rendered as well (false by default)
  75661. */
  75662. showBoundingBox: boolean;
  75663. }
  75664. }
  75665. /**
  75666. * Component responsible of rendering the bounding box of the meshes in a scene.
  75667. * This is usually used through the mesh.showBoundingBox or the scene.forceShowBoundingBoxes properties
  75668. */
  75669. export class BoundingBoxRenderer implements ISceneComponent {
  75670. /**
  75671. * The component name helpfull to identify the component in the list of scene components.
  75672. */
  75673. readonly name: string;
  75674. /**
  75675. * The scene the component belongs to.
  75676. */
  75677. scene: Scene;
  75678. /**
  75679. * Color of the bounding box lines placed in front of an object
  75680. */
  75681. frontColor: Color3;
  75682. /**
  75683. * Color of the bounding box lines placed behind an object
  75684. */
  75685. backColor: Color3;
  75686. /**
  75687. * Defines if the renderer should show the back lines or not
  75688. */
  75689. showBackLines: boolean;
  75690. /**
  75691. * Observable raised before rendering a bounding box
  75692. */
  75693. onBeforeBoxRenderingObservable: Observable<BoundingBox>;
  75694. /**
  75695. * Observable raised after rendering a bounding box
  75696. */
  75697. onAfterBoxRenderingObservable: Observable<BoundingBox>;
  75698. /**
  75699. * @hidden
  75700. */
  75701. renderList: SmartArray<BoundingBox>;
  75702. private _colorShader;
  75703. private _vertexBuffers;
  75704. private _indexBuffer;
  75705. private _fillIndexBuffer;
  75706. private _fillIndexData;
  75707. /**
  75708. * Instantiates a new bounding box renderer in a scene.
  75709. * @param scene the scene the renderer renders in
  75710. */
  75711. constructor(scene: Scene);
  75712. /**
  75713. * Registers the component in a given scene
  75714. */
  75715. register(): void;
  75716. private _evaluateSubMesh;
  75717. private _activeMesh;
  75718. private _prepareRessources;
  75719. private _createIndexBuffer;
  75720. /**
  75721. * Rebuilds the elements related to this component in case of
  75722. * context lost for instance.
  75723. */
  75724. rebuild(): void;
  75725. /**
  75726. * @hidden
  75727. */
  75728. reset(): void;
  75729. /**
  75730. * Render the bounding boxes of a specific rendering group
  75731. * @param renderingGroupId defines the rendering group to render
  75732. */
  75733. render(renderingGroupId: number): void;
  75734. /**
  75735. * In case of occlusion queries, we can render the occlusion bounding box through this method
  75736. * @param mesh Define the mesh to render the occlusion bounding box for
  75737. */
  75738. renderOcclusionBoundingBox(mesh: AbstractMesh): void;
  75739. /**
  75740. * Dispose and release the resources attached to this renderer.
  75741. */
  75742. dispose(): void;
  75743. }
  75744. }
  75745. declare module "babylonjs/Rendering/depthRendererSceneComponent" {
  75746. import { Nullable } from "babylonjs/types";
  75747. import { Scene } from "babylonjs/scene";
  75748. import { DepthRenderer } from "babylonjs/Rendering/depthRenderer";
  75749. import { Camera } from "babylonjs/Cameras/camera";
  75750. import { ISceneComponent } from "babylonjs/sceneComponent";
  75751. module "babylonjs/scene" {
  75752. interface Scene {
  75753. /** @hidden (Backing field) */
  75754. _depthRenderer: {
  75755. [id: string]: DepthRenderer;
  75756. };
  75757. /**
  75758. * Creates a depth renderer a given camera which contains a depth map which can be used for post processing.
  75759. * @param camera The camera to create the depth renderer on (default: scene's active camera)
  75760. * @param storeNonLinearDepth Defines whether the depth is stored linearly like in Babylon Shadows or directly like glFragCoord.z
  75761. * @returns the created depth renderer
  75762. */
  75763. enableDepthRenderer(camera?: Nullable<Camera>, storeNonLinearDepth?: boolean): DepthRenderer;
  75764. /**
  75765. * Disables a depth renderer for a given camera
  75766. * @param camera The camera to disable the depth renderer on (default: scene's active camera)
  75767. */
  75768. disableDepthRenderer(camera?: Nullable<Camera>): void;
  75769. }
  75770. }
  75771. /**
  75772. * Defines the Depth Renderer scene component responsible to manage a depth buffer useful
  75773. * in several rendering techniques.
  75774. */
  75775. export class DepthRendererSceneComponent implements ISceneComponent {
  75776. /**
  75777. * The component name helpfull to identify the component in the list of scene components.
  75778. */
  75779. readonly name: string;
  75780. /**
  75781. * The scene the component belongs to.
  75782. */
  75783. scene: Scene;
  75784. /**
  75785. * Creates a new instance of the component for the given scene
  75786. * @param scene Defines the scene to register the component in
  75787. */
  75788. constructor(scene: Scene);
  75789. /**
  75790. * Registers the component in a given scene
  75791. */
  75792. register(): void;
  75793. /**
  75794. * Rebuilds the elements related to this component in case of
  75795. * context lost for instance.
  75796. */
  75797. rebuild(): void;
  75798. /**
  75799. * Disposes the component and the associated ressources
  75800. */
  75801. dispose(): void;
  75802. private _gatherRenderTargets;
  75803. private _gatherActiveCameraRenderTargets;
  75804. }
  75805. }
  75806. declare module "babylonjs/Rendering/prePassRendererSceneComponent" {
  75807. import { Nullable } from "babylonjs/types";
  75808. import { Scene } from "babylonjs/scene";
  75809. import { ISceneSerializableComponent } from "babylonjs/sceneComponent";
  75810. import { PrePassRenderer } from "babylonjs/Rendering/prePassRenderer";
  75811. import { AbstractScene } from "babylonjs/abstractScene";
  75812. module "babylonjs/abstractScene" {
  75813. interface AbstractScene {
  75814. /** @hidden (Backing field) */
  75815. _prePassRenderer: Nullable<PrePassRenderer>;
  75816. /**
  75817. * Gets or Sets the current prepass renderer associated to the scene.
  75818. */
  75819. prePassRenderer: Nullable<PrePassRenderer>;
  75820. /**
  75821. * Enables the prepass and associates it with the scene
  75822. * @returns the PrePassRenderer
  75823. */
  75824. enablePrePassRenderer(): Nullable<PrePassRenderer>;
  75825. /**
  75826. * Disables the prepass associated with the scene
  75827. */
  75828. disablePrePassRenderer(): void;
  75829. }
  75830. }
  75831. /**
  75832. * Defines the Geometry Buffer scene component responsible to manage a G-Buffer useful
  75833. * in several rendering techniques.
  75834. */
  75835. export class PrePassRendererSceneComponent implements ISceneSerializableComponent {
  75836. /**
  75837. * The component name helpful to identify the component in the list of scene components.
  75838. */
  75839. readonly name: string;
  75840. /**
  75841. * The scene the component belongs to.
  75842. */
  75843. scene: Scene;
  75844. /**
  75845. * Creates a new instance of the component for the given scene
  75846. * @param scene Defines the scene to register the component in
  75847. */
  75848. constructor(scene: Scene);
  75849. /**
  75850. * Registers the component in a given scene
  75851. */
  75852. register(): void;
  75853. private _beforeCameraDraw;
  75854. private _afterCameraDraw;
  75855. private _beforeClearStage;
  75856. /**
  75857. * Serializes the component data to the specified json object
  75858. * @param serializationObject The object to serialize to
  75859. */
  75860. serialize(serializationObject: any): void;
  75861. /**
  75862. * Adds all the elements from the container to the scene
  75863. * @param container the container holding the elements
  75864. */
  75865. addFromContainer(container: AbstractScene): void;
  75866. /**
  75867. * Removes all the elements in the container from the scene
  75868. * @param container contains the elements to remove
  75869. * @param dispose if the removed element should be disposed (default: false)
  75870. */
  75871. removeFromContainer(container: AbstractScene, dispose?: boolean): void;
  75872. /**
  75873. * Rebuilds the elements related to this component in case of
  75874. * context lost for instance.
  75875. */
  75876. rebuild(): void;
  75877. /**
  75878. * Disposes the component and the associated ressources
  75879. */
  75880. dispose(): void;
  75881. }
  75882. }
  75883. declare module "babylonjs/Shaders/outline.fragment" {
  75884. import "babylonjs/Shaders/ShadersInclude/logDepthDeclaration";
  75885. import "babylonjs/Shaders/ShadersInclude/logDepthFragment";
  75886. /** @hidden */
  75887. export var outlinePixelShader: {
  75888. name: string;
  75889. shader: string;
  75890. };
  75891. }
  75892. declare module "babylonjs/Shaders/outline.vertex" {
  75893. import "babylonjs/Shaders/ShadersInclude/bonesDeclaration";
  75894. import "babylonjs/Shaders/ShadersInclude/morphTargetsVertexGlobalDeclaration";
  75895. import "babylonjs/Shaders/ShadersInclude/morphTargetsVertexDeclaration";
  75896. import "babylonjs/Shaders/ShadersInclude/instancesDeclaration";
  75897. import "babylonjs/Shaders/ShadersInclude/logDepthDeclaration";
  75898. import "babylonjs/Shaders/ShadersInclude/morphTargetsVertex";
  75899. import "babylonjs/Shaders/ShadersInclude/instancesVertex";
  75900. import "babylonjs/Shaders/ShadersInclude/bonesVertex";
  75901. import "babylonjs/Shaders/ShadersInclude/logDepthVertex";
  75902. /** @hidden */
  75903. export var outlineVertexShader: {
  75904. name: string;
  75905. shader: string;
  75906. };
  75907. }
  75908. declare module "babylonjs/Rendering/outlineRenderer" {
  75909. import { SubMesh } from "babylonjs/Meshes/subMesh";
  75910. import { _InstancesBatch } from "babylonjs/Meshes/mesh";
  75911. import { Scene } from "babylonjs/scene";
  75912. import { ISceneComponent } from "babylonjs/sceneComponent";
  75913. import "babylonjs/Shaders/outline.fragment";
  75914. import "babylonjs/Shaders/outline.vertex";
  75915. module "babylonjs/scene" {
  75916. interface Scene {
  75917. /** @hidden */
  75918. _outlineRenderer: OutlineRenderer;
  75919. /**
  75920. * Gets the outline renderer associated with the scene
  75921. * @returns a OutlineRenderer
  75922. */
  75923. getOutlineRenderer(): OutlineRenderer;
  75924. }
  75925. }
  75926. module "babylonjs/Meshes/abstractMesh" {
  75927. interface AbstractMesh {
  75928. /** @hidden (Backing field) */
  75929. _renderOutline: boolean;
  75930. /**
  75931. * Gets or sets a boolean indicating if the outline must be rendered as well
  75932. * @see https://www.babylonjs-playground.com/#10WJ5S#3
  75933. */
  75934. renderOutline: boolean;
  75935. /** @hidden (Backing field) */
  75936. _renderOverlay: boolean;
  75937. /**
  75938. * Gets or sets a boolean indicating if the overlay must be rendered as well
  75939. * @see https://www.babylonjs-playground.com/#10WJ5S#2
  75940. */
  75941. renderOverlay: boolean;
  75942. }
  75943. }
  75944. /**
  75945. * This class is responsible to draw bothe outline/overlay of meshes.
  75946. * It should not be used directly but through the available method on mesh.
  75947. */
  75948. export class OutlineRenderer implements ISceneComponent {
  75949. /**
  75950. * Stencil value used to avoid outline being seen within the mesh when the mesh is transparent
  75951. */
  75952. private static _StencilReference;
  75953. /**
  75954. * The name of the component. Each component must have a unique name.
  75955. */
  75956. name: string;
  75957. /**
  75958. * The scene the component belongs to.
  75959. */
  75960. scene: Scene;
  75961. /**
  75962. * Defines a zOffset to prevent zFighting between the overlay and the mesh.
  75963. */
  75964. zOffset: number;
  75965. private _engine;
  75966. private _effect;
  75967. private _cachedDefines;
  75968. private _savedDepthWrite;
  75969. /**
  75970. * Instantiates a new outline renderer. (There could be only one per scene).
  75971. * @param scene Defines the scene it belongs to
  75972. */
  75973. constructor(scene: Scene);
  75974. /**
  75975. * Register the component to one instance of a scene.
  75976. */
  75977. register(): void;
  75978. /**
  75979. * Rebuilds the elements related to this component in case of
  75980. * context lost for instance.
  75981. */
  75982. rebuild(): void;
  75983. /**
  75984. * Disposes the component and the associated ressources.
  75985. */
  75986. dispose(): void;
  75987. /**
  75988. * Renders the outline in the canvas.
  75989. * @param subMesh Defines the sumesh to render
  75990. * @param batch Defines the batch of meshes in case of instances
  75991. * @param useOverlay Defines if the rendering is for the overlay or the outline
  75992. */
  75993. render(subMesh: SubMesh, batch: _InstancesBatch, useOverlay?: boolean): void;
  75994. /**
  75995. * Returns whether or not the outline renderer is ready for a given submesh.
  75996. * All the dependencies e.g. submeshes, texture, effect... mus be ready
  75997. * @param subMesh Defines the submesh to check readyness for
  75998. * @param useInstances Defines wheter wee are trying to render instances or not
  75999. * @returns true if ready otherwise false
  76000. */
  76001. isReady(subMesh: SubMesh, useInstances: boolean): boolean;
  76002. private _beforeRenderingMesh;
  76003. private _afterRenderingMesh;
  76004. }
  76005. }
  76006. declare module "babylonjs/Rendering/index" {
  76007. export * from "babylonjs/Rendering/boundingBoxRenderer";
  76008. export * from "babylonjs/Rendering/depthRenderer";
  76009. export * from "babylonjs/Rendering/depthRendererSceneComponent";
  76010. export * from "babylonjs/Rendering/edgesRenderer";
  76011. export * from "babylonjs/Rendering/geometryBufferRenderer";
  76012. export * from "babylonjs/Rendering/geometryBufferRendererSceneComponent";
  76013. export * from "babylonjs/Rendering/prePassRenderer";
  76014. export * from "babylonjs/Rendering/prePassRendererSceneComponent";
  76015. export * from "babylonjs/Rendering/outlineRenderer";
  76016. export * from "babylonjs/Rendering/renderingGroup";
  76017. export * from "babylonjs/Rendering/renderingManager";
  76018. export * from "babylonjs/Rendering/utilityLayerRenderer";
  76019. }
  76020. declare module "babylonjs/Sprites/ISprites" {
  76021. /**
  76022. * Defines the basic options interface of a Sprite Frame Source Size.
  76023. */
  76024. export interface ISpriteJSONSpriteSourceSize {
  76025. /**
  76026. * number of the original width of the Frame
  76027. */
  76028. w: number;
  76029. /**
  76030. * number of the original height of the Frame
  76031. */
  76032. h: number;
  76033. }
  76034. /**
  76035. * Defines the basic options interface of a Sprite Frame Data.
  76036. */
  76037. export interface ISpriteJSONSpriteFrameData {
  76038. /**
  76039. * number of the x offset of the Frame
  76040. */
  76041. x: number;
  76042. /**
  76043. * number of the y offset of the Frame
  76044. */
  76045. y: number;
  76046. /**
  76047. * number of the width of the Frame
  76048. */
  76049. w: number;
  76050. /**
  76051. * number of the height of the Frame
  76052. */
  76053. h: number;
  76054. }
  76055. /**
  76056. * Defines the basic options interface of a JSON Sprite.
  76057. */
  76058. export interface ISpriteJSONSprite {
  76059. /**
  76060. * string name of the Frame
  76061. */
  76062. filename: string;
  76063. /**
  76064. * ISpriteJSONSpriteFrame basic object of the frame data
  76065. */
  76066. frame: ISpriteJSONSpriteFrameData;
  76067. /**
  76068. * boolean to flag is the frame was rotated.
  76069. */
  76070. rotated: boolean;
  76071. /**
  76072. * boolean to flag is the frame was trimmed.
  76073. */
  76074. trimmed: boolean;
  76075. /**
  76076. * ISpriteJSONSpriteFrame basic object of the source data
  76077. */
  76078. spriteSourceSize: ISpriteJSONSpriteFrameData;
  76079. /**
  76080. * ISpriteJSONSpriteFrame basic object of the source data
  76081. */
  76082. sourceSize: ISpriteJSONSpriteSourceSize;
  76083. }
  76084. /**
  76085. * Defines the basic options interface of a JSON atlas.
  76086. */
  76087. export interface ISpriteJSONAtlas {
  76088. /**
  76089. * Array of objects that contain the frame data.
  76090. */
  76091. frames: Array<ISpriteJSONSprite>;
  76092. /**
  76093. * object basic object containing the sprite meta data.
  76094. */
  76095. meta?: object;
  76096. }
  76097. }
  76098. declare module "babylonjs/Shaders/spriteMap.fragment" {
  76099. /** @hidden */
  76100. export var spriteMapPixelShader: {
  76101. name: string;
  76102. shader: string;
  76103. };
  76104. }
  76105. declare module "babylonjs/Shaders/spriteMap.vertex" {
  76106. /** @hidden */
  76107. export var spriteMapVertexShader: {
  76108. name: string;
  76109. shader: string;
  76110. };
  76111. }
  76112. declare module "babylonjs/Sprites/spriteMap" {
  76113. import { IDisposable, Scene } from "babylonjs/scene";
  76114. import { Vector2, Vector3 } from "babylonjs/Maths/math.vector";
  76115. import { Texture } from "babylonjs/Materials/Textures/texture";
  76116. import { RawTexture } from "babylonjs/Materials/Textures/rawTexture";
  76117. import { ISpriteJSONSprite, ISpriteJSONAtlas } from "babylonjs/Sprites/ISprites";
  76118. import "babylonjs/Meshes/Builders/planeBuilder";
  76119. import "babylonjs/Shaders/spriteMap.fragment";
  76120. import "babylonjs/Shaders/spriteMap.vertex";
  76121. /**
  76122. * Defines the basic options interface of a SpriteMap
  76123. */
  76124. export interface ISpriteMapOptions {
  76125. /**
  76126. * Vector2 of the number of cells in the grid.
  76127. */
  76128. stageSize?: Vector2;
  76129. /**
  76130. * Vector2 of the size of the output plane in World Units.
  76131. */
  76132. outputSize?: Vector2;
  76133. /**
  76134. * Vector3 of the position of the output plane in World Units.
  76135. */
  76136. outputPosition?: Vector3;
  76137. /**
  76138. * Vector3 of the rotation of the output plane.
  76139. */
  76140. outputRotation?: Vector3;
  76141. /**
  76142. * number of layers that the system will reserve in resources.
  76143. */
  76144. layerCount?: number;
  76145. /**
  76146. * number of max animation frames a single cell will reserve in resources.
  76147. */
  76148. maxAnimationFrames?: number;
  76149. /**
  76150. * number cell index of the base tile when the system compiles.
  76151. */
  76152. baseTile?: number;
  76153. /**
  76154. * boolean flip the sprite after its been repositioned by the framing data.
  76155. */
  76156. flipU?: boolean;
  76157. /**
  76158. * Vector3 scalar of the global RGB values of the SpriteMap.
  76159. */
  76160. colorMultiply?: Vector3;
  76161. }
  76162. /**
  76163. * Defines the IDisposable interface in order to be cleanable from resources.
  76164. */
  76165. export interface ISpriteMap extends IDisposable {
  76166. /**
  76167. * String name of the SpriteMap.
  76168. */
  76169. name: string;
  76170. /**
  76171. * The JSON Array file from a https://www.codeandweb.com/texturepacker export. Or similar structure.
  76172. */
  76173. atlasJSON: ISpriteJSONAtlas;
  76174. /**
  76175. * Texture of the SpriteMap.
  76176. */
  76177. spriteSheet: Texture;
  76178. /**
  76179. * The parameters to initialize the SpriteMap with.
  76180. */
  76181. options: ISpriteMapOptions;
  76182. }
  76183. /**
  76184. * Class used to manage a grid restricted sprite deployment on an Output plane.
  76185. */
  76186. export class SpriteMap implements ISpriteMap {
  76187. /** The Name of the spriteMap */
  76188. name: string;
  76189. /** The JSON file with the frame and meta data */
  76190. atlasJSON: ISpriteJSONAtlas;
  76191. /** The systems Sprite Sheet Texture */
  76192. spriteSheet: Texture;
  76193. /** Arguments passed with the Constructor */
  76194. options: ISpriteMapOptions;
  76195. /** Public Sprite Storage array, parsed from atlasJSON */
  76196. sprites: Array<ISpriteJSONSprite>;
  76197. /** Returns the Number of Sprites in the System */
  76198. get spriteCount(): number;
  76199. /** Returns the Position of Output Plane*/
  76200. get position(): Vector3;
  76201. /** Returns the Position of Output Plane*/
  76202. set position(v: Vector3);
  76203. /** Returns the Rotation of Output Plane*/
  76204. get rotation(): Vector3;
  76205. /** Returns the Rotation of Output Plane*/
  76206. set rotation(v: Vector3);
  76207. /** Sets the AnimationMap*/
  76208. get animationMap(): RawTexture;
  76209. /** Sets the AnimationMap*/
  76210. set animationMap(v: RawTexture);
  76211. /** Scene that the SpriteMap was created in */
  76212. private _scene;
  76213. /** Texture Buffer of Float32 that holds tile frame data*/
  76214. private _frameMap;
  76215. /** Texture Buffers of Float32 that holds tileMap data*/
  76216. private _tileMaps;
  76217. /** Texture Buffer of Float32 that holds Animation Data*/
  76218. private _animationMap;
  76219. /** Custom ShaderMaterial Central to the System*/
  76220. private _material;
  76221. /** Custom ShaderMaterial Central to the System*/
  76222. private _output;
  76223. /** Systems Time Ticker*/
  76224. private _time;
  76225. /**
  76226. * Creates a new SpriteMap
  76227. * @param name defines the SpriteMaps Name
  76228. * @param atlasJSON is the JSON file that controls the Sprites Frames and Meta
  76229. * @param spriteSheet is the Texture that the Sprites are on.
  76230. * @param options a basic deployment configuration
  76231. * @param scene The Scene that the map is deployed on
  76232. */
  76233. constructor(name: string, atlasJSON: ISpriteJSONAtlas, spriteSheet: Texture, options: ISpriteMapOptions, scene: Scene);
  76234. /**
  76235. * Returns tileID location
  76236. * @returns Vector2 the cell position ID
  76237. */
  76238. getTileID(): Vector2;
  76239. /**
  76240. * Gets the UV location of the mouse over the SpriteMap.
  76241. * @returns Vector2 the UV position of the mouse interaction
  76242. */
  76243. getMousePosition(): Vector2;
  76244. /**
  76245. * Creates the "frame" texture Buffer
  76246. * -------------------------------------
  76247. * Structure of frames
  76248. * "filename": "Falling-Water-2.png",
  76249. * "frame": {"x":69,"y":103,"w":24,"h":32},
  76250. * "rotated": true,
  76251. * "trimmed": true,
  76252. * "spriteSourceSize": {"x":4,"y":0,"w":24,"h":32},
  76253. * "sourceSize": {"w":32,"h":32}
  76254. * @returns RawTexture of the frameMap
  76255. */
  76256. private _createFrameBuffer;
  76257. /**
  76258. * Creates the tileMap texture Buffer
  76259. * @param buffer normally and array of numbers, or a false to generate from scratch
  76260. * @param _layer indicates what layer for a logic trigger dealing with the baseTile. The system uses this
  76261. * @returns RawTexture of the tileMap
  76262. */
  76263. private _createTileBuffer;
  76264. /**
  76265. * Modifies the data of the tileMaps
  76266. * @param _layer is the ID of the layer you want to edit on the SpriteMap
  76267. * @param pos is the iVector2 Coordinates of the Tile
  76268. * @param tile The SpriteIndex of the new Tile
  76269. */
  76270. changeTiles(_layer: number | undefined, pos: Vector2 | Vector2[], tile?: number): void;
  76271. /**
  76272. * Creates the animationMap texture Buffer
  76273. * @param buffer normally and array of numbers, or a false to generate from scratch
  76274. * @returns RawTexture of the animationMap
  76275. */
  76276. private _createTileAnimationBuffer;
  76277. /**
  76278. * Modifies the data of the animationMap
  76279. * @param cellID is the Index of the Sprite
  76280. * @param _frame is the target Animation frame
  76281. * @param toCell is the Target Index of the next frame of the animation
  76282. * @param time is a value between 0-1 that is the trigger for when the frame should change tiles
  76283. * @param speed is a global scalar of the time variable on the map.
  76284. */
  76285. addAnimationToTile(cellID?: number, _frame?: number, toCell?: number, time?: number, speed?: number): void;
  76286. /**
  76287. * Exports the .tilemaps file
  76288. */
  76289. saveTileMaps(): void;
  76290. /**
  76291. * Imports the .tilemaps file
  76292. * @param url of the .tilemaps file
  76293. */
  76294. loadTileMaps(url: string): void;
  76295. /**
  76296. * Release associated resources
  76297. */
  76298. dispose(): void;
  76299. }
  76300. }
  76301. declare module "babylonjs/Sprites/spritePackedManager" {
  76302. import { SpriteManager } from "babylonjs/Sprites/spriteManager";
  76303. import { Scene } from "babylonjs/scene";
  76304. /**
  76305. * Class used to manage multiple sprites of different sizes on the same spritesheet
  76306. * @see https://doc.babylonjs.com/babylon101/sprites
  76307. */
  76308. export class SpritePackedManager extends SpriteManager {
  76309. /** defines the packed manager's name */
  76310. name: string;
  76311. /**
  76312. * Creates a new sprite manager from a packed sprite sheet
  76313. * @param name defines the manager's name
  76314. * @param imgUrl defines the sprite sheet url
  76315. * @param capacity defines the maximum allowed number of sprites
  76316. * @param scene defines the hosting scene
  76317. * @param spriteJSON null otherwise a JSON object defining sprite sheet data
  76318. * @param epsilon defines the epsilon value to align texture (0.01 by default)
  76319. * @param samplingMode defines the smapling mode to use with spritesheet
  76320. * @param fromPacked set to true; do not alter
  76321. */
  76322. constructor(
  76323. /** defines the packed manager's name */
  76324. name: string, imgUrl: string, capacity: number, scene: Scene, spriteJSON?: string | null, epsilon?: number, samplingMode?: number);
  76325. }
  76326. }
  76327. declare module "babylonjs/Sprites/index" {
  76328. export * from "babylonjs/Sprites/sprite";
  76329. export * from "babylonjs/Sprites/ISprites";
  76330. export * from "babylonjs/Sprites/spriteManager";
  76331. export * from "babylonjs/Sprites/spriteMap";
  76332. export * from "babylonjs/Sprites/spritePackedManager";
  76333. export * from "babylonjs/Sprites/spriteSceneComponent";
  76334. }
  76335. declare module "babylonjs/States/index" {
  76336. export * from "babylonjs/States/alphaCullingState";
  76337. export * from "babylonjs/States/depthCullingState";
  76338. export * from "babylonjs/States/stencilState";
  76339. }
  76340. declare module "babylonjs/Misc/assetsManager" {
  76341. import { Scene } from "babylonjs/scene";
  76342. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  76343. import { IParticleSystem } from "babylonjs/Particles/IParticleSystem";
  76344. import { Skeleton } from "babylonjs/Bones/skeleton";
  76345. import { Observable } from "babylonjs/Misc/observable";
  76346. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  76347. import { Texture } from "babylonjs/Materials/Textures/texture";
  76348. import { CubeTexture } from "babylonjs/Materials/Textures/cubeTexture";
  76349. import { HDRCubeTexture } from "babylonjs/Materials/Textures/hdrCubeTexture";
  76350. import { EquiRectangularCubeTexture } from "babylonjs/Materials/Textures/equiRectangularCubeTexture";
  76351. import { AnimationGroup } from "babylonjs/Animations/animationGroup";
  76352. import { AssetContainer } from "babylonjs/assetContainer";
  76353. /**
  76354. * Defines the list of states available for a task inside a AssetsManager
  76355. */
  76356. export enum AssetTaskState {
  76357. /**
  76358. * Initialization
  76359. */
  76360. INIT = 0,
  76361. /**
  76362. * Running
  76363. */
  76364. RUNNING = 1,
  76365. /**
  76366. * Done
  76367. */
  76368. DONE = 2,
  76369. /**
  76370. * Error
  76371. */
  76372. ERROR = 3
  76373. }
  76374. /**
  76375. * Define an abstract asset task used with a AssetsManager class to load assets into a scene
  76376. */
  76377. export abstract class AbstractAssetTask {
  76378. /**
  76379. * Task name
  76380. */ name: string;
  76381. /**
  76382. * Callback called when the task is successful
  76383. */
  76384. onSuccess: (task: any) => void;
  76385. /**
  76386. * Callback called when the task is not successful
  76387. */
  76388. onError: (task: any, message?: string, exception?: any) => void;
  76389. /**
  76390. * Creates a new AssetsManager
  76391. * @param name defines the name of the task
  76392. */
  76393. constructor(
  76394. /**
  76395. * Task name
  76396. */ name: string);
  76397. private _isCompleted;
  76398. private _taskState;
  76399. private _errorObject;
  76400. /**
  76401. * Get if the task is completed
  76402. */
  76403. get isCompleted(): boolean;
  76404. /**
  76405. * Gets the current state of the task
  76406. */
  76407. get taskState(): AssetTaskState;
  76408. /**
  76409. * Gets the current error object (if task is in error)
  76410. */
  76411. get errorObject(): {
  76412. message?: string;
  76413. exception?: any;
  76414. };
  76415. /**
  76416. * Internal only
  76417. * @hidden
  76418. */
  76419. _setErrorObject(message?: string, exception?: any): void;
  76420. /**
  76421. * Execute the current task
  76422. * @param scene defines the scene where you want your assets to be loaded
  76423. * @param onSuccess is a callback called when the task is successfully executed
  76424. * @param onError is a callback called if an error occurs
  76425. */
  76426. run(scene: Scene, onSuccess: () => void, onError: (message?: string, exception?: any) => void): void;
  76427. /**
  76428. * Execute the current task
  76429. * @param scene defines the scene where you want your assets to be loaded
  76430. * @param onSuccess is a callback called when the task is successfully executed
  76431. * @param onError is a callback called if an error occurs
  76432. */
  76433. runTask(scene: Scene, onSuccess: () => void, onError: (message?: string, exception?: any) => void): void;
  76434. /**
  76435. * Reset will set the task state back to INIT, so the next load call of the assets manager will execute this task again.
  76436. * This can be used with failed tasks that have the reason for failure fixed.
  76437. */
  76438. reset(): void;
  76439. private onErrorCallback;
  76440. private onDoneCallback;
  76441. }
  76442. /**
  76443. * Define the interface used by progress events raised during assets loading
  76444. */
  76445. export interface IAssetsProgressEvent {
  76446. /**
  76447. * Defines the number of remaining tasks to process
  76448. */
  76449. remainingCount: number;
  76450. /**
  76451. * Defines the total number of tasks
  76452. */
  76453. totalCount: number;
  76454. /**
  76455. * Defines the task that was just processed
  76456. */
  76457. task: AbstractAssetTask;
  76458. }
  76459. /**
  76460. * Class used to share progress information about assets loading
  76461. */
  76462. export class AssetsProgressEvent implements IAssetsProgressEvent {
  76463. /**
  76464. * Defines the number of remaining tasks to process
  76465. */
  76466. remainingCount: number;
  76467. /**
  76468. * Defines the total number of tasks
  76469. */
  76470. totalCount: number;
  76471. /**
  76472. * Defines the task that was just processed
  76473. */
  76474. task: AbstractAssetTask;
  76475. /**
  76476. * Creates a AssetsProgressEvent
  76477. * @param remainingCount defines the number of remaining tasks to process
  76478. * @param totalCount defines the total number of tasks
  76479. * @param task defines the task that was just processed
  76480. */
  76481. constructor(remainingCount: number, totalCount: number, task: AbstractAssetTask);
  76482. }
  76483. /**
  76484. * Define a task used by AssetsManager to load assets into a container
  76485. */
  76486. export class ContainerAssetTask extends AbstractAssetTask {
  76487. /**
  76488. * Defines the name of the task
  76489. */
  76490. name: string;
  76491. /**
  76492. * Defines the list of mesh's names you want to load
  76493. */
  76494. meshesNames: any;
  76495. /**
  76496. * Defines the root url to use as a base to load your meshes and associated resources
  76497. */
  76498. rootUrl: string;
  76499. /**
  76500. * Defines the filename or File of the scene to load from
  76501. */
  76502. sceneFilename: string | File;
  76503. /**
  76504. * Get the loaded asset container
  76505. */
  76506. loadedContainer: AssetContainer;
  76507. /**
  76508. * Gets the list of loaded meshes
  76509. */
  76510. loadedMeshes: Array<AbstractMesh>;
  76511. /**
  76512. * Gets the list of loaded particle systems
  76513. */
  76514. loadedParticleSystems: Array<IParticleSystem>;
  76515. /**
  76516. * Gets the list of loaded skeletons
  76517. */
  76518. loadedSkeletons: Array<Skeleton>;
  76519. /**
  76520. * Gets the list of loaded animation groups
  76521. */
  76522. loadedAnimationGroups: Array<AnimationGroup>;
  76523. /**
  76524. * Callback called when the task is successful
  76525. */
  76526. onSuccess: (task: ContainerAssetTask) => void;
  76527. /**
  76528. * Callback called when the task is successful
  76529. */
  76530. onError: (task: ContainerAssetTask, message?: string, exception?: any) => void;
  76531. /**
  76532. * Creates a new ContainerAssetTask
  76533. * @param name defines the name of the task
  76534. * @param meshesNames defines the list of mesh's names you want to load
  76535. * @param rootUrl defines the root url to use as a base to load your meshes and associated resources
  76536. * @param sceneFilename defines the filename or File of the scene to load from
  76537. */
  76538. constructor(
  76539. /**
  76540. * Defines the name of the task
  76541. */
  76542. name: string,
  76543. /**
  76544. * Defines the list of mesh's names you want to load
  76545. */
  76546. meshesNames: any,
  76547. /**
  76548. * Defines the root url to use as a base to load your meshes and associated resources
  76549. */
  76550. rootUrl: string,
  76551. /**
  76552. * Defines the filename or File of the scene to load from
  76553. */
  76554. sceneFilename: string | File);
  76555. /**
  76556. * Execute the current task
  76557. * @param scene defines the scene where you want your assets to be loaded
  76558. * @param onSuccess is a callback called when the task is successfully executed
  76559. * @param onError is a callback called if an error occurs
  76560. */
  76561. runTask(scene: Scene, onSuccess: () => void, onError: (message?: string, exception?: any) => void): void;
  76562. }
  76563. /**
  76564. * Define a task used by AssetsManager to load meshes
  76565. */
  76566. export class MeshAssetTask extends AbstractAssetTask {
  76567. /**
  76568. * Defines the name of the task
  76569. */
  76570. name: string;
  76571. /**
  76572. * Defines the list of mesh's names you want to load
  76573. */
  76574. meshesNames: any;
  76575. /**
  76576. * Defines the root url to use as a base to load your meshes and associated resources
  76577. */
  76578. rootUrl: string;
  76579. /**
  76580. * Defines the filename or File of the scene to load from
  76581. */
  76582. sceneFilename: string | File;
  76583. /**
  76584. * Gets the list of loaded meshes
  76585. */
  76586. loadedMeshes: Array<AbstractMesh>;
  76587. /**
  76588. * Gets the list of loaded particle systems
  76589. */
  76590. loadedParticleSystems: Array<IParticleSystem>;
  76591. /**
  76592. * Gets the list of loaded skeletons
  76593. */
  76594. loadedSkeletons: Array<Skeleton>;
  76595. /**
  76596. * Gets the list of loaded animation groups
  76597. */
  76598. loadedAnimationGroups: Array<AnimationGroup>;
  76599. /**
  76600. * Callback called when the task is successful
  76601. */
  76602. onSuccess: (task: MeshAssetTask) => void;
  76603. /**
  76604. * Callback called when the task is successful
  76605. */
  76606. onError: (task: MeshAssetTask, message?: string, exception?: any) => void;
  76607. /**
  76608. * Creates a new MeshAssetTask
  76609. * @param name defines the name of the task
  76610. * @param meshesNames defines the list of mesh's names you want to load
  76611. * @param rootUrl defines the root url to use as a base to load your meshes and associated resources
  76612. * @param sceneFilename defines the filename or File of the scene to load from
  76613. */
  76614. constructor(
  76615. /**
  76616. * Defines the name of the task
  76617. */
  76618. name: string,
  76619. /**
  76620. * Defines the list of mesh's names you want to load
  76621. */
  76622. meshesNames: any,
  76623. /**
  76624. * Defines the root url to use as a base to load your meshes and associated resources
  76625. */
  76626. rootUrl: string,
  76627. /**
  76628. * Defines the filename or File of the scene to load from
  76629. */
  76630. sceneFilename: string | File);
  76631. /**
  76632. * Execute the current task
  76633. * @param scene defines the scene where you want your assets to be loaded
  76634. * @param onSuccess is a callback called when the task is successfully executed
  76635. * @param onError is a callback called if an error occurs
  76636. */
  76637. runTask(scene: Scene, onSuccess: () => void, onError: (message?: string, exception?: any) => void): void;
  76638. }
  76639. /**
  76640. * Define a task used by AssetsManager to load text content
  76641. */
  76642. export class TextFileAssetTask extends AbstractAssetTask {
  76643. /**
  76644. * Defines the name of the task
  76645. */
  76646. name: string;
  76647. /**
  76648. * Defines the location of the file to load
  76649. */
  76650. url: string;
  76651. /**
  76652. * Gets the loaded text string
  76653. */
  76654. text: string;
  76655. /**
  76656. * Callback called when the task is successful
  76657. */
  76658. onSuccess: (task: TextFileAssetTask) => void;
  76659. /**
  76660. * Callback called when the task is successful
  76661. */
  76662. onError: (task: TextFileAssetTask, message?: string, exception?: any) => void;
  76663. /**
  76664. * Creates a new TextFileAssetTask object
  76665. * @param name defines the name of the task
  76666. * @param url defines the location of the file to load
  76667. */
  76668. constructor(
  76669. /**
  76670. * Defines the name of the task
  76671. */
  76672. name: string,
  76673. /**
  76674. * Defines the location of the file to load
  76675. */
  76676. url: string);
  76677. /**
  76678. * Execute the current task
  76679. * @param scene defines the scene where you want your assets to be loaded
  76680. * @param onSuccess is a callback called when the task is successfully executed
  76681. * @param onError is a callback called if an error occurs
  76682. */
  76683. runTask(scene: Scene, onSuccess: () => void, onError: (message?: string, exception?: any) => void): void;
  76684. }
  76685. /**
  76686. * Define a task used by AssetsManager to load binary data
  76687. */
  76688. export class BinaryFileAssetTask extends AbstractAssetTask {
  76689. /**
  76690. * Defines the name of the task
  76691. */
  76692. name: string;
  76693. /**
  76694. * Defines the location of the file to load
  76695. */
  76696. url: string;
  76697. /**
  76698. * Gets the lodaded data (as an array buffer)
  76699. */
  76700. data: ArrayBuffer;
  76701. /**
  76702. * Callback called when the task is successful
  76703. */
  76704. onSuccess: (task: BinaryFileAssetTask) => void;
  76705. /**
  76706. * Callback called when the task is successful
  76707. */
  76708. onError: (task: BinaryFileAssetTask, message?: string, exception?: any) => void;
  76709. /**
  76710. * Creates a new BinaryFileAssetTask object
  76711. * @param name defines the name of the new task
  76712. * @param url defines the location of the file to load
  76713. */
  76714. constructor(
  76715. /**
  76716. * Defines the name of the task
  76717. */
  76718. name: string,
  76719. /**
  76720. * Defines the location of the file to load
  76721. */
  76722. url: string);
  76723. /**
  76724. * Execute the current task
  76725. * @param scene defines the scene where you want your assets to be loaded
  76726. * @param onSuccess is a callback called when the task is successfully executed
  76727. * @param onError is a callback called if an error occurs
  76728. */
  76729. runTask(scene: Scene, onSuccess: () => void, onError: (message?: string, exception?: any) => void): void;
  76730. }
  76731. /**
  76732. * Define a task used by AssetsManager to load images
  76733. */
  76734. export class ImageAssetTask extends AbstractAssetTask {
  76735. /**
  76736. * Defines the name of the task
  76737. */
  76738. name: string;
  76739. /**
  76740. * Defines the location of the image to load
  76741. */
  76742. url: string;
  76743. /**
  76744. * Gets the loaded images
  76745. */
  76746. image: HTMLImageElement;
  76747. /**
  76748. * Callback called when the task is successful
  76749. */
  76750. onSuccess: (task: ImageAssetTask) => void;
  76751. /**
  76752. * Callback called when the task is successful
  76753. */
  76754. onError: (task: ImageAssetTask, message?: string, exception?: any) => void;
  76755. /**
  76756. * Creates a new ImageAssetTask
  76757. * @param name defines the name of the task
  76758. * @param url defines the location of the image to load
  76759. */
  76760. constructor(
  76761. /**
  76762. * Defines the name of the task
  76763. */
  76764. name: string,
  76765. /**
  76766. * Defines the location of the image to load
  76767. */
  76768. url: string);
  76769. /**
  76770. * Execute the current task
  76771. * @param scene defines the scene where you want your assets to be loaded
  76772. * @param onSuccess is a callback called when the task is successfully executed
  76773. * @param onError is a callback called if an error occurs
  76774. */
  76775. runTask(scene: Scene, onSuccess: () => void, onError: (message?: string, exception?: any) => void): void;
  76776. }
  76777. /**
  76778. * Defines the interface used by texture loading tasks
  76779. */
  76780. export interface ITextureAssetTask<TEX extends BaseTexture> {
  76781. /**
  76782. * Gets the loaded texture
  76783. */
  76784. texture: TEX;
  76785. }
  76786. /**
  76787. * Define a task used by AssetsManager to load 2D textures
  76788. */
  76789. export class TextureAssetTask extends AbstractAssetTask implements ITextureAssetTask<Texture> {
  76790. /**
  76791. * Defines the name of the task
  76792. */
  76793. name: string;
  76794. /**
  76795. * Defines the location of the file to load
  76796. */
  76797. url: string;
  76798. /**
  76799. * Defines if mipmap should not be generated (default is false)
  76800. */
  76801. noMipmap?: boolean | undefined;
  76802. /**
  76803. * Defines if texture must be inverted on Y axis (default is true)
  76804. */
  76805. invertY: boolean;
  76806. /**
  76807. * Defines the sampling mode to use (default is Texture.TRILINEAR_SAMPLINGMODE)
  76808. */
  76809. samplingMode: number;
  76810. /**
  76811. * Gets the loaded texture
  76812. */
  76813. texture: Texture;
  76814. /**
  76815. * Callback called when the task is successful
  76816. */
  76817. onSuccess: (task: TextureAssetTask) => void;
  76818. /**
  76819. * Callback called when the task is successful
  76820. */
  76821. onError: (task: TextureAssetTask, message?: string, exception?: any) => void;
  76822. /**
  76823. * Creates a new TextureAssetTask object
  76824. * @param name defines the name of the task
  76825. * @param url defines the location of the file to load
  76826. * @param noMipmap defines if mipmap should not be generated (default is false)
  76827. * @param invertY defines if texture must be inverted on Y axis (default is true)
  76828. * @param samplingMode defines the sampling mode to use (default is Texture.TRILINEAR_SAMPLINGMODE)
  76829. */
  76830. constructor(
  76831. /**
  76832. * Defines the name of the task
  76833. */
  76834. name: string,
  76835. /**
  76836. * Defines the location of the file to load
  76837. */
  76838. url: string,
  76839. /**
  76840. * Defines if mipmap should not be generated (default is false)
  76841. */
  76842. noMipmap?: boolean | undefined,
  76843. /**
  76844. * Defines if texture must be inverted on Y axis (default is true)
  76845. */
  76846. invertY?: boolean,
  76847. /**
  76848. * Defines the sampling mode to use (default is Texture.TRILINEAR_SAMPLINGMODE)
  76849. */
  76850. samplingMode?: number);
  76851. /**
  76852. * Execute the current task
  76853. * @param scene defines the scene where you want your assets to be loaded
  76854. * @param onSuccess is a callback called when the task is successfully executed
  76855. * @param onError is a callback called if an error occurs
  76856. */
  76857. runTask(scene: Scene, onSuccess: () => void, onError: (message?: string, exception?: any) => void): void;
  76858. }
  76859. /**
  76860. * Define a task used by AssetsManager to load cube textures
  76861. */
  76862. export class CubeTextureAssetTask extends AbstractAssetTask implements ITextureAssetTask<CubeTexture> {
  76863. /**
  76864. * Defines the name of the task
  76865. */
  76866. name: string;
  76867. /**
  76868. * Defines the location of the files to load (You have to specify the folder where the files are + filename with no extension)
  76869. */
  76870. url: string;
  76871. /**
  76872. * Defines the extensions to use to load files (["_px", "_py", "_pz", "_nx", "_ny", "_nz"] by default)
  76873. */
  76874. extensions?: string[] | undefined;
  76875. /**
  76876. * Defines if mipmaps should not be generated (default is false)
  76877. */
  76878. noMipmap?: boolean | undefined;
  76879. /**
  76880. * Defines the explicit list of files (undefined by default)
  76881. */
  76882. files?: string[] | undefined;
  76883. /**
  76884. * Gets the loaded texture
  76885. */
  76886. texture: CubeTexture;
  76887. /**
  76888. * Callback called when the task is successful
  76889. */
  76890. onSuccess: (task: CubeTextureAssetTask) => void;
  76891. /**
  76892. * Callback called when the task is successful
  76893. */
  76894. onError: (task: CubeTextureAssetTask, message?: string, exception?: any) => void;
  76895. /**
  76896. * Creates a new CubeTextureAssetTask
  76897. * @param name defines the name of the task
  76898. * @param url defines the location of the files to load (You have to specify the folder where the files are + filename with no extension)
  76899. * @param extensions defines the extensions to use to load files (["_px", "_py", "_pz", "_nx", "_ny", "_nz"] by default)
  76900. * @param noMipmap defines if mipmaps should not be generated (default is false)
  76901. * @param files defines the explicit list of files (undefined by default)
  76902. */
  76903. constructor(
  76904. /**
  76905. * Defines the name of the task
  76906. */
  76907. name: string,
  76908. /**
  76909. * Defines the location of the files to load (You have to specify the folder where the files are + filename with no extension)
  76910. */
  76911. url: string,
  76912. /**
  76913. * Defines the extensions to use to load files (["_px", "_py", "_pz", "_nx", "_ny", "_nz"] by default)
  76914. */
  76915. extensions?: string[] | undefined,
  76916. /**
  76917. * Defines if mipmaps should not be generated (default is false)
  76918. */
  76919. noMipmap?: boolean | undefined,
  76920. /**
  76921. * Defines the explicit list of files (undefined by default)
  76922. */
  76923. files?: string[] | undefined);
  76924. /**
  76925. * Execute the current task
  76926. * @param scene defines the scene where you want your assets to be loaded
  76927. * @param onSuccess is a callback called when the task is successfully executed
  76928. * @param onError is a callback called if an error occurs
  76929. */
  76930. runTask(scene: Scene, onSuccess: () => void, onError: (message?: string, exception?: any) => void): void;
  76931. }
  76932. /**
  76933. * Define a task used by AssetsManager to load HDR cube textures
  76934. */
  76935. export class HDRCubeTextureAssetTask extends AbstractAssetTask implements ITextureAssetTask<HDRCubeTexture> {
  76936. /**
  76937. * Defines the name of the task
  76938. */
  76939. name: string;
  76940. /**
  76941. * Defines the location of the file to load
  76942. */
  76943. url: string;
  76944. /**
  76945. * Defines the desired size (the more it increases the longer the generation will be)
  76946. */
  76947. size: number;
  76948. /**
  76949. * Defines if mipmaps should not be generated (default is false)
  76950. */
  76951. noMipmap: boolean;
  76952. /**
  76953. * Specifies whether you want to extract the polynomial harmonics during the generation process (default is true)
  76954. */
  76955. generateHarmonics: boolean;
  76956. /**
  76957. * 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)
  76958. */
  76959. gammaSpace: boolean;
  76960. /**
  76961. * Internal Use Only
  76962. */
  76963. reserved: boolean;
  76964. /**
  76965. * Gets the loaded texture
  76966. */
  76967. texture: HDRCubeTexture;
  76968. /**
  76969. * Callback called when the task is successful
  76970. */
  76971. onSuccess: (task: HDRCubeTextureAssetTask) => void;
  76972. /**
  76973. * Callback called when the task is successful
  76974. */
  76975. onError: (task: HDRCubeTextureAssetTask, message?: string, exception?: any) => void;
  76976. /**
  76977. * Creates a new HDRCubeTextureAssetTask object
  76978. * @param name defines the name of the task
  76979. * @param url defines the location of the file to load
  76980. * @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.
  76981. * @param noMipmap defines if mipmaps should not be generated (default is false)
  76982. * @param generateHarmonics specifies whether you want to extract the polynomial harmonics during the generation process (default is true)
  76983. * @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)
  76984. * @param reserved Internal use only
  76985. */
  76986. constructor(
  76987. /**
  76988. * Defines the name of the task
  76989. */
  76990. name: string,
  76991. /**
  76992. * Defines the location of the file to load
  76993. */
  76994. url: string,
  76995. /**
  76996. * Defines the desired size (the more it increases the longer the generation will be)
  76997. */
  76998. size: number,
  76999. /**
  77000. * Defines if mipmaps should not be generated (default is false)
  77001. */
  77002. noMipmap?: boolean,
  77003. /**
  77004. * Specifies whether you want to extract the polynomial harmonics during the generation process (default is true)
  77005. */
  77006. generateHarmonics?: boolean,
  77007. /**
  77008. * 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)
  77009. */
  77010. gammaSpace?: boolean,
  77011. /**
  77012. * Internal Use Only
  77013. */
  77014. reserved?: boolean);
  77015. /**
  77016. * Execute the current task
  77017. * @param scene defines the scene where you want your assets to be loaded
  77018. * @param onSuccess is a callback called when the task is successfully executed
  77019. * @param onError is a callback called if an error occurs
  77020. */
  77021. runTask(scene: Scene, onSuccess: () => void, onError: (message?: string, exception?: any) => void): void;
  77022. }
  77023. /**
  77024. * Define a task used by AssetsManager to load Equirectangular cube textures
  77025. */
  77026. export class EquiRectangularCubeTextureAssetTask extends AbstractAssetTask implements ITextureAssetTask<EquiRectangularCubeTexture> {
  77027. /**
  77028. * Defines the name of the task
  77029. */
  77030. name: string;
  77031. /**
  77032. * Defines the location of the file to load
  77033. */
  77034. url: string;
  77035. /**
  77036. * Defines the desired size (the more it increases the longer the generation will be)
  77037. */
  77038. size: number;
  77039. /**
  77040. * Defines if mipmaps should not be generated (default is false)
  77041. */
  77042. noMipmap: boolean;
  77043. /**
  77044. * Specifies if the texture will be use in gamma or linear space (the PBR material requires those texture in linear space,
  77045. * but the standard material would require them in Gamma space) (default is true)
  77046. */
  77047. gammaSpace: boolean;
  77048. /**
  77049. * Gets the loaded texture
  77050. */
  77051. texture: EquiRectangularCubeTexture;
  77052. /**
  77053. * Callback called when the task is successful
  77054. */
  77055. onSuccess: (task: EquiRectangularCubeTextureAssetTask) => void;
  77056. /**
  77057. * Callback called when the task is successful
  77058. */
  77059. onError: (task: EquiRectangularCubeTextureAssetTask, message?: string, exception?: any) => void;
  77060. /**
  77061. * Creates a new EquiRectangularCubeTextureAssetTask object
  77062. * @param name defines the name of the task
  77063. * @param url defines the location of the file to load
  77064. * @param size defines the desired size (the more it increases the longer the generation will be)
  77065. * If the size is omitted this implies you are using a preprocessed cubemap.
  77066. * @param noMipmap defines if mipmaps should not be generated (default is false)
  77067. * @param gammaSpace specifies if the texture will be used in gamma or linear space
  77068. * (the PBR material requires those texture in linear space, but the standard material would require them in Gamma space)
  77069. * (default is true)
  77070. */
  77071. constructor(
  77072. /**
  77073. * Defines the name of the task
  77074. */
  77075. name: string,
  77076. /**
  77077. * Defines the location of the file to load
  77078. */
  77079. url: string,
  77080. /**
  77081. * Defines the desired size (the more it increases the longer the generation will be)
  77082. */
  77083. size: number,
  77084. /**
  77085. * Defines if mipmaps should not be generated (default is false)
  77086. */
  77087. noMipmap?: boolean,
  77088. /**
  77089. * Specifies if the texture will be use in gamma or linear space (the PBR material requires those texture in linear space,
  77090. * but the standard material would require them in Gamma space) (default is true)
  77091. */
  77092. gammaSpace?: boolean);
  77093. /**
  77094. * Execute the current task
  77095. * @param scene defines the scene where you want your assets to be loaded
  77096. * @param onSuccess is a callback called when the task is successfully executed
  77097. * @param onError is a callback called if an error occurs
  77098. */
  77099. runTask(scene: Scene, onSuccess: () => void, onError: (message?: string, exception?: any) => void): void;
  77100. }
  77101. /**
  77102. * This class can be used to easily import assets into a scene
  77103. * @see https://doc.babylonjs.com/how_to/how_to_use_assetsmanager
  77104. */
  77105. export class AssetsManager {
  77106. private _scene;
  77107. private _isLoading;
  77108. protected _tasks: AbstractAssetTask[];
  77109. protected _waitingTasksCount: number;
  77110. protected _totalTasksCount: number;
  77111. /**
  77112. * Callback called when all tasks are processed
  77113. */
  77114. onFinish: (tasks: AbstractAssetTask[]) => void;
  77115. /**
  77116. * Callback called when a task is successful
  77117. */
  77118. onTaskSuccess: (task: AbstractAssetTask) => void;
  77119. /**
  77120. * Callback called when a task had an error
  77121. */
  77122. onTaskError: (task: AbstractAssetTask) => void;
  77123. /**
  77124. * Callback called when a task is done (whatever the result is)
  77125. */
  77126. onProgress: (remainingCount: number, totalCount: number, task: AbstractAssetTask) => void;
  77127. /**
  77128. * Observable called when all tasks are processed
  77129. */
  77130. onTaskSuccessObservable: Observable<AbstractAssetTask>;
  77131. /**
  77132. * Observable called when a task had an error
  77133. */
  77134. onTaskErrorObservable: Observable<AbstractAssetTask>;
  77135. /**
  77136. * Observable called when all tasks were executed
  77137. */
  77138. onTasksDoneObservable: Observable<AbstractAssetTask[]>;
  77139. /**
  77140. * Observable called when a task is done (whatever the result is)
  77141. */
  77142. onProgressObservable: Observable<IAssetsProgressEvent>;
  77143. /**
  77144. * Gets or sets a boolean defining if the AssetsManager should use the default loading screen
  77145. * @see https://doc.babylonjs.com/how_to/creating_a_custom_loading_screen
  77146. */
  77147. useDefaultLoadingScreen: boolean;
  77148. /**
  77149. * Gets or sets a boolean defining if the AssetsManager should automatically hide the loading screen
  77150. * when all assets have been downloaded.
  77151. * If set to false, you need to manually call in hideLoadingUI() once your scene is ready.
  77152. */
  77153. autoHideLoadingUI: boolean;
  77154. /**
  77155. * Creates a new AssetsManager
  77156. * @param scene defines the scene to work on
  77157. */
  77158. constructor(scene: Scene);
  77159. /**
  77160. * Add a ContainerAssetTask to the list of active tasks
  77161. * @param taskName defines the name of the new task
  77162. * @param meshesNames defines the name of meshes to load
  77163. * @param rootUrl defines the root url to use to locate files
  77164. * @param sceneFilename defines the filename of the scene file
  77165. * @returns a new ContainerAssetTask object
  77166. */
  77167. addContainerTask(taskName: string, meshesNames: any, rootUrl: string, sceneFilename: string): ContainerAssetTask;
  77168. /**
  77169. * Add a MeshAssetTask to the list of active tasks
  77170. * @param taskName defines the name of the new task
  77171. * @param meshesNames defines the name of meshes to load
  77172. * @param rootUrl defines the root url to use to locate files
  77173. * @param sceneFilename defines the filename of the scene file
  77174. * @returns a new MeshAssetTask object
  77175. */
  77176. addMeshTask(taskName: string, meshesNames: any, rootUrl: string, sceneFilename: string): MeshAssetTask;
  77177. /**
  77178. * Add a TextFileAssetTask to the list of active tasks
  77179. * @param taskName defines the name of the new task
  77180. * @param url defines the url of the file to load
  77181. * @returns a new TextFileAssetTask object
  77182. */
  77183. addTextFileTask(taskName: string, url: string): TextFileAssetTask;
  77184. /**
  77185. * Add a BinaryFileAssetTask to the list of active tasks
  77186. * @param taskName defines the name of the new task
  77187. * @param url defines the url of the file to load
  77188. * @returns a new BinaryFileAssetTask object
  77189. */
  77190. addBinaryFileTask(taskName: string, url: string): BinaryFileAssetTask;
  77191. /**
  77192. * Add a ImageAssetTask to the list of active tasks
  77193. * @param taskName defines the name of the new task
  77194. * @param url defines the url of the file to load
  77195. * @returns a new ImageAssetTask object
  77196. */
  77197. addImageTask(taskName: string, url: string): ImageAssetTask;
  77198. /**
  77199. * Add a TextureAssetTask to the list of active tasks
  77200. * @param taskName defines the name of the new task
  77201. * @param url defines the url of the file to load
  77202. * @param noMipmap defines if the texture must not receive mipmaps (false by default)
  77203. * @param invertY defines if you want to invert Y axis of the loaded texture (false by default)
  77204. * @param samplingMode defines the sampling mode to use (Texture.TRILINEAR_SAMPLINGMODE by default)
  77205. * @returns a new TextureAssetTask object
  77206. */
  77207. addTextureTask(taskName: string, url: string, noMipmap?: boolean, invertY?: boolean, samplingMode?: number): TextureAssetTask;
  77208. /**
  77209. * Add a CubeTextureAssetTask to the list of active tasks
  77210. * @param taskName defines the name of the new task
  77211. * @param url defines the url of the file to load
  77212. * @param extensions defines the extension to use to load the cube map (can be null)
  77213. * @param noMipmap defines if the texture must not receive mipmaps (false by default)
  77214. * @param files defines the list of files to load (can be null)
  77215. * @returns a new CubeTextureAssetTask object
  77216. */
  77217. addCubeTextureTask(taskName: string, url: string, extensions?: string[], noMipmap?: boolean, files?: string[]): CubeTextureAssetTask;
  77218. /**
  77219. *
  77220. * Add a HDRCubeTextureAssetTask to the list of active tasks
  77221. * @param taskName defines the name of the new task
  77222. * @param url defines the url of the file to load
  77223. * @param size defines the size you want for the cubemap (can be null)
  77224. * @param noMipmap defines if the texture must not receive mipmaps (false by default)
  77225. * @param generateHarmonics defines if you want to automatically generate (true by default)
  77226. * @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)
  77227. * @param reserved Internal use only
  77228. * @returns a new HDRCubeTextureAssetTask object
  77229. */
  77230. addHDRCubeTextureTask(taskName: string, url: string, size: number, noMipmap?: boolean, generateHarmonics?: boolean, gammaSpace?: boolean, reserved?: boolean): HDRCubeTextureAssetTask;
  77231. /**
  77232. *
  77233. * Add a EquiRectangularCubeTextureAssetTask to the list of active tasks
  77234. * @param taskName defines the name of the new task
  77235. * @param url defines the url of the file to load
  77236. * @param size defines the size you want for the cubemap (can be null)
  77237. * @param noMipmap defines if the texture must not receive mipmaps (false by default)
  77238. * @param gammaSpace Specifies if the texture will be used in gamma or linear space
  77239. * (the PBR material requires those textures in linear space, but the standard material would require them in Gamma space)
  77240. * @returns a new EquiRectangularCubeTextureAssetTask object
  77241. */
  77242. addEquiRectangularCubeTextureAssetTask(taskName: string, url: string, size: number, noMipmap?: boolean, gammaSpace?: boolean): EquiRectangularCubeTextureAssetTask;
  77243. /**
  77244. * Remove a task from the assets manager.
  77245. * @param task the task to remove
  77246. */
  77247. removeTask(task: AbstractAssetTask): void;
  77248. private _decreaseWaitingTasksCount;
  77249. private _runTask;
  77250. /**
  77251. * Reset the AssetsManager and remove all tasks
  77252. * @return the current instance of the AssetsManager
  77253. */
  77254. reset(): AssetsManager;
  77255. /**
  77256. * Start the loading process
  77257. * @return the current instance of the AssetsManager
  77258. */
  77259. load(): AssetsManager;
  77260. /**
  77261. * Start the loading process as an async operation
  77262. * @return a promise returning the list of failed tasks
  77263. */
  77264. loadAsync(): Promise<void>;
  77265. }
  77266. }
  77267. declare module "babylonjs/Misc/deferred" {
  77268. /**
  77269. * Wrapper class for promise with external resolve and reject.
  77270. */
  77271. export class Deferred<T> {
  77272. /**
  77273. * The promise associated with this deferred object.
  77274. */
  77275. readonly promise: Promise<T>;
  77276. private _resolve;
  77277. private _reject;
  77278. /**
  77279. * The resolve method of the promise associated with this deferred object.
  77280. */
  77281. get resolve(): (value?: T | PromiseLike<T> | undefined) => void;
  77282. /**
  77283. * The reject method of the promise associated with this deferred object.
  77284. */
  77285. get reject(): (reason?: any) => void;
  77286. /**
  77287. * Constructor for this deferred object.
  77288. */
  77289. constructor();
  77290. }
  77291. }
  77292. declare module "babylonjs/Misc/meshExploder" {
  77293. import { Mesh } from "babylonjs/Meshes/mesh";
  77294. /**
  77295. * Class used to explode meshes (ie. to have a center and move them away from that center to better see the overall organization)
  77296. */
  77297. export class MeshExploder {
  77298. private _centerMesh;
  77299. private _meshes;
  77300. private _meshesOrigins;
  77301. private _toCenterVectors;
  77302. private _scaledDirection;
  77303. private _newPosition;
  77304. private _centerPosition;
  77305. /**
  77306. * Explodes meshes from a center mesh.
  77307. * @param meshes The meshes to explode.
  77308. * @param centerMesh The mesh to be center of explosion.
  77309. */
  77310. constructor(meshes: Array<Mesh>, centerMesh?: Mesh);
  77311. private _setCenterMesh;
  77312. /**
  77313. * Get class name
  77314. * @returns "MeshExploder"
  77315. */
  77316. getClassName(): string;
  77317. /**
  77318. * "Exploded meshes"
  77319. * @returns Array of meshes with the centerMesh at index 0.
  77320. */
  77321. getMeshes(): Array<Mesh>;
  77322. /**
  77323. * Explodes meshes giving a specific direction
  77324. * @param direction Number to multiply distance of each mesh's origin from center. Use a negative number to implode, or zero to reset.
  77325. */
  77326. explode(direction?: number): void;
  77327. }
  77328. }
  77329. declare module "babylonjs/Misc/filesInput" {
  77330. import { Engine } from "babylonjs/Engines/engine";
  77331. import { Scene } from "babylonjs/scene";
  77332. import { ISceneLoaderProgressEvent } from "babylonjs/Loading/sceneLoader";
  77333. import { Nullable } from "babylonjs/types";
  77334. /**
  77335. * Class used to help managing file picking and drag'n'drop
  77336. */
  77337. export class FilesInput {
  77338. /**
  77339. * List of files ready to be loaded
  77340. */
  77341. static get FilesToLoad(): {
  77342. [key: string]: File;
  77343. };
  77344. /**
  77345. * Callback called when a file is processed
  77346. */
  77347. onProcessFileCallback: (file: File, name: string, extension: string) => boolean;
  77348. private _engine;
  77349. private _currentScene;
  77350. private _sceneLoadedCallback;
  77351. private _progressCallback;
  77352. private _additionalRenderLoopLogicCallback;
  77353. private _textureLoadingCallback;
  77354. private _startingProcessingFilesCallback;
  77355. private _onReloadCallback;
  77356. private _errorCallback;
  77357. private _elementToMonitor;
  77358. private _sceneFileToLoad;
  77359. private _filesToLoad;
  77360. /**
  77361. * Creates a new FilesInput
  77362. * @param engine defines the rendering engine
  77363. * @param scene defines the hosting scene
  77364. * @param sceneLoadedCallback callback called when scene is loaded
  77365. * @param progressCallback callback called to track progress
  77366. * @param additionalRenderLoopLogicCallback callback called to add user logic to the rendering loop
  77367. * @param textureLoadingCallback callback called when a texture is loading
  77368. * @param startingProcessingFilesCallback callback called when the system is about to process all files
  77369. * @param onReloadCallback callback called when a reload is requested
  77370. * @param errorCallback callback call if an error occurs
  77371. */
  77372. 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>);
  77373. private _dragEnterHandler;
  77374. private _dragOverHandler;
  77375. private _dropHandler;
  77376. /**
  77377. * Calls this function to listen to drag'n'drop events on a specific DOM element
  77378. * @param elementToMonitor defines the DOM element to track
  77379. */
  77380. monitorElementForDragNDrop(elementToMonitor: HTMLElement): void;
  77381. /** Gets the current list of files to load */
  77382. get filesToLoad(): File[];
  77383. /**
  77384. * Release all associated resources
  77385. */
  77386. dispose(): void;
  77387. private renderFunction;
  77388. private drag;
  77389. private drop;
  77390. private _traverseFolder;
  77391. private _processFiles;
  77392. /**
  77393. * Load files from a drop event
  77394. * @param event defines the drop event to use as source
  77395. */
  77396. loadFiles(event: any): void;
  77397. private _processReload;
  77398. /**
  77399. * Reload the current scene from the loaded files
  77400. */
  77401. reload(): void;
  77402. }
  77403. }
  77404. declare module "babylonjs/Misc/HighDynamicRange/index" {
  77405. export * from "babylonjs/Misc/HighDynamicRange/cubemapToSphericalPolynomial";
  77406. export * from "babylonjs/Misc/HighDynamicRange/hdr";
  77407. export * from "babylonjs/Misc/HighDynamicRange/panoramaToCubemap";
  77408. }
  77409. declare module "babylonjs/Misc/sceneOptimizer" {
  77410. import { Scene, IDisposable } from "babylonjs/scene";
  77411. import { Observable } from "babylonjs/Misc/observable";
  77412. /**
  77413. * Defines the root class used to create scene optimization to use with SceneOptimizer
  77414. * @description More details at https://doc.babylonjs.com/how_to/how_to_use_sceneoptimizer
  77415. */
  77416. export class SceneOptimization {
  77417. /**
  77418. * Defines the priority of this optimization (0 by default which means first in the list)
  77419. */
  77420. priority: number;
  77421. /**
  77422. * Gets a string describing the action executed by the current optimization
  77423. * @returns description string
  77424. */
  77425. getDescription(): string;
  77426. /**
  77427. * This function will be called by the SceneOptimizer when its priority is reached in order to apply the change required by the current optimization
  77428. * @param scene defines the current scene where to apply this optimization
  77429. * @param optimizer defines the current optimizer
  77430. * @returns true if everything that can be done was applied
  77431. */
  77432. apply(scene: Scene, optimizer: SceneOptimizer): boolean;
  77433. /**
  77434. * Creates the SceneOptimization object
  77435. * @param priority defines the priority of this optimization (0 by default which means first in the list)
  77436. * @param desc defines the description associated with the optimization
  77437. */
  77438. constructor(
  77439. /**
  77440. * Defines the priority of this optimization (0 by default which means first in the list)
  77441. */
  77442. priority?: number);
  77443. }
  77444. /**
  77445. * Defines an optimization used to reduce the size of render target textures
  77446. * @description More details at https://doc.babylonjs.com/how_to/how_to_use_sceneoptimizer
  77447. */
  77448. export class TextureOptimization extends SceneOptimization {
  77449. /**
  77450. * Defines the priority of this optimization (0 by default which means first in the list)
  77451. */
  77452. priority: number;
  77453. /**
  77454. * 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
  77455. */
  77456. maximumSize: number;
  77457. /**
  77458. * Defines the factor (0.5 by default) used to scale down textures bigger than maximum sized allowed.
  77459. */
  77460. step: number;
  77461. /**
  77462. * Gets a string describing the action executed by the current optimization
  77463. * @returns description string
  77464. */
  77465. getDescription(): string;
  77466. /**
  77467. * Creates the TextureOptimization object
  77468. * @param priority defines the priority of this optimization (0 by default which means first in the list)
  77469. * @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
  77470. * @param step defines the factor (0.5 by default) used to scale down textures bigger than maximum sized allowed.
  77471. */
  77472. constructor(
  77473. /**
  77474. * Defines the priority of this optimization (0 by default which means first in the list)
  77475. */
  77476. priority?: number,
  77477. /**
  77478. * 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
  77479. */
  77480. maximumSize?: number,
  77481. /**
  77482. * Defines the factor (0.5 by default) used to scale down textures bigger than maximum sized allowed.
  77483. */
  77484. step?: number);
  77485. /**
  77486. * This function will be called by the SceneOptimizer when its priority is reached in order to apply the change required by the current optimization
  77487. * @param scene defines the current scene where to apply this optimization
  77488. * @param optimizer defines the current optimizer
  77489. * @returns true if everything that can be done was applied
  77490. */
  77491. apply(scene: Scene, optimizer: SceneOptimizer): boolean;
  77492. }
  77493. /**
  77494. * Defines an optimization used to increase or decrease the rendering resolution
  77495. * @description More details at https://doc.babylonjs.com/how_to/how_to_use_sceneoptimizer
  77496. */
  77497. export class HardwareScalingOptimization extends SceneOptimization {
  77498. /**
  77499. * Defines the priority of this optimization (0 by default which means first in the list)
  77500. */
  77501. priority: number;
  77502. /**
  77503. * Defines the maximum scale to use (2 by default)
  77504. */
  77505. maximumScale: number;
  77506. /**
  77507. * Defines the step to use between two passes (0.5 by default)
  77508. */
  77509. step: number;
  77510. private _currentScale;
  77511. private _directionOffset;
  77512. /**
  77513. * Gets a string describing the action executed by the current optimization
  77514. * @return description string
  77515. */
  77516. getDescription(): string;
  77517. /**
  77518. * Creates the HardwareScalingOptimization object
  77519. * @param priority defines the priority of this optimization (0 by default which means first in the list)
  77520. * @param maximumScale defines the maximum scale to use (2 by default)
  77521. * @param step defines the step to use between two passes (0.5 by default)
  77522. */
  77523. constructor(
  77524. /**
  77525. * Defines the priority of this optimization (0 by default which means first in the list)
  77526. */
  77527. priority?: number,
  77528. /**
  77529. * Defines the maximum scale to use (2 by default)
  77530. */
  77531. maximumScale?: number,
  77532. /**
  77533. * Defines the step to use between two passes (0.5 by default)
  77534. */
  77535. step?: number);
  77536. /**
  77537. * This function will be called by the SceneOptimizer when its priority is reached in order to apply the change required by the current optimization
  77538. * @param scene defines the current scene where to apply this optimization
  77539. * @param optimizer defines the current optimizer
  77540. * @returns true if everything that can be done was applied
  77541. */
  77542. apply(scene: Scene, optimizer: SceneOptimizer): boolean;
  77543. }
  77544. /**
  77545. * Defines an optimization used to remove shadows
  77546. * @description More details at https://doc.babylonjs.com/how_to/how_to_use_sceneoptimizer
  77547. */
  77548. export class ShadowsOptimization extends SceneOptimization {
  77549. /**
  77550. * Gets a string describing the action executed by the current optimization
  77551. * @return description string
  77552. */
  77553. getDescription(): string;
  77554. /**
  77555. * This function will be called by the SceneOptimizer when its priority is reached in order to apply the change required by the current optimization
  77556. * @param scene defines the current scene where to apply this optimization
  77557. * @param optimizer defines the current optimizer
  77558. * @returns true if everything that can be done was applied
  77559. */
  77560. apply(scene: Scene, optimizer: SceneOptimizer): boolean;
  77561. }
  77562. /**
  77563. * Defines an optimization used to turn post-processes off
  77564. * @description More details at https://doc.babylonjs.com/how_to/how_to_use_sceneoptimizer
  77565. */
  77566. export class PostProcessesOptimization extends SceneOptimization {
  77567. /**
  77568. * Gets a string describing the action executed by the current optimization
  77569. * @return description string
  77570. */
  77571. getDescription(): string;
  77572. /**
  77573. * This function will be called by the SceneOptimizer when its priority is reached in order to apply the change required by the current optimization
  77574. * @param scene defines the current scene where to apply this optimization
  77575. * @param optimizer defines the current optimizer
  77576. * @returns true if everything that can be done was applied
  77577. */
  77578. apply(scene: Scene, optimizer: SceneOptimizer): boolean;
  77579. }
  77580. /**
  77581. * Defines an optimization used to turn lens flares off
  77582. * @description More details at https://doc.babylonjs.com/how_to/how_to_use_sceneoptimizer
  77583. */
  77584. export class LensFlaresOptimization extends SceneOptimization {
  77585. /**
  77586. * Gets a string describing the action executed by the current optimization
  77587. * @return description string
  77588. */
  77589. getDescription(): string;
  77590. /**
  77591. * This function will be called by the SceneOptimizer when its priority is reached in order to apply the change required by the current optimization
  77592. * @param scene defines the current scene where to apply this optimization
  77593. * @param optimizer defines the current optimizer
  77594. * @returns true if everything that can be done was applied
  77595. */
  77596. apply(scene: Scene, optimizer: SceneOptimizer): boolean;
  77597. }
  77598. /**
  77599. * Defines an optimization based on user defined callback.
  77600. * @description More details at https://doc.babylonjs.com/how_to/how_to_use_sceneoptimizer
  77601. */
  77602. export class CustomOptimization extends SceneOptimization {
  77603. /**
  77604. * Callback called to apply the custom optimization.
  77605. */
  77606. onApply: (scene: Scene, optimizer: SceneOptimizer) => boolean;
  77607. /**
  77608. * Callback called to get custom description
  77609. */
  77610. onGetDescription: () => string;
  77611. /**
  77612. * Gets a string describing the action executed by the current optimization
  77613. * @returns description string
  77614. */
  77615. getDescription(): string;
  77616. /**
  77617. * This function will be called by the SceneOptimizer when its priority is reached in order to apply the change required by the current optimization
  77618. * @param scene defines the current scene where to apply this optimization
  77619. * @param optimizer defines the current optimizer
  77620. * @returns true if everything that can be done was applied
  77621. */
  77622. apply(scene: Scene, optimizer: SceneOptimizer): boolean;
  77623. }
  77624. /**
  77625. * Defines an optimization used to turn particles off
  77626. * @description More details at https://doc.babylonjs.com/how_to/how_to_use_sceneoptimizer
  77627. */
  77628. export class ParticlesOptimization extends SceneOptimization {
  77629. /**
  77630. * Gets a string describing the action executed by the current optimization
  77631. * @return description string
  77632. */
  77633. getDescription(): string;
  77634. /**
  77635. * This function will be called by the SceneOptimizer when its priority is reached in order to apply the change required by the current optimization
  77636. * @param scene defines the current scene where to apply this optimization
  77637. * @param optimizer defines the current optimizer
  77638. * @returns true if everything that can be done was applied
  77639. */
  77640. apply(scene: Scene, optimizer: SceneOptimizer): boolean;
  77641. }
  77642. /**
  77643. * Defines an optimization used to turn render targets off
  77644. * @description More details at https://doc.babylonjs.com/how_to/how_to_use_sceneoptimizer
  77645. */
  77646. export class RenderTargetsOptimization extends SceneOptimization {
  77647. /**
  77648. * Gets a string describing the action executed by the current optimization
  77649. * @return description string
  77650. */
  77651. getDescription(): string;
  77652. /**
  77653. * This function will be called by the SceneOptimizer when its priority is reached in order to apply the change required by the current optimization
  77654. * @param scene defines the current scene where to apply this optimization
  77655. * @param optimizer defines the current optimizer
  77656. * @returns true if everything that can be done was applied
  77657. */
  77658. apply(scene: Scene, optimizer: SceneOptimizer): boolean;
  77659. }
  77660. /**
  77661. * Defines an optimization used to merge meshes with compatible materials
  77662. * @description More details at https://doc.babylonjs.com/how_to/how_to_use_sceneoptimizer
  77663. */
  77664. export class MergeMeshesOptimization extends SceneOptimization {
  77665. private static _UpdateSelectionTree;
  77666. /**
  77667. * Gets or sets a boolean which defines if optimization octree has to be updated
  77668. */
  77669. static get UpdateSelectionTree(): boolean;
  77670. /**
  77671. * Gets or sets a boolean which defines if optimization octree has to be updated
  77672. */
  77673. static set UpdateSelectionTree(value: boolean);
  77674. /**
  77675. * Gets a string describing the action executed by the current optimization
  77676. * @return description string
  77677. */
  77678. getDescription(): string;
  77679. private _canBeMerged;
  77680. /**
  77681. * This function will be called by the SceneOptimizer when its priority is reached in order to apply the change required by the current optimization
  77682. * @param scene defines the current scene where to apply this optimization
  77683. * @param optimizer defines the current optimizer
  77684. * @param updateSelectionTree defines that the selection octree has to be updated (false by default)
  77685. * @returns true if everything that can be done was applied
  77686. */
  77687. apply(scene: Scene, optimizer: SceneOptimizer, updateSelectionTree?: boolean): boolean;
  77688. }
  77689. /**
  77690. * Defines a list of options used by SceneOptimizer
  77691. * @description More details at https://doc.babylonjs.com/how_to/how_to_use_sceneoptimizer
  77692. */
  77693. export class SceneOptimizerOptions {
  77694. /**
  77695. * Defines the target frame rate to reach (60 by default)
  77696. */
  77697. targetFrameRate: number;
  77698. /**
  77699. * Defines the interval between two checkes (2000ms by default)
  77700. */
  77701. trackerDuration: number;
  77702. /**
  77703. * Gets the list of optimizations to apply
  77704. */
  77705. optimizations: SceneOptimization[];
  77706. /**
  77707. * Creates a new list of options used by SceneOptimizer
  77708. * @param targetFrameRate defines the target frame rate to reach (60 by default)
  77709. * @param trackerDuration defines the interval between two checkes (2000ms by default)
  77710. */
  77711. constructor(
  77712. /**
  77713. * Defines the target frame rate to reach (60 by default)
  77714. */
  77715. targetFrameRate?: number,
  77716. /**
  77717. * Defines the interval between two checkes (2000ms by default)
  77718. */
  77719. trackerDuration?: number);
  77720. /**
  77721. * Add a new optimization
  77722. * @param optimization defines the SceneOptimization to add to the list of active optimizations
  77723. * @returns the current SceneOptimizerOptions
  77724. */
  77725. addOptimization(optimization: SceneOptimization): SceneOptimizerOptions;
  77726. /**
  77727. * Add a new custom optimization
  77728. * @param onApply defines the callback called to apply the custom optimization (true if everything that can be done was applied)
  77729. * @param onGetDescription defines the callback called to get the description attached with the optimization.
  77730. * @param priority defines the priority of this optimization (0 by default which means first in the list)
  77731. * @returns the current SceneOptimizerOptions
  77732. */
  77733. addCustomOptimization(onApply: (scene: Scene) => boolean, onGetDescription: () => string, priority?: number): SceneOptimizerOptions;
  77734. /**
  77735. * Creates a list of pre-defined optimizations aimed to reduce the visual impact on the scene
  77736. * @param targetFrameRate defines the target frame rate (60 by default)
  77737. * @returns a SceneOptimizerOptions object
  77738. */
  77739. static LowDegradationAllowed(targetFrameRate?: number): SceneOptimizerOptions;
  77740. /**
  77741. * Creates a list of pre-defined optimizations aimed to have a moderate impact on the scene visual
  77742. * @param targetFrameRate defines the target frame rate (60 by default)
  77743. * @returns a SceneOptimizerOptions object
  77744. */
  77745. static ModerateDegradationAllowed(targetFrameRate?: number): SceneOptimizerOptions;
  77746. /**
  77747. * Creates a list of pre-defined optimizations aimed to have a big impact on the scene visual
  77748. * @param targetFrameRate defines the target frame rate (60 by default)
  77749. * @returns a SceneOptimizerOptions object
  77750. */
  77751. static HighDegradationAllowed(targetFrameRate?: number): SceneOptimizerOptions;
  77752. }
  77753. /**
  77754. * Class used to run optimizations in order to reach a target frame rate
  77755. * @description More details at https://doc.babylonjs.com/how_to/how_to_use_sceneoptimizer
  77756. */
  77757. export class SceneOptimizer implements IDisposable {
  77758. private _isRunning;
  77759. private _options;
  77760. private _scene;
  77761. private _currentPriorityLevel;
  77762. private _targetFrameRate;
  77763. private _trackerDuration;
  77764. private _currentFrameRate;
  77765. private _sceneDisposeObserver;
  77766. private _improvementMode;
  77767. /**
  77768. * Defines an observable called when the optimizer reaches the target frame rate
  77769. */
  77770. onSuccessObservable: Observable<SceneOptimizer>;
  77771. /**
  77772. * Defines an observable called when the optimizer enables an optimization
  77773. */
  77774. onNewOptimizationAppliedObservable: Observable<SceneOptimization>;
  77775. /**
  77776. * Defines an observable called when the optimizer is not able to reach the target frame rate
  77777. */
  77778. onFailureObservable: Observable<SceneOptimizer>;
  77779. /**
  77780. * Gets a boolean indicating if the optimizer is in improvement mode
  77781. */
  77782. get isInImprovementMode(): boolean;
  77783. /**
  77784. * Gets the current priority level (0 at start)
  77785. */
  77786. get currentPriorityLevel(): number;
  77787. /**
  77788. * Gets the current frame rate checked by the SceneOptimizer
  77789. */
  77790. get currentFrameRate(): number;
  77791. /**
  77792. * Gets or sets the current target frame rate (60 by default)
  77793. */
  77794. get targetFrameRate(): number;
  77795. /**
  77796. * Gets or sets the current target frame rate (60 by default)
  77797. */
  77798. set targetFrameRate(value: number);
  77799. /**
  77800. * Gets or sets the current interval between two checks (every 2000ms by default)
  77801. */
  77802. get trackerDuration(): number;
  77803. /**
  77804. * Gets or sets the current interval between two checks (every 2000ms by default)
  77805. */
  77806. set trackerDuration(value: number);
  77807. /**
  77808. * Gets the list of active optimizations
  77809. */
  77810. get optimizations(): SceneOptimization[];
  77811. /**
  77812. * Creates a new SceneOptimizer
  77813. * @param scene defines the scene to work on
  77814. * @param options defines the options to use with the SceneOptimizer
  77815. * @param autoGeneratePriorities defines if priorities must be generated and not read from SceneOptimization property (true by default)
  77816. * @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)
  77817. */
  77818. constructor(scene: Scene, options?: SceneOptimizerOptions, autoGeneratePriorities?: boolean, improvementMode?: boolean);
  77819. /**
  77820. * Stops the current optimizer
  77821. */
  77822. stop(): void;
  77823. /**
  77824. * Reset the optimizer to initial step (current priority level = 0)
  77825. */
  77826. reset(): void;
  77827. /**
  77828. * Start the optimizer. By default it will try to reach a specific framerate
  77829. * but if the optimizer is set with improvementMode === true then it will run all optimiatiation while frame rate is above the target frame rate
  77830. */
  77831. start(): void;
  77832. private _checkCurrentState;
  77833. /**
  77834. * Release all resources
  77835. */
  77836. dispose(): void;
  77837. /**
  77838. * Helper function to create a SceneOptimizer with one single line of code
  77839. * @param scene defines the scene to work on
  77840. * @param options defines the options to use with the SceneOptimizer
  77841. * @param onSuccess defines a callback to call on success
  77842. * @param onFailure defines a callback to call on failure
  77843. * @returns the new SceneOptimizer object
  77844. */
  77845. static OptimizeAsync(scene: Scene, options?: SceneOptimizerOptions, onSuccess?: () => void, onFailure?: () => void): SceneOptimizer;
  77846. }
  77847. }
  77848. declare module "babylonjs/Misc/sceneSerializer" {
  77849. import { Scene } from "babylonjs/scene";
  77850. /**
  77851. * Class used to serialize a scene into a string
  77852. */
  77853. export class SceneSerializer {
  77854. /**
  77855. * Clear cache used by a previous serialization
  77856. */
  77857. static ClearCache(): void;
  77858. /**
  77859. * Serialize a scene into a JSON compatible object
  77860. * @param scene defines the scene to serialize
  77861. * @returns a JSON compatible object
  77862. */
  77863. static Serialize(scene: Scene): any;
  77864. /**
  77865. * Serialize a mesh into a JSON compatible object
  77866. * @param toSerialize defines the mesh to serialize
  77867. * @param withParents defines if parents must be serialized as well
  77868. * @param withChildren defines if children must be serialized as well
  77869. * @returns a JSON compatible object
  77870. */
  77871. static SerializeMesh(toSerialize: any, withParents?: boolean, withChildren?: boolean): any;
  77872. }
  77873. }
  77874. declare module "babylonjs/Misc/textureTools" {
  77875. import { Texture } from "babylonjs/Materials/Textures/texture";
  77876. /**
  77877. * Class used to host texture specific utilities
  77878. */
  77879. export class TextureTools {
  77880. /**
  77881. * Uses the GPU to create a copy texture rescaled at a given size
  77882. * @param texture Texture to copy from
  77883. * @param width defines the desired width
  77884. * @param height defines the desired height
  77885. * @param useBilinearMode defines if bilinear mode has to be used
  77886. * @return the generated texture
  77887. */
  77888. static CreateResizedCopy(texture: Texture, width: number, height: number, useBilinearMode?: boolean): Texture;
  77889. }
  77890. }
  77891. declare module "babylonjs/Misc/videoRecorder" {
  77892. import { Nullable } from "babylonjs/types";
  77893. import { Engine } from "babylonjs/Engines/engine";
  77894. /**
  77895. * This represents the different options available for the video capture.
  77896. */
  77897. export interface VideoRecorderOptions {
  77898. /** Defines the mime type of the video. */
  77899. mimeType: string;
  77900. /** Defines the FPS the video should be recorded at. */
  77901. fps: number;
  77902. /** Defines the chunk size for the recording data. */
  77903. recordChunckSize: number;
  77904. /** The audio tracks to attach to the recording. */
  77905. audioTracks?: MediaStreamTrack[];
  77906. }
  77907. /**
  77908. * This can help with recording videos from BabylonJS.
  77909. * This is based on the available WebRTC functionalities of the browser.
  77910. *
  77911. * @see https://doc.babylonjs.com/how_to/render_scene_on_a_video
  77912. */
  77913. export class VideoRecorder {
  77914. private static readonly _defaultOptions;
  77915. /**
  77916. * Returns whether or not the VideoRecorder is available in your browser.
  77917. * @param engine Defines the Babylon Engine.
  77918. * @returns true if supported otherwise false.
  77919. */
  77920. static IsSupported(engine: Engine): boolean;
  77921. private readonly _options;
  77922. private _canvas;
  77923. private _mediaRecorder;
  77924. private _recordedChunks;
  77925. private _fileName;
  77926. private _resolve;
  77927. private _reject;
  77928. /**
  77929. * True when a recording is already in progress.
  77930. */
  77931. get isRecording(): boolean;
  77932. /**
  77933. * Create a new VideoCapture object which can help converting what you see in Babylon to a video file.
  77934. * @param engine Defines the BabylonJS Engine you wish to record.
  77935. * @param options Defines options that can be used to customize the capture.
  77936. */
  77937. constructor(engine: Engine, options?: Nullable<VideoRecorderOptions>);
  77938. /**
  77939. * Stops the current recording before the default capture timeout passed in the startRecording function.
  77940. */
  77941. stopRecording(): void;
  77942. /**
  77943. * Starts recording the canvas for a max duration specified in parameters.
  77944. * @param fileName Defines the name of the file to be downloaded when the recording stop.
  77945. * If null no automatic download will start and you can rely on the promise to get the data back.
  77946. * @param maxDuration Defines the maximum recording time in seconds.
  77947. * It defaults to 7 seconds. A value of zero will not stop automatically, you would need to call stopRecording manually.
  77948. * @return A promise callback at the end of the recording with the video data in Blob.
  77949. */
  77950. startRecording(fileName?: Nullable<string>, maxDuration?: number): Promise<Blob>;
  77951. /**
  77952. * Releases internal resources used during the recording.
  77953. */
  77954. dispose(): void;
  77955. private _handleDataAvailable;
  77956. private _handleError;
  77957. private _handleStop;
  77958. }
  77959. }
  77960. declare module "babylonjs/Misc/screenshotTools" {
  77961. import { Camera } from "babylonjs/Cameras/camera";
  77962. import { IScreenshotSize } from "babylonjs/Misc/interfaces/screenshotSize";
  77963. import { Engine } from "babylonjs/Engines/engine";
  77964. /**
  77965. * Class containing a set of static utilities functions for screenshots
  77966. */
  77967. export class ScreenshotTools {
  77968. /**
  77969. * Captures a screenshot of the current rendering
  77970. * @see https://doc.babylonjs.com/how_to/render_scene_on_a_png
  77971. * @param engine defines the rendering engine
  77972. * @param camera defines the source camera
  77973. * @param size This parameter can be set to a single number or to an object with the
  77974. * following (optional) properties: precision, width, height. If a single number is passed,
  77975. * it will be used for both width and height. If an object is passed, the screenshot size
  77976. * will be derived from the parameters. The precision property is a multiplier allowing
  77977. * rendering at a higher or lower resolution
  77978. * @param successCallback defines the callback receives a single parameter which contains the
  77979. * screenshot as a string of base64-encoded characters. This string can be assigned to the
  77980. * src parameter of an <img> to display it
  77981. * @param mimeType defines the MIME type of the screenshot image (default: image/png).
  77982. * Check your browser for supported MIME types
  77983. */
  77984. static CreateScreenshot(engine: Engine, camera: Camera, size: IScreenshotSize | number, successCallback?: (data: string) => void, mimeType?: string): void;
  77985. /**
  77986. * Captures a screenshot of the current rendering
  77987. * @see https://doc.babylonjs.com/how_to/render_scene_on_a_png
  77988. * @param engine defines the rendering engine
  77989. * @param camera defines the source camera
  77990. * @param size This parameter can be set to a single number or to an object with the
  77991. * following (optional) properties: precision, width, height. If a single number is passed,
  77992. * it will be used for both width and height. If an object is passed, the screenshot size
  77993. * will be derived from the parameters. The precision property is a multiplier allowing
  77994. * rendering at a higher or lower resolution
  77995. * @param mimeType defines the MIME type of the screenshot image (default: image/png).
  77996. * Check your browser for supported MIME types
  77997. * @returns screenshot as a string of base64-encoded characters. This string can be assigned
  77998. * to the src parameter of an <img> to display it
  77999. */
  78000. static CreateScreenshotAsync(engine: Engine, camera: Camera, size: any, mimeType?: string): Promise<string>;
  78001. /**
  78002. * Generates an image screenshot from the specified camera.
  78003. * @see https://doc.babylonjs.com/how_to/render_scene_on_a_png
  78004. * @param engine The engine to use for rendering
  78005. * @param camera The camera to use for rendering
  78006. * @param size This parameter can be set to a single number or to an object with the
  78007. * following (optional) properties: precision, width, height. If a single number is passed,
  78008. * it will be used for both width and height. If an object is passed, the screenshot size
  78009. * will be derived from the parameters. The precision property is a multiplier allowing
  78010. * rendering at a higher or lower resolution
  78011. * @param successCallback The callback receives a single parameter which contains the
  78012. * screenshot as a string of base64-encoded characters. This string can be assigned to the
  78013. * src parameter of an <img> to display it
  78014. * @param mimeType The MIME type of the screenshot image (default: image/png).
  78015. * Check your browser for supported MIME types
  78016. * @param samples Texture samples (default: 1)
  78017. * @param antialiasing Whether antialiasing should be turned on or not (default: false)
  78018. * @param fileName A name for for the downloaded file.
  78019. * @param renderSprites Whether the sprites should be rendered or not (default: false)
  78020. * @param enableStencilBuffer Whether the stencil buffer should be enabled or not (default: false)
  78021. */
  78022. 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;
  78023. /**
  78024. * Generates an image screenshot from the specified camera.
  78025. * @see https://doc.babylonjs.com/how_to/render_scene_on_a_png
  78026. * @param engine The engine to use for rendering
  78027. * @param camera The camera to use for rendering
  78028. * @param size This parameter can be set to a single number or to an object with the
  78029. * following (optional) properties: precision, width, height. If a single number is passed,
  78030. * it will be used for both width and height. If an object is passed, the screenshot size
  78031. * will be derived from the parameters. The precision property is a multiplier allowing
  78032. * rendering at a higher or lower resolution
  78033. * @param mimeType The MIME type of the screenshot image (default: image/png).
  78034. * Check your browser for supported MIME types
  78035. * @param samples Texture samples (default: 1)
  78036. * @param antialiasing Whether antialiasing should be turned on or not (default: false)
  78037. * @param fileName A name for for the downloaded file.
  78038. * @param renderSprites Whether the sprites should be rendered or not (default: false)
  78039. * @returns screenshot as a string of base64-encoded characters. This string can be assigned
  78040. * to the src parameter of an <img> to display it
  78041. */
  78042. static CreateScreenshotUsingRenderTargetAsync(engine: Engine, camera: Camera, size: any, mimeType?: string, samples?: number, antialiasing?: boolean, fileName?: string, renderSprites?: boolean): Promise<string>;
  78043. /**
  78044. * Gets height and width for screenshot size
  78045. * @private
  78046. */
  78047. private static _getScreenshotSize;
  78048. }
  78049. }
  78050. declare module "babylonjs/Misc/dataReader" {
  78051. /**
  78052. * Interface for a data buffer
  78053. */
  78054. export interface IDataBuffer {
  78055. /**
  78056. * Reads bytes from the data buffer.
  78057. * @param byteOffset The byte offset to read
  78058. * @param byteLength The byte length to read
  78059. * @returns A promise that resolves when the bytes are read
  78060. */
  78061. readAsync(byteOffset: number, byteLength: number): Promise<ArrayBufferView>;
  78062. /**
  78063. * The byte length of the buffer.
  78064. */
  78065. readonly byteLength: number;
  78066. }
  78067. /**
  78068. * Utility class for reading from a data buffer
  78069. */
  78070. export class DataReader {
  78071. /**
  78072. * The data buffer associated with this data reader.
  78073. */
  78074. readonly buffer: IDataBuffer;
  78075. /**
  78076. * The current byte offset from the beginning of the data buffer.
  78077. */
  78078. byteOffset: number;
  78079. private _dataView;
  78080. private _dataByteOffset;
  78081. /**
  78082. * Constructor
  78083. * @param buffer The buffer to read
  78084. */
  78085. constructor(buffer: IDataBuffer);
  78086. /**
  78087. * Loads the given byte length.
  78088. * @param byteLength The byte length to load
  78089. * @returns A promise that resolves when the load is complete
  78090. */
  78091. loadAsync(byteLength: number): Promise<void>;
  78092. /**
  78093. * Read a unsigned 32-bit integer from the currently loaded data range.
  78094. * @returns The 32-bit integer read
  78095. */
  78096. readUint32(): number;
  78097. /**
  78098. * Read a byte array from the currently loaded data range.
  78099. * @param byteLength The byte length to read
  78100. * @returns The byte array read
  78101. */
  78102. readUint8Array(byteLength: number): Uint8Array;
  78103. /**
  78104. * Read a string from the currently loaded data range.
  78105. * @param byteLength The byte length to read
  78106. * @returns The string read
  78107. */
  78108. readString(byteLength: number): string;
  78109. /**
  78110. * Skips the given byte length the currently loaded data range.
  78111. * @param byteLength The byte length to skip
  78112. */
  78113. skipBytes(byteLength: number): void;
  78114. }
  78115. }
  78116. declare module "babylonjs/Misc/dataStorage" {
  78117. /**
  78118. * Class for storing data to local storage if available or in-memory storage otherwise
  78119. */
  78120. export class DataStorage {
  78121. private static _Storage;
  78122. private static _GetStorage;
  78123. /**
  78124. * Reads a string from the data storage
  78125. * @param key The key to read
  78126. * @param defaultValue The value if the key doesn't exist
  78127. * @returns The string value
  78128. */
  78129. static ReadString(key: string, defaultValue: string): string;
  78130. /**
  78131. * Writes a string to the data storage
  78132. * @param key The key to write
  78133. * @param value The value to write
  78134. */
  78135. static WriteString(key: string, value: string): void;
  78136. /**
  78137. * Reads a boolean from the data storage
  78138. * @param key The key to read
  78139. * @param defaultValue The value if the key doesn't exist
  78140. * @returns The boolean value
  78141. */
  78142. static ReadBoolean(key: string, defaultValue: boolean): boolean;
  78143. /**
  78144. * Writes a boolean to the data storage
  78145. * @param key The key to write
  78146. * @param value The value to write
  78147. */
  78148. static WriteBoolean(key: string, value: boolean): void;
  78149. /**
  78150. * Reads a number from the data storage
  78151. * @param key The key to read
  78152. * @param defaultValue The value if the key doesn't exist
  78153. * @returns The number value
  78154. */
  78155. static ReadNumber(key: string, defaultValue: number): number;
  78156. /**
  78157. * Writes a number to the data storage
  78158. * @param key The key to write
  78159. * @param value The value to write
  78160. */
  78161. static WriteNumber(key: string, value: number): void;
  78162. }
  78163. }
  78164. declare module "babylonjs/Misc/sceneRecorder" {
  78165. import { Scene } from "babylonjs/scene";
  78166. /**
  78167. * Class used to record delta files between 2 scene states
  78168. */
  78169. export class SceneRecorder {
  78170. private _trackedScene;
  78171. private _savedJSON;
  78172. /**
  78173. * Track a given scene. This means the current scene state will be considered the original state
  78174. * @param scene defines the scene to track
  78175. */
  78176. track(scene: Scene): void;
  78177. /**
  78178. * Get the delta between current state and original state
  78179. * @returns a string containing the delta
  78180. */
  78181. getDelta(): any;
  78182. private _compareArray;
  78183. private _compareObjects;
  78184. private _compareCollections;
  78185. private static GetShadowGeneratorById;
  78186. /**
  78187. * Apply a given delta to a given scene
  78188. * @param deltaJSON defines the JSON containing the delta
  78189. * @param scene defines the scene to apply the delta to
  78190. */
  78191. static ApplyDelta(deltaJSON: any | string, scene: Scene): void;
  78192. private static _ApplyPropertiesToEntity;
  78193. private static _ApplyDeltaForEntity;
  78194. }
  78195. }
  78196. declare module "babylonjs/Misc/index" {
  78197. export * from "babylonjs/Misc/andOrNotEvaluator";
  78198. export * from "babylonjs/Misc/assetsManager";
  78199. export * from "babylonjs/Misc/basis";
  78200. export * from "babylonjs/Misc/dds";
  78201. export * from "babylonjs/Misc/decorators";
  78202. export * from "babylonjs/Misc/deferred";
  78203. export * from "babylonjs/Misc/environmentTextureTools";
  78204. export * from "babylonjs/Misc/meshExploder";
  78205. export * from "babylonjs/Misc/filesInput";
  78206. export * from "babylonjs/Misc/HighDynamicRange/index";
  78207. export * from "babylonjs/Misc/khronosTextureContainer";
  78208. export * from "babylonjs/Misc/observable";
  78209. export * from "babylonjs/Misc/performanceMonitor";
  78210. export * from "babylonjs/Misc/promise";
  78211. export * from "babylonjs/Misc/sceneOptimizer";
  78212. export * from "babylonjs/Misc/sceneSerializer";
  78213. export * from "babylonjs/Misc/smartArray";
  78214. export * from "babylonjs/Misc/stringDictionary";
  78215. export * from "babylonjs/Misc/tags";
  78216. export * from "babylonjs/Misc/textureTools";
  78217. export * from "babylonjs/Misc/tga";
  78218. export * from "babylonjs/Misc/tools";
  78219. export * from "babylonjs/Misc/videoRecorder";
  78220. export * from "babylonjs/Misc/virtualJoystick";
  78221. export * from "babylonjs/Misc/workerPool";
  78222. export * from "babylonjs/Misc/logger";
  78223. export * from "babylonjs/Misc/typeStore";
  78224. export * from "babylonjs/Misc/filesInputStore";
  78225. export * from "babylonjs/Misc/deepCopier";
  78226. export * from "babylonjs/Misc/pivotTools";
  78227. export * from "babylonjs/Misc/precisionDate";
  78228. export * from "babylonjs/Misc/screenshotTools";
  78229. export * from "babylonjs/Misc/typeStore";
  78230. export * from "babylonjs/Misc/webRequest";
  78231. export * from "babylonjs/Misc/iInspectable";
  78232. export * from "babylonjs/Misc/brdfTextureTools";
  78233. export * from "babylonjs/Misc/rgbdTextureTools";
  78234. export * from "babylonjs/Misc/gradients";
  78235. export * from "babylonjs/Misc/perfCounter";
  78236. export * from "babylonjs/Misc/fileRequest";
  78237. export * from "babylonjs/Misc/customAnimationFrameRequester";
  78238. export * from "babylonjs/Misc/retryStrategy";
  78239. export * from "babylonjs/Misc/interfaces/screenshotSize";
  78240. export * from "babylonjs/Misc/canvasGenerator";
  78241. export * from "babylonjs/Misc/fileTools";
  78242. export * from "babylonjs/Misc/stringTools";
  78243. export * from "babylonjs/Misc/dataReader";
  78244. export * from "babylonjs/Misc/minMaxReducer";
  78245. export * from "babylonjs/Misc/depthReducer";
  78246. export * from "babylonjs/Misc/dataStorage";
  78247. export * from "babylonjs/Misc/sceneRecorder";
  78248. }
  78249. declare module "babylonjs/XR/features/WebXRHitTestLegacy" {
  78250. import { IWebXRFeature } from "babylonjs/XR/webXRFeaturesManager";
  78251. import { WebXRSessionManager } from "babylonjs/XR/webXRSessionManager";
  78252. import { Observable } from "babylonjs/Misc/observable";
  78253. import { Matrix } from "babylonjs/Maths/math.vector";
  78254. import { TransformNode } from "babylonjs/Meshes/transformNode";
  78255. import { WebXRAbstractFeature } from "babylonjs/XR/features/WebXRAbstractFeature";
  78256. /**
  78257. * An interface for all Hit test features
  78258. */
  78259. export interface IWebXRHitTestFeature<T extends IWebXRLegacyHitResult> extends IWebXRFeature {
  78260. /**
  78261. * Triggered when new babylon (transformed) hit test results are available
  78262. */
  78263. onHitTestResultObservable: Observable<T[]>;
  78264. }
  78265. /**
  78266. * Options used for hit testing
  78267. */
  78268. export interface IWebXRLegacyHitTestOptions {
  78269. /**
  78270. * Only test when user interacted with the scene. Default - hit test every frame
  78271. */
  78272. testOnPointerDownOnly?: boolean;
  78273. /**
  78274. * The node to use to transform the local results to world coordinates
  78275. */
  78276. worldParentNode?: TransformNode;
  78277. }
  78278. /**
  78279. * Interface defining the babylon result of raycasting/hit-test
  78280. */
  78281. export interface IWebXRLegacyHitResult {
  78282. /**
  78283. * Transformation matrix that can be applied to a node that will put it in the hit point location
  78284. */
  78285. transformationMatrix: Matrix;
  78286. /**
  78287. * The native hit test result
  78288. */
  78289. xrHitResult: XRHitResult | XRHitTestResult;
  78290. }
  78291. /**
  78292. * The currently-working hit-test module.
  78293. * Hit test (or Ray-casting) is used to interact with the real world.
  78294. * For further information read here - https://github.com/immersive-web/hit-test
  78295. */
  78296. export class WebXRHitTestLegacy extends WebXRAbstractFeature implements IWebXRHitTestFeature<IWebXRLegacyHitResult> {
  78297. /**
  78298. * options to use when constructing this feature
  78299. */
  78300. readonly options: IWebXRLegacyHitTestOptions;
  78301. private _direction;
  78302. private _mat;
  78303. private _onSelectEnabled;
  78304. private _origin;
  78305. /**
  78306. * The module's name
  78307. */
  78308. static readonly Name: string;
  78309. /**
  78310. * The (Babylon) version of this module.
  78311. * This is an integer representing the implementation version.
  78312. * This number does not correspond to the WebXR specs version
  78313. */
  78314. static readonly Version: number;
  78315. /**
  78316. * Populated with the last native XR Hit Results
  78317. */
  78318. lastNativeXRHitResults: XRHitResult[];
  78319. /**
  78320. * Triggered when new babylon (transformed) hit test results are available
  78321. */
  78322. onHitTestResultObservable: Observable<IWebXRLegacyHitResult[]>;
  78323. /**
  78324. * Creates a new instance of the (legacy version) hit test feature
  78325. * @param _xrSessionManager an instance of WebXRSessionManager
  78326. * @param options options to use when constructing this feature
  78327. */
  78328. constructor(_xrSessionManager: WebXRSessionManager,
  78329. /**
  78330. * options to use when constructing this feature
  78331. */
  78332. options?: IWebXRLegacyHitTestOptions);
  78333. /**
  78334. * execute a hit test with an XR Ray
  78335. *
  78336. * @param xrSession a native xrSession that will execute this hit test
  78337. * @param xrRay the ray (position and direction) to use for ray-casting
  78338. * @param referenceSpace native XR reference space to use for the hit-test
  78339. * @param filter filter function that will filter the results
  78340. * @returns a promise that resolves with an array of native XR hit result in xr coordinates system
  78341. */
  78342. static XRHitTestWithRay(xrSession: XRSession, xrRay: XRRay, referenceSpace: XRReferenceSpace, filter?: (result: XRHitResult) => boolean): Promise<XRHitResult[]>;
  78343. /**
  78344. * Execute a hit test on the current running session using a select event returned from a transient input (such as touch)
  78345. * @param event the (select) event to use to select with
  78346. * @param referenceSpace the reference space to use for this hit test
  78347. * @returns a promise that resolves with an array of native XR hit result in xr coordinates system
  78348. */
  78349. static XRHitTestWithSelectEvent(event: XRInputSourceEvent, referenceSpace: XRReferenceSpace): Promise<XRHitResult[]>;
  78350. /**
  78351. * attach this feature
  78352. * Will usually be called by the features manager
  78353. *
  78354. * @returns true if successful.
  78355. */
  78356. attach(): boolean;
  78357. /**
  78358. * detach this feature.
  78359. * Will usually be called by the features manager
  78360. *
  78361. * @returns true if successful.
  78362. */
  78363. detach(): boolean;
  78364. /**
  78365. * Dispose this feature and all of the resources attached
  78366. */
  78367. dispose(): void;
  78368. protected _onXRFrame(frame: XRFrame): void;
  78369. private _onHitTestResults;
  78370. private _onSelect;
  78371. }
  78372. }
  78373. declare module "babylonjs/XR/features/WebXRHitTest" {
  78374. import { WebXRSessionManager } from "babylonjs/XR/webXRSessionManager";
  78375. import { Observable } from "babylonjs/Misc/observable";
  78376. import { Vector3, Quaternion } from "babylonjs/Maths/math.vector";
  78377. import { WebXRAbstractFeature } from "babylonjs/XR/features/WebXRAbstractFeature";
  78378. import { IWebXRLegacyHitTestOptions, IWebXRLegacyHitResult, IWebXRHitTestFeature } from "babylonjs/XR/features/WebXRHitTestLegacy";
  78379. /**
  78380. * Options used for hit testing (version 2)
  78381. */
  78382. export interface IWebXRHitTestOptions extends IWebXRLegacyHitTestOptions {
  78383. /**
  78384. * Do not create a permanent hit test. Will usually be used when only
  78385. * transient inputs are needed.
  78386. */
  78387. disablePermanentHitTest?: boolean;
  78388. /**
  78389. * Enable transient (for example touch-based) hit test inspections
  78390. */
  78391. enableTransientHitTest?: boolean;
  78392. /**
  78393. * Offset ray for the permanent hit test
  78394. */
  78395. offsetRay?: Vector3;
  78396. /**
  78397. * Offset ray for the transient hit test
  78398. */
  78399. transientOffsetRay?: Vector3;
  78400. /**
  78401. * Instead of using viewer space for hit tests, use the reference space defined in the session manager
  78402. */
  78403. useReferenceSpace?: boolean;
  78404. /**
  78405. * Override the default entity type(s) of the hit-test result
  78406. */
  78407. entityTypes?: XRHitTestTrackableType[];
  78408. }
  78409. /**
  78410. * Interface defining the babylon result of hit-test
  78411. */
  78412. export interface IWebXRHitResult extends IWebXRLegacyHitResult {
  78413. /**
  78414. * The input source that generated this hit test (if transient)
  78415. */
  78416. inputSource?: XRInputSource;
  78417. /**
  78418. * Is this a transient hit test
  78419. */
  78420. isTransient?: boolean;
  78421. /**
  78422. * Position of the hit test result
  78423. */
  78424. position: Vector3;
  78425. /**
  78426. * Rotation of the hit test result
  78427. */
  78428. rotationQuaternion: Quaternion;
  78429. /**
  78430. * The native hit test result
  78431. */
  78432. xrHitResult: XRHitTestResult;
  78433. }
  78434. /**
  78435. * The currently-working hit-test module.
  78436. * Hit test (or Ray-casting) is used to interact with the real world.
  78437. * For further information read here - https://github.com/immersive-web/hit-test
  78438. *
  78439. * Tested on chrome (mobile) 80.
  78440. */
  78441. export class WebXRHitTest extends WebXRAbstractFeature implements IWebXRHitTestFeature<IWebXRHitResult> {
  78442. /**
  78443. * options to use when constructing this feature
  78444. */
  78445. readonly options: IWebXRHitTestOptions;
  78446. private _tmpMat;
  78447. private _tmpPos;
  78448. private _tmpQuat;
  78449. private _transientXrHitTestSource;
  78450. private _xrHitTestSource;
  78451. private initHitTestSource;
  78452. /**
  78453. * The module's name
  78454. */
  78455. static readonly Name: string;
  78456. /**
  78457. * The (Babylon) version of this module.
  78458. * This is an integer representing the implementation version.
  78459. * This number does not correspond to the WebXR specs version
  78460. */
  78461. static readonly Version: number;
  78462. /**
  78463. * When set to true, each hit test will have its own position/rotation objects
  78464. * When set to false, position and rotation objects will be reused for each hit test. It is expected that
  78465. * the developers will clone them or copy them as they see fit.
  78466. */
  78467. autoCloneTransformation: boolean;
  78468. /**
  78469. * Triggered when new babylon (transformed) hit test results are available
  78470. */
  78471. onHitTestResultObservable: Observable<IWebXRHitResult[]>;
  78472. /**
  78473. * Use this to temporarily pause hit test checks.
  78474. */
  78475. paused: boolean;
  78476. /**
  78477. * Creates a new instance of the hit test feature
  78478. * @param _xrSessionManager an instance of WebXRSessionManager
  78479. * @param options options to use when constructing this feature
  78480. */
  78481. constructor(_xrSessionManager: WebXRSessionManager,
  78482. /**
  78483. * options to use when constructing this feature
  78484. */
  78485. options?: IWebXRHitTestOptions);
  78486. /**
  78487. * attach this feature
  78488. * Will usually be called by the features manager
  78489. *
  78490. * @returns true if successful.
  78491. */
  78492. attach(): boolean;
  78493. /**
  78494. * detach this feature.
  78495. * Will usually be called by the features manager
  78496. *
  78497. * @returns true if successful.
  78498. */
  78499. detach(): boolean;
  78500. /**
  78501. * Dispose this feature and all of the resources attached
  78502. */
  78503. dispose(): void;
  78504. protected _onXRFrame(frame: XRFrame): void;
  78505. private _processWebXRHitTestResult;
  78506. }
  78507. }
  78508. declare module "babylonjs/XR/features/WebXRAnchorSystem" {
  78509. import { WebXRSessionManager } from "babylonjs/XR/webXRSessionManager";
  78510. import { Observable } from "babylonjs/Misc/observable";
  78511. import { Matrix, Vector3, Quaternion } from "babylonjs/Maths/math.vector";
  78512. import { TransformNode } from "babylonjs/Meshes/transformNode";
  78513. import { WebXRAbstractFeature } from "babylonjs/XR/features/WebXRAbstractFeature";
  78514. import { IWebXRHitResult } from "babylonjs/XR/features/WebXRHitTest";
  78515. /**
  78516. * Configuration options of the anchor system
  78517. */
  78518. export interface IWebXRAnchorSystemOptions {
  78519. /**
  78520. * a node that will be used to convert local to world coordinates
  78521. */
  78522. worldParentNode?: TransformNode;
  78523. /**
  78524. * If set to true a reference of the created anchors will be kept until the next session starts
  78525. * If not defined, anchors will be removed from the array when the feature is detached or the session ended.
  78526. */
  78527. doNotRemoveAnchorsOnSessionEnded?: boolean;
  78528. }
  78529. /**
  78530. * A babylon container for an XR Anchor
  78531. */
  78532. export interface IWebXRAnchor {
  78533. /**
  78534. * A babylon-assigned ID for this anchor
  78535. */
  78536. id: number;
  78537. /**
  78538. * Transformation matrix to apply to an object attached to this anchor
  78539. */
  78540. transformationMatrix: Matrix;
  78541. /**
  78542. * The native anchor object
  78543. */
  78544. xrAnchor: XRAnchor;
  78545. /**
  78546. * if defined, this object will be constantly updated by the anchor's position and rotation
  78547. */
  78548. attachedNode?: TransformNode;
  78549. }
  78550. /**
  78551. * An implementation of the anchor system for WebXR.
  78552. * For further information see https://github.com/immersive-web/anchors/
  78553. */
  78554. export class WebXRAnchorSystem extends WebXRAbstractFeature {
  78555. private _options;
  78556. private _lastFrameDetected;
  78557. private _trackedAnchors;
  78558. private _referenceSpaceForFrameAnchors;
  78559. private _futureAnchors;
  78560. /**
  78561. * The module's name
  78562. */
  78563. static readonly Name: string;
  78564. /**
  78565. * The (Babylon) version of this module.
  78566. * This is an integer representing the implementation version.
  78567. * This number does not correspond to the WebXR specs version
  78568. */
  78569. static readonly Version: number;
  78570. /**
  78571. * Observers registered here will be executed when a new anchor was added to the session
  78572. */
  78573. onAnchorAddedObservable: Observable<IWebXRAnchor>;
  78574. /**
  78575. * Observers registered here will be executed when an anchor was removed from the session
  78576. */
  78577. onAnchorRemovedObservable: Observable<IWebXRAnchor>;
  78578. /**
  78579. * Observers registered here will be executed when an existing anchor updates
  78580. * This can execute N times every frame
  78581. */
  78582. onAnchorUpdatedObservable: Observable<IWebXRAnchor>;
  78583. /**
  78584. * Set the reference space to use for anchor creation, when not using a hit test.
  78585. * Will default to the session's reference space if not defined
  78586. */
  78587. set referenceSpaceForFrameAnchors(referenceSpace: XRReferenceSpace);
  78588. /**
  78589. * constructs a new anchor system
  78590. * @param _xrSessionManager an instance of WebXRSessionManager
  78591. * @param _options configuration object for this feature
  78592. */
  78593. constructor(_xrSessionManager: WebXRSessionManager, _options?: IWebXRAnchorSystemOptions);
  78594. private _tmpVector;
  78595. private _tmpQuaternion;
  78596. private _populateTmpTransformation;
  78597. /**
  78598. * Create a new anchor point using a hit test result at a specific point in the scene
  78599. * An anchor is tracked only after it is added to the trackerAnchors in xrFrame. The promise returned here does not yet guaranty that.
  78600. * Use onAnchorAddedObservable to get newly added anchors if you require tracking guaranty.
  78601. *
  78602. * @param hitTestResult The hit test result to use for this anchor creation
  78603. * @param position an optional position offset for this anchor
  78604. * @param rotationQuaternion an optional rotation offset for this anchor
  78605. * @returns A promise that fulfills when the XR anchor was registered in the system (but not necessarily added to the tracked anchors)
  78606. */
  78607. addAnchorPointUsingHitTestResultAsync(hitTestResult: IWebXRHitResult, position?: Vector3, rotationQuaternion?: Quaternion): Promise<XRAnchor>;
  78608. /**
  78609. * Add a new anchor at a specific position and rotation
  78610. * This function will add a new anchor per default in the next available frame. Unless forced, the createAnchor function
  78611. * will be called in the next xrFrame loop to make sure that the anchor can be created correctly.
  78612. * An anchor is tracked only after it is added to the trackerAnchors in xrFrame. The promise returned here does not yet guaranty that.
  78613. * Use onAnchorAddedObservable to get newly added anchors if you require tracking guaranty.
  78614. *
  78615. * @param position the position in which to add an anchor
  78616. * @param rotationQuaternion an optional rotation for the anchor transformation
  78617. * @param forceCreateInCurrentFrame force the creation of this anchor in the current frame. Must be called inside xrFrame loop!
  78618. * @returns A promise that fulfills when the XR anchor was registered in the system (but not necessarily added to the tracked anchors)
  78619. */
  78620. addAnchorAtPositionAndRotationAsync(position: Vector3, rotationQuaternion?: Quaternion, forceCreateInCurrentFrame?: boolean): Promise<XRAnchor>;
  78621. /**
  78622. * detach this feature.
  78623. * Will usually be called by the features manager
  78624. *
  78625. * @returns true if successful.
  78626. */
  78627. detach(): boolean;
  78628. /**
  78629. * Dispose this feature and all of the resources attached
  78630. */
  78631. dispose(): void;
  78632. protected _onXRFrame(frame: XRFrame): void;
  78633. /**
  78634. * avoiding using Array.find for global support.
  78635. * @param xrAnchor the plane to find in the array
  78636. */
  78637. private _findIndexInAnchorArray;
  78638. private _updateAnchorWithXRFrame;
  78639. private _createAnchorAtTransformation;
  78640. }
  78641. }
  78642. declare module "babylonjs/XR/features/WebXRPlaneDetector" {
  78643. import { TransformNode } from "babylonjs/Meshes/transformNode";
  78644. import { WebXRSessionManager } from "babylonjs/XR/webXRSessionManager";
  78645. import { Observable } from "babylonjs/Misc/observable";
  78646. import { Vector3, Matrix } from "babylonjs/Maths/math.vector";
  78647. import { WebXRAbstractFeature } from "babylonjs/XR/features/WebXRAbstractFeature";
  78648. /**
  78649. * Options used in the plane detector module
  78650. */
  78651. export interface IWebXRPlaneDetectorOptions {
  78652. /**
  78653. * The node to use to transform the local results to world coordinates
  78654. */
  78655. worldParentNode?: TransformNode;
  78656. /**
  78657. * If set to true a reference of the created planes will be kept until the next session starts
  78658. * If not defined, planes will be removed from the array when the feature is detached or the session ended.
  78659. */
  78660. doNotRemovePlanesOnSessionEnded?: boolean;
  78661. }
  78662. /**
  78663. * A babylon interface for a WebXR plane.
  78664. * A Plane is actually a polygon, built from N points in space
  78665. *
  78666. * Supported in chrome 79, not supported in canary 81 ATM
  78667. */
  78668. export interface IWebXRPlane {
  78669. /**
  78670. * a babylon-assigned ID for this polygon
  78671. */
  78672. id: number;
  78673. /**
  78674. * an array of vector3 points in babylon space. right/left hand system is taken into account.
  78675. */
  78676. polygonDefinition: Array<Vector3>;
  78677. /**
  78678. * A transformation matrix to apply on the mesh that will be built using the polygonDefinition
  78679. * Local vs. World are decided if worldParentNode was provided or not in the options when constructing the module
  78680. */
  78681. transformationMatrix: Matrix;
  78682. /**
  78683. * the native xr-plane object
  78684. */
  78685. xrPlane: XRPlane;
  78686. }
  78687. /**
  78688. * The plane detector is used to detect planes in the real world when in AR
  78689. * For more information see https://github.com/immersive-web/real-world-geometry/
  78690. */
  78691. export class WebXRPlaneDetector extends WebXRAbstractFeature {
  78692. private _options;
  78693. private _detectedPlanes;
  78694. private _enabled;
  78695. private _lastFrameDetected;
  78696. /**
  78697. * The module's name
  78698. */
  78699. static readonly Name: string;
  78700. /**
  78701. * The (Babylon) version of this module.
  78702. * This is an integer representing the implementation version.
  78703. * This number does not correspond to the WebXR specs version
  78704. */
  78705. static readonly Version: number;
  78706. /**
  78707. * Observers registered here will be executed when a new plane was added to the session
  78708. */
  78709. onPlaneAddedObservable: Observable<IWebXRPlane>;
  78710. /**
  78711. * Observers registered here will be executed when a plane is no longer detected in the session
  78712. */
  78713. onPlaneRemovedObservable: Observable<IWebXRPlane>;
  78714. /**
  78715. * Observers registered here will be executed when an existing plane updates (for example - expanded)
  78716. * This can execute N times every frame
  78717. */
  78718. onPlaneUpdatedObservable: Observable<IWebXRPlane>;
  78719. /**
  78720. * construct a new Plane Detector
  78721. * @param _xrSessionManager an instance of xr Session manager
  78722. * @param _options configuration to use when constructing this feature
  78723. */
  78724. constructor(_xrSessionManager: WebXRSessionManager, _options?: IWebXRPlaneDetectorOptions);
  78725. /**
  78726. * detach this feature.
  78727. * Will usually be called by the features manager
  78728. *
  78729. * @returns true if successful.
  78730. */
  78731. detach(): boolean;
  78732. /**
  78733. * Dispose this feature and all of the resources attached
  78734. */
  78735. dispose(): void;
  78736. protected _onXRFrame(frame: XRFrame): void;
  78737. private _init;
  78738. private _updatePlaneWithXRPlane;
  78739. /**
  78740. * avoiding using Array.find for global support.
  78741. * @param xrPlane the plane to find in the array
  78742. */
  78743. private findIndexInPlaneArray;
  78744. }
  78745. }
  78746. declare module "babylonjs/XR/features/WebXRBackgroundRemover" {
  78747. import { WebXRSessionManager } from "babylonjs/XR/webXRSessionManager";
  78748. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  78749. import { Observable } from "babylonjs/Misc/observable";
  78750. import { WebXRAbstractFeature } from "babylonjs/XR/features/WebXRAbstractFeature";
  78751. /**
  78752. * Options interface for the background remover plugin
  78753. */
  78754. export interface IWebXRBackgroundRemoverOptions {
  78755. /**
  78756. * Further background meshes to disable when entering AR
  78757. */
  78758. backgroundMeshes?: AbstractMesh[];
  78759. /**
  78760. * flags to configure the removal of the environment helper.
  78761. * If not set, the entire background will be removed. If set, flags should be set as well.
  78762. */
  78763. environmentHelperRemovalFlags?: {
  78764. /**
  78765. * Should the skybox be removed (default false)
  78766. */
  78767. skyBox?: boolean;
  78768. /**
  78769. * Should the ground be removed (default false)
  78770. */
  78771. ground?: boolean;
  78772. };
  78773. /**
  78774. * don't disable the environment helper
  78775. */
  78776. ignoreEnvironmentHelper?: boolean;
  78777. }
  78778. /**
  78779. * A module that will automatically disable background meshes when entering AR and will enable them when leaving AR.
  78780. */
  78781. export class WebXRBackgroundRemover extends WebXRAbstractFeature {
  78782. /**
  78783. * read-only options to be used in this module
  78784. */
  78785. readonly options: IWebXRBackgroundRemoverOptions;
  78786. /**
  78787. * The module's name
  78788. */
  78789. static readonly Name: string;
  78790. /**
  78791. * The (Babylon) version of this module.
  78792. * This is an integer representing the implementation version.
  78793. * This number does not correspond to the WebXR specs version
  78794. */
  78795. static readonly Version: number;
  78796. /**
  78797. * registered observers will be triggered when the background state changes
  78798. */
  78799. onBackgroundStateChangedObservable: Observable<boolean>;
  78800. /**
  78801. * constructs a new background remover module
  78802. * @param _xrSessionManager the session manager for this module
  78803. * @param options read-only options to be used in this module
  78804. */
  78805. constructor(_xrSessionManager: WebXRSessionManager,
  78806. /**
  78807. * read-only options to be used in this module
  78808. */
  78809. options?: IWebXRBackgroundRemoverOptions);
  78810. /**
  78811. * attach this feature
  78812. * Will usually be called by the features manager
  78813. *
  78814. * @returns true if successful.
  78815. */
  78816. attach(): boolean;
  78817. /**
  78818. * detach this feature.
  78819. * Will usually be called by the features manager
  78820. *
  78821. * @returns true if successful.
  78822. */
  78823. detach(): boolean;
  78824. /**
  78825. * Dispose this feature and all of the resources attached
  78826. */
  78827. dispose(): void;
  78828. protected _onXRFrame(_xrFrame: XRFrame): void;
  78829. private _setBackgroundState;
  78830. }
  78831. }
  78832. declare module "babylonjs/XR/features/WebXRControllerPhysics" {
  78833. import { WebXRAbstractFeature } from "babylonjs/XR/features/WebXRAbstractFeature";
  78834. import { WebXRInputSource } from "babylonjs/XR/webXRInputSource";
  78835. import { PhysicsImpostor } from "babylonjs/Physics/physicsImpostor";
  78836. import { WebXRInput } from "babylonjs/XR/webXRInput";
  78837. import { WebXRSessionManager } from "babylonjs/XR/webXRSessionManager";
  78838. import { Nullable } from "babylonjs/types";
  78839. /**
  78840. * Options for the controller physics feature
  78841. */
  78842. export class IWebXRControllerPhysicsOptions {
  78843. /**
  78844. * Should the headset get its own impostor
  78845. */
  78846. enableHeadsetImpostor?: boolean;
  78847. /**
  78848. * Optional parameters for the headset impostor
  78849. */
  78850. headsetImpostorParams?: {
  78851. /**
  78852. * The type of impostor to create. Default is sphere
  78853. */
  78854. impostorType: number;
  78855. /**
  78856. * the size of the impostor. Defaults to 10cm
  78857. */
  78858. impostorSize?: number | {
  78859. width: number;
  78860. height: number;
  78861. depth: number;
  78862. };
  78863. /**
  78864. * Friction definitions
  78865. */
  78866. friction?: number;
  78867. /**
  78868. * Restitution
  78869. */
  78870. restitution?: number;
  78871. };
  78872. /**
  78873. * The physics properties of the future impostors
  78874. */
  78875. physicsProperties?: {
  78876. /**
  78877. * If set to true, a mesh impostor will be created when the controller mesh was loaded
  78878. * Note that this requires a physics engine that supports mesh impostors!
  78879. */
  78880. useControllerMesh?: boolean;
  78881. /**
  78882. * The type of impostor to create. Default is sphere
  78883. */
  78884. impostorType?: number;
  78885. /**
  78886. * the size of the impostor. Defaults to 10cm
  78887. */
  78888. impostorSize?: number | {
  78889. width: number;
  78890. height: number;
  78891. depth: number;
  78892. };
  78893. /**
  78894. * Friction definitions
  78895. */
  78896. friction?: number;
  78897. /**
  78898. * Restitution
  78899. */
  78900. restitution?: number;
  78901. };
  78902. /**
  78903. * the xr input to use with this pointer selection
  78904. */
  78905. xrInput: WebXRInput;
  78906. }
  78907. /**
  78908. * Add physics impostor to your webxr controllers,
  78909. * including naive calculation of their linear and angular velocity
  78910. */
  78911. export class WebXRControllerPhysics extends WebXRAbstractFeature {
  78912. private readonly _options;
  78913. private _attachController;
  78914. private _controllers;
  78915. private _debugMode;
  78916. private _delta;
  78917. private _headsetImpostor?;
  78918. private _headsetMesh?;
  78919. private _lastTimestamp;
  78920. private _tmpQuaternion;
  78921. private _tmpVector;
  78922. /**
  78923. * The module's name
  78924. */
  78925. static readonly Name: string;
  78926. /**
  78927. * The (Babylon) version of this module.
  78928. * This is an integer representing the implementation version.
  78929. * This number does not correspond to the webxr specs version
  78930. */
  78931. static readonly Version: number;
  78932. /**
  78933. * Construct a new Controller Physics Feature
  78934. * @param _xrSessionManager the corresponding xr session manager
  78935. * @param _options options to create this feature with
  78936. */
  78937. constructor(_xrSessionManager: WebXRSessionManager, _options: IWebXRControllerPhysicsOptions);
  78938. /**
  78939. * @hidden
  78940. * enable debugging - will show console outputs and the impostor mesh
  78941. */
  78942. _enablePhysicsDebug(): void;
  78943. /**
  78944. * Manually add a controller (if no xrInput was provided or physics engine was not enabled)
  78945. * @param xrController the controller to add
  78946. */
  78947. addController(xrController: WebXRInputSource): void;
  78948. /**
  78949. * attach this feature
  78950. * Will usually be called by the features manager
  78951. *
  78952. * @returns true if successful.
  78953. */
  78954. attach(): boolean;
  78955. /**
  78956. * detach this feature.
  78957. * Will usually be called by the features manager
  78958. *
  78959. * @returns true if successful.
  78960. */
  78961. detach(): boolean;
  78962. /**
  78963. * Get the headset impostor, if enabled
  78964. * @returns the impostor
  78965. */
  78966. getHeadsetImpostor(): PhysicsImpostor | undefined;
  78967. /**
  78968. * Get the physics impostor of a specific controller.
  78969. * The impostor is not attached to a mesh because a mesh for each controller is not obligatory
  78970. * @param controller the controller or the controller id of which to get the impostor
  78971. * @returns the impostor or null
  78972. */
  78973. getImpostorForController(controller: WebXRInputSource | string): Nullable<PhysicsImpostor>;
  78974. /**
  78975. * Update the physics properties provided in the constructor
  78976. * @param newProperties the new properties object
  78977. */
  78978. setPhysicsProperties(newProperties: {
  78979. impostorType?: number;
  78980. impostorSize?: number | {
  78981. width: number;
  78982. height: number;
  78983. depth: number;
  78984. };
  78985. friction?: number;
  78986. restitution?: number;
  78987. }): void;
  78988. protected _onXRFrame(_xrFrame: any): void;
  78989. private _detachController;
  78990. }
  78991. }
  78992. declare module "babylonjs/XR/features/WebXRFeaturePointSystem" {
  78993. import { WebXRSessionManager } from "babylonjs/XR/webXRSessionManager";
  78994. import { Observable } from "babylonjs/Misc/observable";
  78995. import { Vector3 } from "babylonjs/Maths/math.vector";
  78996. import { WebXRAbstractFeature } from "babylonjs/XR/features/WebXRAbstractFeature";
  78997. /**
  78998. * A babylon interface for a "WebXR" feature point.
  78999. * Represents the position and confidence value of a given feature point.
  79000. */
  79001. export interface IWebXRFeaturePoint {
  79002. /**
  79003. * Represents the position of the feature point in world space.
  79004. */
  79005. position: Vector3;
  79006. /**
  79007. * Represents the confidence value of the feature point in world space. 0 being least confident, and 1 being most confident.
  79008. */
  79009. confidenceValue: number;
  79010. }
  79011. /**
  79012. * The feature point system is used to detect feature points from real world geometry.
  79013. * This feature is currently experimental and only supported on BabylonNative, and should not be used in the browser.
  79014. * The newly introduced API can be seen in webxr.nativeextensions.d.ts and described in FeaturePoints.md.
  79015. */
  79016. export class WebXRFeaturePointSystem extends WebXRAbstractFeature {
  79017. private _enabled;
  79018. private _featurePointCloud;
  79019. /**
  79020. * The module's name
  79021. */
  79022. static readonly Name: string;
  79023. /**
  79024. * The (Babylon) version of this module.
  79025. * This is an integer representing the implementation version.
  79026. * This number does not correspond to the WebXR specs version
  79027. */
  79028. static readonly Version: number;
  79029. /**
  79030. * Observers registered here will be executed whenever new feature points are added (on XRFrame while the session is tracking).
  79031. * Will notify the observers about which feature points have been added.
  79032. */
  79033. readonly onFeaturePointsAddedObservable: Observable<number[]>;
  79034. /**
  79035. * Observers registered here will be executed whenever a feature point has been updated (on XRFrame while the session is tracking).
  79036. * Will notify the observers about which feature points have been updated.
  79037. */
  79038. readonly onFeaturePointsUpdatedObservable: Observable<number[]>;
  79039. /**
  79040. * The current feature point cloud maintained across frames.
  79041. */
  79042. get featurePointCloud(): Array<IWebXRFeaturePoint>;
  79043. /**
  79044. * construct the feature point system
  79045. * @param _xrSessionManager an instance of xr Session manager
  79046. */
  79047. constructor(_xrSessionManager: WebXRSessionManager);
  79048. /**
  79049. * Detach this feature.
  79050. * Will usually be called by the features manager
  79051. *
  79052. * @returns true if successful.
  79053. */
  79054. detach(): boolean;
  79055. /**
  79056. * Dispose this feature and all of the resources attached
  79057. */
  79058. dispose(): void;
  79059. /**
  79060. * On receiving a new XR frame if this feature is attached notify observers new feature point data is available.
  79061. */
  79062. protected _onXRFrame(frame: XRFrame): void;
  79063. /**
  79064. * Initializes the feature. If the feature point feature is not available for this environment do not mark the feature as enabled.
  79065. */
  79066. private _init;
  79067. }
  79068. }
  79069. declare module "babylonjs/XR/features/WebXRHandTracking" {
  79070. import { WebXRAbstractFeature } from "babylonjs/XR/features/WebXRAbstractFeature";
  79071. import { WebXRSessionManager } from "babylonjs/XR/webXRSessionManager";
  79072. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  79073. import { Mesh } from "babylonjs/Meshes/mesh";
  79074. import { WebXRInput } from "babylonjs/XR/webXRInput";
  79075. import { WebXRInputSource } from "babylonjs/XR/webXRInputSource";
  79076. import { Nullable } from "babylonjs/types";
  79077. import { IDisposable } from "babylonjs/scene";
  79078. import { Observable } from "babylonjs/Misc/observable";
  79079. /**
  79080. * Configuration interface for the hand tracking feature
  79081. */
  79082. export interface IWebXRHandTrackingOptions {
  79083. /**
  79084. * The xrInput that will be used as source for new hands
  79085. */
  79086. xrInput: WebXRInput;
  79087. /**
  79088. * Configuration object for the joint meshes
  79089. */
  79090. jointMeshes?: {
  79091. /**
  79092. * Should the meshes created be invisible (defaults to false)
  79093. */
  79094. invisible?: boolean;
  79095. /**
  79096. * A source mesh to be used to create instances. Defaults to a sphere.
  79097. * This mesh will be the source for all other (25) meshes.
  79098. * It should have the general size of a single unit, as the instances will be scaled according to the provided radius
  79099. */
  79100. sourceMesh?: Mesh;
  79101. /**
  79102. * Should the source mesh stay visible. Defaults to false
  79103. */
  79104. keepOriginalVisible?: boolean;
  79105. /**
  79106. * Scale factor for all instances (defaults to 2)
  79107. */
  79108. scaleFactor?: number;
  79109. /**
  79110. * Should each instance have its own physics impostor
  79111. */
  79112. enablePhysics?: boolean;
  79113. /**
  79114. * If enabled, override default physics properties
  79115. */
  79116. physicsProps?: {
  79117. friction?: number;
  79118. restitution?: number;
  79119. impostorType?: number;
  79120. };
  79121. /**
  79122. * For future use - a single hand-mesh that will be updated according to the XRHand data provided
  79123. */
  79124. handMesh?: AbstractMesh;
  79125. };
  79126. }
  79127. /**
  79128. * Parts of the hands divided to writs and finger names
  79129. */
  79130. export const enum HandPart {
  79131. /**
  79132. * HandPart - Wrist
  79133. */
  79134. WRIST = "wrist",
  79135. /**
  79136. * HandPart - The THumb
  79137. */
  79138. THUMB = "thumb",
  79139. /**
  79140. * HandPart - Index finger
  79141. */
  79142. INDEX = "index",
  79143. /**
  79144. * HandPart - Middle finger
  79145. */
  79146. MIDDLE = "middle",
  79147. /**
  79148. * HandPart - Ring finger
  79149. */
  79150. RING = "ring",
  79151. /**
  79152. * HandPart - Little finger
  79153. */
  79154. LITTLE = "little"
  79155. }
  79156. /**
  79157. * Representing a single hand (with its corresponding native XRHand object)
  79158. */
  79159. export class WebXRHand implements IDisposable {
  79160. /** the controller to which the hand correlates */
  79161. readonly xrController: WebXRInputSource;
  79162. /** the meshes to be used to track the hand joints */
  79163. readonly trackedMeshes: AbstractMesh[];
  79164. /**
  79165. * Hand-parts definition (key is HandPart)
  79166. */
  79167. static HandPartsDefinition: {
  79168. [key: string]: number[];
  79169. };
  79170. /**
  79171. * Populate the HandPartsDefinition object.
  79172. * This is called as a side effect since certain browsers don't have XRHand defined.
  79173. */
  79174. static _PopulateHandPartsDefinition(): void;
  79175. /**
  79176. * Construct a new hand object
  79177. * @param xrController the controller to which the hand correlates
  79178. * @param trackedMeshes the meshes to be used to track the hand joints
  79179. */
  79180. constructor(
  79181. /** the controller to which the hand correlates */
  79182. xrController: WebXRInputSource,
  79183. /** the meshes to be used to track the hand joints */
  79184. trackedMeshes: AbstractMesh[]);
  79185. /**
  79186. * Update this hand from the latest xr frame
  79187. * @param xrFrame xrFrame to update from
  79188. * @param referenceSpace The current viewer reference space
  79189. * @param scaleFactor optional scale factor for the meshes
  79190. */
  79191. updateFromXRFrame(xrFrame: XRFrame, referenceSpace: XRReferenceSpace, scaleFactor?: number): void;
  79192. /**
  79193. * Get meshes of part of the hand
  79194. * @param part the part of hand to get
  79195. * @returns An array of meshes that correlate to the hand part requested
  79196. */
  79197. getHandPartMeshes(part: HandPart): AbstractMesh[];
  79198. /**
  79199. * Dispose this Hand object
  79200. */
  79201. dispose(): void;
  79202. }
  79203. /**
  79204. * WebXR Hand Joint tracking feature, available for selected browsers and devices
  79205. */
  79206. export class WebXRHandTracking extends WebXRAbstractFeature {
  79207. /**
  79208. * options to use when constructing this feature
  79209. */
  79210. readonly options: IWebXRHandTrackingOptions;
  79211. private static _idCounter;
  79212. /**
  79213. * The module's name
  79214. */
  79215. static readonly Name: string;
  79216. /**
  79217. * The (Babylon) version of this module.
  79218. * This is an integer representing the implementation version.
  79219. * This number does not correspond to the WebXR specs version
  79220. */
  79221. static readonly Version: number;
  79222. /**
  79223. * This observable will notify registered observers when a new hand object was added and initialized
  79224. */
  79225. onHandAddedObservable: Observable<WebXRHand>;
  79226. /**
  79227. * This observable will notify its observers right before the hand object is disposed
  79228. */
  79229. onHandRemovedObservable: Observable<WebXRHand>;
  79230. private _hands;
  79231. /**
  79232. * Creates a new instance of the hit test feature
  79233. * @param _xrSessionManager an instance of WebXRSessionManager
  79234. * @param options options to use when constructing this feature
  79235. */
  79236. constructor(_xrSessionManager: WebXRSessionManager,
  79237. /**
  79238. * options to use when constructing this feature
  79239. */
  79240. options: IWebXRHandTrackingOptions);
  79241. /**
  79242. * Check if the needed objects are defined.
  79243. * This does not mean that the feature is enabled, but that the objects needed are well defined.
  79244. */
  79245. isCompatible(): boolean;
  79246. /**
  79247. * attach this feature
  79248. * Will usually be called by the features manager
  79249. *
  79250. * @returns true if successful.
  79251. */
  79252. attach(): boolean;
  79253. /**
  79254. * detach this feature.
  79255. * Will usually be called by the features manager
  79256. *
  79257. * @returns true if successful.
  79258. */
  79259. detach(): boolean;
  79260. /**
  79261. * Dispose this feature and all of the resources attached
  79262. */
  79263. dispose(): void;
  79264. /**
  79265. * Get the hand object according to the controller id
  79266. * @param controllerId the controller id to which we want to get the hand
  79267. * @returns null if not found or the WebXRHand object if found
  79268. */
  79269. getHandByControllerId(controllerId: string): Nullable<WebXRHand>;
  79270. /**
  79271. * Get a hand object according to the requested handedness
  79272. * @param handedness the handedness to request
  79273. * @returns null if not found or the WebXRHand object if found
  79274. */
  79275. getHandByHandedness(handedness: XRHandedness): Nullable<WebXRHand>;
  79276. protected _onXRFrame(_xrFrame: XRFrame): void;
  79277. private _attachHand;
  79278. private _detachHand;
  79279. }
  79280. }
  79281. declare module "babylonjs/XR/features/index" {
  79282. export * from "babylonjs/XR/features/WebXRHitTestLegacy";
  79283. export * from "babylonjs/XR/features/WebXRAnchorSystem";
  79284. export * from "babylonjs/XR/features/WebXRPlaneDetector";
  79285. export * from "babylonjs/XR/features/WebXRBackgroundRemover";
  79286. export * from "babylonjs/XR/features/WebXRControllerTeleportation";
  79287. export * from "babylonjs/XR/features/WebXRControllerPointerSelection";
  79288. export * from "babylonjs/XR/features/WebXRControllerPhysics";
  79289. export * from "babylonjs/XR/features/WebXRHitTest";
  79290. export * from "babylonjs/XR/features/WebXRFeaturePointSystem";
  79291. export * from "babylonjs/XR/features/WebXRHandTracking";
  79292. }
  79293. declare module "babylonjs/XR/motionController/webXRMicrosoftMixedRealityController" {
  79294. import { WebXRAbstractMotionController, IMinimalMotionControllerObject, MotionControllerHandedness } from "babylonjs/XR/motionController/webXRAbstractMotionController";
  79295. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  79296. import { Scene } from "babylonjs/scene";
  79297. /**
  79298. * The motion controller class for all microsoft mixed reality controllers
  79299. */
  79300. export class WebXRMicrosoftMixedRealityController extends WebXRAbstractMotionController {
  79301. protected readonly _mapping: {
  79302. defaultButton: {
  79303. valueNodeName: string;
  79304. unpressedNodeName: string;
  79305. pressedNodeName: string;
  79306. };
  79307. defaultAxis: {
  79308. valueNodeName: string;
  79309. minNodeName: string;
  79310. maxNodeName: string;
  79311. };
  79312. buttons: {
  79313. "xr-standard-trigger": {
  79314. rootNodeName: string;
  79315. componentProperty: string;
  79316. states: string[];
  79317. };
  79318. "xr-standard-squeeze": {
  79319. rootNodeName: string;
  79320. componentProperty: string;
  79321. states: string[];
  79322. };
  79323. "xr-standard-touchpad": {
  79324. rootNodeName: string;
  79325. labelAnchorNodeName: string;
  79326. touchPointNodeName: string;
  79327. };
  79328. "xr-standard-thumbstick": {
  79329. rootNodeName: string;
  79330. componentProperty: string;
  79331. states: string[];
  79332. };
  79333. };
  79334. axes: {
  79335. "xr-standard-touchpad": {
  79336. "x-axis": {
  79337. rootNodeName: string;
  79338. };
  79339. "y-axis": {
  79340. rootNodeName: string;
  79341. };
  79342. };
  79343. "xr-standard-thumbstick": {
  79344. "x-axis": {
  79345. rootNodeName: string;
  79346. };
  79347. "y-axis": {
  79348. rootNodeName: string;
  79349. };
  79350. };
  79351. };
  79352. };
  79353. /**
  79354. * The base url used to load the left and right controller models
  79355. */
  79356. static MODEL_BASE_URL: string;
  79357. /**
  79358. * The name of the left controller model file
  79359. */
  79360. static MODEL_LEFT_FILENAME: string;
  79361. /**
  79362. * The name of the right controller model file
  79363. */
  79364. static MODEL_RIGHT_FILENAME: string;
  79365. profileId: string;
  79366. constructor(scene: Scene, gamepadObject: IMinimalMotionControllerObject, handedness: MotionControllerHandedness);
  79367. protected _getFilenameAndPath(): {
  79368. filename: string;
  79369. path: string;
  79370. };
  79371. protected _getModelLoadingConstraints(): boolean;
  79372. protected _processLoadedModel(_meshes: AbstractMesh[]): void;
  79373. protected _setRootMesh(meshes: AbstractMesh[]): void;
  79374. protected _updateModel(): void;
  79375. }
  79376. }
  79377. declare module "babylonjs/XR/motionController/webXROculusTouchMotionController" {
  79378. import { WebXRAbstractMotionController, IMinimalMotionControllerObject, MotionControllerHandedness } from "babylonjs/XR/motionController/webXRAbstractMotionController";
  79379. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  79380. import { Scene } from "babylonjs/scene";
  79381. /**
  79382. * The motion controller class for oculus touch (quest, rift).
  79383. * This class supports legacy mapping as well the standard xr mapping
  79384. */
  79385. export class WebXROculusTouchMotionController extends WebXRAbstractMotionController {
  79386. private _forceLegacyControllers;
  79387. private _modelRootNode;
  79388. /**
  79389. * The base url used to load the left and right controller models
  79390. */
  79391. static MODEL_BASE_URL: string;
  79392. /**
  79393. * The name of the left controller model file
  79394. */
  79395. static MODEL_LEFT_FILENAME: string;
  79396. /**
  79397. * The name of the right controller model file
  79398. */
  79399. static MODEL_RIGHT_FILENAME: string;
  79400. /**
  79401. * Base Url for the Quest controller model.
  79402. */
  79403. static QUEST_MODEL_BASE_URL: string;
  79404. profileId: string;
  79405. constructor(scene: Scene, gamepadObject: IMinimalMotionControllerObject, handedness: MotionControllerHandedness, legacyMapping?: boolean, _forceLegacyControllers?: boolean);
  79406. protected _getFilenameAndPath(): {
  79407. filename: string;
  79408. path: string;
  79409. };
  79410. protected _getModelLoadingConstraints(): boolean;
  79411. protected _processLoadedModel(_meshes: AbstractMesh[]): void;
  79412. protected _setRootMesh(meshes: AbstractMesh[]): void;
  79413. protected _updateModel(): void;
  79414. /**
  79415. * Is this the new type of oculus touch. At the moment both have the same profile and it is impossible to differentiate
  79416. * between the touch and touch 2.
  79417. */
  79418. private _isQuest;
  79419. }
  79420. }
  79421. declare module "babylonjs/XR/motionController/webXRHTCViveMotionController" {
  79422. import { IMinimalMotionControllerObject, MotionControllerHandedness, WebXRAbstractMotionController } from "babylonjs/XR/motionController/webXRAbstractMotionController";
  79423. import { Scene } from "babylonjs/scene";
  79424. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  79425. /**
  79426. * The motion controller class for the standard HTC-Vive controllers
  79427. */
  79428. export class WebXRHTCViveMotionController extends WebXRAbstractMotionController {
  79429. private _modelRootNode;
  79430. /**
  79431. * The base url used to load the left and right controller models
  79432. */
  79433. static MODEL_BASE_URL: string;
  79434. /**
  79435. * File name for the controller model.
  79436. */
  79437. static MODEL_FILENAME: string;
  79438. profileId: string;
  79439. /**
  79440. * Create a new Vive motion controller object
  79441. * @param scene the scene to use to create this controller
  79442. * @param gamepadObject the corresponding gamepad object
  79443. * @param handedness the handedness of the controller
  79444. */
  79445. constructor(scene: Scene, gamepadObject: IMinimalMotionControllerObject, handedness: MotionControllerHandedness);
  79446. protected _getFilenameAndPath(): {
  79447. filename: string;
  79448. path: string;
  79449. };
  79450. protected _getModelLoadingConstraints(): boolean;
  79451. protected _processLoadedModel(_meshes: AbstractMesh[]): void;
  79452. protected _setRootMesh(meshes: AbstractMesh[]): void;
  79453. protected _updateModel(): void;
  79454. }
  79455. }
  79456. declare module "babylonjs/XR/motionController/index" {
  79457. export * from "babylonjs/XR/motionController/webXRAbstractMotionController";
  79458. export * from "babylonjs/XR/motionController/webXRControllerComponent";
  79459. export * from "babylonjs/XR/motionController/webXRGenericMotionController";
  79460. export * from "babylonjs/XR/motionController/webXRMicrosoftMixedRealityController";
  79461. export * from "babylonjs/XR/motionController/webXRMotionControllerManager";
  79462. export * from "babylonjs/XR/motionController/webXROculusTouchMotionController";
  79463. export * from "babylonjs/XR/motionController/webXRHTCViveMotionController";
  79464. export * from "babylonjs/XR/motionController/webXRProfiledMotionController";
  79465. }
  79466. declare module "babylonjs/XR/index" {
  79467. export * from "babylonjs/XR/webXRCamera";
  79468. export * from "babylonjs/XR/webXREnterExitUI";
  79469. export * from "babylonjs/XR/webXRExperienceHelper";
  79470. export * from "babylonjs/XR/webXRInput";
  79471. export * from "babylonjs/XR/webXRInputSource";
  79472. export * from "babylonjs/XR/webXRManagedOutputCanvas";
  79473. export * from "babylonjs/XR/webXRTypes";
  79474. export * from "babylonjs/XR/webXRSessionManager";
  79475. export * from "babylonjs/XR/webXRDefaultExperience";
  79476. export * from "babylonjs/XR/webXRFeaturesManager";
  79477. export * from "babylonjs/XR/features/index";
  79478. export * from "babylonjs/XR/motionController/index";
  79479. }
  79480. declare module "babylonjs/index" {
  79481. export * from "babylonjs/abstractScene";
  79482. export * from "babylonjs/Actions/index";
  79483. export * from "babylonjs/Animations/index";
  79484. export * from "babylonjs/assetContainer";
  79485. export * from "babylonjs/Audio/index";
  79486. export * from "babylonjs/Behaviors/index";
  79487. export * from "babylonjs/Bones/index";
  79488. export * from "babylonjs/Cameras/index";
  79489. export * from "babylonjs/Collisions/index";
  79490. export * from "babylonjs/Culling/index";
  79491. export * from "babylonjs/Debug/index";
  79492. export * from "babylonjs/DeviceInput/index";
  79493. export * from "babylonjs/Engines/index";
  79494. export * from "babylonjs/Events/index";
  79495. export * from "babylonjs/Gamepads/index";
  79496. export * from "babylonjs/Gizmos/index";
  79497. export * from "babylonjs/Helpers/index";
  79498. export * from "babylonjs/Instrumentation/index";
  79499. export * from "babylonjs/Layers/index";
  79500. export * from "babylonjs/LensFlares/index";
  79501. export * from "babylonjs/Lights/index";
  79502. export * from "babylonjs/Loading/index";
  79503. export * from "babylonjs/Materials/index";
  79504. export * from "babylonjs/Maths/index";
  79505. export * from "babylonjs/Meshes/index";
  79506. export * from "babylonjs/Morph/index";
  79507. export * from "babylonjs/Navigation/index";
  79508. export * from "babylonjs/node";
  79509. export * from "babylonjs/Offline/index";
  79510. export * from "babylonjs/Particles/index";
  79511. export * from "babylonjs/Physics/index";
  79512. export * from "babylonjs/PostProcesses/index";
  79513. export * from "babylonjs/Probes/index";
  79514. export * from "babylonjs/Rendering/index";
  79515. export * from "babylonjs/scene";
  79516. export * from "babylonjs/sceneComponent";
  79517. export * from "babylonjs/Sprites/index";
  79518. export * from "babylonjs/States/index";
  79519. export * from "babylonjs/Misc/index";
  79520. export * from "babylonjs/XR/index";
  79521. export * from "babylonjs/types";
  79522. }
  79523. declare module "babylonjs/Animations/pathCursor" {
  79524. import { Vector3 } from "babylonjs/Maths/math.vector";
  79525. import { Path2 } from "babylonjs/Maths/math.path";
  79526. /**
  79527. * A cursor which tracks a point on a path
  79528. */
  79529. export class PathCursor {
  79530. private path;
  79531. /**
  79532. * Stores path cursor callbacks for when an onchange event is triggered
  79533. */
  79534. private _onchange;
  79535. /**
  79536. * The value of the path cursor
  79537. */
  79538. value: number;
  79539. /**
  79540. * The animation array of the path cursor
  79541. */
  79542. animations: Animation[];
  79543. /**
  79544. * Initializes the path cursor
  79545. * @param path The path to track
  79546. */
  79547. constructor(path: Path2);
  79548. /**
  79549. * Gets the cursor point on the path
  79550. * @returns A point on the path cursor at the cursor location
  79551. */
  79552. getPoint(): Vector3;
  79553. /**
  79554. * Moves the cursor ahead by the step amount
  79555. * @param step The amount to move the cursor forward
  79556. * @returns This path cursor
  79557. */
  79558. moveAhead(step?: number): PathCursor;
  79559. /**
  79560. * Moves the cursor behind by the step amount
  79561. * @param step The amount to move the cursor back
  79562. * @returns This path cursor
  79563. */
  79564. moveBack(step?: number): PathCursor;
  79565. /**
  79566. * Moves the cursor by the step amount
  79567. * If the step amount is greater than one, an exception is thrown
  79568. * @param step The amount to move the cursor
  79569. * @returns This path cursor
  79570. */
  79571. move(step: number): PathCursor;
  79572. /**
  79573. * Ensures that the value is limited between zero and one
  79574. * @returns This path cursor
  79575. */
  79576. private ensureLimits;
  79577. /**
  79578. * Runs onchange callbacks on change (used by the animation engine)
  79579. * @returns This path cursor
  79580. */
  79581. private raiseOnChange;
  79582. /**
  79583. * Executes a function on change
  79584. * @param f A path cursor onchange callback
  79585. * @returns This path cursor
  79586. */
  79587. onchange(f: (cursor: PathCursor) => void): PathCursor;
  79588. }
  79589. }
  79590. declare module "babylonjs/Engines/Processors/Expressions/Operators/index" {
  79591. export * from "babylonjs/Engines/Processors/Expressions/Operators/shaderDefineAndOperator";
  79592. export * from "babylonjs/Engines/Processors/Expressions/Operators/shaderDefineArithmeticOperator";
  79593. export * from "babylonjs/Engines/Processors/Expressions/Operators/shaderDefineIsDefinedOperator";
  79594. export * from "babylonjs/Engines/Processors/Expressions/Operators/shaderDefineOrOperator";
  79595. }
  79596. declare module "babylonjs/Engines/Processors/Expressions/index" {
  79597. export * from "babylonjs/Engines/Processors/Expressions/shaderDefineExpression";
  79598. export * from "babylonjs/Engines/Processors/Expressions/Operators/index";
  79599. }
  79600. declare module "babylonjs/Engines/Processors/index" {
  79601. export * from "babylonjs/Engines/Processors/iShaderProcessor";
  79602. export * from "babylonjs/Engines/Processors/Expressions/index";
  79603. export * from "babylonjs/Engines/Processors/shaderCodeConditionNode";
  79604. export * from "babylonjs/Engines/Processors/shaderCodeCursor";
  79605. export * from "babylonjs/Engines/Processors/shaderCodeNode";
  79606. export * from "babylonjs/Engines/Processors/shaderCodeTestNode";
  79607. export * from "babylonjs/Engines/Processors/shaderProcessingOptions";
  79608. export * from "babylonjs/Engines/Processors/shaderProcessor";
  79609. export * from "babylonjs/Engines/Processors/shaderCodeInliner";
  79610. }
  79611. declare module "babylonjs/Legacy/legacy" {
  79612. import * as Babylon from "babylonjs/index";
  79613. export * from "babylonjs/index";
  79614. }
  79615. declare module "babylonjs/Shaders/blur.fragment" {
  79616. /** @hidden */
  79617. export var blurPixelShader: {
  79618. name: string;
  79619. shader: string;
  79620. };
  79621. }
  79622. declare module "babylonjs/Shaders/ShadersInclude/pointCloudVertexDeclaration" {
  79623. /** @hidden */
  79624. export var pointCloudVertexDeclaration: {
  79625. name: string;
  79626. shader: string;
  79627. };
  79628. }
  79629. declare module "babylonjs" {
  79630. export * from "babylonjs/Legacy/legacy";
  79631. }
  79632. declare module BABYLON {
  79633. /** Alias type for value that can be null */
  79634. export type Nullable<T> = T | null;
  79635. /**
  79636. * Alias type for number that are floats
  79637. * @ignorenaming
  79638. */
  79639. export type float = number;
  79640. /**
  79641. * Alias type for number that are doubles.
  79642. * @ignorenaming
  79643. */
  79644. export type double = number;
  79645. /**
  79646. * Alias type for number that are integer
  79647. * @ignorenaming
  79648. */
  79649. export type int = number;
  79650. /** Alias type for number array or Float32Array */
  79651. export type FloatArray = number[] | Float32Array;
  79652. /** Alias type for number array or Float32Array or Int32Array or Uint32Array or Uint16Array */
  79653. export type IndicesArray = number[] | Int32Array | Uint32Array | Uint16Array;
  79654. /**
  79655. * Alias for types that can be used by a Buffer or VertexBuffer.
  79656. */
  79657. export type DataArray = number[] | ArrayBuffer | ArrayBufferView;
  79658. /**
  79659. * Alias type for primitive types
  79660. * @ignorenaming
  79661. */
  79662. type Primitive = undefined | null | boolean | string | number | Function;
  79663. /**
  79664. * Type modifier to make all the properties of an object Readonly
  79665. */
  79666. export type Immutable<T> = T extends Primitive ? T : T extends Array<infer U> ? ReadonlyArray<U> : DeepImmutable<T>;
  79667. /**
  79668. * Type modifier to make all the properties of an object Readonly recursively
  79669. */
  79670. export type DeepImmutable<T> = T extends Primitive ? T : T extends Array<infer U> ? DeepImmutableArray<U> : DeepImmutableObject<T>;
  79671. /**
  79672. * Type modifier to make object properties readonly.
  79673. */
  79674. export type DeepImmutableObject<T> = {
  79675. readonly [K in keyof T]: DeepImmutable<T[K]>;
  79676. };
  79677. /** @hidden */
  79678. interface DeepImmutableArray<T> extends ReadonlyArray<DeepImmutable<T>> {
  79679. }
  79680. }
  79681. declare module BABYLON {
  79682. /**
  79683. * A class serves as a medium between the observable and its observers
  79684. */
  79685. export class EventState {
  79686. /**
  79687. * Create a new EventState
  79688. * @param mask defines the mask associated with this state
  79689. * @param skipNextObservers defines a flag which will instruct the observable to skip following observers when set to true
  79690. * @param target defines the original target of the state
  79691. * @param currentTarget defines the current target of the state
  79692. */
  79693. constructor(mask: number, skipNextObservers?: boolean, target?: any, currentTarget?: any);
  79694. /**
  79695. * Initialize the current event state
  79696. * @param mask defines the mask associated with this state
  79697. * @param skipNextObservers defines a flag which will instruct the observable to skip following observers when set to true
  79698. * @param target defines the original target of the state
  79699. * @param currentTarget defines the current target of the state
  79700. * @returns the current event state
  79701. */
  79702. initalize(mask: number, skipNextObservers?: boolean, target?: any, currentTarget?: any): EventState;
  79703. /**
  79704. * An Observer can set this property to true to prevent subsequent observers of being notified
  79705. */
  79706. skipNextObservers: boolean;
  79707. /**
  79708. * Get the mask value that were used to trigger the event corresponding to this EventState object
  79709. */
  79710. mask: number;
  79711. /**
  79712. * The object that originally notified the event
  79713. */
  79714. target?: any;
  79715. /**
  79716. * The current object in the bubbling phase
  79717. */
  79718. currentTarget?: any;
  79719. /**
  79720. * This will be populated with the return value of the last function that was executed.
  79721. * If it is the first function in the callback chain it will be the event data.
  79722. */
  79723. lastReturnValue?: any;
  79724. }
  79725. /**
  79726. * Represent an Observer registered to a given Observable object.
  79727. */
  79728. export class Observer<T> {
  79729. /**
  79730. * Defines the callback to call when the observer is notified
  79731. */
  79732. callback: (eventData: T, eventState: EventState) => void;
  79733. /**
  79734. * Defines the mask of the observer (used to filter notifications)
  79735. */
  79736. mask: number;
  79737. /**
  79738. * Defines the current scope used to restore the JS context
  79739. */
  79740. scope: any;
  79741. /** @hidden */
  79742. _willBeUnregistered: boolean;
  79743. /**
  79744. * Gets or sets a property defining that the observer as to be unregistered after the next notification
  79745. */
  79746. unregisterOnNextCall: boolean;
  79747. /**
  79748. * Creates a new observer
  79749. * @param callback defines the callback to call when the observer is notified
  79750. * @param mask defines the mask of the observer (used to filter notifications)
  79751. * @param scope defines the current scope used to restore the JS context
  79752. */
  79753. constructor(
  79754. /**
  79755. * Defines the callback to call when the observer is notified
  79756. */
  79757. callback: (eventData: T, eventState: EventState) => void,
  79758. /**
  79759. * Defines the mask of the observer (used to filter notifications)
  79760. */
  79761. mask: number,
  79762. /**
  79763. * Defines the current scope used to restore the JS context
  79764. */
  79765. scope?: any);
  79766. }
  79767. /**
  79768. * Represent a list of observers registered to multiple Observables object.
  79769. */
  79770. export class MultiObserver<T> {
  79771. private _observers;
  79772. private _observables;
  79773. /**
  79774. * Release associated resources
  79775. */
  79776. dispose(): void;
  79777. /**
  79778. * Raise a callback when one of the observable will notify
  79779. * @param observables defines a list of observables to watch
  79780. * @param callback defines the callback to call on notification
  79781. * @param mask defines the mask used to filter notifications
  79782. * @param scope defines the current scope used to restore the JS context
  79783. * @returns the new MultiObserver
  79784. */
  79785. static Watch<T>(observables: Observable<T>[], callback: (eventData: T, eventState: EventState) => void, mask?: number, scope?: any): MultiObserver<T>;
  79786. }
  79787. /**
  79788. * The Observable class is a simple implementation of the Observable pattern.
  79789. *
  79790. * 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.
  79791. * This enable a more fine grained execution without having to rely on multiple different Observable objects.
  79792. * 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).
  79793. * 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.
  79794. */
  79795. export class Observable<T> {
  79796. private _observers;
  79797. private _eventState;
  79798. private _onObserverAdded;
  79799. /**
  79800. * Gets the list of observers
  79801. */
  79802. get observers(): Array<Observer<T>>;
  79803. /**
  79804. * Creates a new observable
  79805. * @param onObserverAdded defines a callback to call when a new observer is added
  79806. */
  79807. constructor(onObserverAdded?: (observer: Observer<T>) => void);
  79808. /**
  79809. * Create a new Observer with the specified callback
  79810. * @param callback the callback that will be executed for that Observer
  79811. * @param mask the mask used to filter observers
  79812. * @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.
  79813. * @param scope optional scope for the callback to be called from
  79814. * @param unregisterOnFirstCall defines if the observer as to be unregistered after the next notification
  79815. * @returns the new observer created for the callback
  79816. */
  79817. add(callback: (eventData: T, eventState: EventState) => void, mask?: number, insertFirst?: boolean, scope?: any, unregisterOnFirstCall?: boolean): Nullable<Observer<T>>;
  79818. /**
  79819. * Create a new Observer with the specified callback and unregisters after the next notification
  79820. * @param callback the callback that will be executed for that Observer
  79821. * @returns the new observer created for the callback
  79822. */
  79823. addOnce(callback: (eventData: T, eventState: EventState) => void): Nullable<Observer<T>>;
  79824. /**
  79825. * Remove an Observer from the Observable object
  79826. * @param observer the instance of the Observer to remove
  79827. * @returns false if it doesn't belong to this Observable
  79828. */
  79829. remove(observer: Nullable<Observer<T>>): boolean;
  79830. /**
  79831. * Remove a callback from the Observable object
  79832. * @param callback the callback to remove
  79833. * @param scope optional scope. If used only the callbacks with this scope will be removed
  79834. * @returns false if it doesn't belong to this Observable
  79835. */
  79836. removeCallback(callback: (eventData: T, eventState: EventState) => void, scope?: any): boolean;
  79837. private _deferUnregister;
  79838. private _remove;
  79839. /**
  79840. * Moves the observable to the top of the observer list making it get called first when notified
  79841. * @param observer the observer to move
  79842. */
  79843. makeObserverTopPriority(observer: Observer<T>): void;
  79844. /**
  79845. * Moves the observable to the bottom of the observer list making it get called last when notified
  79846. * @param observer the observer to move
  79847. */
  79848. makeObserverBottomPriority(observer: Observer<T>): void;
  79849. /**
  79850. * Notify all Observers by calling their respective callback with the given data
  79851. * Will return true if all observers were executed, false if an observer set skipNextObservers to true, then prevent the subsequent ones to execute
  79852. * @param eventData defines the data to send to all observers
  79853. * @param mask defines the mask of the current notification (observers with incompatible mask (ie mask & observer.mask === 0) will not be notified)
  79854. * @param target defines the original target of the state
  79855. * @param currentTarget defines the current target of the state
  79856. * @returns false if the complete observer chain was not processed (because one observer set the skipNextObservers to true)
  79857. */
  79858. notifyObservers(eventData: T, mask?: number, target?: any, currentTarget?: any): boolean;
  79859. /**
  79860. * Calling this will execute each callback, expecting it to be a promise or return a value.
  79861. * If at any point in the chain one function fails, the promise will fail and the execution will not continue.
  79862. * This is useful when a chain of events (sometimes async events) is needed to initialize a certain object
  79863. * and it is crucial that all callbacks will be executed.
  79864. * The order of the callbacks is kept, callbacks are not executed parallel.
  79865. *
  79866. * @param eventData The data to be sent to each callback
  79867. * @param mask is used to filter observers defaults to -1
  79868. * @param target defines the callback target (see EventState)
  79869. * @param currentTarget defines he current object in the bubbling phase
  79870. * @returns {Promise<T>} will return a Promise than resolves when all callbacks executed successfully.
  79871. */
  79872. notifyObserversWithPromise(eventData: T, mask?: number, target?: any, currentTarget?: any): Promise<T>;
  79873. /**
  79874. * Notify a specific observer
  79875. * @param observer defines the observer to notify
  79876. * @param eventData defines the data to be sent to each callback
  79877. * @param mask is used to filter observers defaults to -1
  79878. */
  79879. notifyObserver(observer: Observer<T>, eventData: T, mask?: number): void;
  79880. /**
  79881. * Gets a boolean indicating if the observable has at least one observer
  79882. * @returns true is the Observable has at least one Observer registered
  79883. */
  79884. hasObservers(): boolean;
  79885. /**
  79886. * Clear the list of observers
  79887. */
  79888. clear(): void;
  79889. /**
  79890. * Clone the current observable
  79891. * @returns a new observable
  79892. */
  79893. clone(): Observable<T>;
  79894. /**
  79895. * Does this observable handles observer registered with a given mask
  79896. * @param mask defines the mask to be tested
  79897. * @return whether or not one observer registered with the given mask is handeled
  79898. **/
  79899. hasSpecificMask(mask?: number): boolean;
  79900. }
  79901. }
  79902. declare module BABYLON {
  79903. /**
  79904. * Sets of helpers dealing with the DOM and some of the recurrent functions needed in
  79905. * Babylon.js
  79906. */
  79907. export class DomManagement {
  79908. /**
  79909. * Checks if the window object exists
  79910. * @returns true if the window object exists
  79911. */
  79912. static IsWindowObjectExist(): boolean;
  79913. /**
  79914. * Checks if the navigator object exists
  79915. * @returns true if the navigator object exists
  79916. */
  79917. static IsNavigatorAvailable(): boolean;
  79918. /**
  79919. * Check if the document object exists
  79920. * @returns true if the document object exists
  79921. */
  79922. static IsDocumentAvailable(): boolean;
  79923. /**
  79924. * Extracts text content from a DOM element hierarchy
  79925. * @param element defines the root element
  79926. * @returns a string
  79927. */
  79928. static GetDOMTextContent(element: HTMLElement): string;
  79929. }
  79930. }
  79931. declare module BABYLON {
  79932. /**
  79933. * Logger used througouht the application to allow configuration of
  79934. * the log level required for the messages.
  79935. */
  79936. export class Logger {
  79937. /**
  79938. * No log
  79939. */
  79940. static readonly NoneLogLevel: number;
  79941. /**
  79942. * Only message logs
  79943. */
  79944. static readonly MessageLogLevel: number;
  79945. /**
  79946. * Only warning logs
  79947. */
  79948. static readonly WarningLogLevel: number;
  79949. /**
  79950. * Only error logs
  79951. */
  79952. static readonly ErrorLogLevel: number;
  79953. /**
  79954. * All logs
  79955. */
  79956. static readonly AllLogLevel: number;
  79957. private static _LogCache;
  79958. /**
  79959. * Gets a value indicating the number of loading errors
  79960. * @ignorenaming
  79961. */
  79962. static errorsCount: number;
  79963. /**
  79964. * Callback called when a new log is added
  79965. */
  79966. static OnNewCacheEntry: (entry: string) => void;
  79967. private static _AddLogEntry;
  79968. private static _FormatMessage;
  79969. private static _LogDisabled;
  79970. private static _LogEnabled;
  79971. private static _WarnDisabled;
  79972. private static _WarnEnabled;
  79973. private static _ErrorDisabled;
  79974. private static _ErrorEnabled;
  79975. /**
  79976. * Log a message to the console
  79977. */
  79978. static Log: (message: string) => void;
  79979. /**
  79980. * Write a warning message to the console
  79981. */
  79982. static Warn: (message: string) => void;
  79983. /**
  79984. * Write an error message to the console
  79985. */
  79986. static Error: (message: string) => void;
  79987. /**
  79988. * Gets current log cache (list of logs)
  79989. */
  79990. static get LogCache(): string;
  79991. /**
  79992. * Clears the log cache
  79993. */
  79994. static ClearLogCache(): void;
  79995. /**
  79996. * Sets the current log level (MessageLogLevel / WarningLogLevel / ErrorLogLevel)
  79997. */
  79998. static set LogLevels(level: number);
  79999. }
  80000. }
  80001. declare module BABYLON {
  80002. /** @hidden */
  80003. export class _TypeStore {
  80004. /** @hidden */
  80005. static RegisteredTypes: {
  80006. [key: string]: Object;
  80007. };
  80008. /** @hidden */
  80009. static GetClass(fqdn: string): any;
  80010. }
  80011. }
  80012. declare module BABYLON {
  80013. /**
  80014. * Helper to manipulate strings
  80015. */
  80016. export class StringTools {
  80017. /**
  80018. * Checks for a matching suffix at the end of a string (for ES5 and lower)
  80019. * @param str Source string
  80020. * @param suffix Suffix to search for in the source string
  80021. * @returns Boolean indicating whether the suffix was found (true) or not (false)
  80022. */
  80023. static EndsWith(str: string, suffix: string): boolean;
  80024. /**
  80025. * Checks for a matching suffix at the beginning of a string (for ES5 and lower)
  80026. * @param str Source string
  80027. * @param suffix Suffix to search for in the source string
  80028. * @returns Boolean indicating whether the suffix was found (true) or not (false)
  80029. */
  80030. static StartsWith(str: string, suffix: string): boolean;
  80031. /**
  80032. * Decodes a buffer into a string
  80033. * @param buffer The buffer to decode
  80034. * @returns The decoded string
  80035. */
  80036. static Decode(buffer: Uint8Array | Uint16Array): string;
  80037. /**
  80038. * Encode a buffer to a base64 string
  80039. * @param buffer defines the buffer to encode
  80040. * @returns the encoded string
  80041. */
  80042. static EncodeArrayBufferToBase64(buffer: ArrayBuffer | ArrayBufferView): string;
  80043. /**
  80044. * Converts a number to string and pads with preceeding zeroes until it is of specified length.
  80045. * @param num the number to convert and pad
  80046. * @param length the expected length of the string
  80047. * @returns the padded string
  80048. */
  80049. static PadNumber(num: number, length: number): string;
  80050. }
  80051. }
  80052. declare module BABYLON {
  80053. /**
  80054. * Class containing a set of static utilities functions for deep copy.
  80055. */
  80056. export class DeepCopier {
  80057. /**
  80058. * Tries to copy an object by duplicating every property
  80059. * @param source defines the source object
  80060. * @param destination defines the target object
  80061. * @param doNotCopyList defines a list of properties to avoid
  80062. * @param mustCopyList defines a list of properties to copy (even if they start with _)
  80063. */
  80064. static DeepCopy(source: any, destination: any, doNotCopyList?: string[], mustCopyList?: string[]): void;
  80065. }
  80066. }
  80067. declare module BABYLON {
  80068. /**
  80069. * Class containing a set of static utilities functions for precision date
  80070. */
  80071. export class PrecisionDate {
  80072. /**
  80073. * Gets either window.performance.now() if supported or Date.now() else
  80074. */
  80075. static get Now(): number;
  80076. }
  80077. }
  80078. declare module BABYLON {
  80079. /** @hidden */
  80080. export class _DevTools {
  80081. static WarnImport(name: string): string;
  80082. }
  80083. }
  80084. declare module BABYLON {
  80085. /**
  80086. * Interface used to define the mechanism to get data from the network
  80087. */
  80088. export interface IWebRequest {
  80089. /**
  80090. * Returns client's response url
  80091. */
  80092. responseURL: string;
  80093. /**
  80094. * Returns client's status
  80095. */
  80096. status: number;
  80097. /**
  80098. * Returns client's status as a text
  80099. */
  80100. statusText: string;
  80101. }
  80102. }
  80103. declare module BABYLON {
  80104. /**
  80105. * Extended version of XMLHttpRequest with support for customizations (headers, ...)
  80106. */
  80107. export class WebRequest implements IWebRequest {
  80108. private _xhr;
  80109. /**
  80110. * Custom HTTP Request Headers to be sent with XMLHttpRequests
  80111. * i.e. when loading files, where the server/service expects an Authorization header
  80112. */
  80113. static CustomRequestHeaders: {
  80114. [key: string]: string;
  80115. };
  80116. /**
  80117. * Add callback functions in this array to update all the requests before they get sent to the network
  80118. */
  80119. static CustomRequestModifiers: ((request: XMLHttpRequest, url: string) => void)[];
  80120. private _injectCustomRequestHeaders;
  80121. /**
  80122. * Gets or sets a function to be called when loading progress changes
  80123. */
  80124. get onprogress(): ((this: XMLHttpRequest, ev: ProgressEvent) => any) | null;
  80125. set onprogress(value: ((this: XMLHttpRequest, ev: ProgressEvent) => any) | null);
  80126. /**
  80127. * Returns client's state
  80128. */
  80129. get readyState(): number;
  80130. /**
  80131. * Returns client's status
  80132. */
  80133. get status(): number;
  80134. /**
  80135. * Returns client's status as a text
  80136. */
  80137. get statusText(): string;
  80138. /**
  80139. * Returns client's response
  80140. */
  80141. get response(): any;
  80142. /**
  80143. * Returns client's response url
  80144. */
  80145. get responseURL(): string;
  80146. /**
  80147. * Returns client's response as text
  80148. */
  80149. get responseText(): string;
  80150. /**
  80151. * Gets or sets the expected response type
  80152. */
  80153. get responseType(): XMLHttpRequestResponseType;
  80154. set responseType(value: XMLHttpRequestResponseType);
  80155. /** @hidden */
  80156. addEventListener<K extends keyof XMLHttpRequestEventMap>(type: K, listener: (this: XMLHttpRequest, ev: XMLHttpRequestEventMap[K]) => any, options?: boolean | AddEventListenerOptions): void;
  80157. /** @hidden */
  80158. removeEventListener<K extends keyof XMLHttpRequestEventMap>(type: K, listener: (this: XMLHttpRequest, ev: XMLHttpRequestEventMap[K]) => any, options?: boolean | EventListenerOptions): void;
  80159. /**
  80160. * Cancels any network activity
  80161. */
  80162. abort(): void;
  80163. /**
  80164. * Initiates the request. The optional argument provides the request body. The argument is ignored if request method is GET or HEAD
  80165. * @param body defines an optional request body
  80166. */
  80167. send(body?: Document | BodyInit | null): void;
  80168. /**
  80169. * Sets the request method, request URL
  80170. * @param method defines the method to use (GET, POST, etc..)
  80171. * @param url defines the url to connect with
  80172. */
  80173. open(method: string, url: string): void;
  80174. /**
  80175. * Sets the value of a request header.
  80176. * @param name The name of the header whose value is to be set
  80177. * @param value The value to set as the body of the header
  80178. */
  80179. setRequestHeader(name: string, value: string): void;
  80180. /**
  80181. * Get the string containing the text of a particular header's value.
  80182. * @param name The name of the header
  80183. * @returns The string containing the text of the given header name
  80184. */
  80185. getResponseHeader(name: string): Nullable<string>;
  80186. }
  80187. }
  80188. declare module BABYLON {
  80189. /**
  80190. * File request interface
  80191. */
  80192. export interface IFileRequest {
  80193. /**
  80194. * Raised when the request is complete (success or error).
  80195. */
  80196. onCompleteObservable: Observable<IFileRequest>;
  80197. /**
  80198. * Aborts the request for a file.
  80199. */
  80200. abort: () => void;
  80201. }
  80202. }
  80203. declare module BABYLON {
  80204. /**
  80205. * Define options used to create a render target texture
  80206. */
  80207. export class RenderTargetCreationOptions {
  80208. /**
  80209. * Specifies is mipmaps must be generated
  80210. */
  80211. generateMipMaps?: boolean;
  80212. /** Specifies whether or not a depth should be allocated in the texture (true by default) */
  80213. generateDepthBuffer?: boolean;
  80214. /** Specifies whether or not a stencil should be allocated in the texture (false by default)*/
  80215. generateStencilBuffer?: boolean;
  80216. /** Defines texture type (int by default) */
  80217. type?: number;
  80218. /** Defines sampling mode (trilinear by default) */
  80219. samplingMode?: number;
  80220. /** Defines format (RGBA by default) */
  80221. format?: number;
  80222. }
  80223. }
  80224. declare module BABYLON {
  80225. /** Defines the cross module used constants to avoid circular dependncies */
  80226. export class Constants {
  80227. /** Defines that alpha blending is disabled */
  80228. static readonly ALPHA_DISABLE: number;
  80229. /** Defines that alpha blending is SRC ALPHA * SRC + DEST */
  80230. static readonly ALPHA_ADD: number;
  80231. /** Defines that alpha blending is SRC ALPHA * SRC + (1 - SRC ALPHA) * DEST */
  80232. static readonly ALPHA_COMBINE: number;
  80233. /** Defines that alpha blending is DEST - SRC * DEST */
  80234. static readonly ALPHA_SUBTRACT: number;
  80235. /** Defines that alpha blending is SRC * DEST */
  80236. static readonly ALPHA_MULTIPLY: number;
  80237. /** Defines that alpha blending is SRC ALPHA * SRC + (1 - SRC) * DEST */
  80238. static readonly ALPHA_MAXIMIZED: number;
  80239. /** Defines that alpha blending is SRC + DEST */
  80240. static readonly ALPHA_ONEONE: number;
  80241. /** Defines that alpha blending is SRC + (1 - SRC ALPHA) * DEST */
  80242. static readonly ALPHA_PREMULTIPLIED: number;
  80243. /**
  80244. * Defines that alpha blending is SRC + (1 - SRC ALPHA) * DEST
  80245. * Alpha will be set to (1 - SRC ALPHA) * DEST ALPHA
  80246. */
  80247. static readonly ALPHA_PREMULTIPLIED_PORTERDUFF: number;
  80248. /** Defines that alpha blending is CST * SRC + (1 - CST) * DEST */
  80249. static readonly ALPHA_INTERPOLATE: number;
  80250. /**
  80251. * Defines that alpha blending is SRC + (1 - SRC) * DEST
  80252. * Alpha will be set to SRC ALPHA + (1 - SRC ALPHA) * DEST ALPHA
  80253. */
  80254. static readonly ALPHA_SCREENMODE: number;
  80255. /**
  80256. * Defines that alpha blending is SRC + DST
  80257. * Alpha will be set to SRC ALPHA + DST ALPHA
  80258. */
  80259. static readonly ALPHA_ONEONE_ONEONE: number;
  80260. /**
  80261. * Defines that alpha blending is SRC * DST ALPHA + DST
  80262. * Alpha will be set to 0
  80263. */
  80264. static readonly ALPHA_ALPHATOCOLOR: number;
  80265. /**
  80266. * Defines that alpha blending is SRC * (1 - DST) + DST * (1 - SRC)
  80267. */
  80268. static readonly ALPHA_REVERSEONEMINUS: number;
  80269. /**
  80270. * Defines that alpha blending is SRC + DST * (1 - SRC ALPHA)
  80271. * Alpha will be set to SRC ALPHA + DST ALPHA * (1 - SRC ALPHA)
  80272. */
  80273. static readonly ALPHA_SRC_DSTONEMINUSSRCALPHA: number;
  80274. /**
  80275. * Defines that alpha blending is SRC + DST
  80276. * Alpha will be set to SRC ALPHA
  80277. */
  80278. static readonly ALPHA_ONEONE_ONEZERO: number;
  80279. /**
  80280. * Defines that alpha blending is SRC * (1 - DST) + DST * (1 - SRC)
  80281. * Alpha will be set to DST ALPHA
  80282. */
  80283. static readonly ALPHA_EXCLUSION: number;
  80284. /** Defines that alpha blending equation a SUM */
  80285. static readonly ALPHA_EQUATION_ADD: number;
  80286. /** Defines that alpha blending equation a SUBSTRACTION */
  80287. static readonly ALPHA_EQUATION_SUBSTRACT: number;
  80288. /** Defines that alpha blending equation a REVERSE SUBSTRACTION */
  80289. static readonly ALPHA_EQUATION_REVERSE_SUBTRACT: number;
  80290. /** Defines that alpha blending equation a MAX operation */
  80291. static readonly ALPHA_EQUATION_MAX: number;
  80292. /** Defines that alpha blending equation a MIN operation */
  80293. static readonly ALPHA_EQUATION_MIN: number;
  80294. /**
  80295. * Defines that alpha blending equation a DARKEN operation:
  80296. * It takes the min of the src and sums the alpha channels.
  80297. */
  80298. static readonly ALPHA_EQUATION_DARKEN: number;
  80299. /** Defines that the ressource is not delayed*/
  80300. static readonly DELAYLOADSTATE_NONE: number;
  80301. /** Defines that the ressource was successfully delay loaded */
  80302. static readonly DELAYLOADSTATE_LOADED: number;
  80303. /** Defines that the ressource is currently delay loading */
  80304. static readonly DELAYLOADSTATE_LOADING: number;
  80305. /** Defines that the ressource is delayed and has not started loading */
  80306. static readonly DELAYLOADSTATE_NOTLOADED: number;
  80307. /** Passed to depthFunction or stencilFunction to specify depth or stencil tests will never pass. i.e. Nothing will be drawn */
  80308. static readonly NEVER: number;
  80309. /** 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 */
  80310. static readonly ALWAYS: number;
  80311. /** Passed to depthFunction or stencilFunction to specify depth or stencil tests will pass if the new depth value is less than the stored value */
  80312. static readonly LESS: number;
  80313. /** Passed to depthFunction or stencilFunction to specify depth or stencil tests will pass if the new depth value is equals to the stored value */
  80314. static readonly EQUAL: number;
  80315. /** 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 */
  80316. static readonly LEQUAL: number;
  80317. /** Passed to depthFunction or stencilFunction to specify depth or stencil tests will pass if the new depth value is greater than the stored value */
  80318. static readonly GREATER: number;
  80319. /** 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 */
  80320. static readonly GEQUAL: number;
  80321. /** 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 */
  80322. static readonly NOTEQUAL: number;
  80323. /** Passed to stencilOperation to specify that stencil value must be kept */
  80324. static readonly KEEP: number;
  80325. /** Passed to stencilOperation to specify that stencil value must be replaced */
  80326. static readonly REPLACE: number;
  80327. /** Passed to stencilOperation to specify that stencil value must be incremented */
  80328. static readonly INCR: number;
  80329. /** Passed to stencilOperation to specify that stencil value must be decremented */
  80330. static readonly DECR: number;
  80331. /** Passed to stencilOperation to specify that stencil value must be inverted */
  80332. static readonly INVERT: number;
  80333. /** Passed to stencilOperation to specify that stencil value must be incremented with wrapping */
  80334. static readonly INCR_WRAP: number;
  80335. /** Passed to stencilOperation to specify that stencil value must be decremented with wrapping */
  80336. static readonly DECR_WRAP: number;
  80337. /** Texture is not repeating outside of 0..1 UVs */
  80338. static readonly TEXTURE_CLAMP_ADDRESSMODE: number;
  80339. /** Texture is repeating outside of 0..1 UVs */
  80340. static readonly TEXTURE_WRAP_ADDRESSMODE: number;
  80341. /** Texture is repeating and mirrored */
  80342. static readonly TEXTURE_MIRROR_ADDRESSMODE: number;
  80343. /** ALPHA */
  80344. static readonly TEXTUREFORMAT_ALPHA: number;
  80345. /** LUMINANCE */
  80346. static readonly TEXTUREFORMAT_LUMINANCE: number;
  80347. /** LUMINANCE_ALPHA */
  80348. static readonly TEXTUREFORMAT_LUMINANCE_ALPHA: number;
  80349. /** RGB */
  80350. static readonly TEXTUREFORMAT_RGB: number;
  80351. /** RGBA */
  80352. static readonly TEXTUREFORMAT_RGBA: number;
  80353. /** RED */
  80354. static readonly TEXTUREFORMAT_RED: number;
  80355. /** RED (2nd reference) */
  80356. static readonly TEXTUREFORMAT_R: number;
  80357. /** RG */
  80358. static readonly TEXTUREFORMAT_RG: number;
  80359. /** RED_INTEGER */
  80360. static readonly TEXTUREFORMAT_RED_INTEGER: number;
  80361. /** RED_INTEGER (2nd reference) */
  80362. static readonly TEXTUREFORMAT_R_INTEGER: number;
  80363. /** RG_INTEGER */
  80364. static readonly TEXTUREFORMAT_RG_INTEGER: number;
  80365. /** RGB_INTEGER */
  80366. static readonly TEXTUREFORMAT_RGB_INTEGER: number;
  80367. /** RGBA_INTEGER */
  80368. static readonly TEXTUREFORMAT_RGBA_INTEGER: number;
  80369. /** UNSIGNED_BYTE */
  80370. static readonly TEXTURETYPE_UNSIGNED_BYTE: number;
  80371. /** UNSIGNED_BYTE (2nd reference) */
  80372. static readonly TEXTURETYPE_UNSIGNED_INT: number;
  80373. /** FLOAT */
  80374. static readonly TEXTURETYPE_FLOAT: number;
  80375. /** HALF_FLOAT */
  80376. static readonly TEXTURETYPE_HALF_FLOAT: number;
  80377. /** BYTE */
  80378. static readonly TEXTURETYPE_BYTE: number;
  80379. /** SHORT */
  80380. static readonly TEXTURETYPE_SHORT: number;
  80381. /** UNSIGNED_SHORT */
  80382. static readonly TEXTURETYPE_UNSIGNED_SHORT: number;
  80383. /** INT */
  80384. static readonly TEXTURETYPE_INT: number;
  80385. /** UNSIGNED_INT */
  80386. static readonly TEXTURETYPE_UNSIGNED_INTEGER: number;
  80387. /** UNSIGNED_SHORT_4_4_4_4 */
  80388. static readonly TEXTURETYPE_UNSIGNED_SHORT_4_4_4_4: number;
  80389. /** UNSIGNED_SHORT_5_5_5_1 */
  80390. static readonly TEXTURETYPE_UNSIGNED_SHORT_5_5_5_1: number;
  80391. /** UNSIGNED_SHORT_5_6_5 */
  80392. static readonly TEXTURETYPE_UNSIGNED_SHORT_5_6_5: number;
  80393. /** UNSIGNED_INT_2_10_10_10_REV */
  80394. static readonly TEXTURETYPE_UNSIGNED_INT_2_10_10_10_REV: number;
  80395. /** UNSIGNED_INT_24_8 */
  80396. static readonly TEXTURETYPE_UNSIGNED_INT_24_8: number;
  80397. /** UNSIGNED_INT_10F_11F_11F_REV */
  80398. static readonly TEXTURETYPE_UNSIGNED_INT_10F_11F_11F_REV: number;
  80399. /** UNSIGNED_INT_5_9_9_9_REV */
  80400. static readonly TEXTURETYPE_UNSIGNED_INT_5_9_9_9_REV: number;
  80401. /** FLOAT_32_UNSIGNED_INT_24_8_REV */
  80402. static readonly TEXTURETYPE_FLOAT_32_UNSIGNED_INT_24_8_REV: number;
  80403. /** nearest is mag = nearest and min = nearest and no mip */
  80404. static readonly TEXTURE_NEAREST_SAMPLINGMODE: number;
  80405. /** mag = nearest and min = nearest and mip = none */
  80406. static readonly TEXTURE_NEAREST_NEAREST: number;
  80407. /** Bilinear is mag = linear and min = linear and no mip */
  80408. static readonly TEXTURE_BILINEAR_SAMPLINGMODE: number;
  80409. /** mag = linear and min = linear and mip = none */
  80410. static readonly TEXTURE_LINEAR_LINEAR: number;
  80411. /** Trilinear is mag = linear and min = linear and mip = linear */
  80412. static readonly TEXTURE_TRILINEAR_SAMPLINGMODE: number;
  80413. /** Trilinear is mag = linear and min = linear and mip = linear */
  80414. static readonly TEXTURE_LINEAR_LINEAR_MIPLINEAR: number;
  80415. /** mag = nearest and min = nearest and mip = nearest */
  80416. static readonly TEXTURE_NEAREST_NEAREST_MIPNEAREST: number;
  80417. /** mag = nearest and min = linear and mip = nearest */
  80418. static readonly TEXTURE_NEAREST_LINEAR_MIPNEAREST: number;
  80419. /** mag = nearest and min = linear and mip = linear */
  80420. static readonly TEXTURE_NEAREST_LINEAR_MIPLINEAR: number;
  80421. /** mag = nearest and min = linear and mip = none */
  80422. static readonly TEXTURE_NEAREST_LINEAR: number;
  80423. /** nearest is mag = nearest and min = nearest and mip = linear */
  80424. static readonly TEXTURE_NEAREST_NEAREST_MIPLINEAR: number;
  80425. /** mag = linear and min = nearest and mip = nearest */
  80426. static readonly TEXTURE_LINEAR_NEAREST_MIPNEAREST: number;
  80427. /** mag = linear and min = nearest and mip = linear */
  80428. static readonly TEXTURE_LINEAR_NEAREST_MIPLINEAR: number;
  80429. /** Bilinear is mag = linear and min = linear and mip = nearest */
  80430. static readonly TEXTURE_LINEAR_LINEAR_MIPNEAREST: number;
  80431. /** mag = linear and min = nearest and mip = none */
  80432. static readonly TEXTURE_LINEAR_NEAREST: number;
  80433. /** Explicit coordinates mode */
  80434. static readonly TEXTURE_EXPLICIT_MODE: number;
  80435. /** Spherical coordinates mode */
  80436. static readonly TEXTURE_SPHERICAL_MODE: number;
  80437. /** Planar coordinates mode */
  80438. static readonly TEXTURE_PLANAR_MODE: number;
  80439. /** Cubic coordinates mode */
  80440. static readonly TEXTURE_CUBIC_MODE: number;
  80441. /** Projection coordinates mode */
  80442. static readonly TEXTURE_PROJECTION_MODE: number;
  80443. /** Skybox coordinates mode */
  80444. static readonly TEXTURE_SKYBOX_MODE: number;
  80445. /** Inverse Cubic coordinates mode */
  80446. static readonly TEXTURE_INVCUBIC_MODE: number;
  80447. /** Equirectangular coordinates mode */
  80448. static readonly TEXTURE_EQUIRECTANGULAR_MODE: number;
  80449. /** Equirectangular Fixed coordinates mode */
  80450. static readonly TEXTURE_FIXED_EQUIRECTANGULAR_MODE: number;
  80451. /** Equirectangular Fixed Mirrored coordinates mode */
  80452. static readonly TEXTURE_FIXED_EQUIRECTANGULAR_MIRRORED_MODE: number;
  80453. /** Offline (baking) quality for texture filtering */
  80454. static readonly TEXTURE_FILTERING_QUALITY_OFFLINE: number;
  80455. /** High quality for texture filtering */
  80456. static readonly TEXTURE_FILTERING_QUALITY_HIGH: number;
  80457. /** Medium quality for texture filtering */
  80458. static readonly TEXTURE_FILTERING_QUALITY_MEDIUM: number;
  80459. /** Low quality for texture filtering */
  80460. static readonly TEXTURE_FILTERING_QUALITY_LOW: number;
  80461. /** Defines that texture rescaling will use a floor to find the closer power of 2 size */
  80462. static readonly SCALEMODE_FLOOR: number;
  80463. /** Defines that texture rescaling will look for the nearest power of 2 size */
  80464. static readonly SCALEMODE_NEAREST: number;
  80465. /** Defines that texture rescaling will use a ceil to find the closer power of 2 size */
  80466. static readonly SCALEMODE_CEILING: number;
  80467. /**
  80468. * The dirty texture flag value
  80469. */
  80470. static readonly MATERIAL_TextureDirtyFlag: number;
  80471. /**
  80472. * The dirty light flag value
  80473. */
  80474. static readonly MATERIAL_LightDirtyFlag: number;
  80475. /**
  80476. * The dirty fresnel flag value
  80477. */
  80478. static readonly MATERIAL_FresnelDirtyFlag: number;
  80479. /**
  80480. * The dirty attribute flag value
  80481. */
  80482. static readonly MATERIAL_AttributesDirtyFlag: number;
  80483. /**
  80484. * The dirty misc flag value
  80485. */
  80486. static readonly MATERIAL_MiscDirtyFlag: number;
  80487. /**
  80488. * The all dirty flag value
  80489. */
  80490. static readonly MATERIAL_AllDirtyFlag: number;
  80491. /**
  80492. * Returns the triangle fill mode
  80493. */
  80494. static readonly MATERIAL_TriangleFillMode: number;
  80495. /**
  80496. * Returns the wireframe mode
  80497. */
  80498. static readonly MATERIAL_WireFrameFillMode: number;
  80499. /**
  80500. * Returns the point fill mode
  80501. */
  80502. static readonly MATERIAL_PointFillMode: number;
  80503. /**
  80504. * Returns the point list draw mode
  80505. */
  80506. static readonly MATERIAL_PointListDrawMode: number;
  80507. /**
  80508. * Returns the line list draw mode
  80509. */
  80510. static readonly MATERIAL_LineListDrawMode: number;
  80511. /**
  80512. * Returns the line loop draw mode
  80513. */
  80514. static readonly MATERIAL_LineLoopDrawMode: number;
  80515. /**
  80516. * Returns the line strip draw mode
  80517. */
  80518. static readonly MATERIAL_LineStripDrawMode: number;
  80519. /**
  80520. * Returns the triangle strip draw mode
  80521. */
  80522. static readonly MATERIAL_TriangleStripDrawMode: number;
  80523. /**
  80524. * Returns the triangle fan draw mode
  80525. */
  80526. static readonly MATERIAL_TriangleFanDrawMode: number;
  80527. /**
  80528. * Stores the clock-wise side orientation
  80529. */
  80530. static readonly MATERIAL_ClockWiseSideOrientation: number;
  80531. /**
  80532. * Stores the counter clock-wise side orientation
  80533. */
  80534. static readonly MATERIAL_CounterClockWiseSideOrientation: number;
  80535. /**
  80536. * Nothing
  80537. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  80538. */
  80539. static readonly ACTION_NothingTrigger: number;
  80540. /**
  80541. * On pick
  80542. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  80543. */
  80544. static readonly ACTION_OnPickTrigger: number;
  80545. /**
  80546. * On left pick
  80547. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  80548. */
  80549. static readonly ACTION_OnLeftPickTrigger: number;
  80550. /**
  80551. * On right pick
  80552. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  80553. */
  80554. static readonly ACTION_OnRightPickTrigger: number;
  80555. /**
  80556. * On center pick
  80557. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  80558. */
  80559. static readonly ACTION_OnCenterPickTrigger: number;
  80560. /**
  80561. * On pick down
  80562. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  80563. */
  80564. static readonly ACTION_OnPickDownTrigger: number;
  80565. /**
  80566. * On double pick
  80567. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  80568. */
  80569. static readonly ACTION_OnDoublePickTrigger: number;
  80570. /**
  80571. * On pick up
  80572. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  80573. */
  80574. static readonly ACTION_OnPickUpTrigger: number;
  80575. /**
  80576. * On pick out.
  80577. * This trigger will only be raised if you also declared a OnPickDown
  80578. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  80579. */
  80580. static readonly ACTION_OnPickOutTrigger: number;
  80581. /**
  80582. * On long press
  80583. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  80584. */
  80585. static readonly ACTION_OnLongPressTrigger: number;
  80586. /**
  80587. * On pointer over
  80588. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  80589. */
  80590. static readonly ACTION_OnPointerOverTrigger: number;
  80591. /**
  80592. * On pointer out
  80593. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  80594. */
  80595. static readonly ACTION_OnPointerOutTrigger: number;
  80596. /**
  80597. * On every frame
  80598. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  80599. */
  80600. static readonly ACTION_OnEveryFrameTrigger: number;
  80601. /**
  80602. * On intersection enter
  80603. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  80604. */
  80605. static readonly ACTION_OnIntersectionEnterTrigger: number;
  80606. /**
  80607. * On intersection exit
  80608. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  80609. */
  80610. static readonly ACTION_OnIntersectionExitTrigger: number;
  80611. /**
  80612. * On key down
  80613. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  80614. */
  80615. static readonly ACTION_OnKeyDownTrigger: number;
  80616. /**
  80617. * On key up
  80618. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  80619. */
  80620. static readonly ACTION_OnKeyUpTrigger: number;
  80621. /**
  80622. * Billboard mode will only apply to Y axis
  80623. */
  80624. static readonly PARTICLES_BILLBOARDMODE_Y: number;
  80625. /**
  80626. * Billboard mode will apply to all axes
  80627. */
  80628. static readonly PARTICLES_BILLBOARDMODE_ALL: number;
  80629. /**
  80630. * Special billboard mode where the particle will be biilboard to the camera but rotated to align with direction
  80631. */
  80632. static readonly PARTICLES_BILLBOARDMODE_STRETCHED: number;
  80633. /** Default culling strategy : this is an exclusion test and it's the more accurate.
  80634. * Test order :
  80635. * Is the bounding sphere outside the frustum ?
  80636. * If not, are the bounding box vertices outside the frustum ?
  80637. * It not, then the cullable object is in the frustum.
  80638. */
  80639. static readonly MESHES_CULLINGSTRATEGY_STANDARD: number;
  80640. /** Culling strategy : Bounding Sphere Only.
  80641. * This is an exclusion test. It's faster than the standard strategy because the bounding box is not tested.
  80642. * It's also less accurate than the standard because some not visible objects can still be selected.
  80643. * Test : is the bounding sphere outside the frustum ?
  80644. * If not, then the cullable object is in the frustum.
  80645. */
  80646. static readonly MESHES_CULLINGSTRATEGY_BOUNDINGSPHERE_ONLY: number;
  80647. /** Culling strategy : Optimistic Inclusion.
  80648. * This in an inclusion test first, then the standard exclusion test.
  80649. * This can be faster when a cullable object is expected to be almost always in the camera frustum.
  80650. * 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.
  80651. * Anyway, it's as accurate as the standard strategy.
  80652. * Test :
  80653. * Is the cullable object bounding sphere center in the frustum ?
  80654. * If not, apply the default culling strategy.
  80655. */
  80656. static readonly MESHES_CULLINGSTRATEGY_OPTIMISTIC_INCLUSION: number;
  80657. /** Culling strategy : Optimistic Inclusion then Bounding Sphere Only.
  80658. * This in an inclusion test first, then the bounding sphere only exclusion test.
  80659. * This can be the fastest test when a cullable object is expected to be almost always in the camera frustum.
  80660. * 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.
  80661. * It's less accurate than the standard strategy and as accurate as the BoundingSphereOnly strategy.
  80662. * Test :
  80663. * Is the cullable object bounding sphere center in the frustum ?
  80664. * If not, apply the Bounding Sphere Only strategy. No Bounding Box is tested here.
  80665. */
  80666. static readonly MESHES_CULLINGSTRATEGY_OPTIMISTIC_INCLUSION_THEN_BSPHERE_ONLY: number;
  80667. /**
  80668. * No logging while loading
  80669. */
  80670. static readonly SCENELOADER_NO_LOGGING: number;
  80671. /**
  80672. * Minimal logging while loading
  80673. */
  80674. static readonly SCENELOADER_MINIMAL_LOGGING: number;
  80675. /**
  80676. * Summary logging while loading
  80677. */
  80678. static readonly SCENELOADER_SUMMARY_LOGGING: number;
  80679. /**
  80680. * Detailled logging while loading
  80681. */
  80682. static readonly SCENELOADER_DETAILED_LOGGING: number;
  80683. /**
  80684. * Prepass texture index for color
  80685. */
  80686. static readonly PREPASS_COLOR_INDEX: number;
  80687. /**
  80688. * Prepass texture index for irradiance
  80689. */
  80690. static readonly PREPASS_IRRADIANCE_INDEX: number;
  80691. /**
  80692. * Prepass texture index for depth + normal
  80693. */
  80694. static readonly PREPASS_DEPTHNORMAL_INDEX: number;
  80695. /**
  80696. * Prepass texture index for albedo
  80697. */
  80698. static readonly PREPASS_ALBEDO_INDEX: number;
  80699. }
  80700. }
  80701. declare module BABYLON {
  80702. /**
  80703. * This represents the required contract to create a new type of texture loader.
  80704. */
  80705. export interface IInternalTextureLoader {
  80706. /**
  80707. * Defines wether the loader supports cascade loading the different faces.
  80708. */
  80709. supportCascades: boolean;
  80710. /**
  80711. * This returns if the loader support the current file information.
  80712. * @param extension defines the file extension of the file being loaded
  80713. * @param mimeType defines the optional mime type of the file being loaded
  80714. * @returns true if the loader can load the specified file
  80715. */
  80716. canLoad(extension: string, mimeType?: string): boolean;
  80717. /**
  80718. * Uploads the cube texture data to the WebGL texture. It has already been bound.
  80719. * @param data contains the texture data
  80720. * @param texture defines the BabylonJS internal texture
  80721. * @param createPolynomials will be true if polynomials have been requested
  80722. * @param onLoad defines the callback to trigger once the texture is ready
  80723. * @param onError defines the callback to trigger in case of error
  80724. */
  80725. loadCubeData(data: ArrayBufferView | ArrayBufferView[], texture: InternalTexture, createPolynomials: boolean, onLoad: Nullable<(data?: any) => void>, onError: Nullable<(message?: string, exception?: any) => void>): void;
  80726. /**
  80727. * Uploads the 2D texture data to the WebGL texture. It has already been bound once in the callback.
  80728. * @param data contains the texture data
  80729. * @param texture defines the BabylonJS internal texture
  80730. * @param callback defines the method to call once ready to upload
  80731. */
  80732. loadData(data: ArrayBufferView, texture: InternalTexture, callback: (width: number, height: number, loadMipmap: boolean, isCompressed: boolean, done: () => void, loadFailed?: boolean) => void): void;
  80733. }
  80734. }
  80735. declare module BABYLON {
  80736. /**
  80737. * Class used to store and describe the pipeline context associated with an effect
  80738. */
  80739. export interface IPipelineContext {
  80740. /**
  80741. * Gets a boolean indicating that this pipeline context is supporting asynchronous creating
  80742. */
  80743. isAsync: boolean;
  80744. /**
  80745. * Gets a boolean indicating that the context is ready to be used (like shaders / pipelines are compiled and ready for instance)
  80746. */
  80747. isReady: boolean;
  80748. /** @hidden */
  80749. _getVertexShaderCode(): string | null;
  80750. /** @hidden */
  80751. _getFragmentShaderCode(): string | null;
  80752. /** @hidden */
  80753. _handlesSpectorRebuildCallback(onCompiled: (compiledObject: any) => void): void;
  80754. }
  80755. }
  80756. declare module BABYLON {
  80757. /**
  80758. * Class used to store gfx data (like WebGLBuffer)
  80759. */
  80760. export class DataBuffer {
  80761. /**
  80762. * Gets or sets the number of objects referencing this buffer
  80763. */
  80764. references: number;
  80765. /** Gets or sets the size of the underlying buffer */
  80766. capacity: number;
  80767. /**
  80768. * Gets or sets a boolean indicating if the buffer contains 32bits indices
  80769. */
  80770. is32Bits: boolean;
  80771. /**
  80772. * Gets the underlying buffer
  80773. */
  80774. get underlyingResource(): any;
  80775. }
  80776. }
  80777. declare module BABYLON {
  80778. /** @hidden */
  80779. export interface IShaderProcessor {
  80780. attributeProcessor?: (attribute: string) => string;
  80781. varyingProcessor?: (varying: string, isFragment: boolean) => string;
  80782. uniformProcessor?: (uniform: string, isFragment: boolean) => string;
  80783. uniformBufferProcessor?: (uniformBuffer: string, isFragment: boolean) => string;
  80784. endOfUniformBufferProcessor?: (closingBracketLine: string, isFragment: boolean) => string;
  80785. lineProcessor?: (line: string, isFragment: boolean) => string;
  80786. preProcessor?: (code: string, defines: string[], isFragment: boolean) => string;
  80787. postProcessor?: (code: string, defines: string[], isFragment: boolean) => string;
  80788. }
  80789. }
  80790. declare module BABYLON {
  80791. /** @hidden */
  80792. export interface ProcessingOptions {
  80793. defines: string[];
  80794. indexParameters: any;
  80795. isFragment: boolean;
  80796. shouldUseHighPrecisionShader: boolean;
  80797. supportsUniformBuffers: boolean;
  80798. shadersRepository: string;
  80799. includesShadersStore: {
  80800. [key: string]: string;
  80801. };
  80802. processor?: IShaderProcessor;
  80803. version: string;
  80804. platformName: string;
  80805. lookForClosingBracketForUniformBuffer?: boolean;
  80806. }
  80807. }
  80808. declare module BABYLON {
  80809. /** @hidden */
  80810. export class ShaderCodeNode {
  80811. line: string;
  80812. children: ShaderCodeNode[];
  80813. additionalDefineKey?: string;
  80814. additionalDefineValue?: string;
  80815. isValid(preprocessors: {
  80816. [key: string]: string;
  80817. }): boolean;
  80818. process(preprocessors: {
  80819. [key: string]: string;
  80820. }, options: ProcessingOptions): string;
  80821. }
  80822. }
  80823. declare module BABYLON {
  80824. /** @hidden */
  80825. export class ShaderCodeCursor {
  80826. private _lines;
  80827. lineIndex: number;
  80828. get currentLine(): string;
  80829. get canRead(): boolean;
  80830. set lines(value: string[]);
  80831. }
  80832. }
  80833. declare module BABYLON {
  80834. /** @hidden */
  80835. export class ShaderCodeConditionNode extends ShaderCodeNode {
  80836. process(preprocessors: {
  80837. [key: string]: string;
  80838. }, options: ProcessingOptions): string;
  80839. }
  80840. }
  80841. declare module BABYLON {
  80842. /** @hidden */
  80843. export class ShaderDefineExpression {
  80844. isTrue(preprocessors: {
  80845. [key: string]: string;
  80846. }): boolean;
  80847. private static _OperatorPriority;
  80848. private static _Stack;
  80849. static postfixToInfix(postfix: string[]): string;
  80850. static infixToPostfix(infix: string): string[];
  80851. }
  80852. }
  80853. declare module BABYLON {
  80854. /** @hidden */
  80855. export class ShaderCodeTestNode extends ShaderCodeNode {
  80856. testExpression: ShaderDefineExpression;
  80857. isValid(preprocessors: {
  80858. [key: string]: string;
  80859. }): boolean;
  80860. }
  80861. }
  80862. declare module BABYLON {
  80863. /** @hidden */
  80864. export class ShaderDefineIsDefinedOperator extends ShaderDefineExpression {
  80865. define: string;
  80866. not: boolean;
  80867. constructor(define: string, not?: boolean);
  80868. isTrue(preprocessors: {
  80869. [key: string]: string;
  80870. }): boolean;
  80871. }
  80872. }
  80873. declare module BABYLON {
  80874. /** @hidden */
  80875. export class ShaderDefineOrOperator extends ShaderDefineExpression {
  80876. leftOperand: ShaderDefineExpression;
  80877. rightOperand: ShaderDefineExpression;
  80878. isTrue(preprocessors: {
  80879. [key: string]: string;
  80880. }): boolean;
  80881. }
  80882. }
  80883. declare module BABYLON {
  80884. /** @hidden */
  80885. export class ShaderDefineAndOperator extends ShaderDefineExpression {
  80886. leftOperand: ShaderDefineExpression;
  80887. rightOperand: ShaderDefineExpression;
  80888. isTrue(preprocessors: {
  80889. [key: string]: string;
  80890. }): boolean;
  80891. }
  80892. }
  80893. declare module BABYLON {
  80894. /** @hidden */
  80895. export class ShaderDefineArithmeticOperator extends ShaderDefineExpression {
  80896. define: string;
  80897. operand: string;
  80898. testValue: string;
  80899. constructor(define: string, operand: string, testValue: string);
  80900. isTrue(preprocessors: {
  80901. [key: string]: string;
  80902. }): boolean;
  80903. }
  80904. }
  80905. declare module BABYLON {
  80906. /**
  80907. * Class used to enable access to offline support
  80908. * @see https://doc.babylonjs.com/how_to/caching_resources_in_indexeddb
  80909. */
  80910. export interface IOfflineProvider {
  80911. /**
  80912. * Gets a boolean indicating if scene must be saved in the database
  80913. */
  80914. enableSceneOffline: boolean;
  80915. /**
  80916. * Gets a boolean indicating if textures must be saved in the database
  80917. */
  80918. enableTexturesOffline: boolean;
  80919. /**
  80920. * Open the offline support and make it available
  80921. * @param successCallback defines the callback to call on success
  80922. * @param errorCallback defines the callback to call on error
  80923. */
  80924. open(successCallback: () => void, errorCallback: () => void): void;
  80925. /**
  80926. * Loads an image from the offline support
  80927. * @param url defines the url to load from
  80928. * @param image defines the target DOM image
  80929. */
  80930. loadImage(url: string, image: HTMLImageElement): void;
  80931. /**
  80932. * Loads a file from offline support
  80933. * @param url defines the URL to load from
  80934. * @param sceneLoaded defines a callback to call on success
  80935. * @param progressCallBack defines a callback to call when progress changed
  80936. * @param errorCallback defines a callback to call on error
  80937. * @param useArrayBuffer defines a boolean to use array buffer instead of text string
  80938. */
  80939. loadFile(url: string, sceneLoaded: (data: any) => void, progressCallBack?: (data: any) => void, errorCallback?: () => void, useArrayBuffer?: boolean): void;
  80940. }
  80941. }
  80942. declare module BABYLON {
  80943. /**
  80944. * Class used to help managing file picking and drag'n'drop
  80945. * File Storage
  80946. */
  80947. export class FilesInputStore {
  80948. /**
  80949. * List of files ready to be loaded
  80950. */
  80951. static FilesToLoad: {
  80952. [key: string]: File;
  80953. };
  80954. }
  80955. }
  80956. declare module BABYLON {
  80957. /**
  80958. * Class used to define a retry strategy when error happens while loading assets
  80959. */
  80960. export class RetryStrategy {
  80961. /**
  80962. * Function used to defines an exponential back off strategy
  80963. * @param maxRetries defines the maximum number of retries (3 by default)
  80964. * @param baseInterval defines the interval between retries
  80965. * @returns the strategy function to use
  80966. */
  80967. static ExponentialBackoff(maxRetries?: number, baseInterval?: number): (url: string, request: WebRequest, retryIndex: number) => number;
  80968. }
  80969. }
  80970. declare module BABYLON {
  80971. /**
  80972. * @ignore
  80973. * Application error to support additional information when loading a file
  80974. */
  80975. export abstract class BaseError extends Error {
  80976. protected static _setPrototypeOf: (o: any, proto: object | null) => any;
  80977. }
  80978. }
  80979. declare module BABYLON {
  80980. /** @ignore */
  80981. export class LoadFileError extends BaseError {
  80982. request?: WebRequest;
  80983. file?: File;
  80984. /**
  80985. * Creates a new LoadFileError
  80986. * @param message defines the message of the error
  80987. * @param request defines the optional web request
  80988. * @param file defines the optional file
  80989. */
  80990. constructor(message: string, object?: WebRequest | File);
  80991. }
  80992. /** @ignore */
  80993. export class RequestFileError extends BaseError {
  80994. request: WebRequest;
  80995. /**
  80996. * Creates a new LoadFileError
  80997. * @param message defines the message of the error
  80998. * @param request defines the optional web request
  80999. */
  81000. constructor(message: string, request: WebRequest);
  81001. }
  81002. /** @ignore */
  81003. export class ReadFileError extends BaseError {
  81004. file: File;
  81005. /**
  81006. * Creates a new ReadFileError
  81007. * @param message defines the message of the error
  81008. * @param file defines the optional file
  81009. */
  81010. constructor(message: string, file: File);
  81011. }
  81012. /**
  81013. * @hidden
  81014. */
  81015. export class FileTools {
  81016. /**
  81017. * Gets or sets the retry strategy to apply when an error happens while loading an asset
  81018. */
  81019. static DefaultRetryStrategy: (url: string, request: WebRequest, retryIndex: number) => number;
  81020. /**
  81021. * Gets or sets the base URL to use to load assets
  81022. */
  81023. static BaseUrl: string;
  81024. /**
  81025. * Default behaviour for cors in the application.
  81026. * It can be a string if the expected behavior is identical in the entire app.
  81027. * Or a callback to be able to set it per url or on a group of them (in case of Video source for instance)
  81028. */
  81029. static CorsBehavior: string | ((url: string | string[]) => string);
  81030. /**
  81031. * Gets or sets a function used to pre-process url before using them to load assets
  81032. */
  81033. static PreprocessUrl: (url: string) => string;
  81034. /**
  81035. * Removes unwanted characters from an url
  81036. * @param url defines the url to clean
  81037. * @returns the cleaned url
  81038. */
  81039. private static _CleanUrl;
  81040. /**
  81041. * Sets the cors behavior on a dom element. This will add the required Tools.CorsBehavior to the element.
  81042. * @param url define the url we are trying
  81043. * @param element define the dom element where to configure the cors policy
  81044. */
  81045. static SetCorsBehavior(url: string | string[], element: {
  81046. crossOrigin: string | null;
  81047. }): void;
  81048. /**
  81049. * Loads an image as an HTMLImageElement.
  81050. * @param input url string, ArrayBuffer, or Blob to load
  81051. * @param onLoad callback called when the image successfully loads
  81052. * @param onError callback called when the image fails to load
  81053. * @param offlineProvider offline provider for caching
  81054. * @param mimeType optional mime type
  81055. * @returns the HTMLImageElement of the loaded image
  81056. */
  81057. 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>;
  81058. /**
  81059. * Reads a file from a File object
  81060. * @param file defines the file to load
  81061. * @param onSuccess defines the callback to call when data is loaded
  81062. * @param onProgress defines the callback to call during loading process
  81063. * @param useArrayBuffer defines a boolean indicating that data must be returned as an ArrayBuffer
  81064. * @param onError defines the callback to call when an error occurs
  81065. * @returns a file request object
  81066. */
  81067. static ReadFile(file: File, onSuccess: (data: any) => void, onProgress?: (ev: ProgressEvent) => any, useArrayBuffer?: boolean, onError?: (error: ReadFileError) => void): IFileRequest;
  81068. /**
  81069. * Loads a file from a url
  81070. * @param url url to load
  81071. * @param onSuccess callback called when the file successfully loads
  81072. * @param onProgress callback called while file is loading (if the server supports this mode)
  81073. * @param offlineProvider defines the offline provider for caching
  81074. * @param useArrayBuffer defines a boolean indicating that date must be returned as ArrayBuffer
  81075. * @param onError callback called when the file fails to load
  81076. * @returns a file request object
  81077. */
  81078. 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;
  81079. /**
  81080. * Loads a file
  81081. * @param url url to load
  81082. * @param onSuccess callback called when the file successfully loads
  81083. * @param onProgress callback called while file is loading (if the server supports this mode)
  81084. * @param useArrayBuffer defines a boolean indicating that date must be returned as ArrayBuffer
  81085. * @param onError callback called when the file fails to load
  81086. * @param onOpened callback called when the web request is opened
  81087. * @returns a file request object
  81088. */
  81089. 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;
  81090. /**
  81091. * Checks if the loaded document was accessed via `file:`-Protocol.
  81092. * @returns boolean
  81093. */
  81094. static IsFileURL(): boolean;
  81095. }
  81096. }
  81097. declare module BABYLON {
  81098. /** @hidden */
  81099. export class ShaderProcessor {
  81100. static Process(sourceCode: string, options: ProcessingOptions, callback: (migratedCode: string) => void): void;
  81101. private static _ProcessPrecision;
  81102. private static _ExtractOperation;
  81103. private static _BuildSubExpression;
  81104. private static _BuildExpression;
  81105. private static _MoveCursorWithinIf;
  81106. private static _MoveCursor;
  81107. private static _EvaluatePreProcessors;
  81108. private static _PreparePreProcessors;
  81109. private static _ProcessShaderConversion;
  81110. private static _ProcessIncludes;
  81111. /**
  81112. * Loads a file from a url
  81113. * @param url url to load
  81114. * @param onSuccess callback called when the file successfully loads
  81115. * @param onProgress callback called while file is loading (if the server supports this mode)
  81116. * @param offlineProvider defines the offline provider for caching
  81117. * @param useArrayBuffer defines a boolean indicating that date must be returned as ArrayBuffer
  81118. * @param onError callback called when the file fails to load
  81119. * @returns a file request object
  81120. * @hidden
  81121. */
  81122. 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;
  81123. }
  81124. }
  81125. declare module BABYLON {
  81126. /**
  81127. * @hidden
  81128. */
  81129. export interface IColor4Like {
  81130. r: float;
  81131. g: float;
  81132. b: float;
  81133. a: float;
  81134. }
  81135. /**
  81136. * @hidden
  81137. */
  81138. export interface IColor3Like {
  81139. r: float;
  81140. g: float;
  81141. b: float;
  81142. }
  81143. /**
  81144. * @hidden
  81145. */
  81146. export interface IVector4Like {
  81147. x: float;
  81148. y: float;
  81149. z: float;
  81150. w: float;
  81151. }
  81152. /**
  81153. * @hidden
  81154. */
  81155. export interface IVector3Like {
  81156. x: float;
  81157. y: float;
  81158. z: float;
  81159. }
  81160. /**
  81161. * @hidden
  81162. */
  81163. export interface IVector2Like {
  81164. x: float;
  81165. y: float;
  81166. }
  81167. /**
  81168. * @hidden
  81169. */
  81170. export interface IMatrixLike {
  81171. toArray(): DeepImmutable<Float32Array | Array<number>>;
  81172. updateFlag: int;
  81173. }
  81174. /**
  81175. * @hidden
  81176. */
  81177. export interface IViewportLike {
  81178. x: float;
  81179. y: float;
  81180. width: float;
  81181. height: float;
  81182. }
  81183. /**
  81184. * @hidden
  81185. */
  81186. export interface IPlaneLike {
  81187. normal: IVector3Like;
  81188. d: float;
  81189. normalize(): void;
  81190. }
  81191. }
  81192. declare module BABYLON {
  81193. /**
  81194. * Interface used to define common properties for effect fallbacks
  81195. */
  81196. export interface IEffectFallbacks {
  81197. /**
  81198. * Removes the defines that should be removed when falling back.
  81199. * @param currentDefines defines the current define statements for the shader.
  81200. * @param effect defines the current effect we try to compile
  81201. * @returns The resulting defines with defines of the current rank removed.
  81202. */
  81203. reduce(currentDefines: string, effect: Effect): string;
  81204. /**
  81205. * Removes the fallback from the bound mesh.
  81206. */
  81207. unBindMesh(): void;
  81208. /**
  81209. * Checks to see if more fallbacks are still availible.
  81210. */
  81211. hasMoreFallbacks: boolean;
  81212. }
  81213. }
  81214. declare module BABYLON {
  81215. /**
  81216. * Class used to evalaute queries containing `and` and `or` operators
  81217. */
  81218. export class AndOrNotEvaluator {
  81219. /**
  81220. * Evaluate a query
  81221. * @param query defines the query to evaluate
  81222. * @param evaluateCallback defines the callback used to filter result
  81223. * @returns true if the query matches
  81224. */
  81225. static Eval(query: string, evaluateCallback: (val: any) => boolean): boolean;
  81226. private static _HandleParenthesisContent;
  81227. private static _SimplifyNegation;
  81228. }
  81229. }
  81230. declare module BABYLON {
  81231. /**
  81232. * Class used to store custom tags
  81233. */
  81234. export class Tags {
  81235. /**
  81236. * Adds support for tags on the given object
  81237. * @param obj defines the object to use
  81238. */
  81239. static EnableFor(obj: any): void;
  81240. /**
  81241. * Removes tags support
  81242. * @param obj defines the object to use
  81243. */
  81244. static DisableFor(obj: any): void;
  81245. /**
  81246. * Gets a boolean indicating if the given object has tags
  81247. * @param obj defines the object to use
  81248. * @returns a boolean
  81249. */
  81250. static HasTags(obj: any): boolean;
  81251. /**
  81252. * Gets the tags available on a given object
  81253. * @param obj defines the object to use
  81254. * @param asString defines if the tags must be returned as a string instead of an array of strings
  81255. * @returns the tags
  81256. */
  81257. static GetTags(obj: any, asString?: boolean): any;
  81258. /**
  81259. * Adds tags to an object
  81260. * @param obj defines the object to use
  81261. * @param tagsString defines the tag string. The tags 'true' and 'false' are reserved and cannot be used as tags.
  81262. * A tag cannot start with '||', '&&', and '!'. It cannot contain whitespaces
  81263. */
  81264. static AddTagsTo(obj: any, tagsString: string): void;
  81265. /**
  81266. * @hidden
  81267. */
  81268. static _AddTagTo(obj: any, tag: string): void;
  81269. /**
  81270. * Removes specific tags from a specific object
  81271. * @param obj defines the object to use
  81272. * @param tagsString defines the tags to remove
  81273. */
  81274. static RemoveTagsFrom(obj: any, tagsString: string): void;
  81275. /**
  81276. * @hidden
  81277. */
  81278. static _RemoveTagFrom(obj: any, tag: string): void;
  81279. /**
  81280. * Defines if tags hosted on an object match a given query
  81281. * @param obj defines the object to use
  81282. * @param tagsQuery defines the tag query
  81283. * @returns a boolean
  81284. */
  81285. static MatchesQuery(obj: any, tagsQuery: string): boolean;
  81286. }
  81287. }
  81288. declare module BABYLON {
  81289. /**
  81290. * Scalar computation library
  81291. */
  81292. export class Scalar {
  81293. /**
  81294. * Two pi constants convenient for computation.
  81295. */
  81296. static TwoPi: number;
  81297. /**
  81298. * Boolean : true if the absolute difference between a and b is lower than epsilon (default = 1.401298E-45)
  81299. * @param a number
  81300. * @param b number
  81301. * @param epsilon (default = 1.401298E-45)
  81302. * @returns true if the absolute difference between a and b is lower than epsilon (default = 1.401298E-45)
  81303. */
  81304. static WithinEpsilon(a: number, b: number, epsilon?: number): boolean;
  81305. /**
  81306. * Returns a string : the upper case translation of the number i to hexadecimal.
  81307. * @param i number
  81308. * @returns the upper case translation of the number i to hexadecimal.
  81309. */
  81310. static ToHex(i: number): string;
  81311. /**
  81312. * Returns -1 if value is negative and +1 is value is positive.
  81313. * @param value the value
  81314. * @returns the value itself if it's equal to zero.
  81315. */
  81316. static Sign(value: number): number;
  81317. /**
  81318. * Returns the value itself if it's between min and max.
  81319. * Returns min if the value is lower than min.
  81320. * Returns max if the value is greater than max.
  81321. * @param value the value to clmap
  81322. * @param min the min value to clamp to (default: 0)
  81323. * @param max the max value to clamp to (default: 1)
  81324. * @returns the clamped value
  81325. */
  81326. static Clamp(value: number, min?: number, max?: number): number;
  81327. /**
  81328. * the log2 of value.
  81329. * @param value the value to compute log2 of
  81330. * @returns the log2 of value.
  81331. */
  81332. static Log2(value: number): number;
  81333. /**
  81334. * Loops the value, so that it is never larger than length and never smaller than 0.
  81335. *
  81336. * This is similar to the modulo operator but it works with floating point numbers.
  81337. * For example, using 3.0 for t and 2.5 for length, the result would be 0.5.
  81338. * With t = 5 and length = 2.5, the result would be 0.0.
  81339. * Note, however, that the behaviour is not defined for negative numbers as it is for the modulo operator
  81340. * @param value the value
  81341. * @param length the length
  81342. * @returns the looped value
  81343. */
  81344. static Repeat(value: number, length: number): number;
  81345. /**
  81346. * Normalize the value between 0.0 and 1.0 using min and max values
  81347. * @param value value to normalize
  81348. * @param min max to normalize between
  81349. * @param max min to normalize between
  81350. * @returns the normalized value
  81351. */
  81352. static Normalize(value: number, min: number, max: number): number;
  81353. /**
  81354. * Denormalize the value from 0.0 and 1.0 using min and max values
  81355. * @param normalized value to denormalize
  81356. * @param min max to denormalize between
  81357. * @param max min to denormalize between
  81358. * @returns the denormalized value
  81359. */
  81360. static Denormalize(normalized: number, min: number, max: number): number;
  81361. /**
  81362. * Calculates the shortest difference between two given angles given in degrees.
  81363. * @param current current angle in degrees
  81364. * @param target target angle in degrees
  81365. * @returns the delta
  81366. */
  81367. static DeltaAngle(current: number, target: number): number;
  81368. /**
  81369. * PingPongs the value t, so that it is never larger than length and never smaller than 0.
  81370. * @param tx value
  81371. * @param length length
  81372. * @returns The returned value will move back and forth between 0 and length
  81373. */
  81374. static PingPong(tx: number, length: number): number;
  81375. /**
  81376. * Interpolates between min and max with smoothing at the limits.
  81377. *
  81378. * This function interpolates between min and max in a similar way to Lerp. However, the interpolation will gradually speed up
  81379. * from the start and slow down toward the end. This is useful for creating natural-looking animation, fading and other transitions.
  81380. * @param from from
  81381. * @param to to
  81382. * @param tx value
  81383. * @returns the smooth stepped value
  81384. */
  81385. static SmoothStep(from: number, to: number, tx: number): number;
  81386. /**
  81387. * Moves a value current towards target.
  81388. *
  81389. * This is essentially the same as Mathf.Lerp but instead the function will ensure that the speed never exceeds maxDelta.
  81390. * Negative values of maxDelta pushes the value away from target.
  81391. * @param current current value
  81392. * @param target target value
  81393. * @param maxDelta max distance to move
  81394. * @returns resulting value
  81395. */
  81396. static MoveTowards(current: number, target: number, maxDelta: number): number;
  81397. /**
  81398. * Same as MoveTowards but makes sure the values interpolate correctly when they wrap around 360 degrees.
  81399. *
  81400. * Variables current and target are assumed to be in degrees. For optimization reasons, negative values of maxDelta
  81401. * are not supported and may cause oscillation. To push current away from a target angle, add 180 to that angle instead.
  81402. * @param current current value
  81403. * @param target target value
  81404. * @param maxDelta max distance to move
  81405. * @returns resulting angle
  81406. */
  81407. static MoveTowardsAngle(current: number, target: number, maxDelta: number): number;
  81408. /**
  81409. * Creates a new scalar with values linearly interpolated of "amount" between the start scalar and the end scalar.
  81410. * @param start start value
  81411. * @param end target value
  81412. * @param amount amount to lerp between
  81413. * @returns the lerped value
  81414. */
  81415. static Lerp(start: number, end: number, amount: number): number;
  81416. /**
  81417. * Same as Lerp but makes sure the values interpolate correctly when they wrap around 360 degrees.
  81418. * The parameter t is clamped to the range [0, 1]. Variables a and b are assumed to be in degrees.
  81419. * @param start start value
  81420. * @param end target value
  81421. * @param amount amount to lerp between
  81422. * @returns the lerped value
  81423. */
  81424. static LerpAngle(start: number, end: number, amount: number): number;
  81425. /**
  81426. * Calculates the linear parameter t that produces the interpolant value within the range [a, b].
  81427. * @param a start value
  81428. * @param b target value
  81429. * @param value value between a and b
  81430. * @returns the inverseLerp value
  81431. */
  81432. static InverseLerp(a: number, b: number, value: number): number;
  81433. /**
  81434. * Returns a new scalar located for "amount" (float) on the Hermite spline defined by the scalars "value1", "value3", "tangent1", "tangent2".
  81435. * @see http://mathworld.wolfram.com/HermitePolynomial.html
  81436. * @param value1 spline value
  81437. * @param tangent1 spline value
  81438. * @param value2 spline value
  81439. * @param tangent2 spline value
  81440. * @param amount input value
  81441. * @returns hermite result
  81442. */
  81443. static Hermite(value1: number, tangent1: number, value2: number, tangent2: number, amount: number): number;
  81444. /**
  81445. * Returns a random float number between and min and max values
  81446. * @param min min value of random
  81447. * @param max max value of random
  81448. * @returns random value
  81449. */
  81450. static RandomRange(min: number, max: number): number;
  81451. /**
  81452. * This function returns percentage of a number in a given range.
  81453. *
  81454. * RangeToPercent(40,20,60) will return 0.5 (50%)
  81455. * RangeToPercent(34,0,100) will return 0.34 (34%)
  81456. * @param number to convert to percentage
  81457. * @param min min range
  81458. * @param max max range
  81459. * @returns the percentage
  81460. */
  81461. static RangeToPercent(number: number, min: number, max: number): number;
  81462. /**
  81463. * This function returns number that corresponds to the percentage in a given range.
  81464. *
  81465. * PercentToRange(0.34,0,100) will return 34.
  81466. * @param percent to convert to number
  81467. * @param min min range
  81468. * @param max max range
  81469. * @returns the number
  81470. */
  81471. static PercentToRange(percent: number, min: number, max: number): number;
  81472. /**
  81473. * Returns the angle converted to equivalent value between -Math.PI and Math.PI radians.
  81474. * @param angle The angle to normalize in radian.
  81475. * @return The converted angle.
  81476. */
  81477. static NormalizeRadians(angle: number): number;
  81478. }
  81479. }
  81480. declare module BABYLON {
  81481. /**
  81482. * Constant used to convert a value to gamma space
  81483. * @ignorenaming
  81484. */
  81485. export const ToGammaSpace: number;
  81486. /**
  81487. * Constant used to convert a value to linear space
  81488. * @ignorenaming
  81489. */
  81490. export const ToLinearSpace = 2.2;
  81491. /**
  81492. * Constant used to define the minimal number value in Babylon.js
  81493. * @ignorenaming
  81494. */
  81495. let Epsilon: number;
  81496. }
  81497. declare module BABYLON {
  81498. /**
  81499. * Class used to represent a viewport on screen
  81500. */
  81501. export class Viewport {
  81502. /** viewport left coordinate */
  81503. x: number;
  81504. /** viewport top coordinate */
  81505. y: number;
  81506. /**viewport width */
  81507. width: number;
  81508. /** viewport height */
  81509. height: number;
  81510. /**
  81511. * Creates a Viewport object located at (x, y) and sized (width, height)
  81512. * @param x defines viewport left coordinate
  81513. * @param y defines viewport top coordinate
  81514. * @param width defines the viewport width
  81515. * @param height defines the viewport height
  81516. */
  81517. constructor(
  81518. /** viewport left coordinate */
  81519. x: number,
  81520. /** viewport top coordinate */
  81521. y: number,
  81522. /**viewport width */
  81523. width: number,
  81524. /** viewport height */
  81525. height: number);
  81526. /**
  81527. * Creates a new viewport using absolute sizing (from 0-> width, 0-> height instead of 0->1)
  81528. * @param renderWidth defines the rendering width
  81529. * @param renderHeight defines the rendering height
  81530. * @returns a new Viewport
  81531. */
  81532. toGlobal(renderWidth: number, renderHeight: number): Viewport;
  81533. /**
  81534. * Stores absolute viewport value into a target viewport (from 0-> width, 0-> height instead of 0->1)
  81535. * @param renderWidth defines the rendering width
  81536. * @param renderHeight defines the rendering height
  81537. * @param ref defines the target viewport
  81538. * @returns the current viewport
  81539. */
  81540. toGlobalToRef(renderWidth: number, renderHeight: number, ref: Viewport): Viewport;
  81541. /**
  81542. * Returns a new Viewport copied from the current one
  81543. * @returns a new Viewport
  81544. */
  81545. clone(): Viewport;
  81546. }
  81547. }
  81548. declare module BABYLON {
  81549. /**
  81550. * Class containing a set of static utilities functions for arrays.
  81551. */
  81552. export class ArrayTools {
  81553. /**
  81554. * Returns an array of the given size filled with element built from the given constructor and the paramters
  81555. * @param size the number of element to construct and put in the array
  81556. * @param itemBuilder a callback responsible for creating new instance of item. Called once per array entry.
  81557. * @returns a new array filled with new objects
  81558. */
  81559. static BuildArray<T>(size: number, itemBuilder: () => T): Array<T>;
  81560. }
  81561. }
  81562. declare module BABYLON {
  81563. /**
  81564. * Represents a plane by the equation ax + by + cz + d = 0
  81565. */
  81566. export class Plane {
  81567. private static _TmpMatrix;
  81568. /**
  81569. * Normal of the plane (a,b,c)
  81570. */
  81571. normal: Vector3;
  81572. /**
  81573. * d component of the plane
  81574. */
  81575. d: number;
  81576. /**
  81577. * Creates a Plane object according to the given floats a, b, c, d and the plane equation : ax + by + cz + d = 0
  81578. * @param a a component of the plane
  81579. * @param b b component of the plane
  81580. * @param c c component of the plane
  81581. * @param d d component of the plane
  81582. */
  81583. constructor(a: number, b: number, c: number, d: number);
  81584. /**
  81585. * @returns the plane coordinates as a new array of 4 elements [a, b, c, d].
  81586. */
  81587. asArray(): number[];
  81588. /**
  81589. * @returns a new plane copied from the current Plane.
  81590. */
  81591. clone(): Plane;
  81592. /**
  81593. * @returns the string "Plane".
  81594. */
  81595. getClassName(): string;
  81596. /**
  81597. * @returns the Plane hash code.
  81598. */
  81599. getHashCode(): number;
  81600. /**
  81601. * Normalize the current Plane in place.
  81602. * @returns the updated Plane.
  81603. */
  81604. normalize(): Plane;
  81605. /**
  81606. * Applies a transformation the plane and returns the result
  81607. * @param transformation the transformation matrix to be applied to the plane
  81608. * @returns a new Plane as the result of the transformation of the current Plane by the given matrix.
  81609. */
  81610. transform(transformation: DeepImmutable<Matrix>): Plane;
  81611. /**
  81612. * Compute the dot product between the point and the plane normal
  81613. * @param point point to calculate the dot product with
  81614. * @returns the dot product (float) of the point coordinates and the plane normal.
  81615. */
  81616. dotCoordinate(point: DeepImmutable<Vector3>): number;
  81617. /**
  81618. * Updates the current Plane from the plane defined by the three given points.
  81619. * @param point1 one of the points used to contruct the plane
  81620. * @param point2 one of the points used to contruct the plane
  81621. * @param point3 one of the points used to contruct the plane
  81622. * @returns the updated Plane.
  81623. */
  81624. copyFromPoints(point1: DeepImmutable<Vector3>, point2: DeepImmutable<Vector3>, point3: DeepImmutable<Vector3>): Plane;
  81625. /**
  81626. * Checks if the plane is facing a given direction
  81627. * @param direction the direction to check if the plane is facing
  81628. * @param epsilon value the dot product is compared against (returns true if dot <= epsilon)
  81629. * @returns True is the vector "direction" is the same side than the plane normal.
  81630. */
  81631. isFrontFacingTo(direction: DeepImmutable<Vector3>, epsilon: number): boolean;
  81632. /**
  81633. * Calculates the distance to a point
  81634. * @param point point to calculate distance to
  81635. * @returns the signed distance (float) from the given point to the Plane.
  81636. */
  81637. signedDistanceTo(point: DeepImmutable<Vector3>): number;
  81638. /**
  81639. * Creates a plane from an array
  81640. * @param array the array to create a plane from
  81641. * @returns a new Plane from the given array.
  81642. */
  81643. static FromArray(array: DeepImmutable<ArrayLike<number>>): Plane;
  81644. /**
  81645. * Creates a plane from three points
  81646. * @param point1 point used to create the plane
  81647. * @param point2 point used to create the plane
  81648. * @param point3 point used to create the plane
  81649. * @returns a new Plane defined by the three given points.
  81650. */
  81651. static FromPoints(point1: DeepImmutable<Vector3>, point2: DeepImmutable<Vector3>, point3: DeepImmutable<Vector3>): Plane;
  81652. /**
  81653. * Creates a plane from an origin point and a normal
  81654. * @param origin origin of the plane to be constructed
  81655. * @param normal normal of the plane to be constructed
  81656. * @returns a new Plane the normal vector to this plane at the given origin point.
  81657. * Note : the vector "normal" is updated because normalized.
  81658. */
  81659. static FromPositionAndNormal(origin: DeepImmutable<Vector3>, normal: Vector3): Plane;
  81660. /**
  81661. * Calculates the distance from a plane and a point
  81662. * @param origin origin of the plane to be constructed
  81663. * @param normal normal of the plane to be constructed
  81664. * @param point point to calculate distance to
  81665. * @returns the signed distance between the plane defined by the normal vector at the "origin"" point and the given other point.
  81666. */
  81667. static SignedDistanceToPlaneFromPositionAndNormal(origin: DeepImmutable<Vector3>, normal: DeepImmutable<Vector3>, point: DeepImmutable<Vector3>): number;
  81668. }
  81669. }
  81670. declare module BABYLON {
  81671. /** @hidden */
  81672. export class PerformanceConfigurator {
  81673. /** @hidden */
  81674. static MatrixUse64Bits: boolean;
  81675. /** @hidden */
  81676. static MatrixTrackPrecisionChange: boolean;
  81677. /** @hidden */
  81678. static MatrixCurrentType: any;
  81679. /** @hidden */
  81680. static MatrixTrackedMatrices: Array<any> | null;
  81681. /** @hidden */
  81682. static SetMatrixPrecision(use64bits: boolean): void;
  81683. }
  81684. }
  81685. declare module BABYLON {
  81686. /**
  81687. * Class representing a vector containing 2 coordinates
  81688. */
  81689. export class Vector2 {
  81690. /** defines the first coordinate */
  81691. x: number;
  81692. /** defines the second coordinate */
  81693. y: number;
  81694. /**
  81695. * Creates a new Vector2 from the given x and y coordinates
  81696. * @param x defines the first coordinate
  81697. * @param y defines the second coordinate
  81698. */
  81699. constructor(
  81700. /** defines the first coordinate */
  81701. x?: number,
  81702. /** defines the second coordinate */
  81703. y?: number);
  81704. /**
  81705. * Gets a string with the Vector2 coordinates
  81706. * @returns a string with the Vector2 coordinates
  81707. */
  81708. toString(): string;
  81709. /**
  81710. * Gets class name
  81711. * @returns the string "Vector2"
  81712. */
  81713. getClassName(): string;
  81714. /**
  81715. * Gets current vector hash code
  81716. * @returns the Vector2 hash code as a number
  81717. */
  81718. getHashCode(): number;
  81719. /**
  81720. * Sets the Vector2 coordinates in the given array or Float32Array from the given index.
  81721. * @param array defines the source array
  81722. * @param index defines the offset in source array
  81723. * @returns the current Vector2
  81724. */
  81725. toArray(array: FloatArray, index?: number): Vector2;
  81726. /**
  81727. * Update the current vector from an array
  81728. * @param array defines the destination array
  81729. * @param index defines the offset in the destination array
  81730. * @returns the current Vector3
  81731. */
  81732. fromArray(array: FloatArray, index?: number): Vector2;
  81733. /**
  81734. * Copy the current vector to an array
  81735. * @returns a new array with 2 elements: the Vector2 coordinates.
  81736. */
  81737. asArray(): number[];
  81738. /**
  81739. * Sets the Vector2 coordinates with the given Vector2 coordinates
  81740. * @param source defines the source Vector2
  81741. * @returns the current updated Vector2
  81742. */
  81743. copyFrom(source: DeepImmutable<Vector2>): Vector2;
  81744. /**
  81745. * Sets the Vector2 coordinates with the given floats
  81746. * @param x defines the first coordinate
  81747. * @param y defines the second coordinate
  81748. * @returns the current updated Vector2
  81749. */
  81750. copyFromFloats(x: number, y: number): Vector2;
  81751. /**
  81752. * Sets the Vector2 coordinates with the given floats
  81753. * @param x defines the first coordinate
  81754. * @param y defines the second coordinate
  81755. * @returns the current updated Vector2
  81756. */
  81757. set(x: number, y: number): Vector2;
  81758. /**
  81759. * Add another vector with the current one
  81760. * @param otherVector defines the other vector
  81761. * @returns a new Vector2 set with the addition of the current Vector2 and the given one coordinates
  81762. */
  81763. add(otherVector: DeepImmutable<Vector2>): Vector2;
  81764. /**
  81765. * Sets the "result" coordinates with the addition of the current Vector2 and the given one coordinates
  81766. * @param otherVector defines the other vector
  81767. * @param result defines the target vector
  81768. * @returns the unmodified current Vector2
  81769. */
  81770. addToRef(otherVector: DeepImmutable<Vector2>, result: Vector2): Vector2;
  81771. /**
  81772. * Set the Vector2 coordinates by adding the given Vector2 coordinates
  81773. * @param otherVector defines the other vector
  81774. * @returns the current updated Vector2
  81775. */
  81776. addInPlace(otherVector: DeepImmutable<Vector2>): Vector2;
  81777. /**
  81778. * Gets a new Vector2 by adding the current Vector2 coordinates to the given Vector3 x, y coordinates
  81779. * @param otherVector defines the other vector
  81780. * @returns a new Vector2
  81781. */
  81782. addVector3(otherVector: Vector3): Vector2;
  81783. /**
  81784. * Gets a new Vector2 set with the subtracted coordinates of the given one from the current Vector2
  81785. * @param otherVector defines the other vector
  81786. * @returns a new Vector2
  81787. */
  81788. subtract(otherVector: Vector2): Vector2;
  81789. /**
  81790. * Sets the "result" coordinates with the subtraction of the given one from the current Vector2 coordinates.
  81791. * @param otherVector defines the other vector
  81792. * @param result defines the target vector
  81793. * @returns the unmodified current Vector2
  81794. */
  81795. subtractToRef(otherVector: DeepImmutable<Vector2>, result: Vector2): Vector2;
  81796. /**
  81797. * Sets the current Vector2 coordinates by subtracting from it the given one coordinates
  81798. * @param otherVector defines the other vector
  81799. * @returns the current updated Vector2
  81800. */
  81801. subtractInPlace(otherVector: DeepImmutable<Vector2>): Vector2;
  81802. /**
  81803. * Multiplies in place the current Vector2 coordinates by the given ones
  81804. * @param otherVector defines the other vector
  81805. * @returns the current updated Vector2
  81806. */
  81807. multiplyInPlace(otherVector: DeepImmutable<Vector2>): Vector2;
  81808. /**
  81809. * Returns a new Vector2 set with the multiplication of the current Vector2 and the given one coordinates
  81810. * @param otherVector defines the other vector
  81811. * @returns a new Vector2
  81812. */
  81813. multiply(otherVector: DeepImmutable<Vector2>): Vector2;
  81814. /**
  81815. * Sets "result" coordinates with the multiplication of the current Vector2 and the given one coordinates
  81816. * @param otherVector defines the other vector
  81817. * @param result defines the target vector
  81818. * @returns the unmodified current Vector2
  81819. */
  81820. multiplyToRef(otherVector: DeepImmutable<Vector2>, result: Vector2): Vector2;
  81821. /**
  81822. * Gets a new Vector2 set with the Vector2 coordinates multiplied by the given floats
  81823. * @param x defines the first coordinate
  81824. * @param y defines the second coordinate
  81825. * @returns a new Vector2
  81826. */
  81827. multiplyByFloats(x: number, y: number): Vector2;
  81828. /**
  81829. * Returns a new Vector2 set with the Vector2 coordinates divided by the given one coordinates
  81830. * @param otherVector defines the other vector
  81831. * @returns a new Vector2
  81832. */
  81833. divide(otherVector: Vector2): Vector2;
  81834. /**
  81835. * Sets the "result" coordinates with the Vector2 divided by the given one coordinates
  81836. * @param otherVector defines the other vector
  81837. * @param result defines the target vector
  81838. * @returns the unmodified current Vector2
  81839. */
  81840. divideToRef(otherVector: DeepImmutable<Vector2>, result: Vector2): Vector2;
  81841. /**
  81842. * Divides the current Vector2 coordinates by the given ones
  81843. * @param otherVector defines the other vector
  81844. * @returns the current updated Vector2
  81845. */
  81846. divideInPlace(otherVector: DeepImmutable<Vector2>): Vector2;
  81847. /**
  81848. * Gets a new Vector2 with current Vector2 negated coordinates
  81849. * @returns a new Vector2
  81850. */
  81851. negate(): Vector2;
  81852. /**
  81853. * Negate this vector in place
  81854. * @returns this
  81855. */
  81856. negateInPlace(): Vector2;
  81857. /**
  81858. * Negate the current Vector2 and stores the result in the given vector "result" coordinates
  81859. * @param result defines the Vector3 object where to store the result
  81860. * @returns the current Vector2
  81861. */
  81862. negateToRef(result: Vector2): Vector2;
  81863. /**
  81864. * Multiply the Vector2 coordinates by scale
  81865. * @param scale defines the scaling factor
  81866. * @returns the current updated Vector2
  81867. */
  81868. scaleInPlace(scale: number): Vector2;
  81869. /**
  81870. * Returns a new Vector2 scaled by "scale" from the current Vector2
  81871. * @param scale defines the scaling factor
  81872. * @returns a new Vector2
  81873. */
  81874. scale(scale: number): Vector2;
  81875. /**
  81876. * Scale the current Vector2 values by a factor to a given Vector2
  81877. * @param scale defines the scale factor
  81878. * @param result defines the Vector2 object where to store the result
  81879. * @returns the unmodified current Vector2
  81880. */
  81881. scaleToRef(scale: number, result: Vector2): Vector2;
  81882. /**
  81883. * Scale the current Vector2 values by a factor and add the result to a given Vector2
  81884. * @param scale defines the scale factor
  81885. * @param result defines the Vector2 object where to store the result
  81886. * @returns the unmodified current Vector2
  81887. */
  81888. scaleAndAddToRef(scale: number, result: Vector2): Vector2;
  81889. /**
  81890. * Gets a boolean if two vectors are equals
  81891. * @param otherVector defines the other vector
  81892. * @returns true if the given vector coordinates strictly equal the current Vector2 ones
  81893. */
  81894. equals(otherVector: DeepImmutable<Vector2>): boolean;
  81895. /**
  81896. * Gets a boolean if two vectors are equals (using an epsilon value)
  81897. * @param otherVector defines the other vector
  81898. * @param epsilon defines the minimal distance to consider equality
  81899. * @returns true if the given vector coordinates are close to the current ones by a distance of epsilon.
  81900. */
  81901. equalsWithEpsilon(otherVector: DeepImmutable<Vector2>, epsilon?: number): boolean;
  81902. /**
  81903. * Gets a new Vector2 from current Vector2 floored values
  81904. * @returns a new Vector2
  81905. */
  81906. floor(): Vector2;
  81907. /**
  81908. * Gets a new Vector2 from current Vector2 floored values
  81909. * @returns a new Vector2
  81910. */
  81911. fract(): Vector2;
  81912. /**
  81913. * Gets the length of the vector
  81914. * @returns the vector length (float)
  81915. */
  81916. length(): number;
  81917. /**
  81918. * Gets the vector squared length
  81919. * @returns the vector squared length (float)
  81920. */
  81921. lengthSquared(): number;
  81922. /**
  81923. * Normalize the vector
  81924. * @returns the current updated Vector2
  81925. */
  81926. normalize(): Vector2;
  81927. /**
  81928. * Gets a new Vector2 copied from the Vector2
  81929. * @returns a new Vector2
  81930. */
  81931. clone(): Vector2;
  81932. /**
  81933. * Gets a new Vector2(0, 0)
  81934. * @returns a new Vector2
  81935. */
  81936. static Zero(): Vector2;
  81937. /**
  81938. * Gets a new Vector2(1, 1)
  81939. * @returns a new Vector2
  81940. */
  81941. static One(): Vector2;
  81942. /**
  81943. * Gets a new Vector2 set from the given index element of the given array
  81944. * @param array defines the data source
  81945. * @param offset defines the offset in the data source
  81946. * @returns a new Vector2
  81947. */
  81948. static FromArray(array: DeepImmutable<ArrayLike<number>>, offset?: number): Vector2;
  81949. /**
  81950. * Sets "result" from the given index element of the given array
  81951. * @param array defines the data source
  81952. * @param offset defines the offset in the data source
  81953. * @param result defines the target vector
  81954. */
  81955. static FromArrayToRef(array: DeepImmutable<ArrayLike<number>>, offset: number, result: Vector2): void;
  81956. /**
  81957. * Gets a new Vector2 located for "amount" (float) on the CatmullRom spline defined by the given four Vector2
  81958. * @param value1 defines 1st point of control
  81959. * @param value2 defines 2nd point of control
  81960. * @param value3 defines 3rd point of control
  81961. * @param value4 defines 4th point of control
  81962. * @param amount defines the interpolation factor
  81963. * @returns a new Vector2
  81964. */
  81965. static CatmullRom(value1: DeepImmutable<Vector2>, value2: DeepImmutable<Vector2>, value3: DeepImmutable<Vector2>, value4: DeepImmutable<Vector2>, amount: number): Vector2;
  81966. /**
  81967. * 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".
  81968. * If a coordinate of "value" is lower than "min" coordinates, the returned Vector2 is given this "min" coordinate.
  81969. * If a coordinate of "value" is greater than "max" coordinates, the returned Vector2 is given this "max" coordinate
  81970. * @param value defines the value to clamp
  81971. * @param min defines the lower limit
  81972. * @param max defines the upper limit
  81973. * @returns a new Vector2
  81974. */
  81975. static Clamp(value: DeepImmutable<Vector2>, min: DeepImmutable<Vector2>, max: DeepImmutable<Vector2>): Vector2;
  81976. /**
  81977. * Returns a new Vector2 located for "amount" (float) on the Hermite spline defined by the vectors "value1", "value3", "tangent1", "tangent2"
  81978. * @param value1 defines the 1st control point
  81979. * @param tangent1 defines the outgoing tangent
  81980. * @param value2 defines the 2nd control point
  81981. * @param tangent2 defines the incoming tangent
  81982. * @param amount defines the interpolation factor
  81983. * @returns a new Vector2
  81984. */
  81985. static Hermite(value1: DeepImmutable<Vector2>, tangent1: DeepImmutable<Vector2>, value2: DeepImmutable<Vector2>, tangent2: DeepImmutable<Vector2>, amount: number): Vector2;
  81986. /**
  81987. * Returns a new Vector2 located for "amount" (float) on the linear interpolation between the vector "start" adn the vector "end".
  81988. * @param start defines the start vector
  81989. * @param end defines the end vector
  81990. * @param amount defines the interpolation factor
  81991. * @returns a new Vector2
  81992. */
  81993. static Lerp(start: DeepImmutable<Vector2>, end: DeepImmutable<Vector2>, amount: number): Vector2;
  81994. /**
  81995. * Gets the dot product of the vector "left" and the vector "right"
  81996. * @param left defines first vector
  81997. * @param right defines second vector
  81998. * @returns the dot product (float)
  81999. */
  82000. static Dot(left: DeepImmutable<Vector2>, right: DeepImmutable<Vector2>): number;
  82001. /**
  82002. * Returns a new Vector2 equal to the normalized given vector
  82003. * @param vector defines the vector to normalize
  82004. * @returns a new Vector2
  82005. */
  82006. static Normalize(vector: DeepImmutable<Vector2>): Vector2;
  82007. /**
  82008. * Gets a new Vector2 set with the minimal coordinate values from the "left" and "right" vectors
  82009. * @param left defines 1st vector
  82010. * @param right defines 2nd vector
  82011. * @returns a new Vector2
  82012. */
  82013. static Minimize(left: DeepImmutable<Vector2>, right: DeepImmutable<Vector2>): Vector2;
  82014. /**
  82015. * Gets a new Vecto2 set with the maximal coordinate values from the "left" and "right" vectors
  82016. * @param left defines 1st vector
  82017. * @param right defines 2nd vector
  82018. * @returns a new Vector2
  82019. */
  82020. static Maximize(left: DeepImmutable<Vector2>, right: DeepImmutable<Vector2>): Vector2;
  82021. /**
  82022. * Gets a new Vector2 set with the transformed coordinates of the given vector by the given transformation matrix
  82023. * @param vector defines the vector to transform
  82024. * @param transformation defines the matrix to apply
  82025. * @returns a new Vector2
  82026. */
  82027. static Transform(vector: DeepImmutable<Vector2>, transformation: DeepImmutable<Matrix>): Vector2;
  82028. /**
  82029. * Transforms the given vector coordinates by the given transformation matrix and stores the result in the vector "result" coordinates
  82030. * @param vector defines the vector to transform
  82031. * @param transformation defines the matrix to apply
  82032. * @param result defines the target vector
  82033. */
  82034. static TransformToRef(vector: DeepImmutable<Vector2>, transformation: DeepImmutable<Matrix>, result: Vector2): void;
  82035. /**
  82036. * Determines if a given vector is included in a triangle
  82037. * @param p defines the vector to test
  82038. * @param p0 defines 1st triangle point
  82039. * @param p1 defines 2nd triangle point
  82040. * @param p2 defines 3rd triangle point
  82041. * @returns true if the point "p" is in the triangle defined by the vertors "p0", "p1", "p2"
  82042. */
  82043. static PointInTriangle(p: DeepImmutable<Vector2>, p0: DeepImmutable<Vector2>, p1: DeepImmutable<Vector2>, p2: DeepImmutable<Vector2>): boolean;
  82044. /**
  82045. * Gets the distance between the vectors "value1" and "value2"
  82046. * @param value1 defines first vector
  82047. * @param value2 defines second vector
  82048. * @returns the distance between vectors
  82049. */
  82050. static Distance(value1: DeepImmutable<Vector2>, value2: DeepImmutable<Vector2>): number;
  82051. /**
  82052. * Returns the squared distance between the vectors "value1" and "value2"
  82053. * @param value1 defines first vector
  82054. * @param value2 defines second vector
  82055. * @returns the squared distance between vectors
  82056. */
  82057. static DistanceSquared(value1: DeepImmutable<Vector2>, value2: DeepImmutable<Vector2>): number;
  82058. /**
  82059. * Gets a new Vector2 located at the center of the vectors "value1" and "value2"
  82060. * @param value1 defines first vector
  82061. * @param value2 defines second vector
  82062. * @returns a new Vector2
  82063. */
  82064. static Center(value1: DeepImmutable<Vector2>, value2: DeepImmutable<Vector2>): Vector2;
  82065. /**
  82066. * Gets the shortest distance (float) between the point "p" and the segment defined by the two points "segA" and "segB".
  82067. * @param p defines the middle point
  82068. * @param segA defines one point of the segment
  82069. * @param segB defines the other point of the segment
  82070. * @returns the shortest distance
  82071. */
  82072. static DistanceOfPointFromSegment(p: DeepImmutable<Vector2>, segA: DeepImmutable<Vector2>, segB: DeepImmutable<Vector2>): number;
  82073. }
  82074. /**
  82075. * Class used to store (x,y,z) vector representation
  82076. * A Vector3 is the main object used in 3D geometry
  82077. * It can represent etiher the coordinates of a point the space, either a direction
  82078. * Reminder: js uses a left handed forward facing system
  82079. */
  82080. export class Vector3 {
  82081. private static _UpReadOnly;
  82082. private static _ZeroReadOnly;
  82083. /** @hidden */
  82084. _x: number;
  82085. /** @hidden */
  82086. _y: number;
  82087. /** @hidden */
  82088. _z: number;
  82089. /** @hidden */
  82090. _isDirty: boolean;
  82091. /** Gets or sets the x coordinate */
  82092. get x(): number;
  82093. set x(value: number);
  82094. /** Gets or sets the y coordinate */
  82095. get y(): number;
  82096. set y(value: number);
  82097. /** Gets or sets the z coordinate */
  82098. get z(): number;
  82099. set z(value: number);
  82100. /**
  82101. * Creates a new Vector3 object from the given x, y, z (floats) coordinates.
  82102. * @param x defines the first coordinates (on X axis)
  82103. * @param y defines the second coordinates (on Y axis)
  82104. * @param z defines the third coordinates (on Z axis)
  82105. */
  82106. constructor(x?: number, y?: number, z?: number);
  82107. /**
  82108. * Creates a string representation of the Vector3
  82109. * @returns a string with the Vector3 coordinates.
  82110. */
  82111. toString(): string;
  82112. /**
  82113. * Gets the class name
  82114. * @returns the string "Vector3"
  82115. */
  82116. getClassName(): string;
  82117. /**
  82118. * Creates the Vector3 hash code
  82119. * @returns a number which tends to be unique between Vector3 instances
  82120. */
  82121. getHashCode(): number;
  82122. /**
  82123. * Creates an array containing three elements : the coordinates of the Vector3
  82124. * @returns a new array of numbers
  82125. */
  82126. asArray(): number[];
  82127. /**
  82128. * Populates the given array or Float32Array from the given index with the successive coordinates of the Vector3
  82129. * @param array defines the destination array
  82130. * @param index defines the offset in the destination array
  82131. * @returns the current Vector3
  82132. */
  82133. toArray(array: FloatArray, index?: number): Vector3;
  82134. /**
  82135. * Update the current vector from an array
  82136. * @param array defines the destination array
  82137. * @param index defines the offset in the destination array
  82138. * @returns the current Vector3
  82139. */
  82140. fromArray(array: FloatArray, index?: number): Vector3;
  82141. /**
  82142. * Converts the current Vector3 into a quaternion (considering that the Vector3 contains Euler angles representation of a rotation)
  82143. * @returns a new Quaternion object, computed from the Vector3 coordinates
  82144. */
  82145. toQuaternion(): Quaternion;
  82146. /**
  82147. * Adds the given vector to the current Vector3
  82148. * @param otherVector defines the second operand
  82149. * @returns the current updated Vector3
  82150. */
  82151. addInPlace(otherVector: DeepImmutable<Vector3>): Vector3;
  82152. /**
  82153. * Adds the given coordinates to the current Vector3
  82154. * @param x defines the x coordinate of the operand
  82155. * @param y defines the y coordinate of the operand
  82156. * @param z defines the z coordinate of the operand
  82157. * @returns the current updated Vector3
  82158. */
  82159. addInPlaceFromFloats(x: number, y: number, z: number): Vector3;
  82160. /**
  82161. * Gets a new Vector3, result of the addition the current Vector3 and the given vector
  82162. * @param otherVector defines the second operand
  82163. * @returns the resulting Vector3
  82164. */
  82165. add(otherVector: DeepImmutable<Vector3>): Vector3;
  82166. /**
  82167. * Adds the current Vector3 to the given one and stores the result in the vector "result"
  82168. * @param otherVector defines the second operand
  82169. * @param result defines the Vector3 object where to store the result
  82170. * @returns the current Vector3
  82171. */
  82172. addToRef(otherVector: DeepImmutable<Vector3>, result: Vector3): Vector3;
  82173. /**
  82174. * Subtract the given vector from the current Vector3
  82175. * @param otherVector defines the second operand
  82176. * @returns the current updated Vector3
  82177. */
  82178. subtractInPlace(otherVector: DeepImmutable<Vector3>): Vector3;
  82179. /**
  82180. * Returns a new Vector3, result of the subtraction of the given vector from the current Vector3
  82181. * @param otherVector defines the second operand
  82182. * @returns the resulting Vector3
  82183. */
  82184. subtract(otherVector: DeepImmutable<Vector3>): Vector3;
  82185. /**
  82186. * Subtracts the given vector from the current Vector3 and stores the result in the vector "result".
  82187. * @param otherVector defines the second operand
  82188. * @param result defines the Vector3 object where to store the result
  82189. * @returns the current Vector3
  82190. */
  82191. subtractToRef(otherVector: DeepImmutable<Vector3>, result: Vector3): Vector3;
  82192. /**
  82193. * Returns a new Vector3 set with the subtraction of the given floats from the current Vector3 coordinates
  82194. * @param x defines the x coordinate of the operand
  82195. * @param y defines the y coordinate of the operand
  82196. * @param z defines the z coordinate of the operand
  82197. * @returns the resulting Vector3
  82198. */
  82199. subtractFromFloats(x: number, y: number, z: number): Vector3;
  82200. /**
  82201. * Subtracts the given floats from the current Vector3 coordinates and set the given vector "result" with this result
  82202. * @param x defines the x coordinate of the operand
  82203. * @param y defines the y coordinate of the operand
  82204. * @param z defines the z coordinate of the operand
  82205. * @param result defines the Vector3 object where to store the result
  82206. * @returns the current Vector3
  82207. */
  82208. subtractFromFloatsToRef(x: number, y: number, z: number, result: Vector3): Vector3;
  82209. /**
  82210. * Gets a new Vector3 set with the current Vector3 negated coordinates
  82211. * @returns a new Vector3
  82212. */
  82213. negate(): Vector3;
  82214. /**
  82215. * Negate this vector in place
  82216. * @returns this
  82217. */
  82218. negateInPlace(): Vector3;
  82219. /**
  82220. * Negate the current Vector3 and stores the result in the given vector "result" coordinates
  82221. * @param result defines the Vector3 object where to store the result
  82222. * @returns the current Vector3
  82223. */
  82224. negateToRef(result: Vector3): Vector3;
  82225. /**
  82226. * Multiplies the Vector3 coordinates by the float "scale"
  82227. * @param scale defines the multiplier factor
  82228. * @returns the current updated Vector3
  82229. */
  82230. scaleInPlace(scale: number): Vector3;
  82231. /**
  82232. * Returns a new Vector3 set with the current Vector3 coordinates multiplied by the float "scale"
  82233. * @param scale defines the multiplier factor
  82234. * @returns a new Vector3
  82235. */
  82236. scale(scale: number): Vector3;
  82237. /**
  82238. * Multiplies the current Vector3 coordinates by the float "scale" and stores the result in the given vector "result" coordinates
  82239. * @param scale defines the multiplier factor
  82240. * @param result defines the Vector3 object where to store the result
  82241. * @returns the current Vector3
  82242. */
  82243. scaleToRef(scale: number, result: Vector3): Vector3;
  82244. /**
  82245. * Scale the current Vector3 values by a factor and add the result to a given Vector3
  82246. * @param scale defines the scale factor
  82247. * @param result defines the Vector3 object where to store the result
  82248. * @returns the unmodified current Vector3
  82249. */
  82250. scaleAndAddToRef(scale: number, result: Vector3): Vector3;
  82251. /**
  82252. * Projects the current vector3 to a plane along a ray starting from a specified origin and directed towards the point.
  82253. * @param origin defines the origin of the projection ray
  82254. * @param plane defines the plane to project to
  82255. * @returns the projected vector3
  82256. */
  82257. projectOnPlane(plane: Plane, origin: Vector3): Vector3;
  82258. /**
  82259. * Projects the current vector3 to a plane along a ray starting from a specified origin and directed towards the point.
  82260. * @param origin defines the origin of the projection ray
  82261. * @param plane defines the plane to project to
  82262. * @param result defines the Vector3 where to store the result
  82263. */
  82264. projectOnPlaneToRef(plane: Plane, origin: Vector3, result: Vector3): void;
  82265. /**
  82266. * Returns true if the current Vector3 and the given vector coordinates are strictly equal
  82267. * @param otherVector defines the second operand
  82268. * @returns true if both vectors are equals
  82269. */
  82270. equals(otherVector: DeepImmutable<Vector3>): boolean;
  82271. /**
  82272. * Returns true if the current Vector3 and the given vector coordinates are distant less than epsilon
  82273. * @param otherVector defines the second operand
  82274. * @param epsilon defines the minimal distance to define values as equals
  82275. * @returns true if both vectors are distant less than epsilon
  82276. */
  82277. equalsWithEpsilon(otherVector: DeepImmutable<Vector3>, epsilon?: number): boolean;
  82278. /**
  82279. * Returns true if the current Vector3 coordinates equals the given floats
  82280. * @param x defines the x coordinate of the operand
  82281. * @param y defines the y coordinate of the operand
  82282. * @param z defines the z coordinate of the operand
  82283. * @returns true if both vectors are equals
  82284. */
  82285. equalsToFloats(x: number, y: number, z: number): boolean;
  82286. /**
  82287. * Multiplies the current Vector3 coordinates by the given ones
  82288. * @param otherVector defines the second operand
  82289. * @returns the current updated Vector3
  82290. */
  82291. multiplyInPlace(otherVector: DeepImmutable<Vector3>): Vector3;
  82292. /**
  82293. * Returns a new Vector3, result of the multiplication of the current Vector3 by the given vector
  82294. * @param otherVector defines the second operand
  82295. * @returns the new Vector3
  82296. */
  82297. multiply(otherVector: DeepImmutable<Vector3>): Vector3;
  82298. /**
  82299. * Multiplies the current Vector3 by the given one and stores the result in the given vector "result"
  82300. * @param otherVector defines the second operand
  82301. * @param result defines the Vector3 object where to store the result
  82302. * @returns the current Vector3
  82303. */
  82304. multiplyToRef(otherVector: DeepImmutable<Vector3>, result: Vector3): Vector3;
  82305. /**
  82306. * Returns a new Vector3 set with the result of the mulliplication of the current Vector3 coordinates by the given floats
  82307. * @param x defines the x coordinate of the operand
  82308. * @param y defines the y coordinate of the operand
  82309. * @param z defines the z coordinate of the operand
  82310. * @returns the new Vector3
  82311. */
  82312. multiplyByFloats(x: number, y: number, z: number): Vector3;
  82313. /**
  82314. * Returns a new Vector3 set with the result of the division of the current Vector3 coordinates by the given ones
  82315. * @param otherVector defines the second operand
  82316. * @returns the new Vector3
  82317. */
  82318. divide(otherVector: DeepImmutable<Vector3>): Vector3;
  82319. /**
  82320. * Divides the current Vector3 coordinates by the given ones and stores the result in the given vector "result"
  82321. * @param otherVector defines the second operand
  82322. * @param result defines the Vector3 object where to store the result
  82323. * @returns the current Vector3
  82324. */
  82325. divideToRef(otherVector: DeepImmutable<Vector3>, result: Vector3): Vector3;
  82326. /**
  82327. * Divides the current Vector3 coordinates by the given ones.
  82328. * @param otherVector defines the second operand
  82329. * @returns the current updated Vector3
  82330. */
  82331. divideInPlace(otherVector: Vector3): Vector3;
  82332. /**
  82333. * Updates the current Vector3 with the minimal coordinate values between its and the given vector ones
  82334. * @param other defines the second operand
  82335. * @returns the current updated Vector3
  82336. */
  82337. minimizeInPlace(other: DeepImmutable<Vector3>): Vector3;
  82338. /**
  82339. * Updates the current Vector3 with the maximal coordinate values between its and the given vector ones.
  82340. * @param other defines the second operand
  82341. * @returns the current updated Vector3
  82342. */
  82343. maximizeInPlace(other: DeepImmutable<Vector3>): Vector3;
  82344. /**
  82345. * Updates the current Vector3 with the minimal coordinate values between its and the given coordinates
  82346. * @param x defines the x coordinate of the operand
  82347. * @param y defines the y coordinate of the operand
  82348. * @param z defines the z coordinate of the operand
  82349. * @returns the current updated Vector3
  82350. */
  82351. minimizeInPlaceFromFloats(x: number, y: number, z: number): Vector3;
  82352. /**
  82353. * Updates the current Vector3 with the maximal coordinate values between its and the given coordinates.
  82354. * @param x defines the x coordinate of the operand
  82355. * @param y defines the y coordinate of the operand
  82356. * @param z defines the z coordinate of the operand
  82357. * @returns the current updated Vector3
  82358. */
  82359. maximizeInPlaceFromFloats(x: number, y: number, z: number): Vector3;
  82360. /**
  82361. * Due to float precision, scale of a mesh could be uniform but float values are off by a small fraction
  82362. * Check if is non uniform within a certain amount of decimal places to account for this
  82363. * @param epsilon the amount the values can differ
  82364. * @returns if the the vector is non uniform to a certain number of decimal places
  82365. */
  82366. isNonUniformWithinEpsilon(epsilon: number): boolean;
  82367. /**
  82368. * Gets a boolean indicating that the vector is non uniform meaning x, y or z are not all the same
  82369. */
  82370. get isNonUniform(): boolean;
  82371. /**
  82372. * Gets a new Vector3 from current Vector3 floored values
  82373. * @returns a new Vector3
  82374. */
  82375. floor(): Vector3;
  82376. /**
  82377. * Gets a new Vector3 from current Vector3 floored values
  82378. * @returns a new Vector3
  82379. */
  82380. fract(): Vector3;
  82381. /**
  82382. * Gets the length of the Vector3
  82383. * @returns the length of the Vector3
  82384. */
  82385. length(): number;
  82386. /**
  82387. * Gets the squared length of the Vector3
  82388. * @returns squared length of the Vector3
  82389. */
  82390. lengthSquared(): number;
  82391. /**
  82392. * Normalize the current Vector3.
  82393. * Please note that this is an in place operation.
  82394. * @returns the current updated Vector3
  82395. */
  82396. normalize(): Vector3;
  82397. /**
  82398. * Reorders the x y z properties of the vector in place
  82399. * @param order new ordering of the properties (eg. for vector 1,2,3 with "ZYX" will produce 3,2,1)
  82400. * @returns the current updated vector
  82401. */
  82402. reorderInPlace(order: string): this;
  82403. /**
  82404. * Rotates the vector around 0,0,0 by a quaternion
  82405. * @param quaternion the rotation quaternion
  82406. * @param result vector to store the result
  82407. * @returns the resulting vector
  82408. */
  82409. rotateByQuaternionToRef(quaternion: Quaternion, result: Vector3): Vector3;
  82410. /**
  82411. * Rotates a vector around a given point
  82412. * @param quaternion the rotation quaternion
  82413. * @param point the point to rotate around
  82414. * @param result vector to store the result
  82415. * @returns the resulting vector
  82416. */
  82417. rotateByQuaternionAroundPointToRef(quaternion: Quaternion, point: Vector3, result: Vector3): Vector3;
  82418. /**
  82419. * Returns a new Vector3 as the cross product of the current vector and the "other" one
  82420. * The cross product is then orthogonal to both current and "other"
  82421. * @param other defines the right operand
  82422. * @returns the cross product
  82423. */
  82424. cross(other: Vector3): Vector3;
  82425. /**
  82426. * Normalize the current Vector3 with the given input length.
  82427. * Please note that this is an in place operation.
  82428. * @param len the length of the vector
  82429. * @returns the current updated Vector3
  82430. */
  82431. normalizeFromLength(len: number): Vector3;
  82432. /**
  82433. * Normalize the current Vector3 to a new vector
  82434. * @returns the new Vector3
  82435. */
  82436. normalizeToNew(): Vector3;
  82437. /**
  82438. * Normalize the current Vector3 to the reference
  82439. * @param reference define the Vector3 to update
  82440. * @returns the updated Vector3
  82441. */
  82442. normalizeToRef(reference: Vector3): Vector3;
  82443. /**
  82444. * Creates a new Vector3 copied from the current Vector3
  82445. * @returns the new Vector3
  82446. */
  82447. clone(): Vector3;
  82448. /**
  82449. * Copies the given vector coordinates to the current Vector3 ones
  82450. * @param source defines the source Vector3
  82451. * @returns the current updated Vector3
  82452. */
  82453. copyFrom(source: DeepImmutable<Vector3>): Vector3;
  82454. /**
  82455. * Copies the given floats to the current Vector3 coordinates
  82456. * @param x defines the x coordinate of the operand
  82457. * @param y defines the y coordinate of the operand
  82458. * @param z defines the z coordinate of the operand
  82459. * @returns the current updated Vector3
  82460. */
  82461. copyFromFloats(x: number, y: number, z: number): Vector3;
  82462. /**
  82463. * Copies the given floats to the current Vector3 coordinates
  82464. * @param x defines the x coordinate of the operand
  82465. * @param y defines the y coordinate of the operand
  82466. * @param z defines the z coordinate of the operand
  82467. * @returns the current updated Vector3
  82468. */
  82469. set(x: number, y: number, z: number): Vector3;
  82470. /**
  82471. * Copies the given float to the current Vector3 coordinates
  82472. * @param v defines the x, y and z coordinates of the operand
  82473. * @returns the current updated Vector3
  82474. */
  82475. setAll(v: number): Vector3;
  82476. /**
  82477. * Get the clip factor between two vectors
  82478. * @param vector0 defines the first operand
  82479. * @param vector1 defines the second operand
  82480. * @param axis defines the axis to use
  82481. * @param size defines the size along the axis
  82482. * @returns the clip factor
  82483. */
  82484. static GetClipFactor(vector0: DeepImmutable<Vector3>, vector1: DeepImmutable<Vector3>, axis: DeepImmutable<Vector3>, size: number): number;
  82485. /**
  82486. * Get angle between two vectors
  82487. * @param vector0 angle between vector0 and vector1
  82488. * @param vector1 angle between vector0 and vector1
  82489. * @param normal direction of the normal
  82490. * @return the angle between vector0 and vector1
  82491. */
  82492. static GetAngleBetweenVectors(vector0: DeepImmutable<Vector3>, vector1: DeepImmutable<Vector3>, normal: DeepImmutable<Vector3>): number;
  82493. /**
  82494. * Returns a new Vector3 set from the index "offset" of the given array
  82495. * @param array defines the source array
  82496. * @param offset defines the offset in the source array
  82497. * @returns the new Vector3
  82498. */
  82499. static FromArray(array: DeepImmutable<ArrayLike<number>>, offset?: number): Vector3;
  82500. /**
  82501. * Returns a new Vector3 set from the index "offset" of the given Float32Array
  82502. * @param array defines the source array
  82503. * @param offset defines the offset in the source array
  82504. * @returns the new Vector3
  82505. * @deprecated Please use FromArray instead.
  82506. */
  82507. static FromFloatArray(array: DeepImmutable<Float32Array>, offset?: number): Vector3;
  82508. /**
  82509. * Sets the given vector "result" with the element values from the index "offset" of the given array
  82510. * @param array defines the source array
  82511. * @param offset defines the offset in the source array
  82512. * @param result defines the Vector3 where to store the result
  82513. */
  82514. static FromArrayToRef(array: DeepImmutable<ArrayLike<number>>, offset: number, result: Vector3): void;
  82515. /**
  82516. * Sets the given vector "result" with the element values from the index "offset" of the given Float32Array
  82517. * @param array defines the source array
  82518. * @param offset defines the offset in the source array
  82519. * @param result defines the Vector3 where to store the result
  82520. * @deprecated Please use FromArrayToRef instead.
  82521. */
  82522. static FromFloatArrayToRef(array: DeepImmutable<Float32Array>, offset: number, result: Vector3): void;
  82523. /**
  82524. * Sets the given vector "result" with the given floats.
  82525. * @param x defines the x coordinate of the source
  82526. * @param y defines the y coordinate of the source
  82527. * @param z defines the z coordinate of the source
  82528. * @param result defines the Vector3 where to store the result
  82529. */
  82530. static FromFloatsToRef(x: number, y: number, z: number, result: Vector3): void;
  82531. /**
  82532. * Returns a new Vector3 set to (0.0, 0.0, 0.0)
  82533. * @returns a new empty Vector3
  82534. */
  82535. static Zero(): Vector3;
  82536. /**
  82537. * Returns a new Vector3 set to (1.0, 1.0, 1.0)
  82538. * @returns a new unit Vector3
  82539. */
  82540. static One(): Vector3;
  82541. /**
  82542. * Returns a new Vector3 set to (0.0, 1.0, 0.0)
  82543. * @returns a new up Vector3
  82544. */
  82545. static Up(): Vector3;
  82546. /**
  82547. * Gets a up Vector3 that must not be updated
  82548. */
  82549. static get UpReadOnly(): DeepImmutable<Vector3>;
  82550. /**
  82551. * Gets a zero Vector3 that must not be updated
  82552. */
  82553. static get ZeroReadOnly(): DeepImmutable<Vector3>;
  82554. /**
  82555. * Returns a new Vector3 set to (0.0, -1.0, 0.0)
  82556. * @returns a new down Vector3
  82557. */
  82558. static Down(): Vector3;
  82559. /**
  82560. * Returns a new Vector3 set to (0.0, 0.0, 1.0)
  82561. * @param rightHandedSystem is the scene right-handed (negative z)
  82562. * @returns a new forward Vector3
  82563. */
  82564. static Forward(rightHandedSystem?: boolean): Vector3;
  82565. /**
  82566. * Returns a new Vector3 set to (0.0, 0.0, -1.0)
  82567. * @param rightHandedSystem is the scene right-handed (negative-z)
  82568. * @returns a new forward Vector3
  82569. */
  82570. static Backward(rightHandedSystem?: boolean): Vector3;
  82571. /**
  82572. * Returns a new Vector3 set to (1.0, 0.0, 0.0)
  82573. * @returns a new right Vector3
  82574. */
  82575. static Right(): Vector3;
  82576. /**
  82577. * Returns a new Vector3 set to (-1.0, 0.0, 0.0)
  82578. * @returns a new left Vector3
  82579. */
  82580. static Left(): Vector3;
  82581. /**
  82582. * Returns a new Vector3 set with the result of the transformation by the given matrix of the given vector.
  82583. * This method computes tranformed coordinates only, not transformed direction vectors (ie. it takes translation in account)
  82584. * @param vector defines the Vector3 to transform
  82585. * @param transformation defines the transformation matrix
  82586. * @returns the transformed Vector3
  82587. */
  82588. static TransformCoordinates(vector: DeepImmutable<Vector3>, transformation: DeepImmutable<Matrix>): Vector3;
  82589. /**
  82590. * Sets the given vector "result" coordinates with the result of the transformation by the given matrix of the given vector
  82591. * This method computes tranformed coordinates only, not transformed direction vectors (ie. it takes translation in account)
  82592. * @param vector defines the Vector3 to transform
  82593. * @param transformation defines the transformation matrix
  82594. * @param result defines the Vector3 where to store the result
  82595. */
  82596. static TransformCoordinatesToRef(vector: DeepImmutable<Vector3>, transformation: DeepImmutable<Matrix>, result: Vector3): void;
  82597. /**
  82598. * Sets the given vector "result" coordinates with the result of the transformation by the given matrix of the given floats (x, y, z)
  82599. * This method computes tranformed coordinates only, not transformed direction vectors
  82600. * @param x define the x coordinate of the source vector
  82601. * @param y define the y coordinate of the source vector
  82602. * @param z define the z coordinate of the source vector
  82603. * @param transformation defines the transformation matrix
  82604. * @param result defines the Vector3 where to store the result
  82605. */
  82606. static TransformCoordinatesFromFloatsToRef(x: number, y: number, z: number, transformation: DeepImmutable<Matrix>, result: Vector3): void;
  82607. /**
  82608. * Returns a new Vector3 set with the result of the normal transformation by the given matrix of the given vector
  82609. * This methods computes transformed normalized direction vectors only (ie. it does not apply translation)
  82610. * @param vector defines the Vector3 to transform
  82611. * @param transformation defines the transformation matrix
  82612. * @returns the new Vector3
  82613. */
  82614. static TransformNormal(vector: DeepImmutable<Vector3>, transformation: DeepImmutable<Matrix>): Vector3;
  82615. /**
  82616. * Sets the given vector "result" with the result of the normal transformation by the given matrix of the given vector
  82617. * This methods computes transformed normalized direction vectors only (ie. it does not apply translation)
  82618. * @param vector defines the Vector3 to transform
  82619. * @param transformation defines the transformation matrix
  82620. * @param result defines the Vector3 where to store the result
  82621. */
  82622. static TransformNormalToRef(vector: DeepImmutable<Vector3>, transformation: DeepImmutable<Matrix>, result: Vector3): void;
  82623. /**
  82624. * Sets the given vector "result" with the result of the normal transformation by the given matrix of the given floats (x, y, z)
  82625. * This methods computes transformed normalized direction vectors only (ie. it does not apply translation)
  82626. * @param x define the x coordinate of the source vector
  82627. * @param y define the y coordinate of the source vector
  82628. * @param z define the z coordinate of the source vector
  82629. * @param transformation defines the transformation matrix
  82630. * @param result defines the Vector3 where to store the result
  82631. */
  82632. static TransformNormalFromFloatsToRef(x: number, y: number, z: number, transformation: DeepImmutable<Matrix>, result: Vector3): void;
  82633. /**
  82634. * Returns a new Vector3 located for "amount" on the CatmullRom interpolation spline defined by the vectors "value1", "value2", "value3", "value4"
  82635. * @param value1 defines the first control point
  82636. * @param value2 defines the second control point
  82637. * @param value3 defines the third control point
  82638. * @param value4 defines the fourth control point
  82639. * @param amount defines the amount on the spline to use
  82640. * @returns the new Vector3
  82641. */
  82642. static CatmullRom(value1: DeepImmutable<Vector3>, value2: DeepImmutable<Vector3>, value3: DeepImmutable<Vector3>, value4: DeepImmutable<Vector3>, amount: number): Vector3;
  82643. /**
  82644. * 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"
  82645. * If a coordinate value of "value" is lower than one of the "min" coordinate, then this "value" coordinate is set with the "min" one
  82646. * If a coordinate value of "value" is greater than one of the "max" coordinate, then this "value" coordinate is set with the "max" one
  82647. * @param value defines the current value
  82648. * @param min defines the lower range value
  82649. * @param max defines the upper range value
  82650. * @returns the new Vector3
  82651. */
  82652. static Clamp(value: DeepImmutable<Vector3>, min: DeepImmutable<Vector3>, max: DeepImmutable<Vector3>): Vector3;
  82653. /**
  82654. * 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"
  82655. * If a coordinate value of "value" is lower than one of the "min" coordinate, then this "value" coordinate is set with the "min" one
  82656. * If a coordinate value of "value" is greater than one of the "max" coordinate, then this "value" coordinate is set with the "max" one
  82657. * @param value defines the current value
  82658. * @param min defines the lower range value
  82659. * @param max defines the upper range value
  82660. * @param result defines the Vector3 where to store the result
  82661. */
  82662. static ClampToRef(value: DeepImmutable<Vector3>, min: DeepImmutable<Vector3>, max: DeepImmutable<Vector3>, result: Vector3): void;
  82663. /**
  82664. * Checks if a given vector is inside a specific range
  82665. * @param v defines the vector to test
  82666. * @param min defines the minimum range
  82667. * @param max defines the maximum range
  82668. */
  82669. static CheckExtends(v: Vector3, min: Vector3, max: Vector3): void;
  82670. /**
  82671. * Returns a new Vector3 located for "amount" (float) on the Hermite interpolation spline defined by the vectors "value1", "tangent1", "value2", "tangent2"
  82672. * @param value1 defines the first control point
  82673. * @param tangent1 defines the first tangent vector
  82674. * @param value2 defines the second control point
  82675. * @param tangent2 defines the second tangent vector
  82676. * @param amount defines the amount on the interpolation spline (between 0 and 1)
  82677. * @returns the new Vector3
  82678. */
  82679. static Hermite(value1: DeepImmutable<Vector3>, tangent1: DeepImmutable<Vector3>, value2: DeepImmutable<Vector3>, tangent2: DeepImmutable<Vector3>, amount: number): Vector3;
  82680. /**
  82681. * Returns a new Vector3 located for "amount" (float) on the linear interpolation between the vectors "start" and "end"
  82682. * @param start defines the start value
  82683. * @param end defines the end value
  82684. * @param amount max defines amount between both (between 0 and 1)
  82685. * @returns the new Vector3
  82686. */
  82687. static Lerp(start: DeepImmutable<Vector3>, end: DeepImmutable<Vector3>, amount: number): Vector3;
  82688. /**
  82689. * Sets the given vector "result" with the result of the linear interpolation from the vector "start" for "amount" to the vector "end"
  82690. * @param start defines the start value
  82691. * @param end defines the end value
  82692. * @param amount max defines amount between both (between 0 and 1)
  82693. * @param result defines the Vector3 where to store the result
  82694. */
  82695. static LerpToRef(start: DeepImmutable<Vector3>, end: DeepImmutable<Vector3>, amount: number, result: Vector3): void;
  82696. /**
  82697. * Returns the dot product (float) between the vectors "left" and "right"
  82698. * @param left defines the left operand
  82699. * @param right defines the right operand
  82700. * @returns the dot product
  82701. */
  82702. static Dot(left: DeepImmutable<Vector3>, right: DeepImmutable<Vector3>): number;
  82703. /**
  82704. * Returns a new Vector3 as the cross product of the vectors "left" and "right"
  82705. * The cross product is then orthogonal to both "left" and "right"
  82706. * @param left defines the left operand
  82707. * @param right defines the right operand
  82708. * @returns the cross product
  82709. */
  82710. static Cross(left: DeepImmutable<Vector3>, right: DeepImmutable<Vector3>): Vector3;
  82711. /**
  82712. * Sets the given vector "result" with the cross product of "left" and "right"
  82713. * The cross product is then orthogonal to both "left" and "right"
  82714. * @param left defines the left operand
  82715. * @param right defines the right operand
  82716. * @param result defines the Vector3 where to store the result
  82717. */
  82718. static CrossToRef(left: DeepImmutable<Vector3>, right: DeepImmutable<Vector3>, result: Vector3): void;
  82719. /**
  82720. * Returns a new Vector3 as the normalization of the given vector
  82721. * @param vector defines the Vector3 to normalize
  82722. * @returns the new Vector3
  82723. */
  82724. static Normalize(vector: DeepImmutable<Vector3>): Vector3;
  82725. /**
  82726. * Sets the given vector "result" with the normalization of the given first vector
  82727. * @param vector defines the Vector3 to normalize
  82728. * @param result defines the Vector3 where to store the result
  82729. */
  82730. static NormalizeToRef(vector: DeepImmutable<Vector3>, result: Vector3): void;
  82731. /**
  82732. * Project a Vector3 onto screen space
  82733. * @param vector defines the Vector3 to project
  82734. * @param world defines the world matrix to use
  82735. * @param transform defines the transform (view x projection) matrix to use
  82736. * @param viewport defines the screen viewport to use
  82737. * @returns the new Vector3
  82738. */
  82739. static Project(vector: DeepImmutable<Vector3>, world: DeepImmutable<Matrix>, transform: DeepImmutable<Matrix>, viewport: DeepImmutable<Viewport>): Vector3;
  82740. /** @hidden */
  82741. static _UnprojectFromInvertedMatrixToRef(source: DeepImmutable<Vector3>, matrix: DeepImmutable<Matrix>, result: Vector3): void;
  82742. /**
  82743. * Unproject from screen space to object space
  82744. * @param source defines the screen space Vector3 to use
  82745. * @param viewportWidth defines the current width of the viewport
  82746. * @param viewportHeight defines the current height of the viewport
  82747. * @param world defines the world matrix to use (can be set to Identity to go to world space)
  82748. * @param transform defines the transform (view x projection) matrix to use
  82749. * @returns the new Vector3
  82750. */
  82751. static UnprojectFromTransform(source: Vector3, viewportWidth: number, viewportHeight: number, world: DeepImmutable<Matrix>, transform: DeepImmutable<Matrix>): Vector3;
  82752. /**
  82753. * Unproject from screen space to object space
  82754. * @param source defines the screen space Vector3 to use
  82755. * @param viewportWidth defines the current width of the viewport
  82756. * @param viewportHeight defines the current height of the viewport
  82757. * @param world defines the world matrix to use (can be set to Identity to go to world space)
  82758. * @param view defines the view matrix to use
  82759. * @param projection defines the projection matrix to use
  82760. * @returns the new Vector3
  82761. */
  82762. static Unproject(source: DeepImmutable<Vector3>, viewportWidth: number, viewportHeight: number, world: DeepImmutable<Matrix>, view: DeepImmutable<Matrix>, projection: DeepImmutable<Matrix>): Vector3;
  82763. /**
  82764. * Unproject from screen space to object space
  82765. * @param source defines the screen space Vector3 to use
  82766. * @param viewportWidth defines the current width of the viewport
  82767. * @param viewportHeight defines the current height of the viewport
  82768. * @param world defines the world matrix to use (can be set to Identity to go to world space)
  82769. * @param view defines the view matrix to use
  82770. * @param projection defines the projection matrix to use
  82771. * @param result defines the Vector3 where to store the result
  82772. */
  82773. static UnprojectToRef(source: DeepImmutable<Vector3>, viewportWidth: number, viewportHeight: number, world: DeepImmutable<Matrix>, view: DeepImmutable<Matrix>, projection: DeepImmutable<Matrix>, result: Vector3): void;
  82774. /**
  82775. * Unproject from screen space to object space
  82776. * @param sourceX defines the screen space x coordinate to use
  82777. * @param sourceY defines the screen space y coordinate to use
  82778. * @param sourceZ defines the screen space z coordinate to use
  82779. * @param viewportWidth defines the current width of the viewport
  82780. * @param viewportHeight defines the current height of the viewport
  82781. * @param world defines the world matrix to use (can be set to Identity to go to world space)
  82782. * @param view defines the view matrix to use
  82783. * @param projection defines the projection matrix to use
  82784. * @param result defines the Vector3 where to store the result
  82785. */
  82786. static UnprojectFloatsToRef(sourceX: float, sourceY: float, sourceZ: float, viewportWidth: number, viewportHeight: number, world: DeepImmutable<Matrix>, view: DeepImmutable<Matrix>, projection: DeepImmutable<Matrix>, result: Vector3): void;
  82787. /**
  82788. * Gets the minimal coordinate values between two Vector3
  82789. * @param left defines the first operand
  82790. * @param right defines the second operand
  82791. * @returns the new Vector3
  82792. */
  82793. static Minimize(left: DeepImmutable<Vector3>, right: DeepImmutable<Vector3>): Vector3;
  82794. /**
  82795. * Gets the maximal coordinate values between two Vector3
  82796. * @param left defines the first operand
  82797. * @param right defines the second operand
  82798. * @returns the new Vector3
  82799. */
  82800. static Maximize(left: DeepImmutable<Vector3>, right: DeepImmutable<Vector3>): Vector3;
  82801. /**
  82802. * Returns the distance between the vectors "value1" and "value2"
  82803. * @param value1 defines the first operand
  82804. * @param value2 defines the second operand
  82805. * @returns the distance
  82806. */
  82807. static Distance(value1: DeepImmutable<Vector3>, value2: DeepImmutable<Vector3>): number;
  82808. /**
  82809. * Returns the squared distance between the vectors "value1" and "value2"
  82810. * @param value1 defines the first operand
  82811. * @param value2 defines the second operand
  82812. * @returns the squared distance
  82813. */
  82814. static DistanceSquared(value1: DeepImmutable<Vector3>, value2: DeepImmutable<Vector3>): number;
  82815. /**
  82816. * Returns a new Vector3 located at the center between "value1" and "value2"
  82817. * @param value1 defines the first operand
  82818. * @param value2 defines the second operand
  82819. * @returns the new Vector3
  82820. */
  82821. static Center(value1: DeepImmutable<Vector3>, value2: DeepImmutable<Vector3>): Vector3;
  82822. /**
  82823. * Given three orthogonal normalized left-handed oriented Vector3 axis in space (target system),
  82824. * RotationFromAxis() returns the rotation Euler angles (ex : rotation.x, rotation.y, rotation.z) to apply
  82825. * to something in order to rotate it from its local system to the given target system
  82826. * Note: axis1, axis2 and axis3 are normalized during this operation
  82827. * @param axis1 defines the first axis
  82828. * @param axis2 defines the second axis
  82829. * @param axis3 defines the third axis
  82830. * @returns a new Vector3
  82831. */
  82832. static RotationFromAxis(axis1: DeepImmutable<Vector3>, axis2: DeepImmutable<Vector3>, axis3: DeepImmutable<Vector3>): Vector3;
  82833. /**
  82834. * The same than RotationFromAxis but updates the given ref Vector3 parameter instead of returning a new Vector3
  82835. * @param axis1 defines the first axis
  82836. * @param axis2 defines the second axis
  82837. * @param axis3 defines the third axis
  82838. * @param ref defines the Vector3 where to store the result
  82839. */
  82840. static RotationFromAxisToRef(axis1: DeepImmutable<Vector3>, axis2: DeepImmutable<Vector3>, axis3: DeepImmutable<Vector3>, ref: Vector3): void;
  82841. }
  82842. /**
  82843. * Vector4 class created for EulerAngle class conversion to Quaternion
  82844. */
  82845. export class Vector4 {
  82846. /** x value of the vector */
  82847. x: number;
  82848. /** y value of the vector */
  82849. y: number;
  82850. /** z value of the vector */
  82851. z: number;
  82852. /** w value of the vector */
  82853. w: number;
  82854. /**
  82855. * Creates a Vector4 object from the given floats.
  82856. * @param x x value of the vector
  82857. * @param y y value of the vector
  82858. * @param z z value of the vector
  82859. * @param w w value of the vector
  82860. */
  82861. constructor(
  82862. /** x value of the vector */
  82863. x: number,
  82864. /** y value of the vector */
  82865. y: number,
  82866. /** z value of the vector */
  82867. z: number,
  82868. /** w value of the vector */
  82869. w: number);
  82870. /**
  82871. * Returns the string with the Vector4 coordinates.
  82872. * @returns a string containing all the vector values
  82873. */
  82874. toString(): string;
  82875. /**
  82876. * Returns the string "Vector4".
  82877. * @returns "Vector4"
  82878. */
  82879. getClassName(): string;
  82880. /**
  82881. * Returns the Vector4 hash code.
  82882. * @returns a unique hash code
  82883. */
  82884. getHashCode(): number;
  82885. /**
  82886. * Returns a new array populated with 4 elements : the Vector4 coordinates.
  82887. * @returns the resulting array
  82888. */
  82889. asArray(): number[];
  82890. /**
  82891. * Populates the given array from the given index with the Vector4 coordinates.
  82892. * @param array array to populate
  82893. * @param index index of the array to start at (default: 0)
  82894. * @returns the Vector4.
  82895. */
  82896. toArray(array: FloatArray, index?: number): Vector4;
  82897. /**
  82898. * Update the current vector from an array
  82899. * @param array defines the destination array
  82900. * @param index defines the offset in the destination array
  82901. * @returns the current Vector3
  82902. */
  82903. fromArray(array: FloatArray, index?: number): Vector4;
  82904. /**
  82905. * Adds the given vector to the current Vector4.
  82906. * @param otherVector the vector to add
  82907. * @returns the updated Vector4.
  82908. */
  82909. addInPlace(otherVector: DeepImmutable<Vector4>): Vector4;
  82910. /**
  82911. * Returns a new Vector4 as the result of the addition of the current Vector4 and the given one.
  82912. * @param otherVector the vector to add
  82913. * @returns the resulting vector
  82914. */
  82915. add(otherVector: DeepImmutable<Vector4>): Vector4;
  82916. /**
  82917. * Updates the given vector "result" with the result of the addition of the current Vector4 and the given one.
  82918. * @param otherVector the vector to add
  82919. * @param result the vector to store the result
  82920. * @returns the current Vector4.
  82921. */
  82922. addToRef(otherVector: DeepImmutable<Vector4>, result: Vector4): Vector4;
  82923. /**
  82924. * Subtract in place the given vector from the current Vector4.
  82925. * @param otherVector the vector to subtract
  82926. * @returns the updated Vector4.
  82927. */
  82928. subtractInPlace(otherVector: DeepImmutable<Vector4>): Vector4;
  82929. /**
  82930. * Returns a new Vector4 with the result of the subtraction of the given vector from the current Vector4.
  82931. * @param otherVector the vector to add
  82932. * @returns the new vector with the result
  82933. */
  82934. subtract(otherVector: DeepImmutable<Vector4>): Vector4;
  82935. /**
  82936. * Sets the given vector "result" with the result of the subtraction of the given vector from the current Vector4.
  82937. * @param otherVector the vector to subtract
  82938. * @param result the vector to store the result
  82939. * @returns the current Vector4.
  82940. */
  82941. subtractToRef(otherVector: DeepImmutable<Vector4>, result: Vector4): Vector4;
  82942. /**
  82943. * Returns a new Vector4 set with the result of the subtraction of the given floats from the current Vector4 coordinates.
  82944. */
  82945. /**
  82946. * Returns a new Vector4 set with the result of the subtraction of the given floats from the current Vector4 coordinates.
  82947. * @param x value to subtract
  82948. * @param y value to subtract
  82949. * @param z value to subtract
  82950. * @param w value to subtract
  82951. * @returns new vector containing the result
  82952. */
  82953. subtractFromFloats(x: number, y: number, z: number, w: number): Vector4;
  82954. /**
  82955. * Sets the given vector "result" set with the result of the subtraction of the given floats from the current Vector4 coordinates.
  82956. * @param x value to subtract
  82957. * @param y value to subtract
  82958. * @param z value to subtract
  82959. * @param w value to subtract
  82960. * @param result the vector to store the result in
  82961. * @returns the current Vector4.
  82962. */
  82963. subtractFromFloatsToRef(x: number, y: number, z: number, w: number, result: Vector4): Vector4;
  82964. /**
  82965. * Returns a new Vector4 set with the current Vector4 negated coordinates.
  82966. * @returns a new vector with the negated values
  82967. */
  82968. negate(): Vector4;
  82969. /**
  82970. * Negate this vector in place
  82971. * @returns this
  82972. */
  82973. negateInPlace(): Vector4;
  82974. /**
  82975. * Negate the current Vector4 and stores the result in the given vector "result" coordinates
  82976. * @param result defines the Vector3 object where to store the result
  82977. * @returns the current Vector4
  82978. */
  82979. negateToRef(result: Vector4): Vector4;
  82980. /**
  82981. * Multiplies the current Vector4 coordinates by scale (float).
  82982. * @param scale the number to scale with
  82983. * @returns the updated Vector4.
  82984. */
  82985. scaleInPlace(scale: number): Vector4;
  82986. /**
  82987. * Returns a new Vector4 set with the current Vector4 coordinates multiplied by scale (float).
  82988. * @param scale the number to scale with
  82989. * @returns a new vector with the result
  82990. */
  82991. scale(scale: number): Vector4;
  82992. /**
  82993. * Sets the given vector "result" with the current Vector4 coordinates multiplied by scale (float).
  82994. * @param scale the number to scale with
  82995. * @param result a vector to store the result in
  82996. * @returns the current Vector4.
  82997. */
  82998. scaleToRef(scale: number, result: Vector4): Vector4;
  82999. /**
  83000. * Scale the current Vector4 values by a factor and add the result to a given Vector4
  83001. * @param scale defines the scale factor
  83002. * @param result defines the Vector4 object where to store the result
  83003. * @returns the unmodified current Vector4
  83004. */
  83005. scaleAndAddToRef(scale: number, result: Vector4): Vector4;
  83006. /**
  83007. * Boolean : True if the current Vector4 coordinates are stricly equal to the given ones.
  83008. * @param otherVector the vector to compare against
  83009. * @returns true if they are equal
  83010. */
  83011. equals(otherVector: DeepImmutable<Vector4>): boolean;
  83012. /**
  83013. * Boolean : True if the current Vector4 coordinates are each beneath the distance "epsilon" from the given vector ones.
  83014. * @param otherVector vector to compare against
  83015. * @param epsilon (Default: very small number)
  83016. * @returns true if they are equal
  83017. */
  83018. equalsWithEpsilon(otherVector: DeepImmutable<Vector4>, epsilon?: number): boolean;
  83019. /**
  83020. * Boolean : True if the given floats are strictly equal to the current Vector4 coordinates.
  83021. * @param x x value to compare against
  83022. * @param y y value to compare against
  83023. * @param z z value to compare against
  83024. * @param w w value to compare against
  83025. * @returns true if equal
  83026. */
  83027. equalsToFloats(x: number, y: number, z: number, w: number): boolean;
  83028. /**
  83029. * Multiplies in place the current Vector4 by the given one.
  83030. * @param otherVector vector to multiple with
  83031. * @returns the updated Vector4.
  83032. */
  83033. multiplyInPlace(otherVector: Vector4): Vector4;
  83034. /**
  83035. * Returns a new Vector4 set with the multiplication result of the current Vector4 and the given one.
  83036. * @param otherVector vector to multiple with
  83037. * @returns resulting new vector
  83038. */
  83039. multiply(otherVector: DeepImmutable<Vector4>): Vector4;
  83040. /**
  83041. * Updates the given vector "result" with the multiplication result of the current Vector4 and the given one.
  83042. * @param otherVector vector to multiple with
  83043. * @param result vector to store the result
  83044. * @returns the current Vector4.
  83045. */
  83046. multiplyToRef(otherVector: DeepImmutable<Vector4>, result: Vector4): Vector4;
  83047. /**
  83048. * Returns a new Vector4 set with the multiplication result of the given floats and the current Vector4 coordinates.
  83049. * @param x x value multiply with
  83050. * @param y y value multiply with
  83051. * @param z z value multiply with
  83052. * @param w w value multiply with
  83053. * @returns resulting new vector
  83054. */
  83055. multiplyByFloats(x: number, y: number, z: number, w: number): Vector4;
  83056. /**
  83057. * Returns a new Vector4 set with the division result of the current Vector4 by the given one.
  83058. * @param otherVector vector to devide with
  83059. * @returns resulting new vector
  83060. */
  83061. divide(otherVector: DeepImmutable<Vector4>): Vector4;
  83062. /**
  83063. * Updates the given vector "result" with the division result of the current Vector4 by the given one.
  83064. * @param otherVector vector to devide with
  83065. * @param result vector to store the result
  83066. * @returns the current Vector4.
  83067. */
  83068. divideToRef(otherVector: DeepImmutable<Vector4>, result: Vector4): Vector4;
  83069. /**
  83070. * Divides the current Vector3 coordinates by the given ones.
  83071. * @param otherVector vector to devide with
  83072. * @returns the updated Vector3.
  83073. */
  83074. divideInPlace(otherVector: DeepImmutable<Vector4>): Vector4;
  83075. /**
  83076. * Updates the Vector4 coordinates with the minimum values between its own and the given vector ones
  83077. * @param other defines the second operand
  83078. * @returns the current updated Vector4
  83079. */
  83080. minimizeInPlace(other: DeepImmutable<Vector4>): Vector4;
  83081. /**
  83082. * Updates the Vector4 coordinates with the maximum values between its own and the given vector ones
  83083. * @param other defines the second operand
  83084. * @returns the current updated Vector4
  83085. */
  83086. maximizeInPlace(other: DeepImmutable<Vector4>): Vector4;
  83087. /**
  83088. * Gets a new Vector4 from current Vector4 floored values
  83089. * @returns a new Vector4
  83090. */
  83091. floor(): Vector4;
  83092. /**
  83093. * Gets a new Vector4 from current Vector3 floored values
  83094. * @returns a new Vector4
  83095. */
  83096. fract(): Vector4;
  83097. /**
  83098. * Returns the Vector4 length (float).
  83099. * @returns the length
  83100. */
  83101. length(): number;
  83102. /**
  83103. * Returns the Vector4 squared length (float).
  83104. * @returns the length squared
  83105. */
  83106. lengthSquared(): number;
  83107. /**
  83108. * Normalizes in place the Vector4.
  83109. * @returns the updated Vector4.
  83110. */
  83111. normalize(): Vector4;
  83112. /**
  83113. * Returns a new Vector3 from the Vector4 (x, y, z) coordinates.
  83114. * @returns this converted to a new vector3
  83115. */
  83116. toVector3(): Vector3;
  83117. /**
  83118. * Returns a new Vector4 copied from the current one.
  83119. * @returns the new cloned vector
  83120. */
  83121. clone(): Vector4;
  83122. /**
  83123. * Updates the current Vector4 with the given one coordinates.
  83124. * @param source the source vector to copy from
  83125. * @returns the updated Vector4.
  83126. */
  83127. copyFrom(source: DeepImmutable<Vector4>): Vector4;
  83128. /**
  83129. * Updates the current Vector4 coordinates with the given floats.
  83130. * @param x float to copy from
  83131. * @param y float to copy from
  83132. * @param z float to copy from
  83133. * @param w float to copy from
  83134. * @returns the updated Vector4.
  83135. */
  83136. copyFromFloats(x: number, y: number, z: number, w: number): Vector4;
  83137. /**
  83138. * Updates the current Vector4 coordinates with the given floats.
  83139. * @param x float to set from
  83140. * @param y float to set from
  83141. * @param z float to set from
  83142. * @param w float to set from
  83143. * @returns the updated Vector4.
  83144. */
  83145. set(x: number, y: number, z: number, w: number): Vector4;
  83146. /**
  83147. * Copies the given float to the current Vector3 coordinates
  83148. * @param v defines the x, y, z and w coordinates of the operand
  83149. * @returns the current updated Vector3
  83150. */
  83151. setAll(v: number): Vector4;
  83152. /**
  83153. * Returns a new Vector4 set from the starting index of the given array.
  83154. * @param array the array to pull values from
  83155. * @param offset the offset into the array to start at
  83156. * @returns the new vector
  83157. */
  83158. static FromArray(array: DeepImmutable<ArrayLike<number>>, offset?: number): Vector4;
  83159. /**
  83160. * Updates the given vector "result" from the starting index of the given array.
  83161. * @param array the array to pull values from
  83162. * @param offset the offset into the array to start at
  83163. * @param result the vector to store the result in
  83164. */
  83165. static FromArrayToRef(array: DeepImmutable<ArrayLike<number>>, offset: number, result: Vector4): void;
  83166. /**
  83167. * Updates the given vector "result" from the starting index of the given Float32Array.
  83168. * @param array the array to pull values from
  83169. * @param offset the offset into the array to start at
  83170. * @param result the vector to store the result in
  83171. */
  83172. static FromFloatArrayToRef(array: DeepImmutable<Float32Array>, offset: number, result: Vector4): void;
  83173. /**
  83174. * Updates the given vector "result" coordinates from the given floats.
  83175. * @param x float to set from
  83176. * @param y float to set from
  83177. * @param z float to set from
  83178. * @param w float to set from
  83179. * @param result the vector to the floats in
  83180. */
  83181. static FromFloatsToRef(x: number, y: number, z: number, w: number, result: Vector4): void;
  83182. /**
  83183. * Returns a new Vector4 set to (0.0, 0.0, 0.0, 0.0)
  83184. * @returns the new vector
  83185. */
  83186. static Zero(): Vector4;
  83187. /**
  83188. * Returns a new Vector4 set to (1.0, 1.0, 1.0, 1.0)
  83189. * @returns the new vector
  83190. */
  83191. static One(): Vector4;
  83192. /**
  83193. * Returns a new normalized Vector4 from the given one.
  83194. * @param vector the vector to normalize
  83195. * @returns the vector
  83196. */
  83197. static Normalize(vector: DeepImmutable<Vector4>): Vector4;
  83198. /**
  83199. * Updates the given vector "result" from the normalization of the given one.
  83200. * @param vector the vector to normalize
  83201. * @param result the vector to store the result in
  83202. */
  83203. static NormalizeToRef(vector: DeepImmutable<Vector4>, result: Vector4): void;
  83204. /**
  83205. * Returns a vector with the minimum values from the left and right vectors
  83206. * @param left left vector to minimize
  83207. * @param right right vector to minimize
  83208. * @returns a new vector with the minimum of the left and right vector values
  83209. */
  83210. static Minimize(left: DeepImmutable<Vector4>, right: DeepImmutable<Vector4>): Vector4;
  83211. /**
  83212. * Returns a vector with the maximum values from the left and right vectors
  83213. * @param left left vector to maximize
  83214. * @param right right vector to maximize
  83215. * @returns a new vector with the maximum of the left and right vector values
  83216. */
  83217. static Maximize(left: DeepImmutable<Vector4>, right: DeepImmutable<Vector4>): Vector4;
  83218. /**
  83219. * Returns the distance (float) between the vectors "value1" and "value2".
  83220. * @param value1 value to calulate the distance between
  83221. * @param value2 value to calulate the distance between
  83222. * @return the distance between the two vectors
  83223. */
  83224. static Distance(value1: DeepImmutable<Vector4>, value2: DeepImmutable<Vector4>): number;
  83225. /**
  83226. * Returns the squared distance (float) between the vectors "value1" and "value2".
  83227. * @param value1 value to calulate the distance between
  83228. * @param value2 value to calulate the distance between
  83229. * @return the distance between the two vectors squared
  83230. */
  83231. static DistanceSquared(value1: DeepImmutable<Vector4>, value2: DeepImmutable<Vector4>): number;
  83232. /**
  83233. * Returns a new Vector4 located at the center between the vectors "value1" and "value2".
  83234. * @param value1 value to calulate the center between
  83235. * @param value2 value to calulate the center between
  83236. * @return the center between the two vectors
  83237. */
  83238. static Center(value1: DeepImmutable<Vector4>, value2: DeepImmutable<Vector4>): Vector4;
  83239. /**
  83240. * Returns a new Vector4 set with the result of the normal transformation by the given matrix of the given vector.
  83241. * This methods computes transformed normalized direction vectors only.
  83242. * @param vector the vector to transform
  83243. * @param transformation the transformation matrix to apply
  83244. * @returns the new vector
  83245. */
  83246. static TransformNormal(vector: DeepImmutable<Vector4>, transformation: DeepImmutable<Matrix>): Vector4;
  83247. /**
  83248. * Sets the given vector "result" with the result of the normal transformation by the given matrix of the given vector.
  83249. * This methods computes transformed normalized direction vectors only.
  83250. * @param vector the vector to transform
  83251. * @param transformation the transformation matrix to apply
  83252. * @param result the vector to store the result in
  83253. */
  83254. static TransformNormalToRef(vector: DeepImmutable<Vector4>, transformation: DeepImmutable<Matrix>, result: Vector4): void;
  83255. /**
  83256. * Sets the given vector "result" with the result of the normal transformation by the given matrix of the given floats (x, y, z, w).
  83257. * This methods computes transformed normalized direction vectors only.
  83258. * @param x value to transform
  83259. * @param y value to transform
  83260. * @param z value to transform
  83261. * @param w value to transform
  83262. * @param transformation the transformation matrix to apply
  83263. * @param result the vector to store the results in
  83264. */
  83265. static TransformNormalFromFloatsToRef(x: number, y: number, z: number, w: number, transformation: DeepImmutable<Matrix>, result: Vector4): void;
  83266. /**
  83267. * Creates a new Vector4 from a Vector3
  83268. * @param source defines the source data
  83269. * @param w defines the 4th component (default is 0)
  83270. * @returns a new Vector4
  83271. */
  83272. static FromVector3(source: Vector3, w?: number): Vector4;
  83273. }
  83274. /**
  83275. * Class used to store quaternion data
  83276. * @see https://en.wikipedia.org/wiki/Quaternion
  83277. * @see https://doc.babylonjs.com/features/position,_rotation,_scaling
  83278. */
  83279. export class Quaternion {
  83280. /** @hidden */
  83281. _x: number;
  83282. /** @hidden */
  83283. _y: number;
  83284. /** @hidden */
  83285. _z: number;
  83286. /** @hidden */
  83287. _w: number;
  83288. /** @hidden */
  83289. _isDirty: boolean;
  83290. /** Gets or sets the x coordinate */
  83291. get x(): number;
  83292. set x(value: number);
  83293. /** Gets or sets the y coordinate */
  83294. get y(): number;
  83295. set y(value: number);
  83296. /** Gets or sets the z coordinate */
  83297. get z(): number;
  83298. set z(value: number);
  83299. /** Gets or sets the w coordinate */
  83300. get w(): number;
  83301. set w(value: number);
  83302. /**
  83303. * Creates a new Quaternion from the given floats
  83304. * @param x defines the first component (0 by default)
  83305. * @param y defines the second component (0 by default)
  83306. * @param z defines the third component (0 by default)
  83307. * @param w defines the fourth component (1.0 by default)
  83308. */
  83309. constructor(x?: number, y?: number, z?: number, w?: number);
  83310. /**
  83311. * Gets a string representation for the current quaternion
  83312. * @returns a string with the Quaternion coordinates
  83313. */
  83314. toString(): string;
  83315. /**
  83316. * Gets the class name of the quaternion
  83317. * @returns the string "Quaternion"
  83318. */
  83319. getClassName(): string;
  83320. /**
  83321. * Gets a hash code for this quaternion
  83322. * @returns the quaternion hash code
  83323. */
  83324. getHashCode(): number;
  83325. /**
  83326. * Copy the quaternion to an array
  83327. * @returns a new array populated with 4 elements from the quaternion coordinates
  83328. */
  83329. asArray(): number[];
  83330. /**
  83331. * Check if two quaternions are equals
  83332. * @param otherQuaternion defines the second operand
  83333. * @return true if the current quaternion and the given one coordinates are strictly equals
  83334. */
  83335. equals(otherQuaternion: DeepImmutable<Quaternion>): boolean;
  83336. /**
  83337. * Gets a boolean if two quaternions are equals (using an epsilon value)
  83338. * @param otherQuaternion defines the other quaternion
  83339. * @param epsilon defines the minimal distance to consider equality
  83340. * @returns true if the given quaternion coordinates are close to the current ones by a distance of epsilon.
  83341. */
  83342. equalsWithEpsilon(otherQuaternion: DeepImmutable<Quaternion>, epsilon?: number): boolean;
  83343. /**
  83344. * Clone the current quaternion
  83345. * @returns a new quaternion copied from the current one
  83346. */
  83347. clone(): Quaternion;
  83348. /**
  83349. * Copy a quaternion to the current one
  83350. * @param other defines the other quaternion
  83351. * @returns the updated current quaternion
  83352. */
  83353. copyFrom(other: DeepImmutable<Quaternion>): Quaternion;
  83354. /**
  83355. * Updates the current quaternion with the given float coordinates
  83356. * @param x defines the x coordinate
  83357. * @param y defines the y coordinate
  83358. * @param z defines the z coordinate
  83359. * @param w defines the w coordinate
  83360. * @returns the updated current quaternion
  83361. */
  83362. copyFromFloats(x: number, y: number, z: number, w: number): Quaternion;
  83363. /**
  83364. * Updates the current quaternion from the given float coordinates
  83365. * @param x defines the x coordinate
  83366. * @param y defines the y coordinate
  83367. * @param z defines the z coordinate
  83368. * @param w defines the w coordinate
  83369. * @returns the updated current quaternion
  83370. */
  83371. set(x: number, y: number, z: number, w: number): Quaternion;
  83372. /**
  83373. * Adds two quaternions
  83374. * @param other defines the second operand
  83375. * @returns a new quaternion as the addition result of the given one and the current quaternion
  83376. */
  83377. add(other: DeepImmutable<Quaternion>): Quaternion;
  83378. /**
  83379. * Add a quaternion to the current one
  83380. * @param other defines the quaternion to add
  83381. * @returns the current quaternion
  83382. */
  83383. addInPlace(other: DeepImmutable<Quaternion>): Quaternion;
  83384. /**
  83385. * Subtract two quaternions
  83386. * @param other defines the second operand
  83387. * @returns a new quaternion as the subtraction result of the given one from the current one
  83388. */
  83389. subtract(other: Quaternion): Quaternion;
  83390. /**
  83391. * Multiplies the current quaternion by a scale factor
  83392. * @param value defines the scale factor
  83393. * @returns a new quaternion set by multiplying the current quaternion coordinates by the float "scale"
  83394. */
  83395. scale(value: number): Quaternion;
  83396. /**
  83397. * Scale the current quaternion values by a factor and stores the result to a given quaternion
  83398. * @param scale defines the scale factor
  83399. * @param result defines the Quaternion object where to store the result
  83400. * @returns the unmodified current quaternion
  83401. */
  83402. scaleToRef(scale: number, result: Quaternion): Quaternion;
  83403. /**
  83404. * Multiplies in place the current quaternion by a scale factor
  83405. * @param value defines the scale factor
  83406. * @returns the current modified quaternion
  83407. */
  83408. scaleInPlace(value: number): Quaternion;
  83409. /**
  83410. * Scale the current quaternion values by a factor and add the result to a given quaternion
  83411. * @param scale defines the scale factor
  83412. * @param result defines the Quaternion object where to store the result
  83413. * @returns the unmodified current quaternion
  83414. */
  83415. scaleAndAddToRef(scale: number, result: Quaternion): Quaternion;
  83416. /**
  83417. * Multiplies two quaternions
  83418. * @param q1 defines the second operand
  83419. * @returns a new quaternion set as the multiplication result of the current one with the given one "q1"
  83420. */
  83421. multiply(q1: DeepImmutable<Quaternion>): Quaternion;
  83422. /**
  83423. * Sets the given "result" as the the multiplication result of the current one with the given one "q1"
  83424. * @param q1 defines the second operand
  83425. * @param result defines the target quaternion
  83426. * @returns the current quaternion
  83427. */
  83428. multiplyToRef(q1: DeepImmutable<Quaternion>, result: Quaternion): Quaternion;
  83429. /**
  83430. * Updates the current quaternion with the multiplication of itself with the given one "q1"
  83431. * @param q1 defines the second operand
  83432. * @returns the currentupdated quaternion
  83433. */
  83434. multiplyInPlace(q1: DeepImmutable<Quaternion>): Quaternion;
  83435. /**
  83436. * Conjugates (1-q) the current quaternion and stores the result in the given quaternion
  83437. * @param ref defines the target quaternion
  83438. * @returns the current quaternion
  83439. */
  83440. conjugateToRef(ref: Quaternion): Quaternion;
  83441. /**
  83442. * Conjugates in place (1-q) the current quaternion
  83443. * @returns the current updated quaternion
  83444. */
  83445. conjugateInPlace(): Quaternion;
  83446. /**
  83447. * Conjugates in place (1-q) the current quaternion
  83448. * @returns a new quaternion
  83449. */
  83450. conjugate(): Quaternion;
  83451. /**
  83452. * Gets length of current quaternion
  83453. * @returns the quaternion length (float)
  83454. */
  83455. length(): number;
  83456. /**
  83457. * Normalize in place the current quaternion
  83458. * @returns the current updated quaternion
  83459. */
  83460. normalize(): Quaternion;
  83461. /**
  83462. * Returns a new Vector3 set with the Euler angles translated from the current quaternion
  83463. * @param order is a reserved parameter and is ignore for now
  83464. * @returns a new Vector3 containing the Euler angles
  83465. */
  83466. toEulerAngles(order?: string): Vector3;
  83467. /**
  83468. * Sets the given vector3 "result" with the Euler angles translated from the current quaternion
  83469. * @param result defines the vector which will be filled with the Euler angles
  83470. * @param order is a reserved parameter and is ignore for now
  83471. * @returns the current unchanged quaternion
  83472. */
  83473. toEulerAnglesToRef(result: Vector3): Quaternion;
  83474. /**
  83475. * Updates the given rotation matrix with the current quaternion values
  83476. * @param result defines the target matrix
  83477. * @returns the current unchanged quaternion
  83478. */
  83479. toRotationMatrix(result: Matrix): Quaternion;
  83480. /**
  83481. * Updates the current quaternion from the given rotation matrix values
  83482. * @param matrix defines the source matrix
  83483. * @returns the current updated quaternion
  83484. */
  83485. fromRotationMatrix(matrix: DeepImmutable<Matrix>): Quaternion;
  83486. /**
  83487. * Creates a new quaternion from a rotation matrix
  83488. * @param matrix defines the source matrix
  83489. * @returns a new quaternion created from the given rotation matrix values
  83490. */
  83491. static FromRotationMatrix(matrix: DeepImmutable<Matrix>): Quaternion;
  83492. /**
  83493. * Updates the given quaternion with the given rotation matrix values
  83494. * @param matrix defines the source matrix
  83495. * @param result defines the target quaternion
  83496. */
  83497. static FromRotationMatrixToRef(matrix: DeepImmutable<Matrix>, result: Quaternion): void;
  83498. /**
  83499. * Returns the dot product (float) between the quaternions "left" and "right"
  83500. * @param left defines the left operand
  83501. * @param right defines the right operand
  83502. * @returns the dot product
  83503. */
  83504. static Dot(left: DeepImmutable<Quaternion>, right: DeepImmutable<Quaternion>): number;
  83505. /**
  83506. * Checks if the two quaternions are close to each other
  83507. * @param quat0 defines the first quaternion to check
  83508. * @param quat1 defines the second quaternion to check
  83509. * @returns true if the two quaternions are close to each other
  83510. */
  83511. static AreClose(quat0: DeepImmutable<Quaternion>, quat1: DeepImmutable<Quaternion>): boolean;
  83512. /**
  83513. * Creates an empty quaternion
  83514. * @returns a new quaternion set to (0.0, 0.0, 0.0)
  83515. */
  83516. static Zero(): Quaternion;
  83517. /**
  83518. * Inverse a given quaternion
  83519. * @param q defines the source quaternion
  83520. * @returns a new quaternion as the inverted current quaternion
  83521. */
  83522. static Inverse(q: DeepImmutable<Quaternion>): Quaternion;
  83523. /**
  83524. * Inverse a given quaternion
  83525. * @param q defines the source quaternion
  83526. * @param result the quaternion the result will be stored in
  83527. * @returns the result quaternion
  83528. */
  83529. static InverseToRef(q: Quaternion, result: Quaternion): Quaternion;
  83530. /**
  83531. * Creates an identity quaternion
  83532. * @returns the identity quaternion
  83533. */
  83534. static Identity(): Quaternion;
  83535. /**
  83536. * Gets a boolean indicating if the given quaternion is identity
  83537. * @param quaternion defines the quaternion to check
  83538. * @returns true if the quaternion is identity
  83539. */
  83540. static IsIdentity(quaternion: DeepImmutable<Quaternion>): boolean;
  83541. /**
  83542. * Creates a quaternion from a rotation around an axis
  83543. * @param axis defines the axis to use
  83544. * @param angle defines the angle to use
  83545. * @returns a new quaternion created from the given axis (Vector3) and angle in radians (float)
  83546. */
  83547. static RotationAxis(axis: DeepImmutable<Vector3>, angle: number): Quaternion;
  83548. /**
  83549. * Creates a rotation around an axis and stores it into the given quaternion
  83550. * @param axis defines the axis to use
  83551. * @param angle defines the angle to use
  83552. * @param result defines the target quaternion
  83553. * @returns the target quaternion
  83554. */
  83555. static RotationAxisToRef(axis: DeepImmutable<Vector3>, angle: number, result: Quaternion): Quaternion;
  83556. /**
  83557. * Creates a new quaternion from data stored into an array
  83558. * @param array defines the data source
  83559. * @param offset defines the offset in the source array where the data starts
  83560. * @returns a new quaternion
  83561. */
  83562. static FromArray(array: DeepImmutable<ArrayLike<number>>, offset?: number): Quaternion;
  83563. /**
  83564. * Updates the given quaternion "result" from the starting index of the given array.
  83565. * @param array the array to pull values from
  83566. * @param offset the offset into the array to start at
  83567. * @param result the quaternion to store the result in
  83568. */
  83569. static FromArrayToRef(array: DeepImmutable<ArrayLike<number>>, offset: number, result: Quaternion): void;
  83570. /**
  83571. * Create a quaternion from Euler rotation angles
  83572. * @param x Pitch
  83573. * @param y Yaw
  83574. * @param z Roll
  83575. * @returns the new Quaternion
  83576. */
  83577. static FromEulerAngles(x: number, y: number, z: number): Quaternion;
  83578. /**
  83579. * Updates a quaternion from Euler rotation angles
  83580. * @param x Pitch
  83581. * @param y Yaw
  83582. * @param z Roll
  83583. * @param result the quaternion to store the result
  83584. * @returns the updated quaternion
  83585. */
  83586. static FromEulerAnglesToRef(x: number, y: number, z: number, result: Quaternion): Quaternion;
  83587. /**
  83588. * Create a quaternion from Euler rotation vector
  83589. * @param vec the Euler vector (x Pitch, y Yaw, z Roll)
  83590. * @returns the new Quaternion
  83591. */
  83592. static FromEulerVector(vec: DeepImmutable<Vector3>): Quaternion;
  83593. /**
  83594. * Updates a quaternion from Euler rotation vector
  83595. * @param vec the Euler vector (x Pitch, y Yaw, z Roll)
  83596. * @param result the quaternion to store the result
  83597. * @returns the updated quaternion
  83598. */
  83599. static FromEulerVectorToRef(vec: DeepImmutable<Vector3>, result: Quaternion): Quaternion;
  83600. /**
  83601. * Creates a new quaternion from the given Euler float angles (y, x, z)
  83602. * @param yaw defines the rotation around Y axis
  83603. * @param pitch defines the rotation around X axis
  83604. * @param roll defines the rotation around Z axis
  83605. * @returns the new quaternion
  83606. */
  83607. static RotationYawPitchRoll(yaw: number, pitch: number, roll: number): Quaternion;
  83608. /**
  83609. * Creates a new rotation from the given Euler float angles (y, x, z) and stores it in the target quaternion
  83610. * @param yaw defines the rotation around Y axis
  83611. * @param pitch defines the rotation around X axis
  83612. * @param roll defines the rotation around Z axis
  83613. * @param result defines the target quaternion
  83614. */
  83615. static RotationYawPitchRollToRef(yaw: number, pitch: number, roll: number, result: Quaternion): void;
  83616. /**
  83617. * Creates a new quaternion from the given Euler float angles expressed in z-x-z orientation
  83618. * @param alpha defines the rotation around first axis
  83619. * @param beta defines the rotation around second axis
  83620. * @param gamma defines the rotation around third axis
  83621. * @returns the new quaternion
  83622. */
  83623. static RotationAlphaBetaGamma(alpha: number, beta: number, gamma: number): Quaternion;
  83624. /**
  83625. * Creates a new quaternion from the given Euler float angles expressed in z-x-z orientation and stores it in the target quaternion
  83626. * @param alpha defines the rotation around first axis
  83627. * @param beta defines the rotation around second axis
  83628. * @param gamma defines the rotation around third axis
  83629. * @param result defines the target quaternion
  83630. */
  83631. static RotationAlphaBetaGammaToRef(alpha: number, beta: number, gamma: number, result: Quaternion): void;
  83632. /**
  83633. * 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)
  83634. * @param axis1 defines the first axis
  83635. * @param axis2 defines the second axis
  83636. * @param axis3 defines the third axis
  83637. * @returns the new quaternion
  83638. */
  83639. static RotationQuaternionFromAxis(axis1: DeepImmutable<Vector3>, axis2: DeepImmutable<Vector3>, axis3: DeepImmutable<Vector3>): Quaternion;
  83640. /**
  83641. * 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
  83642. * @param axis1 defines the first axis
  83643. * @param axis2 defines the second axis
  83644. * @param axis3 defines the third axis
  83645. * @param ref defines the target quaternion
  83646. */
  83647. static RotationQuaternionFromAxisToRef(axis1: DeepImmutable<Vector3>, axis2: DeepImmutable<Vector3>, axis3: DeepImmutable<Vector3>, ref: Quaternion): void;
  83648. /**
  83649. * Interpolates between two quaternions
  83650. * @param left defines first quaternion
  83651. * @param right defines second quaternion
  83652. * @param amount defines the gradient to use
  83653. * @returns the new interpolated quaternion
  83654. */
  83655. static Slerp(left: DeepImmutable<Quaternion>, right: DeepImmutable<Quaternion>, amount: number): Quaternion;
  83656. /**
  83657. * Interpolates between two quaternions and stores it into a target quaternion
  83658. * @param left defines first quaternion
  83659. * @param right defines second quaternion
  83660. * @param amount defines the gradient to use
  83661. * @param result defines the target quaternion
  83662. */
  83663. static SlerpToRef(left: DeepImmutable<Quaternion>, right: DeepImmutable<Quaternion>, amount: number, result: Quaternion): void;
  83664. /**
  83665. * Interpolate between two quaternions using Hermite interpolation
  83666. * @param value1 defines first quaternion
  83667. * @param tangent1 defines the incoming tangent
  83668. * @param value2 defines second quaternion
  83669. * @param tangent2 defines the outgoing tangent
  83670. * @param amount defines the target quaternion
  83671. * @returns the new interpolated quaternion
  83672. */
  83673. static Hermite(value1: DeepImmutable<Quaternion>, tangent1: DeepImmutable<Quaternion>, value2: DeepImmutable<Quaternion>, tangent2: DeepImmutable<Quaternion>, amount: number): Quaternion;
  83674. }
  83675. /**
  83676. * Class used to store matrix data (4x4)
  83677. */
  83678. export class Matrix {
  83679. /**
  83680. * Gets the precision of matrix computations
  83681. */
  83682. static get Use64Bits(): boolean;
  83683. private static _updateFlagSeed;
  83684. private static _identityReadOnly;
  83685. private _isIdentity;
  83686. private _isIdentityDirty;
  83687. private _isIdentity3x2;
  83688. private _isIdentity3x2Dirty;
  83689. /**
  83690. * Gets the update flag of the matrix which is an unique number for the matrix.
  83691. * It will be incremented every time the matrix data change.
  83692. * You can use it to speed the comparison between two versions of the same matrix.
  83693. */
  83694. updateFlag: number;
  83695. private readonly _m;
  83696. /**
  83697. * Gets the internal data of the matrix
  83698. */
  83699. get m(): DeepImmutable<Float32Array | Array<number>>;
  83700. /** @hidden */
  83701. _markAsUpdated(): void;
  83702. /** @hidden */
  83703. private _updateIdentityStatus;
  83704. /**
  83705. * Creates an empty matrix (filled with zeros)
  83706. */
  83707. constructor();
  83708. /**
  83709. * Check if the current matrix is identity
  83710. * @returns true is the matrix is the identity matrix
  83711. */
  83712. isIdentity(): boolean;
  83713. /**
  83714. * Check if the current matrix is identity as a texture matrix (3x2 store in 4x4)
  83715. * @returns true is the matrix is the identity matrix
  83716. */
  83717. isIdentityAs3x2(): boolean;
  83718. /**
  83719. * Gets the determinant of the matrix
  83720. * @returns the matrix determinant
  83721. */
  83722. determinant(): number;
  83723. /**
  83724. * Returns the matrix as a Float32Array or Array<number>
  83725. * @returns the matrix underlying array
  83726. */
  83727. toArray(): DeepImmutable<Float32Array | Array<number>>;
  83728. /**
  83729. * Returns the matrix as a Float32Array or Array<number>
  83730. * @returns the matrix underlying array.
  83731. */
  83732. asArray(): DeepImmutable<Float32Array | Array<number>>;
  83733. /**
  83734. * Inverts the current matrix in place
  83735. * @returns the current inverted matrix
  83736. */
  83737. invert(): Matrix;
  83738. /**
  83739. * Sets all the matrix elements to zero
  83740. * @returns the current matrix
  83741. */
  83742. reset(): Matrix;
  83743. /**
  83744. * Adds the current matrix with a second one
  83745. * @param other defines the matrix to add
  83746. * @returns a new matrix as the addition of the current matrix and the given one
  83747. */
  83748. add(other: DeepImmutable<Matrix>): Matrix;
  83749. /**
  83750. * Sets the given matrix "result" to the addition of the current matrix and the given one
  83751. * @param other defines the matrix to add
  83752. * @param result defines the target matrix
  83753. * @returns the current matrix
  83754. */
  83755. addToRef(other: DeepImmutable<Matrix>, result: Matrix): Matrix;
  83756. /**
  83757. * Adds in place the given matrix to the current matrix
  83758. * @param other defines the second operand
  83759. * @returns the current updated matrix
  83760. */
  83761. addToSelf(other: DeepImmutable<Matrix>): Matrix;
  83762. /**
  83763. * Sets the given matrix to the current inverted Matrix
  83764. * @param other defines the target matrix
  83765. * @returns the unmodified current matrix
  83766. */
  83767. invertToRef(other: Matrix): Matrix;
  83768. /**
  83769. * add a value at the specified position in the current Matrix
  83770. * @param index the index of the value within the matrix. between 0 and 15.
  83771. * @param value the value to be added
  83772. * @returns the current updated matrix
  83773. */
  83774. addAtIndex(index: number, value: number): Matrix;
  83775. /**
  83776. * mutiply the specified position in the current Matrix by a value
  83777. * @param index the index of the value within the matrix. between 0 and 15.
  83778. * @param value the value to be added
  83779. * @returns the current updated matrix
  83780. */
  83781. multiplyAtIndex(index: number, value: number): Matrix;
  83782. /**
  83783. * Inserts the translation vector (using 3 floats) in the current matrix
  83784. * @param x defines the 1st component of the translation
  83785. * @param y defines the 2nd component of the translation
  83786. * @param z defines the 3rd component of the translation
  83787. * @returns the current updated matrix
  83788. */
  83789. setTranslationFromFloats(x: number, y: number, z: number): Matrix;
  83790. /**
  83791. * Adds the translation vector (using 3 floats) in the current matrix
  83792. * @param x defines the 1st component of the translation
  83793. * @param y defines the 2nd component of the translation
  83794. * @param z defines the 3rd component of the translation
  83795. * @returns the current updated matrix
  83796. */
  83797. addTranslationFromFloats(x: number, y: number, z: number): Matrix;
  83798. /**
  83799. * Inserts the translation vector in the current matrix
  83800. * @param vector3 defines the translation to insert
  83801. * @returns the current updated matrix
  83802. */
  83803. setTranslation(vector3: DeepImmutable<Vector3>): Matrix;
  83804. /**
  83805. * Gets the translation value of the current matrix
  83806. * @returns a new Vector3 as the extracted translation from the matrix
  83807. */
  83808. getTranslation(): Vector3;
  83809. /**
  83810. * Fill a Vector3 with the extracted translation from the matrix
  83811. * @param result defines the Vector3 where to store the translation
  83812. * @returns the current matrix
  83813. */
  83814. getTranslationToRef(result: Vector3): Matrix;
  83815. /**
  83816. * Remove rotation and scaling part from the matrix
  83817. * @returns the updated matrix
  83818. */
  83819. removeRotationAndScaling(): Matrix;
  83820. /**
  83821. * Multiply two matrices
  83822. * @param other defines the second operand
  83823. * @returns a new matrix set with the multiplication result of the current Matrix and the given one
  83824. */
  83825. multiply(other: DeepImmutable<Matrix>): Matrix;
  83826. /**
  83827. * Copy the current matrix from the given one
  83828. * @param other defines the source matrix
  83829. * @returns the current updated matrix
  83830. */
  83831. copyFrom(other: DeepImmutable<Matrix>): Matrix;
  83832. /**
  83833. * Populates the given array from the starting index with the current matrix values
  83834. * @param array defines the target array
  83835. * @param offset defines the offset in the target array where to start storing values
  83836. * @returns the current matrix
  83837. */
  83838. copyToArray(array: Float32Array | Array<number>, offset?: number): Matrix;
  83839. /**
  83840. * Sets the given matrix "result" with the multiplication result of the current Matrix and the given one
  83841. * @param other defines the second operand
  83842. * @param result defines the matrix where to store the multiplication
  83843. * @returns the current matrix
  83844. */
  83845. multiplyToRef(other: DeepImmutable<Matrix>, result: Matrix): Matrix;
  83846. /**
  83847. * Sets the Float32Array "result" from the given index "offset" with the multiplication of the current matrix and the given one
  83848. * @param other defines the second operand
  83849. * @param result defines the array where to store the multiplication
  83850. * @param offset defines the offset in the target array where to start storing values
  83851. * @returns the current matrix
  83852. */
  83853. multiplyToArray(other: DeepImmutable<Matrix>, result: Float32Array | Array<number>, offset: number): Matrix;
  83854. /**
  83855. * Check equality between this matrix and a second one
  83856. * @param value defines the second matrix to compare
  83857. * @returns true is the current matrix and the given one values are strictly equal
  83858. */
  83859. equals(value: DeepImmutable<Matrix>): boolean;
  83860. /**
  83861. * Clone the current matrix
  83862. * @returns a new matrix from the current matrix
  83863. */
  83864. clone(): Matrix;
  83865. /**
  83866. * Returns the name of the current matrix class
  83867. * @returns the string "Matrix"
  83868. */
  83869. getClassName(): string;
  83870. /**
  83871. * Gets the hash code of the current matrix
  83872. * @returns the hash code
  83873. */
  83874. getHashCode(): number;
  83875. /**
  83876. * Decomposes the current Matrix into a translation, rotation and scaling components
  83877. * @param scale defines the scale vector3 given as a reference to update
  83878. * @param rotation defines the rotation quaternion given as a reference to update
  83879. * @param translation defines the translation vector3 given as a reference to update
  83880. * @returns true if operation was successful
  83881. */
  83882. decompose(scale?: Vector3, rotation?: Quaternion, translation?: Vector3): boolean;
  83883. /**
  83884. * Gets specific row of the matrix
  83885. * @param index defines the number of the row to get
  83886. * @returns the index-th row of the current matrix as a new Vector4
  83887. */
  83888. getRow(index: number): Nullable<Vector4>;
  83889. /**
  83890. * Sets the index-th row of the current matrix to the vector4 values
  83891. * @param index defines the number of the row to set
  83892. * @param row defines the target vector4
  83893. * @returns the updated current matrix
  83894. */
  83895. setRow(index: number, row: Vector4): Matrix;
  83896. /**
  83897. * Compute the transpose of the matrix
  83898. * @returns the new transposed matrix
  83899. */
  83900. transpose(): Matrix;
  83901. /**
  83902. * Compute the transpose of the matrix and store it in a given matrix
  83903. * @param result defines the target matrix
  83904. * @returns the current matrix
  83905. */
  83906. transposeToRef(result: Matrix): Matrix;
  83907. /**
  83908. * Sets the index-th row of the current matrix with the given 4 x float values
  83909. * @param index defines the row index
  83910. * @param x defines the x component to set
  83911. * @param y defines the y component to set
  83912. * @param z defines the z component to set
  83913. * @param w defines the w component to set
  83914. * @returns the updated current matrix
  83915. */
  83916. setRowFromFloats(index: number, x: number, y: number, z: number, w: number): Matrix;
  83917. /**
  83918. * Compute a new matrix set with the current matrix values multiplied by scale (float)
  83919. * @param scale defines the scale factor
  83920. * @returns a new matrix
  83921. */
  83922. scale(scale: number): Matrix;
  83923. /**
  83924. * Scale the current matrix values by a factor to a given result matrix
  83925. * @param scale defines the scale factor
  83926. * @param result defines the matrix to store the result
  83927. * @returns the current matrix
  83928. */
  83929. scaleToRef(scale: number, result: Matrix): Matrix;
  83930. /**
  83931. * Scale the current matrix values by a factor and add the result to a given matrix
  83932. * @param scale defines the scale factor
  83933. * @param result defines the Matrix to store the result
  83934. * @returns the current matrix
  83935. */
  83936. scaleAndAddToRef(scale: number, result: Matrix): Matrix;
  83937. /**
  83938. * Writes to the given matrix a normal matrix, computed from this one (using values from identity matrix for fourth row and column).
  83939. * @param ref matrix to store the result
  83940. */
  83941. toNormalMatrix(ref: Matrix): void;
  83942. /**
  83943. * Gets only rotation part of the current matrix
  83944. * @returns a new matrix sets to the extracted rotation matrix from the current one
  83945. */
  83946. getRotationMatrix(): Matrix;
  83947. /**
  83948. * Extracts the rotation matrix from the current one and sets it as the given "result"
  83949. * @param result defines the target matrix to store data to
  83950. * @returns the current matrix
  83951. */
  83952. getRotationMatrixToRef(result: Matrix): Matrix;
  83953. /**
  83954. * Toggles model matrix from being right handed to left handed in place and vice versa
  83955. */
  83956. toggleModelMatrixHandInPlace(): void;
  83957. /**
  83958. * Toggles projection matrix from being right handed to left handed in place and vice versa
  83959. */
  83960. toggleProjectionMatrixHandInPlace(): void;
  83961. /**
  83962. * Creates a matrix from an array
  83963. * @param array defines the source array
  83964. * @param offset defines an offset in the source array
  83965. * @returns a new Matrix set from the starting index of the given array
  83966. */
  83967. static FromArray(array: DeepImmutable<ArrayLike<number>>, offset?: number): Matrix;
  83968. /**
  83969. * Copy the content of an array into a given matrix
  83970. * @param array defines the source array
  83971. * @param offset defines an offset in the source array
  83972. * @param result defines the target matrix
  83973. */
  83974. static FromArrayToRef(array: DeepImmutable<ArrayLike<number>>, offset: number, result: Matrix): void;
  83975. /**
  83976. * Stores an array into a matrix after having multiplied each component by a given factor
  83977. * @param array defines the source array
  83978. * @param offset defines the offset in the source array
  83979. * @param scale defines the scaling factor
  83980. * @param result defines the target matrix
  83981. */
  83982. static FromFloat32ArrayToRefScaled(array: DeepImmutable<Float32Array | Array<number>>, offset: number, scale: number, result: Matrix): void;
  83983. /**
  83984. * Gets an identity matrix that must not be updated
  83985. */
  83986. static get IdentityReadOnly(): DeepImmutable<Matrix>;
  83987. /**
  83988. * Stores a list of values (16) inside a given matrix
  83989. * @param initialM11 defines 1st value of 1st row
  83990. * @param initialM12 defines 2nd value of 1st row
  83991. * @param initialM13 defines 3rd value of 1st row
  83992. * @param initialM14 defines 4th value of 1st row
  83993. * @param initialM21 defines 1st value of 2nd row
  83994. * @param initialM22 defines 2nd value of 2nd row
  83995. * @param initialM23 defines 3rd value of 2nd row
  83996. * @param initialM24 defines 4th value of 2nd row
  83997. * @param initialM31 defines 1st value of 3rd row
  83998. * @param initialM32 defines 2nd value of 3rd row
  83999. * @param initialM33 defines 3rd value of 3rd row
  84000. * @param initialM34 defines 4th value of 3rd row
  84001. * @param initialM41 defines 1st value of 4th row
  84002. * @param initialM42 defines 2nd value of 4th row
  84003. * @param initialM43 defines 3rd value of 4th row
  84004. * @param initialM44 defines 4th value of 4th row
  84005. * @param result defines the target matrix
  84006. */
  84007. 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;
  84008. /**
  84009. * Creates new matrix from a list of values (16)
  84010. * @param initialM11 defines 1st value of 1st row
  84011. * @param initialM12 defines 2nd value of 1st row
  84012. * @param initialM13 defines 3rd value of 1st row
  84013. * @param initialM14 defines 4th value of 1st row
  84014. * @param initialM21 defines 1st value of 2nd row
  84015. * @param initialM22 defines 2nd value of 2nd row
  84016. * @param initialM23 defines 3rd value of 2nd row
  84017. * @param initialM24 defines 4th value of 2nd row
  84018. * @param initialM31 defines 1st value of 3rd row
  84019. * @param initialM32 defines 2nd value of 3rd row
  84020. * @param initialM33 defines 3rd value of 3rd row
  84021. * @param initialM34 defines 4th value of 3rd row
  84022. * @param initialM41 defines 1st value of 4th row
  84023. * @param initialM42 defines 2nd value of 4th row
  84024. * @param initialM43 defines 3rd value of 4th row
  84025. * @param initialM44 defines 4th value of 4th row
  84026. * @returns the new matrix
  84027. */
  84028. 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;
  84029. /**
  84030. * Creates a new matrix composed by merging scale (vector3), rotation (quaternion) and translation (vector3)
  84031. * @param scale defines the scale vector3
  84032. * @param rotation defines the rotation quaternion
  84033. * @param translation defines the translation vector3
  84034. * @returns a new matrix
  84035. */
  84036. static Compose(scale: DeepImmutable<Vector3>, rotation: DeepImmutable<Quaternion>, translation: DeepImmutable<Vector3>): Matrix;
  84037. /**
  84038. * Sets a matrix to a value composed by merging scale (vector3), rotation (quaternion) and translation (vector3)
  84039. * @param scale defines the scale vector3
  84040. * @param rotation defines the rotation quaternion
  84041. * @param translation defines the translation vector3
  84042. * @param result defines the target matrix
  84043. */
  84044. static ComposeToRef(scale: DeepImmutable<Vector3>, rotation: DeepImmutable<Quaternion>, translation: DeepImmutable<Vector3>, result: Matrix): void;
  84045. /**
  84046. * Creates a new identity matrix
  84047. * @returns a new identity matrix
  84048. */
  84049. static Identity(): Matrix;
  84050. /**
  84051. * Creates a new identity matrix and stores the result in a given matrix
  84052. * @param result defines the target matrix
  84053. */
  84054. static IdentityToRef(result: Matrix): void;
  84055. /**
  84056. * Creates a new zero matrix
  84057. * @returns a new zero matrix
  84058. */
  84059. static Zero(): Matrix;
  84060. /**
  84061. * Creates a new rotation matrix for "angle" radians around the X axis
  84062. * @param angle defines the angle (in radians) to use
  84063. * @return the new matrix
  84064. */
  84065. static RotationX(angle: number): Matrix;
  84066. /**
  84067. * Creates a new matrix as the invert of a given matrix
  84068. * @param source defines the source matrix
  84069. * @returns the new matrix
  84070. */
  84071. static Invert(source: DeepImmutable<Matrix>): Matrix;
  84072. /**
  84073. * Creates a new rotation matrix for "angle" radians around the X axis and stores it in a given matrix
  84074. * @param angle defines the angle (in radians) to use
  84075. * @param result defines the target matrix
  84076. */
  84077. static RotationXToRef(angle: number, result: Matrix): void;
  84078. /**
  84079. * Creates a new rotation matrix for "angle" radians around the Y axis
  84080. * @param angle defines the angle (in radians) to use
  84081. * @return the new matrix
  84082. */
  84083. static RotationY(angle: number): Matrix;
  84084. /**
  84085. * Creates a new rotation matrix for "angle" radians around the Y axis and stores it in a given matrix
  84086. * @param angle defines the angle (in radians) to use
  84087. * @param result defines the target matrix
  84088. */
  84089. static RotationYToRef(angle: number, result: Matrix): void;
  84090. /**
  84091. * Creates a new rotation matrix for "angle" radians around the Z axis
  84092. * @param angle defines the angle (in radians) to use
  84093. * @return the new matrix
  84094. */
  84095. static RotationZ(angle: number): Matrix;
  84096. /**
  84097. * Creates a new rotation matrix for "angle" radians around the Z axis and stores it in a given matrix
  84098. * @param angle defines the angle (in radians) to use
  84099. * @param result defines the target matrix
  84100. */
  84101. static RotationZToRef(angle: number, result: Matrix): void;
  84102. /**
  84103. * Creates a new rotation matrix for "angle" radians around the given axis
  84104. * @param axis defines the axis to use
  84105. * @param angle defines the angle (in radians) to use
  84106. * @return the new matrix
  84107. */
  84108. static RotationAxis(axis: DeepImmutable<Vector3>, angle: number): Matrix;
  84109. /**
  84110. * Creates a new rotation matrix for "angle" radians around the given axis and stores it in a given matrix
  84111. * @param axis defines the axis to use
  84112. * @param angle defines the angle (in radians) to use
  84113. * @param result defines the target matrix
  84114. */
  84115. static RotationAxisToRef(axis: DeepImmutable<Vector3>, angle: number, result: Matrix): void;
  84116. /**
  84117. * Takes normalised vectors and returns a rotation matrix to align "from" with "to".
  84118. * Taken from http://www.iquilezles.org/www/articles/noacos/noacos.htm
  84119. * @param from defines the vector to align
  84120. * @param to defines the vector to align to
  84121. * @param result defines the target matrix
  84122. */
  84123. static RotationAlignToRef(from: DeepImmutable<Vector3>, to: DeepImmutable<Vector3>, result: Matrix): void;
  84124. /**
  84125. * Creates a rotation matrix
  84126. * @param yaw defines the yaw angle in radians (Y axis)
  84127. * @param pitch defines the pitch angle in radians (X axis)
  84128. * @param roll defines the roll angle in radians (Z axis)
  84129. * @returns the new rotation matrix
  84130. */
  84131. static RotationYawPitchRoll(yaw: number, pitch: number, roll: number): Matrix;
  84132. /**
  84133. * Creates a rotation matrix and stores it in a given matrix
  84134. * @param yaw defines the yaw angle in radians (Y axis)
  84135. * @param pitch defines the pitch angle in radians (X axis)
  84136. * @param roll defines the roll angle in radians (Z axis)
  84137. * @param result defines the target matrix
  84138. */
  84139. static RotationYawPitchRollToRef(yaw: number, pitch: number, roll: number, result: Matrix): void;
  84140. /**
  84141. * Creates a scaling matrix
  84142. * @param x defines the scale factor on X axis
  84143. * @param y defines the scale factor on Y axis
  84144. * @param z defines the scale factor on Z axis
  84145. * @returns the new matrix
  84146. */
  84147. static Scaling(x: number, y: number, z: number): Matrix;
  84148. /**
  84149. * Creates a scaling matrix and stores it in a given matrix
  84150. * @param x defines the scale factor on X axis
  84151. * @param y defines the scale factor on Y axis
  84152. * @param z defines the scale factor on Z axis
  84153. * @param result defines the target matrix
  84154. */
  84155. static ScalingToRef(x: number, y: number, z: number, result: Matrix): void;
  84156. /**
  84157. * Creates a translation matrix
  84158. * @param x defines the translation on X axis
  84159. * @param y defines the translation on Y axis
  84160. * @param z defines the translationon Z axis
  84161. * @returns the new matrix
  84162. */
  84163. static Translation(x: number, y: number, z: number): Matrix;
  84164. /**
  84165. * Creates a translation matrix and stores it in a given matrix
  84166. * @param x defines the translation on X axis
  84167. * @param y defines the translation on Y axis
  84168. * @param z defines the translationon Z axis
  84169. * @param result defines the target matrix
  84170. */
  84171. static TranslationToRef(x: number, y: number, z: number, result: Matrix): void;
  84172. /**
  84173. * Returns a new Matrix whose values are the interpolated values for "gradient" (float) between the ones of the matrices "startValue" and "endValue".
  84174. * @param startValue defines the start value
  84175. * @param endValue defines the end value
  84176. * @param gradient defines the gradient factor
  84177. * @returns the new matrix
  84178. */
  84179. static Lerp(startValue: DeepImmutable<Matrix>, endValue: DeepImmutable<Matrix>, gradient: number): Matrix;
  84180. /**
  84181. * Set the given matrix "result" as the interpolated values for "gradient" (float) between the ones of the matrices "startValue" and "endValue".
  84182. * @param startValue defines the start value
  84183. * @param endValue defines the end value
  84184. * @param gradient defines the gradient factor
  84185. * @param result defines the Matrix object where to store data
  84186. */
  84187. static LerpToRef(startValue: DeepImmutable<Matrix>, endValue: DeepImmutable<Matrix>, gradient: number, result: Matrix): void;
  84188. /**
  84189. * Builds a new matrix whose values are computed by:
  84190. * * decomposing the the "startValue" and "endValue" matrices into their respective scale, rotation and translation matrices
  84191. * * interpolating for "gradient" (float) the values between each of these decomposed matrices between the start and the end
  84192. * * recomposing a new matrix from these 3 interpolated scale, rotation and translation matrices
  84193. * @param startValue defines the first matrix
  84194. * @param endValue defines the second matrix
  84195. * @param gradient defines the gradient between the two matrices
  84196. * @returns the new matrix
  84197. */
  84198. static DecomposeLerp(startValue: DeepImmutable<Matrix>, endValue: DeepImmutable<Matrix>, gradient: number): Matrix;
  84199. /**
  84200. * Update a matrix to values which are computed by:
  84201. * * decomposing the the "startValue" and "endValue" matrices into their respective scale, rotation and translation matrices
  84202. * * interpolating for "gradient" (float) the values between each of these decomposed matrices between the start and the end
  84203. * * recomposing a new matrix from these 3 interpolated scale, rotation and translation matrices
  84204. * @param startValue defines the first matrix
  84205. * @param endValue defines the second matrix
  84206. * @param gradient defines the gradient between the two matrices
  84207. * @param result defines the target matrix
  84208. */
  84209. static DecomposeLerpToRef(startValue: DeepImmutable<Matrix>, endValue: DeepImmutable<Matrix>, gradient: number, result: Matrix): void;
  84210. /**
  84211. * 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"
  84212. * This function works in left handed mode
  84213. * @param eye defines the final position of the entity
  84214. * @param target defines where the entity should look at
  84215. * @param up defines the up vector for the entity
  84216. * @returns the new matrix
  84217. */
  84218. static LookAtLH(eye: DeepImmutable<Vector3>, target: DeepImmutable<Vector3>, up: DeepImmutable<Vector3>): Matrix;
  84219. /**
  84220. * 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".
  84221. * This function works in left handed mode
  84222. * @param eye defines the final position of the entity
  84223. * @param target defines where the entity should look at
  84224. * @param up defines the up vector for the entity
  84225. * @param result defines the target matrix
  84226. */
  84227. static LookAtLHToRef(eye: DeepImmutable<Vector3>, target: DeepImmutable<Vector3>, up: DeepImmutable<Vector3>, result: Matrix): void;
  84228. /**
  84229. * 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"
  84230. * This function works in right handed mode
  84231. * @param eye defines the final position of the entity
  84232. * @param target defines where the entity should look at
  84233. * @param up defines the up vector for the entity
  84234. * @returns the new matrix
  84235. */
  84236. static LookAtRH(eye: DeepImmutable<Vector3>, target: DeepImmutable<Vector3>, up: DeepImmutable<Vector3>): Matrix;
  84237. /**
  84238. * 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".
  84239. * This function works in right handed mode
  84240. * @param eye defines the final position of the entity
  84241. * @param target defines where the entity should look at
  84242. * @param up defines the up vector for the entity
  84243. * @param result defines the target matrix
  84244. */
  84245. static LookAtRHToRef(eye: DeepImmutable<Vector3>, target: DeepImmutable<Vector3>, up: DeepImmutable<Vector3>, result: Matrix): void;
  84246. /**
  84247. * Create a left-handed orthographic projection matrix
  84248. * @param width defines the viewport width
  84249. * @param height defines the viewport height
  84250. * @param znear defines the near clip plane
  84251. * @param zfar defines the far clip plane
  84252. * @returns a new matrix as a left-handed orthographic projection matrix
  84253. */
  84254. static OrthoLH(width: number, height: number, znear: number, zfar: number): Matrix;
  84255. /**
  84256. * Store a left-handed orthographic projection to a given matrix
  84257. * @param width defines the viewport width
  84258. * @param height defines the viewport height
  84259. * @param znear defines the near clip plane
  84260. * @param zfar defines the far clip plane
  84261. * @param result defines the target matrix
  84262. */
  84263. static OrthoLHToRef(width: number, height: number, znear: number, zfar: number, result: Matrix): void;
  84264. /**
  84265. * Create a left-handed orthographic projection matrix
  84266. * @param left defines the viewport left coordinate
  84267. * @param right defines the viewport right coordinate
  84268. * @param bottom defines the viewport bottom coordinate
  84269. * @param top defines the viewport top coordinate
  84270. * @param znear defines the near clip plane
  84271. * @param zfar defines the far clip plane
  84272. * @returns a new matrix as a left-handed orthographic projection matrix
  84273. */
  84274. static OrthoOffCenterLH(left: number, right: number, bottom: number, top: number, znear: number, zfar: number): Matrix;
  84275. /**
  84276. * Stores a left-handed orthographic projection into a given matrix
  84277. * @param left defines the viewport left coordinate
  84278. * @param right defines the viewport right coordinate
  84279. * @param bottom defines the viewport bottom coordinate
  84280. * @param top defines the viewport top coordinate
  84281. * @param znear defines the near clip plane
  84282. * @param zfar defines the far clip plane
  84283. * @param result defines the target matrix
  84284. */
  84285. static OrthoOffCenterLHToRef(left: number, right: number, bottom: number, top: number, znear: number, zfar: number, result: Matrix): void;
  84286. /**
  84287. * Creates a right-handed orthographic projection matrix
  84288. * @param left defines the viewport left coordinate
  84289. * @param right defines the viewport right coordinate
  84290. * @param bottom defines the viewport bottom coordinate
  84291. * @param top defines the viewport top coordinate
  84292. * @param znear defines the near clip plane
  84293. * @param zfar defines the far clip plane
  84294. * @returns a new matrix as a right-handed orthographic projection matrix
  84295. */
  84296. static OrthoOffCenterRH(left: number, right: number, bottom: number, top: number, znear: number, zfar: number): Matrix;
  84297. /**
  84298. * Stores a right-handed orthographic projection into a given matrix
  84299. * @param left defines the viewport left coordinate
  84300. * @param right defines the viewport right coordinate
  84301. * @param bottom defines the viewport bottom coordinate
  84302. * @param top defines the viewport top coordinate
  84303. * @param znear defines the near clip plane
  84304. * @param zfar defines the far clip plane
  84305. * @param result defines the target matrix
  84306. */
  84307. static OrthoOffCenterRHToRef(left: number, right: number, bottom: number, top: number, znear: number, zfar: number, result: Matrix): void;
  84308. /**
  84309. * Creates a left-handed perspective projection matrix
  84310. * @param width defines the viewport width
  84311. * @param height defines the viewport height
  84312. * @param znear defines the near clip plane
  84313. * @param zfar defines the far clip plane
  84314. * @returns a new matrix as a left-handed perspective projection matrix
  84315. */
  84316. static PerspectiveLH(width: number, height: number, znear: number, zfar: number): Matrix;
  84317. /**
  84318. * Creates a left-handed perspective projection matrix
  84319. * @param fov defines the horizontal field of view
  84320. * @param aspect defines the aspect ratio
  84321. * @param znear defines the near clip plane
  84322. * @param zfar defines the far clip plane
  84323. * @returns a new matrix as a left-handed perspective projection matrix
  84324. */
  84325. static PerspectiveFovLH(fov: number, aspect: number, znear: number, zfar: number): Matrix;
  84326. /**
  84327. * Stores a left-handed perspective projection into a given matrix
  84328. * @param fov defines the horizontal field of view
  84329. * @param aspect defines the aspect ratio
  84330. * @param znear defines the near clip plane
  84331. * @param zfar defines the far clip plane
  84332. * @param result defines the target matrix
  84333. * @param isVerticalFovFixed defines it the fov is vertically fixed (default) or horizontally
  84334. */
  84335. static PerspectiveFovLHToRef(fov: number, aspect: number, znear: number, zfar: number, result: Matrix, isVerticalFovFixed?: boolean): void;
  84336. /**
  84337. * Stores a left-handed perspective projection into a given matrix with depth reversed
  84338. * @param fov defines the horizontal field of view
  84339. * @param aspect defines the aspect ratio
  84340. * @param znear defines the near clip plane
  84341. * @param zfar not used as infinity is used as far clip
  84342. * @param result defines the target matrix
  84343. * @param isVerticalFovFixed defines it the fov is vertically fixed (default) or horizontally
  84344. */
  84345. static PerspectiveFovReverseLHToRef(fov: number, aspect: number, znear: number, zfar: number, result: Matrix, isVerticalFovFixed?: boolean): void;
  84346. /**
  84347. * Creates a right-handed perspective projection matrix
  84348. * @param fov defines the horizontal field of view
  84349. * @param aspect defines the aspect ratio
  84350. * @param znear defines the near clip plane
  84351. * @param zfar defines the far clip plane
  84352. * @returns a new matrix as a right-handed perspective projection matrix
  84353. */
  84354. static PerspectiveFovRH(fov: number, aspect: number, znear: number, zfar: number): Matrix;
  84355. /**
  84356. * Stores a right-handed perspective projection into a given matrix
  84357. * @param fov defines the horizontal field of view
  84358. * @param aspect defines the aspect ratio
  84359. * @param znear defines the near clip plane
  84360. * @param zfar defines the far clip plane
  84361. * @param result defines the target matrix
  84362. * @param isVerticalFovFixed defines it the fov is vertically fixed (default) or horizontally
  84363. */
  84364. static PerspectiveFovRHToRef(fov: number, aspect: number, znear: number, zfar: number, result: Matrix, isVerticalFovFixed?: boolean): void;
  84365. /**
  84366. * Stores a right-handed perspective projection into a given matrix
  84367. * @param fov defines the horizontal field of view
  84368. * @param aspect defines the aspect ratio
  84369. * @param znear defines the near clip plane
  84370. * @param zfar not used as infinity is used as far clip
  84371. * @param result defines the target matrix
  84372. * @param isVerticalFovFixed defines it the fov is vertically fixed (default) or horizontally
  84373. */
  84374. static PerspectiveFovReverseRHToRef(fov: number, aspect: number, znear: number, zfar: number, result: Matrix, isVerticalFovFixed?: boolean): void;
  84375. /**
  84376. * Stores a perspective projection for WebVR info a given matrix
  84377. * @param fov defines the field of view
  84378. * @param znear defines the near clip plane
  84379. * @param zfar defines the far clip plane
  84380. * @param result defines the target matrix
  84381. * @param rightHanded defines if the matrix must be in right-handed mode (false by default)
  84382. */
  84383. static PerspectiveFovWebVRToRef(fov: {
  84384. upDegrees: number;
  84385. downDegrees: number;
  84386. leftDegrees: number;
  84387. rightDegrees: number;
  84388. }, znear: number, zfar: number, result: Matrix, rightHanded?: boolean): void;
  84389. /**
  84390. * Computes a complete transformation matrix
  84391. * @param viewport defines the viewport to use
  84392. * @param world defines the world matrix
  84393. * @param view defines the view matrix
  84394. * @param projection defines the projection matrix
  84395. * @param zmin defines the near clip plane
  84396. * @param zmax defines the far clip plane
  84397. * @returns the transformation matrix
  84398. */
  84399. static GetFinalMatrix(viewport: DeepImmutable<Viewport>, world: DeepImmutable<Matrix>, view: DeepImmutable<Matrix>, projection: DeepImmutable<Matrix>, zmin: number, zmax: number): Matrix;
  84400. /**
  84401. * Extracts a 2x2 matrix from a given matrix and store the result in a Float32Array
  84402. * @param matrix defines the matrix to use
  84403. * @returns a new Float32Array array with 4 elements : the 2x2 matrix extracted from the given matrix
  84404. */
  84405. static GetAsMatrix2x2(matrix: DeepImmutable<Matrix>): Float32Array | Array<number>;
  84406. /**
  84407. * Extracts a 3x3 matrix from a given matrix and store the result in a Float32Array
  84408. * @param matrix defines the matrix to use
  84409. * @returns a new Float32Array array with 9 elements : the 3x3 matrix extracted from the given matrix
  84410. */
  84411. static GetAsMatrix3x3(matrix: DeepImmutable<Matrix>): Float32Array | Array<number>;
  84412. /**
  84413. * Compute the transpose of a given matrix
  84414. * @param matrix defines the matrix to transpose
  84415. * @returns the new matrix
  84416. */
  84417. static Transpose(matrix: DeepImmutable<Matrix>): Matrix;
  84418. /**
  84419. * Compute the transpose of a matrix and store it in a target matrix
  84420. * @param matrix defines the matrix to transpose
  84421. * @param result defines the target matrix
  84422. */
  84423. static TransposeToRef(matrix: DeepImmutable<Matrix>, result: Matrix): void;
  84424. /**
  84425. * Computes a reflection matrix from a plane
  84426. * @param plane defines the reflection plane
  84427. * @returns a new matrix
  84428. */
  84429. static Reflection(plane: DeepImmutable<IPlaneLike>): Matrix;
  84430. /**
  84431. * Computes a reflection matrix from a plane
  84432. * @param plane defines the reflection plane
  84433. * @param result defines the target matrix
  84434. */
  84435. static ReflectionToRef(plane: DeepImmutable<IPlaneLike>, result: Matrix): void;
  84436. /**
  84437. * Sets the given matrix as a rotation matrix composed from the 3 left handed axes
  84438. * @param xaxis defines the value of the 1st axis
  84439. * @param yaxis defines the value of the 2nd axis
  84440. * @param zaxis defines the value of the 3rd axis
  84441. * @param result defines the target matrix
  84442. */
  84443. static FromXYZAxesToRef(xaxis: DeepImmutable<Vector3>, yaxis: DeepImmutable<Vector3>, zaxis: DeepImmutable<Vector3>, result: Matrix): void;
  84444. /**
  84445. * Creates a rotation matrix from a quaternion and stores it in a target matrix
  84446. * @param quat defines the quaternion to use
  84447. * @param result defines the target matrix
  84448. */
  84449. static FromQuaternionToRef(quat: DeepImmutable<Quaternion>, result: Matrix): void;
  84450. }
  84451. /**
  84452. * @hidden
  84453. */
  84454. export class TmpVectors {
  84455. static Vector2: Vector2[];
  84456. static Vector3: Vector3[];
  84457. static Vector4: Vector4[];
  84458. static Quaternion: Quaternion[];
  84459. static Matrix: Matrix[];
  84460. }
  84461. }
  84462. declare module BABYLON {
  84463. /**
  84464. * Defines potential orientation for back face culling
  84465. */
  84466. export enum Orientation {
  84467. /**
  84468. * Clockwise
  84469. */
  84470. CW = 0,
  84471. /** Counter clockwise */
  84472. CCW = 1
  84473. }
  84474. /** Class used to represent a Bezier curve */
  84475. export class BezierCurve {
  84476. /**
  84477. * Returns the cubic Bezier interpolated value (float) at "t" (float) from the given x1, y1, x2, y2 floats
  84478. * @param t defines the time
  84479. * @param x1 defines the left coordinate on X axis
  84480. * @param y1 defines the left coordinate on Y axis
  84481. * @param x2 defines the right coordinate on X axis
  84482. * @param y2 defines the right coordinate on Y axis
  84483. * @returns the interpolated value
  84484. */
  84485. static Interpolate(t: number, x1: number, y1: number, x2: number, y2: number): number;
  84486. }
  84487. /**
  84488. * Defines angle representation
  84489. */
  84490. export class Angle {
  84491. private _radians;
  84492. /**
  84493. * Creates an Angle object of "radians" radians (float).
  84494. * @param radians the angle in radians
  84495. */
  84496. constructor(radians: number);
  84497. /**
  84498. * Get value in degrees
  84499. * @returns the Angle value in degrees (float)
  84500. */
  84501. degrees(): number;
  84502. /**
  84503. * Get value in radians
  84504. * @returns the Angle value in radians (float)
  84505. */
  84506. radians(): number;
  84507. /**
  84508. * Gets a new Angle object valued with the gradient angle, in radians, of the line joining two points
  84509. * @param a defines first point as the origin
  84510. * @param b defines point
  84511. * @returns a new Angle
  84512. */
  84513. static BetweenTwoPoints(a: DeepImmutable<Vector2>, b: DeepImmutable<Vector2>): Angle;
  84514. /**
  84515. * Gets a new Angle object from the given float in radians
  84516. * @param radians defines the angle value in radians
  84517. * @returns a new Angle
  84518. */
  84519. static FromRadians(radians: number): Angle;
  84520. /**
  84521. * Gets a new Angle object from the given float in degrees
  84522. * @param degrees defines the angle value in degrees
  84523. * @returns a new Angle
  84524. */
  84525. static FromDegrees(degrees: number): Angle;
  84526. }
  84527. /**
  84528. * This represents an arc in a 2d space.
  84529. */
  84530. export class Arc2 {
  84531. /** Defines the start point of the arc */
  84532. startPoint: Vector2;
  84533. /** Defines the mid point of the arc */
  84534. midPoint: Vector2;
  84535. /** Defines the end point of the arc */
  84536. endPoint: Vector2;
  84537. /**
  84538. * Defines the center point of the arc.
  84539. */
  84540. centerPoint: Vector2;
  84541. /**
  84542. * Defines the radius of the arc.
  84543. */
  84544. radius: number;
  84545. /**
  84546. * Defines the angle of the arc (from mid point to end point).
  84547. */
  84548. angle: Angle;
  84549. /**
  84550. * Defines the start angle of the arc (from start point to middle point).
  84551. */
  84552. startAngle: Angle;
  84553. /**
  84554. * Defines the orientation of the arc (clock wise/counter clock wise).
  84555. */
  84556. orientation: Orientation;
  84557. /**
  84558. * Creates an Arc object from the three given points : start, middle and end.
  84559. * @param startPoint Defines the start point of the arc
  84560. * @param midPoint Defines the midlle point of the arc
  84561. * @param endPoint Defines the end point of the arc
  84562. */
  84563. constructor(
  84564. /** Defines the start point of the arc */
  84565. startPoint: Vector2,
  84566. /** Defines the mid point of the arc */
  84567. midPoint: Vector2,
  84568. /** Defines the end point of the arc */
  84569. endPoint: Vector2);
  84570. }
  84571. /**
  84572. * Represents a 2D path made up of multiple 2D points
  84573. */
  84574. export class Path2 {
  84575. private _points;
  84576. private _length;
  84577. /**
  84578. * If the path start and end point are the same
  84579. */
  84580. closed: boolean;
  84581. /**
  84582. * Creates a Path2 object from the starting 2D coordinates x and y.
  84583. * @param x the starting points x value
  84584. * @param y the starting points y value
  84585. */
  84586. constructor(x: number, y: number);
  84587. /**
  84588. * Adds a new segment until the given coordinates (x, y) to the current Path2.
  84589. * @param x the added points x value
  84590. * @param y the added points y value
  84591. * @returns the updated Path2.
  84592. */
  84593. addLineTo(x: number, y: number): Path2;
  84594. /**
  84595. * 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.
  84596. * @param midX middle point x value
  84597. * @param midY middle point y value
  84598. * @param endX end point x value
  84599. * @param endY end point y value
  84600. * @param numberOfSegments (default: 36)
  84601. * @returns the updated Path2.
  84602. */
  84603. addArcTo(midX: number, midY: number, endX: number, endY: number, numberOfSegments?: number): Path2;
  84604. /**
  84605. * Closes the Path2.
  84606. * @returns the Path2.
  84607. */
  84608. close(): Path2;
  84609. /**
  84610. * Gets the sum of the distance between each sequential point in the path
  84611. * @returns the Path2 total length (float).
  84612. */
  84613. length(): number;
  84614. /**
  84615. * Gets the points which construct the path
  84616. * @returns the Path2 internal array of points.
  84617. */
  84618. getPoints(): Vector2[];
  84619. /**
  84620. * Retreives the point at the distance aways from the starting point
  84621. * @param normalizedLengthPosition the length along the path to retreive the point from
  84622. * @returns a new Vector2 located at a percentage of the Path2 total length on this path.
  84623. */
  84624. getPointAtLengthPosition(normalizedLengthPosition: number): Vector2;
  84625. /**
  84626. * Creates a new path starting from an x and y position
  84627. * @param x starting x value
  84628. * @param y starting y value
  84629. * @returns a new Path2 starting at the coordinates (x, y).
  84630. */
  84631. static StartingAt(x: number, y: number): Path2;
  84632. }
  84633. /**
  84634. * Represents a 3D path made up of multiple 3D points
  84635. */
  84636. export class Path3D {
  84637. /**
  84638. * an array of Vector3, the curve axis of the Path3D
  84639. */
  84640. path: Vector3[];
  84641. private _curve;
  84642. private _distances;
  84643. private _tangents;
  84644. private _normals;
  84645. private _binormals;
  84646. private _raw;
  84647. private _alignTangentsWithPath;
  84648. private readonly _pointAtData;
  84649. /**
  84650. * new Path3D(path, normal, raw)
  84651. * Creates a Path3D. A Path3D is a logical math object, so not a mesh.
  84652. * please read the description in the tutorial : https://doc.babylonjs.com/how_to/how_to_use_path3d
  84653. * @param path an array of Vector3, the curve axis of the Path3D
  84654. * @param firstNormal (options) Vector3, the first wanted normal to the curve. Ex (0, 1, 0) for a vertical normal.
  84655. * @param raw (optional, default false) : boolean, if true the returned Path3D isn't normalized. Useful to depict path acceleration or speed.
  84656. * @param alignTangentsWithPath (optional, default false) : boolean, if true the tangents will be aligned with the path.
  84657. */
  84658. constructor(
  84659. /**
  84660. * an array of Vector3, the curve axis of the Path3D
  84661. */
  84662. path: Vector3[], firstNormal?: Nullable<Vector3>, raw?: boolean, alignTangentsWithPath?: boolean);
  84663. /**
  84664. * Returns the Path3D array of successive Vector3 designing its curve.
  84665. * @returns the Path3D array of successive Vector3 designing its curve.
  84666. */
  84667. getCurve(): Vector3[];
  84668. /**
  84669. * Returns the Path3D array of successive Vector3 designing its curve.
  84670. * @returns the Path3D array of successive Vector3 designing its curve.
  84671. */
  84672. getPoints(): Vector3[];
  84673. /**
  84674. * @returns the computed length (float) of the path.
  84675. */
  84676. length(): number;
  84677. /**
  84678. * Returns an array populated with tangent vectors on each Path3D curve point.
  84679. * @returns an array populated with tangent vectors on each Path3D curve point.
  84680. */
  84681. getTangents(): Vector3[];
  84682. /**
  84683. * Returns an array populated with normal vectors on each Path3D curve point.
  84684. * @returns an array populated with normal vectors on each Path3D curve point.
  84685. */
  84686. getNormals(): Vector3[];
  84687. /**
  84688. * Returns an array populated with binormal vectors on each Path3D curve point.
  84689. * @returns an array populated with binormal vectors on each Path3D curve point.
  84690. */
  84691. getBinormals(): Vector3[];
  84692. /**
  84693. * Returns an array populated with distances (float) of the i-th point from the first curve point.
  84694. * @returns an array populated with distances (float) of the i-th point from the first curve point.
  84695. */
  84696. getDistances(): number[];
  84697. /**
  84698. * Returns an interpolated point along this path
  84699. * @param position the position of the point along this path, from 0.0 to 1.0
  84700. * @returns a new Vector3 as the point
  84701. */
  84702. getPointAt(position: number): Vector3;
  84703. /**
  84704. * Returns the tangent vector of an interpolated Path3D curve point at the specified position along this path.
  84705. * @param position the position of the point along this path, from 0.0 to 1.0
  84706. * @param interpolated (optional, default false) : boolean, if true returns an interpolated tangent instead of the tangent of the previous path point.
  84707. * @returns a tangent vector corresponding to the interpolated Path3D curve point, if not interpolated, the tangent is taken from the precomputed tangents array.
  84708. */
  84709. getTangentAt(position: number, interpolated?: boolean): Vector3;
  84710. /**
  84711. * Returns the tangent vector of an interpolated Path3D curve point at the specified position along this path.
  84712. * @param position the position of the point along this path, from 0.0 to 1.0
  84713. * @param interpolated (optional, default false) : boolean, if true returns an interpolated normal instead of the normal of the previous path point.
  84714. * @returns a normal vector corresponding to the interpolated Path3D curve point, if not interpolated, the normal is taken from the precomputed normals array.
  84715. */
  84716. getNormalAt(position: number, interpolated?: boolean): Vector3;
  84717. /**
  84718. * Returns the binormal vector of an interpolated Path3D curve point at the specified position along this path.
  84719. * @param position the position of the point along this path, from 0.0 to 1.0
  84720. * @param interpolated (optional, default false) : boolean, if true returns an interpolated binormal instead of the binormal of the previous path point.
  84721. * @returns a binormal vector corresponding to the interpolated Path3D curve point, if not interpolated, the binormal is taken from the precomputed binormals array.
  84722. */
  84723. getBinormalAt(position: number, interpolated?: boolean): Vector3;
  84724. /**
  84725. * Returns the distance (float) of an interpolated Path3D curve point at the specified position along this path.
  84726. * @param position the position of the point along this path, from 0.0 to 1.0
  84727. * @returns the distance of the interpolated Path3D curve point at the specified position along this path.
  84728. */
  84729. getDistanceAt(position: number): number;
  84730. /**
  84731. * Returns the array index of the previous point of an interpolated point along this path
  84732. * @param position the position of the point to interpolate along this path, from 0.0 to 1.0
  84733. * @returns the array index
  84734. */
  84735. getPreviousPointIndexAt(position: number): number;
  84736. /**
  84737. * 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)
  84738. * @param position the position of the point to interpolate along this path, from 0.0 to 1.0
  84739. * @returns the sub position
  84740. */
  84741. getSubPositionAt(position: number): number;
  84742. /**
  84743. * Returns the position of the closest virtual point on this path to an arbitrary Vector3, from 0.0 to 1.0
  84744. * @param target the vector of which to get the closest position to
  84745. * @returns the position of the closest virtual point on this path to the target vector
  84746. */
  84747. getClosestPositionTo(target: Vector3): number;
  84748. /**
  84749. * Returns a sub path (slice) of this path
  84750. * @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
  84751. * @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
  84752. * @returns a sub path (slice) of this path
  84753. */
  84754. slice(start?: number, end?: number): Path3D;
  84755. /**
  84756. * Forces the Path3D tangent, normal, binormal and distance recomputation.
  84757. * @param path path which all values are copied into the curves points
  84758. * @param firstNormal which should be projected onto the curve
  84759. * @param alignTangentsWithPath (optional, default false) : boolean, if true the tangents will be aligned with the path
  84760. * @returns the same object updated.
  84761. */
  84762. update(path: Vector3[], firstNormal?: Nullable<Vector3>, alignTangentsWithPath?: boolean): Path3D;
  84763. private _compute;
  84764. private _getFirstNonNullVector;
  84765. private _getLastNonNullVector;
  84766. private _normalVector;
  84767. /**
  84768. * Updates the point at data for an interpolated point along this curve
  84769. * @param position the position of the point along this curve, from 0.0 to 1.0
  84770. * @interpolateTNB wether to compute the interpolated tangent, normal and binormal
  84771. * @returns the (updated) point at data
  84772. */
  84773. private _updatePointAtData;
  84774. /**
  84775. * Updates the point at data from the specified parameters
  84776. * @param position where along the path the interpolated point is, from 0.0 to 1.0
  84777. * @param point the interpolated point
  84778. * @param parentIndex the index of an existing curve point that is on, or else positionally the first behind, the interpolated point
  84779. */
  84780. private _setPointAtData;
  84781. /**
  84782. * Updates the point at interpolation matrix for the tangents, normals and binormals
  84783. */
  84784. private _updateInterpolationMatrix;
  84785. }
  84786. /**
  84787. * A Curve3 object is a logical object, so not a mesh, to handle curves in the 3D geometric space.
  84788. * A Curve3 is designed from a series of successive Vector3.
  84789. * @see https://doc.babylonjs.com/how_to/how_to_use_curve3
  84790. */
  84791. export class Curve3 {
  84792. private _points;
  84793. private _length;
  84794. /**
  84795. * Returns a Curve3 object along a Quadratic Bezier curve : https://doc.babylonjs.com/how_to/how_to_use_curve3#quadratic-bezier-curve
  84796. * @param v0 (Vector3) the origin point of the Quadratic Bezier
  84797. * @param v1 (Vector3) the control point
  84798. * @param v2 (Vector3) the end point of the Quadratic Bezier
  84799. * @param nbPoints (integer) the wanted number of points in the curve
  84800. * @returns the created Curve3
  84801. */
  84802. static CreateQuadraticBezier(v0: DeepImmutable<Vector3>, v1: DeepImmutable<Vector3>, v2: DeepImmutable<Vector3>, nbPoints: number): Curve3;
  84803. /**
  84804. * Returns a Curve3 object along a Cubic Bezier curve : https://doc.babylonjs.com/how_to/how_to_use_curve3#cubic-bezier-curve
  84805. * @param v0 (Vector3) the origin point of the Cubic Bezier
  84806. * @param v1 (Vector3) the first control point
  84807. * @param v2 (Vector3) the second control point
  84808. * @param v3 (Vector3) the end point of the Cubic Bezier
  84809. * @param nbPoints (integer) the wanted number of points in the curve
  84810. * @returns the created Curve3
  84811. */
  84812. static CreateCubicBezier(v0: DeepImmutable<Vector3>, v1: DeepImmutable<Vector3>, v2: DeepImmutable<Vector3>, v3: DeepImmutable<Vector3>, nbPoints: number): Curve3;
  84813. /**
  84814. * Returns a Curve3 object along a Hermite Spline curve : https://doc.babylonjs.com/how_to/how_to_use_curve3#hermite-spline
  84815. * @param p1 (Vector3) the origin point of the Hermite Spline
  84816. * @param t1 (Vector3) the tangent vector at the origin point
  84817. * @param p2 (Vector3) the end point of the Hermite Spline
  84818. * @param t2 (Vector3) the tangent vector at the end point
  84819. * @param nbPoints (integer) the wanted number of points in the curve
  84820. * @returns the created Curve3
  84821. */
  84822. static CreateHermiteSpline(p1: DeepImmutable<Vector3>, t1: DeepImmutable<Vector3>, p2: DeepImmutable<Vector3>, t2: DeepImmutable<Vector3>, nbPoints: number): Curve3;
  84823. /**
  84824. * Returns a Curve3 object along a CatmullRom Spline curve :
  84825. * @param points (array of Vector3) the points the spline must pass through. At least, four points required
  84826. * @param nbPoints (integer) the wanted number of points between each curve control points
  84827. * @param closed (boolean) optional with default false, when true forms a closed loop from the points
  84828. * @returns the created Curve3
  84829. */
  84830. static CreateCatmullRomSpline(points: DeepImmutable<Vector3[]>, nbPoints: number, closed?: boolean): Curve3;
  84831. /**
  84832. * A Curve3 object is a logical object, so not a mesh, to handle curves in the 3D geometric space.
  84833. * A Curve3 is designed from a series of successive Vector3.
  84834. * Tuto : https://doc.babylonjs.com/how_to/how_to_use_curve3#curve3-object
  84835. * @param points points which make up the curve
  84836. */
  84837. constructor(points: Vector3[]);
  84838. /**
  84839. * @returns the Curve3 stored array of successive Vector3
  84840. */
  84841. getPoints(): Vector3[];
  84842. /**
  84843. * @returns the computed length (float) of the curve.
  84844. */
  84845. length(): number;
  84846. /**
  84847. * Returns a new instance of Curve3 object : var curve = curveA.continue(curveB);
  84848. * This new Curve3 is built by translating and sticking the curveB at the end of the curveA.
  84849. * curveA and curveB keep unchanged.
  84850. * @param curve the curve to continue from this curve
  84851. * @returns the newly constructed curve
  84852. */
  84853. continue(curve: DeepImmutable<Curve3>): Curve3;
  84854. private _computeLength;
  84855. }
  84856. }
  84857. declare module BABYLON {
  84858. /**
  84859. * This represents the main contract an easing function should follow.
  84860. * Easing functions are used throughout the animation system.
  84861. * @see https://doc.babylonjs.com/babylon101/animations#easing-functions
  84862. */
  84863. export interface IEasingFunction {
  84864. /**
  84865. * Given an input gradient between 0 and 1, this returns the corrseponding value
  84866. * of the easing function.
  84867. * The link below provides some of the most common examples of easing functions.
  84868. * @see https://easings.net/
  84869. * @param gradient Defines the value between 0 and 1 we want the easing value for
  84870. * @returns the corresponding value on the curve defined by the easing function
  84871. */
  84872. ease(gradient: number): number;
  84873. }
  84874. /**
  84875. * Base class used for every default easing function.
  84876. * @see https://doc.babylonjs.com/babylon101/animations#easing-functions
  84877. */
  84878. export class EasingFunction implements IEasingFunction {
  84879. /**
  84880. * Interpolation follows the mathematical formula associated with the easing function.
  84881. */
  84882. static readonly EASINGMODE_EASEIN: number;
  84883. /**
  84884. * Interpolation follows 100% interpolation minus the output of the formula associated with the easing function.
  84885. */
  84886. static readonly EASINGMODE_EASEOUT: number;
  84887. /**
  84888. * Interpolation uses EaseIn for the first half of the animation and EaseOut for the second half.
  84889. */
  84890. static readonly EASINGMODE_EASEINOUT: number;
  84891. private _easingMode;
  84892. /**
  84893. * Sets the easing mode of the current function.
  84894. * @param easingMode Defines the willing mode (EASINGMODE_EASEIN, EASINGMODE_EASEOUT or EASINGMODE_EASEINOUT)
  84895. */
  84896. setEasingMode(easingMode: number): void;
  84897. /**
  84898. * Gets the current easing mode.
  84899. * @returns the easing mode
  84900. */
  84901. getEasingMode(): number;
  84902. /**
  84903. * @hidden
  84904. */
  84905. easeInCore(gradient: number): number;
  84906. /**
  84907. * Given an input gradient between 0 and 1, this returns the corresponding value
  84908. * of the easing function.
  84909. * @param gradient Defines the value between 0 and 1 we want the easing value for
  84910. * @returns the corresponding value on the curve defined by the easing function
  84911. */
  84912. ease(gradient: number): number;
  84913. }
  84914. /**
  84915. * Easing function with a circle shape (see link below).
  84916. * @see https://easings.net/#easeInCirc
  84917. * @see https://doc.babylonjs.com/babylon101/animations#easing-functions
  84918. */
  84919. export class CircleEase extends EasingFunction implements IEasingFunction {
  84920. /** @hidden */
  84921. easeInCore(gradient: number): number;
  84922. }
  84923. /**
  84924. * Easing function with a ease back shape (see link below).
  84925. * @see https://easings.net/#easeInBack
  84926. * @see https://doc.babylonjs.com/babylon101/animations#easing-functions
  84927. */
  84928. export class BackEase extends EasingFunction implements IEasingFunction {
  84929. /** Defines the amplitude of the function */
  84930. amplitude: number;
  84931. /**
  84932. * Instantiates a back ease easing
  84933. * @see https://easings.net/#easeInBack
  84934. * @param amplitude Defines the amplitude of the function
  84935. */
  84936. constructor(
  84937. /** Defines the amplitude of the function */
  84938. amplitude?: number);
  84939. /** @hidden */
  84940. easeInCore(gradient: number): number;
  84941. }
  84942. /**
  84943. * Easing function with a bouncing shape (see link below).
  84944. * @see https://easings.net/#easeInBounce
  84945. * @see https://doc.babylonjs.com/babylon101/animations#easing-functions
  84946. */
  84947. export class BounceEase extends EasingFunction implements IEasingFunction {
  84948. /** Defines the number of bounces */
  84949. bounces: number;
  84950. /** Defines the amplitude of the bounce */
  84951. bounciness: number;
  84952. /**
  84953. * Instantiates a bounce easing
  84954. * @see https://easings.net/#easeInBounce
  84955. * @param bounces Defines the number of bounces
  84956. * @param bounciness Defines the amplitude of the bounce
  84957. */
  84958. constructor(
  84959. /** Defines the number of bounces */
  84960. bounces?: number,
  84961. /** Defines the amplitude of the bounce */
  84962. bounciness?: number);
  84963. /** @hidden */
  84964. easeInCore(gradient: number): number;
  84965. }
  84966. /**
  84967. * Easing function with a power of 3 shape (see link below).
  84968. * @see https://easings.net/#easeInCubic
  84969. * @see https://doc.babylonjs.com/babylon101/animations#easing-functions
  84970. */
  84971. export class CubicEase extends EasingFunction implements IEasingFunction {
  84972. /** @hidden */
  84973. easeInCore(gradient: number): number;
  84974. }
  84975. /**
  84976. * Easing function with an elastic shape (see link below).
  84977. * @see https://easings.net/#easeInElastic
  84978. * @see https://doc.babylonjs.com/babylon101/animations#easing-functions
  84979. */
  84980. export class ElasticEase extends EasingFunction implements IEasingFunction {
  84981. /** Defines the number of oscillations*/
  84982. oscillations: number;
  84983. /** Defines the amplitude of the oscillations*/
  84984. springiness: number;
  84985. /**
  84986. * Instantiates an elastic easing function
  84987. * @see https://easings.net/#easeInElastic
  84988. * @param oscillations Defines the number of oscillations
  84989. * @param springiness Defines the amplitude of the oscillations
  84990. */
  84991. constructor(
  84992. /** Defines the number of oscillations*/
  84993. oscillations?: number,
  84994. /** Defines the amplitude of the oscillations*/
  84995. springiness?: number);
  84996. /** @hidden */
  84997. easeInCore(gradient: number): number;
  84998. }
  84999. /**
  85000. * Easing function with an exponential shape (see link below).
  85001. * @see https://easings.net/#easeInExpo
  85002. * @see https://doc.babylonjs.com/babylon101/animations#easing-functions
  85003. */
  85004. export class ExponentialEase extends EasingFunction implements IEasingFunction {
  85005. /** Defines the exponent of the function */
  85006. exponent: number;
  85007. /**
  85008. * Instantiates an exponential easing function
  85009. * @see https://easings.net/#easeInExpo
  85010. * @param exponent Defines the exponent of the function
  85011. */
  85012. constructor(
  85013. /** Defines the exponent of the function */
  85014. exponent?: number);
  85015. /** @hidden */
  85016. easeInCore(gradient: number): number;
  85017. }
  85018. /**
  85019. * Easing function with a power shape (see link below).
  85020. * @see https://easings.net/#easeInQuad
  85021. * @see https://doc.babylonjs.com/babylon101/animations#easing-functions
  85022. */
  85023. export class PowerEase extends EasingFunction implements IEasingFunction {
  85024. /** Defines the power of the function */
  85025. power: number;
  85026. /**
  85027. * Instantiates an power base easing function
  85028. * @see https://easings.net/#easeInQuad
  85029. * @param power Defines the power of the function
  85030. */
  85031. constructor(
  85032. /** Defines the power of the function */
  85033. power?: number);
  85034. /** @hidden */
  85035. easeInCore(gradient: number): number;
  85036. }
  85037. /**
  85038. * Easing function with a power of 2 shape (see link below).
  85039. * @see https://easings.net/#easeInQuad
  85040. * @see https://doc.babylonjs.com/babylon101/animations#easing-functions
  85041. */
  85042. export class QuadraticEase extends EasingFunction implements IEasingFunction {
  85043. /** @hidden */
  85044. easeInCore(gradient: number): number;
  85045. }
  85046. /**
  85047. * Easing function with a power of 4 shape (see link below).
  85048. * @see https://easings.net/#easeInQuart
  85049. * @see https://doc.babylonjs.com/babylon101/animations#easing-functions
  85050. */
  85051. export class QuarticEase extends EasingFunction implements IEasingFunction {
  85052. /** @hidden */
  85053. easeInCore(gradient: number): number;
  85054. }
  85055. /**
  85056. * Easing function with a power of 5 shape (see link below).
  85057. * @see https://easings.net/#easeInQuint
  85058. * @see https://doc.babylonjs.com/babylon101/animations#easing-functions
  85059. */
  85060. export class QuinticEase extends EasingFunction implements IEasingFunction {
  85061. /** @hidden */
  85062. easeInCore(gradient: number): number;
  85063. }
  85064. /**
  85065. * Easing function with a sin shape (see link below).
  85066. * @see https://easings.net/#easeInSine
  85067. * @see https://doc.babylonjs.com/babylon101/animations#easing-functions
  85068. */
  85069. export class SineEase extends EasingFunction implements IEasingFunction {
  85070. /** @hidden */
  85071. easeInCore(gradient: number): number;
  85072. }
  85073. /**
  85074. * Easing function with a bezier shape (see link below).
  85075. * @see http://cubic-bezier.com/#.17,.67,.83,.67
  85076. * @see https://doc.babylonjs.com/babylon101/animations#easing-functions
  85077. */
  85078. export class BezierCurveEase extends EasingFunction implements IEasingFunction {
  85079. /** Defines the x component of the start tangent in the bezier curve */
  85080. x1: number;
  85081. /** Defines the y component of the start tangent in the bezier curve */
  85082. y1: number;
  85083. /** Defines the x component of the end tangent in the bezier curve */
  85084. x2: number;
  85085. /** Defines the y component of the end tangent in the bezier curve */
  85086. y2: number;
  85087. /**
  85088. * Instantiates a bezier function
  85089. * @see http://cubic-bezier.com/#.17,.67,.83,.67
  85090. * @param x1 Defines the x component of the start tangent in the bezier curve
  85091. * @param y1 Defines the y component of the start tangent in the bezier curve
  85092. * @param x2 Defines the x component of the end tangent in the bezier curve
  85093. * @param y2 Defines the y component of the end tangent in the bezier curve
  85094. */
  85095. constructor(
  85096. /** Defines the x component of the start tangent in the bezier curve */
  85097. x1?: number,
  85098. /** Defines the y component of the start tangent in the bezier curve */
  85099. y1?: number,
  85100. /** Defines the x component of the end tangent in the bezier curve */
  85101. x2?: number,
  85102. /** Defines the y component of the end tangent in the bezier curve */
  85103. y2?: number);
  85104. /** @hidden */
  85105. easeInCore(gradient: number): number;
  85106. }
  85107. }
  85108. declare module BABYLON {
  85109. /**
  85110. * Class used to hold a RBG color
  85111. */
  85112. export class Color3 {
  85113. /**
  85114. * Defines the red component (between 0 and 1, default is 0)
  85115. */
  85116. r: number;
  85117. /**
  85118. * Defines the green component (between 0 and 1, default is 0)
  85119. */
  85120. g: number;
  85121. /**
  85122. * Defines the blue component (between 0 and 1, default is 0)
  85123. */
  85124. b: number;
  85125. /**
  85126. * Creates a new Color3 object from red, green, blue values, all between 0 and 1
  85127. * @param r defines the red component (between 0 and 1, default is 0)
  85128. * @param g defines the green component (between 0 and 1, default is 0)
  85129. * @param b defines the blue component (between 0 and 1, default is 0)
  85130. */
  85131. constructor(
  85132. /**
  85133. * Defines the red component (between 0 and 1, default is 0)
  85134. */
  85135. r?: number,
  85136. /**
  85137. * Defines the green component (between 0 and 1, default is 0)
  85138. */
  85139. g?: number,
  85140. /**
  85141. * Defines the blue component (between 0 and 1, default is 0)
  85142. */
  85143. b?: number);
  85144. /**
  85145. * Creates a string with the Color3 current values
  85146. * @returns the string representation of the Color3 object
  85147. */
  85148. toString(): string;
  85149. /**
  85150. * Returns the string "Color3"
  85151. * @returns "Color3"
  85152. */
  85153. getClassName(): string;
  85154. /**
  85155. * Compute the Color3 hash code
  85156. * @returns an unique number that can be used to hash Color3 objects
  85157. */
  85158. getHashCode(): number;
  85159. /**
  85160. * Stores in the given array from the given starting index the red, green, blue values as successive elements
  85161. * @param array defines the array where to store the r,g,b components
  85162. * @param index defines an optional index in the target array to define where to start storing values
  85163. * @returns the current Color3 object
  85164. */
  85165. toArray(array: FloatArray, index?: number): Color3;
  85166. /**
  85167. * Update the current color with values stored in an array from the starting index of the given array
  85168. * @param array defines the source array
  85169. * @param offset defines an offset in the source array
  85170. * @returns the current Color3 object
  85171. */
  85172. fromArray(array: DeepImmutable<ArrayLike<number>>, offset?: number): Color3;
  85173. /**
  85174. * Returns a new Color4 object from the current Color3 and the given alpha
  85175. * @param alpha defines the alpha component on the new Color4 object (default is 1)
  85176. * @returns a new Color4 object
  85177. */
  85178. toColor4(alpha?: number): Color4;
  85179. /**
  85180. * Returns a new array populated with 3 numeric elements : red, green and blue values
  85181. * @returns the new array
  85182. */
  85183. asArray(): number[];
  85184. /**
  85185. * Returns the luminance value
  85186. * @returns a float value
  85187. */
  85188. toLuminance(): number;
  85189. /**
  85190. * Multiply each Color3 rgb values by the given Color3 rgb values in a new Color3 object
  85191. * @param otherColor defines the second operand
  85192. * @returns the new Color3 object
  85193. */
  85194. multiply(otherColor: DeepImmutable<Color3>): Color3;
  85195. /**
  85196. * Multiply the rgb values of the Color3 and the given Color3 and stores the result in the object "result"
  85197. * @param otherColor defines the second operand
  85198. * @param result defines the Color3 object where to store the result
  85199. * @returns the current Color3
  85200. */
  85201. multiplyToRef(otherColor: DeepImmutable<Color3>, result: Color3): Color3;
  85202. /**
  85203. * Determines equality between Color3 objects
  85204. * @param otherColor defines the second operand
  85205. * @returns true if the rgb values are equal to the given ones
  85206. */
  85207. equals(otherColor: DeepImmutable<Color3>): boolean;
  85208. /**
  85209. * Determines equality between the current Color3 object and a set of r,b,g values
  85210. * @param r defines the red component to check
  85211. * @param g defines the green component to check
  85212. * @param b defines the blue component to check
  85213. * @returns true if the rgb values are equal to the given ones
  85214. */
  85215. equalsFloats(r: number, g: number, b: number): boolean;
  85216. /**
  85217. * Multiplies in place each rgb value by scale
  85218. * @param scale defines the scaling factor
  85219. * @returns the updated Color3
  85220. */
  85221. scale(scale: number): Color3;
  85222. /**
  85223. * Multiplies the rgb values by scale and stores the result into "result"
  85224. * @param scale defines the scaling factor
  85225. * @param result defines the Color3 object where to store the result
  85226. * @returns the unmodified current Color3
  85227. */
  85228. scaleToRef(scale: number, result: Color3): Color3;
  85229. /**
  85230. * Scale the current Color3 values by a factor and add the result to a given Color3
  85231. * @param scale defines the scale factor
  85232. * @param result defines color to store the result into
  85233. * @returns the unmodified current Color3
  85234. */
  85235. scaleAndAddToRef(scale: number, result: Color3): Color3;
  85236. /**
  85237. * Clamps the rgb values by the min and max values and stores the result into "result"
  85238. * @param min defines minimum clamping value (default is 0)
  85239. * @param max defines maximum clamping value (default is 1)
  85240. * @param result defines color to store the result into
  85241. * @returns the original Color3
  85242. */
  85243. clampToRef(min: number | undefined, max: number | undefined, result: Color3): Color3;
  85244. /**
  85245. * Creates a new Color3 set with the added values of the current Color3 and of the given one
  85246. * @param otherColor defines the second operand
  85247. * @returns the new Color3
  85248. */
  85249. add(otherColor: DeepImmutable<Color3>): Color3;
  85250. /**
  85251. * Stores the result of the addition of the current Color3 and given one rgb values into "result"
  85252. * @param otherColor defines the second operand
  85253. * @param result defines Color3 object to store the result into
  85254. * @returns the unmodified current Color3
  85255. */
  85256. addToRef(otherColor: DeepImmutable<Color3>, result: Color3): Color3;
  85257. /**
  85258. * Returns a new Color3 set with the subtracted values of the given one from the current Color3
  85259. * @param otherColor defines the second operand
  85260. * @returns the new Color3
  85261. */
  85262. subtract(otherColor: DeepImmutable<Color3>): Color3;
  85263. /**
  85264. * Stores the result of the subtraction of given one from the current Color3 rgb values into "result"
  85265. * @param otherColor defines the second operand
  85266. * @param result defines Color3 object to store the result into
  85267. * @returns the unmodified current Color3
  85268. */
  85269. subtractToRef(otherColor: DeepImmutable<Color3>, result: Color3): Color3;
  85270. /**
  85271. * Copy the current object
  85272. * @returns a new Color3 copied the current one
  85273. */
  85274. clone(): Color3;
  85275. /**
  85276. * Copies the rgb values from the source in the current Color3
  85277. * @param source defines the source Color3 object
  85278. * @returns the updated Color3 object
  85279. */
  85280. copyFrom(source: DeepImmutable<Color3>): Color3;
  85281. /**
  85282. * Updates the Color3 rgb values from the given floats
  85283. * @param r defines the red component to read from
  85284. * @param g defines the green component to read from
  85285. * @param b defines the blue component to read from
  85286. * @returns the current Color3 object
  85287. */
  85288. copyFromFloats(r: number, g: number, b: number): Color3;
  85289. /**
  85290. * Updates the Color3 rgb values from the given floats
  85291. * @param r defines the red component to read from
  85292. * @param g defines the green component to read from
  85293. * @param b defines the blue component to read from
  85294. * @returns the current Color3 object
  85295. */
  85296. set(r: number, g: number, b: number): Color3;
  85297. /**
  85298. * Compute the Color3 hexadecimal code as a string
  85299. * @returns a string containing the hexadecimal representation of the Color3 object
  85300. */
  85301. toHexString(): string;
  85302. /**
  85303. * Computes a new Color3 converted from the current one to linear space
  85304. * @returns a new Color3 object
  85305. */
  85306. toLinearSpace(): Color3;
  85307. /**
  85308. * Converts current color in rgb space to HSV values
  85309. * @returns a new color3 representing the HSV values
  85310. */
  85311. toHSV(): Color3;
  85312. /**
  85313. * Converts current color in rgb space to HSV values
  85314. * @param result defines the Color3 where to store the HSV values
  85315. */
  85316. toHSVToRef(result: Color3): void;
  85317. /**
  85318. * Converts the Color3 values to linear space and stores the result in "convertedColor"
  85319. * @param convertedColor defines the Color3 object where to store the linear space version
  85320. * @returns the unmodified Color3
  85321. */
  85322. toLinearSpaceToRef(convertedColor: Color3): Color3;
  85323. /**
  85324. * Computes a new Color3 converted from the current one to gamma space
  85325. * @returns a new Color3 object
  85326. */
  85327. toGammaSpace(): Color3;
  85328. /**
  85329. * Converts the Color3 values to gamma space and stores the result in "convertedColor"
  85330. * @param convertedColor defines the Color3 object where to store the gamma space version
  85331. * @returns the unmodified Color3
  85332. */
  85333. toGammaSpaceToRef(convertedColor: Color3): Color3;
  85334. private static _BlackReadOnly;
  85335. /**
  85336. * Convert Hue, saturation and value to a Color3 (RGB)
  85337. * @param hue defines the hue
  85338. * @param saturation defines the saturation
  85339. * @param value defines the value
  85340. * @param result defines the Color3 where to store the RGB values
  85341. */
  85342. static HSVtoRGBToRef(hue: number, saturation: number, value: number, result: Color3): void;
  85343. /**
  85344. * Creates a new Color3 from the string containing valid hexadecimal values
  85345. * @param hex defines a string containing valid hexadecimal values
  85346. * @returns a new Color3 object
  85347. */
  85348. static FromHexString(hex: string): Color3;
  85349. /**
  85350. * Creates a new Color3 from the starting index of the given array
  85351. * @param array defines the source array
  85352. * @param offset defines an offset in the source array
  85353. * @returns a new Color3 object
  85354. */
  85355. static FromArray(array: DeepImmutable<ArrayLike<number>>, offset?: number): Color3;
  85356. /**
  85357. * Creates a new Color3 from the starting index element of the given array
  85358. * @param array defines the source array to read from
  85359. * @param offset defines the offset in the source array
  85360. * @param result defines the target Color3 object
  85361. */
  85362. static FromArrayToRef(array: DeepImmutable<ArrayLike<number>>, offset: number | undefined, result: Color3): void;
  85363. /**
  85364. * Creates a new Color3 from integer values (< 256)
  85365. * @param r defines the red component to read from (value between 0 and 255)
  85366. * @param g defines the green component to read from (value between 0 and 255)
  85367. * @param b defines the blue component to read from (value between 0 and 255)
  85368. * @returns a new Color3 object
  85369. */
  85370. static FromInts(r: number, g: number, b: number): Color3;
  85371. /**
  85372. * Creates a new Color3 with values linearly interpolated of "amount" between the start Color3 and the end Color3
  85373. * @param start defines the start Color3 value
  85374. * @param end defines the end Color3 value
  85375. * @param amount defines the gradient value between start and end
  85376. * @returns a new Color3 object
  85377. */
  85378. static Lerp(start: DeepImmutable<Color3>, end: DeepImmutable<Color3>, amount: number): Color3;
  85379. /**
  85380. * Creates a new Color3 with values linearly interpolated of "amount" between the start Color3 and the end Color3
  85381. * @param left defines the start value
  85382. * @param right defines the end value
  85383. * @param amount defines the gradient factor
  85384. * @param result defines the Color3 object where to store the result
  85385. */
  85386. static LerpToRef(left: DeepImmutable<Color3>, right: DeepImmutable<Color3>, amount: number, result: Color3): void;
  85387. /**
  85388. * Returns a Color3 value containing a red color
  85389. * @returns a new Color3 object
  85390. */
  85391. static Red(): Color3;
  85392. /**
  85393. * Returns a Color3 value containing a green color
  85394. * @returns a new Color3 object
  85395. */
  85396. static Green(): Color3;
  85397. /**
  85398. * Returns a Color3 value containing a blue color
  85399. * @returns a new Color3 object
  85400. */
  85401. static Blue(): Color3;
  85402. /**
  85403. * Returns a Color3 value containing a black color
  85404. * @returns a new Color3 object
  85405. */
  85406. static Black(): Color3;
  85407. /**
  85408. * Gets a Color3 value containing a black color that must not be updated
  85409. */
  85410. static get BlackReadOnly(): DeepImmutable<Color3>;
  85411. /**
  85412. * Returns a Color3 value containing a white color
  85413. * @returns a new Color3 object
  85414. */
  85415. static White(): Color3;
  85416. /**
  85417. * Returns a Color3 value containing a purple color
  85418. * @returns a new Color3 object
  85419. */
  85420. static Purple(): Color3;
  85421. /**
  85422. * Returns a Color3 value containing a magenta color
  85423. * @returns a new Color3 object
  85424. */
  85425. static Magenta(): Color3;
  85426. /**
  85427. * Returns a Color3 value containing a yellow color
  85428. * @returns a new Color3 object
  85429. */
  85430. static Yellow(): Color3;
  85431. /**
  85432. * Returns a Color3 value containing a gray color
  85433. * @returns a new Color3 object
  85434. */
  85435. static Gray(): Color3;
  85436. /**
  85437. * Returns a Color3 value containing a teal color
  85438. * @returns a new Color3 object
  85439. */
  85440. static Teal(): Color3;
  85441. /**
  85442. * Returns a Color3 value containing a random color
  85443. * @returns a new Color3 object
  85444. */
  85445. static Random(): Color3;
  85446. }
  85447. /**
  85448. * Class used to hold a RBGA color
  85449. */
  85450. export class Color4 {
  85451. /**
  85452. * Defines the red component (between 0 and 1, default is 0)
  85453. */
  85454. r: number;
  85455. /**
  85456. * Defines the green component (between 0 and 1, default is 0)
  85457. */
  85458. g: number;
  85459. /**
  85460. * Defines the blue component (between 0 and 1, default is 0)
  85461. */
  85462. b: number;
  85463. /**
  85464. * Defines the alpha component (between 0 and 1, default is 1)
  85465. */
  85466. a: number;
  85467. /**
  85468. * Creates a new Color4 object from red, green, blue values, all between 0 and 1
  85469. * @param r defines the red component (between 0 and 1, default is 0)
  85470. * @param g defines the green component (between 0 and 1, default is 0)
  85471. * @param b defines the blue component (between 0 and 1, default is 0)
  85472. * @param a defines the alpha component (between 0 and 1, default is 1)
  85473. */
  85474. constructor(
  85475. /**
  85476. * Defines the red component (between 0 and 1, default is 0)
  85477. */
  85478. r?: number,
  85479. /**
  85480. * Defines the green component (between 0 and 1, default is 0)
  85481. */
  85482. g?: number,
  85483. /**
  85484. * Defines the blue component (between 0 and 1, default is 0)
  85485. */
  85486. b?: number,
  85487. /**
  85488. * Defines the alpha component (between 0 and 1, default is 1)
  85489. */
  85490. a?: number);
  85491. /**
  85492. * Adds in place the given Color4 values to the current Color4 object
  85493. * @param right defines the second operand
  85494. * @returns the current updated Color4 object
  85495. */
  85496. addInPlace(right: DeepImmutable<Color4>): Color4;
  85497. /**
  85498. * Creates a new array populated with 4 numeric elements : red, green, blue, alpha values
  85499. * @returns the new array
  85500. */
  85501. asArray(): number[];
  85502. /**
  85503. * Stores from the starting index in the given array the Color4 successive values
  85504. * @param array defines the array where to store the r,g,b components
  85505. * @param index defines an optional index in the target array to define where to start storing values
  85506. * @returns the current Color4 object
  85507. */
  85508. toArray(array: number[], index?: number): Color4;
  85509. /**
  85510. * Update the current color with values stored in an array from the starting index of the given array
  85511. * @param array defines the source array
  85512. * @param offset defines an offset in the source array
  85513. * @returns the current Color4 object
  85514. */
  85515. fromArray(array: DeepImmutable<ArrayLike<number>>, offset?: number): Color4;
  85516. /**
  85517. * Determines equality between Color4 objects
  85518. * @param otherColor defines the second operand
  85519. * @returns true if the rgba values are equal to the given ones
  85520. */
  85521. equals(otherColor: DeepImmutable<Color4>): boolean;
  85522. /**
  85523. * Creates a new Color4 set with the added values of the current Color4 and of the given one
  85524. * @param right defines the second operand
  85525. * @returns a new Color4 object
  85526. */
  85527. add(right: DeepImmutable<Color4>): Color4;
  85528. /**
  85529. * Creates a new Color4 set with the subtracted values of the given one from the current Color4
  85530. * @param right defines the second operand
  85531. * @returns a new Color4 object
  85532. */
  85533. subtract(right: DeepImmutable<Color4>): Color4;
  85534. /**
  85535. * Subtracts the given ones from the current Color4 values and stores the results in "result"
  85536. * @param right defines the second operand
  85537. * @param result defines the Color4 object where to store the result
  85538. * @returns the current Color4 object
  85539. */
  85540. subtractToRef(right: DeepImmutable<Color4>, result: Color4): Color4;
  85541. /**
  85542. * Creates a new Color4 with the current Color4 values multiplied by scale
  85543. * @param scale defines the scaling factor to apply
  85544. * @returns a new Color4 object
  85545. */
  85546. scale(scale: number): Color4;
  85547. /**
  85548. * Multiplies the current Color4 values by scale and stores the result in "result"
  85549. * @param scale defines the scaling factor to apply
  85550. * @param result defines the Color4 object where to store the result
  85551. * @returns the current unmodified Color4
  85552. */
  85553. scaleToRef(scale: number, result: Color4): Color4;
  85554. /**
  85555. * Scale the current Color4 values by a factor and add the result to a given Color4
  85556. * @param scale defines the scale factor
  85557. * @param result defines the Color4 object where to store the result
  85558. * @returns the unmodified current Color4
  85559. */
  85560. scaleAndAddToRef(scale: number, result: Color4): Color4;
  85561. /**
  85562. * Clamps the rgb values by the min and max values and stores the result into "result"
  85563. * @param min defines minimum clamping value (default is 0)
  85564. * @param max defines maximum clamping value (default is 1)
  85565. * @param result defines color to store the result into.
  85566. * @returns the cuurent Color4
  85567. */
  85568. clampToRef(min: number | undefined, max: number | undefined, result: Color4): Color4;
  85569. /**
  85570. * Multipy an Color4 value by another and return a new Color4 object
  85571. * @param color defines the Color4 value to multiply by
  85572. * @returns a new Color4 object
  85573. */
  85574. multiply(color: Color4): Color4;
  85575. /**
  85576. * Multipy a Color4 value by another and push the result in a reference value
  85577. * @param color defines the Color4 value to multiply by
  85578. * @param result defines the Color4 to fill the result in
  85579. * @returns the result Color4
  85580. */
  85581. multiplyToRef(color: Color4, result: Color4): Color4;
  85582. /**
  85583. * Creates a string with the Color4 current values
  85584. * @returns the string representation of the Color4 object
  85585. */
  85586. toString(): string;
  85587. /**
  85588. * Returns the string "Color4"
  85589. * @returns "Color4"
  85590. */
  85591. getClassName(): string;
  85592. /**
  85593. * Compute the Color4 hash code
  85594. * @returns an unique number that can be used to hash Color4 objects
  85595. */
  85596. getHashCode(): number;
  85597. /**
  85598. * Creates a new Color4 copied from the current one
  85599. * @returns a new Color4 object
  85600. */
  85601. clone(): Color4;
  85602. /**
  85603. * Copies the given Color4 values into the current one
  85604. * @param source defines the source Color4 object
  85605. * @returns the current updated Color4 object
  85606. */
  85607. copyFrom(source: Color4): Color4;
  85608. /**
  85609. * Copies the given float values into the current one
  85610. * @param r defines the red component to read from
  85611. * @param g defines the green component to read from
  85612. * @param b defines the blue component to read from
  85613. * @param a defines the alpha component to read from
  85614. * @returns the current updated Color4 object
  85615. */
  85616. copyFromFloats(r: number, g: number, b: number, a: number): Color4;
  85617. /**
  85618. * Copies the given float values into the current one
  85619. * @param r defines the red component to read from
  85620. * @param g defines the green component to read from
  85621. * @param b defines the blue component to read from
  85622. * @param a defines the alpha component to read from
  85623. * @returns the current updated Color4 object
  85624. */
  85625. set(r: number, g: number, b: number, a: number): Color4;
  85626. /**
  85627. * Compute the Color4 hexadecimal code as a string
  85628. * @param returnAsColor3 defines if the string should only contains RGB values (off by default)
  85629. * @returns a string containing the hexadecimal representation of the Color4 object
  85630. */
  85631. toHexString(returnAsColor3?: boolean): string;
  85632. /**
  85633. * Computes a new Color4 converted from the current one to linear space
  85634. * @returns a new Color4 object
  85635. */
  85636. toLinearSpace(): Color4;
  85637. /**
  85638. * Converts the Color4 values to linear space and stores the result in "convertedColor"
  85639. * @param convertedColor defines the Color4 object where to store the linear space version
  85640. * @returns the unmodified Color4
  85641. */
  85642. toLinearSpaceToRef(convertedColor: Color4): Color4;
  85643. /**
  85644. * Computes a new Color4 converted from the current one to gamma space
  85645. * @returns a new Color4 object
  85646. */
  85647. toGammaSpace(): Color4;
  85648. /**
  85649. * Converts the Color4 values to gamma space and stores the result in "convertedColor"
  85650. * @param convertedColor defines the Color4 object where to store the gamma space version
  85651. * @returns the unmodified Color4
  85652. */
  85653. toGammaSpaceToRef(convertedColor: Color4): Color4;
  85654. /**
  85655. * Creates a new Color4 from the string containing valid hexadecimal values
  85656. * @param hex defines a string containing valid hexadecimal values
  85657. * @returns a new Color4 object
  85658. */
  85659. static FromHexString(hex: string): Color4;
  85660. /**
  85661. * Creates a new Color4 object set with the linearly interpolated values of "amount" between the left Color4 object and the right Color4 object
  85662. * @param left defines the start value
  85663. * @param right defines the end value
  85664. * @param amount defines the gradient factor
  85665. * @returns a new Color4 object
  85666. */
  85667. static Lerp(left: DeepImmutable<Color4>, right: DeepImmutable<Color4>, amount: number): Color4;
  85668. /**
  85669. * Set the given "result" with the linearly interpolated values of "amount" between the left Color4 object and the right Color4 object
  85670. * @param left defines the start value
  85671. * @param right defines the end value
  85672. * @param amount defines the gradient factor
  85673. * @param result defines the Color4 object where to store data
  85674. */
  85675. static LerpToRef(left: DeepImmutable<Color4>, right: DeepImmutable<Color4>, amount: number, result: Color4): void;
  85676. /**
  85677. * Creates a new Color4 from a Color3 and an alpha value
  85678. * @param color3 defines the source Color3 to read from
  85679. * @param alpha defines the alpha component (1.0 by default)
  85680. * @returns a new Color4 object
  85681. */
  85682. static FromColor3(color3: DeepImmutable<Color3>, alpha?: number): Color4;
  85683. /**
  85684. * Creates a new Color4 from the starting index element of the given array
  85685. * @param array defines the source array to read from
  85686. * @param offset defines the offset in the source array
  85687. * @returns a new Color4 object
  85688. */
  85689. static FromArray(array: DeepImmutable<ArrayLike<number>>, offset?: number): Color4;
  85690. /**
  85691. * Creates a new Color4 from the starting index element of the given array
  85692. * @param array defines the source array to read from
  85693. * @param offset defines the offset in the source array
  85694. * @param result defines the target Color4 object
  85695. */
  85696. static FromArrayToRef(array: DeepImmutable<ArrayLike<number>>, offset: number | undefined, result: Color4): void;
  85697. /**
  85698. * Creates a new Color3 from integer values (< 256)
  85699. * @param r defines the red component to read from (value between 0 and 255)
  85700. * @param g defines the green component to read from (value between 0 and 255)
  85701. * @param b defines the blue component to read from (value between 0 and 255)
  85702. * @param a defines the alpha component to read from (value between 0 and 255)
  85703. * @returns a new Color3 object
  85704. */
  85705. static FromInts(r: number, g: number, b: number, a: number): Color4;
  85706. /**
  85707. * Check the content of a given array and convert it to an array containing RGBA data
  85708. * If the original array was already containing count * 4 values then it is returned directly
  85709. * @param colors defines the array to check
  85710. * @param count defines the number of RGBA data to expect
  85711. * @returns an array containing count * 4 values (RGBA)
  85712. */
  85713. static CheckColors4(colors: number[], count: number): number[];
  85714. }
  85715. /**
  85716. * @hidden
  85717. */
  85718. export class TmpColors {
  85719. static Color3: Color3[];
  85720. static Color4: Color4[];
  85721. }
  85722. }
  85723. declare module BABYLON {
  85724. /**
  85725. * Defines an interface which represents an animation key frame
  85726. */
  85727. export interface IAnimationKey {
  85728. /**
  85729. * Frame of the key frame
  85730. */
  85731. frame: number;
  85732. /**
  85733. * Value at the specifies key frame
  85734. */
  85735. value: any;
  85736. /**
  85737. * The input tangent for the cubic hermite spline
  85738. */
  85739. inTangent?: any;
  85740. /**
  85741. * The output tangent for the cubic hermite spline
  85742. */
  85743. outTangent?: any;
  85744. /**
  85745. * The animation interpolation type
  85746. */
  85747. interpolation?: AnimationKeyInterpolation;
  85748. }
  85749. /**
  85750. * Enum for the animation key frame interpolation type
  85751. */
  85752. export enum AnimationKeyInterpolation {
  85753. /**
  85754. * Do not interpolate between keys and use the start key value only. Tangents are ignored
  85755. */
  85756. STEP = 1
  85757. }
  85758. }
  85759. declare module BABYLON {
  85760. /**
  85761. * Represents the range of an animation
  85762. */
  85763. export class AnimationRange {
  85764. /**The name of the animation range**/
  85765. name: string;
  85766. /**The starting frame of the animation */
  85767. from: number;
  85768. /**The ending frame of the animation*/
  85769. to: number;
  85770. /**
  85771. * Initializes the range of an animation
  85772. * @param name The name of the animation range
  85773. * @param from The starting frame of the animation
  85774. * @param to The ending frame of the animation
  85775. */
  85776. constructor(
  85777. /**The name of the animation range**/
  85778. name: string,
  85779. /**The starting frame of the animation */
  85780. from: number,
  85781. /**The ending frame of the animation*/
  85782. to: number);
  85783. /**
  85784. * Makes a copy of the animation range
  85785. * @returns A copy of the animation range
  85786. */
  85787. clone(): AnimationRange;
  85788. }
  85789. }
  85790. declare module BABYLON {
  85791. /**
  85792. * Composed of a frame, and an action function
  85793. */
  85794. export class AnimationEvent {
  85795. /** The frame for which the event is triggered **/
  85796. frame: number;
  85797. /** The event to perform when triggered **/
  85798. action: (currentFrame: number) => void;
  85799. /** Specifies if the event should be triggered only once**/
  85800. onlyOnce?: boolean | undefined;
  85801. /**
  85802. * Specifies if the animation event is done
  85803. */
  85804. isDone: boolean;
  85805. /**
  85806. * Initializes the animation event
  85807. * @param frame The frame for which the event is triggered
  85808. * @param action The event to perform when triggered
  85809. * @param onlyOnce Specifies if the event should be triggered only once
  85810. */
  85811. constructor(
  85812. /** The frame for which the event is triggered **/
  85813. frame: number,
  85814. /** The event to perform when triggered **/
  85815. action: (currentFrame: number) => void,
  85816. /** Specifies if the event should be triggered only once**/
  85817. onlyOnce?: boolean | undefined);
  85818. /** @hidden */
  85819. _clone(): AnimationEvent;
  85820. }
  85821. }
  85822. declare module BABYLON {
  85823. /**
  85824. * Interface used to define a behavior
  85825. */
  85826. export interface Behavior<T> {
  85827. /** gets or sets behavior's name */
  85828. name: string;
  85829. /**
  85830. * Function called when the behavior needs to be initialized (after attaching it to a target)
  85831. */
  85832. init(): void;
  85833. /**
  85834. * Called when the behavior is attached to a target
  85835. * @param target defines the target where the behavior is attached to
  85836. */
  85837. attach(target: T): void;
  85838. /**
  85839. * Called when the behavior is detached from its target
  85840. */
  85841. detach(): void;
  85842. }
  85843. /**
  85844. * Interface implemented by classes supporting behaviors
  85845. */
  85846. export interface IBehaviorAware<T> {
  85847. /**
  85848. * Attach a behavior
  85849. * @param behavior defines the behavior to attach
  85850. * @returns the current host
  85851. */
  85852. addBehavior(behavior: Behavior<T>): T;
  85853. /**
  85854. * Remove a behavior from the current object
  85855. * @param behavior defines the behavior to detach
  85856. * @returns the current host
  85857. */
  85858. removeBehavior(behavior: Behavior<T>): T;
  85859. /**
  85860. * Gets a behavior using its name to search
  85861. * @param name defines the name to search
  85862. * @returns the behavior or null if not found
  85863. */
  85864. getBehaviorByName(name: string): Nullable<Behavior<T>>;
  85865. }
  85866. }
  85867. declare module BABYLON {
  85868. /**
  85869. * Defines an array and its length.
  85870. * It can be helpfull to group result from both Arrays and smart arrays in one structure.
  85871. */
  85872. export interface ISmartArrayLike<T> {
  85873. /**
  85874. * The data of the array.
  85875. */
  85876. data: Array<T>;
  85877. /**
  85878. * The active length of the array.
  85879. */
  85880. length: number;
  85881. }
  85882. /**
  85883. * Defines an GC Friendly array where the backfield array do not shrink to prevent over allocations.
  85884. */
  85885. export class SmartArray<T> implements ISmartArrayLike<T> {
  85886. /**
  85887. * The full set of data from the array.
  85888. */
  85889. data: Array<T>;
  85890. /**
  85891. * The active length of the array.
  85892. */
  85893. length: number;
  85894. protected _id: number;
  85895. /**
  85896. * Instantiates a Smart Array.
  85897. * @param capacity defines the default capacity of the array.
  85898. */
  85899. constructor(capacity: number);
  85900. /**
  85901. * Pushes a value at the end of the active data.
  85902. * @param value defines the object to push in the array.
  85903. */
  85904. push(value: T): void;
  85905. /**
  85906. * Iterates over the active data and apply the lambda to them.
  85907. * @param func defines the action to apply on each value.
  85908. */
  85909. forEach(func: (content: T) => void): void;
  85910. /**
  85911. * Sorts the full sets of data.
  85912. * @param compareFn defines the comparison function to apply.
  85913. */
  85914. sort(compareFn: (a: T, b: T) => number): void;
  85915. /**
  85916. * Resets the active data to an empty array.
  85917. */
  85918. reset(): void;
  85919. /**
  85920. * Releases all the data from the array as well as the array.
  85921. */
  85922. dispose(): void;
  85923. /**
  85924. * Concats the active data with a given array.
  85925. * @param array defines the data to concatenate with.
  85926. */
  85927. concat(array: any): void;
  85928. /**
  85929. * Returns the position of a value in the active data.
  85930. * @param value defines the value to find the index for
  85931. * @returns the index if found in the active data otherwise -1
  85932. */
  85933. indexOf(value: T): number;
  85934. /**
  85935. * Returns whether an element is part of the active data.
  85936. * @param value defines the value to look for
  85937. * @returns true if found in the active data otherwise false
  85938. */
  85939. contains(value: T): boolean;
  85940. private static _GlobalId;
  85941. }
  85942. /**
  85943. * Defines an GC Friendly array where the backfield array do not shrink to prevent over allocations.
  85944. * The data in this array can only be present once
  85945. */
  85946. export class SmartArrayNoDuplicate<T> extends SmartArray<T> {
  85947. private _duplicateId;
  85948. /**
  85949. * Pushes a value at the end of the active data.
  85950. * THIS DOES NOT PREVENT DUPPLICATE DATA
  85951. * @param value defines the object to push in the array.
  85952. */
  85953. push(value: T): void;
  85954. /**
  85955. * Pushes a value at the end of the active data.
  85956. * If the data is already present, it won t be added again
  85957. * @param value defines the object to push in the array.
  85958. * @returns true if added false if it was already present
  85959. */
  85960. pushNoDuplicate(value: T): boolean;
  85961. /**
  85962. * Resets the active data to an empty array.
  85963. */
  85964. reset(): void;
  85965. /**
  85966. * Concats the active data with a given array.
  85967. * This ensures no dupplicate will be present in the result.
  85968. * @param array defines the data to concatenate with.
  85969. */
  85970. concatWithNoDuplicate(array: any): void;
  85971. }
  85972. }
  85973. declare module BABYLON {
  85974. /**
  85975. * @ignore
  85976. * This is a list of all the different input types that are available in the application.
  85977. * Fo instance: ArcRotateCameraGamepadInput...
  85978. */
  85979. export var CameraInputTypes: {};
  85980. /**
  85981. * This is the contract to implement in order to create a new input class.
  85982. * Inputs are dealing with listening to user actions and moving the camera accordingly.
  85983. */
  85984. export interface ICameraInput<TCamera extends Camera> {
  85985. /**
  85986. * Defines the camera the input is attached to.
  85987. */
  85988. camera: Nullable<TCamera>;
  85989. /**
  85990. * Gets the class name of the current intput.
  85991. * @returns the class name
  85992. */
  85993. getClassName(): string;
  85994. /**
  85995. * Get the friendly name associated with the input class.
  85996. * @returns the input friendly name
  85997. */
  85998. getSimpleName(): string;
  85999. /**
  86000. * Attach the input controls to a specific dom element to get the input from.
  86001. * @param element Defines the element the controls should be listened from
  86002. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  86003. */
  86004. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  86005. /**
  86006. * Detach the current controls from the specified dom element.
  86007. * @param element Defines the element to stop listening the inputs from
  86008. */
  86009. detachControl(element: Nullable<HTMLElement>): void;
  86010. /**
  86011. * Update the current camera state depending on the inputs that have been used this frame.
  86012. * This is a dynamically created lambda to avoid the performance penalty of looping for inputs in the render loop.
  86013. */
  86014. checkInputs?: () => void;
  86015. }
  86016. /**
  86017. * Represents a map of input types to input instance or input index to input instance.
  86018. */
  86019. export interface CameraInputsMap<TCamera extends Camera> {
  86020. /**
  86021. * Accessor to the input by input type.
  86022. */
  86023. [name: string]: ICameraInput<TCamera>;
  86024. /**
  86025. * Accessor to the input by input index.
  86026. */
  86027. [idx: number]: ICameraInput<TCamera>;
  86028. }
  86029. /**
  86030. * This represents the input manager used within a camera.
  86031. * It helps dealing with all the different kind of input attached to a camera.
  86032. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  86033. */
  86034. export class CameraInputsManager<TCamera extends Camera> {
  86035. /**
  86036. * Defines the list of inputs attahed to the camera.
  86037. */
  86038. attached: CameraInputsMap<TCamera>;
  86039. /**
  86040. * Defines the dom element the camera is collecting inputs from.
  86041. * This is null if the controls have not been attached.
  86042. */
  86043. attachedElement: Nullable<HTMLElement>;
  86044. /**
  86045. * Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  86046. */
  86047. noPreventDefault: boolean;
  86048. /**
  86049. * Defined the camera the input manager belongs to.
  86050. */
  86051. camera: TCamera;
  86052. /**
  86053. * Update the current camera state depending on the inputs that have been used this frame.
  86054. * This is a dynamically created lambda to avoid the performance penalty of looping for inputs in the render loop.
  86055. */
  86056. checkInputs: () => void;
  86057. /**
  86058. * Instantiate a new Camera Input Manager.
  86059. * @param camera Defines the camera the input manager blongs to
  86060. */
  86061. constructor(camera: TCamera);
  86062. /**
  86063. * Add an input method to a camera
  86064. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  86065. * @param input camera input method
  86066. */
  86067. add(input: ICameraInput<TCamera>): void;
  86068. /**
  86069. * Remove a specific input method from a camera
  86070. * example: camera.inputs.remove(camera.inputs.attached.mouse);
  86071. * @param inputToRemove camera input method
  86072. */
  86073. remove(inputToRemove: ICameraInput<TCamera>): void;
  86074. /**
  86075. * Remove a specific input type from a camera
  86076. * example: camera.inputs.remove("ArcRotateCameraGamepadInput");
  86077. * @param inputType the type of the input to remove
  86078. */
  86079. removeByType(inputType: string): void;
  86080. private _addCheckInputs;
  86081. /**
  86082. * Attach the input controls to the currently attached dom element to listen the events from.
  86083. * @param input Defines the input to attach
  86084. */
  86085. attachInput(input: ICameraInput<TCamera>): void;
  86086. /**
  86087. * Attach the current manager inputs controls to a specific dom element to listen the events from.
  86088. * @param element Defines the dom element to collect the events from
  86089. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  86090. */
  86091. attachElement(element: HTMLElement, noPreventDefault?: boolean): void;
  86092. /**
  86093. * Detach the current manager inputs controls from a specific dom element.
  86094. * @param element Defines the dom element to collect the events from
  86095. * @param disconnect Defines whether the input should be removed from the current list of attached inputs
  86096. */
  86097. detachElement(element: HTMLElement, disconnect?: boolean): void;
  86098. /**
  86099. * Rebuild the dynamic inputCheck function from the current list of
  86100. * defined inputs in the manager.
  86101. */
  86102. rebuildInputCheck(): void;
  86103. /**
  86104. * Remove all attached input methods from a camera
  86105. */
  86106. clear(): void;
  86107. /**
  86108. * Serialize the current input manager attached to a camera.
  86109. * This ensures than once parsed,
  86110. * the input associated to the camera will be identical to the current ones
  86111. * @param serializedCamera Defines the camera serialization JSON the input serialization should write to
  86112. */
  86113. serialize(serializedCamera: any): void;
  86114. /**
  86115. * Parses an input manager serialized JSON to restore the previous list of inputs
  86116. * and states associated to a camera.
  86117. * @param parsedCamera Defines the JSON to parse
  86118. */
  86119. parse(parsedCamera: any): void;
  86120. }
  86121. }
  86122. declare module BABYLON {
  86123. /**
  86124. * Class used to store data that will be store in GPU memory
  86125. */
  86126. export class Buffer {
  86127. private _engine;
  86128. private _buffer;
  86129. /** @hidden */
  86130. _data: Nullable<DataArray>;
  86131. private _updatable;
  86132. private _instanced;
  86133. private _divisor;
  86134. /**
  86135. * Gets the byte stride.
  86136. */
  86137. readonly byteStride: number;
  86138. /**
  86139. * Constructor
  86140. * @param engine the engine
  86141. * @param data the data to use for this buffer
  86142. * @param updatable whether the data is updatable
  86143. * @param stride the stride (optional)
  86144. * @param postponeInternalCreation whether to postpone creating the internal WebGL buffer (optional)
  86145. * @param instanced whether the buffer is instanced (optional)
  86146. * @param useBytes set to true if the stride in in bytes (optional)
  86147. * @param divisor sets an optional divisor for instances (1 by default)
  86148. */
  86149. constructor(engine: any, data: DataArray, updatable: boolean, stride?: number, postponeInternalCreation?: boolean, instanced?: boolean, useBytes?: boolean, divisor?: number);
  86150. /**
  86151. * Create a new VertexBuffer based on the current buffer
  86152. * @param kind defines the vertex buffer kind (position, normal, etc.)
  86153. * @param offset defines offset in the buffer (0 by default)
  86154. * @param size defines the size in floats of attributes (position is 3 for instance)
  86155. * @param stride defines the stride size in floats in the buffer (the offset to apply to reach next value when data is interleaved)
  86156. * @param instanced defines if the vertex buffer contains indexed data
  86157. * @param useBytes defines if the offset and stride are in bytes *
  86158. * @param divisor sets an optional divisor for instances (1 by default)
  86159. * @returns the new vertex buffer
  86160. */
  86161. createVertexBuffer(kind: string, offset: number, size: number, stride?: number, instanced?: boolean, useBytes?: boolean, divisor?: number): VertexBuffer;
  86162. /**
  86163. * Gets a boolean indicating if the Buffer is updatable?
  86164. * @returns true if the buffer is updatable
  86165. */
  86166. isUpdatable(): boolean;
  86167. /**
  86168. * Gets current buffer's data
  86169. * @returns a DataArray or null
  86170. */
  86171. getData(): Nullable<DataArray>;
  86172. /**
  86173. * Gets underlying native buffer
  86174. * @returns underlying native buffer
  86175. */
  86176. getBuffer(): Nullable<DataBuffer>;
  86177. /**
  86178. * Gets the stride in float32 units (i.e. byte stride / 4).
  86179. * May not be an integer if the byte stride is not divisible by 4.
  86180. * @returns the stride in float32 units
  86181. * @deprecated Please use byteStride instead.
  86182. */
  86183. getStrideSize(): number;
  86184. /**
  86185. * Store data into the buffer. If the buffer was already used it will be either recreated or updated depending on isUpdatable property
  86186. * @param data defines the data to store
  86187. */
  86188. create(data?: Nullable<DataArray>): void;
  86189. /** @hidden */
  86190. _rebuild(): void;
  86191. /**
  86192. * Update current buffer data
  86193. * @param data defines the data to store
  86194. */
  86195. update(data: DataArray): void;
  86196. /**
  86197. * Updates the data directly.
  86198. * @param data the new data
  86199. * @param offset the new offset
  86200. * @param vertexCount the vertex count (optional)
  86201. * @param useBytes set to true if the offset is in bytes
  86202. */
  86203. updateDirectly(data: DataArray, offset: number, vertexCount?: number, useBytes?: boolean): void;
  86204. /**
  86205. * Release all resources
  86206. */
  86207. dispose(): void;
  86208. }
  86209. /**
  86210. * Specialized buffer used to store vertex data
  86211. */
  86212. export class VertexBuffer {
  86213. /** @hidden */
  86214. _buffer: Buffer;
  86215. private _kind;
  86216. private _size;
  86217. private _ownsBuffer;
  86218. private _instanced;
  86219. private _instanceDivisor;
  86220. /**
  86221. * The byte type.
  86222. */
  86223. static readonly BYTE: number;
  86224. /**
  86225. * The unsigned byte type.
  86226. */
  86227. static readonly UNSIGNED_BYTE: number;
  86228. /**
  86229. * The short type.
  86230. */
  86231. static readonly SHORT: number;
  86232. /**
  86233. * The unsigned short type.
  86234. */
  86235. static readonly UNSIGNED_SHORT: number;
  86236. /**
  86237. * The integer type.
  86238. */
  86239. static readonly INT: number;
  86240. /**
  86241. * The unsigned integer type.
  86242. */
  86243. static readonly UNSIGNED_INT: number;
  86244. /**
  86245. * The float type.
  86246. */
  86247. static readonly FLOAT: number;
  86248. /**
  86249. * Gets or sets the instance divisor when in instanced mode
  86250. */
  86251. get instanceDivisor(): number;
  86252. set instanceDivisor(value: number);
  86253. /**
  86254. * Gets the byte stride.
  86255. */
  86256. readonly byteStride: number;
  86257. /**
  86258. * Gets the byte offset.
  86259. */
  86260. readonly byteOffset: number;
  86261. /**
  86262. * Gets whether integer data values should be normalized into a certain range when being casted to a float.
  86263. */
  86264. readonly normalized: boolean;
  86265. /**
  86266. * Gets the data type of each component in the array.
  86267. */
  86268. readonly type: number;
  86269. /**
  86270. * Constructor
  86271. * @param engine the engine
  86272. * @param data the data to use for this vertex buffer
  86273. * @param kind the vertex buffer kind
  86274. * @param updatable whether the data is updatable
  86275. * @param postponeInternalCreation whether to postpone creating the internal WebGL buffer (optional)
  86276. * @param stride the stride (optional)
  86277. * @param instanced whether the buffer is instanced (optional)
  86278. * @param offset the offset of the data (optional)
  86279. * @param size the number of components (optional)
  86280. * @param type the type of the component (optional)
  86281. * @param normalized whether the data contains normalized data (optional)
  86282. * @param useBytes set to true if stride and offset are in bytes (optional)
  86283. * @param divisor defines the instance divisor to use (1 by default)
  86284. */
  86285. 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);
  86286. /** @hidden */
  86287. _rebuild(): void;
  86288. /**
  86289. * Returns the kind of the VertexBuffer (string)
  86290. * @returns a string
  86291. */
  86292. getKind(): string;
  86293. /**
  86294. * Gets a boolean indicating if the VertexBuffer is updatable?
  86295. * @returns true if the buffer is updatable
  86296. */
  86297. isUpdatable(): boolean;
  86298. /**
  86299. * Gets current buffer's data
  86300. * @returns a DataArray or null
  86301. */
  86302. getData(): Nullable<DataArray>;
  86303. /**
  86304. * Gets underlying native buffer
  86305. * @returns underlying native buffer
  86306. */
  86307. getBuffer(): Nullable<DataBuffer>;
  86308. /**
  86309. * Gets the stride in float32 units (i.e. byte stride / 4).
  86310. * May not be an integer if the byte stride is not divisible by 4.
  86311. * @returns the stride in float32 units
  86312. * @deprecated Please use byteStride instead.
  86313. */
  86314. getStrideSize(): number;
  86315. /**
  86316. * Returns the offset as a multiple of the type byte length.
  86317. * @returns the offset in bytes
  86318. * @deprecated Please use byteOffset instead.
  86319. */
  86320. getOffset(): number;
  86321. /**
  86322. * Returns the number of components per vertex attribute (integer)
  86323. * @returns the size in float
  86324. */
  86325. getSize(): number;
  86326. /**
  86327. * Gets a boolean indicating is the internal buffer of the VertexBuffer is instanced
  86328. * @returns true if this buffer is instanced
  86329. */
  86330. getIsInstanced(): boolean;
  86331. /**
  86332. * Returns the instancing divisor, zero for non-instanced (integer).
  86333. * @returns a number
  86334. */
  86335. getInstanceDivisor(): number;
  86336. /**
  86337. * Store data into the buffer. If the buffer was already used it will be either recreated or updated depending on isUpdatable property
  86338. * @param data defines the data to store
  86339. */
  86340. create(data?: DataArray): void;
  86341. /**
  86342. * Updates the underlying buffer according to the passed numeric array or Float32Array.
  86343. * This function will create a new buffer if the current one is not updatable
  86344. * @param data defines the data to store
  86345. */
  86346. update(data: DataArray): void;
  86347. /**
  86348. * Updates directly the underlying WebGLBuffer according to the passed numeric array or Float32Array.
  86349. * Returns the directly updated WebGLBuffer.
  86350. * @param data the new data
  86351. * @param offset the new offset
  86352. * @param useBytes set to true if the offset is in bytes
  86353. */
  86354. updateDirectly(data: DataArray, offset: number, useBytes?: boolean): void;
  86355. /**
  86356. * Disposes the VertexBuffer and the underlying WebGLBuffer.
  86357. */
  86358. dispose(): void;
  86359. /**
  86360. * Enumerates each value of this vertex buffer as numbers.
  86361. * @param count the number of values to enumerate
  86362. * @param callback the callback function called for each value
  86363. */
  86364. forEach(count: number, callback: (value: number, index: number) => void): void;
  86365. /**
  86366. * Positions
  86367. */
  86368. static readonly PositionKind: string;
  86369. /**
  86370. * Normals
  86371. */
  86372. static readonly NormalKind: string;
  86373. /**
  86374. * Tangents
  86375. */
  86376. static readonly TangentKind: string;
  86377. /**
  86378. * Texture coordinates
  86379. */
  86380. static readonly UVKind: string;
  86381. /**
  86382. * Texture coordinates 2
  86383. */
  86384. static readonly UV2Kind: string;
  86385. /**
  86386. * Texture coordinates 3
  86387. */
  86388. static readonly UV3Kind: string;
  86389. /**
  86390. * Texture coordinates 4
  86391. */
  86392. static readonly UV4Kind: string;
  86393. /**
  86394. * Texture coordinates 5
  86395. */
  86396. static readonly UV5Kind: string;
  86397. /**
  86398. * Texture coordinates 6
  86399. */
  86400. static readonly UV6Kind: string;
  86401. /**
  86402. * Colors
  86403. */
  86404. static readonly ColorKind: string;
  86405. /**
  86406. * Matrix indices (for bones)
  86407. */
  86408. static readonly MatricesIndicesKind: string;
  86409. /**
  86410. * Matrix weights (for bones)
  86411. */
  86412. static readonly MatricesWeightsKind: string;
  86413. /**
  86414. * Additional matrix indices (for bones)
  86415. */
  86416. static readonly MatricesIndicesExtraKind: string;
  86417. /**
  86418. * Additional matrix weights (for bones)
  86419. */
  86420. static readonly MatricesWeightsExtraKind: string;
  86421. /**
  86422. * Deduces the stride given a kind.
  86423. * @param kind The kind string to deduce
  86424. * @returns The deduced stride
  86425. */
  86426. static DeduceStride(kind: string): number;
  86427. /**
  86428. * Gets the byte length of the given type.
  86429. * @param type the type
  86430. * @returns the number of bytes
  86431. */
  86432. static GetTypeByteLength(type: number): number;
  86433. /**
  86434. * Enumerates each value of the given parameters as numbers.
  86435. * @param data the data to enumerate
  86436. * @param byteOffset the byte offset of the data
  86437. * @param byteStride the byte stride of the data
  86438. * @param componentCount the number of components per element
  86439. * @param componentType the type of the component
  86440. * @param count the number of values to enumerate
  86441. * @param normalized whether the data is normalized
  86442. * @param callback the callback function called for each value
  86443. */
  86444. static ForEach(data: DataArray, byteOffset: number, byteStride: number, componentCount: number, componentType: number, count: number, normalized: boolean, callback: (value: number, index: number) => void): void;
  86445. private static _GetFloatValue;
  86446. }
  86447. }
  86448. declare module BABYLON {
  86449. /**
  86450. * @hidden
  86451. */
  86452. export class IntersectionInfo {
  86453. bu: Nullable<number>;
  86454. bv: Nullable<number>;
  86455. distance: number;
  86456. faceId: number;
  86457. subMeshId: number;
  86458. constructor(bu: Nullable<number>, bv: Nullable<number>, distance: number);
  86459. }
  86460. }
  86461. declare module BABYLON {
  86462. /**
  86463. * Class used to store bounding sphere information
  86464. */
  86465. export class BoundingSphere {
  86466. /**
  86467. * Gets the center of the bounding sphere in local space
  86468. */
  86469. readonly center: Vector3;
  86470. /**
  86471. * Radius of the bounding sphere in local space
  86472. */
  86473. radius: number;
  86474. /**
  86475. * Gets the center of the bounding sphere in world space
  86476. */
  86477. readonly centerWorld: Vector3;
  86478. /**
  86479. * Radius of the bounding sphere in world space
  86480. */
  86481. radiusWorld: number;
  86482. /**
  86483. * Gets the minimum vector in local space
  86484. */
  86485. readonly minimum: Vector3;
  86486. /**
  86487. * Gets the maximum vector in local space
  86488. */
  86489. readonly maximum: Vector3;
  86490. private _worldMatrix;
  86491. private static readonly TmpVector3;
  86492. /**
  86493. * Creates a new bounding sphere
  86494. * @param min defines the minimum vector (in local space)
  86495. * @param max defines the maximum vector (in local space)
  86496. * @param worldMatrix defines the new world matrix
  86497. */
  86498. constructor(min: DeepImmutable<Vector3>, max: DeepImmutable<Vector3>, worldMatrix?: DeepImmutable<Matrix>);
  86499. /**
  86500. * Recreates the entire bounding sphere from scratch as if we call the constructor in place
  86501. * @param min defines the new minimum vector (in local space)
  86502. * @param max defines the new maximum vector (in local space)
  86503. * @param worldMatrix defines the new world matrix
  86504. */
  86505. reConstruct(min: DeepImmutable<Vector3>, max: DeepImmutable<Vector3>, worldMatrix?: DeepImmutable<Matrix>): void;
  86506. /**
  86507. * Scale the current bounding sphere by applying a scale factor
  86508. * @param factor defines the scale factor to apply
  86509. * @returns the current bounding box
  86510. */
  86511. scale(factor: number): BoundingSphere;
  86512. /**
  86513. * Gets the world matrix of the bounding box
  86514. * @returns a matrix
  86515. */
  86516. getWorldMatrix(): DeepImmutable<Matrix>;
  86517. /** @hidden */
  86518. _update(worldMatrix: DeepImmutable<Matrix>): void;
  86519. /**
  86520. * Tests if the bounding sphere is intersecting the frustum planes
  86521. * @param frustumPlanes defines the frustum planes to test
  86522. * @returns true if there is an intersection
  86523. */
  86524. isInFrustum(frustumPlanes: Array<DeepImmutable<Plane>>): boolean;
  86525. /**
  86526. * Tests if the bounding sphere center is in between the frustum planes.
  86527. * Used for optimistic fast inclusion.
  86528. * @param frustumPlanes defines the frustum planes to test
  86529. * @returns true if the sphere center is in between the frustum planes
  86530. */
  86531. isCenterInFrustum(frustumPlanes: Array<DeepImmutable<Plane>>): boolean;
  86532. /**
  86533. * Tests if a point is inside the bounding sphere
  86534. * @param point defines the point to test
  86535. * @returns true if the point is inside the bounding sphere
  86536. */
  86537. intersectsPoint(point: DeepImmutable<Vector3>): boolean;
  86538. /**
  86539. * Checks if two sphere intersct
  86540. * @param sphere0 sphere 0
  86541. * @param sphere1 sphere 1
  86542. * @returns true if the speres intersect
  86543. */
  86544. static Intersects(sphere0: DeepImmutable<BoundingSphere>, sphere1: DeepImmutable<BoundingSphere>): boolean;
  86545. }
  86546. }
  86547. declare module BABYLON {
  86548. /**
  86549. * Class used to store bounding box information
  86550. */
  86551. export class BoundingBox implements ICullable {
  86552. /**
  86553. * Gets the 8 vectors representing the bounding box in local space
  86554. */
  86555. readonly vectors: Vector3[];
  86556. /**
  86557. * Gets the center of the bounding box in local space
  86558. */
  86559. readonly center: Vector3;
  86560. /**
  86561. * Gets the center of the bounding box in world space
  86562. */
  86563. readonly centerWorld: Vector3;
  86564. /**
  86565. * Gets the extend size in local space
  86566. */
  86567. readonly extendSize: Vector3;
  86568. /**
  86569. * Gets the extend size in world space
  86570. */
  86571. readonly extendSizeWorld: Vector3;
  86572. /**
  86573. * Gets the OBB (object bounding box) directions
  86574. */
  86575. readonly directions: Vector3[];
  86576. /**
  86577. * Gets the 8 vectors representing the bounding box in world space
  86578. */
  86579. readonly vectorsWorld: Vector3[];
  86580. /**
  86581. * Gets the minimum vector in world space
  86582. */
  86583. readonly minimumWorld: Vector3;
  86584. /**
  86585. * Gets the maximum vector in world space
  86586. */
  86587. readonly maximumWorld: Vector3;
  86588. /**
  86589. * Gets the minimum vector in local space
  86590. */
  86591. readonly minimum: Vector3;
  86592. /**
  86593. * Gets the maximum vector in local space
  86594. */
  86595. readonly maximum: Vector3;
  86596. private _worldMatrix;
  86597. private static readonly TmpVector3;
  86598. /**
  86599. * @hidden
  86600. */
  86601. _tag: number;
  86602. /**
  86603. * Creates a new bounding box
  86604. * @param min defines the minimum vector (in local space)
  86605. * @param max defines the maximum vector (in local space)
  86606. * @param worldMatrix defines the new world matrix
  86607. */
  86608. constructor(min: DeepImmutable<Vector3>, max: DeepImmutable<Vector3>, worldMatrix?: DeepImmutable<Matrix>);
  86609. /**
  86610. * Recreates the entire bounding box from scratch as if we call the constructor in place
  86611. * @param min defines the new minimum vector (in local space)
  86612. * @param max defines the new maximum vector (in local space)
  86613. * @param worldMatrix defines the new world matrix
  86614. */
  86615. reConstruct(min: DeepImmutable<Vector3>, max: DeepImmutable<Vector3>, worldMatrix?: DeepImmutable<Matrix>): void;
  86616. /**
  86617. * Scale the current bounding box by applying a scale factor
  86618. * @param factor defines the scale factor to apply
  86619. * @returns the current bounding box
  86620. */
  86621. scale(factor: number): BoundingBox;
  86622. /**
  86623. * Gets the world matrix of the bounding box
  86624. * @returns a matrix
  86625. */
  86626. getWorldMatrix(): DeepImmutable<Matrix>;
  86627. /** @hidden */
  86628. _update(world: DeepImmutable<Matrix>): void;
  86629. /**
  86630. * Tests if the bounding box is intersecting the frustum planes
  86631. * @param frustumPlanes defines the frustum planes to test
  86632. * @returns true if there is an intersection
  86633. */
  86634. isInFrustum(frustumPlanes: Array<DeepImmutable<Plane>>): boolean;
  86635. /**
  86636. * Tests if the bounding box is entirely inside the frustum planes
  86637. * @param frustumPlanes defines the frustum planes to test
  86638. * @returns true if there is an inclusion
  86639. */
  86640. isCompletelyInFrustum(frustumPlanes: Array<DeepImmutable<Plane>>): boolean;
  86641. /**
  86642. * Tests if a point is inside the bounding box
  86643. * @param point defines the point to test
  86644. * @returns true if the point is inside the bounding box
  86645. */
  86646. intersectsPoint(point: DeepImmutable<Vector3>): boolean;
  86647. /**
  86648. * Tests if the bounding box intersects with a bounding sphere
  86649. * @param sphere defines the sphere to test
  86650. * @returns true if there is an intersection
  86651. */
  86652. intersectsSphere(sphere: DeepImmutable<BoundingSphere>): boolean;
  86653. /**
  86654. * Tests if the bounding box intersects with a box defined by a min and max vectors
  86655. * @param min defines the min vector to use
  86656. * @param max defines the max vector to use
  86657. * @returns true if there is an intersection
  86658. */
  86659. intersectsMinMax(min: DeepImmutable<Vector3>, max: DeepImmutable<Vector3>): boolean;
  86660. /**
  86661. * Tests if two bounding boxes are intersections
  86662. * @param box0 defines the first box to test
  86663. * @param box1 defines the second box to test
  86664. * @returns true if there is an intersection
  86665. */
  86666. static Intersects(box0: DeepImmutable<BoundingBox>, box1: DeepImmutable<BoundingBox>): boolean;
  86667. /**
  86668. * Tests if a bounding box defines by a min/max vectors intersects a sphere
  86669. * @param minPoint defines the minimum vector of the bounding box
  86670. * @param maxPoint defines the maximum vector of the bounding box
  86671. * @param sphereCenter defines the sphere center
  86672. * @param sphereRadius defines the sphere radius
  86673. * @returns true if there is an intersection
  86674. */
  86675. static IntersectsSphere(minPoint: DeepImmutable<Vector3>, maxPoint: DeepImmutable<Vector3>, sphereCenter: DeepImmutable<Vector3>, sphereRadius: number): boolean;
  86676. /**
  86677. * Tests if a bounding box defined with 8 vectors is entirely inside frustum planes
  86678. * @param boundingVectors defines an array of 8 vectors representing a bounding box
  86679. * @param frustumPlanes defines the frustum planes to test
  86680. * @return true if there is an inclusion
  86681. */
  86682. static IsCompletelyInFrustum(boundingVectors: Array<DeepImmutable<Vector3>>, frustumPlanes: Array<DeepImmutable<Plane>>): boolean;
  86683. /**
  86684. * Tests if a bounding box defined with 8 vectors intersects frustum planes
  86685. * @param boundingVectors defines an array of 8 vectors representing a bounding box
  86686. * @param frustumPlanes defines the frustum planes to test
  86687. * @return true if there is an intersection
  86688. */
  86689. static IsInFrustum(boundingVectors: Array<DeepImmutable<Vector3>>, frustumPlanes: Array<DeepImmutable<Plane>>): boolean;
  86690. }
  86691. }
  86692. declare module BABYLON {
  86693. /** @hidden */
  86694. export class Collider {
  86695. /** Define if a collision was found */
  86696. collisionFound: boolean;
  86697. /**
  86698. * Define last intersection point in local space
  86699. */
  86700. intersectionPoint: Vector3;
  86701. /**
  86702. * Define last collided mesh
  86703. */
  86704. collidedMesh: Nullable<AbstractMesh>;
  86705. private _collisionPoint;
  86706. private _planeIntersectionPoint;
  86707. private _tempVector;
  86708. private _tempVector2;
  86709. private _tempVector3;
  86710. private _tempVector4;
  86711. private _edge;
  86712. private _baseToVertex;
  86713. private _destinationPoint;
  86714. private _slidePlaneNormal;
  86715. private _displacementVector;
  86716. /** @hidden */
  86717. _radius: Vector3;
  86718. /** @hidden */
  86719. _retry: number;
  86720. private _velocity;
  86721. private _basePoint;
  86722. private _epsilon;
  86723. /** @hidden */
  86724. _velocityWorldLength: number;
  86725. /** @hidden */
  86726. _basePointWorld: Vector3;
  86727. private _velocityWorld;
  86728. private _normalizedVelocity;
  86729. /** @hidden */
  86730. _initialVelocity: Vector3;
  86731. /** @hidden */
  86732. _initialPosition: Vector3;
  86733. private _nearestDistance;
  86734. private _collisionMask;
  86735. get collisionMask(): number;
  86736. set collisionMask(mask: number);
  86737. /**
  86738. * Gets the plane normal used to compute the sliding response (in local space)
  86739. */
  86740. get slidePlaneNormal(): Vector3;
  86741. /** @hidden */
  86742. _initialize(source: Vector3, dir: Vector3, e: number): void;
  86743. /** @hidden */
  86744. _checkPointInTriangle(point: Vector3, pa: Vector3, pb: Vector3, pc: Vector3, n: Vector3): boolean;
  86745. /** @hidden */
  86746. _canDoCollision(sphereCenter: Vector3, sphereRadius: number, vecMin: Vector3, vecMax: Vector3): boolean;
  86747. /** @hidden */
  86748. _testTriangle(faceIndex: number, trianglePlaneArray: Array<Plane>, p1: Vector3, p2: Vector3, p3: Vector3, hasMaterial: boolean, hostMesh: AbstractMesh): void;
  86749. /** @hidden */
  86750. _collide(trianglePlaneArray: Array<Plane>, pts: Vector3[], indices: IndicesArray, indexStart: number, indexEnd: number, decal: number, hasMaterial: boolean, hostMesh: AbstractMesh): void;
  86751. /** @hidden */
  86752. _getResponse(pos: Vector3, vel: Vector3): void;
  86753. }
  86754. }
  86755. declare module BABYLON {
  86756. /**
  86757. * Interface for cullable objects
  86758. * @see https://doc.babylonjs.com/babylon101/materials#back-face-culling
  86759. */
  86760. export interface ICullable {
  86761. /**
  86762. * Checks if the object or part of the object is in the frustum
  86763. * @param frustumPlanes Camera near/planes
  86764. * @returns true if the object is in frustum otherwise false
  86765. */
  86766. isInFrustum(frustumPlanes: Plane[]): boolean;
  86767. /**
  86768. * Checks if a cullable object (mesh...) is in the camera frustum
  86769. * Unlike isInFrustum this cheks the full bounding box
  86770. * @param frustumPlanes Camera near/planes
  86771. * @returns true if the object is in frustum otherwise false
  86772. */
  86773. isCompletelyInFrustum(frustumPlanes: Plane[]): boolean;
  86774. }
  86775. /**
  86776. * Info for a bounding data of a mesh
  86777. */
  86778. export class BoundingInfo implements ICullable {
  86779. /**
  86780. * Bounding box for the mesh
  86781. */
  86782. readonly boundingBox: BoundingBox;
  86783. /**
  86784. * Bounding sphere for the mesh
  86785. */
  86786. readonly boundingSphere: BoundingSphere;
  86787. private _isLocked;
  86788. private static readonly TmpVector3;
  86789. /**
  86790. * Constructs bounding info
  86791. * @param minimum min vector of the bounding box/sphere
  86792. * @param maximum max vector of the bounding box/sphere
  86793. * @param worldMatrix defines the new world matrix
  86794. */
  86795. constructor(minimum: DeepImmutable<Vector3>, maximum: DeepImmutable<Vector3>, worldMatrix?: DeepImmutable<Matrix>);
  86796. /**
  86797. * Recreates the entire bounding info from scratch as if we call the constructor in place
  86798. * @param min defines the new minimum vector (in local space)
  86799. * @param max defines the new maximum vector (in local space)
  86800. * @param worldMatrix defines the new world matrix
  86801. */
  86802. reConstruct(min: DeepImmutable<Vector3>, max: DeepImmutable<Vector3>, worldMatrix?: DeepImmutable<Matrix>): void;
  86803. /**
  86804. * min vector of the bounding box/sphere
  86805. */
  86806. get minimum(): Vector3;
  86807. /**
  86808. * max vector of the bounding box/sphere
  86809. */
  86810. get maximum(): Vector3;
  86811. /**
  86812. * If the info is locked and won't be updated to avoid perf overhead
  86813. */
  86814. get isLocked(): boolean;
  86815. set isLocked(value: boolean);
  86816. /**
  86817. * Updates the bounding sphere and box
  86818. * @param world world matrix to be used to update
  86819. */
  86820. update(world: DeepImmutable<Matrix>): void;
  86821. /**
  86822. * Recreate the bounding info to be centered around a specific point given a specific extend.
  86823. * @param center New center of the bounding info
  86824. * @param extend New extend of the bounding info
  86825. * @returns the current bounding info
  86826. */
  86827. centerOn(center: DeepImmutable<Vector3>, extend: DeepImmutable<Vector3>): BoundingInfo;
  86828. /**
  86829. * Scale the current bounding info by applying a scale factor
  86830. * @param factor defines the scale factor to apply
  86831. * @returns the current bounding info
  86832. */
  86833. scale(factor: number): BoundingInfo;
  86834. /**
  86835. * Returns `true` if the bounding info is within the frustum defined by the passed array of planes.
  86836. * @param frustumPlanes defines the frustum to test
  86837. * @param strategy defines the strategy to use for the culling (default is BABYLON.AbstractMesh.CULLINGSTRATEGY_STANDARD)
  86838. * @returns true if the bounding info is in the frustum planes
  86839. */
  86840. isInFrustum(frustumPlanes: Array<DeepImmutable<Plane>>, strategy?: number): boolean;
  86841. /**
  86842. * Gets the world distance between the min and max points of the bounding box
  86843. */
  86844. get diagonalLength(): number;
  86845. /**
  86846. * Checks if a cullable object (mesh...) is in the camera frustum
  86847. * Unlike isInFrustum this cheks the full bounding box
  86848. * @param frustumPlanes Camera near/planes
  86849. * @returns true if the object is in frustum otherwise false
  86850. */
  86851. isCompletelyInFrustum(frustumPlanes: Array<DeepImmutable<Plane>>): boolean;
  86852. /** @hidden */
  86853. _checkCollision(collider: Collider): boolean;
  86854. /**
  86855. * Checks if a point is inside the bounding box and bounding sphere or the mesh
  86856. * @see https://doc.babylonjs.com/babylon101/intersect_collisions_-_mesh
  86857. * @param point the point to check intersection with
  86858. * @returns if the point intersects
  86859. */
  86860. intersectsPoint(point: DeepImmutable<Vector3>): boolean;
  86861. /**
  86862. * Checks if another bounding info intersects the bounding box and bounding sphere or the mesh
  86863. * @see https://doc.babylonjs.com/babylon101/intersect_collisions_-_mesh
  86864. * @param boundingInfo the bounding info to check intersection with
  86865. * @param precise if the intersection should be done using OBB
  86866. * @returns if the bounding info intersects
  86867. */
  86868. intersects(boundingInfo: DeepImmutable<BoundingInfo>, precise: boolean): boolean;
  86869. }
  86870. }
  86871. declare module BABYLON {
  86872. /**
  86873. * Extracts minimum and maximum values from a list of indexed positions
  86874. * @param positions defines the positions to use
  86875. * @param indices defines the indices to the positions
  86876. * @param indexStart defines the start index
  86877. * @param indexCount defines the end index
  86878. * @param bias defines bias value to add to the result
  86879. * @return minimum and maximum values
  86880. */
  86881. export function extractMinAndMaxIndexed(positions: FloatArray, indices: IndicesArray, indexStart: number, indexCount: number, bias?: Nullable<Vector2>): {
  86882. minimum: Vector3;
  86883. maximum: Vector3;
  86884. };
  86885. /**
  86886. * Extracts minimum and maximum values from a list of positions
  86887. * @param positions defines the positions to use
  86888. * @param start defines the start index in the positions array
  86889. * @param count defines the number of positions to handle
  86890. * @param bias defines bias value to add to the result
  86891. * @param stride defines the stride size to use (distance between two positions in the positions array)
  86892. * @return minimum and maximum values
  86893. */
  86894. export function extractMinAndMax(positions: FloatArray, start: number, count: number, bias?: Nullable<Vector2>, stride?: number): {
  86895. minimum: Vector3;
  86896. maximum: Vector3;
  86897. };
  86898. }
  86899. declare module BABYLON {
  86900. /** @hidden */
  86901. export class WebGLDataBuffer extends DataBuffer {
  86902. private _buffer;
  86903. constructor(resource: WebGLBuffer);
  86904. get underlyingResource(): any;
  86905. }
  86906. }
  86907. declare module BABYLON {
  86908. /** @hidden */
  86909. export class WebGLPipelineContext implements IPipelineContext {
  86910. engine: ThinEngine;
  86911. program: Nullable<WebGLProgram>;
  86912. context?: WebGLRenderingContext;
  86913. vertexShader?: WebGLShader;
  86914. fragmentShader?: WebGLShader;
  86915. isParallelCompiled: boolean;
  86916. onCompiled?: () => void;
  86917. transformFeedback?: WebGLTransformFeedback | null;
  86918. vertexCompilationError: Nullable<string>;
  86919. fragmentCompilationError: Nullable<string>;
  86920. programLinkError: Nullable<string>;
  86921. programValidationError: Nullable<string>;
  86922. get isAsync(): boolean;
  86923. get isReady(): boolean;
  86924. _handlesSpectorRebuildCallback(onCompiled: (program: WebGLProgram) => void): void;
  86925. _getVertexShaderCode(): string | null;
  86926. _getFragmentShaderCode(): string | null;
  86927. }
  86928. }
  86929. declare module BABYLON {
  86930. interface ThinEngine {
  86931. /**
  86932. * Create an uniform buffer
  86933. * @see https://doc.babylonjs.com/features/webgl2#uniform-buffer-objets
  86934. * @param elements defines the content of the uniform buffer
  86935. * @returns the webGL uniform buffer
  86936. */
  86937. createUniformBuffer(elements: FloatArray): DataBuffer;
  86938. /**
  86939. * Create a dynamic uniform buffer
  86940. * @see https://doc.babylonjs.com/features/webgl2#uniform-buffer-objets
  86941. * @param elements defines the content of the uniform buffer
  86942. * @returns the webGL uniform buffer
  86943. */
  86944. createDynamicUniformBuffer(elements: FloatArray): DataBuffer;
  86945. /**
  86946. * Update an existing uniform buffer
  86947. * @see https://doc.babylonjs.com/features/webgl2#uniform-buffer-objets
  86948. * @param uniformBuffer defines the target uniform buffer
  86949. * @param elements defines the content to update
  86950. * @param offset defines the offset in the uniform buffer where update should start
  86951. * @param count defines the size of the data to update
  86952. */
  86953. updateUniformBuffer(uniformBuffer: DataBuffer, elements: FloatArray, offset?: number, count?: number): void;
  86954. /**
  86955. * Bind an uniform buffer to the current webGL context
  86956. * @param buffer defines the buffer to bind
  86957. */
  86958. bindUniformBuffer(buffer: Nullable<DataBuffer>): void;
  86959. /**
  86960. * Bind a buffer to the current webGL context at a given location
  86961. * @param buffer defines the buffer to bind
  86962. * @param location defines the index where to bind the buffer
  86963. */
  86964. bindUniformBufferBase(buffer: DataBuffer, location: number): void;
  86965. /**
  86966. * Bind a specific block at a given index in a specific shader program
  86967. * @param pipelineContext defines the pipeline context to use
  86968. * @param blockName defines the block name
  86969. * @param index defines the index where to bind the block
  86970. */
  86971. bindUniformBlock(pipelineContext: IPipelineContext, blockName: string, index: number): void;
  86972. }
  86973. }
  86974. declare module BABYLON {
  86975. /**
  86976. * Uniform buffer objects.
  86977. *
  86978. * Handles blocks of uniform on the GPU.
  86979. *
  86980. * If WebGL 2 is not available, this class falls back on traditionnal setUniformXXX calls.
  86981. *
  86982. * For more information, please refer to :
  86983. * https://www.khronos.org/opengl/wiki/Uniform_Buffer_Object
  86984. */
  86985. export class UniformBuffer {
  86986. private _engine;
  86987. private _buffer;
  86988. private _data;
  86989. private _bufferData;
  86990. private _dynamic?;
  86991. private _uniformLocations;
  86992. private _uniformSizes;
  86993. private _uniformLocationPointer;
  86994. private _needSync;
  86995. private _noUBO;
  86996. private _currentEffect;
  86997. /** @hidden */
  86998. _alreadyBound: boolean;
  86999. private static _MAX_UNIFORM_SIZE;
  87000. private static _tempBuffer;
  87001. /**
  87002. * Lambda to Update a 3x3 Matrix in a uniform buffer.
  87003. * This is dynamic to allow compat with webgl 1 and 2.
  87004. * You will need to pass the name of the uniform as well as the value.
  87005. */
  87006. updateMatrix3x3: (name: string, matrix: Float32Array) => void;
  87007. /**
  87008. * Lambda to Update a 2x2 Matrix in a uniform buffer.
  87009. * This is dynamic to allow compat with webgl 1 and 2.
  87010. * You will need to pass the name of the uniform as well as the value.
  87011. */
  87012. updateMatrix2x2: (name: string, matrix: Float32Array) => void;
  87013. /**
  87014. * Lambda to Update a single float in a uniform buffer.
  87015. * This is dynamic to allow compat with webgl 1 and 2.
  87016. * You will need to pass the name of the uniform as well as the value.
  87017. */
  87018. updateFloat: (name: string, x: number) => void;
  87019. /**
  87020. * Lambda to Update a vec2 of float in a uniform buffer.
  87021. * This is dynamic to allow compat with webgl 1 and 2.
  87022. * You will need to pass the name of the uniform as well as the value.
  87023. */
  87024. updateFloat2: (name: string, x: number, y: number, suffix?: string) => void;
  87025. /**
  87026. * Lambda to Update a vec3 of float in a uniform buffer.
  87027. * This is dynamic to allow compat with webgl 1 and 2.
  87028. * You will need to pass the name of the uniform as well as the value.
  87029. */
  87030. updateFloat3: (name: string, x: number, y: number, z: number, suffix?: string) => void;
  87031. /**
  87032. * Lambda to Update a vec4 of float in a uniform buffer.
  87033. * This is dynamic to allow compat with webgl 1 and 2.
  87034. * You will need to pass the name of the uniform as well as the value.
  87035. */
  87036. updateFloat4: (name: string, x: number, y: number, z: number, w: number, suffix?: string) => void;
  87037. /**
  87038. * Lambda to Update a 4x4 Matrix in a uniform buffer.
  87039. * This is dynamic to allow compat with webgl 1 and 2.
  87040. * You will need to pass the name of the uniform as well as the value.
  87041. */
  87042. updateMatrix: (name: string, mat: Matrix) => void;
  87043. /**
  87044. * Lambda to Update vec3 of float from a Vector in a uniform buffer.
  87045. * This is dynamic to allow compat with webgl 1 and 2.
  87046. * You will need to pass the name of the uniform as well as the value.
  87047. */
  87048. updateVector3: (name: string, vector: Vector3) => void;
  87049. /**
  87050. * Lambda to Update vec4 of float from a Vector in a uniform buffer.
  87051. * This is dynamic to allow compat with webgl 1 and 2.
  87052. * You will need to pass the name of the uniform as well as the value.
  87053. */
  87054. updateVector4: (name: string, vector: Vector4) => void;
  87055. /**
  87056. * Lambda to Update vec3 of float from a Color in a uniform buffer.
  87057. * This is dynamic to allow compat with webgl 1 and 2.
  87058. * You will need to pass the name of the uniform as well as the value.
  87059. */
  87060. updateColor3: (name: string, color: Color3, suffix?: string) => void;
  87061. /**
  87062. * Lambda to Update vec4 of float from a Color in a uniform buffer.
  87063. * This is dynamic to allow compat with webgl 1 and 2.
  87064. * You will need to pass the name of the uniform as well as the value.
  87065. */
  87066. updateColor4: (name: string, color: Color3, alpha: number, suffix?: string) => void;
  87067. /**
  87068. * Instantiates a new Uniform buffer objects.
  87069. *
  87070. * Handles blocks of uniform on the GPU.
  87071. *
  87072. * If WebGL 2 is not available, this class falls back on traditionnal setUniformXXX calls.
  87073. *
  87074. * For more information, please refer to :
  87075. * @see https://www.khronos.org/opengl/wiki/Uniform_Buffer_Object
  87076. * @param engine Define the engine the buffer is associated with
  87077. * @param data Define the data contained in the buffer
  87078. * @param dynamic Define if the buffer is updatable
  87079. */
  87080. constructor(engine: Engine, data?: number[], dynamic?: boolean);
  87081. /**
  87082. * Indicates if the buffer is using the WebGL2 UBO implementation,
  87083. * or just falling back on setUniformXXX calls.
  87084. */
  87085. get useUbo(): boolean;
  87086. /**
  87087. * Indicates if the WebGL underlying uniform buffer is in sync
  87088. * with the javascript cache data.
  87089. */
  87090. get isSync(): boolean;
  87091. /**
  87092. * Indicates if the WebGL underlying uniform buffer is dynamic.
  87093. * Also, a dynamic UniformBuffer will disable cache verification and always
  87094. * update the underlying WebGL uniform buffer to the GPU.
  87095. * @returns if Dynamic, otherwise false
  87096. */
  87097. isDynamic(): boolean;
  87098. /**
  87099. * The data cache on JS side.
  87100. * @returns the underlying data as a float array
  87101. */
  87102. getData(): Float32Array;
  87103. /**
  87104. * The underlying WebGL Uniform buffer.
  87105. * @returns the webgl buffer
  87106. */
  87107. getBuffer(): Nullable<DataBuffer>;
  87108. /**
  87109. * std140 layout specifies how to align data within an UBO structure.
  87110. * See https://khronos.org/registry/OpenGL/specs/gl/glspec45.core.pdf#page=159
  87111. * for specs.
  87112. */
  87113. private _fillAlignment;
  87114. /**
  87115. * Adds an uniform in the buffer.
  87116. * Warning : the subsequents calls of this function must be in the same order as declared in the shader
  87117. * for the layout to be correct !
  87118. * @param name Name of the uniform, as used in the uniform block in the shader.
  87119. * @param size Data size, or data directly.
  87120. */
  87121. addUniform(name: string, size: number | number[]): void;
  87122. /**
  87123. * Adds a Matrix 4x4 to the uniform buffer.
  87124. * @param name Name of the uniform, as used in the uniform block in the shader.
  87125. * @param mat A 4x4 matrix.
  87126. */
  87127. addMatrix(name: string, mat: Matrix): void;
  87128. /**
  87129. * Adds a vec2 to the uniform buffer.
  87130. * @param name Name of the uniform, as used in the uniform block in the shader.
  87131. * @param x Define the x component value of the vec2
  87132. * @param y Define the y component value of the vec2
  87133. */
  87134. addFloat2(name: string, x: number, y: number): void;
  87135. /**
  87136. * Adds a vec3 to the uniform buffer.
  87137. * @param name Name of the uniform, as used in the uniform block in the shader.
  87138. * @param x Define the x component value of the vec3
  87139. * @param y Define the y component value of the vec3
  87140. * @param z Define the z component value of the vec3
  87141. */
  87142. addFloat3(name: string, x: number, y: number, z: number): void;
  87143. /**
  87144. * Adds a vec3 to the uniform buffer.
  87145. * @param name Name of the uniform, as used in the uniform block in the shader.
  87146. * @param color Define the vec3 from a Color
  87147. */
  87148. addColor3(name: string, color: Color3): void;
  87149. /**
  87150. * Adds a vec4 to the uniform buffer.
  87151. * @param name Name of the uniform, as used in the uniform block in the shader.
  87152. * @param color Define the rgb components from a Color
  87153. * @param alpha Define the a component of the vec4
  87154. */
  87155. addColor4(name: string, color: Color3, alpha: number): void;
  87156. /**
  87157. * Adds a vec3 to the uniform buffer.
  87158. * @param name Name of the uniform, as used in the uniform block in the shader.
  87159. * @param vector Define the vec3 components from a Vector
  87160. */
  87161. addVector3(name: string, vector: Vector3): void;
  87162. /**
  87163. * Adds a Matrix 3x3 to the uniform buffer.
  87164. * @param name Name of the uniform, as used in the uniform block in the shader.
  87165. */
  87166. addMatrix3x3(name: string): void;
  87167. /**
  87168. * Adds a Matrix 2x2 to the uniform buffer.
  87169. * @param name Name of the uniform, as used in the uniform block in the shader.
  87170. */
  87171. addMatrix2x2(name: string): void;
  87172. /**
  87173. * Effectively creates the WebGL Uniform Buffer, once layout is completed with `addUniform`.
  87174. */
  87175. create(): void;
  87176. /** @hidden */
  87177. _rebuild(): void;
  87178. /**
  87179. * Updates the WebGL Uniform Buffer on the GPU.
  87180. * If the `dynamic` flag is set to true, no cache comparison is done.
  87181. * Otherwise, the buffer will be updated only if the cache differs.
  87182. */
  87183. update(): void;
  87184. /**
  87185. * Updates the value of an uniform. The `update` method must be called afterwards to make it effective in the GPU.
  87186. * @param uniformName Define the name of the uniform, as used in the uniform block in the shader.
  87187. * @param data Define the flattened data
  87188. * @param size Define the size of the data.
  87189. */
  87190. updateUniform(uniformName: string, data: FloatArray, size: number): void;
  87191. private _valueCache;
  87192. private _cacheMatrix;
  87193. private _updateMatrix3x3ForUniform;
  87194. private _updateMatrix3x3ForEffect;
  87195. private _updateMatrix2x2ForEffect;
  87196. private _updateMatrix2x2ForUniform;
  87197. private _updateFloatForEffect;
  87198. private _updateFloatForUniform;
  87199. private _updateFloat2ForEffect;
  87200. private _updateFloat2ForUniform;
  87201. private _updateFloat3ForEffect;
  87202. private _updateFloat3ForUniform;
  87203. private _updateFloat4ForEffect;
  87204. private _updateFloat4ForUniform;
  87205. private _updateMatrixForEffect;
  87206. private _updateMatrixForUniform;
  87207. private _updateVector3ForEffect;
  87208. private _updateVector3ForUniform;
  87209. private _updateVector4ForEffect;
  87210. private _updateVector4ForUniform;
  87211. private _updateColor3ForEffect;
  87212. private _updateColor3ForUniform;
  87213. private _updateColor4ForEffect;
  87214. private _updateColor4ForUniform;
  87215. /**
  87216. * Sets a sampler uniform on the effect.
  87217. * @param name Define the name of the sampler.
  87218. * @param texture Define the texture to set in the sampler
  87219. */
  87220. setTexture(name: string, texture: Nullable<BaseTexture>): void;
  87221. /**
  87222. * Directly updates the value of the uniform in the cache AND on the GPU.
  87223. * @param uniformName Define the name of the uniform, as used in the uniform block in the shader.
  87224. * @param data Define the flattened data
  87225. */
  87226. updateUniformDirectly(uniformName: string, data: FloatArray): void;
  87227. /**
  87228. * Binds this uniform buffer to an effect.
  87229. * @param effect Define the effect to bind the buffer to
  87230. * @param name Name of the uniform block in the shader.
  87231. */
  87232. bindToEffect(effect: Effect, name: string): void;
  87233. /**
  87234. * Disposes the uniform buffer.
  87235. */
  87236. dispose(): void;
  87237. }
  87238. }
  87239. declare module BABYLON {
  87240. /**
  87241. * Enum that determines the text-wrapping mode to use.
  87242. */
  87243. export enum InspectableType {
  87244. /**
  87245. * Checkbox for booleans
  87246. */
  87247. Checkbox = 0,
  87248. /**
  87249. * Sliders for numbers
  87250. */
  87251. Slider = 1,
  87252. /**
  87253. * Vector3
  87254. */
  87255. Vector3 = 2,
  87256. /**
  87257. * Quaternions
  87258. */
  87259. Quaternion = 3,
  87260. /**
  87261. * Color3
  87262. */
  87263. Color3 = 4,
  87264. /**
  87265. * String
  87266. */
  87267. String = 5
  87268. }
  87269. /**
  87270. * Interface used to define custom inspectable properties.
  87271. * This interface is used by the inspector to display custom property grids
  87272. * @see https://doc.babylonjs.com/how_to/debug_layer#extensibility
  87273. */
  87274. export interface IInspectable {
  87275. /**
  87276. * Gets the label to display
  87277. */
  87278. label: string;
  87279. /**
  87280. * Gets the name of the property to edit
  87281. */
  87282. propertyName: string;
  87283. /**
  87284. * Gets the type of the editor to use
  87285. */
  87286. type: InspectableType;
  87287. /**
  87288. * Gets the minimum value of the property when using in "slider" mode
  87289. */
  87290. min?: number;
  87291. /**
  87292. * Gets the maximum value of the property when using in "slider" mode
  87293. */
  87294. max?: number;
  87295. /**
  87296. * Gets the setp to use when using in "slider" mode
  87297. */
  87298. step?: number;
  87299. }
  87300. }
  87301. declare module BABYLON {
  87302. /**
  87303. * Class used to provide helper for timing
  87304. */
  87305. export class TimingTools {
  87306. /**
  87307. * Polyfill for setImmediate
  87308. * @param action defines the action to execute after the current execution block
  87309. */
  87310. static SetImmediate(action: () => void): void;
  87311. }
  87312. }
  87313. declare module BABYLON {
  87314. /**
  87315. * Class used to enable instatition of objects by class name
  87316. */
  87317. export class InstantiationTools {
  87318. /**
  87319. * Use this object to register external classes like custom textures or material
  87320. * to allow the laoders to instantiate them
  87321. */
  87322. static RegisteredExternalClasses: {
  87323. [key: string]: Object;
  87324. };
  87325. /**
  87326. * Tries to instantiate a new object from a given class name
  87327. * @param className defines the class name to instantiate
  87328. * @returns the new object or null if the system was not able to do the instantiation
  87329. */
  87330. static Instantiate(className: string): any;
  87331. }
  87332. }
  87333. declare module BABYLON {
  87334. /**
  87335. * Define options used to create a depth texture
  87336. */
  87337. export class DepthTextureCreationOptions {
  87338. /** Specifies whether or not a stencil should be allocated in the texture */
  87339. generateStencil?: boolean;
  87340. /** Specifies whether or not bilinear filtering is enable on the texture */
  87341. bilinearFiltering?: boolean;
  87342. /** Specifies the comparison function to set on the texture. If 0 or undefined, the texture is not in comparison mode */
  87343. comparisonFunction?: number;
  87344. /** Specifies if the created texture is a cube texture */
  87345. isCube?: boolean;
  87346. }
  87347. }
  87348. declare module BABYLON {
  87349. interface ThinEngine {
  87350. /**
  87351. * Creates a depth stencil cube texture.
  87352. * This is only available in WebGL 2.
  87353. * @param size The size of face edge in the cube texture.
  87354. * @param options The options defining the cube texture.
  87355. * @returns The cube texture
  87356. */
  87357. _createDepthStencilCubeTexture(size: number, options: DepthTextureCreationOptions): InternalTexture;
  87358. /**
  87359. * Creates a cube texture
  87360. * @param rootUrl defines the url where the files to load is located
  87361. * @param scene defines the current scene
  87362. * @param files defines the list of files to load (1 per face)
  87363. * @param noMipmap defines a boolean indicating that no mipmaps shall be generated (false by default)
  87364. * @param onLoad defines an optional callback raised when the texture is loaded
  87365. * @param onError defines an optional callback raised if there is an issue to load the texture
  87366. * @param format defines the format of the data
  87367. * @param forcedExtension defines the extension to use to pick the right loader
  87368. * @param createPolynomials if a polynomial sphere should be created for the cube texture
  87369. * @param lodScale defines the scale applied to environment texture. This manages the range of LOD level used for IBL according to the roughness
  87370. * @param lodOffset defines the offset applied to environment texture. This manages first LOD level used for IBL according to the roughness
  87371. * @param fallback defines texture to use while falling back when (compressed) texture file not found.
  87372. * @returns the cube texture as an InternalTexture
  87373. */
  87374. 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;
  87375. /**
  87376. * Creates a cube texture
  87377. * @param rootUrl defines the url where the files to load is located
  87378. * @param scene defines the current scene
  87379. * @param files defines the list of files to load (1 per face)
  87380. * @param noMipmap defines a boolean indicating that no mipmaps shall be generated (false by default)
  87381. * @param onLoad defines an optional callback raised when the texture is loaded
  87382. * @param onError defines an optional callback raised if there is an issue to load the texture
  87383. * @param format defines the format of the data
  87384. * @param forcedExtension defines the extension to use to pick the right loader
  87385. * @returns the cube texture as an InternalTexture
  87386. */
  87387. 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;
  87388. /**
  87389. * Creates a cube texture
  87390. * @param rootUrl defines the url where the files to load is located
  87391. * @param scene defines the current scene
  87392. * @param files defines the list of files to load (1 per face)
  87393. * @param noMipmap defines a boolean indicating that no mipmaps shall be generated (false by default)
  87394. * @param onLoad defines an optional callback raised when the texture is loaded
  87395. * @param onError defines an optional callback raised if there is an issue to load the texture
  87396. * @param format defines the format of the data
  87397. * @param forcedExtension defines the extension to use to pick the right loader
  87398. * @param createPolynomials if a polynomial sphere should be created for the cube texture
  87399. * @param lodScale defines the scale applied to environment texture. This manages the range of LOD level used for IBL according to the roughness
  87400. * @param lodOffset defines the offset applied to environment texture. This manages first LOD level used for IBL according to the roughness
  87401. * @returns the cube texture as an InternalTexture
  87402. */
  87403. 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;
  87404. /** @hidden */
  87405. _partialLoadFile(url: string, index: number, loadedFiles: ArrayBuffer[], onfinish: (files: ArrayBuffer[]) => void, onErrorCallBack: Nullable<(message?: string, exception?: any) => void>): void;
  87406. /** @hidden */
  87407. _cascadeLoadFiles(scene: Nullable<Scene>, onfinish: (images: ArrayBuffer[]) => void, files: string[], onError: Nullable<(message?: string, exception?: any) => void>): void;
  87408. /** @hidden */
  87409. _cascadeLoadImgs(scene: Nullable<Scene>, onfinish: (images: HTMLImageElement[]) => void, files: string[], onError: Nullable<(message?: string, exception?: any) => void>, mimeType?: string): void;
  87410. /** @hidden */
  87411. _partialLoadImg(url: string, index: number, loadedImages: HTMLImageElement[], scene: Nullable<Scene>, onfinish: (images: HTMLImageElement[]) => void, onErrorCallBack: Nullable<(message?: string, exception?: any) => void>, mimeType?: string): void;
  87412. /**
  87413. * @hidden
  87414. */
  87415. _setCubeMapTextureParams(loadMipmap: boolean): void;
  87416. }
  87417. }
  87418. declare module BABYLON {
  87419. /**
  87420. * Class for creating a cube texture
  87421. */
  87422. export class CubeTexture extends BaseTexture {
  87423. private _delayedOnLoad;
  87424. /**
  87425. * Observable triggered once the texture has been loaded.
  87426. */
  87427. onLoadObservable: Observable<CubeTexture>;
  87428. /**
  87429. * The url of the texture
  87430. */
  87431. url: string;
  87432. /**
  87433. * Gets or sets the center of the bounding box associated with the cube texture.
  87434. * It must define where the camera used to render the texture was set
  87435. * @see https://doc.babylonjs.com/how_to/reflect#using-local-cubemap-mode
  87436. */
  87437. boundingBoxPosition: Vector3;
  87438. private _boundingBoxSize;
  87439. /**
  87440. * Gets or sets the size of the bounding box associated with the cube texture
  87441. * When defined, the cubemap will switch to local mode
  87442. * @see https://community.arm.com/graphics/b/blog/posts/reflections-based-on-local-cubemaps-in-unity
  87443. * @example https://www.babylonjs-playground.com/#RNASML
  87444. */
  87445. set boundingBoxSize(value: Vector3);
  87446. /**
  87447. * Returns the bounding box size
  87448. * @see https://doc.babylonjs.com/how_to/reflect#using-local-cubemap-mode
  87449. */
  87450. get boundingBoxSize(): Vector3;
  87451. protected _rotationY: number;
  87452. /**
  87453. * Sets texture matrix rotation angle around Y axis in radians.
  87454. */
  87455. set rotationY(value: number);
  87456. /**
  87457. * Gets texture matrix rotation angle around Y axis radians.
  87458. */
  87459. get rotationY(): number;
  87460. /**
  87461. * Are mip maps generated for this texture or not.
  87462. */
  87463. get noMipmap(): boolean;
  87464. private _noMipmap;
  87465. private _files;
  87466. protected _forcedExtension: Nullable<string>;
  87467. private _extensions;
  87468. private _textureMatrix;
  87469. private _format;
  87470. private _createPolynomials;
  87471. /**
  87472. * Creates a cube texture from an array of image urls
  87473. * @param files defines an array of image urls
  87474. * @param scene defines the hosting scene
  87475. * @param noMipmap specifies if mip maps are not used
  87476. * @returns a cube texture
  87477. */
  87478. static CreateFromImages(files: string[], scene: Scene, noMipmap?: boolean): CubeTexture;
  87479. /**
  87480. * Creates and return a texture created from prefilterd data by tools like IBL Baker or Lys.
  87481. * @param url defines the url of the prefiltered texture
  87482. * @param scene defines the scene the texture is attached to
  87483. * @param forcedExtension defines the extension of the file if different from the url
  87484. * @param createPolynomials defines whether or not to create polynomial harmonics from the texture data if necessary
  87485. * @return the prefiltered texture
  87486. */
  87487. static CreateFromPrefilteredData(url: string, scene: Scene, forcedExtension?: any, createPolynomials?: boolean): CubeTexture;
  87488. /**
  87489. * Creates a cube texture to use with reflection for instance. It can be based upon dds or six images as well
  87490. * as prefiltered data.
  87491. * @param rootUrl defines the url of the texture or the root name of the six images
  87492. * @param null defines the scene or engine the texture is attached to
  87493. * @param extensions defines the suffixes add to the picture name in case six images are in use like _px.jpg...
  87494. * @param noMipmap defines if mipmaps should be created or not
  87495. * @param files defines the six files to load for the different faces in that order: px, py, pz, nx, ny, nz
  87496. * @param onLoad defines a callback triggered at the end of the file load if no errors occured
  87497. * @param onError defines a callback triggered in case of error during load
  87498. * @param format defines the internal format to use for the texture once loaded
  87499. * @param prefiltered defines whether or not the texture is created from prefiltered data
  87500. * @param forcedExtension defines the extensions to use (force a special type of file to load) in case it is different from the file name
  87501. * @param createPolynomials defines whether or not to create polynomial harmonics from the texture data if necessary
  87502. * @param lodScale defines the scale applied to environment texture. This manages the range of LOD level used for IBL according to the roughness
  87503. * @param lodOffset defines the offset applied to environment texture. This manages first LOD level used for IBL according to the roughness
  87504. * @return the cube texture
  87505. */
  87506. 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);
  87507. /**
  87508. * Get the current class name of the texture useful for serialization or dynamic coding.
  87509. * @returns "CubeTexture"
  87510. */
  87511. getClassName(): string;
  87512. /**
  87513. * Update the url (and optional buffer) of this texture if url was null during construction.
  87514. * @param url the url of the texture
  87515. * @param forcedExtension defines the extension to use
  87516. * @param onLoad callback called when the texture is loaded (defaults to null)
  87517. * @param prefiltered Defines whether the updated texture is prefiltered or not
  87518. */
  87519. updateURL(url: string, forcedExtension?: string, onLoad?: () => void, prefiltered?: boolean): void;
  87520. /**
  87521. * Delays loading of the cube texture
  87522. * @param forcedExtension defines the extension to use
  87523. */
  87524. delayLoad(forcedExtension?: string): void;
  87525. /**
  87526. * Returns the reflection texture matrix
  87527. * @returns the reflection texture matrix
  87528. */
  87529. getReflectionTextureMatrix(): Matrix;
  87530. /**
  87531. * Sets the reflection texture matrix
  87532. * @param value Reflection texture matrix
  87533. */
  87534. setReflectionTextureMatrix(value: Matrix): void;
  87535. /**
  87536. * Parses text to create a cube texture
  87537. * @param parsedTexture define the serialized text to read from
  87538. * @param scene defines the hosting scene
  87539. * @param rootUrl defines the root url of the cube texture
  87540. * @returns a cube texture
  87541. */
  87542. static Parse(parsedTexture: any, scene: Scene, rootUrl: string): CubeTexture;
  87543. /**
  87544. * Makes a clone, or deep copy, of the cube texture
  87545. * @returns a new cube texture
  87546. */
  87547. clone(): CubeTexture;
  87548. }
  87549. }
  87550. declare module BABYLON {
  87551. /**
  87552. * Manages the defines for the Material
  87553. */
  87554. export class MaterialDefines {
  87555. /** @hidden */
  87556. protected _keys: string[];
  87557. private _isDirty;
  87558. /** @hidden */
  87559. _renderId: number;
  87560. /** @hidden */
  87561. _areLightsDirty: boolean;
  87562. /** @hidden */
  87563. _areLightsDisposed: boolean;
  87564. /** @hidden */
  87565. _areAttributesDirty: boolean;
  87566. /** @hidden */
  87567. _areTexturesDirty: boolean;
  87568. /** @hidden */
  87569. _areFresnelDirty: boolean;
  87570. /** @hidden */
  87571. _areMiscDirty: boolean;
  87572. /** @hidden */
  87573. _areImageProcessingDirty: boolean;
  87574. /** @hidden */
  87575. _normals: boolean;
  87576. /** @hidden */
  87577. _uvs: boolean;
  87578. /** @hidden */
  87579. _needNormals: boolean;
  87580. /** @hidden */
  87581. _needUVs: boolean;
  87582. [id: string]: any;
  87583. /**
  87584. * Specifies if the material needs to be re-calculated
  87585. */
  87586. get isDirty(): boolean;
  87587. /**
  87588. * Marks the material to indicate that it has been re-calculated
  87589. */
  87590. markAsProcessed(): void;
  87591. /**
  87592. * Marks the material to indicate that it needs to be re-calculated
  87593. */
  87594. markAsUnprocessed(): void;
  87595. /**
  87596. * Marks the material to indicate all of its defines need to be re-calculated
  87597. */
  87598. markAllAsDirty(): void;
  87599. /**
  87600. * Marks the material to indicate that image processing needs to be re-calculated
  87601. */
  87602. markAsImageProcessingDirty(): void;
  87603. /**
  87604. * Marks the material to indicate the lights need to be re-calculated
  87605. * @param disposed Defines whether the light is dirty due to dispose or not
  87606. */
  87607. markAsLightDirty(disposed?: boolean): void;
  87608. /**
  87609. * Marks the attribute state as changed
  87610. */
  87611. markAsAttributesDirty(): void;
  87612. /**
  87613. * Marks the texture state as changed
  87614. */
  87615. markAsTexturesDirty(): void;
  87616. /**
  87617. * Marks the fresnel state as changed
  87618. */
  87619. markAsFresnelDirty(): void;
  87620. /**
  87621. * Marks the misc state as changed
  87622. */
  87623. markAsMiscDirty(): void;
  87624. /**
  87625. * Rebuilds the material defines
  87626. */
  87627. rebuild(): void;
  87628. /**
  87629. * Specifies if two material defines are equal
  87630. * @param other - A material define instance to compare to
  87631. * @returns - Boolean indicating if the material defines are equal (true) or not (false)
  87632. */
  87633. isEqual(other: MaterialDefines): boolean;
  87634. /**
  87635. * Clones this instance's defines to another instance
  87636. * @param other - material defines to clone values to
  87637. */
  87638. cloneTo(other: MaterialDefines): void;
  87639. /**
  87640. * Resets the material define values
  87641. */
  87642. reset(): void;
  87643. /**
  87644. * Converts the material define values to a string
  87645. * @returns - String of material define information
  87646. */
  87647. toString(): string;
  87648. }
  87649. }
  87650. declare module BABYLON {
  87651. /**
  87652. * The color grading curves provide additional color adjustmnent that is applied after any color grading transform (3D LUT).
  87653. * They allow basic adjustment of saturation and small exposure adjustments, along with color filter tinting to provide white balance adjustment or more stylistic effects.
  87654. * 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;
  87655. * corresponding to low luminance, medium luminance, and high luminance areas respectively.
  87656. */
  87657. export class ColorCurves {
  87658. private _dirty;
  87659. private _tempColor;
  87660. private _globalCurve;
  87661. private _highlightsCurve;
  87662. private _midtonesCurve;
  87663. private _shadowsCurve;
  87664. private _positiveCurve;
  87665. private _negativeCurve;
  87666. private _globalHue;
  87667. private _globalDensity;
  87668. private _globalSaturation;
  87669. private _globalExposure;
  87670. /**
  87671. * Gets the global Hue value.
  87672. * 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).
  87673. */
  87674. get globalHue(): number;
  87675. /**
  87676. * Sets the global Hue value.
  87677. * 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).
  87678. */
  87679. set globalHue(value: number);
  87680. /**
  87681. * Gets the global Density value.
  87682. * 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.
  87683. * Values less than zero provide a filter of opposite hue.
  87684. */
  87685. get globalDensity(): number;
  87686. /**
  87687. * Sets the global Density value.
  87688. * 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.
  87689. * Values less than zero provide a filter of opposite hue.
  87690. */
  87691. set globalDensity(value: number);
  87692. /**
  87693. * Gets the global Saturation value.
  87694. * 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.
  87695. */
  87696. get globalSaturation(): number;
  87697. /**
  87698. * Sets the global Saturation value.
  87699. * 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.
  87700. */
  87701. set globalSaturation(value: number);
  87702. /**
  87703. * Gets the global Exposure value.
  87704. * 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.
  87705. */
  87706. get globalExposure(): number;
  87707. /**
  87708. * Sets the global Exposure value.
  87709. * 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.
  87710. */
  87711. set globalExposure(value: number);
  87712. private _highlightsHue;
  87713. private _highlightsDensity;
  87714. private _highlightsSaturation;
  87715. private _highlightsExposure;
  87716. /**
  87717. * Gets the highlights Hue value.
  87718. * 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).
  87719. */
  87720. get highlightsHue(): number;
  87721. /**
  87722. * Sets the highlights Hue value.
  87723. * 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).
  87724. */
  87725. set highlightsHue(value: number);
  87726. /**
  87727. * Gets the highlights Density value.
  87728. * 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.
  87729. * Values less than zero provide a filter of opposite hue.
  87730. */
  87731. get highlightsDensity(): number;
  87732. /**
  87733. * Sets the highlights Density value.
  87734. * 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.
  87735. * Values less than zero provide a filter of opposite hue.
  87736. */
  87737. set highlightsDensity(value: number);
  87738. /**
  87739. * Gets the highlights Saturation value.
  87740. * This is an adjustment value in the range [-100,+100], where the default value of 0.0 makes no adjustment, positive values increase saturation and negative values decrease saturation.
  87741. */
  87742. get highlightsSaturation(): number;
  87743. /**
  87744. * Sets the highlights Saturation value.
  87745. * 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.
  87746. */
  87747. set highlightsSaturation(value: number);
  87748. /**
  87749. * Gets the highlights Exposure value.
  87750. * 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.
  87751. */
  87752. get highlightsExposure(): number;
  87753. /**
  87754. * Sets the highlights Exposure value.
  87755. * 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.
  87756. */
  87757. set highlightsExposure(value: number);
  87758. private _midtonesHue;
  87759. private _midtonesDensity;
  87760. private _midtonesSaturation;
  87761. private _midtonesExposure;
  87762. /**
  87763. * Gets the midtones Hue value.
  87764. * 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).
  87765. */
  87766. get midtonesHue(): number;
  87767. /**
  87768. * Sets the midtones Hue value.
  87769. * 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).
  87770. */
  87771. set midtonesHue(value: number);
  87772. /**
  87773. * Gets the midtones Density value.
  87774. * 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.
  87775. * Values less than zero provide a filter of opposite hue.
  87776. */
  87777. get midtonesDensity(): number;
  87778. /**
  87779. * Sets the midtones Density value.
  87780. * 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.
  87781. * Values less than zero provide a filter of opposite hue.
  87782. */
  87783. set midtonesDensity(value: number);
  87784. /**
  87785. * Gets the midtones Saturation value.
  87786. * This is an adjustment value in the range [-100,+100], where the default value of 0.0 makes no adjustment, positive values increase saturation and negative values decrease saturation.
  87787. */
  87788. get midtonesSaturation(): number;
  87789. /**
  87790. * Sets the midtones Saturation value.
  87791. * 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.
  87792. */
  87793. set midtonesSaturation(value: number);
  87794. /**
  87795. * Gets the midtones Exposure value.
  87796. * 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.
  87797. */
  87798. get midtonesExposure(): number;
  87799. /**
  87800. * Sets the midtones Exposure value.
  87801. * 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.
  87802. */
  87803. set midtonesExposure(value: number);
  87804. private _shadowsHue;
  87805. private _shadowsDensity;
  87806. private _shadowsSaturation;
  87807. private _shadowsExposure;
  87808. /**
  87809. * Gets the shadows Hue value.
  87810. * 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).
  87811. */
  87812. get shadowsHue(): number;
  87813. /**
  87814. * Sets the shadows Hue value.
  87815. * 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).
  87816. */
  87817. set shadowsHue(value: number);
  87818. /**
  87819. * Gets the shadows Density value.
  87820. * 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.
  87821. * Values less than zero provide a filter of opposite hue.
  87822. */
  87823. get shadowsDensity(): number;
  87824. /**
  87825. * Sets the shadows Density value.
  87826. * 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.
  87827. * Values less than zero provide a filter of opposite hue.
  87828. */
  87829. set shadowsDensity(value: number);
  87830. /**
  87831. * Gets the shadows Saturation value.
  87832. * This is an adjustment value in the range [-100,+100], where the default value of 0.0 makes no adjustment, positive values increase saturation and negative values decrease saturation.
  87833. */
  87834. get shadowsSaturation(): number;
  87835. /**
  87836. * Sets the shadows Saturation value.
  87837. * 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.
  87838. */
  87839. set shadowsSaturation(value: number);
  87840. /**
  87841. * Gets the shadows Exposure value.
  87842. * 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.
  87843. */
  87844. get shadowsExposure(): number;
  87845. /**
  87846. * Sets the shadows Exposure value.
  87847. * 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.
  87848. */
  87849. set shadowsExposure(value: number);
  87850. /**
  87851. * Returns the class name
  87852. * @returns The class name
  87853. */
  87854. getClassName(): string;
  87855. /**
  87856. * Binds the color curves to the shader.
  87857. * @param colorCurves The color curve to bind
  87858. * @param effect The effect to bind to
  87859. * @param positiveUniform The positive uniform shader parameter
  87860. * @param neutralUniform The neutral uniform shader parameter
  87861. * @param negativeUniform The negative uniform shader parameter
  87862. */
  87863. static Bind(colorCurves: ColorCurves, effect: Effect, positiveUniform?: string, neutralUniform?: string, negativeUniform?: string): void;
  87864. /**
  87865. * Prepare the list of uniforms associated with the ColorCurves effects.
  87866. * @param uniformsList The list of uniforms used in the effect
  87867. */
  87868. static PrepareUniforms(uniformsList: string[]): void;
  87869. /**
  87870. * Returns color grading data based on a hue, density, saturation and exposure value.
  87871. * @param filterHue The hue of the color filter.
  87872. * @param filterDensity The density of the color filter.
  87873. * @param saturation The saturation.
  87874. * @param exposure The exposure.
  87875. * @param result The result data container.
  87876. */
  87877. private getColorGradingDataToRef;
  87878. /**
  87879. * Takes an input slider value and returns an adjusted value that provides extra control near the centre.
  87880. * @param value The input slider value in range [-100,100].
  87881. * @returns Adjusted value.
  87882. */
  87883. private static applyColorGradingSliderNonlinear;
  87884. /**
  87885. * Returns an RGBA Color4 based on Hue, Saturation and Brightness (also referred to as value, HSV).
  87886. * @param hue The hue (H) input.
  87887. * @param saturation The saturation (S) input.
  87888. * @param brightness The brightness (B) input.
  87889. * @result An RGBA color represented as Vector4.
  87890. */
  87891. private static fromHSBToRef;
  87892. /**
  87893. * Returns a value clamped between min and max
  87894. * @param value The value to clamp
  87895. * @param min The minimum of value
  87896. * @param max The maximum of value
  87897. * @returns The clamped value.
  87898. */
  87899. private static clamp;
  87900. /**
  87901. * Clones the current color curve instance.
  87902. * @return The cloned curves
  87903. */
  87904. clone(): ColorCurves;
  87905. /**
  87906. * Serializes the current color curve instance to a json representation.
  87907. * @return a JSON representation
  87908. */
  87909. serialize(): any;
  87910. /**
  87911. * Parses the color curve from a json representation.
  87912. * @param source the JSON source to parse
  87913. * @return The parsed curves
  87914. */
  87915. static Parse(source: any): ColorCurves;
  87916. }
  87917. }
  87918. declare module BABYLON {
  87919. /**
  87920. * Interface to follow in your material defines to integrate easily the
  87921. * Image proccessing functions.
  87922. * @hidden
  87923. */
  87924. export interface IImageProcessingConfigurationDefines {
  87925. IMAGEPROCESSING: boolean;
  87926. VIGNETTE: boolean;
  87927. VIGNETTEBLENDMODEMULTIPLY: boolean;
  87928. VIGNETTEBLENDMODEOPAQUE: boolean;
  87929. TONEMAPPING: boolean;
  87930. TONEMAPPING_ACES: boolean;
  87931. CONTRAST: boolean;
  87932. EXPOSURE: boolean;
  87933. COLORCURVES: boolean;
  87934. COLORGRADING: boolean;
  87935. COLORGRADING3D: boolean;
  87936. SAMPLER3DGREENDEPTH: boolean;
  87937. SAMPLER3DBGRMAP: boolean;
  87938. IMAGEPROCESSINGPOSTPROCESS: boolean;
  87939. }
  87940. /**
  87941. * @hidden
  87942. */
  87943. export class ImageProcessingConfigurationDefines extends MaterialDefines implements IImageProcessingConfigurationDefines {
  87944. IMAGEPROCESSING: boolean;
  87945. VIGNETTE: boolean;
  87946. VIGNETTEBLENDMODEMULTIPLY: boolean;
  87947. VIGNETTEBLENDMODEOPAQUE: boolean;
  87948. TONEMAPPING: boolean;
  87949. TONEMAPPING_ACES: boolean;
  87950. CONTRAST: boolean;
  87951. COLORCURVES: boolean;
  87952. COLORGRADING: boolean;
  87953. COLORGRADING3D: boolean;
  87954. SAMPLER3DGREENDEPTH: boolean;
  87955. SAMPLER3DBGRMAP: boolean;
  87956. IMAGEPROCESSINGPOSTPROCESS: boolean;
  87957. EXPOSURE: boolean;
  87958. constructor();
  87959. }
  87960. /**
  87961. * This groups together the common properties used for image processing either in direct forward pass
  87962. * or through post processing effect depending on the use of the image processing pipeline in your scene
  87963. * or not.
  87964. */
  87965. export class ImageProcessingConfiguration {
  87966. /**
  87967. * Default tone mapping applied in BabylonJS.
  87968. */
  87969. static readonly TONEMAPPING_STANDARD: number;
  87970. /**
  87971. * ACES Tone mapping (used by default in unreal and unity). This can help getting closer
  87972. * to other engines rendering to increase portability.
  87973. */
  87974. static readonly TONEMAPPING_ACES: number;
  87975. /**
  87976. * Color curves setup used in the effect if colorCurvesEnabled is set to true
  87977. */
  87978. colorCurves: Nullable<ColorCurves>;
  87979. private _colorCurvesEnabled;
  87980. /**
  87981. * Gets wether the color curves effect is enabled.
  87982. */
  87983. get colorCurvesEnabled(): boolean;
  87984. /**
  87985. * Sets wether the color curves effect is enabled.
  87986. */
  87987. set colorCurvesEnabled(value: boolean);
  87988. private _colorGradingTexture;
  87989. /**
  87990. * Color grading LUT texture used in the effect if colorGradingEnabled is set to true
  87991. */
  87992. get colorGradingTexture(): Nullable<BaseTexture>;
  87993. /**
  87994. * Color grading LUT texture used in the effect if colorGradingEnabled is set to true
  87995. */
  87996. set colorGradingTexture(value: Nullable<BaseTexture>);
  87997. private _colorGradingEnabled;
  87998. /**
  87999. * Gets wether the color grading effect is enabled.
  88000. */
  88001. get colorGradingEnabled(): boolean;
  88002. /**
  88003. * Sets wether the color grading effect is enabled.
  88004. */
  88005. set colorGradingEnabled(value: boolean);
  88006. private _colorGradingWithGreenDepth;
  88007. /**
  88008. * Gets wether the color grading effect is using a green depth for the 3d Texture.
  88009. */
  88010. get colorGradingWithGreenDepth(): boolean;
  88011. /**
  88012. * Sets wether the color grading effect is using a green depth for the 3d Texture.
  88013. */
  88014. set colorGradingWithGreenDepth(value: boolean);
  88015. private _colorGradingBGR;
  88016. /**
  88017. * Gets wether the color grading texture contains BGR values.
  88018. */
  88019. get colorGradingBGR(): boolean;
  88020. /**
  88021. * Sets wether the color grading texture contains BGR values.
  88022. */
  88023. set colorGradingBGR(value: boolean);
  88024. /** @hidden */
  88025. _exposure: number;
  88026. /**
  88027. * Gets the Exposure used in the effect.
  88028. */
  88029. get exposure(): number;
  88030. /**
  88031. * Sets the Exposure used in the effect.
  88032. */
  88033. set exposure(value: number);
  88034. private _toneMappingEnabled;
  88035. /**
  88036. * Gets wether the tone mapping effect is enabled.
  88037. */
  88038. get toneMappingEnabled(): boolean;
  88039. /**
  88040. * Sets wether the tone mapping effect is enabled.
  88041. */
  88042. set toneMappingEnabled(value: boolean);
  88043. private _toneMappingType;
  88044. /**
  88045. * Gets the type of tone mapping effect.
  88046. */
  88047. get toneMappingType(): number;
  88048. /**
  88049. * Sets the type of tone mapping effect used in BabylonJS.
  88050. */
  88051. set toneMappingType(value: number);
  88052. protected _contrast: number;
  88053. /**
  88054. * Gets the contrast used in the effect.
  88055. */
  88056. get contrast(): number;
  88057. /**
  88058. * Sets the contrast used in the effect.
  88059. */
  88060. set contrast(value: number);
  88061. /**
  88062. * Vignette stretch size.
  88063. */
  88064. vignetteStretch: number;
  88065. /**
  88066. * Vignette centre X Offset.
  88067. */
  88068. vignetteCentreX: number;
  88069. /**
  88070. * Vignette centre Y Offset.
  88071. */
  88072. vignetteCentreY: number;
  88073. /**
  88074. * Vignette weight or intensity of the vignette effect.
  88075. */
  88076. vignetteWeight: number;
  88077. /**
  88078. * Color of the vignette applied on the screen through the chosen blend mode (vignetteBlendMode)
  88079. * if vignetteEnabled is set to true.
  88080. */
  88081. vignetteColor: Color4;
  88082. /**
  88083. * Camera field of view used by the Vignette effect.
  88084. */
  88085. vignetteCameraFov: number;
  88086. private _vignetteBlendMode;
  88087. /**
  88088. * Gets the vignette blend mode allowing different kind of effect.
  88089. */
  88090. get vignetteBlendMode(): number;
  88091. /**
  88092. * Sets the vignette blend mode allowing different kind of effect.
  88093. */
  88094. set vignetteBlendMode(value: number);
  88095. private _vignetteEnabled;
  88096. /**
  88097. * Gets wether the vignette effect is enabled.
  88098. */
  88099. get vignetteEnabled(): boolean;
  88100. /**
  88101. * Sets wether the vignette effect is enabled.
  88102. */
  88103. set vignetteEnabled(value: boolean);
  88104. private _applyByPostProcess;
  88105. /**
  88106. * Gets wether the image processing is applied through a post process or not.
  88107. */
  88108. get applyByPostProcess(): boolean;
  88109. /**
  88110. * Sets wether the image processing is applied through a post process or not.
  88111. */
  88112. set applyByPostProcess(value: boolean);
  88113. private _isEnabled;
  88114. /**
  88115. * Gets wether the image processing is enabled or not.
  88116. */
  88117. get isEnabled(): boolean;
  88118. /**
  88119. * Sets wether the image processing is enabled or not.
  88120. */
  88121. set isEnabled(value: boolean);
  88122. /**
  88123. * An event triggered when the configuration changes and requires Shader to Update some parameters.
  88124. */
  88125. onUpdateParameters: Observable<ImageProcessingConfiguration>;
  88126. /**
  88127. * Method called each time the image processing information changes requires to recompile the effect.
  88128. */
  88129. protected _updateParameters(): void;
  88130. /**
  88131. * Gets the current class name.
  88132. * @return "ImageProcessingConfiguration"
  88133. */
  88134. getClassName(): string;
  88135. /**
  88136. * Prepare the list of uniforms associated with the Image Processing effects.
  88137. * @param uniforms The list of uniforms used in the effect
  88138. * @param defines the list of defines currently in use
  88139. */
  88140. static PrepareUniforms(uniforms: string[], defines: IImageProcessingConfigurationDefines): void;
  88141. /**
  88142. * Prepare the list of samplers associated with the Image Processing effects.
  88143. * @param samplersList The list of uniforms used in the effect
  88144. * @param defines the list of defines currently in use
  88145. */
  88146. static PrepareSamplers(samplersList: string[], defines: IImageProcessingConfigurationDefines): void;
  88147. /**
  88148. * Prepare the list of defines associated to the shader.
  88149. * @param defines the list of defines to complete
  88150. * @param forPostProcess Define if we are currently in post process mode or not
  88151. */
  88152. prepareDefines(defines: IImageProcessingConfigurationDefines, forPostProcess?: boolean): void;
  88153. /**
  88154. * Returns true if all the image processing information are ready.
  88155. * @returns True if ready, otherwise, false
  88156. */
  88157. isReady(): boolean;
  88158. /**
  88159. * Binds the image processing to the shader.
  88160. * @param effect The effect to bind to
  88161. * @param overrideAspectRatio Override the aspect ratio of the effect
  88162. */
  88163. bind(effect: Effect, overrideAspectRatio?: number): void;
  88164. /**
  88165. * Clones the current image processing instance.
  88166. * @return The cloned image processing
  88167. */
  88168. clone(): ImageProcessingConfiguration;
  88169. /**
  88170. * Serializes the current image processing instance to a json representation.
  88171. * @return a JSON representation
  88172. */
  88173. serialize(): any;
  88174. /**
  88175. * Parses the image processing from a json representation.
  88176. * @param source the JSON source to parse
  88177. * @return The parsed image processing
  88178. */
  88179. static Parse(source: any): ImageProcessingConfiguration;
  88180. private static _VIGNETTEMODE_MULTIPLY;
  88181. private static _VIGNETTEMODE_OPAQUE;
  88182. /**
  88183. * Used to apply the vignette as a mix with the pixel color.
  88184. */
  88185. static get VIGNETTEMODE_MULTIPLY(): number;
  88186. /**
  88187. * Used to apply the vignette as a replacement of the pixel color.
  88188. */
  88189. static get VIGNETTEMODE_OPAQUE(): number;
  88190. }
  88191. }
  88192. declare module BABYLON {
  88193. /** @hidden */
  88194. export var postprocessVertexShader: {
  88195. name: string;
  88196. shader: string;
  88197. };
  88198. }
  88199. declare module BABYLON {
  88200. interface ThinEngine {
  88201. /**
  88202. * Creates a new render target texture
  88203. * @param size defines the size of the texture
  88204. * @param options defines the options used to create the texture
  88205. * @returns a new render target texture stored in an InternalTexture
  88206. */
  88207. createRenderTargetTexture(size: number | {
  88208. width: number;
  88209. height: number;
  88210. layers?: number;
  88211. }, options: boolean | RenderTargetCreationOptions): InternalTexture;
  88212. /**
  88213. * Creates a depth stencil texture.
  88214. * This is only available in WebGL 2 or with the depth texture extension available.
  88215. * @param size The size of face edge in the texture.
  88216. * @param options The options defining the texture.
  88217. * @returns The texture
  88218. */
  88219. createDepthStencilTexture(size: number | {
  88220. width: number;
  88221. height: number;
  88222. layers?: number;
  88223. }, options: DepthTextureCreationOptions): InternalTexture;
  88224. /** @hidden */
  88225. _createDepthStencilTexture(size: number | {
  88226. width: number;
  88227. height: number;
  88228. layers?: number;
  88229. }, options: DepthTextureCreationOptions): InternalTexture;
  88230. }
  88231. }
  88232. declare module BABYLON {
  88233. /**
  88234. * Defines the kind of connection point for node based material
  88235. */
  88236. export enum NodeMaterialBlockConnectionPointTypes {
  88237. /** Float */
  88238. Float = 1,
  88239. /** Int */
  88240. Int = 2,
  88241. /** Vector2 */
  88242. Vector2 = 4,
  88243. /** Vector3 */
  88244. Vector3 = 8,
  88245. /** Vector4 */
  88246. Vector4 = 16,
  88247. /** Color3 */
  88248. Color3 = 32,
  88249. /** Color4 */
  88250. Color4 = 64,
  88251. /** Matrix */
  88252. Matrix = 128,
  88253. /** Custom object */
  88254. Object = 256,
  88255. /** Detect type based on connection */
  88256. AutoDetect = 1024,
  88257. /** Output type that will be defined by input type */
  88258. BasedOnInput = 2048
  88259. }
  88260. }
  88261. declare module BABYLON {
  88262. /**
  88263. * Enum used to define the target of a block
  88264. */
  88265. export enum NodeMaterialBlockTargets {
  88266. /** Vertex shader */
  88267. Vertex = 1,
  88268. /** Fragment shader */
  88269. Fragment = 2,
  88270. /** Neutral */
  88271. Neutral = 4,
  88272. /** Vertex and Fragment */
  88273. VertexAndFragment = 3
  88274. }
  88275. }
  88276. declare module BABYLON {
  88277. /**
  88278. * Enum defining the mode of a NodeMaterialBlockConnectionPoint
  88279. */
  88280. export enum NodeMaterialBlockConnectionPointMode {
  88281. /** Value is an uniform */
  88282. Uniform = 0,
  88283. /** Value is a mesh attribute */
  88284. Attribute = 1,
  88285. /** Value is a varying between vertex and fragment shaders */
  88286. Varying = 2,
  88287. /** Mode is undefined */
  88288. Undefined = 3
  88289. }
  88290. }
  88291. declare module BABYLON {
  88292. /**
  88293. * Enum used to define system values e.g. values automatically provided by the system
  88294. */
  88295. export enum NodeMaterialSystemValues {
  88296. /** World */
  88297. World = 1,
  88298. /** View */
  88299. View = 2,
  88300. /** Projection */
  88301. Projection = 3,
  88302. /** ViewProjection */
  88303. ViewProjection = 4,
  88304. /** WorldView */
  88305. WorldView = 5,
  88306. /** WorldViewProjection */
  88307. WorldViewProjection = 6,
  88308. /** CameraPosition */
  88309. CameraPosition = 7,
  88310. /** Fog Color */
  88311. FogColor = 8,
  88312. /** Delta time */
  88313. DeltaTime = 9
  88314. }
  88315. }
  88316. declare module BABYLON {
  88317. /** Defines supported spaces */
  88318. export enum Space {
  88319. /** Local (object) space */
  88320. LOCAL = 0,
  88321. /** World space */
  88322. WORLD = 1,
  88323. /** Bone space */
  88324. BONE = 2
  88325. }
  88326. /** Defines the 3 main axes */
  88327. export class Axis {
  88328. /** X axis */
  88329. static X: Vector3;
  88330. /** Y axis */
  88331. static Y: Vector3;
  88332. /** Z axis */
  88333. static Z: Vector3;
  88334. }
  88335. }
  88336. declare module BABYLON {
  88337. /**
  88338. * Represents a camera frustum
  88339. */
  88340. export class Frustum {
  88341. /**
  88342. * Gets the planes representing the frustum
  88343. * @param transform matrix to be applied to the returned planes
  88344. * @returns a new array of 6 Frustum planes computed by the given transformation matrix.
  88345. */
  88346. static GetPlanes(transform: DeepImmutable<Matrix>): Plane[];
  88347. /**
  88348. * Gets the near frustum plane transformed by the transform matrix
  88349. * @param transform transformation matrix to be applied to the resulting frustum plane
  88350. * @param frustumPlane the resuling frustum plane
  88351. */
  88352. static GetNearPlaneToRef(transform: DeepImmutable<Matrix>, frustumPlane: Plane): void;
  88353. /**
  88354. * Gets the far frustum plane transformed by the transform matrix
  88355. * @param transform transformation matrix to be applied to the resulting frustum plane
  88356. * @param frustumPlane the resuling frustum plane
  88357. */
  88358. static GetFarPlaneToRef(transform: DeepImmutable<Matrix>, frustumPlane: Plane): void;
  88359. /**
  88360. * Gets the left frustum plane transformed by the transform matrix
  88361. * @param transform transformation matrix to be applied to the resulting frustum plane
  88362. * @param frustumPlane the resuling frustum plane
  88363. */
  88364. static GetLeftPlaneToRef(transform: DeepImmutable<Matrix>, frustumPlane: Plane): void;
  88365. /**
  88366. * Gets the right frustum plane transformed by the transform matrix
  88367. * @param transform transformation matrix to be applied to the resulting frustum plane
  88368. * @param frustumPlane the resuling frustum plane
  88369. */
  88370. static GetRightPlaneToRef(transform: DeepImmutable<Matrix>, frustumPlane: Plane): void;
  88371. /**
  88372. * Gets the top frustum plane transformed by the transform matrix
  88373. * @param transform transformation matrix to be applied to the resulting frustum plane
  88374. * @param frustumPlane the resuling frustum plane
  88375. */
  88376. static GetTopPlaneToRef(transform: DeepImmutable<Matrix>, frustumPlane: Plane): void;
  88377. /**
  88378. * Gets the bottom frustum plane transformed by the transform matrix
  88379. * @param transform transformation matrix to be applied to the resulting frustum plane
  88380. * @param frustumPlane the resuling frustum plane
  88381. */
  88382. static GetBottomPlaneToRef(transform: DeepImmutable<Matrix>, frustumPlane: Plane): void;
  88383. /**
  88384. * Sets the given array "frustumPlanes" with the 6 Frustum planes computed by the given transformation matrix.
  88385. * @param transform transformation matrix to be applied to the resulting frustum planes
  88386. * @param frustumPlanes the resuling frustum planes
  88387. */
  88388. static GetPlanesToRef(transform: DeepImmutable<Matrix>, frustumPlanes: Plane[]): void;
  88389. }
  88390. }
  88391. declare module BABYLON {
  88392. /**
  88393. * Interface for the size containing width and height
  88394. */
  88395. export interface ISize {
  88396. /**
  88397. * Width
  88398. */
  88399. width: number;
  88400. /**
  88401. * Heighht
  88402. */
  88403. height: number;
  88404. }
  88405. /**
  88406. * Size containing widht and height
  88407. */
  88408. export class Size implements ISize {
  88409. /**
  88410. * Width
  88411. */
  88412. width: number;
  88413. /**
  88414. * Height
  88415. */
  88416. height: number;
  88417. /**
  88418. * Creates a Size object from the given width and height (floats).
  88419. * @param width width of the new size
  88420. * @param height height of the new size
  88421. */
  88422. constructor(width: number, height: number);
  88423. /**
  88424. * Returns a string with the Size width and height
  88425. * @returns a string with the Size width and height
  88426. */
  88427. toString(): string;
  88428. /**
  88429. * "Size"
  88430. * @returns the string "Size"
  88431. */
  88432. getClassName(): string;
  88433. /**
  88434. * Returns the Size hash code.
  88435. * @returns a hash code for a unique width and height
  88436. */
  88437. getHashCode(): number;
  88438. /**
  88439. * Updates the current size from the given one.
  88440. * @param src the given size
  88441. */
  88442. copyFrom(src: Size): void;
  88443. /**
  88444. * Updates in place the current Size from the given floats.
  88445. * @param width width of the new size
  88446. * @param height height of the new size
  88447. * @returns the updated Size.
  88448. */
  88449. copyFromFloats(width: number, height: number): Size;
  88450. /**
  88451. * Updates in place the current Size from the given floats.
  88452. * @param width width to set
  88453. * @param height height to set
  88454. * @returns the updated Size.
  88455. */
  88456. set(width: number, height: number): Size;
  88457. /**
  88458. * Multiplies the width and height by numbers
  88459. * @param w factor to multiple the width by
  88460. * @param h factor to multiple the height by
  88461. * @returns a new Size set with the multiplication result of the current Size and the given floats.
  88462. */
  88463. multiplyByFloats(w: number, h: number): Size;
  88464. /**
  88465. * Clones the size
  88466. * @returns a new Size copied from the given one.
  88467. */
  88468. clone(): Size;
  88469. /**
  88470. * True if the current Size and the given one width and height are strictly equal.
  88471. * @param other the other size to compare against
  88472. * @returns True if the current Size and the given one width and height are strictly equal.
  88473. */
  88474. equals(other: Size): boolean;
  88475. /**
  88476. * The surface of the Size : width * height (float).
  88477. */
  88478. get surface(): number;
  88479. /**
  88480. * Create a new size of zero
  88481. * @returns a new Size set to (0.0, 0.0)
  88482. */
  88483. static Zero(): Size;
  88484. /**
  88485. * Sums the width and height of two sizes
  88486. * @param otherSize size to add to this size
  88487. * @returns a new Size set as the addition result of the current Size and the given one.
  88488. */
  88489. add(otherSize: Size): Size;
  88490. /**
  88491. * Subtracts the width and height of two
  88492. * @param otherSize size to subtract to this size
  88493. * @returns a new Size set as the subtraction result of the given one from the current Size.
  88494. */
  88495. subtract(otherSize: Size): Size;
  88496. /**
  88497. * Creates a new Size set at the linear interpolation "amount" between "start" and "end"
  88498. * @param start starting size to lerp between
  88499. * @param end end size to lerp between
  88500. * @param amount amount to lerp between the start and end values
  88501. * @returns a new Size set at the linear interpolation "amount" between "start" and "end"
  88502. */
  88503. static Lerp(start: Size, end: Size, amount: number): Size;
  88504. }
  88505. }
  88506. declare module BABYLON {
  88507. /**
  88508. * Contains position and normal vectors for a vertex
  88509. */
  88510. export class PositionNormalVertex {
  88511. /** the position of the vertex (defaut: 0,0,0) */
  88512. position: Vector3;
  88513. /** the normal of the vertex (defaut: 0,1,0) */
  88514. normal: Vector3;
  88515. /**
  88516. * Creates a PositionNormalVertex
  88517. * @param position the position of the vertex (defaut: 0,0,0)
  88518. * @param normal the normal of the vertex (defaut: 0,1,0)
  88519. */
  88520. constructor(
  88521. /** the position of the vertex (defaut: 0,0,0) */
  88522. position?: Vector3,
  88523. /** the normal of the vertex (defaut: 0,1,0) */
  88524. normal?: Vector3);
  88525. /**
  88526. * Clones the PositionNormalVertex
  88527. * @returns the cloned PositionNormalVertex
  88528. */
  88529. clone(): PositionNormalVertex;
  88530. }
  88531. /**
  88532. * Contains position, normal and uv vectors for a vertex
  88533. */
  88534. export class PositionNormalTextureVertex {
  88535. /** the position of the vertex (defaut: 0,0,0) */
  88536. position: Vector3;
  88537. /** the normal of the vertex (defaut: 0,1,0) */
  88538. normal: Vector3;
  88539. /** the uv of the vertex (default: 0,0) */
  88540. uv: Vector2;
  88541. /**
  88542. * Creates a PositionNormalTextureVertex
  88543. * @param position the position of the vertex (defaut: 0,0,0)
  88544. * @param normal the normal of the vertex (defaut: 0,1,0)
  88545. * @param uv the uv of the vertex (default: 0,0)
  88546. */
  88547. constructor(
  88548. /** the position of the vertex (defaut: 0,0,0) */
  88549. position?: Vector3,
  88550. /** the normal of the vertex (defaut: 0,1,0) */
  88551. normal?: Vector3,
  88552. /** the uv of the vertex (default: 0,0) */
  88553. uv?: Vector2);
  88554. /**
  88555. * Clones the PositionNormalTextureVertex
  88556. * @returns the cloned PositionNormalTextureVertex
  88557. */
  88558. clone(): PositionNormalTextureVertex;
  88559. }
  88560. }
  88561. declare module BABYLON {
  88562. /**
  88563. * Enum defining the type of animations supported by InputBlock
  88564. */
  88565. export enum AnimatedInputBlockTypes {
  88566. /** No animation */
  88567. None = 0,
  88568. /** Time based animation. Will only work for floats */
  88569. Time = 1
  88570. }
  88571. }
  88572. declare module BABYLON {
  88573. /**
  88574. * Interface describing all the common properties and methods a shadow light needs to implement.
  88575. * This helps both the shadow generator and materials to genrate the corresponding shadow maps
  88576. * as well as binding the different shadow properties to the effects.
  88577. */
  88578. export interface IShadowLight extends Light {
  88579. /**
  88580. * The light id in the scene (used in scene.findLighById for instance)
  88581. */
  88582. id: string;
  88583. /**
  88584. * The position the shdow will be casted from.
  88585. */
  88586. position: Vector3;
  88587. /**
  88588. * In 2d mode (needCube being false), the direction used to cast the shadow.
  88589. */
  88590. direction: Vector3;
  88591. /**
  88592. * The transformed position. Position of the light in world space taking parenting in account.
  88593. */
  88594. transformedPosition: Vector3;
  88595. /**
  88596. * The transformed direction. Direction of the light in world space taking parenting in account.
  88597. */
  88598. transformedDirection: Vector3;
  88599. /**
  88600. * The friendly name of the light in the scene.
  88601. */
  88602. name: string;
  88603. /**
  88604. * Defines the shadow projection clipping minimum z value.
  88605. */
  88606. shadowMinZ: number;
  88607. /**
  88608. * Defines the shadow projection clipping maximum z value.
  88609. */
  88610. shadowMaxZ: number;
  88611. /**
  88612. * Computes the transformed information (transformedPosition and transformedDirection in World space) of the current light
  88613. * @returns true if the information has been computed, false if it does not need to (no parenting)
  88614. */
  88615. computeTransformedInformation(): boolean;
  88616. /**
  88617. * Gets the scene the light belongs to.
  88618. * @returns The scene
  88619. */
  88620. getScene(): Scene;
  88621. /**
  88622. * Callback defining a custom Projection Matrix Builder.
  88623. * This can be used to override the default projection matrix computation.
  88624. */
  88625. customProjectionMatrixBuilder: (viewMatrix: Matrix, renderList: Array<AbstractMesh>, result: Matrix) => void;
  88626. /**
  88627. * Sets the shadow projection matrix in parameter to the generated projection matrix.
  88628. * @param matrix The materix to updated with the projection information
  88629. * @param viewMatrix The transform matrix of the light
  88630. * @param renderList The list of mesh to render in the map
  88631. * @returns The current light
  88632. */
  88633. setShadowProjectionMatrix(matrix: Matrix, viewMatrix: Matrix, renderList: Array<AbstractMesh>): IShadowLight;
  88634. /**
  88635. * Gets the current depth scale used in ESM.
  88636. * @returns The scale
  88637. */
  88638. getDepthScale(): number;
  88639. /**
  88640. * Returns whether or not the shadow generation require a cube texture or a 2d texture.
  88641. * @returns true if a cube texture needs to be use
  88642. */
  88643. needCube(): boolean;
  88644. /**
  88645. * Detects if the projection matrix requires to be recomputed this frame.
  88646. * @returns true if it requires to be recomputed otherwise, false.
  88647. */
  88648. needProjectionMatrixCompute(): boolean;
  88649. /**
  88650. * Forces the shadow generator to recompute the projection matrix even if position and direction did not changed.
  88651. */
  88652. forceProjectionMatrixCompute(): void;
  88653. /**
  88654. * Get the direction to use to render the shadow map. In case of cube texture, the face index can be passed.
  88655. * @param faceIndex The index of the face we are computed the direction to generate shadow
  88656. * @returns The set direction in 2d mode otherwise the direction to the cubemap face if needCube() is true
  88657. */
  88658. getShadowDirection(faceIndex?: number): Vector3;
  88659. /**
  88660. * Gets the minZ used for shadow according to both the scene and the light.
  88661. * @param activeCamera The camera we are returning the min for
  88662. * @returns the depth min z
  88663. */
  88664. getDepthMinZ(activeCamera: Camera): number;
  88665. /**
  88666. * Gets the maxZ used for shadow according to both the scene and the light.
  88667. * @param activeCamera The camera we are returning the max for
  88668. * @returns the depth max z
  88669. */
  88670. getDepthMaxZ(activeCamera: Camera): number;
  88671. }
  88672. /**
  88673. * Base implementation IShadowLight
  88674. * It groups all the common behaviour in order to reduce dupplication and better follow the DRY pattern.
  88675. */
  88676. export abstract class ShadowLight extends Light implements IShadowLight {
  88677. protected abstract _setDefaultShadowProjectionMatrix(matrix: Matrix, viewMatrix: Matrix, renderList: Array<AbstractMesh>): void;
  88678. protected _position: Vector3;
  88679. protected _setPosition(value: Vector3): void;
  88680. /**
  88681. * Sets the position the shadow will be casted from. Also use as the light position for both
  88682. * point and spot lights.
  88683. */
  88684. get position(): Vector3;
  88685. /**
  88686. * Sets the position the shadow will be casted from. Also use as the light position for both
  88687. * point and spot lights.
  88688. */
  88689. set position(value: Vector3);
  88690. protected _direction: Vector3;
  88691. protected _setDirection(value: Vector3): void;
  88692. /**
  88693. * In 2d mode (needCube being false), gets the direction used to cast the shadow.
  88694. * Also use as the light direction on spot and directional lights.
  88695. */
  88696. get direction(): Vector3;
  88697. /**
  88698. * In 2d mode (needCube being false), sets the direction used to cast the shadow.
  88699. * Also use as the light direction on spot and directional lights.
  88700. */
  88701. set direction(value: Vector3);
  88702. protected _shadowMinZ: number;
  88703. /**
  88704. * Gets the shadow projection clipping minimum z value.
  88705. */
  88706. get shadowMinZ(): number;
  88707. /**
  88708. * Sets the shadow projection clipping minimum z value.
  88709. */
  88710. set shadowMinZ(value: number);
  88711. protected _shadowMaxZ: number;
  88712. /**
  88713. * Sets the shadow projection clipping maximum z value.
  88714. */
  88715. get shadowMaxZ(): number;
  88716. /**
  88717. * Gets the shadow projection clipping maximum z value.
  88718. */
  88719. set shadowMaxZ(value: number);
  88720. /**
  88721. * Callback defining a custom Projection Matrix Builder.
  88722. * This can be used to override the default projection matrix computation.
  88723. */
  88724. customProjectionMatrixBuilder: (viewMatrix: Matrix, renderList: Array<AbstractMesh>, result: Matrix) => void;
  88725. /**
  88726. * The transformed position. Position of the light in world space taking parenting in account.
  88727. */
  88728. transformedPosition: Vector3;
  88729. /**
  88730. * The transformed direction. Direction of the light in world space taking parenting in account.
  88731. */
  88732. transformedDirection: Vector3;
  88733. private _needProjectionMatrixCompute;
  88734. /**
  88735. * Computes the transformed information (transformedPosition and transformedDirection in World space) of the current light
  88736. * @returns true if the information has been computed, false if it does not need to (no parenting)
  88737. */
  88738. computeTransformedInformation(): boolean;
  88739. /**
  88740. * Return the depth scale used for the shadow map.
  88741. * @returns the depth scale.
  88742. */
  88743. getDepthScale(): number;
  88744. /**
  88745. * Get the direction to use to render the shadow map. In case of cube texture, the face index can be passed.
  88746. * @param faceIndex The index of the face we are computed the direction to generate shadow
  88747. * @returns The set direction in 2d mode otherwise the direction to the cubemap face if needCube() is true
  88748. */
  88749. getShadowDirection(faceIndex?: number): Vector3;
  88750. /**
  88751. * Returns the ShadowLight absolute position in the World.
  88752. * @returns the position vector in world space
  88753. */
  88754. getAbsolutePosition(): Vector3;
  88755. /**
  88756. * Sets the ShadowLight direction toward the passed target.
  88757. * @param target The point to target in local space
  88758. * @returns the updated ShadowLight direction
  88759. */
  88760. setDirectionToTarget(target: Vector3): Vector3;
  88761. /**
  88762. * Returns the light rotation in euler definition.
  88763. * @returns the x y z rotation in local space.
  88764. */
  88765. getRotation(): Vector3;
  88766. /**
  88767. * Returns whether or not the shadow generation require a cube texture or a 2d texture.
  88768. * @returns true if a cube texture needs to be use
  88769. */
  88770. needCube(): boolean;
  88771. /**
  88772. * Detects if the projection matrix requires to be recomputed this frame.
  88773. * @returns true if it requires to be recomputed otherwise, false.
  88774. */
  88775. needProjectionMatrixCompute(): boolean;
  88776. /**
  88777. * Forces the shadow generator to recompute the projection matrix even if position and direction did not changed.
  88778. */
  88779. forceProjectionMatrixCompute(): void;
  88780. /** @hidden */
  88781. _initCache(): void;
  88782. /** @hidden */
  88783. _isSynchronized(): boolean;
  88784. /**
  88785. * Computes the world matrix of the node
  88786. * @param force defines if the cache version should be invalidated forcing the world matrix to be created from scratch
  88787. * @returns the world matrix
  88788. */
  88789. computeWorldMatrix(force?: boolean): Matrix;
  88790. /**
  88791. * Gets the minZ used for shadow according to both the scene and the light.
  88792. * @param activeCamera The camera we are returning the min for
  88793. * @returns the depth min z
  88794. */
  88795. getDepthMinZ(activeCamera: Camera): number;
  88796. /**
  88797. * Gets the maxZ used for shadow according to both the scene and the light.
  88798. * @param activeCamera The camera we are returning the max for
  88799. * @returns the depth max z
  88800. */
  88801. getDepthMaxZ(activeCamera: Camera): number;
  88802. /**
  88803. * Sets the shadow projection matrix in parameter to the generated projection matrix.
  88804. * @param matrix The materix to updated with the projection information
  88805. * @param viewMatrix The transform matrix of the light
  88806. * @param renderList The list of mesh to render in the map
  88807. * @returns The current light
  88808. */
  88809. setShadowProjectionMatrix(matrix: Matrix, viewMatrix: Matrix, renderList: Array<AbstractMesh>): IShadowLight;
  88810. }
  88811. }
  88812. declare module BABYLON {
  88813. /** @hidden */
  88814. export var packingFunctions: {
  88815. name: string;
  88816. shader: string;
  88817. };
  88818. }
  88819. declare module BABYLON {
  88820. /** @hidden */
  88821. export var bayerDitherFunctions: {
  88822. name: string;
  88823. shader: string;
  88824. };
  88825. }
  88826. declare module BABYLON {
  88827. /** @hidden */
  88828. export var shadowMapFragmentDeclaration: {
  88829. name: string;
  88830. shader: string;
  88831. };
  88832. }
  88833. declare module BABYLON {
  88834. /** @hidden */
  88835. export var clipPlaneFragmentDeclaration: {
  88836. name: string;
  88837. shader: string;
  88838. };
  88839. }
  88840. declare module BABYLON {
  88841. /** @hidden */
  88842. export var clipPlaneFragment: {
  88843. name: string;
  88844. shader: string;
  88845. };
  88846. }
  88847. declare module BABYLON {
  88848. /** @hidden */
  88849. export var shadowMapFragment: {
  88850. name: string;
  88851. shader: string;
  88852. };
  88853. }
  88854. declare module BABYLON {
  88855. /** @hidden */
  88856. export var shadowMapPixelShader: {
  88857. name: string;
  88858. shader: string;
  88859. };
  88860. }
  88861. declare module BABYLON {
  88862. /** @hidden */
  88863. export var bonesDeclaration: {
  88864. name: string;
  88865. shader: string;
  88866. };
  88867. }
  88868. declare module BABYLON {
  88869. /** @hidden */
  88870. export var morphTargetsVertexGlobalDeclaration: {
  88871. name: string;
  88872. shader: string;
  88873. };
  88874. }
  88875. declare module BABYLON {
  88876. /** @hidden */
  88877. export var morphTargetsVertexDeclaration: {
  88878. name: string;
  88879. shader: string;
  88880. };
  88881. }
  88882. declare module BABYLON {
  88883. /** @hidden */
  88884. export var instancesDeclaration: {
  88885. name: string;
  88886. shader: string;
  88887. };
  88888. }
  88889. declare module BABYLON {
  88890. /** @hidden */
  88891. export var helperFunctions: {
  88892. name: string;
  88893. shader: string;
  88894. };
  88895. }
  88896. declare module BABYLON {
  88897. /** @hidden */
  88898. export var shadowMapVertexDeclaration: {
  88899. name: string;
  88900. shader: string;
  88901. };
  88902. }
  88903. declare module BABYLON {
  88904. /** @hidden */
  88905. export var clipPlaneVertexDeclaration: {
  88906. name: string;
  88907. shader: string;
  88908. };
  88909. }
  88910. declare module BABYLON {
  88911. /** @hidden */
  88912. export var morphTargetsVertex: {
  88913. name: string;
  88914. shader: string;
  88915. };
  88916. }
  88917. declare module BABYLON {
  88918. /** @hidden */
  88919. export var instancesVertex: {
  88920. name: string;
  88921. shader: string;
  88922. };
  88923. }
  88924. declare module BABYLON {
  88925. /** @hidden */
  88926. export var bonesVertex: {
  88927. name: string;
  88928. shader: string;
  88929. };
  88930. }
  88931. declare module BABYLON {
  88932. /** @hidden */
  88933. export var shadowMapVertexNormalBias: {
  88934. name: string;
  88935. shader: string;
  88936. };
  88937. }
  88938. declare module BABYLON {
  88939. /** @hidden */
  88940. export var shadowMapVertexMetric: {
  88941. name: string;
  88942. shader: string;
  88943. };
  88944. }
  88945. declare module BABYLON {
  88946. /** @hidden */
  88947. export var clipPlaneVertex: {
  88948. name: string;
  88949. shader: string;
  88950. };
  88951. }
  88952. declare module BABYLON {
  88953. /** @hidden */
  88954. export var shadowMapVertexShader: {
  88955. name: string;
  88956. shader: string;
  88957. };
  88958. }
  88959. declare module BABYLON {
  88960. /** @hidden */
  88961. export var depthBoxBlurPixelShader: {
  88962. name: string;
  88963. shader: string;
  88964. };
  88965. }
  88966. declare module BABYLON {
  88967. /** @hidden */
  88968. export var shadowMapFragmentSoftTransparentShadow: {
  88969. name: string;
  88970. shader: string;
  88971. };
  88972. }
  88973. declare module BABYLON {
  88974. /**
  88975. * EffectFallbacks can be used to add fallbacks (properties to disable) to certain properties when desired to improve performance.
  88976. * (Eg. Start at high quality with reflection and fog, if fps is low, remove reflection, if still low remove fog)
  88977. */
  88978. export class EffectFallbacks implements IEffectFallbacks {
  88979. private _defines;
  88980. private _currentRank;
  88981. private _maxRank;
  88982. private _mesh;
  88983. /**
  88984. * Removes the fallback from the bound mesh.
  88985. */
  88986. unBindMesh(): void;
  88987. /**
  88988. * Adds a fallback on the specified property.
  88989. * @param rank The rank of the fallback (Lower ranks will be fallbacked to first)
  88990. * @param define The name of the define in the shader
  88991. */
  88992. addFallback(rank: number, define: string): void;
  88993. /**
  88994. * Sets the mesh to use CPU skinning when needing to fallback.
  88995. * @param rank The rank of the fallback (Lower ranks will be fallbacked to first)
  88996. * @param mesh The mesh to use the fallbacks.
  88997. */
  88998. addCPUSkinningFallback(rank: number, mesh: AbstractMesh): void;
  88999. /**
  89000. * Checks to see if more fallbacks are still availible.
  89001. */
  89002. get hasMoreFallbacks(): boolean;
  89003. /**
  89004. * Removes the defines that should be removed when falling back.
  89005. * @param currentDefines defines the current define statements for the shader.
  89006. * @param effect defines the current effect we try to compile
  89007. * @returns The resulting defines with defines of the current rank removed.
  89008. */
  89009. reduce(currentDefines: string, effect: Effect): string;
  89010. }
  89011. }
  89012. declare module BABYLON {
  89013. /**
  89014. * Interface used to define Action
  89015. */
  89016. export interface IAction {
  89017. /**
  89018. * Trigger for the action
  89019. */
  89020. trigger: number;
  89021. /** Options of the trigger */
  89022. triggerOptions: any;
  89023. /**
  89024. * Gets the trigger parameters
  89025. * @returns the trigger parameters
  89026. */
  89027. getTriggerParameter(): any;
  89028. /**
  89029. * Internal only - executes current action event
  89030. * @hidden
  89031. */
  89032. _executeCurrent(evt?: ActionEvent): void;
  89033. /**
  89034. * Serialize placeholder for child classes
  89035. * @param parent of child
  89036. * @returns the serialized object
  89037. */
  89038. serialize(parent: any): any;
  89039. /**
  89040. * Internal only
  89041. * @hidden
  89042. */
  89043. _prepare(): void;
  89044. /**
  89045. * Internal only - manager for action
  89046. * @hidden
  89047. */
  89048. _actionManager: Nullable<AbstractActionManager>;
  89049. /**
  89050. * Adds action to chain of actions, may be a DoNothingAction
  89051. * @param action defines the next action to execute
  89052. * @returns The action passed in
  89053. * @see https://www.babylonjs-playground.com/#1T30HR#0
  89054. */
  89055. then(action: IAction): IAction;
  89056. }
  89057. /**
  89058. * The action to be carried out following a trigger
  89059. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#available-actions
  89060. */
  89061. export class Action implements IAction {
  89062. /** the trigger, with or without parameters, for the action */
  89063. triggerOptions: any;
  89064. /**
  89065. * Trigger for the action
  89066. */
  89067. trigger: number;
  89068. /**
  89069. * Internal only - manager for action
  89070. * @hidden
  89071. */
  89072. _actionManager: ActionManager;
  89073. private _nextActiveAction;
  89074. private _child;
  89075. private _condition?;
  89076. private _triggerParameter;
  89077. /**
  89078. * An event triggered prior to action being executed.
  89079. */
  89080. onBeforeExecuteObservable: Observable<Action>;
  89081. /**
  89082. * Creates a new Action
  89083. * @param triggerOptions the trigger, with or without parameters, for the action
  89084. * @param condition an optional determinant of action
  89085. */
  89086. constructor(
  89087. /** the trigger, with or without parameters, for the action */
  89088. triggerOptions: any, condition?: Condition);
  89089. /**
  89090. * Internal only
  89091. * @hidden
  89092. */
  89093. _prepare(): void;
  89094. /**
  89095. * Gets the trigger parameters
  89096. * @returns the trigger parameters
  89097. */
  89098. getTriggerParameter(): any;
  89099. /**
  89100. * Internal only - executes current action event
  89101. * @hidden
  89102. */
  89103. _executeCurrent(evt?: ActionEvent): void;
  89104. /**
  89105. * Execute placeholder for child classes
  89106. * @param evt optional action event
  89107. */
  89108. execute(evt?: ActionEvent): void;
  89109. /**
  89110. * Skips to next active action
  89111. */
  89112. skipToNextActiveAction(): void;
  89113. /**
  89114. * Adds action to chain of actions, may be a DoNothingAction
  89115. * @param action defines the next action to execute
  89116. * @returns The action passed in
  89117. * @see https://www.babylonjs-playground.com/#1T30HR#0
  89118. */
  89119. then(action: Action): Action;
  89120. /**
  89121. * Internal only
  89122. * @hidden
  89123. */
  89124. _getProperty(propertyPath: string): string;
  89125. /**
  89126. * Internal only
  89127. * @hidden
  89128. */
  89129. _getEffectiveTarget(target: any, propertyPath: string): any;
  89130. /**
  89131. * Serialize placeholder for child classes
  89132. * @param parent of child
  89133. * @returns the serialized object
  89134. */
  89135. serialize(parent: any): any;
  89136. /**
  89137. * Internal only called by serialize
  89138. * @hidden
  89139. */
  89140. protected _serialize(serializedAction: any, parent?: any): any;
  89141. /**
  89142. * Internal only
  89143. * @hidden
  89144. */
  89145. static _SerializeValueAsString: (value: any) => string;
  89146. /**
  89147. * Internal only
  89148. * @hidden
  89149. */
  89150. static _GetTargetProperty: (target: Scene | Node) => {
  89151. name: string;
  89152. targetType: string;
  89153. value: string;
  89154. };
  89155. }
  89156. }
  89157. declare module BABYLON {
  89158. /**
  89159. * A Condition applied to an Action
  89160. */
  89161. export class Condition {
  89162. /**
  89163. * Internal only - manager for action
  89164. * @hidden
  89165. */
  89166. _actionManager: ActionManager;
  89167. /**
  89168. * Internal only
  89169. * @hidden
  89170. */
  89171. _evaluationId: number;
  89172. /**
  89173. * Internal only
  89174. * @hidden
  89175. */
  89176. _currentResult: boolean;
  89177. /**
  89178. * Creates a new Condition
  89179. * @param actionManager the manager of the action the condition is applied to
  89180. */
  89181. constructor(actionManager: ActionManager);
  89182. /**
  89183. * Check if the current condition is valid
  89184. * @returns a boolean
  89185. */
  89186. isValid(): boolean;
  89187. /**
  89188. * Internal only
  89189. * @hidden
  89190. */
  89191. _getProperty(propertyPath: string): string;
  89192. /**
  89193. * Internal only
  89194. * @hidden
  89195. */
  89196. _getEffectiveTarget(target: any, propertyPath: string): any;
  89197. /**
  89198. * Serialize placeholder for child classes
  89199. * @returns the serialized object
  89200. */
  89201. serialize(): any;
  89202. /**
  89203. * Internal only
  89204. * @hidden
  89205. */
  89206. protected _serialize(serializedCondition: any): any;
  89207. }
  89208. /**
  89209. * Defines specific conditional operators as extensions of Condition
  89210. */
  89211. export class ValueCondition extends Condition {
  89212. /** path to specify the property of the target the conditional operator uses */
  89213. propertyPath: string;
  89214. /** the value compared by the conditional operator against the current value of the property */
  89215. value: any;
  89216. /** the conditional operator, default ValueCondition.IsEqual */
  89217. operator: number;
  89218. /**
  89219. * Internal only
  89220. * @hidden
  89221. */
  89222. private static _IsEqual;
  89223. /**
  89224. * Internal only
  89225. * @hidden
  89226. */
  89227. private static _IsDifferent;
  89228. /**
  89229. * Internal only
  89230. * @hidden
  89231. */
  89232. private static _IsGreater;
  89233. /**
  89234. * Internal only
  89235. * @hidden
  89236. */
  89237. private static _IsLesser;
  89238. /**
  89239. * returns the number for IsEqual
  89240. */
  89241. static get IsEqual(): number;
  89242. /**
  89243. * Returns the number for IsDifferent
  89244. */
  89245. static get IsDifferent(): number;
  89246. /**
  89247. * Returns the number for IsGreater
  89248. */
  89249. static get IsGreater(): number;
  89250. /**
  89251. * Returns the number for IsLesser
  89252. */
  89253. static get IsLesser(): number;
  89254. /**
  89255. * Internal only The action manager for the condition
  89256. * @hidden
  89257. */
  89258. _actionManager: ActionManager;
  89259. /**
  89260. * Internal only
  89261. * @hidden
  89262. */
  89263. private _target;
  89264. /**
  89265. * Internal only
  89266. * @hidden
  89267. */
  89268. private _effectiveTarget;
  89269. /**
  89270. * Internal only
  89271. * @hidden
  89272. */
  89273. private _property;
  89274. /**
  89275. * Creates a new ValueCondition
  89276. * @param actionManager manager for the action the condition applies to
  89277. * @param target for the action
  89278. * @param propertyPath path to specify the property of the target the conditional operator uses
  89279. * @param value the value compared by the conditional operator against the current value of the property
  89280. * @param operator the conditional operator, default ValueCondition.IsEqual
  89281. */
  89282. constructor(actionManager: ActionManager, target: any,
  89283. /** path to specify the property of the target the conditional operator uses */
  89284. propertyPath: string,
  89285. /** the value compared by the conditional operator against the current value of the property */
  89286. value: any,
  89287. /** the conditional operator, default ValueCondition.IsEqual */
  89288. operator?: number);
  89289. /**
  89290. * Compares the given value with the property value for the specified conditional operator
  89291. * @returns the result of the comparison
  89292. */
  89293. isValid(): boolean;
  89294. /**
  89295. * Serialize the ValueCondition into a JSON compatible object
  89296. * @returns serialization object
  89297. */
  89298. serialize(): any;
  89299. /**
  89300. * Gets the name of the conditional operator for the ValueCondition
  89301. * @param operator the conditional operator
  89302. * @returns the name
  89303. */
  89304. static GetOperatorName(operator: number): string;
  89305. }
  89306. /**
  89307. * Defines a predicate condition as an extension of Condition
  89308. */
  89309. export class PredicateCondition extends Condition {
  89310. /** defines the predicate function used to validate the condition */
  89311. predicate: () => boolean;
  89312. /**
  89313. * Internal only - manager for action
  89314. * @hidden
  89315. */
  89316. _actionManager: ActionManager;
  89317. /**
  89318. * Creates a new PredicateCondition
  89319. * @param actionManager manager for the action the condition applies to
  89320. * @param predicate defines the predicate function used to validate the condition
  89321. */
  89322. constructor(actionManager: ActionManager,
  89323. /** defines the predicate function used to validate the condition */
  89324. predicate: () => boolean);
  89325. /**
  89326. * @returns the validity of the predicate condition
  89327. */
  89328. isValid(): boolean;
  89329. }
  89330. /**
  89331. * Defines a state condition as an extension of Condition
  89332. */
  89333. export class StateCondition extends Condition {
  89334. /** Value to compare with target state */
  89335. value: string;
  89336. /**
  89337. * Internal only - manager for action
  89338. * @hidden
  89339. */
  89340. _actionManager: ActionManager;
  89341. /**
  89342. * Internal only
  89343. * @hidden
  89344. */
  89345. private _target;
  89346. /**
  89347. * Creates a new StateCondition
  89348. * @param actionManager manager for the action the condition applies to
  89349. * @param target of the condition
  89350. * @param value to compare with target state
  89351. */
  89352. constructor(actionManager: ActionManager, target: any,
  89353. /** Value to compare with target state */
  89354. value: string);
  89355. /**
  89356. * Gets a boolean indicating if the current condition is met
  89357. * @returns the validity of the state
  89358. */
  89359. isValid(): boolean;
  89360. /**
  89361. * Serialize the StateCondition into a JSON compatible object
  89362. * @returns serialization object
  89363. */
  89364. serialize(): any;
  89365. }
  89366. }
  89367. declare module BABYLON {
  89368. /**
  89369. * This defines an action responsible to toggle a boolean once triggered.
  89370. * @see https://doc.babylonjs.com/how_to/how_to_use_actions
  89371. */
  89372. export class SwitchBooleanAction extends Action {
  89373. /**
  89374. * The path to the boolean property in the target object
  89375. */
  89376. propertyPath: string;
  89377. private _target;
  89378. private _effectiveTarget;
  89379. private _property;
  89380. /**
  89381. * Instantiate the action
  89382. * @param triggerOptions defines the trigger options
  89383. * @param target defines the object containing the boolean
  89384. * @param propertyPath defines the path to the boolean property in the target object
  89385. * @param condition defines the trigger related conditions
  89386. */
  89387. constructor(triggerOptions: any, target: any, propertyPath: string, condition?: Condition);
  89388. /** @hidden */
  89389. _prepare(): void;
  89390. /**
  89391. * Execute the action toggle the boolean value.
  89392. */
  89393. execute(): void;
  89394. /**
  89395. * Serializes the actions and its related information.
  89396. * @param parent defines the object to serialize in
  89397. * @returns the serialized object
  89398. */
  89399. serialize(parent: any): any;
  89400. }
  89401. /**
  89402. * This defines an action responsible to set a the state field of the target
  89403. * to a desired value once triggered.
  89404. * @see https://doc.babylonjs.com/how_to/how_to_use_actions
  89405. */
  89406. export class SetStateAction extends Action {
  89407. /**
  89408. * The value to store in the state field.
  89409. */
  89410. value: string;
  89411. private _target;
  89412. /**
  89413. * Instantiate the action
  89414. * @param triggerOptions defines the trigger options
  89415. * @param target defines the object containing the state property
  89416. * @param value defines the value to store in the state field
  89417. * @param condition defines the trigger related conditions
  89418. */
  89419. constructor(triggerOptions: any, target: any, value: string, condition?: Condition);
  89420. /**
  89421. * Execute the action and store the value on the target state property.
  89422. */
  89423. execute(): void;
  89424. /**
  89425. * Serializes the actions and its related information.
  89426. * @param parent defines the object to serialize in
  89427. * @returns the serialized object
  89428. */
  89429. serialize(parent: any): any;
  89430. }
  89431. /**
  89432. * This defines an action responsible to set a property of the target
  89433. * to a desired value once triggered.
  89434. * @see https://doc.babylonjs.com/how_to/how_to_use_actions
  89435. */
  89436. export class SetValueAction extends Action {
  89437. /**
  89438. * The path of the property to set in the target.
  89439. */
  89440. propertyPath: string;
  89441. /**
  89442. * The value to set in the property
  89443. */
  89444. value: any;
  89445. private _target;
  89446. private _effectiveTarget;
  89447. private _property;
  89448. /**
  89449. * Instantiate the action
  89450. * @param triggerOptions defines the trigger options
  89451. * @param target defines the object containing the property
  89452. * @param propertyPath defines the path of the property to set in the target
  89453. * @param value defines the value to set in the property
  89454. * @param condition defines the trigger related conditions
  89455. */
  89456. constructor(triggerOptions: any, target: any, propertyPath: string, value: any, condition?: Condition);
  89457. /** @hidden */
  89458. _prepare(): void;
  89459. /**
  89460. * Execute the action and set the targetted property to the desired value.
  89461. */
  89462. execute(): void;
  89463. /**
  89464. * Serializes the actions and its related information.
  89465. * @param parent defines the object to serialize in
  89466. * @returns the serialized object
  89467. */
  89468. serialize(parent: any): any;
  89469. }
  89470. /**
  89471. * This defines an action responsible to increment the target value
  89472. * to a desired value once triggered.
  89473. * @see https://doc.babylonjs.com/how_to/how_to_use_actions
  89474. */
  89475. export class IncrementValueAction extends Action {
  89476. /**
  89477. * The path of the property to increment in the target.
  89478. */
  89479. propertyPath: string;
  89480. /**
  89481. * The value we should increment the property by.
  89482. */
  89483. value: any;
  89484. private _target;
  89485. private _effectiveTarget;
  89486. private _property;
  89487. /**
  89488. * Instantiate the action
  89489. * @param triggerOptions defines the trigger options
  89490. * @param target defines the object containing the property
  89491. * @param propertyPath defines the path of the property to increment in the target
  89492. * @param value defines the value value we should increment the property by
  89493. * @param condition defines the trigger related conditions
  89494. */
  89495. constructor(triggerOptions: any, target: any, propertyPath: string, value: any, condition?: Condition);
  89496. /** @hidden */
  89497. _prepare(): void;
  89498. /**
  89499. * Execute the action and increment the target of the value amount.
  89500. */
  89501. execute(): void;
  89502. /**
  89503. * Serializes the actions and its related information.
  89504. * @param parent defines the object to serialize in
  89505. * @returns the serialized object
  89506. */
  89507. serialize(parent: any): any;
  89508. }
  89509. /**
  89510. * This defines an action responsible to start an animation once triggered.
  89511. * @see https://doc.babylonjs.com/how_to/how_to_use_actions
  89512. */
  89513. export class PlayAnimationAction extends Action {
  89514. /**
  89515. * Where the animation should start (animation frame)
  89516. */
  89517. from: number;
  89518. /**
  89519. * Where the animation should stop (animation frame)
  89520. */
  89521. to: number;
  89522. /**
  89523. * Define if the animation should loop or stop after the first play.
  89524. */
  89525. loop?: boolean;
  89526. private _target;
  89527. /**
  89528. * Instantiate the action
  89529. * @param triggerOptions defines the trigger options
  89530. * @param target defines the target animation or animation name
  89531. * @param from defines from where the animation should start (animation frame)
  89532. * @param end defines where the animation should stop (animation frame)
  89533. * @param loop defines if the animation should loop or stop after the first play
  89534. * @param condition defines the trigger related conditions
  89535. */
  89536. constructor(triggerOptions: any, target: any, from: number, to: number, loop?: boolean, condition?: Condition);
  89537. /** @hidden */
  89538. _prepare(): void;
  89539. /**
  89540. * Execute the action and play the animation.
  89541. */
  89542. execute(): void;
  89543. /**
  89544. * Serializes the actions and its related information.
  89545. * @param parent defines the object to serialize in
  89546. * @returns the serialized object
  89547. */
  89548. serialize(parent: any): any;
  89549. }
  89550. /**
  89551. * This defines an action responsible to stop an animation once triggered.
  89552. * @see https://doc.babylonjs.com/how_to/how_to_use_actions
  89553. */
  89554. export class StopAnimationAction extends Action {
  89555. private _target;
  89556. /**
  89557. * Instantiate the action
  89558. * @param triggerOptions defines the trigger options
  89559. * @param target defines the target animation or animation name
  89560. * @param condition defines the trigger related conditions
  89561. */
  89562. constructor(triggerOptions: any, target: any, condition?: Condition);
  89563. /** @hidden */
  89564. _prepare(): void;
  89565. /**
  89566. * Execute the action and stop the animation.
  89567. */
  89568. execute(): void;
  89569. /**
  89570. * Serializes the actions and its related information.
  89571. * @param parent defines the object to serialize in
  89572. * @returns the serialized object
  89573. */
  89574. serialize(parent: any): any;
  89575. }
  89576. /**
  89577. * This defines an action responsible that does nothing once triggered.
  89578. * @see https://doc.babylonjs.com/how_to/how_to_use_actions
  89579. */
  89580. export class DoNothingAction extends Action {
  89581. /**
  89582. * Instantiate the action
  89583. * @param triggerOptions defines the trigger options
  89584. * @param condition defines the trigger related conditions
  89585. */
  89586. constructor(triggerOptions?: any, condition?: Condition);
  89587. /**
  89588. * Execute the action and do nothing.
  89589. */
  89590. execute(): void;
  89591. /**
  89592. * Serializes the actions and its related information.
  89593. * @param parent defines the object to serialize in
  89594. * @returns the serialized object
  89595. */
  89596. serialize(parent: any): any;
  89597. }
  89598. /**
  89599. * This defines an action responsible to trigger several actions once triggered.
  89600. * @see https://doc.babylonjs.com/how_to/how_to_use_actions
  89601. */
  89602. export class CombineAction extends Action {
  89603. /**
  89604. * The list of aggregated animations to run.
  89605. */
  89606. children: Action[];
  89607. /**
  89608. * Instantiate the action
  89609. * @param triggerOptions defines the trigger options
  89610. * @param children defines the list of aggregated animations to run
  89611. * @param condition defines the trigger related conditions
  89612. */
  89613. constructor(triggerOptions: any, children: Action[], condition?: Condition);
  89614. /** @hidden */
  89615. _prepare(): void;
  89616. /**
  89617. * Execute the action and executes all the aggregated actions.
  89618. */
  89619. execute(evt: ActionEvent): void;
  89620. /**
  89621. * Serializes the actions and its related information.
  89622. * @param parent defines the object to serialize in
  89623. * @returns the serialized object
  89624. */
  89625. serialize(parent: any): any;
  89626. }
  89627. /**
  89628. * This defines an action responsible to run code (external event) once triggered.
  89629. * @see https://doc.babylonjs.com/how_to/how_to_use_actions
  89630. */
  89631. export class ExecuteCodeAction extends Action {
  89632. /**
  89633. * The callback function to run.
  89634. */
  89635. func: (evt: ActionEvent) => void;
  89636. /**
  89637. * Instantiate the action
  89638. * @param triggerOptions defines the trigger options
  89639. * @param func defines the callback function to run
  89640. * @param condition defines the trigger related conditions
  89641. */
  89642. constructor(triggerOptions: any, func: (evt: ActionEvent) => void, condition?: Condition);
  89643. /**
  89644. * Execute the action and run the attached code.
  89645. */
  89646. execute(evt: ActionEvent): void;
  89647. }
  89648. /**
  89649. * This defines an action responsible to set the parent property of the target once triggered.
  89650. * @see https://doc.babylonjs.com/how_to/how_to_use_actions
  89651. */
  89652. export class SetParentAction extends Action {
  89653. private _parent;
  89654. private _target;
  89655. /**
  89656. * Instantiate the action
  89657. * @param triggerOptions defines the trigger options
  89658. * @param target defines the target containing the parent property
  89659. * @param parent defines from where the animation should start (animation frame)
  89660. * @param condition defines the trigger related conditions
  89661. */
  89662. constructor(triggerOptions: any, target: any, parent: any, condition?: Condition);
  89663. /** @hidden */
  89664. _prepare(): void;
  89665. /**
  89666. * Execute the action and set the parent property.
  89667. */
  89668. execute(): void;
  89669. /**
  89670. * Serializes the actions and its related information.
  89671. * @param parent defines the object to serialize in
  89672. * @returns the serialized object
  89673. */
  89674. serialize(parent: any): any;
  89675. }
  89676. }
  89677. declare module BABYLON {
  89678. /**
  89679. * Action Manager manages all events to be triggered on a given mesh or the global scene.
  89680. * A single scene can have many Action Managers to handle predefined actions on specific meshes.
  89681. * @see https://doc.babylonjs.com/how_to/how_to_use_actions
  89682. */
  89683. export class ActionManager extends AbstractActionManager {
  89684. /**
  89685. * Nothing
  89686. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  89687. */
  89688. static readonly NothingTrigger: number;
  89689. /**
  89690. * On pick
  89691. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  89692. */
  89693. static readonly OnPickTrigger: number;
  89694. /**
  89695. * On left pick
  89696. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  89697. */
  89698. static readonly OnLeftPickTrigger: number;
  89699. /**
  89700. * On right pick
  89701. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  89702. */
  89703. static readonly OnRightPickTrigger: number;
  89704. /**
  89705. * On center pick
  89706. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  89707. */
  89708. static readonly OnCenterPickTrigger: number;
  89709. /**
  89710. * On pick down
  89711. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  89712. */
  89713. static readonly OnPickDownTrigger: number;
  89714. /**
  89715. * On double pick
  89716. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  89717. */
  89718. static readonly OnDoublePickTrigger: number;
  89719. /**
  89720. * On pick up
  89721. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  89722. */
  89723. static readonly OnPickUpTrigger: number;
  89724. /**
  89725. * On pick out.
  89726. * This trigger will only be raised if you also declared a OnPickDown
  89727. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  89728. */
  89729. static readonly OnPickOutTrigger: number;
  89730. /**
  89731. * On long press
  89732. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  89733. */
  89734. static readonly OnLongPressTrigger: number;
  89735. /**
  89736. * On pointer over
  89737. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  89738. */
  89739. static readonly OnPointerOverTrigger: number;
  89740. /**
  89741. * On pointer out
  89742. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  89743. */
  89744. static readonly OnPointerOutTrigger: number;
  89745. /**
  89746. * On every frame
  89747. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  89748. */
  89749. static readonly OnEveryFrameTrigger: number;
  89750. /**
  89751. * On intersection enter
  89752. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  89753. */
  89754. static readonly OnIntersectionEnterTrigger: number;
  89755. /**
  89756. * On intersection exit
  89757. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  89758. */
  89759. static readonly OnIntersectionExitTrigger: number;
  89760. /**
  89761. * On key down
  89762. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  89763. */
  89764. static readonly OnKeyDownTrigger: number;
  89765. /**
  89766. * On key up
  89767. * @see https://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  89768. */
  89769. static readonly OnKeyUpTrigger: number;
  89770. private _scene;
  89771. /**
  89772. * Creates a new action manager
  89773. * @param scene defines the hosting scene
  89774. */
  89775. constructor(scene: Scene);
  89776. /**
  89777. * Releases all associated resources
  89778. */
  89779. dispose(): void;
  89780. /**
  89781. * Gets hosting scene
  89782. * @returns the hosting scene
  89783. */
  89784. getScene(): Scene;
  89785. /**
  89786. * Does this action manager handles actions of any of the given triggers
  89787. * @param triggers defines the triggers to be tested
  89788. * @return a boolean indicating whether one (or more) of the triggers is handled
  89789. */
  89790. hasSpecificTriggers(triggers: number[]): boolean;
  89791. /**
  89792. * Does this action manager handles actions of any of the given triggers. This function takes two arguments for
  89793. * speed.
  89794. * @param triggerA defines the trigger to be tested
  89795. * @param triggerB defines the trigger to be tested
  89796. * @return a boolean indicating whether one (or more) of the triggers is handled
  89797. */
  89798. hasSpecificTriggers2(triggerA: number, triggerB: number): boolean;
  89799. /**
  89800. * Does this action manager handles actions of a given trigger
  89801. * @param trigger defines the trigger to be tested
  89802. * @param parameterPredicate defines an optional predicate to filter triggers by parameter
  89803. * @return whether the trigger is handled
  89804. */
  89805. hasSpecificTrigger(trigger: number, parameterPredicate?: (parameter: any) => boolean): boolean;
  89806. /**
  89807. * Does this action manager has pointer triggers
  89808. */
  89809. get hasPointerTriggers(): boolean;
  89810. /**
  89811. * Does this action manager has pick triggers
  89812. */
  89813. get hasPickTriggers(): boolean;
  89814. /**
  89815. * Registers an action to this action manager
  89816. * @param action defines the action to be registered
  89817. * @return the action amended (prepared) after registration
  89818. */
  89819. registerAction(action: IAction): Nullable<IAction>;
  89820. /**
  89821. * Unregisters an action to this action manager
  89822. * @param action defines the action to be unregistered
  89823. * @return a boolean indicating whether the action has been unregistered
  89824. */
  89825. unregisterAction(action: IAction): Boolean;
  89826. /**
  89827. * Process a specific trigger
  89828. * @param trigger defines the trigger to process
  89829. * @param evt defines the event details to be processed
  89830. */
  89831. processTrigger(trigger: number, evt?: IActionEvent): void;
  89832. /** @hidden */
  89833. _getEffectiveTarget(target: any, propertyPath: string): any;
  89834. /** @hidden */
  89835. _getProperty(propertyPath: string): string;
  89836. /**
  89837. * Serialize this manager to a JSON object
  89838. * @param name defines the property name to store this manager
  89839. * @returns a JSON representation of this manager
  89840. */
  89841. serialize(name: string): any;
  89842. /**
  89843. * Creates a new ActionManager from a JSON data
  89844. * @param parsedActions defines the JSON data to read from
  89845. * @param object defines the hosting mesh
  89846. * @param scene defines the hosting scene
  89847. */
  89848. static Parse(parsedActions: any, object: Nullable<AbstractMesh>, scene: Scene): void;
  89849. /**
  89850. * Get a trigger name by index
  89851. * @param trigger defines the trigger index
  89852. * @returns a trigger name
  89853. */
  89854. static GetTriggerName(trigger: number): string;
  89855. }
  89856. }
  89857. declare module BABYLON {
  89858. /**
  89859. * Class used to represent a sprite
  89860. * @see https://doc.babylonjs.com/babylon101/sprites
  89861. */
  89862. export class Sprite implements IAnimatable {
  89863. /** defines the name */
  89864. name: string;
  89865. /** Gets or sets the current world position */
  89866. position: Vector3;
  89867. /** Gets or sets the main color */
  89868. color: Color4;
  89869. /** Gets or sets the width */
  89870. width: number;
  89871. /** Gets or sets the height */
  89872. height: number;
  89873. /** Gets or sets rotation angle */
  89874. angle: number;
  89875. /** Gets or sets the cell index in the sprite sheet */
  89876. cellIndex: number;
  89877. /** Gets or sets the cell reference in the sprite sheet, uses sprite's filename when added to sprite sheet */
  89878. cellRef: string;
  89879. /** Gets or sets a boolean indicating if UV coordinates should be inverted in U axis */
  89880. invertU: boolean;
  89881. /** Gets or sets a boolean indicating if UV coordinates should be inverted in B axis */
  89882. invertV: boolean;
  89883. /** Gets or sets a boolean indicating that this sprite should be disposed after animation ends */
  89884. disposeWhenFinishedAnimating: boolean;
  89885. /** Gets the list of attached animations */
  89886. animations: Nullable<Array<Animation>>;
  89887. /** Gets or sets a boolean indicating if the sprite can be picked */
  89888. isPickable: boolean;
  89889. /** Gets or sets a boolean indicating that sprite texture alpha will be used for precise picking (false by default) */
  89890. useAlphaForPicking: boolean;
  89891. /** @hidden */
  89892. _xOffset: number;
  89893. /** @hidden */
  89894. _yOffset: number;
  89895. /** @hidden */
  89896. _xSize: number;
  89897. /** @hidden */
  89898. _ySize: number;
  89899. /**
  89900. * Gets or sets the associated action manager
  89901. */
  89902. actionManager: Nullable<ActionManager>;
  89903. /**
  89904. * An event triggered when the control has been disposed
  89905. */
  89906. onDisposeObservable: Observable<Sprite>;
  89907. private _animationStarted;
  89908. private _loopAnimation;
  89909. private _fromIndex;
  89910. private _toIndex;
  89911. private _delay;
  89912. private _direction;
  89913. private _manager;
  89914. private _time;
  89915. private _onAnimationEnd;
  89916. /**
  89917. * Gets or sets a boolean indicating if the sprite is visible (renderable). Default is true
  89918. */
  89919. isVisible: boolean;
  89920. /**
  89921. * Gets or sets the sprite size
  89922. */
  89923. get size(): number;
  89924. set size(value: number);
  89925. /**
  89926. * Returns a boolean indicating if the animation is started
  89927. */
  89928. get animationStarted(): boolean;
  89929. /**
  89930. * Gets or sets the unique id of the sprite
  89931. */
  89932. uniqueId: number;
  89933. /**
  89934. * Gets the manager of this sprite
  89935. */
  89936. get manager(): ISpriteManager;
  89937. /**
  89938. * Creates a new Sprite
  89939. * @param name defines the name
  89940. * @param manager defines the manager
  89941. */
  89942. constructor(
  89943. /** defines the name */
  89944. name: string, manager: ISpriteManager);
  89945. /**
  89946. * Returns the string "Sprite"
  89947. * @returns "Sprite"
  89948. */
  89949. getClassName(): string;
  89950. /** Gets or sets the initial key for the animation (setting it will restart the animation) */
  89951. get fromIndex(): number;
  89952. set fromIndex(value: number);
  89953. /** Gets or sets the end key for the animation (setting it will restart the animation) */
  89954. get toIndex(): number;
  89955. set toIndex(value: number);
  89956. /** Gets or sets a boolean indicating if the animation is looping (setting it will restart the animation) */
  89957. get loopAnimation(): boolean;
  89958. set loopAnimation(value: boolean);
  89959. /** Gets or sets the delay between cell changes (setting it will restart the animation) */
  89960. get delay(): number;
  89961. set delay(value: number);
  89962. /**
  89963. * Starts an animation
  89964. * @param from defines the initial key
  89965. * @param to defines the end key
  89966. * @param loop defines if the animation must loop
  89967. * @param delay defines the start delay (in ms)
  89968. * @param onAnimationEnd defines a callback to call when animation ends
  89969. */
  89970. playAnimation(from: number, to: number, loop: boolean, delay: number, onAnimationEnd?: Nullable<() => void>): void;
  89971. /** Stops current animation (if any) */
  89972. stopAnimation(): void;
  89973. /** @hidden */
  89974. _animate(deltaTime: number): void;
  89975. /** Release associated resources */
  89976. dispose(): void;
  89977. /**
  89978. * Serializes the sprite to a JSON object
  89979. * @returns the JSON object
  89980. */
  89981. serialize(): any;
  89982. /**
  89983. * Parses a JSON object to create a new sprite
  89984. * @param parsedSprite The JSON object to parse
  89985. * @param manager defines the hosting manager
  89986. * @returns the new sprite
  89987. */
  89988. static Parse(parsedSprite: any, manager: SpriteManager): Sprite;
  89989. }
  89990. }
  89991. declare module BABYLON {
  89992. /**
  89993. * Information about the result of picking within a scene
  89994. * @see https://doc.babylonjs.com/babylon101/picking_collisions
  89995. */
  89996. export class PickingInfo {
  89997. /** @hidden */
  89998. _pickingUnavailable: boolean;
  89999. /**
  90000. * If the pick collided with an object
  90001. */
  90002. hit: boolean;
  90003. /**
  90004. * Distance away where the pick collided
  90005. */
  90006. distance: number;
  90007. /**
  90008. * The location of pick collision
  90009. */
  90010. pickedPoint: Nullable<Vector3>;
  90011. /**
  90012. * The mesh corresponding the the pick collision
  90013. */
  90014. pickedMesh: Nullable<AbstractMesh>;
  90015. /** (See getTextureCoordinates) The barycentric U coordinate that is used when calculating the texture coordinates of the collision.*/
  90016. bu: number;
  90017. /** (See getTextureCoordinates) The barycentric V coordinate that is used when calculating the texture coordinates of the collision.*/
  90018. bv: number;
  90019. /** The index of the face on the mesh that was picked, or the index of the Line if the picked Mesh is a LinesMesh */
  90020. faceId: number;
  90021. /** The index of the face on the subMesh that was picked, or the index of the Line if the picked Mesh is a LinesMesh */
  90022. subMeshFaceId: number;
  90023. /** Id of the the submesh that was picked */
  90024. subMeshId: number;
  90025. /** If a sprite was picked, this will be the sprite the pick collided with */
  90026. pickedSprite: Nullable<Sprite>;
  90027. /** If we are pikcing a mesh with thin instance, this will give you the picked thin instance */
  90028. thinInstanceIndex: number;
  90029. /**
  90030. * If a mesh was used to do the picking (eg. 6dof controller) this will be populated.
  90031. */
  90032. originMesh: Nullable<AbstractMesh>;
  90033. /**
  90034. * The ray that was used to perform the picking.
  90035. */
  90036. ray: Nullable<Ray>;
  90037. /**
  90038. * Gets the normal correspodning to the face the pick collided with
  90039. * @param useWorldCoordinates If the resulting normal should be relative to the world (default: false)
  90040. * @param useVerticesNormals If the vertices normals should be used to calculate the normal instead of the normal map
  90041. * @returns The normal correspodning to the face the pick collided with
  90042. */
  90043. getNormal(useWorldCoordinates?: boolean, useVerticesNormals?: boolean): Nullable<Vector3>;
  90044. /**
  90045. * Gets the texture coordinates of where the pick occured
  90046. * @returns the vector containing the coordnates of the texture
  90047. */
  90048. getTextureCoordinates(): Nullable<Vector2>;
  90049. }
  90050. }
  90051. declare module BABYLON {
  90052. /**
  90053. * Class representing a ray with position and direction
  90054. */
  90055. export class Ray {
  90056. /** origin point */
  90057. origin: Vector3;
  90058. /** direction */
  90059. direction: Vector3;
  90060. /** length of the ray */
  90061. length: number;
  90062. private static readonly _TmpVector3;
  90063. private _tmpRay;
  90064. /**
  90065. * Creates a new ray
  90066. * @param origin origin point
  90067. * @param direction direction
  90068. * @param length length of the ray
  90069. */
  90070. constructor(
  90071. /** origin point */
  90072. origin: Vector3,
  90073. /** direction */
  90074. direction: Vector3,
  90075. /** length of the ray */
  90076. length?: number);
  90077. /**
  90078. * Checks if the ray intersects a box
  90079. * This does not account for the ray lenght by design to improve perfs.
  90080. * @param minimum bound of the box
  90081. * @param maximum bound of the box
  90082. * @param intersectionTreshold extra extend to be added to the box in all direction
  90083. * @returns if the box was hit
  90084. */
  90085. intersectsBoxMinMax(minimum: DeepImmutable<Vector3>, maximum: DeepImmutable<Vector3>, intersectionTreshold?: number): boolean;
  90086. /**
  90087. * Checks if the ray intersects a box
  90088. * This does not account for the ray lenght by design to improve perfs.
  90089. * @param box the bounding box to check
  90090. * @param intersectionTreshold extra extend to be added to the BoundingBox in all direction
  90091. * @returns if the box was hit
  90092. */
  90093. intersectsBox(box: DeepImmutable<BoundingBox>, intersectionTreshold?: number): boolean;
  90094. /**
  90095. * If the ray hits a sphere
  90096. * @param sphere the bounding sphere to check
  90097. * @param intersectionTreshold extra extend to be added to the BoundingSphere in all direction
  90098. * @returns true if it hits the sphere
  90099. */
  90100. intersectsSphere(sphere: DeepImmutable<BoundingSphere>, intersectionTreshold?: number): boolean;
  90101. /**
  90102. * If the ray hits a triange
  90103. * @param vertex0 triangle vertex
  90104. * @param vertex1 triangle vertex
  90105. * @param vertex2 triangle vertex
  90106. * @returns intersection information if hit
  90107. */
  90108. intersectsTriangle(vertex0: DeepImmutable<Vector3>, vertex1: DeepImmutable<Vector3>, vertex2: DeepImmutable<Vector3>): Nullable<IntersectionInfo>;
  90109. /**
  90110. * Checks if ray intersects a plane
  90111. * @param plane the plane to check
  90112. * @returns the distance away it was hit
  90113. */
  90114. intersectsPlane(plane: DeepImmutable<Plane>): Nullable<number>;
  90115. /**
  90116. * Calculate the intercept of a ray on a given axis
  90117. * @param axis to check 'x' | 'y' | 'z'
  90118. * @param offset from axis interception (i.e. an offset of 1y is intercepted above ground)
  90119. * @returns a vector containing the coordinates where 'axis' is equal to zero (else offset), or null if there is no intercept.
  90120. */
  90121. intersectsAxis(axis: string, offset?: number): Nullable<Vector3>;
  90122. /**
  90123. * Checks if ray intersects a mesh
  90124. * @param mesh the mesh to check
  90125. * @param fastCheck defines if the first intersection will be used (and not the closest)
  90126. * @returns picking info of the intersecton
  90127. */
  90128. intersectsMesh(mesh: DeepImmutable<AbstractMesh>, fastCheck?: boolean): PickingInfo;
  90129. /**
  90130. * Checks if ray intersects a mesh
  90131. * @param meshes the meshes to check
  90132. * @param fastCheck defines if the first intersection will be used (and not the closest)
  90133. * @param results array to store result in
  90134. * @returns Array of picking infos
  90135. */
  90136. intersectsMeshes(meshes: Array<DeepImmutable<AbstractMesh>>, fastCheck?: boolean, results?: Array<PickingInfo>): Array<PickingInfo>;
  90137. private _comparePickingInfo;
  90138. private static smallnum;
  90139. private static rayl;
  90140. /**
  90141. * Intersection test between the ray and a given segment whithin a given tolerance (threshold)
  90142. * @param sega the first point of the segment to test the intersection against
  90143. * @param segb the second point of the segment to test the intersection against
  90144. * @param threshold the tolerance margin, if the ray doesn't intersect the segment but is close to the given threshold, the intersection is successful
  90145. * @return the distance from the ray origin to the intersection point if there's intersection, or -1 if there's no intersection
  90146. */
  90147. intersectionSegment(sega: DeepImmutable<Vector3>, segb: DeepImmutable<Vector3>, threshold: number): number;
  90148. /**
  90149. * Update the ray from viewport position
  90150. * @param x position
  90151. * @param y y position
  90152. * @param viewportWidth viewport width
  90153. * @param viewportHeight viewport height
  90154. * @param world world matrix
  90155. * @param view view matrix
  90156. * @param projection projection matrix
  90157. * @returns this ray updated
  90158. */
  90159. update(x: number, y: number, viewportWidth: number, viewportHeight: number, world: DeepImmutable<Matrix>, view: DeepImmutable<Matrix>, projection: DeepImmutable<Matrix>): Ray;
  90160. /**
  90161. * Creates a ray with origin and direction of 0,0,0
  90162. * @returns the new ray
  90163. */
  90164. static Zero(): Ray;
  90165. /**
  90166. * Creates a new ray from screen space and viewport
  90167. * @param x position
  90168. * @param y y position
  90169. * @param viewportWidth viewport width
  90170. * @param viewportHeight viewport height
  90171. * @param world world matrix
  90172. * @param view view matrix
  90173. * @param projection projection matrix
  90174. * @returns new ray
  90175. */
  90176. static CreateNew(x: number, y: number, viewportWidth: number, viewportHeight: number, world: DeepImmutable<Matrix>, view: DeepImmutable<Matrix>, projection: DeepImmutable<Matrix>): Ray;
  90177. /**
  90178. * 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
  90179. * transformed to the given world matrix.
  90180. * @param origin The origin point
  90181. * @param end The end point
  90182. * @param world a matrix to transform the ray to. Default is the identity matrix.
  90183. * @returns the new ray
  90184. */
  90185. static CreateNewFromTo(origin: Vector3, end: Vector3, world?: DeepImmutable<Matrix>): Ray;
  90186. /**
  90187. * Transforms a ray by a matrix
  90188. * @param ray ray to transform
  90189. * @param matrix matrix to apply
  90190. * @returns the resulting new ray
  90191. */
  90192. static Transform(ray: DeepImmutable<Ray>, matrix: DeepImmutable<Matrix>): Ray;
  90193. /**
  90194. * Transforms a ray by a matrix
  90195. * @param ray ray to transform
  90196. * @param matrix matrix to apply
  90197. * @param result ray to store result in
  90198. */
  90199. static TransformToRef(ray: DeepImmutable<Ray>, matrix: DeepImmutable<Matrix>, result: Ray): void;
  90200. /**
  90201. * Unproject a ray from screen space to object space
  90202. * @param sourceX defines the screen space x coordinate to use
  90203. * @param sourceY defines the screen space y coordinate to use
  90204. * @param viewportWidth defines the current width of the viewport
  90205. * @param viewportHeight defines the current height of the viewport
  90206. * @param world defines the world matrix to use (can be set to Identity to go to world space)
  90207. * @param view defines the view matrix to use
  90208. * @param projection defines the projection matrix to use
  90209. */
  90210. unprojectRayToRef(sourceX: float, sourceY: float, viewportWidth: number, viewportHeight: number, world: DeepImmutable<Matrix>, view: DeepImmutable<Matrix>, projection: DeepImmutable<Matrix>): void;
  90211. }
  90212. /**
  90213. * Type used to define predicate used to select faces when a mesh intersection is detected
  90214. */
  90215. export type TrianglePickingPredicate = (p0: Vector3, p1: Vector3, p2: Vector3, ray: Ray) => boolean;
  90216. interface Scene {
  90217. /** @hidden */
  90218. _tempPickingRay: Nullable<Ray>;
  90219. /** @hidden */
  90220. _cachedRayForTransform: Ray;
  90221. /** @hidden */
  90222. _pickWithRayInverseMatrix: Matrix;
  90223. /** @hidden */
  90224. _internalPick(rayFunction: (world: Matrix) => Ray, predicate?: (mesh: AbstractMesh) => boolean, fastCheck?: boolean, onlyBoundingInfo?: boolean, trianglePredicate?: TrianglePickingPredicate): Nullable<PickingInfo>;
  90225. /** @hidden */
  90226. _internalMultiPick(rayFunction: (world: Matrix) => Ray, predicate?: (mesh: AbstractMesh) => boolean, trianglePredicate?: TrianglePickingPredicate): Nullable<PickingInfo[]>;
  90227. /** @hidden */
  90228. _internalPickForMesh(pickingInfo: Nullable<PickingInfo>, rayFunction: (world: Matrix) => Ray, mesh: AbstractMesh, world: Matrix, fastCheck?: boolean, onlyBoundingInfo?: boolean, trianglePredicate?: TrianglePickingPredicate): Nullable<PickingInfo>;
  90229. }
  90230. }
  90231. declare module BABYLON {
  90232. /**
  90233. * Groups all the scene component constants in one place to ease maintenance.
  90234. * @hidden
  90235. */
  90236. export class SceneComponentConstants {
  90237. static readonly NAME_EFFECTLAYER: string;
  90238. static readonly NAME_LAYER: string;
  90239. static readonly NAME_LENSFLARESYSTEM: string;
  90240. static readonly NAME_BOUNDINGBOXRENDERER: string;
  90241. static readonly NAME_PARTICLESYSTEM: string;
  90242. static readonly NAME_GAMEPAD: string;
  90243. static readonly NAME_SIMPLIFICATIONQUEUE: string;
  90244. static readonly NAME_GEOMETRYBUFFERRENDERER: string;
  90245. static readonly NAME_PREPASSRENDERER: string;
  90246. static readonly NAME_DEPTHRENDERER: string;
  90247. static readonly NAME_POSTPROCESSRENDERPIPELINEMANAGER: string;
  90248. static readonly NAME_SPRITE: string;
  90249. static readonly NAME_OUTLINERENDERER: string;
  90250. static readonly NAME_PROCEDURALTEXTURE: string;
  90251. static readonly NAME_SHADOWGENERATOR: string;
  90252. static readonly NAME_OCTREE: string;
  90253. static readonly NAME_PHYSICSENGINE: string;
  90254. static readonly NAME_AUDIO: string;
  90255. static readonly STEP_ISREADYFORMESH_EFFECTLAYER: number;
  90256. static readonly STEP_BEFOREEVALUATEACTIVEMESH_BOUNDINGBOXRENDERER: number;
  90257. static readonly STEP_EVALUATESUBMESH_BOUNDINGBOXRENDERER: number;
  90258. static readonly STEP_ACTIVEMESH_BOUNDINGBOXRENDERER: number;
  90259. static readonly STEP_CAMERADRAWRENDERTARGET_EFFECTLAYER: number;
  90260. static readonly STEP_BEFORECAMERADRAW_EFFECTLAYER: number;
  90261. static readonly STEP_BEFORECAMERADRAW_LAYER: number;
  90262. static readonly STEP_BEFORECAMERADRAW_PREPASS: number;
  90263. static readonly STEP_BEFORERENDERTARGETDRAW_LAYER: number;
  90264. static readonly STEP_BEFORERENDERINGMESH_OUTLINE: number;
  90265. static readonly STEP_AFTERRENDERINGMESH_OUTLINE: number;
  90266. static readonly STEP_AFTERRENDERINGGROUPDRAW_EFFECTLAYER_DRAW: number;
  90267. static readonly STEP_AFTERRENDERINGGROUPDRAW_BOUNDINGBOXRENDERER: number;
  90268. static readonly STEP_BEFORECAMERAUPDATE_SIMPLIFICATIONQUEUE: number;
  90269. static readonly STEP_BEFORECAMERAUPDATE_GAMEPAD: number;
  90270. static readonly STEP_BEFORECLEAR_PROCEDURALTEXTURE: number;
  90271. static readonly STEP_AFTERRENDERTARGETDRAW_LAYER: number;
  90272. static readonly STEP_AFTERCAMERADRAW_EFFECTLAYER: number;
  90273. static readonly STEP_AFTERCAMERADRAW_LENSFLARESYSTEM: number;
  90274. static readonly STEP_AFTERCAMERADRAW_EFFECTLAYER_DRAW: number;
  90275. static readonly STEP_AFTERCAMERADRAW_LAYER: number;
  90276. static readonly STEP_AFTERCAMERADRAW_PREPASS: number;
  90277. static readonly STEP_AFTERRENDER_AUDIO: number;
  90278. static readonly STEP_GATHERRENDERTARGETS_DEPTHRENDERER: number;
  90279. static readonly STEP_GATHERRENDERTARGETS_GEOMETRYBUFFERRENDERER: number;
  90280. static readonly STEP_GATHERRENDERTARGETS_SHADOWGENERATOR: number;
  90281. static readonly STEP_GATHERRENDERTARGETS_POSTPROCESSRENDERPIPELINEMANAGER: number;
  90282. static readonly STEP_GATHERACTIVECAMERARENDERTARGETS_DEPTHRENDERER: number;
  90283. static readonly STEP_BEFORECLEARSTAGE_PREPASS: number;
  90284. static readonly STEP_POINTERMOVE_SPRITE: number;
  90285. static readonly STEP_POINTERDOWN_SPRITE: number;
  90286. static readonly STEP_POINTERUP_SPRITE: number;
  90287. }
  90288. /**
  90289. * This represents a scene component.
  90290. *
  90291. * This is used to decouple the dependency the scene is having on the different workloads like
  90292. * layers, post processes...
  90293. */
  90294. export interface ISceneComponent {
  90295. /**
  90296. * The name of the component. Each component must have a unique name.
  90297. */
  90298. name: string;
  90299. /**
  90300. * The scene the component belongs to.
  90301. */
  90302. scene: Scene;
  90303. /**
  90304. * Register the component to one instance of a scene.
  90305. */
  90306. register(): void;
  90307. /**
  90308. * Rebuilds the elements related to this component in case of
  90309. * context lost for instance.
  90310. */
  90311. rebuild(): void;
  90312. /**
  90313. * Disposes the component and the associated ressources.
  90314. */
  90315. dispose(): void;
  90316. }
  90317. /**
  90318. * This represents a SERIALIZABLE scene component.
  90319. *
  90320. * This extends Scene Component to add Serialization methods on top.
  90321. */
  90322. export interface ISceneSerializableComponent extends ISceneComponent {
  90323. /**
  90324. * Adds all the elements from the container to the scene
  90325. * @param container the container holding the elements
  90326. */
  90327. addFromContainer(container: AbstractScene): void;
  90328. /**
  90329. * Removes all the elements in the container from the scene
  90330. * @param container contains the elements to remove
  90331. * @param dispose if the removed element should be disposed (default: false)
  90332. */
  90333. removeFromContainer(container: AbstractScene, dispose?: boolean): void;
  90334. /**
  90335. * Serializes the component data to the specified json object
  90336. * @param serializationObject The object to serialize to
  90337. */
  90338. serialize(serializationObject: any): void;
  90339. }
  90340. /**
  90341. * Strong typing of a Mesh related stage step action
  90342. */
  90343. export type MeshStageAction = (mesh: AbstractMesh, hardwareInstancedRendering: boolean) => boolean;
  90344. /**
  90345. * Strong typing of a Evaluate Sub Mesh related stage step action
  90346. */
  90347. export type EvaluateSubMeshStageAction = (mesh: AbstractMesh, subMesh: SubMesh) => void;
  90348. /**
  90349. * Strong typing of a Active Mesh related stage step action
  90350. */
  90351. export type ActiveMeshStageAction = (sourceMesh: AbstractMesh, mesh: AbstractMesh) => void;
  90352. /**
  90353. * Strong typing of a Camera related stage step action
  90354. */
  90355. export type CameraStageAction = (camera: Camera) => void;
  90356. /**
  90357. * Strong typing of a Camera Frame buffer related stage step action
  90358. */
  90359. export type CameraStageFrameBufferAction = (camera: Camera) => boolean;
  90360. /**
  90361. * Strong typing of a Render Target related stage step action
  90362. */
  90363. export type RenderTargetStageAction = (renderTarget: RenderTargetTexture) => void;
  90364. /**
  90365. * Strong typing of a RenderingGroup related stage step action
  90366. */
  90367. export type RenderingGroupStageAction = (renderingGroupId: number) => void;
  90368. /**
  90369. * Strong typing of a Mesh Render related stage step action
  90370. */
  90371. export type RenderingMeshStageAction = (mesh: Mesh, subMesh: SubMesh, batch: _InstancesBatch) => void;
  90372. /**
  90373. * Strong typing of a simple stage step action
  90374. */
  90375. export type SimpleStageAction = () => void;
  90376. /**
  90377. * Strong typing of a render target action.
  90378. */
  90379. export type RenderTargetsStageAction = (renderTargets: SmartArrayNoDuplicate<RenderTargetTexture>) => void;
  90380. /**
  90381. * Strong typing of a pointer move action.
  90382. */
  90383. export type PointerMoveStageAction = (unTranslatedPointerX: number, unTranslatedPointerY: number, pickResult: Nullable<PickingInfo>, isMeshPicked: boolean, element: HTMLElement) => Nullable<PickingInfo>;
  90384. /**
  90385. * Strong typing of a pointer up/down action.
  90386. */
  90387. export type PointerUpDownStageAction = (unTranslatedPointerX: number, unTranslatedPointerY: number, pickResult: Nullable<PickingInfo>, evt: PointerEvent) => Nullable<PickingInfo>;
  90388. /**
  90389. * Representation of a stage in the scene (Basically a list of ordered steps)
  90390. * @hidden
  90391. */
  90392. export class Stage<T extends Function> extends Array<{
  90393. index: number;
  90394. component: ISceneComponent;
  90395. action: T;
  90396. }> {
  90397. /**
  90398. * Hide ctor from the rest of the world.
  90399. * @param items The items to add.
  90400. */
  90401. private constructor();
  90402. /**
  90403. * Creates a new Stage.
  90404. * @returns A new instance of a Stage
  90405. */
  90406. static Create<T extends Function>(): Stage<T>;
  90407. /**
  90408. * Registers a step in an ordered way in the targeted stage.
  90409. * @param index Defines the position to register the step in
  90410. * @param component Defines the component attached to the step
  90411. * @param action Defines the action to launch during the step
  90412. */
  90413. registerStep(index: number, component: ISceneComponent, action: T): void;
  90414. /**
  90415. * Clears all the steps from the stage.
  90416. */
  90417. clear(): void;
  90418. }
  90419. }
  90420. declare module BABYLON {
  90421. interface Scene {
  90422. /** @hidden */
  90423. _pointerOverSprite: Nullable<Sprite>;
  90424. /** @hidden */
  90425. _pickedDownSprite: Nullable<Sprite>;
  90426. /** @hidden */
  90427. _tempSpritePickingRay: Nullable<Ray>;
  90428. /**
  90429. * All of the sprite managers added to this scene
  90430. * @see https://doc.babylonjs.com/babylon101/sprites
  90431. */
  90432. spriteManagers: Array<ISpriteManager>;
  90433. /**
  90434. * An event triggered when sprites rendering is about to start
  90435. * Note: This event can be trigger more than once per frame (because sprites can be rendered by render target textures as well)
  90436. */
  90437. onBeforeSpritesRenderingObservable: Observable<Scene>;
  90438. /**
  90439. * An event triggered when sprites rendering is done
  90440. * Note: This event can be trigger more than once per frame (because sprites can be rendered by render target textures as well)
  90441. */
  90442. onAfterSpritesRenderingObservable: Observable<Scene>;
  90443. /** @hidden */
  90444. _internalPickSprites(ray: Ray, predicate?: (sprite: Sprite) => boolean, fastCheck?: boolean, camera?: Camera): Nullable<PickingInfo>;
  90445. /** Launch a ray to try to pick a sprite in the scene
  90446. * @param x position on screen
  90447. * @param y position on screen
  90448. * @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
  90449. * @param fastCheck defines if the first intersection will be used (and not the closest)
  90450. * @param camera camera to use for computing the picking ray. Can be set to null. In this case, the scene.activeCamera will be used
  90451. * @returns a PickingInfo
  90452. */
  90453. pickSprite(x: number, y: number, predicate?: (sprite: Sprite) => boolean, fastCheck?: boolean, camera?: Camera): Nullable<PickingInfo>;
  90454. /** Use the given ray to pick a sprite in the scene
  90455. * @param ray The ray (in world space) to use to pick meshes
  90456. * @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
  90457. * @param fastCheck defines if the first intersection will be used (and not the closest)
  90458. * @param camera camera to use. Can be set to null. In this case, the scene.activeCamera will be used
  90459. * @returns a PickingInfo
  90460. */
  90461. pickSpriteWithRay(ray: Ray, predicate?: (sprite: Sprite) => boolean, fastCheck?: boolean, camera?: Camera): Nullable<PickingInfo>;
  90462. /** @hidden */
  90463. _internalMultiPickSprites(ray: Ray, predicate?: (sprite: Sprite) => boolean, camera?: Camera): Nullable<PickingInfo[]>;
  90464. /** Launch a ray to try to pick sprites in the scene
  90465. * @param x position on screen
  90466. * @param y position on screen
  90467. * @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
  90468. * @param camera camera to use for computing the picking ray. Can be set to null. In this case, the scene.activeCamera will be used
  90469. * @returns a PickingInfo array
  90470. */
  90471. multiPickSprite(x: number, y: number, predicate?: (sprite: Sprite) => boolean, camera?: Camera): Nullable<PickingInfo[]>;
  90472. /** Use the given ray to pick sprites in the scene
  90473. * @param ray The ray (in world space) to use to pick meshes
  90474. * @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
  90475. * @param camera camera to use. Can be set to null. In this case, the scene.activeCamera will be used
  90476. * @returns a PickingInfo array
  90477. */
  90478. multiPickSpriteWithRay(ray: Ray, predicate?: (sprite: Sprite) => boolean, camera?: Camera): Nullable<PickingInfo[]>;
  90479. /**
  90480. * Force the sprite under the pointer
  90481. * @param sprite defines the sprite to use
  90482. */
  90483. setPointerOverSprite(sprite: Nullable<Sprite>): void;
  90484. /**
  90485. * Gets the sprite under the pointer
  90486. * @returns a Sprite or null if no sprite is under the pointer
  90487. */
  90488. getPointerOverSprite(): Nullable<Sprite>;
  90489. }
  90490. /**
  90491. * Defines the sprite scene component responsible to manage sprites
  90492. * in a given scene.
  90493. */
  90494. export class SpriteSceneComponent implements ISceneComponent {
  90495. /**
  90496. * The component name helpfull to identify the component in the list of scene components.
  90497. */
  90498. readonly name: string;
  90499. /**
  90500. * The scene the component belongs to.
  90501. */
  90502. scene: Scene;
  90503. /** @hidden */
  90504. private _spritePredicate;
  90505. /**
  90506. * Creates a new instance of the component for the given scene
  90507. * @param scene Defines the scene to register the component in
  90508. */
  90509. constructor(scene: Scene);
  90510. /**
  90511. * Registers the component in a given scene
  90512. */
  90513. register(): void;
  90514. /**
  90515. * Rebuilds the elements related to this component in case of
  90516. * context lost for instance.
  90517. */
  90518. rebuild(): void;
  90519. /**
  90520. * Disposes the component and the associated ressources.
  90521. */
  90522. dispose(): void;
  90523. private _pickSpriteButKeepRay;
  90524. private _pointerMove;
  90525. private _pointerDown;
  90526. private _pointerUp;
  90527. }
  90528. }
  90529. declare module BABYLON {
  90530. /** @hidden */
  90531. export var fogFragmentDeclaration: {
  90532. name: string;
  90533. shader: string;
  90534. };
  90535. }
  90536. declare module BABYLON {
  90537. /** @hidden */
  90538. export var fogFragment: {
  90539. name: string;
  90540. shader: string;
  90541. };
  90542. }
  90543. declare module BABYLON {
  90544. /** @hidden */
  90545. export var spritesPixelShader: {
  90546. name: string;
  90547. shader: string;
  90548. };
  90549. }
  90550. declare module BABYLON {
  90551. /** @hidden */
  90552. export var fogVertexDeclaration: {
  90553. name: string;
  90554. shader: string;
  90555. };
  90556. }
  90557. declare module BABYLON {
  90558. /** @hidden */
  90559. export var spritesVertexShader: {
  90560. name: string;
  90561. shader: string;
  90562. };
  90563. }
  90564. declare module BABYLON {
  90565. /**
  90566. * Defines the minimum interface to fullfil in order to be a sprite manager.
  90567. */
  90568. export interface ISpriteManager extends IDisposable {
  90569. /**
  90570. * Gets manager's name
  90571. */
  90572. name: string;
  90573. /**
  90574. * Restricts the camera to viewing objects with the same layerMask.
  90575. * A camera with a layerMask of 1 will render spriteManager.layerMask & camera.layerMask!== 0
  90576. */
  90577. layerMask: number;
  90578. /**
  90579. * Gets or sets a boolean indicating if the mesh can be picked (by scene.pick for instance or through actions). Default is true
  90580. */
  90581. isPickable: boolean;
  90582. /**
  90583. * Gets the hosting scene
  90584. */
  90585. scene: Scene;
  90586. /**
  90587. * Specifies the rendering group id for this mesh (0 by default)
  90588. * @see https://doc.babylonjs.com/resources/transparency_and_how_meshes_are_rendered#rendering-groups
  90589. */
  90590. renderingGroupId: number;
  90591. /**
  90592. * Defines the list of sprites managed by the manager.
  90593. */
  90594. sprites: Array<Sprite>;
  90595. /**
  90596. * Gets or sets the spritesheet texture
  90597. */
  90598. texture: Texture;
  90599. /** Defines the default width of a cell in the spritesheet */
  90600. cellWidth: number;
  90601. /** Defines the default height of a cell in the spritesheet */
  90602. cellHeight: number;
  90603. /**
  90604. * Tests the intersection of a sprite with a specific ray.
  90605. * @param ray The ray we are sending to test the collision
  90606. * @param camera The camera space we are sending rays in
  90607. * @param predicate A predicate allowing excluding sprites from the list of object to test
  90608. * @param fastCheck defines if the first intersection will be used (and not the closest)
  90609. * @returns picking info or null.
  90610. */
  90611. intersects(ray: Ray, camera: Camera, predicate?: (sprite: Sprite) => boolean, fastCheck?: boolean): Nullable<PickingInfo>;
  90612. /**
  90613. * Intersects the sprites with a ray
  90614. * @param ray defines the ray to intersect with
  90615. * @param camera defines the current active camera
  90616. * @param predicate defines a predicate used to select candidate sprites
  90617. * @returns null if no hit or a PickingInfo array
  90618. */
  90619. multiIntersects(ray: Ray, camera: Camera, predicate?: (sprite: Sprite) => boolean): Nullable<PickingInfo[]>;
  90620. /**
  90621. * Renders the list of sprites on screen.
  90622. */
  90623. render(): void;
  90624. }
  90625. /**
  90626. * Class used to manage multiple sprites on the same spritesheet
  90627. * @see https://doc.babylonjs.com/babylon101/sprites
  90628. */
  90629. export class SpriteManager implements ISpriteManager {
  90630. /** defines the manager's name */
  90631. name: string;
  90632. /** Define the Url to load snippets */
  90633. static SnippetUrl: string;
  90634. /** Snippet ID if the manager was created from the snippet server */
  90635. snippetId: string;
  90636. /** Gets the list of sprites */
  90637. sprites: Sprite[];
  90638. /** Gets or sets the rendering group id (0 by default) */
  90639. renderingGroupId: number;
  90640. /** Gets or sets camera layer mask */
  90641. layerMask: number;
  90642. /** Gets or sets a boolean indicating if the manager must consider scene fog when rendering */
  90643. fogEnabled: boolean;
  90644. /** Gets or sets a boolean indicating if the sprites are pickable */
  90645. isPickable: boolean;
  90646. /** Defines the default width of a cell in the spritesheet */
  90647. cellWidth: number;
  90648. /** Defines the default height of a cell in the spritesheet */
  90649. cellHeight: number;
  90650. /** Associative array from JSON sprite data file */
  90651. private _cellData;
  90652. /** Array of sprite names from JSON sprite data file */
  90653. private _spriteMap;
  90654. /** True when packed cell data from JSON file is ready*/
  90655. private _packedAndReady;
  90656. private _textureContent;
  90657. private _useInstancing;
  90658. /**
  90659. * An event triggered when the manager is disposed.
  90660. */
  90661. onDisposeObservable: Observable<SpriteManager>;
  90662. private _onDisposeObserver;
  90663. /**
  90664. * Callback called when the manager is disposed
  90665. */
  90666. set onDispose(callback: () => void);
  90667. private _capacity;
  90668. private _fromPacked;
  90669. private _spriteTexture;
  90670. private _epsilon;
  90671. private _scene;
  90672. private _vertexData;
  90673. private _buffer;
  90674. private _vertexBuffers;
  90675. private _spriteBuffer;
  90676. private _indexBuffer;
  90677. private _effectBase;
  90678. private _effectFog;
  90679. private _vertexBufferSize;
  90680. /**
  90681. * Gets or sets the unique id of the sprite
  90682. */
  90683. uniqueId: number;
  90684. /**
  90685. * Gets the array of sprites
  90686. */
  90687. get children(): Sprite[];
  90688. /**
  90689. * Gets the hosting scene
  90690. */
  90691. get scene(): Scene;
  90692. /**
  90693. * Gets the capacity of the manager
  90694. */
  90695. get capacity(): number;
  90696. /**
  90697. * Gets or sets the spritesheet texture
  90698. */
  90699. get texture(): Texture;
  90700. set texture(value: Texture);
  90701. private _blendMode;
  90702. /**
  90703. * Blend mode use to render the particle, it can be any of
  90704. * the static Constants.ALPHA_x properties provided in this class.
  90705. * Default value is Constants.ALPHA_COMBINE
  90706. */
  90707. get blendMode(): number;
  90708. set blendMode(blendMode: number);
  90709. /** Disables writing to the depth buffer when rendering the sprites.
  90710. * It can be handy to disable depth writing when using textures without alpha channel
  90711. * and setting some specific blend modes.
  90712. */
  90713. disableDepthWrite: boolean;
  90714. /**
  90715. * Creates a new sprite manager
  90716. * @param name defines the manager's name
  90717. * @param imgUrl defines the sprite sheet url
  90718. * @param capacity defines the maximum allowed number of sprites
  90719. * @param cellSize defines the size of a sprite cell
  90720. * @param scene defines the hosting scene
  90721. * @param epsilon defines the epsilon value to align texture (0.01 by default)
  90722. * @param samplingMode defines the smapling mode to use with spritesheet
  90723. * @param fromPacked set to false; do not alter
  90724. * @param spriteJSON null otherwise a JSON object defining sprite sheet data; do not alter
  90725. */
  90726. constructor(
  90727. /** defines the manager's name */
  90728. name: string, imgUrl: string, capacity: number, cellSize: any, scene: Scene, epsilon?: number, samplingMode?: number, fromPacked?: boolean, spriteJSON?: any | null);
  90729. /**
  90730. * Returns the string "SpriteManager"
  90731. * @returns "SpriteManager"
  90732. */
  90733. getClassName(): string;
  90734. private _makePacked;
  90735. private _appendSpriteVertex;
  90736. private _checkTextureAlpha;
  90737. /**
  90738. * Intersects the sprites with a ray
  90739. * @param ray defines the ray to intersect with
  90740. * @param camera defines the current active camera
  90741. * @param predicate defines a predicate used to select candidate sprites
  90742. * @param fastCheck defines if a fast check only must be done (the first potential sprite is will be used and not the closer)
  90743. * @returns null if no hit or a PickingInfo
  90744. */
  90745. intersects(ray: Ray, camera: Camera, predicate?: (sprite: Sprite) => boolean, fastCheck?: boolean): Nullable<PickingInfo>;
  90746. /**
  90747. * Intersects the sprites with a ray
  90748. * @param ray defines the ray to intersect with
  90749. * @param camera defines the current active camera
  90750. * @param predicate defines a predicate used to select candidate sprites
  90751. * @returns null if no hit or a PickingInfo array
  90752. */
  90753. multiIntersects(ray: Ray, camera: Camera, predicate?: (sprite: Sprite) => boolean): Nullable<PickingInfo[]>;
  90754. /**
  90755. * Render all child sprites
  90756. */
  90757. render(): void;
  90758. /**
  90759. * Release associated resources
  90760. */
  90761. dispose(): void;
  90762. /**
  90763. * Serializes the sprite manager to a JSON object
  90764. * @param serializeTexture defines if the texture must be serialized as well
  90765. * @returns the JSON object
  90766. */
  90767. serialize(serializeTexture?: boolean): any;
  90768. /**
  90769. * Parses a JSON object to create a new sprite manager.
  90770. * @param parsedManager The JSON object to parse
  90771. * @param scene The scene to create the sprite managerin
  90772. * @param rootUrl The root url to use to load external dependencies like texture
  90773. * @returns the new sprite manager
  90774. */
  90775. static Parse(parsedManager: any, scene: Scene, rootUrl: string): SpriteManager;
  90776. /**
  90777. * Creates a sprite manager from a snippet saved in a remote file
  90778. * @param name defines the name of the sprite manager to create (can be null or empty to use the one from the json data)
  90779. * @param url defines the url to load from
  90780. * @param scene defines the hosting scene
  90781. * @param rootUrl defines the root URL to use to load textures and relative dependencies
  90782. * @returns a promise that will resolve to the new sprite manager
  90783. */
  90784. static ParseFromFileAsync(name: Nullable<string>, url: string, scene: Scene, rootUrl?: string): Promise<SpriteManager>;
  90785. /**
  90786. * Creates a sprite manager from a snippet saved by the sprite editor
  90787. * @param snippetId defines the snippet to load (can be set to _BLANK to create a default one)
  90788. * @param scene defines the hosting scene
  90789. * @param rootUrl defines the root URL to use to load textures and relative dependencies
  90790. * @returns a promise that will resolve to the new sprite manager
  90791. */
  90792. static CreateFromSnippetAsync(snippetId: string, scene: Scene, rootUrl?: string): Promise<SpriteManager>;
  90793. }
  90794. }
  90795. declare module BABYLON {
  90796. /** Interface used by value gradients (color, factor, ...) */
  90797. export interface IValueGradient {
  90798. /**
  90799. * Gets or sets the gradient value (between 0 and 1)
  90800. */
  90801. gradient: number;
  90802. }
  90803. /** Class used to store color4 gradient */
  90804. export class ColorGradient implements IValueGradient {
  90805. /**
  90806. * Gets or sets the gradient value (between 0 and 1)
  90807. */
  90808. gradient: number;
  90809. /**
  90810. * Gets or sets first associated color
  90811. */
  90812. color1: Color4;
  90813. /**
  90814. * Gets or sets second associated color
  90815. */
  90816. color2?: Color4 | undefined;
  90817. /**
  90818. * Creates a new color4 gradient
  90819. * @param gradient gets or sets the gradient value (between 0 and 1)
  90820. * @param color1 gets or sets first associated color
  90821. * @param color2 gets or sets first second color
  90822. */
  90823. constructor(
  90824. /**
  90825. * Gets or sets the gradient value (between 0 and 1)
  90826. */
  90827. gradient: number,
  90828. /**
  90829. * Gets or sets first associated color
  90830. */
  90831. color1: Color4,
  90832. /**
  90833. * Gets or sets second associated color
  90834. */
  90835. color2?: Color4 | undefined);
  90836. /**
  90837. * Will get a color picked randomly between color1 and color2.
  90838. * If color2 is undefined then color1 will be used
  90839. * @param result defines the target Color4 to store the result in
  90840. */
  90841. getColorToRef(result: Color4): void;
  90842. }
  90843. /** Class used to store color 3 gradient */
  90844. export class Color3Gradient implements IValueGradient {
  90845. /**
  90846. * Gets or sets the gradient value (between 0 and 1)
  90847. */
  90848. gradient: number;
  90849. /**
  90850. * Gets or sets the associated color
  90851. */
  90852. color: Color3;
  90853. /**
  90854. * Creates a new color3 gradient
  90855. * @param gradient gets or sets the gradient value (between 0 and 1)
  90856. * @param color gets or sets associated color
  90857. */
  90858. constructor(
  90859. /**
  90860. * Gets or sets the gradient value (between 0 and 1)
  90861. */
  90862. gradient: number,
  90863. /**
  90864. * Gets or sets the associated color
  90865. */
  90866. color: Color3);
  90867. }
  90868. /** Class used to store factor gradient */
  90869. export class FactorGradient implements IValueGradient {
  90870. /**
  90871. * Gets or sets the gradient value (between 0 and 1)
  90872. */
  90873. gradient: number;
  90874. /**
  90875. * Gets or sets first associated factor
  90876. */
  90877. factor1: number;
  90878. /**
  90879. * Gets or sets second associated factor
  90880. */
  90881. factor2?: number | undefined;
  90882. /**
  90883. * Creates a new factor gradient
  90884. * @param gradient gets or sets the gradient value (between 0 and 1)
  90885. * @param factor1 gets or sets first associated factor
  90886. * @param factor2 gets or sets second associated factor
  90887. */
  90888. constructor(
  90889. /**
  90890. * Gets or sets the gradient value (between 0 and 1)
  90891. */
  90892. gradient: number,
  90893. /**
  90894. * Gets or sets first associated factor
  90895. */
  90896. factor1: number,
  90897. /**
  90898. * Gets or sets second associated factor
  90899. */
  90900. factor2?: number | undefined);
  90901. /**
  90902. * Will get a number picked randomly between factor1 and factor2.
  90903. * If factor2 is undefined then factor1 will be used
  90904. * @returns the picked number
  90905. */
  90906. getFactor(): number;
  90907. }
  90908. /**
  90909. * Helper used to simplify some generic gradient tasks
  90910. */
  90911. export class GradientHelper {
  90912. /**
  90913. * Gets the current gradient from an array of IValueGradient
  90914. * @param ratio defines the current ratio to get
  90915. * @param gradients defines the array of IValueGradient
  90916. * @param updateFunc defines the callback function used to get the final value from the selected gradients
  90917. */
  90918. static GetCurrentGradient(ratio: number, gradients: IValueGradient[], updateFunc: (current: IValueGradient, next: IValueGradient, scale: number) => void): void;
  90919. }
  90920. }
  90921. declare module BABYLON {
  90922. interface ThinEngine {
  90923. /**
  90924. * Creates a raw texture
  90925. * @param data defines the data to store in the texture
  90926. * @param width defines the width of the texture
  90927. * @param height defines the height of the texture
  90928. * @param format defines the format of the data
  90929. * @param generateMipMaps defines if the engine should generate the mip levels
  90930. * @param invertY defines if data must be stored with Y axis inverted
  90931. * @param samplingMode defines the required sampling mode (Texture.NEAREST_SAMPLINGMODE by default)
  90932. * @param compression defines the compression used (null by default)
  90933. * @param type defines the type fo the data (Engine.TEXTURETYPE_UNSIGNED_INT by default)
  90934. * @returns the raw texture inside an InternalTexture
  90935. */
  90936. createRawTexture(data: Nullable<ArrayBufferView>, width: number, height: number, format: number, generateMipMaps: boolean, invertY: boolean, samplingMode: number, compression: Nullable<string>, type: number): InternalTexture;
  90937. /**
  90938. * Update a raw texture
  90939. * @param texture defines the texture to update
  90940. * @param data defines the data to store in the texture
  90941. * @param format defines the format of the data
  90942. * @param invertY defines if data must be stored with Y axis inverted
  90943. */
  90944. updateRawTexture(texture: Nullable<InternalTexture>, data: Nullable<ArrayBufferView>, format: number, invertY: boolean): void;
  90945. /**
  90946. * Update a raw texture
  90947. * @param texture defines the texture to update
  90948. * @param data defines the data to store in the texture
  90949. * @param format defines the format of the data
  90950. * @param invertY defines if data must be stored with Y axis inverted
  90951. * @param compression defines the compression used (null by default)
  90952. * @param type defines the type fo the data (Engine.TEXTURETYPE_UNSIGNED_INT by default)
  90953. */
  90954. updateRawTexture(texture: Nullable<InternalTexture>, data: Nullable<ArrayBufferView>, format: number, invertY: boolean, compression: Nullable<string>, type: number): void;
  90955. /**
  90956. * Creates a new raw cube texture
  90957. * @param data defines the array of data to use to create each face
  90958. * @param size defines the size of the textures
  90959. * @param format defines the format of the data
  90960. * @param type defines the type of the data (like Engine.TEXTURETYPE_UNSIGNED_INT)
  90961. * @param generateMipMaps defines if the engine should generate the mip levels
  90962. * @param invertY defines if data must be stored with Y axis inverted
  90963. * @param samplingMode defines the required sampling mode (like Texture.NEAREST_SAMPLINGMODE)
  90964. * @param compression defines the compression used (null by default)
  90965. * @returns the cube texture as an InternalTexture
  90966. */
  90967. createRawCubeTexture(data: Nullable<ArrayBufferView[]>, size: number, format: number, type: number, generateMipMaps: boolean, invertY: boolean, samplingMode: number, compression: Nullable<string>): InternalTexture;
  90968. /**
  90969. * Update a raw cube texture
  90970. * @param texture defines the texture to udpdate
  90971. * @param data defines the data to store
  90972. * @param format defines the data format
  90973. * @param type defines the type fo the data (Engine.TEXTURETYPE_UNSIGNED_INT by default)
  90974. * @param invertY defines if data must be stored with Y axis inverted
  90975. */
  90976. updateRawCubeTexture(texture: InternalTexture, data: ArrayBufferView[], format: number, type: number, invertY: boolean): void;
  90977. /**
  90978. * Update a raw cube texture
  90979. * @param texture defines the texture to udpdate
  90980. * @param data defines the data to store
  90981. * @param format defines the data format
  90982. * @param type defines the type fo the data (Engine.TEXTURETYPE_UNSIGNED_INT by default)
  90983. * @param invertY defines if data must be stored with Y axis inverted
  90984. * @param compression defines the compression used (null by default)
  90985. */
  90986. updateRawCubeTexture(texture: InternalTexture, data: ArrayBufferView[], format: number, type: number, invertY: boolean, compression: Nullable<string>): void;
  90987. /**
  90988. * Update a raw cube texture
  90989. * @param texture defines the texture to udpdate
  90990. * @param data defines the data to store
  90991. * @param format defines the data format
  90992. * @param type defines the type fo the data (Engine.TEXTURETYPE_UNSIGNED_INT by default)
  90993. * @param invertY defines if data must be stored with Y axis inverted
  90994. * @param compression defines the compression used (null by default)
  90995. * @param level defines which level of the texture to update
  90996. */
  90997. updateRawCubeTexture(texture: InternalTexture, data: ArrayBufferView[], format: number, type: number, invertY: boolean, compression: Nullable<string>, level: number): void;
  90998. /**
  90999. * Creates a new raw cube texture from a specified url
  91000. * @param url defines the url where the data is located
  91001. * @param scene defines the current scene
  91002. * @param size defines the size of the textures
  91003. * @param format defines the format of the data
  91004. * @param type defines the type fo the data (like Engine.TEXTURETYPE_UNSIGNED_INT)
  91005. * @param noMipmap defines if the engine should avoid generating the mip levels
  91006. * @param callback defines a callback used to extract texture data from loaded data
  91007. * @param mipmapGenerator defines to provide an optional tool to generate mip levels
  91008. * @param onLoad defines a callback called when texture is loaded
  91009. * @param onError defines a callback called if there is an error
  91010. * @returns the cube texture as an InternalTexture
  91011. */
  91012. 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;
  91013. /**
  91014. * Creates a new raw cube texture from a specified url
  91015. * @param url defines the url where the data is located
  91016. * @param scene defines the current scene
  91017. * @param size defines the size of the textures
  91018. * @param format defines the format of the data
  91019. * @param type defines the type fo the data (like Engine.TEXTURETYPE_UNSIGNED_INT)
  91020. * @param noMipmap defines if the engine should avoid generating the mip levels
  91021. * @param callback defines a callback used to extract texture data from loaded data
  91022. * @param mipmapGenerator defines to provide an optional tool to generate mip levels
  91023. * @param onLoad defines a callback called when texture is loaded
  91024. * @param onError defines a callback called if there is an error
  91025. * @param samplingMode defines the required sampling mode (like Texture.NEAREST_SAMPLINGMODE)
  91026. * @param invertY defines if data must be stored with Y axis inverted
  91027. * @returns the cube texture as an InternalTexture
  91028. */
  91029. 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;
  91030. /**
  91031. * Creates a new raw 3D texture
  91032. * @param data defines the data used to create the texture
  91033. * @param width defines the width of the texture
  91034. * @param height defines the height of the texture
  91035. * @param depth defines the depth of the texture
  91036. * @param format defines the format of the texture
  91037. * @param generateMipMaps defines if the engine must generate mip levels
  91038. * @param invertY defines if data must be stored with Y axis inverted
  91039. * @param samplingMode defines the required sampling mode (like Texture.NEAREST_SAMPLINGMODE)
  91040. * @param compression defines the compressed used (can be null)
  91041. * @param textureType defines the compressed used (can be null)
  91042. * @returns a new raw 3D texture (stored in an InternalTexture)
  91043. */
  91044. createRawTexture3D(data: Nullable<ArrayBufferView>, width: number, height: number, depth: number, format: number, generateMipMaps: boolean, invertY: boolean, samplingMode: number, compression: Nullable<string>, textureType: number): InternalTexture;
  91045. /**
  91046. * Update a raw 3D texture
  91047. * @param texture defines the texture to update
  91048. * @param data defines the data to store
  91049. * @param format defines the data format
  91050. * @param invertY defines if data must be stored with Y axis inverted
  91051. */
  91052. updateRawTexture3D(texture: InternalTexture, data: Nullable<ArrayBufferView>, format: number, invertY: boolean): void;
  91053. /**
  91054. * Update a raw 3D texture
  91055. * @param texture defines the texture to update
  91056. * @param data defines the data to store
  91057. * @param format defines the data format
  91058. * @param invertY defines if data must be stored with Y axis inverted
  91059. * @param compression defines the used compression (can be null)
  91060. * @param textureType defines the texture Type (Engine.TEXTURETYPE_UNSIGNED_INT, Engine.TEXTURETYPE_FLOAT...)
  91061. */
  91062. updateRawTexture3D(texture: InternalTexture, data: Nullable<ArrayBufferView>, format: number, invertY: boolean, compression: Nullable<string>, textureType: number): void;
  91063. /**
  91064. * Creates a new raw 2D array texture
  91065. * @param data defines the data used to create the texture
  91066. * @param width defines the width of the texture
  91067. * @param height defines the height of the texture
  91068. * @param depth defines the number of layers of the texture
  91069. * @param format defines the format of the texture
  91070. * @param generateMipMaps defines if the engine must generate mip levels
  91071. * @param invertY defines if data must be stored with Y axis inverted
  91072. * @param samplingMode defines the required sampling mode (like Texture.NEAREST_SAMPLINGMODE)
  91073. * @param compression defines the compressed used (can be null)
  91074. * @param textureType defines the compressed used (can be null)
  91075. * @returns a new raw 2D array texture (stored in an InternalTexture)
  91076. */
  91077. createRawTexture2DArray(data: Nullable<ArrayBufferView>, width: number, height: number, depth: number, format: number, generateMipMaps: boolean, invertY: boolean, samplingMode: number, compression: Nullable<string>, textureType: number): InternalTexture;
  91078. /**
  91079. * Update a raw 2D array texture
  91080. * @param texture defines the texture to update
  91081. * @param data defines the data to store
  91082. * @param format defines the data format
  91083. * @param invertY defines if data must be stored with Y axis inverted
  91084. */
  91085. updateRawTexture2DArray(texture: InternalTexture, data: Nullable<ArrayBufferView>, format: number, invertY: boolean): void;
  91086. /**
  91087. * Update a raw 2D array texture
  91088. * @param texture defines the texture to update
  91089. * @param data defines the data to store
  91090. * @param format defines the data format
  91091. * @param invertY defines if data must be stored with Y axis inverted
  91092. * @param compression defines the used compression (can be null)
  91093. * @param textureType defines the texture Type (Engine.TEXTURETYPE_UNSIGNED_INT, Engine.TEXTURETYPE_FLOAT...)
  91094. */
  91095. updateRawTexture2DArray(texture: InternalTexture, data: Nullable<ArrayBufferView>, format: number, invertY: boolean, compression: Nullable<string>, textureType: number): void;
  91096. }
  91097. }
  91098. declare module BABYLON {
  91099. /**
  91100. * Raw texture can help creating a texture directly from an array of data.
  91101. * This can be super useful if you either get the data from an uncompressed source or
  91102. * if you wish to create your texture pixel by pixel.
  91103. */
  91104. export class RawTexture extends Texture {
  91105. /**
  91106. * Define the format of the data (RGB, RGBA... Engine.TEXTUREFORMAT_xxx)
  91107. */
  91108. format: number;
  91109. /**
  91110. * Instantiates a new RawTexture.
  91111. * Raw texture can help creating a texture directly from an array of data.
  91112. * This can be super useful if you either get the data from an uncompressed source or
  91113. * if you wish to create your texture pixel by pixel.
  91114. * @param data define the array of data to use to create the texture
  91115. * @param width define the width of the texture
  91116. * @param height define the height of the texture
  91117. * @param format define the format of the data (RGB, RGBA... Engine.TEXTUREFORMAT_xxx)
  91118. * @param sceneOrEngine defines the scene or engine the texture will belong to
  91119. * @param generateMipMaps define whether mip maps should be generated or not
  91120. * @param invertY define if the data should be flipped on Y when uploaded to the GPU
  91121. * @param samplingMode define the texture sampling mode (Texture.xxx_SAMPLINGMODE)
  91122. * @param type define the format of the data (int, float... Engine.TEXTURETYPE_xxx)
  91123. */
  91124. constructor(data: ArrayBufferView, width: number, height: number,
  91125. /**
  91126. * Define the format of the data (RGB, RGBA... Engine.TEXTUREFORMAT_xxx)
  91127. */
  91128. format: number, sceneOrEngine: Nullable<Scene | ThinEngine>, generateMipMaps?: boolean, invertY?: boolean, samplingMode?: number, type?: number);
  91129. /**
  91130. * Updates the texture underlying data.
  91131. * @param data Define the new data of the texture
  91132. */
  91133. update(data: ArrayBufferView): void;
  91134. /**
  91135. * Creates a luminance texture from some data.
  91136. * @param data Define the texture data
  91137. * @param width Define the width of the texture
  91138. * @param height Define the height of the texture
  91139. * @param sceneOrEngine defines the scene or engine the texture will belong to
  91140. * @param generateMipMaps Define whether or not to create mip maps for the texture
  91141. * @param invertY define if the data should be flipped on Y when uploaded to the GPU
  91142. * @param samplingMode define the texture sampling mode (Texture.xxx_SAMPLINGMODE)
  91143. * @returns the luminance texture
  91144. */
  91145. static CreateLuminanceTexture(data: ArrayBufferView, width: number, height: number, sceneOrEngine: Nullable<Scene | ThinEngine>, generateMipMaps?: boolean, invertY?: boolean, samplingMode?: number): RawTexture;
  91146. /**
  91147. * Creates a luminance alpha texture from some data.
  91148. * @param data Define the texture data
  91149. * @param width Define the width of the texture
  91150. * @param height Define the height of the texture
  91151. * @param sceneOrEngine defines the scene or engine the texture will belong to
  91152. * @param generateMipMaps Define whether or not to create mip maps for the texture
  91153. * @param invertY define if the data should be flipped on Y when uploaded to the GPU
  91154. * @param samplingMode define the texture sampling mode (Texture.xxx_SAMPLINGMODE)
  91155. * @returns the luminance alpha texture
  91156. */
  91157. static CreateLuminanceAlphaTexture(data: ArrayBufferView, width: number, height: number, sceneOrEngine: Nullable<Scene | ThinEngine>, generateMipMaps?: boolean, invertY?: boolean, samplingMode?: number): RawTexture;
  91158. /**
  91159. * Creates an alpha texture from some data.
  91160. * @param data Define the texture data
  91161. * @param width Define the width of the texture
  91162. * @param height Define the height of the texture
  91163. * @param sceneOrEngine defines the scene or engine the texture will belong to
  91164. * @param generateMipMaps Define whether or not to create mip maps for the texture
  91165. * @param invertY define if the data should be flipped on Y when uploaded to the GPU
  91166. * @param samplingMode define the texture sampling mode (Texture.xxx_SAMPLINGMODE)
  91167. * @returns the alpha texture
  91168. */
  91169. static CreateAlphaTexture(data: ArrayBufferView, width: number, height: number, sceneOrEngine: Nullable<Scene | ThinEngine>, generateMipMaps?: boolean, invertY?: boolean, samplingMode?: number): RawTexture;
  91170. /**
  91171. * Creates a RGB texture from some data.
  91172. * @param data Define the texture data
  91173. * @param width Define the width of the texture
  91174. * @param height Define the height of the texture
  91175. * @param sceneOrEngine defines the scene or engine the texture will belong to
  91176. * @param generateMipMaps Define whether or not to create mip maps for the texture
  91177. * @param invertY define if the data should be flipped on Y when uploaded to the GPU
  91178. * @param samplingMode define the texture sampling mode (Texture.xxx_SAMPLINGMODE)
  91179. * @param type define the format of the data (int, float... Engine.TEXTURETYPE_xxx)
  91180. * @returns the RGB alpha texture
  91181. */
  91182. static CreateRGBTexture(data: ArrayBufferView, width: number, height: number, sceneOrEngine: Nullable<Scene | ThinEngine>, generateMipMaps?: boolean, invertY?: boolean, samplingMode?: number, type?: number): RawTexture;
  91183. /**
  91184. * Creates a RGBA texture from some data.
  91185. * @param data Define the texture data
  91186. * @param width Define the width of the texture
  91187. * @param height Define the height of the texture
  91188. * @param sceneOrEngine defines the scene or engine the texture will belong to
  91189. * @param generateMipMaps Define whether or not to create mip maps for the texture
  91190. * @param invertY define if the data should be flipped on Y when uploaded to the GPU
  91191. * @param samplingMode define the texture sampling mode (Texture.xxx_SAMPLINGMODE)
  91192. * @param type define the format of the data (int, float... Engine.TEXTURETYPE_xxx)
  91193. * @returns the RGBA texture
  91194. */
  91195. static CreateRGBATexture(data: ArrayBufferView, width: number, height: number, sceneOrEngine: Nullable<Scene | ThinEngine>, generateMipMaps?: boolean, invertY?: boolean, samplingMode?: number, type?: number): RawTexture;
  91196. /**
  91197. * Creates a R texture from some data.
  91198. * @param data Define the texture data
  91199. * @param width Define the width of the texture
  91200. * @param height Define the height of the texture
  91201. * @param sceneOrEngine defines the scene or engine the texture will belong to
  91202. * @param generateMipMaps Define whether or not to create mip maps for the texture
  91203. * @param invertY define if the data should be flipped on Y when uploaded to the GPU
  91204. * @param samplingMode define the texture sampling mode (Texture.xxx_SAMPLINGMODE)
  91205. * @param type define the format of the data (int, float... Engine.TEXTURETYPE_xxx)
  91206. * @returns the R texture
  91207. */
  91208. static CreateRTexture(data: ArrayBufferView, width: number, height: number, sceneOrEngine: Nullable<Scene | ThinEngine>, generateMipMaps?: boolean, invertY?: boolean, samplingMode?: number, type?: number): RawTexture;
  91209. }
  91210. }
  91211. declare module BABYLON {
  91212. interface ThinEngine {
  91213. /**
  91214. * Update a dynamic index buffer
  91215. * @param indexBuffer defines the target index buffer
  91216. * @param indices defines the data to update
  91217. * @param offset defines the offset in the target index buffer where update should start
  91218. */
  91219. updateDynamicIndexBuffer(indexBuffer: DataBuffer, indices: IndicesArray, offset?: number): void;
  91220. /**
  91221. * Updates a dynamic vertex buffer.
  91222. * @param vertexBuffer the vertex buffer to update
  91223. * @param data the data used to update the vertex buffer
  91224. * @param byteOffset the byte offset of the data
  91225. * @param byteLength the byte length of the data
  91226. */
  91227. updateDynamicVertexBuffer(vertexBuffer: DataBuffer, data: DataArray, byteOffset?: number, byteLength?: number): void;
  91228. }
  91229. }
  91230. declare module BABYLON {
  91231. interface AbstractScene {
  91232. /**
  91233. * The list of procedural textures added to the scene
  91234. * @see https://doc.babylonjs.com/how_to/how_to_use_procedural_textures
  91235. */
  91236. proceduralTextures: Array<ProceduralTexture>;
  91237. }
  91238. /**
  91239. * Defines the Procedural Texture scene component responsible to manage any Procedural Texture
  91240. * in a given scene.
  91241. */
  91242. export class ProceduralTextureSceneComponent implements ISceneComponent {
  91243. /**
  91244. * The component name helpfull to identify the component in the list of scene components.
  91245. */
  91246. readonly name: string;
  91247. /**
  91248. * The scene the component belongs to.
  91249. */
  91250. scene: Scene;
  91251. /**
  91252. * Creates a new instance of the component for the given scene
  91253. * @param scene Defines the scene to register the component in
  91254. */
  91255. constructor(scene: Scene);
  91256. /**
  91257. * Registers the component in a given scene
  91258. */
  91259. register(): void;
  91260. /**
  91261. * Rebuilds the elements related to this component in case of
  91262. * context lost for instance.
  91263. */
  91264. rebuild(): void;
  91265. /**
  91266. * Disposes the component and the associated ressources.
  91267. */
  91268. dispose(): void;
  91269. private _beforeClear;
  91270. }
  91271. }
  91272. declare module BABYLON {
  91273. interface ThinEngine {
  91274. /**
  91275. * Creates a new render target cube texture
  91276. * @param size defines the size of the texture
  91277. * @param options defines the options used to create the texture
  91278. * @returns a new render target cube texture stored in an InternalTexture
  91279. */
  91280. createRenderTargetCubeTexture(size: number, options?: Partial<RenderTargetCreationOptions>): InternalTexture;
  91281. }
  91282. }
  91283. declare module BABYLON {
  91284. /** @hidden */
  91285. export var proceduralVertexShader: {
  91286. name: string;
  91287. shader: string;
  91288. };
  91289. }
  91290. declare module BABYLON {
  91291. /**
  91292. * 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.
  91293. * This is the base class of any Procedural texture and contains most of the shareable code.
  91294. * @see https://doc.babylonjs.com/how_to/how_to_use_procedural_textures
  91295. */
  91296. export class ProceduralTexture extends Texture {
  91297. /**
  91298. * Define if the texture is enabled or not (disabled texture will not render)
  91299. */
  91300. isEnabled: boolean;
  91301. /**
  91302. * Define if the texture must be cleared before rendering (default is true)
  91303. */
  91304. autoClear: boolean;
  91305. /**
  91306. * Callback called when the texture is generated
  91307. */
  91308. onGenerated: () => void;
  91309. /**
  91310. * Event raised when the texture is generated
  91311. */
  91312. onGeneratedObservable: Observable<ProceduralTexture>;
  91313. /** @hidden */
  91314. _generateMipMaps: boolean;
  91315. /** @hidden **/
  91316. _effect: Effect;
  91317. /** @hidden */
  91318. _textures: {
  91319. [key: string]: Texture;
  91320. };
  91321. /** @hidden */
  91322. protected _fallbackTexture: Nullable<Texture>;
  91323. private _size;
  91324. private _currentRefreshId;
  91325. private _frameId;
  91326. private _refreshRate;
  91327. private _vertexBuffers;
  91328. private _indexBuffer;
  91329. private _uniforms;
  91330. private _samplers;
  91331. private _fragment;
  91332. private _floats;
  91333. private _ints;
  91334. private _floatsArrays;
  91335. private _colors3;
  91336. private _colors4;
  91337. private _vectors2;
  91338. private _vectors3;
  91339. private _matrices;
  91340. private _fallbackTextureUsed;
  91341. private _fullEngine;
  91342. private _cachedDefines;
  91343. private _contentUpdateId;
  91344. private _contentData;
  91345. /**
  91346. * Instantiates a new procedural texture.
  91347. * 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.
  91348. * This is the base class of any Procedural texture and contains most of the shareable code.
  91349. * @see https://doc.babylonjs.com/how_to/how_to_use_procedural_textures
  91350. * @param name Define the name of the texture
  91351. * @param size Define the size of the texture to create
  91352. * @param fragment Define the fragment shader to use to generate the texture or null if it is defined later
  91353. * @param scene Define the scene the texture belongs to
  91354. * @param fallbackTexture Define a fallback texture in case there were issues to create the custom texture
  91355. * @param generateMipMaps Define if the texture should creates mip maps or not
  91356. * @param isCube Define if the texture is a cube texture or not (this will render each faces of the cube)
  91357. */
  91358. constructor(name: string, size: any, fragment: any, scene: Nullable<Scene>, fallbackTexture?: Nullable<Texture>, generateMipMaps?: boolean, isCube?: boolean);
  91359. /**
  91360. * The effect that is created when initializing the post process.
  91361. * @returns The created effect corresponding the the postprocess.
  91362. */
  91363. getEffect(): Effect;
  91364. /**
  91365. * Gets texture content (Use this function wisely as reading from a texture can be slow)
  91366. * @returns an ArrayBufferView (Uint8Array or Float32Array)
  91367. */
  91368. getContent(): Nullable<ArrayBufferView>;
  91369. private _createIndexBuffer;
  91370. /** @hidden */
  91371. _rebuild(): void;
  91372. /**
  91373. * Resets the texture in order to recreate its associated resources.
  91374. * This can be called in case of context loss
  91375. */
  91376. reset(): void;
  91377. protected _getDefines(): string;
  91378. /**
  91379. * Is the texture ready to be used ? (rendered at least once)
  91380. * @returns true if ready, otherwise, false.
  91381. */
  91382. isReady(): boolean;
  91383. /**
  91384. * Resets the refresh counter of the texture and start bak from scratch.
  91385. * Could be useful to regenerate the texture if it is setup to render only once.
  91386. */
  91387. resetRefreshCounter(): void;
  91388. /**
  91389. * Set the fragment shader to use in order to render the texture.
  91390. * @param fragment This can be set to a path (into the shader store) or to a json object containing a fragmentElement property.
  91391. */
  91392. setFragment(fragment: any): void;
  91393. /**
  91394. * Define the refresh rate of the texture or the rendering frequency.
  91395. * Use 0 to render just once, 1 to render on every frame, 2 to render every two frames and so on...
  91396. */
  91397. get refreshRate(): number;
  91398. set refreshRate(value: number);
  91399. /** @hidden */
  91400. _shouldRender(): boolean;
  91401. /**
  91402. * Get the size the texture is rendering at.
  91403. * @returns the size (texture is always squared)
  91404. */
  91405. getRenderSize(): number;
  91406. /**
  91407. * Resize the texture to new value.
  91408. * @param size Define the new size the texture should have
  91409. * @param generateMipMaps Define whether the new texture should create mip maps
  91410. */
  91411. resize(size: number, generateMipMaps: boolean): void;
  91412. private _checkUniform;
  91413. /**
  91414. * Set a texture in the shader program used to render.
  91415. * @param name Define the name of the uniform samplers as defined in the shader
  91416. * @param texture Define the texture to bind to this sampler
  91417. * @return the texture itself allowing "fluent" like uniform updates
  91418. */
  91419. setTexture(name: string, texture: Texture): ProceduralTexture;
  91420. /**
  91421. * Set a float in the shader.
  91422. * @param name Define the name of the uniform as defined in the shader
  91423. * @param value Define the value to give to the uniform
  91424. * @return the texture itself allowing "fluent" like uniform updates
  91425. */
  91426. setFloat(name: string, value: number): ProceduralTexture;
  91427. /**
  91428. * Set a int in the shader.
  91429. * @param name Define the name of the uniform as defined in the shader
  91430. * @param value Define the value to give to the uniform
  91431. * @return the texture itself allowing "fluent" like uniform updates
  91432. */
  91433. setInt(name: string, value: number): ProceduralTexture;
  91434. /**
  91435. * Set an array of floats in the shader.
  91436. * @param name Define the name of the uniform as defined in the shader
  91437. * @param value Define the value to give to the uniform
  91438. * @return the texture itself allowing "fluent" like uniform updates
  91439. */
  91440. setFloats(name: string, value: number[]): ProceduralTexture;
  91441. /**
  91442. * Set a vec3 in the shader from a Color3.
  91443. * @param name Define the name of the uniform as defined in the shader
  91444. * @param value Define the value to give to the uniform
  91445. * @return the texture itself allowing "fluent" like uniform updates
  91446. */
  91447. setColor3(name: string, value: Color3): ProceduralTexture;
  91448. /**
  91449. * Set a vec4 in the shader from a Color4.
  91450. * @param name Define the name of the uniform as defined in the shader
  91451. * @param value Define the value to give to the uniform
  91452. * @return the texture itself allowing "fluent" like uniform updates
  91453. */
  91454. setColor4(name: string, value: Color4): ProceduralTexture;
  91455. /**
  91456. * Set a vec2 in the shader from a Vector2.
  91457. * @param name Define the name of the uniform as defined in the shader
  91458. * @param value Define the value to give to the uniform
  91459. * @return the texture itself allowing "fluent" like uniform updates
  91460. */
  91461. setVector2(name: string, value: Vector2): ProceduralTexture;
  91462. /**
  91463. * Set a vec3 in the shader from a Vector3.
  91464. * @param name Define the name of the uniform as defined in the shader
  91465. * @param value Define the value to give to the uniform
  91466. * @return the texture itself allowing "fluent" like uniform updates
  91467. */
  91468. setVector3(name: string, value: Vector3): ProceduralTexture;
  91469. /**
  91470. * Set a mat4 in the shader from a MAtrix.
  91471. * @param name Define the name of the uniform as defined in the shader
  91472. * @param value Define the value to give to the uniform
  91473. * @return the texture itself allowing "fluent" like uniform updates
  91474. */
  91475. setMatrix(name: string, value: Matrix): ProceduralTexture;
  91476. /**
  91477. * Render the texture to its associated render target.
  91478. * @param useCameraPostProcess Define if camera post process should be applied to the texture
  91479. */
  91480. render(useCameraPostProcess?: boolean): void;
  91481. /**
  91482. * Clone the texture.
  91483. * @returns the cloned texture
  91484. */
  91485. clone(): ProceduralTexture;
  91486. /**
  91487. * Dispose the texture and release its asoociated resources.
  91488. */
  91489. dispose(): void;
  91490. }
  91491. }
  91492. declare module BABYLON {
  91493. /**
  91494. * This represents the base class for particle system in Babylon.
  91495. * 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.
  91496. * Particles can take different shapes while emitted like box, sphere, cone or you can write your custom function.
  91497. * @example https://doc.babylonjs.com/babylon101/particles
  91498. */
  91499. export class BaseParticleSystem {
  91500. /**
  91501. * Source color is added to the destination color without alpha affecting the result
  91502. */
  91503. static BLENDMODE_ONEONE: number;
  91504. /**
  91505. * Blend current color and particle color using particle’s alpha
  91506. */
  91507. static BLENDMODE_STANDARD: number;
  91508. /**
  91509. * Add current color and particle color multiplied by particle’s alpha
  91510. */
  91511. static BLENDMODE_ADD: number;
  91512. /**
  91513. * Multiply current color with particle color
  91514. */
  91515. static BLENDMODE_MULTIPLY: number;
  91516. /**
  91517. * Multiply current color with particle color then add current color and particle color multiplied by particle’s alpha
  91518. */
  91519. static BLENDMODE_MULTIPLYADD: number;
  91520. /**
  91521. * List of animations used by the particle system.
  91522. */
  91523. animations: Animation[];
  91524. /**
  91525. * Gets or sets the unique id of the particle system
  91526. */
  91527. uniqueId: number;
  91528. /**
  91529. * The id of the Particle system.
  91530. */
  91531. id: string;
  91532. /**
  91533. * The friendly name of the Particle system.
  91534. */
  91535. name: string;
  91536. /**
  91537. * Snippet ID if the particle system was created from the snippet server
  91538. */
  91539. snippetId: string;
  91540. /**
  91541. * The rendering group used by the Particle system to chose when to render.
  91542. */
  91543. renderingGroupId: number;
  91544. /**
  91545. * The emitter represents the Mesh or position we are attaching the particle system to.
  91546. */
  91547. emitter: Nullable<AbstractMesh | Vector3>;
  91548. /**
  91549. * The maximum number of particles to emit per frame
  91550. */
  91551. emitRate: number;
  91552. /**
  91553. * If you want to launch only a few particles at once, that can be done, as well.
  91554. */
  91555. manualEmitCount: number;
  91556. /**
  91557. * The overall motion speed (0.01 is default update speed, faster updates = faster animation)
  91558. */
  91559. updateSpeed: number;
  91560. /**
  91561. * The amount of time the particle system is running (depends of the overall update speed).
  91562. */
  91563. targetStopDuration: number;
  91564. /**
  91565. * Specifies whether the particle system will be disposed once it reaches the end of the animation.
  91566. */
  91567. disposeOnStop: boolean;
  91568. /**
  91569. * Minimum power of emitting particles.
  91570. */
  91571. minEmitPower: number;
  91572. /**
  91573. * Maximum power of emitting particles.
  91574. */
  91575. maxEmitPower: number;
  91576. /**
  91577. * Minimum life time of emitting particles.
  91578. */
  91579. minLifeTime: number;
  91580. /**
  91581. * Maximum life time of emitting particles.
  91582. */
  91583. maxLifeTime: number;
  91584. /**
  91585. * Minimum Size of emitting particles.
  91586. */
  91587. minSize: number;
  91588. /**
  91589. * Maximum Size of emitting particles.
  91590. */
  91591. maxSize: number;
  91592. /**
  91593. * Minimum scale of emitting particles on X axis.
  91594. */
  91595. minScaleX: number;
  91596. /**
  91597. * Maximum scale of emitting particles on X axis.
  91598. */
  91599. maxScaleX: number;
  91600. /**
  91601. * Minimum scale of emitting particles on Y axis.
  91602. */
  91603. minScaleY: number;
  91604. /**
  91605. * Maximum scale of emitting particles on Y axis.
  91606. */
  91607. maxScaleY: number;
  91608. /**
  91609. * Gets or sets the minimal initial rotation in radians.
  91610. */
  91611. minInitialRotation: number;
  91612. /**
  91613. * Gets or sets the maximal initial rotation in radians.
  91614. */
  91615. maxInitialRotation: number;
  91616. /**
  91617. * Minimum angular speed of emitting particles (Z-axis rotation for each particle).
  91618. */
  91619. minAngularSpeed: number;
  91620. /**
  91621. * Maximum angular speed of emitting particles (Z-axis rotation for each particle).
  91622. */
  91623. maxAngularSpeed: number;
  91624. /**
  91625. * The texture used to render each particle. (this can be a spritesheet)
  91626. */
  91627. particleTexture: Nullable<BaseTexture>;
  91628. /**
  91629. * The layer mask we are rendering the particles through.
  91630. */
  91631. layerMask: number;
  91632. /**
  91633. * This can help using your own shader to render the particle system.
  91634. * The according effect will be created
  91635. */
  91636. customShader: any;
  91637. /**
  91638. * By default particle system starts as soon as they are created. This prevents the
  91639. * automatic start to happen and let you decide when to start emitting particles.
  91640. */
  91641. preventAutoStart: boolean;
  91642. private _noiseTexture;
  91643. /**
  91644. * Gets or sets a texture used to add random noise to particle positions
  91645. */
  91646. get noiseTexture(): Nullable<ProceduralTexture>;
  91647. set noiseTexture(value: Nullable<ProceduralTexture>);
  91648. /** Gets or sets the strength to apply to the noise value (default is (10, 10, 10)) */
  91649. noiseStrength: Vector3;
  91650. /**
  91651. * Callback triggered when the particle animation is ending.
  91652. */
  91653. onAnimationEnd: Nullable<() => void>;
  91654. /**
  91655. * Blend mode use to render the particle, it can be either ParticleSystem.BLENDMODE_ONEONE or ParticleSystem.BLENDMODE_STANDARD.
  91656. */
  91657. blendMode: number;
  91658. /**
  91659. * Forces the particle to write their depth information to the depth buffer. This can help preventing other draw calls
  91660. * to override the particles.
  91661. */
  91662. forceDepthWrite: boolean;
  91663. /** 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 */
  91664. preWarmCycles: number;
  91665. /** Gets or sets a value indicating the time step multiplier to use in pre-warm mode (default is 1) */
  91666. preWarmStepOffset: number;
  91667. /**
  91668. * 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)
  91669. */
  91670. spriteCellChangeSpeed: number;
  91671. /**
  91672. * If using a spritesheet (isAnimationSheetEnabled) defines the first sprite cell to display
  91673. */
  91674. startSpriteCellID: number;
  91675. /**
  91676. * If using a spritesheet (isAnimationSheetEnabled) defines the last sprite cell to display
  91677. */
  91678. endSpriteCellID: number;
  91679. /**
  91680. * If using a spritesheet (isAnimationSheetEnabled), defines the sprite cell width to use
  91681. */
  91682. spriteCellWidth: number;
  91683. /**
  91684. * If using a spritesheet (isAnimationSheetEnabled), defines the sprite cell height to use
  91685. */
  91686. spriteCellHeight: number;
  91687. /**
  91688. * This allows the system to random pick the start cell ID between startSpriteCellID and endSpriteCellID
  91689. */
  91690. spriteRandomStartCell: boolean;
  91691. /** Gets or sets a Vector2 used to move the pivot (by default (0,0)) */
  91692. translationPivot: Vector2;
  91693. /** @hidden */
  91694. protected _isAnimationSheetEnabled: boolean;
  91695. /**
  91696. * Gets or sets a boolean indicating that hosted animations (in the system.animations array) must be started when system.start() is called
  91697. */
  91698. beginAnimationOnStart: boolean;
  91699. /**
  91700. * Gets or sets the frame to start the animation from when beginAnimationOnStart is true
  91701. */
  91702. beginAnimationFrom: number;
  91703. /**
  91704. * Gets or sets the frame to end the animation on when beginAnimationOnStart is true
  91705. */
  91706. beginAnimationTo: number;
  91707. /**
  91708. * Gets or sets a boolean indicating if animations must loop when beginAnimationOnStart is true
  91709. */
  91710. beginAnimationLoop: boolean;
  91711. /**
  91712. * Gets or sets a world offset applied to all particles
  91713. */
  91714. worldOffset: Vector3;
  91715. /**
  91716. * Gets or sets whether an animation sprite sheet is enabled or not on the particle system
  91717. */
  91718. get isAnimationSheetEnabled(): boolean;
  91719. set isAnimationSheetEnabled(value: boolean);
  91720. /**
  91721. * Get hosting scene
  91722. * @returns the scene
  91723. */
  91724. getScene(): Nullable<Scene>;
  91725. /**
  91726. * You can use gravity if you want to give an orientation to your particles.
  91727. */
  91728. gravity: Vector3;
  91729. protected _colorGradients: Nullable<Array<ColorGradient>>;
  91730. protected _sizeGradients: Nullable<Array<FactorGradient>>;
  91731. protected _lifeTimeGradients: Nullable<Array<FactorGradient>>;
  91732. protected _angularSpeedGradients: Nullable<Array<FactorGradient>>;
  91733. protected _velocityGradients: Nullable<Array<FactorGradient>>;
  91734. protected _limitVelocityGradients: Nullable<Array<FactorGradient>>;
  91735. protected _dragGradients: Nullable<Array<FactorGradient>>;
  91736. protected _emitRateGradients: Nullable<Array<FactorGradient>>;
  91737. protected _startSizeGradients: Nullable<Array<FactorGradient>>;
  91738. protected _rampGradients: Nullable<Array<Color3Gradient>>;
  91739. protected _colorRemapGradients: Nullable<Array<FactorGradient>>;
  91740. protected _alphaRemapGradients: Nullable<Array<FactorGradient>>;
  91741. protected _hasTargetStopDurationDependantGradient(): boolean | null;
  91742. /**
  91743. * Defines the delay in milliseconds before starting the system (0 by default)
  91744. */
  91745. startDelay: number;
  91746. /**
  91747. * Gets the current list of drag gradients.
  91748. * You must use addDragGradient and removeDragGradient to udpate this list
  91749. * @returns the list of drag gradients
  91750. */
  91751. getDragGradients(): Nullable<Array<FactorGradient>>;
  91752. /** Gets or sets a value indicating the damping to apply if the limit velocity factor is reached */
  91753. limitVelocityDamping: number;
  91754. /**
  91755. * Gets the current list of limit velocity gradients.
  91756. * You must use addLimitVelocityGradient and removeLimitVelocityGradient to udpate this list
  91757. * @returns the list of limit velocity gradients
  91758. */
  91759. getLimitVelocityGradients(): Nullable<Array<FactorGradient>>;
  91760. /**
  91761. * Gets the current list of color gradients.
  91762. * You must use addColorGradient and removeColorGradient to udpate this list
  91763. * @returns the list of color gradients
  91764. */
  91765. getColorGradients(): Nullable<Array<ColorGradient>>;
  91766. /**
  91767. * Gets the current list of size gradients.
  91768. * You must use addSizeGradient and removeSizeGradient to udpate this list
  91769. * @returns the list of size gradients
  91770. */
  91771. getSizeGradients(): Nullable<Array<FactorGradient>>;
  91772. /**
  91773. * Gets the current list of color remap gradients.
  91774. * You must use addColorRemapGradient and removeColorRemapGradient to udpate this list
  91775. * @returns the list of color remap gradients
  91776. */
  91777. getColorRemapGradients(): Nullable<Array<FactorGradient>>;
  91778. /**
  91779. * Gets the current list of alpha remap gradients.
  91780. * You must use addAlphaRemapGradient and removeAlphaRemapGradient to udpate this list
  91781. * @returns the list of alpha remap gradients
  91782. */
  91783. getAlphaRemapGradients(): Nullable<Array<FactorGradient>>;
  91784. /**
  91785. * Gets the current list of life time gradients.
  91786. * You must use addLifeTimeGradient and removeLifeTimeGradient to udpate this list
  91787. * @returns the list of life time gradients
  91788. */
  91789. getLifeTimeGradients(): Nullable<Array<FactorGradient>>;
  91790. /**
  91791. * Gets the current list of angular speed gradients.
  91792. * You must use addAngularSpeedGradient and removeAngularSpeedGradient to udpate this list
  91793. * @returns the list of angular speed gradients
  91794. */
  91795. getAngularSpeedGradients(): Nullable<Array<FactorGradient>>;
  91796. /**
  91797. * Gets the current list of velocity gradients.
  91798. * You must use addVelocityGradient and removeVelocityGradient to udpate this list
  91799. * @returns the list of velocity gradients
  91800. */
  91801. getVelocityGradients(): Nullable<Array<FactorGradient>>;
  91802. /**
  91803. * Gets the current list of start size gradients.
  91804. * You must use addStartSizeGradient and removeStartSizeGradient to udpate this list
  91805. * @returns the list of start size gradients
  91806. */
  91807. getStartSizeGradients(): Nullable<Array<FactorGradient>>;
  91808. /**
  91809. * Gets the current list of emit rate gradients.
  91810. * You must use addEmitRateGradient and removeEmitRateGradient to udpate this list
  91811. * @returns the list of emit rate gradients
  91812. */
  91813. getEmitRateGradients(): Nullable<Array<FactorGradient>>;
  91814. /**
  91815. * Random direction of each particle after it has been emitted, between direction1 and direction2 vectors.
  91816. * This only works when particleEmitterTyps is a BoxParticleEmitter
  91817. */
  91818. get direction1(): Vector3;
  91819. set direction1(value: Vector3);
  91820. /**
  91821. * Random direction of each particle after it has been emitted, between direction1 and direction2 vectors.
  91822. * This only works when particleEmitterTyps is a BoxParticleEmitter
  91823. */
  91824. get direction2(): Vector3;
  91825. set direction2(value: Vector3);
  91826. /**
  91827. * 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.
  91828. * This only works when particleEmitterTyps is a BoxParticleEmitter
  91829. */
  91830. get minEmitBox(): Vector3;
  91831. set minEmitBox(value: Vector3);
  91832. /**
  91833. * 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.
  91834. * This only works when particleEmitterTyps is a BoxParticleEmitter
  91835. */
  91836. get maxEmitBox(): Vector3;
  91837. set maxEmitBox(value: Vector3);
  91838. /**
  91839. * Random color of each particle after it has been emitted, between color1 and color2 vectors
  91840. */
  91841. color1: Color4;
  91842. /**
  91843. * Random color of each particle after it has been emitted, between color1 and color2 vectors
  91844. */
  91845. color2: Color4;
  91846. /**
  91847. * Color the particle will have at the end of its lifetime
  91848. */
  91849. colorDead: Color4;
  91850. /**
  91851. * An optional mask to filter some colors out of the texture, or filter a part of the alpha channel
  91852. */
  91853. textureMask: Color4;
  91854. /**
  91855. * The particle emitter type defines the emitter used by the particle system.
  91856. * It can be for example box, sphere, or cone...
  91857. */
  91858. particleEmitterType: IParticleEmitterType;
  91859. /** @hidden */
  91860. _isSubEmitter: boolean;
  91861. /**
  91862. * Gets or sets the billboard mode to use when isBillboardBased = true.
  91863. * Value can be: ParticleSystem.BILLBOARDMODE_ALL, ParticleSystem.BILLBOARDMODE_Y, ParticleSystem.BILLBOARDMODE_STRETCHED
  91864. */
  91865. billboardMode: number;
  91866. protected _isBillboardBased: boolean;
  91867. /**
  91868. * Gets or sets a boolean indicating if the particles must be rendered as billboard or aligned with the direction
  91869. */
  91870. get isBillboardBased(): boolean;
  91871. set isBillboardBased(value: boolean);
  91872. /**
  91873. * The scene the particle system belongs to.
  91874. */
  91875. protected _scene: Nullable<Scene>;
  91876. /**
  91877. * The engine the particle system belongs to.
  91878. */
  91879. protected _engine: ThinEngine;
  91880. /**
  91881. * Local cache of defines for image processing.
  91882. */
  91883. protected _imageProcessingConfigurationDefines: ImageProcessingConfigurationDefines;
  91884. /**
  91885. * Default configuration related to image processing available in the standard Material.
  91886. */
  91887. protected _imageProcessingConfiguration: Nullable<ImageProcessingConfiguration>;
  91888. /**
  91889. * Gets the image processing configuration used either in this material.
  91890. */
  91891. get imageProcessingConfiguration(): Nullable<ImageProcessingConfiguration>;
  91892. /**
  91893. * Sets the Default image processing configuration used either in the this material.
  91894. *
  91895. * If sets to null, the scene one is in use.
  91896. */
  91897. set imageProcessingConfiguration(value: Nullable<ImageProcessingConfiguration>);
  91898. /**
  91899. * Attaches a new image processing configuration to the Standard Material.
  91900. * @param configuration
  91901. */
  91902. protected _attachImageProcessingConfiguration(configuration: Nullable<ImageProcessingConfiguration>): void;
  91903. /** @hidden */
  91904. protected _reset(): void;
  91905. /** @hidden */
  91906. protected _removeGradientAndTexture(gradient: number, gradients: Nullable<IValueGradient[]>, texture: Nullable<RawTexture>): BaseParticleSystem;
  91907. /**
  91908. * Instantiates a particle system.
  91909. * 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.
  91910. * @param name The name of the particle system
  91911. */
  91912. constructor(name: string);
  91913. /**
  91914. * Creates a Point Emitter for the particle system (emits directly from the emitter position)
  91915. * @param direction1 Particles are emitted between the direction1 and direction2 from within the box
  91916. * @param direction2 Particles are emitted between the direction1 and direction2 from within the box
  91917. * @returns the emitter
  91918. */
  91919. createPointEmitter(direction1: Vector3, direction2: Vector3): PointParticleEmitter;
  91920. /**
  91921. * Creates a Hemisphere Emitter for the particle system (emits along the hemisphere radius)
  91922. * @param radius The radius of the hemisphere to emit from
  91923. * @param radiusRange The range of the hemisphere to emit from [0-1] 0 Surface Only, 1 Entire Radius
  91924. * @returns the emitter
  91925. */
  91926. createHemisphericEmitter(radius?: number, radiusRange?: number): HemisphericParticleEmitter;
  91927. /**
  91928. * Creates a Sphere Emitter for the particle system (emits along the sphere radius)
  91929. * @param radius The radius of the sphere to emit from
  91930. * @param radiusRange The range of the sphere to emit from [0-1] 0 Surface Only, 1 Entire Radius
  91931. * @returns the emitter
  91932. */
  91933. createSphereEmitter(radius?: number, radiusRange?: number): SphereParticleEmitter;
  91934. /**
  91935. * Creates a Directed Sphere Emitter for the particle system (emits between direction1 and direction2)
  91936. * @param radius The radius of the sphere to emit from
  91937. * @param direction1 Particles are emitted between the direction1 and direction2 from within the sphere
  91938. * @param direction2 Particles are emitted between the direction1 and direction2 from within the sphere
  91939. * @returns the emitter
  91940. */
  91941. createDirectedSphereEmitter(radius?: number, direction1?: Vector3, direction2?: Vector3): SphereDirectedParticleEmitter;
  91942. /**
  91943. * Creates a Cylinder Emitter for the particle system (emits from the cylinder to the particle position)
  91944. * @param radius The radius of the emission cylinder
  91945. * @param height The height of the emission cylinder
  91946. * @param radiusRange The range of emission [0-1] 0 Surface only, 1 Entire Radius
  91947. * @param directionRandomizer How much to randomize the particle direction [0-1]
  91948. * @returns the emitter
  91949. */
  91950. createCylinderEmitter(radius?: number, height?: number, radiusRange?: number, directionRandomizer?: number): CylinderParticleEmitter;
  91951. /**
  91952. * Creates a Directed Cylinder Emitter for the particle system (emits between direction1 and direction2)
  91953. * @param radius The radius of the cylinder to emit from
  91954. * @param height The height of the emission cylinder
  91955. * @param radiusRange the range of the emission cylinder [0-1] 0 Surface only, 1 Entire Radius (1 by default)
  91956. * @param direction1 Particles are emitted between the direction1 and direction2 from within the cylinder
  91957. * @param direction2 Particles are emitted between the direction1 and direction2 from within the cylinder
  91958. * @returns the emitter
  91959. */
  91960. createDirectedCylinderEmitter(radius?: number, height?: number, radiusRange?: number, direction1?: Vector3, direction2?: Vector3): CylinderDirectedParticleEmitter;
  91961. /**
  91962. * Creates a Cone Emitter for the particle system (emits from the cone to the particle position)
  91963. * @param radius The radius of the cone to emit from
  91964. * @param angle The base angle of the cone
  91965. * @returns the emitter
  91966. */
  91967. createConeEmitter(radius?: number, angle?: number): ConeParticleEmitter;
  91968. /**
  91969. * Creates a Box Emitter for the particle system. (emits between direction1 and direction2 from withing the box defined by minEmitBox and maxEmitBox)
  91970. * @param direction1 Particles are emitted between the direction1 and direction2 from within the box
  91971. * @param direction2 Particles are emitted between the direction1 and direction2 from within the box
  91972. * @param minEmitBox Particles are emitted from the box between minEmitBox and maxEmitBox
  91973. * @param maxEmitBox Particles are emitted from the box between minEmitBox and maxEmitBox
  91974. * @returns the emitter
  91975. */
  91976. createBoxEmitter(direction1: Vector3, direction2: Vector3, minEmitBox: Vector3, maxEmitBox: Vector3): BoxParticleEmitter;
  91977. }
  91978. }
  91979. declare module BABYLON {
  91980. /**
  91981. * Type of sub emitter
  91982. */
  91983. export enum SubEmitterType {
  91984. /**
  91985. * Attached to the particle over it's lifetime
  91986. */
  91987. ATTACHED = 0,
  91988. /**
  91989. * Created when the particle dies
  91990. */
  91991. END = 1
  91992. }
  91993. /**
  91994. * Sub emitter class used to emit particles from an existing particle
  91995. */
  91996. export class SubEmitter {
  91997. /**
  91998. * the particle system to be used by the sub emitter
  91999. */
  92000. particleSystem: ParticleSystem;
  92001. /**
  92002. * Type of the submitter (Default: END)
  92003. */
  92004. type: SubEmitterType;
  92005. /**
  92006. * 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)
  92007. * Note: This only is supported when using an emitter of type Mesh
  92008. */
  92009. inheritDirection: boolean;
  92010. /**
  92011. * How much of the attached particles speed should be added to the sub emitted particle (default: 0)
  92012. */
  92013. inheritedVelocityAmount: number;
  92014. /**
  92015. * Creates a sub emitter
  92016. * @param particleSystem the particle system to be used by the sub emitter
  92017. */
  92018. constructor(
  92019. /**
  92020. * the particle system to be used by the sub emitter
  92021. */
  92022. particleSystem: ParticleSystem);
  92023. /**
  92024. * Clones the sub emitter
  92025. * @returns the cloned sub emitter
  92026. */
  92027. clone(): SubEmitter;
  92028. /**
  92029. * Serialize current object to a JSON object
  92030. * @returns the serialized object
  92031. */
  92032. serialize(): any;
  92033. /** @hidden */
  92034. static _ParseParticleSystem(system: any, sceneOrEngine: Scene | ThinEngine, rootUrl: string): ParticleSystem;
  92035. /**
  92036. * Creates a new SubEmitter from a serialized JSON version
  92037. * @param serializationObject defines the JSON object to read from
  92038. * @param sceneOrEngine defines the hosting scene or the hosting engine
  92039. * @param rootUrl defines the rootUrl for data loading
  92040. * @returns a new SubEmitter
  92041. */
  92042. static Parse(serializationObject: any, sceneOrEngine: Scene | ThinEngine, rootUrl: string): SubEmitter;
  92043. /** Release associated resources */
  92044. dispose(): void;
  92045. }
  92046. }
  92047. declare module BABYLON {
  92048. /** @hidden */
  92049. export var imageProcessingDeclaration: {
  92050. name: string;
  92051. shader: string;
  92052. };
  92053. }
  92054. declare module BABYLON {
  92055. /** @hidden */
  92056. export var imageProcessingFunctions: {
  92057. name: string;
  92058. shader: string;
  92059. };
  92060. }
  92061. declare module BABYLON {
  92062. /** @hidden */
  92063. export var particlesPixelShader: {
  92064. name: string;
  92065. shader: string;
  92066. };
  92067. }
  92068. declare module BABYLON {
  92069. /** @hidden */
  92070. export var particlesVertexShader: {
  92071. name: string;
  92072. shader: string;
  92073. };
  92074. }
  92075. declare module BABYLON {
  92076. /**
  92077. * Interface used to define entities containing multiple clip planes
  92078. */
  92079. export interface IClipPlanesHolder {
  92080. /**
  92081. * Gets or sets the active clipplane 1
  92082. */
  92083. clipPlane: Nullable<Plane>;
  92084. /**
  92085. * Gets or sets the active clipplane 2
  92086. */
  92087. clipPlane2: Nullable<Plane>;
  92088. /**
  92089. * Gets or sets the active clipplane 3
  92090. */
  92091. clipPlane3: Nullable<Plane>;
  92092. /**
  92093. * Gets or sets the active clipplane 4
  92094. */
  92095. clipPlane4: Nullable<Plane>;
  92096. /**
  92097. * Gets or sets the active clipplane 5
  92098. */
  92099. clipPlane5: Nullable<Plane>;
  92100. /**
  92101. * Gets or sets the active clipplane 6
  92102. */
  92103. clipPlane6: Nullable<Plane>;
  92104. }
  92105. }
  92106. declare module BABYLON {
  92107. /**
  92108. * "Static Class" containing a few commonly used helper while dealing with material for rendering purpose.
  92109. *
  92110. * It is complementary with MaterialHelper but provides completely independent functions (for tree shaking sake)
  92111. *
  92112. * This works by convention in BabylonJS but is meant to be use only with shader following the in place naming rules and conventions.
  92113. */
  92114. export class ThinMaterialHelper {
  92115. /**
  92116. * Binds the clip plane information from the holder to the effect.
  92117. * @param effect The effect we are binding the data to
  92118. * @param holder The entity containing the clip plane information
  92119. */
  92120. static BindClipPlane(effect: Effect, holder: IClipPlanesHolder): void;
  92121. }
  92122. }
  92123. declare module BABYLON {
  92124. interface ThinEngine {
  92125. /**
  92126. * Sets alpha constants used by some alpha blending modes
  92127. * @param r defines the red component
  92128. * @param g defines the green component
  92129. * @param b defines the blue component
  92130. * @param a defines the alpha component
  92131. */
  92132. setAlphaConstants(r: number, g: number, b: number, a: number): void;
  92133. /**
  92134. * Sets the current alpha mode
  92135. * @param mode defines the mode to use (one of the Engine.ALPHA_XXX)
  92136. * @param noDepthWriteChange defines if depth writing state should remains unchanged (false by default)
  92137. * @see https://doc.babylonjs.com/resources/transparency_and_how_meshes_are_rendered
  92138. */
  92139. setAlphaMode(mode: number, noDepthWriteChange?: boolean): void;
  92140. /**
  92141. * Gets the current alpha mode
  92142. * @see https://doc.babylonjs.com/resources/transparency_and_how_meshes_are_rendered
  92143. * @returns the current alpha mode
  92144. */
  92145. getAlphaMode(): number;
  92146. /**
  92147. * Sets the current alpha equation
  92148. * @param equation defines the equation to use (one of the Engine.ALPHA_EQUATION_XXX)
  92149. */
  92150. setAlphaEquation(equation: number): void;
  92151. /**
  92152. * Gets the current alpha equation.
  92153. * @returns the current alpha equation
  92154. */
  92155. getAlphaEquation(): number;
  92156. }
  92157. }
  92158. declare module BABYLON {
  92159. /**
  92160. * This represents a particle system in Babylon.
  92161. * 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.
  92162. * Particles can take different shapes while emitted like box, sphere, cone or you can write your custom function.
  92163. * @example https://doc.babylonjs.com/babylon101/particles
  92164. */
  92165. export class ParticleSystem extends BaseParticleSystem implements IDisposable, IAnimatable, IParticleSystem {
  92166. /**
  92167. * Billboard mode will only apply to Y axis
  92168. */
  92169. static readonly BILLBOARDMODE_Y: number;
  92170. /**
  92171. * Billboard mode will apply to all axes
  92172. */
  92173. static readonly BILLBOARDMODE_ALL: number;
  92174. /**
  92175. * Special billboard mode where the particle will be biilboard to the camera but rotated to align with direction
  92176. */
  92177. static readonly BILLBOARDMODE_STRETCHED: number;
  92178. /**
  92179. * This function can be defined to provide custom update for active particles.
  92180. * This function will be called instead of regular update (age, position, color, etc.).
  92181. * Do not forget that this function will be called on every frame so try to keep it simple and fast :)
  92182. */
  92183. updateFunction: (particles: Particle[]) => void;
  92184. private _emitterWorldMatrix;
  92185. /**
  92186. * This function can be defined to specify initial direction for every new particle.
  92187. * It by default use the emitterType defined function
  92188. */
  92189. startDirectionFunction: (worldMatrix: Matrix, directionToUpdate: Vector3, particle: Particle, isLocal: boolean) => void;
  92190. /**
  92191. * This function can be defined to specify initial position for every new particle.
  92192. * It by default use the emitterType defined function
  92193. */
  92194. startPositionFunction: (worldMatrix: Matrix, positionToUpdate: Vector3, particle: Particle, isLocal: boolean) => void;
  92195. /**
  92196. * @hidden
  92197. */
  92198. _inheritedVelocityOffset: Vector3;
  92199. /**
  92200. * An event triggered when the system is disposed
  92201. */
  92202. onDisposeObservable: Observable<IParticleSystem>;
  92203. private _onDisposeObserver;
  92204. /**
  92205. * Sets a callback that will be triggered when the system is disposed
  92206. */
  92207. set onDispose(callback: () => void);
  92208. private _particles;
  92209. private _epsilon;
  92210. private _capacity;
  92211. private _stockParticles;
  92212. private _newPartsExcess;
  92213. private _vertexData;
  92214. private _vertexBuffer;
  92215. private _vertexBuffers;
  92216. private _spriteBuffer;
  92217. private _indexBuffer;
  92218. private _effect;
  92219. private _customEffect;
  92220. private _cachedDefines;
  92221. private _scaledColorStep;
  92222. private _colorDiff;
  92223. private _scaledDirection;
  92224. private _scaledGravity;
  92225. private _currentRenderId;
  92226. private _alive;
  92227. private _useInstancing;
  92228. private _started;
  92229. private _stopped;
  92230. private _actualFrame;
  92231. private _scaledUpdateSpeed;
  92232. private _vertexBufferSize;
  92233. /** @hidden */
  92234. _currentEmitRateGradient: Nullable<FactorGradient>;
  92235. /** @hidden */
  92236. _currentEmitRate1: number;
  92237. /** @hidden */
  92238. _currentEmitRate2: number;
  92239. /** @hidden */
  92240. _currentStartSizeGradient: Nullable<FactorGradient>;
  92241. /** @hidden */
  92242. _currentStartSize1: number;
  92243. /** @hidden */
  92244. _currentStartSize2: number;
  92245. private readonly _rawTextureWidth;
  92246. private _rampGradientsTexture;
  92247. private _useRampGradients;
  92248. /** Gets or sets a matrix to use to compute projection */
  92249. defaultProjectionMatrix: Matrix;
  92250. /** Gets or sets a matrix to use to compute view */
  92251. defaultViewMatrix: Matrix;
  92252. /** Gets or sets a boolean indicating that ramp gradients must be used
  92253. * @see https://doc.babylonjs.com/babylon101/particles#ramp-gradients
  92254. */
  92255. get useRampGradients(): boolean;
  92256. set useRampGradients(value: boolean);
  92257. /**
  92258. * 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.
  92259. * 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: [])
  92260. */
  92261. subEmitters: Array<ParticleSystem | SubEmitter | Array<SubEmitter>>;
  92262. private _subEmitters;
  92263. /**
  92264. * @hidden
  92265. * If the particle systems emitter should be disposed when the particle system is disposed
  92266. */
  92267. _disposeEmitterOnDispose: boolean;
  92268. /**
  92269. * The current active Sub-systems, this property is used by the root particle system only.
  92270. */
  92271. activeSubSystems: Array<ParticleSystem>;
  92272. /**
  92273. * Specifies if the particles are updated in emitter local space or world space
  92274. */
  92275. isLocal: boolean;
  92276. private _rootParticleSystem;
  92277. /**
  92278. * Gets the current list of active particles
  92279. */
  92280. get particles(): Particle[];
  92281. /**
  92282. * Gets the number of particles active at the same time.
  92283. * @returns The number of active particles.
  92284. */
  92285. getActiveCount(): number;
  92286. /**
  92287. * Returns the string "ParticleSystem"
  92288. * @returns a string containing the class name
  92289. */
  92290. getClassName(): string;
  92291. /**
  92292. * Gets a boolean indicating that the system is stopping
  92293. * @returns true if the system is currently stopping
  92294. */
  92295. isStopping(): boolean;
  92296. /**
  92297. * Gets the custom effect used to render the particles
  92298. * @param blendMode Blend mode for which the effect should be retrieved
  92299. * @returns The effect
  92300. */
  92301. getCustomEffect(blendMode?: number): Nullable<Effect>;
  92302. /**
  92303. * Sets the custom effect used to render the particles
  92304. * @param effect The effect to set
  92305. * @param blendMode Blend mode for which the effect should be set
  92306. */
  92307. setCustomEffect(effect: Nullable<Effect>, blendMode?: number): void;
  92308. /** @hidden */
  92309. private _onBeforeDrawParticlesObservable;
  92310. /**
  92311. * Observable that will be called just before the particles are drawn
  92312. */
  92313. get onBeforeDrawParticlesObservable(): Observable<Nullable<Effect>>;
  92314. /**
  92315. * Gets the name of the particle vertex shader
  92316. */
  92317. get vertexShaderName(): string;
  92318. /**
  92319. * Instantiates a particle system.
  92320. * 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.
  92321. * @param name The name of the particle system
  92322. * @param capacity The max number of particles alive at the same time
  92323. * @param sceneOrEngine The scene the particle system belongs to or the engine to use if no scene
  92324. * @param customEffect a custom effect used to change the way particles are rendered by default
  92325. * @param isAnimationSheetEnabled Must be true if using a spritesheet to animate the particles texture
  92326. * @param epsilon Offset used to render the particles
  92327. */
  92328. constructor(name: string, capacity: number, sceneOrEngine: Scene | ThinEngine, customEffect?: Nullable<Effect>, isAnimationSheetEnabled?: boolean, epsilon?: number);
  92329. private _addFactorGradient;
  92330. private _removeFactorGradient;
  92331. /**
  92332. * Adds a new life time gradient
  92333. * @param gradient defines the gradient to use (between 0 and 1)
  92334. * @param factor defines the life time factor to affect to the specified gradient
  92335. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  92336. * @returns the current particle system
  92337. */
  92338. addLifeTimeGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  92339. /**
  92340. * Remove a specific life time gradient
  92341. * @param gradient defines the gradient to remove
  92342. * @returns the current particle system
  92343. */
  92344. removeLifeTimeGradient(gradient: number): IParticleSystem;
  92345. /**
  92346. * Adds a new size gradient
  92347. * @param gradient defines the gradient to use (between 0 and 1)
  92348. * @param factor defines the size factor to affect to the specified gradient
  92349. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  92350. * @returns the current particle system
  92351. */
  92352. addSizeGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  92353. /**
  92354. * Remove a specific size gradient
  92355. * @param gradient defines the gradient to remove
  92356. * @returns the current particle system
  92357. */
  92358. removeSizeGradient(gradient: number): IParticleSystem;
  92359. /**
  92360. * Adds a new color remap gradient
  92361. * @param gradient defines the gradient to use (between 0 and 1)
  92362. * @param min defines the color remap minimal range
  92363. * @param max defines the color remap maximal range
  92364. * @returns the current particle system
  92365. */
  92366. addColorRemapGradient(gradient: number, min: number, max: number): IParticleSystem;
  92367. /**
  92368. * Remove a specific color remap gradient
  92369. * @param gradient defines the gradient to remove
  92370. * @returns the current particle system
  92371. */
  92372. removeColorRemapGradient(gradient: number): IParticleSystem;
  92373. /**
  92374. * Adds a new alpha remap gradient
  92375. * @param gradient defines the gradient to use (between 0 and 1)
  92376. * @param min defines the alpha remap minimal range
  92377. * @param max defines the alpha remap maximal range
  92378. * @returns the current particle system
  92379. */
  92380. addAlphaRemapGradient(gradient: number, min: number, max: number): IParticleSystem;
  92381. /**
  92382. * Remove a specific alpha remap gradient
  92383. * @param gradient defines the gradient to remove
  92384. * @returns the current particle system
  92385. */
  92386. removeAlphaRemapGradient(gradient: number): IParticleSystem;
  92387. /**
  92388. * Adds a new angular speed gradient
  92389. * @param gradient defines the gradient to use (between 0 and 1)
  92390. * @param factor defines the angular speed to affect to the specified gradient
  92391. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  92392. * @returns the current particle system
  92393. */
  92394. addAngularSpeedGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  92395. /**
  92396. * Remove a specific angular speed gradient
  92397. * @param gradient defines the gradient to remove
  92398. * @returns the current particle system
  92399. */
  92400. removeAngularSpeedGradient(gradient: number): IParticleSystem;
  92401. /**
  92402. * Adds a new velocity gradient
  92403. * @param gradient defines the gradient to use (between 0 and 1)
  92404. * @param factor defines the velocity to affect to the specified gradient
  92405. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  92406. * @returns the current particle system
  92407. */
  92408. addVelocityGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  92409. /**
  92410. * Remove a specific velocity gradient
  92411. * @param gradient defines the gradient to remove
  92412. * @returns the current particle system
  92413. */
  92414. removeVelocityGradient(gradient: number): IParticleSystem;
  92415. /**
  92416. * Adds a new limit velocity gradient
  92417. * @param gradient defines the gradient to use (between 0 and 1)
  92418. * @param factor defines the limit velocity value to affect to the specified gradient
  92419. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  92420. * @returns the current particle system
  92421. */
  92422. addLimitVelocityGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  92423. /**
  92424. * Remove a specific limit velocity gradient
  92425. * @param gradient defines the gradient to remove
  92426. * @returns the current particle system
  92427. */
  92428. removeLimitVelocityGradient(gradient: number): IParticleSystem;
  92429. /**
  92430. * Adds a new drag gradient
  92431. * @param gradient defines the gradient to use (between 0 and 1)
  92432. * @param factor defines the drag value to affect to the specified gradient
  92433. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  92434. * @returns the current particle system
  92435. */
  92436. addDragGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  92437. /**
  92438. * Remove a specific drag gradient
  92439. * @param gradient defines the gradient to remove
  92440. * @returns the current particle system
  92441. */
  92442. removeDragGradient(gradient: number): IParticleSystem;
  92443. /**
  92444. * Adds a new emit rate gradient (please note that this will only work if you set the targetStopDuration property)
  92445. * @param gradient defines the gradient to use (between 0 and 1)
  92446. * @param factor defines the emit rate value to affect to the specified gradient
  92447. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  92448. * @returns the current particle system
  92449. */
  92450. addEmitRateGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  92451. /**
  92452. * Remove a specific emit rate gradient
  92453. * @param gradient defines the gradient to remove
  92454. * @returns the current particle system
  92455. */
  92456. removeEmitRateGradient(gradient: number): IParticleSystem;
  92457. /**
  92458. * Adds a new start size gradient (please note that this will only work if you set the targetStopDuration property)
  92459. * @param gradient defines the gradient to use (between 0 and 1)
  92460. * @param factor defines the start size value to affect to the specified gradient
  92461. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  92462. * @returns the current particle system
  92463. */
  92464. addStartSizeGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  92465. /**
  92466. * Remove a specific start size gradient
  92467. * @param gradient defines the gradient to remove
  92468. * @returns the current particle system
  92469. */
  92470. removeStartSizeGradient(gradient: number): IParticleSystem;
  92471. private _createRampGradientTexture;
  92472. /**
  92473. * Gets the current list of ramp gradients.
  92474. * You must use addRampGradient and removeRampGradient to udpate this list
  92475. * @returns the list of ramp gradients
  92476. */
  92477. getRampGradients(): Nullable<Array<Color3Gradient>>;
  92478. /** Force the system to rebuild all gradients that need to be resync */
  92479. forceRefreshGradients(): void;
  92480. private _syncRampGradientTexture;
  92481. /**
  92482. * Adds a new ramp gradient used to remap particle colors
  92483. * @param gradient defines the gradient to use (between 0 and 1)
  92484. * @param color defines the color to affect to the specified gradient
  92485. * @returns the current particle system
  92486. */
  92487. addRampGradient(gradient: number, color: Color3): ParticleSystem;
  92488. /**
  92489. * Remove a specific ramp gradient
  92490. * @param gradient defines the gradient to remove
  92491. * @returns the current particle system
  92492. */
  92493. removeRampGradient(gradient: number): ParticleSystem;
  92494. /**
  92495. * Adds a new color gradient
  92496. * @param gradient defines the gradient to use (between 0 and 1)
  92497. * @param color1 defines the color to affect to the specified gradient
  92498. * @param color2 defines an additional color used to define a range ([color, color2]) with main color to pick the final color from
  92499. * @returns this particle system
  92500. */
  92501. addColorGradient(gradient: number, color1: Color4, color2?: Color4): IParticleSystem;
  92502. /**
  92503. * Remove a specific color gradient
  92504. * @param gradient defines the gradient to remove
  92505. * @returns this particle system
  92506. */
  92507. removeColorGradient(gradient: number): IParticleSystem;
  92508. private _fetchR;
  92509. protected _reset(): void;
  92510. private _resetEffect;
  92511. private _createVertexBuffers;
  92512. private _createIndexBuffer;
  92513. /**
  92514. * Gets the maximum number of particles active at the same time.
  92515. * @returns The max number of active particles.
  92516. */
  92517. getCapacity(): number;
  92518. /**
  92519. * Gets whether there are still active particles in the system.
  92520. * @returns True if it is alive, otherwise false.
  92521. */
  92522. isAlive(): boolean;
  92523. /**
  92524. * Gets if the system has been started. (Note: this will still be true after stop is called)
  92525. * @returns True if it has been started, otherwise false.
  92526. */
  92527. isStarted(): boolean;
  92528. private _prepareSubEmitterInternalArray;
  92529. /**
  92530. * Starts the particle system and begins to emit
  92531. * @param delay defines the delay in milliseconds before starting the system (this.startDelay by default)
  92532. */
  92533. start(delay?: number): void;
  92534. /**
  92535. * Stops the particle system.
  92536. * @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.
  92537. */
  92538. stop(stopSubEmitters?: boolean): void;
  92539. /**
  92540. * Remove all active particles
  92541. */
  92542. reset(): void;
  92543. /**
  92544. * @hidden (for internal use only)
  92545. */
  92546. _appendParticleVertex(index: number, particle: Particle, offsetX: number, offsetY: number): void;
  92547. /**
  92548. * "Recycles" one of the particle by copying it back to the "stock" of particles and removing it from the active list.
  92549. * Its lifetime will start back at 0.
  92550. */
  92551. recycleParticle: (particle: Particle) => void;
  92552. private _stopSubEmitters;
  92553. private _createParticle;
  92554. private _removeFromRoot;
  92555. private _emitFromParticle;
  92556. private _update;
  92557. /** @hidden */
  92558. static _GetAttributeNamesOrOptions(isAnimationSheetEnabled?: boolean, isBillboardBased?: boolean, useRampGradients?: boolean): string[];
  92559. /** @hidden */
  92560. static _GetEffectCreationOptions(isAnimationSheetEnabled?: boolean): string[];
  92561. /**
  92562. * Fill the defines array according to the current settings of the particle system
  92563. * @param defines Array to be updated
  92564. * @param blendMode blend mode to take into account when updating the array
  92565. */
  92566. fillDefines(defines: Array<string>, blendMode: number): void;
  92567. /**
  92568. * Fill the uniforms, attributes and samplers arrays according to the current settings of the particle system
  92569. * @param uniforms Uniforms array to fill
  92570. * @param attributes Attributes array to fill
  92571. * @param samplers Samplers array to fill
  92572. */
  92573. fillUniformsAttributesAndSamplerNames(uniforms: Array<string>, attributes: Array<string>, samplers: Array<string>): void;
  92574. /** @hidden */
  92575. private _getEffect;
  92576. /**
  92577. * Animates the particle system for the current frame by emitting new particles and or animating the living ones.
  92578. * @param preWarmOnly will prevent the system from updating the vertex buffer (default is false)
  92579. */
  92580. animate(preWarmOnly?: boolean): void;
  92581. private _appendParticleVertices;
  92582. /**
  92583. * Rebuilds the particle system.
  92584. */
  92585. rebuild(): void;
  92586. /**
  92587. * Is this system ready to be used/rendered
  92588. * @return true if the system is ready
  92589. */
  92590. isReady(): boolean;
  92591. private _render;
  92592. /**
  92593. * Renders the particle system in its current state.
  92594. * @returns the current number of particles
  92595. */
  92596. render(): number;
  92597. /**
  92598. * Disposes the particle system and free the associated resources
  92599. * @param disposeTexture defines if the particule texture must be disposed as well (true by default)
  92600. */
  92601. dispose(disposeTexture?: boolean): void;
  92602. /**
  92603. * Clones the particle system.
  92604. * @param name The name of the cloned object
  92605. * @param newEmitter The new emitter to use
  92606. * @returns the cloned particle system
  92607. */
  92608. clone(name: string, newEmitter: any): ParticleSystem;
  92609. /**
  92610. * Serializes the particle system to a JSON object
  92611. * @param serializeTexture defines if the texture must be serialized as well
  92612. * @returns the JSON object
  92613. */
  92614. serialize(serializeTexture?: boolean): any;
  92615. /** @hidden */
  92616. static _Serialize(serializationObject: any, particleSystem: IParticleSystem, serializeTexture: boolean): void;
  92617. /** @hidden */
  92618. static _Parse(parsedParticleSystem: any, particleSystem: IParticleSystem, sceneOrEngine: Scene | ThinEngine, rootUrl: string): void;
  92619. /**
  92620. * Parses a JSON object to create a particle system.
  92621. * @param parsedParticleSystem The JSON object to parse
  92622. * @param sceneOrEngine The scene or the engine to create the particle system in
  92623. * @param rootUrl The root url to use to load external dependencies like texture
  92624. * @param doNotStart Ignore the preventAutoStart attribute and does not start
  92625. * @returns the Parsed particle system
  92626. */
  92627. static Parse(parsedParticleSystem: any, sceneOrEngine: Scene | ThinEngine, rootUrl: string, doNotStart?: boolean): ParticleSystem;
  92628. }
  92629. }
  92630. declare module BABYLON {
  92631. /**
  92632. * A particle represents one of the element emitted by a particle system.
  92633. * This is mainly define by its coordinates, direction, velocity and age.
  92634. */
  92635. export class Particle {
  92636. /**
  92637. * The particle system the particle belongs to.
  92638. */
  92639. particleSystem: ParticleSystem;
  92640. private static _Count;
  92641. /**
  92642. * Unique ID of the particle
  92643. */
  92644. id: number;
  92645. /**
  92646. * The world position of the particle in the scene.
  92647. */
  92648. position: Vector3;
  92649. /**
  92650. * The world direction of the particle in the scene.
  92651. */
  92652. direction: Vector3;
  92653. /**
  92654. * The color of the particle.
  92655. */
  92656. color: Color4;
  92657. /**
  92658. * The color change of the particle per step.
  92659. */
  92660. colorStep: Color4;
  92661. /**
  92662. * Defines how long will the life of the particle be.
  92663. */
  92664. lifeTime: number;
  92665. /**
  92666. * The current age of the particle.
  92667. */
  92668. age: number;
  92669. /**
  92670. * The current size of the particle.
  92671. */
  92672. size: number;
  92673. /**
  92674. * The current scale of the particle.
  92675. */
  92676. scale: Vector2;
  92677. /**
  92678. * The current angle of the particle.
  92679. */
  92680. angle: number;
  92681. /**
  92682. * Defines how fast is the angle changing.
  92683. */
  92684. angularSpeed: number;
  92685. /**
  92686. * Defines the cell index used by the particle to be rendered from a sprite.
  92687. */
  92688. cellIndex: number;
  92689. /**
  92690. * The information required to support color remapping
  92691. */
  92692. remapData: Vector4;
  92693. /** @hidden */
  92694. _randomCellOffset?: number;
  92695. /** @hidden */
  92696. _initialDirection: Nullable<Vector3>;
  92697. /** @hidden */
  92698. _attachedSubEmitters: Nullable<Array<SubEmitter>>;
  92699. /** @hidden */
  92700. _initialStartSpriteCellID: number;
  92701. /** @hidden */
  92702. _initialEndSpriteCellID: number;
  92703. /** @hidden */
  92704. _currentColorGradient: Nullable<ColorGradient>;
  92705. /** @hidden */
  92706. _currentColor1: Color4;
  92707. /** @hidden */
  92708. _currentColor2: Color4;
  92709. /** @hidden */
  92710. _currentSizeGradient: Nullable<FactorGradient>;
  92711. /** @hidden */
  92712. _currentSize1: number;
  92713. /** @hidden */
  92714. _currentSize2: number;
  92715. /** @hidden */
  92716. _currentAngularSpeedGradient: Nullable<FactorGradient>;
  92717. /** @hidden */
  92718. _currentAngularSpeed1: number;
  92719. /** @hidden */
  92720. _currentAngularSpeed2: number;
  92721. /** @hidden */
  92722. _currentVelocityGradient: Nullable<FactorGradient>;
  92723. /** @hidden */
  92724. _currentVelocity1: number;
  92725. /** @hidden */
  92726. _currentVelocity2: number;
  92727. /** @hidden */
  92728. _currentLimitVelocityGradient: Nullable<FactorGradient>;
  92729. /** @hidden */
  92730. _currentLimitVelocity1: number;
  92731. /** @hidden */
  92732. _currentLimitVelocity2: number;
  92733. /** @hidden */
  92734. _currentDragGradient: Nullable<FactorGradient>;
  92735. /** @hidden */
  92736. _currentDrag1: number;
  92737. /** @hidden */
  92738. _currentDrag2: number;
  92739. /** @hidden */
  92740. _randomNoiseCoordinates1: Vector3;
  92741. /** @hidden */
  92742. _randomNoiseCoordinates2: Vector3;
  92743. /** @hidden */
  92744. _localPosition?: Vector3;
  92745. /**
  92746. * Creates a new instance Particle
  92747. * @param particleSystem the particle system the particle belongs to
  92748. */
  92749. constructor(
  92750. /**
  92751. * The particle system the particle belongs to.
  92752. */
  92753. particleSystem: ParticleSystem);
  92754. private updateCellInfoFromSystem;
  92755. /**
  92756. * Defines how the sprite cell index is updated for the particle
  92757. */
  92758. updateCellIndex(): void;
  92759. /** @hidden */
  92760. _inheritParticleInfoToSubEmitter(subEmitter: SubEmitter): void;
  92761. /** @hidden */
  92762. _inheritParticleInfoToSubEmitters(): void;
  92763. /** @hidden */
  92764. _reset(): void;
  92765. /**
  92766. * Copy the properties of particle to another one.
  92767. * @param other the particle to copy the information to.
  92768. */
  92769. copyTo(other: Particle): void;
  92770. }
  92771. }
  92772. declare module BABYLON {
  92773. /**
  92774. * Particle emitter represents a volume emitting particles.
  92775. * This is the responsibility of the implementation to define the volume shape like cone/sphere/box.
  92776. */
  92777. export interface IParticleEmitterType {
  92778. /**
  92779. * Called by the particle System when the direction is computed for the created particle.
  92780. * @param worldMatrix is the world matrix of the particle system
  92781. * @param directionToUpdate is the direction vector to update with the result
  92782. * @param particle is the particle we are computed the direction for
  92783. * @param isLocal defines if the direction should be set in local space
  92784. */
  92785. startDirectionFunction(worldMatrix: Matrix, directionToUpdate: Vector3, particle: Particle, isLocal: boolean): void;
  92786. /**
  92787. * Called by the particle System when the position is computed for the created particle.
  92788. * @param worldMatrix is the world matrix of the particle system
  92789. * @param positionToUpdate is the position vector to update with the result
  92790. * @param particle is the particle we are computed the position for
  92791. * @param isLocal defines if the position should be set in local space
  92792. */
  92793. startPositionFunction(worldMatrix: Matrix, positionToUpdate: Vector3, particle: Particle, isLocal: boolean): void;
  92794. /**
  92795. * Clones the current emitter and returns a copy of it
  92796. * @returns the new emitter
  92797. */
  92798. clone(): IParticleEmitterType;
  92799. /**
  92800. * Called by the GPUParticleSystem to setup the update shader
  92801. * @param effect defines the update shader
  92802. */
  92803. applyToShader(effect: Effect): void;
  92804. /**
  92805. * Returns a string to use to update the GPU particles update shader
  92806. * @returns the effect defines string
  92807. */
  92808. getEffectDefines(): string;
  92809. /**
  92810. * Returns a string representing the class name
  92811. * @returns a string containing the class name
  92812. */
  92813. getClassName(): string;
  92814. /**
  92815. * Serializes the particle system to a JSON object.
  92816. * @returns the JSON object
  92817. */
  92818. serialize(): any;
  92819. /**
  92820. * Parse properties from a JSON object
  92821. * @param serializationObject defines the JSON object
  92822. * @param scene defines the hosting scene
  92823. */
  92824. parse(serializationObject: any, scene: Nullable<Scene>): void;
  92825. }
  92826. }
  92827. declare module BABYLON {
  92828. /**
  92829. * Particle emitter emitting particles from the inside of a box.
  92830. * It emits the particles randomly between 2 given directions.
  92831. */
  92832. export class BoxParticleEmitter implements IParticleEmitterType {
  92833. /**
  92834. * Random direction of each particle after it has been emitted, between direction1 and direction2 vectors.
  92835. */
  92836. direction1: Vector3;
  92837. /**
  92838. * Random direction of each particle after it has been emitted, between direction1 and direction2 vectors.
  92839. */
  92840. direction2: Vector3;
  92841. /**
  92842. * 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.
  92843. */
  92844. minEmitBox: Vector3;
  92845. /**
  92846. * 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.
  92847. */
  92848. maxEmitBox: Vector3;
  92849. /**
  92850. * Creates a new instance BoxParticleEmitter
  92851. */
  92852. constructor();
  92853. /**
  92854. * Called by the particle System when the direction is computed for the created particle.
  92855. * @param worldMatrix is the world matrix of the particle system
  92856. * @param directionToUpdate is the direction vector to update with the result
  92857. * @param particle is the particle we are computed the direction for
  92858. * @param isLocal defines if the direction should be set in local space
  92859. */
  92860. startDirectionFunction(worldMatrix: Matrix, directionToUpdate: Vector3, particle: Particle, isLocal: boolean): void;
  92861. /**
  92862. * Called by the particle System when the position is computed for the created particle.
  92863. * @param worldMatrix is the world matrix of the particle system
  92864. * @param positionToUpdate is the position vector to update with the result
  92865. * @param particle is the particle we are computed the position for
  92866. * @param isLocal defines if the position should be set in local space
  92867. */
  92868. startPositionFunction(worldMatrix: Matrix, positionToUpdate: Vector3, particle: Particle, isLocal: boolean): void;
  92869. /**
  92870. * Clones the current emitter and returns a copy of it
  92871. * @returns the new emitter
  92872. */
  92873. clone(): BoxParticleEmitter;
  92874. /**
  92875. * Called by the GPUParticleSystem to setup the update shader
  92876. * @param effect defines the update shader
  92877. */
  92878. applyToShader(effect: Effect): void;
  92879. /**
  92880. * Returns a string to use to update the GPU particles update shader
  92881. * @returns a string containng the defines string
  92882. */
  92883. getEffectDefines(): string;
  92884. /**
  92885. * Returns the string "BoxParticleEmitter"
  92886. * @returns a string containing the class name
  92887. */
  92888. getClassName(): string;
  92889. /**
  92890. * Serializes the particle system to a JSON object.
  92891. * @returns the JSON object
  92892. */
  92893. serialize(): any;
  92894. /**
  92895. * Parse properties from a JSON object
  92896. * @param serializationObject defines the JSON object
  92897. */
  92898. parse(serializationObject: any): void;
  92899. }
  92900. }
  92901. declare module BABYLON {
  92902. /**
  92903. * Particle emitter emitting particles from the inside of a cone.
  92904. * It emits the particles alongside the cone volume from the base to the particle.
  92905. * The emission direction might be randomized.
  92906. */
  92907. export class ConeParticleEmitter implements IParticleEmitterType {
  92908. /** defines how much to randomize the particle direction [0-1] (default is 0) */
  92909. directionRandomizer: number;
  92910. private _radius;
  92911. private _angle;
  92912. private _height;
  92913. /**
  92914. * Gets or sets a value indicating where on the radius the start position should be picked (1 = everywhere, 0 = only surface)
  92915. */
  92916. radiusRange: number;
  92917. /**
  92918. * Gets or sets a value indicating where on the height the start position should be picked (1 = everywhere, 0 = only surface)
  92919. */
  92920. heightRange: number;
  92921. /**
  92922. * Gets or sets a value indicating if all the particles should be emitted from the spawn point only (the base of the cone)
  92923. */
  92924. emitFromSpawnPointOnly: boolean;
  92925. /**
  92926. * Gets or sets the radius of the emission cone
  92927. */
  92928. get radius(): number;
  92929. set radius(value: number);
  92930. /**
  92931. * Gets or sets the angle of the emission cone
  92932. */
  92933. get angle(): number;
  92934. set angle(value: number);
  92935. private _buildHeight;
  92936. /**
  92937. * Creates a new instance ConeParticleEmitter
  92938. * @param radius the radius of the emission cone (1 by default)
  92939. * @param angle the cone base angle (PI by default)
  92940. * @param directionRandomizer defines how much to randomize the particle direction [0-1] (default is 0)
  92941. */
  92942. constructor(radius?: number, angle?: number,
  92943. /** defines how much to randomize the particle direction [0-1] (default is 0) */
  92944. directionRandomizer?: number);
  92945. /**
  92946. * Called by the particle System when the direction is computed for the created particle.
  92947. * @param worldMatrix is the world matrix of the particle system
  92948. * @param directionToUpdate is the direction vector to update with the result
  92949. * @param particle is the particle we are computed the direction for
  92950. * @param isLocal defines if the direction should be set in local space
  92951. */
  92952. startDirectionFunction(worldMatrix: Matrix, directionToUpdate: Vector3, particle: Particle, isLocal: boolean): void;
  92953. /**
  92954. * Called by the particle System when the position is computed for the created particle.
  92955. * @param worldMatrix is the world matrix of the particle system
  92956. * @param positionToUpdate is the position vector to update with the result
  92957. * @param particle is the particle we are computed the position for
  92958. * @param isLocal defines if the position should be set in local space
  92959. */
  92960. startPositionFunction(worldMatrix: Matrix, positionToUpdate: Vector3, particle: Particle, isLocal: boolean): void;
  92961. /**
  92962. * Clones the current emitter and returns a copy of it
  92963. * @returns the new emitter
  92964. */
  92965. clone(): ConeParticleEmitter;
  92966. /**
  92967. * Called by the GPUParticleSystem to setup the update shader
  92968. * @param effect defines the update shader
  92969. */
  92970. applyToShader(effect: Effect): void;
  92971. /**
  92972. * Returns a string to use to update the GPU particles update shader
  92973. * @returns a string containng the defines string
  92974. */
  92975. getEffectDefines(): string;
  92976. /**
  92977. * Returns the string "ConeParticleEmitter"
  92978. * @returns a string containing the class name
  92979. */
  92980. getClassName(): string;
  92981. /**
  92982. * Serializes the particle system to a JSON object.
  92983. * @returns the JSON object
  92984. */
  92985. serialize(): any;
  92986. /**
  92987. * Parse properties from a JSON object
  92988. * @param serializationObject defines the JSON object
  92989. */
  92990. parse(serializationObject: any): void;
  92991. }
  92992. }
  92993. declare module BABYLON {
  92994. /**
  92995. * Particle emitter emitting particles from the inside of a cylinder.
  92996. * It emits the particles alongside the cylinder radius. The emission direction might be randomized.
  92997. */
  92998. export class CylinderParticleEmitter implements IParticleEmitterType {
  92999. /**
  93000. * The radius of the emission cylinder.
  93001. */
  93002. radius: number;
  93003. /**
  93004. * The height of the emission cylinder.
  93005. */
  93006. height: number;
  93007. /**
  93008. * The range of emission [0-1] 0 Surface only, 1 Entire Radius.
  93009. */
  93010. radiusRange: number;
  93011. /**
  93012. * How much to randomize the particle direction [0-1].
  93013. */
  93014. directionRandomizer: number;
  93015. /**
  93016. * Creates a new instance CylinderParticleEmitter
  93017. * @param radius the radius of the emission cylinder (1 by default)
  93018. * @param height the height of the emission cylinder (1 by default)
  93019. * @param radiusRange the range of the emission cylinder [0-1] 0 Surface only, 1 Entire Radius (1 by default)
  93020. * @param directionRandomizer defines how much to randomize the particle direction [0-1]
  93021. */
  93022. constructor(
  93023. /**
  93024. * The radius of the emission cylinder.
  93025. */
  93026. radius?: number,
  93027. /**
  93028. * The height of the emission cylinder.
  93029. */
  93030. height?: number,
  93031. /**
  93032. * The range of emission [0-1] 0 Surface only, 1 Entire Radius.
  93033. */
  93034. radiusRange?: number,
  93035. /**
  93036. * How much to randomize the particle direction [0-1].
  93037. */
  93038. directionRandomizer?: number);
  93039. /**
  93040. * Called by the particle System when the direction is computed for the created particle.
  93041. * @param worldMatrix is the world matrix of the particle system
  93042. * @param directionToUpdate is the direction vector to update with the result
  93043. * @param particle is the particle we are computed the direction for
  93044. * @param isLocal defines if the direction should be set in local space
  93045. */
  93046. startDirectionFunction(worldMatrix: Matrix, directionToUpdate: Vector3, particle: Particle, isLocal: boolean): void;
  93047. /**
  93048. * Called by the particle System when the position is computed for the created particle.
  93049. * @param worldMatrix is the world matrix of the particle system
  93050. * @param positionToUpdate is the position vector to update with the result
  93051. * @param particle is the particle we are computed the position for
  93052. * @param isLocal defines if the position should be set in local space
  93053. */
  93054. startPositionFunction(worldMatrix: Matrix, positionToUpdate: Vector3, particle: Particle, isLocal: boolean): void;
  93055. /**
  93056. * Clones the current emitter and returns a copy of it
  93057. * @returns the new emitter
  93058. */
  93059. clone(): CylinderParticleEmitter;
  93060. /**
  93061. * Called by the GPUParticleSystem to setup the update shader
  93062. * @param effect defines the update shader
  93063. */
  93064. applyToShader(effect: Effect): void;
  93065. /**
  93066. * Returns a string to use to update the GPU particles update shader
  93067. * @returns a string containng the defines string
  93068. */
  93069. getEffectDefines(): string;
  93070. /**
  93071. * Returns the string "CylinderParticleEmitter"
  93072. * @returns a string containing the class name
  93073. */
  93074. getClassName(): string;
  93075. /**
  93076. * Serializes the particle system to a JSON object.
  93077. * @returns the JSON object
  93078. */
  93079. serialize(): any;
  93080. /**
  93081. * Parse properties from a JSON object
  93082. * @param serializationObject defines the JSON object
  93083. */
  93084. parse(serializationObject: any): void;
  93085. }
  93086. /**
  93087. * Particle emitter emitting particles from the inside of a cylinder.
  93088. * It emits the particles randomly between two vectors.
  93089. */
  93090. export class CylinderDirectedParticleEmitter extends CylinderParticleEmitter {
  93091. /**
  93092. * The min limit of the emission direction.
  93093. */
  93094. direction1: Vector3;
  93095. /**
  93096. * The max limit of the emission direction.
  93097. */
  93098. direction2: Vector3;
  93099. /**
  93100. * Creates a new instance CylinderDirectedParticleEmitter
  93101. * @param radius the radius of the emission cylinder (1 by default)
  93102. * @param height the height of the emission cylinder (1 by default)
  93103. * @param radiusRange the range of the emission cylinder [0-1] 0 Surface only, 1 Entire Radius (1 by default)
  93104. * @param direction1 the min limit of the emission direction (up vector by default)
  93105. * @param direction2 the max limit of the emission direction (up vector by default)
  93106. */
  93107. constructor(radius?: number, height?: number, radiusRange?: number,
  93108. /**
  93109. * The min limit of the emission direction.
  93110. */
  93111. direction1?: Vector3,
  93112. /**
  93113. * The max limit of the emission direction.
  93114. */
  93115. direction2?: Vector3);
  93116. /**
  93117. * Called by the particle System when the direction is computed for the created particle.
  93118. * @param worldMatrix is the world matrix of the particle system
  93119. * @param directionToUpdate is the direction vector to update with the result
  93120. * @param particle is the particle we are computed the direction for
  93121. */
  93122. startDirectionFunction(worldMatrix: Matrix, directionToUpdate: Vector3, particle: Particle): void;
  93123. /**
  93124. * Clones the current emitter and returns a copy of it
  93125. * @returns the new emitter
  93126. */
  93127. clone(): CylinderDirectedParticleEmitter;
  93128. /**
  93129. * Called by the GPUParticleSystem to setup the update shader
  93130. * @param effect defines the update shader
  93131. */
  93132. applyToShader(effect: Effect): void;
  93133. /**
  93134. * Returns a string to use to update the GPU particles update shader
  93135. * @returns a string containng the defines string
  93136. */
  93137. getEffectDefines(): string;
  93138. /**
  93139. * Returns the string "CylinderDirectedParticleEmitter"
  93140. * @returns a string containing the class name
  93141. */
  93142. getClassName(): string;
  93143. /**
  93144. * Serializes the particle system to a JSON object.
  93145. * @returns the JSON object
  93146. */
  93147. serialize(): any;
  93148. /**
  93149. * Parse properties from a JSON object
  93150. * @param serializationObject defines the JSON object
  93151. */
  93152. parse(serializationObject: any): void;
  93153. }
  93154. }
  93155. declare module BABYLON {
  93156. /**
  93157. * Particle emitter emitting particles from the inside of a hemisphere.
  93158. * It emits the particles alongside the hemisphere radius. The emission direction might be randomized.
  93159. */
  93160. export class HemisphericParticleEmitter implements IParticleEmitterType {
  93161. /**
  93162. * The radius of the emission hemisphere.
  93163. */
  93164. radius: number;
  93165. /**
  93166. * The range of emission [0-1] 0 Surface only, 1 Entire Radius.
  93167. */
  93168. radiusRange: number;
  93169. /**
  93170. * How much to randomize the particle direction [0-1].
  93171. */
  93172. directionRandomizer: number;
  93173. /**
  93174. * Creates a new instance HemisphericParticleEmitter
  93175. * @param radius the radius of the emission hemisphere (1 by default)
  93176. * @param radiusRange the range of the emission hemisphere [0-1] 0 Surface only, 1 Entire Radius (1 by default)
  93177. * @param directionRandomizer defines how much to randomize the particle direction [0-1]
  93178. */
  93179. constructor(
  93180. /**
  93181. * The radius of the emission hemisphere.
  93182. */
  93183. radius?: number,
  93184. /**
  93185. * The range of emission [0-1] 0 Surface only, 1 Entire Radius.
  93186. */
  93187. radiusRange?: number,
  93188. /**
  93189. * How much to randomize the particle direction [0-1].
  93190. */
  93191. directionRandomizer?: number);
  93192. /**
  93193. * Called by the particle System when the direction is computed for the created particle.
  93194. * @param worldMatrix is the world matrix of the particle system
  93195. * @param directionToUpdate is the direction vector to update with the result
  93196. * @param particle is the particle we are computed the direction for
  93197. * @param isLocal defines if the direction should be set in local space
  93198. */
  93199. startDirectionFunction(worldMatrix: Matrix, directionToUpdate: Vector3, particle: Particle, isLocal: boolean): void;
  93200. /**
  93201. * Called by the particle System when the position is computed for the created particle.
  93202. * @param worldMatrix is the world matrix of the particle system
  93203. * @param positionToUpdate is the position vector to update with the result
  93204. * @param particle is the particle we are computed the position for
  93205. * @param isLocal defines if the position should be set in local space
  93206. */
  93207. startPositionFunction(worldMatrix: Matrix, positionToUpdate: Vector3, particle: Particle, isLocal: boolean): void;
  93208. /**
  93209. * Clones the current emitter and returns a copy of it
  93210. * @returns the new emitter
  93211. */
  93212. clone(): HemisphericParticleEmitter;
  93213. /**
  93214. * Called by the GPUParticleSystem to setup the update shader
  93215. * @param effect defines the update shader
  93216. */
  93217. applyToShader(effect: Effect): void;
  93218. /**
  93219. * Returns a string to use to update the GPU particles update shader
  93220. * @returns a string containng the defines string
  93221. */
  93222. getEffectDefines(): string;
  93223. /**
  93224. * Returns the string "HemisphericParticleEmitter"
  93225. * @returns a string containing the class name
  93226. */
  93227. getClassName(): string;
  93228. /**
  93229. * Serializes the particle system to a JSON object.
  93230. * @returns the JSON object
  93231. */
  93232. serialize(): any;
  93233. /**
  93234. * Parse properties from a JSON object
  93235. * @param serializationObject defines the JSON object
  93236. */
  93237. parse(serializationObject: any): void;
  93238. }
  93239. }
  93240. declare module BABYLON {
  93241. /**
  93242. * Particle emitter emitting particles from a point.
  93243. * It emits the particles randomly between 2 given directions.
  93244. */
  93245. export class PointParticleEmitter implements IParticleEmitterType {
  93246. /**
  93247. * Random direction of each particle after it has been emitted, between direction1 and direction2 vectors.
  93248. */
  93249. direction1: Vector3;
  93250. /**
  93251. * Random direction of each particle after it has been emitted, between direction1 and direction2 vectors.
  93252. */
  93253. direction2: Vector3;
  93254. /**
  93255. * Creates a new instance PointParticleEmitter
  93256. */
  93257. constructor();
  93258. /**
  93259. * Called by the particle System when the direction is computed for the created particle.
  93260. * @param worldMatrix is the world matrix of the particle system
  93261. * @param directionToUpdate is the direction vector to update with the result
  93262. * @param particle is the particle we are computed the direction for
  93263. * @param isLocal defines if the direction should be set in local space
  93264. */
  93265. startDirectionFunction(worldMatrix: Matrix, directionToUpdate: Vector3, particle: Particle, isLocal: boolean): void;
  93266. /**
  93267. * Called by the particle System when the position is computed for the created particle.
  93268. * @param worldMatrix is the world matrix of the particle system
  93269. * @param positionToUpdate is the position vector to update with the result
  93270. * @param particle is the particle we are computed the position for
  93271. * @param isLocal defines if the position should be set in local space
  93272. */
  93273. startPositionFunction(worldMatrix: Matrix, positionToUpdate: Vector3, particle: Particle, isLocal: boolean): void;
  93274. /**
  93275. * Clones the current emitter and returns a copy of it
  93276. * @returns the new emitter
  93277. */
  93278. clone(): PointParticleEmitter;
  93279. /**
  93280. * Called by the GPUParticleSystem to setup the update shader
  93281. * @param effect defines the update shader
  93282. */
  93283. applyToShader(effect: Effect): void;
  93284. /**
  93285. * Returns a string to use to update the GPU particles update shader
  93286. * @returns a string containng the defines string
  93287. */
  93288. getEffectDefines(): string;
  93289. /**
  93290. * Returns the string "PointParticleEmitter"
  93291. * @returns a string containing the class name
  93292. */
  93293. getClassName(): string;
  93294. /**
  93295. * Serializes the particle system to a JSON object.
  93296. * @returns the JSON object
  93297. */
  93298. serialize(): any;
  93299. /**
  93300. * Parse properties from a JSON object
  93301. * @param serializationObject defines the JSON object
  93302. */
  93303. parse(serializationObject: any): void;
  93304. }
  93305. }
  93306. declare module BABYLON {
  93307. /**
  93308. * Particle emitter emitting particles from the inside of a sphere.
  93309. * It emits the particles alongside the sphere radius. The emission direction might be randomized.
  93310. */
  93311. export class SphereParticleEmitter implements IParticleEmitterType {
  93312. /**
  93313. * The radius of the emission sphere.
  93314. */
  93315. radius: number;
  93316. /**
  93317. * The range of emission [0-1] 0 Surface only, 1 Entire Radius.
  93318. */
  93319. radiusRange: number;
  93320. /**
  93321. * How much to randomize the particle direction [0-1].
  93322. */
  93323. directionRandomizer: number;
  93324. /**
  93325. * Creates a new instance SphereParticleEmitter
  93326. * @param radius the radius of the emission sphere (1 by default)
  93327. * @param radiusRange the range of the emission sphere [0-1] 0 Surface only, 1 Entire Radius (1 by default)
  93328. * @param directionRandomizer defines how much to randomize the particle direction [0-1]
  93329. */
  93330. constructor(
  93331. /**
  93332. * The radius of the emission sphere.
  93333. */
  93334. radius?: number,
  93335. /**
  93336. * The range of emission [0-1] 0 Surface only, 1 Entire Radius.
  93337. */
  93338. radiusRange?: number,
  93339. /**
  93340. * How much to randomize the particle direction [0-1].
  93341. */
  93342. directionRandomizer?: number);
  93343. /**
  93344. * Called by the particle System when the direction is computed for the created particle.
  93345. * @param worldMatrix is the world matrix of the particle system
  93346. * @param directionToUpdate is the direction vector to update with the result
  93347. * @param particle is the particle we are computed the direction for
  93348. * @param isLocal defines if the direction should be set in local space
  93349. */
  93350. startDirectionFunction(worldMatrix: Matrix, directionToUpdate: Vector3, particle: Particle, isLocal: boolean): void;
  93351. /**
  93352. * Called by the particle System when the position is computed for the created particle.
  93353. * @param worldMatrix is the world matrix of the particle system
  93354. * @param positionToUpdate is the position vector to update with the result
  93355. * @param particle is the particle we are computed the position for
  93356. * @param isLocal defines if the position should be set in local space
  93357. */
  93358. startPositionFunction(worldMatrix: Matrix, positionToUpdate: Vector3, particle: Particle, isLocal: boolean): void;
  93359. /**
  93360. * Clones the current emitter and returns a copy of it
  93361. * @returns the new emitter
  93362. */
  93363. clone(): SphereParticleEmitter;
  93364. /**
  93365. * Called by the GPUParticleSystem to setup the update shader
  93366. * @param effect defines the update shader
  93367. */
  93368. applyToShader(effect: Effect): void;
  93369. /**
  93370. * Returns a string to use to update the GPU particles update shader
  93371. * @returns a string containng the defines string
  93372. */
  93373. getEffectDefines(): string;
  93374. /**
  93375. * Returns the string "SphereParticleEmitter"
  93376. * @returns a string containing the class name
  93377. */
  93378. getClassName(): string;
  93379. /**
  93380. * Serializes the particle system to a JSON object.
  93381. * @returns the JSON object
  93382. */
  93383. serialize(): any;
  93384. /**
  93385. * Parse properties from a JSON object
  93386. * @param serializationObject defines the JSON object
  93387. */
  93388. parse(serializationObject: any): void;
  93389. }
  93390. /**
  93391. * Particle emitter emitting particles from the inside of a sphere.
  93392. * It emits the particles randomly between two vectors.
  93393. */
  93394. export class SphereDirectedParticleEmitter extends SphereParticleEmitter {
  93395. /**
  93396. * The min limit of the emission direction.
  93397. */
  93398. direction1: Vector3;
  93399. /**
  93400. * The max limit of the emission direction.
  93401. */
  93402. direction2: Vector3;
  93403. /**
  93404. * Creates a new instance SphereDirectedParticleEmitter
  93405. * @param radius the radius of the emission sphere (1 by default)
  93406. * @param direction1 the min limit of the emission direction (up vector by default)
  93407. * @param direction2 the max limit of the emission direction (up vector by default)
  93408. */
  93409. constructor(radius?: number,
  93410. /**
  93411. * The min limit of the emission direction.
  93412. */
  93413. direction1?: Vector3,
  93414. /**
  93415. * The max limit of the emission direction.
  93416. */
  93417. direction2?: Vector3);
  93418. /**
  93419. * Called by the particle System when the direction is computed for the created particle.
  93420. * @param worldMatrix is the world matrix of the particle system
  93421. * @param directionToUpdate is the direction vector to update with the result
  93422. * @param particle is the particle we are computed the direction for
  93423. */
  93424. startDirectionFunction(worldMatrix: Matrix, directionToUpdate: Vector3, particle: Particle): void;
  93425. /**
  93426. * Clones the current emitter and returns a copy of it
  93427. * @returns the new emitter
  93428. */
  93429. clone(): SphereDirectedParticleEmitter;
  93430. /**
  93431. * Called by the GPUParticleSystem to setup the update shader
  93432. * @param effect defines the update shader
  93433. */
  93434. applyToShader(effect: Effect): void;
  93435. /**
  93436. * Returns a string to use to update the GPU particles update shader
  93437. * @returns a string containng the defines string
  93438. */
  93439. getEffectDefines(): string;
  93440. /**
  93441. * Returns the string "SphereDirectedParticleEmitter"
  93442. * @returns a string containing the class name
  93443. */
  93444. getClassName(): string;
  93445. /**
  93446. * Serializes the particle system to a JSON object.
  93447. * @returns the JSON object
  93448. */
  93449. serialize(): any;
  93450. /**
  93451. * Parse properties from a JSON object
  93452. * @param serializationObject defines the JSON object
  93453. */
  93454. parse(serializationObject: any): void;
  93455. }
  93456. }
  93457. declare module BABYLON {
  93458. /**
  93459. * Particle emitter emitting particles from a custom list of positions.
  93460. */
  93461. export class CustomParticleEmitter implements IParticleEmitterType {
  93462. /**
  93463. * Gets or sets the position generator that will create the inital position of each particle.
  93464. * Index will be provided when used with GPU particle. Particle will be provided when used with CPU particles
  93465. */
  93466. particlePositionGenerator: (index: number, particle: Nullable<Particle>, outPosition: Vector3) => void;
  93467. /**
  93468. * Gets or sets the destination generator that will create the final destination of each particle.
  93469. * * Index will be provided when used with GPU particle. Particle will be provided when used with CPU particles
  93470. */
  93471. particleDestinationGenerator: (index: number, particle: Nullable<Particle>, outDestination: Vector3) => void;
  93472. /**
  93473. * Creates a new instance CustomParticleEmitter
  93474. */
  93475. constructor();
  93476. /**
  93477. * Called by the particle System when the direction is computed for the created particle.
  93478. * @param worldMatrix is the world matrix of the particle system
  93479. * @param directionToUpdate is the direction vector to update with the result
  93480. * @param particle is the particle we are computed the direction for
  93481. * @param isLocal defines if the direction should be set in local space
  93482. */
  93483. startDirectionFunction(worldMatrix: Matrix, directionToUpdate: Vector3, particle: Particle, isLocal: boolean): void;
  93484. /**
  93485. * Called by the particle System when the position is computed for the created particle.
  93486. * @param worldMatrix is the world matrix of the particle system
  93487. * @param positionToUpdate is the position vector to update with the result
  93488. * @param particle is the particle we are computed the position for
  93489. * @param isLocal defines if the position should be set in local space
  93490. */
  93491. startPositionFunction(worldMatrix: Matrix, positionToUpdate: Vector3, particle: Particle, isLocal: boolean): void;
  93492. /**
  93493. * Clones the current emitter and returns a copy of it
  93494. * @returns the new emitter
  93495. */
  93496. clone(): CustomParticleEmitter;
  93497. /**
  93498. * Called by the GPUParticleSystem to setup the update shader
  93499. * @param effect defines the update shader
  93500. */
  93501. applyToShader(effect: Effect): void;
  93502. /**
  93503. * Returns a string to use to update the GPU particles update shader
  93504. * @returns a string containng the defines string
  93505. */
  93506. getEffectDefines(): string;
  93507. /**
  93508. * Returns the string "PointParticleEmitter"
  93509. * @returns a string containing the class name
  93510. */
  93511. getClassName(): string;
  93512. /**
  93513. * Serializes the particle system to a JSON object.
  93514. * @returns the JSON object
  93515. */
  93516. serialize(): any;
  93517. /**
  93518. * Parse properties from a JSON object
  93519. * @param serializationObject defines the JSON object
  93520. */
  93521. parse(serializationObject: any): void;
  93522. }
  93523. }
  93524. declare module BABYLON {
  93525. /**
  93526. * Particle emitter emitting particles from the inside of a box.
  93527. * It emits the particles randomly between 2 given directions.
  93528. */
  93529. export class MeshParticleEmitter implements IParticleEmitterType {
  93530. private _indices;
  93531. private _positions;
  93532. private _normals;
  93533. private _storedNormal;
  93534. private _mesh;
  93535. /**
  93536. * Random direction of each particle after it has been emitted, between direction1 and direction2 vectors.
  93537. */
  93538. direction1: Vector3;
  93539. /**
  93540. * Random direction of each particle after it has been emitted, between direction1 and direction2 vectors.
  93541. */
  93542. direction2: Vector3;
  93543. /**
  93544. * Gets or sets a boolean indicating that particle directions must be built from mesh face normals
  93545. */
  93546. useMeshNormalsForDirection: boolean;
  93547. /** Defines the mesh to use as source */
  93548. get mesh(): Nullable<AbstractMesh>;
  93549. set mesh(value: Nullable<AbstractMesh>);
  93550. /**
  93551. * Creates a new instance MeshParticleEmitter
  93552. * @param mesh defines the mesh to use as source
  93553. */
  93554. constructor(mesh?: Nullable<AbstractMesh>);
  93555. /**
  93556. * Called by the particle System when the direction is computed for the created particle.
  93557. * @param worldMatrix is the world matrix of the particle system
  93558. * @param directionToUpdate is the direction vector to update with the result
  93559. * @param particle is the particle we are computed the direction for
  93560. * @param isLocal defines if the direction should be set in local space
  93561. */
  93562. startDirectionFunction(worldMatrix: Matrix, directionToUpdate: Vector3, particle: Particle, isLocal: boolean): void;
  93563. /**
  93564. * Called by the particle System when the position is computed for the created particle.
  93565. * @param worldMatrix is the world matrix of the particle system
  93566. * @param positionToUpdate is the position vector to update with the result
  93567. * @param particle is the particle we are computed the position for
  93568. * @param isLocal defines if the position should be set in local space
  93569. */
  93570. startPositionFunction(worldMatrix: Matrix, positionToUpdate: Vector3, particle: Particle, isLocal: boolean): void;
  93571. /**
  93572. * Clones the current emitter and returns a copy of it
  93573. * @returns the new emitter
  93574. */
  93575. clone(): MeshParticleEmitter;
  93576. /**
  93577. * Called by the GPUParticleSystem to setup the update shader
  93578. * @param effect defines the update shader
  93579. */
  93580. applyToShader(effect: Effect): void;
  93581. /**
  93582. * Returns a string to use to update the GPU particles update shader
  93583. * @returns a string containng the defines string
  93584. */
  93585. getEffectDefines(): string;
  93586. /**
  93587. * Returns the string "BoxParticleEmitter"
  93588. * @returns a string containing the class name
  93589. */
  93590. getClassName(): string;
  93591. /**
  93592. * Serializes the particle system to a JSON object.
  93593. * @returns the JSON object
  93594. */
  93595. serialize(): any;
  93596. /**
  93597. * Parse properties from a JSON object
  93598. * @param serializationObject defines the JSON object
  93599. * @param scene defines the hosting scene
  93600. */
  93601. parse(serializationObject: any, scene: Nullable<Scene>): void;
  93602. }
  93603. }
  93604. declare module BABYLON {
  93605. /**
  93606. * Interface representing a particle system in Babylon.js.
  93607. * This groups the common functionalities that needs to be implemented in order to create a particle system.
  93608. * A particle system represents a way to manage particles from their emission to their animation and rendering.
  93609. */
  93610. export interface IParticleSystem {
  93611. /**
  93612. * List of animations used by the particle system.
  93613. */
  93614. animations: Animation[];
  93615. /**
  93616. * The id of the Particle system.
  93617. */
  93618. id: string;
  93619. /**
  93620. * The name of the Particle system.
  93621. */
  93622. name: string;
  93623. /**
  93624. * The emitter represents the Mesh or position we are attaching the particle system to.
  93625. */
  93626. emitter: Nullable<AbstractMesh | Vector3>;
  93627. /**
  93628. * Gets or sets a boolean indicating if the particles must be rendered as billboard or aligned with the direction
  93629. */
  93630. isBillboardBased: boolean;
  93631. /**
  93632. * The rendering group used by the Particle system to chose when to render.
  93633. */
  93634. renderingGroupId: number;
  93635. /**
  93636. * The layer mask we are rendering the particles through.
  93637. */
  93638. layerMask: number;
  93639. /**
  93640. * The overall motion speed (0.01 is default update speed, faster updates = faster animation)
  93641. */
  93642. updateSpeed: number;
  93643. /**
  93644. * The amount of time the particle system is running (depends of the overall update speed).
  93645. */
  93646. targetStopDuration: number;
  93647. /**
  93648. * The texture used to render each particle. (this can be a spritesheet)
  93649. */
  93650. particleTexture: Nullable<BaseTexture>;
  93651. /**
  93652. * Blend mode use to render the particle, it can be either ParticleSystem.BLENDMODE_ONEONE, ParticleSystem.BLENDMODE_STANDARD or ParticleSystem.BLENDMODE_ADD.
  93653. */
  93654. blendMode: number;
  93655. /**
  93656. * Minimum life time of emitting particles.
  93657. */
  93658. minLifeTime: number;
  93659. /**
  93660. * Maximum life time of emitting particles.
  93661. */
  93662. maxLifeTime: number;
  93663. /**
  93664. * Minimum Size of emitting particles.
  93665. */
  93666. minSize: number;
  93667. /**
  93668. * Maximum Size of emitting particles.
  93669. */
  93670. maxSize: number;
  93671. /**
  93672. * Minimum scale of emitting particles on X axis.
  93673. */
  93674. minScaleX: number;
  93675. /**
  93676. * Maximum scale of emitting particles on X axis.
  93677. */
  93678. maxScaleX: number;
  93679. /**
  93680. * Minimum scale of emitting particles on Y axis.
  93681. */
  93682. minScaleY: number;
  93683. /**
  93684. * Maximum scale of emitting particles on Y axis.
  93685. */
  93686. maxScaleY: number;
  93687. /**
  93688. * Random color of each particle after it has been emitted, between color1 and color2 vectors.
  93689. */
  93690. color1: Color4;
  93691. /**
  93692. * Random color of each particle after it has been emitted, between color1 and color2 vectors.
  93693. */
  93694. color2: Color4;
  93695. /**
  93696. * Color the particle will have at the end of its lifetime.
  93697. */
  93698. colorDead: Color4;
  93699. /**
  93700. * The maximum number of particles to emit per frame until we reach the activeParticleCount value
  93701. */
  93702. emitRate: number;
  93703. /**
  93704. * You can use gravity if you want to give an orientation to your particles.
  93705. */
  93706. gravity: Vector3;
  93707. /**
  93708. * Minimum power of emitting particles.
  93709. */
  93710. minEmitPower: number;
  93711. /**
  93712. * Maximum power of emitting particles.
  93713. */
  93714. maxEmitPower: number;
  93715. /**
  93716. * Minimum angular speed of emitting particles (Z-axis rotation for each particle).
  93717. */
  93718. minAngularSpeed: number;
  93719. /**
  93720. * Maximum angular speed of emitting particles (Z-axis rotation for each particle).
  93721. */
  93722. maxAngularSpeed: number;
  93723. /**
  93724. * Gets or sets the minimal initial rotation in radians.
  93725. */
  93726. minInitialRotation: number;
  93727. /**
  93728. * Gets or sets the maximal initial rotation in radians.
  93729. */
  93730. maxInitialRotation: number;
  93731. /**
  93732. * The particle emitter type defines the emitter used by the particle system.
  93733. * It can be for example box, sphere, or cone...
  93734. */
  93735. particleEmitterType: Nullable<IParticleEmitterType>;
  93736. /**
  93737. * Defines the delay in milliseconds before starting the system (0 by default)
  93738. */
  93739. startDelay: number;
  93740. /**
  93741. * 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
  93742. */
  93743. preWarmCycles: number;
  93744. /**
  93745. * Gets or sets a value indicating the time step multiplier to use in pre-warm mode (default is 1)
  93746. */
  93747. preWarmStepOffset: number;
  93748. /**
  93749. * 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)
  93750. */
  93751. spriteCellChangeSpeed: number;
  93752. /**
  93753. * If using a spritesheet (isAnimationSheetEnabled) defines the first sprite cell to display
  93754. */
  93755. startSpriteCellID: number;
  93756. /**
  93757. * If using a spritesheet (isAnimationSheetEnabled) defines the last sprite cell to display
  93758. */
  93759. endSpriteCellID: number;
  93760. /**
  93761. * If using a spritesheet (isAnimationSheetEnabled), defines the sprite cell width to use
  93762. */
  93763. spriteCellWidth: number;
  93764. /**
  93765. * If using a spritesheet (isAnimationSheetEnabled), defines the sprite cell height to use
  93766. */
  93767. spriteCellHeight: number;
  93768. /**
  93769. * This allows the system to random pick the start cell ID between startSpriteCellID and endSpriteCellID
  93770. */
  93771. spriteRandomStartCell: boolean;
  93772. /**
  93773. * Gets or sets a boolean indicating if a spritesheet is used to animate the particles texture
  93774. */
  93775. isAnimationSheetEnabled: boolean;
  93776. /** Gets or sets a Vector2 used to move the pivot (by default (0,0)) */
  93777. translationPivot: Vector2;
  93778. /**
  93779. * Gets or sets a texture used to add random noise to particle positions
  93780. */
  93781. noiseTexture: Nullable<BaseTexture>;
  93782. /** Gets or sets the strength to apply to the noise value (default is (10, 10, 10)) */
  93783. noiseStrength: Vector3;
  93784. /**
  93785. * Gets or sets the billboard mode to use when isBillboardBased = true.
  93786. * Value can be: ParticleSystem.BILLBOARDMODE_ALL, ParticleSystem.BILLBOARDMODE_Y, ParticleSystem.BILLBOARDMODE_STRETCHED
  93787. */
  93788. billboardMode: number;
  93789. /** Gets or sets a value indicating the damping to apply if the limit velocity factor is reached */
  93790. limitVelocityDamping: number;
  93791. /**
  93792. * Gets or sets a boolean indicating that hosted animations (in the system.animations array) must be started when system.start() is called
  93793. */
  93794. beginAnimationOnStart: boolean;
  93795. /**
  93796. * Gets or sets the frame to start the animation from when beginAnimationOnStart is true
  93797. */
  93798. beginAnimationFrom: number;
  93799. /**
  93800. * Gets or sets the frame to end the animation on when beginAnimationOnStart is true
  93801. */
  93802. beginAnimationTo: number;
  93803. /**
  93804. * Gets or sets a boolean indicating if animations must loop when beginAnimationOnStart is true
  93805. */
  93806. beginAnimationLoop: boolean;
  93807. /**
  93808. * Specifies whether the particle system will be disposed once it reaches the end of the animation.
  93809. */
  93810. disposeOnStop: boolean;
  93811. /**
  93812. * Specifies if the particles are updated in emitter local space or world space
  93813. */
  93814. isLocal: boolean;
  93815. /** Snippet ID if the particle system was created from the snippet server */
  93816. snippetId: string;
  93817. /** Gets or sets a matrix to use to compute projection */
  93818. defaultProjectionMatrix: Matrix;
  93819. /**
  93820. * Gets the maximum number of particles active at the same time.
  93821. * @returns The max number of active particles.
  93822. */
  93823. getCapacity(): number;
  93824. /**
  93825. * Gets the number of particles active at the same time.
  93826. * @returns The number of active particles.
  93827. */
  93828. getActiveCount(): number;
  93829. /**
  93830. * Gets if the system has been started. (Note: this will still be true after stop is called)
  93831. * @returns True if it has been started, otherwise false.
  93832. */
  93833. isStarted(): boolean;
  93834. /**
  93835. * Animates the particle system for this frame.
  93836. */
  93837. animate(): void;
  93838. /**
  93839. * Renders the particle system in its current state.
  93840. * @returns the current number of particles
  93841. */
  93842. render(): number;
  93843. /**
  93844. * Dispose the particle system and frees its associated resources.
  93845. * @param disposeTexture defines if the particule texture must be disposed as well (true by default)
  93846. */
  93847. dispose(disposeTexture?: boolean): void;
  93848. /**
  93849. * An event triggered when the system is disposed
  93850. */
  93851. onDisposeObservable: Observable<IParticleSystem>;
  93852. /**
  93853. * Clones the particle system.
  93854. * @param name The name of the cloned object
  93855. * @param newEmitter The new emitter to use
  93856. * @returns the cloned particle system
  93857. */
  93858. clone(name: string, newEmitter: any): Nullable<IParticleSystem>;
  93859. /**
  93860. * Serializes the particle system to a JSON object
  93861. * @param serializeTexture defines if the texture must be serialized as well
  93862. * @returns the JSON object
  93863. */
  93864. serialize(serializeTexture: boolean): any;
  93865. /**
  93866. * Rebuild the particle system
  93867. */
  93868. rebuild(): void;
  93869. /** Force the system to rebuild all gradients that need to be resync */
  93870. forceRefreshGradients(): void;
  93871. /**
  93872. * Starts the particle system and begins to emit
  93873. * @param delay defines the delay in milliseconds before starting the system (0 by default)
  93874. */
  93875. start(delay?: number): void;
  93876. /**
  93877. * Stops the particle system.
  93878. */
  93879. stop(): void;
  93880. /**
  93881. * Remove all active particles
  93882. */
  93883. reset(): void;
  93884. /**
  93885. * Gets a boolean indicating that the system is stopping
  93886. * @returns true if the system is currently stopping
  93887. */
  93888. isStopping(): boolean;
  93889. /**
  93890. * Is this system ready to be used/rendered
  93891. * @return true if the system is ready
  93892. */
  93893. isReady(): boolean;
  93894. /**
  93895. * Returns the string "ParticleSystem"
  93896. * @returns a string containing the class name
  93897. */
  93898. getClassName(): string;
  93899. /**
  93900. * Gets the custom effect used to render the particles
  93901. * @param blendMode Blend mode for which the effect should be retrieved
  93902. * @returns The effect
  93903. */
  93904. getCustomEffect(blendMode: number): Nullable<Effect>;
  93905. /**
  93906. * Sets the custom effect used to render the particles
  93907. * @param effect The effect to set
  93908. * @param blendMode Blend mode for which the effect should be set
  93909. */
  93910. setCustomEffect(effect: Nullable<Effect>, blendMode: number): void;
  93911. /**
  93912. * Fill the defines array according to the current settings of the particle system
  93913. * @param defines Array to be updated
  93914. * @param blendMode blend mode to take into account when updating the array
  93915. */
  93916. fillDefines(defines: Array<string>, blendMode: number): void;
  93917. /**
  93918. * Fill the uniforms, attributes and samplers arrays according to the current settings of the particle system
  93919. * @param uniforms Uniforms array to fill
  93920. * @param attributes Attributes array to fill
  93921. * @param samplers Samplers array to fill
  93922. */
  93923. fillUniformsAttributesAndSamplerNames(uniforms: Array<string>, attributes: Array<string>, samplers: Array<string>): void;
  93924. /**
  93925. * Observable that will be called just before the particles are drawn
  93926. */
  93927. onBeforeDrawParticlesObservable: Observable<Nullable<Effect>>;
  93928. /**
  93929. * Gets the name of the particle vertex shader
  93930. */
  93931. vertexShaderName: string;
  93932. /**
  93933. * Adds a new color gradient
  93934. * @param gradient defines the gradient to use (between 0 and 1)
  93935. * @param color1 defines the color to affect to the specified gradient
  93936. * @param color2 defines an additional color used to define a range ([color, color2]) with main color to pick the final color from
  93937. * @returns the current particle system
  93938. */
  93939. addColorGradient(gradient: number, color1: Color4, color2?: Color4): IParticleSystem;
  93940. /**
  93941. * Remove a specific color gradient
  93942. * @param gradient defines the gradient to remove
  93943. * @returns the current particle system
  93944. */
  93945. removeColorGradient(gradient: number): IParticleSystem;
  93946. /**
  93947. * Adds a new size gradient
  93948. * @param gradient defines the gradient to use (between 0 and 1)
  93949. * @param factor defines the size factor to affect to the specified gradient
  93950. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  93951. * @returns the current particle system
  93952. */
  93953. addSizeGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  93954. /**
  93955. * Remove a specific size gradient
  93956. * @param gradient defines the gradient to remove
  93957. * @returns the current particle system
  93958. */
  93959. removeSizeGradient(gradient: number): IParticleSystem;
  93960. /**
  93961. * Gets the current list of color gradients.
  93962. * You must use addColorGradient and removeColorGradient to udpate this list
  93963. * @returns the list of color gradients
  93964. */
  93965. getColorGradients(): Nullable<Array<ColorGradient>>;
  93966. /**
  93967. * Gets the current list of size gradients.
  93968. * You must use addSizeGradient and removeSizeGradient to udpate this list
  93969. * @returns the list of size gradients
  93970. */
  93971. getSizeGradients(): Nullable<Array<FactorGradient>>;
  93972. /**
  93973. * Gets the current list of angular speed gradients.
  93974. * You must use addAngularSpeedGradient and removeAngularSpeedGradient to udpate this list
  93975. * @returns the list of angular speed gradients
  93976. */
  93977. getAngularSpeedGradients(): Nullable<Array<FactorGradient>>;
  93978. /**
  93979. * Adds a new angular speed gradient
  93980. * @param gradient defines the gradient to use (between 0 and 1)
  93981. * @param factor defines the angular speed to affect to the specified gradient
  93982. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  93983. * @returns the current particle system
  93984. */
  93985. addAngularSpeedGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  93986. /**
  93987. * Remove a specific angular speed gradient
  93988. * @param gradient defines the gradient to remove
  93989. * @returns the current particle system
  93990. */
  93991. removeAngularSpeedGradient(gradient: number): IParticleSystem;
  93992. /**
  93993. * Gets the current list of velocity gradients.
  93994. * You must use addVelocityGradient and removeVelocityGradient to udpate this list
  93995. * @returns the list of velocity gradients
  93996. */
  93997. getVelocityGradients(): Nullable<Array<FactorGradient>>;
  93998. /**
  93999. * Adds a new velocity gradient
  94000. * @param gradient defines the gradient to use (between 0 and 1)
  94001. * @param factor defines the velocity to affect to the specified gradient
  94002. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  94003. * @returns the current particle system
  94004. */
  94005. addVelocityGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  94006. /**
  94007. * Remove a specific velocity gradient
  94008. * @param gradient defines the gradient to remove
  94009. * @returns the current particle system
  94010. */
  94011. removeVelocityGradient(gradient: number): IParticleSystem;
  94012. /**
  94013. * Gets the current list of limit velocity gradients.
  94014. * You must use addLimitVelocityGradient and removeLimitVelocityGradient to udpate this list
  94015. * @returns the list of limit velocity gradients
  94016. */
  94017. getLimitVelocityGradients(): Nullable<Array<FactorGradient>>;
  94018. /**
  94019. * Adds a new limit velocity gradient
  94020. * @param gradient defines the gradient to use (between 0 and 1)
  94021. * @param factor defines the limit velocity to affect to the specified gradient
  94022. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  94023. * @returns the current particle system
  94024. */
  94025. addLimitVelocityGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  94026. /**
  94027. * Remove a specific limit velocity gradient
  94028. * @param gradient defines the gradient to remove
  94029. * @returns the current particle system
  94030. */
  94031. removeLimitVelocityGradient(gradient: number): IParticleSystem;
  94032. /**
  94033. * Adds a new drag gradient
  94034. * @param gradient defines the gradient to use (between 0 and 1)
  94035. * @param factor defines the drag to affect to the specified gradient
  94036. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  94037. * @returns the current particle system
  94038. */
  94039. addDragGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  94040. /**
  94041. * Remove a specific drag gradient
  94042. * @param gradient defines the gradient to remove
  94043. * @returns the current particle system
  94044. */
  94045. removeDragGradient(gradient: number): IParticleSystem;
  94046. /**
  94047. * Gets the current list of drag gradients.
  94048. * You must use addDragGradient and removeDragGradient to udpate this list
  94049. * @returns the list of drag gradients
  94050. */
  94051. getDragGradients(): Nullable<Array<FactorGradient>>;
  94052. /**
  94053. * Adds a new emit rate gradient (please note that this will only work if you set the targetStopDuration property)
  94054. * @param gradient defines the gradient to use (between 0 and 1)
  94055. * @param factor defines the emit rate to affect to the specified gradient
  94056. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  94057. * @returns the current particle system
  94058. */
  94059. addEmitRateGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  94060. /**
  94061. * Remove a specific emit rate gradient
  94062. * @param gradient defines the gradient to remove
  94063. * @returns the current particle system
  94064. */
  94065. removeEmitRateGradient(gradient: number): IParticleSystem;
  94066. /**
  94067. * Gets the current list of emit rate gradients.
  94068. * You must use addEmitRateGradient and removeEmitRateGradient to udpate this list
  94069. * @returns the list of emit rate gradients
  94070. */
  94071. getEmitRateGradients(): Nullable<Array<FactorGradient>>;
  94072. /**
  94073. * Adds a new start size gradient (please note that this will only work if you set the targetStopDuration property)
  94074. * @param gradient defines the gradient to use (between 0 and 1)
  94075. * @param factor defines the start size to affect to the specified gradient
  94076. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  94077. * @returns the current particle system
  94078. */
  94079. addStartSizeGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  94080. /**
  94081. * Remove a specific start size gradient
  94082. * @param gradient defines the gradient to remove
  94083. * @returns the current particle system
  94084. */
  94085. removeStartSizeGradient(gradient: number): IParticleSystem;
  94086. /**
  94087. * Gets the current list of start size gradients.
  94088. * You must use addStartSizeGradient and removeStartSizeGradient to udpate this list
  94089. * @returns the list of start size gradients
  94090. */
  94091. getStartSizeGradients(): Nullable<Array<FactorGradient>>;
  94092. /**
  94093. * Adds a new life time gradient
  94094. * @param gradient defines the gradient to use (between 0 and 1)
  94095. * @param factor defines the life time factor to affect to the specified gradient
  94096. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  94097. * @returns the current particle system
  94098. */
  94099. addLifeTimeGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  94100. /**
  94101. * Remove a specific life time gradient
  94102. * @param gradient defines the gradient to remove
  94103. * @returns the current particle system
  94104. */
  94105. removeLifeTimeGradient(gradient: number): IParticleSystem;
  94106. /**
  94107. * Gets the current list of life time gradients.
  94108. * You must use addLifeTimeGradient and removeLifeTimeGradient to udpate this list
  94109. * @returns the list of life time gradients
  94110. */
  94111. getLifeTimeGradients(): Nullable<Array<FactorGradient>>;
  94112. /**
  94113. * Gets the current list of color gradients.
  94114. * You must use addColorGradient and removeColorGradient to udpate this list
  94115. * @returns the list of color gradients
  94116. */
  94117. getColorGradients(): Nullable<Array<ColorGradient>>;
  94118. /**
  94119. * Adds a new ramp gradient used to remap particle colors
  94120. * @param gradient defines the gradient to use (between 0 and 1)
  94121. * @param color defines the color to affect to the specified gradient
  94122. * @returns the current particle system
  94123. */
  94124. addRampGradient(gradient: number, color: Color3): IParticleSystem;
  94125. /**
  94126. * Gets the current list of ramp gradients.
  94127. * You must use addRampGradient and removeRampGradient to udpate this list
  94128. * @returns the list of ramp gradients
  94129. */
  94130. getRampGradients(): Nullable<Array<Color3Gradient>>;
  94131. /** Gets or sets a boolean indicating that ramp gradients must be used
  94132. * @see https://doc.babylonjs.com/babylon101/particles#ramp-gradients
  94133. */
  94134. useRampGradients: boolean;
  94135. /**
  94136. * Adds a new color remap gradient
  94137. * @param gradient defines the gradient to use (between 0 and 1)
  94138. * @param min defines the color remap minimal range
  94139. * @param max defines the color remap maximal range
  94140. * @returns the current particle system
  94141. */
  94142. addColorRemapGradient(gradient: number, min: number, max: number): IParticleSystem;
  94143. /**
  94144. * Gets the current list of color remap gradients.
  94145. * You must use addColorRemapGradient and removeColorRemapGradient to udpate this list
  94146. * @returns the list of color remap gradients
  94147. */
  94148. getColorRemapGradients(): Nullable<Array<FactorGradient>>;
  94149. /**
  94150. * Adds a new alpha remap gradient
  94151. * @param gradient defines the gradient to use (between 0 and 1)
  94152. * @param min defines the alpha remap minimal range
  94153. * @param max defines the alpha remap maximal range
  94154. * @returns the current particle system
  94155. */
  94156. addAlphaRemapGradient(gradient: number, min: number, max: number): IParticleSystem;
  94157. /**
  94158. * Gets the current list of alpha remap gradients.
  94159. * You must use addAlphaRemapGradient and removeAlphaRemapGradient to udpate this list
  94160. * @returns the list of alpha remap gradients
  94161. */
  94162. getAlphaRemapGradients(): Nullable<Array<FactorGradient>>;
  94163. /**
  94164. * Creates a Point Emitter for the particle system (emits directly from the emitter position)
  94165. * @param direction1 Particles are emitted between the direction1 and direction2 from within the box
  94166. * @param direction2 Particles are emitted between the direction1 and direction2 from within the box
  94167. * @returns the emitter
  94168. */
  94169. createPointEmitter(direction1: Vector3, direction2: Vector3): PointParticleEmitter;
  94170. /**
  94171. * Creates a Hemisphere Emitter for the particle system (emits along the hemisphere radius)
  94172. * @param radius The radius of the hemisphere to emit from
  94173. * @param radiusRange The range of the hemisphere to emit from [0-1] 0 Surface Only, 1 Entire Radius
  94174. * @returns the emitter
  94175. */
  94176. createHemisphericEmitter(radius: number, radiusRange: number): HemisphericParticleEmitter;
  94177. /**
  94178. * Creates a Sphere Emitter for the particle system (emits along the sphere radius)
  94179. * @param radius The radius of the sphere to emit from
  94180. * @param radiusRange The range of the sphere to emit from [0-1] 0 Surface Only, 1 Entire Radius
  94181. * @returns the emitter
  94182. */
  94183. createSphereEmitter(radius: number, radiusRange: number): SphereParticleEmitter;
  94184. /**
  94185. * Creates a Directed Sphere Emitter for the particle system (emits between direction1 and direction2)
  94186. * @param radius The radius of the sphere to emit from
  94187. * @param direction1 Particles are emitted between the direction1 and direction2 from within the sphere
  94188. * @param direction2 Particles are emitted between the direction1 and direction2 from within the sphere
  94189. * @returns the emitter
  94190. */
  94191. createDirectedSphereEmitter(radius: number, direction1: Vector3, direction2: Vector3): SphereDirectedParticleEmitter;
  94192. /**
  94193. * Creates a Cylinder Emitter for the particle system (emits from the cylinder to the particle position)
  94194. * @param radius The radius of the emission cylinder
  94195. * @param height The height of the emission cylinder
  94196. * @param radiusRange The range of emission [0-1] 0 Surface only, 1 Entire Radius
  94197. * @param directionRandomizer How much to randomize the particle direction [0-1]
  94198. * @returns the emitter
  94199. */
  94200. createCylinderEmitter(radius: number, height: number, radiusRange: number, directionRandomizer: number): CylinderParticleEmitter;
  94201. /**
  94202. * Creates a Directed Cylinder Emitter for the particle system (emits between direction1 and direction2)
  94203. * @param radius The radius of the cylinder to emit from
  94204. * @param height The height of the emission cylinder
  94205. * @param radiusRange the range of the emission cylinder [0-1] 0 Surface only, 1 Entire Radius (1 by default)
  94206. * @param direction1 Particles are emitted between the direction1 and direction2 from within the cylinder
  94207. * @param direction2 Particles are emitted between the direction1 and direction2 from within the cylinder
  94208. * @returns the emitter
  94209. */
  94210. createDirectedCylinderEmitter(radius: number, height: number, radiusRange: number, direction1: Vector3, direction2: Vector3): SphereDirectedParticleEmitter;
  94211. /**
  94212. * Creates a Cone Emitter for the particle system (emits from the cone to the particle position)
  94213. * @param radius The radius of the cone to emit from
  94214. * @param angle The base angle of the cone
  94215. * @returns the emitter
  94216. */
  94217. createConeEmitter(radius: number, angle: number): ConeParticleEmitter;
  94218. /**
  94219. * Creates a Box Emitter for the particle system. (emits between direction1 and direction2 from withing the box defined by minEmitBox and maxEmitBox)
  94220. * @param direction1 Particles are emitted between the direction1 and direction2 from within the box
  94221. * @param direction2 Particles are emitted between the direction1 and direction2 from within the box
  94222. * @param minEmitBox Particles are emitted from the box between minEmitBox and maxEmitBox
  94223. * @param maxEmitBox Particles are emitted from the box between minEmitBox and maxEmitBox
  94224. * @returns the emitter
  94225. */
  94226. createBoxEmitter(direction1: Vector3, direction2: Vector3, minEmitBox: Vector3, maxEmitBox: Vector3): BoxParticleEmitter;
  94227. /**
  94228. * Get hosting scene
  94229. * @returns the scene
  94230. */
  94231. getScene(): Nullable<Scene>;
  94232. }
  94233. }
  94234. declare module BABYLON {
  94235. /**
  94236. * 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.
  94237. * @see https://doc.babylonjs.com/how_to/transformnode
  94238. */
  94239. export class TransformNode extends Node {
  94240. /**
  94241. * Object will not rotate to face the camera
  94242. */
  94243. static BILLBOARDMODE_NONE: number;
  94244. /**
  94245. * Object will rotate to face the camera but only on the x axis
  94246. */
  94247. static BILLBOARDMODE_X: number;
  94248. /**
  94249. * Object will rotate to face the camera but only on the y axis
  94250. */
  94251. static BILLBOARDMODE_Y: number;
  94252. /**
  94253. * Object will rotate to face the camera but only on the z axis
  94254. */
  94255. static BILLBOARDMODE_Z: number;
  94256. /**
  94257. * Object will rotate to face the camera
  94258. */
  94259. static BILLBOARDMODE_ALL: number;
  94260. /**
  94261. * Object will rotate to face the camera's position instead of orientation
  94262. */
  94263. static BILLBOARDMODE_USE_POSITION: number;
  94264. private static _TmpRotation;
  94265. private static _TmpScaling;
  94266. private static _TmpTranslation;
  94267. private _forward;
  94268. private _forwardInverted;
  94269. private _up;
  94270. private _right;
  94271. private _rightInverted;
  94272. private _position;
  94273. private _rotation;
  94274. private _rotationQuaternion;
  94275. protected _scaling: Vector3;
  94276. protected _isDirty: boolean;
  94277. private _transformToBoneReferal;
  94278. private _isAbsoluteSynced;
  94279. private _billboardMode;
  94280. /**
  94281. * Gets or sets the billboard mode. Default is 0.
  94282. *
  94283. * | Value | Type | Description |
  94284. * | --- | --- | --- |
  94285. * | 0 | BILLBOARDMODE_NONE | |
  94286. * | 1 | BILLBOARDMODE_X | |
  94287. * | 2 | BILLBOARDMODE_Y | |
  94288. * | 4 | BILLBOARDMODE_Z | |
  94289. * | 7 | BILLBOARDMODE_ALL | |
  94290. *
  94291. */
  94292. get billboardMode(): number;
  94293. set billboardMode(value: number);
  94294. private _preserveParentRotationForBillboard;
  94295. /**
  94296. * Gets or sets a boolean indicating that parent rotation should be preserved when using billboards.
  94297. * This could be useful for glTF objects where parent rotation helps converting from right handed to left handed
  94298. */
  94299. get preserveParentRotationForBillboard(): boolean;
  94300. set preserveParentRotationForBillboard(value: boolean);
  94301. /**
  94302. * 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
  94303. */
  94304. scalingDeterminant: number;
  94305. private _infiniteDistance;
  94306. /**
  94307. * Gets or sets the distance of the object to max, often used by skybox
  94308. */
  94309. get infiniteDistance(): boolean;
  94310. set infiniteDistance(value: boolean);
  94311. /**
  94312. * Gets or sets a boolean indicating that non uniform scaling (when at least one component is different from others) should be ignored.
  94313. * By default the system will update normals to compensate
  94314. */
  94315. ignoreNonUniformScaling: boolean;
  94316. /**
  94317. * 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
  94318. */
  94319. reIntegrateRotationIntoRotationQuaternion: boolean;
  94320. /** @hidden */
  94321. _poseMatrix: Nullable<Matrix>;
  94322. /** @hidden */
  94323. _localMatrix: Matrix;
  94324. private _usePivotMatrix;
  94325. private _absolutePosition;
  94326. private _absoluteScaling;
  94327. private _absoluteRotationQuaternion;
  94328. private _pivotMatrix;
  94329. private _pivotMatrixInverse;
  94330. protected _postMultiplyPivotMatrix: boolean;
  94331. protected _isWorldMatrixFrozen: boolean;
  94332. /** @hidden */
  94333. _indexInSceneTransformNodesArray: number;
  94334. /**
  94335. * An event triggered after the world matrix is updated
  94336. */
  94337. onAfterWorldMatrixUpdateObservable: Observable<TransformNode>;
  94338. constructor(name: string, scene?: Nullable<Scene>, isPure?: boolean);
  94339. /**
  94340. * Gets a string identifying the name of the class
  94341. * @returns "TransformNode" string
  94342. */
  94343. getClassName(): string;
  94344. /**
  94345. * Gets or set the node position (default is (0.0, 0.0, 0.0))
  94346. */
  94347. get position(): Vector3;
  94348. set position(newPosition: Vector3);
  94349. /**
  94350. * 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)).
  94351. * If rotation quaternion is set, this Vector3 will be ignored and copy from the quaternion
  94352. */
  94353. get rotation(): Vector3;
  94354. set rotation(newRotation: Vector3);
  94355. /**
  94356. * 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)).
  94357. */
  94358. get scaling(): Vector3;
  94359. set scaling(newScaling: Vector3);
  94360. /**
  94361. * 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).
  94362. * If set, only the rotationQuaternion is then used to compute the node rotation (ie. node.rotation will be ignored)
  94363. */
  94364. get rotationQuaternion(): Nullable<Quaternion>;
  94365. set rotationQuaternion(quaternion: Nullable<Quaternion>);
  94366. /**
  94367. * The forward direction of that transform in world space.
  94368. */
  94369. get forward(): Vector3;
  94370. /**
  94371. * The up direction of that transform in world space.
  94372. */
  94373. get up(): Vector3;
  94374. /**
  94375. * The right direction of that transform in world space.
  94376. */
  94377. get right(): Vector3;
  94378. /**
  94379. * Copies the parameter passed Matrix into the mesh Pose matrix.
  94380. * @param matrix the matrix to copy the pose from
  94381. * @returns this TransformNode.
  94382. */
  94383. updatePoseMatrix(matrix: Matrix): TransformNode;
  94384. /**
  94385. * Returns the mesh Pose matrix.
  94386. * @returns the pose matrix
  94387. */
  94388. getPoseMatrix(): Matrix;
  94389. /** @hidden */
  94390. _isSynchronized(): boolean;
  94391. /** @hidden */
  94392. _initCache(): void;
  94393. /**
  94394. * Flag the transform node as dirty (Forcing it to update everything)
  94395. * @param property if set to "rotation" the objects rotationQuaternion will be set to null
  94396. * @returns this transform node
  94397. */
  94398. markAsDirty(property: string): TransformNode;
  94399. /**
  94400. * Returns the current mesh absolute position.
  94401. * Returns a Vector3.
  94402. */
  94403. get absolutePosition(): Vector3;
  94404. /**
  94405. * Returns the current mesh absolute scaling.
  94406. * Returns a Vector3.
  94407. */
  94408. get absoluteScaling(): Vector3;
  94409. /**
  94410. * Returns the current mesh absolute rotation.
  94411. * Returns a Quaternion.
  94412. */
  94413. get absoluteRotationQuaternion(): Quaternion;
  94414. /**
  94415. * Sets a new matrix to apply before all other transformation
  94416. * @param matrix defines the transform matrix
  94417. * @returns the current TransformNode
  94418. */
  94419. setPreTransformMatrix(matrix: Matrix): TransformNode;
  94420. /**
  94421. * Sets a new pivot matrix to the current node
  94422. * @param matrix defines the new pivot matrix to use
  94423. * @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
  94424. * @returns the current TransformNode
  94425. */
  94426. setPivotMatrix(matrix: DeepImmutable<Matrix>, postMultiplyPivotMatrix?: boolean): TransformNode;
  94427. /**
  94428. * Returns the mesh pivot matrix.
  94429. * Default : Identity.
  94430. * @returns the matrix
  94431. */
  94432. getPivotMatrix(): Matrix;
  94433. /**
  94434. * Instantiate (when possible) or clone that node with its hierarchy
  94435. * @param newParent defines the new parent to use for the instance (or clone)
  94436. * @param options defines options to configure how copy is done
  94437. * @param onNewNodeCreated defines an option callback to call when a clone or an instance is created
  94438. * @returns an instance (or a clone) of the current node with its hiearchy
  94439. */
  94440. instantiateHierarchy(newParent?: Nullable<TransformNode>, options?: {
  94441. doNotInstantiate: boolean;
  94442. }, onNewNodeCreated?: (source: TransformNode, clone: TransformNode) => void): Nullable<TransformNode>;
  94443. /**
  94444. * Prevents the World matrix to be computed any longer
  94445. * @param newWorldMatrix defines an optional matrix to use as world matrix
  94446. * @returns the TransformNode.
  94447. */
  94448. freezeWorldMatrix(newWorldMatrix?: Nullable<Matrix>): TransformNode;
  94449. /**
  94450. * Allows back the World matrix computation.
  94451. * @returns the TransformNode.
  94452. */
  94453. unfreezeWorldMatrix(): this;
  94454. /**
  94455. * True if the World matrix has been frozen.
  94456. */
  94457. get isWorldMatrixFrozen(): boolean;
  94458. /**
  94459. * Retuns the mesh absolute position in the World.
  94460. * @returns a Vector3.
  94461. */
  94462. getAbsolutePosition(): Vector3;
  94463. /**
  94464. * Sets the mesh absolute position in the World from a Vector3 or an Array(3).
  94465. * @param absolutePosition the absolute position to set
  94466. * @returns the TransformNode.
  94467. */
  94468. setAbsolutePosition(absolutePosition: Vector3): TransformNode;
  94469. /**
  94470. * Sets the mesh position in its local space.
  94471. * @param vector3 the position to set in localspace
  94472. * @returns the TransformNode.
  94473. */
  94474. setPositionWithLocalVector(vector3: Vector3): TransformNode;
  94475. /**
  94476. * Returns the mesh position in the local space from the current World matrix values.
  94477. * @returns a new Vector3.
  94478. */
  94479. getPositionExpressedInLocalSpace(): Vector3;
  94480. /**
  94481. * Translates the mesh along the passed Vector3 in its local space.
  94482. * @param vector3 the distance to translate in localspace
  94483. * @returns the TransformNode.
  94484. */
  94485. locallyTranslate(vector3: Vector3): TransformNode;
  94486. private static _lookAtVectorCache;
  94487. /**
  94488. * Orients a mesh towards a target point. Mesh must be drawn facing user.
  94489. * @param targetPoint the position (must be in same space as current mesh) to look at
  94490. * @param yawCor optional yaw (y-axis) correction in radians
  94491. * @param pitchCor optional pitch (x-axis) correction in radians
  94492. * @param rollCor optional roll (z-axis) correction in radians
  94493. * @param space the choosen space of the target
  94494. * @returns the TransformNode.
  94495. */
  94496. lookAt(targetPoint: Vector3, yawCor?: number, pitchCor?: number, rollCor?: number, space?: Space): TransformNode;
  94497. /**
  94498. * Returns a new Vector3 that is the localAxis, expressed in the mesh local space, rotated like the mesh.
  94499. * This Vector3 is expressed in the World space.
  94500. * @param localAxis axis to rotate
  94501. * @returns a new Vector3 that is the localAxis, expressed in the mesh local space, rotated like the mesh.
  94502. */
  94503. getDirection(localAxis: Vector3): Vector3;
  94504. /**
  94505. * Sets the Vector3 "result" as the rotated Vector3 "localAxis" in the same rotation than the mesh.
  94506. * localAxis is expressed in the mesh local space.
  94507. * result is computed in the Wordl space from the mesh World matrix.
  94508. * @param localAxis axis to rotate
  94509. * @param result the resulting transformnode
  94510. * @returns this TransformNode.
  94511. */
  94512. getDirectionToRef(localAxis: Vector3, result: Vector3): TransformNode;
  94513. /**
  94514. * Sets this transform node rotation to the given local axis.
  94515. * @param localAxis the axis in local space
  94516. * @param yawCor optional yaw (y-axis) correction in radians
  94517. * @param pitchCor optional pitch (x-axis) correction in radians
  94518. * @param rollCor optional roll (z-axis) correction in radians
  94519. * @returns this TransformNode
  94520. */
  94521. setDirection(localAxis: Vector3, yawCor?: number, pitchCor?: number, rollCor?: number): TransformNode;
  94522. /**
  94523. * Sets a new pivot point to the current node
  94524. * @param point defines the new pivot point to use
  94525. * @param space defines if the point is in world or local space (local by default)
  94526. * @returns the current TransformNode
  94527. */
  94528. setPivotPoint(point: Vector3, space?: Space): TransformNode;
  94529. /**
  94530. * Returns a new Vector3 set with the mesh pivot point coordinates in the local space.
  94531. * @returns the pivot point
  94532. */
  94533. getPivotPoint(): Vector3;
  94534. /**
  94535. * Sets the passed Vector3 "result" with the coordinates of the mesh pivot point in the local space.
  94536. * @param result the vector3 to store the result
  94537. * @returns this TransformNode.
  94538. */
  94539. getPivotPointToRef(result: Vector3): TransformNode;
  94540. /**
  94541. * Returns a new Vector3 set with the mesh pivot point World coordinates.
  94542. * @returns a new Vector3 set with the mesh pivot point World coordinates.
  94543. */
  94544. getAbsolutePivotPoint(): Vector3;
  94545. /**
  94546. * Sets the Vector3 "result" coordinates with the mesh pivot point World coordinates.
  94547. * @param result vector3 to store the result
  94548. * @returns this TransformNode.
  94549. */
  94550. getAbsolutePivotPointToRef(result: Vector3): TransformNode;
  94551. /**
  94552. * Defines the passed node as the parent of the current node.
  94553. * The node will remain exactly where it is and its position / rotation will be updated accordingly
  94554. * @see https://doc.babylonjs.com/how_to/parenting
  94555. * @param node the node ot set as the parent
  94556. * @returns this TransformNode.
  94557. */
  94558. setParent(node: Nullable<Node>): TransformNode;
  94559. private _nonUniformScaling;
  94560. /**
  94561. * True if the scaling property of this object is non uniform eg. (1,2,1)
  94562. */
  94563. get nonUniformScaling(): boolean;
  94564. /** @hidden */
  94565. _updateNonUniformScalingState(value: boolean): boolean;
  94566. /**
  94567. * Attach the current TransformNode to another TransformNode associated with a bone
  94568. * @param bone Bone affecting the TransformNode
  94569. * @param affectedTransformNode TransformNode associated with the bone
  94570. * @returns this object
  94571. */
  94572. attachToBone(bone: Bone, affectedTransformNode: TransformNode): TransformNode;
  94573. /**
  94574. * Detach the transform node if its associated with a bone
  94575. * @returns this object
  94576. */
  94577. detachFromBone(): TransformNode;
  94578. private static _rotationAxisCache;
  94579. /**
  94580. * Rotates the mesh around the axis vector for the passed angle (amount) expressed in radians, in the given space.
  94581. * space (default LOCAL) can be either Space.LOCAL, either Space.WORLD.
  94582. * Note that the property `rotationQuaternion` is then automatically updated and the property `rotation` is set to (0,0,0) and no longer used.
  94583. * The passed axis is also normalized.
  94584. * @param axis the axis to rotate around
  94585. * @param amount the amount to rotate in radians
  94586. * @param space Space to rotate in (Default: local)
  94587. * @returns the TransformNode.
  94588. */
  94589. rotate(axis: Vector3, amount: number, space?: Space): TransformNode;
  94590. /**
  94591. * Rotates the mesh around the axis vector for the passed angle (amount) expressed in radians, in world space.
  94592. * Note that the property `rotationQuaternion` is then automatically updated and the property `rotation` is set to (0,0,0) and no longer used.
  94593. * The passed axis is also normalized. .
  94594. * Method is based on http://www.euclideanspace.com/maths/geometry/affine/aroundPoint/index.htm
  94595. * @param point the point to rotate around
  94596. * @param axis the axis to rotate around
  94597. * @param amount the amount to rotate in radians
  94598. * @returns the TransformNode
  94599. */
  94600. rotateAround(point: Vector3, axis: Vector3, amount: number): TransformNode;
  94601. /**
  94602. * Translates the mesh along the axis vector for the passed distance in the given space.
  94603. * space (default LOCAL) can be either Space.LOCAL, either Space.WORLD.
  94604. * @param axis the axis to translate in
  94605. * @param distance the distance to translate
  94606. * @param space Space to rotate in (Default: local)
  94607. * @returns the TransformNode.
  94608. */
  94609. translate(axis: Vector3, distance: number, space?: Space): TransformNode;
  94610. /**
  94611. * Adds a rotation step to the mesh current rotation.
  94612. * x, y, z are Euler angles expressed in radians.
  94613. * This methods updates the current mesh rotation, either mesh.rotation, either mesh.rotationQuaternion if it's set.
  94614. * This means this rotation is made in the mesh local space only.
  94615. * It's useful to set a custom rotation order different from the BJS standard one YXZ.
  94616. * Example : this rotates the mesh first around its local X axis, then around its local Z axis, finally around its local Y axis.
  94617. * ```javascript
  94618. * mesh.addRotation(x1, 0, 0).addRotation(0, 0, z2).addRotation(0, 0, y3);
  94619. * ```
  94620. * Note that `addRotation()` accumulates the passed rotation values to the current ones and computes the .rotation or .rotationQuaternion updated values.
  94621. * 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.
  94622. * @param x Rotation to add
  94623. * @param y Rotation to add
  94624. * @param z Rotation to add
  94625. * @returns the TransformNode.
  94626. */
  94627. addRotation(x: number, y: number, z: number): TransformNode;
  94628. /**
  94629. * @hidden
  94630. */
  94631. protected _getEffectiveParent(): Nullable<Node>;
  94632. /**
  94633. * Computes the world matrix of the node
  94634. * @param force defines if the cache version should be invalidated forcing the world matrix to be created from scratch
  94635. * @returns the world matrix
  94636. */
  94637. computeWorldMatrix(force?: boolean): Matrix;
  94638. /**
  94639. * Resets this nodeTransform's local matrix to Matrix.Identity().
  94640. * @param independentOfChildren indicates if all child nodeTransform's world-space transform should be preserved.
  94641. */
  94642. resetLocalMatrix(independentOfChildren?: boolean): void;
  94643. protected _afterComputeWorldMatrix(): void;
  94644. /**
  94645. * If you'd like to be called back after the mesh position, rotation or scaling has been updated.
  94646. * @param func callback function to add
  94647. *
  94648. * @returns the TransformNode.
  94649. */
  94650. registerAfterWorldMatrixUpdate(func: (mesh: TransformNode) => void): TransformNode;
  94651. /**
  94652. * Removes a registered callback function.
  94653. * @param func callback function to remove
  94654. * @returns the TransformNode.
  94655. */
  94656. unregisterAfterWorldMatrixUpdate(func: (mesh: TransformNode) => void): TransformNode;
  94657. /**
  94658. * Gets the position of the current mesh in camera space
  94659. * @param camera defines the camera to use
  94660. * @returns a position
  94661. */
  94662. getPositionInCameraSpace(camera?: Nullable<Camera>): Vector3;
  94663. /**
  94664. * Returns the distance from the mesh to the active camera
  94665. * @param camera defines the camera to use
  94666. * @returns the distance
  94667. */
  94668. getDistanceToCamera(camera?: Nullable<Camera>): number;
  94669. /**
  94670. * Clone the current transform node
  94671. * @param name Name of the new clone
  94672. * @param newParent New parent for the clone
  94673. * @param doNotCloneChildren Do not clone children hierarchy
  94674. * @returns the new transform node
  94675. */
  94676. clone(name: string, newParent: Nullable<Node>, doNotCloneChildren?: boolean): Nullable<TransformNode>;
  94677. /**
  94678. * Serializes the objects information.
  94679. * @param currentSerializationObject defines the object to serialize in
  94680. * @returns the serialized object
  94681. */
  94682. serialize(currentSerializationObject?: any): any;
  94683. /**
  94684. * Returns a new TransformNode object parsed from the source provided.
  94685. * @param parsedTransformNode is the source.
  94686. * @param scene the scne the object belongs to
  94687. * @param rootUrl is a string, it's the root URL to prefix the `delayLoadingFile` property with
  94688. * @returns a new TransformNode object parsed from the source provided.
  94689. */
  94690. static Parse(parsedTransformNode: any, scene: Scene, rootUrl: string): TransformNode;
  94691. /**
  94692. * Get all child-transformNodes of this node
  94693. * @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
  94694. * @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
  94695. * @returns an array of TransformNode
  94696. */
  94697. getChildTransformNodes(directDescendantsOnly?: boolean, predicate?: (node: Node) => boolean): TransformNode[];
  94698. /**
  94699. * Releases resources associated with this transform node.
  94700. * @param doNotRecurse Set to true to not recurse into each children (recurse into each children by default)
  94701. * @param disposeMaterialAndTextures Set to true to also dispose referenced materials and textures (false by default)
  94702. */
  94703. dispose(doNotRecurse?: boolean, disposeMaterialAndTextures?: boolean): void;
  94704. /**
  94705. * Uniformly scales the mesh to fit inside of a unit cube (1 X 1 X 1 units)
  94706. * @param includeDescendants Use the hierarchy's bounding box instead of the mesh's bounding box. Default is false
  94707. * @param ignoreRotation ignore rotation when computing the scale (ie. object will be axis aligned). Default is false
  94708. * @param predicate predicate that is passed in to getHierarchyBoundingVectors when selecting which object should be included when scaling
  94709. * @returns the current mesh
  94710. */
  94711. normalizeToUnitCube(includeDescendants?: boolean, ignoreRotation?: boolean, predicate?: Nullable<(node: AbstractMesh) => boolean>): TransformNode;
  94712. private _syncAbsoluteScalingAndRotation;
  94713. }
  94714. }
  94715. declare module BABYLON {
  94716. /**
  94717. * Class used to override all child animations of a given target
  94718. */
  94719. export class AnimationPropertiesOverride {
  94720. /**
  94721. * Gets or sets a value indicating if animation blending must be used
  94722. */
  94723. enableBlending: boolean;
  94724. /**
  94725. * Gets or sets the blending speed to use when enableBlending is true
  94726. */
  94727. blendingSpeed: number;
  94728. /**
  94729. * Gets or sets the default loop mode to use
  94730. */
  94731. loopMode: number;
  94732. }
  94733. }
  94734. declare module BABYLON {
  94735. /**
  94736. * Class used to store bone information
  94737. * @see https://doc.babylonjs.com/how_to/how_to_use_bones_and_skeletons
  94738. */
  94739. export class Bone extends Node {
  94740. /**
  94741. * defines the bone name
  94742. */
  94743. name: string;
  94744. private static _tmpVecs;
  94745. private static _tmpQuat;
  94746. private static _tmpMats;
  94747. /**
  94748. * Gets the list of child bones
  94749. */
  94750. children: Bone[];
  94751. /** Gets the animations associated with this bone */
  94752. animations: Animation[];
  94753. /**
  94754. * Gets or sets bone length
  94755. */
  94756. length: number;
  94757. /**
  94758. * @hidden Internal only
  94759. * Set this value to map this bone to a different index in the transform matrices
  94760. * Set this value to -1 to exclude the bone from the transform matrices
  94761. */
  94762. _index: Nullable<number>;
  94763. private _skeleton;
  94764. private _localMatrix;
  94765. private _restPose;
  94766. private _bindPose;
  94767. private _baseMatrix;
  94768. private _absoluteTransform;
  94769. private _invertedAbsoluteTransform;
  94770. private _parent;
  94771. private _scalingDeterminant;
  94772. private _worldTransform;
  94773. private _localScaling;
  94774. private _localRotation;
  94775. private _localPosition;
  94776. private _needToDecompose;
  94777. private _needToCompose;
  94778. /** @hidden */
  94779. _linkedTransformNode: Nullable<TransformNode>;
  94780. /** @hidden */
  94781. _waitingTransformNodeId: Nullable<string>;
  94782. /** @hidden */
  94783. get _matrix(): Matrix;
  94784. /** @hidden */
  94785. set _matrix(value: Matrix);
  94786. /**
  94787. * Create a new bone
  94788. * @param name defines the bone name
  94789. * @param skeleton defines the parent skeleton
  94790. * @param parentBone defines the parent (can be null if the bone is the root)
  94791. * @param localMatrix defines the local matrix
  94792. * @param restPose defines the rest pose matrix
  94793. * @param baseMatrix defines the base matrix
  94794. * @param index defines index of the bone in the hiearchy
  94795. */
  94796. constructor(
  94797. /**
  94798. * defines the bone name
  94799. */
  94800. name: string, skeleton: Skeleton, parentBone?: Nullable<Bone>, localMatrix?: Nullable<Matrix>, restPose?: Nullable<Matrix>, baseMatrix?: Nullable<Matrix>, index?: Nullable<number>);
  94801. /**
  94802. * Gets the current object class name.
  94803. * @return the class name
  94804. */
  94805. getClassName(): string;
  94806. /**
  94807. * Gets the parent skeleton
  94808. * @returns a skeleton
  94809. */
  94810. getSkeleton(): Skeleton;
  94811. /**
  94812. * Gets parent bone
  94813. * @returns a bone or null if the bone is the root of the bone hierarchy
  94814. */
  94815. getParent(): Nullable<Bone>;
  94816. /**
  94817. * Returns an array containing the root bones
  94818. * @returns an array containing the root bones
  94819. */
  94820. getChildren(): Array<Bone>;
  94821. /**
  94822. * Gets the node index in matrix array generated for rendering
  94823. * @returns the node index
  94824. */
  94825. getIndex(): number;
  94826. /**
  94827. * Sets the parent bone
  94828. * @param parent defines the parent (can be null if the bone is the root)
  94829. * @param updateDifferenceMatrix defines if the difference matrix must be updated
  94830. */
  94831. setParent(parent: Nullable<Bone>, updateDifferenceMatrix?: boolean): void;
  94832. /**
  94833. * Gets the local matrix
  94834. * @returns a matrix
  94835. */
  94836. getLocalMatrix(): Matrix;
  94837. /**
  94838. * Gets the base matrix (initial matrix which remains unchanged)
  94839. * @returns a matrix
  94840. */
  94841. getBaseMatrix(): Matrix;
  94842. /**
  94843. * Gets the rest pose matrix
  94844. * @returns a matrix
  94845. */
  94846. getRestPose(): Matrix;
  94847. /**
  94848. * Sets the rest pose matrix
  94849. * @param matrix the local-space rest pose to set for this bone
  94850. */
  94851. setRestPose(matrix: Matrix): void;
  94852. /**
  94853. * Gets the bind pose matrix
  94854. * @returns the bind pose matrix
  94855. */
  94856. getBindPose(): Matrix;
  94857. /**
  94858. * Sets the bind pose matrix
  94859. * @param matrix the local-space bind pose to set for this bone
  94860. */
  94861. setBindPose(matrix: Matrix): void;
  94862. /**
  94863. * Gets a matrix used to store world matrix (ie. the matrix sent to shaders)
  94864. */
  94865. getWorldMatrix(): Matrix;
  94866. /**
  94867. * Sets the local matrix to rest pose matrix
  94868. */
  94869. returnToRest(): void;
  94870. /**
  94871. * Gets the inverse of the absolute transform matrix.
  94872. * This matrix will be multiplied by local matrix to get the difference matrix (ie. the difference between original state and current state)
  94873. * @returns a matrix
  94874. */
  94875. getInvertedAbsoluteTransform(): Matrix;
  94876. /**
  94877. * Gets the absolute transform matrix (ie base matrix * parent world matrix)
  94878. * @returns a matrix
  94879. */
  94880. getAbsoluteTransform(): Matrix;
  94881. /**
  94882. * Links with the given transform node.
  94883. * The local matrix of this bone is copied from the transform node every frame.
  94884. * @param transformNode defines the transform node to link to
  94885. */
  94886. linkTransformNode(transformNode: Nullable<TransformNode>): void;
  94887. /**
  94888. * Gets the node used to drive the bone's transformation
  94889. * @returns a transform node or null
  94890. */
  94891. getTransformNode(): Nullable<TransformNode>;
  94892. /** Gets or sets current position (in local space) */
  94893. get position(): Vector3;
  94894. set position(newPosition: Vector3);
  94895. /** Gets or sets current rotation (in local space) */
  94896. get rotation(): Vector3;
  94897. set rotation(newRotation: Vector3);
  94898. /** Gets or sets current rotation quaternion (in local space) */
  94899. get rotationQuaternion(): Quaternion;
  94900. set rotationQuaternion(newRotation: Quaternion);
  94901. /** Gets or sets current scaling (in local space) */
  94902. get scaling(): Vector3;
  94903. set scaling(newScaling: Vector3);
  94904. /**
  94905. * Gets the animation properties override
  94906. */
  94907. get animationPropertiesOverride(): Nullable<AnimationPropertiesOverride>;
  94908. private _decompose;
  94909. private _compose;
  94910. /**
  94911. * Update the base and local matrices
  94912. * @param matrix defines the new base or local matrix
  94913. * @param updateDifferenceMatrix defines if the difference matrix must be updated
  94914. * @param updateLocalMatrix defines if the local matrix should be updated
  94915. */
  94916. updateMatrix(matrix: Matrix, updateDifferenceMatrix?: boolean, updateLocalMatrix?: boolean): void;
  94917. /** @hidden */
  94918. _updateDifferenceMatrix(rootMatrix?: Matrix, updateChildren?: boolean): void;
  94919. /**
  94920. * Flag the bone as dirty (Forcing it to update everything)
  94921. */
  94922. markAsDirty(): void;
  94923. /** @hidden */
  94924. _markAsDirtyAndCompose(): void;
  94925. private _markAsDirtyAndDecompose;
  94926. /**
  94927. * Translate the bone in local or world space
  94928. * @param vec The amount to translate the bone
  94929. * @param space The space that the translation is in
  94930. * @param mesh The mesh that this bone is attached to. This is only used in world space
  94931. */
  94932. translate(vec: Vector3, space?: Space, mesh?: AbstractMesh): void;
  94933. /**
  94934. * Set the postion of the bone in local or world space
  94935. * @param position The position to set the bone
  94936. * @param space The space that the position is in
  94937. * @param mesh The mesh that this bone is attached to. This is only used in world space
  94938. */
  94939. setPosition(position: Vector3, space?: Space, mesh?: AbstractMesh): void;
  94940. /**
  94941. * Set the absolute position of the bone (world space)
  94942. * @param position The position to set the bone
  94943. * @param mesh The mesh that this bone is attached to
  94944. */
  94945. setAbsolutePosition(position: Vector3, mesh?: AbstractMesh): void;
  94946. /**
  94947. * Scale the bone on the x, y and z axes (in local space)
  94948. * @param x The amount to scale the bone on the x axis
  94949. * @param y The amount to scale the bone on the y axis
  94950. * @param z The amount to scale the bone on the z axis
  94951. * @param scaleChildren sets this to true if children of the bone should be scaled as well (false by default)
  94952. */
  94953. scale(x: number, y: number, z: number, scaleChildren?: boolean): void;
  94954. /**
  94955. * Set the bone scaling in local space
  94956. * @param scale defines the scaling vector
  94957. */
  94958. setScale(scale: Vector3): void;
  94959. /**
  94960. * Gets the current scaling in local space
  94961. * @returns the current scaling vector
  94962. */
  94963. getScale(): Vector3;
  94964. /**
  94965. * Gets the current scaling in local space and stores it in a target vector
  94966. * @param result defines the target vector
  94967. */
  94968. getScaleToRef(result: Vector3): void;
  94969. /**
  94970. * Set the yaw, pitch, and roll of the bone in local or world space
  94971. * @param yaw The rotation of the bone on the y axis
  94972. * @param pitch The rotation of the bone on the x axis
  94973. * @param roll The rotation of the bone on the z axis
  94974. * @param space The space that the axes of rotation are in
  94975. * @param mesh The mesh that this bone is attached to. This is only used in world space
  94976. */
  94977. setYawPitchRoll(yaw: number, pitch: number, roll: number, space?: Space, mesh?: AbstractMesh): void;
  94978. /**
  94979. * Add a rotation to the bone on an axis in local or world space
  94980. * @param axis The axis to rotate the bone on
  94981. * @param amount The amount to rotate the bone
  94982. * @param space The space that the axis is in
  94983. * @param mesh The mesh that this bone is attached to. This is only used in world space
  94984. */
  94985. rotate(axis: Vector3, amount: number, space?: Space, mesh?: AbstractMesh): void;
  94986. /**
  94987. * Set the rotation of the bone to a particular axis angle in local or world space
  94988. * @param axis The axis to rotate the bone on
  94989. * @param angle The angle that the bone should be rotated to
  94990. * @param space The space that the axis is in
  94991. * @param mesh The mesh that this bone is attached to. This is only used in world space
  94992. */
  94993. setAxisAngle(axis: Vector3, angle: number, space?: Space, mesh?: AbstractMesh): void;
  94994. /**
  94995. * Set the euler rotation of the bone in local of world space
  94996. * @param rotation The euler rotation that the bone should be set to
  94997. * @param space The space that the rotation is in
  94998. * @param mesh The mesh that this bone is attached to. This is only used in world space
  94999. */
  95000. setRotation(rotation: Vector3, space?: Space, mesh?: AbstractMesh): void;
  95001. /**
  95002. * Set the quaternion rotation of the bone in local of world space
  95003. * @param quat The quaternion rotation that the bone should be set to
  95004. * @param space The space that the rotation is in
  95005. * @param mesh The mesh that this bone is attached to. This is only used in world space
  95006. */
  95007. setRotationQuaternion(quat: Quaternion, space?: Space, mesh?: AbstractMesh): void;
  95008. /**
  95009. * Set the rotation matrix of the bone in local of world space
  95010. * @param rotMat The rotation matrix that the bone should be set to
  95011. * @param space The space that the rotation is in
  95012. * @param mesh The mesh that this bone is attached to. This is only used in world space
  95013. */
  95014. setRotationMatrix(rotMat: Matrix, space?: Space, mesh?: AbstractMesh): void;
  95015. private _rotateWithMatrix;
  95016. private _getNegativeRotationToRef;
  95017. /**
  95018. * Get the position of the bone in local or world space
  95019. * @param space The space that the returned position is in
  95020. * @param mesh The mesh that this bone is attached to. This is only used in world space
  95021. * @returns The position of the bone
  95022. */
  95023. getPosition(space?: Space, mesh?: Nullable<AbstractMesh>): Vector3;
  95024. /**
  95025. * Copy the position of the bone to a vector3 in local or world space
  95026. * @param space The space that the returned position is in
  95027. * @param mesh The mesh that this bone is attached to. This is only used in world space
  95028. * @param result The vector3 to copy the position to
  95029. */
  95030. getPositionToRef(space: Space | undefined, mesh: Nullable<AbstractMesh>, result: Vector3): void;
  95031. /**
  95032. * Get the absolute position of the bone (world space)
  95033. * @param mesh The mesh that this bone is attached to
  95034. * @returns The absolute position of the bone
  95035. */
  95036. getAbsolutePosition(mesh?: Nullable<AbstractMesh>): Vector3;
  95037. /**
  95038. * Copy the absolute position of the bone (world space) to the result param
  95039. * @param mesh The mesh that this bone is attached to
  95040. * @param result The vector3 to copy the absolute position to
  95041. */
  95042. getAbsolutePositionToRef(mesh: AbstractMesh, result: Vector3): void;
  95043. /**
  95044. * Compute the absolute transforms of this bone and its children
  95045. */
  95046. computeAbsoluteTransforms(): void;
  95047. /**
  95048. * Get the world direction from an axis that is in the local space of the bone
  95049. * @param localAxis The local direction that is used to compute the world direction
  95050. * @param mesh The mesh that this bone is attached to
  95051. * @returns The world direction
  95052. */
  95053. getDirection(localAxis: Vector3, mesh?: Nullable<AbstractMesh>): Vector3;
  95054. /**
  95055. * Copy the world direction to a vector3 from an axis that is in the local space of the bone
  95056. * @param localAxis The local direction that is used to compute the world direction
  95057. * @param mesh The mesh that this bone is attached to
  95058. * @param result The vector3 that the world direction will be copied to
  95059. */
  95060. getDirectionToRef(localAxis: Vector3, mesh: AbstractMesh | null | undefined, result: Vector3): void;
  95061. /**
  95062. * Get the euler rotation of the bone in local or world space
  95063. * @param space The space that the rotation should be in
  95064. * @param mesh The mesh that this bone is attached to. This is only used in world space
  95065. * @returns The euler rotation
  95066. */
  95067. getRotation(space?: Space, mesh?: Nullable<AbstractMesh>): Vector3;
  95068. /**
  95069. * Copy the euler rotation of the bone to a vector3. The rotation can be in either local or world space
  95070. * @param space The space that the rotation should be in
  95071. * @param mesh The mesh that this bone is attached to. This is only used in world space
  95072. * @param result The vector3 that the rotation should be copied to
  95073. */
  95074. getRotationToRef(space: Space | undefined, mesh: AbstractMesh | null | undefined, result: Vector3): void;
  95075. /**
  95076. * Get the quaternion rotation of the bone in either local or world space
  95077. * @param space The space that the rotation should be in
  95078. * @param mesh The mesh that this bone is attached to. This is only used in world space
  95079. * @returns The quaternion rotation
  95080. */
  95081. getRotationQuaternion(space?: Space, mesh?: Nullable<AbstractMesh>): Quaternion;
  95082. /**
  95083. * Copy the quaternion rotation of the bone to a quaternion. The rotation can be in either local or world space
  95084. * @param space The space that the rotation should be in
  95085. * @param mesh The mesh that this bone is attached to. This is only used in world space
  95086. * @param result The quaternion that the rotation should be copied to
  95087. */
  95088. getRotationQuaternionToRef(space: Space | undefined, mesh: AbstractMesh | null | undefined, result: Quaternion): void;
  95089. /**
  95090. * Get the rotation matrix of the bone in local or world space
  95091. * @param space The space that the rotation should be in
  95092. * @param mesh The mesh that this bone is attached to. This is only used in world space
  95093. * @returns The rotation matrix
  95094. */
  95095. getRotationMatrix(space: Space | undefined, mesh: AbstractMesh): Matrix;
  95096. /**
  95097. * Copy the rotation matrix of the bone to a matrix. The rotation can be in either local or world space
  95098. * @param space The space that the rotation should be in
  95099. * @param mesh The mesh that this bone is attached to. This is only used in world space
  95100. * @param result The quaternion that the rotation should be copied to
  95101. */
  95102. getRotationMatrixToRef(space: Space | undefined, mesh: AbstractMesh, result: Matrix): void;
  95103. /**
  95104. * Get the world position of a point that is in the local space of the bone
  95105. * @param position The local position
  95106. * @param mesh The mesh that this bone is attached to
  95107. * @returns The world position
  95108. */
  95109. getAbsolutePositionFromLocal(position: Vector3, mesh?: Nullable<AbstractMesh>): Vector3;
  95110. /**
  95111. * Get the world position of a point that is in the local space of the bone and copy it to the result param
  95112. * @param position The local position
  95113. * @param mesh The mesh that this bone is attached to
  95114. * @param result The vector3 that the world position should be copied to
  95115. */
  95116. getAbsolutePositionFromLocalToRef(position: Vector3, mesh: AbstractMesh | null | undefined, result: Vector3): void;
  95117. /**
  95118. * Get the local position of a point that is in world space
  95119. * @param position The world position
  95120. * @param mesh The mesh that this bone is attached to
  95121. * @returns The local position
  95122. */
  95123. getLocalPositionFromAbsolute(position: Vector3, mesh?: Nullable<AbstractMesh>): Vector3;
  95124. /**
  95125. * Get the local position of a point that is in world space and copy it to the result param
  95126. * @param position The world position
  95127. * @param mesh The mesh that this bone is attached to
  95128. * @param result The vector3 that the local position should be copied to
  95129. */
  95130. getLocalPositionFromAbsoluteToRef(position: Vector3, mesh: AbstractMesh | null | undefined, result: Vector3): void;
  95131. }
  95132. }
  95133. declare module BABYLON {
  95134. /**
  95135. * Defines a runtime animation
  95136. */
  95137. export class RuntimeAnimation {
  95138. private _events;
  95139. /**
  95140. * The current frame of the runtime animation
  95141. */
  95142. private _currentFrame;
  95143. /**
  95144. * The animation used by the runtime animation
  95145. */
  95146. private _animation;
  95147. /**
  95148. * The target of the runtime animation
  95149. */
  95150. private _target;
  95151. /**
  95152. * The initiating animatable
  95153. */
  95154. private _host;
  95155. /**
  95156. * The original value of the runtime animation
  95157. */
  95158. private _originalValue;
  95159. /**
  95160. * The original blend value of the runtime animation
  95161. */
  95162. private _originalBlendValue;
  95163. /**
  95164. * The offsets cache of the runtime animation
  95165. */
  95166. private _offsetsCache;
  95167. /**
  95168. * The high limits cache of the runtime animation
  95169. */
  95170. private _highLimitsCache;
  95171. /**
  95172. * Specifies if the runtime animation has been stopped
  95173. */
  95174. private _stopped;
  95175. /**
  95176. * The blending factor of the runtime animation
  95177. */
  95178. private _blendingFactor;
  95179. /**
  95180. * The BabylonJS scene
  95181. */
  95182. private _scene;
  95183. /**
  95184. * The current value of the runtime animation
  95185. */
  95186. private _currentValue;
  95187. /** @hidden */
  95188. _animationState: _IAnimationState;
  95189. /**
  95190. * The active target of the runtime animation
  95191. */
  95192. private _activeTargets;
  95193. private _currentActiveTarget;
  95194. private _directTarget;
  95195. /**
  95196. * The target path of the runtime animation
  95197. */
  95198. private _targetPath;
  95199. /**
  95200. * The weight of the runtime animation
  95201. */
  95202. private _weight;
  95203. /**
  95204. * The ratio offset of the runtime animation
  95205. */
  95206. private _ratioOffset;
  95207. /**
  95208. * The previous delay of the runtime animation
  95209. */
  95210. private _previousDelay;
  95211. /**
  95212. * The previous ratio of the runtime animation
  95213. */
  95214. private _previousRatio;
  95215. private _enableBlending;
  95216. private _keys;
  95217. private _minFrame;
  95218. private _maxFrame;
  95219. private _minValue;
  95220. private _maxValue;
  95221. private _targetIsArray;
  95222. /**
  95223. * Gets the current frame of the runtime animation
  95224. */
  95225. get currentFrame(): number;
  95226. /**
  95227. * Gets the weight of the runtime animation
  95228. */
  95229. get weight(): number;
  95230. /**
  95231. * Gets the current value of the runtime animation
  95232. */
  95233. get currentValue(): any;
  95234. /**
  95235. * Gets the target path of the runtime animation
  95236. */
  95237. get targetPath(): string;
  95238. /**
  95239. * Gets the actual target of the runtime animation
  95240. */
  95241. get target(): any;
  95242. /**
  95243. * Gets the additive state of the runtime animation
  95244. */
  95245. get isAdditive(): boolean;
  95246. /** @hidden */
  95247. _onLoop: () => void;
  95248. /**
  95249. * Create a new RuntimeAnimation object
  95250. * @param target defines the target of the animation
  95251. * @param animation defines the source animation object
  95252. * @param scene defines the hosting scene
  95253. * @param host defines the initiating Animatable
  95254. */
  95255. constructor(target: any, animation: Animation, scene: Scene, host: Animatable);
  95256. private _preparePath;
  95257. /**
  95258. * Gets the animation from the runtime animation
  95259. */
  95260. get animation(): Animation;
  95261. /**
  95262. * Resets the runtime animation to the beginning
  95263. * @param restoreOriginal defines whether to restore the target property to the original value
  95264. */
  95265. reset(restoreOriginal?: boolean): void;
  95266. /**
  95267. * Specifies if the runtime animation is stopped
  95268. * @returns Boolean specifying if the runtime animation is stopped
  95269. */
  95270. isStopped(): boolean;
  95271. /**
  95272. * Disposes of the runtime animation
  95273. */
  95274. dispose(): void;
  95275. /**
  95276. * Apply the interpolated value to the target
  95277. * @param currentValue defines the value computed by the animation
  95278. * @param weight defines the weight to apply to this value (Defaults to 1.0)
  95279. */
  95280. setValue(currentValue: any, weight: number): void;
  95281. private _getOriginalValues;
  95282. private _setValue;
  95283. /**
  95284. * Gets the loop pmode of the runtime animation
  95285. * @returns Loop Mode
  95286. */
  95287. private _getCorrectLoopMode;
  95288. /**
  95289. * Move the current animation to a given frame
  95290. * @param frame defines the frame to move to
  95291. */
  95292. goToFrame(frame: number): void;
  95293. /**
  95294. * @hidden Internal use only
  95295. */
  95296. _prepareForSpeedRatioChange(newSpeedRatio: number): void;
  95297. /**
  95298. * Execute the current animation
  95299. * @param delay defines the delay to add to the current frame
  95300. * @param from defines the lower bound of the animation range
  95301. * @param to defines the upper bound of the animation range
  95302. * @param loop defines if the current animation must loop
  95303. * @param speedRatio defines the current speed ratio
  95304. * @param weight defines the weight of the animation (default is -1 so no weight)
  95305. * @param onLoop optional callback called when animation loops
  95306. * @returns a boolean indicating if the animation is running
  95307. */
  95308. animate(delay: number, from: number, to: number, loop: boolean, speedRatio: number, weight?: number): boolean;
  95309. }
  95310. }
  95311. declare module BABYLON {
  95312. /**
  95313. * Class used to store an actual running animation
  95314. */
  95315. export class Animatable {
  95316. /** defines the target object */
  95317. target: any;
  95318. /** defines the starting frame number (default is 0) */
  95319. fromFrame: number;
  95320. /** defines the ending frame number (default is 100) */
  95321. toFrame: number;
  95322. /** defines if the animation must loop (default is false) */
  95323. loopAnimation: boolean;
  95324. /** defines a callback to call when animation ends if it is not looping */
  95325. onAnimationEnd?: (() => void) | null | undefined;
  95326. /** defines a callback to call when animation loops */
  95327. onAnimationLoop?: (() => void) | null | undefined;
  95328. /** defines whether the animation should be evaluated additively */
  95329. isAdditive: boolean;
  95330. private _localDelayOffset;
  95331. private _pausedDelay;
  95332. private _runtimeAnimations;
  95333. private _paused;
  95334. private _scene;
  95335. private _speedRatio;
  95336. private _weight;
  95337. private _syncRoot;
  95338. /**
  95339. * Gets or sets a boolean indicating if the animatable must be disposed and removed at the end of the animation.
  95340. * This will only apply for non looping animation (default is true)
  95341. */
  95342. disposeOnEnd: boolean;
  95343. /**
  95344. * Gets a boolean indicating if the animation has started
  95345. */
  95346. animationStarted: boolean;
  95347. /**
  95348. * Observer raised when the animation ends
  95349. */
  95350. onAnimationEndObservable: Observable<Animatable>;
  95351. /**
  95352. * Observer raised when the animation loops
  95353. */
  95354. onAnimationLoopObservable: Observable<Animatable>;
  95355. /**
  95356. * Gets the root Animatable used to synchronize and normalize animations
  95357. */
  95358. get syncRoot(): Nullable<Animatable>;
  95359. /**
  95360. * Gets the current frame of the first RuntimeAnimation
  95361. * Used to synchronize Animatables
  95362. */
  95363. get masterFrame(): number;
  95364. /**
  95365. * Gets or sets the animatable weight (-1.0 by default meaning not weighted)
  95366. */
  95367. get weight(): number;
  95368. set weight(value: number);
  95369. /**
  95370. * Gets or sets the speed ratio to apply to the animatable (1.0 by default)
  95371. */
  95372. get speedRatio(): number;
  95373. set speedRatio(value: number);
  95374. /**
  95375. * Creates a new Animatable
  95376. * @param scene defines the hosting scene
  95377. * @param target defines the target object
  95378. * @param fromFrame defines the starting frame number (default is 0)
  95379. * @param toFrame defines the ending frame number (default is 100)
  95380. * @param loopAnimation defines if the animation must loop (default is false)
  95381. * @param speedRatio defines the factor to apply to animation speed (default is 1)
  95382. * @param onAnimationEnd defines a callback to call when animation ends if it is not looping
  95383. * @param animations defines a group of animation to add to the new Animatable
  95384. * @param onAnimationLoop defines a callback to call when animation loops
  95385. * @param isAdditive defines whether the animation should be evaluated additively
  95386. */
  95387. constructor(scene: Scene,
  95388. /** defines the target object */
  95389. target: any,
  95390. /** defines the starting frame number (default is 0) */
  95391. fromFrame?: number,
  95392. /** defines the ending frame number (default is 100) */
  95393. toFrame?: number,
  95394. /** defines if the animation must loop (default is false) */
  95395. loopAnimation?: boolean, speedRatio?: number,
  95396. /** defines a callback to call when animation ends if it is not looping */
  95397. onAnimationEnd?: (() => void) | null | undefined, animations?: Animation[],
  95398. /** defines a callback to call when animation loops */
  95399. onAnimationLoop?: (() => void) | null | undefined,
  95400. /** defines whether the animation should be evaluated additively */
  95401. isAdditive?: boolean);
  95402. /**
  95403. * Synchronize and normalize current Animatable with a source Animatable
  95404. * This is useful when using animation weights and when animations are not of the same length
  95405. * @param root defines the root Animatable to synchronize with
  95406. * @returns the current Animatable
  95407. */
  95408. syncWith(root: Animatable): Animatable;
  95409. /**
  95410. * Gets the list of runtime animations
  95411. * @returns an array of RuntimeAnimation
  95412. */
  95413. getAnimations(): RuntimeAnimation[];
  95414. /**
  95415. * Adds more animations to the current animatable
  95416. * @param target defines the target of the animations
  95417. * @param animations defines the new animations to add
  95418. */
  95419. appendAnimations(target: any, animations: Animation[]): void;
  95420. /**
  95421. * Gets the source animation for a specific property
  95422. * @param property defines the propertyu to look for
  95423. * @returns null or the source animation for the given property
  95424. */
  95425. getAnimationByTargetProperty(property: string): Nullable<Animation>;
  95426. /**
  95427. * Gets the runtime animation for a specific property
  95428. * @param property defines the propertyu to look for
  95429. * @returns null or the runtime animation for the given property
  95430. */
  95431. getRuntimeAnimationByTargetProperty(property: string): Nullable<RuntimeAnimation>;
  95432. /**
  95433. * Resets the animatable to its original state
  95434. */
  95435. reset(): void;
  95436. /**
  95437. * Allows the animatable to blend with current running animations
  95438. * @see https://doc.babylonjs.com/babylon101/animations#animation-blending
  95439. * @param blendingSpeed defines the blending speed to use
  95440. */
  95441. enableBlending(blendingSpeed: number): void;
  95442. /**
  95443. * Disable animation blending
  95444. * @see https://doc.babylonjs.com/babylon101/animations#animation-blending
  95445. */
  95446. disableBlending(): void;
  95447. /**
  95448. * Jump directly to a given frame
  95449. * @param frame defines the frame to jump to
  95450. */
  95451. goToFrame(frame: number): void;
  95452. /**
  95453. * Pause the animation
  95454. */
  95455. pause(): void;
  95456. /**
  95457. * Restart the animation
  95458. */
  95459. restart(): void;
  95460. private _raiseOnAnimationEnd;
  95461. /**
  95462. * Stop and delete the current animation
  95463. * @param animationName defines a string used to only stop some of the runtime animations instead of all
  95464. * @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)
  95465. */
  95466. stop(animationName?: string, targetMask?: (target: any) => boolean): void;
  95467. /**
  95468. * Wait asynchronously for the animation to end
  95469. * @returns a promise which will be fullfilled when the animation ends
  95470. */
  95471. waitAsync(): Promise<Animatable>;
  95472. /** @hidden */
  95473. _animate(delay: number): boolean;
  95474. }
  95475. interface Scene {
  95476. /** @hidden */
  95477. _registerTargetForLateAnimationBinding(runtimeAnimation: RuntimeAnimation, originalValue: any): void;
  95478. /** @hidden */
  95479. _processLateAnimationBindingsForMatrices(holder: {
  95480. totalWeight: number;
  95481. totalAdditiveWeight: number;
  95482. animations: RuntimeAnimation[];
  95483. additiveAnimations: RuntimeAnimation[];
  95484. originalValue: Matrix;
  95485. }): any;
  95486. /** @hidden */
  95487. _processLateAnimationBindingsForQuaternions(holder: {
  95488. totalWeight: number;
  95489. totalAdditiveWeight: number;
  95490. animations: RuntimeAnimation[];
  95491. additiveAnimations: RuntimeAnimation[];
  95492. originalValue: Quaternion;
  95493. }, refQuaternion: Quaternion): Quaternion;
  95494. /** @hidden */
  95495. _processLateAnimationBindings(): void;
  95496. /**
  95497. * Will start the animation sequence of a given target
  95498. * @param target defines the target
  95499. * @param from defines from which frame should animation start
  95500. * @param to defines until which frame should animation run.
  95501. * @param weight defines the weight to apply to the animation (1.0 by default)
  95502. * @param loop defines if the animation loops
  95503. * @param speedRatio defines the speed in which to run the animation (1.0 by default)
  95504. * @param onAnimationEnd defines the function to be executed when the animation ends
  95505. * @param animatable defines an animatable object. If not provided a new one will be created from the given params
  95506. * @param targetMask defines if the target should be animated if animations are present (this is called recursively on descendant animatables regardless of return value)
  95507. * @param onAnimationLoop defines the callback to call when an animation loops
  95508. * @param isAdditive defines whether the animation should be evaluated additively (false by default)
  95509. * @returns the animatable object created for this animation
  95510. */
  95511. 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;
  95512. /**
  95513. * Will start the animation sequence of a given target
  95514. * @param target defines the target
  95515. * @param from defines from which frame should animation start
  95516. * @param to defines until which frame should animation run.
  95517. * @param loop defines if the animation loops
  95518. * @param speedRatio defines the speed in which to run the animation (1.0 by default)
  95519. * @param onAnimationEnd defines the function to be executed when the animation ends
  95520. * @param animatable defines an animatable object. If not provided a new one will be created from the given params
  95521. * @param stopCurrent defines if the current animations must be stopped first (true by default)
  95522. * @param targetMask defines if the target should be animate if animations are present (this is called recursively on descendant animatables regardless of return value)
  95523. * @param onAnimationLoop defines the callback to call when an animation loops
  95524. * @param isAdditive defines whether the animation should be evaluated additively (false by default)
  95525. * @returns the animatable object created for this animation
  95526. */
  95527. 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;
  95528. /**
  95529. * Will start the animation sequence of a given target and its hierarchy
  95530. * @param target defines the target
  95531. * @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.
  95532. * @param from defines from which frame should animation start
  95533. * @param to defines until which frame should animation run.
  95534. * @param loop defines if the animation loops
  95535. * @param speedRatio defines the speed in which to run the animation (1.0 by default)
  95536. * @param onAnimationEnd defines the function to be executed when the animation ends
  95537. * @param animatable defines an animatable object. If not provided a new one will be created from the given params
  95538. * @param stopCurrent defines if the current animations must be stopped first (true by default)
  95539. * @param targetMask defines if the target should be animated if animations are present (this is called recursively on descendant animatables regardless of return value)
  95540. * @param onAnimationLoop defines the callback to call when an animation loops
  95541. * @param isAdditive defines whether the animation should be evaluated additively (false by default)
  95542. * @returns the list of created animatables
  95543. */
  95544. 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[];
  95545. /**
  95546. * Begin a new animation on a given node
  95547. * @param target defines the target where the animation will take place
  95548. * @param animations defines the list of animations to start
  95549. * @param from defines the initial value
  95550. * @param to defines the final value
  95551. * @param loop defines if you want animation to loop (off by default)
  95552. * @param speedRatio defines the speed ratio to apply to all animations
  95553. * @param onAnimationEnd defines the callback to call when an animation ends (will be called once per node)
  95554. * @param onAnimationLoop defines the callback to call when an animation loops
  95555. * @param isAdditive defines whether the animation should be evaluated additively (false by default)
  95556. * @returns the list of created animatables
  95557. */
  95558. beginDirectAnimation(target: any, animations: Animation[], from: number, to: number, loop?: boolean, speedRatio?: number, onAnimationEnd?: () => void, onAnimationLoop?: () => void, isAdditive?: boolean): Animatable;
  95559. /**
  95560. * Begin a new animation on a given node and its hierarchy
  95561. * @param target defines the root node where the animation will take place
  95562. * @param directDescendantsOnly if true only direct descendants will be used, if false direct and also indirect (children of children, an so on in a recursive manner) descendants will be used.
  95563. * @param animations defines the list of animations to start
  95564. * @param from defines the initial value
  95565. * @param to defines the final value
  95566. * @param loop defines if you want animation to loop (off by default)
  95567. * @param speedRatio defines the speed ratio to apply to all animations
  95568. * @param onAnimationEnd defines the callback to call when an animation ends (will be called once per node)
  95569. * @param onAnimationLoop defines the callback to call when an animation loops
  95570. * @param isAdditive defines whether the animation should be evaluated additively (false by default)
  95571. * @returns the list of animatables created for all nodes
  95572. */
  95573. beginDirectHierarchyAnimation(target: Node, directDescendantsOnly: boolean, animations: Animation[], from: number, to: number, loop?: boolean, speedRatio?: number, onAnimationEnd?: () => void, onAnimationLoop?: () => void, isAdditive?: boolean): Animatable[];
  95574. /**
  95575. * Gets the animatable associated with a specific target
  95576. * @param target defines the target of the animatable
  95577. * @returns the required animatable if found
  95578. */
  95579. getAnimatableByTarget(target: any): Nullable<Animatable>;
  95580. /**
  95581. * Gets all animatables associated with a given target
  95582. * @param target defines the target to look animatables for
  95583. * @returns an array of Animatables
  95584. */
  95585. getAllAnimatablesByTarget(target: any): Array<Animatable>;
  95586. /**
  95587. * Stops and removes all animations that have been applied to the scene
  95588. */
  95589. stopAllAnimations(): void;
  95590. /**
  95591. * Gets the current delta time used by animation engine
  95592. */
  95593. deltaTime: number;
  95594. }
  95595. interface Bone {
  95596. /**
  95597. * Copy an animation range from another bone
  95598. * @param source defines the source bone
  95599. * @param rangeName defines the range name to copy
  95600. * @param frameOffset defines the frame offset
  95601. * @param rescaleAsRequired defines if rescaling must be applied if required
  95602. * @param skelDimensionsRatio defines the scaling ratio
  95603. * @returns true if operation was successful
  95604. */
  95605. copyAnimationRange(source: Bone, rangeName: string, frameOffset: number, rescaleAsRequired: boolean, skelDimensionsRatio: Nullable<Vector3>): boolean;
  95606. }
  95607. }
  95608. declare module BABYLON {
  95609. /**
  95610. * Class used to handle skinning animations
  95611. * @see https://doc.babylonjs.com/how_to/how_to_use_bones_and_skeletons
  95612. */
  95613. export class Skeleton implements IAnimatable {
  95614. /** defines the skeleton name */
  95615. name: string;
  95616. /** defines the skeleton Id */
  95617. id: string;
  95618. /**
  95619. * Defines the list of child bones
  95620. */
  95621. bones: Bone[];
  95622. /**
  95623. * Defines an estimate of the dimension of the skeleton at rest
  95624. */
  95625. dimensionsAtRest: Vector3;
  95626. /**
  95627. * Defines a boolean indicating if the root matrix is provided by meshes or by the current skeleton (this is the default value)
  95628. */
  95629. needInitialSkinMatrix: boolean;
  95630. /**
  95631. * Defines a mesh that override the matrix used to get the world matrix (null by default).
  95632. */
  95633. overrideMesh: Nullable<AbstractMesh>;
  95634. /**
  95635. * Gets the list of animations attached to this skeleton
  95636. */
  95637. animations: Array<Animation>;
  95638. private _scene;
  95639. private _isDirty;
  95640. private _transformMatrices;
  95641. private _transformMatrixTexture;
  95642. private _meshesWithPoseMatrix;
  95643. private _animatables;
  95644. private _identity;
  95645. private _synchronizedWithMesh;
  95646. private _ranges;
  95647. private _lastAbsoluteTransformsUpdateId;
  95648. private _canUseTextureForBones;
  95649. private _uniqueId;
  95650. /** @hidden */
  95651. _numBonesWithLinkedTransformNode: number;
  95652. /** @hidden */
  95653. _hasWaitingData: Nullable<boolean>;
  95654. /** @hidden */
  95655. _waitingOverrideMeshId: Nullable<string>;
  95656. /**
  95657. * Specifies if the skeleton should be serialized
  95658. */
  95659. doNotSerialize: boolean;
  95660. private _useTextureToStoreBoneMatrices;
  95661. /**
  95662. * Gets or sets a boolean indicating that bone matrices should be stored as a texture instead of using shader uniforms (default is true).
  95663. * Please note that this option is not available if the hardware does not support it
  95664. */
  95665. get useTextureToStoreBoneMatrices(): boolean;
  95666. set useTextureToStoreBoneMatrices(value: boolean);
  95667. private _animationPropertiesOverride;
  95668. /**
  95669. * Gets or sets the animation properties override
  95670. */
  95671. get animationPropertiesOverride(): Nullable<AnimationPropertiesOverride>;
  95672. set animationPropertiesOverride(value: Nullable<AnimationPropertiesOverride>);
  95673. /**
  95674. * List of inspectable custom properties (used by the Inspector)
  95675. * @see https://doc.babylonjs.com/how_to/debug_layer#extensibility
  95676. */
  95677. inspectableCustomProperties: IInspectable[];
  95678. /**
  95679. * An observable triggered before computing the skeleton's matrices
  95680. */
  95681. onBeforeComputeObservable: Observable<Skeleton>;
  95682. /**
  95683. * Gets a boolean indicating that the skeleton effectively stores matrices into a texture
  95684. */
  95685. get isUsingTextureForMatrices(): boolean;
  95686. /**
  95687. * Gets the unique ID of this skeleton
  95688. */
  95689. get uniqueId(): number;
  95690. /**
  95691. * Creates a new skeleton
  95692. * @param name defines the skeleton name
  95693. * @param id defines the skeleton Id
  95694. * @param scene defines the hosting scene
  95695. */
  95696. constructor(
  95697. /** defines the skeleton name */
  95698. name: string,
  95699. /** defines the skeleton Id */
  95700. id: string, scene: Scene);
  95701. /**
  95702. * Gets the current object class name.
  95703. * @return the class name
  95704. */
  95705. getClassName(): string;
  95706. /**
  95707. * Returns an array containing the root bones
  95708. * @returns an array containing the root bones
  95709. */
  95710. getChildren(): Array<Bone>;
  95711. /**
  95712. * Gets the list of transform matrices to send to shaders (one matrix per bone)
  95713. * @param mesh defines the mesh to use to get the root matrix (if needInitialSkinMatrix === true)
  95714. * @returns a Float32Array containing matrices data
  95715. */
  95716. getTransformMatrices(mesh: AbstractMesh): Float32Array;
  95717. /**
  95718. * Gets the list of transform matrices to send to shaders inside a texture (one matrix per bone)
  95719. * @param mesh defines the mesh to use to get the root matrix (if needInitialSkinMatrix === true)
  95720. * @returns a raw texture containing the data
  95721. */
  95722. getTransformMatrixTexture(mesh: AbstractMesh): Nullable<RawTexture>;
  95723. /**
  95724. * Gets the current hosting scene
  95725. * @returns a scene object
  95726. */
  95727. getScene(): Scene;
  95728. /**
  95729. * Gets a string representing the current skeleton data
  95730. * @param fullDetails defines a boolean indicating if we want a verbose version
  95731. * @returns a string representing the current skeleton data
  95732. */
  95733. toString(fullDetails?: boolean): string;
  95734. /**
  95735. * Get bone's index searching by name
  95736. * @param name defines bone's name to search for
  95737. * @return the indice of the bone. Returns -1 if not found
  95738. */
  95739. getBoneIndexByName(name: string): number;
  95740. /**
  95741. * Creater a new animation range
  95742. * @param name defines the name of the range
  95743. * @param from defines the start key
  95744. * @param to defines the end key
  95745. */
  95746. createAnimationRange(name: string, from: number, to: number): void;
  95747. /**
  95748. * Delete a specific animation range
  95749. * @param name defines the name of the range
  95750. * @param deleteFrames defines if frames must be removed as well
  95751. */
  95752. deleteAnimationRange(name: string, deleteFrames?: boolean): void;
  95753. /**
  95754. * Gets a specific animation range
  95755. * @param name defines the name of the range to look for
  95756. * @returns the requested animation range or null if not found
  95757. */
  95758. getAnimationRange(name: string): Nullable<AnimationRange>;
  95759. /**
  95760. * Gets the list of all animation ranges defined on this skeleton
  95761. * @returns an array
  95762. */
  95763. getAnimationRanges(): Nullable<AnimationRange>[];
  95764. /**
  95765. * Copy animation range from a source skeleton.
  95766. * This is not for a complete retargeting, only between very similar skeleton's with only possible bone length differences
  95767. * @param source defines the source skeleton
  95768. * @param name defines the name of the range to copy
  95769. * @param rescaleAsRequired defines if rescaling must be applied if required
  95770. * @returns true if operation was successful
  95771. */
  95772. copyAnimationRange(source: Skeleton, name: string, rescaleAsRequired?: boolean): boolean;
  95773. /**
  95774. * Forces the skeleton to go to rest pose
  95775. */
  95776. returnToRest(): void;
  95777. private _getHighestAnimationFrame;
  95778. /**
  95779. * Begin a specific animation range
  95780. * @param name defines the name of the range to start
  95781. * @param loop defines if looping must be turned on (false by default)
  95782. * @param speedRatio defines the speed ratio to apply (1 by default)
  95783. * @param onAnimationEnd defines a callback which will be called when animation will end
  95784. * @returns a new animatable
  95785. */
  95786. beginAnimation(name: string, loop?: boolean, speedRatio?: number, onAnimationEnd?: () => void): Nullable<Animatable>;
  95787. /**
  95788. * Convert the keyframes for a range of animation on a skeleton to be relative to a given reference frame.
  95789. * @param skeleton defines the Skeleton containing the animation range to convert
  95790. * @param referenceFrame defines the frame that keyframes in the range will be relative to
  95791. * @param range defines the name of the AnimationRange belonging to the Skeleton to convert
  95792. * @returns the original skeleton
  95793. */
  95794. static MakeAnimationAdditive(skeleton: Skeleton, referenceFrame: number | undefined, range: string): Nullable<Skeleton>;
  95795. /** @hidden */
  95796. _markAsDirty(): void;
  95797. /** @hidden */
  95798. _registerMeshWithPoseMatrix(mesh: AbstractMesh): void;
  95799. /** @hidden */
  95800. _unregisterMeshWithPoseMatrix(mesh: AbstractMesh): void;
  95801. private _computeTransformMatrices;
  95802. /**
  95803. * Build all resources required to render a skeleton
  95804. */
  95805. prepare(): void;
  95806. /**
  95807. * Gets the list of animatables currently running for this skeleton
  95808. * @returns an array of animatables
  95809. */
  95810. getAnimatables(): IAnimatable[];
  95811. /**
  95812. * Clone the current skeleton
  95813. * @param name defines the name of the new skeleton
  95814. * @param id defines the id of the new skeleton
  95815. * @returns the new skeleton
  95816. */
  95817. clone(name: string, id?: string): Skeleton;
  95818. /**
  95819. * Enable animation blending for this skeleton
  95820. * @param blendingSpeed defines the blending speed to apply
  95821. * @see https://doc.babylonjs.com/babylon101/animations#animation-blending
  95822. */
  95823. enableBlending(blendingSpeed?: number): void;
  95824. /**
  95825. * Releases all resources associated with the current skeleton
  95826. */
  95827. dispose(): void;
  95828. /**
  95829. * Serialize the skeleton in a JSON object
  95830. * @returns a JSON object
  95831. */
  95832. serialize(): any;
  95833. /**
  95834. * Creates a new skeleton from serialized data
  95835. * @param parsedSkeleton defines the serialized data
  95836. * @param scene defines the hosting scene
  95837. * @returns a new skeleton
  95838. */
  95839. static Parse(parsedSkeleton: any, scene: Scene): Skeleton;
  95840. /**
  95841. * Compute all node absolute transforms
  95842. * @param forceUpdate defines if computation must be done even if cache is up to date
  95843. */
  95844. computeAbsoluteTransforms(forceUpdate?: boolean): void;
  95845. /**
  95846. * Gets the root pose matrix
  95847. * @returns a matrix
  95848. */
  95849. getPoseMatrix(): Nullable<Matrix>;
  95850. /**
  95851. * Sorts bones per internal index
  95852. */
  95853. sortBones(): void;
  95854. private _sortBones;
  95855. }
  95856. }
  95857. declare module BABYLON {
  95858. /**
  95859. * Creates an instance based on a source mesh.
  95860. */
  95861. export class InstancedMesh extends AbstractMesh {
  95862. private _sourceMesh;
  95863. private _currentLOD;
  95864. /** @hidden */
  95865. _indexInSourceMeshInstanceArray: number;
  95866. constructor(name: string, source: Mesh);
  95867. /**
  95868. * Returns the string "InstancedMesh".
  95869. */
  95870. getClassName(): string;
  95871. /** Gets the list of lights affecting that mesh */
  95872. get lightSources(): Light[];
  95873. _resyncLightSources(): void;
  95874. _resyncLightSource(light: Light): void;
  95875. _removeLightSource(light: Light, dispose: boolean): void;
  95876. /**
  95877. * If the source mesh receives shadows
  95878. */
  95879. get receiveShadows(): boolean;
  95880. /**
  95881. * The material of the source mesh
  95882. */
  95883. get material(): Nullable<Material>;
  95884. /**
  95885. * Visibility of the source mesh
  95886. */
  95887. get visibility(): number;
  95888. /**
  95889. * Skeleton of the source mesh
  95890. */
  95891. get skeleton(): Nullable<Skeleton>;
  95892. /**
  95893. * Rendering ground id of the source mesh
  95894. */
  95895. get renderingGroupId(): number;
  95896. set renderingGroupId(value: number);
  95897. /**
  95898. * Returns the total number of vertices (integer).
  95899. */
  95900. getTotalVertices(): number;
  95901. /**
  95902. * Returns a positive integer : the total number of indices in this mesh geometry.
  95903. * @returns the numner of indices or zero if the mesh has no geometry.
  95904. */
  95905. getTotalIndices(): number;
  95906. /**
  95907. * The source mesh of the instance
  95908. */
  95909. get sourceMesh(): Mesh;
  95910. /**
  95911. * Creates a new InstancedMesh object from the mesh model.
  95912. * @see https://doc.babylonjs.com/how_to/how_to_use_instances
  95913. * @param name defines the name of the new instance
  95914. * @returns a new InstancedMesh
  95915. */
  95916. createInstance(name: string): InstancedMesh;
  95917. /**
  95918. * Is this node ready to be used/rendered
  95919. * @param completeCheck defines if a complete check (including materials and lights) has to be done (false by default)
  95920. * @return {boolean} is it ready
  95921. */
  95922. isReady(completeCheck?: boolean): boolean;
  95923. /**
  95924. * Returns an array of integers or a typed array (Int32Array, Uint32Array, Uint16Array) populated with the mesh indices.
  95925. * @param kind kind of verticies to retreive (eg. positons, normals, uvs, etc.)
  95926. * @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.
  95927. * @returns a float array or a Float32Array of the requested kind of data : positons, normals, uvs, etc.
  95928. */
  95929. getVerticesData(kind: string, copyWhenShared?: boolean): Nullable<FloatArray>;
  95930. /**
  95931. * Sets the vertex data of the mesh geometry for the requested `kind`.
  95932. * If the mesh has no geometry, a new Geometry object is set to the mesh and then passed this vertex data.
  95933. * The `data` are either a numeric array either a Float32Array.
  95934. * The parameter `updatable` is passed as is to the underlying Geometry object constructor (if initianilly none) or updater.
  95935. * 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).
  95936. * Note that a new underlying VertexBuffer object is created each call.
  95937. * If the `kind` is the `PositionKind`, the mesh BoundingInfo is renewed, so the bounding box and sphere, and the mesh World Matrix is recomputed.
  95938. *
  95939. * Possible `kind` values :
  95940. * - VertexBuffer.PositionKind
  95941. * - VertexBuffer.UVKind
  95942. * - VertexBuffer.UV2Kind
  95943. * - VertexBuffer.UV3Kind
  95944. * - VertexBuffer.UV4Kind
  95945. * - VertexBuffer.UV5Kind
  95946. * - VertexBuffer.UV6Kind
  95947. * - VertexBuffer.ColorKind
  95948. * - VertexBuffer.MatricesIndicesKind
  95949. * - VertexBuffer.MatricesIndicesExtraKind
  95950. * - VertexBuffer.MatricesWeightsKind
  95951. * - VertexBuffer.MatricesWeightsExtraKind
  95952. *
  95953. * Returns the Mesh.
  95954. */
  95955. setVerticesData(kind: string, data: FloatArray, updatable?: boolean, stride?: number): AbstractMesh;
  95956. /**
  95957. * Updates the existing vertex data of the mesh geometry for the requested `kind`.
  95958. * If the mesh has no geometry, it is simply returned as it is.
  95959. * The `data` are either a numeric array either a Float32Array.
  95960. * No new underlying VertexBuffer object is created.
  95961. * 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.
  95962. * If the parameter `makeItUnique` is true, a new global geometry is created from this positions and is set to the mesh.
  95963. *
  95964. * Possible `kind` values :
  95965. * - VertexBuffer.PositionKind
  95966. * - VertexBuffer.UVKind
  95967. * - VertexBuffer.UV2Kind
  95968. * - VertexBuffer.UV3Kind
  95969. * - VertexBuffer.UV4Kind
  95970. * - VertexBuffer.UV5Kind
  95971. * - VertexBuffer.UV6Kind
  95972. * - VertexBuffer.ColorKind
  95973. * - VertexBuffer.MatricesIndicesKind
  95974. * - VertexBuffer.MatricesIndicesExtraKind
  95975. * - VertexBuffer.MatricesWeightsKind
  95976. * - VertexBuffer.MatricesWeightsExtraKind
  95977. *
  95978. * Returns the Mesh.
  95979. */
  95980. updateVerticesData(kind: string, data: FloatArray, updateExtends?: boolean, makeItUnique?: boolean): Mesh;
  95981. /**
  95982. * Sets the mesh indices.
  95983. * Expects an array populated with integers or a typed array (Int32Array, Uint32Array, Uint16Array).
  95984. * If the mesh has no geometry, a new Geometry object is created and set to the mesh.
  95985. * This method creates a new index buffer each call.
  95986. * Returns the Mesh.
  95987. */
  95988. setIndices(indices: IndicesArray, totalVertices?: Nullable<number>): Mesh;
  95989. /**
  95990. * Boolean : True if the mesh owns the requested kind of data.
  95991. */
  95992. isVerticesDataPresent(kind: string): boolean;
  95993. /**
  95994. * Returns an array of indices (IndicesArray).
  95995. */
  95996. getIndices(): Nullable<IndicesArray>;
  95997. get _positions(): Nullable<Vector3[]>;
  95998. /**
  95999. * This method recomputes and sets a new BoundingInfo to the mesh unless it is locked.
  96000. * This means the mesh underlying bounding box and sphere are recomputed.
  96001. * @param applySkeleton defines whether to apply the skeleton before computing the bounding info
  96002. * @returns the current mesh
  96003. */
  96004. refreshBoundingInfo(applySkeleton?: boolean): InstancedMesh;
  96005. /** @hidden */
  96006. _preActivate(): InstancedMesh;
  96007. /** @hidden */
  96008. _activate(renderId: number, intermediateRendering: boolean): boolean;
  96009. /** @hidden */
  96010. _postActivate(): void;
  96011. getWorldMatrix(): Matrix;
  96012. get isAnInstance(): boolean;
  96013. /**
  96014. * Returns the current associated LOD AbstractMesh.
  96015. */
  96016. getLOD(camera: Camera): AbstractMesh;
  96017. /** @hidden */
  96018. _preActivateForIntermediateRendering(renderId: number): Mesh;
  96019. /** @hidden */
  96020. _syncSubMeshes(): InstancedMesh;
  96021. /** @hidden */
  96022. _generatePointsArray(): boolean;
  96023. /** @hidden */
  96024. _updateBoundingInfo(): AbstractMesh;
  96025. /**
  96026. * Creates a new InstancedMesh from the current mesh.
  96027. * - name (string) : the cloned mesh name
  96028. * - newParent (optional Node) : the optional Node to parent the clone to.
  96029. * - doNotCloneChildren (optional boolean, default `false`) : if `true` the model children aren't cloned.
  96030. *
  96031. * Returns the clone.
  96032. */
  96033. clone(name: string, newParent?: Nullable<Node>, doNotCloneChildren?: boolean): InstancedMesh;
  96034. /**
  96035. * Disposes the InstancedMesh.
  96036. * Returns nothing.
  96037. */
  96038. dispose(doNotRecurse?: boolean, disposeMaterialAndTextures?: boolean): void;
  96039. }
  96040. interface Mesh {
  96041. /**
  96042. * Register a custom buffer that will be instanced
  96043. * @see https://doc.babylonjs.com/how_to/how_to_use_instances#custom-buffers
  96044. * @param kind defines the buffer kind
  96045. * @param stride defines the stride in floats
  96046. */
  96047. registerInstancedBuffer(kind: string, stride: number): void;
  96048. /**
  96049. * true to use the edge renderer for all instances of this mesh
  96050. */
  96051. edgesShareWithInstances: boolean;
  96052. /** @hidden */
  96053. _userInstancedBuffersStorage: {
  96054. data: {
  96055. [key: string]: Float32Array;
  96056. };
  96057. sizes: {
  96058. [key: string]: number;
  96059. };
  96060. vertexBuffers: {
  96061. [key: string]: Nullable<VertexBuffer>;
  96062. };
  96063. strides: {
  96064. [key: string]: number;
  96065. };
  96066. };
  96067. }
  96068. interface AbstractMesh {
  96069. /**
  96070. * Object used to store instanced buffers defined by user
  96071. * @see https://doc.babylonjs.com/how_to/how_to_use_instances#custom-buffers
  96072. */
  96073. instancedBuffers: {
  96074. [key: string]: any;
  96075. };
  96076. }
  96077. }
  96078. declare module BABYLON {
  96079. /**
  96080. * Defines the options associated with the creation of a shader material.
  96081. */
  96082. export interface IShaderMaterialOptions {
  96083. /**
  96084. * Does the material work in alpha blend mode
  96085. */
  96086. needAlphaBlending: boolean;
  96087. /**
  96088. * Does the material work in alpha test mode
  96089. */
  96090. needAlphaTesting: boolean;
  96091. /**
  96092. * The list of attribute names used in the shader
  96093. */
  96094. attributes: string[];
  96095. /**
  96096. * The list of unifrom names used in the shader
  96097. */
  96098. uniforms: string[];
  96099. /**
  96100. * The list of UBO names used in the shader
  96101. */
  96102. uniformBuffers: string[];
  96103. /**
  96104. * The list of sampler names used in the shader
  96105. */
  96106. samplers: string[];
  96107. /**
  96108. * The list of defines used in the shader
  96109. */
  96110. defines: string[];
  96111. }
  96112. /**
  96113. * 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.
  96114. *
  96115. * This returned material effects how the mesh will look based on the code in the shaders.
  96116. *
  96117. * @see https://doc.babylonjs.com/how_to/shader_material
  96118. */
  96119. export class ShaderMaterial extends Material {
  96120. private _shaderPath;
  96121. private _options;
  96122. private _textures;
  96123. private _textureArrays;
  96124. private _floats;
  96125. private _ints;
  96126. private _floatsArrays;
  96127. private _colors3;
  96128. private _colors3Arrays;
  96129. private _colors4;
  96130. private _colors4Arrays;
  96131. private _vectors2;
  96132. private _vectors3;
  96133. private _vectors4;
  96134. private _matrices;
  96135. private _matrixArrays;
  96136. private _matrices3x3;
  96137. private _matrices2x2;
  96138. private _vectors2Arrays;
  96139. private _vectors3Arrays;
  96140. private _vectors4Arrays;
  96141. private _cachedWorldViewMatrix;
  96142. private _cachedWorldViewProjectionMatrix;
  96143. private _renderId;
  96144. private _multiview;
  96145. private _cachedDefines;
  96146. /** Define the Url to load snippets */
  96147. static SnippetUrl: string;
  96148. /** Snippet ID if the material was created from the snippet server */
  96149. snippetId: string;
  96150. /**
  96151. * Instantiate a new shader material.
  96152. * 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.
  96153. * This returned material effects how the mesh will look based on the code in the shaders.
  96154. * @see https://doc.babylonjs.com/how_to/shader_material
  96155. * @param name Define the name of the material in the scene
  96156. * @param scene Define the scene the material belongs to
  96157. * @param shaderPath Defines the route to the shader code in one of three ways:
  96158. * * object: { vertex: "custom", fragment: "custom" }, used with Effect.ShadersStore["customVertexShader"] and Effect.ShadersStore["customFragmentShader"]
  96159. * * object: { vertexElement: "vertexShaderCode", fragmentElement: "fragmentShaderCode" }, used with shader code in script tags
  96160. * * object: { vertexSource: "vertex shader code string", fragmentSource: "fragment shader code string" } using with strings containing the shaders code
  96161. * * string: "./COMMON_NAME", used with external files COMMON_NAME.vertex.fx and COMMON_NAME.fragment.fx in index.html folder.
  96162. * @param options Define the options used to create the shader
  96163. */
  96164. constructor(name: string, scene: Scene, shaderPath: any, options?: Partial<IShaderMaterialOptions>);
  96165. /**
  96166. * Gets the shader path used to define the shader code
  96167. * It can be modified to trigger a new compilation
  96168. */
  96169. get shaderPath(): any;
  96170. /**
  96171. * Sets the shader path used to define the shader code
  96172. * It can be modified to trigger a new compilation
  96173. */
  96174. set shaderPath(shaderPath: any);
  96175. /**
  96176. * Gets the options used to compile the shader.
  96177. * They can be modified to trigger a new compilation
  96178. */
  96179. get options(): IShaderMaterialOptions;
  96180. /**
  96181. * Gets the current class name of the material e.g. "ShaderMaterial"
  96182. * Mainly use in serialization.
  96183. * @returns the class name
  96184. */
  96185. getClassName(): string;
  96186. /**
  96187. * Specifies if the material will require alpha blending
  96188. * @returns a boolean specifying if alpha blending is needed
  96189. */
  96190. needAlphaBlending(): boolean;
  96191. /**
  96192. * Specifies if this material should be rendered in alpha test mode
  96193. * @returns a boolean specifying if an alpha test is needed.
  96194. */
  96195. needAlphaTesting(): boolean;
  96196. private _checkUniform;
  96197. /**
  96198. * Set a texture in the shader.
  96199. * @param name Define the name of the uniform samplers as defined in the shader
  96200. * @param texture Define the texture to bind to this sampler
  96201. * @return the material itself allowing "fluent" like uniform updates
  96202. */
  96203. setTexture(name: string, texture: BaseTexture): ShaderMaterial;
  96204. /**
  96205. * Set a texture array in the shader.
  96206. * @param name Define the name of the uniform sampler array as defined in the shader
  96207. * @param textures Define the list of textures to bind to this sampler
  96208. * @return the material itself allowing "fluent" like uniform updates
  96209. */
  96210. setTextureArray(name: string, textures: BaseTexture[]): ShaderMaterial;
  96211. /**
  96212. * Set a float in the shader.
  96213. * @param name Define the name of the uniform as defined in the shader
  96214. * @param value Define the value to give to the uniform
  96215. * @return the material itself allowing "fluent" like uniform updates
  96216. */
  96217. setFloat(name: string, value: number): ShaderMaterial;
  96218. /**
  96219. * Set a int in the shader.
  96220. * @param name Define the name of the uniform as defined in the shader
  96221. * @param value Define the value to give to the uniform
  96222. * @return the material itself allowing "fluent" like uniform updates
  96223. */
  96224. setInt(name: string, value: number): ShaderMaterial;
  96225. /**
  96226. * Set an array of floats in the shader.
  96227. * @param name Define the name of the uniform as defined in the shader
  96228. * @param value Define the value to give to the uniform
  96229. * @return the material itself allowing "fluent" like uniform updates
  96230. */
  96231. setFloats(name: string, value: number[]): ShaderMaterial;
  96232. /**
  96233. * Set a vec3 in the shader from a Color3.
  96234. * @param name Define the name of the uniform as defined in the shader
  96235. * @param value Define the value to give to the uniform
  96236. * @return the material itself allowing "fluent" like uniform updates
  96237. */
  96238. setColor3(name: string, value: Color3): ShaderMaterial;
  96239. /**
  96240. * Set a vec3 array in the shader from a Color3 array.
  96241. * @param name Define the name of the uniform as defined in the shader
  96242. * @param value Define the value to give to the uniform
  96243. * @return the material itself allowing "fluent" like uniform updates
  96244. */
  96245. setColor3Array(name: string, value: Color3[]): ShaderMaterial;
  96246. /**
  96247. * Set a vec4 in the shader from a Color4.
  96248. * @param name Define the name of the uniform as defined in the shader
  96249. * @param value Define the value to give to the uniform
  96250. * @return the material itself allowing "fluent" like uniform updates
  96251. */
  96252. setColor4(name: string, value: Color4): ShaderMaterial;
  96253. /**
  96254. * Set a vec4 array in the shader from a Color4 array.
  96255. * @param name Define the name of the uniform as defined in the shader
  96256. * @param value Define the value to give to the uniform
  96257. * @return the material itself allowing "fluent" like uniform updates
  96258. */
  96259. setColor4Array(name: string, value: Color4[]): ShaderMaterial;
  96260. /**
  96261. * Set a vec2 in the shader from a Vector2.
  96262. * @param name Define the name of the uniform as defined in the shader
  96263. * @param value Define the value to give to the uniform
  96264. * @return the material itself allowing "fluent" like uniform updates
  96265. */
  96266. setVector2(name: string, value: Vector2): ShaderMaterial;
  96267. /**
  96268. * Set a vec3 in the shader from a Vector3.
  96269. * @param name Define the name of the uniform as defined in the shader
  96270. * @param value Define the value to give to the uniform
  96271. * @return the material itself allowing "fluent" like uniform updates
  96272. */
  96273. setVector3(name: string, value: Vector3): ShaderMaterial;
  96274. /**
  96275. * Set a vec4 in the shader from a Vector4.
  96276. * @param name Define the name of the uniform as defined in the shader
  96277. * @param value Define the value to give to the uniform
  96278. * @return the material itself allowing "fluent" like uniform updates
  96279. */
  96280. setVector4(name: string, value: Vector4): ShaderMaterial;
  96281. /**
  96282. * Set a mat4 in the shader from a Matrix.
  96283. * @param name Define the name of the uniform as defined in the shader
  96284. * @param value Define the value to give to the uniform
  96285. * @return the material itself allowing "fluent" like uniform updates
  96286. */
  96287. setMatrix(name: string, value: Matrix): ShaderMaterial;
  96288. /**
  96289. * Set a float32Array in the shader from a matrix array.
  96290. * @param name Define the name of the uniform as defined in the shader
  96291. * @param value Define the value to give to the uniform
  96292. * @return the material itself allowing "fluent" like uniform updates
  96293. */
  96294. setMatrices(name: string, value: Matrix[]): ShaderMaterial;
  96295. /**
  96296. * Set a mat3 in the shader from a Float32Array.
  96297. * @param name Define the name of the uniform as defined in the shader
  96298. * @param value Define the value to give to the uniform
  96299. * @return the material itself allowing "fluent" like uniform updates
  96300. */
  96301. setMatrix3x3(name: string, value: Float32Array | Array<number>): ShaderMaterial;
  96302. /**
  96303. * Set a mat2 in the shader from a Float32Array.
  96304. * @param name Define the name of the uniform as defined in the shader
  96305. * @param value Define the value to give to the uniform
  96306. * @return the material itself allowing "fluent" like uniform updates
  96307. */
  96308. setMatrix2x2(name: string, value: Float32Array | Array<number>): ShaderMaterial;
  96309. /**
  96310. * Set a vec2 array in the shader from a number array.
  96311. * @param name Define the name of the uniform as defined in the shader
  96312. * @param value Define the value to give to the uniform
  96313. * @return the material itself allowing "fluent" like uniform updates
  96314. */
  96315. setArray2(name: string, value: number[]): ShaderMaterial;
  96316. /**
  96317. * Set a vec3 array in the shader from a number array.
  96318. * @param name Define the name of the uniform as defined in the shader
  96319. * @param value Define the value to give to the uniform
  96320. * @return the material itself allowing "fluent" like uniform updates
  96321. */
  96322. setArray3(name: string, value: number[]): ShaderMaterial;
  96323. /**
  96324. * Set a vec4 array in the shader from a number array.
  96325. * @param name Define the name of the uniform as defined in the shader
  96326. * @param value Define the value to give to the uniform
  96327. * @return the material itself allowing "fluent" like uniform updates
  96328. */
  96329. setArray4(name: string, value: number[]): ShaderMaterial;
  96330. private _checkCache;
  96331. /**
  96332. * Specifies that the submesh is ready to be used
  96333. * @param mesh defines the mesh to check
  96334. * @param subMesh defines which submesh to check
  96335. * @param useInstances specifies that instances should be used
  96336. * @returns a boolean indicating that the submesh is ready or not
  96337. */
  96338. isReadyForSubMesh(mesh: AbstractMesh, subMesh: SubMesh, useInstances?: boolean): boolean;
  96339. /**
  96340. * Checks if the material is ready to render the requested mesh
  96341. * @param mesh Define the mesh to render
  96342. * @param useInstances Define whether or not the material is used with instances
  96343. * @returns true if ready, otherwise false
  96344. */
  96345. isReady(mesh?: AbstractMesh, useInstances?: boolean): boolean;
  96346. /**
  96347. * Binds the world matrix to the material
  96348. * @param world defines the world transformation matrix
  96349. * @param effectOverride - If provided, use this effect instead of internal effect
  96350. */
  96351. bindOnlyWorldMatrix(world: Matrix, effectOverride?: Nullable<Effect>): void;
  96352. /**
  96353. * Binds the submesh to this material by preparing the effect and shader to draw
  96354. * @param world defines the world transformation matrix
  96355. * @param mesh defines the mesh containing the submesh
  96356. * @param subMesh defines the submesh to bind the material to
  96357. */
  96358. bindForSubMesh(world: Matrix, mesh: Mesh, subMesh: SubMesh): void;
  96359. /**
  96360. * Binds the material to the mesh
  96361. * @param world defines the world transformation matrix
  96362. * @param mesh defines the mesh to bind the material to
  96363. * @param effectOverride - If provided, use this effect instead of internal effect
  96364. */
  96365. bind(world: Matrix, mesh?: Mesh, effectOverride?: Nullable<Effect>): void;
  96366. protected _afterBind(mesh?: Mesh): void;
  96367. /**
  96368. * Gets the active textures from the material
  96369. * @returns an array of textures
  96370. */
  96371. getActiveTextures(): BaseTexture[];
  96372. /**
  96373. * Specifies if the material uses a texture
  96374. * @param texture defines the texture to check against the material
  96375. * @returns a boolean specifying if the material uses the texture
  96376. */
  96377. hasTexture(texture: BaseTexture): boolean;
  96378. /**
  96379. * Makes a duplicate of the material, and gives it a new name
  96380. * @param name defines the new name for the duplicated material
  96381. * @returns the cloned material
  96382. */
  96383. clone(name: string): ShaderMaterial;
  96384. /**
  96385. * Disposes the material
  96386. * @param forceDisposeEffect specifies if effects should be forcefully disposed
  96387. * @param forceDisposeTextures specifies if textures should be forcefully disposed
  96388. * @param notBoundToMesh specifies if the material that is being disposed is known to be not bound to any mesh
  96389. */
  96390. dispose(forceDisposeEffect?: boolean, forceDisposeTextures?: boolean, notBoundToMesh?: boolean): void;
  96391. /**
  96392. * Serializes this material in a JSON representation
  96393. * @returns the serialized material object
  96394. */
  96395. serialize(): any;
  96396. /**
  96397. * Creates a shader material from parsed shader material data
  96398. * @param source defines the JSON represnetation of the material
  96399. * @param scene defines the hosting scene
  96400. * @param rootUrl defines the root URL to use to load textures and relative dependencies
  96401. * @returns a new material
  96402. */
  96403. static Parse(source: any, scene: Scene, rootUrl: string): ShaderMaterial;
  96404. /**
  96405. * Creates a new ShaderMaterial from a snippet saved in a remote file
  96406. * @param name defines the name of the ShaderMaterial to create (can be null or empty to use the one from the json data)
  96407. * @param url defines the url to load from
  96408. * @param scene defines the hosting scene
  96409. * @param rootUrl defines the root URL to use to load textures and relative dependencies
  96410. * @returns a promise that will resolve to the new ShaderMaterial
  96411. */
  96412. static ParseFromFileAsync(name: Nullable<string>, url: string, scene: Scene, rootUrl?: string): Promise<ShaderMaterial>;
  96413. /**
  96414. * Creates a ShaderMaterial from a snippet saved by the Inspector
  96415. * @param snippetId defines the snippet to load
  96416. * @param scene defines the hosting scene
  96417. * @param rootUrl defines the root URL to use to load textures and relative dependencies
  96418. * @returns a promise that will resolve to the new ShaderMaterial
  96419. */
  96420. static CreateFromSnippetAsync(snippetId: string, scene: Scene, rootUrl?: string): Promise<ShaderMaterial>;
  96421. }
  96422. }
  96423. declare module BABYLON {
  96424. /** @hidden */
  96425. export var colorPixelShader: {
  96426. name: string;
  96427. shader: string;
  96428. };
  96429. }
  96430. declare module BABYLON {
  96431. /** @hidden */
  96432. export var colorVertexShader: {
  96433. name: string;
  96434. shader: string;
  96435. };
  96436. }
  96437. declare module BABYLON {
  96438. /**
  96439. * Line mesh
  96440. * @see https://doc.babylonjs.com/babylon101/parametric_shapes
  96441. */
  96442. export class LinesMesh extends Mesh {
  96443. /**
  96444. * If vertex color should be applied to the mesh
  96445. */
  96446. readonly useVertexColor?: boolean | undefined;
  96447. /**
  96448. * If vertex alpha should be applied to the mesh
  96449. */
  96450. readonly useVertexAlpha?: boolean | undefined;
  96451. /**
  96452. * Color of the line (Default: White)
  96453. */
  96454. color: Color3;
  96455. /**
  96456. * Alpha of the line (Default: 1)
  96457. */
  96458. alpha: number;
  96459. /**
  96460. * The intersection Threshold is the margin applied when intersection a segment of the LinesMesh with a Ray.
  96461. * This margin is expressed in world space coordinates, so its value may vary.
  96462. * Default value is 0.1
  96463. */
  96464. intersectionThreshold: number;
  96465. private _colorShader;
  96466. private color4;
  96467. /**
  96468. * Creates a new LinesMesh
  96469. * @param name defines the name
  96470. * @param scene defines the hosting scene
  96471. * @param parent defines the parent mesh if any
  96472. * @param source defines the optional source LinesMesh used to clone data from
  96473. * @param doNotCloneChildren When cloning, skip cloning child meshes of source, default False.
  96474. * When false, achieved by calling a clone(), also passing False.
  96475. * This will make creation of children, recursive.
  96476. * @param useVertexColor defines if this LinesMesh supports vertex color
  96477. * @param useVertexAlpha defines if this LinesMesh supports vertex alpha
  96478. */
  96479. constructor(name: string, scene?: Nullable<Scene>, parent?: Nullable<Node>, source?: Nullable<LinesMesh>, doNotCloneChildren?: boolean,
  96480. /**
  96481. * If vertex color should be applied to the mesh
  96482. */
  96483. useVertexColor?: boolean | undefined,
  96484. /**
  96485. * If vertex alpha should be applied to the mesh
  96486. */
  96487. useVertexAlpha?: boolean | undefined);
  96488. private _addClipPlaneDefine;
  96489. private _removeClipPlaneDefine;
  96490. isReady(): boolean;
  96491. /**
  96492. * Returns the string "LineMesh"
  96493. */
  96494. getClassName(): string;
  96495. /**
  96496. * @hidden
  96497. */
  96498. get material(): Material;
  96499. /**
  96500. * @hidden
  96501. */
  96502. set material(value: Material);
  96503. /**
  96504. * @hidden
  96505. */
  96506. get checkCollisions(): boolean;
  96507. /** @hidden */
  96508. _bind(subMesh: SubMesh, effect: Effect, fillMode: number): Mesh;
  96509. /** @hidden */
  96510. _draw(subMesh: SubMesh, fillMode: number, instancesCount?: number): Mesh;
  96511. /**
  96512. * Disposes of the line mesh
  96513. * @param doNotRecurse If children should be disposed
  96514. */
  96515. dispose(doNotRecurse?: boolean): void;
  96516. /**
  96517. * Returns a new LineMesh object cloned from the current one.
  96518. */
  96519. clone(name: string, newParent?: Nullable<Node>, doNotCloneChildren?: boolean): LinesMesh;
  96520. /**
  96521. * Creates a new InstancedLinesMesh object from the mesh model.
  96522. * @see https://doc.babylonjs.com/how_to/how_to_use_instances
  96523. * @param name defines the name of the new instance
  96524. * @returns a new InstancedLinesMesh
  96525. */
  96526. createInstance(name: string): InstancedLinesMesh;
  96527. }
  96528. /**
  96529. * Creates an instance based on a source LinesMesh
  96530. */
  96531. export class InstancedLinesMesh extends InstancedMesh {
  96532. /**
  96533. * The intersection Threshold is the margin applied when intersection a segment of the LinesMesh with a Ray.
  96534. * This margin is expressed in world space coordinates, so its value may vary.
  96535. * Initilized with the intersectionThreshold value of the source LinesMesh
  96536. */
  96537. intersectionThreshold: number;
  96538. constructor(name: string, source: LinesMesh);
  96539. /**
  96540. * Returns the string "InstancedLinesMesh".
  96541. */
  96542. getClassName(): string;
  96543. }
  96544. }
  96545. declare module BABYLON {
  96546. /** @hidden */
  96547. export var linePixelShader: {
  96548. name: string;
  96549. shader: string;
  96550. };
  96551. }
  96552. declare module BABYLON {
  96553. /** @hidden */
  96554. export var lineVertexShader: {
  96555. name: string;
  96556. shader: string;
  96557. };
  96558. }
  96559. declare module BABYLON {
  96560. interface Scene {
  96561. /** @hidden */
  96562. _edgeRenderLineShader: Nullable<ShaderMaterial>;
  96563. }
  96564. interface AbstractMesh {
  96565. /**
  96566. * Gets the edgesRenderer associated with the mesh
  96567. */
  96568. edgesRenderer: Nullable<EdgesRenderer>;
  96569. }
  96570. interface LinesMesh {
  96571. /**
  96572. * Enables the edge rendering mode on the mesh.
  96573. * This mode makes the mesh edges visible
  96574. * @param epsilon defines the maximal distance between two angles to detect a face
  96575. * @param checkVerticesInsteadOfIndices indicates that we should check vertex list directly instead of faces
  96576. * @returns the currentAbstractMesh
  96577. * @see https://www.babylonjs-playground.com/#19O9TU#0
  96578. */
  96579. enableEdgesRendering(epsilon?: number, checkVerticesInsteadOfIndices?: boolean): AbstractMesh;
  96580. }
  96581. interface InstancedLinesMesh {
  96582. /**
  96583. * Enables the edge rendering mode on the mesh.
  96584. * This mode makes the mesh edges visible
  96585. * @param epsilon defines the maximal distance between two angles to detect a face
  96586. * @param checkVerticesInsteadOfIndices indicates that we should check vertex list directly instead of faces
  96587. * @returns the current InstancedLinesMesh
  96588. * @see https://www.babylonjs-playground.com/#19O9TU#0
  96589. */
  96590. enableEdgesRendering(epsilon?: number, checkVerticesInsteadOfIndices?: boolean): InstancedLinesMesh;
  96591. }
  96592. /**
  96593. * Defines the minimum contract an Edges renderer should follow.
  96594. */
  96595. export interface IEdgesRenderer extends IDisposable {
  96596. /**
  96597. * Gets or sets a boolean indicating if the edgesRenderer is active
  96598. */
  96599. isEnabled: boolean;
  96600. /**
  96601. * Renders the edges of the attached mesh,
  96602. */
  96603. render(): void;
  96604. /**
  96605. * Checks wether or not the edges renderer is ready to render.
  96606. * @return true if ready, otherwise false.
  96607. */
  96608. isReady(): boolean;
  96609. /**
  96610. * List of instances to render in case the source mesh has instances
  96611. */
  96612. customInstances: SmartArray<Matrix>;
  96613. }
  96614. /**
  96615. * Defines the additional options of the edges renderer
  96616. */
  96617. export interface IEdgesRendererOptions {
  96618. /**
  96619. * Gets or sets a boolean indicating that the alternate edge finder algorithm must be used
  96620. * If not defined, the default value is true
  96621. */
  96622. useAlternateEdgeFinder?: boolean;
  96623. /**
  96624. * Gets or sets a boolean indicating that the vertex merger fast processing must be used.
  96625. * If not defined, the default value is true.
  96626. * 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)
  96627. * This option is used only if useAlternateEdgeFinder = true
  96628. */
  96629. useFastVertexMerger?: boolean;
  96630. /**
  96631. * During edges processing, the vertices are merged if they are close enough: epsilonVertexMerge is the limit whithin which vertices are considered to be equal.
  96632. * The default value is 1e-6
  96633. * This option is used only if useAlternateEdgeFinder = true
  96634. */
  96635. epsilonVertexMerge?: number;
  96636. /**
  96637. * 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
  96638. * 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.
  96639. * This option is used only if useAlternateEdgeFinder = true
  96640. */
  96641. applyTessellation?: boolean;
  96642. /**
  96643. * 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
  96644. * The default value is 1e-6
  96645. * This option is used only if useAlternateEdgeFinder = true
  96646. */
  96647. epsilonVertexAligned?: number;
  96648. }
  96649. /**
  96650. * This class is used to generate edges of the mesh that could then easily be rendered in a scene.
  96651. */
  96652. export class EdgesRenderer implements IEdgesRenderer {
  96653. /**
  96654. * Define the size of the edges with an orthographic camera
  96655. */
  96656. edgesWidthScalerForOrthographic: number;
  96657. /**
  96658. * Define the size of the edges with a perspective camera
  96659. */
  96660. edgesWidthScalerForPerspective: number;
  96661. protected _source: AbstractMesh;
  96662. protected _linesPositions: number[];
  96663. protected _linesNormals: number[];
  96664. protected _linesIndices: number[];
  96665. protected _epsilon: number;
  96666. protected _indicesCount: number;
  96667. protected _lineShader: ShaderMaterial;
  96668. protected _ib: DataBuffer;
  96669. protected _buffers: {
  96670. [key: string]: Nullable<VertexBuffer>;
  96671. };
  96672. protected _buffersForInstances: {
  96673. [key: string]: Nullable<VertexBuffer>;
  96674. };
  96675. protected _checkVerticesInsteadOfIndices: boolean;
  96676. protected _options: Nullable<IEdgesRendererOptions>;
  96677. private _meshRebuildObserver;
  96678. private _meshDisposeObserver;
  96679. /** Gets or sets a boolean indicating if the edgesRenderer is active */
  96680. isEnabled: boolean;
  96681. /**
  96682. * List of instances to render in case the source mesh has instances
  96683. */
  96684. customInstances: SmartArray<Matrix>;
  96685. private static GetShader;
  96686. /**
  96687. * Creates an instance of the EdgesRenderer. It is primarily use to display edges of a mesh.
  96688. * Beware when you use this class with complex objects as the adjacencies computation can be really long
  96689. * @param source Mesh used to create edges
  96690. * @param epsilon sum of angles in adjacency to check for edge
  96691. * @param checkVerticesInsteadOfIndices bases the edges detection on vertices vs indices. Note that this parameter is not used if options.useAlternateEdgeFinder = true
  96692. * @param generateEdgesLines - should generate Lines or only prepare resources.
  96693. * @param options The options to apply when generating the edges
  96694. */
  96695. constructor(source: AbstractMesh, epsilon?: number, checkVerticesInsteadOfIndices?: boolean, generateEdgesLines?: boolean, options?: IEdgesRendererOptions);
  96696. protected _prepareRessources(): void;
  96697. /** @hidden */
  96698. _rebuild(): void;
  96699. /**
  96700. * Releases the required resources for the edges renderer
  96701. */
  96702. dispose(): void;
  96703. protected _processEdgeForAdjacencies(pa: number, pb: number, p0: number, p1: number, p2: number): number;
  96704. protected _processEdgeForAdjacenciesWithVertices(pa: Vector3, pb: Vector3, p0: Vector3, p1: Vector3, p2: Vector3): number;
  96705. /**
  96706. * Checks if the pair of p0 and p1 is en edge
  96707. * @param faceIndex
  96708. * @param edge
  96709. * @param faceNormals
  96710. * @param p0
  96711. * @param p1
  96712. * @private
  96713. */
  96714. protected _checkEdge(faceIndex: number, edge: number, faceNormals: Array<Vector3>, p0: Vector3, p1: Vector3): void;
  96715. /**
  96716. * push line into the position, normal and index buffer
  96717. * @protected
  96718. */
  96719. protected createLine(p0: Vector3, p1: Vector3, offset: number): void;
  96720. /**
  96721. * See https://playground.babylonjs.com/#R3JR6V#1 for a visual display of the algorithm
  96722. */
  96723. private _tessellateTriangle;
  96724. private _generateEdgesLinesAlternate;
  96725. /**
  96726. * Generates lines edges from adjacencjes
  96727. * @private
  96728. */
  96729. _generateEdgesLines(): void;
  96730. /**
  96731. * Checks wether or not the edges renderer is ready to render.
  96732. * @return true if ready, otherwise false.
  96733. */
  96734. isReady(): boolean;
  96735. /**
  96736. * Renders the edges of the attached mesh,
  96737. */
  96738. render(): void;
  96739. }
  96740. /**
  96741. * LineEdgesRenderer for LineMeshes to remove unnecessary triangulation
  96742. */
  96743. export class LineEdgesRenderer extends EdgesRenderer {
  96744. /**
  96745. * This constructor turns off auto generating edges line in Edges Renderer to make it here.
  96746. * @param source LineMesh used to generate edges
  96747. * @param epsilon not important (specified angle for edge detection)
  96748. * @param checkVerticesInsteadOfIndices not important for LineMesh
  96749. */
  96750. constructor(source: AbstractMesh, epsilon?: number, checkVerticesInsteadOfIndices?: boolean);
  96751. /**
  96752. * Generate edges for each line in LinesMesh. Every Line should be rendered as edge.
  96753. */
  96754. _generateEdgesLines(): void;
  96755. }
  96756. }
  96757. declare module BABYLON {
  96758. /**
  96759. * This represents the object necessary to create a rendering group.
  96760. * This is exclusively used and created by the rendering manager.
  96761. * To modify the behavior, you use the available helpers in your scene or meshes.
  96762. * @hidden
  96763. */
  96764. export class RenderingGroup {
  96765. index: number;
  96766. private static _zeroVector;
  96767. private _scene;
  96768. private _opaqueSubMeshes;
  96769. private _transparentSubMeshes;
  96770. private _alphaTestSubMeshes;
  96771. private _depthOnlySubMeshes;
  96772. private _particleSystems;
  96773. private _spriteManagers;
  96774. private _opaqueSortCompareFn;
  96775. private _alphaTestSortCompareFn;
  96776. private _transparentSortCompareFn;
  96777. private _renderOpaque;
  96778. private _renderAlphaTest;
  96779. private _renderTransparent;
  96780. /** @hidden */
  96781. _edgesRenderers: SmartArrayNoDuplicate<IEdgesRenderer>;
  96782. onBeforeTransparentRendering: () => void;
  96783. /**
  96784. * Set the opaque sort comparison function.
  96785. * If null the sub meshes will be render in the order they were created
  96786. */
  96787. set opaqueSortCompareFn(value: Nullable<(a: SubMesh, b: SubMesh) => number>);
  96788. /**
  96789. * Set the alpha test sort comparison function.
  96790. * If null the sub meshes will be render in the order they were created
  96791. */
  96792. set alphaTestSortCompareFn(value: Nullable<(a: SubMesh, b: SubMesh) => number>);
  96793. /**
  96794. * Set the transparent sort comparison function.
  96795. * If null the sub meshes will be render in the order they were created
  96796. */
  96797. set transparentSortCompareFn(value: Nullable<(a: SubMesh, b: SubMesh) => number>);
  96798. /**
  96799. * Creates a new rendering group.
  96800. * @param index The rendering group index
  96801. * @param opaqueSortCompareFn The opaque sort comparison function. If null no order is applied
  96802. * @param alphaTestSortCompareFn The alpha test sort comparison function. If null no order is applied
  96803. * @param transparentSortCompareFn The transparent sort comparison function. If null back to front + alpha index sort is applied
  96804. */
  96805. 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>);
  96806. /**
  96807. * Render all the sub meshes contained in the group.
  96808. * @param customRenderFunction Used to override the default render behaviour of the group.
  96809. * @returns true if rendered some submeshes.
  96810. */
  96811. render(customRenderFunction: Nullable<(opaqueSubMeshes: SmartArray<SubMesh>, transparentSubMeshes: SmartArray<SubMesh>, alphaTestSubMeshes: SmartArray<SubMesh>, depthOnlySubMeshes: SmartArray<SubMesh>) => void>, renderSprites: boolean, renderParticles: boolean, activeMeshes: Nullable<AbstractMesh[]>): void;
  96812. /**
  96813. * Renders the opaque submeshes in the order from the opaqueSortCompareFn.
  96814. * @param subMeshes The submeshes to render
  96815. */
  96816. private renderOpaqueSorted;
  96817. /**
  96818. * Renders the opaque submeshes in the order from the alphatestSortCompareFn.
  96819. * @param subMeshes The submeshes to render
  96820. */
  96821. private renderAlphaTestSorted;
  96822. /**
  96823. * Renders the opaque submeshes in the order from the transparentSortCompareFn.
  96824. * @param subMeshes The submeshes to render
  96825. */
  96826. private renderTransparentSorted;
  96827. /**
  96828. * Renders the submeshes in a specified order.
  96829. * @param subMeshes The submeshes to sort before render
  96830. * @param sortCompareFn The comparison function use to sort
  96831. * @param cameraPosition The camera position use to preprocess the submeshes to help sorting
  96832. * @param transparent Specifies to activate blending if true
  96833. */
  96834. private static renderSorted;
  96835. /**
  96836. * Renders the submeshes in the order they were dispatched (no sort applied).
  96837. * @param subMeshes The submeshes to render
  96838. */
  96839. private static renderUnsorted;
  96840. /**
  96841. * Build in function which can be applied to ensure meshes of a special queue (opaque, alpha test, transparent)
  96842. * are rendered back to front if in the same alpha index.
  96843. *
  96844. * @param a The first submesh
  96845. * @param b The second submesh
  96846. * @returns The result of the comparison
  96847. */
  96848. static defaultTransparentSortCompare(a: SubMesh, b: SubMesh): number;
  96849. /**
  96850. * Build in function which can be applied to ensure meshes of a special queue (opaque, alpha test, transparent)
  96851. * are rendered back to front.
  96852. *
  96853. * @param a The first submesh
  96854. * @param b The second submesh
  96855. * @returns The result of the comparison
  96856. */
  96857. static backToFrontSortCompare(a: SubMesh, b: SubMesh): number;
  96858. /**
  96859. * Build in function which can be applied to ensure meshes of a special queue (opaque, alpha test, transparent)
  96860. * are rendered front to back (prevent overdraw).
  96861. *
  96862. * @param a The first submesh
  96863. * @param b The second submesh
  96864. * @returns The result of the comparison
  96865. */
  96866. static frontToBackSortCompare(a: SubMesh, b: SubMesh): number;
  96867. /**
  96868. * Resets the different lists of submeshes to prepare a new frame.
  96869. */
  96870. prepare(): void;
  96871. dispose(): void;
  96872. /**
  96873. * Inserts the submesh in its correct queue depending on its material.
  96874. * @param subMesh The submesh to dispatch
  96875. * @param [mesh] Optional reference to the submeshes's mesh. Provide if you have an exiting reference to improve performance.
  96876. * @param [material] Optional reference to the submeshes's material. Provide if you have an exiting reference to improve performance.
  96877. */
  96878. dispatch(subMesh: SubMesh, mesh?: AbstractMesh, material?: Nullable<Material>): void;
  96879. dispatchSprites(spriteManager: ISpriteManager): void;
  96880. dispatchParticles(particleSystem: IParticleSystem): void;
  96881. private _renderParticles;
  96882. private _renderSprites;
  96883. }
  96884. }
  96885. declare module BABYLON {
  96886. /**
  96887. * Interface describing the different options available in the rendering manager
  96888. * regarding Auto Clear between groups.
  96889. */
  96890. export interface IRenderingManagerAutoClearSetup {
  96891. /**
  96892. * Defines whether or not autoclear is enable.
  96893. */
  96894. autoClear: boolean;
  96895. /**
  96896. * Defines whether or not to autoclear the depth buffer.
  96897. */
  96898. depth: boolean;
  96899. /**
  96900. * Defines whether or not to autoclear the stencil buffer.
  96901. */
  96902. stencil: boolean;
  96903. }
  96904. /**
  96905. * This class is used by the onRenderingGroupObservable
  96906. */
  96907. export class RenderingGroupInfo {
  96908. /**
  96909. * The Scene that being rendered
  96910. */
  96911. scene: Scene;
  96912. /**
  96913. * The camera currently used for the rendering pass
  96914. */
  96915. camera: Nullable<Camera>;
  96916. /**
  96917. * The ID of the renderingGroup being processed
  96918. */
  96919. renderingGroupId: number;
  96920. }
  96921. /**
  96922. * This is the manager responsible of all the rendering for meshes sprites and particles.
  96923. * It is enable to manage the different groups as well as the different necessary sort functions.
  96924. * This should not be used directly aside of the few static configurations
  96925. */
  96926. export class RenderingManager {
  96927. /**
  96928. * The max id used for rendering groups (not included)
  96929. */
  96930. static MAX_RENDERINGGROUPS: number;
  96931. /**
  96932. * The min id used for rendering groups (included)
  96933. */
  96934. static MIN_RENDERINGGROUPS: number;
  96935. /**
  96936. * Used to globally prevent autoclearing scenes.
  96937. */
  96938. static AUTOCLEAR: boolean;
  96939. /**
  96940. * @hidden
  96941. */
  96942. _useSceneAutoClearSetup: boolean;
  96943. private _scene;
  96944. private _renderingGroups;
  96945. private _depthStencilBufferAlreadyCleaned;
  96946. private _autoClearDepthStencil;
  96947. private _customOpaqueSortCompareFn;
  96948. private _customAlphaTestSortCompareFn;
  96949. private _customTransparentSortCompareFn;
  96950. private _renderingGroupInfo;
  96951. /**
  96952. * Instantiates a new rendering group for a particular scene
  96953. * @param scene Defines the scene the groups belongs to
  96954. */
  96955. constructor(scene: Scene);
  96956. private _clearDepthStencilBuffer;
  96957. /**
  96958. * Renders the entire managed groups. This is used by the scene or the different rennder targets.
  96959. * @hidden
  96960. */
  96961. render(customRenderFunction: Nullable<(opaqueSubMeshes: SmartArray<SubMesh>, transparentSubMeshes: SmartArray<SubMesh>, alphaTestSubMeshes: SmartArray<SubMesh>, depthOnlySubMeshes: SmartArray<SubMesh>) => void>, activeMeshes: Nullable<AbstractMesh[]>, renderParticles: boolean, renderSprites: boolean): void;
  96962. /**
  96963. * Resets the different information of the group to prepare a new frame
  96964. * @hidden
  96965. */
  96966. reset(): void;
  96967. /**
  96968. * Dispose and release the group and its associated resources.
  96969. * @hidden
  96970. */
  96971. dispose(): void;
  96972. /**
  96973. * Clear the info related to rendering groups preventing retention points during dispose.
  96974. */
  96975. freeRenderingGroups(): void;
  96976. private _prepareRenderingGroup;
  96977. /**
  96978. * Add a sprite manager to the rendering manager in order to render it this frame.
  96979. * @param spriteManager Define the sprite manager to render
  96980. */
  96981. dispatchSprites(spriteManager: ISpriteManager): void;
  96982. /**
  96983. * Add a particle system to the rendering manager in order to render it this frame.
  96984. * @param particleSystem Define the particle system to render
  96985. */
  96986. dispatchParticles(particleSystem: IParticleSystem): void;
  96987. /**
  96988. * Add a submesh to the manager in order to render it this frame
  96989. * @param subMesh The submesh to dispatch
  96990. * @param mesh Optional reference to the submeshes's mesh. Provide if you have an exiting reference to improve performance.
  96991. * @param material Optional reference to the submeshes's material. Provide if you have an exiting reference to improve performance.
  96992. */
  96993. dispatch(subMesh: SubMesh, mesh?: AbstractMesh, material?: Nullable<Material>): void;
  96994. /**
  96995. * Overrides the default sort function applied in the renderging group to prepare the meshes.
  96996. * This allowed control for front to back rendering or reversly depending of the special needs.
  96997. *
  96998. * @param renderingGroupId The rendering group id corresponding to its index
  96999. * @param opaqueSortCompareFn The opaque queue comparison function use to sort.
  97000. * @param alphaTestSortCompareFn The alpha test queue comparison function use to sort.
  97001. * @param transparentSortCompareFn The transparent queue comparison function use to sort.
  97002. */
  97003. 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;
  97004. /**
  97005. * Specifies whether or not the stencil and depth buffer are cleared between two rendering groups.
  97006. *
  97007. * @param renderingGroupId The rendering group id corresponding to its index
  97008. * @param autoClearDepthStencil Automatically clears depth and stencil between groups if true.
  97009. * @param depth Automatically clears depth between groups if true and autoClear is true.
  97010. * @param stencil Automatically clears stencil between groups if true and autoClear is true.
  97011. */
  97012. setRenderingAutoClearDepthStencil(renderingGroupId: number, autoClearDepthStencil: boolean, depth?: boolean, stencil?: boolean): void;
  97013. /**
  97014. * Gets the current auto clear configuration for one rendering group of the rendering
  97015. * manager.
  97016. * @param index the rendering group index to get the information for
  97017. * @returns The auto clear setup for the requested rendering group
  97018. */
  97019. getAutoClearDepthStencilSetup(index: number): IRenderingManagerAutoClearSetup;
  97020. }
  97021. }
  97022. declare module BABYLON {
  97023. /**
  97024. * Defines the options associated with the creation of a custom shader for a shadow generator.
  97025. */
  97026. export interface ICustomShaderOptions {
  97027. /**
  97028. * Gets or sets the custom shader name to use
  97029. */
  97030. shaderName: string;
  97031. /**
  97032. * The list of attribute names used in the shader
  97033. */
  97034. attributes?: string[];
  97035. /**
  97036. * The list of unifrom names used in the shader
  97037. */
  97038. uniforms?: string[];
  97039. /**
  97040. * The list of sampler names used in the shader
  97041. */
  97042. samplers?: string[];
  97043. /**
  97044. * The list of defines used in the shader
  97045. */
  97046. defines?: string[];
  97047. }
  97048. /**
  97049. * Interface to implement to create a shadow generator compatible with BJS.
  97050. */
  97051. export interface IShadowGenerator {
  97052. /** Gets or set the id of the shadow generator. It will be the one from the light if not defined */
  97053. id: string;
  97054. /**
  97055. * Gets the main RTT containing the shadow map (usually storing depth from the light point of view).
  97056. * @returns The render target texture if present otherwise, null
  97057. */
  97058. getShadowMap(): Nullable<RenderTargetTexture>;
  97059. /**
  97060. * Determine wheter the shadow generator is ready or not (mainly all effects and related post processes needs to be ready).
  97061. * @param subMesh The submesh we want to render in the shadow map
  97062. * @param useInstances Defines wether will draw in the map using instances
  97063. * @param isTransparent Indicates that isReady is called for a transparent subMesh
  97064. * @returns true if ready otherwise, false
  97065. */
  97066. isReady(subMesh: SubMesh, useInstances: boolean, isTransparent: boolean): boolean;
  97067. /**
  97068. * Prepare all the defines in a material relying on a shadow map at the specified light index.
  97069. * @param defines Defines of the material we want to update
  97070. * @param lightIndex Index of the light in the enabled light list of the material
  97071. */
  97072. prepareDefines(defines: MaterialDefines, lightIndex: number): void;
  97073. /**
  97074. * Binds the shadow related information inside of an effect (information like near, far, darkness...
  97075. * defined in the generator but impacting the effect).
  97076. * It implies the unifroms available on the materials are the standard BJS ones.
  97077. * @param lightIndex Index of the light in the enabled light list of the material owning the effect
  97078. * @param effect The effect we are binfing the information for
  97079. */
  97080. bindShadowLight(lightIndex: string, effect: Effect): void;
  97081. /**
  97082. * Gets the transformation matrix used to project the meshes into the map from the light point of view.
  97083. * (eq to shadow prjection matrix * light transform matrix)
  97084. * @returns The transform matrix used to create the shadow map
  97085. */
  97086. getTransformMatrix(): Matrix;
  97087. /**
  97088. * Recreates the shadow map dependencies like RTT and post processes. This can be used during the switch between
  97089. * Cube and 2D textures for instance.
  97090. */
  97091. recreateShadowMap(): void;
  97092. /**
  97093. * Forces all the attached effect to compile to enable rendering only once ready vs. lazyly compiling effects.
  97094. * @param onCompiled Callback triggered at the and of the effects compilation
  97095. * @param options Sets of optional options forcing the compilation with different modes
  97096. */
  97097. forceCompilation(onCompiled?: (generator: IShadowGenerator) => void, options?: Partial<{
  97098. useInstances: boolean;
  97099. }>): void;
  97100. /**
  97101. * Forces all the attached effect to compile to enable rendering only once ready vs. lazyly compiling effects.
  97102. * @param options Sets of optional options forcing the compilation with different modes
  97103. * @returns A promise that resolves when the compilation completes
  97104. */
  97105. forceCompilationAsync(options?: Partial<{
  97106. useInstances: boolean;
  97107. }>): Promise<void>;
  97108. /**
  97109. * Serializes the shadow generator setup to a json object.
  97110. * @returns The serialized JSON object
  97111. */
  97112. serialize(): any;
  97113. /**
  97114. * Disposes the Shadow map and related Textures and effects.
  97115. */
  97116. dispose(): void;
  97117. }
  97118. /**
  97119. * Default implementation IShadowGenerator.
  97120. * This is the main object responsible of generating shadows in the framework.
  97121. * Documentation: https://doc.babylonjs.com/babylon101/shadows
  97122. */
  97123. export class ShadowGenerator implements IShadowGenerator {
  97124. /**
  97125. * Name of the shadow generator class
  97126. */
  97127. static CLASSNAME: string;
  97128. /**
  97129. * Shadow generator mode None: no filtering applied.
  97130. */
  97131. static readonly FILTER_NONE: number;
  97132. /**
  97133. * Shadow generator mode ESM: Exponential Shadow Mapping.
  97134. * (http://developer.download.nvidia.com/presentations/2008/GDC/GDC08_SoftShadowMapping.pdf)
  97135. */
  97136. static readonly FILTER_EXPONENTIALSHADOWMAP: number;
  97137. /**
  97138. * Shadow generator mode Poisson Sampling: Percentage Closer Filtering.
  97139. * (Multiple Tap around evenly distributed around the pixel are used to evaluate the shadow strength)
  97140. */
  97141. static readonly FILTER_POISSONSAMPLING: number;
  97142. /**
  97143. * Shadow generator mode ESM: Blurred Exponential Shadow Mapping.
  97144. * (http://developer.download.nvidia.com/presentations/2008/GDC/GDC08_SoftShadowMapping.pdf)
  97145. */
  97146. static readonly FILTER_BLUREXPONENTIALSHADOWMAP: number;
  97147. /**
  97148. * Shadow generator mode ESM: Exponential Shadow Mapping using the inverse of the exponential preventing
  97149. * edge artifacts on steep falloff.
  97150. * (http://developer.download.nvidia.com/presentations/2008/GDC/GDC08_SoftShadowMapping.pdf)
  97151. */
  97152. static readonly FILTER_CLOSEEXPONENTIALSHADOWMAP: number;
  97153. /**
  97154. * Shadow generator mode ESM: Blurred Exponential Shadow Mapping using the inverse of the exponential preventing
  97155. * edge artifacts on steep falloff.
  97156. * (http://developer.download.nvidia.com/presentations/2008/GDC/GDC08_SoftShadowMapping.pdf)
  97157. */
  97158. static readonly FILTER_BLURCLOSEEXPONENTIALSHADOWMAP: number;
  97159. /**
  97160. * Shadow generator mode PCF: Percentage Closer Filtering
  97161. * benefits from Webgl 2 shadow samplers. Fallback to Poisson Sampling in Webgl 1
  97162. * (https://developer.nvidia.com/gpugems/GPUGems/gpugems_ch11.html)
  97163. */
  97164. static readonly FILTER_PCF: number;
  97165. /**
  97166. * Shadow generator mode PCSS: Percentage Closering Soft Shadow.
  97167. * benefits from Webgl 2 shadow samplers. Fallback to Poisson Sampling in Webgl 1
  97168. * Contact Hardening
  97169. */
  97170. static readonly FILTER_PCSS: number;
  97171. /**
  97172. * Reserved for PCF and PCSS
  97173. * Highest Quality.
  97174. *
  97175. * Execute PCF on a 5*5 kernel improving a lot the shadow aliasing artifacts.
  97176. *
  97177. * Execute PCSS with 32 taps blocker search and 64 taps PCF.
  97178. */
  97179. static readonly QUALITY_HIGH: number;
  97180. /**
  97181. * Reserved for PCF and PCSS
  97182. * Good tradeoff for quality/perf cross devices
  97183. *
  97184. * Execute PCF on a 3*3 kernel.
  97185. *
  97186. * Execute PCSS with 16 taps blocker search and 32 taps PCF.
  97187. */
  97188. static readonly QUALITY_MEDIUM: number;
  97189. /**
  97190. * Reserved for PCF and PCSS
  97191. * The lowest quality but the fastest.
  97192. *
  97193. * Execute PCF on a 1*1 kernel.
  97194. *
  97195. * Execute PCSS with 16 taps blocker search and 16 taps PCF.
  97196. */
  97197. static readonly QUALITY_LOW: number;
  97198. /** Gets or set the id of the shadow generator. It will be the one from the light if not defined */
  97199. id: string;
  97200. /** Gets or sets the custom shader name to use */
  97201. customShaderOptions: ICustomShaderOptions;
  97202. /**
  97203. * Observable triggered before the shadow is rendered. Can be used to update internal effect state
  97204. */
  97205. onBeforeShadowMapRenderObservable: Observable<Effect>;
  97206. /**
  97207. * Observable triggered after the shadow is rendered. Can be used to restore internal effect state
  97208. */
  97209. onAfterShadowMapRenderObservable: Observable<Effect>;
  97210. /**
  97211. * Observable triggered before a mesh is rendered in the shadow map.
  97212. * Can be used to update internal effect state (that you can get from the onBeforeShadowMapRenderObservable)
  97213. */
  97214. onBeforeShadowMapRenderMeshObservable: Observable<Mesh>;
  97215. /**
  97216. * Observable triggered after a mesh is rendered in the shadow map.
  97217. * Can be used to update internal effect state (that you can get from the onAfterShadowMapRenderObservable)
  97218. */
  97219. onAfterShadowMapRenderMeshObservable: Observable<Mesh>;
  97220. protected _bias: number;
  97221. /**
  97222. * Gets the bias: offset applied on the depth preventing acnea (in light direction).
  97223. */
  97224. get bias(): number;
  97225. /**
  97226. * Sets the bias: offset applied on the depth preventing acnea (in light direction).
  97227. */
  97228. set bias(bias: number);
  97229. protected _normalBias: number;
  97230. /**
  97231. * Gets the normalBias: offset applied on the depth preventing acnea (along side the normal direction and proportinal to the light/normal angle).
  97232. */
  97233. get normalBias(): number;
  97234. /**
  97235. * Sets the normalBias: offset applied on the depth preventing acnea (along side the normal direction and proportinal to the light/normal angle).
  97236. */
  97237. set normalBias(normalBias: number);
  97238. protected _blurBoxOffset: number;
  97239. /**
  97240. * Gets the blur box offset: offset applied during the blur pass.
  97241. * Only useful if useKernelBlur = false
  97242. */
  97243. get blurBoxOffset(): number;
  97244. /**
  97245. * Sets the blur box offset: offset applied during the blur pass.
  97246. * Only useful if useKernelBlur = false
  97247. */
  97248. set blurBoxOffset(value: number);
  97249. protected _blurScale: number;
  97250. /**
  97251. * Gets the blur scale: scale of the blurred texture compared to the main shadow map.
  97252. * 2 means half of the size.
  97253. */
  97254. get blurScale(): number;
  97255. /**
  97256. * Sets the blur scale: scale of the blurred texture compared to the main shadow map.
  97257. * 2 means half of the size.
  97258. */
  97259. set blurScale(value: number);
  97260. protected _blurKernel: number;
  97261. /**
  97262. * Gets the blur kernel: kernel size of the blur pass.
  97263. * Only useful if useKernelBlur = true
  97264. */
  97265. get blurKernel(): number;
  97266. /**
  97267. * Sets the blur kernel: kernel size of the blur pass.
  97268. * Only useful if useKernelBlur = true
  97269. */
  97270. set blurKernel(value: number);
  97271. protected _useKernelBlur: boolean;
  97272. /**
  97273. * Gets whether the blur pass is a kernel blur (if true) or box blur.
  97274. * Only useful in filtered mode (useBlurExponentialShadowMap...)
  97275. */
  97276. get useKernelBlur(): boolean;
  97277. /**
  97278. * Sets whether the blur pass is a kernel blur (if true) or box blur.
  97279. * Only useful in filtered mode (useBlurExponentialShadowMap...)
  97280. */
  97281. set useKernelBlur(value: boolean);
  97282. protected _depthScale: number;
  97283. /**
  97284. * Gets the depth scale used in ESM mode.
  97285. */
  97286. get depthScale(): number;
  97287. /**
  97288. * Sets the depth scale used in ESM mode.
  97289. * This can override the scale stored on the light.
  97290. */
  97291. set depthScale(value: number);
  97292. protected _validateFilter(filter: number): number;
  97293. protected _filter: number;
  97294. /**
  97295. * Gets the current mode of the shadow generator (normal, PCF, ESM...).
  97296. * The returned value is a number equal to one of the available mode defined in ShadowMap.FILTER_x like _FILTER_NONE
  97297. */
  97298. get filter(): number;
  97299. /**
  97300. * Sets the current mode of the shadow generator (normal, PCF, ESM...).
  97301. * The returned value is a number equal to one of the available mode defined in ShadowMap.FILTER_x like _FILTER_NONE
  97302. */
  97303. set filter(value: number);
  97304. /**
  97305. * Gets if the current filter is set to Poisson Sampling.
  97306. */
  97307. get usePoissonSampling(): boolean;
  97308. /**
  97309. * Sets the current filter to Poisson Sampling.
  97310. */
  97311. set usePoissonSampling(value: boolean);
  97312. /**
  97313. * Gets if the current filter is set to ESM.
  97314. */
  97315. get useExponentialShadowMap(): boolean;
  97316. /**
  97317. * Sets the current filter is to ESM.
  97318. */
  97319. set useExponentialShadowMap(value: boolean);
  97320. /**
  97321. * Gets if the current filter is set to filtered ESM.
  97322. */
  97323. get useBlurExponentialShadowMap(): boolean;
  97324. /**
  97325. * Gets if the current filter is set to filtered ESM.
  97326. */
  97327. set useBlurExponentialShadowMap(value: boolean);
  97328. /**
  97329. * Gets if the current filter is set to "close ESM" (using the inverse of the
  97330. * exponential to prevent steep falloff artifacts).
  97331. */
  97332. get useCloseExponentialShadowMap(): boolean;
  97333. /**
  97334. * Sets the current filter to "close ESM" (using the inverse of the
  97335. * exponential to prevent steep falloff artifacts).
  97336. */
  97337. set useCloseExponentialShadowMap(value: boolean);
  97338. /**
  97339. * Gets if the current filter is set to filtered "close ESM" (using the inverse of the
  97340. * exponential to prevent steep falloff artifacts).
  97341. */
  97342. get useBlurCloseExponentialShadowMap(): boolean;
  97343. /**
  97344. * Sets the current filter to filtered "close ESM" (using the inverse of the
  97345. * exponential to prevent steep falloff artifacts).
  97346. */
  97347. set useBlurCloseExponentialShadowMap(value: boolean);
  97348. /**
  97349. * Gets if the current filter is set to "PCF" (percentage closer filtering).
  97350. */
  97351. get usePercentageCloserFiltering(): boolean;
  97352. /**
  97353. * Sets the current filter to "PCF" (percentage closer filtering).
  97354. */
  97355. set usePercentageCloserFiltering(value: boolean);
  97356. protected _filteringQuality: number;
  97357. /**
  97358. * Gets the PCF or PCSS Quality.
  97359. * Only valid if usePercentageCloserFiltering or usePercentageCloserFiltering is true.
  97360. */
  97361. get filteringQuality(): number;
  97362. /**
  97363. * Sets the PCF or PCSS Quality.
  97364. * Only valid if usePercentageCloserFiltering or usePercentageCloserFiltering is true.
  97365. */
  97366. set filteringQuality(filteringQuality: number);
  97367. /**
  97368. * Gets if the current filter is set to "PCSS" (contact hardening).
  97369. */
  97370. get useContactHardeningShadow(): boolean;
  97371. /**
  97372. * Sets the current filter to "PCSS" (contact hardening).
  97373. */
  97374. set useContactHardeningShadow(value: boolean);
  97375. protected _contactHardeningLightSizeUVRatio: number;
  97376. /**
  97377. * Gets the Light Size (in shadow map uv unit) used in PCSS to determine the blocker search area and the penumbra size.
  97378. * Using a ratio helps keeping shape stability independently of the map size.
  97379. *
  97380. * It does not account for the light projection as it was having too much
  97381. * instability during the light setup or during light position changes.
  97382. *
  97383. * Only valid if useContactHardeningShadow is true.
  97384. */
  97385. get contactHardeningLightSizeUVRatio(): number;
  97386. /**
  97387. * Sets the Light Size (in shadow map uv unit) used in PCSS to determine the blocker search area and the penumbra size.
  97388. * Using a ratio helps keeping shape stability independently of the map size.
  97389. *
  97390. * It does not account for the light projection as it was having too much
  97391. * instability during the light setup or during light position changes.
  97392. *
  97393. * Only valid if useContactHardeningShadow is true.
  97394. */
  97395. set contactHardeningLightSizeUVRatio(contactHardeningLightSizeUVRatio: number);
  97396. protected _darkness: number;
  97397. /** Gets or sets the actual darkness of a shadow */
  97398. get darkness(): number;
  97399. set darkness(value: number);
  97400. /**
  97401. * Returns the darkness value (float). This can only decrease the actual darkness of a shadow.
  97402. * 0 means strongest and 1 would means no shadow.
  97403. * @returns the darkness.
  97404. */
  97405. getDarkness(): number;
  97406. /**
  97407. * Sets the darkness value (float). This can only decrease the actual darkness of a shadow.
  97408. * @param darkness The darkness value 0 means strongest and 1 would means no shadow.
  97409. * @returns the shadow generator allowing fluent coding.
  97410. */
  97411. setDarkness(darkness: number): ShadowGenerator;
  97412. protected _transparencyShadow: boolean;
  97413. /** Gets or sets the ability to have transparent shadow */
  97414. get transparencyShadow(): boolean;
  97415. set transparencyShadow(value: boolean);
  97416. /**
  97417. * Sets the ability to have transparent shadow (boolean).
  97418. * @param transparent True if transparent else False
  97419. * @returns the shadow generator allowing fluent coding
  97420. */
  97421. setTransparencyShadow(transparent: boolean): ShadowGenerator;
  97422. /**
  97423. * Enables or disables shadows with varying strength based on the transparency
  97424. * When it is enabled, the strength of the shadow is taken equal to mesh.visibility
  97425. * If you enabled an alpha texture on your material, the alpha value red from the texture is also combined to compute the strength:
  97426. * mesh.visibility * alphaTexture.a
  97427. * Note that by definition transparencyShadow must be set to true for enableSoftTransparentShadow to work!
  97428. */
  97429. enableSoftTransparentShadow: boolean;
  97430. protected _shadowMap: Nullable<RenderTargetTexture>;
  97431. protected _shadowMap2: Nullable<RenderTargetTexture>;
  97432. /**
  97433. * Gets the main RTT containing the shadow map (usually storing depth from the light point of view).
  97434. * @returns The render target texture if present otherwise, null
  97435. */
  97436. getShadowMap(): Nullable<RenderTargetTexture>;
  97437. /**
  97438. * Gets the RTT used during rendering (can be a blurred version of the shadow map or the shadow map itself).
  97439. * @returns The render target texture if the shadow map is present otherwise, null
  97440. */
  97441. getShadowMapForRendering(): Nullable<RenderTargetTexture>;
  97442. /**
  97443. * Gets the class name of that object
  97444. * @returns "ShadowGenerator"
  97445. */
  97446. getClassName(): string;
  97447. /**
  97448. * Helper function to add a mesh and its descendants to the list of shadow casters.
  97449. * @param mesh Mesh to add
  97450. * @param includeDescendants boolean indicating if the descendants should be added. Default to true
  97451. * @returns the Shadow Generator itself
  97452. */
  97453. addShadowCaster(mesh: AbstractMesh, includeDescendants?: boolean): ShadowGenerator;
  97454. /**
  97455. * Helper function to remove a mesh and its descendants from the list of shadow casters
  97456. * @param mesh Mesh to remove
  97457. * @param includeDescendants boolean indicating if the descendants should be removed. Default to true
  97458. * @returns the Shadow Generator itself
  97459. */
  97460. removeShadowCaster(mesh: AbstractMesh, includeDescendants?: boolean): ShadowGenerator;
  97461. /**
  97462. * Controls the extent to which the shadows fade out at the edge of the frustum
  97463. */
  97464. frustumEdgeFalloff: number;
  97465. protected _light: IShadowLight;
  97466. /**
  97467. * Returns the associated light object.
  97468. * @returns the light generating the shadow
  97469. */
  97470. getLight(): IShadowLight;
  97471. /**
  97472. * If true the shadow map is generated by rendering the back face of the mesh instead of the front face.
  97473. * This can help with self-shadowing as the geometry making up the back of objects is slightly offset.
  97474. * It might on the other hand introduce peter panning.
  97475. */
  97476. forceBackFacesOnly: boolean;
  97477. protected _scene: Scene;
  97478. protected _lightDirection: Vector3;
  97479. protected _effect: Effect;
  97480. protected _viewMatrix: Matrix;
  97481. protected _projectionMatrix: Matrix;
  97482. protected _transformMatrix: Matrix;
  97483. protected _cachedPosition: Vector3;
  97484. protected _cachedDirection: Vector3;
  97485. protected _cachedDefines: string;
  97486. protected _currentRenderID: number;
  97487. protected _boxBlurPostprocess: Nullable<PostProcess>;
  97488. protected _kernelBlurXPostprocess: Nullable<PostProcess>;
  97489. protected _kernelBlurYPostprocess: Nullable<PostProcess>;
  97490. protected _blurPostProcesses: PostProcess[];
  97491. protected _mapSize: number;
  97492. protected _currentFaceIndex: number;
  97493. protected _currentFaceIndexCache: number;
  97494. protected _textureType: number;
  97495. protected _defaultTextureMatrix: Matrix;
  97496. protected _storedUniqueId: Nullable<number>;
  97497. /** @hidden */
  97498. static _SceneComponentInitialization: (scene: Scene) => void;
  97499. /**
  97500. * Creates a ShadowGenerator object.
  97501. * A ShadowGenerator is the required tool to use the shadows.
  97502. * Each light casting shadows needs to use its own ShadowGenerator.
  97503. * Documentation : https://doc.babylonjs.com/babylon101/shadows
  97504. * @param mapSize The size of the texture what stores the shadows. Example : 1024.
  97505. * @param light The light object generating the shadows.
  97506. * @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.
  97507. */
  97508. constructor(mapSize: number, light: IShadowLight, usefulFloatFirst?: boolean);
  97509. protected _initializeGenerator(): void;
  97510. protected _createTargetRenderTexture(): void;
  97511. protected _initializeShadowMap(): void;
  97512. protected _initializeBlurRTTAndPostProcesses(): void;
  97513. protected _renderForShadowMap(opaqueSubMeshes: SmartArray<SubMesh>, alphaTestSubMeshes: SmartArray<SubMesh>, transparentSubMeshes: SmartArray<SubMesh>, depthOnlySubMeshes: SmartArray<SubMesh>): void;
  97514. protected _bindCustomEffectForRenderSubMeshForShadowMap(subMesh: SubMesh, effect: Effect, matriceNames: any, mesh: AbstractMesh): void;
  97515. protected _renderSubMeshForShadowMap(subMesh: SubMesh, isTransparent?: boolean): void;
  97516. protected _applyFilterValues(): void;
  97517. /**
  97518. * Forces all the attached effect to compile to enable rendering only once ready vs. lazyly compiling effects.
  97519. * @param onCompiled Callback triggered at the and of the effects compilation
  97520. * @param options Sets of optional options forcing the compilation with different modes
  97521. */
  97522. forceCompilation(onCompiled?: (generator: IShadowGenerator) => void, options?: Partial<{
  97523. useInstances: boolean;
  97524. }>): void;
  97525. /**
  97526. * Forces all the attached effect to compile to enable rendering only once ready vs. lazyly compiling effects.
  97527. * @param options Sets of optional options forcing the compilation with different modes
  97528. * @returns A promise that resolves when the compilation completes
  97529. */
  97530. forceCompilationAsync(options?: Partial<{
  97531. useInstances: boolean;
  97532. }>): Promise<void>;
  97533. protected _isReadyCustomDefines(defines: any, subMesh: SubMesh, useInstances: boolean): void;
  97534. private _prepareShadowDefines;
  97535. /**
  97536. * Determine wheter the shadow generator is ready or not (mainly all effects and related post processes needs to be ready).
  97537. * @param subMesh The submesh we want to render in the shadow map
  97538. * @param useInstances Defines wether will draw in the map using instances
  97539. * @param isTransparent Indicates that isReady is called for a transparent subMesh
  97540. * @returns true if ready otherwise, false
  97541. */
  97542. isReady(subMesh: SubMesh, useInstances: boolean, isTransparent: boolean): boolean;
  97543. /**
  97544. * Prepare all the defines in a material relying on a shadow map at the specified light index.
  97545. * @param defines Defines of the material we want to update
  97546. * @param lightIndex Index of the light in the enabled light list of the material
  97547. */
  97548. prepareDefines(defines: any, lightIndex: number): void;
  97549. /**
  97550. * Binds the shadow related information inside of an effect (information like near, far, darkness...
  97551. * defined in the generator but impacting the effect).
  97552. * @param lightIndex Index of the light in the enabled light list of the material owning the effect
  97553. * @param effect The effect we are binfing the information for
  97554. */
  97555. bindShadowLight(lightIndex: string, effect: Effect): void;
  97556. /**
  97557. * Gets the transformation matrix used to project the meshes into the map from the light point of view.
  97558. * (eq to shadow prjection matrix * light transform matrix)
  97559. * @returns The transform matrix used to create the shadow map
  97560. */
  97561. getTransformMatrix(): Matrix;
  97562. /**
  97563. * Recreates the shadow map dependencies like RTT and post processes. This can be used during the switch between
  97564. * Cube and 2D textures for instance.
  97565. */
  97566. recreateShadowMap(): void;
  97567. protected _disposeBlurPostProcesses(): void;
  97568. protected _disposeRTTandPostProcesses(): void;
  97569. /**
  97570. * Disposes the ShadowGenerator.
  97571. * Returns nothing.
  97572. */
  97573. dispose(): void;
  97574. /**
  97575. * Serializes the shadow generator setup to a json object.
  97576. * @returns The serialized JSON object
  97577. */
  97578. serialize(): any;
  97579. /**
  97580. * Parses a serialized ShadowGenerator and returns a new ShadowGenerator.
  97581. * @param parsedShadowGenerator The JSON object to parse
  97582. * @param scene The scene to create the shadow map for
  97583. * @param constr A function that builds a shadow generator or undefined to create an instance of the default shadow generator
  97584. * @returns The parsed shadow generator
  97585. */
  97586. static Parse(parsedShadowGenerator: any, scene: Scene, constr?: (mapSize: number, light: IShadowLight) => ShadowGenerator): ShadowGenerator;
  97587. }
  97588. }
  97589. declare module BABYLON {
  97590. /**
  97591. * Base class of all the lights in Babylon. It groups all the generic information about lights.
  97592. * Lights are used, as you would expect, to affect how meshes are seen, in terms of both illumination and colour.
  97593. * 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.
  97594. */
  97595. export abstract class Light extends Node {
  97596. /**
  97597. * Falloff Default: light is falling off following the material specification:
  97598. * standard material is using standard falloff whereas pbr material can request special falloff per materials.
  97599. */
  97600. static readonly FALLOFF_DEFAULT: number;
  97601. /**
  97602. * Falloff Physical: light is falling off following the inverse squared distance law.
  97603. */
  97604. static readonly FALLOFF_PHYSICAL: number;
  97605. /**
  97606. * Falloff gltf: light is falling off as described in the gltf moving to PBR document
  97607. * to enhance interoperability with other engines.
  97608. */
  97609. static readonly FALLOFF_GLTF: number;
  97610. /**
  97611. * Falloff Standard: light is falling off like in the standard material
  97612. * to enhance interoperability with other materials.
  97613. */
  97614. static readonly FALLOFF_STANDARD: number;
  97615. /**
  97616. * If every light affecting the material is in this lightmapMode,
  97617. * material.lightmapTexture adds or multiplies
  97618. * (depends on material.useLightmapAsShadowmap)
  97619. * after every other light calculations.
  97620. */
  97621. static readonly LIGHTMAP_DEFAULT: number;
  97622. /**
  97623. * material.lightmapTexture as only diffuse lighting from this light
  97624. * adds only specular lighting from this light
  97625. * adds dynamic shadows
  97626. */
  97627. static readonly LIGHTMAP_SPECULAR: number;
  97628. /**
  97629. * material.lightmapTexture as only lighting
  97630. * no light calculation from this light
  97631. * only adds dynamic shadows from this light
  97632. */
  97633. static readonly LIGHTMAP_SHADOWSONLY: number;
  97634. /**
  97635. * Each light type uses the default quantity according to its type:
  97636. * point/spot lights use luminous intensity
  97637. * directional lights use illuminance
  97638. */
  97639. static readonly INTENSITYMODE_AUTOMATIC: number;
  97640. /**
  97641. * lumen (lm)
  97642. */
  97643. static readonly INTENSITYMODE_LUMINOUSPOWER: number;
  97644. /**
  97645. * candela (lm/sr)
  97646. */
  97647. static readonly INTENSITYMODE_LUMINOUSINTENSITY: number;
  97648. /**
  97649. * lux (lm/m^2)
  97650. */
  97651. static readonly INTENSITYMODE_ILLUMINANCE: number;
  97652. /**
  97653. * nit (cd/m^2)
  97654. */
  97655. static readonly INTENSITYMODE_LUMINANCE: number;
  97656. /**
  97657. * Light type const id of the point light.
  97658. */
  97659. static readonly LIGHTTYPEID_POINTLIGHT: number;
  97660. /**
  97661. * Light type const id of the directional light.
  97662. */
  97663. static readonly LIGHTTYPEID_DIRECTIONALLIGHT: number;
  97664. /**
  97665. * Light type const id of the spot light.
  97666. */
  97667. static readonly LIGHTTYPEID_SPOTLIGHT: number;
  97668. /**
  97669. * Light type const id of the hemispheric light.
  97670. */
  97671. static readonly LIGHTTYPEID_HEMISPHERICLIGHT: number;
  97672. /**
  97673. * Diffuse gives the basic color to an object.
  97674. */
  97675. diffuse: Color3;
  97676. /**
  97677. * Specular produces a highlight color on an object.
  97678. * Note: This is note affecting PBR materials.
  97679. */
  97680. specular: Color3;
  97681. /**
  97682. * Defines the falloff type for this light. This lets overrriding how punctual light are
  97683. * falling off base on range or angle.
  97684. * This can be set to any values in Light.FALLOFF_x.
  97685. *
  97686. * Note: This is only useful for PBR Materials at the moment. This could be extended if required to
  97687. * other types of materials.
  97688. */
  97689. falloffType: number;
  97690. /**
  97691. * Strength of the light.
  97692. * Note: By default it is define in the framework own unit.
  97693. * Note: In PBR materials the intensityMode can be use to chose what unit the intensity is defined in.
  97694. */
  97695. intensity: number;
  97696. private _range;
  97697. protected _inverseSquaredRange: number;
  97698. /**
  97699. * Defines how far from the source the light is impacting in scene units.
  97700. * Note: Unused in PBR material as the distance light falloff is defined following the inverse squared falloff.
  97701. */
  97702. get range(): number;
  97703. /**
  97704. * Defines how far from the source the light is impacting in scene units.
  97705. * Note: Unused in PBR material as the distance light falloff is defined following the inverse squared falloff.
  97706. */
  97707. set range(value: number);
  97708. /**
  97709. * Cached photometric scale default to 1.0 as the automatic intensity mode defaults to 1.0 for every type
  97710. * of light.
  97711. */
  97712. private _photometricScale;
  97713. private _intensityMode;
  97714. /**
  97715. * Gets the photometric scale used to interpret the intensity.
  97716. * This is only relevant with PBR Materials where the light intensity can be defined in a physical way.
  97717. */
  97718. get intensityMode(): number;
  97719. /**
  97720. * Sets the photometric scale used to interpret the intensity.
  97721. * This is only relevant with PBR Materials where the light intensity can be defined in a physical way.
  97722. */
  97723. set intensityMode(value: number);
  97724. private _radius;
  97725. /**
  97726. * Gets the light radius used by PBR Materials to simulate soft area lights.
  97727. */
  97728. get radius(): number;
  97729. /**
  97730. * sets the light radius used by PBR Materials to simulate soft area lights.
  97731. */
  97732. set radius(value: number);
  97733. private _renderPriority;
  97734. /**
  97735. * Defines the rendering priority of the lights. It can help in case of fallback or number of lights
  97736. * exceeding the number allowed of the materials.
  97737. */
  97738. renderPriority: number;
  97739. private _shadowEnabled;
  97740. /**
  97741. * Gets wether or not the shadows are enabled for this light. This can help turning off/on shadow without detaching
  97742. * the current shadow generator.
  97743. */
  97744. get shadowEnabled(): boolean;
  97745. /**
  97746. * Sets wether or not the shadows are enabled for this light. This can help turning off/on shadow without detaching
  97747. * the current shadow generator.
  97748. */
  97749. set shadowEnabled(value: boolean);
  97750. private _includedOnlyMeshes;
  97751. /**
  97752. * Gets the only meshes impacted by this light.
  97753. */
  97754. get includedOnlyMeshes(): AbstractMesh[];
  97755. /**
  97756. * Sets the only meshes impacted by this light.
  97757. */
  97758. set includedOnlyMeshes(value: AbstractMesh[]);
  97759. private _excludedMeshes;
  97760. /**
  97761. * Gets the meshes not impacted by this light.
  97762. */
  97763. get excludedMeshes(): AbstractMesh[];
  97764. /**
  97765. * Sets the meshes not impacted by this light.
  97766. */
  97767. set excludedMeshes(value: AbstractMesh[]);
  97768. private _excludeWithLayerMask;
  97769. /**
  97770. * Gets the layer id use to find what meshes are not impacted by the light.
  97771. * Inactive if 0
  97772. */
  97773. get excludeWithLayerMask(): number;
  97774. /**
  97775. * Sets the layer id use to find what meshes are not impacted by the light.
  97776. * Inactive if 0
  97777. */
  97778. set excludeWithLayerMask(value: number);
  97779. private _includeOnlyWithLayerMask;
  97780. /**
  97781. * Gets the layer id use to find what meshes are impacted by the light.
  97782. * Inactive if 0
  97783. */
  97784. get includeOnlyWithLayerMask(): number;
  97785. /**
  97786. * Sets the layer id use to find what meshes are impacted by the light.
  97787. * Inactive if 0
  97788. */
  97789. set includeOnlyWithLayerMask(value: number);
  97790. private _lightmapMode;
  97791. /**
  97792. * Gets the lightmap mode of this light (should be one of the constants defined by Light.LIGHTMAP_x)
  97793. */
  97794. get lightmapMode(): number;
  97795. /**
  97796. * Sets the lightmap mode of this light (should be one of the constants defined by Light.LIGHTMAP_x)
  97797. */
  97798. set lightmapMode(value: number);
  97799. /**
  97800. * Shadow generator associted to the light.
  97801. * @hidden Internal use only.
  97802. */
  97803. _shadowGenerator: Nullable<IShadowGenerator>;
  97804. /**
  97805. * @hidden Internal use only.
  97806. */
  97807. _excludedMeshesIds: string[];
  97808. /**
  97809. * @hidden Internal use only.
  97810. */
  97811. _includedOnlyMeshesIds: string[];
  97812. /**
  97813. * The current light unifom buffer.
  97814. * @hidden Internal use only.
  97815. */
  97816. _uniformBuffer: UniformBuffer;
  97817. /** @hidden */
  97818. _renderId: number;
  97819. /**
  97820. * Creates a Light object in the scene.
  97821. * Documentation : https://doc.babylonjs.com/babylon101/lights
  97822. * @param name The firendly name of the light
  97823. * @param scene The scene the light belongs too
  97824. */
  97825. constructor(name: string, scene: Scene);
  97826. protected abstract _buildUniformLayout(): void;
  97827. /**
  97828. * Sets the passed Effect "effect" with the Light information.
  97829. * @param effect The effect to update
  97830. * @param lightIndex The index of the light in the effect to update
  97831. * @returns The light
  97832. */
  97833. abstract transferToEffect(effect: Effect, lightIndex: string): Light;
  97834. /**
  97835. * Sets the passed Effect "effect" with the Light textures.
  97836. * @param effect The effect to update
  97837. * @param lightIndex The index of the light in the effect to update
  97838. * @returns The light
  97839. */
  97840. transferTexturesToEffect(effect: Effect, lightIndex: string): Light;
  97841. /**
  97842. * Binds the lights information from the scene to the effect for the given mesh.
  97843. * @param lightIndex Light index
  97844. * @param scene The scene where the light belongs to
  97845. * @param effect The effect we are binding the data to
  97846. * @param useSpecular Defines if specular is supported
  97847. * @param rebuildInParallel Specifies whether the shader is rebuilding in parallel
  97848. */
  97849. _bindLight(lightIndex: number, scene: Scene, effect: Effect, useSpecular: boolean, rebuildInParallel?: boolean): void;
  97850. /**
  97851. * Sets the passed Effect "effect" with the Light information.
  97852. * @param effect The effect to update
  97853. * @param lightDataUniformName The uniform used to store light data (position or direction)
  97854. * @returns The light
  97855. */
  97856. abstract transferToNodeMaterialEffect(effect: Effect, lightDataUniformName: string): Light;
  97857. /**
  97858. * Returns the string "Light".
  97859. * @returns the class name
  97860. */
  97861. getClassName(): string;
  97862. /** @hidden */
  97863. readonly _isLight: boolean;
  97864. /**
  97865. * Converts the light information to a readable string for debug purpose.
  97866. * @param fullDetails Supports for multiple levels of logging within scene loading
  97867. * @returns the human readable light info
  97868. */
  97869. toString(fullDetails?: boolean): string;
  97870. /** @hidden */
  97871. protected _syncParentEnabledState(): void;
  97872. /**
  97873. * Set the enabled state of this node.
  97874. * @param value - the new enabled state
  97875. */
  97876. setEnabled(value: boolean): void;
  97877. /**
  97878. * Returns the Light associated shadow generator if any.
  97879. * @return the associated shadow generator.
  97880. */
  97881. getShadowGenerator(): Nullable<IShadowGenerator>;
  97882. /**
  97883. * Returns a Vector3, the absolute light position in the World.
  97884. * @returns the world space position of the light
  97885. */
  97886. getAbsolutePosition(): Vector3;
  97887. /**
  97888. * Specifies if the light will affect the passed mesh.
  97889. * @param mesh The mesh to test against the light
  97890. * @return true the mesh is affected otherwise, false.
  97891. */
  97892. canAffectMesh(mesh: AbstractMesh): boolean;
  97893. /**
  97894. * Sort function to order lights for rendering.
  97895. * @param a First Light object to compare to second.
  97896. * @param b Second Light object to compare first.
  97897. * @return -1 to reduce's a's index relative to be, 0 for no change, 1 to increase a's index relative to b.
  97898. */
  97899. static CompareLightsPriority(a: Light, b: Light): number;
  97900. /**
  97901. * Releases resources associated with this node.
  97902. * @param doNotRecurse Set to true to not recurse into each children (recurse into each children by default)
  97903. * @param disposeMaterialAndTextures Set to true to also dispose referenced materials and textures (false by default)
  97904. */
  97905. dispose(doNotRecurse?: boolean, disposeMaterialAndTextures?: boolean): void;
  97906. /**
  97907. * Returns the light type ID (integer).
  97908. * @returns The light Type id as a constant defines in Light.LIGHTTYPEID_x
  97909. */
  97910. getTypeID(): number;
  97911. /**
  97912. * Returns the intensity scaled by the Photometric Scale according to the light type and intensity mode.
  97913. * @returns the scaled intensity in intensity mode unit
  97914. */
  97915. getScaledIntensity(): number;
  97916. /**
  97917. * Returns a new Light object, named "name", from the current one.
  97918. * @param name The name of the cloned light
  97919. * @param newParent The parent of this light, if it has one
  97920. * @returns the new created light
  97921. */
  97922. clone(name: string, newParent?: Nullable<Node>): Nullable<Light>;
  97923. /**
  97924. * Serializes the current light into a Serialization object.
  97925. * @returns the serialized object.
  97926. */
  97927. serialize(): any;
  97928. /**
  97929. * Creates a new typed light from the passed type (integer) : point light = 0, directional light = 1, spot light = 2, hemispheric light = 3.
  97930. * This new light is named "name" and added to the passed scene.
  97931. * @param type Type according to the types available in Light.LIGHTTYPEID_x
  97932. * @param name The friendly name of the light
  97933. * @param scene The scene the new light will belong to
  97934. * @returns the constructor function
  97935. */
  97936. static GetConstructorFromName(type: number, name: string, scene: Scene): Nullable<() => Light>;
  97937. /**
  97938. * Parses the passed "parsedLight" and returns a new instanced Light from this parsing.
  97939. * @param parsedLight The JSON representation of the light
  97940. * @param scene The scene to create the parsed light in
  97941. * @returns the created light after parsing
  97942. */
  97943. static Parse(parsedLight: any, scene: Scene): Nullable<Light>;
  97944. private _hookArrayForExcluded;
  97945. private _hookArrayForIncludedOnly;
  97946. private _resyncMeshes;
  97947. /**
  97948. * Forces the meshes to update their light related information in their rendering used effects
  97949. * @hidden Internal Use Only
  97950. */
  97951. _markMeshesAsLightDirty(): void;
  97952. /**
  97953. * Recomputes the cached photometric scale if needed.
  97954. */
  97955. private _computePhotometricScale;
  97956. /**
  97957. * Returns the Photometric Scale according to the light type and intensity mode.
  97958. */
  97959. private _getPhotometricScale;
  97960. /**
  97961. * Reorder the light in the scene according to their defined priority.
  97962. * @hidden Internal Use Only
  97963. */
  97964. _reorderLightsInScene(): void;
  97965. /**
  97966. * Prepares the list of defines specific to the light type.
  97967. * @param defines the list of defines
  97968. * @param lightIndex defines the index of the light for the effect
  97969. */
  97970. abstract prepareLightSpecificDefines(defines: any, lightIndex: number): void;
  97971. }
  97972. }
  97973. declare module BABYLON {
  97974. /**
  97975. * A target camera takes a mesh or position as a target and continues to look at it while it moves.
  97976. * This is the base of the follow, arc rotate cameras and Free camera
  97977. * @see https://doc.babylonjs.com/features/cameras
  97978. */
  97979. export class TargetCamera extends Camera {
  97980. private static _RigCamTransformMatrix;
  97981. private static _TargetTransformMatrix;
  97982. private static _TargetFocalPoint;
  97983. private _tmpUpVector;
  97984. private _tmpTargetVector;
  97985. /**
  97986. * Define the current direction the camera is moving to
  97987. */
  97988. cameraDirection: Vector3;
  97989. /**
  97990. * Define the current rotation the camera is rotating to
  97991. */
  97992. cameraRotation: Vector2;
  97993. /** Gets or sets a boolean indicating that the scaling of the parent hierarchy will not be taken in account by the camera */
  97994. ignoreParentScaling: boolean;
  97995. /**
  97996. * When set, the up vector of the camera will be updated by the rotation of the camera
  97997. */
  97998. updateUpVectorFromRotation: boolean;
  97999. private _tmpQuaternion;
  98000. /**
  98001. * Define the current rotation of the camera
  98002. */
  98003. rotation: Vector3;
  98004. /**
  98005. * Define the current rotation of the camera as a quaternion to prevent Gimbal lock
  98006. */
  98007. rotationQuaternion: Quaternion;
  98008. /**
  98009. * Define the current speed of the camera
  98010. */
  98011. speed: number;
  98012. /**
  98013. * Add constraint to the camera to prevent it to move freely in all directions and
  98014. * around all axis.
  98015. */
  98016. noRotationConstraint: boolean;
  98017. /**
  98018. * Reverses mouselook direction to 'natural' panning as opposed to traditional direct
  98019. * panning
  98020. */
  98021. invertRotation: boolean;
  98022. /**
  98023. * Speed multiplier for inverse camera panning
  98024. */
  98025. inverseRotationSpeed: number;
  98026. /**
  98027. * Define the current target of the camera as an object or a position.
  98028. */
  98029. lockedTarget: any;
  98030. /** @hidden */
  98031. _currentTarget: Vector3;
  98032. /** @hidden */
  98033. _initialFocalDistance: number;
  98034. /** @hidden */
  98035. _viewMatrix: Matrix;
  98036. /** @hidden */
  98037. _camMatrix: Matrix;
  98038. /** @hidden */
  98039. _cameraTransformMatrix: Matrix;
  98040. /** @hidden */
  98041. _cameraRotationMatrix: Matrix;
  98042. /** @hidden */
  98043. _referencePoint: Vector3;
  98044. /** @hidden */
  98045. _transformedReferencePoint: Vector3;
  98046. /** @hidden */
  98047. _reset: () => void;
  98048. private _defaultUp;
  98049. /**
  98050. * Instantiates a target camera that takes a mesh or position as a target and continues to look at it while it moves.
  98051. * This is the base of the follow, arc rotate cameras and Free camera
  98052. * @see https://doc.babylonjs.com/features/cameras
  98053. * @param name Defines the name of the camera in the scene
  98054. * @param position Defines the start position of the camera in the scene
  98055. * @param scene Defines the scene the camera belongs to
  98056. * @param setActiveOnSceneIfNoneActive Defines wheter the camera should be marked as active if not other active cameras have been defined
  98057. */
  98058. constructor(name: string, position: Vector3, scene: Scene, setActiveOnSceneIfNoneActive?: boolean);
  98059. /**
  98060. * Gets the position in front of the camera at a given distance.
  98061. * @param distance The distance from the camera we want the position to be
  98062. * @returns the position
  98063. */
  98064. getFrontPosition(distance: number): Vector3;
  98065. /** @hidden */
  98066. _getLockedTargetPosition(): Nullable<Vector3>;
  98067. private _storedPosition;
  98068. private _storedRotation;
  98069. private _storedRotationQuaternion;
  98070. /**
  98071. * Store current camera state of the camera (fov, position, rotation, etc..)
  98072. * @returns the camera
  98073. */
  98074. storeState(): Camera;
  98075. /**
  98076. * Restored camera state. You must call storeState() first
  98077. * @returns whether it was successful or not
  98078. * @hidden
  98079. */
  98080. _restoreStateValues(): boolean;
  98081. /** @hidden */
  98082. _initCache(): void;
  98083. /** @hidden */
  98084. _updateCache(ignoreParentClass?: boolean): void;
  98085. /** @hidden */
  98086. _isSynchronizedViewMatrix(): boolean;
  98087. /** @hidden */
  98088. _computeLocalCameraSpeed(): number;
  98089. /**
  98090. * Defines the target the camera should look at.
  98091. * @param target Defines the new target as a Vector or a mesh
  98092. */
  98093. setTarget(target: Vector3): void;
  98094. /**
  98095. * Defines the target point of the camera.
  98096. * The camera looks towards it form the radius distance.
  98097. */
  98098. get target(): Vector3;
  98099. set target(value: Vector3);
  98100. /**
  98101. * Return the current target position of the camera. This value is expressed in local space.
  98102. * @returns the target position
  98103. */
  98104. getTarget(): Vector3;
  98105. /** @hidden */
  98106. _decideIfNeedsToMove(): boolean;
  98107. /** @hidden */
  98108. _updatePosition(): void;
  98109. /** @hidden */
  98110. _checkInputs(): void;
  98111. protected _updateCameraRotationMatrix(): void;
  98112. /**
  98113. * 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)
  98114. * @returns the current camera
  98115. */
  98116. private _rotateUpVectorWithCameraRotationMatrix;
  98117. private _cachedRotationZ;
  98118. private _cachedQuaternionRotationZ;
  98119. /** @hidden */
  98120. _getViewMatrix(): Matrix;
  98121. protected _computeViewMatrix(position: Vector3, target: Vector3, up: Vector3): void;
  98122. /**
  98123. * @hidden
  98124. */
  98125. createRigCamera(name: string, cameraIndex: number): Nullable<Camera>;
  98126. /**
  98127. * @hidden
  98128. */
  98129. _updateRigCameras(): void;
  98130. private _getRigCamPositionAndTarget;
  98131. /**
  98132. * Gets the current object class name.
  98133. * @return the class name
  98134. */
  98135. getClassName(): string;
  98136. }
  98137. }
  98138. declare module BABYLON {
  98139. /**
  98140. * Gather the list of keyboard event types as constants.
  98141. */
  98142. export class KeyboardEventTypes {
  98143. /**
  98144. * The keydown event is fired when a key becomes active (pressed).
  98145. */
  98146. static readonly KEYDOWN: number;
  98147. /**
  98148. * The keyup event is fired when a key has been released.
  98149. */
  98150. static readonly KEYUP: number;
  98151. }
  98152. /**
  98153. * This class is used to store keyboard related info for the onKeyboardObservable event.
  98154. */
  98155. export class KeyboardInfo {
  98156. /**
  98157. * Defines the type of event (KeyboardEventTypes)
  98158. */
  98159. type: number;
  98160. /**
  98161. * Defines the related dom event
  98162. */
  98163. event: KeyboardEvent;
  98164. /**
  98165. * Instantiates a new keyboard info.
  98166. * This class is used to store keyboard related info for the onKeyboardObservable event.
  98167. * @param type Defines the type of event (KeyboardEventTypes)
  98168. * @param event Defines the related dom event
  98169. */
  98170. constructor(
  98171. /**
  98172. * Defines the type of event (KeyboardEventTypes)
  98173. */
  98174. type: number,
  98175. /**
  98176. * Defines the related dom event
  98177. */
  98178. event: KeyboardEvent);
  98179. }
  98180. /**
  98181. * This class is used to store keyboard related info for the onPreKeyboardObservable event.
  98182. * Set the skipOnKeyboardObservable property to true if you want the engine to stop any process after this event is triggered, even not calling onKeyboardObservable
  98183. */
  98184. export class KeyboardInfoPre extends KeyboardInfo {
  98185. /**
  98186. * Defines the type of event (KeyboardEventTypes)
  98187. */
  98188. type: number;
  98189. /**
  98190. * Defines the related dom event
  98191. */
  98192. event: KeyboardEvent;
  98193. /**
  98194. * Defines whether the engine should skip the next onKeyboardObservable associated to this pre.
  98195. */
  98196. skipOnPointerObservable: boolean;
  98197. /**
  98198. * Instantiates a new keyboard pre info.
  98199. * This class is used to store keyboard related info for the onPreKeyboardObservable event.
  98200. * @param type Defines the type of event (KeyboardEventTypes)
  98201. * @param event Defines the related dom event
  98202. */
  98203. constructor(
  98204. /**
  98205. * Defines the type of event (KeyboardEventTypes)
  98206. */
  98207. type: number,
  98208. /**
  98209. * Defines the related dom event
  98210. */
  98211. event: KeyboardEvent);
  98212. }
  98213. }
  98214. declare module BABYLON {
  98215. /**
  98216. * Manage the keyboard inputs to control the movement of a free camera.
  98217. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  98218. */
  98219. export class FreeCameraKeyboardMoveInput implements ICameraInput<FreeCamera> {
  98220. /**
  98221. * Defines the camera the input is attached to.
  98222. */
  98223. camera: FreeCamera;
  98224. /**
  98225. * Gets or Set the list of keyboard keys used to control the forward move of the camera.
  98226. */
  98227. keysUp: number[];
  98228. /**
  98229. * Gets or Set the list of keyboard keys used to control the upward move of the camera.
  98230. */
  98231. keysUpward: number[];
  98232. /**
  98233. * Gets or Set the list of keyboard keys used to control the backward move of the camera.
  98234. */
  98235. keysDown: number[];
  98236. /**
  98237. * Gets or Set the list of keyboard keys used to control the downward move of the camera.
  98238. */
  98239. keysDownward: number[];
  98240. /**
  98241. * Gets or Set the list of keyboard keys used to control the left strafe move of the camera.
  98242. */
  98243. keysLeft: number[];
  98244. /**
  98245. * Gets or Set the list of keyboard keys used to control the right strafe move of the camera.
  98246. */
  98247. keysRight: number[];
  98248. private _keys;
  98249. private _onCanvasBlurObserver;
  98250. private _onKeyboardObserver;
  98251. private _engine;
  98252. private _scene;
  98253. /**
  98254. * Attach the input controls to a specific dom element to get the input from.
  98255. * @param element Defines the element the controls should be listened from
  98256. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  98257. */
  98258. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  98259. /**
  98260. * Detach the current controls from the specified dom element.
  98261. * @param element Defines the element to stop listening the inputs from
  98262. */
  98263. detachControl(element: Nullable<HTMLElement>): void;
  98264. /**
  98265. * Update the current camera state depending on the inputs that have been used this frame.
  98266. * This is a dynamically created lambda to avoid the performance penalty of looping for inputs in the render loop.
  98267. */
  98268. checkInputs(): void;
  98269. /**
  98270. * Gets the class name of the current intput.
  98271. * @returns the class name
  98272. */
  98273. getClassName(): string;
  98274. /** @hidden */
  98275. _onLostFocus(): void;
  98276. /**
  98277. * Get the friendly name associated with the input class.
  98278. * @returns the input friendly name
  98279. */
  98280. getSimpleName(): string;
  98281. }
  98282. }
  98283. declare module BABYLON {
  98284. /**
  98285. * Gather the list of pointer event types as constants.
  98286. */
  98287. export class PointerEventTypes {
  98288. /**
  98289. * 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.
  98290. */
  98291. static readonly POINTERDOWN: number;
  98292. /**
  98293. * The pointerup event is fired when a pointer is no longer active.
  98294. */
  98295. static readonly POINTERUP: number;
  98296. /**
  98297. * The pointermove event is fired when a pointer changes coordinates.
  98298. */
  98299. static readonly POINTERMOVE: number;
  98300. /**
  98301. * The pointerwheel event is fired when a mouse wheel has been rotated.
  98302. */
  98303. static readonly POINTERWHEEL: number;
  98304. /**
  98305. * The pointerpick event is fired when a mesh or sprite has been picked by the pointer.
  98306. */
  98307. static readonly POINTERPICK: number;
  98308. /**
  98309. * The pointertap event is fired when a the object has been touched and released without drag.
  98310. */
  98311. static readonly POINTERTAP: number;
  98312. /**
  98313. * The pointerdoubletap event is fired when a the object has been touched and released twice without drag.
  98314. */
  98315. static readonly POINTERDOUBLETAP: number;
  98316. }
  98317. /**
  98318. * Base class of pointer info types.
  98319. */
  98320. export class PointerInfoBase {
  98321. /**
  98322. * Defines the type of event (PointerEventTypes)
  98323. */
  98324. type: number;
  98325. /**
  98326. * Defines the related dom event
  98327. */
  98328. event: PointerEvent | MouseWheelEvent;
  98329. /**
  98330. * Instantiates the base class of pointers info.
  98331. * @param type Defines the type of event (PointerEventTypes)
  98332. * @param event Defines the related dom event
  98333. */
  98334. constructor(
  98335. /**
  98336. * Defines the type of event (PointerEventTypes)
  98337. */
  98338. type: number,
  98339. /**
  98340. * Defines the related dom event
  98341. */
  98342. event: PointerEvent | MouseWheelEvent);
  98343. }
  98344. /**
  98345. * This class is used to store pointer related info for the onPrePointerObservable event.
  98346. * Set the skipOnPointerObservable property to true if you want the engine to stop any process after this event is triggered, even not calling onPointerObservable
  98347. */
  98348. export class PointerInfoPre extends PointerInfoBase {
  98349. /**
  98350. * Ray from a pointer if availible (eg. 6dof controller)
  98351. */
  98352. ray: Nullable<Ray>;
  98353. /**
  98354. * Defines the local position of the pointer on the canvas.
  98355. */
  98356. localPosition: Vector2;
  98357. /**
  98358. * Defines whether the engine should skip the next OnPointerObservable associated to this pre.
  98359. */
  98360. skipOnPointerObservable: boolean;
  98361. /**
  98362. * Instantiates a PointerInfoPre to store pointer related info to the onPrePointerObservable event.
  98363. * @param type Defines the type of event (PointerEventTypes)
  98364. * @param event Defines the related dom event
  98365. * @param localX Defines the local x coordinates of the pointer when the event occured
  98366. * @param localY Defines the local y coordinates of the pointer when the event occured
  98367. */
  98368. constructor(type: number, event: PointerEvent | MouseWheelEvent, localX: number, localY: number);
  98369. }
  98370. /**
  98371. * This type contains all the data related to a pointer event in Babylon.js.
  98372. * 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.
  98373. */
  98374. export class PointerInfo extends PointerInfoBase {
  98375. /**
  98376. * Defines the picking info associated to the info (if any)\
  98377. */
  98378. pickInfo: Nullable<PickingInfo>;
  98379. /**
  98380. * Instantiates a PointerInfo to store pointer related info to the onPointerObservable event.
  98381. * @param type Defines the type of event (PointerEventTypes)
  98382. * @param event Defines the related dom event
  98383. * @param pickInfo Defines the picking info associated to the info (if any)\
  98384. */
  98385. constructor(type: number, event: PointerEvent | MouseWheelEvent,
  98386. /**
  98387. * Defines the picking info associated to the info (if any)\
  98388. */
  98389. pickInfo: Nullable<PickingInfo>);
  98390. }
  98391. /**
  98392. * Data relating to a touch event on the screen.
  98393. */
  98394. export interface PointerTouch {
  98395. /**
  98396. * X coordinate of touch.
  98397. */
  98398. x: number;
  98399. /**
  98400. * Y coordinate of touch.
  98401. */
  98402. y: number;
  98403. /**
  98404. * Id of touch. Unique for each finger.
  98405. */
  98406. pointerId: number;
  98407. /**
  98408. * Event type passed from DOM.
  98409. */
  98410. type: any;
  98411. }
  98412. }
  98413. declare module BABYLON {
  98414. /**
  98415. * Manage the mouse inputs to control the movement of a free camera.
  98416. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  98417. */
  98418. export class FreeCameraMouseInput implements ICameraInput<FreeCamera> {
  98419. /**
  98420. * Define if touch is enabled in the mouse input
  98421. */
  98422. touchEnabled: boolean;
  98423. /**
  98424. * Defines the camera the input is attached to.
  98425. */
  98426. camera: FreeCamera;
  98427. /**
  98428. * Defines the buttons associated with the input to handle camera move.
  98429. */
  98430. buttons: number[];
  98431. /**
  98432. * Defines the pointer angular sensibility along the X and Y axis or how fast is the camera rotating.
  98433. */
  98434. angularSensibility: number;
  98435. private _pointerInput;
  98436. private _onMouseMove;
  98437. private _observer;
  98438. private previousPosition;
  98439. /**
  98440. * Observable for when a pointer move event occurs containing the move offset
  98441. */
  98442. onPointerMovedObservable: Observable<{
  98443. offsetX: number;
  98444. offsetY: number;
  98445. }>;
  98446. /**
  98447. * @hidden
  98448. * If the camera should be rotated automatically based on pointer movement
  98449. */
  98450. _allowCameraRotation: boolean;
  98451. /**
  98452. * Manage the mouse inputs to control the movement of a free camera.
  98453. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  98454. * @param touchEnabled Defines if touch is enabled or not
  98455. */
  98456. constructor(
  98457. /**
  98458. * Define if touch is enabled in the mouse input
  98459. */
  98460. touchEnabled?: boolean);
  98461. /**
  98462. * Attach the input controls to a specific dom element to get the input from.
  98463. * @param element Defines the element the controls should be listened from
  98464. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  98465. */
  98466. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  98467. /**
  98468. * Called on JS contextmenu event.
  98469. * Override this method to provide functionality.
  98470. */
  98471. protected onContextMenu(evt: PointerEvent): void;
  98472. /**
  98473. * Detach the current controls from the specified dom element.
  98474. * @param element Defines the element to stop listening the inputs from
  98475. */
  98476. detachControl(element: Nullable<HTMLElement>): void;
  98477. /**
  98478. * Gets the class name of the current intput.
  98479. * @returns the class name
  98480. */
  98481. getClassName(): string;
  98482. /**
  98483. * Get the friendly name associated with the input class.
  98484. * @returns the input friendly name
  98485. */
  98486. getSimpleName(): string;
  98487. }
  98488. }
  98489. declare module BABYLON {
  98490. /**
  98491. * Manage the touch inputs to control the movement of a free camera.
  98492. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  98493. */
  98494. export class FreeCameraTouchInput implements ICameraInput<FreeCamera> {
  98495. /**
  98496. * Define if mouse events can be treated as touch events
  98497. */
  98498. allowMouse: boolean;
  98499. /**
  98500. * Defines the camera the input is attached to.
  98501. */
  98502. camera: FreeCamera;
  98503. /**
  98504. * Defines the touch sensibility for rotation.
  98505. * The higher the faster.
  98506. */
  98507. touchAngularSensibility: number;
  98508. /**
  98509. * Defines the touch sensibility for move.
  98510. * The higher the faster.
  98511. */
  98512. touchMoveSensibility: number;
  98513. private _offsetX;
  98514. private _offsetY;
  98515. private _pointerPressed;
  98516. private _pointerInput;
  98517. private _observer;
  98518. private _onLostFocus;
  98519. /**
  98520. * Manage the touch inputs to control the movement of a free camera.
  98521. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  98522. * @param allowMouse Defines if mouse events can be treated as touch events
  98523. */
  98524. constructor(
  98525. /**
  98526. * Define if mouse events can be treated as touch events
  98527. */
  98528. allowMouse?: boolean);
  98529. /**
  98530. * Attach the input controls to a specific dom element to get the input from.
  98531. * @param element Defines the element the controls should be listened from
  98532. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  98533. */
  98534. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  98535. /**
  98536. * Detach the current controls from the specified dom element.
  98537. * @param element Defines the element to stop listening the inputs from
  98538. */
  98539. detachControl(element: Nullable<HTMLElement>): void;
  98540. /**
  98541. * Update the current camera state depending on the inputs that have been used this frame.
  98542. * This is a dynamically created lambda to avoid the performance penalty of looping for inputs in the render loop.
  98543. */
  98544. checkInputs(): void;
  98545. /**
  98546. * Gets the class name of the current intput.
  98547. * @returns the class name
  98548. */
  98549. getClassName(): string;
  98550. /**
  98551. * Get the friendly name associated with the input class.
  98552. * @returns the input friendly name
  98553. */
  98554. getSimpleName(): string;
  98555. }
  98556. }
  98557. declare module BABYLON {
  98558. /**
  98559. * Default Inputs manager for the FreeCamera.
  98560. * It groups all the default supported inputs for ease of use.
  98561. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  98562. */
  98563. export class FreeCameraInputsManager extends CameraInputsManager<FreeCamera> {
  98564. /**
  98565. * @hidden
  98566. */
  98567. _mouseInput: Nullable<FreeCameraMouseInput>;
  98568. /**
  98569. * Instantiates a new FreeCameraInputsManager.
  98570. * @param camera Defines the camera the inputs belong to
  98571. */
  98572. constructor(camera: FreeCamera);
  98573. /**
  98574. * Add keyboard input support to the input manager.
  98575. * @returns the current input manager
  98576. */
  98577. addKeyboard(): FreeCameraInputsManager;
  98578. /**
  98579. * Add mouse input support to the input manager.
  98580. * @param touchEnabled if the FreeCameraMouseInput should support touch (default: true)
  98581. * @returns the current input manager
  98582. */
  98583. addMouse(touchEnabled?: boolean): FreeCameraInputsManager;
  98584. /**
  98585. * Removes the mouse input support from the manager
  98586. * @returns the current input manager
  98587. */
  98588. removeMouse(): FreeCameraInputsManager;
  98589. /**
  98590. * Add touch input support to the input manager.
  98591. * @returns the current input manager
  98592. */
  98593. addTouch(): FreeCameraInputsManager;
  98594. /**
  98595. * Remove all attached input methods from a camera
  98596. */
  98597. clear(): void;
  98598. }
  98599. }
  98600. declare module BABYLON {
  98601. /**
  98602. * This represents a free type of camera. It can be useful in First Person Shooter game for instance.
  98603. * Please consider using the new UniversalCamera instead as it adds more functionality like the gamepad.
  98604. * @see https://doc.babylonjs.com/features/cameras#universal-camera
  98605. */
  98606. export class FreeCamera extends TargetCamera {
  98607. /**
  98608. * Define the collision ellipsoid of the camera.
  98609. * This is helpful to simulate a camera body like the player body around the camera
  98610. * @see https://doc.babylonjs.com/babylon101/cameras,_mesh_collisions_and_gravity#arcrotatecamera
  98611. */
  98612. ellipsoid: Vector3;
  98613. /**
  98614. * Define an offset for the position of the ellipsoid around the camera.
  98615. * This can be helpful to determine the center of the body near the gravity center of the body
  98616. * instead of its head.
  98617. */
  98618. ellipsoidOffset: Vector3;
  98619. /**
  98620. * Enable or disable collisions of the camera with the rest of the scene objects.
  98621. */
  98622. checkCollisions: boolean;
  98623. /**
  98624. * Enable or disable gravity on the camera.
  98625. */
  98626. applyGravity: boolean;
  98627. /**
  98628. * Define the input manager associated to the camera.
  98629. */
  98630. inputs: FreeCameraInputsManager;
  98631. /**
  98632. * Gets the input sensibility for a mouse input. (default is 2000.0)
  98633. * Higher values reduce sensitivity.
  98634. */
  98635. get angularSensibility(): number;
  98636. /**
  98637. * Sets the input sensibility for a mouse input. (default is 2000.0)
  98638. * Higher values reduce sensitivity.
  98639. */
  98640. set angularSensibility(value: number);
  98641. /**
  98642. * Gets or Set the list of keyboard keys used to control the forward move of the camera.
  98643. */
  98644. get keysUp(): number[];
  98645. set keysUp(value: number[]);
  98646. /**
  98647. * Gets or Set the list of keyboard keys used to control the upward move of the camera.
  98648. */
  98649. get keysUpward(): number[];
  98650. set keysUpward(value: number[]);
  98651. /**
  98652. * Gets or Set the list of keyboard keys used to control the backward move of the camera.
  98653. */
  98654. get keysDown(): number[];
  98655. set keysDown(value: number[]);
  98656. /**
  98657. * Gets or Set the list of keyboard keys used to control the downward move of the camera.
  98658. */
  98659. get keysDownward(): number[];
  98660. set keysDownward(value: number[]);
  98661. /**
  98662. * Gets or Set the list of keyboard keys used to control the left strafe move of the camera.
  98663. */
  98664. get keysLeft(): number[];
  98665. set keysLeft(value: number[]);
  98666. /**
  98667. * Gets or Set the list of keyboard keys used to control the right strafe move of the camera.
  98668. */
  98669. get keysRight(): number[];
  98670. set keysRight(value: number[]);
  98671. /**
  98672. * Event raised when the camera collide with a mesh in the scene.
  98673. */
  98674. onCollide: (collidedMesh: AbstractMesh) => void;
  98675. private _collider;
  98676. private _needMoveForGravity;
  98677. private _oldPosition;
  98678. private _diffPosition;
  98679. private _newPosition;
  98680. /** @hidden */
  98681. _localDirection: Vector3;
  98682. /** @hidden */
  98683. _transformedDirection: Vector3;
  98684. /**
  98685. * Instantiates a Free Camera.
  98686. * This represents a free type of camera. It can be useful in First Person Shooter game for instance.
  98687. * Please consider using the new UniversalCamera instead as it adds more functionality like touch to this camera.
  98688. * @see https://doc.babylonjs.com/features/cameras#universal-camera
  98689. * @param name Define the name of the camera in the scene
  98690. * @param position Define the start position of the camera in the scene
  98691. * @param scene Define the scene the camera belongs to
  98692. * @param setActiveOnSceneIfNoneActive Defines wheter the camera should be marked as active if not other active cameras have been defined
  98693. */
  98694. constructor(name: string, position: Vector3, scene: Scene, setActiveOnSceneIfNoneActive?: boolean);
  98695. /**
  98696. * Attached controls to the current camera.
  98697. * @param element Defines the element the controls should be listened from
  98698. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  98699. */
  98700. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  98701. /**
  98702. * Detach the current controls from the camera.
  98703. * The camera will stop reacting to inputs.
  98704. * @param element Defines the element to stop listening the inputs from
  98705. */
  98706. detachControl(element: HTMLElement): void;
  98707. private _collisionMask;
  98708. /**
  98709. * Define a collision mask to limit the list of object the camera can collide with
  98710. */
  98711. get collisionMask(): number;
  98712. set collisionMask(mask: number);
  98713. /** @hidden */
  98714. _collideWithWorld(displacement: Vector3): void;
  98715. private _onCollisionPositionChange;
  98716. /** @hidden */
  98717. _checkInputs(): void;
  98718. /** @hidden */
  98719. _decideIfNeedsToMove(): boolean;
  98720. /** @hidden */
  98721. _updatePosition(): void;
  98722. /**
  98723. * Destroy the camera and release the current resources hold by it.
  98724. */
  98725. dispose(): void;
  98726. /**
  98727. * Gets the current object class name.
  98728. * @return the class name
  98729. */
  98730. getClassName(): string;
  98731. }
  98732. }
  98733. declare module BABYLON {
  98734. /**
  98735. * Represents a gamepad control stick position
  98736. */
  98737. export class StickValues {
  98738. /**
  98739. * The x component of the control stick
  98740. */
  98741. x: number;
  98742. /**
  98743. * The y component of the control stick
  98744. */
  98745. y: number;
  98746. /**
  98747. * Initializes the gamepad x and y control stick values
  98748. * @param x The x component of the gamepad control stick value
  98749. * @param y The y component of the gamepad control stick value
  98750. */
  98751. constructor(
  98752. /**
  98753. * The x component of the control stick
  98754. */
  98755. x: number,
  98756. /**
  98757. * The y component of the control stick
  98758. */
  98759. y: number);
  98760. }
  98761. /**
  98762. * An interface which manages callbacks for gamepad button changes
  98763. */
  98764. export interface GamepadButtonChanges {
  98765. /**
  98766. * Called when a gamepad has been changed
  98767. */
  98768. changed: boolean;
  98769. /**
  98770. * Called when a gamepad press event has been triggered
  98771. */
  98772. pressChanged: boolean;
  98773. /**
  98774. * Called when a touch event has been triggered
  98775. */
  98776. touchChanged: boolean;
  98777. /**
  98778. * Called when a value has changed
  98779. */
  98780. valueChanged: boolean;
  98781. }
  98782. /**
  98783. * Represents a gamepad
  98784. */
  98785. export class Gamepad {
  98786. /**
  98787. * The id of the gamepad
  98788. */
  98789. id: string;
  98790. /**
  98791. * The index of the gamepad
  98792. */
  98793. index: number;
  98794. /**
  98795. * The browser gamepad
  98796. */
  98797. browserGamepad: any;
  98798. /**
  98799. * Specifies what type of gamepad this represents
  98800. */
  98801. type: number;
  98802. private _leftStick;
  98803. private _rightStick;
  98804. /** @hidden */
  98805. _isConnected: boolean;
  98806. private _leftStickAxisX;
  98807. private _leftStickAxisY;
  98808. private _rightStickAxisX;
  98809. private _rightStickAxisY;
  98810. /**
  98811. * Triggered when the left control stick has been changed
  98812. */
  98813. private _onleftstickchanged;
  98814. /**
  98815. * Triggered when the right control stick has been changed
  98816. */
  98817. private _onrightstickchanged;
  98818. /**
  98819. * Represents a gamepad controller
  98820. */
  98821. static GAMEPAD: number;
  98822. /**
  98823. * Represents a generic controller
  98824. */
  98825. static GENERIC: number;
  98826. /**
  98827. * Represents an XBox controller
  98828. */
  98829. static XBOX: number;
  98830. /**
  98831. * Represents a pose-enabled controller
  98832. */
  98833. static POSE_ENABLED: number;
  98834. /**
  98835. * Represents an Dual Shock controller
  98836. */
  98837. static DUALSHOCK: number;
  98838. /**
  98839. * Specifies whether the left control stick should be Y-inverted
  98840. */
  98841. protected _invertLeftStickY: boolean;
  98842. /**
  98843. * Specifies if the gamepad has been connected
  98844. */
  98845. get isConnected(): boolean;
  98846. /**
  98847. * Initializes the gamepad
  98848. * @param id The id of the gamepad
  98849. * @param index The index of the gamepad
  98850. * @param browserGamepad The browser gamepad
  98851. * @param leftStickX The x component of the left joystick
  98852. * @param leftStickY The y component of the left joystick
  98853. * @param rightStickX The x component of the right joystick
  98854. * @param rightStickY The y component of the right joystick
  98855. */
  98856. constructor(
  98857. /**
  98858. * The id of the gamepad
  98859. */
  98860. id: string,
  98861. /**
  98862. * The index of the gamepad
  98863. */
  98864. index: number,
  98865. /**
  98866. * The browser gamepad
  98867. */
  98868. browserGamepad: any, leftStickX?: number, leftStickY?: number, rightStickX?: number, rightStickY?: number);
  98869. /**
  98870. * Callback triggered when the left joystick has changed
  98871. * @param callback
  98872. */
  98873. onleftstickchanged(callback: (values: StickValues) => void): void;
  98874. /**
  98875. * Callback triggered when the right joystick has changed
  98876. * @param callback
  98877. */
  98878. onrightstickchanged(callback: (values: StickValues) => void): void;
  98879. /**
  98880. * Gets the left joystick
  98881. */
  98882. get leftStick(): StickValues;
  98883. /**
  98884. * Sets the left joystick values
  98885. */
  98886. set leftStick(newValues: StickValues);
  98887. /**
  98888. * Gets the right joystick
  98889. */
  98890. get rightStick(): StickValues;
  98891. /**
  98892. * Sets the right joystick value
  98893. */
  98894. set rightStick(newValues: StickValues);
  98895. /**
  98896. * Updates the gamepad joystick positions
  98897. */
  98898. update(): void;
  98899. /**
  98900. * Disposes the gamepad
  98901. */
  98902. dispose(): void;
  98903. }
  98904. /**
  98905. * Represents a generic gamepad
  98906. */
  98907. export class GenericPad extends Gamepad {
  98908. private _buttons;
  98909. private _onbuttondown;
  98910. private _onbuttonup;
  98911. /**
  98912. * Observable triggered when a button has been pressed
  98913. */
  98914. onButtonDownObservable: Observable<number>;
  98915. /**
  98916. * Observable triggered when a button has been released
  98917. */
  98918. onButtonUpObservable: Observable<number>;
  98919. /**
  98920. * Callback triggered when a button has been pressed
  98921. * @param callback Called when a button has been pressed
  98922. */
  98923. onbuttondown(callback: (buttonPressed: number) => void): void;
  98924. /**
  98925. * Callback triggered when a button has been released
  98926. * @param callback Called when a button has been released
  98927. */
  98928. onbuttonup(callback: (buttonReleased: number) => void): void;
  98929. /**
  98930. * Initializes the generic gamepad
  98931. * @param id The id of the generic gamepad
  98932. * @param index The index of the generic gamepad
  98933. * @param browserGamepad The browser gamepad
  98934. */
  98935. constructor(id: string, index: number, browserGamepad: any);
  98936. private _setButtonValue;
  98937. /**
  98938. * Updates the generic gamepad
  98939. */
  98940. update(): void;
  98941. /**
  98942. * Disposes the generic gamepad
  98943. */
  98944. dispose(): void;
  98945. }
  98946. }
  98947. declare module BABYLON {
  98948. /**
  98949. * Defines the types of pose enabled controllers that are supported
  98950. */
  98951. export enum PoseEnabledControllerType {
  98952. /**
  98953. * HTC Vive
  98954. */
  98955. VIVE = 0,
  98956. /**
  98957. * Oculus Rift
  98958. */
  98959. OCULUS = 1,
  98960. /**
  98961. * Windows mixed reality
  98962. */
  98963. WINDOWS = 2,
  98964. /**
  98965. * Samsung gear VR
  98966. */
  98967. GEAR_VR = 3,
  98968. /**
  98969. * Google Daydream
  98970. */
  98971. DAYDREAM = 4,
  98972. /**
  98973. * Generic
  98974. */
  98975. GENERIC = 5
  98976. }
  98977. /**
  98978. * Defines the MutableGamepadButton interface for the state of a gamepad button
  98979. */
  98980. export interface MutableGamepadButton {
  98981. /**
  98982. * Value of the button/trigger
  98983. */
  98984. value: number;
  98985. /**
  98986. * If the button/trigger is currently touched
  98987. */
  98988. touched: boolean;
  98989. /**
  98990. * If the button/trigger is currently pressed
  98991. */
  98992. pressed: boolean;
  98993. }
  98994. /**
  98995. * Defines the ExtendedGamepadButton interface for a gamepad button which includes state provided by a pose controller
  98996. * @hidden
  98997. */
  98998. export interface ExtendedGamepadButton extends GamepadButton {
  98999. /**
  99000. * If the button/trigger is currently pressed
  99001. */
  99002. readonly pressed: boolean;
  99003. /**
  99004. * If the button/trigger is currently touched
  99005. */
  99006. readonly touched: boolean;
  99007. /**
  99008. * Value of the button/trigger
  99009. */
  99010. readonly value: number;
  99011. }
  99012. /** @hidden */
  99013. export interface _GamePadFactory {
  99014. /**
  99015. * Returns whether or not the current gamepad can be created for this type of controller.
  99016. * @param gamepadInfo Defines the gamepad info as received from the controller APIs.
  99017. * @returns true if it can be created, otherwise false
  99018. */
  99019. canCreate(gamepadInfo: any): boolean;
  99020. /**
  99021. * Creates a new instance of the Gamepad.
  99022. * @param gamepadInfo Defines the gamepad info as received from the controller APIs.
  99023. * @returns the new gamepad instance
  99024. */
  99025. create(gamepadInfo: any): Gamepad;
  99026. }
  99027. /**
  99028. * Defines the PoseEnabledControllerHelper object that is used initialize a gamepad as the controller type it is specified as (eg. windows mixed reality controller)
  99029. */
  99030. export class PoseEnabledControllerHelper {
  99031. /** @hidden */
  99032. static _ControllerFactories: _GamePadFactory[];
  99033. /** @hidden */
  99034. static _DefaultControllerFactory: Nullable<(gamepadInfo: any) => Gamepad>;
  99035. /**
  99036. * Initializes a gamepad as the controller type it is specified as (eg. windows mixed reality controller)
  99037. * @param vrGamepad the gamepad to initialized
  99038. * @returns a vr controller of the type the gamepad identified as
  99039. */
  99040. static InitiateController(vrGamepad: any): Gamepad;
  99041. }
  99042. /**
  99043. * Defines the PoseEnabledController object that contains state of a vr capable controller
  99044. */
  99045. export class PoseEnabledController extends Gamepad implements PoseControlled {
  99046. /**
  99047. * If the controller is used in a webXR session
  99048. */
  99049. isXR: boolean;
  99050. private _deviceRoomPosition;
  99051. private _deviceRoomRotationQuaternion;
  99052. /**
  99053. * The device position in babylon space
  99054. */
  99055. devicePosition: Vector3;
  99056. /**
  99057. * The device rotation in babylon space
  99058. */
  99059. deviceRotationQuaternion: Quaternion;
  99060. /**
  99061. * The scale factor of the device in babylon space
  99062. */
  99063. deviceScaleFactor: number;
  99064. /**
  99065. * (Likely devicePosition should be used instead) The device position in its room space
  99066. */
  99067. position: Vector3;
  99068. /**
  99069. * (Likely deviceRotationQuaternion should be used instead) The device rotation in its room space
  99070. */
  99071. rotationQuaternion: Quaternion;
  99072. /**
  99073. * The type of controller (Eg. Windows mixed reality)
  99074. */
  99075. controllerType: PoseEnabledControllerType;
  99076. protected _calculatedPosition: Vector3;
  99077. private _calculatedRotation;
  99078. /**
  99079. * The raw pose from the device
  99080. */
  99081. rawPose: DevicePose;
  99082. private _trackPosition;
  99083. private _maxRotationDistFromHeadset;
  99084. private _draggedRoomRotation;
  99085. /**
  99086. * @hidden
  99087. */
  99088. _disableTrackPosition(fixedPosition: Vector3): void;
  99089. /**
  99090. * Internal, the mesh attached to the controller
  99091. * @hidden
  99092. */
  99093. _mesh: Nullable<AbstractMesh>;
  99094. private _poseControlledCamera;
  99095. private _leftHandSystemQuaternion;
  99096. /**
  99097. * Internal, matrix used to convert room space to babylon space
  99098. * @hidden
  99099. */
  99100. _deviceToWorld: Matrix;
  99101. /**
  99102. * Node to be used when casting a ray from the controller
  99103. * @hidden
  99104. */
  99105. _pointingPoseNode: Nullable<TransformNode>;
  99106. /**
  99107. * Name of the child mesh that can be used to cast a ray from the controller
  99108. */
  99109. static readonly POINTING_POSE: string;
  99110. /**
  99111. * Creates a new PoseEnabledController from a gamepad
  99112. * @param browserGamepad the gamepad that the PoseEnabledController should be created from
  99113. */
  99114. constructor(browserGamepad: any);
  99115. private _workingMatrix;
  99116. /**
  99117. * Updates the state of the pose enbaled controller and mesh based on the current position and rotation of the controller
  99118. */
  99119. update(): void;
  99120. /**
  99121. * Updates only the pose device and mesh without doing any button event checking
  99122. */
  99123. protected _updatePoseAndMesh(): void;
  99124. /**
  99125. * Updates the state of the pose enbaled controller based on the raw pose data from the device
  99126. * @param poseData raw pose fromthe device
  99127. */
  99128. updateFromDevice(poseData: DevicePose): void;
  99129. /**
  99130. * @hidden
  99131. */
  99132. _meshAttachedObservable: Observable<AbstractMesh>;
  99133. /**
  99134. * Attaches a mesh to the controller
  99135. * @param mesh the mesh to be attached
  99136. */
  99137. attachToMesh(mesh: AbstractMesh): void;
  99138. /**
  99139. * Attaches the controllers mesh to a camera
  99140. * @param camera the camera the mesh should be attached to
  99141. */
  99142. attachToPoseControlledCamera(camera: TargetCamera): void;
  99143. /**
  99144. * Disposes of the controller
  99145. */
  99146. dispose(): void;
  99147. /**
  99148. * The mesh that is attached to the controller
  99149. */
  99150. get mesh(): Nullable<AbstractMesh>;
  99151. /**
  99152. * Gets the ray of the controller in the direction the controller is pointing
  99153. * @param length the length the resulting ray should be
  99154. * @returns a ray in the direction the controller is pointing
  99155. */
  99156. getForwardRay(length?: number): Ray;
  99157. }
  99158. }
  99159. declare module BABYLON {
  99160. /**
  99161. * Defines the WebVRController object that represents controllers tracked in 3D space
  99162. */
  99163. export abstract class WebVRController extends PoseEnabledController {
  99164. /**
  99165. * Internal, the default controller model for the controller
  99166. */
  99167. protected _defaultModel: Nullable<AbstractMesh>;
  99168. /**
  99169. * Fired when the trigger state has changed
  99170. */
  99171. onTriggerStateChangedObservable: Observable<ExtendedGamepadButton>;
  99172. /**
  99173. * Fired when the main button state has changed
  99174. */
  99175. onMainButtonStateChangedObservable: Observable<ExtendedGamepadButton>;
  99176. /**
  99177. * Fired when the secondary button state has changed
  99178. */
  99179. onSecondaryButtonStateChangedObservable: Observable<ExtendedGamepadButton>;
  99180. /**
  99181. * Fired when the pad state has changed
  99182. */
  99183. onPadStateChangedObservable: Observable<ExtendedGamepadButton>;
  99184. /**
  99185. * Fired when controllers stick values have changed
  99186. */
  99187. onPadValuesChangedObservable: Observable<StickValues>;
  99188. /**
  99189. * Array of button availible on the controller
  99190. */
  99191. protected _buttons: Array<MutableGamepadButton>;
  99192. private _onButtonStateChange;
  99193. /**
  99194. * Fired when a controller button's state has changed
  99195. * @param callback the callback containing the button that was modified
  99196. */
  99197. onButtonStateChange(callback: (controlledIndex: number, buttonIndex: number, state: ExtendedGamepadButton) => void): void;
  99198. /**
  99199. * X and Y axis corresponding to the controllers joystick
  99200. */
  99201. pad: StickValues;
  99202. /**
  99203. * 'left' or 'right', see https://w3c.github.io/gamepad/extensions.html#gamepadhand-enum
  99204. */
  99205. hand: string;
  99206. /**
  99207. * The default controller model for the controller
  99208. */
  99209. get defaultModel(): Nullable<AbstractMesh>;
  99210. /**
  99211. * Creates a new WebVRController from a gamepad
  99212. * @param vrGamepad the gamepad that the WebVRController should be created from
  99213. */
  99214. constructor(vrGamepad: any);
  99215. /**
  99216. * Updates the state of the controller and mesh based on the current position and rotation of the controller
  99217. */
  99218. update(): void;
  99219. /**
  99220. * Function to be called when a button is modified
  99221. */
  99222. protected abstract _handleButtonChange(buttonIdx: number, value: ExtendedGamepadButton, changes: GamepadButtonChanges): void;
  99223. /**
  99224. * Loads a mesh and attaches it to the controller
  99225. * @param scene the scene the mesh should be added to
  99226. * @param meshLoaded callback for when the mesh has been loaded
  99227. */
  99228. abstract initControllerMesh(scene: Scene, meshLoaded?: (mesh: AbstractMesh) => void): void;
  99229. private _setButtonValue;
  99230. private _changes;
  99231. private _checkChanges;
  99232. /**
  99233. * Disposes of th webVRCOntroller
  99234. */
  99235. dispose(): void;
  99236. }
  99237. }
  99238. declare module BABYLON {
  99239. /**
  99240. * The HemisphericLight simulates the ambient environment light,
  99241. * so the passed direction is the light reflection direction, not the incoming direction.
  99242. */
  99243. export class HemisphericLight extends Light {
  99244. /**
  99245. * The groundColor is the light in the opposite direction to the one specified during creation.
  99246. * 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.
  99247. */
  99248. groundColor: Color3;
  99249. /**
  99250. * The light reflection direction, not the incoming direction.
  99251. */
  99252. direction: Vector3;
  99253. /**
  99254. * Creates a HemisphericLight object in the scene according to the passed direction (Vector3).
  99255. * The HemisphericLight simulates the ambient environment light, so the passed direction is the light reflection direction, not the incoming direction.
  99256. * The HemisphericLight can't cast shadows.
  99257. * Documentation : https://doc.babylonjs.com/babylon101/lights
  99258. * @param name The friendly name of the light
  99259. * @param direction The direction of the light reflection
  99260. * @param scene The scene the light belongs to
  99261. */
  99262. constructor(name: string, direction: Vector3, scene: Scene);
  99263. protected _buildUniformLayout(): void;
  99264. /**
  99265. * Returns the string "HemisphericLight".
  99266. * @return The class name
  99267. */
  99268. getClassName(): string;
  99269. /**
  99270. * Sets the HemisphericLight direction towards the passed target (Vector3).
  99271. * Returns the updated direction.
  99272. * @param target The target the direction should point to
  99273. * @return The computed direction
  99274. */
  99275. setDirectionToTarget(target: Vector3): Vector3;
  99276. /**
  99277. * Returns the shadow generator associated to the light.
  99278. * @returns Always null for hemispheric lights because it does not support shadows.
  99279. */
  99280. getShadowGenerator(): Nullable<IShadowGenerator>;
  99281. /**
  99282. * Sets the passed Effect object with the HemisphericLight normalized direction and color and the passed name (string).
  99283. * @param effect The effect to update
  99284. * @param lightIndex The index of the light in the effect to update
  99285. * @returns The hemispheric light
  99286. */
  99287. transferToEffect(effect: Effect, lightIndex: string): HemisphericLight;
  99288. transferToNodeMaterialEffect(effect: Effect, lightDataUniformName: string): this;
  99289. /**
  99290. * Computes the world matrix of the node
  99291. * @param force defines if the cache version should be invalidated forcing the world matrix to be created from scratch
  99292. * @param useWasUpdatedFlag defines a reserved property
  99293. * @returns the world matrix
  99294. */
  99295. computeWorldMatrix(): Matrix;
  99296. /**
  99297. * Returns the integer 3.
  99298. * @return The light Type id as a constant defines in Light.LIGHTTYPEID_x
  99299. */
  99300. getTypeID(): number;
  99301. /**
  99302. * Prepares the list of defines specific to the light type.
  99303. * @param defines the list of defines
  99304. * @param lightIndex defines the index of the light for the effect
  99305. */
  99306. prepareLightSpecificDefines(defines: any, lightIndex: number): void;
  99307. }
  99308. }
  99309. declare module BABYLON {
  99310. /** @hidden */
  99311. export var vrMultiviewToSingleviewPixelShader: {
  99312. name: string;
  99313. shader: string;
  99314. };
  99315. }
  99316. declare module BABYLON {
  99317. /**
  99318. * Renders to multiple views with a single draw call
  99319. * @see https://www.khronos.org/registry/webgl/extensions/WEBGL_multiview/
  99320. */
  99321. export class MultiviewRenderTarget extends RenderTargetTexture {
  99322. /**
  99323. * Creates a multiview render target
  99324. * @param scene scene used with the render target
  99325. * @param size the size of the render target (used for each view)
  99326. */
  99327. constructor(scene: Scene, size?: number | {
  99328. width: number;
  99329. height: number;
  99330. } | {
  99331. ratio: number;
  99332. });
  99333. /**
  99334. * @hidden
  99335. * @param faceIndex the face index, if its a cube texture
  99336. */
  99337. _bindFrameBuffer(faceIndex?: number): void;
  99338. /**
  99339. * Gets the number of views the corresponding to the texture (eg. a MultiviewRenderTarget will have > 1)
  99340. * @returns the view count
  99341. */
  99342. getViewCount(): number;
  99343. }
  99344. }
  99345. declare module BABYLON {
  99346. interface Engine {
  99347. /**
  99348. * Creates a new multiview render target
  99349. * @param width defines the width of the texture
  99350. * @param height defines the height of the texture
  99351. * @returns the created multiview texture
  99352. */
  99353. createMultiviewRenderTargetTexture(width: number, height: number): InternalTexture;
  99354. /**
  99355. * Binds a multiview framebuffer to be drawn to
  99356. * @param multiviewTexture texture to bind
  99357. */
  99358. bindMultiviewFramebuffer(multiviewTexture: InternalTexture): void;
  99359. }
  99360. interface Camera {
  99361. /**
  99362. * @hidden
  99363. * 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)
  99364. */
  99365. _useMultiviewToSingleView: boolean;
  99366. /**
  99367. * @hidden
  99368. * 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)
  99369. */
  99370. _multiviewTexture: Nullable<RenderTargetTexture>;
  99371. /**
  99372. * @hidden
  99373. * ensures the multiview texture of the camera exists and has the specified width/height
  99374. * @param width height to set on the multiview texture
  99375. * @param height width to set on the multiview texture
  99376. */
  99377. _resizeOrCreateMultiviewTexture(width: number, height: number): void;
  99378. }
  99379. interface Scene {
  99380. /** @hidden */
  99381. _transformMatrixR: Matrix;
  99382. /** @hidden */
  99383. _multiviewSceneUbo: Nullable<UniformBuffer>;
  99384. /** @hidden */
  99385. _createMultiviewUbo(): void;
  99386. /** @hidden */
  99387. _updateMultiviewUbo(viewR?: Matrix, projectionR?: Matrix): void;
  99388. /** @hidden */
  99389. _renderMultiviewToSingleView(camera: Camera): void;
  99390. }
  99391. }
  99392. declare module BABYLON {
  99393. /**
  99394. * VRMultiviewToSingleview used to convert multiview texture arrays to standard textures for scenarios such as webVR
  99395. * This will not be used for webXR as it supports displaying texture arrays directly
  99396. */
  99397. export class VRMultiviewToSingleviewPostProcess extends PostProcess {
  99398. /**
  99399. * Gets a string identifying the name of the class
  99400. * @returns "VRMultiviewToSingleviewPostProcess" string
  99401. */
  99402. getClassName(): string;
  99403. /**
  99404. * Initializes a VRMultiviewToSingleview
  99405. * @param name name of the post process
  99406. * @param camera camera to be applied to
  99407. * @param scaleFactor scaling factor to the size of the output texture
  99408. */
  99409. constructor(name: string, camera: Camera, scaleFactor: number);
  99410. }
  99411. }
  99412. declare module BABYLON {
  99413. /**
  99414. * Interface used to define additional presentation attributes
  99415. */
  99416. export interface IVRPresentationAttributes {
  99417. /**
  99418. * Defines a boolean indicating that we want to get 72hz mode on Oculus Browser (default is off eg. 60hz)
  99419. */
  99420. highRefreshRate: boolean;
  99421. /**
  99422. * Enables foveation in VR to improve perf. 0 none, 1 low, 2 medium, 3 high (Default is 1)
  99423. */
  99424. foveationLevel: number;
  99425. }
  99426. interface Engine {
  99427. /** @hidden */
  99428. _vrDisplay: any;
  99429. /** @hidden */
  99430. _vrSupported: boolean;
  99431. /** @hidden */
  99432. _oldSize: Size;
  99433. /** @hidden */
  99434. _oldHardwareScaleFactor: number;
  99435. /** @hidden */
  99436. _vrExclusivePointerMode: boolean;
  99437. /** @hidden */
  99438. _webVRInitPromise: Promise<IDisplayChangedEventArgs>;
  99439. /** @hidden */
  99440. _onVRDisplayPointerRestricted: () => void;
  99441. /** @hidden */
  99442. _onVRDisplayPointerUnrestricted: () => void;
  99443. /** @hidden */
  99444. _onVrDisplayConnect: Nullable<(display: any) => void>;
  99445. /** @hidden */
  99446. _onVrDisplayDisconnect: Nullable<() => void>;
  99447. /** @hidden */
  99448. _onVrDisplayPresentChange: Nullable<() => void>;
  99449. /**
  99450. * Observable signaled when VR display mode changes
  99451. */
  99452. onVRDisplayChangedObservable: Observable<IDisplayChangedEventArgs>;
  99453. /**
  99454. * Observable signaled when VR request present is complete
  99455. */
  99456. onVRRequestPresentComplete: Observable<boolean>;
  99457. /**
  99458. * Observable signaled when VR request present starts
  99459. */
  99460. onVRRequestPresentStart: Observable<Engine>;
  99461. /**
  99462. * Gets a boolean indicating that the engine is currently in VR exclusive mode for the pointers
  99463. * @see https://docs.microsoft.com/en-us/microsoft-edge/webvr/essentials#mouse-input
  99464. */
  99465. isInVRExclusivePointerMode: boolean;
  99466. /**
  99467. * Gets a boolean indicating if a webVR device was detected
  99468. * @returns true if a webVR device was detected
  99469. */
  99470. isVRDevicePresent(): boolean;
  99471. /**
  99472. * Gets the current webVR device
  99473. * @returns the current webVR device (or null)
  99474. */
  99475. getVRDevice(): any;
  99476. /**
  99477. * Initializes a webVR display and starts listening to display change events
  99478. * The onVRDisplayChangedObservable will be notified upon these changes
  99479. * @returns A promise containing a VRDisplay and if vr is supported
  99480. */
  99481. initWebVRAsync(): Promise<IDisplayChangedEventArgs>;
  99482. /** @hidden */
  99483. _getVRDisplaysAsync(): Promise<IDisplayChangedEventArgs>;
  99484. /**
  99485. * Gets or sets the presentation attributes used to configure VR rendering
  99486. */
  99487. vrPresentationAttributes?: IVRPresentationAttributes;
  99488. /**
  99489. * Call this function to switch to webVR mode
  99490. * Will do nothing if webVR is not supported or if there is no webVR device
  99491. * @param options the webvr options provided to the camera. mainly used for multiview
  99492. * @see https://doc.babylonjs.com/how_to/webvr_camera
  99493. */
  99494. enableVR(options: WebVROptions): void;
  99495. /** @hidden */
  99496. _onVRFullScreenTriggered(): void;
  99497. }
  99498. }
  99499. declare module BABYLON {
  99500. /**
  99501. * This is a copy of VRPose. See https://developer.mozilla.org/en-US/docs/Web/API/VRPose
  99502. * IMPORTANT!! The data is right-hand data.
  99503. * @export
  99504. * @interface DevicePose
  99505. */
  99506. export interface DevicePose {
  99507. /**
  99508. * The position of the device, values in array are [x,y,z].
  99509. */
  99510. readonly position: Nullable<Float32Array>;
  99511. /**
  99512. * The linearVelocity of the device, values in array are [x,y,z].
  99513. */
  99514. readonly linearVelocity: Nullable<Float32Array>;
  99515. /**
  99516. * The linearAcceleration of the device, values in array are [x,y,z].
  99517. */
  99518. readonly linearAcceleration: Nullable<Float32Array>;
  99519. /**
  99520. * The orientation of the device in a quaternion array, values in array are [x,y,z,w].
  99521. */
  99522. readonly orientation: Nullable<Float32Array>;
  99523. /**
  99524. * The angularVelocity of the device, values in array are [x,y,z].
  99525. */
  99526. readonly angularVelocity: Nullable<Float32Array>;
  99527. /**
  99528. * The angularAcceleration of the device, values in array are [x,y,z].
  99529. */
  99530. readonly angularAcceleration: Nullable<Float32Array>;
  99531. }
  99532. /**
  99533. * Interface representing a pose controlled object in Babylon.
  99534. * A pose controlled object has both regular pose values as well as pose values
  99535. * from an external device such as a VR head mounted display
  99536. */
  99537. export interface PoseControlled {
  99538. /**
  99539. * The position of the object in babylon space.
  99540. */
  99541. position: Vector3;
  99542. /**
  99543. * The rotation quaternion of the object in babylon space.
  99544. */
  99545. rotationQuaternion: Quaternion;
  99546. /**
  99547. * The position of the device in babylon space.
  99548. */
  99549. devicePosition?: Vector3;
  99550. /**
  99551. * The rotation quaternion of the device in babylon space.
  99552. */
  99553. deviceRotationQuaternion: Quaternion;
  99554. /**
  99555. * The raw pose coming from the device.
  99556. */
  99557. rawPose: Nullable<DevicePose>;
  99558. /**
  99559. * The scale of the device to be used when translating from device space to babylon space.
  99560. */
  99561. deviceScaleFactor: number;
  99562. /**
  99563. * Updates the poseControlled values based on the input device pose.
  99564. * @param poseData the pose data to update the object with
  99565. */
  99566. updateFromDevice(poseData: DevicePose): void;
  99567. }
  99568. /**
  99569. * Set of options to customize the webVRCamera
  99570. */
  99571. export interface WebVROptions {
  99572. /**
  99573. * Sets if the webVR camera should be tracked to the vrDevice. (default: true)
  99574. */
  99575. trackPosition?: boolean;
  99576. /**
  99577. * Sets the scale of the vrDevice in babylon space. (default: 1)
  99578. */
  99579. positionScale?: number;
  99580. /**
  99581. * If there are more than one VRDisplays, this will choose the display matching this name. (default: pick first vrDisplay)
  99582. */
  99583. displayName?: string;
  99584. /**
  99585. * Should the native controller meshes be initialized. (default: true)
  99586. */
  99587. controllerMeshes?: boolean;
  99588. /**
  99589. * Creating a default HemiLight only on controllers. (default: true)
  99590. */
  99591. defaultLightingOnControllers?: boolean;
  99592. /**
  99593. * If you don't want to use the default VR button of the helper. (default: false)
  99594. */
  99595. useCustomVRButton?: boolean;
  99596. /**
  99597. * If you'd like to provide your own button to the VRHelper. (default: standard babylon vr button)
  99598. */
  99599. customVRButton?: HTMLButtonElement;
  99600. /**
  99601. * To change the length of the ray for gaze/controllers. Will be scaled by positionScale. (default: 100)
  99602. */
  99603. rayLength?: number;
  99604. /**
  99605. * To change the default offset from the ground to account for user's height in meters. Will be scaled by positionScale. (default: 1.7)
  99606. */
  99607. defaultHeight?: number;
  99608. /**
  99609. * If multiview should be used if availible (default: false)
  99610. */
  99611. useMultiview?: boolean;
  99612. }
  99613. /**
  99614. * This represents a WebVR camera.
  99615. * The WebVR camera is Babylon's simple interface to interaction with Windows Mixed Reality, HTC Vive and Oculus Rift.
  99616. * @example https://doc.babylonjs.com/how_to/webvr_camera
  99617. */
  99618. export class WebVRFreeCamera extends FreeCamera implements PoseControlled {
  99619. private webVROptions;
  99620. /**
  99621. * @hidden
  99622. * The vrDisplay tied to the camera. See https://developer.mozilla.org/en-US/docs/Web/API/VRDisplay
  99623. */
  99624. _vrDevice: any;
  99625. /**
  99626. * The rawPose of the vrDevice.
  99627. */
  99628. rawPose: Nullable<DevicePose>;
  99629. private _onVREnabled;
  99630. private _specsVersion;
  99631. private _attached;
  99632. private _frameData;
  99633. protected _descendants: Array<Node>;
  99634. private _deviceRoomPosition;
  99635. /** @hidden */
  99636. _deviceRoomRotationQuaternion: Quaternion;
  99637. private _standingMatrix;
  99638. /**
  99639. * Represents device position in babylon space.
  99640. */
  99641. devicePosition: Vector3;
  99642. /**
  99643. * Represents device rotation in babylon space.
  99644. */
  99645. deviceRotationQuaternion: Quaternion;
  99646. /**
  99647. * The scale of the device to be used when translating from device space to babylon space.
  99648. */
  99649. deviceScaleFactor: number;
  99650. private _deviceToWorld;
  99651. private _worldToDevice;
  99652. /**
  99653. * References to the webVR controllers for the vrDevice.
  99654. */
  99655. controllers: Array<WebVRController>;
  99656. /**
  99657. * Emits an event when a controller is attached.
  99658. */
  99659. onControllersAttachedObservable: Observable<WebVRController[]>;
  99660. /**
  99661. * Emits an event when a controller's mesh has been loaded;
  99662. */
  99663. onControllerMeshLoadedObservable: Observable<WebVRController>;
  99664. /**
  99665. * Emits an event when the HMD's pose has been updated.
  99666. */
  99667. onPoseUpdatedFromDeviceObservable: Observable<any>;
  99668. private _poseSet;
  99669. /**
  99670. * If the rig cameras be used as parent instead of this camera.
  99671. */
  99672. rigParenting: boolean;
  99673. private _lightOnControllers;
  99674. private _defaultHeight?;
  99675. /**
  99676. * Instantiates a WebVRFreeCamera.
  99677. * @param name The name of the WebVRFreeCamera
  99678. * @param position The starting anchor position for the camera
  99679. * @param scene The scene the camera belongs to
  99680. * @param webVROptions a set of customizable options for the webVRCamera
  99681. */
  99682. constructor(name: string, position: Vector3, scene: Scene, webVROptions?: WebVROptions);
  99683. /**
  99684. * Gets the device distance from the ground in meters.
  99685. * @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.
  99686. */
  99687. deviceDistanceToRoomGround(): number;
  99688. /**
  99689. * Enables the standing matrix when supported. This can be used to position the user's view the correct height from the ground.
  99690. * @param callback will be called when the standing matrix is set. Callback parameter is if the standing matrix is supported.
  99691. */
  99692. useStandingMatrix(callback?: (bool: boolean) => void): void;
  99693. /**
  99694. * Enables the standing matrix when supported. This can be used to position the user's view the correct height from the ground.
  99695. * @returns A promise with a boolean set to if the standing matrix is supported.
  99696. */
  99697. useStandingMatrixAsync(): Promise<boolean>;
  99698. /**
  99699. * Disposes the camera
  99700. */
  99701. dispose(): void;
  99702. /**
  99703. * Gets a vrController by name.
  99704. * @param name The name of the controller to retreive
  99705. * @returns the controller matching the name specified or null if not found
  99706. */
  99707. getControllerByName(name: string): Nullable<WebVRController>;
  99708. private _leftController;
  99709. /**
  99710. * The controller corresponding to the users left hand.
  99711. */
  99712. get leftController(): Nullable<WebVRController>;
  99713. private _rightController;
  99714. /**
  99715. * The controller corresponding to the users right hand.
  99716. */
  99717. get rightController(): Nullable<WebVRController>;
  99718. /**
  99719. * Casts a ray forward from the vrCamera's gaze.
  99720. * @param length Length of the ray (default: 100)
  99721. * @returns the ray corresponding to the gaze
  99722. */
  99723. getForwardRay(length?: number): Ray;
  99724. /**
  99725. * @hidden
  99726. * Updates the camera based on device's frame data
  99727. */
  99728. _checkInputs(): void;
  99729. /**
  99730. * Updates the poseControlled values based on the input device pose.
  99731. * @param poseData Pose coming from the device
  99732. */
  99733. updateFromDevice(poseData: DevicePose): void;
  99734. private _htmlElementAttached;
  99735. private _detachIfAttached;
  99736. /**
  99737. * WebVR's attach control will start broadcasting frames to the device.
  99738. * Note that in certain browsers (chrome for example) this function must be called
  99739. * within a user-interaction callback. Example:
  99740. * <pre> scene.onPointerDown = function() { camera.attachControl(canvas); }</pre>
  99741. *
  99742. * @param element html element to attach the vrDevice to
  99743. * @param noPreventDefault prevent the default html element operation when attaching the vrDevice
  99744. */
  99745. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  99746. /**
  99747. * Detaches the camera from the html element and disables VR
  99748. *
  99749. * @param element html element to detach from
  99750. */
  99751. detachControl(element: HTMLElement): void;
  99752. /**
  99753. * @returns the name of this class
  99754. */
  99755. getClassName(): string;
  99756. /**
  99757. * Calls resetPose on the vrDisplay
  99758. * See: https://developer.mozilla.org/en-US/docs/Web/API/VRDisplay/resetPose
  99759. */
  99760. resetToCurrentRotation(): void;
  99761. /**
  99762. * @hidden
  99763. * Updates the rig cameras (left and right eye)
  99764. */
  99765. _updateRigCameras(): void;
  99766. private _workingVector;
  99767. private _oneVector;
  99768. private _workingMatrix;
  99769. private updateCacheCalled;
  99770. private _correctPositionIfNotTrackPosition;
  99771. /**
  99772. * @hidden
  99773. * Updates the cached values of the camera
  99774. * @param ignoreParentClass ignores updating the parent class's cache (default: false)
  99775. */
  99776. _updateCache(ignoreParentClass?: boolean): void;
  99777. /**
  99778. * @hidden
  99779. * Get current device position in babylon world
  99780. */
  99781. _computeDevicePosition(): void;
  99782. /**
  99783. * Updates the current device position and rotation in the babylon world
  99784. */
  99785. update(): void;
  99786. /**
  99787. * @hidden
  99788. * Gets the view matrix of this camera (Always set to identity as left and right eye cameras contain the actual view matrix)
  99789. * @returns an identity matrix
  99790. */
  99791. _getViewMatrix(): Matrix;
  99792. private _tmpMatrix;
  99793. /**
  99794. * This function is called by the two RIG cameras.
  99795. * 'this' is the left or right camera (and NOT (!!!) the WebVRFreeCamera instance)
  99796. * @hidden
  99797. */
  99798. _getWebVRViewMatrix(): Matrix;
  99799. /** @hidden */
  99800. _getWebVRProjectionMatrix(): Matrix;
  99801. private _onGamepadConnectedObserver;
  99802. private _onGamepadDisconnectedObserver;
  99803. private _updateCacheWhenTrackingDisabledObserver;
  99804. /**
  99805. * Initializes the controllers and their meshes
  99806. */
  99807. initControllers(): void;
  99808. }
  99809. }
  99810. declare module BABYLON {
  99811. /**
  99812. * "Static Class" containing the most commonly used helper while dealing with material for rendering purpose.
  99813. *
  99814. * It contains the basic tools to help defining defines, binding uniform for the common part of the materials.
  99815. *
  99816. * This works by convention in BabylonJS but is meant to be use only with shader following the in place naming rules and conventions.
  99817. */
  99818. export class MaterialHelper {
  99819. /**
  99820. * Bind the current view position to an effect.
  99821. * @param effect The effect to be bound
  99822. * @param scene The scene the eyes position is used from
  99823. * @param variableName name of the shader variable that will hold the eye position
  99824. */
  99825. static BindEyePosition(effect: Effect, scene: Scene, variableName?: string): void;
  99826. /**
  99827. * Helps preparing the defines values about the UVs in used in the effect.
  99828. * UVs are shared as much as we can accross channels in the shaders.
  99829. * @param texture The texture we are preparing the UVs for
  99830. * @param defines The defines to update
  99831. * @param key The channel key "diffuse", "specular"... used in the shader
  99832. */
  99833. static PrepareDefinesForMergedUV(texture: BaseTexture, defines: any, key: string): void;
  99834. /**
  99835. * Binds a texture matrix value to its corrsponding uniform
  99836. * @param texture The texture to bind the matrix for
  99837. * @param uniformBuffer The uniform buffer receivin the data
  99838. * @param key The channel key "diffuse", "specular"... used in the shader
  99839. */
  99840. static BindTextureMatrix(texture: BaseTexture, uniformBuffer: UniformBuffer, key: string): void;
  99841. /**
  99842. * Gets the current status of the fog (should it be enabled?)
  99843. * @param mesh defines the mesh to evaluate for fog support
  99844. * @param scene defines the hosting scene
  99845. * @returns true if fog must be enabled
  99846. */
  99847. static GetFogState(mesh: AbstractMesh, scene: Scene): boolean;
  99848. /**
  99849. * Helper used to prepare the list of defines associated with misc. values for shader compilation
  99850. * @param mesh defines the current mesh
  99851. * @param scene defines the current scene
  99852. * @param useLogarithmicDepth defines if logarithmic depth has to be turned on
  99853. * @param pointsCloud defines if point cloud rendering has to be turned on
  99854. * @param fogEnabled defines if fog has to be turned on
  99855. * @param alphaTest defines if alpha testing has to be turned on
  99856. * @param defines defines the current list of defines
  99857. */
  99858. static PrepareDefinesForMisc(mesh: AbstractMesh, scene: Scene, useLogarithmicDepth: boolean, pointsCloud: boolean, fogEnabled: boolean, alphaTest: boolean, defines: any): void;
  99859. /**
  99860. * Helper used to prepare the list of defines associated with frame values for shader compilation
  99861. * @param scene defines the current scene
  99862. * @param engine defines the current engine
  99863. * @param defines specifies the list of active defines
  99864. * @param useInstances defines if instances have to be turned on
  99865. * @param useClipPlane defines if clip plane have to be turned on
  99866. * @param useInstances defines if instances have to be turned on
  99867. * @param useThinInstances defines if thin instances have to be turned on
  99868. */
  99869. static PrepareDefinesForFrameBoundValues(scene: Scene, engine: Engine, defines: any, useInstances: boolean, useClipPlane?: Nullable<boolean>, useThinInstances?: boolean): void;
  99870. /**
  99871. * Prepares the defines for bones
  99872. * @param mesh The mesh containing the geometry data we will draw
  99873. * @param defines The defines to update
  99874. */
  99875. static PrepareDefinesForBones(mesh: AbstractMesh, defines: any): void;
  99876. /**
  99877. * Prepares the defines for morph targets
  99878. * @param mesh The mesh containing the geometry data we will draw
  99879. * @param defines The defines to update
  99880. */
  99881. static PrepareDefinesForMorphTargets(mesh: AbstractMesh, defines: any): void;
  99882. /**
  99883. * Prepares the defines used in the shader depending on the attributes data available in the mesh
  99884. * @param mesh The mesh containing the geometry data we will draw
  99885. * @param defines The defines to update
  99886. * @param useVertexColor Precise whether vertex colors should be used or not (override mesh info)
  99887. * @param useBones Precise whether bones should be used or not (override mesh info)
  99888. * @param useMorphTargets Precise whether morph targets should be used or not (override mesh info)
  99889. * @param useVertexAlpha Precise whether vertex alpha should be used or not (override mesh info)
  99890. * @returns false if defines are considered not dirty and have not been checked
  99891. */
  99892. static PrepareDefinesForAttributes(mesh: AbstractMesh, defines: any, useVertexColor: boolean, useBones: boolean, useMorphTargets?: boolean, useVertexAlpha?: boolean): boolean;
  99893. /**
  99894. * Prepares the defines related to multiview
  99895. * @param scene The scene we are intending to draw
  99896. * @param defines The defines to update
  99897. */
  99898. static PrepareDefinesForMultiview(scene: Scene, defines: any): void;
  99899. /**
  99900. * Prepares the defines related to the prepass
  99901. * @param scene The scene we are intending to draw
  99902. * @param defines The defines to update
  99903. * @param canRenderToMRT Indicates if this material renders to several textures in the prepass
  99904. */
  99905. static PrepareDefinesForPrePass(scene: Scene, defines: any, canRenderToMRT: boolean): void;
  99906. /**
  99907. * Prepares the defines related to the light information passed in parameter
  99908. * @param scene The scene we are intending to draw
  99909. * @param mesh The mesh the effect is compiling for
  99910. * @param light The light the effect is compiling for
  99911. * @param lightIndex The index of the light
  99912. * @param defines The defines to update
  99913. * @param specularSupported Specifies whether specular is supported or not (override lights data)
  99914. * @param state Defines the current state regarding what is needed (normals, etc...)
  99915. */
  99916. static PrepareDefinesForLight(scene: Scene, mesh: AbstractMesh, light: Light, lightIndex: number, defines: any, specularSupported: boolean, state: {
  99917. needNormals: boolean;
  99918. needRebuild: boolean;
  99919. shadowEnabled: boolean;
  99920. specularEnabled: boolean;
  99921. lightmapMode: boolean;
  99922. }): void;
  99923. /**
  99924. * Prepares the defines related to the light information passed in parameter
  99925. * @param scene The scene we are intending to draw
  99926. * @param mesh The mesh the effect is compiling for
  99927. * @param defines The defines to update
  99928. * @param specularSupported Specifies whether specular is supported or not (override lights data)
  99929. * @param maxSimultaneousLights Specfies how manuy lights can be added to the effect at max
  99930. * @param disableLighting Specifies whether the lighting is disabled (override scene and light)
  99931. * @returns true if normals will be required for the rest of the effect
  99932. */
  99933. static PrepareDefinesForLights(scene: Scene, mesh: AbstractMesh, defines: any, specularSupported: boolean, maxSimultaneousLights?: number, disableLighting?: boolean): boolean;
  99934. /**
  99935. * Prepares the uniforms and samplers list to be used in the effect (for a specific light)
  99936. * @param lightIndex defines the light index
  99937. * @param uniformsList The uniform list
  99938. * @param samplersList The sampler list
  99939. * @param projectedLightTexture defines if projected texture must be used
  99940. * @param uniformBuffersList defines an optional list of uniform buffers
  99941. */
  99942. static PrepareUniformsAndSamplersForLight(lightIndex: number, uniformsList: string[], samplersList: string[], projectedLightTexture?: any, uniformBuffersList?: Nullable<string[]>): void;
  99943. /**
  99944. * Prepares the uniforms and samplers list to be used in the effect
  99945. * @param uniformsListOrOptions The uniform names to prepare or an EffectCreationOptions containing the liist and extra information
  99946. * @param samplersList The sampler list
  99947. * @param defines The defines helping in the list generation
  99948. * @param maxSimultaneousLights The maximum number of simultanous light allowed in the effect
  99949. */
  99950. static PrepareUniformsAndSamplersList(uniformsListOrOptions: string[] | IEffectCreationOptions, samplersList?: string[], defines?: any, maxSimultaneousLights?: number): void;
  99951. /**
  99952. * This helps decreasing rank by rank the shadow quality (0 being the highest rank and quality)
  99953. * @param defines The defines to update while falling back
  99954. * @param fallbacks The authorized effect fallbacks
  99955. * @param maxSimultaneousLights The maximum number of lights allowed
  99956. * @param rank the current rank of the Effect
  99957. * @returns The newly affected rank
  99958. */
  99959. static HandleFallbacksForShadows(defines: any, fallbacks: EffectFallbacks, maxSimultaneousLights?: number, rank?: number): number;
  99960. private static _TmpMorphInfluencers;
  99961. /**
  99962. * Prepares the list of attributes required for morph targets according to the effect defines.
  99963. * @param attribs The current list of supported attribs
  99964. * @param mesh The mesh to prepare the morph targets attributes for
  99965. * @param influencers The number of influencers
  99966. */
  99967. static PrepareAttributesForMorphTargetsInfluencers(attribs: string[], mesh: AbstractMesh, influencers: number): void;
  99968. /**
  99969. * Prepares the list of attributes required for morph targets according to the effect defines.
  99970. * @param attribs The current list of supported attribs
  99971. * @param mesh The mesh to prepare the morph targets attributes for
  99972. * @param defines The current Defines of the effect
  99973. */
  99974. static PrepareAttributesForMorphTargets(attribs: string[], mesh: AbstractMesh, defines: any): void;
  99975. /**
  99976. * Prepares the list of attributes required for bones according to the effect defines.
  99977. * @param attribs The current list of supported attribs
  99978. * @param mesh The mesh to prepare the bones attributes for
  99979. * @param defines The current Defines of the effect
  99980. * @param fallbacks The current efffect fallback strategy
  99981. */
  99982. static PrepareAttributesForBones(attribs: string[], mesh: AbstractMesh, defines: any, fallbacks: EffectFallbacks): void;
  99983. /**
  99984. * Check and prepare the list of attributes required for instances according to the effect defines.
  99985. * @param attribs The current list of supported attribs
  99986. * @param defines The current MaterialDefines of the effect
  99987. */
  99988. static PrepareAttributesForInstances(attribs: string[], defines: MaterialDefines): void;
  99989. /**
  99990. * Add the list of attributes required for instances to the attribs array.
  99991. * @param attribs The current list of supported attribs
  99992. */
  99993. static PushAttributesForInstances(attribs: string[]): void;
  99994. /**
  99995. * Binds the light information to the effect.
  99996. * @param light The light containing the generator
  99997. * @param effect The effect we are binding the data to
  99998. * @param lightIndex The light index in the effect used to render
  99999. */
  100000. static BindLightProperties(light: Light, effect: Effect, lightIndex: number): void;
  100001. /**
  100002. * Binds the lights information from the scene to the effect for the given mesh.
  100003. * @param light Light to bind
  100004. * @param lightIndex Light index
  100005. * @param scene The scene where the light belongs to
  100006. * @param effect The effect we are binding the data to
  100007. * @param useSpecular Defines if specular is supported
  100008. * @param rebuildInParallel Specifies whether the shader is rebuilding in parallel
  100009. */
  100010. static BindLight(light: Light, lightIndex: number, scene: Scene, effect: Effect, useSpecular: boolean, rebuildInParallel?: boolean): void;
  100011. /**
  100012. * Binds the lights information from the scene to the effect for the given mesh.
  100013. * @param scene The scene the lights belongs to
  100014. * @param mesh The mesh we are binding the information to render
  100015. * @param effect The effect we are binding the data to
  100016. * @param defines The generated defines for the effect
  100017. * @param maxSimultaneousLights The maximum number of light that can be bound to the effect
  100018. * @param rebuildInParallel Specifies whether the shader is rebuilding in parallel
  100019. */
  100020. static BindLights(scene: Scene, mesh: AbstractMesh, effect: Effect, defines: any, maxSimultaneousLights?: number, rebuildInParallel?: boolean): void;
  100021. private static _tempFogColor;
  100022. /**
  100023. * Binds the fog information from the scene to the effect for the given mesh.
  100024. * @param scene The scene the lights belongs to
  100025. * @param mesh The mesh we are binding the information to render
  100026. * @param effect The effect we are binding the data to
  100027. * @param linearSpace Defines if the fog effect is applied in linear space
  100028. */
  100029. static BindFogParameters(scene: Scene, mesh: AbstractMesh, effect: Effect, linearSpace?: boolean): void;
  100030. /**
  100031. * Binds the bones information from the mesh to the effect.
  100032. * @param mesh The mesh we are binding the information to render
  100033. * @param effect The effect we are binding the data to
  100034. */
  100035. static BindBonesParameters(mesh?: AbstractMesh, effect?: Effect): void;
  100036. /**
  100037. * Binds the morph targets information from the mesh to the effect.
  100038. * @param abstractMesh The mesh we are binding the information to render
  100039. * @param effect The effect we are binding the data to
  100040. */
  100041. static BindMorphTargetParameters(abstractMesh: AbstractMesh, effect: Effect): void;
  100042. /**
  100043. * Binds the logarithmic depth information from the scene to the effect for the given defines.
  100044. * @param defines The generated defines used in the effect
  100045. * @param effect The effect we are binding the data to
  100046. * @param scene The scene we are willing to render with logarithmic scale for
  100047. */
  100048. static BindLogDepth(defines: any, effect: Effect, scene: Scene): void;
  100049. /**
  100050. * Binds the clip plane information from the scene to the effect.
  100051. * @param scene The scene the clip plane information are extracted from
  100052. * @param effect The effect we are binding the data to
  100053. */
  100054. static BindClipPlane(effect: Effect, scene: Scene): void;
  100055. }
  100056. }
  100057. declare module BABYLON {
  100058. /**
  100059. * Block used to expose an input value
  100060. */
  100061. export class InputBlock extends NodeMaterialBlock {
  100062. private _mode;
  100063. private _associatedVariableName;
  100064. private _storedValue;
  100065. private _valueCallback;
  100066. private _type;
  100067. private _animationType;
  100068. /** Gets or set a value used to limit the range of float values */
  100069. min: number;
  100070. /** Gets or set a value used to limit the range of float values */
  100071. max: number;
  100072. /** Gets or set a value indicating that this input can only get 0 and 1 values */
  100073. isBoolean: boolean;
  100074. /** Gets or sets a value used by the Node Material editor to determine how to configure the current value if it is a matrix */
  100075. matrixMode: number;
  100076. /** @hidden */
  100077. _systemValue: Nullable<NodeMaterialSystemValues>;
  100078. /** Gets or sets a boolean indicating that this input can be edited in the Inspector (false by default) */
  100079. visibleInInspector: boolean;
  100080. /** Gets or sets a boolean indicating that the value of this input will not change after a build */
  100081. isConstant: boolean;
  100082. /** Gets or sets the group to use to display this block in the Inspector */
  100083. groupInInspector: string;
  100084. /** Gets an observable raised when the value is changed */
  100085. onValueChangedObservable: Observable<InputBlock>;
  100086. /**
  100087. * Gets or sets the connection point type (default is float)
  100088. */
  100089. get type(): NodeMaterialBlockConnectionPointTypes;
  100090. /**
  100091. * Creates a new InputBlock
  100092. * @param name defines the block name
  100093. * @param target defines the target of that block (Vertex by default)
  100094. * @param type defines the type of the input (can be set to NodeMaterialBlockConnectionPointTypes.AutoDetect)
  100095. */
  100096. constructor(name: string, target?: NodeMaterialBlockTargets, type?: NodeMaterialBlockConnectionPointTypes);
  100097. /**
  100098. * Validates if a name is a reserve word.
  100099. * @param newName the new name to be given to the node.
  100100. * @returns false if the name is a reserve word, else true.
  100101. */
  100102. validateBlockName(newName: string): boolean;
  100103. /**
  100104. * Gets the output component
  100105. */
  100106. get output(): NodeMaterialConnectionPoint;
  100107. /**
  100108. * Set the source of this connection point to a vertex attribute
  100109. * @param attributeName defines the attribute name (position, uv, normal, etc...). If not specified it will take the connection point name
  100110. * @returns the current connection point
  100111. */
  100112. setAsAttribute(attributeName?: string): InputBlock;
  100113. /**
  100114. * Set the source of this connection point to a system value
  100115. * @param value define the system value to use (world, view, etc...) or null to switch to manual value
  100116. * @returns the current connection point
  100117. */
  100118. setAsSystemValue(value: Nullable<NodeMaterialSystemValues>): InputBlock;
  100119. /**
  100120. * Gets or sets the value of that point.
  100121. * Please note that this value will be ignored if valueCallback is defined
  100122. */
  100123. get value(): any;
  100124. set value(value: any);
  100125. /**
  100126. * Gets or sets a callback used to get the value of that point.
  100127. * Please note that setting this value will force the connection point to ignore the value property
  100128. */
  100129. get valueCallback(): () => any;
  100130. set valueCallback(value: () => any);
  100131. /**
  100132. * Gets or sets the associated variable name in the shader
  100133. */
  100134. get associatedVariableName(): string;
  100135. set associatedVariableName(value: string);
  100136. /** Gets or sets the type of animation applied to the input */
  100137. get animationType(): AnimatedInputBlockTypes;
  100138. set animationType(value: AnimatedInputBlockTypes);
  100139. /**
  100140. * Gets a boolean indicating that this connection point not defined yet
  100141. */
  100142. get isUndefined(): boolean;
  100143. /**
  100144. * Gets or sets a boolean indicating that this connection point is coming from an uniform.
  100145. * In this case the connection point name must be the name of the uniform to use.
  100146. * Can only be set on inputs
  100147. */
  100148. get isUniform(): boolean;
  100149. set isUniform(value: boolean);
  100150. /**
  100151. * Gets or sets a boolean indicating that this connection point is coming from an attribute.
  100152. * In this case the connection point name must be the name of the attribute to use
  100153. * Can only be set on inputs
  100154. */
  100155. get isAttribute(): boolean;
  100156. set isAttribute(value: boolean);
  100157. /**
  100158. * Gets or sets a boolean indicating that this connection point is generating a varying variable.
  100159. * Can only be set on exit points
  100160. */
  100161. get isVarying(): boolean;
  100162. set isVarying(value: boolean);
  100163. /**
  100164. * Gets a boolean indicating that the current connection point is a system value
  100165. */
  100166. get isSystemValue(): boolean;
  100167. /**
  100168. * Gets or sets the current well known value or null if not defined as a system value
  100169. */
  100170. get systemValue(): Nullable<NodeMaterialSystemValues>;
  100171. set systemValue(value: Nullable<NodeMaterialSystemValues>);
  100172. /**
  100173. * Gets the current class name
  100174. * @returns the class name
  100175. */
  100176. getClassName(): string;
  100177. /**
  100178. * Animate the input if animationType !== None
  100179. * @param scene defines the rendering scene
  100180. */
  100181. animate(scene: Scene): void;
  100182. private _emitDefine;
  100183. initialize(state: NodeMaterialBuildState): void;
  100184. /**
  100185. * Set the input block to its default value (based on its type)
  100186. */
  100187. setDefaultValue(): void;
  100188. private _emitConstant;
  100189. /** @hidden */
  100190. get _noContextSwitch(): boolean;
  100191. private _emit;
  100192. /** @hidden */
  100193. _transmitWorld(effect: Effect, world: Matrix, worldView: Matrix, worldViewProjection: Matrix): void;
  100194. /** @hidden */
  100195. _transmit(effect: Effect, scene: Scene): void;
  100196. protected _buildBlock(state: NodeMaterialBuildState): void;
  100197. protected _dumpPropertiesCode(): string;
  100198. dispose(): void;
  100199. serialize(): any;
  100200. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  100201. }
  100202. }
  100203. declare module BABYLON {
  100204. /**
  100205. * Enum used to define the compatibility state between two connection points
  100206. */
  100207. export enum NodeMaterialConnectionPointCompatibilityStates {
  100208. /** Points are compatibles */
  100209. Compatible = 0,
  100210. /** Points are incompatible because of their types */
  100211. TypeIncompatible = 1,
  100212. /** Points are incompatible because of their targets (vertex vs fragment) */
  100213. TargetIncompatible = 2
  100214. }
  100215. /**
  100216. * Defines the direction of a connection point
  100217. */
  100218. export enum NodeMaterialConnectionPointDirection {
  100219. /** Input */
  100220. Input = 0,
  100221. /** Output */
  100222. Output = 1
  100223. }
  100224. /**
  100225. * Defines a connection point for a block
  100226. */
  100227. export class NodeMaterialConnectionPoint {
  100228. /** @hidden */
  100229. _ownerBlock: NodeMaterialBlock;
  100230. /** @hidden */
  100231. _connectedPoint: Nullable<NodeMaterialConnectionPoint>;
  100232. private _endpoints;
  100233. private _associatedVariableName;
  100234. private _direction;
  100235. /** @hidden */
  100236. _typeConnectionSource: Nullable<NodeMaterialConnectionPoint>;
  100237. /** @hidden */
  100238. _linkedConnectionSource: Nullable<NodeMaterialConnectionPoint>;
  100239. private _type;
  100240. /** @hidden */
  100241. _enforceAssociatedVariableName: boolean;
  100242. /** Gets the direction of the point */
  100243. get direction(): NodeMaterialConnectionPointDirection;
  100244. /** Indicates that this connection point needs dual validation before being connected to another point */
  100245. needDualDirectionValidation: boolean;
  100246. /**
  100247. * Gets or sets the additional types supported by this connection point
  100248. */
  100249. acceptedConnectionPointTypes: NodeMaterialBlockConnectionPointTypes[];
  100250. /**
  100251. * Gets or sets the additional types excluded by this connection point
  100252. */
  100253. excludedConnectionPointTypes: NodeMaterialBlockConnectionPointTypes[];
  100254. /**
  100255. * Observable triggered when this point is connected
  100256. */
  100257. onConnectionObservable: Observable<NodeMaterialConnectionPoint>;
  100258. /**
  100259. * Gets or sets the associated variable name in the shader
  100260. */
  100261. get associatedVariableName(): string;
  100262. set associatedVariableName(value: string);
  100263. /** Get the inner type (ie AutoDetect for instance instead of the inferred one) */
  100264. get innerType(): NodeMaterialBlockConnectionPointTypes;
  100265. /**
  100266. * Gets or sets the connection point type (default is float)
  100267. */
  100268. get type(): NodeMaterialBlockConnectionPointTypes;
  100269. set type(value: NodeMaterialBlockConnectionPointTypes);
  100270. /**
  100271. * Gets or sets the connection point name
  100272. */
  100273. name: string;
  100274. /**
  100275. * Gets or sets the connection point name
  100276. */
  100277. displayName: string;
  100278. /**
  100279. * Gets or sets a boolean indicating that this connection point can be omitted
  100280. */
  100281. isOptional: boolean;
  100282. /**
  100283. * Gets or sets a boolean indicating that this connection point is exposed on a frame
  100284. */
  100285. isExposedOnFrame: boolean;
  100286. /**
  100287. * Gets or sets a string indicating that this uniform must be defined under a #ifdef
  100288. */
  100289. define: string;
  100290. /** @hidden */
  100291. _prioritizeVertex: boolean;
  100292. private _target;
  100293. /** Gets or sets the target of that connection point */
  100294. get target(): NodeMaterialBlockTargets;
  100295. set target(value: NodeMaterialBlockTargets);
  100296. /**
  100297. * Gets a boolean indicating that the current point is connected to another NodeMaterialBlock
  100298. */
  100299. get isConnected(): boolean;
  100300. /**
  100301. * Gets a boolean indicating that the current point is connected to an input block
  100302. */
  100303. get isConnectedToInputBlock(): boolean;
  100304. /**
  100305. * Gets a the connected input block (if any)
  100306. */
  100307. get connectInputBlock(): Nullable<InputBlock>;
  100308. /** Get the other side of the connection (if any) */
  100309. get connectedPoint(): Nullable<NodeMaterialConnectionPoint>;
  100310. /** Get the block that owns this connection point */
  100311. get ownerBlock(): NodeMaterialBlock;
  100312. /** Get the block connected on the other side of this connection (if any) */
  100313. get sourceBlock(): Nullable<NodeMaterialBlock>;
  100314. /** Get the block connected on the endpoints of this connection (if any) */
  100315. get connectedBlocks(): Array<NodeMaterialBlock>;
  100316. /** Gets the list of connected endpoints */
  100317. get endpoints(): NodeMaterialConnectionPoint[];
  100318. /** Gets a boolean indicating if that output point is connected to at least one input */
  100319. get hasEndpoints(): boolean;
  100320. /** Gets a boolean indicating that this connection will be used in the vertex shader */
  100321. get isConnectedInVertexShader(): boolean;
  100322. /** Gets a boolean indicating that this connection will be used in the fragment shader */
  100323. get isConnectedInFragmentShader(): boolean;
  100324. /**
  100325. * Creates a block suitable to be used as an input for this input point.
  100326. * If null is returned, a block based on the point type will be created.
  100327. * @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
  100328. */
  100329. createCustomInputBlock(): Nullable<[NodeMaterialBlock, string]>;
  100330. /**
  100331. * Creates a new connection point
  100332. * @param name defines the connection point name
  100333. * @param ownerBlock defines the block hosting this connection point
  100334. * @param direction defines the direction of the connection point
  100335. */
  100336. constructor(name: string, ownerBlock: NodeMaterialBlock, direction: NodeMaterialConnectionPointDirection);
  100337. /**
  100338. * Gets the current class name e.g. "NodeMaterialConnectionPoint"
  100339. * @returns the class name
  100340. */
  100341. getClassName(): string;
  100342. /**
  100343. * Gets a boolean indicating if the current point can be connected to another point
  100344. * @param connectionPoint defines the other connection point
  100345. * @returns a boolean
  100346. */
  100347. canConnectTo(connectionPoint: NodeMaterialConnectionPoint): boolean;
  100348. /**
  100349. * Gets a number indicating if the current point can be connected to another point
  100350. * @param connectionPoint defines the other connection point
  100351. * @returns a number defining the compatibility state
  100352. */
  100353. checkCompatibilityState(connectionPoint: NodeMaterialConnectionPoint): NodeMaterialConnectionPointCompatibilityStates;
  100354. /**
  100355. * Connect this point to another connection point
  100356. * @param connectionPoint defines the other connection point
  100357. * @param ignoreConstraints defines if the system will ignore connection type constraints (default is false)
  100358. * @returns the current connection point
  100359. */
  100360. connectTo(connectionPoint: NodeMaterialConnectionPoint, ignoreConstraints?: boolean): NodeMaterialConnectionPoint;
  100361. /**
  100362. * Disconnect this point from one of his endpoint
  100363. * @param endpoint defines the other connection point
  100364. * @returns the current connection point
  100365. */
  100366. disconnectFrom(endpoint: NodeMaterialConnectionPoint): NodeMaterialConnectionPoint;
  100367. /**
  100368. * Serializes this point in a JSON representation
  100369. * @param isInput defines if the connection point is an input (default is true)
  100370. * @returns the serialized point object
  100371. */
  100372. serialize(isInput?: boolean): any;
  100373. /**
  100374. * Release resources
  100375. */
  100376. dispose(): void;
  100377. }
  100378. }
  100379. declare module BABYLON {
  100380. /**
  100381. * Enum used to define the material modes
  100382. */
  100383. export enum NodeMaterialModes {
  100384. /** Regular material */
  100385. Material = 0,
  100386. /** For post process */
  100387. PostProcess = 1,
  100388. /** For particle system */
  100389. Particle = 2
  100390. }
  100391. }
  100392. declare module BABYLON {
  100393. /**
  100394. * Block used to read a texture from a sampler
  100395. */
  100396. export class TextureBlock extends NodeMaterialBlock {
  100397. private _defineName;
  100398. private _linearDefineName;
  100399. private _gammaDefineName;
  100400. private _tempTextureRead;
  100401. private _samplerName;
  100402. private _transformedUVName;
  100403. private _textureTransformName;
  100404. private _textureInfoName;
  100405. private _mainUVName;
  100406. private _mainUVDefineName;
  100407. private _fragmentOnly;
  100408. /**
  100409. * Gets or sets the texture associated with the node
  100410. */
  100411. texture: Nullable<Texture>;
  100412. /**
  100413. * Gets or sets a boolean indicating if content needs to be converted to gamma space
  100414. */
  100415. convertToGammaSpace: boolean;
  100416. /**
  100417. * Gets or sets a boolean indicating if content needs to be converted to linear space
  100418. */
  100419. convertToLinearSpace: boolean;
  100420. /**
  100421. * Create a new TextureBlock
  100422. * @param name defines the block name
  100423. */
  100424. constructor(name: string, fragmentOnly?: boolean);
  100425. /**
  100426. * Gets the current class name
  100427. * @returns the class name
  100428. */
  100429. getClassName(): string;
  100430. /**
  100431. * Gets the uv input component
  100432. */
  100433. get uv(): NodeMaterialConnectionPoint;
  100434. /**
  100435. * Gets the rgba output component
  100436. */
  100437. get rgba(): NodeMaterialConnectionPoint;
  100438. /**
  100439. * Gets the rgb output component
  100440. */
  100441. get rgb(): NodeMaterialConnectionPoint;
  100442. /**
  100443. * Gets the r output component
  100444. */
  100445. get r(): NodeMaterialConnectionPoint;
  100446. /**
  100447. * Gets the g output component
  100448. */
  100449. get g(): NodeMaterialConnectionPoint;
  100450. /**
  100451. * Gets the b output component
  100452. */
  100453. get b(): NodeMaterialConnectionPoint;
  100454. /**
  100455. * Gets the a output component
  100456. */
  100457. get a(): NodeMaterialConnectionPoint;
  100458. get target(): NodeMaterialBlockTargets;
  100459. autoConfigure(material: NodeMaterial): void;
  100460. initializeDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines, useInstances?: boolean): void;
  100461. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  100462. isReady(): boolean;
  100463. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh): void;
  100464. private get _isMixed();
  100465. private _injectVertexCode;
  100466. private _writeTextureRead;
  100467. private _writeOutput;
  100468. protected _buildBlock(state: NodeMaterialBuildState): this | undefined;
  100469. protected _dumpPropertiesCode(): string;
  100470. serialize(): any;
  100471. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  100472. }
  100473. }
  100474. declare module BABYLON {
  100475. /** @hidden */
  100476. export var reflectionFunction: {
  100477. name: string;
  100478. shader: string;
  100479. };
  100480. }
  100481. declare module BABYLON {
  100482. /**
  100483. * Base block used to read a reflection texture from a sampler
  100484. */
  100485. export abstract class ReflectionTextureBaseBlock extends NodeMaterialBlock {
  100486. /** @hidden */
  100487. _define3DName: string;
  100488. /** @hidden */
  100489. _defineCubicName: string;
  100490. /** @hidden */
  100491. _defineExplicitName: string;
  100492. /** @hidden */
  100493. _defineProjectionName: string;
  100494. /** @hidden */
  100495. _defineLocalCubicName: string;
  100496. /** @hidden */
  100497. _defineSphericalName: string;
  100498. /** @hidden */
  100499. _definePlanarName: string;
  100500. /** @hidden */
  100501. _defineEquirectangularName: string;
  100502. /** @hidden */
  100503. _defineMirroredEquirectangularFixedName: string;
  100504. /** @hidden */
  100505. _defineEquirectangularFixedName: string;
  100506. /** @hidden */
  100507. _defineSkyboxName: string;
  100508. /** @hidden */
  100509. _defineOppositeZ: string;
  100510. /** @hidden */
  100511. _cubeSamplerName: string;
  100512. /** @hidden */
  100513. _2DSamplerName: string;
  100514. protected _positionUVWName: string;
  100515. protected _directionWName: string;
  100516. protected _reflectionVectorName: string;
  100517. /** @hidden */
  100518. _reflectionCoordsName: string;
  100519. /** @hidden */
  100520. _reflectionMatrixName: string;
  100521. protected _reflectionColorName: string;
  100522. /**
  100523. * Gets or sets the texture associated with the node
  100524. */
  100525. texture: Nullable<BaseTexture>;
  100526. /**
  100527. * Create a new ReflectionTextureBaseBlock
  100528. * @param name defines the block name
  100529. */
  100530. constructor(name: string);
  100531. /**
  100532. * Gets the current class name
  100533. * @returns the class name
  100534. */
  100535. getClassName(): string;
  100536. /**
  100537. * Gets the world position input component
  100538. */
  100539. abstract get position(): NodeMaterialConnectionPoint;
  100540. /**
  100541. * Gets the world position input component
  100542. */
  100543. abstract get worldPosition(): NodeMaterialConnectionPoint;
  100544. /**
  100545. * Gets the world normal input component
  100546. */
  100547. abstract get worldNormal(): NodeMaterialConnectionPoint;
  100548. /**
  100549. * Gets the world input component
  100550. */
  100551. abstract get world(): NodeMaterialConnectionPoint;
  100552. /**
  100553. * Gets the camera (or eye) position component
  100554. */
  100555. abstract get cameraPosition(): NodeMaterialConnectionPoint;
  100556. /**
  100557. * Gets the view input component
  100558. */
  100559. abstract get view(): NodeMaterialConnectionPoint;
  100560. protected _getTexture(): Nullable<BaseTexture>;
  100561. autoConfigure(material: NodeMaterial): void;
  100562. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  100563. isReady(): boolean;
  100564. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh): void;
  100565. /**
  100566. * Gets the code to inject in the vertex shader
  100567. * @param state current state of the node material building
  100568. * @returns the shader code
  100569. */
  100570. handleVertexSide(state: NodeMaterialBuildState): string;
  100571. /**
  100572. * Handles the inits for the fragment code path
  100573. * @param state node material build state
  100574. */
  100575. handleFragmentSideInits(state: NodeMaterialBuildState): void;
  100576. /**
  100577. * Generates the reflection coords code for the fragment code path
  100578. * @param worldNormalVarName name of the world normal variable
  100579. * @param worldPos name of the world position variable. If not provided, will use the world position connected to this block
  100580. * @param onlyReflectionVector if true, generates code only for the reflection vector computation, not for the reflection coordinates
  100581. * @returns the shader code
  100582. */
  100583. handleFragmentSideCodeReflectionCoords(worldNormalVarName: string, worldPos?: string, onlyReflectionVector?: boolean): string;
  100584. /**
  100585. * Generates the reflection color code for the fragment code path
  100586. * @param lodVarName name of the lod variable
  100587. * @param swizzleLookupTexture swizzle to use for the final color variable
  100588. * @returns the shader code
  100589. */
  100590. handleFragmentSideCodeReflectionColor(lodVarName?: string, swizzleLookupTexture?: string): string;
  100591. /**
  100592. * Generates the code corresponding to the connected output points
  100593. * @param state node material build state
  100594. * @param varName name of the variable to output
  100595. * @returns the shader code
  100596. */
  100597. writeOutputs(state: NodeMaterialBuildState, varName: string): string;
  100598. protected _buildBlock(state: NodeMaterialBuildState): this;
  100599. protected _dumpPropertiesCode(): string;
  100600. serialize(): any;
  100601. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  100602. }
  100603. }
  100604. declare module BABYLON {
  100605. /**
  100606. * Defines a connection point to be used for points with a custom object type
  100607. */
  100608. export class NodeMaterialConnectionPointCustomObject<T extends NodeMaterialBlock> extends NodeMaterialConnectionPoint {
  100609. private _blockType;
  100610. private _blockName;
  100611. private _nameForCheking?;
  100612. /**
  100613. * Creates a new connection point
  100614. * @param name defines the connection point name
  100615. * @param ownerBlock defines the block hosting this connection point
  100616. * @param direction defines the direction of the connection point
  100617. */
  100618. constructor(name: string, ownerBlock: NodeMaterialBlock, direction: NodeMaterialConnectionPointDirection, _blockType: new (...args: any[]) => T, _blockName: string, _nameForCheking?: string | undefined);
  100619. /**
  100620. * Gets a number indicating if the current point can be connected to another point
  100621. * @param connectionPoint defines the other connection point
  100622. * @returns a number defining the compatibility state
  100623. */
  100624. checkCompatibilityState(connectionPoint: NodeMaterialConnectionPoint): NodeMaterialConnectionPointCompatibilityStates;
  100625. /**
  100626. * Creates a block suitable to be used as an input for this input point.
  100627. * If null is returned, a block based on the point type will be created.
  100628. * @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
  100629. */
  100630. createCustomInputBlock(): Nullable<[NodeMaterialBlock, string]>;
  100631. }
  100632. }
  100633. declare module BABYLON {
  100634. /**
  100635. * Enum defining the type of properties that can be edited in the property pages in the NME
  100636. */
  100637. export enum PropertyTypeForEdition {
  100638. /** property is a boolean */
  100639. Boolean = 0,
  100640. /** property is a float */
  100641. Float = 1,
  100642. /** property is a Vector2 */
  100643. Vector2 = 2,
  100644. /** property is a list of values */
  100645. List = 3
  100646. }
  100647. /**
  100648. * Interface that defines an option in a variable of type list
  100649. */
  100650. export interface IEditablePropertyListOption {
  100651. /** label of the option */
  100652. "label": string;
  100653. /** value of the option */
  100654. "value": number;
  100655. }
  100656. /**
  100657. * Interface that defines the options available for an editable property
  100658. */
  100659. export interface IEditablePropertyOption {
  100660. /** min value */
  100661. "min"?: number;
  100662. /** max value */
  100663. "max"?: number;
  100664. /** notifiers: indicates which actions to take when the property is changed */
  100665. "notifiers"?: {
  100666. /** the material should be rebuilt */
  100667. "rebuild"?: boolean;
  100668. /** the preview should be updated */
  100669. "update"?: boolean;
  100670. };
  100671. /** list of the options for a variable of type list */
  100672. "options"?: IEditablePropertyListOption[];
  100673. }
  100674. /**
  100675. * Interface that describes an editable property
  100676. */
  100677. export interface IPropertyDescriptionForEdition {
  100678. /** name of the property */
  100679. "propertyName": string;
  100680. /** display name of the property */
  100681. "displayName": string;
  100682. /** type of the property */
  100683. "type": PropertyTypeForEdition;
  100684. /** group of the property - all properties with the same group value will be displayed in a specific section */
  100685. "groupName": string;
  100686. /** options for the property */
  100687. "options": IEditablePropertyOption;
  100688. }
  100689. /**
  100690. * Decorator that flags a property in a node material block as being editable
  100691. */
  100692. export function editableInPropertyPage(displayName: string, propertyType?: PropertyTypeForEdition, groupName?: string, options?: IEditablePropertyOption): (target: any, propertyKey: string) => void;
  100693. }
  100694. declare module BABYLON {
  100695. /**
  100696. * Block used to implement the refraction part of the sub surface module of the PBR material
  100697. */
  100698. export class RefractionBlock extends NodeMaterialBlock {
  100699. /** @hidden */
  100700. _define3DName: string;
  100701. /** @hidden */
  100702. _refractionMatrixName: string;
  100703. /** @hidden */
  100704. _defineLODRefractionAlpha: string;
  100705. /** @hidden */
  100706. _defineLinearSpecularRefraction: string;
  100707. /** @hidden */
  100708. _defineOppositeZ: string;
  100709. /** @hidden */
  100710. _cubeSamplerName: string;
  100711. /** @hidden */
  100712. _2DSamplerName: string;
  100713. /** @hidden */
  100714. _vRefractionMicrosurfaceInfosName: string;
  100715. /** @hidden */
  100716. _vRefractionInfosName: string;
  100717. private _scene;
  100718. /**
  100719. * This parameters will make the material used its opacity to control how much it is refracting aginst not.
  100720. * Materials half opaque for instance using refraction could benefit from this control.
  100721. */
  100722. linkRefractionWithTransparency: boolean;
  100723. /**
  100724. * Controls if refraction needs to be inverted on Y. This could be useful for procedural texture.
  100725. */
  100726. invertRefractionY: boolean;
  100727. /**
  100728. * Gets or sets the texture associated with the node
  100729. */
  100730. texture: Nullable<BaseTexture>;
  100731. /**
  100732. * Create a new RefractionBlock
  100733. * @param name defines the block name
  100734. */
  100735. constructor(name: string);
  100736. /**
  100737. * Gets the current class name
  100738. * @returns the class name
  100739. */
  100740. getClassName(): string;
  100741. /**
  100742. * Gets the intensity input component
  100743. */
  100744. get intensity(): NodeMaterialConnectionPoint;
  100745. /**
  100746. * Gets the index of refraction input component
  100747. */
  100748. get indexOfRefraction(): NodeMaterialConnectionPoint;
  100749. /**
  100750. * Gets the tint at distance input component
  100751. */
  100752. get tintAtDistance(): NodeMaterialConnectionPoint;
  100753. /**
  100754. * Gets the view input component
  100755. */
  100756. get view(): NodeMaterialConnectionPoint;
  100757. /**
  100758. * Gets the refraction object output component
  100759. */
  100760. get refraction(): NodeMaterialConnectionPoint;
  100761. /**
  100762. * Returns true if the block has a texture
  100763. */
  100764. get hasTexture(): boolean;
  100765. protected _getTexture(): Nullable<BaseTexture>;
  100766. autoConfigure(material: NodeMaterial): void;
  100767. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  100768. isReady(): boolean;
  100769. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh, subMesh?: SubMesh): void;
  100770. /**
  100771. * Gets the main code of the block (fragment side)
  100772. * @param state current state of the node material building
  100773. * @returns the shader code
  100774. */
  100775. getCode(state: NodeMaterialBuildState): string;
  100776. protected _buildBlock(state: NodeMaterialBuildState): this;
  100777. protected _dumpPropertiesCode(): string;
  100778. serialize(): any;
  100779. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  100780. }
  100781. }
  100782. declare module BABYLON {
  100783. /**
  100784. * Base block used as input for post process
  100785. */
  100786. export class CurrentScreenBlock extends NodeMaterialBlock {
  100787. private _samplerName;
  100788. private _linearDefineName;
  100789. private _gammaDefineName;
  100790. private _mainUVName;
  100791. private _tempTextureRead;
  100792. /**
  100793. * Gets or sets the texture associated with the node
  100794. */
  100795. texture: Nullable<BaseTexture>;
  100796. /**
  100797. * Gets or sets a boolean indicating if content needs to be converted to gamma space
  100798. */
  100799. convertToGammaSpace: boolean;
  100800. /**
  100801. * Gets or sets a boolean indicating if content needs to be converted to linear space
  100802. */
  100803. convertToLinearSpace: boolean;
  100804. /**
  100805. * Create a new CurrentScreenBlock
  100806. * @param name defines the block name
  100807. */
  100808. constructor(name: string);
  100809. /**
  100810. * Gets the current class name
  100811. * @returns the class name
  100812. */
  100813. getClassName(): string;
  100814. /**
  100815. * Gets the uv input component
  100816. */
  100817. get uv(): NodeMaterialConnectionPoint;
  100818. /**
  100819. * Gets the rgba output component
  100820. */
  100821. get rgba(): NodeMaterialConnectionPoint;
  100822. /**
  100823. * Gets the rgb output component
  100824. */
  100825. get rgb(): NodeMaterialConnectionPoint;
  100826. /**
  100827. * Gets the r output component
  100828. */
  100829. get r(): NodeMaterialConnectionPoint;
  100830. /**
  100831. * Gets the g output component
  100832. */
  100833. get g(): NodeMaterialConnectionPoint;
  100834. /**
  100835. * Gets the b output component
  100836. */
  100837. get b(): NodeMaterialConnectionPoint;
  100838. /**
  100839. * Gets the a output component
  100840. */
  100841. get a(): NodeMaterialConnectionPoint;
  100842. /**
  100843. * Initialize the block and prepare the context for build
  100844. * @param state defines the state that will be used for the build
  100845. */
  100846. initialize(state: NodeMaterialBuildState): void;
  100847. get target(): NodeMaterialBlockTargets;
  100848. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  100849. isReady(): boolean;
  100850. private _injectVertexCode;
  100851. private _writeTextureRead;
  100852. private _writeOutput;
  100853. protected _buildBlock(state: NodeMaterialBuildState): this | undefined;
  100854. serialize(): any;
  100855. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  100856. }
  100857. }
  100858. declare module BABYLON {
  100859. /**
  100860. * Base block used for the particle texture
  100861. */
  100862. export class ParticleTextureBlock extends NodeMaterialBlock {
  100863. private _samplerName;
  100864. private _linearDefineName;
  100865. private _gammaDefineName;
  100866. private _tempTextureRead;
  100867. /**
  100868. * Gets or sets the texture associated with the node
  100869. */
  100870. texture: Nullable<BaseTexture>;
  100871. /**
  100872. * Gets or sets a boolean indicating if content needs to be converted to gamma space
  100873. */
  100874. convertToGammaSpace: boolean;
  100875. /**
  100876. * Gets or sets a boolean indicating if content needs to be converted to linear space
  100877. */
  100878. convertToLinearSpace: boolean;
  100879. /**
  100880. * Create a new ParticleTextureBlock
  100881. * @param name defines the block name
  100882. */
  100883. constructor(name: string);
  100884. /**
  100885. * Gets the current class name
  100886. * @returns the class name
  100887. */
  100888. getClassName(): string;
  100889. /**
  100890. * Gets the uv input component
  100891. */
  100892. get uv(): NodeMaterialConnectionPoint;
  100893. /**
  100894. * Gets the rgba output component
  100895. */
  100896. get rgba(): NodeMaterialConnectionPoint;
  100897. /**
  100898. * Gets the rgb output component
  100899. */
  100900. get rgb(): NodeMaterialConnectionPoint;
  100901. /**
  100902. * Gets the r output component
  100903. */
  100904. get r(): NodeMaterialConnectionPoint;
  100905. /**
  100906. * Gets the g output component
  100907. */
  100908. get g(): NodeMaterialConnectionPoint;
  100909. /**
  100910. * Gets the b output component
  100911. */
  100912. get b(): NodeMaterialConnectionPoint;
  100913. /**
  100914. * Gets the a output component
  100915. */
  100916. get a(): NodeMaterialConnectionPoint;
  100917. /**
  100918. * Initialize the block and prepare the context for build
  100919. * @param state defines the state that will be used for the build
  100920. */
  100921. initialize(state: NodeMaterialBuildState): void;
  100922. autoConfigure(material: NodeMaterial): void;
  100923. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  100924. isReady(): boolean;
  100925. private _writeOutput;
  100926. protected _buildBlock(state: NodeMaterialBuildState): this | undefined;
  100927. serialize(): any;
  100928. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  100929. }
  100930. }
  100931. declare module BABYLON {
  100932. /**
  100933. * Class used to store shared data between 2 NodeMaterialBuildState
  100934. */
  100935. export class NodeMaterialBuildStateSharedData {
  100936. /**
  100937. * Gets the list of emitted varyings
  100938. */
  100939. temps: string[];
  100940. /**
  100941. * Gets the list of emitted varyings
  100942. */
  100943. varyings: string[];
  100944. /**
  100945. * Gets the varying declaration string
  100946. */
  100947. varyingDeclaration: string;
  100948. /**
  100949. * Input blocks
  100950. */
  100951. inputBlocks: InputBlock[];
  100952. /**
  100953. * Input blocks
  100954. */
  100955. textureBlocks: (TextureBlock | ReflectionTextureBaseBlock | RefractionBlock | CurrentScreenBlock | ParticleTextureBlock)[];
  100956. /**
  100957. * Bindable blocks (Blocks that need to set data to the effect)
  100958. */
  100959. bindableBlocks: NodeMaterialBlock[];
  100960. /**
  100961. * List of blocks that can provide a compilation fallback
  100962. */
  100963. blocksWithFallbacks: NodeMaterialBlock[];
  100964. /**
  100965. * List of blocks that can provide a define update
  100966. */
  100967. blocksWithDefines: NodeMaterialBlock[];
  100968. /**
  100969. * List of blocks that can provide a repeatable content
  100970. */
  100971. repeatableContentBlocks: NodeMaterialBlock[];
  100972. /**
  100973. * List of blocks that can provide a dynamic list of uniforms
  100974. */
  100975. dynamicUniformBlocks: NodeMaterialBlock[];
  100976. /**
  100977. * List of blocks that can block the isReady function for the material
  100978. */
  100979. blockingBlocks: NodeMaterialBlock[];
  100980. /**
  100981. * Gets the list of animated inputs
  100982. */
  100983. animatedInputs: InputBlock[];
  100984. /**
  100985. * Build Id used to avoid multiple recompilations
  100986. */
  100987. buildId: number;
  100988. /** List of emitted variables */
  100989. variableNames: {
  100990. [key: string]: number;
  100991. };
  100992. /** List of emitted defines */
  100993. defineNames: {
  100994. [key: string]: number;
  100995. };
  100996. /** Should emit comments? */
  100997. emitComments: boolean;
  100998. /** Emit build activity */
  100999. verbose: boolean;
  101000. /** Gets or sets the hosting scene */
  101001. scene: Scene;
  101002. /**
  101003. * Gets the compilation hints emitted at compilation time
  101004. */
  101005. hints: {
  101006. needWorldViewMatrix: boolean;
  101007. needWorldViewProjectionMatrix: boolean;
  101008. needAlphaBlending: boolean;
  101009. needAlphaTesting: boolean;
  101010. };
  101011. /**
  101012. * List of compilation checks
  101013. */
  101014. checks: {
  101015. emitVertex: boolean;
  101016. emitFragment: boolean;
  101017. notConnectedNonOptionalInputs: NodeMaterialConnectionPoint[];
  101018. };
  101019. /**
  101020. * Is vertex program allowed to be empty?
  101021. */
  101022. allowEmptyVertexProgram: boolean;
  101023. /** Creates a new shared data */
  101024. constructor();
  101025. /**
  101026. * Emits console errors and exceptions if there is a failing check
  101027. */
  101028. emitErrors(): void;
  101029. }
  101030. }
  101031. declare module BABYLON {
  101032. /**
  101033. * Class used to store node based material build state
  101034. */
  101035. export class NodeMaterialBuildState {
  101036. /** Gets or sets a boolean indicating if the current state can emit uniform buffers */
  101037. supportUniformBuffers: boolean;
  101038. /**
  101039. * Gets the list of emitted attributes
  101040. */
  101041. attributes: string[];
  101042. /**
  101043. * Gets the list of emitted uniforms
  101044. */
  101045. uniforms: string[];
  101046. /**
  101047. * Gets the list of emitted constants
  101048. */
  101049. constants: string[];
  101050. /**
  101051. * Gets the list of emitted samplers
  101052. */
  101053. samplers: string[];
  101054. /**
  101055. * Gets the list of emitted functions
  101056. */
  101057. functions: {
  101058. [key: string]: string;
  101059. };
  101060. /**
  101061. * Gets the list of emitted extensions
  101062. */
  101063. extensions: {
  101064. [key: string]: string;
  101065. };
  101066. /**
  101067. * Gets the target of the compilation state
  101068. */
  101069. target: NodeMaterialBlockTargets;
  101070. /**
  101071. * Gets the list of emitted counters
  101072. */
  101073. counters: {
  101074. [key: string]: number;
  101075. };
  101076. /**
  101077. * Shared data between multiple NodeMaterialBuildState instances
  101078. */
  101079. sharedData: NodeMaterialBuildStateSharedData;
  101080. /** @hidden */
  101081. _vertexState: NodeMaterialBuildState;
  101082. /** @hidden */
  101083. _attributeDeclaration: string;
  101084. /** @hidden */
  101085. _uniformDeclaration: string;
  101086. /** @hidden */
  101087. _constantDeclaration: string;
  101088. /** @hidden */
  101089. _samplerDeclaration: string;
  101090. /** @hidden */
  101091. _varyingTransfer: string;
  101092. /** @hidden */
  101093. _injectAtEnd: string;
  101094. private _repeatableContentAnchorIndex;
  101095. /** @hidden */
  101096. _builtCompilationString: string;
  101097. /**
  101098. * Gets the emitted compilation strings
  101099. */
  101100. compilationString: string;
  101101. /**
  101102. * Finalize the compilation strings
  101103. * @param state defines the current compilation state
  101104. */
  101105. finalize(state: NodeMaterialBuildState): void;
  101106. /** @hidden */
  101107. get _repeatableContentAnchor(): string;
  101108. /** @hidden */
  101109. _getFreeVariableName(prefix: string): string;
  101110. /** @hidden */
  101111. _getFreeDefineName(prefix: string): string;
  101112. /** @hidden */
  101113. _excludeVariableName(name: string): void;
  101114. /** @hidden */
  101115. _emit2DSampler(name: string): void;
  101116. /** @hidden */
  101117. _getGLType(type: NodeMaterialBlockConnectionPointTypes): string;
  101118. /** @hidden */
  101119. _emitExtension(name: string, extension: string, define?: string): void;
  101120. /** @hidden */
  101121. _emitFunction(name: string, code: string, comments: string): void;
  101122. /** @hidden */
  101123. _emitCodeFromInclude(includeName: string, comments: string, options?: {
  101124. replaceStrings?: {
  101125. search: RegExp;
  101126. replace: string;
  101127. }[];
  101128. repeatKey?: string;
  101129. }): string;
  101130. /** @hidden */
  101131. _emitFunctionFromInclude(includeName: string, comments: string, options?: {
  101132. repeatKey?: string;
  101133. removeAttributes?: boolean;
  101134. removeUniforms?: boolean;
  101135. removeVaryings?: boolean;
  101136. removeIfDef?: boolean;
  101137. replaceStrings?: {
  101138. search: RegExp;
  101139. replace: string;
  101140. }[];
  101141. }, storeKey?: string): void;
  101142. /** @hidden */
  101143. _registerTempVariable(name: string): boolean;
  101144. /** @hidden */
  101145. _emitVaryingFromString(name: string, type: string, define?: string, notDefine?: boolean): boolean;
  101146. /** @hidden */
  101147. _emitUniformFromString(name: string, type: string, define?: string, notDefine?: boolean): void;
  101148. /** @hidden */
  101149. _emitFloat(value: number): string;
  101150. }
  101151. }
  101152. declare module BABYLON {
  101153. /**
  101154. * Helper class used to generate session unique ID
  101155. */
  101156. export class UniqueIdGenerator {
  101157. private static _UniqueIdCounter;
  101158. /**
  101159. * Gets an unique (relatively to the current scene) Id
  101160. */
  101161. static get UniqueId(): number;
  101162. }
  101163. }
  101164. declare module BABYLON {
  101165. /**
  101166. * Defines a block that can be used inside a node based material
  101167. */
  101168. export class NodeMaterialBlock {
  101169. private _buildId;
  101170. private _buildTarget;
  101171. private _target;
  101172. private _isFinalMerger;
  101173. private _isInput;
  101174. private _name;
  101175. protected _isUnique: boolean;
  101176. /** Gets or sets a boolean indicating that only one input can be connected at a time */
  101177. inputsAreExclusive: boolean;
  101178. /** @hidden */
  101179. _codeVariableName: string;
  101180. /** @hidden */
  101181. _inputs: NodeMaterialConnectionPoint[];
  101182. /** @hidden */
  101183. _outputs: NodeMaterialConnectionPoint[];
  101184. /** @hidden */
  101185. _preparationId: number;
  101186. /**
  101187. * Gets the name of the block
  101188. */
  101189. get name(): string;
  101190. /**
  101191. * Sets the name of the block. Will check if the name is valid.
  101192. */
  101193. set name(newName: string);
  101194. /**
  101195. * Gets or sets the unique id of the node
  101196. */
  101197. uniqueId: number;
  101198. /**
  101199. * Gets or sets the comments associated with this block
  101200. */
  101201. comments: string;
  101202. /**
  101203. * Gets a boolean indicating that this block can only be used once per NodeMaterial
  101204. */
  101205. get isUnique(): boolean;
  101206. /**
  101207. * Gets a boolean indicating that this block is an end block (e.g. it is generating a system value)
  101208. */
  101209. get isFinalMerger(): boolean;
  101210. /**
  101211. * Gets a boolean indicating that this block is an input (e.g. it sends data to the shader)
  101212. */
  101213. get isInput(): boolean;
  101214. /**
  101215. * Gets or sets the build Id
  101216. */
  101217. get buildId(): number;
  101218. set buildId(value: number);
  101219. /**
  101220. * Gets or sets the target of the block
  101221. */
  101222. get target(): NodeMaterialBlockTargets;
  101223. set target(value: NodeMaterialBlockTargets);
  101224. /**
  101225. * Gets the list of input points
  101226. */
  101227. get inputs(): NodeMaterialConnectionPoint[];
  101228. /** Gets the list of output points */
  101229. get outputs(): NodeMaterialConnectionPoint[];
  101230. /**
  101231. * Find an input by its name
  101232. * @param name defines the name of the input to look for
  101233. * @returns the input or null if not found
  101234. */
  101235. getInputByName(name: string): Nullable<NodeMaterialConnectionPoint>;
  101236. /**
  101237. * Find an output by its name
  101238. * @param name defines the name of the outputto look for
  101239. * @returns the output or null if not found
  101240. */
  101241. getOutputByName(name: string): Nullable<NodeMaterialConnectionPoint>;
  101242. /**
  101243. * Creates a new NodeMaterialBlock
  101244. * @param name defines the block name
  101245. * @param target defines the target of that block (Vertex by default)
  101246. * @param isFinalMerger defines a boolean indicating that this block is an end block (e.g. it is generating a system value). Default is false
  101247. * @param isInput defines a boolean indicating that this block is an input (e.g. it sends data to the shader). Default is false
  101248. */
  101249. constructor(name: string, target?: NodeMaterialBlockTargets, isFinalMerger?: boolean, isInput?: boolean);
  101250. /**
  101251. * Initialize the block and prepare the context for build
  101252. * @param state defines the state that will be used for the build
  101253. */
  101254. initialize(state: NodeMaterialBuildState): void;
  101255. /**
  101256. * Bind data to effect. Will only be called for blocks with isBindable === true
  101257. * @param effect defines the effect to bind data to
  101258. * @param nodeMaterial defines the hosting NodeMaterial
  101259. * @param mesh defines the mesh that will be rendered
  101260. * @param subMesh defines the submesh that will be rendered
  101261. */
  101262. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh, subMesh?: SubMesh): void;
  101263. protected _declareOutput(output: NodeMaterialConnectionPoint, state: NodeMaterialBuildState): string;
  101264. protected _writeVariable(currentPoint: NodeMaterialConnectionPoint): string;
  101265. protected _writeFloat(value: number): string;
  101266. /**
  101267. * Gets the current class name e.g. "NodeMaterialBlock"
  101268. * @returns the class name
  101269. */
  101270. getClassName(): string;
  101271. /**
  101272. * Register a new input. Must be called inside a block constructor
  101273. * @param name defines the connection point name
  101274. * @param type defines the connection point type
  101275. * @param isOptional defines a boolean indicating that this input can be omitted
  101276. * @param target defines the target to use to limit the connection point (will be VertexAndFragment by default)
  101277. * @param point an already created connection point. If not provided, create a new one
  101278. * @returns the current block
  101279. */
  101280. registerInput(name: string, type: NodeMaterialBlockConnectionPointTypes, isOptional?: boolean, target?: NodeMaterialBlockTargets, point?: NodeMaterialConnectionPoint): this;
  101281. /**
  101282. * Register a new output. Must be called inside a block constructor
  101283. * @param name defines the connection point name
  101284. * @param type defines the connection point type
  101285. * @param target defines the target to use to limit the connection point (will be VertexAndFragment by default)
  101286. * @param point an already created connection point. If not provided, create a new one
  101287. * @returns the current block
  101288. */
  101289. registerOutput(name: string, type: NodeMaterialBlockConnectionPointTypes, target?: NodeMaterialBlockTargets, point?: NodeMaterialConnectionPoint): this;
  101290. /**
  101291. * Will return the first available input e.g. the first one which is not an uniform or an attribute
  101292. * @param forOutput defines an optional connection point to check compatibility with
  101293. * @returns the first available input or null
  101294. */
  101295. getFirstAvailableInput(forOutput?: Nullable<NodeMaterialConnectionPoint>): Nullable<NodeMaterialConnectionPoint>;
  101296. /**
  101297. * Will return the first available output e.g. the first one which is not yet connected and not a varying
  101298. * @param forBlock defines an optional block to check compatibility with
  101299. * @returns the first available input or null
  101300. */
  101301. getFirstAvailableOutput(forBlock?: Nullable<NodeMaterialBlock>): Nullable<NodeMaterialConnectionPoint>;
  101302. /**
  101303. * Gets the sibling of the given output
  101304. * @param current defines the current output
  101305. * @returns the next output in the list or null
  101306. */
  101307. getSiblingOutput(current: NodeMaterialConnectionPoint): Nullable<NodeMaterialConnectionPoint>;
  101308. /**
  101309. * Connect current block with another block
  101310. * @param other defines the block to connect with
  101311. * @param options define the various options to help pick the right connections
  101312. * @returns the current block
  101313. */
  101314. connectTo(other: NodeMaterialBlock, options?: {
  101315. input?: string;
  101316. output?: string;
  101317. outputSwizzle?: string;
  101318. }): this | undefined;
  101319. protected _buildBlock(state: NodeMaterialBuildState): void;
  101320. /**
  101321. * Add uniforms, samplers and uniform buffers at compilation time
  101322. * @param state defines the state to update
  101323. * @param nodeMaterial defines the node material requesting the update
  101324. * @param defines defines the material defines to update
  101325. * @param uniformBuffers defines the list of uniform buffer names
  101326. */
  101327. updateUniformsAndSamples(state: NodeMaterialBuildState, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines, uniformBuffers: string[]): void;
  101328. /**
  101329. * Add potential fallbacks if shader compilation fails
  101330. * @param mesh defines the mesh to be rendered
  101331. * @param fallbacks defines the current prioritized list of fallbacks
  101332. */
  101333. provideFallbacks(mesh: AbstractMesh, fallbacks: EffectFallbacks): void;
  101334. /**
  101335. * Initialize defines for shader compilation
  101336. * @param mesh defines the mesh to be rendered
  101337. * @param nodeMaterial defines the node material requesting the update
  101338. * @param defines defines the material defines to update
  101339. * @param useInstances specifies that instances should be used
  101340. */
  101341. initializeDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines, useInstances?: boolean): void;
  101342. /**
  101343. * Update defines for shader compilation
  101344. * @param mesh defines the mesh to be rendered
  101345. * @param nodeMaterial defines the node material requesting the update
  101346. * @param defines defines the material defines to update
  101347. * @param useInstances specifies that instances should be used
  101348. * @param subMesh defines which submesh to render
  101349. */
  101350. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines, useInstances?: boolean, subMesh?: SubMesh): void;
  101351. /**
  101352. * Lets the block try to connect some inputs automatically
  101353. * @param material defines the hosting NodeMaterial
  101354. */
  101355. autoConfigure(material: NodeMaterial): void;
  101356. /**
  101357. * Function called when a block is declared as repeatable content generator
  101358. * @param vertexShaderState defines the current compilation state for the vertex shader
  101359. * @param fragmentShaderState defines the current compilation state for the fragment shader
  101360. * @param mesh defines the mesh to be rendered
  101361. * @param defines defines the material defines to update
  101362. */
  101363. replaceRepeatableContent(vertexShaderState: NodeMaterialBuildState, fragmentShaderState: NodeMaterialBuildState, mesh: AbstractMesh, defines: NodeMaterialDefines): void;
  101364. /**
  101365. * Checks if the block is ready
  101366. * @param mesh defines the mesh to be rendered
  101367. * @param nodeMaterial defines the node material requesting the update
  101368. * @param defines defines the material defines to update
  101369. * @param useInstances specifies that instances should be used
  101370. * @returns true if the block is ready
  101371. */
  101372. isReady(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines, useInstances?: boolean): boolean;
  101373. protected _linkConnectionTypes(inputIndex0: number, inputIndex1: number): void;
  101374. private _processBuild;
  101375. /**
  101376. * Validates the new name for the block node.
  101377. * @param newName the new name to be given to the node.
  101378. * @returns false if the name is a reserve word, else true.
  101379. */
  101380. validateBlockName(newName: string): boolean;
  101381. /**
  101382. * Compile the current node and generate the shader code
  101383. * @param state defines the current compilation state (uniforms, samplers, current string)
  101384. * @param activeBlocks defines the list of active blocks (i.e. blocks to compile)
  101385. * @returns true if already built
  101386. */
  101387. build(state: NodeMaterialBuildState, activeBlocks: NodeMaterialBlock[]): boolean;
  101388. protected _inputRename(name: string): string;
  101389. protected _outputRename(name: string): string;
  101390. protected _dumpPropertiesCode(): string;
  101391. /** @hidden */
  101392. _dumpCode(uniqueNames: string[], alreadyDumped: NodeMaterialBlock[]): string;
  101393. /** @hidden */
  101394. _dumpCodeForOutputConnections(alreadyDumped: NodeMaterialBlock[]): string;
  101395. /**
  101396. * Clone the current block to a new identical block
  101397. * @param scene defines the hosting scene
  101398. * @param rootUrl defines the root URL to use to load textures and relative dependencies
  101399. * @returns a copy of the current block
  101400. */
  101401. clone(scene: Scene, rootUrl?: string): Nullable<NodeMaterialBlock>;
  101402. /**
  101403. * Serializes this block in a JSON representation
  101404. * @returns the serialized block object
  101405. */
  101406. serialize(): any;
  101407. /** @hidden */
  101408. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  101409. private _deserializePortDisplayNamesAndExposedOnFrame;
  101410. /**
  101411. * Release resources
  101412. */
  101413. dispose(): void;
  101414. }
  101415. }
  101416. declare module BABYLON {
  101417. /**
  101418. * Base class of materials working in push mode in babylon JS
  101419. * @hidden
  101420. */
  101421. export class PushMaterial extends Material {
  101422. protected _activeEffect: Effect;
  101423. protected _normalMatrix: Matrix;
  101424. constructor(name: string, scene: Scene);
  101425. getEffect(): Effect;
  101426. isReady(mesh?: AbstractMesh, useInstances?: boolean): boolean;
  101427. protected _isReadyForSubMesh(subMesh: SubMesh): boolean;
  101428. /**
  101429. * Binds the given world matrix to the active effect
  101430. *
  101431. * @param world the matrix to bind
  101432. */
  101433. bindOnlyWorldMatrix(world: Matrix): void;
  101434. /**
  101435. * Binds the given normal matrix to the active effect
  101436. *
  101437. * @param normalMatrix the matrix to bind
  101438. */
  101439. bindOnlyNormalMatrix(normalMatrix: Matrix): void;
  101440. bind(world: Matrix, mesh?: Mesh): void;
  101441. protected _afterBind(mesh: Mesh, effect?: Nullable<Effect>): void;
  101442. protected _mustRebind(scene: Scene, effect: Effect, visibility?: number): boolean;
  101443. }
  101444. }
  101445. declare module BABYLON {
  101446. /**
  101447. * Root class for all node material optimizers
  101448. */
  101449. export class NodeMaterialOptimizer {
  101450. /**
  101451. * Function used to optimize a NodeMaterial graph
  101452. * @param vertexOutputNodes defines the list of output nodes for the vertex shader
  101453. * @param fragmentOutputNodes defines the list of output nodes for the fragment shader
  101454. */
  101455. optimize(vertexOutputNodes: NodeMaterialBlock[], fragmentOutputNodes: NodeMaterialBlock[]): void;
  101456. }
  101457. }
  101458. declare module BABYLON {
  101459. /**
  101460. * Block used to transform a vector (2, 3 or 4) with a matrix. It will generate a Vector4
  101461. */
  101462. export class TransformBlock extends NodeMaterialBlock {
  101463. /**
  101464. * Defines the value to use to complement W value to transform it to a Vector4
  101465. */
  101466. complementW: number;
  101467. /**
  101468. * Defines the value to use to complement z value to transform it to a Vector4
  101469. */
  101470. complementZ: number;
  101471. /**
  101472. * Creates a new TransformBlock
  101473. * @param name defines the block name
  101474. */
  101475. constructor(name: string);
  101476. /**
  101477. * Gets the current class name
  101478. * @returns the class name
  101479. */
  101480. getClassName(): string;
  101481. /**
  101482. * Gets the vector input
  101483. */
  101484. get vector(): NodeMaterialConnectionPoint;
  101485. /**
  101486. * Gets the output component
  101487. */
  101488. get output(): NodeMaterialConnectionPoint;
  101489. /**
  101490. * Gets the xyz output component
  101491. */
  101492. get xyz(): NodeMaterialConnectionPoint;
  101493. /**
  101494. * Gets the matrix transform input
  101495. */
  101496. get transform(): NodeMaterialConnectionPoint;
  101497. protected _buildBlock(state: NodeMaterialBuildState): this;
  101498. /**
  101499. * Update defines for shader compilation
  101500. * @param mesh defines the mesh to be rendered
  101501. * @param nodeMaterial defines the node material requesting the update
  101502. * @param defines defines the material defines to update
  101503. * @param useInstances specifies that instances should be used
  101504. * @param subMesh defines which submesh to render
  101505. */
  101506. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines, useInstances?: boolean, subMesh?: SubMesh): void;
  101507. serialize(): any;
  101508. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  101509. protected _dumpPropertiesCode(): string;
  101510. }
  101511. }
  101512. declare module BABYLON {
  101513. /**
  101514. * Block used to output the vertex position
  101515. */
  101516. export class VertexOutputBlock extends NodeMaterialBlock {
  101517. /**
  101518. * Creates a new VertexOutputBlock
  101519. * @param name defines the block name
  101520. */
  101521. constructor(name: string);
  101522. /**
  101523. * Gets the current class name
  101524. * @returns the class name
  101525. */
  101526. getClassName(): string;
  101527. /**
  101528. * Gets the vector input component
  101529. */
  101530. get vector(): NodeMaterialConnectionPoint;
  101531. protected _buildBlock(state: NodeMaterialBuildState): this;
  101532. }
  101533. }
  101534. declare module BABYLON {
  101535. /**
  101536. * Block used to output the final color
  101537. */
  101538. export class FragmentOutputBlock extends NodeMaterialBlock {
  101539. /**
  101540. * Create a new FragmentOutputBlock
  101541. * @param name defines the block name
  101542. */
  101543. constructor(name: string);
  101544. /**
  101545. * Gets the current class name
  101546. * @returns the class name
  101547. */
  101548. getClassName(): string;
  101549. /**
  101550. * Gets the rgba input component
  101551. */
  101552. get rgba(): NodeMaterialConnectionPoint;
  101553. /**
  101554. * Gets the rgb input component
  101555. */
  101556. get rgb(): NodeMaterialConnectionPoint;
  101557. /**
  101558. * Gets the a input component
  101559. */
  101560. get a(): NodeMaterialConnectionPoint;
  101561. protected _buildBlock(state: NodeMaterialBuildState): this;
  101562. }
  101563. }
  101564. declare module BABYLON {
  101565. /**
  101566. * Block used for the particle ramp gradient section
  101567. */
  101568. export class ParticleRampGradientBlock extends NodeMaterialBlock {
  101569. /**
  101570. * Create a new ParticleRampGradientBlock
  101571. * @param name defines the block name
  101572. */
  101573. constructor(name: string);
  101574. /**
  101575. * Gets the current class name
  101576. * @returns the class name
  101577. */
  101578. getClassName(): string;
  101579. /**
  101580. * Gets the color input component
  101581. */
  101582. get color(): NodeMaterialConnectionPoint;
  101583. /**
  101584. * Gets the rampColor output component
  101585. */
  101586. get rampColor(): NodeMaterialConnectionPoint;
  101587. /**
  101588. * Initialize the block and prepare the context for build
  101589. * @param state defines the state that will be used for the build
  101590. */
  101591. initialize(state: NodeMaterialBuildState): void;
  101592. protected _buildBlock(state: NodeMaterialBuildState): this | undefined;
  101593. }
  101594. }
  101595. declare module BABYLON {
  101596. /**
  101597. * Block used for the particle blend multiply section
  101598. */
  101599. export class ParticleBlendMultiplyBlock extends NodeMaterialBlock {
  101600. /**
  101601. * Create a new ParticleBlendMultiplyBlock
  101602. * @param name defines the block name
  101603. */
  101604. constructor(name: string);
  101605. /**
  101606. * Gets the current class name
  101607. * @returns the class name
  101608. */
  101609. getClassName(): string;
  101610. /**
  101611. * Gets the color input component
  101612. */
  101613. get color(): NodeMaterialConnectionPoint;
  101614. /**
  101615. * Gets the alphaTexture input component
  101616. */
  101617. get alphaTexture(): NodeMaterialConnectionPoint;
  101618. /**
  101619. * Gets the alphaColor input component
  101620. */
  101621. get alphaColor(): NodeMaterialConnectionPoint;
  101622. /**
  101623. * Gets the blendColor output component
  101624. */
  101625. get blendColor(): NodeMaterialConnectionPoint;
  101626. /**
  101627. * Initialize the block and prepare the context for build
  101628. * @param state defines the state that will be used for the build
  101629. */
  101630. initialize(state: NodeMaterialBuildState): void;
  101631. protected _buildBlock(state: NodeMaterialBuildState): this | undefined;
  101632. }
  101633. }
  101634. declare module BABYLON {
  101635. /**
  101636. * Block used to create a Vector2/3/4 out of individual inputs (one for each component)
  101637. */
  101638. export class VectorMergerBlock extends NodeMaterialBlock {
  101639. /**
  101640. * Create a new VectorMergerBlock
  101641. * @param name defines the block name
  101642. */
  101643. constructor(name: string);
  101644. /**
  101645. * Gets the current class name
  101646. * @returns the class name
  101647. */
  101648. getClassName(): string;
  101649. /**
  101650. * Gets the xyz component (input)
  101651. */
  101652. get xyzIn(): NodeMaterialConnectionPoint;
  101653. /**
  101654. * Gets the xy component (input)
  101655. */
  101656. get xyIn(): NodeMaterialConnectionPoint;
  101657. /**
  101658. * Gets the x component (input)
  101659. */
  101660. get x(): NodeMaterialConnectionPoint;
  101661. /**
  101662. * Gets the y component (input)
  101663. */
  101664. get y(): NodeMaterialConnectionPoint;
  101665. /**
  101666. * Gets the z component (input)
  101667. */
  101668. get z(): NodeMaterialConnectionPoint;
  101669. /**
  101670. * Gets the w component (input)
  101671. */
  101672. get w(): NodeMaterialConnectionPoint;
  101673. /**
  101674. * Gets the xyzw component (output)
  101675. */
  101676. get xyzw(): NodeMaterialConnectionPoint;
  101677. /**
  101678. * Gets the xyz component (output)
  101679. */
  101680. get xyzOut(): NodeMaterialConnectionPoint;
  101681. /**
  101682. * Gets the xy component (output)
  101683. */
  101684. get xyOut(): NodeMaterialConnectionPoint;
  101685. /**
  101686. * Gets the xy component (output)
  101687. * @deprecated Please use xyOut instead.
  101688. */
  101689. get xy(): NodeMaterialConnectionPoint;
  101690. /**
  101691. * Gets the xyz component (output)
  101692. * @deprecated Please use xyzOut instead.
  101693. */
  101694. get xyz(): NodeMaterialConnectionPoint;
  101695. protected _buildBlock(state: NodeMaterialBuildState): this;
  101696. }
  101697. }
  101698. declare module BABYLON {
  101699. /**
  101700. * Block used to remap a float from a range to a new one
  101701. */
  101702. export class RemapBlock extends NodeMaterialBlock {
  101703. /**
  101704. * Gets or sets the source range
  101705. */
  101706. sourceRange: Vector2;
  101707. /**
  101708. * Gets or sets the target range
  101709. */
  101710. targetRange: Vector2;
  101711. /**
  101712. * Creates a new RemapBlock
  101713. * @param name defines the block name
  101714. */
  101715. constructor(name: string);
  101716. /**
  101717. * Gets the current class name
  101718. * @returns the class name
  101719. */
  101720. getClassName(): string;
  101721. /**
  101722. * Gets the input component
  101723. */
  101724. get input(): NodeMaterialConnectionPoint;
  101725. /**
  101726. * Gets the source min input component
  101727. */
  101728. get sourceMin(): NodeMaterialConnectionPoint;
  101729. /**
  101730. * Gets the source max input component
  101731. */
  101732. get sourceMax(): NodeMaterialConnectionPoint;
  101733. /**
  101734. * Gets the target min input component
  101735. */
  101736. get targetMin(): NodeMaterialConnectionPoint;
  101737. /**
  101738. * Gets the target max input component
  101739. */
  101740. get targetMax(): NodeMaterialConnectionPoint;
  101741. /**
  101742. * Gets the output component
  101743. */
  101744. get output(): NodeMaterialConnectionPoint;
  101745. protected _buildBlock(state: NodeMaterialBuildState): this;
  101746. protected _dumpPropertiesCode(): string;
  101747. serialize(): any;
  101748. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  101749. }
  101750. }
  101751. declare module BABYLON {
  101752. /**
  101753. * Block used to multiply 2 values
  101754. */
  101755. export class MultiplyBlock extends NodeMaterialBlock {
  101756. /**
  101757. * Creates a new MultiplyBlock
  101758. * @param name defines the block name
  101759. */
  101760. constructor(name: string);
  101761. /**
  101762. * Gets the current class name
  101763. * @returns the class name
  101764. */
  101765. getClassName(): string;
  101766. /**
  101767. * Gets the left operand input component
  101768. */
  101769. get left(): NodeMaterialConnectionPoint;
  101770. /**
  101771. * Gets the right operand input component
  101772. */
  101773. get right(): NodeMaterialConnectionPoint;
  101774. /**
  101775. * Gets the output component
  101776. */
  101777. get output(): NodeMaterialConnectionPoint;
  101778. protected _buildBlock(state: NodeMaterialBuildState): this;
  101779. }
  101780. }
  101781. declare module BABYLON {
  101782. /**
  101783. * Block used to expand a Color3/4 into 4 outputs (one for each component)
  101784. */
  101785. export class ColorSplitterBlock extends NodeMaterialBlock {
  101786. /**
  101787. * Create a new ColorSplitterBlock
  101788. * @param name defines the block name
  101789. */
  101790. constructor(name: string);
  101791. /**
  101792. * Gets the current class name
  101793. * @returns the class name
  101794. */
  101795. getClassName(): string;
  101796. /**
  101797. * Gets the rgba component (input)
  101798. */
  101799. get rgba(): NodeMaterialConnectionPoint;
  101800. /**
  101801. * Gets the rgb component (input)
  101802. */
  101803. get rgbIn(): NodeMaterialConnectionPoint;
  101804. /**
  101805. * Gets the rgb component (output)
  101806. */
  101807. get rgbOut(): NodeMaterialConnectionPoint;
  101808. /**
  101809. * Gets the r component (output)
  101810. */
  101811. get r(): NodeMaterialConnectionPoint;
  101812. /**
  101813. * Gets the g component (output)
  101814. */
  101815. get g(): NodeMaterialConnectionPoint;
  101816. /**
  101817. * Gets the b component (output)
  101818. */
  101819. get b(): NodeMaterialConnectionPoint;
  101820. /**
  101821. * Gets the a component (output)
  101822. */
  101823. get a(): NodeMaterialConnectionPoint;
  101824. protected _inputRename(name: string): string;
  101825. protected _outputRename(name: string): string;
  101826. protected _buildBlock(state: NodeMaterialBuildState): this | undefined;
  101827. }
  101828. }
  101829. declare module BABYLON {
  101830. /**
  101831. * Interface used to configure the node material editor
  101832. */
  101833. export interface INodeMaterialEditorOptions {
  101834. /** Define the URl to load node editor script */
  101835. editorURL?: string;
  101836. }
  101837. /** @hidden */
  101838. export class NodeMaterialDefines extends MaterialDefines implements IImageProcessingConfigurationDefines {
  101839. NORMAL: boolean;
  101840. TANGENT: boolean;
  101841. UV1: boolean;
  101842. /** BONES */
  101843. NUM_BONE_INFLUENCERS: number;
  101844. BonesPerMesh: number;
  101845. BONETEXTURE: boolean;
  101846. /** MORPH TARGETS */
  101847. MORPHTARGETS: boolean;
  101848. MORPHTARGETS_NORMAL: boolean;
  101849. MORPHTARGETS_TANGENT: boolean;
  101850. MORPHTARGETS_UV: boolean;
  101851. NUM_MORPH_INFLUENCERS: number;
  101852. /** IMAGE PROCESSING */
  101853. IMAGEPROCESSING: boolean;
  101854. VIGNETTE: boolean;
  101855. VIGNETTEBLENDMODEMULTIPLY: boolean;
  101856. VIGNETTEBLENDMODEOPAQUE: boolean;
  101857. TONEMAPPING: boolean;
  101858. TONEMAPPING_ACES: boolean;
  101859. CONTRAST: boolean;
  101860. EXPOSURE: boolean;
  101861. COLORCURVES: boolean;
  101862. COLORGRADING: boolean;
  101863. COLORGRADING3D: boolean;
  101864. SAMPLER3DGREENDEPTH: boolean;
  101865. SAMPLER3DBGRMAP: boolean;
  101866. IMAGEPROCESSINGPOSTPROCESS: boolean;
  101867. /** MISC. */
  101868. BUMPDIRECTUV: number;
  101869. constructor();
  101870. setValue(name: string, value: any, markAsUnprocessedIfDirty?: boolean): void;
  101871. }
  101872. /**
  101873. * Class used to configure NodeMaterial
  101874. */
  101875. export interface INodeMaterialOptions {
  101876. /**
  101877. * Defines if blocks should emit comments
  101878. */
  101879. emitComments: boolean;
  101880. }
  101881. /**
  101882. * Class used to create a node based material built by assembling shader blocks
  101883. */
  101884. export class NodeMaterial extends PushMaterial {
  101885. private static _BuildIdGenerator;
  101886. private _options;
  101887. private _vertexCompilationState;
  101888. private _fragmentCompilationState;
  101889. private _sharedData;
  101890. private _buildId;
  101891. private _buildWasSuccessful;
  101892. private _cachedWorldViewMatrix;
  101893. private _cachedWorldViewProjectionMatrix;
  101894. private _optimizers;
  101895. private _animationFrame;
  101896. /** Define the Url to load node editor script */
  101897. static EditorURL: string;
  101898. /** Define the Url to load snippets */
  101899. static SnippetUrl: string;
  101900. /** Gets or sets a boolean indicating that node materials should not deserialize textures from json / snippet content */
  101901. static IgnoreTexturesAtLoadTime: boolean;
  101902. private BJSNODEMATERIALEDITOR;
  101903. /** Get the inspector from bundle or global */
  101904. private _getGlobalNodeMaterialEditor;
  101905. /**
  101906. * Snippet ID if the material was created from the snippet server
  101907. */
  101908. snippetId: string;
  101909. /**
  101910. * Gets or sets data used by visual editor
  101911. * @see https://nme.babylonjs.com
  101912. */
  101913. editorData: any;
  101914. /**
  101915. * 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)
  101916. */
  101917. ignoreAlpha: boolean;
  101918. /**
  101919. * Defines the maximum number of lights that can be used in the material
  101920. */
  101921. maxSimultaneousLights: number;
  101922. /**
  101923. * Observable raised when the material is built
  101924. */
  101925. onBuildObservable: Observable<NodeMaterial>;
  101926. /**
  101927. * Gets or sets the root nodes of the material vertex shader
  101928. */
  101929. _vertexOutputNodes: NodeMaterialBlock[];
  101930. /**
  101931. * Gets or sets the root nodes of the material fragment (pixel) shader
  101932. */
  101933. _fragmentOutputNodes: NodeMaterialBlock[];
  101934. /** Gets or sets options to control the node material overall behavior */
  101935. get options(): INodeMaterialOptions;
  101936. set options(options: INodeMaterialOptions);
  101937. /**
  101938. * Default configuration related to image processing available in the standard Material.
  101939. */
  101940. protected _imageProcessingConfiguration: ImageProcessingConfiguration;
  101941. /**
  101942. * Gets the image processing configuration used either in this material.
  101943. */
  101944. get imageProcessingConfiguration(): ImageProcessingConfiguration;
  101945. /**
  101946. * Sets the Default image processing configuration used either in the this material.
  101947. *
  101948. * If sets to null, the scene one is in use.
  101949. */
  101950. set imageProcessingConfiguration(value: ImageProcessingConfiguration);
  101951. /**
  101952. * Gets an array of blocks that needs to be serialized even if they are not yet connected
  101953. */
  101954. attachedBlocks: NodeMaterialBlock[];
  101955. /**
  101956. * Specifies the mode of the node material
  101957. * @hidden
  101958. */
  101959. _mode: NodeMaterialModes;
  101960. /**
  101961. * Gets the mode property
  101962. */
  101963. get mode(): NodeMaterialModes;
  101964. /**
  101965. * Create a new node based material
  101966. * @param name defines the material name
  101967. * @param scene defines the hosting scene
  101968. * @param options defines creation option
  101969. */
  101970. constructor(name: string, scene?: Scene, options?: Partial<INodeMaterialOptions>);
  101971. /**
  101972. * Gets the current class name of the material e.g. "NodeMaterial"
  101973. * @returns the class name
  101974. */
  101975. getClassName(): string;
  101976. /**
  101977. * Keep track of the image processing observer to allow dispose and replace.
  101978. */
  101979. private _imageProcessingObserver;
  101980. /**
  101981. * Attaches a new image processing configuration to the Standard Material.
  101982. * @param configuration
  101983. */
  101984. protected _attachImageProcessingConfiguration(configuration: Nullable<ImageProcessingConfiguration>): void;
  101985. /**
  101986. * Get a block by its name
  101987. * @param name defines the name of the block to retrieve
  101988. * @returns the required block or null if not found
  101989. */
  101990. getBlockByName(name: string): Nullable<NodeMaterialBlock>;
  101991. /**
  101992. * Get a block by its name
  101993. * @param predicate defines the predicate used to find the good candidate
  101994. * @returns the required block or null if not found
  101995. */
  101996. getBlockByPredicate(predicate: (block: NodeMaterialBlock) => boolean): Nullable<NodeMaterialBlock>;
  101997. /**
  101998. * Get an input block by its name
  101999. * @param predicate defines the predicate used to find the good candidate
  102000. * @returns the required input block or null if not found
  102001. */
  102002. getInputBlockByPredicate(predicate: (block: InputBlock) => boolean): Nullable<InputBlock>;
  102003. /**
  102004. * Gets the list of input blocks attached to this material
  102005. * @returns an array of InputBlocks
  102006. */
  102007. getInputBlocks(): InputBlock[];
  102008. /**
  102009. * Adds a new optimizer to the list of optimizers
  102010. * @param optimizer defines the optimizers to add
  102011. * @returns the current material
  102012. */
  102013. registerOptimizer(optimizer: NodeMaterialOptimizer): this | undefined;
  102014. /**
  102015. * Remove an optimizer from the list of optimizers
  102016. * @param optimizer defines the optimizers to remove
  102017. * @returns the current material
  102018. */
  102019. unregisterOptimizer(optimizer: NodeMaterialOptimizer): this | undefined;
  102020. /**
  102021. * Add a new block to the list of output nodes
  102022. * @param node defines the node to add
  102023. * @returns the current material
  102024. */
  102025. addOutputNode(node: NodeMaterialBlock): this;
  102026. /**
  102027. * Remove a block from the list of root nodes
  102028. * @param node defines the node to remove
  102029. * @returns the current material
  102030. */
  102031. removeOutputNode(node: NodeMaterialBlock): this;
  102032. private _addVertexOutputNode;
  102033. private _removeVertexOutputNode;
  102034. private _addFragmentOutputNode;
  102035. private _removeFragmentOutputNode;
  102036. /**
  102037. * Specifies if the material will require alpha blending
  102038. * @returns a boolean specifying if alpha blending is needed
  102039. */
  102040. needAlphaBlending(): boolean;
  102041. /**
  102042. * Specifies if this material should be rendered in alpha test mode
  102043. * @returns a boolean specifying if an alpha test is needed.
  102044. */
  102045. needAlphaTesting(): boolean;
  102046. private _initializeBlock;
  102047. private _resetDualBlocks;
  102048. /**
  102049. * Remove a block from the current node material
  102050. * @param block defines the block to remove
  102051. */
  102052. removeBlock(block: NodeMaterialBlock): void;
  102053. /**
  102054. * Build the material and generates the inner effect
  102055. * @param verbose defines if the build should log activity
  102056. */
  102057. build(verbose?: boolean): void;
  102058. /**
  102059. * Runs an otpimization phase to try to improve the shader code
  102060. */
  102061. optimize(): void;
  102062. private _prepareDefinesForAttributes;
  102063. /**
  102064. * Create a post process from the material
  102065. * @param camera The camera to apply the render pass to.
  102066. * @param options The required width/height ratio to downsize to before computing the render pass. (Use 1.0 for full size)
  102067. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  102068. * @param engine The engine which the post process will be applied. (default: current engine)
  102069. * @param reusable If the post process can be reused on the same frame. (default: false)
  102070. * @param textureType Type of textures used when performing the post process. (default: 0)
  102071. * @param textureFormat Format of textures used when performing the post process. (default: TEXTUREFORMAT_RGBA)
  102072. * @returns the post process created
  102073. */
  102074. createPostProcess(camera: Nullable<Camera>, options?: number | PostProcessOptions, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number, textureFormat?: number): PostProcess;
  102075. /**
  102076. * Create the post process effect from the material
  102077. * @param postProcess The post process to create the effect for
  102078. */
  102079. createEffectForPostProcess(postProcess: PostProcess): void;
  102080. private _createEffectOrPostProcess;
  102081. private _createEffectForParticles;
  102082. /**
  102083. * Create the effect to be used as the custom effect for a particle system
  102084. * @param particleSystem Particle system to create the effect for
  102085. * @param onCompiled defines a function to call when the effect creation is successful
  102086. * @param onError defines a function to call when the effect creation has failed
  102087. */
  102088. createEffectForParticles(particleSystem: IParticleSystem, onCompiled?: (effect: Effect) => void, onError?: (effect: Effect, errors: string) => void): void;
  102089. private _processDefines;
  102090. /**
  102091. * Get if the submesh is ready to be used and all its information available.
  102092. * Child classes can use it to update shaders
  102093. * @param mesh defines the mesh to check
  102094. * @param subMesh defines which submesh to check
  102095. * @param useInstances specifies that instances should be used
  102096. * @returns a boolean indicating that the submesh is ready or not
  102097. */
  102098. isReadyForSubMesh(mesh: AbstractMesh, subMesh: SubMesh, useInstances?: boolean): boolean;
  102099. /**
  102100. * Get a string representing the shaders built by the current node graph
  102101. */
  102102. get compiledShaders(): string;
  102103. /**
  102104. * Binds the world matrix to the material
  102105. * @param world defines the world transformation matrix
  102106. */
  102107. bindOnlyWorldMatrix(world: Matrix): void;
  102108. /**
  102109. * Binds the submesh to this material by preparing the effect and shader to draw
  102110. * @param world defines the world transformation matrix
  102111. * @param mesh defines the mesh containing the submesh
  102112. * @param subMesh defines the submesh to bind the material to
  102113. */
  102114. bindForSubMesh(world: Matrix, mesh: Mesh, subMesh: SubMesh): void;
  102115. /**
  102116. * Gets the active textures from the material
  102117. * @returns an array of textures
  102118. */
  102119. getActiveTextures(): BaseTexture[];
  102120. /**
  102121. * Gets the list of texture blocks
  102122. * @returns an array of texture blocks
  102123. */
  102124. getTextureBlocks(): (TextureBlock | ReflectionTextureBaseBlock | RefractionBlock | CurrentScreenBlock | ParticleTextureBlock)[];
  102125. /**
  102126. * Specifies if the material uses a texture
  102127. * @param texture defines the texture to check against the material
  102128. * @returns a boolean specifying if the material uses the texture
  102129. */
  102130. hasTexture(texture: BaseTexture): boolean;
  102131. /**
  102132. * Disposes the material
  102133. * @param forceDisposeEffect specifies if effects should be forcefully disposed
  102134. * @param forceDisposeTextures specifies if textures should be forcefully disposed
  102135. * @param notBoundToMesh specifies if the material that is being disposed is known to be not bound to any mesh
  102136. */
  102137. dispose(forceDisposeEffect?: boolean, forceDisposeTextures?: boolean, notBoundToMesh?: boolean): void;
  102138. /** Creates the node editor window. */
  102139. private _createNodeEditor;
  102140. /**
  102141. * Launch the node material editor
  102142. * @param config Define the configuration of the editor
  102143. * @return a promise fulfilled when the node editor is visible
  102144. */
  102145. edit(config?: INodeMaterialEditorOptions): Promise<void>;
  102146. /**
  102147. * Clear the current material
  102148. */
  102149. clear(): void;
  102150. /**
  102151. * Clear the current material and set it to a default state
  102152. */
  102153. setToDefault(): void;
  102154. /**
  102155. * Clear the current material and set it to a default state for post process
  102156. */
  102157. setToDefaultPostProcess(): void;
  102158. /**
  102159. * Clear the current material and set it to a default state for particle
  102160. */
  102161. setToDefaultParticle(): void;
  102162. /**
  102163. * Loads the current Node Material from a url pointing to a file save by the Node Material Editor
  102164. * @param url defines the url to load from
  102165. * @returns a promise that will fullfil when the material is fully loaded
  102166. */
  102167. loadAsync(url: string): Promise<void>;
  102168. private _gatherBlocks;
  102169. /**
  102170. * Generate a string containing the code declaration required to create an equivalent of this material
  102171. * @returns a string
  102172. */
  102173. generateCode(): string;
  102174. /**
  102175. * Serializes this material in a JSON representation
  102176. * @returns the serialized material object
  102177. */
  102178. serialize(selectedBlocks?: NodeMaterialBlock[]): any;
  102179. private _restoreConnections;
  102180. /**
  102181. * Clear the current graph and load a new one from a serialization object
  102182. * @param source defines the JSON representation of the material
  102183. * @param rootUrl defines the root URL to use to load textures and relative dependencies
  102184. * @param merge defines whether or not the source must be merged or replace the current content
  102185. */
  102186. loadFromSerialization(source: any, rootUrl?: string, merge?: boolean): void;
  102187. /**
  102188. * Makes a duplicate of the current material.
  102189. * @param name - name to use for the new material.
  102190. */
  102191. clone(name: string): NodeMaterial;
  102192. /**
  102193. * Creates a node material from parsed material data
  102194. * @param source defines the JSON representation of the material
  102195. * @param scene defines the hosting scene
  102196. * @param rootUrl defines the root URL to use to load textures and relative dependencies
  102197. * @returns a new node material
  102198. */
  102199. static Parse(source: any, scene: Scene, rootUrl?: string): NodeMaterial;
  102200. /**
  102201. * Creates a node material from a snippet saved in a remote file
  102202. * @param name defines the name of the material to create
  102203. * @param url defines the url to load from
  102204. * @param scene defines the hosting scene
  102205. * @returns a promise that will resolve to the new node material
  102206. */
  102207. static ParseFromFileAsync(name: string, url: string, scene: Scene): Promise<NodeMaterial>;
  102208. /**
  102209. * Creates a node material from a snippet saved by the node material editor
  102210. * @param snippetId defines the snippet to load
  102211. * @param scene defines the hosting scene
  102212. * @param rootUrl defines the root URL to use to load textures and relative dependencies
  102213. * @param nodeMaterial defines a node material to update (instead of creating a new one)
  102214. * @returns a promise that will resolve to the new node material
  102215. */
  102216. static ParseFromSnippetAsync(snippetId: string, scene: Scene, rootUrl?: string, nodeMaterial?: NodeMaterial): Promise<NodeMaterial>;
  102217. /**
  102218. * Creates a new node material set to default basic configuration
  102219. * @param name defines the name of the material
  102220. * @param scene defines the hosting scene
  102221. * @returns a new NodeMaterial
  102222. */
  102223. static CreateDefault(name: string, scene?: Scene): NodeMaterial;
  102224. }
  102225. }
  102226. declare module BABYLON {
  102227. /**
  102228. * Size options for a post process
  102229. */
  102230. export type PostProcessOptions = {
  102231. width: number;
  102232. height: number;
  102233. };
  102234. /**
  102235. * PostProcess can be used to apply a shader to a texture after it has been rendered
  102236. * See https://doc.babylonjs.com/how_to/how_to_use_postprocesses
  102237. */
  102238. export class PostProcess {
  102239. /**
  102240. * Gets or sets the unique id of the post process
  102241. */
  102242. uniqueId: number;
  102243. /** Name of the PostProcess. */
  102244. name: string;
  102245. /**
  102246. * Width of the texture to apply the post process on
  102247. */
  102248. width: number;
  102249. /**
  102250. * Height of the texture to apply the post process on
  102251. */
  102252. height: number;
  102253. /**
  102254. * Gets the node material used to create this postprocess (null if the postprocess was manually created)
  102255. */
  102256. nodeMaterialSource: Nullable<NodeMaterial>;
  102257. /**
  102258. * Internal, reference to the location where this postprocess was output to. (Typically the texture on the next postprocess in the chain)
  102259. * @hidden
  102260. */
  102261. _outputTexture: Nullable<InternalTexture>;
  102262. /**
  102263. * Sampling mode used by the shader
  102264. * See https://doc.babylonjs.com/classes/3.1/texture
  102265. */
  102266. renderTargetSamplingMode: number;
  102267. /**
  102268. * Clear color to use when screen clearing
  102269. */
  102270. clearColor: Color4;
  102271. /**
  102272. * If the buffer needs to be cleared before applying the post process. (default: true)
  102273. * Should be set to false if shader will overwrite all previous pixels.
  102274. */
  102275. autoClear: boolean;
  102276. /**
  102277. * Type of alpha mode to use when performing the post process (default: Engine.ALPHA_DISABLE)
  102278. */
  102279. alphaMode: number;
  102280. /**
  102281. * Sets the setAlphaBlendConstants of the babylon engine
  102282. */
  102283. alphaConstants: Color4;
  102284. /**
  102285. * Animations to be used for the post processing
  102286. */
  102287. animations: Animation[];
  102288. /**
  102289. * Enable Pixel Perfect mode where texture is not scaled to be power of 2.
  102290. * Can only be used on a single postprocess or on the last one of a chain. (default: false)
  102291. */
  102292. enablePixelPerfectMode: boolean;
  102293. /**
  102294. * Force the postprocess to be applied without taking in account viewport
  102295. */
  102296. forceFullscreenViewport: boolean;
  102297. /**
  102298. * List of inspectable custom properties (used by the Inspector)
  102299. * @see https://doc.babylonjs.com/how_to/debug_layer#extensibility
  102300. */
  102301. inspectableCustomProperties: IInspectable[];
  102302. /**
  102303. * Scale mode for the post process (default: Engine.SCALEMODE_FLOOR)
  102304. *
  102305. * | Value | Type | Description |
  102306. * | ----- | ----------------------------------- | ----------- |
  102307. * | 1 | SCALEMODE_FLOOR | [engine.scalemode_floor](https://doc.babylonjs.com/api/classes/babylon.engine#scalemode_floor) |
  102308. * | 2 | SCALEMODE_NEAREST | [engine.scalemode_nearest](https://doc.babylonjs.com/api/classes/babylon.engine#scalemode_nearest) |
  102309. * | 3 | SCALEMODE_CEILING | [engine.scalemode_ceiling](https://doc.babylonjs.com/api/classes/babylon.engine#scalemode_ceiling) |
  102310. *
  102311. */
  102312. scaleMode: number;
  102313. /**
  102314. * Force textures to be a power of two (default: false)
  102315. */
  102316. alwaysForcePOT: boolean;
  102317. private _samples;
  102318. /**
  102319. * Number of sample textures (default: 1)
  102320. */
  102321. get samples(): number;
  102322. set samples(n: number);
  102323. /**
  102324. * Modify the scale of the post process to be the same as the viewport (default: false)
  102325. */
  102326. adaptScaleToCurrentViewport: boolean;
  102327. private _camera;
  102328. protected _scene: Scene;
  102329. private _engine;
  102330. private _options;
  102331. private _reusable;
  102332. private _textureType;
  102333. private _textureFormat;
  102334. /**
  102335. * Smart array of input and output textures for the post process.
  102336. * @hidden
  102337. */
  102338. _textures: SmartArray<InternalTexture>;
  102339. /**
  102340. * The index in _textures that corresponds to the output texture.
  102341. * @hidden
  102342. */
  102343. _currentRenderTextureInd: number;
  102344. private _effect;
  102345. private _samplers;
  102346. private _fragmentUrl;
  102347. private _vertexUrl;
  102348. private _parameters;
  102349. private _scaleRatio;
  102350. protected _indexParameters: any;
  102351. private _shareOutputWithPostProcess;
  102352. private _texelSize;
  102353. private _forcedOutputTexture;
  102354. /**
  102355. * Returns the fragment url or shader name used in the post process.
  102356. * @returns the fragment url or name in the shader store.
  102357. */
  102358. getEffectName(): string;
  102359. /**
  102360. * An event triggered when the postprocess is activated.
  102361. */
  102362. onActivateObservable: Observable<Camera>;
  102363. private _onActivateObserver;
  102364. /**
  102365. * A function that is added to the onActivateObservable
  102366. */
  102367. set onActivate(callback: Nullable<(camera: Camera) => void>);
  102368. /**
  102369. * An event triggered when the postprocess changes its size.
  102370. */
  102371. onSizeChangedObservable: Observable<PostProcess>;
  102372. private _onSizeChangedObserver;
  102373. /**
  102374. * A function that is added to the onSizeChangedObservable
  102375. */
  102376. set onSizeChanged(callback: (postProcess: PostProcess) => void);
  102377. /**
  102378. * An event triggered when the postprocess applies its effect.
  102379. */
  102380. onApplyObservable: Observable<Effect>;
  102381. private _onApplyObserver;
  102382. /**
  102383. * A function that is added to the onApplyObservable
  102384. */
  102385. set onApply(callback: (effect: Effect) => void);
  102386. /**
  102387. * An event triggered before rendering the postprocess
  102388. */
  102389. onBeforeRenderObservable: Observable<Effect>;
  102390. private _onBeforeRenderObserver;
  102391. /**
  102392. * A function that is added to the onBeforeRenderObservable
  102393. */
  102394. set onBeforeRender(callback: (effect: Effect) => void);
  102395. /**
  102396. * An event triggered after rendering the postprocess
  102397. */
  102398. onAfterRenderObservable: Observable<Effect>;
  102399. private _onAfterRenderObserver;
  102400. /**
  102401. * A function that is added to the onAfterRenderObservable
  102402. */
  102403. set onAfterRender(callback: (efect: Effect) => void);
  102404. /**
  102405. * 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
  102406. * render it's output into this texture and this texture will be used as textureSampler in the fragment shader of this post process.
  102407. */
  102408. get inputTexture(): InternalTexture;
  102409. set inputTexture(value: InternalTexture);
  102410. /**
  102411. * Since inputTexture should always be defined, if we previously manually set `inputTexture`,
  102412. * the only way to unset it is to use this function to restore its internal state
  102413. */
  102414. restoreDefaultInputTexture(): void;
  102415. /**
  102416. * Gets the camera which post process is applied to.
  102417. * @returns The camera the post process is applied to.
  102418. */
  102419. getCamera(): Camera;
  102420. /**
  102421. * Gets the texel size of the postprocess.
  102422. * See https://en.wikipedia.org/wiki/Texel_(graphics)
  102423. */
  102424. get texelSize(): Vector2;
  102425. /**
  102426. * Creates a new instance PostProcess
  102427. * @param name The name of the PostProcess.
  102428. * @param fragmentUrl The url of the fragment shader to be used.
  102429. * @param parameters Array of the names of uniform non-sampler2D variables that will be passed to the shader.
  102430. * @param samplers Array of the names of uniform sampler2D variables that will be passed to the shader.
  102431. * @param options The required width/height ratio to downsize to before computing the render pass. (Use 1.0 for full size)
  102432. * @param camera The camera to apply the render pass to.
  102433. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  102434. * @param engine The engine which the post process will be applied. (default: current engine)
  102435. * @param reusable If the post process can be reused on the same frame. (default: false)
  102436. * @param defines String of defines that will be set when running the fragment shader. (default: null)
  102437. * @param textureType Type of textures used when performing the post process. (default: 0)
  102438. * @param vertexUrl The url of the vertex shader to be used. (default: "postprocess")
  102439. * @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
  102440. * @param blockCompilation If the shader should not be compiled imediatly. (default: false)
  102441. * @param textureFormat Format of textures used when performing the post process. (default: TEXTUREFORMAT_RGBA)
  102442. */
  102443. 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);
  102444. /**
  102445. * Gets a string identifying the name of the class
  102446. * @returns "PostProcess" string
  102447. */
  102448. getClassName(): string;
  102449. /**
  102450. * Gets the engine which this post process belongs to.
  102451. * @returns The engine the post process was enabled with.
  102452. */
  102453. getEngine(): Engine;
  102454. /**
  102455. * The effect that is created when initializing the post process.
  102456. * @returns The created effect corresponding the the postprocess.
  102457. */
  102458. getEffect(): Effect;
  102459. /**
  102460. * To avoid multiple redundant textures for multiple post process, the output the output texture for this post process can be shared with another.
  102461. * @param postProcess The post process to share the output with.
  102462. * @returns This post process.
  102463. */
  102464. shareOutputWith(postProcess: PostProcess): PostProcess;
  102465. /**
  102466. * Reverses the effect of calling shareOutputWith and returns the post process back to its original state.
  102467. * This should be called if the post process that shares output with this post process is disabled/disposed.
  102468. */
  102469. useOwnOutput(): void;
  102470. /**
  102471. * Updates the effect with the current post process compile time values and recompiles the shader.
  102472. * @param defines Define statements that should be added at the beginning of the shader. (default: null)
  102473. * @param uniforms Set of uniform variables that will be passed to the shader. (default: null)
  102474. * @param samplers Set of Texture2D variables that will be passed to the shader. (default: null)
  102475. * @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
  102476. * @param onCompiled Called when the shader has been compiled.
  102477. * @param onError Called if there is an error when compiling a shader.
  102478. * @param vertexUrl The url of the vertex shader to be used (default: the one given at construction time)
  102479. * @param fragmentUrl The url of the fragment shader to be used (default: the one given at construction time)
  102480. */
  102481. 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;
  102482. /**
  102483. * The post process is reusable if it can be used multiple times within one frame.
  102484. * @returns If the post process is reusable
  102485. */
  102486. isReusable(): boolean;
  102487. /** invalidate frameBuffer to hint the postprocess to create a depth buffer */
  102488. markTextureDirty(): void;
  102489. /**
  102490. * Activates the post process by intializing the textures to be used when executed. Notifies onActivateObservable.
  102491. * 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.
  102492. * @param camera The camera that will be used in the post process. This camera will be used when calling onActivateObservable.
  102493. * @param sourceTexture The source texture to be inspected to get the width and height if not specified in the post process constructor. (default: null)
  102494. * @param forceDepthStencil If true, a depth and stencil buffer will be generated. (default: false)
  102495. * @returns The target texture that was bound to be written to.
  102496. */
  102497. activate(camera: Nullable<Camera>, sourceTexture?: Nullable<InternalTexture>, forceDepthStencil?: boolean): InternalTexture;
  102498. /**
  102499. * If the post process is supported.
  102500. */
  102501. get isSupported(): boolean;
  102502. /**
  102503. * The aspect ratio of the output texture.
  102504. */
  102505. get aspectRatio(): number;
  102506. /**
  102507. * Get a value indicating if the post-process is ready to be used
  102508. * @returns true if the post-process is ready (shader is compiled)
  102509. */
  102510. isReady(): boolean;
  102511. /**
  102512. * Binds all textures and uniforms to the shader, this will be run on every pass.
  102513. * @returns the effect corresponding to this post process. Null if not compiled or not ready.
  102514. */
  102515. apply(): Nullable<Effect>;
  102516. private _disposeTextures;
  102517. /**
  102518. * Disposes the post process.
  102519. * @param camera The camera to dispose the post process on.
  102520. */
  102521. dispose(camera?: Camera): void;
  102522. /**
  102523. * Serializes the particle system to a JSON object
  102524. * @returns the JSON object
  102525. */
  102526. serialize(): any;
  102527. /**
  102528. * Creates a material from parsed material data
  102529. * @param parsedPostProcess defines parsed post process data
  102530. * @param scene defines the hosting scene
  102531. * @param rootUrl defines the root URL to use to load textures
  102532. * @returns a new post process
  102533. */
  102534. static Parse(parsedPostProcess: any, scene: Scene, rootUrl: string): Nullable<PostProcess>;
  102535. }
  102536. }
  102537. declare module BABYLON {
  102538. /** @hidden */
  102539. export var kernelBlurVaryingDeclaration: {
  102540. name: string;
  102541. shader: string;
  102542. };
  102543. }
  102544. declare module BABYLON {
  102545. /** @hidden */
  102546. export var kernelBlurFragment: {
  102547. name: string;
  102548. shader: string;
  102549. };
  102550. }
  102551. declare module BABYLON {
  102552. /** @hidden */
  102553. export var kernelBlurFragment2: {
  102554. name: string;
  102555. shader: string;
  102556. };
  102557. }
  102558. declare module BABYLON {
  102559. /** @hidden */
  102560. export var kernelBlurPixelShader: {
  102561. name: string;
  102562. shader: string;
  102563. };
  102564. }
  102565. declare module BABYLON {
  102566. /** @hidden */
  102567. export var kernelBlurVertex: {
  102568. name: string;
  102569. shader: string;
  102570. };
  102571. }
  102572. declare module BABYLON {
  102573. /** @hidden */
  102574. export var kernelBlurVertexShader: {
  102575. name: string;
  102576. shader: string;
  102577. };
  102578. }
  102579. declare module BABYLON {
  102580. /**
  102581. * The Blur Post Process which blurs an image based on a kernel and direction.
  102582. * Can be used twice in x and y directions to perform a guassian blur in two passes.
  102583. */
  102584. export class BlurPostProcess extends PostProcess {
  102585. private blockCompilation;
  102586. protected _kernel: number;
  102587. protected _idealKernel: number;
  102588. protected _packedFloat: boolean;
  102589. private _staticDefines;
  102590. /** The direction in which to blur the image. */
  102591. direction: Vector2;
  102592. /**
  102593. * Sets the length in pixels of the blur sample region
  102594. */
  102595. set kernel(v: number);
  102596. /**
  102597. * Gets the length in pixels of the blur sample region
  102598. */
  102599. get kernel(): number;
  102600. /**
  102601. * Sets wether or not the blur needs to unpack/repack floats
  102602. */
  102603. set packedFloat(v: boolean);
  102604. /**
  102605. * Gets wether or not the blur is unpacking/repacking floats
  102606. */
  102607. get packedFloat(): boolean;
  102608. /**
  102609. * Gets a string identifying the name of the class
  102610. * @returns "BlurPostProcess" string
  102611. */
  102612. getClassName(): string;
  102613. /**
  102614. * Creates a new instance BlurPostProcess
  102615. * @param name The name of the effect.
  102616. * @param direction The direction in which to blur the image.
  102617. * @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.
  102618. * @param options The required width/height ratio to downsize to before computing the render pass. (Use 1.0 for full size)
  102619. * @param camera The camera to apply the render pass to.
  102620. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  102621. * @param engine The engine which the post process will be applied. (default: current engine)
  102622. * @param reusable If the post process can be reused on the same frame. (default: false)
  102623. * @param textureType Type of textures used when performing the post process. (default: 0)
  102624. * @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)
  102625. */
  102626. 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);
  102627. /**
  102628. * Updates the effect with the current post process compile time values and recompiles the shader.
  102629. * @param defines Define statements that should be added at the beginning of the shader. (default: null)
  102630. * @param uniforms Set of uniform variables that will be passed to the shader. (default: null)
  102631. * @param samplers Set of Texture2D variables that will be passed to the shader. (default: null)
  102632. * @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
  102633. * @param onCompiled Called when the shader has been compiled.
  102634. * @param onError Called if there is an error when compiling a shader.
  102635. */
  102636. updateEffect(defines?: Nullable<string>, uniforms?: Nullable<string[]>, samplers?: Nullable<string[]>, indexParameters?: any, onCompiled?: (effect: Effect) => void, onError?: (effect: Effect, errors: string) => void): void;
  102637. protected _updateParameters(onCompiled?: (effect: Effect) => void, onError?: (effect: Effect, errors: string) => void): void;
  102638. /**
  102639. * Best kernels are odd numbers that when divided by 2, their integer part is even, so 5, 9 or 13.
  102640. * Other odd kernels optimize correctly but require proportionally more samples, even kernels are
  102641. * possible but will produce minor visual artifacts. Since each new kernel requires a new shader we
  102642. * want to minimize kernel changes, having gaps between physical kernels is helpful in that regard.
  102643. * The gaps between physical kernels are compensated for in the weighting of the samples
  102644. * @param idealKernel Ideal blur kernel.
  102645. * @return Nearest best kernel.
  102646. */
  102647. protected _nearestBestKernel(idealKernel: number): number;
  102648. /**
  102649. * Calculates the value of a Gaussian distribution with sigma 3 at a given point.
  102650. * @param x The point on the Gaussian distribution to sample.
  102651. * @return the value of the Gaussian function at x.
  102652. */
  102653. protected _gaussianWeight(x: number): number;
  102654. /**
  102655. * Generates a string that can be used as a floating point number in GLSL.
  102656. * @param x Value to print.
  102657. * @param decimalFigures Number of decimal places to print the number to (excluding trailing 0s).
  102658. * @return GLSL float string.
  102659. */
  102660. protected _glslFloat(x: number, decimalFigures?: number): string;
  102661. /** @hidden */
  102662. static _Parse(parsedPostProcess: any, targetCamera: Camera, scene: Scene, rootUrl: string): Nullable<BlurPostProcess>;
  102663. }
  102664. }
  102665. declare module BABYLON {
  102666. /**
  102667. * Mirror texture can be used to simulate the view from a mirror in a scene.
  102668. * It will dynamically be rendered every frame to adapt to the camera point of view.
  102669. * You can then easily use it as a reflectionTexture on a flat surface.
  102670. * In case the surface is not a plane, please consider relying on reflection probes.
  102671. * @see https://doc.babylonjs.com/how_to/reflect#mirrors
  102672. */
  102673. export class MirrorTexture extends RenderTargetTexture {
  102674. private scene;
  102675. /**
  102676. * Define the reflection plane we want to use. The mirrorPlane is usually set to the constructed reflector.
  102677. * 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.
  102678. * @see https://doc.babylonjs.com/how_to/reflect#mirrors
  102679. */
  102680. mirrorPlane: Plane;
  102681. /**
  102682. * Define the blur ratio used to blur the reflection if needed.
  102683. */
  102684. set blurRatio(value: number);
  102685. get blurRatio(): number;
  102686. /**
  102687. * Define the adaptive blur kernel used to blur the reflection if needed.
  102688. * This will autocompute the closest best match for the `blurKernel`
  102689. */
  102690. set adaptiveBlurKernel(value: number);
  102691. /**
  102692. * Define the blur kernel used to blur the reflection if needed.
  102693. * Please consider using `adaptiveBlurKernel` as it could find the closest best value for you.
  102694. */
  102695. set blurKernel(value: number);
  102696. /**
  102697. * Define the blur kernel on the X Axis used to blur the reflection if needed.
  102698. * Please consider using `adaptiveBlurKernel` as it could find the closest best value for you.
  102699. */
  102700. set blurKernelX(value: number);
  102701. get blurKernelX(): number;
  102702. /**
  102703. * Define the blur kernel on the Y Axis used to blur the reflection if needed.
  102704. * Please consider using `adaptiveBlurKernel` as it could find the closest best value for you.
  102705. */
  102706. set blurKernelY(value: number);
  102707. get blurKernelY(): number;
  102708. private _autoComputeBlurKernel;
  102709. protected _onRatioRescale(): void;
  102710. private _updateGammaSpace;
  102711. private _imageProcessingConfigChangeObserver;
  102712. private _transformMatrix;
  102713. private _mirrorMatrix;
  102714. private _savedViewMatrix;
  102715. private _blurX;
  102716. private _blurY;
  102717. private _adaptiveBlurKernel;
  102718. private _blurKernelX;
  102719. private _blurKernelY;
  102720. private _blurRatio;
  102721. /**
  102722. * Instantiates a Mirror Texture.
  102723. * Mirror texture can be used to simulate the view from a mirror in a scene.
  102724. * It will dynamically be rendered every frame to adapt to the camera point of view.
  102725. * You can then easily use it as a reflectionTexture on a flat surface.
  102726. * In case the surface is not a plane, please consider relying on reflection probes.
  102727. * @see https://doc.babylonjs.com/how_to/reflect#mirrors
  102728. * @param name
  102729. * @param size
  102730. * @param scene
  102731. * @param generateMipMaps
  102732. * @param type
  102733. * @param samplingMode
  102734. * @param generateDepthBuffer
  102735. */
  102736. constructor(name: string, size: number | {
  102737. width: number;
  102738. height: number;
  102739. } | {
  102740. ratio: number;
  102741. }, scene: Scene, generateMipMaps?: boolean, type?: number, samplingMode?: number, generateDepthBuffer?: boolean);
  102742. private _preparePostProcesses;
  102743. /**
  102744. * Clone the mirror texture.
  102745. * @returns the cloned texture
  102746. */
  102747. clone(): MirrorTexture;
  102748. /**
  102749. * Serialize the texture to a JSON representation you could use in Parse later on
  102750. * @returns the serialized JSON representation
  102751. */
  102752. serialize(): any;
  102753. /**
  102754. * Dispose the texture and release its associated resources.
  102755. */
  102756. dispose(): void;
  102757. }
  102758. }
  102759. declare module BABYLON {
  102760. /**
  102761. * This represents a texture in babylon. It can be easily loaded from a network, base64 or html input.
  102762. * @see https://doc.babylonjs.com/babylon101/materials#texture
  102763. */
  102764. export class Texture extends BaseTexture {
  102765. /**
  102766. * Gets or sets a general boolean used to indicate that textures containing direct data (buffers) must be saved as part of the serialization process
  102767. */
  102768. static SerializeBuffers: boolean;
  102769. /** @hidden */
  102770. static _CubeTextureParser: (jsonTexture: any, scene: Scene, rootUrl: string) => CubeTexture;
  102771. /** @hidden */
  102772. static _CreateMirror: (name: string, renderTargetSize: number, scene: Scene, generateMipMaps: boolean) => MirrorTexture;
  102773. /** @hidden */
  102774. static _CreateRenderTargetTexture: (name: string, renderTargetSize: number, scene: Scene, generateMipMaps: boolean) => RenderTargetTexture;
  102775. /** nearest is mag = nearest and min = nearest and mip = linear */
  102776. static readonly NEAREST_SAMPLINGMODE: number;
  102777. /** nearest is mag = nearest and min = nearest and mip = linear */
  102778. static readonly NEAREST_NEAREST_MIPLINEAR: number;
  102779. /** Bilinear is mag = linear and min = linear and mip = nearest */
  102780. static readonly BILINEAR_SAMPLINGMODE: number;
  102781. /** Bilinear is mag = linear and min = linear and mip = nearest */
  102782. static readonly LINEAR_LINEAR_MIPNEAREST: number;
  102783. /** Trilinear is mag = linear and min = linear and mip = linear */
  102784. static readonly TRILINEAR_SAMPLINGMODE: number;
  102785. /** Trilinear is mag = linear and min = linear and mip = linear */
  102786. static readonly LINEAR_LINEAR_MIPLINEAR: number;
  102787. /** mag = nearest and min = nearest and mip = nearest */
  102788. static readonly NEAREST_NEAREST_MIPNEAREST: number;
  102789. /** mag = nearest and min = linear and mip = nearest */
  102790. static readonly NEAREST_LINEAR_MIPNEAREST: number;
  102791. /** mag = nearest and min = linear and mip = linear */
  102792. static readonly NEAREST_LINEAR_MIPLINEAR: number;
  102793. /** mag = nearest and min = linear and mip = none */
  102794. static readonly NEAREST_LINEAR: number;
  102795. /** mag = nearest and min = nearest and mip = none */
  102796. static readonly NEAREST_NEAREST: number;
  102797. /** mag = linear and min = nearest and mip = nearest */
  102798. static readonly LINEAR_NEAREST_MIPNEAREST: number;
  102799. /** mag = linear and min = nearest and mip = linear */
  102800. static readonly LINEAR_NEAREST_MIPLINEAR: number;
  102801. /** mag = linear and min = linear and mip = none */
  102802. static readonly LINEAR_LINEAR: number;
  102803. /** mag = linear and min = nearest and mip = none */
  102804. static readonly LINEAR_NEAREST: number;
  102805. /** Explicit coordinates mode */
  102806. static readonly EXPLICIT_MODE: number;
  102807. /** Spherical coordinates mode */
  102808. static readonly SPHERICAL_MODE: number;
  102809. /** Planar coordinates mode */
  102810. static readonly PLANAR_MODE: number;
  102811. /** Cubic coordinates mode */
  102812. static readonly CUBIC_MODE: number;
  102813. /** Projection coordinates mode */
  102814. static readonly PROJECTION_MODE: number;
  102815. /** Inverse Cubic coordinates mode */
  102816. static readonly SKYBOX_MODE: number;
  102817. /** Inverse Cubic coordinates mode */
  102818. static readonly INVCUBIC_MODE: number;
  102819. /** Equirectangular coordinates mode */
  102820. static readonly EQUIRECTANGULAR_MODE: number;
  102821. /** Equirectangular Fixed coordinates mode */
  102822. static readonly FIXED_EQUIRECTANGULAR_MODE: number;
  102823. /** Equirectangular Fixed Mirrored coordinates mode */
  102824. static readonly FIXED_EQUIRECTANGULAR_MIRRORED_MODE: number;
  102825. /** Texture is not repeating outside of 0..1 UVs */
  102826. static readonly CLAMP_ADDRESSMODE: number;
  102827. /** Texture is repeating outside of 0..1 UVs */
  102828. static readonly WRAP_ADDRESSMODE: number;
  102829. /** Texture is repeating and mirrored */
  102830. static readonly MIRROR_ADDRESSMODE: number;
  102831. /**
  102832. * 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
  102833. */
  102834. static UseSerializedUrlIfAny: boolean;
  102835. /**
  102836. * Define the url of the texture.
  102837. */
  102838. url: Nullable<string>;
  102839. /**
  102840. * Define an offset on the texture to offset the u coordinates of the UVs
  102841. * @see https://doc.babylonjs.com/how_to/more_materials#offsetting
  102842. */
  102843. uOffset: number;
  102844. /**
  102845. * Define an offset on the texture to offset the v coordinates of the UVs
  102846. * @see https://doc.babylonjs.com/how_to/more_materials#offsetting
  102847. */
  102848. vOffset: number;
  102849. /**
  102850. * Define an offset on the texture to scale the u coordinates of the UVs
  102851. * @see https://doc.babylonjs.com/how_to/more_materials#tiling
  102852. */
  102853. uScale: number;
  102854. /**
  102855. * Define an offset on the texture to scale the v coordinates of the UVs
  102856. * @see https://doc.babylonjs.com/how_to/more_materials#tiling
  102857. */
  102858. vScale: number;
  102859. /**
  102860. * Define an offset on the texture to rotate around the u coordinates of the UVs
  102861. * @see https://doc.babylonjs.com/how_to/more_materials
  102862. */
  102863. uAng: number;
  102864. /**
  102865. * Define an offset on the texture to rotate around the v coordinates of the UVs
  102866. * @see https://doc.babylonjs.com/how_to/more_materials
  102867. */
  102868. vAng: number;
  102869. /**
  102870. * Define an offset on the texture to rotate around the w coordinates of the UVs (in case of 3d texture)
  102871. * @see https://doc.babylonjs.com/how_to/more_materials
  102872. */
  102873. wAng: number;
  102874. /**
  102875. * Defines the center of rotation (U)
  102876. */
  102877. uRotationCenter: number;
  102878. /**
  102879. * Defines the center of rotation (V)
  102880. */
  102881. vRotationCenter: number;
  102882. /**
  102883. * Defines the center of rotation (W)
  102884. */
  102885. wRotationCenter: number;
  102886. /**
  102887. * Are mip maps generated for this texture or not.
  102888. */
  102889. get noMipmap(): boolean;
  102890. /**
  102891. * List of inspectable custom properties (used by the Inspector)
  102892. * @see https://doc.babylonjs.com/how_to/debug_layer#extensibility
  102893. */
  102894. inspectableCustomProperties: Nullable<IInspectable[]>;
  102895. private _noMipmap;
  102896. /** @hidden */
  102897. _invertY: boolean;
  102898. private _rowGenerationMatrix;
  102899. private _cachedTextureMatrix;
  102900. private _projectionModeMatrix;
  102901. private _t0;
  102902. private _t1;
  102903. private _t2;
  102904. private _cachedUOffset;
  102905. private _cachedVOffset;
  102906. private _cachedUScale;
  102907. private _cachedVScale;
  102908. private _cachedUAng;
  102909. private _cachedVAng;
  102910. private _cachedWAng;
  102911. private _cachedProjectionMatrixId;
  102912. private _cachedCoordinatesMode;
  102913. /** @hidden */
  102914. protected _initialSamplingMode: number;
  102915. /** @hidden */
  102916. _buffer: Nullable<string | ArrayBuffer | ArrayBufferView | HTMLImageElement | Blob | ImageBitmap>;
  102917. private _deleteBuffer;
  102918. protected _format: Nullable<number>;
  102919. private _delayedOnLoad;
  102920. private _delayedOnError;
  102921. private _mimeType?;
  102922. /** Returns the texture mime type if it was defined by a loader (undefined else) */
  102923. get mimeType(): string | undefined;
  102924. /**
  102925. * Observable triggered once the texture has been loaded.
  102926. */
  102927. onLoadObservable: Observable<Texture>;
  102928. protected _isBlocking: boolean;
  102929. /**
  102930. * Is the texture preventing material to render while loading.
  102931. * If false, a default texture will be used instead of the loading one during the preparation step.
  102932. */
  102933. set isBlocking(value: boolean);
  102934. get isBlocking(): boolean;
  102935. /**
  102936. * Get the current sampling mode associated with the texture.
  102937. */
  102938. get samplingMode(): number;
  102939. /**
  102940. * Gets a boolean indicating if the texture needs to be inverted on the y axis during loading
  102941. */
  102942. get invertY(): boolean;
  102943. /**
  102944. * Instantiates a new texture.
  102945. * This represents a texture in babylon. It can be easily loaded from a network, base64 or html input.
  102946. * @see https://doc.babylonjs.com/babylon101/materials#texture
  102947. * @param url defines the url of the picture to load as a texture
  102948. * @param sceneOrEngine defines the scene or engine the texture will belong to
  102949. * @param noMipmap defines if the texture will require mip maps or not
  102950. * @param invertY defines if the texture needs to be inverted on the y axis during loading
  102951. * @param samplingMode defines the sampling mode we want for the texture while fectching from it (Texture.NEAREST_SAMPLINGMODE...)
  102952. * @param onLoad defines a callback triggered when the texture has been loaded
  102953. * @param onError defines a callback triggered when an error occurred during the loading session
  102954. * @param buffer defines the buffer to load the texture from in case the texture is loaded from a buffer representation
  102955. * @param deleteBuffer defines if the buffer we are loading the texture from should be deleted after load
  102956. * @param format defines the format of the texture we are trying to load (Engine.TEXTUREFORMAT_RGBA...)
  102957. * @param mimeType defines an optional mime type information
  102958. */
  102959. 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);
  102960. /**
  102961. * Update the url (and optional buffer) of this texture if url was null during construction.
  102962. * @param url the url of the texture
  102963. * @param buffer the buffer of the texture (defaults to null)
  102964. * @param onLoad callback called when the texture is loaded (defaults to null)
  102965. */
  102966. updateURL(url: string, buffer?: Nullable<string | ArrayBuffer | ArrayBufferView | HTMLImageElement | Blob>, onLoad?: () => void): void;
  102967. /**
  102968. * Finish the loading sequence of a texture flagged as delayed load.
  102969. * @hidden
  102970. */
  102971. delayLoad(): void;
  102972. private _prepareRowForTextureGeneration;
  102973. /**
  102974. * Get the current texture matrix which includes the requested offsetting, tiling and rotation components.
  102975. * @returns the transform matrix of the texture.
  102976. */
  102977. getTextureMatrix(uBase?: number): Matrix;
  102978. /**
  102979. * Get the current matrix used to apply reflection. This is useful to rotate an environment texture for instance.
  102980. * @returns The reflection texture transform
  102981. */
  102982. getReflectionTextureMatrix(): Matrix;
  102983. /**
  102984. * Clones the texture.
  102985. * @returns the cloned texture
  102986. */
  102987. clone(): Texture;
  102988. /**
  102989. * Serialize the texture to a JSON representation we can easily use in the resepective Parse function.
  102990. * @returns The JSON representation of the texture
  102991. */
  102992. serialize(): any;
  102993. /**
  102994. * Get the current class name of the texture useful for serialization or dynamic coding.
  102995. * @returns "Texture"
  102996. */
  102997. getClassName(): string;
  102998. /**
  102999. * Dispose the texture and release its associated resources.
  103000. */
  103001. dispose(): void;
  103002. /**
  103003. * Parse the JSON representation of a texture in order to recreate the texture in the given scene.
  103004. * @param parsedTexture Define the JSON representation of the texture
  103005. * @param scene Define the scene the parsed texture should be instantiated in
  103006. * @param rootUrl Define the root url of the parsing sequence in the case of relative dependencies
  103007. * @returns The parsed texture if successful
  103008. */
  103009. static Parse(parsedTexture: any, scene: Scene, rootUrl: string): Nullable<BaseTexture>;
  103010. /**
  103011. * Creates a texture from its base 64 representation.
  103012. * @param data Define the base64 payload without the data: prefix
  103013. * @param name Define the name of the texture in the scene useful fo caching purpose for instance
  103014. * @param scene Define the scene the texture should belong to
  103015. * @param noMipmap Forces the texture to not create mip map information if true
  103016. * @param invertY define if the texture needs to be inverted on the y axis during loading
  103017. * @param samplingMode define the sampling mode we want for the texture while fectching from it (Texture.NEAREST_SAMPLINGMODE...)
  103018. * @param onLoad define a callback triggered when the texture has been loaded
  103019. * @param onError define a callback triggered when an error occurred during the loading session
  103020. * @param format define the format of the texture we are trying to load (Engine.TEXTUREFORMAT_RGBA...)
  103021. * @returns the created texture
  103022. */
  103023. static CreateFromBase64String(data: string, name: string, scene: Scene, noMipmap?: boolean, invertY?: boolean, samplingMode?: number, onLoad?: Nullable<() => void>, onError?: Nullable<() => void>, format?: number): Texture;
  103024. /**
  103025. * Creates a texture from its data: representation. (data: will be added in case only the payload has been passed in)
  103026. * @param data Define the base64 payload without the data: prefix
  103027. * @param name Define the name of the texture in the scene useful fo caching purpose for instance
  103028. * @param buffer define the buffer to load the texture from in case the texture is loaded from a buffer representation
  103029. * @param scene Define the scene the texture should belong to
  103030. * @param deleteBuffer define if the buffer we are loading the texture from should be deleted after load
  103031. * @param noMipmap Forces the texture to not create mip map information if true
  103032. * @param invertY define if the texture needs to be inverted on the y axis during loading
  103033. * @param samplingMode define the sampling mode we want for the texture while fectching from it (Texture.NEAREST_SAMPLINGMODE...)
  103034. * @param onLoad define a callback triggered when the texture has been loaded
  103035. * @param onError define a callback triggered when an error occurred during the loading session
  103036. * @param format define the format of the texture we are trying to load (Engine.TEXTUREFORMAT_RGBA...)
  103037. * @returns the created texture
  103038. */
  103039. 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;
  103040. }
  103041. }
  103042. declare module BABYLON {
  103043. /**
  103044. * PostProcessManager is used to manage one or more post processes or post process pipelines
  103045. * See https://doc.babylonjs.com/how_to/how_to_use_postprocesses
  103046. */
  103047. export class PostProcessManager {
  103048. private _scene;
  103049. private _indexBuffer;
  103050. private _vertexBuffers;
  103051. /**
  103052. * Creates a new instance PostProcess
  103053. * @param scene The scene that the post process is associated with.
  103054. */
  103055. constructor(scene: Scene);
  103056. private _prepareBuffers;
  103057. private _buildIndexBuffer;
  103058. /**
  103059. * Rebuilds the vertex buffers of the manager.
  103060. * @hidden
  103061. */
  103062. _rebuild(): void;
  103063. /**
  103064. * Prepares a frame to be run through a post process.
  103065. * @param sourceTexture The input texture to the post procesess. (default: null)
  103066. * @param postProcesses An array of post processes to be run. (default: null)
  103067. * @returns True if the post processes were able to be run.
  103068. * @hidden
  103069. */
  103070. _prepareFrame(sourceTexture?: Nullable<InternalTexture>, postProcesses?: Nullable<PostProcess[]>): boolean;
  103071. /**
  103072. * Manually render a set of post processes to a texture.
  103073. * Please note, the frame buffer won't be unbound after the call in case you have more render to do.
  103074. * @param postProcesses An array of post processes to be run.
  103075. * @param targetTexture The target texture to render to.
  103076. * @param forceFullscreenViewport force gl.viewport to be full screen eg. 0,0,textureWidth,textureHeight
  103077. * @param faceIndex defines the face to render to if a cubemap is defined as the target
  103078. * @param lodLevel defines which lod of the texture to render to
  103079. * @param doNotBindFrambuffer If set to true, assumes that the framebuffer has been bound previously
  103080. */
  103081. directRender(postProcesses: PostProcess[], targetTexture?: Nullable<InternalTexture>, forceFullscreenViewport?: boolean, faceIndex?: number, lodLevel?: number, doNotBindFrambuffer?: boolean): void;
  103082. /**
  103083. * Finalize the result of the output of the postprocesses.
  103084. * @param doNotPresent If true the result will not be displayed to the screen.
  103085. * @param targetTexture The target texture to render to.
  103086. * @param faceIndex The index of the face to bind the target texture to.
  103087. * @param postProcesses The array of post processes to render.
  103088. * @param forceFullscreenViewport force gl.viewport to be full screen eg. 0,0,textureWidth,textureHeight (default: false)
  103089. * @hidden
  103090. */
  103091. _finalizeFrame(doNotPresent?: boolean, targetTexture?: InternalTexture, faceIndex?: number, postProcesses?: Array<PostProcess>, forceFullscreenViewport?: boolean): void;
  103092. /**
  103093. * Disposes of the post process manager.
  103094. */
  103095. dispose(): void;
  103096. }
  103097. }
  103098. declare module BABYLON {
  103099. /**
  103100. * This Helps creating a texture that will be created from a camera in your scene.
  103101. * It is basically a dynamic texture that could be used to create special effects for instance.
  103102. * Actually, It is the base of lot of effects in the framework like post process, shadows, effect layers and rendering pipelines...
  103103. */
  103104. export class RenderTargetTexture extends Texture {
  103105. /**
  103106. * The texture will only be rendered once which can be useful to improve performance if everything in your render is static for instance.
  103107. */
  103108. static readonly REFRESHRATE_RENDER_ONCE: number;
  103109. /**
  103110. * The texture will only be rendered rendered every frame and is recomended for dynamic contents.
  103111. */
  103112. static readonly REFRESHRATE_RENDER_ONEVERYFRAME: number;
  103113. /**
  103114. * The texture will be rendered every 2 frames which could be enough if your dynamic objects are not
  103115. * the central point of your effect and can save a lot of performances.
  103116. */
  103117. static readonly REFRESHRATE_RENDER_ONEVERYTWOFRAMES: number;
  103118. /**
  103119. * Use this predicate to dynamically define the list of mesh you want to render.
  103120. * If set, the renderList property will be overwritten.
  103121. */
  103122. renderListPredicate: (AbstractMesh: AbstractMesh) => boolean;
  103123. private _renderList;
  103124. /**
  103125. * Use this list to define the list of mesh you want to render.
  103126. */
  103127. get renderList(): Nullable<Array<AbstractMesh>>;
  103128. set renderList(value: Nullable<Array<AbstractMesh>>);
  103129. /**
  103130. * Use this function to overload the renderList array at rendering time.
  103131. * Return null to render with the curent renderList, else return the list of meshes to use for rendering.
  103132. * For 2DArray RTT, layerOrFace is the index of the layer that is going to be rendered, else it is the faceIndex of
  103133. * the cube (if the RTT is a cube, else layerOrFace=0).
  103134. * The renderList passed to the function is the current render list (the one that will be used if the function returns null).
  103135. * The length of this list is passed through renderListLength: don't use renderList.length directly because the array can
  103136. * hold dummy elements!
  103137. */
  103138. getCustomRenderList: (layerOrFace: number, renderList: Nullable<Immutable<Array<AbstractMesh>>>, renderListLength: number) => Nullable<Array<AbstractMesh>>;
  103139. private _hookArray;
  103140. /**
  103141. * Define if particles should be rendered in your texture.
  103142. */
  103143. renderParticles: boolean;
  103144. /**
  103145. * Define if sprites should be rendered in your texture.
  103146. */
  103147. renderSprites: boolean;
  103148. /**
  103149. * Define the camera used to render the texture.
  103150. */
  103151. activeCamera: Nullable<Camera>;
  103152. /**
  103153. * Override the mesh isReady function with your own one.
  103154. */
  103155. customIsReadyFunction: (mesh: AbstractMesh, refreshRate: number) => boolean;
  103156. /**
  103157. * Override the render function of the texture with your own one.
  103158. */
  103159. customRenderFunction: (opaqueSubMeshes: SmartArray<SubMesh>, alphaTestSubMeshes: SmartArray<SubMesh>, transparentSubMeshes: SmartArray<SubMesh>, depthOnlySubMeshes: SmartArray<SubMesh>, beforeTransparents?: () => void) => void;
  103160. /**
  103161. * Define if camera post processes should be use while rendering the texture.
  103162. */
  103163. useCameraPostProcesses: boolean;
  103164. /**
  103165. * Define if the camera viewport should be respected while rendering the texture or if the render should be done to the entire texture.
  103166. */
  103167. ignoreCameraViewport: boolean;
  103168. private _postProcessManager;
  103169. private _postProcesses;
  103170. private _resizeObserver;
  103171. /**
  103172. * An event triggered when the texture is unbind.
  103173. */
  103174. onBeforeBindObservable: Observable<RenderTargetTexture>;
  103175. /**
  103176. * An event triggered when the texture is unbind.
  103177. */
  103178. onAfterUnbindObservable: Observable<RenderTargetTexture>;
  103179. private _onAfterUnbindObserver;
  103180. /**
  103181. * Set a after unbind callback in the texture.
  103182. * This has been kept for backward compatibility and use of onAfterUnbindObservable is recommended.
  103183. */
  103184. set onAfterUnbind(callback: () => void);
  103185. /**
  103186. * An event triggered before rendering the texture
  103187. */
  103188. onBeforeRenderObservable: Observable<number>;
  103189. private _onBeforeRenderObserver;
  103190. /**
  103191. * Set a before render callback in the texture.
  103192. * This has been kept for backward compatibility and use of onBeforeRenderObservable is recommended.
  103193. */
  103194. set onBeforeRender(callback: (faceIndex: number) => void);
  103195. /**
  103196. * An event triggered after rendering the texture
  103197. */
  103198. onAfterRenderObservable: Observable<number>;
  103199. private _onAfterRenderObserver;
  103200. /**
  103201. * Set a after render callback in the texture.
  103202. * This has been kept for backward compatibility and use of onAfterRenderObservable is recommended.
  103203. */
  103204. set onAfterRender(callback: (faceIndex: number) => void);
  103205. /**
  103206. * An event triggered after the texture clear
  103207. */
  103208. onClearObservable: Observable<Engine>;
  103209. private _onClearObserver;
  103210. /**
  103211. * Set a clear callback in the texture.
  103212. * This has been kept for backward compatibility and use of onClearObservable is recommended.
  103213. */
  103214. set onClear(callback: (Engine: Engine) => void);
  103215. /**
  103216. * An event triggered when the texture is resized.
  103217. */
  103218. onResizeObservable: Observable<RenderTargetTexture>;
  103219. /**
  103220. * Define the clear color of the Render Target if it should be different from the scene.
  103221. */
  103222. clearColor: Color4;
  103223. protected _size: number | {
  103224. width: number;
  103225. height: number;
  103226. layers?: number;
  103227. };
  103228. protected _initialSizeParameter: number | {
  103229. width: number;
  103230. height: number;
  103231. } | {
  103232. ratio: number;
  103233. };
  103234. protected _sizeRatio: Nullable<number>;
  103235. /** @hidden */
  103236. _generateMipMaps: boolean;
  103237. protected _renderingManager: RenderingManager;
  103238. /** @hidden */
  103239. _waitingRenderList?: string[];
  103240. protected _doNotChangeAspectRatio: boolean;
  103241. protected _currentRefreshId: number;
  103242. protected _refreshRate: number;
  103243. protected _textureMatrix: Matrix;
  103244. protected _samples: number;
  103245. protected _renderTargetOptions: RenderTargetCreationOptions;
  103246. /**
  103247. * Gets render target creation options that were used.
  103248. */
  103249. get renderTargetOptions(): RenderTargetCreationOptions;
  103250. protected _onRatioRescale(): void;
  103251. /**
  103252. * Gets or sets the center of the bounding box associated with the texture (when in cube mode)
  103253. * It must define where the camera used to render the texture is set
  103254. */
  103255. boundingBoxPosition: Vector3;
  103256. private _boundingBoxSize;
  103257. /**
  103258. * Gets or sets the size of the bounding box associated with the texture (when in cube mode)
  103259. * When defined, the cubemap will switch to local mode
  103260. * @see https://community.arm.com/graphics/b/blog/posts/reflections-based-on-local-cubemaps-in-unity
  103261. * @example https://www.babylonjs-playground.com/#RNASML
  103262. */
  103263. set boundingBoxSize(value: Vector3);
  103264. get boundingBoxSize(): Vector3;
  103265. /**
  103266. * In case the RTT has been created with a depth texture, get the associated
  103267. * depth texture.
  103268. * Otherwise, return null.
  103269. */
  103270. get depthStencilTexture(): Nullable<InternalTexture>;
  103271. /**
  103272. * Instantiate a render target texture. This is mainly used to render of screen the scene to for instance apply post processse
  103273. * or used a shadow, depth texture...
  103274. * @param name The friendly name of the texture
  103275. * @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)
  103276. * @param scene The scene the RTT belongs to. The latest created scene will be used if not precised.
  103277. * @param generateMipMaps True if mip maps need to be generated after render.
  103278. * @param doNotChangeAspectRatio True to not change the aspect ratio of the scene in the RTT
  103279. * @param type The type of the buffer in the RTT (int, half float, float...)
  103280. * @param isCube True if a cube texture needs to be created
  103281. * @param samplingMode The sampling mode to be usedwith the render target (Linear, Nearest...)
  103282. * @param generateDepthBuffer True to generate a depth buffer
  103283. * @param generateStencilBuffer True to generate a stencil buffer
  103284. * @param isMulti True if multiple textures need to be created (Draw Buffers)
  103285. * @param format The internal format of the buffer in the RTT (RED, RG, RGB, RGBA, ALPHA...)
  103286. * @param delayAllocation if the texture allocation should be delayed (default: false)
  103287. */
  103288. constructor(name: string, size: number | {
  103289. width: number;
  103290. height: number;
  103291. layers?: number;
  103292. } | {
  103293. ratio: number;
  103294. }, scene: Nullable<Scene>, generateMipMaps?: boolean, doNotChangeAspectRatio?: boolean, type?: number, isCube?: boolean, samplingMode?: number, generateDepthBuffer?: boolean, generateStencilBuffer?: boolean, isMulti?: boolean, format?: number, delayAllocation?: boolean);
  103295. /**
  103296. * Creates a depth stencil texture.
  103297. * This is only available in WebGL 2 or with the depth texture extension available.
  103298. * @param comparisonFunction Specifies the comparison function to set on the texture. If 0 or undefined, the texture is not in comparison mode
  103299. * @param bilinearFiltering Specifies whether or not bilinear filtering is enable on the texture
  103300. * @param generateStencil Specifies whether or not a stencil should be allocated in the texture
  103301. */
  103302. createDepthStencilTexture(comparisonFunction?: number, bilinearFiltering?: boolean, generateStencil?: boolean): void;
  103303. private _processSizeParameter;
  103304. /**
  103305. * Define the number of samples to use in case of MSAA.
  103306. * It defaults to one meaning no MSAA has been enabled.
  103307. */
  103308. get samples(): number;
  103309. set samples(value: number);
  103310. /**
  103311. * Resets the refresh counter of the texture and start bak from scratch.
  103312. * Could be useful to regenerate the texture if it is setup to render only once.
  103313. */
  103314. resetRefreshCounter(): void;
  103315. /**
  103316. * Define the refresh rate of the texture or the rendering frequency.
  103317. * Use 0 to render just once, 1 to render on every frame, 2 to render every two frames and so on...
  103318. */
  103319. get refreshRate(): number;
  103320. set refreshRate(value: number);
  103321. /**
  103322. * Adds a post process to the render target rendering passes.
  103323. * @param postProcess define the post process to add
  103324. */
  103325. addPostProcess(postProcess: PostProcess): void;
  103326. /**
  103327. * Clear all the post processes attached to the render target
  103328. * @param dispose define if the cleared post processesshould also be disposed (false by default)
  103329. */
  103330. clearPostProcesses(dispose?: boolean): void;
  103331. /**
  103332. * Remove one of the post process from the list of attached post processes to the texture
  103333. * @param postProcess define the post process to remove from the list
  103334. */
  103335. removePostProcess(postProcess: PostProcess): void;
  103336. /** @hidden */
  103337. _shouldRender(): boolean;
  103338. /**
  103339. * Gets the actual render size of the texture.
  103340. * @returns the width of the render size
  103341. */
  103342. getRenderSize(): number;
  103343. /**
  103344. * Gets the actual render width of the texture.
  103345. * @returns the width of the render size
  103346. */
  103347. getRenderWidth(): number;
  103348. /**
  103349. * Gets the actual render height of the texture.
  103350. * @returns the height of the render size
  103351. */
  103352. getRenderHeight(): number;
  103353. /**
  103354. * Gets the actual number of layers of the texture.
  103355. * @returns the number of layers
  103356. */
  103357. getRenderLayers(): number;
  103358. /**
  103359. * Get if the texture can be rescaled or not.
  103360. */
  103361. get canRescale(): boolean;
  103362. /**
  103363. * Resize the texture using a ratio.
  103364. * @param ratio the ratio to apply to the texture size in order to compute the new target size
  103365. */
  103366. scale(ratio: number): void;
  103367. /**
  103368. * Get the texture reflection matrix used to rotate/transform the reflection.
  103369. * @returns the reflection matrix
  103370. */
  103371. getReflectionTextureMatrix(): Matrix;
  103372. /**
  103373. * Resize the texture to a new desired size.
  103374. * Be carrefull as it will recreate all the data in the new texture.
  103375. * @param size Define the new size. It can be:
  103376. * - a number for squared texture,
  103377. * - an object containing { width: number, height: number }
  103378. * - or an object containing a ratio { ratio: number }
  103379. */
  103380. resize(size: number | {
  103381. width: number;
  103382. height: number;
  103383. } | {
  103384. ratio: number;
  103385. }): void;
  103386. private _defaultRenderListPrepared;
  103387. /**
  103388. * Renders all the objects from the render list into the texture.
  103389. * @param useCameraPostProcess Define if camera post processes should be used during the rendering
  103390. * @param dumpForDebug Define if the rendering result should be dumped (copied) for debugging purpose
  103391. */
  103392. render(useCameraPostProcess?: boolean, dumpForDebug?: boolean): void;
  103393. private _bestReflectionRenderTargetDimension;
  103394. private _prepareRenderingManager;
  103395. /**
  103396. * @hidden
  103397. * @param faceIndex face index to bind to if this is a cubetexture
  103398. * @param layer defines the index of the texture to bind in the array
  103399. */
  103400. _bindFrameBuffer(faceIndex?: number, layer?: number): void;
  103401. protected unbindFrameBuffer(engine: Engine, faceIndex: number): void;
  103402. private renderToTarget;
  103403. /**
  103404. * Overrides the default sort function applied in the renderging group to prepare the meshes.
  103405. * This allowed control for front to back rendering or reversly depending of the special needs.
  103406. *
  103407. * @param renderingGroupId The rendering group id corresponding to its index
  103408. * @param opaqueSortCompareFn The opaque queue comparison function use to sort.
  103409. * @param alphaTestSortCompareFn The alpha test queue comparison function use to sort.
  103410. * @param transparentSortCompareFn The transparent queue comparison function use to sort.
  103411. */
  103412. 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;
  103413. /**
  103414. * Specifies whether or not the stencil and depth buffer are cleared between two rendering groups.
  103415. *
  103416. * @param renderingGroupId The rendering group id corresponding to its index
  103417. * @param autoClearDepthStencil Automatically clears depth and stencil between groups if true.
  103418. */
  103419. setRenderingAutoClearDepthStencil(renderingGroupId: number, autoClearDepthStencil: boolean): void;
  103420. /**
  103421. * Clones the texture.
  103422. * @returns the cloned texture
  103423. */
  103424. clone(): RenderTargetTexture;
  103425. /**
  103426. * Serialize the texture to a JSON representation we can easily use in the resepective Parse function.
  103427. * @returns The JSON representation of the texture
  103428. */
  103429. serialize(): any;
  103430. /**
  103431. * This will remove the attached framebuffer objects. The texture will not be able to be used as render target anymore
  103432. */
  103433. disposeFramebufferObjects(): void;
  103434. /**
  103435. * Dispose the texture and release its associated resources.
  103436. */
  103437. dispose(): void;
  103438. /** @hidden */
  103439. _rebuild(): void;
  103440. /**
  103441. * Clear the info related to rendering groups preventing retention point in material dispose.
  103442. */
  103443. freeRenderingGroups(): void;
  103444. /**
  103445. * Gets the number of views the corresponding to the texture (eg. a MultiviewRenderTarget will have > 1)
  103446. * @returns the view count
  103447. */
  103448. getViewCount(): number;
  103449. }
  103450. }
  103451. declare module BABYLON {
  103452. /**
  103453. * Class used to manipulate GUIDs
  103454. */
  103455. export class GUID {
  103456. /**
  103457. * Implementation from http://stackoverflow.com/questions/105034/how-to-create-a-guid-uuid-in-javascript/2117523#answer-2117523
  103458. * Be aware Math.random() could cause collisions, but:
  103459. * "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"
  103460. * @returns a pseudo random id
  103461. */
  103462. static RandomId(): string;
  103463. }
  103464. }
  103465. declare module BABYLON {
  103466. /**
  103467. * Options to be used when creating a shadow depth material
  103468. */
  103469. export interface IIOptionShadowDepthMaterial {
  103470. /** Variables in the vertex shader code that need to have their names remapped.
  103471. * The format is: ["var_name", "var_remapped_name", "var_name", "var_remapped_name", ...]
  103472. * "var_name" should be either: worldPos or vNormalW
  103473. * So, if the variable holding the world position in your vertex shader is not named worldPos, you must tell the system
  103474. * the name to use instead by using: ["worldPos", "myWorldPosVar"] assuming the variable is named myWorldPosVar in your code.
  103475. * If the normal must also be remapped: ["worldPos", "myWorldPosVar", "vNormalW", "myWorldNormal"]
  103476. */
  103477. remappedVariables?: string[];
  103478. /** Set standalone to true if the base material wrapped by ShadowDepthMaterial is not used for a regular object but for depth shadow generation only */
  103479. standalone?: boolean;
  103480. }
  103481. /**
  103482. * Class that can be used to wrap a base material to generate accurate shadows when using custom vertex/fragment code in the base material
  103483. */
  103484. export class ShadowDepthWrapper {
  103485. private _scene;
  103486. private _options?;
  103487. private _baseMaterial;
  103488. private _onEffectCreatedObserver;
  103489. private _subMeshToEffect;
  103490. private _subMeshToDepthEffect;
  103491. private _meshes;
  103492. /** @hidden */
  103493. _matriceNames: any;
  103494. /** Gets the standalone status of the wrapper */
  103495. get standalone(): boolean;
  103496. /** Gets the base material the wrapper is built upon */
  103497. get baseMaterial(): Material;
  103498. /**
  103499. * Instantiate a new shadow depth wrapper.
  103500. * It works by injecting some specific code in the vertex/fragment shaders of the base material and is used by a shadow generator to
  103501. * generate the shadow depth map. For more information, please refer to the documentation:
  103502. * https://doc.babylonjs.com/babylon101/shadows
  103503. * @param baseMaterial Material to wrap
  103504. * @param scene Define the scene the material belongs to
  103505. * @param options Options used to create the wrapper
  103506. */
  103507. constructor(baseMaterial: Material, scene: Scene, options?: IIOptionShadowDepthMaterial);
  103508. /**
  103509. * Gets the effect to use to generate the depth map
  103510. * @param subMesh subMesh to get the effect for
  103511. * @param shadowGenerator shadow generator to get the effect for
  103512. * @returns the effect to use to generate the depth map for the subMesh + shadow generator specified
  103513. */
  103514. getEffect(subMesh: Nullable<SubMesh>, shadowGenerator: ShadowGenerator): Nullable<Effect>;
  103515. /**
  103516. * Specifies that the submesh is ready to be used for depth rendering
  103517. * @param subMesh submesh to check
  103518. * @param defines the list of defines to take into account when checking the effect
  103519. * @param shadowGenerator combined with subMesh, it defines the effect to check
  103520. * @param useInstances specifies that instances should be used
  103521. * @returns a boolean indicating that the submesh is ready or not
  103522. */
  103523. isReadyForSubMesh(subMesh: SubMesh, defines: string[], shadowGenerator: ShadowGenerator, useInstances: boolean): boolean;
  103524. /**
  103525. * Disposes the resources
  103526. */
  103527. dispose(): void;
  103528. private _makeEffect;
  103529. }
  103530. }
  103531. declare module BABYLON {
  103532. interface ThinEngine {
  103533. /**
  103534. * Unbind a list of render target textures from the webGL context
  103535. * This is used only when drawBuffer extension or webGL2 are active
  103536. * @param textures defines the render target textures to unbind
  103537. * @param disableGenerateMipMaps defines a boolean indicating that mipmaps must not be generated
  103538. * @param onBeforeUnbind defines a function which will be called before the effective unbind
  103539. */
  103540. unBindMultiColorAttachmentFramebuffer(textures: InternalTexture[], disableGenerateMipMaps: boolean, onBeforeUnbind?: () => void): void;
  103541. /**
  103542. * Create a multi render target texture
  103543. * @see https://doc.babylonjs.com/features/webgl2#multiple-render-target
  103544. * @param size defines the size of the texture
  103545. * @param options defines the creation options
  103546. * @returns the cube texture as an InternalTexture
  103547. */
  103548. createMultipleRenderTarget(size: any, options: IMultiRenderTargetOptions): InternalTexture[];
  103549. /**
  103550. * Update the sample count for a given multiple render target texture
  103551. * @see https://doc.babylonjs.com/features/webgl2#multisample-render-targets
  103552. * @param textures defines the textures to update
  103553. * @param samples defines the sample count to set
  103554. * @returns the effective sample count (could be 0 if multisample render targets are not supported)
  103555. */
  103556. updateMultipleRenderTargetTextureSampleCount(textures: Nullable<InternalTexture[]>, samples: number): number;
  103557. /**
  103558. * Select a subsets of attachments to draw to.
  103559. * @param attachments gl attachments
  103560. */
  103561. bindAttachments(attachments: number[]): void;
  103562. }
  103563. }
  103564. declare module BABYLON {
  103565. /**
  103566. * Creation options of the multi render target texture.
  103567. */
  103568. export interface IMultiRenderTargetOptions {
  103569. /**
  103570. * Define if the texture needs to create mip maps after render.
  103571. */
  103572. generateMipMaps?: boolean;
  103573. /**
  103574. * Define the types of all the draw buffers we want to create
  103575. */
  103576. types?: number[];
  103577. /**
  103578. * Define the sampling modes of all the draw buffers we want to create
  103579. */
  103580. samplingModes?: number[];
  103581. /**
  103582. * Define if a depth buffer is required
  103583. */
  103584. generateDepthBuffer?: boolean;
  103585. /**
  103586. * Define if a stencil buffer is required
  103587. */
  103588. generateStencilBuffer?: boolean;
  103589. /**
  103590. * Define if a depth texture is required instead of a depth buffer
  103591. */
  103592. generateDepthTexture?: boolean;
  103593. /**
  103594. * Define the number of desired draw buffers
  103595. */
  103596. textureCount?: number;
  103597. /**
  103598. * Define if aspect ratio should be adapted to the texture or stay the scene one
  103599. */
  103600. doNotChangeAspectRatio?: boolean;
  103601. /**
  103602. * Define the default type of the buffers we are creating
  103603. */
  103604. defaultType?: number;
  103605. }
  103606. /**
  103607. * A multi render target, like a render target provides the ability to render to a texture.
  103608. * Unlike the render target, it can render to several draw buffers in one draw.
  103609. * This is specially interesting in deferred rendering or for any effects requiring more than
  103610. * just one color from a single pass.
  103611. */
  103612. export class MultiRenderTarget extends RenderTargetTexture {
  103613. private _internalTextures;
  103614. private _textures;
  103615. private _multiRenderTargetOptions;
  103616. private _count;
  103617. /**
  103618. * Get if draw buffers are currently supported by the used hardware and browser.
  103619. */
  103620. get isSupported(): boolean;
  103621. /**
  103622. * Get the list of textures generated by the multi render target.
  103623. */
  103624. get textures(): Texture[];
  103625. /**
  103626. * Gets the number of textures in this MRT. This number can be different from `_textures.length` in case a depth texture is generated.
  103627. */
  103628. get count(): number;
  103629. /**
  103630. * Get the depth texture generated by the multi render target if options.generateDepthTexture has been set
  103631. */
  103632. get depthTexture(): Texture;
  103633. /**
  103634. * Set the wrapping mode on U of all the textures we are rendering to.
  103635. * Can be any of the Texture. (CLAMP_ADDRESSMODE, MIRROR_ADDRESSMODE or WRAP_ADDRESSMODE)
  103636. */
  103637. set wrapU(wrap: number);
  103638. /**
  103639. * Set the wrapping mode on V of all the textures we are rendering to.
  103640. * Can be any of the Texture. (CLAMP_ADDRESSMODE, MIRROR_ADDRESSMODE or WRAP_ADDRESSMODE)
  103641. */
  103642. set wrapV(wrap: number);
  103643. /**
  103644. * Instantiate a new multi render target texture.
  103645. * A multi render target, like a render target provides the ability to render to a texture.
  103646. * Unlike the render target, it can render to several draw buffers in one draw.
  103647. * This is specially interesting in deferred rendering or for any effects requiring more than
  103648. * just one color from a single pass.
  103649. * @param name Define the name of the texture
  103650. * @param size Define the size of the buffers to render to
  103651. * @param count Define the number of target we are rendering into
  103652. * @param scene Define the scene the texture belongs to
  103653. * @param options Define the options used to create the multi render target
  103654. */
  103655. constructor(name: string, size: any, count: number, scene: Scene, options?: IMultiRenderTargetOptions);
  103656. /** @hidden */
  103657. _rebuild(): void;
  103658. private _createInternalTextures;
  103659. private _createTextures;
  103660. /**
  103661. * Define the number of samples used if MSAA is enabled.
  103662. */
  103663. get samples(): number;
  103664. set samples(value: number);
  103665. /**
  103666. * Resize all the textures in the multi render target.
  103667. * Be carrefull as it will recreate all the data in the new texture.
  103668. * @param size Define the new size
  103669. */
  103670. resize(size: any): void;
  103671. protected unbindFrameBuffer(engine: Engine, faceIndex: number): void;
  103672. /**
  103673. * Dispose the render targets and their associated resources
  103674. */
  103675. dispose(): void;
  103676. /**
  103677. * Release all the underlying texture used as draw buffers.
  103678. */
  103679. releaseInternalTextures(): void;
  103680. }
  103681. }
  103682. declare module BABYLON {
  103683. /** @hidden */
  103684. export var imageProcessingPixelShader: {
  103685. name: string;
  103686. shader: string;
  103687. };
  103688. }
  103689. declare module BABYLON {
  103690. /**
  103691. * ImageProcessingPostProcess
  103692. * @see https://doc.babylonjs.com/how_to/how_to_use_postprocesses#imageprocessing
  103693. */
  103694. export class ImageProcessingPostProcess extends PostProcess {
  103695. /**
  103696. * Default configuration related to image processing available in the PBR Material.
  103697. */
  103698. protected _imageProcessingConfiguration: ImageProcessingConfiguration;
  103699. /**
  103700. * Gets the image processing configuration used either in this material.
  103701. */
  103702. get imageProcessingConfiguration(): ImageProcessingConfiguration;
  103703. /**
  103704. * Sets the Default image processing configuration used either in the this material.
  103705. *
  103706. * If sets to null, the scene one is in use.
  103707. */
  103708. set imageProcessingConfiguration(value: ImageProcessingConfiguration);
  103709. /**
  103710. * Keep track of the image processing observer to allow dispose and replace.
  103711. */
  103712. private _imageProcessingObserver;
  103713. /**
  103714. * Attaches a new image processing configuration to the PBR Material.
  103715. * @param configuration
  103716. */
  103717. protected _attachImageProcessingConfiguration(configuration: Nullable<ImageProcessingConfiguration>, doNotBuild?: boolean): void;
  103718. /**
  103719. * If the post process is supported.
  103720. */
  103721. get isSupported(): boolean;
  103722. /**
  103723. * Gets Color curves setup used in the effect if colorCurvesEnabled is set to true .
  103724. */
  103725. get colorCurves(): Nullable<ColorCurves>;
  103726. /**
  103727. * Sets Color curves setup used in the effect if colorCurvesEnabled is set to true .
  103728. */
  103729. set colorCurves(value: Nullable<ColorCurves>);
  103730. /**
  103731. * Gets wether the color curves effect is enabled.
  103732. */
  103733. get colorCurvesEnabled(): boolean;
  103734. /**
  103735. * Sets wether the color curves effect is enabled.
  103736. */
  103737. set colorCurvesEnabled(value: boolean);
  103738. /**
  103739. * Gets Color grading LUT texture used in the effect if colorGradingEnabled is set to true.
  103740. */
  103741. get colorGradingTexture(): Nullable<BaseTexture>;
  103742. /**
  103743. * Sets Color grading LUT texture used in the effect if colorGradingEnabled is set to true.
  103744. */
  103745. set colorGradingTexture(value: Nullable<BaseTexture>);
  103746. /**
  103747. * Gets wether the color grading effect is enabled.
  103748. */
  103749. get colorGradingEnabled(): boolean;
  103750. /**
  103751. * Gets wether the color grading effect is enabled.
  103752. */
  103753. set colorGradingEnabled(value: boolean);
  103754. /**
  103755. * Gets exposure used in the effect.
  103756. */
  103757. get exposure(): number;
  103758. /**
  103759. * Sets exposure used in the effect.
  103760. */
  103761. set exposure(value: number);
  103762. /**
  103763. * Gets wether tonemapping is enabled or not.
  103764. */
  103765. get toneMappingEnabled(): boolean;
  103766. /**
  103767. * Sets wether tonemapping is enabled or not
  103768. */
  103769. set toneMappingEnabled(value: boolean);
  103770. /**
  103771. * Gets the type of tone mapping effect.
  103772. */
  103773. get toneMappingType(): number;
  103774. /**
  103775. * Sets the type of tone mapping effect.
  103776. */
  103777. set toneMappingType(value: number);
  103778. /**
  103779. * Gets contrast used in the effect.
  103780. */
  103781. get contrast(): number;
  103782. /**
  103783. * Sets contrast used in the effect.
  103784. */
  103785. set contrast(value: number);
  103786. /**
  103787. * Gets Vignette stretch size.
  103788. */
  103789. get vignetteStretch(): number;
  103790. /**
  103791. * Sets Vignette stretch size.
  103792. */
  103793. set vignetteStretch(value: number);
  103794. /**
  103795. * Gets Vignette centre X Offset.
  103796. */
  103797. get vignetteCentreX(): number;
  103798. /**
  103799. * Sets Vignette centre X Offset.
  103800. */
  103801. set vignetteCentreX(value: number);
  103802. /**
  103803. * Gets Vignette centre Y Offset.
  103804. */
  103805. get vignetteCentreY(): number;
  103806. /**
  103807. * Sets Vignette centre Y Offset.
  103808. */
  103809. set vignetteCentreY(value: number);
  103810. /**
  103811. * Gets Vignette weight or intensity of the vignette effect.
  103812. */
  103813. get vignetteWeight(): number;
  103814. /**
  103815. * Sets Vignette weight or intensity of the vignette effect.
  103816. */
  103817. set vignetteWeight(value: number);
  103818. /**
  103819. * Gets Color of the vignette applied on the screen through the chosen blend mode (vignetteBlendMode)
  103820. * if vignetteEnabled is set to true.
  103821. */
  103822. get vignetteColor(): Color4;
  103823. /**
  103824. * Sets Color of the vignette applied on the screen through the chosen blend mode (vignetteBlendMode)
  103825. * if vignetteEnabled is set to true.
  103826. */
  103827. set vignetteColor(value: Color4);
  103828. /**
  103829. * Gets Camera field of view used by the Vignette effect.
  103830. */
  103831. get vignetteCameraFov(): number;
  103832. /**
  103833. * Sets Camera field of view used by the Vignette effect.
  103834. */
  103835. set vignetteCameraFov(value: number);
  103836. /**
  103837. * Gets the vignette blend mode allowing different kind of effect.
  103838. */
  103839. get vignetteBlendMode(): number;
  103840. /**
  103841. * Sets the vignette blend mode allowing different kind of effect.
  103842. */
  103843. set vignetteBlendMode(value: number);
  103844. /**
  103845. * Gets wether the vignette effect is enabled.
  103846. */
  103847. get vignetteEnabled(): boolean;
  103848. /**
  103849. * Sets wether the vignette effect is enabled.
  103850. */
  103851. set vignetteEnabled(value: boolean);
  103852. private _fromLinearSpace;
  103853. /**
  103854. * Gets wether the input of the processing is in Gamma or Linear Space.
  103855. */
  103856. get fromLinearSpace(): boolean;
  103857. /**
  103858. * Sets wether the input of the processing is in Gamma or Linear Space.
  103859. */
  103860. set fromLinearSpace(value: boolean);
  103861. /**
  103862. * Defines cache preventing GC.
  103863. */
  103864. private _defines;
  103865. constructor(name: string, options: number | PostProcessOptions, camera?: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number, imageProcessingConfiguration?: ImageProcessingConfiguration);
  103866. /**
  103867. * "ImageProcessingPostProcess"
  103868. * @returns "ImageProcessingPostProcess"
  103869. */
  103870. getClassName(): string;
  103871. /**
  103872. * @hidden
  103873. */
  103874. _updateParameters(): void;
  103875. dispose(camera?: Camera): void;
  103876. }
  103877. }
  103878. declare module BABYLON {
  103879. /** @hidden */
  103880. export var fibonacci: {
  103881. name: string;
  103882. shader: string;
  103883. };
  103884. }
  103885. declare module BABYLON {
  103886. /** @hidden */
  103887. export var subSurfaceScatteringFunctions: {
  103888. name: string;
  103889. shader: string;
  103890. };
  103891. }
  103892. declare module BABYLON {
  103893. /** @hidden */
  103894. export var diffusionProfile: {
  103895. name: string;
  103896. shader: string;
  103897. };
  103898. }
  103899. declare module BABYLON {
  103900. /** @hidden */
  103901. export var subSurfaceScatteringPixelShader: {
  103902. name: string;
  103903. shader: string;
  103904. };
  103905. }
  103906. declare module BABYLON {
  103907. /**
  103908. * Sub surface scattering post process
  103909. */
  103910. export class SubSurfaceScatteringPostProcess extends PostProcess {
  103911. /**
  103912. * Gets a string identifying the name of the class
  103913. * @returns "SubSurfaceScatteringPostProcess" string
  103914. */
  103915. getClassName(): string;
  103916. constructor(name: string, scene: Scene, options: number | PostProcessOptions, camera?: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number);
  103917. }
  103918. }
  103919. declare module BABYLON {
  103920. /**
  103921. * Interface for defining prepass effects in the prepass post-process pipeline
  103922. */
  103923. export interface PrePassEffectConfiguration {
  103924. /**
  103925. * Post process to attach for this effect
  103926. */
  103927. postProcess: PostProcess;
  103928. /**
  103929. * Is the effect enabled
  103930. */
  103931. enabled: boolean;
  103932. /**
  103933. * Disposes the effect configuration
  103934. */
  103935. dispose(): void;
  103936. /**
  103937. * Disposes the effect configuration
  103938. */
  103939. createPostProcess: () => PostProcess;
  103940. }
  103941. }
  103942. declare module BABYLON {
  103943. /**
  103944. * Contains all parameters needed for the prepass to perform
  103945. * screen space subsurface scattering
  103946. */
  103947. export class SubSurfaceConfiguration implements PrePassEffectConfiguration {
  103948. private _ssDiffusionS;
  103949. private _ssFilterRadii;
  103950. private _ssDiffusionD;
  103951. /**
  103952. * Post process to attach for screen space subsurface scattering
  103953. */
  103954. postProcess: SubSurfaceScatteringPostProcess;
  103955. /**
  103956. * Diffusion profile color for subsurface scattering
  103957. */
  103958. get ssDiffusionS(): number[];
  103959. /**
  103960. * Diffusion profile max color channel value for subsurface scattering
  103961. */
  103962. get ssDiffusionD(): number[];
  103963. /**
  103964. * Diffusion profile filter radius for subsurface scattering
  103965. */
  103966. get ssFilterRadii(): number[];
  103967. /**
  103968. * Is subsurface enabled
  103969. */
  103970. enabled: boolean;
  103971. /**
  103972. * Diffusion profile colors for subsurface scattering
  103973. * You can add one diffusion color using `addDiffusionProfile` on `scene.prePassRenderer`
  103974. * See ...
  103975. * Note that you can only store up to 5 of them
  103976. */
  103977. ssDiffusionProfileColors: Color3[];
  103978. /**
  103979. * Defines the ratio real world => scene units.
  103980. * Used for subsurface scattering
  103981. */
  103982. metersPerUnit: number;
  103983. private _scene;
  103984. /**
  103985. * Builds a subsurface configuration object
  103986. * @param scene The scene
  103987. */
  103988. constructor(scene: Scene);
  103989. /**
  103990. * Adds a new diffusion profile.
  103991. * Useful for more realistic subsurface scattering on diverse materials.
  103992. * @param color The color of the diffusion profile. Should be the average color of the material.
  103993. * @return The index of the diffusion profile for the material subsurface configuration
  103994. */
  103995. addDiffusionProfile(color: Color3): number;
  103996. /**
  103997. * Creates the sss post process
  103998. * @return The created post process
  103999. */
  104000. createPostProcess(): SubSurfaceScatteringPostProcess;
  104001. /**
  104002. * Deletes all diffusion profiles.
  104003. * Note that in order to render subsurface scattering, you should have at least 1 diffusion profile.
  104004. */
  104005. clearAllDiffusionProfiles(): void;
  104006. /**
  104007. * Disposes this object
  104008. */
  104009. dispose(): void;
  104010. /**
  104011. * @hidden
  104012. * https://zero-radiance.github.io/post/sampling-diffusion/
  104013. *
  104014. * Importance sample the normalized diffuse reflectance profile for the computed value of 's'.
  104015. * ------------------------------------------------------------------------------------
  104016. * R[r, phi, s] = s * (Exp[-r * s] + Exp[-r * s / 3]) / (8 * Pi * r)
  104017. * PDF[r, phi, s] = r * R[r, phi, s]
  104018. * CDF[r, s] = 1 - 1/4 * Exp[-r * s] - 3/4 * Exp[-r * s / 3]
  104019. * ------------------------------------------------------------------------------------
  104020. * We importance sample the color channel with the widest scattering distance.
  104021. */
  104022. getDiffusionProfileParameters(color: Color3): number;
  104023. /**
  104024. * Performs sampling of a Normalized Burley diffusion profile in polar coordinates.
  104025. * 'u' is the random number (the value of the CDF): [0, 1).
  104026. * rcp(s) = 1 / ShapeParam = ScatteringDistance.
  104027. * Returns the sampled radial distance, s.t. (u = 0 -> r = 0) and (u = 1 -> r = Inf).
  104028. */
  104029. private _sampleBurleyDiffusionProfile;
  104030. }
  104031. }
  104032. declare module BABYLON {
  104033. /**
  104034. * Renders a pre pass of the scene
  104035. * This means every mesh in the scene will be rendered to a render target texture
  104036. * And then this texture will be composited to the rendering canvas with post processes
  104037. * It is necessary for effects like subsurface scattering or deferred shading
  104038. */
  104039. export class PrePassRenderer {
  104040. /** @hidden */
  104041. static _SceneComponentInitialization: (scene: Scene) => void;
  104042. private _scene;
  104043. private _engine;
  104044. private _isDirty;
  104045. /**
  104046. * Number of textures in the multi render target texture where the scene is directly rendered
  104047. */
  104048. readonly mrtCount: number;
  104049. /**
  104050. * The render target where the scene is directly rendered
  104051. */
  104052. prePassRT: MultiRenderTarget;
  104053. private _mrtTypes;
  104054. private _multiRenderAttachments;
  104055. private _defaultAttachments;
  104056. private _clearAttachments;
  104057. private _postProcesses;
  104058. private readonly _clearColor;
  104059. /**
  104060. * Image processing post process for composition
  104061. */
  104062. imageProcessingPostProcess: ImageProcessingPostProcess;
  104063. /**
  104064. * Configuration for sub surface scattering post process
  104065. */
  104066. subSurfaceConfiguration: SubSurfaceConfiguration;
  104067. /**
  104068. * Should materials render their geometry on the MRT
  104069. */
  104070. materialsShouldRenderGeometry: boolean;
  104071. /**
  104072. * Should materials render the irradiance information on the MRT
  104073. */
  104074. materialsShouldRenderIrradiance: boolean;
  104075. private _enabled;
  104076. /**
  104077. * Indicates if the prepass is enabled
  104078. */
  104079. get enabled(): boolean;
  104080. /**
  104081. * How many samples are used for MSAA of the scene render target
  104082. */
  104083. get samples(): number;
  104084. set samples(n: number);
  104085. /**
  104086. * Instanciates a prepass renderer
  104087. * @param scene The scene
  104088. */
  104089. constructor(scene: Scene);
  104090. private _initializeAttachments;
  104091. private _createCompositionEffect;
  104092. /**
  104093. * Indicates if rendering a prepass is supported
  104094. */
  104095. get isSupported(): boolean;
  104096. /**
  104097. * Sets the proper output textures to draw in the engine.
  104098. * @param effect The effect that is drawn. It can be or not be compatible with drawing to several output textures.
  104099. */
  104100. bindAttachmentsForEffect(effect: Effect): void;
  104101. /**
  104102. * @hidden
  104103. */
  104104. _beforeCameraDraw(): void;
  104105. /**
  104106. * @hidden
  104107. */
  104108. _afterCameraDraw(): void;
  104109. private _checkRTSize;
  104110. private _bindFrameBuffer;
  104111. /**
  104112. * Clears the scene render target (in the sense of settings pixels to the scene clear color value)
  104113. */
  104114. clear(): void;
  104115. private _setState;
  104116. private _enable;
  104117. private _disable;
  104118. private _resetPostProcessChain;
  104119. private _bindPostProcessChain;
  104120. /**
  104121. * Marks the prepass renderer as dirty, triggering a check if the prepass is necessary for the next rendering.
  104122. */
  104123. markAsDirty(): void;
  104124. private _update;
  104125. /**
  104126. * Disposes the prepass renderer.
  104127. */
  104128. dispose(): void;
  104129. }
  104130. }
  104131. declare module BABYLON {
  104132. /**
  104133. * Options for compiling materials.
  104134. */
  104135. export interface IMaterialCompilationOptions {
  104136. /**
  104137. * Defines whether clip planes are enabled.
  104138. */
  104139. clipPlane: boolean;
  104140. /**
  104141. * Defines whether instances are enabled.
  104142. */
  104143. useInstances: boolean;
  104144. }
  104145. /**
  104146. * Options passed when calling customShaderNameResolve
  104147. */
  104148. export interface ICustomShaderNameResolveOptions {
  104149. /**
  104150. * 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
  104151. */
  104152. processFinalCode?: Nullable<(shaderType: string, code: string) => string>;
  104153. }
  104154. /**
  104155. * Base class for the main features of a material in Babylon.js
  104156. */
  104157. export class Material implements IAnimatable {
  104158. /**
  104159. * Returns the triangle fill mode
  104160. */
  104161. static readonly TriangleFillMode: number;
  104162. /**
  104163. * Returns the wireframe mode
  104164. */
  104165. static readonly WireFrameFillMode: number;
  104166. /**
  104167. * Returns the point fill mode
  104168. */
  104169. static readonly PointFillMode: number;
  104170. /**
  104171. * Returns the point list draw mode
  104172. */
  104173. static readonly PointListDrawMode: number;
  104174. /**
  104175. * Returns the line list draw mode
  104176. */
  104177. static readonly LineListDrawMode: number;
  104178. /**
  104179. * Returns the line loop draw mode
  104180. */
  104181. static readonly LineLoopDrawMode: number;
  104182. /**
  104183. * Returns the line strip draw mode
  104184. */
  104185. static readonly LineStripDrawMode: number;
  104186. /**
  104187. * Returns the triangle strip draw mode
  104188. */
  104189. static readonly TriangleStripDrawMode: number;
  104190. /**
  104191. * Returns the triangle fan draw mode
  104192. */
  104193. static readonly TriangleFanDrawMode: number;
  104194. /**
  104195. * Stores the clock-wise side orientation
  104196. */
  104197. static readonly ClockWiseSideOrientation: number;
  104198. /**
  104199. * Stores the counter clock-wise side orientation
  104200. */
  104201. static readonly CounterClockWiseSideOrientation: number;
  104202. /**
  104203. * The dirty texture flag value
  104204. */
  104205. static readonly TextureDirtyFlag: number;
  104206. /**
  104207. * The dirty light flag value
  104208. */
  104209. static readonly LightDirtyFlag: number;
  104210. /**
  104211. * The dirty fresnel flag value
  104212. */
  104213. static readonly FresnelDirtyFlag: number;
  104214. /**
  104215. * The dirty attribute flag value
  104216. */
  104217. static readonly AttributesDirtyFlag: number;
  104218. /**
  104219. * The dirty misc flag value
  104220. */
  104221. static readonly MiscDirtyFlag: number;
  104222. /**
  104223. * The all dirty flag value
  104224. */
  104225. static readonly AllDirtyFlag: number;
  104226. /**
  104227. * MaterialTransparencyMode: No transparency mode, Alpha channel is not use.
  104228. */
  104229. static readonly MATERIAL_OPAQUE: number;
  104230. /**
  104231. * MaterialTransparencyMode: Alpha Test mode, pixel are discarded below a certain threshold defined by the alpha cutoff value.
  104232. */
  104233. static readonly MATERIAL_ALPHATEST: number;
  104234. /**
  104235. * MaterialTransparencyMode: Pixels are blended (according to the alpha mode) with the already drawn pixels in the current frame buffer.
  104236. */
  104237. static readonly MATERIAL_ALPHABLEND: number;
  104238. /**
  104239. * MaterialTransparencyMode: Pixels are blended (according to the alpha mode) with the already drawn pixels in the current frame buffer.
  104240. * They are also discarded below the alpha cutoff threshold to improve performances.
  104241. */
  104242. static readonly MATERIAL_ALPHATESTANDBLEND: number;
  104243. /**
  104244. * The Whiteout method is used to blend normals.
  104245. * Details of the algorithm can be found here: https://blog.selfshadow.com/publications/blending-in-detail/
  104246. */
  104247. static readonly MATERIAL_NORMALBLENDMETHOD_WHITEOUT: number;
  104248. /**
  104249. * The Reoriented Normal Mapping method is used to blend normals.
  104250. * Details of the algorithm can be found here: https://blog.selfshadow.com/publications/blending-in-detail/
  104251. */
  104252. static readonly MATERIAL_NORMALBLENDMETHOD_RNM: number;
  104253. /**
  104254. * Custom callback helping to override the default shader used in the material.
  104255. */
  104256. customShaderNameResolve: (shaderName: string, uniforms: string[], uniformBuffers: string[], samplers: string[], defines: MaterialDefines | string[], attributes?: string[], options?: ICustomShaderNameResolveOptions) => string;
  104257. /**
  104258. * Custom shadow depth material to use for shadow rendering instead of the in-built one
  104259. */
  104260. shadowDepthWrapper: Nullable<ShadowDepthWrapper>;
  104261. /**
  104262. * Gets or sets a boolean indicating that the material is allowed (if supported) to do shader hot swapping.
  104263. * This means that the material can keep using a previous shader while a new one is being compiled.
  104264. * This is mostly used when shader parallel compilation is supported (true by default)
  104265. */
  104266. allowShaderHotSwapping: boolean;
  104267. /**
  104268. * The ID of the material
  104269. */
  104270. id: string;
  104271. /**
  104272. * Gets or sets the unique id of the material
  104273. */
  104274. uniqueId: number;
  104275. /**
  104276. * The name of the material
  104277. */
  104278. name: string;
  104279. /**
  104280. * Gets or sets user defined metadata
  104281. */
  104282. metadata: any;
  104283. /**
  104284. * For internal use only. Please do not use.
  104285. */
  104286. reservedDataStore: any;
  104287. /**
  104288. * Specifies if the ready state should be checked on each call
  104289. */
  104290. checkReadyOnEveryCall: boolean;
  104291. /**
  104292. * Specifies if the ready state should be checked once
  104293. */
  104294. checkReadyOnlyOnce: boolean;
  104295. /**
  104296. * The state of the material
  104297. */
  104298. state: string;
  104299. /**
  104300. * If the material can be rendered to several textures with MRT extension
  104301. */
  104302. get canRenderToMRT(): boolean;
  104303. /**
  104304. * The alpha value of the material
  104305. */
  104306. protected _alpha: number;
  104307. /**
  104308. * List of inspectable custom properties (used by the Inspector)
  104309. * @see https://doc.babylonjs.com/how_to/debug_layer#extensibility
  104310. */
  104311. inspectableCustomProperties: IInspectable[];
  104312. /**
  104313. * Sets the alpha value of the material
  104314. */
  104315. set alpha(value: number);
  104316. /**
  104317. * Gets the alpha value of the material
  104318. */
  104319. get alpha(): number;
  104320. /**
  104321. * Specifies if back face culling is enabled
  104322. */
  104323. protected _backFaceCulling: boolean;
  104324. /**
  104325. * Sets the back-face culling state
  104326. */
  104327. set backFaceCulling(value: boolean);
  104328. /**
  104329. * Gets the back-face culling state
  104330. */
  104331. get backFaceCulling(): boolean;
  104332. /**
  104333. * Stores the value for side orientation
  104334. */
  104335. sideOrientation: number;
  104336. /**
  104337. * Callback triggered when the material is compiled
  104338. */
  104339. onCompiled: Nullable<(effect: Effect) => void>;
  104340. /**
  104341. * Callback triggered when an error occurs
  104342. */
  104343. onError: Nullable<(effect: Effect, errors: string) => void>;
  104344. /**
  104345. * Callback triggered to get the render target textures
  104346. */
  104347. getRenderTargetTextures: Nullable<() => SmartArray<RenderTargetTexture>>;
  104348. /**
  104349. * Gets a boolean indicating that current material needs to register RTT
  104350. */
  104351. get hasRenderTargetTextures(): boolean;
  104352. /**
  104353. * Specifies if the material should be serialized
  104354. */
  104355. doNotSerialize: boolean;
  104356. /**
  104357. * @hidden
  104358. */
  104359. _storeEffectOnSubMeshes: boolean;
  104360. /**
  104361. * Stores the animations for the material
  104362. */
  104363. animations: Nullable<Array<Animation>>;
  104364. /**
  104365. * An event triggered when the material is disposed
  104366. */
  104367. onDisposeObservable: Observable<Material>;
  104368. /**
  104369. * An observer which watches for dispose events
  104370. */
  104371. private _onDisposeObserver;
  104372. private _onUnBindObservable;
  104373. /**
  104374. * Called during a dispose event
  104375. */
  104376. set onDispose(callback: () => void);
  104377. private _onBindObservable;
  104378. /**
  104379. * An event triggered when the material is bound
  104380. */
  104381. get onBindObservable(): Observable<AbstractMesh>;
  104382. /**
  104383. * An observer which watches for bind events
  104384. */
  104385. private _onBindObserver;
  104386. /**
  104387. * Called during a bind event
  104388. */
  104389. set onBind(callback: (Mesh: AbstractMesh) => void);
  104390. /**
  104391. * An event triggered when the material is unbound
  104392. */
  104393. get onUnBindObservable(): Observable<Material>;
  104394. protected _onEffectCreatedObservable: Nullable<Observable<{
  104395. effect: Effect;
  104396. subMesh: Nullable<SubMesh>;
  104397. }>>;
  104398. /**
  104399. * An event triggered when the effect is (re)created
  104400. */
  104401. get onEffectCreatedObservable(): Observable<{
  104402. effect: Effect;
  104403. subMesh: Nullable<SubMesh>;
  104404. }>;
  104405. /**
  104406. * Stores the value of the alpha mode
  104407. */
  104408. private _alphaMode;
  104409. /**
  104410. * Sets the value of the alpha mode.
  104411. *
  104412. * | Value | Type | Description |
  104413. * | --- | --- | --- |
  104414. * | 0 | ALPHA_DISABLE | |
  104415. * | 1 | ALPHA_ADD | |
  104416. * | 2 | ALPHA_COMBINE | |
  104417. * | 3 | ALPHA_SUBTRACT | |
  104418. * | 4 | ALPHA_MULTIPLY | |
  104419. * | 5 | ALPHA_MAXIMIZED | |
  104420. * | 6 | ALPHA_ONEONE | |
  104421. * | 7 | ALPHA_PREMULTIPLIED | |
  104422. * | 8 | ALPHA_PREMULTIPLIED_PORTERDUFF | |
  104423. * | 9 | ALPHA_INTERPOLATE | |
  104424. * | 10 | ALPHA_SCREENMODE | |
  104425. *
  104426. */
  104427. set alphaMode(value: number);
  104428. /**
  104429. * Gets the value of the alpha mode
  104430. */
  104431. get alphaMode(): number;
  104432. /**
  104433. * Stores the state of the need depth pre-pass value
  104434. */
  104435. private _needDepthPrePass;
  104436. /**
  104437. * Sets the need depth pre-pass value
  104438. */
  104439. set needDepthPrePass(value: boolean);
  104440. /**
  104441. * Gets the depth pre-pass value
  104442. */
  104443. get needDepthPrePass(): boolean;
  104444. /**
  104445. * Specifies if depth writing should be disabled
  104446. */
  104447. disableDepthWrite: boolean;
  104448. /**
  104449. * Specifies if color writing should be disabled
  104450. */
  104451. disableColorWrite: boolean;
  104452. /**
  104453. * Specifies if depth writing should be forced
  104454. */
  104455. forceDepthWrite: boolean;
  104456. /**
  104457. * Specifies the depth function that should be used. 0 means the default engine function
  104458. */
  104459. depthFunction: number;
  104460. /**
  104461. * Specifies if there should be a separate pass for culling
  104462. */
  104463. separateCullingPass: boolean;
  104464. /**
  104465. * Stores the state specifing if fog should be enabled
  104466. */
  104467. private _fogEnabled;
  104468. /**
  104469. * Sets the state for enabling fog
  104470. */
  104471. set fogEnabled(value: boolean);
  104472. /**
  104473. * Gets the value of the fog enabled state
  104474. */
  104475. get fogEnabled(): boolean;
  104476. /**
  104477. * Stores the size of points
  104478. */
  104479. pointSize: number;
  104480. /**
  104481. * Stores the z offset value
  104482. */
  104483. zOffset: number;
  104484. get wireframe(): boolean;
  104485. /**
  104486. * Sets the state of wireframe mode
  104487. */
  104488. set wireframe(value: boolean);
  104489. /**
  104490. * Gets the value specifying if point clouds are enabled
  104491. */
  104492. get pointsCloud(): boolean;
  104493. /**
  104494. * Sets the state of point cloud mode
  104495. */
  104496. set pointsCloud(value: boolean);
  104497. /**
  104498. * Gets the material fill mode
  104499. */
  104500. get fillMode(): number;
  104501. /**
  104502. * Sets the material fill mode
  104503. */
  104504. set fillMode(value: number);
  104505. /**
  104506. * @hidden
  104507. * Stores the effects for the material
  104508. */
  104509. _effect: Nullable<Effect>;
  104510. /**
  104511. * Specifies if uniform buffers should be used
  104512. */
  104513. private _useUBO;
  104514. /**
  104515. * Stores a reference to the scene
  104516. */
  104517. private _scene;
  104518. /**
  104519. * Stores the fill mode state
  104520. */
  104521. private _fillMode;
  104522. /**
  104523. * Specifies if the depth write state should be cached
  104524. */
  104525. private _cachedDepthWriteState;
  104526. /**
  104527. * Specifies if the color write state should be cached
  104528. */
  104529. private _cachedColorWriteState;
  104530. /**
  104531. * Specifies if the depth function state should be cached
  104532. */
  104533. private _cachedDepthFunctionState;
  104534. /**
  104535. * Stores the uniform buffer
  104536. */
  104537. protected _uniformBuffer: UniformBuffer;
  104538. /** @hidden */
  104539. _indexInSceneMaterialArray: number;
  104540. /** @hidden */
  104541. meshMap: Nullable<{
  104542. [id: string]: AbstractMesh | undefined;
  104543. }>;
  104544. /**
  104545. * Creates a material instance
  104546. * @param name defines the name of the material
  104547. * @param scene defines the scene to reference
  104548. * @param doNotAdd specifies if the material should be added to the scene
  104549. */
  104550. constructor(name: string, scene: Scene, doNotAdd?: boolean);
  104551. /**
  104552. * Returns a string representation of the current material
  104553. * @param fullDetails defines a boolean indicating which levels of logging is desired
  104554. * @returns a string with material information
  104555. */
  104556. toString(fullDetails?: boolean): string;
  104557. /**
  104558. * Gets the class name of the material
  104559. * @returns a string with the class name of the material
  104560. */
  104561. getClassName(): string;
  104562. /**
  104563. * Specifies if updates for the material been locked
  104564. */
  104565. get isFrozen(): boolean;
  104566. /**
  104567. * Locks updates for the material
  104568. */
  104569. freeze(): void;
  104570. /**
  104571. * Unlocks updates for the material
  104572. */
  104573. unfreeze(): void;
  104574. /**
  104575. * Specifies if the material is ready to be used
  104576. * @param mesh defines the mesh to check
  104577. * @param useInstances specifies if instances should be used
  104578. * @returns a boolean indicating if the material is ready to be used
  104579. */
  104580. isReady(mesh?: AbstractMesh, useInstances?: boolean): boolean;
  104581. /**
  104582. * Specifies that the submesh is ready to be used
  104583. * @param mesh defines the mesh to check
  104584. * @param subMesh defines which submesh to check
  104585. * @param useInstances specifies that instances should be used
  104586. * @returns a boolean indicating that the submesh is ready or not
  104587. */
  104588. isReadyForSubMesh(mesh: AbstractMesh, subMesh: SubMesh, useInstances?: boolean): boolean;
  104589. /**
  104590. * Returns the material effect
  104591. * @returns the effect associated with the material
  104592. */
  104593. getEffect(): Nullable<Effect>;
  104594. /**
  104595. * Returns the current scene
  104596. * @returns a Scene
  104597. */
  104598. getScene(): Scene;
  104599. /**
  104600. * Enforces alpha test in opaque or blend mode in order to improve the performances of some situations.
  104601. */
  104602. protected _forceAlphaTest: boolean;
  104603. /**
  104604. * The transparency mode of the material.
  104605. */
  104606. protected _transparencyMode: Nullable<number>;
  104607. /**
  104608. * Gets the current transparency mode.
  104609. */
  104610. get transparencyMode(): Nullable<number>;
  104611. /**
  104612. * Sets the transparency mode of the material.
  104613. *
  104614. * | Value | Type | Description |
  104615. * | ----- | ----------------------------------- | ----------- |
  104616. * | 0 | OPAQUE | |
  104617. * | 1 | ALPHATEST | |
  104618. * | 2 | ALPHABLEND | |
  104619. * | 3 | ALPHATESTANDBLEND | |
  104620. *
  104621. */
  104622. set transparencyMode(value: Nullable<number>);
  104623. /**
  104624. * Returns true if alpha blending should be disabled.
  104625. */
  104626. protected get _disableAlphaBlending(): boolean;
  104627. /**
  104628. * Specifies whether or not this material should be rendered in alpha blend mode.
  104629. * @returns a boolean specifying if alpha blending is needed
  104630. */
  104631. needAlphaBlending(): boolean;
  104632. /**
  104633. * Specifies if the mesh will require alpha blending
  104634. * @param mesh defines the mesh to check
  104635. * @returns a boolean specifying if alpha blending is needed for the mesh
  104636. */
  104637. needAlphaBlendingForMesh(mesh: AbstractMesh): boolean;
  104638. /**
  104639. * Specifies whether or not this material should be rendered in alpha test mode.
  104640. * @returns a boolean specifying if an alpha test is needed.
  104641. */
  104642. needAlphaTesting(): boolean;
  104643. /**
  104644. * Specifies if material alpha testing should be turned on for the mesh
  104645. * @param mesh defines the mesh to check
  104646. */
  104647. protected _shouldTurnAlphaTestOn(mesh: AbstractMesh): boolean;
  104648. /**
  104649. * Gets the texture used for the alpha test
  104650. * @returns the texture to use for alpha testing
  104651. */
  104652. getAlphaTestTexture(): Nullable<BaseTexture>;
  104653. /**
  104654. * Marks the material to indicate that it needs to be re-calculated
  104655. */
  104656. markDirty(): void;
  104657. /** @hidden */
  104658. _preBind(effect?: Effect, overrideOrientation?: Nullable<number>): boolean;
  104659. /**
  104660. * Binds the material to the mesh
  104661. * @param world defines the world transformation matrix
  104662. * @param mesh defines the mesh to bind the material to
  104663. */
  104664. bind(world: Matrix, mesh?: Mesh): void;
  104665. /**
  104666. * Binds the submesh to the material
  104667. * @param world defines the world transformation matrix
  104668. * @param mesh defines the mesh containing the submesh
  104669. * @param subMesh defines the submesh to bind the material to
  104670. */
  104671. bindForSubMesh(world: Matrix, mesh: Mesh, subMesh: SubMesh): void;
  104672. /**
  104673. * Binds the world matrix to the material
  104674. * @param world defines the world transformation matrix
  104675. */
  104676. bindOnlyWorldMatrix(world: Matrix): void;
  104677. /**
  104678. * Binds the scene's uniform buffer to the effect.
  104679. * @param effect defines the effect to bind to the scene uniform buffer
  104680. * @param sceneUbo defines the uniform buffer storing scene data
  104681. */
  104682. bindSceneUniformBuffer(effect: Effect, sceneUbo: UniformBuffer): void;
  104683. /**
  104684. * Binds the view matrix to the effect
  104685. * @param effect defines the effect to bind the view matrix to
  104686. */
  104687. bindView(effect: Effect): void;
  104688. /**
  104689. * Binds the view projection matrix to the effect
  104690. * @param effect defines the effect to bind the view projection matrix to
  104691. */
  104692. bindViewProjection(effect: Effect): void;
  104693. /**
  104694. * Processes to execute after binding the material to a mesh
  104695. * @param mesh defines the rendered mesh
  104696. */
  104697. protected _afterBind(mesh?: Mesh): void;
  104698. /**
  104699. * Unbinds the material from the mesh
  104700. */
  104701. unbind(): void;
  104702. /**
  104703. * Gets the active textures from the material
  104704. * @returns an array of textures
  104705. */
  104706. getActiveTextures(): BaseTexture[];
  104707. /**
  104708. * Specifies if the material uses a texture
  104709. * @param texture defines the texture to check against the material
  104710. * @returns a boolean specifying if the material uses the texture
  104711. */
  104712. hasTexture(texture: BaseTexture): boolean;
  104713. /**
  104714. * Makes a duplicate of the material, and gives it a new name
  104715. * @param name defines the new name for the duplicated material
  104716. * @returns the cloned material
  104717. */
  104718. clone(name: string): Nullable<Material>;
  104719. /**
  104720. * Gets the meshes bound to the material
  104721. * @returns an array of meshes bound to the material
  104722. */
  104723. getBindedMeshes(): AbstractMesh[];
  104724. /**
  104725. * Force shader compilation
  104726. * @param mesh defines the mesh associated with this material
  104727. * @param onCompiled defines a function to execute once the material is compiled
  104728. * @param options defines the options to configure the compilation
  104729. * @param onError defines a function to execute if the material fails compiling
  104730. */
  104731. forceCompilation(mesh: AbstractMesh, onCompiled?: (material: Material) => void, options?: Partial<IMaterialCompilationOptions>, onError?: (reason: string) => void): void;
  104732. /**
  104733. * Force shader compilation
  104734. * @param mesh defines the mesh that will use this material
  104735. * @param options defines additional options for compiling the shaders
  104736. * @returns a promise that resolves when the compilation completes
  104737. */
  104738. forceCompilationAsync(mesh: AbstractMesh, options?: Partial<IMaterialCompilationOptions>): Promise<void>;
  104739. private static readonly _AllDirtyCallBack;
  104740. private static readonly _ImageProcessingDirtyCallBack;
  104741. private static readonly _TextureDirtyCallBack;
  104742. private static readonly _FresnelDirtyCallBack;
  104743. private static readonly _MiscDirtyCallBack;
  104744. private static readonly _LightsDirtyCallBack;
  104745. private static readonly _AttributeDirtyCallBack;
  104746. private static _FresnelAndMiscDirtyCallBack;
  104747. private static _TextureAndMiscDirtyCallBack;
  104748. private static readonly _DirtyCallbackArray;
  104749. private static readonly _RunDirtyCallBacks;
  104750. /**
  104751. * Marks a define in the material to indicate that it needs to be re-computed
  104752. * @param flag defines a flag used to determine which parts of the material have to be marked as dirty
  104753. */
  104754. markAsDirty(flag: number): void;
  104755. /**
  104756. * Marks all submeshes of a material to indicate that their material defines need to be re-calculated
  104757. * @param func defines a function which checks material defines against the submeshes
  104758. */
  104759. protected _markAllSubMeshesAsDirty(func: (defines: MaterialDefines) => void): void;
  104760. /**
  104761. * Indicates that the scene should check if the rendering now needs a prepass
  104762. */
  104763. protected _markScenePrePassDirty(): void;
  104764. /**
  104765. * Indicates that we need to re-calculated for all submeshes
  104766. */
  104767. protected _markAllSubMeshesAsAllDirty(): void;
  104768. /**
  104769. * Indicates that image processing needs to be re-calculated for all submeshes
  104770. */
  104771. protected _markAllSubMeshesAsImageProcessingDirty(): void;
  104772. /**
  104773. * Indicates that textures need to be re-calculated for all submeshes
  104774. */
  104775. protected _markAllSubMeshesAsTexturesDirty(): void;
  104776. /**
  104777. * Indicates that fresnel needs to be re-calculated for all submeshes
  104778. */
  104779. protected _markAllSubMeshesAsFresnelDirty(): void;
  104780. /**
  104781. * Indicates that fresnel and misc need to be re-calculated for all submeshes
  104782. */
  104783. protected _markAllSubMeshesAsFresnelAndMiscDirty(): void;
  104784. /**
  104785. * Indicates that lights need to be re-calculated for all submeshes
  104786. */
  104787. protected _markAllSubMeshesAsLightsDirty(): void;
  104788. /**
  104789. * Indicates that attributes need to be re-calculated for all submeshes
  104790. */
  104791. protected _markAllSubMeshesAsAttributesDirty(): void;
  104792. /**
  104793. * Indicates that misc needs to be re-calculated for all submeshes
  104794. */
  104795. protected _markAllSubMeshesAsMiscDirty(): void;
  104796. /**
  104797. * Indicates that textures and misc need to be re-calculated for all submeshes
  104798. */
  104799. protected _markAllSubMeshesAsTexturesAndMiscDirty(): void;
  104800. /**
  104801. * Sets the required values to the prepass renderer.
  104802. * @param prePassRenderer defines the prepass renderer to setup.
  104803. * @returns true if the pre pass is needed.
  104804. */
  104805. setPrePassRenderer(prePassRenderer: PrePassRenderer): boolean;
  104806. /**
  104807. * Disposes the material
  104808. * @param forceDisposeEffect specifies if effects should be forcefully disposed
  104809. * @param forceDisposeTextures specifies if textures should be forcefully disposed
  104810. * @param notBoundToMesh specifies if the material that is being disposed is known to be not bound to any mesh
  104811. */
  104812. dispose(forceDisposeEffect?: boolean, forceDisposeTextures?: boolean, notBoundToMesh?: boolean): void;
  104813. /** @hidden */
  104814. private releaseVertexArrayObject;
  104815. /**
  104816. * Serializes this material
  104817. * @returns the serialized material object
  104818. */
  104819. serialize(): any;
  104820. /**
  104821. * Creates a material from parsed material data
  104822. * @param parsedMaterial defines parsed material data
  104823. * @param scene defines the hosting scene
  104824. * @param rootUrl defines the root URL to use to load textures
  104825. * @returns a new material
  104826. */
  104827. static Parse(parsedMaterial: any, scene: Scene, rootUrl: string): Nullable<Material>;
  104828. }
  104829. }
  104830. declare module BABYLON {
  104831. /**
  104832. * A multi-material is used to apply different materials to different parts of the same object without the need of
  104833. * separate meshes. This can be use to improve performances.
  104834. * @see https://doc.babylonjs.com/how_to/multi_materials
  104835. */
  104836. export class MultiMaterial extends Material {
  104837. private _subMaterials;
  104838. /**
  104839. * Gets or Sets the list of Materials used within the multi material.
  104840. * They need to be ordered according to the submeshes order in the associated mesh
  104841. */
  104842. get subMaterials(): Nullable<Material>[];
  104843. set subMaterials(value: Nullable<Material>[]);
  104844. /**
  104845. * Function used to align with Node.getChildren()
  104846. * @returns the list of Materials used within the multi material
  104847. */
  104848. getChildren(): Nullable<Material>[];
  104849. /**
  104850. * Instantiates a new Multi Material
  104851. * A multi-material is used to apply different materials to different parts of the same object without the need of
  104852. * separate meshes. This can be use to improve performances.
  104853. * @see https://doc.babylonjs.com/how_to/multi_materials
  104854. * @param name Define the name in the scene
  104855. * @param scene Define the scene the material belongs to
  104856. */
  104857. constructor(name: string, scene: Scene);
  104858. private _hookArray;
  104859. /**
  104860. * Get one of the submaterial by its index in the submaterials array
  104861. * @param index The index to look the sub material at
  104862. * @returns The Material if the index has been defined
  104863. */
  104864. getSubMaterial(index: number): Nullable<Material>;
  104865. /**
  104866. * Get the list of active textures for the whole sub materials list.
  104867. * @returns All the textures that will be used during the rendering
  104868. */
  104869. getActiveTextures(): BaseTexture[];
  104870. /**
  104871. * Gets the current class name of the material e.g. "MultiMaterial"
  104872. * Mainly use in serialization.
  104873. * @returns the class name
  104874. */
  104875. getClassName(): string;
  104876. /**
  104877. * Checks if the material is ready to render the requested sub mesh
  104878. * @param mesh Define the mesh the submesh belongs to
  104879. * @param subMesh Define the sub mesh to look readyness for
  104880. * @param useInstances Define whether or not the material is used with instances
  104881. * @returns true if ready, otherwise false
  104882. */
  104883. isReadyForSubMesh(mesh: AbstractMesh, subMesh: SubMesh, useInstances?: boolean): boolean;
  104884. /**
  104885. * Clones the current material and its related sub materials
  104886. * @param name Define the name of the newly cloned material
  104887. * @param cloneChildren Define if submaterial will be cloned or shared with the parent instance
  104888. * @returns the cloned material
  104889. */
  104890. clone(name: string, cloneChildren?: boolean): MultiMaterial;
  104891. /**
  104892. * Serializes the materials into a JSON representation.
  104893. * @returns the JSON representation
  104894. */
  104895. serialize(): any;
  104896. /**
  104897. * Dispose the material and release its associated resources
  104898. * @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)
  104899. * @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)
  104900. * @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)
  104901. */
  104902. dispose(forceDisposeEffect?: boolean, forceDisposeTextures?: boolean, forceDisposeChildren?: boolean): void;
  104903. /**
  104904. * Creates a MultiMaterial from parsed MultiMaterial data.
  104905. * @param parsedMultiMaterial defines parsed MultiMaterial data.
  104906. * @param scene defines the hosting scene
  104907. * @returns a new MultiMaterial
  104908. */
  104909. static ParseMultiMaterial(parsedMultiMaterial: any, scene: Scene): MultiMaterial;
  104910. }
  104911. }
  104912. declare module BABYLON {
  104913. /**
  104914. * Defines a subdivision inside a mesh
  104915. */
  104916. export class SubMesh implements ICullable {
  104917. /** the material index to use */
  104918. materialIndex: number;
  104919. /** vertex index start */
  104920. verticesStart: number;
  104921. /** vertices count */
  104922. verticesCount: number;
  104923. /** index start */
  104924. indexStart: number;
  104925. /** indices count */
  104926. indexCount: number;
  104927. /** @hidden */
  104928. _materialDefines: Nullable<MaterialDefines>;
  104929. /** @hidden */
  104930. _materialEffect: Nullable<Effect>;
  104931. /** @hidden */
  104932. _effectOverride: Nullable<Effect>;
  104933. /**
  104934. * Gets material defines used by the effect associated to the sub mesh
  104935. */
  104936. get materialDefines(): Nullable<MaterialDefines>;
  104937. /**
  104938. * Sets material defines used by the effect associated to the sub mesh
  104939. */
  104940. set materialDefines(defines: Nullable<MaterialDefines>);
  104941. /**
  104942. * Gets associated effect
  104943. */
  104944. get effect(): Nullable<Effect>;
  104945. /**
  104946. * Sets associated effect (effect used to render this submesh)
  104947. * @param effect defines the effect to associate with
  104948. * @param defines defines the set of defines used to compile this effect
  104949. */
  104950. setEffect(effect: Nullable<Effect>, defines?: Nullable<MaterialDefines>): void;
  104951. /** @hidden */
  104952. _linesIndexCount: number;
  104953. private _mesh;
  104954. private _renderingMesh;
  104955. private _boundingInfo;
  104956. private _linesIndexBuffer;
  104957. /** @hidden */
  104958. _lastColliderWorldVertices: Nullable<Vector3[]>;
  104959. /** @hidden */
  104960. _trianglePlanes: Plane[];
  104961. /** @hidden */
  104962. _lastColliderTransformMatrix: Nullable<Matrix>;
  104963. /** @hidden */
  104964. _renderId: number;
  104965. /** @hidden */
  104966. _alphaIndex: number;
  104967. /** @hidden */
  104968. _distanceToCamera: number;
  104969. /** @hidden */
  104970. _id: number;
  104971. private _currentMaterial;
  104972. /**
  104973. * Add a new submesh to a mesh
  104974. * @param materialIndex defines the material index to use
  104975. * @param verticesStart defines vertex index start
  104976. * @param verticesCount defines vertices count
  104977. * @param indexStart defines index start
  104978. * @param indexCount defines indices count
  104979. * @param mesh defines the parent mesh
  104980. * @param renderingMesh defines an optional rendering mesh
  104981. * @param createBoundingBox defines if bounding box should be created for this submesh
  104982. * @returns the new submesh
  104983. */
  104984. static AddToMesh(materialIndex: number, verticesStart: number, verticesCount: number, indexStart: number, indexCount: number, mesh: AbstractMesh, renderingMesh?: Mesh, createBoundingBox?: boolean): SubMesh;
  104985. /**
  104986. * Creates a new submesh
  104987. * @param materialIndex defines the material index to use
  104988. * @param verticesStart defines vertex index start
  104989. * @param verticesCount defines vertices count
  104990. * @param indexStart defines index start
  104991. * @param indexCount defines indices count
  104992. * @param mesh defines the parent mesh
  104993. * @param renderingMesh defines an optional rendering mesh
  104994. * @param createBoundingBox defines if bounding box should be created for this submesh
  104995. * @param addToMesh defines a boolean indicating that the submesh must be added to the mesh.subMeshes array (true by default)
  104996. */
  104997. constructor(
  104998. /** the material index to use */
  104999. materialIndex: number,
  105000. /** vertex index start */
  105001. verticesStart: number,
  105002. /** vertices count */
  105003. verticesCount: number,
  105004. /** index start */
  105005. indexStart: number,
  105006. /** indices count */
  105007. indexCount: number, mesh: AbstractMesh, renderingMesh?: Mesh, createBoundingBox?: boolean, addToMesh?: boolean);
  105008. /**
  105009. * Returns true if this submesh covers the entire parent mesh
  105010. * @ignorenaming
  105011. */
  105012. get IsGlobal(): boolean;
  105013. /**
  105014. * Returns the submesh BoudingInfo object
  105015. * @returns current bounding info (or mesh's one if the submesh is global)
  105016. */
  105017. getBoundingInfo(): BoundingInfo;
  105018. /**
  105019. * Sets the submesh BoundingInfo
  105020. * @param boundingInfo defines the new bounding info to use
  105021. * @returns the SubMesh
  105022. */
  105023. setBoundingInfo(boundingInfo: BoundingInfo): SubMesh;
  105024. /**
  105025. * Returns the mesh of the current submesh
  105026. * @return the parent mesh
  105027. */
  105028. getMesh(): AbstractMesh;
  105029. /**
  105030. * Returns the rendering mesh of the submesh
  105031. * @returns the rendering mesh (could be different from parent mesh)
  105032. */
  105033. getRenderingMesh(): Mesh;
  105034. /**
  105035. * Returns the replacement mesh of the submesh
  105036. * @returns the replacement mesh (could be different from parent mesh)
  105037. */
  105038. getReplacementMesh(): Nullable<AbstractMesh>;
  105039. /**
  105040. * Returns the effective mesh of the submesh
  105041. * @returns the effective mesh (could be different from parent mesh)
  105042. */
  105043. getEffectiveMesh(): AbstractMesh;
  105044. /**
  105045. * Returns the submesh material
  105046. * @returns null or the current material
  105047. */
  105048. getMaterial(): Nullable<Material>;
  105049. private _IsMultiMaterial;
  105050. /**
  105051. * Sets a new updated BoundingInfo object to the submesh
  105052. * @param data defines an optional position array to use to determine the bounding info
  105053. * @returns the SubMesh
  105054. */
  105055. refreshBoundingInfo(data?: Nullable<FloatArray>): SubMesh;
  105056. /** @hidden */
  105057. _checkCollision(collider: Collider): boolean;
  105058. /**
  105059. * Updates the submesh BoundingInfo
  105060. * @param world defines the world matrix to use to update the bounding info
  105061. * @returns the submesh
  105062. */
  105063. updateBoundingInfo(world: DeepImmutable<Matrix>): SubMesh;
  105064. /**
  105065. * True is the submesh bounding box intersects the frustum defined by the passed array of planes.
  105066. * @param frustumPlanes defines the frustum planes
  105067. * @returns true if the submesh is intersecting with the frustum
  105068. */
  105069. isInFrustum(frustumPlanes: Plane[]): boolean;
  105070. /**
  105071. * True is the submesh bounding box is completely inside the frustum defined by the passed array of planes
  105072. * @param frustumPlanes defines the frustum planes
  105073. * @returns true if the submesh is inside the frustum
  105074. */
  105075. isCompletelyInFrustum(frustumPlanes: Plane[]): boolean;
  105076. /**
  105077. * Renders the submesh
  105078. * @param enableAlphaMode defines if alpha needs to be used
  105079. * @returns the submesh
  105080. */
  105081. render(enableAlphaMode: boolean): SubMesh;
  105082. /**
  105083. * @hidden
  105084. */
  105085. _getLinesIndexBuffer(indices: IndicesArray, engine: Engine): DataBuffer;
  105086. /**
  105087. * Checks if the submesh intersects with a ray
  105088. * @param ray defines the ray to test
  105089. * @returns true is the passed ray intersects the submesh bounding box
  105090. */
  105091. canIntersects(ray: Ray): boolean;
  105092. /**
  105093. * Intersects current submesh with a ray
  105094. * @param ray defines the ray to test
  105095. * @param positions defines mesh's positions array
  105096. * @param indices defines mesh's indices array
  105097. * @param fastCheck defines if the first intersection will be used (and not the closest)
  105098. * @param trianglePredicate defines an optional predicate used to select faces when a mesh intersection is detected
  105099. * @returns intersection info or null if no intersection
  105100. */
  105101. intersects(ray: Ray, positions: Vector3[], indices: IndicesArray, fastCheck?: boolean, trianglePredicate?: TrianglePickingPredicate): Nullable<IntersectionInfo>;
  105102. /** @hidden */
  105103. private _intersectLines;
  105104. /** @hidden */
  105105. private _intersectUnIndexedLines;
  105106. /** @hidden */
  105107. private _intersectTriangles;
  105108. /** @hidden */
  105109. private _intersectUnIndexedTriangles;
  105110. /** @hidden */
  105111. _rebuild(): void;
  105112. /**
  105113. * Creates a new submesh from the passed mesh
  105114. * @param newMesh defines the new hosting mesh
  105115. * @param newRenderingMesh defines an optional rendering mesh
  105116. * @returns the new submesh
  105117. */
  105118. clone(newMesh: AbstractMesh, newRenderingMesh?: Mesh): SubMesh;
  105119. /**
  105120. * Release associated resources
  105121. */
  105122. dispose(): void;
  105123. /**
  105124. * Gets the class name
  105125. * @returns the string "SubMesh".
  105126. */
  105127. getClassName(): string;
  105128. /**
  105129. * Creates a new submesh from indices data
  105130. * @param materialIndex the index of the main mesh material
  105131. * @param startIndex the index where to start the copy in the mesh indices array
  105132. * @param indexCount the number of indices to copy then from the startIndex
  105133. * @param mesh the main mesh to create the submesh from
  105134. * @param renderingMesh the optional rendering mesh
  105135. * @returns a new submesh
  105136. */
  105137. static CreateFromIndices(materialIndex: number, startIndex: number, indexCount: number, mesh: AbstractMesh, renderingMesh?: Mesh): SubMesh;
  105138. }
  105139. }
  105140. declare module BABYLON {
  105141. /**
  105142. * Class used to represent data loading progression
  105143. */
  105144. export class SceneLoaderFlags {
  105145. private static _ForceFullSceneLoadingForIncremental;
  105146. private static _ShowLoadingScreen;
  105147. private static _CleanBoneMatrixWeights;
  105148. private static _loggingLevel;
  105149. /**
  105150. * Gets or sets a boolean indicating if entire scene must be loaded even if scene contains incremental data
  105151. */
  105152. static get ForceFullSceneLoadingForIncremental(): boolean;
  105153. static set ForceFullSceneLoadingForIncremental(value: boolean);
  105154. /**
  105155. * Gets or sets a boolean indicating if loading screen must be displayed while loading a scene
  105156. */
  105157. static get ShowLoadingScreen(): boolean;
  105158. static set ShowLoadingScreen(value: boolean);
  105159. /**
  105160. * Defines the current logging level (while loading the scene)
  105161. * @ignorenaming
  105162. */
  105163. static get loggingLevel(): number;
  105164. static set loggingLevel(value: number);
  105165. /**
  105166. * Gets or set a boolean indicating if matrix weights must be cleaned upon loading
  105167. */
  105168. static get CleanBoneMatrixWeights(): boolean;
  105169. static set CleanBoneMatrixWeights(value: boolean);
  105170. }
  105171. }
  105172. declare module BABYLON {
  105173. /**
  105174. * Class used to store geometry data (vertex buffers + index buffer)
  105175. */
  105176. export class Geometry implements IGetSetVerticesData {
  105177. /**
  105178. * Gets or sets the ID of the geometry
  105179. */
  105180. id: string;
  105181. /**
  105182. * Gets or sets the unique ID of the geometry
  105183. */
  105184. uniqueId: number;
  105185. /**
  105186. * Gets the delay loading state of the geometry (none by default which means not delayed)
  105187. */
  105188. delayLoadState: number;
  105189. /**
  105190. * Gets the file containing the data to load when running in delay load state
  105191. */
  105192. delayLoadingFile: Nullable<string>;
  105193. /**
  105194. * Callback called when the geometry is updated
  105195. */
  105196. onGeometryUpdated: (geometry: Geometry, kind?: string) => void;
  105197. private _scene;
  105198. private _engine;
  105199. private _meshes;
  105200. private _totalVertices;
  105201. /** @hidden */
  105202. _indices: IndicesArray;
  105203. /** @hidden */
  105204. _vertexBuffers: {
  105205. [key: string]: VertexBuffer;
  105206. };
  105207. private _isDisposed;
  105208. private _extend;
  105209. private _boundingBias;
  105210. /** @hidden */
  105211. _delayInfo: Array<string>;
  105212. private _indexBuffer;
  105213. private _indexBufferIsUpdatable;
  105214. /** @hidden */
  105215. _boundingInfo: Nullable<BoundingInfo>;
  105216. /** @hidden */
  105217. _delayLoadingFunction: Nullable<(any: any, geometry: Geometry) => void>;
  105218. /** @hidden */
  105219. _softwareSkinningFrameId: number;
  105220. private _vertexArrayObjects;
  105221. private _updatable;
  105222. /** @hidden */
  105223. _positions: Nullable<Vector3[]>;
  105224. /**
  105225. * 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
  105226. */
  105227. get boundingBias(): Vector2;
  105228. /**
  105229. * 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
  105230. */
  105231. set boundingBias(value: Vector2);
  105232. /**
  105233. * Static function used to attach a new empty geometry to a mesh
  105234. * @param mesh defines the mesh to attach the geometry to
  105235. * @returns the new Geometry
  105236. */
  105237. static CreateGeometryForMesh(mesh: Mesh): Geometry;
  105238. /** Get the list of meshes using this geometry */
  105239. get meshes(): Mesh[];
  105240. /**
  105241. * 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
  105242. * and won't be computed based on the vertex positions (which is what we get when useBoundingInfoFromGeometry = false)
  105243. */
  105244. useBoundingInfoFromGeometry: boolean;
  105245. /**
  105246. * Creates a new geometry
  105247. * @param id defines the unique ID
  105248. * @param scene defines the hosting scene
  105249. * @param vertexData defines the VertexData used to get geometry data
  105250. * @param updatable defines if geometry must be updatable (false by default)
  105251. * @param mesh defines the mesh that will be associated with the geometry
  105252. */
  105253. constructor(id: string, scene: Scene, vertexData?: VertexData, updatable?: boolean, mesh?: Nullable<Mesh>);
  105254. /**
  105255. * Gets the current extend of the geometry
  105256. */
  105257. get extend(): {
  105258. minimum: Vector3;
  105259. maximum: Vector3;
  105260. };
  105261. /**
  105262. * Gets the hosting scene
  105263. * @returns the hosting Scene
  105264. */
  105265. getScene(): Scene;
  105266. /**
  105267. * Gets the hosting engine
  105268. * @returns the hosting Engine
  105269. */
  105270. getEngine(): Engine;
  105271. /**
  105272. * Defines if the geometry is ready to use
  105273. * @returns true if the geometry is ready to be used
  105274. */
  105275. isReady(): boolean;
  105276. /**
  105277. * Gets a value indicating that the geometry should not be serialized
  105278. */
  105279. get doNotSerialize(): boolean;
  105280. /** @hidden */
  105281. _rebuild(): void;
  105282. /**
  105283. * Affects all geometry data in one call
  105284. * @param vertexData defines the geometry data
  105285. * @param updatable defines if the geometry must be flagged as updatable (false as default)
  105286. */
  105287. setAllVerticesData(vertexData: VertexData, updatable?: boolean): void;
  105288. /**
  105289. * Set specific vertex data
  105290. * @param kind defines the data kind (Position, normal, etc...)
  105291. * @param data defines the vertex data to use
  105292. * @param updatable defines if the vertex must be flagged as updatable (false as default)
  105293. * @param stride defines the stride to use (0 by default). This value is deduced from the kind value if not specified
  105294. */
  105295. setVerticesData(kind: string, data: FloatArray, updatable?: boolean, stride?: number): void;
  105296. /**
  105297. * Removes a specific vertex data
  105298. * @param kind defines the data kind (Position, normal, etc...)
  105299. */
  105300. removeVerticesData(kind: string): void;
  105301. /**
  105302. * Affect a vertex buffer to the geometry. the vertexBuffer.getKind() function is used to determine where to store the data
  105303. * @param buffer defines the vertex buffer to use
  105304. * @param totalVertices defines the total number of vertices for position kind (could be null)
  105305. */
  105306. setVerticesBuffer(buffer: VertexBuffer, totalVertices?: Nullable<number>): void;
  105307. /**
  105308. * Update a specific vertex buffer
  105309. * This function will directly update the underlying DataBuffer according to the passed numeric array or Float32Array
  105310. * It will do nothing if the buffer is not updatable
  105311. * @param kind defines the data kind (Position, normal, etc...)
  105312. * @param data defines the data to use
  105313. * @param offset defines the offset in the target buffer where to store the data
  105314. * @param useBytes set to true if the offset is in bytes
  105315. */
  105316. updateVerticesDataDirectly(kind: string, data: DataArray, offset: number, useBytes?: boolean): void;
  105317. /**
  105318. * Update a specific vertex buffer
  105319. * This function will create a new buffer if the current one is not updatable
  105320. * @param kind defines the data kind (Position, normal, etc...)
  105321. * @param data defines the data to use
  105322. * @param updateExtends defines if the geometry extends must be recomputed (false by default)
  105323. */
  105324. updateVerticesData(kind: string, data: FloatArray, updateExtends?: boolean): void;
  105325. private _updateBoundingInfo;
  105326. /** @hidden */
  105327. _bind(effect: Nullable<Effect>, indexToBind?: Nullable<DataBuffer>): void;
  105328. /**
  105329. * Gets total number of vertices
  105330. * @returns the total number of vertices
  105331. */
  105332. getTotalVertices(): number;
  105333. /**
  105334. * Gets a specific vertex data attached to this geometry. Float data is constructed if the vertex buffer data cannot be returned directly.
  105335. * @param kind defines the data kind (Position, normal, etc...)
  105336. * @param copyWhenShared defines if the returned array must be cloned upon returning it if the current geometry is shared between multiple meshes
  105337. * @param forceCopy defines a boolean indicating that the returned array must be cloned upon returning it
  105338. * @returns a float array containing vertex data
  105339. */
  105340. getVerticesData(kind: string, copyWhenShared?: boolean, forceCopy?: boolean): Nullable<FloatArray>;
  105341. /**
  105342. * Returns a boolean defining if the vertex data for the requested `kind` is updatable
  105343. * @param kind defines the data kind (Position, normal, etc...)
  105344. * @returns true if the vertex buffer with the specified kind is updatable
  105345. */
  105346. isVertexBufferUpdatable(kind: string): boolean;
  105347. /**
  105348. * Gets a specific vertex buffer
  105349. * @param kind defines the data kind (Position, normal, etc...)
  105350. * @returns a VertexBuffer
  105351. */
  105352. getVertexBuffer(kind: string): Nullable<VertexBuffer>;
  105353. /**
  105354. * Returns all vertex buffers
  105355. * @return an object holding all vertex buffers indexed by kind
  105356. */
  105357. getVertexBuffers(): Nullable<{
  105358. [key: string]: VertexBuffer;
  105359. }>;
  105360. /**
  105361. * Gets a boolean indicating if specific vertex buffer is present
  105362. * @param kind defines the data kind (Position, normal, etc...)
  105363. * @returns true if data is present
  105364. */
  105365. isVerticesDataPresent(kind: string): boolean;
  105366. /**
  105367. * Gets a list of all attached data kinds (Position, normal, etc...)
  105368. * @returns a list of string containing all kinds
  105369. */
  105370. getVerticesDataKinds(): string[];
  105371. /**
  105372. * Update index buffer
  105373. * @param indices defines the indices to store in the index buffer
  105374. * @param offset defines the offset in the target buffer where to store the data
  105375. * @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)
  105376. */
  105377. updateIndices(indices: IndicesArray, offset?: number, gpuMemoryOnly?: boolean): void;
  105378. /**
  105379. * Creates a new index buffer
  105380. * @param indices defines the indices to store in the index buffer
  105381. * @param totalVertices defines the total number of vertices (could be null)
  105382. * @param updatable defines if the index buffer must be flagged as updatable (false by default)
  105383. */
  105384. setIndices(indices: IndicesArray, totalVertices?: Nullable<number>, updatable?: boolean): void;
  105385. /**
  105386. * Return the total number of indices
  105387. * @returns the total number of indices
  105388. */
  105389. getTotalIndices(): number;
  105390. /**
  105391. * Gets the index buffer array
  105392. * @param copyWhenShared defines if the returned array must be cloned upon returning it if the current geometry is shared between multiple meshes
  105393. * @param forceCopy defines a boolean indicating that the returned array must be cloned upon returning it
  105394. * @returns the index buffer array
  105395. */
  105396. getIndices(copyWhenShared?: boolean, forceCopy?: boolean): Nullable<IndicesArray>;
  105397. /**
  105398. * Gets the index buffer
  105399. * @return the index buffer
  105400. */
  105401. getIndexBuffer(): Nullable<DataBuffer>;
  105402. /** @hidden */
  105403. _releaseVertexArrayObject(effect?: Nullable<Effect>): void;
  105404. /**
  105405. * Release the associated resources for a specific mesh
  105406. * @param mesh defines the source mesh
  105407. * @param shouldDispose defines if the geometry must be disposed if there is no more mesh pointing to it
  105408. */
  105409. releaseForMesh(mesh: Mesh, shouldDispose?: boolean): void;
  105410. /**
  105411. * Apply current geometry to a given mesh
  105412. * @param mesh defines the mesh to apply geometry to
  105413. */
  105414. applyToMesh(mesh: Mesh): void;
  105415. private _updateExtend;
  105416. private _applyToMesh;
  105417. private notifyUpdate;
  105418. /**
  105419. * Load the geometry if it was flagged as delay loaded
  105420. * @param scene defines the hosting scene
  105421. * @param onLoaded defines a callback called when the geometry is loaded
  105422. */
  105423. load(scene: Scene, onLoaded?: () => void): void;
  105424. private _queueLoad;
  105425. /**
  105426. * Invert the geometry to move from a right handed system to a left handed one.
  105427. */
  105428. toLeftHanded(): void;
  105429. /** @hidden */
  105430. _resetPointsArrayCache(): void;
  105431. /** @hidden */
  105432. _generatePointsArray(): boolean;
  105433. /**
  105434. * Gets a value indicating if the geometry is disposed
  105435. * @returns true if the geometry was disposed
  105436. */
  105437. isDisposed(): boolean;
  105438. private _disposeVertexArrayObjects;
  105439. /**
  105440. * Free all associated resources
  105441. */
  105442. dispose(): void;
  105443. /**
  105444. * Clone the current geometry into a new geometry
  105445. * @param id defines the unique ID of the new geometry
  105446. * @returns a new geometry object
  105447. */
  105448. copy(id: string): Geometry;
  105449. /**
  105450. * Serialize the current geometry info (and not the vertices data) into a JSON object
  105451. * @return a JSON representation of the current geometry data (without the vertices data)
  105452. */
  105453. serialize(): any;
  105454. private toNumberArray;
  105455. /**
  105456. * Serialize all vertices data into a JSON oject
  105457. * @returns a JSON representation of the current geometry data
  105458. */
  105459. serializeVerticeData(): any;
  105460. /**
  105461. * Extracts a clone of a mesh geometry
  105462. * @param mesh defines the source mesh
  105463. * @param id defines the unique ID of the new geometry object
  105464. * @returns the new geometry object
  105465. */
  105466. static ExtractFromMesh(mesh: Mesh, id: string): Nullable<Geometry>;
  105467. /**
  105468. * You should now use Tools.RandomId(), this method is still here for legacy reasons.
  105469. * Implementation from http://stackoverflow.com/questions/105034/how-to-create-a-guid-uuid-in-javascript/2117523#answer-2117523
  105470. * Be aware Math.random() could cause collisions, but:
  105471. * "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"
  105472. * @returns a string containing a new GUID
  105473. */
  105474. static RandomId(): string;
  105475. /** @hidden */
  105476. static _ImportGeometry(parsedGeometry: any, mesh: Mesh): void;
  105477. private static _CleanMatricesWeights;
  105478. /**
  105479. * Create a new geometry from persisted data (Using .babylon file format)
  105480. * @param parsedVertexData defines the persisted data
  105481. * @param scene defines the hosting scene
  105482. * @param rootUrl defines the root url to use to load assets (like delayed data)
  105483. * @returns the new geometry object
  105484. */
  105485. static Parse(parsedVertexData: any, scene: Scene, rootUrl: string): Nullable<Geometry>;
  105486. }
  105487. }
  105488. declare module BABYLON {
  105489. /**
  105490. * Define an interface for all classes that will get and set the data on vertices
  105491. */
  105492. export interface IGetSetVerticesData {
  105493. /**
  105494. * Gets a boolean indicating if specific vertex data is present
  105495. * @param kind defines the vertex data kind to use
  105496. * @returns true is data kind is present
  105497. */
  105498. isVerticesDataPresent(kind: string): boolean;
  105499. /**
  105500. * Gets a specific vertex data attached to this geometry. Float data is constructed if the vertex buffer data cannot be returned directly.
  105501. * @param kind defines the data kind (Position, normal, etc...)
  105502. * @param copyWhenShared defines if the returned array must be cloned upon returning it if the current geometry is shared between multiple meshes
  105503. * @param forceCopy defines a boolean indicating that the returned array must be cloned upon returning it
  105504. * @returns a float array containing vertex data
  105505. */
  105506. getVerticesData(kind: string, copyWhenShared?: boolean, forceCopy?: boolean): Nullable<FloatArray>;
  105507. /**
  105508. * Returns an array of integers or a typed array (Int32Array, Uint32Array, Uint16Array) populated with the mesh indices.
  105509. * @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.
  105510. * @param forceCopy defines a boolean indicating that the returned array must be cloned upon returning it
  105511. * @returns the indices array or an empty array if the mesh has no geometry
  105512. */
  105513. getIndices(copyWhenShared?: boolean, forceCopy?: boolean): Nullable<IndicesArray>;
  105514. /**
  105515. * Set specific vertex data
  105516. * @param kind defines the data kind (Position, normal, etc...)
  105517. * @param data defines the vertex data to use
  105518. * @param updatable defines if the vertex must be flagged as updatable (false as default)
  105519. * @param stride defines the stride to use (0 by default). This value is deduced from the kind value if not specified
  105520. */
  105521. setVerticesData(kind: string, data: FloatArray, updatable: boolean): void;
  105522. /**
  105523. * Update a specific associated vertex buffer
  105524. * @param kind defines which buffer to write to (positions, indices, normals, etc). Possible `kind` values :
  105525. * - VertexBuffer.PositionKind
  105526. * - VertexBuffer.UVKind
  105527. * - VertexBuffer.UV2Kind
  105528. * - VertexBuffer.UV3Kind
  105529. * - VertexBuffer.UV4Kind
  105530. * - VertexBuffer.UV5Kind
  105531. * - VertexBuffer.UV6Kind
  105532. * - VertexBuffer.ColorKind
  105533. * - VertexBuffer.MatricesIndicesKind
  105534. * - VertexBuffer.MatricesIndicesExtraKind
  105535. * - VertexBuffer.MatricesWeightsKind
  105536. * - VertexBuffer.MatricesWeightsExtraKind
  105537. * @param data defines the data source
  105538. * @param updateExtends defines if extends info of the mesh must be updated (can be null). This is mostly useful for "position" kind
  105539. * @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)
  105540. */
  105541. updateVerticesData(kind: string, data: FloatArray, updateExtends?: boolean, makeItUnique?: boolean): void;
  105542. /**
  105543. * Creates a new index buffer
  105544. * @param indices defines the indices to store in the index buffer
  105545. * @param totalVertices defines the total number of vertices (could be null)
  105546. * @param updatable defines if the index buffer must be flagged as updatable (false by default)
  105547. */
  105548. setIndices(indices: IndicesArray, totalVertices: Nullable<number>, updatable?: boolean): void;
  105549. }
  105550. /**
  105551. * This class contains the various kinds of data on every vertex of a mesh used in determining its shape and appearance
  105552. */
  105553. export class VertexData {
  105554. /**
  105555. * Mesh side orientation : usually the external or front surface
  105556. */
  105557. static readonly FRONTSIDE: number;
  105558. /**
  105559. * Mesh side orientation : usually the internal or back surface
  105560. */
  105561. static readonly BACKSIDE: number;
  105562. /**
  105563. * Mesh side orientation : both internal and external or front and back surfaces
  105564. */
  105565. static readonly DOUBLESIDE: number;
  105566. /**
  105567. * Mesh side orientation : by default, `FRONTSIDE`
  105568. */
  105569. static readonly DEFAULTSIDE: number;
  105570. /**
  105571. * An array of the x, y, z position of each vertex [...., x, y, z, .....]
  105572. */
  105573. positions: Nullable<FloatArray>;
  105574. /**
  105575. * An array of the x, y, z normal vector of each vertex [...., x, y, z, .....]
  105576. */
  105577. normals: Nullable<FloatArray>;
  105578. /**
  105579. * An array of the x, y, z tangent vector of each vertex [...., x, y, z, .....]
  105580. */
  105581. tangents: Nullable<FloatArray>;
  105582. /**
  105583. * An array of u,v which maps a texture image onto each vertex [...., u, v, .....]
  105584. */
  105585. uvs: Nullable<FloatArray>;
  105586. /**
  105587. * A second array of u,v which maps a texture image onto each vertex [...., u, v, .....]
  105588. */
  105589. uvs2: Nullable<FloatArray>;
  105590. /**
  105591. * A third array of u,v which maps a texture image onto each vertex [...., u, v, .....]
  105592. */
  105593. uvs3: Nullable<FloatArray>;
  105594. /**
  105595. * A fourth array of u,v which maps a texture image onto each vertex [...., u, v, .....]
  105596. */
  105597. uvs4: Nullable<FloatArray>;
  105598. /**
  105599. * A fifth array of u,v which maps a texture image onto each vertex [...., u, v, .....]
  105600. */
  105601. uvs5: Nullable<FloatArray>;
  105602. /**
  105603. * A sixth array of u,v which maps a texture image onto each vertex [...., u, v, .....]
  105604. */
  105605. uvs6: Nullable<FloatArray>;
  105606. /**
  105607. * An array of the r, g, b, a, color of each vertex [...., r, g, b, a, .....]
  105608. */
  105609. colors: Nullable<FloatArray>;
  105610. /**
  105611. * 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).
  105612. */
  105613. matricesIndices: Nullable<FloatArray>;
  105614. /**
  105615. * An array containing the list of weights defining the weight of each indexed matrix in the final computation
  105616. */
  105617. matricesWeights: Nullable<FloatArray>;
  105618. /**
  105619. * An array extending the number of possible indices
  105620. */
  105621. matricesIndicesExtra: Nullable<FloatArray>;
  105622. /**
  105623. * An array extending the number of possible weights when the number of indices is extended
  105624. */
  105625. matricesWeightsExtra: Nullable<FloatArray>;
  105626. /**
  105627. * An array of i, j, k the three vertex indices required for each triangular facet [...., i, j, k .....]
  105628. */
  105629. indices: Nullable<IndicesArray>;
  105630. /**
  105631. * Uses the passed data array to set the set the values for the specified kind of data
  105632. * @param data a linear array of floating numbers
  105633. * @param kind the type of data that is being set, eg positions, colors etc
  105634. */
  105635. set(data: FloatArray, kind: string): void;
  105636. /**
  105637. * Associates the vertexData to the passed Mesh.
  105638. * Sets it as updatable or not (default `false`)
  105639. * @param mesh the mesh the vertexData is applied to
  105640. * @param updatable when used and having the value true allows new data to update the vertexData
  105641. * @returns the VertexData
  105642. */
  105643. applyToMesh(mesh: Mesh, updatable?: boolean): VertexData;
  105644. /**
  105645. * Associates the vertexData to the passed Geometry.
  105646. * Sets it as updatable or not (default `false`)
  105647. * @param geometry the geometry the vertexData is applied to
  105648. * @param updatable when used and having the value true allows new data to update the vertexData
  105649. * @returns VertexData
  105650. */
  105651. applyToGeometry(geometry: Geometry, updatable?: boolean): VertexData;
  105652. /**
  105653. * Updates the associated mesh
  105654. * @param mesh the mesh to be updated
  105655. * @param updateExtends when true the mesh BoundingInfo will be renewed when and if position kind is updated, optional with default false
  105656. * @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
  105657. * @returns VertexData
  105658. */
  105659. updateMesh(mesh: Mesh): VertexData;
  105660. /**
  105661. * Updates the associated geometry
  105662. * @param geometry the geometry to be updated
  105663. * @param updateExtends when true BoundingInfo will be renewed when and if position kind is updated, optional with default false
  105664. * @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
  105665. * @returns VertexData.
  105666. */
  105667. updateGeometry(geometry: Geometry): VertexData;
  105668. private _applyTo;
  105669. private _update;
  105670. /**
  105671. * Transforms each position and each normal of the vertexData according to the passed Matrix
  105672. * @param matrix the transforming matrix
  105673. * @returns the VertexData
  105674. */
  105675. transform(matrix: Matrix): VertexData;
  105676. /**
  105677. * Merges the passed VertexData into the current one
  105678. * @param other the VertexData to be merged into the current one
  105679. * @param use32BitsIndices defines a boolean indicating if indices must be store in a 32 bits array
  105680. * @returns the modified VertexData
  105681. */
  105682. merge(other: VertexData, use32BitsIndices?: boolean): VertexData;
  105683. private _mergeElement;
  105684. private _validate;
  105685. /**
  105686. * Serializes the VertexData
  105687. * @returns a serialized object
  105688. */
  105689. serialize(): any;
  105690. /**
  105691. * Extracts the vertexData from a mesh
  105692. * @param mesh the mesh from which to extract the VertexData
  105693. * @param copyWhenShared defines if the VertexData must be cloned when shared between multiple meshes, optional, default false
  105694. * @param forceCopy indicating that the VertexData must be cloned, optional, default false
  105695. * @returns the object VertexData associated to the passed mesh
  105696. */
  105697. static ExtractFromMesh(mesh: Mesh, copyWhenShared?: boolean, forceCopy?: boolean): VertexData;
  105698. /**
  105699. * Extracts the vertexData from the geometry
  105700. * @param geometry the geometry from which to extract the VertexData
  105701. * @param copyWhenShared defines if the VertexData must be cloned when the geometrty is shared between multiple meshes, optional, default false
  105702. * @param forceCopy indicating that the VertexData must be cloned, optional, default false
  105703. * @returns the object VertexData associated to the passed mesh
  105704. */
  105705. static ExtractFromGeometry(geometry: Geometry, copyWhenShared?: boolean, forceCopy?: boolean): VertexData;
  105706. private static _ExtractFrom;
  105707. /**
  105708. * Creates the VertexData for a Ribbon
  105709. * @param options an object used to set the following optional parameters for the ribbon, required but can be empty
  105710. * * pathArray array of paths, each of which an array of successive Vector3
  105711. * * closeArray creates a seam between the first and the last paths of the pathArray, optional, default false
  105712. * * closePath creates a seam between the first and the last points of each path of the path array, optional, default false
  105713. * * 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
  105714. * * sideOrientation optional and takes the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  105715. * * 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)
  105716. * * 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)
  105717. * * invertUV swaps in the U and V coordinates when applying a texture, optional, default false
  105718. * * uvs a linear array, of length 2 * number of vertices, of custom UV values, optional
  105719. * * colors a linear array, of length 4 * number of vertices, of custom color values, optional
  105720. * @returns the VertexData of the ribbon
  105721. */
  105722. static CreateRibbon(options: {
  105723. pathArray: Vector3[][];
  105724. closeArray?: boolean;
  105725. closePath?: boolean;
  105726. offset?: number;
  105727. sideOrientation?: number;
  105728. frontUVs?: Vector4;
  105729. backUVs?: Vector4;
  105730. invertUV?: boolean;
  105731. uvs?: Vector2[];
  105732. colors?: Color4[];
  105733. }): VertexData;
  105734. /**
  105735. * Creates the VertexData for a box
  105736. * @param options an object used to set the following optional parameters for the box, required but can be empty
  105737. * * size sets the width, height and depth of the box to the value of size, optional default 1
  105738. * * width sets the width (x direction) of the box, overwrites the width set by size, optional, default size
  105739. * * height sets the height (y direction) of the box, overwrites the height set by size, optional, default size
  105740. * * depth sets the depth (z direction) of the box, overwrites the depth set by size, optional, default size
  105741. * * faceUV an array of 6 Vector4 elements used to set different images to each box side
  105742. * * faceColors an array of 6 Color3 elements used to set different colors to each box side
  105743. * * sideOrientation optional and takes the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  105744. * * 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)
  105745. * * 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)
  105746. * @returns the VertexData of the box
  105747. */
  105748. static CreateBox(options: {
  105749. size?: number;
  105750. width?: number;
  105751. height?: number;
  105752. depth?: number;
  105753. faceUV?: Vector4[];
  105754. faceColors?: Color4[];
  105755. sideOrientation?: number;
  105756. frontUVs?: Vector4;
  105757. backUVs?: Vector4;
  105758. }): VertexData;
  105759. /**
  105760. * Creates the VertexData for a tiled box
  105761. * @param options an object used to set the following optional parameters for the box, required but can be empty
  105762. * * faceTiles sets the pattern, tile size and number of tiles for a face
  105763. * * faceUV an array of 6 Vector4 elements used to set different images to each box side
  105764. * * faceColors an array of 6 Color3 elements used to set different colors to each box side
  105765. * * sideOrientation optional and takes the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  105766. * @returns the VertexData of the box
  105767. */
  105768. static CreateTiledBox(options: {
  105769. pattern?: number;
  105770. width?: number;
  105771. height?: number;
  105772. depth?: number;
  105773. tileSize?: number;
  105774. tileWidth?: number;
  105775. tileHeight?: number;
  105776. alignHorizontal?: number;
  105777. alignVertical?: number;
  105778. faceUV?: Vector4[];
  105779. faceColors?: Color4[];
  105780. sideOrientation?: number;
  105781. }): VertexData;
  105782. /**
  105783. * Creates the VertexData for a tiled plane
  105784. * @param options an object used to set the following optional parameters for the box, required but can be empty
  105785. * * pattern a limited pattern arrangement depending on the number
  105786. * * tileSize sets the width, height and depth of the tile to the value of size, optional default 1
  105787. * * tileWidth sets the width (x direction) of the tile, overwrites the width set by size, optional, default size
  105788. * * tileHeight sets the height (y direction) of the tile, overwrites the height set by size, optional, default size
  105789. * * sideOrientation optional and takes the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  105790. * * 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)
  105791. * * 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)
  105792. * @returns the VertexData of the tiled plane
  105793. */
  105794. static CreateTiledPlane(options: {
  105795. pattern?: number;
  105796. tileSize?: number;
  105797. tileWidth?: number;
  105798. tileHeight?: number;
  105799. size?: number;
  105800. width?: number;
  105801. height?: number;
  105802. alignHorizontal?: number;
  105803. alignVertical?: number;
  105804. sideOrientation?: number;
  105805. frontUVs?: Vector4;
  105806. backUVs?: Vector4;
  105807. }): VertexData;
  105808. /**
  105809. * Creates the VertexData for an ellipsoid, defaults to a sphere
  105810. * @param options an object used to set the following optional parameters for the box, required but can be empty
  105811. * * segments sets the number of horizontal strips optional, default 32
  105812. * * diameter sets the axes dimensions, diameterX, diameterY and diameterZ to the value of diameter, optional default 1
  105813. * * diameterX sets the diameterX (x direction) of the ellipsoid, overwrites the diameterX set by diameter, optional, default diameter
  105814. * * diameterY sets the diameterY (y direction) of the ellipsoid, overwrites the diameterY set by diameter, optional, default diameter
  105815. * * diameterZ sets the diameterZ (z direction) of the ellipsoid, overwrites the diameterZ set by diameter, optional, default diameter
  105816. * * 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
  105817. * * 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
  105818. * * sideOrientation optional and takes the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  105819. * * 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)
  105820. * * 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)
  105821. * @returns the VertexData of the ellipsoid
  105822. */
  105823. static CreateSphere(options: {
  105824. segments?: number;
  105825. diameter?: number;
  105826. diameterX?: number;
  105827. diameterY?: number;
  105828. diameterZ?: number;
  105829. arc?: number;
  105830. slice?: number;
  105831. sideOrientation?: number;
  105832. frontUVs?: Vector4;
  105833. backUVs?: Vector4;
  105834. }): VertexData;
  105835. /**
  105836. * Creates the VertexData for a cylinder, cone or prism
  105837. * @param options an object used to set the following optional parameters for the box, required but can be empty
  105838. * * height sets the height (y direction) of the cylinder, optional, default 2
  105839. * * diameterTop sets the diameter of the top of the cone, overwrites diameter, optional, default diameter
  105840. * * diameterBottom sets the diameter of the bottom of the cone, overwrites diameter, optional, default diameter
  105841. * * diameter sets the diameter of the top and bottom of the cone, optional default 1
  105842. * * tessellation the number of prism sides, 3 for a triangular prism, optional, default 24
  105843. * * subdivisions` the number of rings along the cylinder height, optional, default 1
  105844. * * 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
  105845. * * faceColors an array of Color3 elements used to set different colors to the top, rings and bottom respectively
  105846. * * faceUV an array of Vector4 elements used to set different images to the top, rings and bottom respectively
  105847. * * hasRings when true makes each subdivision independantly treated as a face for faceUV and faceColors, optional, default false
  105848. * * enclose when true closes an open cylinder by adding extra flat faces between the height axis and vertical edges, think cut cake
  105849. * * sideOrientation optional and takes the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  105850. * * frontUvs only usable when you create a double-sided mesh, used to choose what parts of the texture image to crop and apply on the front side, optional, default vector4 (0, 0, 1, 1)
  105851. * * backUVs only usable when you create a double-sided mesh, used to choose what parts of the texture image to crop and apply on the back side, optional, default vector4 (0, 0, 1, 1)
  105852. * @returns the VertexData of the cylinder, cone or prism
  105853. */
  105854. static CreateCylinder(options: {
  105855. height?: number;
  105856. diameterTop?: number;
  105857. diameterBottom?: number;
  105858. diameter?: number;
  105859. tessellation?: number;
  105860. subdivisions?: number;
  105861. arc?: number;
  105862. faceColors?: Color4[];
  105863. faceUV?: Vector4[];
  105864. hasRings?: boolean;
  105865. enclose?: boolean;
  105866. sideOrientation?: number;
  105867. frontUVs?: Vector4;
  105868. backUVs?: Vector4;
  105869. }): VertexData;
  105870. /**
  105871. * Creates the VertexData for a torus
  105872. * @param options an object used to set the following optional parameters for the box, required but can be empty
  105873. * * diameter the diameter of the torus, optional default 1
  105874. * * thickness the diameter of the tube forming the torus, optional default 0.5
  105875. * * tessellation the number of prism sides, 3 for a triangular prism, optional, default 24
  105876. * * sideOrientation optional and takes the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  105877. * * 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)
  105878. * * 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)
  105879. * @returns the VertexData of the torus
  105880. */
  105881. static CreateTorus(options: {
  105882. diameter?: number;
  105883. thickness?: number;
  105884. tessellation?: number;
  105885. sideOrientation?: number;
  105886. frontUVs?: Vector4;
  105887. backUVs?: Vector4;
  105888. }): VertexData;
  105889. /**
  105890. * Creates the VertexData of the LineSystem
  105891. * @param options an object used to set the following optional parameters for the LineSystem, required but can be empty
  105892. * - lines an array of lines, each line being an array of successive Vector3
  105893. * - colors an array of line colors, each of the line colors being an array of successive Color4, one per line point
  105894. * @returns the VertexData of the LineSystem
  105895. */
  105896. static CreateLineSystem(options: {
  105897. lines: Vector3[][];
  105898. colors?: Nullable<Color4[][]>;
  105899. }): VertexData;
  105900. /**
  105901. * Create the VertexData for a DashedLines
  105902. * @param options an object used to set the following optional parameters for the DashedLines, required but can be empty
  105903. * - points an array successive Vector3
  105904. * - dashSize the size of the dashes relative to the dash number, optional, default 3
  105905. * - gapSize the size of the gap between two successive dashes relative to the dash number, optional, default 1
  105906. * - dashNb the intended total number of dashes, optional, default 200
  105907. * @returns the VertexData for the DashedLines
  105908. */
  105909. static CreateDashedLines(options: {
  105910. points: Vector3[];
  105911. dashSize?: number;
  105912. gapSize?: number;
  105913. dashNb?: number;
  105914. }): VertexData;
  105915. /**
  105916. * Creates the VertexData for a Ground
  105917. * @param options an object used to set the following optional parameters for the Ground, required but can be empty
  105918. * - width the width (x direction) of the ground, optional, default 1
  105919. * - height the height (z direction) of the ground, optional, default 1
  105920. * - subdivisions the number of subdivisions per side, optional, default 1
  105921. * @returns the VertexData of the Ground
  105922. */
  105923. static CreateGround(options: {
  105924. width?: number;
  105925. height?: number;
  105926. subdivisions?: number;
  105927. subdivisionsX?: number;
  105928. subdivisionsY?: number;
  105929. }): VertexData;
  105930. /**
  105931. * Creates the VertexData for a TiledGround by subdividing the ground into tiles
  105932. * @param options an object used to set the following optional parameters for the Ground, required but can be empty
  105933. * * xmin the ground minimum X coordinate, optional, default -1
  105934. * * zmin the ground minimum Z coordinate, optional, default -1
  105935. * * xmax the ground maximum X coordinate, optional, default 1
  105936. * * zmax the ground maximum Z coordinate, optional, default 1
  105937. * * 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}
  105938. * * 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}
  105939. * @returns the VertexData of the TiledGround
  105940. */
  105941. static CreateTiledGround(options: {
  105942. xmin: number;
  105943. zmin: number;
  105944. xmax: number;
  105945. zmax: number;
  105946. subdivisions?: {
  105947. w: number;
  105948. h: number;
  105949. };
  105950. precision?: {
  105951. w: number;
  105952. h: number;
  105953. };
  105954. }): VertexData;
  105955. /**
  105956. * Creates the VertexData of the Ground designed from a heightmap
  105957. * @param options an object used to set the following parameters for the Ground, required and provided by MeshBuilder.CreateGroundFromHeightMap
  105958. * * width the width (x direction) of the ground
  105959. * * height the height (z direction) of the ground
  105960. * * subdivisions the number of subdivisions per side
  105961. * * minHeight the minimum altitude on the ground, optional, default 0
  105962. * * maxHeight the maximum altitude on the ground, optional default 1
  105963. * * colorFilter the filter to apply to the image pixel colors to compute the height, optional Color3, default (0.3, 0.59, 0.11)
  105964. * * buffer the array holding the image color data
  105965. * * bufferWidth the width of image
  105966. * * bufferHeight the height of image
  105967. * * alphaFilter Remove any data where the alpha channel is below this value, defaults 0 (all data visible)
  105968. * @returns the VertexData of the Ground designed from a heightmap
  105969. */
  105970. static CreateGroundFromHeightMap(options: {
  105971. width: number;
  105972. height: number;
  105973. subdivisions: number;
  105974. minHeight: number;
  105975. maxHeight: number;
  105976. colorFilter: Color3;
  105977. buffer: Uint8Array;
  105978. bufferWidth: number;
  105979. bufferHeight: number;
  105980. alphaFilter: number;
  105981. }): VertexData;
  105982. /**
  105983. * Creates the VertexData for a Plane
  105984. * @param options an object used to set the following optional parameters for the plane, required but can be empty
  105985. * * size sets the width and height of the plane to the value of size, optional default 1
  105986. * * width sets the width (x direction) of the plane, overwrites the width set by size, optional, default size
  105987. * * height sets the height (y direction) of the plane, overwrites the height set by size, optional, default size
  105988. * * sideOrientation optional and takes the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  105989. * * 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)
  105990. * * 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)
  105991. * @returns the VertexData of the box
  105992. */
  105993. static CreatePlane(options: {
  105994. size?: number;
  105995. width?: number;
  105996. height?: number;
  105997. sideOrientation?: number;
  105998. frontUVs?: Vector4;
  105999. backUVs?: Vector4;
  106000. }): VertexData;
  106001. /**
  106002. * Creates the VertexData of the Disc or regular Polygon
  106003. * @param options an object used to set the following optional parameters for the disc, required but can be empty
  106004. * * radius the radius of the disc, optional default 0.5
  106005. * * tessellation the number of polygon sides, optional, default 64
  106006. * * 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
  106007. * * sideOrientation optional and takes the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  106008. * * 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)
  106009. * * 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)
  106010. * @returns the VertexData of the box
  106011. */
  106012. static CreateDisc(options: {
  106013. radius?: number;
  106014. tessellation?: number;
  106015. arc?: number;
  106016. sideOrientation?: number;
  106017. frontUVs?: Vector4;
  106018. backUVs?: Vector4;
  106019. }): VertexData;
  106020. /**
  106021. * Creates the VertexData for an irregular Polygon in the XoZ plane using a mesh built by polygonTriangulation.build()
  106022. * All parameters are provided by MeshBuilder.CreatePolygon as needed
  106023. * @param polygon a mesh built from polygonTriangulation.build()
  106024. * @param sideOrientation takes the values Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  106025. * @param fUV an array of Vector4 elements used to set different images to the top, rings and bottom respectively
  106026. * @param fColors an array of Color3 elements used to set different colors to the top, rings and bottom respectively
  106027. * @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)
  106028. * @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)
  106029. * @param wrap a boolean, default false, when true and fUVs used texture is wrapped around all sides, when false texture is applied side
  106030. * @returns the VertexData of the Polygon
  106031. */
  106032. static CreatePolygon(polygon: Mesh, sideOrientation: number, fUV?: Vector4[], fColors?: Color4[], frontUVs?: Vector4, backUVs?: Vector4, wrap?: boolean): VertexData;
  106033. /**
  106034. * Creates the VertexData of the IcoSphere
  106035. * @param options an object used to set the following optional parameters for the IcoSphere, required but can be empty
  106036. * * radius the radius of the IcoSphere, optional default 1
  106037. * * radiusX allows stretching in the x direction, optional, default radius
  106038. * * radiusY allows stretching in the y direction, optional, default radius
  106039. * * radiusZ allows stretching in the z direction, optional, default radius
  106040. * * flat when true creates a flat shaded mesh, optional, default true
  106041. * * subdivisions increasing the subdivisions increases the number of faces, optional, default 4
  106042. * * sideOrientation optional and takes the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  106043. * * 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)
  106044. * * 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)
  106045. * @returns the VertexData of the IcoSphere
  106046. */
  106047. static CreateIcoSphere(options: {
  106048. radius?: number;
  106049. radiusX?: number;
  106050. radiusY?: number;
  106051. radiusZ?: number;
  106052. flat?: boolean;
  106053. subdivisions?: number;
  106054. sideOrientation?: number;
  106055. frontUVs?: Vector4;
  106056. backUVs?: Vector4;
  106057. }): VertexData;
  106058. /**
  106059. * Creates the VertexData for a Polyhedron
  106060. * @param options an object used to set the following optional parameters for the polyhedron, required but can be empty
  106061. * * type provided types are:
  106062. * * 0 : Tetrahedron, 1 : Octahedron, 2 : Dodecahedron, 3 : Icosahedron, 4 : Rhombicuboctahedron, 5 : Triangular Prism, 6 : Pentagonal Prism, 7 : Hexagonal Prism, 8 : Square Pyramid (J1)
  106063. * * 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)
  106064. * * size the size of the IcoSphere, optional default 1
  106065. * * sizeX allows stretching in the x direction, optional, default size
  106066. * * sizeY allows stretching in the y direction, optional, default size
  106067. * * sizeZ allows stretching in the z direction, optional, default size
  106068. * * 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
  106069. * * faceUV an array of Vector4 elements used to set different images to the top, rings and bottom respectively
  106070. * * faceColors an array of Color3 elements used to set different colors to the top, rings and bottom respectively
  106071. * * flat when true creates a flat shaded mesh, optional, default true
  106072. * * subdivisions increasing the subdivisions increases the number of faces, optional, default 4
  106073. * * sideOrientation optional and takes the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  106074. * * frontUvs only usable when you create a double-sided mesh, used to choose what parts of the texture image to crop and apply on the front side, optional, default vector4 (0, 0, 1, 1)
  106075. * * backUVs only usable when you create a double-sided mesh, used to choose what parts of the texture image to crop and apply on the back side, optional, default vector4 (0, 0, 1, 1)
  106076. * @returns the VertexData of the Polyhedron
  106077. */
  106078. static CreatePolyhedron(options: {
  106079. type?: number;
  106080. size?: number;
  106081. sizeX?: number;
  106082. sizeY?: number;
  106083. sizeZ?: number;
  106084. custom?: any;
  106085. faceUV?: Vector4[];
  106086. faceColors?: Color4[];
  106087. flat?: boolean;
  106088. sideOrientation?: number;
  106089. frontUVs?: Vector4;
  106090. backUVs?: Vector4;
  106091. }): VertexData;
  106092. /**
  106093. * Creates the VertexData for a TorusKnot
  106094. * @param options an object used to set the following optional parameters for the TorusKnot, required but can be empty
  106095. * * radius the radius of the torus knot, optional, default 2
  106096. * * tube the thickness of the tube, optional, default 0.5
  106097. * * radialSegments the number of sides on each tube segments, optional, default 32
  106098. * * tubularSegments the number of tubes to decompose the knot into, optional, default 32
  106099. * * p the number of windings around the z axis, optional, default 2
  106100. * * q the number of windings around the x axis, optional, default 3
  106101. * * sideOrientation optional and takes the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  106102. * * 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)
  106103. * * 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)
  106104. * @returns the VertexData of the Torus Knot
  106105. */
  106106. static CreateTorusKnot(options: {
  106107. radius?: number;
  106108. tube?: number;
  106109. radialSegments?: number;
  106110. tubularSegments?: number;
  106111. p?: number;
  106112. q?: number;
  106113. sideOrientation?: number;
  106114. frontUVs?: Vector4;
  106115. backUVs?: Vector4;
  106116. }): VertexData;
  106117. /**
  106118. * Compute normals for given positions and indices
  106119. * @param positions an array of vertex positions, [...., x, y, z, ......]
  106120. * @param indices an array of indices in groups of three for each triangular facet, [...., i, j, k, ......]
  106121. * @param normals an array of vertex normals, [...., x, y, z, ......]
  106122. * @param options an object used to set the following optional parameters for the TorusKnot, optional
  106123. * * facetNormals : optional array of facet normals (vector3)
  106124. * * facetPositions : optional array of facet positions (vector3)
  106125. * * facetPartitioning : optional partitioning array. facetPositions is required for facetPartitioning computation
  106126. * * ratio : optional partitioning ratio / bounding box, required for facetPartitioning computation
  106127. * * bInfo : optional bounding info, required for facetPartitioning computation
  106128. * * bbSize : optional bounding box size data, required for facetPartitioning computation
  106129. * * subDiv : optional partitioning data about subdivsions on each axis (int), required for facetPartitioning computation
  106130. * * useRightHandedSystem: optional boolean to for right handed system computation
  106131. * * depthSort : optional boolean to enable the facet depth sort computation
  106132. * * distanceTo : optional Vector3 to compute the facet depth from this location
  106133. * * depthSortedFacets : optional array of depthSortedFacets to store the facet distances from the reference location
  106134. */
  106135. static ComputeNormals(positions: any, indices: any, normals: any, options?: {
  106136. facetNormals?: any;
  106137. facetPositions?: any;
  106138. facetPartitioning?: any;
  106139. ratio?: number;
  106140. bInfo?: any;
  106141. bbSize?: Vector3;
  106142. subDiv?: any;
  106143. useRightHandedSystem?: boolean;
  106144. depthSort?: boolean;
  106145. distanceTo?: Vector3;
  106146. depthSortedFacets?: any;
  106147. }): void;
  106148. /** @hidden */
  106149. static _ComputeSides(sideOrientation: number, positions: FloatArray, indices: FloatArray, normals: FloatArray, uvs: FloatArray, frontUVs?: Vector4, backUVs?: Vector4): void;
  106150. /**
  106151. * Applies VertexData created from the imported parameters to the geometry
  106152. * @param parsedVertexData the parsed data from an imported file
  106153. * @param geometry the geometry to apply the VertexData to
  106154. */
  106155. static ImportVertexData(parsedVertexData: any, geometry: Geometry): void;
  106156. }
  106157. }
  106158. declare module BABYLON {
  106159. /**
  106160. * Defines a target to use with MorphTargetManager
  106161. * @see https://doc.babylonjs.com/how_to/how_to_use_morphtargets
  106162. */
  106163. export class MorphTarget implements IAnimatable {
  106164. /** defines the name of the target */
  106165. name: string;
  106166. /**
  106167. * Gets or sets the list of animations
  106168. */
  106169. animations: Animation[];
  106170. private _scene;
  106171. private _positions;
  106172. private _normals;
  106173. private _tangents;
  106174. private _uvs;
  106175. private _influence;
  106176. private _uniqueId;
  106177. /**
  106178. * Observable raised when the influence changes
  106179. */
  106180. onInfluenceChanged: Observable<boolean>;
  106181. /** @hidden */
  106182. _onDataLayoutChanged: Observable<void>;
  106183. /**
  106184. * Gets or sets the influence of this target (ie. its weight in the overall morphing)
  106185. */
  106186. get influence(): number;
  106187. set influence(influence: number);
  106188. /**
  106189. * Gets or sets the id of the morph Target
  106190. */
  106191. id: string;
  106192. private _animationPropertiesOverride;
  106193. /**
  106194. * Gets or sets the animation properties override
  106195. */
  106196. get animationPropertiesOverride(): Nullable<AnimationPropertiesOverride>;
  106197. set animationPropertiesOverride(value: Nullable<AnimationPropertiesOverride>);
  106198. /**
  106199. * Creates a new MorphTarget
  106200. * @param name defines the name of the target
  106201. * @param influence defines the influence to use
  106202. * @param scene defines the scene the morphtarget belongs to
  106203. */
  106204. constructor(
  106205. /** defines the name of the target */
  106206. name: string, influence?: number, scene?: Nullable<Scene>);
  106207. /**
  106208. * Gets the unique ID of this manager
  106209. */
  106210. get uniqueId(): number;
  106211. /**
  106212. * Gets a boolean defining if the target contains position data
  106213. */
  106214. get hasPositions(): boolean;
  106215. /**
  106216. * Gets a boolean defining if the target contains normal data
  106217. */
  106218. get hasNormals(): boolean;
  106219. /**
  106220. * Gets a boolean defining if the target contains tangent data
  106221. */
  106222. get hasTangents(): boolean;
  106223. /**
  106224. * Gets a boolean defining if the target contains texture coordinates data
  106225. */
  106226. get hasUVs(): boolean;
  106227. /**
  106228. * Affects position data to this target
  106229. * @param data defines the position data to use
  106230. */
  106231. setPositions(data: Nullable<FloatArray>): void;
  106232. /**
  106233. * Gets the position data stored in this target
  106234. * @returns a FloatArray containing the position data (or null if not present)
  106235. */
  106236. getPositions(): Nullable<FloatArray>;
  106237. /**
  106238. * Affects normal data to this target
  106239. * @param data defines the normal data to use
  106240. */
  106241. setNormals(data: Nullable<FloatArray>): void;
  106242. /**
  106243. * Gets the normal data stored in this target
  106244. * @returns a FloatArray containing the normal data (or null if not present)
  106245. */
  106246. getNormals(): Nullable<FloatArray>;
  106247. /**
  106248. * Affects tangent data to this target
  106249. * @param data defines the tangent data to use
  106250. */
  106251. setTangents(data: Nullable<FloatArray>): void;
  106252. /**
  106253. * Gets the tangent data stored in this target
  106254. * @returns a FloatArray containing the tangent data (or null if not present)
  106255. */
  106256. getTangents(): Nullable<FloatArray>;
  106257. /**
  106258. * Affects texture coordinates data to this target
  106259. * @param data defines the texture coordinates data to use
  106260. */
  106261. setUVs(data: Nullable<FloatArray>): void;
  106262. /**
  106263. * Gets the texture coordinates data stored in this target
  106264. * @returns a FloatArray containing the texture coordinates data (or null if not present)
  106265. */
  106266. getUVs(): Nullable<FloatArray>;
  106267. /**
  106268. * Clone the current target
  106269. * @returns a new MorphTarget
  106270. */
  106271. clone(): MorphTarget;
  106272. /**
  106273. * Serializes the current target into a Serialization object
  106274. * @returns the serialized object
  106275. */
  106276. serialize(): any;
  106277. /**
  106278. * Returns the string "MorphTarget"
  106279. * @returns "MorphTarget"
  106280. */
  106281. getClassName(): string;
  106282. /**
  106283. * Creates a new target from serialized data
  106284. * @param serializationObject defines the serialized data to use
  106285. * @returns a new MorphTarget
  106286. */
  106287. static Parse(serializationObject: any): MorphTarget;
  106288. /**
  106289. * Creates a MorphTarget from mesh data
  106290. * @param mesh defines the source mesh
  106291. * @param name defines the name to use for the new target
  106292. * @param influence defines the influence to attach to the target
  106293. * @returns a new MorphTarget
  106294. */
  106295. static FromMesh(mesh: AbstractMesh, name?: string, influence?: number): MorphTarget;
  106296. }
  106297. }
  106298. declare module BABYLON {
  106299. /**
  106300. * This class is used to deform meshes using morphing between different targets
  106301. * @see https://doc.babylonjs.com/how_to/how_to_use_morphtargets
  106302. */
  106303. export class MorphTargetManager {
  106304. private _targets;
  106305. private _targetInfluenceChangedObservers;
  106306. private _targetDataLayoutChangedObservers;
  106307. private _activeTargets;
  106308. private _scene;
  106309. private _influences;
  106310. private _supportsNormals;
  106311. private _supportsTangents;
  106312. private _supportsUVs;
  106313. private _vertexCount;
  106314. private _uniqueId;
  106315. private _tempInfluences;
  106316. /**
  106317. * Gets or sets a boolean indicating if normals must be morphed
  106318. */
  106319. enableNormalMorphing: boolean;
  106320. /**
  106321. * Gets or sets a boolean indicating if tangents must be morphed
  106322. */
  106323. enableTangentMorphing: boolean;
  106324. /**
  106325. * Gets or sets a boolean indicating if UV must be morphed
  106326. */
  106327. enableUVMorphing: boolean;
  106328. /**
  106329. * Creates a new MorphTargetManager
  106330. * @param scene defines the current scene
  106331. */
  106332. constructor(scene?: Nullable<Scene>);
  106333. /**
  106334. * Gets the unique ID of this manager
  106335. */
  106336. get uniqueId(): number;
  106337. /**
  106338. * Gets the number of vertices handled by this manager
  106339. */
  106340. get vertexCount(): number;
  106341. /**
  106342. * Gets a boolean indicating if this manager supports morphing of normals
  106343. */
  106344. get supportsNormals(): boolean;
  106345. /**
  106346. * Gets a boolean indicating if this manager supports morphing of tangents
  106347. */
  106348. get supportsTangents(): boolean;
  106349. /**
  106350. * Gets a boolean indicating if this manager supports morphing of texture coordinates
  106351. */
  106352. get supportsUVs(): boolean;
  106353. /**
  106354. * Gets the number of targets stored in this manager
  106355. */
  106356. get numTargets(): number;
  106357. /**
  106358. * Gets the number of influencers (ie. the number of targets with influences > 0)
  106359. */
  106360. get numInfluencers(): number;
  106361. /**
  106362. * Gets the list of influences (one per target)
  106363. */
  106364. get influences(): Float32Array;
  106365. /**
  106366. * Gets the active target at specified index. An active target is a target with an influence > 0
  106367. * @param index defines the index to check
  106368. * @returns the requested target
  106369. */
  106370. getActiveTarget(index: number): MorphTarget;
  106371. /**
  106372. * Gets the target at specified index
  106373. * @param index defines the index to check
  106374. * @returns the requested target
  106375. */
  106376. getTarget(index: number): MorphTarget;
  106377. /**
  106378. * Add a new target to this manager
  106379. * @param target defines the target to add
  106380. */
  106381. addTarget(target: MorphTarget): void;
  106382. /**
  106383. * Removes a target from the manager
  106384. * @param target defines the target to remove
  106385. */
  106386. removeTarget(target: MorphTarget): void;
  106387. /**
  106388. * Clone the current manager
  106389. * @returns a new MorphTargetManager
  106390. */
  106391. clone(): MorphTargetManager;
  106392. /**
  106393. * Serializes the current manager into a Serialization object
  106394. * @returns the serialized object
  106395. */
  106396. serialize(): any;
  106397. private _syncActiveTargets;
  106398. /**
  106399. * Syncrhonize the targets with all the meshes using this morph target manager
  106400. */
  106401. synchronize(): void;
  106402. /**
  106403. * Creates a new MorphTargetManager from serialized data
  106404. * @param serializationObject defines the serialized data
  106405. * @param scene defines the hosting scene
  106406. * @returns the new MorphTargetManager
  106407. */
  106408. static Parse(serializationObject: any, scene: Scene): MorphTargetManager;
  106409. }
  106410. }
  106411. declare module BABYLON {
  106412. /**
  106413. * Class used to represent a specific level of detail of a mesh
  106414. * @see https://doc.babylonjs.com/how_to/how_to_use_lod
  106415. */
  106416. export class MeshLODLevel {
  106417. /** Defines the distance where this level should start being displayed */
  106418. distance: number;
  106419. /** Defines the mesh to use to render this level */
  106420. mesh: Nullable<Mesh>;
  106421. /**
  106422. * Creates a new LOD level
  106423. * @param distance defines the distance where this level should star being displayed
  106424. * @param mesh defines the mesh to use to render this level
  106425. */
  106426. constructor(
  106427. /** Defines the distance where this level should start being displayed */
  106428. distance: number,
  106429. /** Defines the mesh to use to render this level */
  106430. mesh: Nullable<Mesh>);
  106431. }
  106432. }
  106433. declare module BABYLON {
  106434. /**
  106435. * Helper class used to generate a canvas to manipulate images
  106436. */
  106437. export class CanvasGenerator {
  106438. /**
  106439. * Create a new canvas (or offscreen canvas depending on the context)
  106440. * @param width defines the expected width
  106441. * @param height defines the expected height
  106442. * @return a new canvas or offscreen canvas
  106443. */
  106444. static CreateCanvas(width: number, height: number): HTMLCanvasElement | OffscreenCanvas;
  106445. }
  106446. }
  106447. declare module BABYLON {
  106448. /**
  106449. * Mesh representing the gorund
  106450. */
  106451. export class GroundMesh extends Mesh {
  106452. /** If octree should be generated */
  106453. generateOctree: boolean;
  106454. private _heightQuads;
  106455. /** @hidden */
  106456. _subdivisionsX: number;
  106457. /** @hidden */
  106458. _subdivisionsY: number;
  106459. /** @hidden */
  106460. _width: number;
  106461. /** @hidden */
  106462. _height: number;
  106463. /** @hidden */
  106464. _minX: number;
  106465. /** @hidden */
  106466. _maxX: number;
  106467. /** @hidden */
  106468. _minZ: number;
  106469. /** @hidden */
  106470. _maxZ: number;
  106471. constructor(name: string, scene: Scene);
  106472. /**
  106473. * "GroundMesh"
  106474. * @returns "GroundMesh"
  106475. */
  106476. getClassName(): string;
  106477. /**
  106478. * The minimum of x and y subdivisions
  106479. */
  106480. get subdivisions(): number;
  106481. /**
  106482. * X subdivisions
  106483. */
  106484. get subdivisionsX(): number;
  106485. /**
  106486. * Y subdivisions
  106487. */
  106488. get subdivisionsY(): number;
  106489. /**
  106490. * This function will update an octree to help to select the right submeshes for rendering, picking and collision computations.
  106491. * Please note that you must have a decent number of submeshes to get performance improvements when using an octree
  106492. * @param chunksCount the number of subdivisions for x and y
  106493. * @param octreeBlocksSize (Default: 32)
  106494. */
  106495. optimize(chunksCount: number, octreeBlocksSize?: number): void;
  106496. /**
  106497. * Returns a height (y) value in the Worl system :
  106498. * the ground altitude at the coordinates (x, z) expressed in the World system.
  106499. * @param x x coordinate
  106500. * @param z z coordinate
  106501. * @returns the ground y position if (x, z) are outside the ground surface.
  106502. */
  106503. getHeightAtCoordinates(x: number, z: number): number;
  106504. /**
  106505. * Returns a normalized vector (Vector3) orthogonal to the ground
  106506. * at the ground coordinates (x, z) expressed in the World system.
  106507. * @param x x coordinate
  106508. * @param z z coordinate
  106509. * @returns Vector3(0.0, 1.0, 0.0) if (x, z) are outside the ground surface.
  106510. */
  106511. getNormalAtCoordinates(x: number, z: number): Vector3;
  106512. /**
  106513. * Updates the Vector3 passed a reference with a normalized vector orthogonal to the ground
  106514. * at the ground coordinates (x, z) expressed in the World system.
  106515. * Doesn't uptade the reference Vector3 if (x, z) are outside the ground surface.
  106516. * @param x x coordinate
  106517. * @param z z coordinate
  106518. * @param ref vector to store the result
  106519. * @returns the GroundMesh.
  106520. */
  106521. getNormalAtCoordinatesToRef(x: number, z: number, ref: Vector3): GroundMesh;
  106522. /**
  106523. * Force the heights to be recomputed for getHeightAtCoordinates() or getNormalAtCoordinates()
  106524. * if the ground has been updated.
  106525. * This can be used in the render loop.
  106526. * @returns the GroundMesh.
  106527. */
  106528. updateCoordinateHeights(): GroundMesh;
  106529. private _getFacetAt;
  106530. private _initHeightQuads;
  106531. private _computeHeightQuads;
  106532. /**
  106533. * Serializes this ground mesh
  106534. * @param serializationObject object to write serialization to
  106535. */
  106536. serialize(serializationObject: any): void;
  106537. /**
  106538. * Parses a serialized ground mesh
  106539. * @param parsedMesh the serialized mesh
  106540. * @param scene the scene to create the ground mesh in
  106541. * @returns the created ground mesh
  106542. */
  106543. static Parse(parsedMesh: any, scene: Scene): GroundMesh;
  106544. }
  106545. }
  106546. declare module BABYLON {
  106547. /**
  106548. * Interface for Physics-Joint data
  106549. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  106550. */
  106551. export interface PhysicsJointData {
  106552. /**
  106553. * The main pivot of the joint
  106554. */
  106555. mainPivot?: Vector3;
  106556. /**
  106557. * The connected pivot of the joint
  106558. */
  106559. connectedPivot?: Vector3;
  106560. /**
  106561. * The main axis of the joint
  106562. */
  106563. mainAxis?: Vector3;
  106564. /**
  106565. * The connected axis of the joint
  106566. */
  106567. connectedAxis?: Vector3;
  106568. /**
  106569. * The collision of the joint
  106570. */
  106571. collision?: boolean;
  106572. /**
  106573. * Native Oimo/Cannon/Energy data
  106574. */
  106575. nativeParams?: any;
  106576. }
  106577. /**
  106578. * This is a holder class for the physics joint created by the physics plugin
  106579. * It holds a set of functions to control the underlying joint
  106580. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  106581. */
  106582. export class PhysicsJoint {
  106583. /**
  106584. * The type of the physics joint
  106585. */
  106586. type: number;
  106587. /**
  106588. * The data for the physics joint
  106589. */
  106590. jointData: PhysicsJointData;
  106591. private _physicsJoint;
  106592. protected _physicsPlugin: IPhysicsEnginePlugin;
  106593. /**
  106594. * Initializes the physics joint
  106595. * @param type The type of the physics joint
  106596. * @param jointData The data for the physics joint
  106597. */
  106598. constructor(
  106599. /**
  106600. * The type of the physics joint
  106601. */
  106602. type: number,
  106603. /**
  106604. * The data for the physics joint
  106605. */
  106606. jointData: PhysicsJointData);
  106607. /**
  106608. * Gets the physics joint
  106609. */
  106610. get physicsJoint(): any;
  106611. /**
  106612. * Sets the physics joint
  106613. */
  106614. set physicsJoint(newJoint: any);
  106615. /**
  106616. * Sets the physics plugin
  106617. */
  106618. set physicsPlugin(physicsPlugin: IPhysicsEnginePlugin);
  106619. /**
  106620. * Execute a function that is physics-plugin specific.
  106621. * @param {Function} func the function that will be executed.
  106622. * It accepts two parameters: the physics world and the physics joint
  106623. */
  106624. executeNativeFunction(func: (world: any, physicsJoint: any) => void): void;
  106625. /**
  106626. * Distance-Joint type
  106627. */
  106628. static DistanceJoint: number;
  106629. /**
  106630. * Hinge-Joint type
  106631. */
  106632. static HingeJoint: number;
  106633. /**
  106634. * Ball-and-Socket joint type
  106635. */
  106636. static BallAndSocketJoint: number;
  106637. /**
  106638. * Wheel-Joint type
  106639. */
  106640. static WheelJoint: number;
  106641. /**
  106642. * Slider-Joint type
  106643. */
  106644. static SliderJoint: number;
  106645. /**
  106646. * Prismatic-Joint type
  106647. */
  106648. static PrismaticJoint: number;
  106649. /**
  106650. * Universal-Joint type
  106651. * ENERGY FTW! (compare with this - @see http://ode-wiki.org/wiki/index.php?title=Manual:_Joint_Types_and_Functions)
  106652. */
  106653. static UniversalJoint: number;
  106654. /**
  106655. * Hinge-Joint 2 type
  106656. */
  106657. static Hinge2Joint: number;
  106658. /**
  106659. * Point to Point Joint type. Similar to a Ball-Joint. Different in parameters
  106660. */
  106661. static PointToPointJoint: number;
  106662. /**
  106663. * Spring-Joint type
  106664. */
  106665. static SpringJoint: number;
  106666. /**
  106667. * Lock-Joint type
  106668. */
  106669. static LockJoint: number;
  106670. }
  106671. /**
  106672. * A class representing a physics distance joint
  106673. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  106674. */
  106675. export class DistanceJoint extends PhysicsJoint {
  106676. /**
  106677. *
  106678. * @param jointData The data for the Distance-Joint
  106679. */
  106680. constructor(jointData: DistanceJointData);
  106681. /**
  106682. * Update the predefined distance.
  106683. * @param maxDistance The maximum preferred distance
  106684. * @param minDistance The minimum preferred distance
  106685. */
  106686. updateDistance(maxDistance: number, minDistance?: number): void;
  106687. }
  106688. /**
  106689. * Represents a Motor-Enabled Joint
  106690. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  106691. */
  106692. export class MotorEnabledJoint extends PhysicsJoint implements IMotorEnabledJoint {
  106693. /**
  106694. * Initializes the Motor-Enabled Joint
  106695. * @param type The type of the joint
  106696. * @param jointData The physica joint data for the joint
  106697. */
  106698. constructor(type: number, jointData: PhysicsJointData);
  106699. /**
  106700. * Set the motor values.
  106701. * Attention, this function is plugin specific. Engines won't react 100% the same.
  106702. * @param force the force to apply
  106703. * @param maxForce max force for this motor.
  106704. */
  106705. setMotor(force?: number, maxForce?: number): void;
  106706. /**
  106707. * Set the motor's limits.
  106708. * Attention, this function is plugin specific. Engines won't react 100% the same.
  106709. * @param upperLimit The upper limit of the motor
  106710. * @param lowerLimit The lower limit of the motor
  106711. */
  106712. setLimit(upperLimit: number, lowerLimit?: number): void;
  106713. }
  106714. /**
  106715. * This class represents a single physics Hinge-Joint
  106716. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  106717. */
  106718. export class HingeJoint extends MotorEnabledJoint {
  106719. /**
  106720. * Initializes the Hinge-Joint
  106721. * @param jointData The joint data for the Hinge-Joint
  106722. */
  106723. constructor(jointData: PhysicsJointData);
  106724. /**
  106725. * Set the motor values.
  106726. * Attention, this function is plugin specific. Engines won't react 100% the same.
  106727. * @param {number} force the force to apply
  106728. * @param {number} maxForce max force for this motor.
  106729. */
  106730. setMotor(force?: number, maxForce?: number): void;
  106731. /**
  106732. * Set the motor's limits.
  106733. * Attention, this function is plugin specific. Engines won't react 100% the same.
  106734. * @param upperLimit The upper limit of the motor
  106735. * @param lowerLimit The lower limit of the motor
  106736. */
  106737. setLimit(upperLimit: number, lowerLimit?: number): void;
  106738. }
  106739. /**
  106740. * This class represents a dual hinge physics joint (same as wheel joint)
  106741. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  106742. */
  106743. export class Hinge2Joint extends MotorEnabledJoint {
  106744. /**
  106745. * Initializes the Hinge2-Joint
  106746. * @param jointData The joint data for the Hinge2-Joint
  106747. */
  106748. constructor(jointData: PhysicsJointData);
  106749. /**
  106750. * Set the motor values.
  106751. * Attention, this function is plugin specific. Engines won't react 100% the same.
  106752. * @param {number} targetSpeed the speed the motor is to reach
  106753. * @param {number} maxForce max force for this motor.
  106754. * @param {motorIndex} the motor's index, 0 or 1.
  106755. */
  106756. setMotor(targetSpeed?: number, maxForce?: number, motorIndex?: number): void;
  106757. /**
  106758. * Set the motor limits.
  106759. * Attention, this function is plugin specific. Engines won't react 100% the same.
  106760. * @param {number} upperLimit the upper limit
  106761. * @param {number} lowerLimit lower limit
  106762. * @param {motorIndex} the motor's index, 0 or 1.
  106763. */
  106764. setLimit(upperLimit: number, lowerLimit?: number, motorIndex?: number): void;
  106765. }
  106766. /**
  106767. * Interface for a motor enabled joint
  106768. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  106769. */
  106770. export interface IMotorEnabledJoint {
  106771. /**
  106772. * Physics joint
  106773. */
  106774. physicsJoint: any;
  106775. /**
  106776. * Sets the motor of the motor-enabled joint
  106777. * @param force The force of the motor
  106778. * @param maxForce The maximum force of the motor
  106779. * @param motorIndex The index of the motor
  106780. */
  106781. setMotor(force?: number, maxForce?: number, motorIndex?: number): void;
  106782. /**
  106783. * Sets the limit of the motor
  106784. * @param upperLimit The upper limit of the motor
  106785. * @param lowerLimit The lower limit of the motor
  106786. * @param motorIndex The index of the motor
  106787. */
  106788. setLimit(upperLimit: number, lowerLimit?: number, motorIndex?: number): void;
  106789. }
  106790. /**
  106791. * Joint data for a Distance-Joint
  106792. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  106793. */
  106794. export interface DistanceJointData extends PhysicsJointData {
  106795. /**
  106796. * Max distance the 2 joint objects can be apart
  106797. */
  106798. maxDistance: number;
  106799. }
  106800. /**
  106801. * Joint data from a spring joint
  106802. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  106803. */
  106804. export interface SpringJointData extends PhysicsJointData {
  106805. /**
  106806. * Length of the spring
  106807. */
  106808. length: number;
  106809. /**
  106810. * Stiffness of the spring
  106811. */
  106812. stiffness: number;
  106813. /**
  106814. * Damping of the spring
  106815. */
  106816. damping: number;
  106817. /** this callback will be called when applying the force to the impostors. */
  106818. forceApplicationCallback: () => void;
  106819. }
  106820. }
  106821. declare module BABYLON {
  106822. /**
  106823. * Holds the data for the raycast result
  106824. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  106825. */
  106826. export class PhysicsRaycastResult {
  106827. private _hasHit;
  106828. private _hitDistance;
  106829. private _hitNormalWorld;
  106830. private _hitPointWorld;
  106831. private _rayFromWorld;
  106832. private _rayToWorld;
  106833. /**
  106834. * Gets if there was a hit
  106835. */
  106836. get hasHit(): boolean;
  106837. /**
  106838. * Gets the distance from the hit
  106839. */
  106840. get hitDistance(): number;
  106841. /**
  106842. * Gets the hit normal/direction in the world
  106843. */
  106844. get hitNormalWorld(): Vector3;
  106845. /**
  106846. * Gets the hit point in the world
  106847. */
  106848. get hitPointWorld(): Vector3;
  106849. /**
  106850. * Gets the ray "start point" of the ray in the world
  106851. */
  106852. get rayFromWorld(): Vector3;
  106853. /**
  106854. * Gets the ray "end point" of the ray in the world
  106855. */
  106856. get rayToWorld(): Vector3;
  106857. /**
  106858. * Sets the hit data (normal & point in world space)
  106859. * @param hitNormalWorld defines the normal in world space
  106860. * @param hitPointWorld defines the point in world space
  106861. */
  106862. setHitData(hitNormalWorld: IXYZ, hitPointWorld: IXYZ): void;
  106863. /**
  106864. * Sets the distance from the start point to the hit point
  106865. * @param distance
  106866. */
  106867. setHitDistance(distance: number): void;
  106868. /**
  106869. * Calculates the distance manually
  106870. */
  106871. calculateHitDistance(): void;
  106872. /**
  106873. * Resets all the values to default
  106874. * @param from The from point on world space
  106875. * @param to The to point on world space
  106876. */
  106877. reset(from?: Vector3, to?: Vector3): void;
  106878. }
  106879. /**
  106880. * Interface for the size containing width and height
  106881. */
  106882. interface IXYZ {
  106883. /**
  106884. * X
  106885. */
  106886. x: number;
  106887. /**
  106888. * Y
  106889. */
  106890. y: number;
  106891. /**
  106892. * Z
  106893. */
  106894. z: number;
  106895. }
  106896. }
  106897. declare module BABYLON {
  106898. /**
  106899. * Interface used to describe a physics joint
  106900. */
  106901. export interface PhysicsImpostorJoint {
  106902. /** Defines the main impostor to which the joint is linked */
  106903. mainImpostor: PhysicsImpostor;
  106904. /** Defines the impostor that is connected to the main impostor using this joint */
  106905. connectedImpostor: PhysicsImpostor;
  106906. /** Defines the joint itself */
  106907. joint: PhysicsJoint;
  106908. }
  106909. /** @hidden */
  106910. export interface IPhysicsEnginePlugin {
  106911. world: any;
  106912. name: string;
  106913. setGravity(gravity: Vector3): void;
  106914. setTimeStep(timeStep: number): void;
  106915. getTimeStep(): number;
  106916. executeStep(delta: number, impostors: Array<PhysicsImpostor>): void;
  106917. applyImpulse(impostor: PhysicsImpostor, force: Vector3, contactPoint: Vector3): void;
  106918. applyForce(impostor: PhysicsImpostor, force: Vector3, contactPoint: Vector3): void;
  106919. generatePhysicsBody(impostor: PhysicsImpostor): void;
  106920. removePhysicsBody(impostor: PhysicsImpostor): void;
  106921. generateJoint(joint: PhysicsImpostorJoint): void;
  106922. removeJoint(joint: PhysicsImpostorJoint): void;
  106923. isSupported(): boolean;
  106924. setTransformationFromPhysicsBody(impostor: PhysicsImpostor): void;
  106925. setPhysicsBodyTransformation(impostor: PhysicsImpostor, newPosition: Vector3, newRotation: Quaternion): void;
  106926. setLinearVelocity(impostor: PhysicsImpostor, velocity: Nullable<Vector3>): void;
  106927. setAngularVelocity(impostor: PhysicsImpostor, velocity: Nullable<Vector3>): void;
  106928. getLinearVelocity(impostor: PhysicsImpostor): Nullable<Vector3>;
  106929. getAngularVelocity(impostor: PhysicsImpostor): Nullable<Vector3>;
  106930. setBodyMass(impostor: PhysicsImpostor, mass: number): void;
  106931. getBodyMass(impostor: PhysicsImpostor): number;
  106932. getBodyFriction(impostor: PhysicsImpostor): number;
  106933. setBodyFriction(impostor: PhysicsImpostor, friction: number): void;
  106934. getBodyRestitution(impostor: PhysicsImpostor): number;
  106935. setBodyRestitution(impostor: PhysicsImpostor, restitution: number): void;
  106936. getBodyPressure?(impostor: PhysicsImpostor): number;
  106937. setBodyPressure?(impostor: PhysicsImpostor, pressure: number): void;
  106938. getBodyStiffness?(impostor: PhysicsImpostor): number;
  106939. setBodyStiffness?(impostor: PhysicsImpostor, stiffness: number): void;
  106940. getBodyVelocityIterations?(impostor: PhysicsImpostor): number;
  106941. setBodyVelocityIterations?(impostor: PhysicsImpostor, velocityIterations: number): void;
  106942. getBodyPositionIterations?(impostor: PhysicsImpostor): number;
  106943. setBodyPositionIterations?(impostor: PhysicsImpostor, positionIterations: number): void;
  106944. appendAnchor?(impostor: PhysicsImpostor, otherImpostor: PhysicsImpostor, width: number, height: number, influence: number, noCollisionBetweenLinkedBodies: boolean): void;
  106945. appendHook?(impostor: PhysicsImpostor, otherImpostor: PhysicsImpostor, length: number, influence: number, noCollisionBetweenLinkedBodies: boolean): void;
  106946. sleepBody(impostor: PhysicsImpostor): void;
  106947. wakeUpBody(impostor: PhysicsImpostor): void;
  106948. raycast(from: Vector3, to: Vector3): PhysicsRaycastResult;
  106949. updateDistanceJoint(joint: PhysicsJoint, maxDistance: number, minDistance?: number): void;
  106950. setMotor(joint: IMotorEnabledJoint, speed: number, maxForce?: number, motorIndex?: number): void;
  106951. setLimit(joint: IMotorEnabledJoint, upperLimit: number, lowerLimit?: number, motorIndex?: number): void;
  106952. getRadius(impostor: PhysicsImpostor): number;
  106953. getBoxSizeToRef(impostor: PhysicsImpostor, result: Vector3): void;
  106954. syncMeshWithImpostor(mesh: AbstractMesh, impostor: PhysicsImpostor): void;
  106955. dispose(): void;
  106956. }
  106957. /**
  106958. * Interface used to define a physics engine
  106959. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  106960. */
  106961. export interface IPhysicsEngine {
  106962. /**
  106963. * Gets the gravity vector used by the simulation
  106964. */
  106965. gravity: Vector3;
  106966. /**
  106967. * Sets the gravity vector used by the simulation
  106968. * @param gravity defines the gravity vector to use
  106969. */
  106970. setGravity(gravity: Vector3): void;
  106971. /**
  106972. * Set the time step of the physics engine.
  106973. * Default is 1/60.
  106974. * To slow it down, enter 1/600 for example.
  106975. * To speed it up, 1/30
  106976. * @param newTimeStep the new timestep to apply to this world.
  106977. */
  106978. setTimeStep(newTimeStep: number): void;
  106979. /**
  106980. * Get the time step of the physics engine.
  106981. * @returns the current time step
  106982. */
  106983. getTimeStep(): number;
  106984. /**
  106985. * Set the sub time step of the physics engine.
  106986. * Default is 0 meaning there is no sub steps
  106987. * To increase physics resolution precision, set a small value (like 1 ms)
  106988. * @param subTimeStep defines the new sub timestep used for physics resolution.
  106989. */
  106990. setSubTimeStep(subTimeStep: number): void;
  106991. /**
  106992. * Get the sub time step of the physics engine.
  106993. * @returns the current sub time step
  106994. */
  106995. getSubTimeStep(): number;
  106996. /**
  106997. * Release all resources
  106998. */
  106999. dispose(): void;
  107000. /**
  107001. * Gets the name of the current physics plugin
  107002. * @returns the name of the plugin
  107003. */
  107004. getPhysicsPluginName(): string;
  107005. /**
  107006. * Adding a new impostor for the impostor tracking.
  107007. * This will be done by the impostor itself.
  107008. * @param impostor the impostor to add
  107009. */
  107010. addImpostor(impostor: PhysicsImpostor): void;
  107011. /**
  107012. * Remove an impostor from the engine.
  107013. * This impostor and its mesh will not longer be updated by the physics engine.
  107014. * @param impostor the impostor to remove
  107015. */
  107016. removeImpostor(impostor: PhysicsImpostor): void;
  107017. /**
  107018. * Add a joint to the physics engine
  107019. * @param mainImpostor defines the main impostor to which the joint is added.
  107020. * @param connectedImpostor defines the impostor that is connected to the main impostor using this joint
  107021. * @param joint defines the joint that will connect both impostors.
  107022. */
  107023. addJoint(mainImpostor: PhysicsImpostor, connectedImpostor: PhysicsImpostor, joint: PhysicsJoint): void;
  107024. /**
  107025. * Removes a joint from the simulation
  107026. * @param mainImpostor defines the impostor used with the joint
  107027. * @param connectedImpostor defines the other impostor connected to the main one by the joint
  107028. * @param joint defines the joint to remove
  107029. */
  107030. removeJoint(mainImpostor: PhysicsImpostor, connectedImpostor: PhysicsImpostor, joint: PhysicsJoint): void;
  107031. /**
  107032. * Gets the current plugin used to run the simulation
  107033. * @returns current plugin
  107034. */
  107035. getPhysicsPlugin(): IPhysicsEnginePlugin;
  107036. /**
  107037. * Gets the list of physic impostors
  107038. * @returns an array of PhysicsImpostor
  107039. */
  107040. getImpostors(): Array<PhysicsImpostor>;
  107041. /**
  107042. * Gets the impostor for a physics enabled object
  107043. * @param object defines the object impersonated by the impostor
  107044. * @returns the PhysicsImpostor or null if not found
  107045. */
  107046. getImpostorForPhysicsObject(object: IPhysicsEnabledObject): Nullable<PhysicsImpostor>;
  107047. /**
  107048. * Gets the impostor for a physics body object
  107049. * @param body defines physics body used by the impostor
  107050. * @returns the PhysicsImpostor or null if not found
  107051. */
  107052. getImpostorWithPhysicsBody(body: any): Nullable<PhysicsImpostor>;
  107053. /**
  107054. * Does a raycast in the physics world
  107055. * @param from when should the ray start?
  107056. * @param to when should the ray end?
  107057. * @returns PhysicsRaycastResult
  107058. */
  107059. raycast(from: Vector3, to: Vector3): PhysicsRaycastResult;
  107060. /**
  107061. * Called by the scene. No need to call it.
  107062. * @param delta defines the timespam between frames
  107063. */
  107064. _step(delta: number): void;
  107065. }
  107066. }
  107067. declare module BABYLON {
  107068. /**
  107069. * The interface for the physics imposter parameters
  107070. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  107071. */
  107072. export interface PhysicsImpostorParameters {
  107073. /**
  107074. * The mass of the physics imposter
  107075. */
  107076. mass: number;
  107077. /**
  107078. * The friction of the physics imposter
  107079. */
  107080. friction?: number;
  107081. /**
  107082. * The coefficient of restitution of the physics imposter
  107083. */
  107084. restitution?: number;
  107085. /**
  107086. * The native options of the physics imposter
  107087. */
  107088. nativeOptions?: any;
  107089. /**
  107090. * Specifies if the parent should be ignored
  107091. */
  107092. ignoreParent?: boolean;
  107093. /**
  107094. * Specifies if bi-directional transformations should be disabled
  107095. */
  107096. disableBidirectionalTransformation?: boolean;
  107097. /**
  107098. * The pressure inside the physics imposter, soft object only
  107099. */
  107100. pressure?: number;
  107101. /**
  107102. * The stiffness the physics imposter, soft object only
  107103. */
  107104. stiffness?: number;
  107105. /**
  107106. * The number of iterations used in maintaining consistent vertex velocities, soft object only
  107107. */
  107108. velocityIterations?: number;
  107109. /**
  107110. * The number of iterations used in maintaining consistent vertex positions, soft object only
  107111. */
  107112. positionIterations?: number;
  107113. /**
  107114. * The number used to fix points on a cloth (0, 1, 2, 4, 8) or rope (0, 1, 2) only
  107115. * 0 None, 1, back left or top, 2, back right or bottom, 4, front left, 8, front right
  107116. * Add to fix multiple points
  107117. */
  107118. fixedPoints?: number;
  107119. /**
  107120. * The collision margin around a soft object
  107121. */
  107122. margin?: number;
  107123. /**
  107124. * The collision margin around a soft object
  107125. */
  107126. damping?: number;
  107127. /**
  107128. * The path for a rope based on an extrusion
  107129. */
  107130. path?: any;
  107131. /**
  107132. * The shape of an extrusion used for a rope based on an extrusion
  107133. */
  107134. shape?: any;
  107135. }
  107136. /**
  107137. * Interface for a physics-enabled object
  107138. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  107139. */
  107140. export interface IPhysicsEnabledObject {
  107141. /**
  107142. * The position of the physics-enabled object
  107143. */
  107144. position: Vector3;
  107145. /**
  107146. * The rotation of the physics-enabled object
  107147. */
  107148. rotationQuaternion: Nullable<Quaternion>;
  107149. /**
  107150. * The scale of the physics-enabled object
  107151. */
  107152. scaling: Vector3;
  107153. /**
  107154. * The rotation of the physics-enabled object
  107155. */
  107156. rotation?: Vector3;
  107157. /**
  107158. * The parent of the physics-enabled object
  107159. */
  107160. parent?: any;
  107161. /**
  107162. * The bounding info of the physics-enabled object
  107163. * @returns The bounding info of the physics-enabled object
  107164. */
  107165. getBoundingInfo(): BoundingInfo;
  107166. /**
  107167. * Computes the world matrix
  107168. * @param force Specifies if the world matrix should be computed by force
  107169. * @returns A world matrix
  107170. */
  107171. computeWorldMatrix(force: boolean): Matrix;
  107172. /**
  107173. * Gets the world matrix
  107174. * @returns A world matrix
  107175. */
  107176. getWorldMatrix?(): Matrix;
  107177. /**
  107178. * Gets the child meshes
  107179. * @param directDescendantsOnly Specifies if only direct-descendants should be obtained
  107180. * @returns An array of abstract meshes
  107181. */
  107182. getChildMeshes?(directDescendantsOnly?: boolean): Array<AbstractMesh>;
  107183. /**
  107184. * Gets the vertex data
  107185. * @param kind The type of vertex data
  107186. * @returns A nullable array of numbers, or a float32 array
  107187. */
  107188. getVerticesData(kind: string): Nullable<Array<number> | Float32Array>;
  107189. /**
  107190. * Gets the indices from the mesh
  107191. * @returns A nullable array of index arrays
  107192. */
  107193. getIndices?(): Nullable<IndicesArray>;
  107194. /**
  107195. * Gets the scene from the mesh
  107196. * @returns the indices array or null
  107197. */
  107198. getScene?(): Scene;
  107199. /**
  107200. * Gets the absolute position from the mesh
  107201. * @returns the absolute position
  107202. */
  107203. getAbsolutePosition(): Vector3;
  107204. /**
  107205. * Gets the absolute pivot point from the mesh
  107206. * @returns the absolute pivot point
  107207. */
  107208. getAbsolutePivotPoint(): Vector3;
  107209. /**
  107210. * Rotates the mesh
  107211. * @param axis The axis of rotation
  107212. * @param amount The amount of rotation
  107213. * @param space The space of the rotation
  107214. * @returns The rotation transform node
  107215. */
  107216. rotate(axis: Vector3, amount: number, space?: Space): TransformNode;
  107217. /**
  107218. * Translates the mesh
  107219. * @param axis The axis of translation
  107220. * @param distance The distance of translation
  107221. * @param space The space of the translation
  107222. * @returns The transform node
  107223. */
  107224. translate(axis: Vector3, distance: number, space?: Space): TransformNode;
  107225. /**
  107226. * Sets the absolute position of the mesh
  107227. * @param absolutePosition The absolute position of the mesh
  107228. * @returns The transform node
  107229. */
  107230. setAbsolutePosition(absolutePosition: Vector3): TransformNode;
  107231. /**
  107232. * Gets the class name of the mesh
  107233. * @returns The class name
  107234. */
  107235. getClassName(): string;
  107236. }
  107237. /**
  107238. * Represents a physics imposter
  107239. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  107240. */
  107241. export class PhysicsImpostor {
  107242. /**
  107243. * The physics-enabled object used as the physics imposter
  107244. */
  107245. object: IPhysicsEnabledObject;
  107246. /**
  107247. * The type of the physics imposter
  107248. */
  107249. type: number;
  107250. private _options;
  107251. private _scene?;
  107252. /**
  107253. * The default object size of the imposter
  107254. */
  107255. static DEFAULT_OBJECT_SIZE: Vector3;
  107256. /**
  107257. * The identity quaternion of the imposter
  107258. */
  107259. static IDENTITY_QUATERNION: Quaternion;
  107260. /** @hidden */
  107261. _pluginData: any;
  107262. private _physicsEngine;
  107263. private _physicsBody;
  107264. private _bodyUpdateRequired;
  107265. private _onBeforePhysicsStepCallbacks;
  107266. private _onAfterPhysicsStepCallbacks;
  107267. /** @hidden */
  107268. _onPhysicsCollideCallbacks: Array<{
  107269. callback: (collider: PhysicsImpostor, collidedAgainst: PhysicsImpostor) => void;
  107270. otherImpostors: Array<PhysicsImpostor>;
  107271. }>;
  107272. private _deltaPosition;
  107273. private _deltaRotation;
  107274. private _deltaRotationConjugated;
  107275. /** @hidden */
  107276. _isFromLine: boolean;
  107277. private _parent;
  107278. private _isDisposed;
  107279. private static _tmpVecs;
  107280. private static _tmpQuat;
  107281. /**
  107282. * Specifies if the physics imposter is disposed
  107283. */
  107284. get isDisposed(): boolean;
  107285. /**
  107286. * Gets the mass of the physics imposter
  107287. */
  107288. get mass(): number;
  107289. set mass(value: number);
  107290. /**
  107291. * Gets the coefficient of friction
  107292. */
  107293. get friction(): number;
  107294. /**
  107295. * Sets the coefficient of friction
  107296. */
  107297. set friction(value: number);
  107298. /**
  107299. * Gets the coefficient of restitution
  107300. */
  107301. get restitution(): number;
  107302. /**
  107303. * Sets the coefficient of restitution
  107304. */
  107305. set restitution(value: number);
  107306. /**
  107307. * Gets the pressure of a soft body; only supported by the AmmoJSPlugin
  107308. */
  107309. get pressure(): number;
  107310. /**
  107311. * Sets the pressure of a soft body; only supported by the AmmoJSPlugin
  107312. */
  107313. set pressure(value: number);
  107314. /**
  107315. * Gets the stiffness of a soft body; only supported by the AmmoJSPlugin
  107316. */
  107317. get stiffness(): number;
  107318. /**
  107319. * Sets the stiffness of a soft body; only supported by the AmmoJSPlugin
  107320. */
  107321. set stiffness(value: number);
  107322. /**
  107323. * Gets the velocityIterations of a soft body; only supported by the AmmoJSPlugin
  107324. */
  107325. get velocityIterations(): number;
  107326. /**
  107327. * Sets the velocityIterations of a soft body; only supported by the AmmoJSPlugin
  107328. */
  107329. set velocityIterations(value: number);
  107330. /**
  107331. * Gets the positionIterations of a soft body; only supported by the AmmoJSPlugin
  107332. */
  107333. get positionIterations(): number;
  107334. /**
  107335. * Sets the positionIterations of a soft body; only supported by the AmmoJSPlugin
  107336. */
  107337. set positionIterations(value: number);
  107338. /**
  107339. * The unique id of the physics imposter
  107340. * set by the physics engine when adding this impostor to the array
  107341. */
  107342. uniqueId: number;
  107343. /**
  107344. * @hidden
  107345. */
  107346. soft: boolean;
  107347. /**
  107348. * @hidden
  107349. */
  107350. segments: number;
  107351. private _joints;
  107352. /**
  107353. * Initializes the physics imposter
  107354. * @param object The physics-enabled object used as the physics imposter
  107355. * @param type The type of the physics imposter
  107356. * @param _options The options for the physics imposter
  107357. * @param _scene The Babylon scene
  107358. */
  107359. constructor(
  107360. /**
  107361. * The physics-enabled object used as the physics imposter
  107362. */
  107363. object: IPhysicsEnabledObject,
  107364. /**
  107365. * The type of the physics imposter
  107366. */
  107367. type: number, _options?: PhysicsImpostorParameters, _scene?: Scene | undefined);
  107368. /**
  107369. * This function will completly initialize this impostor.
  107370. * It will create a new body - but only if this mesh has no parent.
  107371. * If it has, this impostor will not be used other than to define the impostor
  107372. * of the child mesh.
  107373. * @hidden
  107374. */
  107375. _init(): void;
  107376. private _getPhysicsParent;
  107377. /**
  107378. * Should a new body be generated.
  107379. * @returns boolean specifying if body initialization is required
  107380. */
  107381. isBodyInitRequired(): boolean;
  107382. /**
  107383. * Sets the updated scaling
  107384. * @param updated Specifies if the scaling is updated
  107385. */
  107386. setScalingUpdated(): void;
  107387. /**
  107388. * Force a regeneration of this or the parent's impostor's body.
  107389. * Use under cautious - This will remove all joints already implemented.
  107390. */
  107391. forceUpdate(): void;
  107392. /**
  107393. * Gets the body that holds this impostor. Either its own, or its parent.
  107394. */
  107395. get physicsBody(): any;
  107396. /**
  107397. * Get the parent of the physics imposter
  107398. * @returns Physics imposter or null
  107399. */
  107400. get parent(): Nullable<PhysicsImpostor>;
  107401. /**
  107402. * Sets the parent of the physics imposter
  107403. */
  107404. set parent(value: Nullable<PhysicsImpostor>);
  107405. /**
  107406. * Set the physics body. Used mainly by the physics engine/plugin
  107407. */
  107408. set physicsBody(physicsBody: any);
  107409. /**
  107410. * Resets the update flags
  107411. */
  107412. resetUpdateFlags(): void;
  107413. /**
  107414. * Gets the object extend size
  107415. * @returns the object extend size
  107416. */
  107417. getObjectExtendSize(): Vector3;
  107418. /**
  107419. * Gets the object center
  107420. * @returns The object center
  107421. */
  107422. getObjectCenter(): Vector3;
  107423. /**
  107424. * Get a specific parameter from the options parameters
  107425. * @param paramName The object parameter name
  107426. * @returns The object parameter
  107427. */
  107428. getParam(paramName: string): any;
  107429. /**
  107430. * Sets a specific parameter in the options given to the physics plugin
  107431. * @param paramName The parameter name
  107432. * @param value The value of the parameter
  107433. */
  107434. setParam(paramName: string, value: number): void;
  107435. /**
  107436. * Specifically change the body's mass option. Won't recreate the physics body object
  107437. * @param mass The mass of the physics imposter
  107438. */
  107439. setMass(mass: number): void;
  107440. /**
  107441. * Gets the linear velocity
  107442. * @returns linear velocity or null
  107443. */
  107444. getLinearVelocity(): Nullable<Vector3>;
  107445. /**
  107446. * Sets the linear velocity
  107447. * @param velocity linear velocity or null
  107448. */
  107449. setLinearVelocity(velocity: Nullable<Vector3>): void;
  107450. /**
  107451. * Gets the angular velocity
  107452. * @returns angular velocity or null
  107453. */
  107454. getAngularVelocity(): Nullable<Vector3>;
  107455. /**
  107456. * Sets the angular velocity
  107457. * @param velocity The velocity or null
  107458. */
  107459. setAngularVelocity(velocity: Nullable<Vector3>): void;
  107460. /**
  107461. * Execute a function with the physics plugin native code
  107462. * Provide a function the will have two variables - the world object and the physics body object
  107463. * @param func The function to execute with the physics plugin native code
  107464. */
  107465. executeNativeFunction(func: (world: any, physicsBody: any) => void): void;
  107466. /**
  107467. * Register a function that will be executed before the physics world is stepping forward
  107468. * @param func The function to execute before the physics world is stepped forward
  107469. */
  107470. registerBeforePhysicsStep(func: (impostor: PhysicsImpostor) => void): void;
  107471. /**
  107472. * Unregister a function that will be executed before the physics world is stepping forward
  107473. * @param func The function to execute before the physics world is stepped forward
  107474. */
  107475. unregisterBeforePhysicsStep(func: (impostor: PhysicsImpostor) => void): void;
  107476. /**
  107477. * Register a function that will be executed after the physics step
  107478. * @param func The function to execute after physics step
  107479. */
  107480. registerAfterPhysicsStep(func: (impostor: PhysicsImpostor) => void): void;
  107481. /**
  107482. * Unregisters a function that will be executed after the physics step
  107483. * @param func The function to execute after physics step
  107484. */
  107485. unregisterAfterPhysicsStep(func: (impostor: PhysicsImpostor) => void): void;
  107486. /**
  107487. * register a function that will be executed when this impostor collides against a different body
  107488. * @param collideAgainst Physics imposter, or array of physics imposters to collide against
  107489. * @param func Callback that is executed on collision
  107490. */
  107491. registerOnPhysicsCollide(collideAgainst: PhysicsImpostor | Array<PhysicsImpostor>, func: (collider: PhysicsImpostor, collidedAgainst: PhysicsImpostor) => void): void;
  107492. /**
  107493. * Unregisters the physics imposter on contact
  107494. * @param collideAgainst The physics object to collide against
  107495. * @param func Callback to execute on collision
  107496. */
  107497. unregisterOnPhysicsCollide(collideAgainst: PhysicsImpostor | Array<PhysicsImpostor>, func: (collider: PhysicsImpostor, collidedAgainst: PhysicsImpostor | Array<PhysicsImpostor>) => void): void;
  107498. private _tmpQuat;
  107499. private _tmpQuat2;
  107500. /**
  107501. * Get the parent rotation
  107502. * @returns The parent rotation
  107503. */
  107504. getParentsRotation(): Quaternion;
  107505. /**
  107506. * this function is executed by the physics engine.
  107507. */
  107508. beforeStep: () => void;
  107509. /**
  107510. * this function is executed by the physics engine
  107511. */
  107512. afterStep: () => void;
  107513. /**
  107514. * Legacy collision detection event support
  107515. */
  107516. onCollideEvent: Nullable<(collider: PhysicsImpostor, collidedWith: PhysicsImpostor) => void>;
  107517. /**
  107518. * event and body object due to cannon's event-based architecture.
  107519. */
  107520. onCollide: (e: {
  107521. body: any;
  107522. }) => void;
  107523. /**
  107524. * Apply a force
  107525. * @param force The force to apply
  107526. * @param contactPoint The contact point for the force
  107527. * @returns The physics imposter
  107528. */
  107529. applyForce(force: Vector3, contactPoint: Vector3): PhysicsImpostor;
  107530. /**
  107531. * Apply an impulse
  107532. * @param force The impulse force
  107533. * @param contactPoint The contact point for the impulse force
  107534. * @returns The physics imposter
  107535. */
  107536. applyImpulse(force: Vector3, contactPoint: Vector3): PhysicsImpostor;
  107537. /**
  107538. * A help function to create a joint
  107539. * @param otherImpostor A physics imposter used to create a joint
  107540. * @param jointType The type of joint
  107541. * @param jointData The data for the joint
  107542. * @returns The physics imposter
  107543. */
  107544. createJoint(otherImpostor: PhysicsImpostor, jointType: number, jointData: PhysicsJointData): PhysicsImpostor;
  107545. /**
  107546. * Add a joint to this impostor with a different impostor
  107547. * @param otherImpostor A physics imposter used to add a joint
  107548. * @param joint The joint to add
  107549. * @returns The physics imposter
  107550. */
  107551. addJoint(otherImpostor: PhysicsImpostor, joint: PhysicsJoint): PhysicsImpostor;
  107552. /**
  107553. * Add an anchor to a cloth impostor
  107554. * @param otherImpostor rigid impostor to anchor to
  107555. * @param width ratio across width from 0 to 1
  107556. * @param height ratio up height from 0 to 1
  107557. * @param influence the elasticity between cloth impostor and anchor from 0, very stretchy to 1, little strech
  107558. * @param noCollisionBetweenLinkedBodies when true collisions between cloth impostor and anchor are ignored; default false
  107559. * @returns impostor the soft imposter
  107560. */
  107561. addAnchor(otherImpostor: PhysicsImpostor, width: number, height: number, influence: number, noCollisionBetweenLinkedBodies: boolean): PhysicsImpostor;
  107562. /**
  107563. * Add a hook to a rope impostor
  107564. * @param otherImpostor rigid impostor to anchor to
  107565. * @param length ratio across rope from 0 to 1
  107566. * @param influence the elasticity between rope impostor and anchor from 0, very stretchy to 1, little strech
  107567. * @param noCollisionBetweenLinkedBodies when true collisions between soft impostor and anchor are ignored; default false
  107568. * @returns impostor the rope imposter
  107569. */
  107570. addHook(otherImpostor: PhysicsImpostor, length: number, influence: number, noCollisionBetweenLinkedBodies: boolean): PhysicsImpostor;
  107571. /**
  107572. * Will keep this body still, in a sleep mode.
  107573. * @returns the physics imposter
  107574. */
  107575. sleep(): PhysicsImpostor;
  107576. /**
  107577. * Wake the body up.
  107578. * @returns The physics imposter
  107579. */
  107580. wakeUp(): PhysicsImpostor;
  107581. /**
  107582. * Clones the physics imposter
  107583. * @param newObject The physics imposter clones to this physics-enabled object
  107584. * @returns A nullable physics imposter
  107585. */
  107586. clone(newObject: IPhysicsEnabledObject): Nullable<PhysicsImpostor>;
  107587. /**
  107588. * Disposes the physics imposter
  107589. */
  107590. dispose(): void;
  107591. /**
  107592. * Sets the delta position
  107593. * @param position The delta position amount
  107594. */
  107595. setDeltaPosition(position: Vector3): void;
  107596. /**
  107597. * Sets the delta rotation
  107598. * @param rotation The delta rotation amount
  107599. */
  107600. setDeltaRotation(rotation: Quaternion): void;
  107601. /**
  107602. * Gets the box size of the physics imposter and stores the result in the input parameter
  107603. * @param result Stores the box size
  107604. * @returns The physics imposter
  107605. */
  107606. getBoxSizeToRef(result: Vector3): PhysicsImpostor;
  107607. /**
  107608. * Gets the radius of the physics imposter
  107609. * @returns Radius of the physics imposter
  107610. */
  107611. getRadius(): number;
  107612. /**
  107613. * Sync a bone with this impostor
  107614. * @param bone The bone to sync to the impostor.
  107615. * @param boneMesh The mesh that the bone is influencing.
  107616. * @param jointPivot The pivot of the joint / bone in local space.
  107617. * @param distToJoint Optional distance from the impostor to the joint.
  107618. * @param adjustRotation Optional quaternion for adjusting the local rotation of the bone.
  107619. */
  107620. syncBoneWithImpostor(bone: Bone, boneMesh: AbstractMesh, jointPivot: Vector3, distToJoint?: number, adjustRotation?: Quaternion): void;
  107621. /**
  107622. * Sync impostor to a bone
  107623. * @param bone The bone that the impostor will be synced to.
  107624. * @param boneMesh The mesh that the bone is influencing.
  107625. * @param jointPivot The pivot of the joint / bone in local space.
  107626. * @param distToJoint Optional distance from the impostor to the joint.
  107627. * @param adjustRotation Optional quaternion for adjusting the local rotation of the bone.
  107628. * @param boneAxis Optional vector3 axis the bone is aligned with
  107629. */
  107630. syncImpostorWithBone(bone: Bone, boneMesh: AbstractMesh, jointPivot: Vector3, distToJoint?: number, adjustRotation?: Quaternion, boneAxis?: Vector3): void;
  107631. /**
  107632. * No-Imposter type
  107633. */
  107634. static NoImpostor: number;
  107635. /**
  107636. * Sphere-Imposter type
  107637. */
  107638. static SphereImpostor: number;
  107639. /**
  107640. * Box-Imposter type
  107641. */
  107642. static BoxImpostor: number;
  107643. /**
  107644. * Plane-Imposter type
  107645. */
  107646. static PlaneImpostor: number;
  107647. /**
  107648. * Mesh-imposter type
  107649. */
  107650. static MeshImpostor: number;
  107651. /**
  107652. * Capsule-Impostor type (Ammo.js plugin only)
  107653. */
  107654. static CapsuleImpostor: number;
  107655. /**
  107656. * Cylinder-Imposter type
  107657. */
  107658. static CylinderImpostor: number;
  107659. /**
  107660. * Particle-Imposter type
  107661. */
  107662. static ParticleImpostor: number;
  107663. /**
  107664. * Heightmap-Imposter type
  107665. */
  107666. static HeightmapImpostor: number;
  107667. /**
  107668. * ConvexHull-Impostor type (Ammo.js plugin only)
  107669. */
  107670. static ConvexHullImpostor: number;
  107671. /**
  107672. * Custom-Imposter type (Ammo.js plugin only)
  107673. */
  107674. static CustomImpostor: number;
  107675. /**
  107676. * Rope-Imposter type
  107677. */
  107678. static RopeImpostor: number;
  107679. /**
  107680. * Cloth-Imposter type
  107681. */
  107682. static ClothImpostor: number;
  107683. /**
  107684. * Softbody-Imposter type
  107685. */
  107686. static SoftbodyImpostor: number;
  107687. }
  107688. }
  107689. declare module BABYLON {
  107690. /**
  107691. * @hidden
  107692. **/
  107693. export class _CreationDataStorage {
  107694. closePath?: boolean;
  107695. closeArray?: boolean;
  107696. idx: number[];
  107697. dashSize: number;
  107698. gapSize: number;
  107699. path3D: Path3D;
  107700. pathArray: Vector3[][];
  107701. arc: number;
  107702. radius: number;
  107703. cap: number;
  107704. tessellation: number;
  107705. }
  107706. /**
  107707. * @hidden
  107708. **/
  107709. class _InstanceDataStorage {
  107710. visibleInstances: any;
  107711. batchCache: _InstancesBatch;
  107712. instancesBufferSize: number;
  107713. instancesBuffer: Nullable<Buffer>;
  107714. instancesData: Float32Array;
  107715. overridenInstanceCount: number;
  107716. isFrozen: boolean;
  107717. previousBatch: Nullable<_InstancesBatch>;
  107718. hardwareInstancedRendering: boolean;
  107719. sideOrientation: number;
  107720. manualUpdate: boolean;
  107721. }
  107722. /**
  107723. * @hidden
  107724. **/
  107725. export class _InstancesBatch {
  107726. mustReturn: boolean;
  107727. visibleInstances: Nullable<InstancedMesh[]>[];
  107728. renderSelf: boolean[];
  107729. hardwareInstancedRendering: boolean[];
  107730. }
  107731. /**
  107732. * @hidden
  107733. **/
  107734. class _ThinInstanceDataStorage {
  107735. instancesCount: number;
  107736. matrixBuffer: Nullable<Buffer>;
  107737. matrixBufferSize: number;
  107738. matrixData: Nullable<Float32Array>;
  107739. boundingVectors: Array<Vector3>;
  107740. worldMatrices: Nullable<Matrix[]>;
  107741. }
  107742. /**
  107743. * Class used to represent renderable models
  107744. */
  107745. export class Mesh extends AbstractMesh implements IGetSetVerticesData {
  107746. /**
  107747. * Mesh side orientation : usually the external or front surface
  107748. */
  107749. static readonly FRONTSIDE: number;
  107750. /**
  107751. * Mesh side orientation : usually the internal or back surface
  107752. */
  107753. static readonly BACKSIDE: number;
  107754. /**
  107755. * Mesh side orientation : both internal and external or front and back surfaces
  107756. */
  107757. static readonly DOUBLESIDE: number;
  107758. /**
  107759. * Mesh side orientation : by default, `FRONTSIDE`
  107760. */
  107761. static readonly DEFAULTSIDE: number;
  107762. /**
  107763. * Mesh cap setting : no cap
  107764. */
  107765. static readonly NO_CAP: number;
  107766. /**
  107767. * Mesh cap setting : one cap at the beginning of the mesh
  107768. */
  107769. static readonly CAP_START: number;
  107770. /**
  107771. * Mesh cap setting : one cap at the end of the mesh
  107772. */
  107773. static readonly CAP_END: number;
  107774. /**
  107775. * Mesh cap setting : two caps, one at the beginning and one at the end of the mesh
  107776. */
  107777. static readonly CAP_ALL: number;
  107778. /**
  107779. * Mesh pattern setting : no flip or rotate
  107780. */
  107781. static readonly NO_FLIP: number;
  107782. /**
  107783. * Mesh pattern setting : flip (reflect in y axis) alternate tiles on each row or column
  107784. */
  107785. static readonly FLIP_TILE: number;
  107786. /**
  107787. * Mesh pattern setting : rotate (180degs) alternate tiles on each row or column
  107788. */
  107789. static readonly ROTATE_TILE: number;
  107790. /**
  107791. * Mesh pattern setting : flip (reflect in y axis) all tiles on alternate rows
  107792. */
  107793. static readonly FLIP_ROW: number;
  107794. /**
  107795. * Mesh pattern setting : rotate (180degs) all tiles on alternate rows
  107796. */
  107797. static readonly ROTATE_ROW: number;
  107798. /**
  107799. * Mesh pattern setting : flip and rotate alternate tiles on each row or column
  107800. */
  107801. static readonly FLIP_N_ROTATE_TILE: number;
  107802. /**
  107803. * Mesh pattern setting : rotate pattern and rotate
  107804. */
  107805. static readonly FLIP_N_ROTATE_ROW: number;
  107806. /**
  107807. * Mesh tile positioning : part tiles same on left/right or top/bottom
  107808. */
  107809. static readonly CENTER: number;
  107810. /**
  107811. * Mesh tile positioning : part tiles on left
  107812. */
  107813. static readonly LEFT: number;
  107814. /**
  107815. * Mesh tile positioning : part tiles on right
  107816. */
  107817. static readonly RIGHT: number;
  107818. /**
  107819. * Mesh tile positioning : part tiles on top
  107820. */
  107821. static readonly TOP: number;
  107822. /**
  107823. * Mesh tile positioning : part tiles on bottom
  107824. */
  107825. static readonly BOTTOM: number;
  107826. /**
  107827. * Gets the default side orientation.
  107828. * @param orientation the orientation to value to attempt to get
  107829. * @returns the default orientation
  107830. * @hidden
  107831. */
  107832. static _GetDefaultSideOrientation(orientation?: number): number;
  107833. private _internalMeshDataInfo;
  107834. get computeBonesUsingShaders(): boolean;
  107835. set computeBonesUsingShaders(value: boolean);
  107836. /**
  107837. * An event triggered before rendering the mesh
  107838. */
  107839. get onBeforeRenderObservable(): Observable<Mesh>;
  107840. /**
  107841. * An event triggered before binding the mesh
  107842. */
  107843. get onBeforeBindObservable(): Observable<Mesh>;
  107844. /**
  107845. * An event triggered after rendering the mesh
  107846. */
  107847. get onAfterRenderObservable(): Observable<Mesh>;
  107848. /**
  107849. * An event triggered before drawing the mesh
  107850. */
  107851. get onBeforeDrawObservable(): Observable<Mesh>;
  107852. private _onBeforeDrawObserver;
  107853. /**
  107854. * Sets a callback to call before drawing the mesh. It is recommended to use onBeforeDrawObservable instead
  107855. */
  107856. set onBeforeDraw(callback: () => void);
  107857. get hasInstances(): boolean;
  107858. get hasThinInstances(): boolean;
  107859. /**
  107860. * Gets the delay loading state of the mesh (when delay loading is turned on)
  107861. * @see https://doc.babylonjs.com/how_to/using_the_incremental_loading_system
  107862. */
  107863. delayLoadState: number;
  107864. /**
  107865. * Gets the list of instances created from this mesh
  107866. * it is not supposed to be modified manually.
  107867. * Note also that the order of the InstancedMesh wihin the array is not significant and might change.
  107868. * @see https://doc.babylonjs.com/how_to/how_to_use_instances
  107869. */
  107870. instances: InstancedMesh[];
  107871. /**
  107872. * Gets the file containing delay loading data for this mesh
  107873. */
  107874. delayLoadingFile: string;
  107875. /** @hidden */
  107876. _binaryInfo: any;
  107877. /**
  107878. * User defined function used to change how LOD level selection is done
  107879. * @see https://doc.babylonjs.com/how_to/how_to_use_lod
  107880. */
  107881. onLODLevelSelection: (distance: number, mesh: Mesh, selectedLevel: Nullable<Mesh>) => void;
  107882. /**
  107883. * Gets or sets the morph target manager
  107884. * @see https://doc.babylonjs.com/how_to/how_to_use_morphtargets
  107885. */
  107886. get morphTargetManager(): Nullable<MorphTargetManager>;
  107887. set morphTargetManager(value: Nullable<MorphTargetManager>);
  107888. /** @hidden */
  107889. _creationDataStorage: Nullable<_CreationDataStorage>;
  107890. /** @hidden */
  107891. _geometry: Nullable<Geometry>;
  107892. /** @hidden */
  107893. _delayInfo: Array<string>;
  107894. /** @hidden */
  107895. _delayLoadingFunction: (any: any, mesh: Mesh) => void;
  107896. /** @hidden */
  107897. _instanceDataStorage: _InstanceDataStorage;
  107898. /** @hidden */
  107899. _thinInstanceDataStorage: _ThinInstanceDataStorage;
  107900. private _effectiveMaterial;
  107901. /** @hidden */
  107902. _shouldGenerateFlatShading: boolean;
  107903. /** @hidden */
  107904. _originalBuilderSideOrientation: number;
  107905. /**
  107906. * Use this property to change the original side orientation defined at construction time
  107907. */
  107908. overrideMaterialSideOrientation: Nullable<number>;
  107909. /**
  107910. * Gets the source mesh (the one used to clone this one from)
  107911. */
  107912. get source(): Nullable<Mesh>;
  107913. /**
  107914. * Gets or sets a boolean indicating that this mesh does not use index buffer
  107915. */
  107916. get isUnIndexed(): boolean;
  107917. set isUnIndexed(value: boolean);
  107918. /** Gets the array buffer used to store the instanced buffer used for instances' world matrices */
  107919. get worldMatrixInstancedBuffer(): Float32Array;
  107920. /** Gets or sets a boolean indicating that the update of the instance buffer of the world matrices is manual */
  107921. get manualUpdateOfWorldMatrixInstancedBuffer(): boolean;
  107922. set manualUpdateOfWorldMatrixInstancedBuffer(value: boolean);
  107923. /**
  107924. * @constructor
  107925. * @param name The value used by scene.getMeshByName() to do a lookup.
  107926. * @param scene The scene to add this mesh to.
  107927. * @param parent The parent of this mesh, if it has one
  107928. * @param source An optional Mesh from which geometry is shared, cloned.
  107929. * @param doNotCloneChildren When cloning, skip cloning child meshes of source, default False.
  107930. * When false, achieved by calling a clone(), also passing False.
  107931. * This will make creation of children, recursive.
  107932. * @param clonePhysicsImpostor When cloning, include cloning mesh physics impostor, default True.
  107933. */
  107934. constructor(name: string, scene?: Nullable<Scene>, parent?: Nullable<Node>, source?: Nullable<Mesh>, doNotCloneChildren?: boolean, clonePhysicsImpostor?: boolean);
  107935. instantiateHierarchy(newParent?: Nullable<TransformNode>, options?: {
  107936. doNotInstantiate: boolean;
  107937. }, onNewNodeCreated?: (source: TransformNode, clone: TransformNode) => void): Nullable<TransformNode>;
  107938. /**
  107939. * Gets the class name
  107940. * @returns the string "Mesh".
  107941. */
  107942. getClassName(): string;
  107943. /** @hidden */
  107944. get _isMesh(): boolean;
  107945. /**
  107946. * Returns a description of this mesh
  107947. * @param fullDetails define if full details about this mesh must be used
  107948. * @returns a descriptive string representing this mesh
  107949. */
  107950. toString(fullDetails?: boolean): string;
  107951. /** @hidden */
  107952. _unBindEffect(): void;
  107953. /**
  107954. * Gets a boolean indicating if this mesh has LOD
  107955. */
  107956. get hasLODLevels(): boolean;
  107957. /**
  107958. * Gets the list of MeshLODLevel associated with the current mesh
  107959. * @returns an array of MeshLODLevel
  107960. */
  107961. getLODLevels(): MeshLODLevel[];
  107962. private _sortLODLevels;
  107963. /**
  107964. * Add a mesh as LOD level triggered at the given distance.
  107965. * @see https://doc.babylonjs.com/how_to/how_to_use_lod
  107966. * @param distance The distance from the center of the object to show this level
  107967. * @param mesh The mesh to be added as LOD level (can be null)
  107968. * @return This mesh (for chaining)
  107969. */
  107970. addLODLevel(distance: number, mesh: Nullable<Mesh>): Mesh;
  107971. /**
  107972. * Returns the LOD level mesh at the passed distance or null if not found.
  107973. * @see https://doc.babylonjs.com/how_to/how_to_use_lod
  107974. * @param distance The distance from the center of the object to show this level
  107975. * @returns a Mesh or `null`
  107976. */
  107977. getLODLevelAtDistance(distance: number): Nullable<Mesh>;
  107978. /**
  107979. * Remove a mesh from the LOD array
  107980. * @see https://doc.babylonjs.com/how_to/how_to_use_lod
  107981. * @param mesh defines the mesh to be removed
  107982. * @return This mesh (for chaining)
  107983. */
  107984. removeLODLevel(mesh: Mesh): Mesh;
  107985. /**
  107986. * Returns the registered LOD mesh distant from the parameter `camera` position if any, else returns the current mesh.
  107987. * @see https://doc.babylonjs.com/how_to/how_to_use_lod
  107988. * @param camera defines the camera to use to compute distance
  107989. * @param boundingSphere defines a custom bounding sphere to use instead of the one from this mesh
  107990. * @return This mesh (for chaining)
  107991. */
  107992. getLOD(camera: Camera, boundingSphere?: BoundingSphere): Nullable<AbstractMesh>;
  107993. /**
  107994. * Gets the mesh internal Geometry object
  107995. */
  107996. get geometry(): Nullable<Geometry>;
  107997. /**
  107998. * Returns the total number of vertices within the mesh geometry or zero if the mesh has no geometry.
  107999. * @returns the total number of vertices
  108000. */
  108001. getTotalVertices(): number;
  108002. /**
  108003. * Returns the content of an associated vertex buffer
  108004. * @param kind defines which buffer to read from (positions, indices, normals, etc). Possible `kind` values :
  108005. * - VertexBuffer.PositionKind
  108006. * - VertexBuffer.UVKind
  108007. * - VertexBuffer.UV2Kind
  108008. * - VertexBuffer.UV3Kind
  108009. * - VertexBuffer.UV4Kind
  108010. * - VertexBuffer.UV5Kind
  108011. * - VertexBuffer.UV6Kind
  108012. * - VertexBuffer.ColorKind
  108013. * - VertexBuffer.MatricesIndicesKind
  108014. * - VertexBuffer.MatricesIndicesExtraKind
  108015. * - VertexBuffer.MatricesWeightsKind
  108016. * - VertexBuffer.MatricesWeightsExtraKind
  108017. * @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
  108018. * @param forceCopy defines a boolean forcing the copy of the buffer no matter what the value of copyWhenShared is
  108019. * @returns a FloatArray or null if the mesh has no geometry or no vertex buffer for this kind.
  108020. */
  108021. getVerticesData(kind: string, copyWhenShared?: boolean, forceCopy?: boolean): Nullable<FloatArray>;
  108022. /**
  108023. * Returns the mesh VertexBuffer object from the requested `kind`
  108024. * @param kind defines which buffer to read from (positions, indices, normals, etc). Possible `kind` values :
  108025. * - VertexBuffer.PositionKind
  108026. * - VertexBuffer.NormalKind
  108027. * - VertexBuffer.UVKind
  108028. * - VertexBuffer.UV2Kind
  108029. * - VertexBuffer.UV3Kind
  108030. * - VertexBuffer.UV4Kind
  108031. * - VertexBuffer.UV5Kind
  108032. * - VertexBuffer.UV6Kind
  108033. * - VertexBuffer.ColorKind
  108034. * - VertexBuffer.MatricesIndicesKind
  108035. * - VertexBuffer.MatricesIndicesExtraKind
  108036. * - VertexBuffer.MatricesWeightsKind
  108037. * - VertexBuffer.MatricesWeightsExtraKind
  108038. * @returns a FloatArray or null if the mesh has no vertex buffer for this kind.
  108039. */
  108040. getVertexBuffer(kind: string): Nullable<VertexBuffer>;
  108041. /**
  108042. * Tests if a specific vertex buffer is associated with this mesh
  108043. * @param kind defines which buffer to check (positions, indices, normals, etc). Possible `kind` values :
  108044. * - VertexBuffer.PositionKind
  108045. * - VertexBuffer.NormalKind
  108046. * - VertexBuffer.UVKind
  108047. * - VertexBuffer.UV2Kind
  108048. * - VertexBuffer.UV3Kind
  108049. * - VertexBuffer.UV4Kind
  108050. * - VertexBuffer.UV5Kind
  108051. * - VertexBuffer.UV6Kind
  108052. * - VertexBuffer.ColorKind
  108053. * - VertexBuffer.MatricesIndicesKind
  108054. * - VertexBuffer.MatricesIndicesExtraKind
  108055. * - VertexBuffer.MatricesWeightsKind
  108056. * - VertexBuffer.MatricesWeightsExtraKind
  108057. * @returns a boolean
  108058. */
  108059. isVerticesDataPresent(kind: string): boolean;
  108060. /**
  108061. * Returns a boolean defining if the vertex data for the requested `kind` is updatable.
  108062. * @param kind defines which buffer to check (positions, indices, normals, etc). Possible `kind` values :
  108063. * - VertexBuffer.PositionKind
  108064. * - VertexBuffer.UVKind
  108065. * - VertexBuffer.UV2Kind
  108066. * - VertexBuffer.UV3Kind
  108067. * - VertexBuffer.UV4Kind
  108068. * - VertexBuffer.UV5Kind
  108069. * - VertexBuffer.UV6Kind
  108070. * - VertexBuffer.ColorKind
  108071. * - VertexBuffer.MatricesIndicesKind
  108072. * - VertexBuffer.MatricesIndicesExtraKind
  108073. * - VertexBuffer.MatricesWeightsKind
  108074. * - VertexBuffer.MatricesWeightsExtraKind
  108075. * @returns a boolean
  108076. */
  108077. isVertexBufferUpdatable(kind: string): boolean;
  108078. /**
  108079. * Returns a string which contains the list of existing `kinds` of Vertex Data associated with this mesh.
  108080. * @param kind defines which buffer to read from (positions, indices, normals, etc). Possible `kind` values :
  108081. * - VertexBuffer.PositionKind
  108082. * - VertexBuffer.NormalKind
  108083. * - VertexBuffer.UVKind
  108084. * - VertexBuffer.UV2Kind
  108085. * - VertexBuffer.UV3Kind
  108086. * - VertexBuffer.UV4Kind
  108087. * - VertexBuffer.UV5Kind
  108088. * - VertexBuffer.UV6Kind
  108089. * - VertexBuffer.ColorKind
  108090. * - VertexBuffer.MatricesIndicesKind
  108091. * - VertexBuffer.MatricesIndicesExtraKind
  108092. * - VertexBuffer.MatricesWeightsKind
  108093. * - VertexBuffer.MatricesWeightsExtraKind
  108094. * @returns an array of strings
  108095. */
  108096. getVerticesDataKinds(): string[];
  108097. /**
  108098. * Returns a positive integer : the total number of indices in this mesh geometry.
  108099. * @returns the numner of indices or zero if the mesh has no geometry.
  108100. */
  108101. getTotalIndices(): number;
  108102. /**
  108103. * Returns an array of integers or a typed array (Int32Array, Uint32Array, Uint16Array) populated with the mesh indices.
  108104. * @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.
  108105. * @param forceCopy defines a boolean indicating that the returned array must be cloned upon returning it
  108106. * @returns the indices array or an empty array if the mesh has no geometry
  108107. */
  108108. getIndices(copyWhenShared?: boolean, forceCopy?: boolean): Nullable<IndicesArray>;
  108109. get isBlocked(): boolean;
  108110. /**
  108111. * Determine if the current mesh is ready to be rendered
  108112. * @param completeCheck defines if a complete check (including materials and lights) has to be done (false by default)
  108113. * @param forceInstanceSupport will check if the mesh will be ready when used with instances (false by default)
  108114. * @returns true if all associated assets are ready (material, textures, shaders)
  108115. */
  108116. isReady(completeCheck?: boolean, forceInstanceSupport?: boolean): boolean;
  108117. /**
  108118. * 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.
  108119. */
  108120. get areNormalsFrozen(): boolean;
  108121. /**
  108122. * 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.
  108123. * @returns the current mesh
  108124. */
  108125. freezeNormals(): Mesh;
  108126. /**
  108127. * 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
  108128. * @returns the current mesh
  108129. */
  108130. unfreezeNormals(): Mesh;
  108131. /**
  108132. * Sets a value overriding the instance count. Only applicable when custom instanced InterleavedVertexBuffer are used rather than InstancedMeshs
  108133. */
  108134. set overridenInstanceCount(count: number);
  108135. /** @hidden */
  108136. _preActivate(): Mesh;
  108137. /** @hidden */
  108138. _preActivateForIntermediateRendering(renderId: number): Mesh;
  108139. /** @hidden */
  108140. _registerInstanceForRenderId(instance: InstancedMesh, renderId: number): Mesh;
  108141. protected _afterComputeWorldMatrix(): void;
  108142. /** @hidden */
  108143. _postActivate(): void;
  108144. /**
  108145. * This method recomputes and sets a new BoundingInfo to the mesh unless it is locked.
  108146. * This means the mesh underlying bounding box and sphere are recomputed.
  108147. * @param applySkeleton defines whether to apply the skeleton before computing the bounding info
  108148. * @returns the current mesh
  108149. */
  108150. refreshBoundingInfo(applySkeleton?: boolean): Mesh;
  108151. /** @hidden */
  108152. _createGlobalSubMesh(force: boolean): Nullable<SubMesh>;
  108153. /**
  108154. * This function will subdivide the mesh into multiple submeshes
  108155. * @param count defines the expected number of submeshes
  108156. */
  108157. subdivide(count: number): void;
  108158. /**
  108159. * Copy a FloatArray into a specific associated vertex buffer
  108160. * @param kind defines which buffer to write to (positions, indices, normals, etc). Possible `kind` values :
  108161. * - VertexBuffer.PositionKind
  108162. * - VertexBuffer.UVKind
  108163. * - VertexBuffer.UV2Kind
  108164. * - VertexBuffer.UV3Kind
  108165. * - VertexBuffer.UV4Kind
  108166. * - VertexBuffer.UV5Kind
  108167. * - VertexBuffer.UV6Kind
  108168. * - VertexBuffer.ColorKind
  108169. * - VertexBuffer.MatricesIndicesKind
  108170. * - VertexBuffer.MatricesIndicesExtraKind
  108171. * - VertexBuffer.MatricesWeightsKind
  108172. * - VertexBuffer.MatricesWeightsExtraKind
  108173. * @param data defines the data source
  108174. * @param updatable defines if the updated vertex buffer must be flagged as updatable
  108175. * @param stride defines the data stride size (can be null)
  108176. * @returns the current mesh
  108177. */
  108178. setVerticesData(kind: string, data: FloatArray, updatable?: boolean, stride?: number): AbstractMesh;
  108179. /**
  108180. * Delete a vertex buffer associated with this mesh
  108181. * @param kind defines which buffer to delete (positions, indices, normals, etc). Possible `kind` values :
  108182. * - VertexBuffer.PositionKind
  108183. * - VertexBuffer.UVKind
  108184. * - VertexBuffer.UV2Kind
  108185. * - VertexBuffer.UV3Kind
  108186. * - VertexBuffer.UV4Kind
  108187. * - VertexBuffer.UV5Kind
  108188. * - VertexBuffer.UV6Kind
  108189. * - VertexBuffer.ColorKind
  108190. * - VertexBuffer.MatricesIndicesKind
  108191. * - VertexBuffer.MatricesIndicesExtraKind
  108192. * - VertexBuffer.MatricesWeightsKind
  108193. * - VertexBuffer.MatricesWeightsExtraKind
  108194. */
  108195. removeVerticesData(kind: string): void;
  108196. /**
  108197. * Flags an associated vertex buffer as updatable
  108198. * @param kind defines which buffer to use (positions, indices, normals, etc). Possible `kind` values :
  108199. * - VertexBuffer.PositionKind
  108200. * - VertexBuffer.UVKind
  108201. * - VertexBuffer.UV2Kind
  108202. * - VertexBuffer.UV3Kind
  108203. * - VertexBuffer.UV4Kind
  108204. * - VertexBuffer.UV5Kind
  108205. * - VertexBuffer.UV6Kind
  108206. * - VertexBuffer.ColorKind
  108207. * - VertexBuffer.MatricesIndicesKind
  108208. * - VertexBuffer.MatricesIndicesExtraKind
  108209. * - VertexBuffer.MatricesWeightsKind
  108210. * - VertexBuffer.MatricesWeightsExtraKind
  108211. * @param updatable defines if the updated vertex buffer must be flagged as updatable
  108212. */
  108213. markVerticesDataAsUpdatable(kind: string, updatable?: boolean): void;
  108214. /**
  108215. * Sets the mesh global Vertex Buffer
  108216. * @param buffer defines the buffer to use
  108217. * @returns the current mesh
  108218. */
  108219. setVerticesBuffer(buffer: VertexBuffer): Mesh;
  108220. /**
  108221. * Update a specific associated vertex buffer
  108222. * @param kind defines which buffer to write to (positions, indices, normals, etc). Possible `kind` values :
  108223. * - VertexBuffer.PositionKind
  108224. * - VertexBuffer.UVKind
  108225. * - VertexBuffer.UV2Kind
  108226. * - VertexBuffer.UV3Kind
  108227. * - VertexBuffer.UV4Kind
  108228. * - VertexBuffer.UV5Kind
  108229. * - VertexBuffer.UV6Kind
  108230. * - VertexBuffer.ColorKind
  108231. * - VertexBuffer.MatricesIndicesKind
  108232. * - VertexBuffer.MatricesIndicesExtraKind
  108233. * - VertexBuffer.MatricesWeightsKind
  108234. * - VertexBuffer.MatricesWeightsExtraKind
  108235. * @param data defines the data source
  108236. * @param updateExtends defines if extends info of the mesh must be updated (can be null). This is mostly useful for "position" kind
  108237. * @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)
  108238. * @returns the current mesh
  108239. */
  108240. updateVerticesData(kind: string, data: FloatArray, updateExtends?: boolean, makeItUnique?: boolean): AbstractMesh;
  108241. /**
  108242. * This method updates the vertex positions of an updatable mesh according to the `positionFunction` returned values.
  108243. * @see https://doc.babylonjs.com/how_to/how_to_dynamically_morph_a_mesh#other-shapes-updatemeshpositions
  108244. * @param positionFunction is a simple JS function what is passed the mesh `positions` array. It doesn't need to return anything
  108245. * @param computeNormals is a boolean (default true) to enable/disable the mesh normal recomputation after the vertex position update
  108246. * @returns the current mesh
  108247. */
  108248. updateMeshPositions(positionFunction: (data: FloatArray) => void, computeNormals?: boolean): Mesh;
  108249. /**
  108250. * Creates a un-shared specific occurence of the geometry for the mesh.
  108251. * @returns the current mesh
  108252. */
  108253. makeGeometryUnique(): Mesh;
  108254. /**
  108255. * Set the index buffer of this mesh
  108256. * @param indices defines the source data
  108257. * @param totalVertices defines the total number of vertices referenced by this index data (can be null)
  108258. * @param updatable defines if the updated index buffer must be flagged as updatable (default is false)
  108259. * @returns the current mesh
  108260. */
  108261. setIndices(indices: IndicesArray, totalVertices?: Nullable<number>, updatable?: boolean): AbstractMesh;
  108262. /**
  108263. * Update the current index buffer
  108264. * @param indices defines the source data
  108265. * @param offset defines the offset in the index buffer where to store the new data (can be null)
  108266. * @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)
  108267. * @returns the current mesh
  108268. */
  108269. updateIndices(indices: IndicesArray, offset?: number, gpuMemoryOnly?: boolean): AbstractMesh;
  108270. /**
  108271. * Invert the geometry to move from a right handed system to a left handed one.
  108272. * @returns the current mesh
  108273. */
  108274. toLeftHanded(): Mesh;
  108275. /** @hidden */
  108276. _bind(subMesh: SubMesh, effect: Effect, fillMode: number): Mesh;
  108277. /** @hidden */
  108278. _draw(subMesh: SubMesh, fillMode: number, instancesCount?: number): Mesh;
  108279. /**
  108280. * Registers for this mesh a javascript function called just before the rendering process
  108281. * @param func defines the function to call before rendering this mesh
  108282. * @returns the current mesh
  108283. */
  108284. registerBeforeRender(func: (mesh: AbstractMesh) => void): Mesh;
  108285. /**
  108286. * Disposes a previously registered javascript function called before the rendering
  108287. * @param func defines the function to remove
  108288. * @returns the current mesh
  108289. */
  108290. unregisterBeforeRender(func: (mesh: AbstractMesh) => void): Mesh;
  108291. /**
  108292. * Registers for this mesh a javascript function called just after the rendering is complete
  108293. * @param func defines the function to call after rendering this mesh
  108294. * @returns the current mesh
  108295. */
  108296. registerAfterRender(func: (mesh: AbstractMesh) => void): Mesh;
  108297. /**
  108298. * Disposes a previously registered javascript function called after the rendering.
  108299. * @param func defines the function to remove
  108300. * @returns the current mesh
  108301. */
  108302. unregisterAfterRender(func: (mesh: AbstractMesh) => void): Mesh;
  108303. /** @hidden */
  108304. _getInstancesRenderList(subMeshId: number, isReplacementMode?: boolean): _InstancesBatch;
  108305. /** @hidden */
  108306. _renderWithInstances(subMesh: SubMesh, fillMode: number, batch: _InstancesBatch, effect: Effect, engine: Engine): Mesh;
  108307. /** @hidden */
  108308. _renderWithThinInstances(subMesh: SubMesh, fillMode: number, effect: Effect, engine: Engine): void;
  108309. /** @hidden */
  108310. _processInstancedBuffers(visibleInstances: InstancedMesh[], renderSelf: boolean): void;
  108311. /** @hidden */
  108312. _processRendering(renderingMesh: AbstractMesh, subMesh: SubMesh, effect: Effect, fillMode: number, batch: _InstancesBatch, hardwareInstancedRendering: boolean, onBeforeDraw: (isInstance: boolean, world: Matrix, effectiveMaterial?: Material) => void, effectiveMaterial?: Material): Mesh;
  108313. /** @hidden */
  108314. _rebuild(): void;
  108315. /** @hidden */
  108316. _freeze(): void;
  108317. /** @hidden */
  108318. _unFreeze(): void;
  108319. /**
  108320. * 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
  108321. * @param subMesh defines the subMesh to render
  108322. * @param enableAlphaMode defines if alpha mode can be changed
  108323. * @param effectiveMeshReplacement defines an optional mesh used to provide info for the rendering
  108324. * @returns the current mesh
  108325. */
  108326. render(subMesh: SubMesh, enableAlphaMode: boolean, effectiveMeshReplacement?: AbstractMesh): Mesh;
  108327. private _onBeforeDraw;
  108328. /**
  108329. * Renormalize the mesh and patch it up if there are no weights
  108330. * Similar to normalization by adding the weights compute the reciprocal and multiply all elements, this wil ensure that everything adds to 1.
  108331. * However in the case of zero weights then we set just a single influence to 1.
  108332. * We check in the function for extra's present and if so we use the normalizeSkinWeightsWithExtras rather than the FourWeights version.
  108333. */
  108334. cleanMatrixWeights(): void;
  108335. private normalizeSkinFourWeights;
  108336. private normalizeSkinWeightsAndExtra;
  108337. /**
  108338. * ValidateSkinning is used to determine that a mesh has valid skinning data along with skin metrics, if missing weights,
  108339. * or not normalized it is returned as invalid mesh the string can be used for console logs, or on screen messages to let
  108340. * the user know there was an issue with importing the mesh
  108341. * @returns a validation object with skinned, valid and report string
  108342. */
  108343. validateSkinning(): {
  108344. skinned: boolean;
  108345. valid: boolean;
  108346. report: string;
  108347. };
  108348. /** @hidden */
  108349. _checkDelayState(): Mesh;
  108350. private _queueLoad;
  108351. /**
  108352. * Returns `true` if the mesh is within the frustum defined by the passed array of planes.
  108353. * A mesh is in the frustum if its bounding box intersects the frustum
  108354. * @param frustumPlanes defines the frustum to test
  108355. * @returns true if the mesh is in the frustum planes
  108356. */
  108357. isInFrustum(frustumPlanes: Plane[]): boolean;
  108358. /**
  108359. * Sets the mesh material by the material or multiMaterial `id` property
  108360. * @param id is a string identifying the material or the multiMaterial
  108361. * @returns the current mesh
  108362. */
  108363. setMaterialByID(id: string): Mesh;
  108364. /**
  108365. * Returns as a new array populated with the mesh material and/or skeleton, if any.
  108366. * @returns an array of IAnimatable
  108367. */
  108368. getAnimatables(): IAnimatable[];
  108369. /**
  108370. * Modifies the mesh geometry according to the passed transformation matrix.
  108371. * This method returns nothing but it really modifies the mesh even if it's originally not set as updatable.
  108372. * The mesh normals are modified using the same transformation.
  108373. * Note that, under the hood, this method sets a new VertexBuffer each call.
  108374. * @param transform defines the transform matrix to use
  108375. * @see https://doc.babylonjs.com/resources/baking_transformations
  108376. * @returns the current mesh
  108377. */
  108378. bakeTransformIntoVertices(transform: Matrix): Mesh;
  108379. /**
  108380. * Modifies the mesh geometry according to its own current World Matrix.
  108381. * The mesh World Matrix is then reset.
  108382. * This method returns nothing but really modifies the mesh even if it's originally not set as updatable.
  108383. * Note that, under the hood, this method sets a new VertexBuffer each call.
  108384. * @see https://doc.babylonjs.com/resources/baking_transformations
  108385. * @param bakeIndependenlyOfChildren indicates whether to preserve all child nodes' World Matrix during baking
  108386. * @returns the current mesh
  108387. */
  108388. bakeCurrentTransformIntoVertices(bakeIndependenlyOfChildren?: boolean): Mesh;
  108389. /** @hidden */
  108390. get _positions(): Nullable<Vector3[]>;
  108391. /** @hidden */
  108392. _resetPointsArrayCache(): Mesh;
  108393. /** @hidden */
  108394. _generatePointsArray(): boolean;
  108395. /**
  108396. * Returns a new Mesh object generated from the current mesh properties.
  108397. * This method must not get confused with createInstance()
  108398. * @param name is a string, the name given to the new mesh
  108399. * @param newParent can be any Node object (default `null`)
  108400. * @param doNotCloneChildren allows/denies the recursive cloning of the original mesh children if any (default `false`)
  108401. * @param clonePhysicsImpostor allows/denies the cloning in the same time of the original mesh `body` used by the physics engine, if any (default `true`)
  108402. * @returns a new mesh
  108403. */
  108404. clone(name?: string, newParent?: Nullable<Node>, doNotCloneChildren?: boolean, clonePhysicsImpostor?: boolean): Mesh;
  108405. /**
  108406. * Releases resources associated with this mesh.
  108407. * @param doNotRecurse Set to true to not recurse into each children (recurse into each children by default)
  108408. * @param disposeMaterialAndTextures Set to true to also dispose referenced materials and textures (false by default)
  108409. */
  108410. dispose(doNotRecurse?: boolean, disposeMaterialAndTextures?: boolean): void;
  108411. /** @hidden */
  108412. _disposeInstanceSpecificData(): void;
  108413. /** @hidden */
  108414. _disposeThinInstanceSpecificData(): void;
  108415. /**
  108416. * Modifies the mesh geometry according to a displacement map.
  108417. * 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.
  108418. * The mesh must be set as updatable. Its internal geometry is directly modified, no new buffer are allocated.
  108419. * @param url is a string, the URL from the image file is to be downloaded.
  108420. * @param minHeight is the lower limit of the displacement.
  108421. * @param maxHeight is the upper limit of the displacement.
  108422. * @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.
  108423. * @param uvOffset is an optional vector2 used to offset UV.
  108424. * @param uvScale is an optional vector2 used to scale UV.
  108425. * @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.
  108426. * @returns the Mesh.
  108427. */
  108428. applyDisplacementMap(url: string, minHeight: number, maxHeight: number, onSuccess?: (mesh: Mesh) => void, uvOffset?: Vector2, uvScale?: Vector2, forceUpdate?: boolean): Mesh;
  108429. /**
  108430. * Modifies the mesh geometry according to a displacementMap buffer.
  108431. * 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.
  108432. * The mesh must be set as updatable. Its internal geometry is directly modified, no new buffer are allocated.
  108433. * @param buffer is a `Uint8Array` buffer containing series of `Uint8` lower than 255, the red, green, blue and alpha values of each successive pixel.
  108434. * @param heightMapWidth is the width of the buffer image.
  108435. * @param heightMapHeight is the height of the buffer image.
  108436. * @param minHeight is the lower limit of the displacement.
  108437. * @param maxHeight is the upper limit of the displacement.
  108438. * @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.
  108439. * @param uvOffset is an optional vector2 used to offset UV.
  108440. * @param uvScale is an optional vector2 used to scale UV.
  108441. * @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.
  108442. * @returns the Mesh.
  108443. */
  108444. applyDisplacementMapFromBuffer(buffer: Uint8Array, heightMapWidth: number, heightMapHeight: number, minHeight: number, maxHeight: number, uvOffset?: Vector2, uvScale?: Vector2, forceUpdate?: boolean): Mesh;
  108445. /**
  108446. * Modify the mesh to get a flat shading rendering.
  108447. * This means each mesh facet will then have its own normals. Usually new vertices are added in the mesh geometry to get this result.
  108448. * Warning : the mesh is really modified even if not set originally as updatable and, under the hood, a new VertexBuffer is allocated.
  108449. * @returns current mesh
  108450. */
  108451. convertToFlatShadedMesh(): Mesh;
  108452. /**
  108453. * This method removes all the mesh indices and add new vertices (duplication) in order to unfold facets into buffers.
  108454. * In other words, more vertices, no more indices and a single bigger VBO.
  108455. * The mesh is really modified even if not set originally as updatable. Under the hood, a new VertexBuffer is allocated.
  108456. * @returns current mesh
  108457. */
  108458. convertToUnIndexedMesh(): Mesh;
  108459. /**
  108460. * Inverses facet orientations.
  108461. * Warning : the mesh is really modified even if not set originally as updatable. A new VertexBuffer is created under the hood each call.
  108462. * @param flipNormals will also inverts the normals
  108463. * @returns current mesh
  108464. */
  108465. flipFaces(flipNormals?: boolean): Mesh;
  108466. /**
  108467. * Increase the number of facets and hence vertices in a mesh
  108468. * Vertex normals are interpolated from existing vertex normals
  108469. * Warning : the mesh is really modified even if not set originally as updatable. A new VertexBuffer is created under the hood each call.
  108470. * @param numberPerEdge the number of new vertices to add to each edge of a facet, optional default 1
  108471. */
  108472. increaseVertices(numberPerEdge: number): void;
  108473. /**
  108474. * Force adjacent facets to share vertices and remove any facets that have all vertices in a line
  108475. * This will undo any application of covertToFlatShadedMesh
  108476. * Warning : the mesh is really modified even if not set originally as updatable. A new VertexBuffer is created under the hood each call.
  108477. */
  108478. forceSharedVertices(): void;
  108479. /** @hidden */
  108480. static _instancedMeshFactory(name: string, mesh: Mesh): InstancedMesh;
  108481. /** @hidden */
  108482. static _PhysicsImpostorParser(scene: Scene, physicObject: IPhysicsEnabledObject, jsonObject: any): PhysicsImpostor;
  108483. /**
  108484. * Creates a new InstancedMesh object from the mesh model.
  108485. * @see https://doc.babylonjs.com/how_to/how_to_use_instances
  108486. * @param name defines the name of the new instance
  108487. * @returns a new InstancedMesh
  108488. */
  108489. createInstance(name: string): InstancedMesh;
  108490. /**
  108491. * Synchronises all the mesh instance submeshes to the current mesh submeshes, if any.
  108492. * After this call, all the mesh instances have the same submeshes than the current mesh.
  108493. * @returns the current mesh
  108494. */
  108495. synchronizeInstances(): Mesh;
  108496. /**
  108497. * Optimization of the mesh's indices, in case a mesh has duplicated vertices.
  108498. * The function will only reorder the indices and will not remove unused vertices to avoid problems with submeshes.
  108499. * This should be used together with the simplification to avoid disappearing triangles.
  108500. * @param successCallback an optional success callback to be called after the optimization finished.
  108501. * @returns the current mesh
  108502. */
  108503. optimizeIndices(successCallback?: (mesh?: Mesh) => void): Mesh;
  108504. /**
  108505. * Serialize current mesh
  108506. * @param serializationObject defines the object which will receive the serialization data
  108507. */
  108508. serialize(serializationObject: any): void;
  108509. /** @hidden */
  108510. _syncGeometryWithMorphTargetManager(): void;
  108511. /** @hidden */
  108512. static _GroundMeshParser: (parsedMesh: any, scene: Scene) => Mesh;
  108513. /**
  108514. * Returns a new Mesh object parsed from the source provided.
  108515. * @param parsedMesh is the source
  108516. * @param scene defines the hosting scene
  108517. * @param rootUrl is the root URL to prefix the `delayLoadingFile` property with
  108518. * @returns a new Mesh
  108519. */
  108520. static Parse(parsedMesh: any, scene: Scene, rootUrl: string): Mesh;
  108521. /**
  108522. * Creates a ribbon mesh. Please consider using the same method from the MeshBuilder class instead
  108523. * @see https://doc.babylonjs.com/how_to/parametric_shapes
  108524. * @param name defines the name of the mesh to create
  108525. * @param pathArray is a required array of paths, what are each an array of successive Vector3. The pathArray parameter depicts the ribbon geometry.
  108526. * @param closeArray creates a seam between the first and the last paths of the path array (default is false)
  108527. * @param closePath creates a seam between the first and the last points of each path of the path array
  108528. * @param offset is taken in account only if the `pathArray` is containing a single path
  108529. * @param scene defines the hosting scene
  108530. * @param updatable defines if the mesh must be flagged as updatable
  108531. * @param sideOrientation defines the mesh side orientation (https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation)
  108532. * @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)
  108533. * @returns a new Mesh
  108534. */
  108535. static CreateRibbon(name: string, pathArray: Vector3[][], closeArray: boolean, closePath: boolean, offset: number, scene?: Scene, updatable?: boolean, sideOrientation?: number, instance?: Mesh): Mesh;
  108536. /**
  108537. * Creates a plane polygonal mesh. By default, this is a disc. Please consider using the same method from the MeshBuilder class instead
  108538. * @param name defines the name of the mesh to create
  108539. * @param radius sets the radius size (float) of the polygon (default 0.5)
  108540. * @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
  108541. * @param scene defines the hosting scene
  108542. * @param updatable defines if the mesh must be flagged as updatable
  108543. * @param sideOrientation defines the mesh side orientation (https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation)
  108544. * @returns a new Mesh
  108545. */
  108546. static CreateDisc(name: string, radius: number, tessellation: number, scene?: Nullable<Scene>, updatable?: boolean, sideOrientation?: number): Mesh;
  108547. /**
  108548. * Creates a box mesh. Please consider using the same method from the MeshBuilder class instead
  108549. * @param name defines the name of the mesh to create
  108550. * @param size sets the size (float) of each box side (default 1)
  108551. * @param scene defines the hosting scene
  108552. * @param updatable defines if the mesh must be flagged as updatable
  108553. * @param sideOrientation defines the mesh side orientation (https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation)
  108554. * @returns a new Mesh
  108555. */
  108556. static CreateBox(name: string, size: number, scene?: Nullable<Scene>, updatable?: boolean, sideOrientation?: number): Mesh;
  108557. /**
  108558. * Creates a sphere mesh. Please consider using the same method from the MeshBuilder class instead
  108559. * @param name defines the name of the mesh to create
  108560. * @param segments sets the sphere number of horizontal stripes (positive integer, default 32)
  108561. * @param diameter sets the diameter size (float) of the sphere (default 1)
  108562. * @param scene defines the hosting scene
  108563. * @param updatable defines if the mesh must be flagged as updatable
  108564. * @param sideOrientation defines the mesh side orientation (https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation)
  108565. * @returns a new Mesh
  108566. */
  108567. static CreateSphere(name: string, segments: number, diameter: number, scene?: Scene, updatable?: boolean, sideOrientation?: number): Mesh;
  108568. /**
  108569. * Creates a hemisphere mesh. Please consider using the same method from the MeshBuilder class instead
  108570. * @param name defines the name of the mesh to create
  108571. * @param segments sets the sphere number of horizontal stripes (positive integer, default 32)
  108572. * @param diameter sets the diameter size (float) of the sphere (default 1)
  108573. * @param scene defines the hosting scene
  108574. * @returns a new Mesh
  108575. */
  108576. static CreateHemisphere(name: string, segments: number, diameter: number, scene?: Scene): Mesh;
  108577. /**
  108578. * Creates a cylinder or a cone mesh. Please consider using the same method from the MeshBuilder class instead
  108579. * @param name defines the name of the mesh to create
  108580. * @param height sets the height size (float) of the cylinder/cone (float, default 2)
  108581. * @param diameterTop set the top cap diameter (floats, default 1)
  108582. * @param diameterBottom set the bottom cap diameter (floats, default 1). This value can't be zero
  108583. * @param tessellation sets the number of cylinder sides (positive integer, default 24). Set it to 3 to get a prism for instance
  108584. * @param subdivisions sets the number of rings along the cylinder height (positive integer, default 1)
  108585. * @param scene defines the hosting scene
  108586. * @param updatable defines if the mesh must be flagged as updatable
  108587. * @param sideOrientation defines the mesh side orientation (https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation)
  108588. * @returns a new Mesh
  108589. */
  108590. static CreateCylinder(name: string, height: number, diameterTop: number, diameterBottom: number, tessellation: number, subdivisions: any, scene?: Scene, updatable?: any, sideOrientation?: number): Mesh;
  108591. /**
  108592. * Creates a torus mesh. Please consider using the same method from the MeshBuilder class instead
  108593. * @param name defines the name of the mesh to create
  108594. * @param diameter sets the diameter size (float) of the torus (default 1)
  108595. * @param thickness sets the diameter size of the tube of the torus (float, default 0.5)
  108596. * @param tessellation sets the number of torus sides (postive integer, default 16)
  108597. * @param scene defines the hosting scene
  108598. * @param updatable defines if the mesh must be flagged as updatable
  108599. * @param sideOrientation defines the mesh side orientation (https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation)
  108600. * @returns a new Mesh
  108601. */
  108602. static CreateTorus(name: string, diameter: number, thickness: number, tessellation: number, scene?: Scene, updatable?: boolean, sideOrientation?: number): Mesh;
  108603. /**
  108604. * Creates a torus knot mesh. Please consider using the same method from the MeshBuilder class instead
  108605. * @param name defines the name of the mesh to create
  108606. * @param radius sets the global radius size (float) of the torus knot (default 2)
  108607. * @param tube sets the diameter size of the tube of the torus (float, default 0.5)
  108608. * @param radialSegments sets the number of sides on each tube segments (positive integer, default 32)
  108609. * @param tubularSegments sets the number of tubes to decompose the knot into (positive integer, default 32)
  108610. * @param p the number of windings on X axis (positive integers, default 2)
  108611. * @param q the number of windings on Y axis (positive integers, default 3)
  108612. * @param scene defines the hosting scene
  108613. * @param updatable defines if the mesh must be flagged as updatable
  108614. * @param sideOrientation defines the mesh side orientation (https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation)
  108615. * @returns a new Mesh
  108616. */
  108617. static CreateTorusKnot(name: string, radius: number, tube: number, radialSegments: number, tubularSegments: number, p: number, q: number, scene?: Scene, updatable?: boolean, sideOrientation?: number): Mesh;
  108618. /**
  108619. * Creates a line mesh. Please consider using the same method from the MeshBuilder class instead.
  108620. * @param name defines the name of the mesh to create
  108621. * @param points is an array successive Vector3
  108622. * @param scene defines the hosting scene
  108623. * @param updatable defines if the mesh must be flagged as updatable
  108624. * @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).
  108625. * @returns a new Mesh
  108626. */
  108627. static CreateLines(name: string, points: Vector3[], scene?: Nullable<Scene>, updatable?: boolean, instance?: Nullable<LinesMesh>): LinesMesh;
  108628. /**
  108629. * Creates a dashed line mesh. Please consider using the same method from the MeshBuilder class instead
  108630. * @param name defines the name of the mesh to create
  108631. * @param points is an array successive Vector3
  108632. * @param dashSize is the size of the dashes relatively the dash number (positive float, default 3)
  108633. * @param gapSize is the size of the gap between two successive dashes relatively the dash number (positive float, default 1)
  108634. * @param dashNb is the intended total number of dashes (positive integer, default 200)
  108635. * @param scene defines the hosting scene
  108636. * @param updatable defines if the mesh must be flagged as updatable
  108637. * @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)
  108638. * @returns a new Mesh
  108639. */
  108640. static CreateDashedLines(name: string, points: Vector3[], dashSize: number, gapSize: number, dashNb: number, scene?: Nullable<Scene>, updatable?: boolean, instance?: LinesMesh): LinesMesh;
  108641. /**
  108642. * Creates a polygon mesh.Please consider using the same method from the MeshBuilder class instead
  108643. * The polygon's shape will depend on the input parameters and is constructed parallel to a ground mesh.
  108644. * 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.
  108645. * You can set the mesh side orientation with the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  108646. * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created.
  108647. * Remember you can only change the shape positions, not their number when updating a polygon.
  108648. * @see https://doc.babylonjs.com/how_to/parametric_shapes#non-regular-polygon
  108649. * @param name defines the name of the mesh to create
  108650. * @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
  108651. * @param scene defines the hosting scene
  108652. * @param holes is a required array of arrays of successive Vector3 used to defines holes in the polygon
  108653. * @param updatable defines if the mesh must be flagged as updatable
  108654. * @param sideOrientation defines the mesh side orientation (https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation)
  108655. * @param earcutInjection can be used to inject your own earcut reference
  108656. * @returns a new Mesh
  108657. */
  108658. static CreatePolygon(name: string, shape: Vector3[], scene: Scene, holes?: Vector3[][], updatable?: boolean, sideOrientation?: number, earcutInjection?: any): Mesh;
  108659. /**
  108660. * Creates an extruded polygon mesh, with depth in the Y direction. Please consider using the same method from the MeshBuilder class instead.
  108661. * @see https://doc.babylonjs.com/how_to/parametric_shapes#extruded-non-regular-polygon
  108662. * @param name defines the name of the mesh to create
  108663. * @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
  108664. * @param depth defines the height of extrusion
  108665. * @param scene defines the hosting scene
  108666. * @param holes is a required array of arrays of successive Vector3 used to defines holes in the polygon
  108667. * @param updatable defines if the mesh must be flagged as updatable
  108668. * @param sideOrientation defines the mesh side orientation (https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation)
  108669. * @param earcutInjection can be used to inject your own earcut reference
  108670. * @returns a new Mesh
  108671. */
  108672. static ExtrudePolygon(name: string, shape: Vector3[], depth: number, scene: Scene, holes?: Vector3[][], updatable?: boolean, sideOrientation?: number, earcutInjection?: any): Mesh;
  108673. /**
  108674. * Creates an extruded shape mesh.
  108675. * 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
  108676. * @see https://doc.babylonjs.com/how_to/parametric_shapes
  108677. * @see https://doc.babylonjs.com/how_to/parametric_shapes#extruded-shapes
  108678. * @param name defines the name of the mesh to create
  108679. * @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
  108680. * @param path is a required array of successive Vector3. This is the axis curve the shape is extruded along
  108681. * @param scale is the value to scale the shape
  108682. * @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
  108683. * @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
  108684. * @param scene defines the hosting scene
  108685. * @param updatable defines if the mesh must be flagged as updatable
  108686. * @param sideOrientation defines the mesh side orientation (https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation)
  108687. * @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)
  108688. * @returns a new Mesh
  108689. */
  108690. static ExtrudeShape(name: string, shape: Vector3[], path: Vector3[], scale: number, rotation: number, cap: number, scene?: Nullable<Scene>, updatable?: boolean, sideOrientation?: number, instance?: Mesh): Mesh;
  108691. /**
  108692. * Creates an custom extruded shape mesh.
  108693. * The custom extrusion is a parametric shape.
  108694. * It has no predefined shape. Its final shape will depend on the input parameters.
  108695. * Please consider using the same method from the MeshBuilder class instead
  108696. * @see https://doc.babylonjs.com/how_to/parametric_shapes#extruded-shapes
  108697. * @param name defines the name of the mesh to create
  108698. * @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
  108699. * @param path is a required array of successive Vector3. This is the axis curve the shape is extruded along
  108700. * @param scaleFunction is a custom Javascript function called on each path point
  108701. * @param rotationFunction is a custom Javascript function called on each path point
  108702. * @param ribbonCloseArray forces the extrusion underlying ribbon to close all the paths in its `pathArray`
  108703. * @param ribbonClosePath forces the extrusion underlying ribbon to close its `pathArray`
  108704. * @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
  108705. * @param scene defines the hosting scene
  108706. * @param updatable defines if the mesh must be flagged as updatable
  108707. * @param sideOrientation defines the mesh side orientation (https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation)
  108708. * @param 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)
  108709. * @returns a new Mesh
  108710. */
  108711. 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;
  108712. /**
  108713. * Creates lathe mesh.
  108714. * The lathe is a shape with a symetry axis : a 2D model shape is rotated around this axis to design the lathe.
  108715. * Please consider using the same method from the MeshBuilder class instead
  108716. * @param name defines the name of the mesh to create
  108717. * @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
  108718. * @param radius is the radius value of the lathe
  108719. * @param tessellation is the side number of the lathe.
  108720. * @param scene defines the hosting scene
  108721. * @param updatable defines if the mesh must be flagged as updatable
  108722. * @param sideOrientation defines the mesh side orientation (https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation)
  108723. * @returns a new Mesh
  108724. */
  108725. static CreateLathe(name: string, shape: Vector3[], radius: number, tessellation: number, scene: Scene, updatable?: boolean, sideOrientation?: number): Mesh;
  108726. /**
  108727. * Creates a plane mesh. Please consider using the same method from the MeshBuilder class instead
  108728. * @param name defines the name of the mesh to create
  108729. * @param size sets the size (float) of both sides of the plane at once (default 1)
  108730. * @param scene defines the hosting scene
  108731. * @param updatable defines if the mesh must be flagged as updatable
  108732. * @param sideOrientation defines the mesh side orientation (https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation)
  108733. * @returns a new Mesh
  108734. */
  108735. static CreatePlane(name: string, size: number, scene: Scene, updatable?: boolean, sideOrientation?: number): Mesh;
  108736. /**
  108737. * Creates a ground mesh.
  108738. * Please consider using the same method from the MeshBuilder class instead
  108739. * @param name defines the name of the mesh to create
  108740. * @param width set the width of the ground
  108741. * @param height set the height of the ground
  108742. * @param subdivisions sets the number of subdivisions per side
  108743. * @param scene defines the hosting scene
  108744. * @param updatable defines if the mesh must be flagged as updatable
  108745. * @returns a new Mesh
  108746. */
  108747. static CreateGround(name: string, width: number, height: number, subdivisions: number, scene?: Scene, updatable?: boolean): Mesh;
  108748. /**
  108749. * Creates a tiled ground mesh.
  108750. * Please consider using the same method from the MeshBuilder class instead
  108751. * @param name defines the name of the mesh to create
  108752. * @param xmin set the ground minimum X coordinate
  108753. * @param zmin set the ground minimum Y coordinate
  108754. * @param xmax set the ground maximum X coordinate
  108755. * @param zmax set the ground maximum Z coordinate
  108756. * @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
  108757. * @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
  108758. * @param scene defines the hosting scene
  108759. * @param updatable defines if the mesh must be flagged as updatable
  108760. * @returns a new Mesh
  108761. */
  108762. static CreateTiledGround(name: string, xmin: number, zmin: number, xmax: number, zmax: number, subdivisions: {
  108763. w: number;
  108764. h: number;
  108765. }, precision: {
  108766. w: number;
  108767. h: number;
  108768. }, scene: Scene, updatable?: boolean): Mesh;
  108769. /**
  108770. * Creates a ground mesh from a height map.
  108771. * Please consider using the same method from the MeshBuilder class instead
  108772. * @see https://doc.babylonjs.com/babylon101/height_map
  108773. * @param name defines the name of the mesh to create
  108774. * @param url sets the URL of the height map image resource
  108775. * @param width set the ground width size
  108776. * @param height set the ground height size
  108777. * @param subdivisions sets the number of subdivision per side
  108778. * @param minHeight is the minimum altitude on the ground
  108779. * @param maxHeight is the maximum altitude on the ground
  108780. * @param scene defines the hosting scene
  108781. * @param updatable defines if the mesh must be flagged as updatable
  108782. * @param onReady is a callback function that will be called once the mesh is built (the height map download can last some time)
  108783. * @param alphaFilter will filter any data where the alpha channel is below this value, defaults 0 (all data visible)
  108784. * @returns a new Mesh
  108785. */
  108786. 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;
  108787. /**
  108788. * Creates a tube mesh.
  108789. * The tube is a parametric shape.
  108790. * It has no predefined shape. Its final shape will depend on the input parameters.
  108791. * Please consider using the same method from the MeshBuilder class instead
  108792. * @see https://doc.babylonjs.com/how_to/parametric_shapes
  108793. * @param name defines the name of the mesh to create
  108794. * @param path is a required array of successive Vector3. It is the curve used as the axis of the tube
  108795. * @param radius sets the tube radius size
  108796. * @param tessellation is the number of sides on the tubular surface
  108797. * @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
  108798. * @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
  108799. * @param scene defines the hosting scene
  108800. * @param updatable defines if the mesh must be flagged as updatable
  108801. * @param sideOrientation defines the mesh side orientation (https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation)
  108802. * @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)
  108803. * @returns a new Mesh
  108804. */
  108805. static CreateTube(name: string, path: Vector3[], radius: number, tessellation: number, radiusFunction: {
  108806. (i: number, distance: number): number;
  108807. }, cap: number, scene: Scene, updatable?: boolean, sideOrientation?: number, instance?: Mesh): Mesh;
  108808. /**
  108809. * Creates a polyhedron mesh.
  108810. * Please consider using the same method from the MeshBuilder class instead.
  108811. * * 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
  108812. * * The parameter `size` (positive float, default 1) sets the polygon size
  108813. * * You can overwrite the `size` on each dimension bu using the parameters `sizeX`, `sizeY` or `sizeZ` (positive floats, default to `size` value)
  108814. * * 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`
  108815. * * 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
  108816. * * 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)`)
  108817. * * 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
  108818. * * 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
  108819. * * You can also set the mesh side orientation with the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  108820. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  108821. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  108822. * @param name defines the name of the mesh to create
  108823. * @param options defines the options used to create the mesh
  108824. * @param scene defines the hosting scene
  108825. * @returns a new Mesh
  108826. */
  108827. static CreatePolyhedron(name: string, options: {
  108828. type?: number;
  108829. size?: number;
  108830. sizeX?: number;
  108831. sizeY?: number;
  108832. sizeZ?: number;
  108833. custom?: any;
  108834. faceUV?: Vector4[];
  108835. faceColors?: Color4[];
  108836. updatable?: boolean;
  108837. sideOrientation?: number;
  108838. }, scene: Scene): Mesh;
  108839. /**
  108840. * Creates a sphere based upon an icosahedron with 20 triangular faces which can be subdivided
  108841. * * The parameter `radius` sets the radius size (float) of the icosphere (default 1)
  108842. * * 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`)
  108843. * * The parameter `subdivisions` sets the number of subdivisions (postive integer, default 4). The more subdivisions, the more faces on the icosphere whatever its size
  108844. * * 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
  108845. * * You can also set the mesh side orientation with the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  108846. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  108847. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  108848. * @param name defines the name of the mesh
  108849. * @param options defines the options used to create the mesh
  108850. * @param scene defines the hosting scene
  108851. * @returns a new Mesh
  108852. * @see https://doc.babylonjs.com/how_to/polyhedra_shapes#icosphere
  108853. */
  108854. static CreateIcoSphere(name: string, options: {
  108855. radius?: number;
  108856. flat?: boolean;
  108857. subdivisions?: number;
  108858. sideOrientation?: number;
  108859. updatable?: boolean;
  108860. }, scene: Scene): Mesh;
  108861. /**
  108862. * Creates a decal mesh.
  108863. * Please consider using the same method from the MeshBuilder class instead.
  108864. * A decal is a mesh usually applied as a model onto the surface of another mesh
  108865. * @param name defines the name of the mesh
  108866. * @param sourceMesh defines the mesh receiving the decal
  108867. * @param position sets the position of the decal in world coordinates
  108868. * @param normal sets the normal of the mesh where the decal is applied onto in world coordinates
  108869. * @param size sets the decal scaling
  108870. * @param angle sets the angle to rotate the decal
  108871. * @returns a new Mesh
  108872. */
  108873. static CreateDecal(name: string, sourceMesh: AbstractMesh, position: Vector3, normal: Vector3, size: Vector3, angle: number): Mesh;
  108874. /**
  108875. * Prepare internal position array for software CPU skinning
  108876. * @returns original positions used for CPU skinning. Useful for integrating Morphing with skeletons in same mesh
  108877. */
  108878. setPositionsForCPUSkinning(): Float32Array;
  108879. /**
  108880. * Prepare internal normal array for software CPU skinning
  108881. * @returns original normals used for CPU skinning. Useful for integrating Morphing with skeletons in same mesh.
  108882. */
  108883. setNormalsForCPUSkinning(): Float32Array;
  108884. /**
  108885. * Updates the vertex buffer by applying transformation from the bones
  108886. * @param skeleton defines the skeleton to apply to current mesh
  108887. * @returns the current mesh
  108888. */
  108889. applySkeleton(skeleton: Skeleton): Mesh;
  108890. /**
  108891. * 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
  108892. * @param meshes defines the list of meshes to scan
  108893. * @returns an object `{min:` Vector3`, max:` Vector3`}`
  108894. */
  108895. static MinMax(meshes: AbstractMesh[]): {
  108896. min: Vector3;
  108897. max: Vector3;
  108898. };
  108899. /**
  108900. * Returns the center of the `{min:` Vector3`, max:` Vector3`}` or the center of MinMax vector3 computed from a mesh array
  108901. * @param meshesOrMinMaxVector could be an array of meshes or a `{min:` Vector3`, max:` Vector3`}` object
  108902. * @returns a vector3
  108903. */
  108904. static Center(meshesOrMinMaxVector: {
  108905. min: Vector3;
  108906. max: Vector3;
  108907. } | AbstractMesh[]): Vector3;
  108908. /**
  108909. * Merge the array of meshes into a single mesh for performance reasons.
  108910. * @param meshes defines he vertices source. They should all be of the same material. Entries can empty
  108911. * @param disposeSource when true (default), dispose of the vertices from the source meshes
  108912. * @param allow32BitsIndices when the sum of the vertices > 64k, this must be set to true
  108913. * @param meshSubclass when set, vertices inserted into this Mesh. Meshes can then be merged into a Mesh sub-class.
  108914. * @param subdivideWithSubMeshes when true (false default), subdivide mesh to his subMesh array with meshes source.
  108915. * @param multiMultiMaterials when true (false default), subdivide mesh and accept multiple multi materials, ignores subdivideWithSubMeshes.
  108916. * @returns a new mesh
  108917. */
  108918. static MergeMeshes(meshes: Array<Mesh>, disposeSource?: boolean, allow32BitsIndices?: boolean, meshSubclass?: Mesh, subdivideWithSubMeshes?: boolean, multiMultiMaterials?: boolean): Nullable<Mesh>;
  108919. /** @hidden */
  108920. addInstance(instance: InstancedMesh): void;
  108921. /** @hidden */
  108922. removeInstance(instance: InstancedMesh): void;
  108923. }
  108924. }
  108925. declare module BABYLON {
  108926. /**
  108927. * This is the base class of all the camera used in the application.
  108928. * @see https://doc.babylonjs.com/features/cameras
  108929. */
  108930. export class Camera extends Node {
  108931. /** @hidden */
  108932. static _createDefaultParsedCamera: (name: string, scene: Scene) => Camera;
  108933. /**
  108934. * This is the default projection mode used by the cameras.
  108935. * It helps recreating a feeling of perspective and better appreciate depth.
  108936. * This is the best way to simulate real life cameras.
  108937. */
  108938. static readonly PERSPECTIVE_CAMERA: number;
  108939. /**
  108940. * This helps creating camera with an orthographic mode.
  108941. * 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.
  108942. */
  108943. static readonly ORTHOGRAPHIC_CAMERA: number;
  108944. /**
  108945. * This is the default FOV mode for perspective cameras.
  108946. * This setting aligns the upper and lower bounds of the viewport to the upper and lower bounds of the camera frustum.
  108947. */
  108948. static readonly FOVMODE_VERTICAL_FIXED: number;
  108949. /**
  108950. * This setting aligns the left and right bounds of the viewport to the left and right bounds of the camera frustum.
  108951. */
  108952. static readonly FOVMODE_HORIZONTAL_FIXED: number;
  108953. /**
  108954. * This specifies ther is no need for a camera rig.
  108955. * Basically only one eye is rendered corresponding to the camera.
  108956. */
  108957. static readonly RIG_MODE_NONE: number;
  108958. /**
  108959. * Simulates a camera Rig with one blue eye and one red eye.
  108960. * This can be use with 3d blue and red glasses.
  108961. */
  108962. static readonly RIG_MODE_STEREOSCOPIC_ANAGLYPH: number;
  108963. /**
  108964. * Defines that both eyes of the camera will be rendered side by side with a parallel target.
  108965. */
  108966. static readonly RIG_MODE_STEREOSCOPIC_SIDEBYSIDE_PARALLEL: number;
  108967. /**
  108968. * Defines that both eyes of the camera will be rendered side by side with a none parallel target.
  108969. */
  108970. static readonly RIG_MODE_STEREOSCOPIC_SIDEBYSIDE_CROSSEYED: number;
  108971. /**
  108972. * Defines that both eyes of the camera will be rendered over under each other.
  108973. */
  108974. static readonly RIG_MODE_STEREOSCOPIC_OVERUNDER: number;
  108975. /**
  108976. * Defines that both eyes of the camera will be rendered on successive lines interlaced for passive 3d monitors.
  108977. */
  108978. static readonly RIG_MODE_STEREOSCOPIC_INTERLACED: number;
  108979. /**
  108980. * Defines that both eyes of the camera should be renderered in a VR mode (carbox).
  108981. */
  108982. static readonly RIG_MODE_VR: number;
  108983. /**
  108984. * Defines that both eyes of the camera should be renderered in a VR mode (webVR).
  108985. */
  108986. static readonly RIG_MODE_WEBVR: number;
  108987. /**
  108988. * Custom rig mode allowing rig cameras to be populated manually with any number of cameras
  108989. */
  108990. static readonly RIG_MODE_CUSTOM: number;
  108991. /**
  108992. * Defines if by default attaching controls should prevent the default javascript event to continue.
  108993. */
  108994. static ForceAttachControlToAlwaysPreventDefault: boolean;
  108995. /**
  108996. * Define the input manager associated with the camera.
  108997. */
  108998. inputs: CameraInputsManager<Camera>;
  108999. /** @hidden */
  109000. _position: Vector3;
  109001. /**
  109002. * Define the current local position of the camera in the scene
  109003. */
  109004. get position(): Vector3;
  109005. set position(newPosition: Vector3);
  109006. protected _upVector: Vector3;
  109007. /**
  109008. * The vector the camera should consider as up.
  109009. * (default is Vector3(0, 1, 0) aka Vector3.Up())
  109010. */
  109011. set upVector(vec: Vector3);
  109012. get upVector(): Vector3;
  109013. /**
  109014. * Define the current limit on the left side for an orthographic camera
  109015. * In scene unit
  109016. */
  109017. orthoLeft: Nullable<number>;
  109018. /**
  109019. * Define the current limit on the right side for an orthographic camera
  109020. * In scene unit
  109021. */
  109022. orthoRight: Nullable<number>;
  109023. /**
  109024. * Define the current limit on the bottom side for an orthographic camera
  109025. * In scene unit
  109026. */
  109027. orthoBottom: Nullable<number>;
  109028. /**
  109029. * Define the current limit on the top side for an orthographic camera
  109030. * In scene unit
  109031. */
  109032. orthoTop: Nullable<number>;
  109033. /**
  109034. * Field Of View is set in Radians. (default is 0.8)
  109035. */
  109036. fov: number;
  109037. /**
  109038. * Define the minimum distance the camera can see from.
  109039. * This is important to note that the depth buffer are not infinite and the closer it starts
  109040. * the more your scene might encounter depth fighting issue.
  109041. */
  109042. minZ: number;
  109043. /**
  109044. * Define the maximum distance the camera can see to.
  109045. * This is important to note that the depth buffer are not infinite and the further it end
  109046. * the more your scene might encounter depth fighting issue.
  109047. */
  109048. maxZ: number;
  109049. /**
  109050. * Define the default inertia of the camera.
  109051. * This helps giving a smooth feeling to the camera movement.
  109052. */
  109053. inertia: number;
  109054. /**
  109055. * Define the mode of the camera (Camera.PERSPECTIVE_CAMERA or Camera.ORTHOGRAPHIC_CAMERA)
  109056. */
  109057. mode: number;
  109058. /**
  109059. * Define whether the camera is intermediate.
  109060. * This is useful to not present the output directly to the screen in case of rig without post process for instance
  109061. */
  109062. isIntermediate: boolean;
  109063. /**
  109064. * Define the viewport of the camera.
  109065. * This correspond to the portion of the screen the camera will render to in normalized 0 to 1 unit.
  109066. */
  109067. viewport: Viewport;
  109068. /**
  109069. * Restricts the camera to viewing objects with the same layerMask.
  109070. * A camera with a layerMask of 1 will render mesh.layerMask & camera.layerMask!== 0
  109071. */
  109072. layerMask: number;
  109073. /**
  109074. * fovMode sets the camera frustum bounds to the viewport bounds. (default is FOVMODE_VERTICAL_FIXED)
  109075. */
  109076. fovMode: number;
  109077. /**
  109078. * Rig mode of the camera.
  109079. * This is useful to create the camera with two "eyes" instead of one to create VR or stereoscopic scenes.
  109080. * This is normally controlled byt the camera themselves as internal use.
  109081. */
  109082. cameraRigMode: number;
  109083. /**
  109084. * Defines the distance between both "eyes" in case of a RIG
  109085. */
  109086. interaxialDistance: number;
  109087. /**
  109088. * Defines if stereoscopic rendering is done side by side or over under.
  109089. */
  109090. isStereoscopicSideBySide: boolean;
  109091. /**
  109092. * 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
  109093. * This is pretty helpfull if you wish to make a camera render to a texture you could reuse somewhere
  109094. * else in the scene. (Eg. security camera)
  109095. *
  109096. * 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)
  109097. */
  109098. customRenderTargets: RenderTargetTexture[];
  109099. /**
  109100. * When set, the camera will render to this render target instead of the default canvas
  109101. *
  109102. * If the desire is to use the output of a camera as a texture in the scene consider using camera.customRenderTargets instead
  109103. */
  109104. outputRenderTarget: Nullable<RenderTargetTexture>;
  109105. /**
  109106. * Observable triggered when the camera view matrix has changed.
  109107. */
  109108. onViewMatrixChangedObservable: Observable<Camera>;
  109109. /**
  109110. * Observable triggered when the camera Projection matrix has changed.
  109111. */
  109112. onProjectionMatrixChangedObservable: Observable<Camera>;
  109113. /**
  109114. * Observable triggered when the inputs have been processed.
  109115. */
  109116. onAfterCheckInputsObservable: Observable<Camera>;
  109117. /**
  109118. * Observable triggered when reset has been called and applied to the camera.
  109119. */
  109120. onRestoreStateObservable: Observable<Camera>;
  109121. /**
  109122. * Is this camera a part of a rig system?
  109123. */
  109124. isRigCamera: boolean;
  109125. /**
  109126. * If isRigCamera set to true this will be set with the parent camera.
  109127. * The parent camera is not (!) necessarily the .parent of this camera (like in the case of XR)
  109128. */
  109129. rigParent?: Camera;
  109130. /** @hidden */
  109131. _cameraRigParams: any;
  109132. /** @hidden */
  109133. _rigCameras: Camera[];
  109134. /** @hidden */
  109135. _rigPostProcess: Nullable<PostProcess>;
  109136. protected _webvrViewMatrix: Matrix;
  109137. /** @hidden */
  109138. _skipRendering: boolean;
  109139. /** @hidden */
  109140. _projectionMatrix: Matrix;
  109141. /** @hidden */
  109142. _postProcesses: Nullable<PostProcess>[];
  109143. /** @hidden */
  109144. _activeMeshes: SmartArray<AbstractMesh>;
  109145. protected _globalPosition: Vector3;
  109146. /** @hidden */
  109147. _computedViewMatrix: Matrix;
  109148. private _doNotComputeProjectionMatrix;
  109149. private _transformMatrix;
  109150. private _frustumPlanes;
  109151. private _refreshFrustumPlanes;
  109152. private _storedFov;
  109153. private _stateStored;
  109154. /**
  109155. * Instantiates a new camera object.
  109156. * This should not be used directly but through the inherited cameras: ArcRotate, Free...
  109157. * @see https://doc.babylonjs.com/features/cameras
  109158. * @param name Defines the name of the camera in the scene
  109159. * @param position Defines the position of the camera
  109160. * @param scene Defines the scene the camera belongs too
  109161. * @param setActiveOnSceneIfNoneActive Defines if the camera should be set as active after creation if no other camera have been defined in the scene
  109162. */
  109163. constructor(name: string, position: Vector3, scene: Scene, setActiveOnSceneIfNoneActive?: boolean);
  109164. /**
  109165. * Store current camera state (fov, position, etc..)
  109166. * @returns the camera
  109167. */
  109168. storeState(): Camera;
  109169. /**
  109170. * Restores the camera state values if it has been stored. You must call storeState() first
  109171. */
  109172. protected _restoreStateValues(): boolean;
  109173. /**
  109174. * Restored camera state. You must call storeState() first.
  109175. * @returns true if restored and false otherwise
  109176. */
  109177. restoreState(): boolean;
  109178. /**
  109179. * Gets the class name of the camera.
  109180. * @returns the class name
  109181. */
  109182. getClassName(): string;
  109183. /** @hidden */
  109184. readonly _isCamera: boolean;
  109185. /**
  109186. * Gets a string representation of the camera useful for debug purpose.
  109187. * @param fullDetails Defines that a more verboe level of logging is required
  109188. * @returns the string representation
  109189. */
  109190. toString(fullDetails?: boolean): string;
  109191. /**
  109192. * Gets the current world space position of the camera.
  109193. */
  109194. get globalPosition(): Vector3;
  109195. /**
  109196. * Gets the list of active meshes this frame (meshes no culled or excluded by lod s in the frame)
  109197. * @returns the active meshe list
  109198. */
  109199. getActiveMeshes(): SmartArray<AbstractMesh>;
  109200. /**
  109201. * Check whether a mesh is part of the current active mesh list of the camera
  109202. * @param mesh Defines the mesh to check
  109203. * @returns true if active, false otherwise
  109204. */
  109205. isActiveMesh(mesh: Mesh): boolean;
  109206. /**
  109207. * Is this camera ready to be used/rendered
  109208. * @param completeCheck defines if a complete check (including post processes) has to be done (false by default)
  109209. * @return true if the camera is ready
  109210. */
  109211. isReady(completeCheck?: boolean): boolean;
  109212. /** @hidden */
  109213. _initCache(): void;
  109214. /** @hidden */
  109215. _updateCache(ignoreParentClass?: boolean): void;
  109216. /** @hidden */
  109217. _isSynchronized(): boolean;
  109218. /** @hidden */
  109219. _isSynchronizedViewMatrix(): boolean;
  109220. /** @hidden */
  109221. _isSynchronizedProjectionMatrix(): boolean;
  109222. /**
  109223. * Attach the input controls to a specific dom element to get the input from.
  109224. * @param element Defines the element the controls should be listened from
  109225. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  109226. */
  109227. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  109228. /**
  109229. * Detach the current controls from the specified dom element.
  109230. * @param element Defines the element to stop listening the inputs from
  109231. */
  109232. detachControl(element: HTMLElement): void;
  109233. /**
  109234. * Update the camera state according to the different inputs gathered during the frame.
  109235. */
  109236. update(): void;
  109237. /** @hidden */
  109238. _checkInputs(): void;
  109239. /** @hidden */
  109240. get rigCameras(): Camera[];
  109241. /**
  109242. * Gets the post process used by the rig cameras
  109243. */
  109244. get rigPostProcess(): Nullable<PostProcess>;
  109245. /**
  109246. * Internal, gets the first post proces.
  109247. * @returns the first post process to be run on this camera.
  109248. */
  109249. _getFirstPostProcess(): Nullable<PostProcess>;
  109250. private _cascadePostProcessesToRigCams;
  109251. /**
  109252. * Attach a post process to the camera.
  109253. * @see https://doc.babylonjs.com/how_to/how_to_use_postprocesses#attach-postprocess
  109254. * @param postProcess The post process to attach to the camera
  109255. * @param insertAt The position of the post process in case several of them are in use in the scene
  109256. * @returns the position the post process has been inserted at
  109257. */
  109258. attachPostProcess(postProcess: PostProcess, insertAt?: Nullable<number>): number;
  109259. /**
  109260. * Detach a post process to the camera.
  109261. * @see https://doc.babylonjs.com/how_to/how_to_use_postprocesses#attach-postprocess
  109262. * @param postProcess The post process to detach from the camera
  109263. */
  109264. detachPostProcess(postProcess: PostProcess): void;
  109265. /**
  109266. * Gets the current world matrix of the camera
  109267. */
  109268. getWorldMatrix(): Matrix;
  109269. /** @hidden */
  109270. _getViewMatrix(): Matrix;
  109271. /**
  109272. * Gets the current view matrix of the camera.
  109273. * @param force forces the camera to recompute the matrix without looking at the cached state
  109274. * @returns the view matrix
  109275. */
  109276. getViewMatrix(force?: boolean): Matrix;
  109277. /**
  109278. * Freeze the projection matrix.
  109279. * It will prevent the cache check of the camera projection compute and can speed up perf
  109280. * if no parameter of the camera are meant to change
  109281. * @param projection Defines manually a projection if necessary
  109282. */
  109283. freezeProjectionMatrix(projection?: Matrix): void;
  109284. /**
  109285. * Unfreeze the projection matrix if it has previously been freezed by freezeProjectionMatrix.
  109286. */
  109287. unfreezeProjectionMatrix(): void;
  109288. /**
  109289. * Gets the current projection matrix of the camera.
  109290. * @param force forces the camera to recompute the matrix without looking at the cached state
  109291. * @returns the projection matrix
  109292. */
  109293. getProjectionMatrix(force?: boolean): Matrix;
  109294. /**
  109295. * Gets the transformation matrix (ie. the multiplication of view by projection matrices)
  109296. * @returns a Matrix
  109297. */
  109298. getTransformationMatrix(): Matrix;
  109299. private _updateFrustumPlanes;
  109300. /**
  109301. * Checks if a cullable object (mesh...) is in the camera frustum
  109302. * This checks the bounding box center. See isCompletelyInFrustum for a full bounding check
  109303. * @param target The object to check
  109304. * @param checkRigCameras If the rig cameras should be checked (eg. with webVR camera both eyes should be checked) (Default: false)
  109305. * @returns true if the object is in frustum otherwise false
  109306. */
  109307. isInFrustum(target: ICullable, checkRigCameras?: boolean): boolean;
  109308. /**
  109309. * Checks if a cullable object (mesh...) is in the camera frustum
  109310. * Unlike isInFrustum this cheks the full bounding box
  109311. * @param target The object to check
  109312. * @returns true if the object is in frustum otherwise false
  109313. */
  109314. isCompletelyInFrustum(target: ICullable): boolean;
  109315. /**
  109316. * Gets a ray in the forward direction from the camera.
  109317. * @param length Defines the length of the ray to create
  109318. * @param transform Defines the transform to apply to the ray, by default the world matrx is used to create a workd space ray
  109319. * @param origin Defines the start point of the ray which defaults to the camera position
  109320. * @returns the forward ray
  109321. */
  109322. getForwardRay(length?: number, transform?: Matrix, origin?: Vector3): Ray;
  109323. /**
  109324. * Gets a ray in the forward direction from the camera.
  109325. * @param refRay the ray to (re)use when setting the values
  109326. * @param length Defines the length of the ray to create
  109327. * @param transform Defines the transform to apply to the ray, by default the world matrx is used to create a workd space ray
  109328. * @param origin Defines the start point of the ray which defaults to the camera position
  109329. * @returns the forward ray
  109330. */
  109331. getForwardRayToRef(refRay: Ray, length?: number, transform?: Matrix, origin?: Vector3): Ray;
  109332. /**
  109333. * Releases resources associated with this node.
  109334. * @param doNotRecurse Set to true to not recurse into each children (recurse into each children by default)
  109335. * @param disposeMaterialAndTextures Set to true to also dispose referenced materials and textures (false by default)
  109336. */
  109337. dispose(doNotRecurse?: boolean, disposeMaterialAndTextures?: boolean): void;
  109338. /** @hidden */
  109339. _isLeftCamera: boolean;
  109340. /**
  109341. * Gets the left camera of a rig setup in case of Rigged Camera
  109342. */
  109343. get isLeftCamera(): boolean;
  109344. /** @hidden */
  109345. _isRightCamera: boolean;
  109346. /**
  109347. * Gets the right camera of a rig setup in case of Rigged Camera
  109348. */
  109349. get isRightCamera(): boolean;
  109350. /**
  109351. * Gets the left camera of a rig setup in case of Rigged Camera
  109352. */
  109353. get leftCamera(): Nullable<FreeCamera>;
  109354. /**
  109355. * Gets the right camera of a rig setup in case of Rigged Camera
  109356. */
  109357. get rightCamera(): Nullable<FreeCamera>;
  109358. /**
  109359. * Gets the left camera target of a rig setup in case of Rigged Camera
  109360. * @returns the target position
  109361. */
  109362. getLeftTarget(): Nullable<Vector3>;
  109363. /**
  109364. * Gets the right camera target of a rig setup in case of Rigged Camera
  109365. * @returns the target position
  109366. */
  109367. getRightTarget(): Nullable<Vector3>;
  109368. /**
  109369. * @hidden
  109370. */
  109371. setCameraRigMode(mode: number, rigParams: any): void;
  109372. /** @hidden */
  109373. static _setStereoscopicRigMode(camera: Camera): void;
  109374. /** @hidden */
  109375. static _setStereoscopicAnaglyphRigMode(camera: Camera): void;
  109376. /** @hidden */
  109377. static _setVRRigMode(camera: Camera, rigParams: any): void;
  109378. /** @hidden */
  109379. static _setWebVRRigMode(camera: Camera, rigParams: any): void;
  109380. /** @hidden */
  109381. _getVRProjectionMatrix(): Matrix;
  109382. protected _updateCameraRotationMatrix(): void;
  109383. protected _updateWebVRCameraRotationMatrix(): void;
  109384. /**
  109385. * This function MUST be overwritten by the different WebVR cameras available.
  109386. * The context in which it is running is the RIG camera. So 'this' is the TargetCamera, left or right.
  109387. * @hidden
  109388. */
  109389. _getWebVRProjectionMatrix(): Matrix;
  109390. /**
  109391. * This function MUST be overwritten by the different WebVR cameras available.
  109392. * The context in which it is running is the RIG camera. So 'this' is the TargetCamera, left or right.
  109393. * @hidden
  109394. */
  109395. _getWebVRViewMatrix(): Matrix;
  109396. /** @hidden */
  109397. setCameraRigParameter(name: string, value: any): void;
  109398. /**
  109399. * needs to be overridden by children so sub has required properties to be copied
  109400. * @hidden
  109401. */
  109402. createRigCamera(name: string, cameraIndex: number): Nullable<Camera>;
  109403. /**
  109404. * May need to be overridden by children
  109405. * @hidden
  109406. */
  109407. _updateRigCameras(): void;
  109408. /** @hidden */
  109409. _setupInputs(): void;
  109410. /**
  109411. * Serialiaze the camera setup to a json represention
  109412. * @returns the JSON representation
  109413. */
  109414. serialize(): any;
  109415. /**
  109416. * Clones the current camera.
  109417. * @param name The cloned camera name
  109418. * @returns the cloned camera
  109419. */
  109420. clone(name: string): Camera;
  109421. /**
  109422. * Gets the direction of the camera relative to a given local axis.
  109423. * @param localAxis Defines the reference axis to provide a relative direction.
  109424. * @return the direction
  109425. */
  109426. getDirection(localAxis: Vector3): Vector3;
  109427. /**
  109428. * Returns the current camera absolute rotation
  109429. */
  109430. get absoluteRotation(): Quaternion;
  109431. /**
  109432. * Gets the direction of the camera relative to a given local axis into a passed vector.
  109433. * @param localAxis Defines the reference axis to provide a relative direction.
  109434. * @param result Defines the vector to store the result in
  109435. */
  109436. getDirectionToRef(localAxis: Vector3, result: Vector3): void;
  109437. /**
  109438. * Gets a camera constructor for a given camera type
  109439. * @param type The type of the camera to construct (should be equal to one of the camera class name)
  109440. * @param name The name of the camera the result will be able to instantiate
  109441. * @param scene The scene the result will construct the camera in
  109442. * @param interaxial_distance In case of stereoscopic setup, the distance between both eyes
  109443. * @param isStereoscopicSideBySide In case of stereoscopic setup, should the sereo be side b side
  109444. * @returns a factory method to construc the camera
  109445. */
  109446. static GetConstructorFromName(type: string, name: string, scene: Scene, interaxial_distance?: number, isStereoscopicSideBySide?: boolean): () => Camera;
  109447. /**
  109448. * Compute the world matrix of the camera.
  109449. * @returns the camera world matrix
  109450. */
  109451. computeWorldMatrix(): Matrix;
  109452. /**
  109453. * Parse a JSON and creates the camera from the parsed information
  109454. * @param parsedCamera The JSON to parse
  109455. * @param scene The scene to instantiate the camera in
  109456. * @returns the newly constructed camera
  109457. */
  109458. static Parse(parsedCamera: any, scene: Scene): Camera;
  109459. }
  109460. }
  109461. declare module BABYLON {
  109462. /**
  109463. * Class containing static functions to help procedurally build meshes
  109464. */
  109465. export class DiscBuilder {
  109466. /**
  109467. * Creates a plane polygonal mesh. By default, this is a disc
  109468. * * The parameter `radius` sets the radius size (float) of the polygon (default 0.5)
  109469. * * 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
  109470. * * 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
  109471. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  109472. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  109473. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  109474. * @param name defines the name of the mesh
  109475. * @param options defines the options used to create the mesh
  109476. * @param scene defines the hosting scene
  109477. * @returns the plane polygonal mesh
  109478. * @see https://doc.babylonjs.com/how_to/set_shapes#disc-or-regular-polygon
  109479. */
  109480. static CreateDisc(name: string, options: {
  109481. radius?: number;
  109482. tessellation?: number;
  109483. arc?: number;
  109484. updatable?: boolean;
  109485. sideOrientation?: number;
  109486. frontUVs?: Vector4;
  109487. backUVs?: Vector4;
  109488. }, scene?: Nullable<Scene>): Mesh;
  109489. }
  109490. }
  109491. declare module BABYLON {
  109492. /**
  109493. * Options to be used when creating a FresnelParameters.
  109494. */
  109495. export type IFresnelParametersCreationOptions = {
  109496. /**
  109497. * Define the color used on edges (grazing angle)
  109498. */
  109499. leftColor?: Color3;
  109500. /**
  109501. * Define the color used on center
  109502. */
  109503. rightColor?: Color3;
  109504. /**
  109505. * Define bias applied to computed fresnel term
  109506. */
  109507. bias?: number;
  109508. /**
  109509. * Defined the power exponent applied to fresnel term
  109510. */
  109511. power?: number;
  109512. /**
  109513. * Define if the fresnel effect is enable or not.
  109514. */
  109515. isEnabled?: boolean;
  109516. };
  109517. /**
  109518. * Serialized format for FresnelParameters.
  109519. */
  109520. export type IFresnelParametersSerialized = {
  109521. /**
  109522. * Define the color used on edges (grazing angle) [as an array]
  109523. */
  109524. leftColor: number[];
  109525. /**
  109526. * Define the color used on center [as an array]
  109527. */
  109528. rightColor: number[];
  109529. /**
  109530. * Define bias applied to computed fresnel term
  109531. */
  109532. bias: number;
  109533. /**
  109534. * Defined the power exponent applied to fresnel term
  109535. */
  109536. power?: number;
  109537. /**
  109538. * Define if the fresnel effect is enable or not.
  109539. */
  109540. isEnabled: boolean;
  109541. };
  109542. /**
  109543. * This represents all the required information to add a fresnel effect on a material:
  109544. * @see https://doc.babylonjs.com/how_to/how_to_use_fresnelparameters
  109545. */
  109546. export class FresnelParameters {
  109547. private _isEnabled;
  109548. /**
  109549. * Define if the fresnel effect is enable or not.
  109550. */
  109551. get isEnabled(): boolean;
  109552. set isEnabled(value: boolean);
  109553. /**
  109554. * Define the color used on edges (grazing angle)
  109555. */
  109556. leftColor: Color3;
  109557. /**
  109558. * Define the color used on center
  109559. */
  109560. rightColor: Color3;
  109561. /**
  109562. * Define bias applied to computed fresnel term
  109563. */
  109564. bias: number;
  109565. /**
  109566. * Defined the power exponent applied to fresnel term
  109567. */
  109568. power: number;
  109569. /**
  109570. * Creates a new FresnelParameters object.
  109571. *
  109572. * @param options provide your own settings to optionally to override defaults
  109573. */
  109574. constructor(options?: IFresnelParametersCreationOptions);
  109575. /**
  109576. * Clones the current fresnel and its valuues
  109577. * @returns a clone fresnel configuration
  109578. */
  109579. clone(): FresnelParameters;
  109580. /**
  109581. * Determines equality between FresnelParameters objects
  109582. * @param otherFresnelParameters defines the second operand
  109583. * @returns true if the power, bias, leftColor, rightColor and isEnabled values are equal to the given ones
  109584. */
  109585. equals(otherFresnelParameters: DeepImmutable<FresnelParameters>): boolean;
  109586. /**
  109587. * Serializes the current fresnel parameters to a JSON representation.
  109588. * @return the JSON serialization
  109589. */
  109590. serialize(): IFresnelParametersSerialized;
  109591. /**
  109592. * Parse a JSON object and deserialize it to a new Fresnel parameter object.
  109593. * @param parsedFresnelParameters Define the JSON representation
  109594. * @returns the parsed parameters
  109595. */
  109596. static Parse(parsedFresnelParameters: IFresnelParametersSerialized): FresnelParameters;
  109597. }
  109598. }
  109599. declare module BABYLON {
  109600. /**
  109601. * This groups all the flags used to control the materials channel.
  109602. */
  109603. export class MaterialFlags {
  109604. private static _DiffuseTextureEnabled;
  109605. /**
  109606. * Are diffuse textures enabled in the application.
  109607. */
  109608. static get DiffuseTextureEnabled(): boolean;
  109609. static set DiffuseTextureEnabled(value: boolean);
  109610. private static _DetailTextureEnabled;
  109611. /**
  109612. * Are detail textures enabled in the application.
  109613. */
  109614. static get DetailTextureEnabled(): boolean;
  109615. static set DetailTextureEnabled(value: boolean);
  109616. private static _AmbientTextureEnabled;
  109617. /**
  109618. * Are ambient textures enabled in the application.
  109619. */
  109620. static get AmbientTextureEnabled(): boolean;
  109621. static set AmbientTextureEnabled(value: boolean);
  109622. private static _OpacityTextureEnabled;
  109623. /**
  109624. * Are opacity textures enabled in the application.
  109625. */
  109626. static get OpacityTextureEnabled(): boolean;
  109627. static set OpacityTextureEnabled(value: boolean);
  109628. private static _ReflectionTextureEnabled;
  109629. /**
  109630. * Are reflection textures enabled in the application.
  109631. */
  109632. static get ReflectionTextureEnabled(): boolean;
  109633. static set ReflectionTextureEnabled(value: boolean);
  109634. private static _EmissiveTextureEnabled;
  109635. /**
  109636. * Are emissive textures enabled in the application.
  109637. */
  109638. static get EmissiveTextureEnabled(): boolean;
  109639. static set EmissiveTextureEnabled(value: boolean);
  109640. private static _SpecularTextureEnabled;
  109641. /**
  109642. * Are specular textures enabled in the application.
  109643. */
  109644. static get SpecularTextureEnabled(): boolean;
  109645. static set SpecularTextureEnabled(value: boolean);
  109646. private static _BumpTextureEnabled;
  109647. /**
  109648. * Are bump textures enabled in the application.
  109649. */
  109650. static get BumpTextureEnabled(): boolean;
  109651. static set BumpTextureEnabled(value: boolean);
  109652. private static _LightmapTextureEnabled;
  109653. /**
  109654. * Are lightmap textures enabled in the application.
  109655. */
  109656. static get LightmapTextureEnabled(): boolean;
  109657. static set LightmapTextureEnabled(value: boolean);
  109658. private static _RefractionTextureEnabled;
  109659. /**
  109660. * Are refraction textures enabled in the application.
  109661. */
  109662. static get RefractionTextureEnabled(): boolean;
  109663. static set RefractionTextureEnabled(value: boolean);
  109664. private static _ColorGradingTextureEnabled;
  109665. /**
  109666. * Are color grading textures enabled in the application.
  109667. */
  109668. static get ColorGradingTextureEnabled(): boolean;
  109669. static set ColorGradingTextureEnabled(value: boolean);
  109670. private static _FresnelEnabled;
  109671. /**
  109672. * Are fresnels enabled in the application.
  109673. */
  109674. static get FresnelEnabled(): boolean;
  109675. static set FresnelEnabled(value: boolean);
  109676. private static _ClearCoatTextureEnabled;
  109677. /**
  109678. * Are clear coat textures enabled in the application.
  109679. */
  109680. static get ClearCoatTextureEnabled(): boolean;
  109681. static set ClearCoatTextureEnabled(value: boolean);
  109682. private static _ClearCoatBumpTextureEnabled;
  109683. /**
  109684. * Are clear coat bump textures enabled in the application.
  109685. */
  109686. static get ClearCoatBumpTextureEnabled(): boolean;
  109687. static set ClearCoatBumpTextureEnabled(value: boolean);
  109688. private static _ClearCoatTintTextureEnabled;
  109689. /**
  109690. * Are clear coat tint textures enabled in the application.
  109691. */
  109692. static get ClearCoatTintTextureEnabled(): boolean;
  109693. static set ClearCoatTintTextureEnabled(value: boolean);
  109694. private static _SheenTextureEnabled;
  109695. /**
  109696. * Are sheen textures enabled in the application.
  109697. */
  109698. static get SheenTextureEnabled(): boolean;
  109699. static set SheenTextureEnabled(value: boolean);
  109700. private static _AnisotropicTextureEnabled;
  109701. /**
  109702. * Are anisotropic textures enabled in the application.
  109703. */
  109704. static get AnisotropicTextureEnabled(): boolean;
  109705. static set AnisotropicTextureEnabled(value: boolean);
  109706. private static _ThicknessTextureEnabled;
  109707. /**
  109708. * Are thickness textures enabled in the application.
  109709. */
  109710. static get ThicknessTextureEnabled(): boolean;
  109711. static set ThicknessTextureEnabled(value: boolean);
  109712. }
  109713. }
  109714. declare module BABYLON {
  109715. /** @hidden */
  109716. export var defaultFragmentDeclaration: {
  109717. name: string;
  109718. shader: string;
  109719. };
  109720. }
  109721. declare module BABYLON {
  109722. /** @hidden */
  109723. export var defaultUboDeclaration: {
  109724. name: string;
  109725. shader: string;
  109726. };
  109727. }
  109728. declare module BABYLON {
  109729. /** @hidden */
  109730. export var prePassDeclaration: {
  109731. name: string;
  109732. shader: string;
  109733. };
  109734. }
  109735. declare module BABYLON {
  109736. /** @hidden */
  109737. export var lightFragmentDeclaration: {
  109738. name: string;
  109739. shader: string;
  109740. };
  109741. }
  109742. declare module BABYLON {
  109743. /** @hidden */
  109744. export var lightUboDeclaration: {
  109745. name: string;
  109746. shader: string;
  109747. };
  109748. }
  109749. declare module BABYLON {
  109750. /** @hidden */
  109751. export var lightsFragmentFunctions: {
  109752. name: string;
  109753. shader: string;
  109754. };
  109755. }
  109756. declare module BABYLON {
  109757. /** @hidden */
  109758. export var shadowsFragmentFunctions: {
  109759. name: string;
  109760. shader: string;
  109761. };
  109762. }
  109763. declare module BABYLON {
  109764. /** @hidden */
  109765. export var fresnelFunction: {
  109766. name: string;
  109767. shader: string;
  109768. };
  109769. }
  109770. declare module BABYLON {
  109771. /** @hidden */
  109772. export var bumpFragmentMainFunctions: {
  109773. name: string;
  109774. shader: string;
  109775. };
  109776. }
  109777. declare module BABYLON {
  109778. /** @hidden */
  109779. export var bumpFragmentFunctions: {
  109780. name: string;
  109781. shader: string;
  109782. };
  109783. }
  109784. declare module BABYLON {
  109785. /** @hidden */
  109786. export var logDepthDeclaration: {
  109787. name: string;
  109788. shader: string;
  109789. };
  109790. }
  109791. declare module BABYLON {
  109792. /** @hidden */
  109793. export var bumpFragment: {
  109794. name: string;
  109795. shader: string;
  109796. };
  109797. }
  109798. declare module BABYLON {
  109799. /** @hidden */
  109800. export var depthPrePass: {
  109801. name: string;
  109802. shader: string;
  109803. };
  109804. }
  109805. declare module BABYLON {
  109806. /** @hidden */
  109807. export var lightFragment: {
  109808. name: string;
  109809. shader: string;
  109810. };
  109811. }
  109812. declare module BABYLON {
  109813. /** @hidden */
  109814. export var logDepthFragment: {
  109815. name: string;
  109816. shader: string;
  109817. };
  109818. }
  109819. declare module BABYLON {
  109820. /** @hidden */
  109821. export var defaultPixelShader: {
  109822. name: string;
  109823. shader: string;
  109824. };
  109825. }
  109826. declare module BABYLON {
  109827. /** @hidden */
  109828. export var defaultVertexDeclaration: {
  109829. name: string;
  109830. shader: string;
  109831. };
  109832. }
  109833. declare module BABYLON {
  109834. /** @hidden */
  109835. export var bumpVertexDeclaration: {
  109836. name: string;
  109837. shader: string;
  109838. };
  109839. }
  109840. declare module BABYLON {
  109841. /** @hidden */
  109842. export var bumpVertex: {
  109843. name: string;
  109844. shader: string;
  109845. };
  109846. }
  109847. declare module BABYLON {
  109848. /** @hidden */
  109849. export var fogVertex: {
  109850. name: string;
  109851. shader: string;
  109852. };
  109853. }
  109854. declare module BABYLON {
  109855. /** @hidden */
  109856. export var shadowsVertex: {
  109857. name: string;
  109858. shader: string;
  109859. };
  109860. }
  109861. declare module BABYLON {
  109862. /** @hidden */
  109863. export var pointCloudVertex: {
  109864. name: string;
  109865. shader: string;
  109866. };
  109867. }
  109868. declare module BABYLON {
  109869. /** @hidden */
  109870. export var logDepthVertex: {
  109871. name: string;
  109872. shader: string;
  109873. };
  109874. }
  109875. declare module BABYLON {
  109876. /** @hidden */
  109877. export var defaultVertexShader: {
  109878. name: string;
  109879. shader: string;
  109880. };
  109881. }
  109882. declare module BABYLON {
  109883. /**
  109884. * @hidden
  109885. */
  109886. export interface IMaterialDetailMapDefines {
  109887. DETAIL: boolean;
  109888. DETAILDIRECTUV: number;
  109889. DETAIL_NORMALBLENDMETHOD: number;
  109890. /** @hidden */
  109891. _areTexturesDirty: boolean;
  109892. }
  109893. /**
  109894. * Define the code related to the detail map parameters of a material
  109895. *
  109896. * Inspired from:
  109897. * 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
  109898. * Unreal: https://docs.unrealengine.com/en-US/Engine/Rendering/Materials/HowTo/DetailTexturing/index.html
  109899. * Cryengine: https://docs.cryengine.com/display/SDKDOC2/Detail+Maps
  109900. */
  109901. export class DetailMapConfiguration {
  109902. private _texture;
  109903. /**
  109904. * The detail texture of the material.
  109905. */
  109906. texture: Nullable<BaseTexture>;
  109907. /**
  109908. * Defines how strongly the detail diffuse/albedo channel is blended with the regular diffuse/albedo texture
  109909. * Bigger values mean stronger blending
  109910. */
  109911. diffuseBlendLevel: number;
  109912. /**
  109913. * Defines how strongly the detail roughness channel is blended with the regular roughness value
  109914. * Bigger values mean stronger blending. Only used with PBR materials
  109915. */
  109916. roughnessBlendLevel: number;
  109917. /**
  109918. * Defines how strong the bump effect from the detail map is
  109919. * Bigger values mean stronger effect
  109920. */
  109921. bumpLevel: number;
  109922. private _normalBlendMethod;
  109923. /**
  109924. * The method used to blend the bump and detail normals together
  109925. */
  109926. normalBlendMethod: number;
  109927. private _isEnabled;
  109928. /**
  109929. * Enable or disable the detail map on this material
  109930. */
  109931. isEnabled: boolean;
  109932. /** @hidden */
  109933. private _internalMarkAllSubMeshesAsTexturesDirty;
  109934. /** @hidden */
  109935. _markAllSubMeshesAsTexturesDirty(): void;
  109936. /**
  109937. * Instantiate a new detail map
  109938. * @param markAllSubMeshesAsTexturesDirty Callback to flag the material to dirty
  109939. */
  109940. constructor(markAllSubMeshesAsTexturesDirty: () => void);
  109941. /**
  109942. * Gets whether the submesh is ready to be used or not.
  109943. * @param defines the list of "defines" to update.
  109944. * @param scene defines the scene the material belongs to.
  109945. * @returns - boolean indicating that the submesh is ready or not.
  109946. */
  109947. isReadyForSubMesh(defines: IMaterialDetailMapDefines, scene: Scene): boolean;
  109948. /**
  109949. * Update the defines for detail map usage
  109950. * @param defines the list of "defines" to update.
  109951. * @param scene defines the scene the material belongs to.
  109952. */
  109953. prepareDefines(defines: IMaterialDetailMapDefines, scene: Scene): void;
  109954. /**
  109955. * Binds the material data.
  109956. * @param uniformBuffer defines the Uniform buffer to fill in.
  109957. * @param scene defines the scene the material belongs to.
  109958. * @param isFrozen defines whether the material is frozen or not.
  109959. */
  109960. bindForSubMesh(uniformBuffer: UniformBuffer, scene: Scene, isFrozen: boolean): void;
  109961. /**
  109962. * Checks to see if a texture is used in the material.
  109963. * @param texture - Base texture to use.
  109964. * @returns - Boolean specifying if a texture is used in the material.
  109965. */
  109966. hasTexture(texture: BaseTexture): boolean;
  109967. /**
  109968. * Returns an array of the actively used textures.
  109969. * @param activeTextures Array of BaseTextures
  109970. */
  109971. getActiveTextures(activeTextures: BaseTexture[]): void;
  109972. /**
  109973. * Returns the animatable textures.
  109974. * @param animatables Array of animatable textures.
  109975. */
  109976. getAnimatables(animatables: IAnimatable[]): void;
  109977. /**
  109978. * Disposes the resources of the material.
  109979. * @param forceDisposeTextures - Forces the disposal of all textures.
  109980. */
  109981. dispose(forceDisposeTextures?: boolean): void;
  109982. /**
  109983. * Get the current class name useful for serialization or dynamic coding.
  109984. * @returns "DetailMap"
  109985. */
  109986. getClassName(): string;
  109987. /**
  109988. * Add the required uniforms to the current list.
  109989. * @param uniforms defines the current uniform list.
  109990. */
  109991. static AddUniforms(uniforms: string[]): void;
  109992. /**
  109993. * Add the required samplers to the current list.
  109994. * @param samplers defines the current sampler list.
  109995. */
  109996. static AddSamplers(samplers: string[]): void;
  109997. /**
  109998. * Add the required uniforms to the current buffer.
  109999. * @param uniformBuffer defines the current uniform buffer.
  110000. */
  110001. static PrepareUniformBuffer(uniformBuffer: UniformBuffer): void;
  110002. /**
  110003. * Makes a duplicate of the current instance into another one.
  110004. * @param detailMap define the instance where to copy the info
  110005. */
  110006. copyTo(detailMap: DetailMapConfiguration): void;
  110007. /**
  110008. * Serializes this detail map instance
  110009. * @returns - An object with the serialized instance.
  110010. */
  110011. serialize(): any;
  110012. /**
  110013. * Parses a detail map setting from a serialized object.
  110014. * @param source - Serialized object.
  110015. * @param scene Defines the scene we are parsing for
  110016. * @param rootUrl Defines the rootUrl to load from
  110017. */
  110018. parse(source: any, scene: Scene, rootUrl: string): void;
  110019. }
  110020. }
  110021. declare module BABYLON {
  110022. /** @hidden */
  110023. export class StandardMaterialDefines extends MaterialDefines implements IImageProcessingConfigurationDefines, IMaterialDetailMapDefines {
  110024. MAINUV1: boolean;
  110025. MAINUV2: boolean;
  110026. DIFFUSE: boolean;
  110027. DIFFUSEDIRECTUV: number;
  110028. DETAIL: boolean;
  110029. DETAILDIRECTUV: number;
  110030. DETAIL_NORMALBLENDMETHOD: number;
  110031. AMBIENT: boolean;
  110032. AMBIENTDIRECTUV: number;
  110033. OPACITY: boolean;
  110034. OPACITYDIRECTUV: number;
  110035. OPACITYRGB: boolean;
  110036. REFLECTION: boolean;
  110037. EMISSIVE: boolean;
  110038. EMISSIVEDIRECTUV: number;
  110039. SPECULAR: boolean;
  110040. SPECULARDIRECTUV: number;
  110041. BUMP: boolean;
  110042. BUMPDIRECTUV: number;
  110043. PARALLAX: boolean;
  110044. PARALLAXOCCLUSION: boolean;
  110045. SPECULAROVERALPHA: boolean;
  110046. CLIPPLANE: boolean;
  110047. CLIPPLANE2: boolean;
  110048. CLIPPLANE3: boolean;
  110049. CLIPPLANE4: boolean;
  110050. CLIPPLANE5: boolean;
  110051. CLIPPLANE6: boolean;
  110052. ALPHATEST: boolean;
  110053. DEPTHPREPASS: boolean;
  110054. ALPHAFROMDIFFUSE: boolean;
  110055. POINTSIZE: boolean;
  110056. FOG: boolean;
  110057. SPECULARTERM: boolean;
  110058. DIFFUSEFRESNEL: boolean;
  110059. OPACITYFRESNEL: boolean;
  110060. REFLECTIONFRESNEL: boolean;
  110061. REFRACTIONFRESNEL: boolean;
  110062. EMISSIVEFRESNEL: boolean;
  110063. FRESNEL: boolean;
  110064. NORMAL: boolean;
  110065. UV1: boolean;
  110066. UV2: boolean;
  110067. VERTEXCOLOR: boolean;
  110068. VERTEXALPHA: boolean;
  110069. NUM_BONE_INFLUENCERS: number;
  110070. BonesPerMesh: number;
  110071. BONETEXTURE: boolean;
  110072. INSTANCES: boolean;
  110073. THIN_INSTANCES: boolean;
  110074. GLOSSINESS: boolean;
  110075. ROUGHNESS: boolean;
  110076. EMISSIVEASILLUMINATION: boolean;
  110077. LINKEMISSIVEWITHDIFFUSE: boolean;
  110078. REFLECTIONFRESNELFROMSPECULAR: boolean;
  110079. LIGHTMAP: boolean;
  110080. LIGHTMAPDIRECTUV: number;
  110081. OBJECTSPACE_NORMALMAP: boolean;
  110082. USELIGHTMAPASSHADOWMAP: boolean;
  110083. REFLECTIONMAP_3D: boolean;
  110084. REFLECTIONMAP_SPHERICAL: boolean;
  110085. REFLECTIONMAP_PLANAR: boolean;
  110086. REFLECTIONMAP_CUBIC: boolean;
  110087. USE_LOCAL_REFLECTIONMAP_CUBIC: boolean;
  110088. REFLECTIONMAP_PROJECTION: boolean;
  110089. REFLECTIONMAP_SKYBOX: boolean;
  110090. REFLECTIONMAP_EXPLICIT: boolean;
  110091. REFLECTIONMAP_EQUIRECTANGULAR: boolean;
  110092. REFLECTIONMAP_EQUIRECTANGULAR_FIXED: boolean;
  110093. REFLECTIONMAP_MIRROREDEQUIRECTANGULAR_FIXED: boolean;
  110094. INVERTCUBICMAP: boolean;
  110095. LOGARITHMICDEPTH: boolean;
  110096. REFRACTION: boolean;
  110097. REFRACTIONMAP_3D: boolean;
  110098. REFLECTIONOVERALPHA: boolean;
  110099. TWOSIDEDLIGHTING: boolean;
  110100. SHADOWFLOAT: boolean;
  110101. MORPHTARGETS: boolean;
  110102. MORPHTARGETS_NORMAL: boolean;
  110103. MORPHTARGETS_TANGENT: boolean;
  110104. MORPHTARGETS_UV: boolean;
  110105. NUM_MORPH_INFLUENCERS: number;
  110106. NONUNIFORMSCALING: boolean;
  110107. PREMULTIPLYALPHA: boolean;
  110108. ALPHATEST_AFTERALLALPHACOMPUTATIONS: boolean;
  110109. ALPHABLEND: boolean;
  110110. PREPASS: boolean;
  110111. SCENE_MRT_COUNT: number;
  110112. RGBDLIGHTMAP: boolean;
  110113. RGBDREFLECTION: boolean;
  110114. RGBDREFRACTION: boolean;
  110115. IMAGEPROCESSING: boolean;
  110116. VIGNETTE: boolean;
  110117. VIGNETTEBLENDMODEMULTIPLY: boolean;
  110118. VIGNETTEBLENDMODEOPAQUE: boolean;
  110119. TONEMAPPING: boolean;
  110120. TONEMAPPING_ACES: boolean;
  110121. CONTRAST: boolean;
  110122. COLORCURVES: boolean;
  110123. COLORGRADING: boolean;
  110124. COLORGRADING3D: boolean;
  110125. SAMPLER3DGREENDEPTH: boolean;
  110126. SAMPLER3DBGRMAP: boolean;
  110127. IMAGEPROCESSINGPOSTPROCESS: boolean;
  110128. MULTIVIEW: boolean;
  110129. /**
  110130. * If the reflection texture on this material is in linear color space
  110131. * @hidden
  110132. */
  110133. IS_REFLECTION_LINEAR: boolean;
  110134. /**
  110135. * If the refraction texture on this material is in linear color space
  110136. * @hidden
  110137. */
  110138. IS_REFRACTION_LINEAR: boolean;
  110139. EXPOSURE: boolean;
  110140. constructor();
  110141. setReflectionMode(modeToEnable: string): void;
  110142. }
  110143. /**
  110144. * This is the default material used in Babylon. It is the best trade off between quality
  110145. * and performances.
  110146. * @see https://doc.babylonjs.com/babylon101/materials
  110147. */
  110148. export class StandardMaterial extends PushMaterial {
  110149. private _diffuseTexture;
  110150. /**
  110151. * The basic texture of the material as viewed under a light.
  110152. */
  110153. diffuseTexture: Nullable<BaseTexture>;
  110154. private _ambientTexture;
  110155. /**
  110156. * AKA Occlusion Texture in other nomenclature, it helps adding baked shadows into your material.
  110157. */
  110158. ambientTexture: Nullable<BaseTexture>;
  110159. private _opacityTexture;
  110160. /**
  110161. * Define the transparency of the material from a texture.
  110162. * The final alpha value can be read either from the red channel (if texture.getAlphaFromRGB is false)
  110163. * or from the luminance or the current texel (if texture.getAlphaFromRGB is true)
  110164. */
  110165. opacityTexture: Nullable<BaseTexture>;
  110166. private _reflectionTexture;
  110167. /**
  110168. * Define the texture used to display the reflection.
  110169. * @see https://doc.babylonjs.com/how_to/reflect#how-to-obtain-reflections-and-refractions
  110170. */
  110171. reflectionTexture: Nullable<BaseTexture>;
  110172. private _emissiveTexture;
  110173. /**
  110174. * Define texture of the material as if self lit.
  110175. * This will be mixed in the final result even in the absence of light.
  110176. */
  110177. emissiveTexture: Nullable<BaseTexture>;
  110178. private _specularTexture;
  110179. /**
  110180. * Define how the color and intensity of the highlight given by the light in the material.
  110181. */
  110182. specularTexture: Nullable<BaseTexture>;
  110183. private _bumpTexture;
  110184. /**
  110185. * Bump mapping is a technique to simulate bump and dents on a rendered surface.
  110186. * 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.
  110187. * @see https://doc.babylonjs.com/how_to/more_materials#bump-map
  110188. */
  110189. bumpTexture: Nullable<BaseTexture>;
  110190. private _lightmapTexture;
  110191. /**
  110192. * Complex lighting can be computationally expensive to compute at runtime.
  110193. * To save on computation, lightmaps may be used to store calculated lighting in a texture which will be applied to a given mesh.
  110194. * @see https://doc.babylonjs.com/babylon101/lights#lightmaps
  110195. */
  110196. lightmapTexture: Nullable<BaseTexture>;
  110197. private _refractionTexture;
  110198. /**
  110199. * Define the texture used to display the refraction.
  110200. * @see https://doc.babylonjs.com/how_to/reflect#how-to-obtain-reflections-and-refractions
  110201. */
  110202. refractionTexture: Nullable<BaseTexture>;
  110203. /**
  110204. * The color of the material lit by the environmental background lighting.
  110205. * @see https://doc.babylonjs.com/babylon101/materials#ambient-color-example
  110206. */
  110207. ambientColor: Color3;
  110208. /**
  110209. * The basic color of the material as viewed under a light.
  110210. */
  110211. diffuseColor: Color3;
  110212. /**
  110213. * Define how the color and intensity of the highlight given by the light in the material.
  110214. */
  110215. specularColor: Color3;
  110216. /**
  110217. * Define the color of the material as if self lit.
  110218. * This will be mixed in the final result even in the absence of light.
  110219. */
  110220. emissiveColor: Color3;
  110221. /**
  110222. * Defines how sharp are the highlights in the material.
  110223. * The bigger the value the sharper giving a more glossy feeling to the result.
  110224. * Reversely, the smaller the value the blurrier giving a more rough feeling to the result.
  110225. */
  110226. specularPower: number;
  110227. private _useAlphaFromDiffuseTexture;
  110228. /**
  110229. * Does the transparency come from the diffuse texture alpha channel.
  110230. */
  110231. useAlphaFromDiffuseTexture: boolean;
  110232. private _useEmissiveAsIllumination;
  110233. /**
  110234. * If true, the emissive value is added into the end result, otherwise it is multiplied in.
  110235. */
  110236. useEmissiveAsIllumination: boolean;
  110237. private _linkEmissiveWithDiffuse;
  110238. /**
  110239. * If true, some kind of energy conservation will prevent the end result to be more than 1 by reducing
  110240. * the emissive level when the final color is close to one.
  110241. */
  110242. linkEmissiveWithDiffuse: boolean;
  110243. private _useSpecularOverAlpha;
  110244. /**
  110245. * Specifies that the material will keep the specular highlights over a transparent surface (only the most limunous ones).
  110246. * A car glass is a good exemple of that. When sun reflects on it you can not see what is behind.
  110247. */
  110248. useSpecularOverAlpha: boolean;
  110249. private _useReflectionOverAlpha;
  110250. /**
  110251. * Specifies that the material will keeps the reflection highlights over a transparent surface (only the most limunous ones).
  110252. * A car glass is a good exemple of that. When the street lights reflects on it you can not see what is behind.
  110253. */
  110254. useReflectionOverAlpha: boolean;
  110255. private _disableLighting;
  110256. /**
  110257. * Does lights from the scene impacts this material.
  110258. * It can be a nice trick for performance to disable lighting on a fully emissive material.
  110259. */
  110260. disableLighting: boolean;
  110261. private _useObjectSpaceNormalMap;
  110262. /**
  110263. * Allows using an object space normal map (instead of tangent space).
  110264. */
  110265. useObjectSpaceNormalMap: boolean;
  110266. private _useParallax;
  110267. /**
  110268. * Is parallax enabled or not.
  110269. * @see https://doc.babylonjs.com/how_to/using_parallax_mapping
  110270. */
  110271. useParallax: boolean;
  110272. private _useParallaxOcclusion;
  110273. /**
  110274. * Is parallax occlusion enabled or not.
  110275. * If true, the outcome is way more realistic than traditional Parallax but you can expect a performance hit that worthes consideration.
  110276. * @see https://doc.babylonjs.com/how_to/using_parallax_mapping
  110277. */
  110278. useParallaxOcclusion: boolean;
  110279. /**
  110280. * 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.
  110281. */
  110282. parallaxScaleBias: number;
  110283. private _roughness;
  110284. /**
  110285. * Helps to define how blurry the reflections should appears in the material.
  110286. */
  110287. roughness: number;
  110288. /**
  110289. * In case of refraction, define the value of the index of refraction.
  110290. * @see https://doc.babylonjs.com/how_to/reflect#how-to-obtain-reflections-and-refractions
  110291. */
  110292. indexOfRefraction: number;
  110293. /**
  110294. * Invert the refraction texture alongside the y axis.
  110295. * It can be useful with procedural textures or probe for instance.
  110296. * @see https://doc.babylonjs.com/how_to/reflect#how-to-obtain-reflections-and-refractions
  110297. */
  110298. invertRefractionY: boolean;
  110299. /**
  110300. * Defines the alpha limits in alpha test mode.
  110301. */
  110302. alphaCutOff: number;
  110303. private _useLightmapAsShadowmap;
  110304. /**
  110305. * In case of light mapping, define whether the map contains light or shadow informations.
  110306. */
  110307. useLightmapAsShadowmap: boolean;
  110308. private _diffuseFresnelParameters;
  110309. /**
  110310. * Define the diffuse fresnel parameters of the material.
  110311. * @see https://doc.babylonjs.com/how_to/how_to_use_fresnelparameters
  110312. */
  110313. diffuseFresnelParameters: FresnelParameters;
  110314. private _opacityFresnelParameters;
  110315. /**
  110316. * Define the opacity fresnel parameters of the material.
  110317. * @see https://doc.babylonjs.com/how_to/how_to_use_fresnelparameters
  110318. */
  110319. opacityFresnelParameters: FresnelParameters;
  110320. private _reflectionFresnelParameters;
  110321. /**
  110322. * Define the reflection fresnel parameters of the material.
  110323. * @see https://doc.babylonjs.com/how_to/how_to_use_fresnelparameters
  110324. */
  110325. reflectionFresnelParameters: FresnelParameters;
  110326. private _refractionFresnelParameters;
  110327. /**
  110328. * Define the refraction fresnel parameters of the material.
  110329. * @see https://doc.babylonjs.com/how_to/how_to_use_fresnelparameters
  110330. */
  110331. refractionFresnelParameters: FresnelParameters;
  110332. private _emissiveFresnelParameters;
  110333. /**
  110334. * Define the emissive fresnel parameters of the material.
  110335. * @see https://doc.babylonjs.com/how_to/how_to_use_fresnelparameters
  110336. */
  110337. emissiveFresnelParameters: FresnelParameters;
  110338. private _useReflectionFresnelFromSpecular;
  110339. /**
  110340. * If true automatically deducts the fresnels values from the material specularity.
  110341. * @see https://doc.babylonjs.com/how_to/how_to_use_fresnelparameters
  110342. */
  110343. useReflectionFresnelFromSpecular: boolean;
  110344. private _useGlossinessFromSpecularMapAlpha;
  110345. /**
  110346. * Defines if the glossiness/roughness of the material should be read from the specular map alpha channel
  110347. */
  110348. useGlossinessFromSpecularMapAlpha: boolean;
  110349. private _maxSimultaneousLights;
  110350. /**
  110351. * Defines the maximum number of lights that can be used in the material
  110352. */
  110353. maxSimultaneousLights: number;
  110354. private _invertNormalMapX;
  110355. /**
  110356. * If sets to true, x component of normal map value will invert (x = 1.0 - x).
  110357. */
  110358. invertNormalMapX: boolean;
  110359. private _invertNormalMapY;
  110360. /**
  110361. * If sets to true, y component of normal map value will invert (y = 1.0 - y).
  110362. */
  110363. invertNormalMapY: boolean;
  110364. private _twoSidedLighting;
  110365. /**
  110366. * If sets to true and backfaceCulling is false, normals will be flipped on the backside.
  110367. */
  110368. twoSidedLighting: boolean;
  110369. /**
  110370. * Default configuration related to image processing available in the standard Material.
  110371. */
  110372. protected _imageProcessingConfiguration: ImageProcessingConfiguration;
  110373. /**
  110374. * Gets the image processing configuration used either in this material.
  110375. */
  110376. get imageProcessingConfiguration(): ImageProcessingConfiguration;
  110377. /**
  110378. * Sets the Default image processing configuration used either in the this material.
  110379. *
  110380. * If sets to null, the scene one is in use.
  110381. */
  110382. set imageProcessingConfiguration(value: ImageProcessingConfiguration);
  110383. /**
  110384. * Keep track of the image processing observer to allow dispose and replace.
  110385. */
  110386. private _imageProcessingObserver;
  110387. /**
  110388. * Attaches a new image processing configuration to the Standard Material.
  110389. * @param configuration
  110390. */
  110391. protected _attachImageProcessingConfiguration(configuration: Nullable<ImageProcessingConfiguration>): void;
  110392. /**
  110393. * Gets wether the color curves effect is enabled.
  110394. */
  110395. get cameraColorCurvesEnabled(): boolean;
  110396. /**
  110397. * Sets wether the color curves effect is enabled.
  110398. */
  110399. set cameraColorCurvesEnabled(value: boolean);
  110400. /**
  110401. * Gets wether the color grading effect is enabled.
  110402. */
  110403. get cameraColorGradingEnabled(): boolean;
  110404. /**
  110405. * Gets wether the color grading effect is enabled.
  110406. */
  110407. set cameraColorGradingEnabled(value: boolean);
  110408. /**
  110409. * Gets wether tonemapping is enabled or not.
  110410. */
  110411. get cameraToneMappingEnabled(): boolean;
  110412. /**
  110413. * Sets wether tonemapping is enabled or not
  110414. */
  110415. set cameraToneMappingEnabled(value: boolean);
  110416. /**
  110417. * The camera exposure used on this material.
  110418. * This property is here and not in the camera to allow controlling exposure without full screen post process.
  110419. * This corresponds to a photographic exposure.
  110420. */
  110421. get cameraExposure(): number;
  110422. /**
  110423. * The camera exposure used on this material.
  110424. * This property is here and not in the camera to allow controlling exposure without full screen post process.
  110425. * This corresponds to a photographic exposure.
  110426. */
  110427. set cameraExposure(value: number);
  110428. /**
  110429. * Gets The camera contrast used on this material.
  110430. */
  110431. get cameraContrast(): number;
  110432. /**
  110433. * Sets The camera contrast used on this material.
  110434. */
  110435. set cameraContrast(value: number);
  110436. /**
  110437. * Gets the Color Grading 2D Lookup Texture.
  110438. */
  110439. get cameraColorGradingTexture(): Nullable<BaseTexture>;
  110440. /**
  110441. * Sets the Color Grading 2D Lookup Texture.
  110442. */
  110443. set cameraColorGradingTexture(value: Nullable<BaseTexture>);
  110444. /**
  110445. * The color grading curves provide additional color adjustmnent that is applied after any color grading transform (3D LUT).
  110446. * They allow basic adjustment of saturation and small exposure adjustments, along with color filter tinting to provide white balance adjustment or more stylistic effects.
  110447. * 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;
  110448. * corresponding to low luminance, medium luminance, and high luminance areas respectively.
  110449. */
  110450. get cameraColorCurves(): Nullable<ColorCurves>;
  110451. /**
  110452. * The color grading curves provide additional color adjustmnent that is applied after any color grading transform (3D LUT).
  110453. * They allow basic adjustment of saturation and small exposure adjustments, along with color filter tinting to provide white balance adjustment or more stylistic effects.
  110454. * 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;
  110455. * corresponding to low luminance, medium luminance, and high luminance areas respectively.
  110456. */
  110457. set cameraColorCurves(value: Nullable<ColorCurves>);
  110458. /**
  110459. * Can this material render to several textures at once
  110460. */
  110461. get canRenderToMRT(): boolean;
  110462. /**
  110463. * Defines the detail map parameters for the material.
  110464. */
  110465. readonly detailMap: DetailMapConfiguration;
  110466. protected _renderTargets: SmartArray<RenderTargetTexture>;
  110467. protected _worldViewProjectionMatrix: Matrix;
  110468. protected _globalAmbientColor: Color3;
  110469. protected _useLogarithmicDepth: boolean;
  110470. protected _rebuildInParallel: boolean;
  110471. /**
  110472. * Instantiates a new standard material.
  110473. * This is the default material used in Babylon. It is the best trade off between quality
  110474. * and performances.
  110475. * @see https://doc.babylonjs.com/babylon101/materials
  110476. * @param name Define the name of the material in the scene
  110477. * @param scene Define the scene the material belong to
  110478. */
  110479. constructor(name: string, scene: Scene);
  110480. /**
  110481. * Gets a boolean indicating that current material needs to register RTT
  110482. */
  110483. get hasRenderTargetTextures(): boolean;
  110484. /**
  110485. * Gets the current class name of the material e.g. "StandardMaterial"
  110486. * Mainly use in serialization.
  110487. * @returns the class name
  110488. */
  110489. getClassName(): string;
  110490. /**
  110491. * In case the depth buffer does not allow enough depth precision for your scene (might be the case in large scenes)
  110492. * You can try switching to logarithmic depth.
  110493. * @see https://doc.babylonjs.com/how_to/using_logarithmic_depth_buffer
  110494. */
  110495. get useLogarithmicDepth(): boolean;
  110496. set useLogarithmicDepth(value: boolean);
  110497. /**
  110498. * Specifies if the material will require alpha blending
  110499. * @returns a boolean specifying if alpha blending is needed
  110500. */
  110501. needAlphaBlending(): boolean;
  110502. /**
  110503. * Specifies if this material should be rendered in alpha test mode
  110504. * @returns a boolean specifying if an alpha test is needed.
  110505. */
  110506. needAlphaTesting(): boolean;
  110507. protected _shouldUseAlphaFromDiffuseTexture(): boolean;
  110508. /**
  110509. * Get the texture used for alpha test purpose.
  110510. * @returns the diffuse texture in case of the standard material.
  110511. */
  110512. getAlphaTestTexture(): Nullable<BaseTexture>;
  110513. /**
  110514. * Get if the submesh is ready to be used and all its information available.
  110515. * Child classes can use it to update shaders
  110516. * @param mesh defines the mesh to check
  110517. * @param subMesh defines which submesh to check
  110518. * @param useInstances specifies that instances should be used
  110519. * @returns a boolean indicating that the submesh is ready or not
  110520. */
  110521. isReadyForSubMesh(mesh: AbstractMesh, subMesh: SubMesh, useInstances?: boolean): boolean;
  110522. /**
  110523. * Builds the material UBO layouts.
  110524. * Used internally during the effect preparation.
  110525. */
  110526. buildUniformLayout(): void;
  110527. /**
  110528. * Unbinds the material from the mesh
  110529. */
  110530. unbind(): void;
  110531. /**
  110532. * Binds the submesh to this material by preparing the effect and shader to draw
  110533. * @param world defines the world transformation matrix
  110534. * @param mesh defines the mesh containing the submesh
  110535. * @param subMesh defines the submesh to bind the material to
  110536. */
  110537. bindForSubMesh(world: Matrix, mesh: Mesh, subMesh: SubMesh): void;
  110538. /**
  110539. * Get the list of animatables in the material.
  110540. * @returns the list of animatables object used in the material
  110541. */
  110542. getAnimatables(): IAnimatable[];
  110543. /**
  110544. * Gets the active textures from the material
  110545. * @returns an array of textures
  110546. */
  110547. getActiveTextures(): BaseTexture[];
  110548. /**
  110549. * Specifies if the material uses a texture
  110550. * @param texture defines the texture to check against the material
  110551. * @returns a boolean specifying if the material uses the texture
  110552. */
  110553. hasTexture(texture: BaseTexture): boolean;
  110554. /**
  110555. * Disposes the material
  110556. * @param forceDisposeEffect specifies if effects should be forcefully disposed
  110557. * @param forceDisposeTextures specifies if textures should be forcefully disposed
  110558. */
  110559. dispose(forceDisposeEffect?: boolean, forceDisposeTextures?: boolean): void;
  110560. /**
  110561. * Makes a duplicate of the material, and gives it a new name
  110562. * @param name defines the new name for the duplicated material
  110563. * @returns the cloned material
  110564. */
  110565. clone(name: string): StandardMaterial;
  110566. /**
  110567. * Serializes this material in a JSON representation
  110568. * @returns the serialized material object
  110569. */
  110570. serialize(): any;
  110571. /**
  110572. * Creates a standard material from parsed material data
  110573. * @param source defines the JSON representation of the material
  110574. * @param scene defines the hosting scene
  110575. * @param rootUrl defines the root URL to use to load textures and relative dependencies
  110576. * @returns a new standard material
  110577. */
  110578. static Parse(source: any, scene: Scene, rootUrl: string): StandardMaterial;
  110579. /**
  110580. * Are diffuse textures enabled in the application.
  110581. */
  110582. static get DiffuseTextureEnabled(): boolean;
  110583. static set DiffuseTextureEnabled(value: boolean);
  110584. /**
  110585. * Are detail textures enabled in the application.
  110586. */
  110587. static get DetailTextureEnabled(): boolean;
  110588. static set DetailTextureEnabled(value: boolean);
  110589. /**
  110590. * Are ambient textures enabled in the application.
  110591. */
  110592. static get AmbientTextureEnabled(): boolean;
  110593. static set AmbientTextureEnabled(value: boolean);
  110594. /**
  110595. * Are opacity textures enabled in the application.
  110596. */
  110597. static get OpacityTextureEnabled(): boolean;
  110598. static set OpacityTextureEnabled(value: boolean);
  110599. /**
  110600. * Are reflection textures enabled in the application.
  110601. */
  110602. static get ReflectionTextureEnabled(): boolean;
  110603. static set ReflectionTextureEnabled(value: boolean);
  110604. /**
  110605. * Are emissive textures enabled in the application.
  110606. */
  110607. static get EmissiveTextureEnabled(): boolean;
  110608. static set EmissiveTextureEnabled(value: boolean);
  110609. /**
  110610. * Are specular textures enabled in the application.
  110611. */
  110612. static get SpecularTextureEnabled(): boolean;
  110613. static set SpecularTextureEnabled(value: boolean);
  110614. /**
  110615. * Are bump textures enabled in the application.
  110616. */
  110617. static get BumpTextureEnabled(): boolean;
  110618. static set BumpTextureEnabled(value: boolean);
  110619. /**
  110620. * Are lightmap textures enabled in the application.
  110621. */
  110622. static get LightmapTextureEnabled(): boolean;
  110623. static set LightmapTextureEnabled(value: boolean);
  110624. /**
  110625. * Are refraction textures enabled in the application.
  110626. */
  110627. static get RefractionTextureEnabled(): boolean;
  110628. static set RefractionTextureEnabled(value: boolean);
  110629. /**
  110630. * Are color grading textures enabled in the application.
  110631. */
  110632. static get ColorGradingTextureEnabled(): boolean;
  110633. static set ColorGradingTextureEnabled(value: boolean);
  110634. /**
  110635. * Are fresnels enabled in the application.
  110636. */
  110637. static get FresnelEnabled(): boolean;
  110638. static set FresnelEnabled(value: boolean);
  110639. }
  110640. }
  110641. declare module BABYLON {
  110642. /**
  110643. * The SPS is a single updatable mesh. The solid particles are simply separate parts or faces fo this big mesh.
  110644. *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.
  110645. * The SPS is also a particle system. It provides some methods to manage the particles.
  110646. * However it is behavior agnostic. This means it has no emitter, no particle physics, no particle recycler. You have to implement your own behavior.
  110647. *
  110648. * Full documentation here : https://doc.babylonjs.com/how_to/Solid_Particle_System
  110649. */
  110650. export class SolidParticleSystem implements IDisposable {
  110651. /**
  110652. * The SPS array of Solid Particle objects. Just access each particle as with any classic array.
  110653. * Example : var p = SPS.particles[i];
  110654. */
  110655. particles: SolidParticle[];
  110656. /**
  110657. * The SPS total number of particles. Read only. Use SPS.counter instead if you need to set your own value.
  110658. */
  110659. nbParticles: number;
  110660. /**
  110661. * If the particles must ever face the camera (default false). Useful for planar particles.
  110662. */
  110663. billboard: boolean;
  110664. /**
  110665. * Recompute normals when adding a shape
  110666. */
  110667. recomputeNormals: boolean;
  110668. /**
  110669. * This a counter ofr your own usage. It's not set by any SPS functions.
  110670. */
  110671. counter: number;
  110672. /**
  110673. * The SPS name. This name is also given to the underlying mesh.
  110674. */
  110675. name: string;
  110676. /**
  110677. * The SPS mesh. It's a standard BJS Mesh, so all the methods from the Mesh class are avalaible.
  110678. */
  110679. mesh: Mesh;
  110680. /**
  110681. * This empty object is intended to store some SPS specific or temporary values in order to lower the Garbage Collector activity.
  110682. * Please read : https://doc.babylonjs.com/how_to/Solid_Particle_System#garbage-collector-concerns
  110683. */
  110684. vars: any;
  110685. /**
  110686. * This array is populated when the SPS is set as 'pickable'.
  110687. * Each key of this array is a `faceId` value that you can get from a pickResult object.
  110688. * Each element of this array is an object `{idx: int, faceId: int}`.
  110689. * `idx` is the picked particle index in the `SPS.particles` array
  110690. * `faceId` is the picked face index counted within this particle.
  110691. * This array is the first element of the pickedBySubMesh array : sps.pickBySubMesh[0].
  110692. * It's not pertinent to use it when using a SPS with the support for MultiMaterial enabled.
  110693. * Use the method SPS.pickedParticle(pickingInfo) instead.
  110694. * Please read : https://doc.babylonjs.com/how_to/Solid_Particle_System#pickable-particles
  110695. */
  110696. pickedParticles: {
  110697. idx: number;
  110698. faceId: number;
  110699. }[];
  110700. /**
  110701. * This array is populated when the SPS is set as 'pickable'
  110702. * Each key of this array is a submesh index.
  110703. * Each element of this array is a second array defined like this :
  110704. * Each key of this second array is a `faceId` value that you can get from a pickResult object.
  110705. * Each element of this second array is an object `{idx: int, faceId: int}`.
  110706. * `idx` is the picked particle index in the `SPS.particles` array
  110707. * `faceId` is the picked face index counted within this particle.
  110708. * It's better to use the method SPS.pickedParticle(pickingInfo) rather than using directly this array.
  110709. * Please read : https://doc.babylonjs.com/how_to/Solid_Particle_System#pickable-particles
  110710. */
  110711. pickedBySubMesh: {
  110712. idx: number;
  110713. faceId: number;
  110714. }[][];
  110715. /**
  110716. * This array is populated when `enableDepthSort` is set to true.
  110717. * Each element of this array is an instance of the class DepthSortedParticle.
  110718. */
  110719. depthSortedParticles: DepthSortedParticle[];
  110720. /**
  110721. * If the particle intersection must be computed only with the bounding sphere (no bounding box computation, so faster). (Internal use only)
  110722. * @hidden
  110723. */
  110724. _bSphereOnly: boolean;
  110725. /**
  110726. * A number to multiply the boundind sphere radius by in order to reduce it for instance. (Internal use only)
  110727. * @hidden
  110728. */
  110729. _bSphereRadiusFactor: number;
  110730. private _scene;
  110731. private _positions;
  110732. private _indices;
  110733. private _normals;
  110734. private _colors;
  110735. private _uvs;
  110736. private _indices32;
  110737. private _positions32;
  110738. private _normals32;
  110739. private _fixedNormal32;
  110740. private _colors32;
  110741. private _uvs32;
  110742. private _index;
  110743. private _updatable;
  110744. private _pickable;
  110745. private _isVisibilityBoxLocked;
  110746. private _alwaysVisible;
  110747. private _depthSort;
  110748. private _expandable;
  110749. private _shapeCounter;
  110750. private _copy;
  110751. private _color;
  110752. private _computeParticleColor;
  110753. private _computeParticleTexture;
  110754. private _computeParticleRotation;
  110755. private _computeParticleVertex;
  110756. private _computeBoundingBox;
  110757. private _depthSortParticles;
  110758. private _camera;
  110759. private _mustUnrotateFixedNormals;
  110760. private _particlesIntersect;
  110761. private _needs32Bits;
  110762. private _isNotBuilt;
  110763. private _lastParticleId;
  110764. private _idxOfId;
  110765. private _multimaterialEnabled;
  110766. private _useModelMaterial;
  110767. private _indicesByMaterial;
  110768. private _materialIndexes;
  110769. private _depthSortFunction;
  110770. private _materialSortFunction;
  110771. private _materials;
  110772. private _multimaterial;
  110773. private _materialIndexesById;
  110774. private _defaultMaterial;
  110775. private _autoUpdateSubMeshes;
  110776. private _tmpVertex;
  110777. /**
  110778. * Creates a SPS (Solid Particle System) object.
  110779. * @param name (String) is the SPS name, this will be the underlying mesh name.
  110780. * @param scene (Scene) is the scene in which the SPS is added.
  110781. * @param options defines the options of the sps e.g.
  110782. * * updatable (optional boolean, default true) : if the SPS must be updatable or immutable.
  110783. * * isPickable (optional boolean, default false) : if the solid particles must be pickable.
  110784. * * enableDepthSort (optional boolean, default false) : if the solid particles must be sorted in the geometry according to their distance to the camera.
  110785. * * 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.
  110786. * * enableMultiMaterial (optional boolean, default false) : if the solid particles can be given different materials.
  110787. * * expandable (optional boolean, default false) : if particles can still be added after the initial SPS mesh creation.
  110788. * * particleIntersection (optional boolean, default false) : if the solid particle intersections must be computed.
  110789. * * boundingSphereOnly (optional boolean, default false) : if the particle intersection must be computed only with the bounding sphere (no bounding box computation, so faster).
  110790. * * bSphereRadiusFactor (optional float, default 1.0) : a number to multiply the boundind sphere radius by in order to reduce it for instance.
  110791. * @example bSphereRadiusFactor = 1.0 / Math.sqrt(3.0) => the bounding sphere exactly matches a spherical mesh.
  110792. */
  110793. constructor(name: string, scene: Scene, options?: {
  110794. updatable?: boolean;
  110795. isPickable?: boolean;
  110796. enableDepthSort?: boolean;
  110797. particleIntersection?: boolean;
  110798. boundingSphereOnly?: boolean;
  110799. bSphereRadiusFactor?: number;
  110800. expandable?: boolean;
  110801. useModelMaterial?: boolean;
  110802. enableMultiMaterial?: boolean;
  110803. });
  110804. /**
  110805. * Builds the SPS underlying mesh. Returns a standard Mesh.
  110806. * If no model shape was added to the SPS, the returned mesh is just a single triangular plane.
  110807. * @returns the created mesh
  110808. */
  110809. buildMesh(): Mesh;
  110810. /**
  110811. * Digests the mesh and generates as many solid particles in the system as wanted. Returns the SPS.
  110812. * These particles will have the same geometry than the mesh parts and will be positioned at the same localisation than the mesh original places.
  110813. * Thus the particles generated from `digest()` have their property `position` set yet.
  110814. * @param mesh ( Mesh ) is the mesh to be digested
  110815. * @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
  110816. * {delta} (optional integer, default 0) is the random extra number of facets per particle , each particle will have between `facetNb` and `facetNb + delta` facets
  110817. * {number} (optional positive integer) is the wanted number of particles : each particle is built with `mesh_total_facets / number` facets
  110818. * {storage} (optional existing array) is an array where the particles will be stored for a further use instead of being inserted in the SPS.
  110819. * @returns the current SPS
  110820. */
  110821. digest(mesh: Mesh, options?: {
  110822. facetNb?: number;
  110823. number?: number;
  110824. delta?: number;
  110825. storage?: [];
  110826. }): SolidParticleSystem;
  110827. /**
  110828. * Unrotate the fixed normals in case the mesh was built with pre-rotated particles, ex : use of positionFunction in addShape()
  110829. * @hidden
  110830. */
  110831. private _unrotateFixedNormals;
  110832. /**
  110833. * Resets the temporary working copy particle
  110834. * @hidden
  110835. */
  110836. private _resetCopy;
  110837. /**
  110838. * Inserts the shape model geometry in the global SPS mesh by updating the positions, indices, normals, colors, uvs arrays
  110839. * @param p the current index in the positions array to be updated
  110840. * @param ind the current index in the indices array
  110841. * @param shape a Vector3 array, the shape geometry
  110842. * @param positions the positions array to be updated
  110843. * @param meshInd the shape indices array
  110844. * @param indices the indices array to be updated
  110845. * @param meshUV the shape uv array
  110846. * @param uvs the uv array to be updated
  110847. * @param meshCol the shape color array
  110848. * @param colors the color array to be updated
  110849. * @param meshNor the shape normals array
  110850. * @param normals the normals array to be updated
  110851. * @param idx the particle index
  110852. * @param idxInShape the particle index in its shape
  110853. * @param options the addShape() method passed options
  110854. * @model the particle model
  110855. * @hidden
  110856. */
  110857. private _meshBuilder;
  110858. /**
  110859. * Returns a shape Vector3 array from positions float array
  110860. * @param positions float array
  110861. * @returns a vector3 array
  110862. * @hidden
  110863. */
  110864. private _posToShape;
  110865. /**
  110866. * Returns a shapeUV array from a float uvs (array deep copy)
  110867. * @param uvs as a float array
  110868. * @returns a shapeUV array
  110869. * @hidden
  110870. */
  110871. private _uvsToShapeUV;
  110872. /**
  110873. * Adds a new particle object in the particles array
  110874. * @param idx particle index in particles array
  110875. * @param id particle id
  110876. * @param idxpos positionIndex : the starting index of the particle vertices in the SPS "positions" array
  110877. * @param idxind indiceIndex : he starting index of the particle indices in the SPS "indices" array
  110878. * @param model particle ModelShape object
  110879. * @param shapeId model shape identifier
  110880. * @param idxInShape index of the particle in the current model
  110881. * @param bInfo model bounding info object
  110882. * @param storage target storage array, if any
  110883. * @hidden
  110884. */
  110885. private _addParticle;
  110886. /**
  110887. * Adds some particles to the SPS from the model shape. Returns the shape id.
  110888. * Please read the doc : https://doc.babylonjs.com/how_to/Solid_Particle_System#create-an-immutable-sps
  110889. * @param mesh is any Mesh object that will be used as a model for the solid particles.
  110890. * @param nb (positive integer) the number of particles to be created from this model
  110891. * @param options {positionFunction} is an optional javascript function to called for each particle on SPS creation.
  110892. * {vertexFunction} is an optional javascript function to called for each vertex of each particle on SPS creation
  110893. * {storage} (optional existing array) is an array where the particles will be stored for a further use instead of being inserted in the SPS.
  110894. * @returns the number of shapes in the system
  110895. */
  110896. addShape(mesh: Mesh, nb: number, options?: {
  110897. positionFunction?: any;
  110898. vertexFunction?: any;
  110899. storage?: [];
  110900. }): number;
  110901. /**
  110902. * Rebuilds a particle back to its just built status : if needed, recomputes the custom positions and vertices
  110903. * @hidden
  110904. */
  110905. private _rebuildParticle;
  110906. /**
  110907. * Rebuilds the whole mesh and updates the VBO : custom positions and vertices are recomputed if needed.
  110908. * @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.
  110909. * @returns the SPS.
  110910. */
  110911. rebuildMesh(reset?: boolean): SolidParticleSystem;
  110912. /** Removes the particles from the start-th to the end-th included from an expandable SPS (required).
  110913. * Returns an array with the removed particles.
  110914. * 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.
  110915. * The SPS can't be empty so at least one particle needs to remain in place.
  110916. * Under the hood, the VertexData array, so the VBO buffer, is recreated each call.
  110917. * @param start index of the first particle to remove
  110918. * @param end index of the last particle to remove (included)
  110919. * @returns an array populated with the removed particles
  110920. */
  110921. removeParticles(start: number, end: number): SolidParticle[];
  110922. /**
  110923. * Inserts some pre-created particles in the solid particle system so that they can be managed by setParticles().
  110924. * @param solidParticleArray an array populated with Solid Particles objects
  110925. * @returns the SPS
  110926. */
  110927. insertParticlesFromArray(solidParticleArray: SolidParticle[]): SolidParticleSystem;
  110928. /**
  110929. * Creates a new particle and modifies the SPS mesh geometry :
  110930. * - calls _meshBuilder() to increase the SPS mesh geometry step by step
  110931. * - calls _addParticle() to populate the particle array
  110932. * factorized code from addShape() and insertParticlesFromArray()
  110933. * @param idx particle index in the particles array
  110934. * @param i particle index in its shape
  110935. * @param modelShape particle ModelShape object
  110936. * @param shape shape vertex array
  110937. * @param meshInd shape indices array
  110938. * @param meshUV shape uv array
  110939. * @param meshCol shape color array
  110940. * @param meshNor shape normals array
  110941. * @param bbInfo shape bounding info
  110942. * @param storage target particle storage
  110943. * @options addShape() passed options
  110944. * @hidden
  110945. */
  110946. private _insertNewParticle;
  110947. /**
  110948. * Sets all the particles : this method actually really updates the mesh according to the particle positions, rotations, colors, textures, etc.
  110949. * This method calls `updateParticle()` for each particle of the SPS.
  110950. * For an animated SPS, it is usually called within the render loop.
  110951. * 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.
  110952. * @param start The particle index in the particle array where to start to compute the particle property values _(default 0)_
  110953. * @param end The particle index in the particle array where to stop to compute the particle property values _(default nbParticle - 1)_
  110954. * @param update If the mesh must be finally updated on this call after all the particle computations _(default true)_
  110955. * @returns the SPS.
  110956. */
  110957. setParticles(start?: number, end?: number, update?: boolean): SolidParticleSystem;
  110958. /**
  110959. * Disposes the SPS.
  110960. */
  110961. dispose(): void;
  110962. /** Returns an object {idx: numbern faceId: number} for the picked particle from the passed pickingInfo object.
  110963. * idx is the particle index in the SPS
  110964. * faceId is the picked face index counted within this particle.
  110965. * Returns null if the pickInfo can't identify a picked particle.
  110966. * @param pickingInfo (PickingInfo object)
  110967. * @returns {idx: number, faceId: number} or null
  110968. */
  110969. pickedParticle(pickingInfo: PickingInfo): Nullable<{
  110970. idx: number;
  110971. faceId: number;
  110972. }>;
  110973. /**
  110974. * Returns a SolidParticle object from its identifier : particle.id
  110975. * @param id (integer) the particle Id
  110976. * @returns the searched particle or null if not found in the SPS.
  110977. */
  110978. getParticleById(id: number): Nullable<SolidParticle>;
  110979. /**
  110980. * Returns a new array populated with the particles having the passed shapeId.
  110981. * @param shapeId (integer) the shape identifier
  110982. * @returns a new solid particle array
  110983. */
  110984. getParticlesByShapeId(shapeId: number): SolidParticle[];
  110985. /**
  110986. * Populates the passed array "ref" with the particles having the passed shapeId.
  110987. * @param shapeId the shape identifier
  110988. * @returns the SPS
  110989. * @param ref
  110990. */
  110991. getParticlesByShapeIdToRef(shapeId: number, ref: SolidParticle[]): SolidParticleSystem;
  110992. /**
  110993. * Computes the required SubMeshes according the materials assigned to the particles.
  110994. * @returns the solid particle system.
  110995. * Does nothing if called before the SPS mesh is built.
  110996. */
  110997. computeSubMeshes(): SolidParticleSystem;
  110998. /**
  110999. * Sorts the solid particles by material when MultiMaterial is enabled.
  111000. * Updates the indices32 array.
  111001. * Updates the indicesByMaterial array.
  111002. * Updates the mesh indices array.
  111003. * @returns the SPS
  111004. * @hidden
  111005. */
  111006. private _sortParticlesByMaterial;
  111007. /**
  111008. * Sets the material indexes by id materialIndexesById[id] = materialIndex
  111009. * @hidden
  111010. */
  111011. private _setMaterialIndexesById;
  111012. /**
  111013. * Returns an array with unique values of Materials from the passed array
  111014. * @param array the material array to be checked and filtered
  111015. * @hidden
  111016. */
  111017. private _filterUniqueMaterialId;
  111018. /**
  111019. * Sets a new Standard Material as _defaultMaterial if not already set.
  111020. * @hidden
  111021. */
  111022. private _setDefaultMaterial;
  111023. /**
  111024. * Visibilty helper : Recomputes the visible size according to the mesh bounding box
  111025. * doc : https://doc.babylonjs.com/how_to/Solid_Particle_System#sps-visibility
  111026. * @returns the SPS.
  111027. */
  111028. refreshVisibleSize(): SolidParticleSystem;
  111029. /**
  111030. * Visibility helper : Sets the size of a visibility box, this sets the underlying mesh bounding box.
  111031. * @param size the size (float) of the visibility box
  111032. * note : this doesn't lock the SPS mesh bounding box.
  111033. * doc : https://doc.babylonjs.com/how_to/Solid_Particle_System#sps-visibility
  111034. */
  111035. setVisibilityBox(size: number): void;
  111036. /**
  111037. * Gets whether the SPS as always visible or not
  111038. * doc : https://doc.babylonjs.com/how_to/Solid_Particle_System#sps-visibility
  111039. */
  111040. get isAlwaysVisible(): boolean;
  111041. /**
  111042. * Sets the SPS as always visible or not
  111043. * doc : https://doc.babylonjs.com/how_to/Solid_Particle_System#sps-visibility
  111044. */
  111045. set isAlwaysVisible(val: boolean);
  111046. /**
  111047. * Sets the SPS visibility box as locked or not. This enables/disables the underlying mesh bounding box updates.
  111048. * doc : https://doc.babylonjs.com/how_to/Solid_Particle_System#sps-visibility
  111049. */
  111050. set isVisibilityBoxLocked(val: boolean);
  111051. /**
  111052. * Gets if the SPS visibility box as locked or not. This enables/disables the underlying mesh bounding box updates.
  111053. * doc : https://doc.babylonjs.com/how_to/Solid_Particle_System#sps-visibility
  111054. */
  111055. get isVisibilityBoxLocked(): boolean;
  111056. /**
  111057. * Tells to `setParticles()` to compute the particle rotations or not.
  111058. * Default value : true. The SPS is faster when it's set to false.
  111059. * Note : the particle rotations aren't stored values, so setting `computeParticleRotation` to false will prevents the particle to rotate.
  111060. */
  111061. set computeParticleRotation(val: boolean);
  111062. /**
  111063. * Tells to `setParticles()` to compute the particle colors or not.
  111064. * Default value : true. The SPS is faster when it's set to false.
  111065. * Note : the particle colors are stored values, so setting `computeParticleColor` to false will keep yet the last colors set.
  111066. */
  111067. set computeParticleColor(val: boolean);
  111068. set computeParticleTexture(val: boolean);
  111069. /**
  111070. * Tells to `setParticles()` to call the vertex function for each vertex of each particle, or not.
  111071. * Default value : false. The SPS is faster when it's set to false.
  111072. * Note : the particle custom vertex positions aren't stored values.
  111073. */
  111074. set computeParticleVertex(val: boolean);
  111075. /**
  111076. * Tells to `setParticles()` to compute or not the mesh bounding box when computing the particle positions.
  111077. */
  111078. set computeBoundingBox(val: boolean);
  111079. /**
  111080. * Tells to `setParticles()` to sort or not the distance between each particle and the camera.
  111081. * Skipped when `enableDepthSort` is set to `false` (default) at construction time.
  111082. * Default : `true`
  111083. */
  111084. set depthSortParticles(val: boolean);
  111085. /**
  111086. * Gets if `setParticles()` computes the particle rotations or not.
  111087. * Default value : true. The SPS is faster when it's set to false.
  111088. * Note : the particle rotations aren't stored values, so setting `computeParticleRotation` to false will prevents the particle to rotate.
  111089. */
  111090. get computeParticleRotation(): boolean;
  111091. /**
  111092. * Gets if `setParticles()` computes the particle colors or not.
  111093. * Default value : true. The SPS is faster when it's set to false.
  111094. * Note : the particle colors are stored values, so setting `computeParticleColor` to false will keep yet the last colors set.
  111095. */
  111096. get computeParticleColor(): boolean;
  111097. /**
  111098. * Gets if `setParticles()` computes the particle textures or not.
  111099. * Default value : true. The SPS is faster when it's set to false.
  111100. * Note : the particle textures are stored values, so setting `computeParticleTexture` to false will keep yet the last colors set.
  111101. */
  111102. get computeParticleTexture(): boolean;
  111103. /**
  111104. * Gets if `setParticles()` calls the vertex function for each vertex of each particle, or not.
  111105. * Default value : false. The SPS is faster when it's set to false.
  111106. * Note : the particle custom vertex positions aren't stored values.
  111107. */
  111108. get computeParticleVertex(): boolean;
  111109. /**
  111110. * Gets if `setParticles()` computes or not the mesh bounding box when computing the particle positions.
  111111. */
  111112. get computeBoundingBox(): boolean;
  111113. /**
  111114. * Gets if `setParticles()` sorts or not the distance between each particle and the camera.
  111115. * Skipped when `enableDepthSort` is set to `false` (default) at construction time.
  111116. * Default : `true`
  111117. */
  111118. get depthSortParticles(): boolean;
  111119. /**
  111120. * Gets if the SPS is created as expandable at construction time.
  111121. * Default : `false`
  111122. */
  111123. get expandable(): boolean;
  111124. /**
  111125. * Gets if the SPS supports the Multi Materials
  111126. */
  111127. get multimaterialEnabled(): boolean;
  111128. /**
  111129. * Gets if the SPS uses the model materials for its own multimaterial.
  111130. */
  111131. get useModelMaterial(): boolean;
  111132. /**
  111133. * The SPS used material array.
  111134. */
  111135. get materials(): Material[];
  111136. /**
  111137. * Sets the SPS MultiMaterial from the passed materials.
  111138. * Note : the passed array is internally copied and not used then by reference.
  111139. * @param materials an array of material objects. This array indexes are the materialIndex values of the particles.
  111140. */
  111141. setMultiMaterial(materials: Material[]): void;
  111142. /**
  111143. * The SPS computed multimaterial object
  111144. */
  111145. get multimaterial(): MultiMaterial;
  111146. set multimaterial(mm: MultiMaterial);
  111147. /**
  111148. * If the subMeshes must be updated on the next call to setParticles()
  111149. */
  111150. get autoUpdateSubMeshes(): boolean;
  111151. set autoUpdateSubMeshes(val: boolean);
  111152. /**
  111153. * This function does nothing. It may be overwritten to set all the particle first values.
  111154. * The SPS doesn't call this function, you may have to call it by your own.
  111155. * doc : https://doc.babylonjs.com/how_to/Solid_Particle_System#particle-management
  111156. */
  111157. initParticles(): void;
  111158. /**
  111159. * This function does nothing. It may be overwritten to recycle a particle.
  111160. * The SPS doesn't call this function, you may have to call it by your own.
  111161. * doc : https://doc.babylonjs.com/how_to/Solid_Particle_System#particle-management
  111162. * @param particle The particle to recycle
  111163. * @returns the recycled particle
  111164. */
  111165. recycleParticle(particle: SolidParticle): SolidParticle;
  111166. /**
  111167. * Updates a particle : this function should be overwritten by the user.
  111168. * It is called on each particle by `setParticles()`. This is the place to code each particle behavior.
  111169. * doc : https://doc.babylonjs.com/how_to/Solid_Particle_System#particle-management
  111170. * @example : just set a particle position or velocity and recycle conditions
  111171. * @param particle The particle to update
  111172. * @returns the updated particle
  111173. */
  111174. updateParticle(particle: SolidParticle): SolidParticle;
  111175. /**
  111176. * Updates a vertex of a particle : it can be overwritten by the user.
  111177. * This will be called on each vertex particle by `setParticles()` if `computeParticleVertex` is set to true only.
  111178. * @param particle the current particle
  111179. * @param vertex the current vertex of the current particle : a SolidParticleVertex object
  111180. * @param pt the index of the current vertex in the particle shape
  111181. * doc : https://doc.babylonjs.com/how_to/Solid_Particle_System#update-each-particle-shape
  111182. * @example : just set a vertex particle position or color
  111183. * @returns the sps
  111184. */
  111185. updateParticleVertex(particle: SolidParticle, vertex: SolidParticleVertex, pt: number): SolidParticleSystem;
  111186. /**
  111187. * This will be called before any other treatment by `setParticles()` and will be passed three parameters.
  111188. * This does nothing and may be overwritten by the user.
  111189. * @param start the particle index in the particle array where to stop to iterate, same than the value passed to setParticle()
  111190. * @param stop the particle index in the particle array where to stop to iterate, same than the value passed to setParticle()
  111191. * @param update the boolean update value actually passed to setParticles()
  111192. */
  111193. beforeUpdateParticles(start?: number, stop?: number, update?: boolean): void;
  111194. /**
  111195. * This will be called by `setParticles()` after all the other treatments and just before the actual mesh update.
  111196. * This will be passed three parameters.
  111197. * This does nothing and may be overwritten by the user.
  111198. * @param start the particle index in the particle array where to stop to iterate, same than the value passed to setParticle()
  111199. * @param stop the particle index in the particle array where to stop to iterate, same than the value passed to setParticle()
  111200. * @param update the boolean update value actually passed to setParticles()
  111201. */
  111202. afterUpdateParticles(start?: number, stop?: number, update?: boolean): void;
  111203. }
  111204. }
  111205. declare module BABYLON {
  111206. /**
  111207. * Represents one particle of a solid particle system.
  111208. */
  111209. export class SolidParticle {
  111210. /**
  111211. * particle global index
  111212. */
  111213. idx: number;
  111214. /**
  111215. * particle identifier
  111216. */
  111217. id: number;
  111218. /**
  111219. * The color of the particle
  111220. */
  111221. color: Nullable<Color4>;
  111222. /**
  111223. * The world space position of the particle.
  111224. */
  111225. position: Vector3;
  111226. /**
  111227. * The world space rotation of the particle. (Not use if rotationQuaternion is set)
  111228. */
  111229. rotation: Vector3;
  111230. /**
  111231. * The world space rotation quaternion of the particle.
  111232. */
  111233. rotationQuaternion: Nullable<Quaternion>;
  111234. /**
  111235. * The scaling of the particle.
  111236. */
  111237. scaling: Vector3;
  111238. /**
  111239. * The uvs of the particle.
  111240. */
  111241. uvs: Vector4;
  111242. /**
  111243. * The current speed of the particle.
  111244. */
  111245. velocity: Vector3;
  111246. /**
  111247. * The pivot point in the particle local space.
  111248. */
  111249. pivot: Vector3;
  111250. /**
  111251. * Must the particle be translated from its pivot point in its local space ?
  111252. * In this case, the pivot point is set at the origin of the particle local space and the particle is translated.
  111253. * Default : false
  111254. */
  111255. translateFromPivot: boolean;
  111256. /**
  111257. * Is the particle active or not ?
  111258. */
  111259. alive: boolean;
  111260. /**
  111261. * Is the particle visible or not ?
  111262. */
  111263. isVisible: boolean;
  111264. /**
  111265. * Index of this particle in the global "positions" array (Internal use)
  111266. * @hidden
  111267. */
  111268. _pos: number;
  111269. /**
  111270. * @hidden Index of this particle in the global "indices" array (Internal use)
  111271. */
  111272. _ind: number;
  111273. /**
  111274. * @hidden ModelShape of this particle (Internal use)
  111275. */
  111276. _model: ModelShape;
  111277. /**
  111278. * ModelShape id of this particle
  111279. */
  111280. shapeId: number;
  111281. /**
  111282. * Index of the particle in its shape id
  111283. */
  111284. idxInShape: number;
  111285. /**
  111286. * @hidden Reference to the shape model BoundingInfo object (Internal use)
  111287. */
  111288. _modelBoundingInfo: BoundingInfo;
  111289. /**
  111290. * @hidden Particle BoundingInfo object (Internal use)
  111291. */
  111292. _boundingInfo: BoundingInfo;
  111293. /**
  111294. * @hidden Reference to the SPS what the particle belongs to (Internal use)
  111295. */
  111296. _sps: SolidParticleSystem;
  111297. /**
  111298. * @hidden Still set as invisible in order to skip useless computations (Internal use)
  111299. */
  111300. _stillInvisible: boolean;
  111301. /**
  111302. * @hidden Last computed particle rotation matrix
  111303. */
  111304. _rotationMatrix: number[];
  111305. /**
  111306. * Parent particle Id, if any.
  111307. * Default null.
  111308. */
  111309. parentId: Nullable<number>;
  111310. /**
  111311. * The particle material identifier (integer) when MultiMaterials are enabled in the SPS.
  111312. */
  111313. materialIndex: Nullable<number>;
  111314. /**
  111315. * Custom object or properties.
  111316. */
  111317. props: Nullable<any>;
  111318. /**
  111319. * The culling strategy to use to check whether the solid particle must be culled or not when using isInFrustum().
  111320. * The possible values are :
  111321. * - AbstractMesh.CULLINGSTRATEGY_STANDARD
  111322. * - AbstractMesh.CULLINGSTRATEGY_BOUNDINGSPHERE_ONLY
  111323. * - AbstractMesh.CULLINGSTRATEGY_OPTIMISTIC_INCLUSION
  111324. * - AbstractMesh.CULLINGSTRATEGY_OPTIMISTIC_INCLUSION_THEN_BSPHERE_ONLY
  111325. * The default value for solid particles is AbstractMesh.CULLINGSTRATEGY_BOUNDINGSPHERE_ONLY
  111326. * Please read each static variable documentation in the class AbstractMesh to get details about the culling process.
  111327. * */
  111328. cullingStrategy: number;
  111329. /**
  111330. * @hidden Internal global position in the SPS.
  111331. */
  111332. _globalPosition: Vector3;
  111333. /**
  111334. * Creates a Solid Particle object.
  111335. * Don't create particles manually, use instead the Solid Particle System internal tools like _addParticle()
  111336. * @param particleIndex (integer) is the particle index in the Solid Particle System pool.
  111337. * @param particleId (integer) is the particle identifier. Unless some particles are removed from the SPS, it's the same value than the particle idx.
  111338. * @param positionIndex (integer) is the starting index of the particle vertices in the SPS "positions" array.
  111339. * @param indiceIndex (integer) is the starting index of the particle indices in the SPS "indices" array.
  111340. * @param model (ModelShape) is a reference to the model shape on what the particle is designed.
  111341. * @param shapeId (integer) is the model shape identifier in the SPS.
  111342. * @param idxInShape (integer) is the index of the particle in the current model (ex: the 10th box of addShape(box, 30))
  111343. * @param sps defines the sps it is associated to
  111344. * @param modelBoundingInfo is the reference to the model BoundingInfo used for intersection computations.
  111345. * @param materialIndex is the particle material identifier (integer) when the MultiMaterials are enabled in the SPS.
  111346. */
  111347. constructor(particleIndex: number, particleId: number, positionIndex: number, indiceIndex: number, model: Nullable<ModelShape>, shapeId: number, idxInShape: number, sps: SolidParticleSystem, modelBoundingInfo?: Nullable<BoundingInfo>, materialIndex?: Nullable<number>);
  111348. /**
  111349. * Copies the particle property values into the existing target : position, rotation, scaling, uvs, colors, pivot, parent, visibility, alive
  111350. * @param target the particle target
  111351. * @returns the current particle
  111352. */
  111353. copyToRef(target: SolidParticle): SolidParticle;
  111354. /**
  111355. * Legacy support, changed scale to scaling
  111356. */
  111357. get scale(): Vector3;
  111358. /**
  111359. * Legacy support, changed scale to scaling
  111360. */
  111361. set scale(scale: Vector3);
  111362. /**
  111363. * Legacy support, changed quaternion to rotationQuaternion
  111364. */
  111365. get quaternion(): Nullable<Quaternion>;
  111366. /**
  111367. * Legacy support, changed quaternion to rotationQuaternion
  111368. */
  111369. set quaternion(q: Nullable<Quaternion>);
  111370. /**
  111371. * Returns a boolean. True if the particle intersects another particle or another mesh, else false.
  111372. * The intersection is computed on the particle bounding sphere and Axis Aligned Bounding Box (AABB)
  111373. * @param target is the object (solid particle or mesh) what the intersection is computed against.
  111374. * @returns true if it intersects
  111375. */
  111376. intersectsMesh(target: Mesh | SolidParticle): boolean;
  111377. /**
  111378. * Returns `true` if the solid particle is within the frustum defined by the passed array of planes.
  111379. * A particle is in the frustum if its bounding box intersects the frustum
  111380. * @param frustumPlanes defines the frustum to test
  111381. * @returns true if the particle is in the frustum planes
  111382. */
  111383. isInFrustum(frustumPlanes: Plane[]): boolean;
  111384. /**
  111385. * get the rotation matrix of the particle
  111386. * @hidden
  111387. */
  111388. getRotationMatrix(m: Matrix): void;
  111389. }
  111390. /**
  111391. * Represents the shape of the model used by one particle of a solid particle system.
  111392. * SPS internal tool, don't use it manually.
  111393. */
  111394. export class ModelShape {
  111395. /**
  111396. * The shape id
  111397. * @hidden
  111398. */
  111399. shapeID: number;
  111400. /**
  111401. * flat array of model positions (internal use)
  111402. * @hidden
  111403. */
  111404. _shape: Vector3[];
  111405. /**
  111406. * flat array of model UVs (internal use)
  111407. * @hidden
  111408. */
  111409. _shapeUV: number[];
  111410. /**
  111411. * color array of the model
  111412. * @hidden
  111413. */
  111414. _shapeColors: number[];
  111415. /**
  111416. * indices array of the model
  111417. * @hidden
  111418. */
  111419. _indices: number[];
  111420. /**
  111421. * normals array of the model
  111422. * @hidden
  111423. */
  111424. _normals: number[];
  111425. /**
  111426. * length of the shape in the model indices array (internal use)
  111427. * @hidden
  111428. */
  111429. _indicesLength: number;
  111430. /**
  111431. * Custom position function (internal use)
  111432. * @hidden
  111433. */
  111434. _positionFunction: Nullable<(particle: SolidParticle, i: number, s: number) => void>;
  111435. /**
  111436. * Custom vertex function (internal use)
  111437. * @hidden
  111438. */
  111439. _vertexFunction: Nullable<(particle: SolidParticle, vertex: Vector3, i: number) => void>;
  111440. /**
  111441. * Model material (internal use)
  111442. * @hidden
  111443. */
  111444. _material: Nullable<Material>;
  111445. /**
  111446. * 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.
  111447. * SPS internal tool, don't use it manually.
  111448. * @hidden
  111449. */
  111450. 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>);
  111451. }
  111452. /**
  111453. * Represents a Depth Sorted Particle in the solid particle system.
  111454. * @hidden
  111455. */
  111456. export class DepthSortedParticle {
  111457. /**
  111458. * Particle index
  111459. */
  111460. idx: number;
  111461. /**
  111462. * Index of the particle in the "indices" array
  111463. */
  111464. ind: number;
  111465. /**
  111466. * Length of the particle shape in the "indices" array
  111467. */
  111468. indicesLength: number;
  111469. /**
  111470. * Squared distance from the particle to the camera
  111471. */
  111472. sqDistance: number;
  111473. /**
  111474. * Material index when used with MultiMaterials
  111475. */
  111476. materialIndex: number;
  111477. /**
  111478. * Creates a new sorted particle
  111479. * @param materialIndex
  111480. */
  111481. constructor(idx: number, ind: number, indLength: number, materialIndex: number);
  111482. }
  111483. /**
  111484. * Represents a solid particle vertex
  111485. */
  111486. export class SolidParticleVertex {
  111487. /**
  111488. * Vertex position
  111489. */
  111490. position: Vector3;
  111491. /**
  111492. * Vertex color
  111493. */
  111494. color: Color4;
  111495. /**
  111496. * Vertex UV
  111497. */
  111498. uv: Vector2;
  111499. /**
  111500. * Creates a new solid particle vertex
  111501. */
  111502. constructor();
  111503. /** Vertex x coordinate */
  111504. get x(): number;
  111505. set x(val: number);
  111506. /** Vertex y coordinate */
  111507. get y(): number;
  111508. set y(val: number);
  111509. /** Vertex z coordinate */
  111510. get z(): number;
  111511. set z(val: number);
  111512. }
  111513. }
  111514. declare module BABYLON {
  111515. /**
  111516. * @hidden
  111517. */
  111518. export class _MeshCollisionData {
  111519. _checkCollisions: boolean;
  111520. _collisionMask: number;
  111521. _collisionGroup: number;
  111522. _surroundingMeshes: Nullable<AbstractMesh[]>;
  111523. _collider: Nullable<Collider>;
  111524. _oldPositionForCollisions: Vector3;
  111525. _diffPositionForCollisions: Vector3;
  111526. _onCollideObserver: Nullable<Observer<AbstractMesh>>;
  111527. _onCollisionPositionChangeObserver: Nullable<Observer<Vector3>>;
  111528. }
  111529. }
  111530. declare module BABYLON {
  111531. /** @hidden */
  111532. class _FacetDataStorage {
  111533. facetPositions: Vector3[];
  111534. facetNormals: Vector3[];
  111535. facetPartitioning: number[][];
  111536. facetNb: number;
  111537. partitioningSubdivisions: number;
  111538. partitioningBBoxRatio: number;
  111539. facetDataEnabled: boolean;
  111540. facetParameters: any;
  111541. bbSize: Vector3;
  111542. subDiv: {
  111543. max: number;
  111544. X: number;
  111545. Y: number;
  111546. Z: number;
  111547. };
  111548. facetDepthSort: boolean;
  111549. facetDepthSortEnabled: boolean;
  111550. depthSortedIndices: IndicesArray;
  111551. depthSortedFacets: {
  111552. ind: number;
  111553. sqDistance: number;
  111554. }[];
  111555. facetDepthSortFunction: (f1: {
  111556. ind: number;
  111557. sqDistance: number;
  111558. }, f2: {
  111559. ind: number;
  111560. sqDistance: number;
  111561. }) => number;
  111562. facetDepthSortFrom: Vector3;
  111563. facetDepthSortOrigin: Vector3;
  111564. invertedMatrix: Matrix;
  111565. }
  111566. /**
  111567. * @hidden
  111568. **/
  111569. class _InternalAbstractMeshDataInfo {
  111570. _hasVertexAlpha: boolean;
  111571. _useVertexColors: boolean;
  111572. _numBoneInfluencers: number;
  111573. _applyFog: boolean;
  111574. _receiveShadows: boolean;
  111575. _facetData: _FacetDataStorage;
  111576. _visibility: number;
  111577. _skeleton: Nullable<Skeleton>;
  111578. _layerMask: number;
  111579. _computeBonesUsingShaders: boolean;
  111580. _isActive: boolean;
  111581. _onlyForInstances: boolean;
  111582. _isActiveIntermediate: boolean;
  111583. _onlyForInstancesIntermediate: boolean;
  111584. _actAsRegularMesh: boolean;
  111585. }
  111586. /**
  111587. * Class used to store all common mesh properties
  111588. */
  111589. export class AbstractMesh extends TransformNode implements IDisposable, ICullable, IGetSetVerticesData {
  111590. /** No occlusion */
  111591. static OCCLUSION_TYPE_NONE: number;
  111592. /** Occlusion set to optimisitic */
  111593. static OCCLUSION_TYPE_OPTIMISTIC: number;
  111594. /** Occlusion set to strict */
  111595. static OCCLUSION_TYPE_STRICT: number;
  111596. /** Use an accurante occlusion algorithm */
  111597. static OCCLUSION_ALGORITHM_TYPE_ACCURATE: number;
  111598. /** Use a conservative occlusion algorithm */
  111599. static OCCLUSION_ALGORITHM_TYPE_CONSERVATIVE: number;
  111600. /** Default culling strategy : this is an exclusion test and it's the more accurate.
  111601. * Test order :
  111602. * Is the bounding sphere outside the frustum ?
  111603. * If not, are the bounding box vertices outside the frustum ?
  111604. * It not, then the cullable object is in the frustum.
  111605. */
  111606. static readonly CULLINGSTRATEGY_STANDARD: number;
  111607. /** Culling strategy : Bounding Sphere Only.
  111608. * This is an exclusion test. It's faster than the standard strategy because the bounding box is not tested.
  111609. * It's also less accurate than the standard because some not visible objects can still be selected.
  111610. * Test : is the bounding sphere outside the frustum ?
  111611. * If not, then the cullable object is in the frustum.
  111612. */
  111613. static readonly CULLINGSTRATEGY_BOUNDINGSPHERE_ONLY: number;
  111614. /** Culling strategy : Optimistic Inclusion.
  111615. * This in an inclusion test first, then the standard exclusion test.
  111616. * This can be faster when a cullable object is expected to be almost always in the camera frustum.
  111617. * 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.
  111618. * Anyway, it's as accurate as the standard strategy.
  111619. * Test :
  111620. * Is the cullable object bounding sphere center in the frustum ?
  111621. * If not, apply the default culling strategy.
  111622. */
  111623. static readonly CULLINGSTRATEGY_OPTIMISTIC_INCLUSION: number;
  111624. /** Culling strategy : Optimistic Inclusion then Bounding Sphere Only.
  111625. * This in an inclusion test first, then the bounding sphere only exclusion test.
  111626. * This can be the fastest test when a cullable object is expected to be almost always in the camera frustum.
  111627. * 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.
  111628. * It's less accurate than the standard strategy and as accurate as the BoundingSphereOnly strategy.
  111629. * Test :
  111630. * Is the cullable object bounding sphere center in the frustum ?
  111631. * If not, apply the Bounding Sphere Only strategy. No Bounding Box is tested here.
  111632. */
  111633. static readonly CULLINGSTRATEGY_OPTIMISTIC_INCLUSION_THEN_BSPHERE_ONLY: number;
  111634. /**
  111635. * No billboard
  111636. */
  111637. static get BILLBOARDMODE_NONE(): number;
  111638. /** Billboard on X axis */
  111639. static get BILLBOARDMODE_X(): number;
  111640. /** Billboard on Y axis */
  111641. static get BILLBOARDMODE_Y(): number;
  111642. /** Billboard on Z axis */
  111643. static get BILLBOARDMODE_Z(): number;
  111644. /** Billboard on all axes */
  111645. static get BILLBOARDMODE_ALL(): number;
  111646. /** Billboard on using position instead of orientation */
  111647. static get BILLBOARDMODE_USE_POSITION(): number;
  111648. /** @hidden */
  111649. _internalAbstractMeshDataInfo: _InternalAbstractMeshDataInfo;
  111650. /**
  111651. * The culling strategy to use to check whether the mesh must be rendered or not.
  111652. * This value can be changed at any time and will be used on the next render mesh selection.
  111653. * The possible values are :
  111654. * - AbstractMesh.CULLINGSTRATEGY_STANDARD
  111655. * - AbstractMesh.CULLINGSTRATEGY_BOUNDINGSPHERE_ONLY
  111656. * - AbstractMesh.CULLINGSTRATEGY_OPTIMISTIC_INCLUSION
  111657. * - AbstractMesh.CULLINGSTRATEGY_OPTIMISTIC_INCLUSION_THEN_BSPHERE_ONLY
  111658. * Please read each static variable documentation to get details about the culling process.
  111659. * */
  111660. cullingStrategy: number;
  111661. /**
  111662. * Gets the number of facets in the mesh
  111663. * @see https://doc.babylonjs.com/how_to/how_to_use_facetdata#what-is-a-mesh-facet
  111664. */
  111665. get facetNb(): number;
  111666. /**
  111667. * Gets or set the number (integer) of subdivisions per axis in the partioning space
  111668. * @see https://doc.babylonjs.com/how_to/how_to_use_facetdata#tweaking-the-partitioning
  111669. */
  111670. get partitioningSubdivisions(): number;
  111671. set partitioningSubdivisions(nb: number);
  111672. /**
  111673. * The ratio (float) to apply to the bouding box size to set to the partioning space.
  111674. * Ex : 1.01 (default) the partioning space is 1% bigger than the bounding box
  111675. * @see https://doc.babylonjs.com/how_to/how_to_use_facetdata#tweaking-the-partitioning
  111676. */
  111677. get partitioningBBoxRatio(): number;
  111678. set partitioningBBoxRatio(ratio: number);
  111679. /**
  111680. * Gets or sets a boolean indicating that the facets must be depth sorted on next call to `updateFacetData()`.
  111681. * Works only for updatable meshes.
  111682. * Doesn't work with multi-materials
  111683. * @see https://doc.babylonjs.com/how_to/how_to_use_facetdata#facet-depth-sort
  111684. */
  111685. get mustDepthSortFacets(): boolean;
  111686. set mustDepthSortFacets(sort: boolean);
  111687. /**
  111688. * The location (Vector3) where the facet depth sort must be computed from.
  111689. * By default, the active camera position.
  111690. * Used only when facet depth sort is enabled
  111691. * @see https://doc.babylonjs.com/how_to/how_to_use_facetdata#facet-depth-sort
  111692. */
  111693. get facetDepthSortFrom(): Vector3;
  111694. set facetDepthSortFrom(location: Vector3);
  111695. /**
  111696. * gets a boolean indicating if facetData is enabled
  111697. * @see https://doc.babylonjs.com/how_to/how_to_use_facetdata#what-is-a-mesh-facet
  111698. */
  111699. get isFacetDataEnabled(): boolean;
  111700. /** @hidden */
  111701. _updateNonUniformScalingState(value: boolean): boolean;
  111702. /**
  111703. * An event triggered when this mesh collides with another one
  111704. */
  111705. onCollideObservable: Observable<AbstractMesh>;
  111706. /** Set a function to call when this mesh collides with another one */
  111707. set onCollide(callback: () => void);
  111708. /**
  111709. * An event triggered when the collision's position changes
  111710. */
  111711. onCollisionPositionChangeObservable: Observable<Vector3>;
  111712. /** Set a function to call when the collision's position changes */
  111713. set onCollisionPositionChange(callback: () => void);
  111714. /**
  111715. * An event triggered when material is changed
  111716. */
  111717. onMaterialChangedObservable: Observable<AbstractMesh>;
  111718. /**
  111719. * Gets or sets the orientation for POV movement & rotation
  111720. */
  111721. definedFacingForward: boolean;
  111722. /** @hidden */
  111723. _occlusionQuery: Nullable<WebGLQuery>;
  111724. /** @hidden */
  111725. _renderingGroup: Nullable<RenderingGroup>;
  111726. /**
  111727. * Gets or sets mesh visibility between 0 and 1 (default is 1)
  111728. */
  111729. get visibility(): number;
  111730. /**
  111731. * Gets or sets mesh visibility between 0 and 1 (default is 1)
  111732. */
  111733. set visibility(value: number);
  111734. /** Gets or sets the alpha index used to sort transparent meshes
  111735. * @see https://doc.babylonjs.com/resources/transparency_and_how_meshes_are_rendered#alpha-index
  111736. */
  111737. alphaIndex: number;
  111738. /**
  111739. * Gets or sets a boolean indicating if the mesh is visible (renderable). Default is true
  111740. */
  111741. isVisible: boolean;
  111742. /**
  111743. * Gets or sets a boolean indicating if the mesh can be picked (by scene.pick for instance or through actions). Default is true
  111744. */
  111745. isPickable: boolean;
  111746. /** Gets or sets a boolean indicating that bounding boxes of subMeshes must be rendered as well (false by default) */
  111747. showSubMeshesBoundingBox: boolean;
  111748. /** Gets or sets a boolean indicating if the mesh must be considered as a ray blocker for lens flares (false by default)
  111749. * @see https://doc.babylonjs.com/how_to/how_to_use_lens_flares
  111750. */
  111751. isBlocker: boolean;
  111752. /**
  111753. * Gets or sets a boolean indicating that pointer move events must be supported on this mesh (false by default)
  111754. */
  111755. enablePointerMoveEvents: boolean;
  111756. private _renderingGroupId;
  111757. /**
  111758. * Specifies the rendering group id for this mesh (0 by default)
  111759. * @see https://doc.babylonjs.com/resources/transparency_and_how_meshes_are_rendered#rendering-groups
  111760. */
  111761. get renderingGroupId(): number;
  111762. set renderingGroupId(value: number);
  111763. private _material;
  111764. /** Gets or sets current material */
  111765. get material(): Nullable<Material>;
  111766. set material(value: Nullable<Material>);
  111767. /**
  111768. * Gets or sets a boolean indicating that this mesh can receive realtime shadows
  111769. * @see https://doc.babylonjs.com/babylon101/shadows
  111770. */
  111771. get receiveShadows(): boolean;
  111772. set receiveShadows(value: boolean);
  111773. /** Defines color to use when rendering outline */
  111774. outlineColor: Color3;
  111775. /** Define width to use when rendering outline */
  111776. outlineWidth: number;
  111777. /** Defines color to use when rendering overlay */
  111778. overlayColor: Color3;
  111779. /** Defines alpha to use when rendering overlay */
  111780. overlayAlpha: number;
  111781. /** Gets or sets a boolean indicating that this mesh contains vertex color data with alpha values */
  111782. get hasVertexAlpha(): boolean;
  111783. set hasVertexAlpha(value: boolean);
  111784. /** 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) */
  111785. get useVertexColors(): boolean;
  111786. set useVertexColors(value: boolean);
  111787. /**
  111788. * Gets or sets a boolean indicating that bone animations must be computed by the CPU (false by default)
  111789. */
  111790. get computeBonesUsingShaders(): boolean;
  111791. set computeBonesUsingShaders(value: boolean);
  111792. /** Gets or sets the number of allowed bone influences per vertex (4 by default) */
  111793. get numBoneInfluencers(): number;
  111794. set numBoneInfluencers(value: number);
  111795. /** Gets or sets a boolean indicating that this mesh will allow fog to be rendered on it (true by default) */
  111796. get applyFog(): boolean;
  111797. set applyFog(value: boolean);
  111798. /** Gets or sets a boolean indicating that internal octree (if available) can be used to boost submeshes selection (true by default) */
  111799. useOctreeForRenderingSelection: boolean;
  111800. /** Gets or sets a boolean indicating that internal octree (if available) can be used to boost submeshes picking (true by default) */
  111801. useOctreeForPicking: boolean;
  111802. /** Gets or sets a boolean indicating that internal octree (if available) can be used to boost submeshes collision (true by default) */
  111803. useOctreeForCollisions: boolean;
  111804. /**
  111805. * Gets or sets the current layer mask (default is 0x0FFFFFFF)
  111806. * @see https://doc.babylonjs.com/how_to/layermasks_and_multi-cam_textures
  111807. */
  111808. get layerMask(): number;
  111809. set layerMask(value: number);
  111810. /**
  111811. * True if the mesh must be rendered in any case (this will shortcut the frustum clipping phase)
  111812. */
  111813. alwaysSelectAsActiveMesh: boolean;
  111814. /**
  111815. * Gets or sets a boolean indicating that the bounding info does not need to be kept in sync (for performance reason)
  111816. */
  111817. doNotSyncBoundingInfo: boolean;
  111818. /**
  111819. * Gets or sets the current action manager
  111820. * @see https://doc.babylonjs.com/how_to/how_to_use_actions
  111821. */
  111822. actionManager: Nullable<AbstractActionManager>;
  111823. private _meshCollisionData;
  111824. /**
  111825. * Gets or sets the ellipsoid used to impersonate this mesh when using collision engine (default is (0.5, 1, 0.5))
  111826. * @see https://doc.babylonjs.com/babylon101/cameras,_mesh_collisions_and_gravity
  111827. */
  111828. ellipsoid: Vector3;
  111829. /**
  111830. * Gets or sets the ellipsoid offset used to impersonate this mesh when using collision engine (default is (0, 0, 0))
  111831. * @see https://doc.babylonjs.com/babylon101/cameras,_mesh_collisions_and_gravity
  111832. */
  111833. ellipsoidOffset: Vector3;
  111834. /**
  111835. * Gets or sets a collision mask used to mask collisions (default is -1).
  111836. * A collision between A and B will happen if A.collisionGroup & b.collisionMask !== 0
  111837. */
  111838. get collisionMask(): number;
  111839. set collisionMask(mask: number);
  111840. /**
  111841. * Gets or sets the current collision group mask (-1 by default).
  111842. * A collision between A and B will happen if A.collisionGroup & b.collisionMask !== 0
  111843. */
  111844. get collisionGroup(): number;
  111845. set collisionGroup(mask: number);
  111846. /**
  111847. * Gets or sets current surrounding meshes (null by default).
  111848. *
  111849. * By default collision detection is tested against every mesh in the scene.
  111850. * It is possible to set surroundingMeshes to a defined list of meshes and then only these specified
  111851. * meshes will be tested for the collision.
  111852. *
  111853. * Note: if set to an empty array no collision will happen when this mesh is moved.
  111854. */
  111855. get surroundingMeshes(): Nullable<AbstractMesh[]>;
  111856. set surroundingMeshes(meshes: Nullable<AbstractMesh[]>);
  111857. /**
  111858. * Defines edge width used when edgesRenderer is enabled
  111859. * @see https://www.babylonjs-playground.com/#10OJSG#13
  111860. */
  111861. edgesWidth: number;
  111862. /**
  111863. * Defines edge color used when edgesRenderer is enabled
  111864. * @see https://www.babylonjs-playground.com/#10OJSG#13
  111865. */
  111866. edgesColor: Color4;
  111867. /** @hidden */
  111868. _edgesRenderer: Nullable<IEdgesRenderer>;
  111869. /** @hidden */
  111870. _masterMesh: Nullable<AbstractMesh>;
  111871. /** @hidden */
  111872. _boundingInfo: Nullable<BoundingInfo>;
  111873. /** @hidden */
  111874. _renderId: number;
  111875. /**
  111876. * Gets or sets the list of subMeshes
  111877. * @see https://doc.babylonjs.com/how_to/multi_materials
  111878. */
  111879. subMeshes: SubMesh[];
  111880. /** @hidden */
  111881. _intersectionsInProgress: AbstractMesh[];
  111882. /** @hidden */
  111883. _unIndexed: boolean;
  111884. /** @hidden */
  111885. _lightSources: Light[];
  111886. /** Gets the list of lights affecting that mesh */
  111887. get lightSources(): Light[];
  111888. /** @hidden */
  111889. get _positions(): Nullable<Vector3[]>;
  111890. /** @hidden */
  111891. _waitingData: {
  111892. lods: Nullable<any>;
  111893. actions: Nullable<any>;
  111894. freezeWorldMatrix: Nullable<boolean>;
  111895. };
  111896. /** @hidden */
  111897. _bonesTransformMatrices: Nullable<Float32Array>;
  111898. /** @hidden */
  111899. _transformMatrixTexture: Nullable<RawTexture>;
  111900. /**
  111901. * Gets or sets a skeleton to apply skining transformations
  111902. * @see https://doc.babylonjs.com/how_to/how_to_use_bones_and_skeletons
  111903. */
  111904. set skeleton(value: Nullable<Skeleton>);
  111905. get skeleton(): Nullable<Skeleton>;
  111906. /**
  111907. * An event triggered when the mesh is rebuilt.
  111908. */
  111909. onRebuildObservable: Observable<AbstractMesh>;
  111910. /**
  111911. * Creates a new AbstractMesh
  111912. * @param name defines the name of the mesh
  111913. * @param scene defines the hosting scene
  111914. */
  111915. constructor(name: string, scene?: Nullable<Scene>);
  111916. /**
  111917. * Returns the string "AbstractMesh"
  111918. * @returns "AbstractMesh"
  111919. */
  111920. getClassName(): string;
  111921. /**
  111922. * Gets a string representation of the current mesh
  111923. * @param fullDetails defines a boolean indicating if full details must be included
  111924. * @returns a string representation of the current mesh
  111925. */
  111926. toString(fullDetails?: boolean): string;
  111927. /**
  111928. * @hidden
  111929. */
  111930. protected _getEffectiveParent(): Nullable<Node>;
  111931. /** @hidden */
  111932. _getActionManagerForTrigger(trigger?: number, initialCall?: boolean): Nullable<AbstractActionManager>;
  111933. /** @hidden */
  111934. _rebuild(): void;
  111935. /** @hidden */
  111936. _resyncLightSources(): void;
  111937. /** @hidden */
  111938. _resyncLightSource(light: Light): void;
  111939. /** @hidden */
  111940. _unBindEffect(): void;
  111941. /** @hidden */
  111942. _removeLightSource(light: Light, dispose: boolean): void;
  111943. private _markSubMeshesAsDirty;
  111944. /** @hidden */
  111945. _markSubMeshesAsLightDirty(dispose?: boolean): void;
  111946. /** @hidden */
  111947. _markSubMeshesAsAttributesDirty(): void;
  111948. /** @hidden */
  111949. _markSubMeshesAsMiscDirty(): void;
  111950. /**
  111951. * Gets or sets a Vector3 depicting the mesh scaling along each local axis X, Y, Z. Default is (1.0, 1.0, 1.0)
  111952. */
  111953. get scaling(): Vector3;
  111954. set scaling(newScaling: Vector3);
  111955. /**
  111956. * Returns true if the mesh is blocked. Implemented by child classes
  111957. */
  111958. get isBlocked(): boolean;
  111959. /**
  111960. * Returns the mesh itself by default. Implemented by child classes
  111961. * @param camera defines the camera to use to pick the right LOD level
  111962. * @returns the currentAbstractMesh
  111963. */
  111964. getLOD(camera: Camera): Nullable<AbstractMesh>;
  111965. /**
  111966. * Returns 0 by default. Implemented by child classes
  111967. * @returns an integer
  111968. */
  111969. getTotalVertices(): number;
  111970. /**
  111971. * Returns a positive integer : the total number of indices in this mesh geometry.
  111972. * @returns the numner of indices or zero if the mesh has no geometry.
  111973. */
  111974. getTotalIndices(): number;
  111975. /**
  111976. * Returns null by default. Implemented by child classes
  111977. * @returns null
  111978. */
  111979. getIndices(): Nullable<IndicesArray>;
  111980. /**
  111981. * Returns the array of the requested vertex data kind. Implemented by child classes
  111982. * @param kind defines the vertex data kind to use
  111983. * @returns null
  111984. */
  111985. getVerticesData(kind: string): Nullable<FloatArray>;
  111986. /**
  111987. * Sets the vertex data of the mesh geometry for the requested `kind`.
  111988. * If the mesh has no geometry, a new Geometry object is set to the mesh and then passed this vertex data.
  111989. * Note that a new underlying VertexBuffer object is created each call.
  111990. * If the `kind` is the `PositionKind`, the mesh BoundingInfo is renewed, so the bounding box and sphere, and the mesh World Matrix is recomputed.
  111991. * @param kind defines vertex data kind:
  111992. * * VertexBuffer.PositionKind
  111993. * * VertexBuffer.UVKind
  111994. * * VertexBuffer.UV2Kind
  111995. * * VertexBuffer.UV3Kind
  111996. * * VertexBuffer.UV4Kind
  111997. * * VertexBuffer.UV5Kind
  111998. * * VertexBuffer.UV6Kind
  111999. * * VertexBuffer.ColorKind
  112000. * * VertexBuffer.MatricesIndicesKind
  112001. * * VertexBuffer.MatricesIndicesExtraKind
  112002. * * VertexBuffer.MatricesWeightsKind
  112003. * * VertexBuffer.MatricesWeightsExtraKind
  112004. * @param data defines the data source
  112005. * @param updatable defines if the data must be flagged as updatable (or static)
  112006. * @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
  112007. * @returns the current mesh
  112008. */
  112009. setVerticesData(kind: string, data: FloatArray, updatable?: boolean, stride?: number): AbstractMesh;
  112010. /**
  112011. * Updates the existing vertex data of the mesh geometry for the requested `kind`.
  112012. * If the mesh has no geometry, it is simply returned as it is.
  112013. * @param kind defines vertex data kind:
  112014. * * VertexBuffer.PositionKind
  112015. * * VertexBuffer.UVKind
  112016. * * VertexBuffer.UV2Kind
  112017. * * VertexBuffer.UV3Kind
  112018. * * VertexBuffer.UV4Kind
  112019. * * VertexBuffer.UV5Kind
  112020. * * VertexBuffer.UV6Kind
  112021. * * VertexBuffer.ColorKind
  112022. * * VertexBuffer.MatricesIndicesKind
  112023. * * VertexBuffer.MatricesIndicesExtraKind
  112024. * * VertexBuffer.MatricesWeightsKind
  112025. * * VertexBuffer.MatricesWeightsExtraKind
  112026. * @param data defines the data source
  112027. * @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
  112028. * @param makeItUnique If true, a new global geometry is created from this data and is set to the mesh
  112029. * @returns the current mesh
  112030. */
  112031. updateVerticesData(kind: string, data: FloatArray, updateExtends?: boolean, makeItUnique?: boolean): AbstractMesh;
  112032. /**
  112033. * Sets the mesh indices,
  112034. * If the mesh has no geometry, a new Geometry object is created and set to the mesh.
  112035. * @param indices Expects an array populated with integers or a typed array (Int32Array, Uint32Array, Uint16Array)
  112036. * @param totalVertices Defines the total number of vertices
  112037. * @returns the current mesh
  112038. */
  112039. setIndices(indices: IndicesArray, totalVertices: Nullable<number>): AbstractMesh;
  112040. /**
  112041. * Gets a boolean indicating if specific vertex data is present
  112042. * @param kind defines the vertex data kind to use
  112043. * @returns true is data kind is present
  112044. */
  112045. isVerticesDataPresent(kind: string): boolean;
  112046. /**
  112047. * Returns the mesh BoundingInfo object or creates a new one and returns if it was undefined.
  112048. * Note that it returns a shallow bounding of the mesh (i.e. it does not include children).
  112049. * To get the full bounding of all children, call `getHierarchyBoundingVectors` instead.
  112050. * @returns a BoundingInfo
  112051. */
  112052. getBoundingInfo(): BoundingInfo;
  112053. /**
  112054. * Uniformly scales the mesh to fit inside of a unit cube (1 X 1 X 1 units)
  112055. * @param includeDescendants Use the hierarchy's bounding box instead of the mesh's bounding box. Default is false
  112056. * @param ignoreRotation ignore rotation when computing the scale (ie. object will be axis aligned). Default is false
  112057. * @param predicate predicate that is passed in to getHierarchyBoundingVectors when selecting which object should be included when scaling
  112058. * @returns the current mesh
  112059. */
  112060. normalizeToUnitCube(includeDescendants?: boolean, ignoreRotation?: boolean, predicate?: Nullable<(node: AbstractMesh) => boolean>): AbstractMesh;
  112061. /**
  112062. * Overwrite the current bounding info
  112063. * @param boundingInfo defines the new bounding info
  112064. * @returns the current mesh
  112065. */
  112066. setBoundingInfo(boundingInfo: BoundingInfo): AbstractMesh;
  112067. /** Gets a boolean indicating if this mesh has skinning data and an attached skeleton */
  112068. get useBones(): boolean;
  112069. /** @hidden */
  112070. _preActivate(): void;
  112071. /** @hidden */
  112072. _preActivateForIntermediateRendering(renderId: number): void;
  112073. /** @hidden */
  112074. _activate(renderId: number, intermediateRendering: boolean): boolean;
  112075. /** @hidden */
  112076. _postActivate(): void;
  112077. /** @hidden */
  112078. _freeze(): void;
  112079. /** @hidden */
  112080. _unFreeze(): void;
  112081. /**
  112082. * Gets the current world matrix
  112083. * @returns a Matrix
  112084. */
  112085. getWorldMatrix(): Matrix;
  112086. /** @hidden */
  112087. _getWorldMatrixDeterminant(): number;
  112088. /**
  112089. * Gets a boolean indicating if this mesh is an instance or a regular mesh
  112090. */
  112091. get isAnInstance(): boolean;
  112092. /**
  112093. * Gets a boolean indicating if this mesh has instances
  112094. */
  112095. get hasInstances(): boolean;
  112096. /**
  112097. * Gets a boolean indicating if this mesh has thin instances
  112098. */
  112099. get hasThinInstances(): boolean;
  112100. /**
  112101. * Perform relative position change from the point of view of behind the front of the mesh.
  112102. * This is performed taking into account the meshes current rotation, so you do not have to care.
  112103. * Supports definition of mesh facing forward or backward
  112104. * @param amountRight defines the distance on the right axis
  112105. * @param amountUp defines the distance on the up axis
  112106. * @param amountForward defines the distance on the forward axis
  112107. * @returns the current mesh
  112108. */
  112109. movePOV(amountRight: number, amountUp: number, amountForward: number): AbstractMesh;
  112110. /**
  112111. * Calculate relative position change from the point of view of behind the front of the mesh.
  112112. * This is performed taking into account the meshes current rotation, so you do not have to care.
  112113. * Supports definition of mesh facing forward or backward
  112114. * @param amountRight defines the distance on the right axis
  112115. * @param amountUp defines the distance on the up axis
  112116. * @param amountForward defines the distance on the forward axis
  112117. * @returns the new displacement vector
  112118. */
  112119. calcMovePOV(amountRight: number, amountUp: number, amountForward: number): Vector3;
  112120. /**
  112121. * Perform relative rotation change from the point of view of behind the front of the mesh.
  112122. * Supports definition of mesh facing forward or backward
  112123. * @param flipBack defines the flip
  112124. * @param twirlClockwise defines the twirl
  112125. * @param tiltRight defines the tilt
  112126. * @returns the current mesh
  112127. */
  112128. rotatePOV(flipBack: number, twirlClockwise: number, tiltRight: number): AbstractMesh;
  112129. /**
  112130. * Calculate relative rotation change from the point of view of behind the front of the mesh.
  112131. * Supports definition of mesh facing forward or backward.
  112132. * @param flipBack defines the flip
  112133. * @param twirlClockwise defines the twirl
  112134. * @param tiltRight defines the tilt
  112135. * @returns the new rotation vector
  112136. */
  112137. calcRotatePOV(flipBack: number, twirlClockwise: number, tiltRight: number): Vector3;
  112138. /**
  112139. * This method recomputes and sets a new BoundingInfo to the mesh unless it is locked.
  112140. * This means the mesh underlying bounding box and sphere are recomputed.
  112141. * @param applySkeleton defines whether to apply the skeleton before computing the bounding info
  112142. * @returns the current mesh
  112143. */
  112144. refreshBoundingInfo(applySkeleton?: boolean): AbstractMesh;
  112145. /** @hidden */
  112146. _refreshBoundingInfo(data: Nullable<FloatArray>, bias: Nullable<Vector2>): void;
  112147. /** @hidden */
  112148. _getPositionData(applySkeleton: boolean): Nullable<FloatArray>;
  112149. /** @hidden */
  112150. _updateBoundingInfo(): AbstractMesh;
  112151. /** @hidden */
  112152. _updateSubMeshesBoundingInfo(matrix: DeepImmutable<Matrix>): AbstractMesh;
  112153. /** @hidden */
  112154. protected _afterComputeWorldMatrix(): void;
  112155. /** @hidden */
  112156. get _effectiveMesh(): AbstractMesh;
  112157. /**
  112158. * Returns `true` if the mesh is within the frustum defined by the passed array of planes.
  112159. * A mesh is in the frustum if its bounding box intersects the frustum
  112160. * @param frustumPlanes defines the frustum to test
  112161. * @returns true if the mesh is in the frustum planes
  112162. */
  112163. isInFrustum(frustumPlanes: Plane[]): boolean;
  112164. /**
  112165. * Returns `true` if the mesh is completely in the frustum defined be the passed array of planes.
  112166. * A mesh is completely in the frustum if its bounding box it completely inside the frustum.
  112167. * @param frustumPlanes defines the frustum to test
  112168. * @returns true if the mesh is completely in the frustum planes
  112169. */
  112170. isCompletelyInFrustum(frustumPlanes: Plane[]): boolean;
  112171. /**
  112172. * True if the mesh intersects another mesh or a SolidParticle object
  112173. * @param mesh defines a target mesh or SolidParticle to test
  112174. * @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)
  112175. * @param includeDescendants Can be set to true to test if the mesh defined in parameters intersects with the current mesh or any child meshes
  112176. * @returns true if there is an intersection
  112177. */
  112178. intersectsMesh(mesh: AbstractMesh | SolidParticle, precise?: boolean, includeDescendants?: boolean): boolean;
  112179. /**
  112180. * Returns true if the passed point (Vector3) is inside the mesh bounding box
  112181. * @param point defines the point to test
  112182. * @returns true if there is an intersection
  112183. */
  112184. intersectsPoint(point: Vector3): boolean;
  112185. /**
  112186. * Gets or sets a boolean indicating that this mesh can be used in the collision engine
  112187. * @see https://doc.babylonjs.com/babylon101/cameras,_mesh_collisions_and_gravity
  112188. */
  112189. get checkCollisions(): boolean;
  112190. set checkCollisions(collisionEnabled: boolean);
  112191. /**
  112192. * Gets Collider object used to compute collisions (not physics)
  112193. * @see https://doc.babylonjs.com/babylon101/cameras,_mesh_collisions_and_gravity
  112194. */
  112195. get collider(): Nullable<Collider>;
  112196. /**
  112197. * Move the mesh using collision engine
  112198. * @see https://doc.babylonjs.com/babylon101/cameras,_mesh_collisions_and_gravity
  112199. * @param displacement defines the requested displacement vector
  112200. * @returns the current mesh
  112201. */
  112202. moveWithCollisions(displacement: Vector3): AbstractMesh;
  112203. private _onCollisionPositionChange;
  112204. /** @hidden */
  112205. _collideForSubMesh(subMesh: SubMesh, transformMatrix: Matrix, collider: Collider): AbstractMesh;
  112206. /** @hidden */
  112207. _processCollisionsForSubMeshes(collider: Collider, transformMatrix: Matrix): AbstractMesh;
  112208. /** @hidden */
  112209. _checkCollision(collider: Collider): AbstractMesh;
  112210. /** @hidden */
  112211. _generatePointsArray(): boolean;
  112212. /**
  112213. * Checks if the passed Ray intersects with the mesh
  112214. * @param ray defines the ray to use
  112215. * @param fastCheck defines if fast mode (but less precise) must be used (false by default)
  112216. * @param trianglePredicate defines an optional predicate used to select faces when a mesh intersection is detected
  112217. * @param onlyBoundingInfo defines a boolean indicating if picking should only happen using bounding info (false by default)
  112218. * @param worldToUse defines the world matrix to use to get the world coordinate of the intersection point
  112219. * @returns the picking info
  112220. * @see https://doc.babylonjs.com/babylon101/intersect_collisions_-_mesh
  112221. */
  112222. intersects(ray: Ray, fastCheck?: boolean, trianglePredicate?: TrianglePickingPredicate, onlyBoundingInfo?: boolean, worldToUse?: Matrix): PickingInfo;
  112223. /**
  112224. * Clones the current mesh
  112225. * @param name defines the mesh name
  112226. * @param newParent defines the new mesh parent
  112227. * @param doNotCloneChildren defines a boolean indicating that children must not be cloned (false by default)
  112228. * @returns the new mesh
  112229. */
  112230. clone(name: string, newParent: Nullable<Node>, doNotCloneChildren?: boolean): Nullable<AbstractMesh>;
  112231. /**
  112232. * Disposes all the submeshes of the current meshnp
  112233. * @returns the current mesh
  112234. */
  112235. releaseSubMeshes(): AbstractMesh;
  112236. /**
  112237. * Releases resources associated with this abstract mesh.
  112238. * @param doNotRecurse Set to true to not recurse into each children (recurse into each children by default)
  112239. * @param disposeMaterialAndTextures Set to true to also dispose referenced materials and textures (false by default)
  112240. */
  112241. dispose(doNotRecurse?: boolean, disposeMaterialAndTextures?: boolean): void;
  112242. /**
  112243. * Adds the passed mesh as a child to the current mesh
  112244. * @param mesh defines the child mesh
  112245. * @returns the current mesh
  112246. */
  112247. addChild(mesh: AbstractMesh): AbstractMesh;
  112248. /**
  112249. * Removes the passed mesh from the current mesh children list
  112250. * @param mesh defines the child mesh
  112251. * @returns the current mesh
  112252. */
  112253. removeChild(mesh: AbstractMesh): AbstractMesh;
  112254. /** @hidden */
  112255. private _initFacetData;
  112256. /**
  112257. * Updates the mesh facetData arrays and the internal partitioning when the mesh is morphed or updated.
  112258. * This method can be called within the render loop.
  112259. * 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
  112260. * @returns the current mesh
  112261. * @see https://doc.babylonjs.com/how_to/how_to_use_facetdata
  112262. */
  112263. updateFacetData(): AbstractMesh;
  112264. /**
  112265. * Returns the facetLocalNormals array.
  112266. * The normals are expressed in the mesh local spac
  112267. * @returns an array of Vector3
  112268. * @see https://doc.babylonjs.com/how_to/how_to_use_facetdata
  112269. */
  112270. getFacetLocalNormals(): Vector3[];
  112271. /**
  112272. * Returns the facetLocalPositions array.
  112273. * The facet positions are expressed in the mesh local space
  112274. * @returns an array of Vector3
  112275. * @see https://doc.babylonjs.com/how_to/how_to_use_facetdata
  112276. */
  112277. getFacetLocalPositions(): Vector3[];
  112278. /**
  112279. * Returns the facetLocalPartioning array
  112280. * @returns an array of array of numbers
  112281. * @see https://doc.babylonjs.com/how_to/how_to_use_facetdata
  112282. */
  112283. getFacetLocalPartitioning(): number[][];
  112284. /**
  112285. * Returns the i-th facet position in the world system.
  112286. * This method allocates a new Vector3 per call
  112287. * @param i defines the facet index
  112288. * @returns a new Vector3
  112289. * @see https://doc.babylonjs.com/how_to/how_to_use_facetdata
  112290. */
  112291. getFacetPosition(i: number): Vector3;
  112292. /**
  112293. * Sets the reference Vector3 with the i-th facet position in the world system
  112294. * @param i defines the facet index
  112295. * @param ref defines the target vector
  112296. * @returns the current mesh
  112297. * @see https://doc.babylonjs.com/how_to/how_to_use_facetdata
  112298. */
  112299. getFacetPositionToRef(i: number, ref: Vector3): AbstractMesh;
  112300. /**
  112301. * Returns the i-th facet normal in the world system.
  112302. * This method allocates a new Vector3 per call
  112303. * @param i defines the facet index
  112304. * @returns a new Vector3
  112305. * @see https://doc.babylonjs.com/how_to/how_to_use_facetdata
  112306. */
  112307. getFacetNormal(i: number): Vector3;
  112308. /**
  112309. * Sets the reference Vector3 with the i-th facet normal in the world system
  112310. * @param i defines the facet index
  112311. * @param ref defines the target vector
  112312. * @returns the current mesh
  112313. * @see https://doc.babylonjs.com/how_to/how_to_use_facetdata
  112314. */
  112315. getFacetNormalToRef(i: number, ref: Vector3): this;
  112316. /**
  112317. * 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)
  112318. * @param x defines x coordinate
  112319. * @param y defines y coordinate
  112320. * @param z defines z coordinate
  112321. * @returns the array of facet indexes
  112322. * @see https://doc.babylonjs.com/how_to/how_to_use_facetdata
  112323. */
  112324. getFacetsAtLocalCoordinates(x: number, y: number, z: number): Nullable<number[]>;
  112325. /**
  112326. * Returns the closest mesh facet index at (x,y,z) World coordinates, null if not found
  112327. * @param projected sets as the (x,y,z) world projection on the facet
  112328. * @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
  112329. * @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
  112330. * @param x defines x coordinate
  112331. * @param y defines y coordinate
  112332. * @param z defines z coordinate
  112333. * @returns the face index if found (or null instead)
  112334. * @see https://doc.babylonjs.com/how_to/how_to_use_facetdata
  112335. */
  112336. getClosestFacetAtCoordinates(x: number, y: number, z: number, projected?: Vector3, checkFace?: boolean, facing?: boolean): Nullable<number>;
  112337. /**
  112338. * Returns the closest mesh facet index at (x,y,z) local coordinates, null if not found
  112339. * @param projected sets as the (x,y,z) local projection on the facet
  112340. * @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
  112341. * @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
  112342. * @param x defines x coordinate
  112343. * @param y defines y coordinate
  112344. * @param z defines z coordinate
  112345. * @returns the face index if found (or null instead)
  112346. * @see https://doc.babylonjs.com/how_to/how_to_use_facetdata
  112347. */
  112348. getClosestFacetAtLocalCoordinates(x: number, y: number, z: number, projected?: Vector3, checkFace?: boolean, facing?: boolean): Nullable<number>;
  112349. /**
  112350. * Returns the object "parameter" set with all the expected parameters for facetData computation by ComputeNormals()
  112351. * @returns the parameters
  112352. * @see https://doc.babylonjs.com/how_to/how_to_use_facetdata
  112353. */
  112354. getFacetDataParameters(): any;
  112355. /**
  112356. * Disables the feature FacetData and frees the related memory
  112357. * @returns the current mesh
  112358. * @see https://doc.babylonjs.com/how_to/how_to_use_facetdata
  112359. */
  112360. disableFacetData(): AbstractMesh;
  112361. /**
  112362. * Updates the AbstractMesh indices array
  112363. * @param indices defines the data source
  112364. * @param offset defines the offset in the index buffer where to store the new data (can be null)
  112365. * @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)
  112366. * @returns the current mesh
  112367. */
  112368. updateIndices(indices: IndicesArray, offset?: number, gpuMemoryOnly?: boolean): AbstractMesh;
  112369. /**
  112370. * Creates new normals data for the mesh
  112371. * @param updatable defines if the normal vertex buffer must be flagged as updatable
  112372. * @returns the current mesh
  112373. */
  112374. createNormals(updatable: boolean): AbstractMesh;
  112375. /**
  112376. * Align the mesh with a normal
  112377. * @param normal defines the normal to use
  112378. * @param upDirection can be used to redefined the up vector to use (will use the (0, 1, 0) by default)
  112379. * @returns the current mesh
  112380. */
  112381. alignWithNormal(normal: Vector3, upDirection?: Vector3): AbstractMesh;
  112382. /** @hidden */
  112383. _checkOcclusionQuery(): boolean;
  112384. /**
  112385. * Disables the mesh edge rendering mode
  112386. * @returns the currentAbstractMesh
  112387. */
  112388. disableEdgesRendering(): AbstractMesh;
  112389. /**
  112390. * Enables the edge rendering mode on the mesh.
  112391. * This mode makes the mesh edges visible
  112392. * @param epsilon defines the maximal distance between two angles to detect a face
  112393. * @param checkVerticesInsteadOfIndices indicates that we should check vertex list directly instead of faces
  112394. * @returns the currentAbstractMesh
  112395. * @see https://www.babylonjs-playground.com/#19O9TU#0
  112396. */
  112397. enableEdgesRendering(epsilon?: number, checkVerticesInsteadOfIndices?: boolean): AbstractMesh;
  112398. /**
  112399. * This function returns all of the particle systems in the scene that use the mesh as an emitter.
  112400. * @returns an array of particle systems in the scene that use the mesh as an emitter
  112401. */
  112402. getConnectedParticleSystems(): IParticleSystem[];
  112403. }
  112404. }
  112405. declare module BABYLON {
  112406. /**
  112407. * Interface used to define ActionEvent
  112408. */
  112409. export interface IActionEvent {
  112410. /** The mesh or sprite that triggered the action */
  112411. source: any;
  112412. /** The X mouse cursor position at the time of the event */
  112413. pointerX: number;
  112414. /** The Y mouse cursor position at the time of the event */
  112415. pointerY: number;
  112416. /** The mesh that is currently pointed at (can be null) */
  112417. meshUnderPointer: Nullable<AbstractMesh>;
  112418. /** the original (browser) event that triggered the ActionEvent */
  112419. sourceEvent?: any;
  112420. /** additional data for the event */
  112421. additionalData?: any;
  112422. }
  112423. /**
  112424. * ActionEvent is the event being sent when an action is triggered.
  112425. */
  112426. export class ActionEvent implements IActionEvent {
  112427. /** The mesh or sprite that triggered the action */
  112428. source: any;
  112429. /** The X mouse cursor position at the time of the event */
  112430. pointerX: number;
  112431. /** The Y mouse cursor position at the time of the event */
  112432. pointerY: number;
  112433. /** The mesh that is currently pointed at (can be null) */
  112434. meshUnderPointer: Nullable<AbstractMesh>;
  112435. /** the original (browser) event that triggered the ActionEvent */
  112436. sourceEvent?: any;
  112437. /** additional data for the event */
  112438. additionalData?: any;
  112439. /**
  112440. * Creates a new ActionEvent
  112441. * @param source The mesh or sprite that triggered the action
  112442. * @param pointerX The X mouse cursor position at the time of the event
  112443. * @param pointerY The Y mouse cursor position at the time of the event
  112444. * @param meshUnderPointer The mesh that is currently pointed at (can be null)
  112445. * @param sourceEvent the original (browser) event that triggered the ActionEvent
  112446. * @param additionalData additional data for the event
  112447. */
  112448. constructor(
  112449. /** The mesh or sprite that triggered the action */
  112450. source: any,
  112451. /** The X mouse cursor position at the time of the event */
  112452. pointerX: number,
  112453. /** The Y mouse cursor position at the time of the event */
  112454. pointerY: number,
  112455. /** The mesh that is currently pointed at (can be null) */
  112456. meshUnderPointer: Nullable<AbstractMesh>,
  112457. /** the original (browser) event that triggered the ActionEvent */
  112458. sourceEvent?: any,
  112459. /** additional data for the event */
  112460. additionalData?: any);
  112461. /**
  112462. * Helper function to auto-create an ActionEvent from a source mesh.
  112463. * @param source The source mesh that triggered the event
  112464. * @param evt The original (browser) event
  112465. * @param additionalData additional data for the event
  112466. * @returns the new ActionEvent
  112467. */
  112468. static CreateNew(source: AbstractMesh, evt?: Event, additionalData?: any): ActionEvent;
  112469. /**
  112470. * Helper function to auto-create an ActionEvent from a source sprite
  112471. * @param source The source sprite that triggered the event
  112472. * @param scene Scene associated with the sprite
  112473. * @param evt The original (browser) event
  112474. * @param additionalData additional data for the event
  112475. * @returns the new ActionEvent
  112476. */
  112477. static CreateNewFromSprite(source: Sprite, scene: Scene, evt?: Event, additionalData?: any): ActionEvent;
  112478. /**
  112479. * Helper function to auto-create an ActionEvent from a scene. If triggered by a mesh use ActionEvent.CreateNew
  112480. * @param scene the scene where the event occurred
  112481. * @param evt The original (browser) event
  112482. * @returns the new ActionEvent
  112483. */
  112484. static CreateNewFromScene(scene: Scene, evt: Event): ActionEvent;
  112485. /**
  112486. * Helper function to auto-create an ActionEvent from a primitive
  112487. * @param prim defines the target primitive
  112488. * @param pointerPos defines the pointer position
  112489. * @param evt The original (browser) event
  112490. * @param additionalData additional data for the event
  112491. * @returns the new ActionEvent
  112492. */
  112493. static CreateNewFromPrimitive(prim: any, pointerPos: Vector2, evt?: Event, additionalData?: any): ActionEvent;
  112494. }
  112495. }
  112496. declare module BABYLON {
  112497. /**
  112498. * Abstract class used to decouple action Manager from scene and meshes.
  112499. * Do not instantiate.
  112500. * @see https://doc.babylonjs.com/how_to/how_to_use_actions
  112501. */
  112502. export abstract class AbstractActionManager implements IDisposable {
  112503. /** Gets the list of active triggers */
  112504. static Triggers: {
  112505. [key: string]: number;
  112506. };
  112507. /** Gets the cursor to use when hovering items */
  112508. hoverCursor: string;
  112509. /** Gets the list of actions */
  112510. actions: IAction[];
  112511. /**
  112512. * Gets or sets a boolean indicating that the manager is recursive meaning that it can trigger action from children
  112513. */
  112514. isRecursive: boolean;
  112515. /**
  112516. * Releases all associated resources
  112517. */
  112518. abstract dispose(): void;
  112519. /**
  112520. * Does this action manager has pointer triggers
  112521. */
  112522. abstract get hasPointerTriggers(): boolean;
  112523. /**
  112524. * Does this action manager has pick triggers
  112525. */
  112526. abstract get hasPickTriggers(): boolean;
  112527. /**
  112528. * Process a specific trigger
  112529. * @param trigger defines the trigger to process
  112530. * @param evt defines the event details to be processed
  112531. */
  112532. abstract processTrigger(trigger: number, evt?: IActionEvent): void;
  112533. /**
  112534. * Does this action manager handles actions of any of the given triggers
  112535. * @param triggers defines the triggers to be tested
  112536. * @return a boolean indicating whether one (or more) of the triggers is handled
  112537. */
  112538. abstract hasSpecificTriggers(triggers: number[]): boolean;
  112539. /**
  112540. * Does this action manager handles actions of any of the given triggers. This function takes two arguments for
  112541. * speed.
  112542. * @param triggerA defines the trigger to be tested
  112543. * @param triggerB defines the trigger to be tested
  112544. * @return a boolean indicating whether one (or more) of the triggers is handled
  112545. */
  112546. abstract hasSpecificTriggers2(triggerA: number, triggerB: number): boolean;
  112547. /**
  112548. * Does this action manager handles actions of a given trigger
  112549. * @param trigger defines the trigger to be tested
  112550. * @param parameterPredicate defines an optional predicate to filter triggers by parameter
  112551. * @return whether the trigger is handled
  112552. */
  112553. abstract hasSpecificTrigger(trigger: number, parameterPredicate?: (parameter: any) => boolean): boolean;
  112554. /**
  112555. * Serialize this manager to a JSON object
  112556. * @param name defines the property name to store this manager
  112557. * @returns a JSON representation of this manager
  112558. */
  112559. abstract serialize(name: string): any;
  112560. /**
  112561. * Registers an action to this action manager
  112562. * @param action defines the action to be registered
  112563. * @return the action amended (prepared) after registration
  112564. */
  112565. abstract registerAction(action: IAction): Nullable<IAction>;
  112566. /**
  112567. * Unregisters an action to this action manager
  112568. * @param action defines the action to be unregistered
  112569. * @return a boolean indicating whether the action has been unregistered
  112570. */
  112571. abstract unregisterAction(action: IAction): Boolean;
  112572. /**
  112573. * Does exist one action manager with at least one trigger
  112574. **/
  112575. static get HasTriggers(): boolean;
  112576. /**
  112577. * Does exist one action manager with at least one pick trigger
  112578. **/
  112579. static get HasPickTriggers(): boolean;
  112580. /**
  112581. * Does exist one action manager that handles actions of a given trigger
  112582. * @param trigger defines the trigger to be tested
  112583. * @return a boolean indicating whether the trigger is handeled by at least one action manager
  112584. **/
  112585. static HasSpecificTrigger(trigger: number): boolean;
  112586. }
  112587. }
  112588. declare module BABYLON {
  112589. /**
  112590. * Defines how a node can be built from a string name.
  112591. */
  112592. export type NodeConstructor = (name: string, scene: Scene, options?: any) => () => Node;
  112593. /**
  112594. * Node is the basic class for all scene objects (Mesh, Light, Camera.)
  112595. */
  112596. export class Node implements IBehaviorAware<Node> {
  112597. /** @hidden */
  112598. static _AnimationRangeFactory: (name: string, from: number, to: number) => AnimationRange;
  112599. private static _NodeConstructors;
  112600. /**
  112601. * Add a new node constructor
  112602. * @param type defines the type name of the node to construct
  112603. * @param constructorFunc defines the constructor function
  112604. */
  112605. static AddNodeConstructor(type: string, constructorFunc: NodeConstructor): void;
  112606. /**
  112607. * Returns a node constructor based on type name
  112608. * @param type defines the type name
  112609. * @param name defines the new node name
  112610. * @param scene defines the hosting scene
  112611. * @param options defines optional options to transmit to constructors
  112612. * @returns the new constructor or null
  112613. */
  112614. static Construct(type: string, name: string, scene: Scene, options?: any): Nullable<() => Node>;
  112615. /**
  112616. * Gets or sets the name of the node
  112617. */
  112618. name: string;
  112619. /**
  112620. * Gets or sets the id of the node
  112621. */
  112622. id: string;
  112623. /**
  112624. * Gets or sets the unique id of the node
  112625. */
  112626. uniqueId: number;
  112627. /**
  112628. * Gets or sets a string used to store user defined state for the node
  112629. */
  112630. state: string;
  112631. /**
  112632. * Gets or sets an object used to store user defined information for the node
  112633. */
  112634. metadata: any;
  112635. /**
  112636. * For internal use only. Please do not use.
  112637. */
  112638. reservedDataStore: any;
  112639. /**
  112640. * List of inspectable custom properties (used by the Inspector)
  112641. * @see https://doc.babylonjs.com/how_to/debug_layer#extensibility
  112642. */
  112643. inspectableCustomProperties: IInspectable[];
  112644. private _doNotSerialize;
  112645. /**
  112646. * Gets or sets a boolean used to define if the node must be serialized
  112647. */
  112648. get doNotSerialize(): boolean;
  112649. set doNotSerialize(value: boolean);
  112650. /** @hidden */
  112651. _isDisposed: boolean;
  112652. /**
  112653. * Gets a list of Animations associated with the node
  112654. */
  112655. animations: Animation[];
  112656. protected _ranges: {
  112657. [name: string]: Nullable<AnimationRange>;
  112658. };
  112659. /**
  112660. * Callback raised when the node is ready to be used
  112661. */
  112662. onReady: Nullable<(node: Node) => void>;
  112663. private _isEnabled;
  112664. private _isParentEnabled;
  112665. private _isReady;
  112666. /** @hidden */
  112667. _currentRenderId: number;
  112668. private _parentUpdateId;
  112669. /** @hidden */
  112670. _childUpdateId: number;
  112671. /** @hidden */
  112672. _waitingParentId: Nullable<string>;
  112673. /** @hidden */
  112674. _scene: Scene;
  112675. /** @hidden */
  112676. _cache: any;
  112677. private _parentNode;
  112678. private _children;
  112679. /** @hidden */
  112680. _worldMatrix: Matrix;
  112681. /** @hidden */
  112682. _worldMatrixDeterminant: number;
  112683. /** @hidden */
  112684. _worldMatrixDeterminantIsDirty: boolean;
  112685. /** @hidden */
  112686. private _sceneRootNodesIndex;
  112687. /**
  112688. * Gets a boolean indicating if the node has been disposed
  112689. * @returns true if the node was disposed
  112690. */
  112691. isDisposed(): boolean;
  112692. /**
  112693. * Gets or sets the parent of the node (without keeping the current position in the scene)
  112694. * @see https://doc.babylonjs.com/how_to/parenting
  112695. */
  112696. set parent(parent: Nullable<Node>);
  112697. get parent(): Nullable<Node>;
  112698. /** @hidden */
  112699. _addToSceneRootNodes(): void;
  112700. /** @hidden */
  112701. _removeFromSceneRootNodes(): void;
  112702. private _animationPropertiesOverride;
  112703. /**
  112704. * Gets or sets the animation properties override
  112705. */
  112706. get animationPropertiesOverride(): Nullable<AnimationPropertiesOverride>;
  112707. set animationPropertiesOverride(value: Nullable<AnimationPropertiesOverride>);
  112708. /**
  112709. * Gets a string identifying the name of the class
  112710. * @returns "Node" string
  112711. */
  112712. getClassName(): string;
  112713. /** @hidden */
  112714. readonly _isNode: boolean;
  112715. /**
  112716. * An event triggered when the mesh is disposed
  112717. */
  112718. onDisposeObservable: Observable<Node>;
  112719. private _onDisposeObserver;
  112720. /**
  112721. * Sets a callback that will be raised when the node will be disposed
  112722. */
  112723. set onDispose(callback: () => void);
  112724. /**
  112725. * Creates a new Node
  112726. * @param name the name and id to be given to this node
  112727. * @param scene the scene this node will be added to
  112728. */
  112729. constructor(name: string, scene?: Nullable<Scene>);
  112730. /**
  112731. * Gets the scene of the node
  112732. * @returns a scene
  112733. */
  112734. getScene(): Scene;
  112735. /**
  112736. * Gets the engine of the node
  112737. * @returns a Engine
  112738. */
  112739. getEngine(): Engine;
  112740. private _behaviors;
  112741. /**
  112742. * Attach a behavior to the node
  112743. * @see https://doc.babylonjs.com/features/behaviour
  112744. * @param behavior defines the behavior to attach
  112745. * @param attachImmediately defines that the behavior must be attached even if the scene is still loading
  112746. * @returns the current Node
  112747. */
  112748. addBehavior(behavior: Behavior<Node>, attachImmediately?: boolean): Node;
  112749. /**
  112750. * Remove an attached behavior
  112751. * @see https://doc.babylonjs.com/features/behaviour
  112752. * @param behavior defines the behavior to attach
  112753. * @returns the current Node
  112754. */
  112755. removeBehavior(behavior: Behavior<Node>): Node;
  112756. /**
  112757. * Gets the list of attached behaviors
  112758. * @see https://doc.babylonjs.com/features/behaviour
  112759. */
  112760. get behaviors(): Behavior<Node>[];
  112761. /**
  112762. * Gets an attached behavior by name
  112763. * @param name defines the name of the behavior to look for
  112764. * @see https://doc.babylonjs.com/features/behaviour
  112765. * @returns null if behavior was not found else the requested behavior
  112766. */
  112767. getBehaviorByName(name: string): Nullable<Behavior<Node>>;
  112768. /**
  112769. * Returns the latest update of the World matrix
  112770. * @returns a Matrix
  112771. */
  112772. getWorldMatrix(): Matrix;
  112773. /** @hidden */
  112774. _getWorldMatrixDeterminant(): number;
  112775. /**
  112776. * Returns directly the latest state of the mesh World matrix.
  112777. * A Matrix is returned.
  112778. */
  112779. get worldMatrixFromCache(): Matrix;
  112780. /** @hidden */
  112781. _initCache(): void;
  112782. /** @hidden */
  112783. updateCache(force?: boolean): void;
  112784. /** @hidden */
  112785. _getActionManagerForTrigger(trigger?: number, initialCall?: boolean): Nullable<AbstractActionManager>;
  112786. /** @hidden */
  112787. _updateCache(ignoreParentClass?: boolean): void;
  112788. /** @hidden */
  112789. _isSynchronized(): boolean;
  112790. /** @hidden */
  112791. _markSyncedWithParent(): void;
  112792. /** @hidden */
  112793. isSynchronizedWithParent(): boolean;
  112794. /** @hidden */
  112795. isSynchronized(): boolean;
  112796. /**
  112797. * Is this node ready to be used/rendered
  112798. * @param completeCheck defines if a complete check (including materials and lights) has to be done (false by default)
  112799. * @return true if the node is ready
  112800. */
  112801. isReady(completeCheck?: boolean): boolean;
  112802. /**
  112803. * Is this node enabled?
  112804. * 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
  112805. * @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
  112806. * @return whether this node (and its parent) is enabled
  112807. */
  112808. isEnabled(checkAncestors?: boolean): boolean;
  112809. /** @hidden */
  112810. protected _syncParentEnabledState(): void;
  112811. /**
  112812. * Set the enabled state of this node
  112813. * @param value defines the new enabled state
  112814. */
  112815. setEnabled(value: boolean): void;
  112816. /**
  112817. * Is this node a descendant of the given node?
  112818. * The function will iterate up the hierarchy until the ancestor was found or no more parents defined
  112819. * @param ancestor defines the parent node to inspect
  112820. * @returns a boolean indicating if this node is a descendant of the given node
  112821. */
  112822. isDescendantOf(ancestor: Node): boolean;
  112823. /** @hidden */
  112824. _getDescendants(results: Node[], directDescendantsOnly?: boolean, predicate?: (node: Node) => boolean): void;
  112825. /**
  112826. * Will return all nodes that have this node as ascendant
  112827. * @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
  112828. * @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
  112829. * @return all children nodes of all types
  112830. */
  112831. getDescendants(directDescendantsOnly?: boolean, predicate?: (node: Node) => boolean): Node[];
  112832. /**
  112833. * Get all child-meshes of this node
  112834. * @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)
  112835. * @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
  112836. * @returns an array of AbstractMesh
  112837. */
  112838. getChildMeshes(directDescendantsOnly?: boolean, predicate?: (node: Node) => boolean): AbstractMesh[];
  112839. /**
  112840. * Get all direct children of this node
  112841. * @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
  112842. * @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)
  112843. * @returns an array of Node
  112844. */
  112845. getChildren(predicate?: (node: Node) => boolean, directDescendantsOnly?: boolean): Node[];
  112846. /** @hidden */
  112847. _setReady(state: boolean): void;
  112848. /**
  112849. * Get an animation by name
  112850. * @param name defines the name of the animation to look for
  112851. * @returns null if not found else the requested animation
  112852. */
  112853. getAnimationByName(name: string): Nullable<Animation>;
  112854. /**
  112855. * Creates an animation range for this node
  112856. * @param name defines the name of the range
  112857. * @param from defines the starting key
  112858. * @param to defines the end key
  112859. */
  112860. createAnimationRange(name: string, from: number, to: number): void;
  112861. /**
  112862. * Delete a specific animation range
  112863. * @param name defines the name of the range to delete
  112864. * @param deleteFrames defines if animation frames from the range must be deleted as well
  112865. */
  112866. deleteAnimationRange(name: string, deleteFrames?: boolean): void;
  112867. /**
  112868. * Get an animation range by name
  112869. * @param name defines the name of the animation range to look for
  112870. * @returns null if not found else the requested animation range
  112871. */
  112872. getAnimationRange(name: string): Nullable<AnimationRange>;
  112873. /**
  112874. * Gets the list of all animation ranges defined on this node
  112875. * @returns an array
  112876. */
  112877. getAnimationRanges(): Nullable<AnimationRange>[];
  112878. /**
  112879. * Will start the animation sequence
  112880. * @param name defines the range frames for animation sequence
  112881. * @param loop defines if the animation should loop (false by default)
  112882. * @param speedRatio defines the speed factor in which to run the animation (1 by default)
  112883. * @param onAnimationEnd defines a function to be executed when the animation ended (undefined by default)
  112884. * @returns the object created for this animation. If range does not exist, it will return null
  112885. */
  112886. beginAnimation(name: string, loop?: boolean, speedRatio?: number, onAnimationEnd?: () => void): Nullable<Animatable>;
  112887. /**
  112888. * Serialize animation ranges into a JSON compatible object
  112889. * @returns serialization object
  112890. */
  112891. serializeAnimationRanges(): any;
  112892. /**
  112893. * Computes the world matrix of the node
  112894. * @param force defines if the cache version should be invalidated forcing the world matrix to be created from scratch
  112895. * @returns the world matrix
  112896. */
  112897. computeWorldMatrix(force?: boolean): Matrix;
  112898. /**
  112899. * Releases resources associated with this node.
  112900. * @param doNotRecurse Set to true to not recurse into each children (recurse into each children by default)
  112901. * @param disposeMaterialAndTextures Set to true to also dispose referenced materials and textures (false by default)
  112902. */
  112903. dispose(doNotRecurse?: boolean, disposeMaterialAndTextures?: boolean): void;
  112904. /**
  112905. * Parse animation range data from a serialization object and store them into a given node
  112906. * @param node defines where to store the animation ranges
  112907. * @param parsedNode defines the serialization object to read data from
  112908. * @param scene defines the hosting scene
  112909. */
  112910. static ParseAnimationRanges(node: Node, parsedNode: any, scene: Scene): void;
  112911. /**
  112912. * Return the minimum and maximum world vectors of the entire hierarchy under current node
  112913. * @param includeDescendants Include bounding info from descendants as well (true by default)
  112914. * @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
  112915. * @returns the new bounding vectors
  112916. */
  112917. getHierarchyBoundingVectors(includeDescendants?: boolean, predicate?: Nullable<(abstractMesh: AbstractMesh) => boolean>): {
  112918. min: Vector3;
  112919. max: Vector3;
  112920. };
  112921. }
  112922. }
  112923. declare module BABYLON {
  112924. /**
  112925. * @hidden
  112926. */
  112927. export class _IAnimationState {
  112928. key: number;
  112929. repeatCount: number;
  112930. workValue?: any;
  112931. loopMode?: number;
  112932. offsetValue?: any;
  112933. highLimitValue?: any;
  112934. }
  112935. /**
  112936. * Class used to store any kind of animation
  112937. */
  112938. export class Animation {
  112939. /**Name of the animation */
  112940. name: string;
  112941. /**Property to animate */
  112942. targetProperty: string;
  112943. /**The frames per second of the animation */
  112944. framePerSecond: number;
  112945. /**The data type of the animation */
  112946. dataType: number;
  112947. /**The loop mode of the animation */
  112948. loopMode?: number | undefined;
  112949. /**Specifies if blending should be enabled */
  112950. enableBlending?: boolean | undefined;
  112951. /**
  112952. * Use matrix interpolation instead of using direct key value when animating matrices
  112953. */
  112954. static AllowMatricesInterpolation: boolean;
  112955. /**
  112956. * When matrix interpolation is enabled, this boolean forces the system to use Matrix.DecomposeLerp instead of Matrix.Lerp. Interpolation is more precise but slower
  112957. */
  112958. static AllowMatrixDecomposeForInterpolation: boolean;
  112959. /** Define the Url to load snippets */
  112960. static SnippetUrl: string;
  112961. /** Snippet ID if the animation was created from the snippet server */
  112962. snippetId: string;
  112963. /**
  112964. * Stores the key frames of the animation
  112965. */
  112966. private _keys;
  112967. /**
  112968. * Stores the easing function of the animation
  112969. */
  112970. private _easingFunction;
  112971. /**
  112972. * @hidden Internal use only
  112973. */
  112974. _runtimeAnimations: RuntimeAnimation[];
  112975. /**
  112976. * The set of event that will be linked to this animation
  112977. */
  112978. private _events;
  112979. /**
  112980. * Stores an array of target property paths
  112981. */
  112982. targetPropertyPath: string[];
  112983. /**
  112984. * Stores the blending speed of the animation
  112985. */
  112986. blendingSpeed: number;
  112987. /**
  112988. * Stores the animation ranges for the animation
  112989. */
  112990. private _ranges;
  112991. /**
  112992. * @hidden Internal use
  112993. */
  112994. static _PrepareAnimation(name: string, targetProperty: string, framePerSecond: number, totalFrame: number, from: any, to: any, loopMode?: number, easingFunction?: EasingFunction): Nullable<Animation>;
  112995. /**
  112996. * Sets up an animation
  112997. * @param property The property to animate
  112998. * @param animationType The animation type to apply
  112999. * @param framePerSecond The frames per second of the animation
  113000. * @param easingFunction The easing function used in the animation
  113001. * @returns The created animation
  113002. */
  113003. static CreateAnimation(property: string, animationType: number, framePerSecond: number, easingFunction: EasingFunction): Animation;
  113004. /**
  113005. * Create and start an animation on a node
  113006. * @param name defines the name of the global animation that will be run on all nodes
  113007. * @param node defines the root node where the animation will take place
  113008. * @param targetProperty defines property to animate
  113009. * @param framePerSecond defines the number of frame per second yo use
  113010. * @param totalFrame defines the number of frames in total
  113011. * @param from defines the initial value
  113012. * @param to defines the final value
  113013. * @param loopMode defines which loop mode you want to use (off by default)
  113014. * @param easingFunction defines the easing function to use (linear by default)
  113015. * @param onAnimationEnd defines the callback to call when animation end
  113016. * @returns the animatable created for this animation
  113017. */
  113018. static CreateAndStartAnimation(name: string, node: Node, targetProperty: string, framePerSecond: number, totalFrame: number, from: any, to: any, loopMode?: number, easingFunction?: EasingFunction, onAnimationEnd?: () => void): Nullable<Animatable>;
  113019. /**
  113020. * Create and start an animation on a node and its descendants
  113021. * @param name defines the name of the global animation that will be run on all nodes
  113022. * @param node defines the root node where the animation will take place
  113023. * @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
  113024. * @param targetProperty defines property to animate
  113025. * @param framePerSecond defines the number of frame per second to use
  113026. * @param totalFrame defines the number of frames in total
  113027. * @param from defines the initial value
  113028. * @param to defines the final value
  113029. * @param loopMode defines which loop mode you want to use (off by default)
  113030. * @param easingFunction defines the easing function to use (linear by default)
  113031. * @param onAnimationEnd defines the callback to call when an animation ends (will be called once per node)
  113032. * @returns the list of animatables created for all nodes
  113033. * @example https://www.babylonjs-playground.com/#MH0VLI
  113034. */
  113035. 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[]>;
  113036. /**
  113037. * Creates a new animation, merges it with the existing animations and starts it
  113038. * @param name Name of the animation
  113039. * @param node Node which contains the scene that begins the animations
  113040. * @param targetProperty Specifies which property to animate
  113041. * @param framePerSecond The frames per second of the animation
  113042. * @param totalFrame The total number of frames
  113043. * @param from The frame at the beginning of the animation
  113044. * @param to The frame at the end of the animation
  113045. * @param loopMode Specifies the loop mode of the animation
  113046. * @param easingFunction (Optional) The easing function of the animation, which allow custom mathematical formulas for animations
  113047. * @param onAnimationEnd Callback to run once the animation is complete
  113048. * @returns Nullable animation
  113049. */
  113050. static CreateMergeAndStartAnimation(name: string, node: Node, targetProperty: string, framePerSecond: number, totalFrame: number, from: any, to: any, loopMode?: number, easingFunction?: EasingFunction, onAnimationEnd?: () => void): Nullable<Animatable>;
  113051. /**
  113052. * Convert the keyframes for all animations belonging to the group to be relative to a given reference frame.
  113053. * @param sourceAnimation defines the Animation containing keyframes to convert
  113054. * @param referenceFrame defines the frame that keyframes in the range will be relative to
  113055. * @param range defines the name of the AnimationRange belonging to the Animation to convert
  113056. * @param cloneOriginal defines whether or not to clone the animation and convert the clone or convert the original animation (default is false)
  113057. * @param clonedName defines the name of the resulting cloned Animation if cloneOriginal is true
  113058. * @returns a new Animation if cloneOriginal is true or the original Animation if cloneOriginal is false
  113059. */
  113060. static MakeAnimationAdditive(sourceAnimation: Animation, referenceFrame?: number, range?: string, cloneOriginal?: boolean, clonedName?: string): Animation;
  113061. /**
  113062. * Transition property of an host to the target Value
  113063. * @param property The property to transition
  113064. * @param targetValue The target Value of the property
  113065. * @param host The object where the property to animate belongs
  113066. * @param scene Scene used to run the animation
  113067. * @param frameRate Framerate (in frame/s) to use
  113068. * @param transition The transition type we want to use
  113069. * @param duration The duration of the animation, in milliseconds
  113070. * @param onAnimationEnd Callback trigger at the end of the animation
  113071. * @returns Nullable animation
  113072. */
  113073. static TransitionTo(property: string, targetValue: any, host: any, scene: Scene, frameRate: number, transition: Animation, duration: number, onAnimationEnd?: Nullable<() => void>): Nullable<Animatable>;
  113074. /**
  113075. * Return the array of runtime animations currently using this animation
  113076. */
  113077. get runtimeAnimations(): RuntimeAnimation[];
  113078. /**
  113079. * Specifies if any of the runtime animations are currently running
  113080. */
  113081. get hasRunningRuntimeAnimations(): boolean;
  113082. /**
  113083. * Initializes the animation
  113084. * @param name Name of the animation
  113085. * @param targetProperty Property to animate
  113086. * @param framePerSecond The frames per second of the animation
  113087. * @param dataType The data type of the animation
  113088. * @param loopMode The loop mode of the animation
  113089. * @param enableBlending Specifies if blending should be enabled
  113090. */
  113091. constructor(
  113092. /**Name of the animation */
  113093. name: string,
  113094. /**Property to animate */
  113095. targetProperty: string,
  113096. /**The frames per second of the animation */
  113097. framePerSecond: number,
  113098. /**The data type of the animation */
  113099. dataType: number,
  113100. /**The loop mode of the animation */
  113101. loopMode?: number | undefined,
  113102. /**Specifies if blending should be enabled */
  113103. enableBlending?: boolean | undefined);
  113104. /**
  113105. * Converts the animation to a string
  113106. * @param fullDetails support for multiple levels of logging within scene loading
  113107. * @returns String form of the animation
  113108. */
  113109. toString(fullDetails?: boolean): string;
  113110. /**
  113111. * Add an event to this animation
  113112. * @param event Event to add
  113113. */
  113114. addEvent(event: AnimationEvent): void;
  113115. /**
  113116. * Remove all events found at the given frame
  113117. * @param frame The frame to remove events from
  113118. */
  113119. removeEvents(frame: number): void;
  113120. /**
  113121. * Retrieves all the events from the animation
  113122. * @returns Events from the animation
  113123. */
  113124. getEvents(): AnimationEvent[];
  113125. /**
  113126. * Creates an animation range
  113127. * @param name Name of the animation range
  113128. * @param from Starting frame of the animation range
  113129. * @param to Ending frame of the animation
  113130. */
  113131. createRange(name: string, from: number, to: number): void;
  113132. /**
  113133. * Deletes an animation range by name
  113134. * @param name Name of the animation range to delete
  113135. * @param deleteFrames Specifies if the key frames for the range should also be deleted (true) or not (false)
  113136. */
  113137. deleteRange(name: string, deleteFrames?: boolean): void;
  113138. /**
  113139. * Gets the animation range by name, or null if not defined
  113140. * @param name Name of the animation range
  113141. * @returns Nullable animation range
  113142. */
  113143. getRange(name: string): Nullable<AnimationRange>;
  113144. /**
  113145. * Gets the key frames from the animation
  113146. * @returns The key frames of the animation
  113147. */
  113148. getKeys(): Array<IAnimationKey>;
  113149. /**
  113150. * Gets the highest frame rate of the animation
  113151. * @returns Highest frame rate of the animation
  113152. */
  113153. getHighestFrame(): number;
  113154. /**
  113155. * Gets the easing function of the animation
  113156. * @returns Easing function of the animation
  113157. */
  113158. getEasingFunction(): IEasingFunction;
  113159. /**
  113160. * Sets the easing function of the animation
  113161. * @param easingFunction A custom mathematical formula for animation
  113162. */
  113163. setEasingFunction(easingFunction: EasingFunction): void;
  113164. /**
  113165. * Interpolates a scalar linearly
  113166. * @param startValue Start value of the animation curve
  113167. * @param endValue End value of the animation curve
  113168. * @param gradient Scalar amount to interpolate
  113169. * @returns Interpolated scalar value
  113170. */
  113171. floatInterpolateFunction(startValue: number, endValue: number, gradient: number): number;
  113172. /**
  113173. * Interpolates a scalar cubically
  113174. * @param startValue Start value of the animation curve
  113175. * @param outTangent End tangent of the animation
  113176. * @param endValue End value of the animation curve
  113177. * @param inTangent Start tangent of the animation curve
  113178. * @param gradient Scalar amount to interpolate
  113179. * @returns Interpolated scalar value
  113180. */
  113181. floatInterpolateFunctionWithTangents(startValue: number, outTangent: number, endValue: number, inTangent: number, gradient: number): number;
  113182. /**
  113183. * Interpolates a quaternion using a spherical linear interpolation
  113184. * @param startValue Start value of the animation curve
  113185. * @param endValue End value of the animation curve
  113186. * @param gradient Scalar amount to interpolate
  113187. * @returns Interpolated quaternion value
  113188. */
  113189. quaternionInterpolateFunction(startValue: Quaternion, endValue: Quaternion, gradient: number): Quaternion;
  113190. /**
  113191. * Interpolates a quaternion cubically
  113192. * @param startValue Start value of the animation curve
  113193. * @param outTangent End tangent of the animation curve
  113194. * @param endValue End value of the animation curve
  113195. * @param inTangent Start tangent of the animation curve
  113196. * @param gradient Scalar amount to interpolate
  113197. * @returns Interpolated quaternion value
  113198. */
  113199. quaternionInterpolateFunctionWithTangents(startValue: Quaternion, outTangent: Quaternion, endValue: Quaternion, inTangent: Quaternion, gradient: number): Quaternion;
  113200. /**
  113201. * Interpolates a Vector3 linearl
  113202. * @param startValue Start value of the animation curve
  113203. * @param endValue End value of the animation curve
  113204. * @param gradient Scalar amount to interpolate
  113205. * @returns Interpolated scalar value
  113206. */
  113207. vector3InterpolateFunction(startValue: Vector3, endValue: Vector3, gradient: number): Vector3;
  113208. /**
  113209. * Interpolates a Vector3 cubically
  113210. * @param startValue Start value of the animation curve
  113211. * @param outTangent End tangent of the animation
  113212. * @param endValue End value of the animation curve
  113213. * @param inTangent Start tangent of the animation curve
  113214. * @param gradient Scalar amount to interpolate
  113215. * @returns InterpolatedVector3 value
  113216. */
  113217. vector3InterpolateFunctionWithTangents(startValue: Vector3, outTangent: Vector3, endValue: Vector3, inTangent: Vector3, gradient: number): Vector3;
  113218. /**
  113219. * Interpolates a Vector2 linearly
  113220. * @param startValue Start value of the animation curve
  113221. * @param endValue End value of the animation curve
  113222. * @param gradient Scalar amount to interpolate
  113223. * @returns Interpolated Vector2 value
  113224. */
  113225. vector2InterpolateFunction(startValue: Vector2, endValue: Vector2, gradient: number): Vector2;
  113226. /**
  113227. * Interpolates a Vector2 cubically
  113228. * @param startValue Start value of the animation curve
  113229. * @param outTangent End tangent of the animation
  113230. * @param endValue End value of the animation curve
  113231. * @param inTangent Start tangent of the animation curve
  113232. * @param gradient Scalar amount to interpolate
  113233. * @returns Interpolated Vector2 value
  113234. */
  113235. vector2InterpolateFunctionWithTangents(startValue: Vector2, outTangent: Vector2, endValue: Vector2, inTangent: Vector2, gradient: number): Vector2;
  113236. /**
  113237. * Interpolates a size linearly
  113238. * @param startValue Start value of the animation curve
  113239. * @param endValue End value of the animation curve
  113240. * @param gradient Scalar amount to interpolate
  113241. * @returns Interpolated Size value
  113242. */
  113243. sizeInterpolateFunction(startValue: Size, endValue: Size, gradient: number): Size;
  113244. /**
  113245. * Interpolates a Color3 linearly
  113246. * @param startValue Start value of the animation curve
  113247. * @param endValue End value of the animation curve
  113248. * @param gradient Scalar amount to interpolate
  113249. * @returns Interpolated Color3 value
  113250. */
  113251. color3InterpolateFunction(startValue: Color3, endValue: Color3, gradient: number): Color3;
  113252. /**
  113253. * Interpolates a Color4 linearly
  113254. * @param startValue Start value of the animation curve
  113255. * @param endValue End value of the animation curve
  113256. * @param gradient Scalar amount to interpolate
  113257. * @returns Interpolated Color3 value
  113258. */
  113259. color4InterpolateFunction(startValue: Color4, endValue: Color4, gradient: number): Color4;
  113260. /**
  113261. * @hidden Internal use only
  113262. */
  113263. _getKeyValue(value: any): any;
  113264. /**
  113265. * @hidden Internal use only
  113266. */
  113267. _interpolate(currentFrame: number, state: _IAnimationState): any;
  113268. /**
  113269. * Defines the function to use to interpolate matrices
  113270. * @param startValue defines the start matrix
  113271. * @param endValue defines the end matrix
  113272. * @param gradient defines the gradient between both matrices
  113273. * @param result defines an optional target matrix where to store the interpolation
  113274. * @returns the interpolated matrix
  113275. */
  113276. matrixInterpolateFunction(startValue: Matrix, endValue: Matrix, gradient: number, result?: Matrix): Matrix;
  113277. /**
  113278. * Makes a copy of the animation
  113279. * @returns Cloned animation
  113280. */
  113281. clone(): Animation;
  113282. /**
  113283. * Sets the key frames of the animation
  113284. * @param values The animation key frames to set
  113285. */
  113286. setKeys(values: Array<IAnimationKey>): void;
  113287. /**
  113288. * Serializes the animation to an object
  113289. * @returns Serialized object
  113290. */
  113291. serialize(): any;
  113292. /**
  113293. * Float animation type
  113294. */
  113295. static readonly ANIMATIONTYPE_FLOAT: number;
  113296. /**
  113297. * Vector3 animation type
  113298. */
  113299. static readonly ANIMATIONTYPE_VECTOR3: number;
  113300. /**
  113301. * Quaternion animation type
  113302. */
  113303. static readonly ANIMATIONTYPE_QUATERNION: number;
  113304. /**
  113305. * Matrix animation type
  113306. */
  113307. static readonly ANIMATIONTYPE_MATRIX: number;
  113308. /**
  113309. * Color3 animation type
  113310. */
  113311. static readonly ANIMATIONTYPE_COLOR3: number;
  113312. /**
  113313. * Color3 animation type
  113314. */
  113315. static readonly ANIMATIONTYPE_COLOR4: number;
  113316. /**
  113317. * Vector2 animation type
  113318. */
  113319. static readonly ANIMATIONTYPE_VECTOR2: number;
  113320. /**
  113321. * Size animation type
  113322. */
  113323. static readonly ANIMATIONTYPE_SIZE: number;
  113324. /**
  113325. * Relative Loop Mode
  113326. */
  113327. static readonly ANIMATIONLOOPMODE_RELATIVE: number;
  113328. /**
  113329. * Cycle Loop Mode
  113330. */
  113331. static readonly ANIMATIONLOOPMODE_CYCLE: number;
  113332. /**
  113333. * Constant Loop Mode
  113334. */
  113335. static readonly ANIMATIONLOOPMODE_CONSTANT: number;
  113336. /** @hidden */
  113337. static _UniversalLerp(left: any, right: any, amount: number): any;
  113338. /**
  113339. * Parses an animation object and creates an animation
  113340. * @param parsedAnimation Parsed animation object
  113341. * @returns Animation object
  113342. */
  113343. static Parse(parsedAnimation: any): Animation;
  113344. /**
  113345. * Appends the serialized animations from the source animations
  113346. * @param source Source containing the animations
  113347. * @param destination Target to store the animations
  113348. */
  113349. static AppendSerializedAnimations(source: IAnimatable, destination: any): void;
  113350. /**
  113351. * Creates a new animation or an array of animations from a snippet saved in a remote file
  113352. * @param name defines the name of the animation to create (can be null or empty to use the one from the json data)
  113353. * @param url defines the url to load from
  113354. * @returns a promise that will resolve to the new animation or an array of animations
  113355. */
  113356. static ParseFromFileAsync(name: Nullable<string>, url: string): Promise<Animation | Array<Animation>>;
  113357. /**
  113358. * Creates an animation or an array of animations from a snippet saved by the Inspector
  113359. * @param snippetId defines the snippet to load
  113360. * @returns a promise that will resolve to the new animation or a new array of animations
  113361. */
  113362. static CreateFromSnippetAsync(snippetId: string): Promise<Animation | Array<Animation>>;
  113363. }
  113364. }
  113365. declare module BABYLON {
  113366. /**
  113367. * Interface containing an array of animations
  113368. */
  113369. export interface IAnimatable {
  113370. /**
  113371. * Array of animations
  113372. */
  113373. animations: Nullable<Array<Animation>>;
  113374. }
  113375. }
  113376. declare module BABYLON {
  113377. export function expandToProperty(callback: string, targetKey?: Nullable<string>): (target: any, propertyKey: string) => void;
  113378. export function serialize(sourceName?: string): (target: any, propertyKey: string | symbol) => void;
  113379. export function serializeAsTexture(sourceName?: string): (target: any, propertyKey: string | symbol) => void;
  113380. export function serializeAsColor3(sourceName?: string): (target: any, propertyKey: string | symbol) => void;
  113381. export function serializeAsFresnelParameters(sourceName?: string): (target: any, propertyKey: string | symbol) => void;
  113382. export function serializeAsVector2(sourceName?: string): (target: any, propertyKey: string | symbol) => void;
  113383. export function serializeAsVector3(sourceName?: string): (target: any, propertyKey: string | symbol) => void;
  113384. export function serializeAsMeshReference(sourceName?: string): (target: any, propertyKey: string | symbol) => void;
  113385. export function serializeAsColorCurves(sourceName?: string): (target: any, propertyKey: string | symbol) => void;
  113386. export function serializeAsColor4(sourceName?: string): (target: any, propertyKey: string | symbol) => void;
  113387. export function serializeAsImageProcessingConfiguration(sourceName?: string): (target: any, propertyKey: string | symbol) => void;
  113388. export function serializeAsQuaternion(sourceName?: string): (target: any, propertyKey: string | symbol) => void;
  113389. export function serializeAsMatrix(sourceName?: string): (target: any, propertyKey: string | symbol) => void;
  113390. /**
  113391. * Decorator used to define property that can be serialized as reference to a camera
  113392. * @param sourceName defines the name of the property to decorate
  113393. */
  113394. export function serializeAsCameraReference(sourceName?: string): (target: any, propertyKey: string | symbol) => void;
  113395. /**
  113396. * Class used to help serialization objects
  113397. */
  113398. export class SerializationHelper {
  113399. /** @hidden */
  113400. static _ImageProcessingConfigurationParser: (sourceProperty: any) => ImageProcessingConfiguration;
  113401. /** @hidden */
  113402. static _FresnelParametersParser: (sourceProperty: any) => FresnelParameters;
  113403. /** @hidden */
  113404. static _ColorCurvesParser: (sourceProperty: any) => ColorCurves;
  113405. /** @hidden */
  113406. static _TextureParser: (sourceProperty: any, scene: Scene, rootUrl: string) => Nullable<BaseTexture>;
  113407. /**
  113408. * Appends the serialized animations from the source animations
  113409. * @param source Source containing the animations
  113410. * @param destination Target to store the animations
  113411. */
  113412. static AppendSerializedAnimations(source: IAnimatable, destination: any): void;
  113413. /**
  113414. * Static function used to serialized a specific entity
  113415. * @param entity defines the entity to serialize
  113416. * @param serializationObject defines the optional target obecjt where serialization data will be stored
  113417. * @returns a JSON compatible object representing the serialization of the entity
  113418. */
  113419. static Serialize<T>(entity: T, serializationObject?: any): any;
  113420. /**
  113421. * Creates a new entity from a serialization data object
  113422. * @param creationFunction defines a function used to instanciated the new entity
  113423. * @param source defines the source serialization data
  113424. * @param scene defines the hosting scene
  113425. * @param rootUrl defines the root url for resources
  113426. * @returns a new entity
  113427. */
  113428. static Parse<T>(creationFunction: () => T, source: any, scene: Nullable<Scene>, rootUrl?: Nullable<string>): T;
  113429. /**
  113430. * Clones an object
  113431. * @param creationFunction defines the function used to instanciate the new object
  113432. * @param source defines the source object
  113433. * @returns the cloned object
  113434. */
  113435. static Clone<T>(creationFunction: () => T, source: T): T;
  113436. /**
  113437. * Instanciates a new object based on a source one (some data will be shared between both object)
  113438. * @param creationFunction defines the function used to instanciate the new object
  113439. * @param source defines the source object
  113440. * @returns the new object
  113441. */
  113442. static Instanciate<T>(creationFunction: () => T, source: T): T;
  113443. }
  113444. }
  113445. declare module BABYLON {
  113446. /**
  113447. * Base class of all the textures in babylon.
  113448. * It groups all the common properties the materials, post process, lights... might need
  113449. * in order to make a correct use of the texture.
  113450. */
  113451. export class BaseTexture implements IAnimatable {
  113452. /**
  113453. * Default anisotropic filtering level for the application.
  113454. * It is set to 4 as a good tradeoff between perf and quality.
  113455. */
  113456. static DEFAULT_ANISOTROPIC_FILTERING_LEVEL: number;
  113457. /**
  113458. * Gets or sets the unique id of the texture
  113459. */
  113460. uniqueId: number;
  113461. /**
  113462. * Define the name of the texture.
  113463. */
  113464. name: string;
  113465. /**
  113466. * Gets or sets an object used to store user defined information.
  113467. */
  113468. metadata: any;
  113469. /**
  113470. * For internal use only. Please do not use.
  113471. */
  113472. reservedDataStore: any;
  113473. private _hasAlpha;
  113474. /**
  113475. * Define if the texture is having a usable alpha value (can be use for transparency or glossiness for instance).
  113476. */
  113477. set hasAlpha(value: boolean);
  113478. get hasAlpha(): boolean;
  113479. /**
  113480. * Defines if the alpha value should be determined via the rgb values.
  113481. * If true the luminance of the pixel might be used to find the corresponding alpha value.
  113482. */
  113483. getAlphaFromRGB: boolean;
  113484. /**
  113485. * Intensity or strength of the texture.
  113486. * It is commonly used by materials to fine tune the intensity of the texture
  113487. */
  113488. level: number;
  113489. /**
  113490. * Define the UV chanel to use starting from 0 and defaulting to 0.
  113491. * This is part of the texture as textures usually maps to one uv set.
  113492. */
  113493. coordinatesIndex: number;
  113494. protected _coordinatesMode: number;
  113495. /**
  113496. * How a texture is mapped.
  113497. *
  113498. * | Value | Type | Description |
  113499. * | ----- | ----------------------------------- | ----------- |
  113500. * | 0 | EXPLICIT_MODE | |
  113501. * | 1 | SPHERICAL_MODE | |
  113502. * | 2 | PLANAR_MODE | |
  113503. * | 3 | CUBIC_MODE | |
  113504. * | 4 | PROJECTION_MODE | |
  113505. * | 5 | SKYBOX_MODE | |
  113506. * | 6 | INVCUBIC_MODE | |
  113507. * | 7 | EQUIRECTANGULAR_MODE | |
  113508. * | 8 | FIXED_EQUIRECTANGULAR_MODE | |
  113509. * | 9 | FIXED_EQUIRECTANGULAR_MIRRORED_MODE | |
  113510. */
  113511. set coordinatesMode(value: number);
  113512. get coordinatesMode(): number;
  113513. private _wrapU;
  113514. /**
  113515. * | Value | Type | Description |
  113516. * | ----- | ------------------ | ----------- |
  113517. * | 0 | CLAMP_ADDRESSMODE | |
  113518. * | 1 | WRAP_ADDRESSMODE | |
  113519. * | 2 | MIRROR_ADDRESSMODE | |
  113520. */
  113521. get wrapU(): number;
  113522. set wrapU(value: number);
  113523. private _wrapV;
  113524. /**
  113525. * | Value | Type | Description |
  113526. * | ----- | ------------------ | ----------- |
  113527. * | 0 | CLAMP_ADDRESSMODE | |
  113528. * | 1 | WRAP_ADDRESSMODE | |
  113529. * | 2 | MIRROR_ADDRESSMODE | |
  113530. */
  113531. get wrapV(): number;
  113532. set wrapV(value: number);
  113533. /**
  113534. * | Value | Type | Description |
  113535. * | ----- | ------------------ | ----------- |
  113536. * | 0 | CLAMP_ADDRESSMODE | |
  113537. * | 1 | WRAP_ADDRESSMODE | |
  113538. * | 2 | MIRROR_ADDRESSMODE | |
  113539. */
  113540. wrapR: number;
  113541. /**
  113542. * With compliant hardware and browser (supporting anisotropic filtering)
  113543. * this defines the level of anisotropic filtering in the texture.
  113544. * The higher the better but the slower. This defaults to 4 as it seems to be the best tradeoff.
  113545. */
  113546. anisotropicFilteringLevel: number;
  113547. /**
  113548. * Define if the texture is a cube texture or if false a 2d texture.
  113549. */
  113550. get isCube(): boolean;
  113551. set isCube(value: boolean);
  113552. /**
  113553. * Define if the texture is a 3d texture (webgl 2) or if false a 2d texture.
  113554. */
  113555. get is3D(): boolean;
  113556. set is3D(value: boolean);
  113557. /**
  113558. * Define if the texture is a 2d array texture (webgl 2) or if false a 2d texture.
  113559. */
  113560. get is2DArray(): boolean;
  113561. set is2DArray(value: boolean);
  113562. /**
  113563. * Define if the texture contains data in gamma space (most of the png/jpg aside bump).
  113564. * HDR texture are usually stored in linear space.
  113565. * This only impacts the PBR and Background materials
  113566. */
  113567. gammaSpace: boolean;
  113568. /**
  113569. * Gets or sets whether or not the texture contains RGBD data.
  113570. */
  113571. get isRGBD(): boolean;
  113572. set isRGBD(value: boolean);
  113573. /**
  113574. * Is Z inverted in the texture (useful in a cube texture).
  113575. */
  113576. invertZ: boolean;
  113577. /**
  113578. * Are mip maps generated for this texture or not.
  113579. */
  113580. get noMipmap(): boolean;
  113581. /**
  113582. * @hidden
  113583. */
  113584. lodLevelInAlpha: boolean;
  113585. /**
  113586. * With prefiltered texture, defined the offset used during the prefiltering steps.
  113587. */
  113588. get lodGenerationOffset(): number;
  113589. set lodGenerationOffset(value: number);
  113590. /**
  113591. * With prefiltered texture, defined the scale used during the prefiltering steps.
  113592. */
  113593. get lodGenerationScale(): number;
  113594. set lodGenerationScale(value: number);
  113595. /**
  113596. * With prefiltered texture, defined if the specular generation is based on a linear ramp.
  113597. * By default we are using a log2 of the linear roughness helping to keep a better resolution for
  113598. * average roughness values.
  113599. */
  113600. get linearSpecularLOD(): boolean;
  113601. set linearSpecularLOD(value: boolean);
  113602. /**
  113603. * In case a better definition than spherical harmonics is required for the diffuse part of the environment.
  113604. * You can set the irradiance texture to rely on a texture instead of the spherical approach.
  113605. * This texture need to have the same characteristics than its parent (Cube vs 2d, coordinates mode, Gamma/Linear, RGBD).
  113606. */
  113607. get irradianceTexture(): Nullable<BaseTexture>;
  113608. set irradianceTexture(value: Nullable<BaseTexture>);
  113609. /**
  113610. * Define if the texture is a render target.
  113611. */
  113612. isRenderTarget: boolean;
  113613. /**
  113614. * Define the unique id of the texture in the scene.
  113615. */
  113616. get uid(): string;
  113617. /** @hidden */
  113618. _prefiltered: boolean;
  113619. /**
  113620. * Return a string representation of the texture.
  113621. * @returns the texture as a string
  113622. */
  113623. toString(): string;
  113624. /**
  113625. * Get the class name of the texture.
  113626. * @returns "BaseTexture"
  113627. */
  113628. getClassName(): string;
  113629. /**
  113630. * Define the list of animation attached to the texture.
  113631. */
  113632. animations: Animation[];
  113633. /**
  113634. * An event triggered when the texture is disposed.
  113635. */
  113636. onDisposeObservable: Observable<BaseTexture>;
  113637. private _onDisposeObserver;
  113638. /**
  113639. * Callback triggered when the texture has been disposed.
  113640. * Kept for back compatibility, you can use the onDisposeObservable instead.
  113641. */
  113642. set onDispose(callback: () => void);
  113643. /**
  113644. * Define the current state of the loading sequence when in delayed load mode.
  113645. */
  113646. delayLoadState: number;
  113647. protected _scene: Nullable<Scene>;
  113648. protected _engine: Nullable<ThinEngine>;
  113649. /** @hidden */
  113650. _texture: Nullable<InternalTexture>;
  113651. private _uid;
  113652. /**
  113653. * Define if the texture is preventinga material to render or not.
  113654. * If not and the texture is not ready, the engine will use a default black texture instead.
  113655. */
  113656. get isBlocking(): boolean;
  113657. /**
  113658. * Instantiates a new BaseTexture.
  113659. * Base class of all the textures in babylon.
  113660. * It groups all the common properties the materials, post process, lights... might need
  113661. * in order to make a correct use of the texture.
  113662. * @param sceneOrEngine Define the scene or engine the texture blongs to
  113663. */
  113664. constructor(sceneOrEngine: Nullable<Scene | ThinEngine>);
  113665. /**
  113666. * Get the scene the texture belongs to.
  113667. * @returns the scene or null if undefined
  113668. */
  113669. getScene(): Nullable<Scene>;
  113670. /** @hidden */
  113671. protected _getEngine(): Nullable<ThinEngine>;
  113672. /**
  113673. * Get the texture transform matrix used to offset tile the texture for istance.
  113674. * @returns the transformation matrix
  113675. */
  113676. getTextureMatrix(): Matrix;
  113677. /**
  113678. * Get the texture reflection matrix used to rotate/transform the reflection.
  113679. * @returns the reflection matrix
  113680. */
  113681. getReflectionTextureMatrix(): Matrix;
  113682. /**
  113683. * Get the underlying lower level texture from Babylon.
  113684. * @returns the insternal texture
  113685. */
  113686. getInternalTexture(): Nullable<InternalTexture>;
  113687. /**
  113688. * Get if the texture is ready to be consumed (either it is ready or it is not blocking)
  113689. * @returns true if ready or not blocking
  113690. */
  113691. isReadyOrNotBlocking(): boolean;
  113692. /**
  113693. * Get if the texture is ready to be used (downloaded, converted, mip mapped...).
  113694. * @returns true if fully ready
  113695. */
  113696. isReady(): boolean;
  113697. private _cachedSize;
  113698. /**
  113699. * Get the size of the texture.
  113700. * @returns the texture size.
  113701. */
  113702. getSize(): ISize;
  113703. /**
  113704. * Get the base size of the texture.
  113705. * It can be different from the size if the texture has been resized for POT for instance
  113706. * @returns the base size
  113707. */
  113708. getBaseSize(): ISize;
  113709. /**
  113710. * Update the sampling mode of the texture.
  113711. * Default is Trilinear mode.
  113712. *
  113713. * | Value | Type | Description |
  113714. * | ----- | ------------------ | ----------- |
  113715. * | 1 | NEAREST_SAMPLINGMODE or NEAREST_NEAREST_MIPLINEAR | Nearest is: mag = nearest, min = nearest, mip = linear |
  113716. * | 2 | BILINEAR_SAMPLINGMODE or LINEAR_LINEAR_MIPNEAREST | Bilinear is: mag = linear, min = linear, mip = nearest |
  113717. * | 3 | TRILINEAR_SAMPLINGMODE or LINEAR_LINEAR_MIPLINEAR | Trilinear is: mag = linear, min = linear, mip = linear |
  113718. * | 4 | NEAREST_NEAREST_MIPNEAREST | |
  113719. * | 5 | NEAREST_LINEAR_MIPNEAREST | |
  113720. * | 6 | NEAREST_LINEAR_MIPLINEAR | |
  113721. * | 7 | NEAREST_LINEAR | |
  113722. * | 8 | NEAREST_NEAREST | |
  113723. * | 9 | LINEAR_NEAREST_MIPNEAREST | |
  113724. * | 10 | LINEAR_NEAREST_MIPLINEAR | |
  113725. * | 11 | LINEAR_LINEAR | |
  113726. * | 12 | LINEAR_NEAREST | |
  113727. *
  113728. * > _mag_: magnification filter (close to the viewer)
  113729. * > _min_: minification filter (far from the viewer)
  113730. * > _mip_: filter used between mip map levels
  113731. *@param samplingMode Define the new sampling mode of the texture
  113732. */
  113733. updateSamplingMode(samplingMode: number): void;
  113734. /**
  113735. * Scales the texture if is `canRescale()`
  113736. * @param ratio the resize factor we want to use to rescale
  113737. */
  113738. scale(ratio: number): void;
  113739. /**
  113740. * Get if the texture can rescale.
  113741. */
  113742. get canRescale(): boolean;
  113743. /** @hidden */
  113744. _getFromCache(url: Nullable<string>, noMipmap: boolean, sampling?: number, invertY?: boolean): Nullable<InternalTexture>;
  113745. /** @hidden */
  113746. _rebuild(): void;
  113747. /**
  113748. * Triggers the load sequence in delayed load mode.
  113749. */
  113750. delayLoad(): void;
  113751. /**
  113752. * Clones the texture.
  113753. * @returns the cloned texture
  113754. */
  113755. clone(): Nullable<BaseTexture>;
  113756. /**
  113757. * Get the texture underlying type (INT, FLOAT...)
  113758. */
  113759. get textureType(): number;
  113760. /**
  113761. * Get the texture underlying format (RGB, RGBA...)
  113762. */
  113763. get textureFormat(): number;
  113764. /**
  113765. * Indicates that textures need to be re-calculated for all materials
  113766. */
  113767. protected _markAllSubMeshesAsTexturesDirty(): void;
  113768. /**
  113769. * Reads the pixels stored in the webgl texture and returns them as an ArrayBuffer.
  113770. * This will returns an RGBA array buffer containing either in values (0-255) or
  113771. * float values (0-1) depending of the underlying buffer type.
  113772. * @param faceIndex defines the face of the texture to read (in case of cube texture)
  113773. * @param level defines the LOD level of the texture to read (in case of Mip Maps)
  113774. * @param buffer defines a user defined buffer to fill with data (can be null)
  113775. * @returns The Array buffer containing the pixels data.
  113776. */
  113777. readPixels(faceIndex?: number, level?: number, buffer?: Nullable<ArrayBufferView>): Nullable<ArrayBufferView>;
  113778. /**
  113779. * Release and destroy the underlying lower level texture aka internalTexture.
  113780. */
  113781. releaseInternalTexture(): void;
  113782. /** @hidden */
  113783. get _lodTextureHigh(): Nullable<BaseTexture>;
  113784. /** @hidden */
  113785. get _lodTextureMid(): Nullable<BaseTexture>;
  113786. /** @hidden */
  113787. get _lodTextureLow(): Nullable<BaseTexture>;
  113788. /**
  113789. * Dispose the texture and release its associated resources.
  113790. */
  113791. dispose(): void;
  113792. /**
  113793. * Serialize the texture into a JSON representation that can be parsed later on.
  113794. * @returns the JSON representation of the texture
  113795. */
  113796. serialize(): any;
  113797. /**
  113798. * Helper function to be called back once a list of texture contains only ready textures.
  113799. * @param textures Define the list of textures to wait for
  113800. * @param callback Define the callback triggered once the entire list will be ready
  113801. */
  113802. static WhenAllReady(textures: BaseTexture[], callback: () => void): void;
  113803. private static _isScene;
  113804. }
  113805. }
  113806. declare module BABYLON {
  113807. /**
  113808. * Options to be used when creating an effect.
  113809. */
  113810. export interface IEffectCreationOptions {
  113811. /**
  113812. * Atrributes that will be used in the shader.
  113813. */
  113814. attributes: string[];
  113815. /**
  113816. * Uniform varible names that will be set in the shader.
  113817. */
  113818. uniformsNames: string[];
  113819. /**
  113820. * Uniform buffer variable names that will be set in the shader.
  113821. */
  113822. uniformBuffersNames: string[];
  113823. /**
  113824. * Sampler texture variable names that will be set in the shader.
  113825. */
  113826. samplers: string[];
  113827. /**
  113828. * Define statements that will be set in the shader.
  113829. */
  113830. defines: any;
  113831. /**
  113832. * Possible fallbacks for this effect to improve performance when needed.
  113833. */
  113834. fallbacks: Nullable<IEffectFallbacks>;
  113835. /**
  113836. * Callback that will be called when the shader is compiled.
  113837. */
  113838. onCompiled: Nullable<(effect: Effect) => void>;
  113839. /**
  113840. * Callback that will be called if an error occurs during shader compilation.
  113841. */
  113842. onError: Nullable<(effect: Effect, errors: string) => void>;
  113843. /**
  113844. * Parameters to be used with Babylons include syntax to iterate over an array (eg. {lights: 10})
  113845. */
  113846. indexParameters?: any;
  113847. /**
  113848. * Max number of lights that can be used in the shader.
  113849. */
  113850. maxSimultaneousLights?: number;
  113851. /**
  113852. * See https://developer.mozilla.org/en-US/docs/Web/API/WebGL2RenderingContext/transformFeedbackVaryings
  113853. */
  113854. transformFeedbackVaryings?: Nullable<string[]>;
  113855. /**
  113856. * 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
  113857. */
  113858. processFinalCode?: Nullable<(shaderType: string, code: string) => string>;
  113859. /**
  113860. * Is this effect rendering to several color attachments ?
  113861. */
  113862. multiTarget?: boolean;
  113863. }
  113864. /**
  113865. * Effect containing vertex and fragment shader that can be executed on an object.
  113866. */
  113867. export class Effect implements IDisposable {
  113868. /**
  113869. * Gets or sets the relative url used to load shaders if using the engine in non-minified mode
  113870. */
  113871. static ShadersRepository: string;
  113872. /**
  113873. * Enable logging of the shader code when a compilation error occurs
  113874. */
  113875. static LogShaderCodeOnCompilationError: boolean;
  113876. /**
  113877. * Name of the effect.
  113878. */
  113879. name: any;
  113880. /**
  113881. * String container all the define statements that should be set on the shader.
  113882. */
  113883. defines: string;
  113884. /**
  113885. * Callback that will be called when the shader is compiled.
  113886. */
  113887. onCompiled: Nullable<(effect: Effect) => void>;
  113888. /**
  113889. * Callback that will be called if an error occurs during shader compilation.
  113890. */
  113891. onError: Nullable<(effect: Effect, errors: string) => void>;
  113892. /**
  113893. * Callback that will be called when effect is bound.
  113894. */
  113895. onBind: Nullable<(effect: Effect) => void>;
  113896. /**
  113897. * Unique ID of the effect.
  113898. */
  113899. uniqueId: number;
  113900. /**
  113901. * Observable that will be called when the shader is compiled.
  113902. * It is recommended to use executeWhenCompile() or to make sure that scene.isReady() is called to get this observable raised.
  113903. */
  113904. onCompileObservable: Observable<Effect>;
  113905. /**
  113906. * Observable that will be called if an error occurs during shader compilation.
  113907. */
  113908. onErrorObservable: Observable<Effect>;
  113909. /** @hidden */
  113910. _onBindObservable: Nullable<Observable<Effect>>;
  113911. /**
  113912. * @hidden
  113913. * Specifies if the effect was previously ready
  113914. */
  113915. _wasPreviouslyReady: boolean;
  113916. /**
  113917. * Observable that will be called when effect is bound.
  113918. */
  113919. get onBindObservable(): Observable<Effect>;
  113920. /** @hidden */
  113921. _bonesComputationForcedToCPU: boolean;
  113922. /** @hidden */
  113923. _multiTarget: boolean;
  113924. private static _uniqueIdSeed;
  113925. private _engine;
  113926. private _uniformBuffersNames;
  113927. private _uniformBuffersNamesList;
  113928. private _uniformsNames;
  113929. private _samplerList;
  113930. private _samplers;
  113931. private _isReady;
  113932. private _compilationError;
  113933. private _allFallbacksProcessed;
  113934. private _attributesNames;
  113935. private _attributes;
  113936. private _attributeLocationByName;
  113937. private _uniforms;
  113938. /**
  113939. * Key for the effect.
  113940. * @hidden
  113941. */
  113942. _key: string;
  113943. private _indexParameters;
  113944. private _fallbacks;
  113945. private _vertexSourceCode;
  113946. private _fragmentSourceCode;
  113947. private _vertexSourceCodeOverride;
  113948. private _fragmentSourceCodeOverride;
  113949. private _transformFeedbackVaryings;
  113950. /**
  113951. * Compiled shader to webGL program.
  113952. * @hidden
  113953. */
  113954. _pipelineContext: Nullable<IPipelineContext>;
  113955. private _valueCache;
  113956. private static _baseCache;
  113957. /**
  113958. * Instantiates an effect.
  113959. * An effect can be used to create/manage/execute vertex and fragment shaders.
  113960. * @param baseName Name of the effect.
  113961. * @param attributesNamesOrOptions List of attribute names that will be passed to the shader or set of all options to create the effect.
  113962. * @param uniformsNamesOrEngine List of uniform variable names that will be passed to the shader or the engine that will be used to render effect.
  113963. * @param samplers List of sampler variables that will be passed to the shader.
  113964. * @param engine Engine to be used to render the effect
  113965. * @param defines Define statements to be added to the shader.
  113966. * @param fallbacks Possible fallbacks for this effect to improve performance when needed.
  113967. * @param onCompiled Callback that will be called when the shader is compiled.
  113968. * @param onError Callback that will be called if an error occurs during shader compilation.
  113969. * @param indexParameters Parameters to be used with Babylons include syntax to iterate over an array (eg. {lights: 10})
  113970. */
  113971. 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);
  113972. private _useFinalCode;
  113973. /**
  113974. * Unique key for this effect
  113975. */
  113976. get key(): string;
  113977. /**
  113978. * If the effect has been compiled and prepared.
  113979. * @returns if the effect is compiled and prepared.
  113980. */
  113981. isReady(): boolean;
  113982. private _isReadyInternal;
  113983. /**
  113984. * The engine the effect was initialized with.
  113985. * @returns the engine.
  113986. */
  113987. getEngine(): Engine;
  113988. /**
  113989. * The pipeline context for this effect
  113990. * @returns the associated pipeline context
  113991. */
  113992. getPipelineContext(): Nullable<IPipelineContext>;
  113993. /**
  113994. * The set of names of attribute variables for the shader.
  113995. * @returns An array of attribute names.
  113996. */
  113997. getAttributesNames(): string[];
  113998. /**
  113999. * Returns the attribute at the given index.
  114000. * @param index The index of the attribute.
  114001. * @returns The location of the attribute.
  114002. */
  114003. getAttributeLocation(index: number): number;
  114004. /**
  114005. * Returns the attribute based on the name of the variable.
  114006. * @param name of the attribute to look up.
  114007. * @returns the attribute location.
  114008. */
  114009. getAttributeLocationByName(name: string): number;
  114010. /**
  114011. * The number of attributes.
  114012. * @returns the numnber of attributes.
  114013. */
  114014. getAttributesCount(): number;
  114015. /**
  114016. * Gets the index of a uniform variable.
  114017. * @param uniformName of the uniform to look up.
  114018. * @returns the index.
  114019. */
  114020. getUniformIndex(uniformName: string): number;
  114021. /**
  114022. * Returns the attribute based on the name of the variable.
  114023. * @param uniformName of the uniform to look up.
  114024. * @returns the location of the uniform.
  114025. */
  114026. getUniform(uniformName: string): Nullable<WebGLUniformLocation>;
  114027. /**
  114028. * Returns an array of sampler variable names
  114029. * @returns The array of sampler variable names.
  114030. */
  114031. getSamplers(): string[];
  114032. /**
  114033. * Returns an array of uniform variable names
  114034. * @returns The array of uniform variable names.
  114035. */
  114036. getUniformNames(): string[];
  114037. /**
  114038. * Returns an array of uniform buffer variable names
  114039. * @returns The array of uniform buffer variable names.
  114040. */
  114041. getUniformBuffersNames(): string[];
  114042. /**
  114043. * Returns the index parameters used to create the effect
  114044. * @returns The index parameters object
  114045. */
  114046. getIndexParameters(): any;
  114047. /**
  114048. * The error from the last compilation.
  114049. * @returns the error string.
  114050. */
  114051. getCompilationError(): string;
  114052. /**
  114053. * Gets a boolean indicating that all fallbacks were used during compilation
  114054. * @returns true if all fallbacks were used
  114055. */
  114056. allFallbacksProcessed(): boolean;
  114057. /**
  114058. * Adds a callback to the onCompiled observable and call the callback imediatly if already ready.
  114059. * @param func The callback to be used.
  114060. */
  114061. executeWhenCompiled(func: (effect: Effect) => void): void;
  114062. private _checkIsReady;
  114063. private _loadShader;
  114064. /**
  114065. * Gets the vertex shader source code of this effect
  114066. */
  114067. get vertexSourceCode(): string;
  114068. /**
  114069. * Gets the fragment shader source code of this effect
  114070. */
  114071. get fragmentSourceCode(): string;
  114072. /**
  114073. * Recompiles the webGL program
  114074. * @param vertexSourceCode The source code for the vertex shader.
  114075. * @param fragmentSourceCode The source code for the fragment shader.
  114076. * @param onCompiled Callback called when completed.
  114077. * @param onError Callback called on error.
  114078. * @hidden
  114079. */
  114080. _rebuildProgram(vertexSourceCode: string, fragmentSourceCode: string, onCompiled: (pipelineContext: IPipelineContext) => void, onError: (message: string) => void): void;
  114081. /**
  114082. * Prepares the effect
  114083. * @hidden
  114084. */
  114085. _prepareEffect(): void;
  114086. private _getShaderCodeAndErrorLine;
  114087. private _processCompilationErrors;
  114088. /**
  114089. * Checks if the effect is supported. (Must be called after compilation)
  114090. */
  114091. get isSupported(): boolean;
  114092. /**
  114093. * Binds a texture to the engine to be used as output of the shader.
  114094. * @param channel Name of the output variable.
  114095. * @param texture Texture to bind.
  114096. * @hidden
  114097. */
  114098. _bindTexture(channel: string, texture: Nullable<InternalTexture>): void;
  114099. /**
  114100. * Sets a texture on the engine to be used in the shader.
  114101. * @param channel Name of the sampler variable.
  114102. * @param texture Texture to set.
  114103. */
  114104. setTexture(channel: string, texture: Nullable<BaseTexture>): void;
  114105. /**
  114106. * Sets a depth stencil texture from a render target on the engine to be used in the shader.
  114107. * @param channel Name of the sampler variable.
  114108. * @param texture Texture to set.
  114109. */
  114110. setDepthStencilTexture(channel: string, texture: Nullable<RenderTargetTexture>): void;
  114111. /**
  114112. * Sets an array of textures on the engine to be used in the shader.
  114113. * @param channel Name of the variable.
  114114. * @param textures Textures to set.
  114115. */
  114116. setTextureArray(channel: string, textures: BaseTexture[]): void;
  114117. /**
  114118. * 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)
  114119. * @param channel Name of the sampler variable.
  114120. * @param postProcess Post process to get the input texture from.
  114121. */
  114122. setTextureFromPostProcess(channel: string, postProcess: Nullable<PostProcess>): void;
  114123. /**
  114124. * (Warning! setTextureFromPostProcessOutput may be desired instead)
  114125. * 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)
  114126. * @param channel Name of the sampler variable.
  114127. * @param postProcess Post process to get the output texture from.
  114128. */
  114129. setTextureFromPostProcessOutput(channel: string, postProcess: Nullable<PostProcess>): void;
  114130. /** @hidden */
  114131. _cacheMatrix(uniformName: string, matrix: IMatrixLike): boolean;
  114132. /** @hidden */
  114133. _cacheFloat2(uniformName: string, x: number, y: number): boolean;
  114134. /** @hidden */
  114135. _cacheFloat3(uniformName: string, x: number, y: number, z: number): boolean;
  114136. /** @hidden */
  114137. _cacheFloat4(uniformName: string, x: number, y: number, z: number, w: number): boolean;
  114138. /**
  114139. * Binds a buffer to a uniform.
  114140. * @param buffer Buffer to bind.
  114141. * @param name Name of the uniform variable to bind to.
  114142. */
  114143. bindUniformBuffer(buffer: DataBuffer, name: string): void;
  114144. /**
  114145. * Binds block to a uniform.
  114146. * @param blockName Name of the block to bind.
  114147. * @param index Index to bind.
  114148. */
  114149. bindUniformBlock(blockName: string, index: number): void;
  114150. /**
  114151. * Sets an interger value on a uniform variable.
  114152. * @param uniformName Name of the variable.
  114153. * @param value Value to be set.
  114154. * @returns this effect.
  114155. */
  114156. setInt(uniformName: string, value: number): Effect;
  114157. /**
  114158. * Sets an int array on a uniform variable.
  114159. * @param uniformName Name of the variable.
  114160. * @param array array to be set.
  114161. * @returns this effect.
  114162. */
  114163. setIntArray(uniformName: string, array: Int32Array): Effect;
  114164. /**
  114165. * 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)
  114166. * @param uniformName Name of the variable.
  114167. * @param array array to be set.
  114168. * @returns this effect.
  114169. */
  114170. setIntArray2(uniformName: string, array: Int32Array): Effect;
  114171. /**
  114172. * 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)
  114173. * @param uniformName Name of the variable.
  114174. * @param array array to be set.
  114175. * @returns this effect.
  114176. */
  114177. setIntArray3(uniformName: string, array: Int32Array): Effect;
  114178. /**
  114179. * 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)
  114180. * @param uniformName Name of the variable.
  114181. * @param array array to be set.
  114182. * @returns this effect.
  114183. */
  114184. setIntArray4(uniformName: string, array: Int32Array): Effect;
  114185. /**
  114186. * Sets an float array on a uniform variable.
  114187. * @param uniformName Name of the variable.
  114188. * @param array array to be set.
  114189. * @returns this effect.
  114190. */
  114191. setFloatArray(uniformName: string, array: Float32Array): Effect;
  114192. /**
  114193. * 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)
  114194. * @param uniformName Name of the variable.
  114195. * @param array array to be set.
  114196. * @returns this effect.
  114197. */
  114198. setFloatArray2(uniformName: string, array: Float32Array): Effect;
  114199. /**
  114200. * 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)
  114201. * @param uniformName Name of the variable.
  114202. * @param array array to be set.
  114203. * @returns this effect.
  114204. */
  114205. setFloatArray3(uniformName: string, array: Float32Array): Effect;
  114206. /**
  114207. * 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)
  114208. * @param uniformName Name of the variable.
  114209. * @param array array to be set.
  114210. * @returns this effect.
  114211. */
  114212. setFloatArray4(uniformName: string, array: Float32Array): Effect;
  114213. /**
  114214. * Sets an array on a uniform variable.
  114215. * @param uniformName Name of the variable.
  114216. * @param array array to be set.
  114217. * @returns this effect.
  114218. */
  114219. setArray(uniformName: string, array: number[]): Effect;
  114220. /**
  114221. * 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)
  114222. * @param uniformName Name of the variable.
  114223. * @param array array to be set.
  114224. * @returns this effect.
  114225. */
  114226. setArray2(uniformName: string, array: number[]): Effect;
  114227. /**
  114228. * 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)
  114229. * @param uniformName Name of the variable.
  114230. * @param array array to be set.
  114231. * @returns this effect.
  114232. */
  114233. setArray3(uniformName: string, array: number[]): Effect;
  114234. /**
  114235. * 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)
  114236. * @param uniformName Name of the variable.
  114237. * @param array array to be set.
  114238. * @returns this effect.
  114239. */
  114240. setArray4(uniformName: string, array: number[]): Effect;
  114241. /**
  114242. * Sets matrices on a uniform variable.
  114243. * @param uniformName Name of the variable.
  114244. * @param matrices matrices to be set.
  114245. * @returns this effect.
  114246. */
  114247. setMatrices(uniformName: string, matrices: Float32Array | Array<number>): Effect;
  114248. /**
  114249. * Sets matrix on a uniform variable.
  114250. * @param uniformName Name of the variable.
  114251. * @param matrix matrix to be set.
  114252. * @returns this effect.
  114253. */
  114254. setMatrix(uniformName: string, matrix: IMatrixLike): Effect;
  114255. /**
  114256. * 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)
  114257. * @param uniformName Name of the variable.
  114258. * @param matrix matrix to be set.
  114259. * @returns this effect.
  114260. */
  114261. setMatrix3x3(uniformName: string, matrix: Float32Array | Array<number>): Effect;
  114262. /**
  114263. * Sets a 2x2 matrix on a uniform variable. (Speicified as [1,2,3,4] will result in [1,2][3,4] matrix)
  114264. * @param uniformName Name of the variable.
  114265. * @param matrix matrix to be set.
  114266. * @returns this effect.
  114267. */
  114268. setMatrix2x2(uniformName: string, matrix: Float32Array | Array<number>): Effect;
  114269. /**
  114270. * Sets a float on a uniform variable.
  114271. * @param uniformName Name of the variable.
  114272. * @param value value to be set.
  114273. * @returns this effect.
  114274. */
  114275. setFloat(uniformName: string, value: number): Effect;
  114276. /**
  114277. * Sets a boolean on a uniform variable.
  114278. * @param uniformName Name of the variable.
  114279. * @param bool value to be set.
  114280. * @returns this effect.
  114281. */
  114282. setBool(uniformName: string, bool: boolean): Effect;
  114283. /**
  114284. * Sets a Vector2 on a uniform variable.
  114285. * @param uniformName Name of the variable.
  114286. * @param vector2 vector2 to be set.
  114287. * @returns this effect.
  114288. */
  114289. setVector2(uniformName: string, vector2: IVector2Like): Effect;
  114290. /**
  114291. * Sets a float2 on a uniform variable.
  114292. * @param uniformName Name of the variable.
  114293. * @param x First float in float2.
  114294. * @param y Second float in float2.
  114295. * @returns this effect.
  114296. */
  114297. setFloat2(uniformName: string, x: number, y: number): Effect;
  114298. /**
  114299. * Sets a Vector3 on a uniform variable.
  114300. * @param uniformName Name of the variable.
  114301. * @param vector3 Value to be set.
  114302. * @returns this effect.
  114303. */
  114304. setVector3(uniformName: string, vector3: IVector3Like): Effect;
  114305. /**
  114306. * Sets a float3 on a uniform variable.
  114307. * @param uniformName Name of the variable.
  114308. * @param x First float in float3.
  114309. * @param y Second float in float3.
  114310. * @param z Third float in float3.
  114311. * @returns this effect.
  114312. */
  114313. setFloat3(uniformName: string, x: number, y: number, z: number): Effect;
  114314. /**
  114315. * Sets a Vector4 on a uniform variable.
  114316. * @param uniformName Name of the variable.
  114317. * @param vector4 Value to be set.
  114318. * @returns this effect.
  114319. */
  114320. setVector4(uniformName: string, vector4: IVector4Like): Effect;
  114321. /**
  114322. * Sets a float4 on a uniform variable.
  114323. * @param uniformName Name of the variable.
  114324. * @param x First float in float4.
  114325. * @param y Second float in float4.
  114326. * @param z Third float in float4.
  114327. * @param w Fourth float in float4.
  114328. * @returns this effect.
  114329. */
  114330. setFloat4(uniformName: string, x: number, y: number, z: number, w: number): Effect;
  114331. /**
  114332. * Sets a Color3 on a uniform variable.
  114333. * @param uniformName Name of the variable.
  114334. * @param color3 Value to be set.
  114335. * @returns this effect.
  114336. */
  114337. setColor3(uniformName: string, color3: IColor3Like): Effect;
  114338. /**
  114339. * Sets a Color4 on a uniform variable.
  114340. * @param uniformName Name of the variable.
  114341. * @param color3 Value to be set.
  114342. * @param alpha Alpha value to be set.
  114343. * @returns this effect.
  114344. */
  114345. setColor4(uniformName: string, color3: IColor3Like, alpha: number): Effect;
  114346. /**
  114347. * Sets a Color4 on a uniform variable
  114348. * @param uniformName defines the name of the variable
  114349. * @param color4 defines the value to be set
  114350. * @returns this effect.
  114351. */
  114352. setDirectColor4(uniformName: string, color4: IColor4Like): Effect;
  114353. /** Release all associated resources */
  114354. dispose(): void;
  114355. /**
  114356. * This function will add a new shader to the shader store
  114357. * @param name the name of the shader
  114358. * @param pixelShader optional pixel shader content
  114359. * @param vertexShader optional vertex shader content
  114360. */
  114361. static RegisterShader(name: string, pixelShader?: string, vertexShader?: string): void;
  114362. /**
  114363. * Store of each shader (The can be looked up using effect.key)
  114364. */
  114365. static ShadersStore: {
  114366. [key: string]: string;
  114367. };
  114368. /**
  114369. * Store of each included file for a shader (The can be looked up using effect.key)
  114370. */
  114371. static IncludesShadersStore: {
  114372. [key: string]: string;
  114373. };
  114374. /**
  114375. * Resets the cache of effects.
  114376. */
  114377. static ResetCache(): void;
  114378. }
  114379. }
  114380. declare module BABYLON {
  114381. /**
  114382. * Interface used to describe the capabilities of the engine relatively to the current browser
  114383. */
  114384. export interface EngineCapabilities {
  114385. /** Maximum textures units per fragment shader */
  114386. maxTexturesImageUnits: number;
  114387. /** Maximum texture units per vertex shader */
  114388. maxVertexTextureImageUnits: number;
  114389. /** Maximum textures units in the entire pipeline */
  114390. maxCombinedTexturesImageUnits: number;
  114391. /** Maximum texture size */
  114392. maxTextureSize: number;
  114393. /** Maximum texture samples */
  114394. maxSamples?: number;
  114395. /** Maximum cube texture size */
  114396. maxCubemapTextureSize: number;
  114397. /** Maximum render texture size */
  114398. maxRenderTextureSize: number;
  114399. /** Maximum number of vertex attributes */
  114400. maxVertexAttribs: number;
  114401. /** Maximum number of varyings */
  114402. maxVaryingVectors: number;
  114403. /** Maximum number of uniforms per vertex shader */
  114404. maxVertexUniformVectors: number;
  114405. /** Maximum number of uniforms per fragment shader */
  114406. maxFragmentUniformVectors: number;
  114407. /** Defines if standard derivates (dx/dy) are supported */
  114408. standardDerivatives: boolean;
  114409. /** Defines if s3tc texture compression is supported */
  114410. s3tc?: WEBGL_compressed_texture_s3tc;
  114411. /** Defines if pvrtc texture compression is supported */
  114412. pvrtc: any;
  114413. /** Defines if etc1 texture compression is supported */
  114414. etc1: any;
  114415. /** Defines if etc2 texture compression is supported */
  114416. etc2: any;
  114417. /** Defines if astc texture compression is supported */
  114418. astc: any;
  114419. /** Defines if float textures are supported */
  114420. textureFloat: boolean;
  114421. /** Defines if vertex array objects are supported */
  114422. vertexArrayObject: boolean;
  114423. /** Gets the webgl extension for anisotropic filtering (null if not supported) */
  114424. textureAnisotropicFilterExtension?: EXT_texture_filter_anisotropic;
  114425. /** Gets the maximum level of anisotropy supported */
  114426. maxAnisotropy: number;
  114427. /** Defines if instancing is supported */
  114428. instancedArrays: boolean;
  114429. /** Defines if 32 bits indices are supported */
  114430. uintIndices: boolean;
  114431. /** Defines if high precision shaders are supported */
  114432. highPrecisionShaderSupported: boolean;
  114433. /** Defines if depth reading in the fragment shader is supported */
  114434. fragmentDepthSupported: boolean;
  114435. /** Defines if float texture linear filtering is supported*/
  114436. textureFloatLinearFiltering: boolean;
  114437. /** Defines if rendering to float textures is supported */
  114438. textureFloatRender: boolean;
  114439. /** Defines if half float textures are supported*/
  114440. textureHalfFloat: boolean;
  114441. /** Defines if half float texture linear filtering is supported*/
  114442. textureHalfFloatLinearFiltering: boolean;
  114443. /** Defines if rendering to half float textures is supported */
  114444. textureHalfFloatRender: boolean;
  114445. /** Defines if textureLOD shader command is supported */
  114446. textureLOD: boolean;
  114447. /** Defines if draw buffers extension is supported */
  114448. drawBuffersExtension: boolean;
  114449. /** Defines if depth textures are supported */
  114450. depthTextureExtension: boolean;
  114451. /** Defines if float color buffer are supported */
  114452. colorBufferFloat: boolean;
  114453. /** Gets disjoint timer query extension (null if not supported) */
  114454. timerQuery?: EXT_disjoint_timer_query;
  114455. /** Defines if timestamp can be used with timer query */
  114456. canUseTimestampForTimerQuery: boolean;
  114457. /** Defines if multiview is supported (https://www.khronos.org/registry/webgl/extensions/WEBGL_multiview/) */
  114458. multiview?: any;
  114459. /** Defines if oculus multiview is supported (https://developer.oculus.com/documentation/oculus-browser/latest/concepts/browser-multiview/) */
  114460. oculusMultiview?: any;
  114461. /** Function used to let the system compiles shaders in background */
  114462. parallelShaderCompile?: {
  114463. COMPLETION_STATUS_KHR: number;
  114464. };
  114465. /** Max number of texture samples for MSAA */
  114466. maxMSAASamples: number;
  114467. /** Defines if the blend min max extension is supported */
  114468. blendMinMax: boolean;
  114469. }
  114470. }
  114471. declare module BABYLON {
  114472. /**
  114473. * @hidden
  114474. **/
  114475. export class DepthCullingState {
  114476. private _isDepthTestDirty;
  114477. private _isDepthMaskDirty;
  114478. private _isDepthFuncDirty;
  114479. private _isCullFaceDirty;
  114480. private _isCullDirty;
  114481. private _isZOffsetDirty;
  114482. private _isFrontFaceDirty;
  114483. private _depthTest;
  114484. private _depthMask;
  114485. private _depthFunc;
  114486. private _cull;
  114487. private _cullFace;
  114488. private _zOffset;
  114489. private _frontFace;
  114490. /**
  114491. * Initializes the state.
  114492. */
  114493. constructor();
  114494. get isDirty(): boolean;
  114495. get zOffset(): number;
  114496. set zOffset(value: number);
  114497. get cullFace(): Nullable<number>;
  114498. set cullFace(value: Nullable<number>);
  114499. get cull(): Nullable<boolean>;
  114500. set cull(value: Nullable<boolean>);
  114501. get depthFunc(): Nullable<number>;
  114502. set depthFunc(value: Nullable<number>);
  114503. get depthMask(): boolean;
  114504. set depthMask(value: boolean);
  114505. get depthTest(): boolean;
  114506. set depthTest(value: boolean);
  114507. get frontFace(): Nullable<number>;
  114508. set frontFace(value: Nullable<number>);
  114509. reset(): void;
  114510. apply(gl: WebGLRenderingContext): void;
  114511. }
  114512. }
  114513. declare module BABYLON {
  114514. /**
  114515. * @hidden
  114516. **/
  114517. export class StencilState {
  114518. /** 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 */
  114519. static readonly ALWAYS: number;
  114520. /** Passed to stencilOperation to specify that stencil value must be kept */
  114521. static readonly KEEP: number;
  114522. /** Passed to stencilOperation to specify that stencil value must be replaced */
  114523. static readonly REPLACE: number;
  114524. private _isStencilTestDirty;
  114525. private _isStencilMaskDirty;
  114526. private _isStencilFuncDirty;
  114527. private _isStencilOpDirty;
  114528. private _stencilTest;
  114529. private _stencilMask;
  114530. private _stencilFunc;
  114531. private _stencilFuncRef;
  114532. private _stencilFuncMask;
  114533. private _stencilOpStencilFail;
  114534. private _stencilOpDepthFail;
  114535. private _stencilOpStencilDepthPass;
  114536. get isDirty(): boolean;
  114537. get stencilFunc(): number;
  114538. set stencilFunc(value: number);
  114539. get stencilFuncRef(): number;
  114540. set stencilFuncRef(value: number);
  114541. get stencilFuncMask(): number;
  114542. set stencilFuncMask(value: number);
  114543. get stencilOpStencilFail(): number;
  114544. set stencilOpStencilFail(value: number);
  114545. get stencilOpDepthFail(): number;
  114546. set stencilOpDepthFail(value: number);
  114547. get stencilOpStencilDepthPass(): number;
  114548. set stencilOpStencilDepthPass(value: number);
  114549. get stencilMask(): number;
  114550. set stencilMask(value: number);
  114551. get stencilTest(): boolean;
  114552. set stencilTest(value: boolean);
  114553. constructor();
  114554. reset(): void;
  114555. apply(gl: WebGLRenderingContext): void;
  114556. }
  114557. }
  114558. declare module BABYLON {
  114559. /**
  114560. * @hidden
  114561. **/
  114562. export class AlphaState {
  114563. private _isAlphaBlendDirty;
  114564. private _isBlendFunctionParametersDirty;
  114565. private _isBlendEquationParametersDirty;
  114566. private _isBlendConstantsDirty;
  114567. private _alphaBlend;
  114568. private _blendFunctionParameters;
  114569. private _blendEquationParameters;
  114570. private _blendConstants;
  114571. /**
  114572. * Initializes the state.
  114573. */
  114574. constructor();
  114575. get isDirty(): boolean;
  114576. get alphaBlend(): boolean;
  114577. set alphaBlend(value: boolean);
  114578. setAlphaBlendConstants(r: number, g: number, b: number, a: number): void;
  114579. setAlphaBlendFunctionParameters(value0: number, value1: number, value2: number, value3: number): void;
  114580. setAlphaEquationParameters(rgb: number, alpha: number): void;
  114581. reset(): void;
  114582. apply(gl: WebGLRenderingContext): void;
  114583. }
  114584. }
  114585. declare module BABYLON {
  114586. /** @hidden */
  114587. export class WebGL2ShaderProcessor implements IShaderProcessor {
  114588. attributeProcessor(attribute: string): string;
  114589. varyingProcessor(varying: string, isFragment: boolean): string;
  114590. postProcessor(code: string, defines: string[], isFragment: boolean): string;
  114591. }
  114592. }
  114593. declare module BABYLON {
  114594. /**
  114595. * Interface for attribute information associated with buffer instanciation
  114596. */
  114597. export interface InstancingAttributeInfo {
  114598. /**
  114599. * Name of the GLSL attribute
  114600. * if attribute index is not specified, this is used to retrieve the index from the effect
  114601. */
  114602. attributeName: string;
  114603. /**
  114604. * Index/offset of the attribute in the vertex shader
  114605. * if not specified, this will be computes from the name.
  114606. */
  114607. index?: number;
  114608. /**
  114609. * size of the attribute, 1, 2, 3 or 4
  114610. */
  114611. attributeSize: number;
  114612. /**
  114613. * Offset of the data in the Vertex Buffer acting as the instancing buffer
  114614. */
  114615. offset: number;
  114616. /**
  114617. * Modifies the rate at which generic vertex attributes advance when rendering multiple instances
  114618. * default to 1
  114619. */
  114620. divisor?: number;
  114621. /**
  114622. * type of the attribute, gl.BYTE, gl.UNSIGNED_BYTE, gl.SHORT, gl.UNSIGNED_SHORT, gl.FIXED, gl.FLOAT.
  114623. * default is FLOAT
  114624. */
  114625. attributeType?: number;
  114626. /**
  114627. * normalization of fixed-point data. behavior unclear, use FALSE, default is FALSE
  114628. */
  114629. normalized?: boolean;
  114630. }
  114631. }
  114632. declare module BABYLON {
  114633. interface ThinEngine {
  114634. /**
  114635. * Update a video texture
  114636. * @param texture defines the texture to update
  114637. * @param video defines the video element to use
  114638. * @param invertY defines if data must be stored with Y axis inverted
  114639. */
  114640. updateVideoTexture(texture: Nullable<InternalTexture>, video: HTMLVideoElement, invertY: boolean): void;
  114641. }
  114642. }
  114643. declare module BABYLON {
  114644. interface ThinEngine {
  114645. /**
  114646. * Creates a dynamic texture
  114647. * @param width defines the width of the texture
  114648. * @param height defines the height of the texture
  114649. * @param generateMipMaps defines if the engine should generate the mip levels
  114650. * @param samplingMode defines the required sampling mode (Texture.NEAREST_SAMPLINGMODE by default)
  114651. * @returns the dynamic texture inside an InternalTexture
  114652. */
  114653. createDynamicTexture(width: number, height: number, generateMipMaps: boolean, samplingMode: number): InternalTexture;
  114654. /**
  114655. * Update the content of a dynamic texture
  114656. * @param texture defines the texture to update
  114657. * @param canvas defines the canvas containing the source
  114658. * @param invertY defines if data must be stored with Y axis inverted
  114659. * @param premulAlpha defines if alpha is stored as premultiplied
  114660. * @param format defines the format of the data
  114661. * @param forceBindTexture if the texture should be forced to be bound eg. after a graphics context loss (Default: false)
  114662. */
  114663. updateDynamicTexture(texture: Nullable<InternalTexture>, canvas: HTMLCanvasElement | OffscreenCanvas, invertY: boolean, premulAlpha?: boolean, format?: number, forceBindTexture?: boolean): void;
  114664. }
  114665. }
  114666. declare module BABYLON {
  114667. /**
  114668. * Settings for finer control over video usage
  114669. */
  114670. export interface VideoTextureSettings {
  114671. /**
  114672. * Applies `autoplay` to video, if specified
  114673. */
  114674. autoPlay?: boolean;
  114675. /**
  114676. * Applies `loop` to video, if specified
  114677. */
  114678. loop?: boolean;
  114679. /**
  114680. * Automatically updates internal texture from video at every frame in the render loop
  114681. */
  114682. autoUpdateTexture: boolean;
  114683. /**
  114684. * Image src displayed during the video loading or until the user interacts with the video.
  114685. */
  114686. poster?: string;
  114687. }
  114688. /**
  114689. * If you want to display a video in your scene, this is the special texture for that.
  114690. * This special texture works similar to other textures, with the exception of a few parameters.
  114691. * @see https://doc.babylonjs.com/how_to/video_texture
  114692. */
  114693. export class VideoTexture extends Texture {
  114694. /**
  114695. * Tells whether textures will be updated automatically or user is required to call `updateTexture` manually
  114696. */
  114697. readonly autoUpdateTexture: boolean;
  114698. /**
  114699. * The video instance used by the texture internally
  114700. */
  114701. readonly video: HTMLVideoElement;
  114702. private _onUserActionRequestedObservable;
  114703. /**
  114704. * Event triggerd when a dom action is required by the user to play the video.
  114705. * This happens due to recent changes in browser policies preventing video to auto start.
  114706. */
  114707. get onUserActionRequestedObservable(): Observable<Texture>;
  114708. private _generateMipMaps;
  114709. private _stillImageCaptured;
  114710. private _displayingPosterTexture;
  114711. private _settings;
  114712. private _createInternalTextureOnEvent;
  114713. private _frameId;
  114714. private _currentSrc;
  114715. /**
  114716. * Creates a video texture.
  114717. * If you want to display a video in your scene, this is the special texture for that.
  114718. * This special texture works similar to other textures, with the exception of a few parameters.
  114719. * @see https://doc.babylonjs.com/how_to/video_texture
  114720. * @param name optional name, will detect from video source, if not defined
  114721. * @param src can be used to provide an url, array of urls or an already setup HTML video element.
  114722. * @param scene is obviously the current scene.
  114723. * @param generateMipMaps can be used to turn on mipmaps (Can be expensive for videoTextures because they are often updated).
  114724. * @param invertY is false by default but can be used to invert video on Y axis
  114725. * @param samplingMode controls the sampling method and is set to TRILINEAR_SAMPLINGMODE by default
  114726. * @param settings allows finer control over video usage
  114727. */
  114728. constructor(name: Nullable<string>, src: string | string[] | HTMLVideoElement, scene: Nullable<Scene>, generateMipMaps?: boolean, invertY?: boolean, samplingMode?: number, settings?: VideoTextureSettings);
  114729. private _getName;
  114730. private _getVideo;
  114731. private _createInternalTexture;
  114732. private reset;
  114733. /**
  114734. * @hidden Internal method to initiate `update`.
  114735. */
  114736. _rebuild(): void;
  114737. /**
  114738. * Update Texture in the `auto` mode. Does not do anything if `settings.autoUpdateTexture` is false.
  114739. */
  114740. update(): void;
  114741. /**
  114742. * Update Texture in `manual` mode. Does not do anything if not visible or paused.
  114743. * @param isVisible Visibility state, detected by user using `scene.getActiveMeshes()` or othervise.
  114744. */
  114745. updateTexture(isVisible: boolean): void;
  114746. protected _updateInternalTexture: () => void;
  114747. /**
  114748. * Change video content. Changing video instance or setting multiple urls (as in constructor) is not supported.
  114749. * @param url New url.
  114750. */
  114751. updateURL(url: string): void;
  114752. /**
  114753. * Clones the texture.
  114754. * @returns the cloned texture
  114755. */
  114756. clone(): VideoTexture;
  114757. /**
  114758. * Dispose the texture and release its associated resources.
  114759. */
  114760. dispose(): void;
  114761. /**
  114762. * Creates a video texture straight from a stream.
  114763. * @param scene Define the scene the texture should be created in
  114764. * @param stream Define the stream the texture should be created from
  114765. * @returns The created video texture as a promise
  114766. */
  114767. static CreateFromStreamAsync(scene: Scene, stream: MediaStream): Promise<VideoTexture>;
  114768. /**
  114769. * Creates a video texture straight from your WebCam video feed.
  114770. * @param scene Define the scene the texture should be created in
  114771. * @param constraints Define the constraints to use to create the web cam feed from WebRTC
  114772. * @param audioConstaints Define the audio constraints to use to create the web cam feed from WebRTC
  114773. * @returns The created video texture as a promise
  114774. */
  114775. static CreateFromWebCamAsync(scene: Scene, constraints: {
  114776. minWidth: number;
  114777. maxWidth: number;
  114778. minHeight: number;
  114779. maxHeight: number;
  114780. deviceId: string;
  114781. } & MediaTrackConstraints, audioConstaints?: boolean | MediaTrackConstraints): Promise<VideoTexture>;
  114782. /**
  114783. * Creates a video texture straight from your WebCam video feed.
  114784. * @param scene Define the scene the texture should be created in
  114785. * @param onReady Define a callback to triggered once the texture will be ready
  114786. * @param constraints Define the constraints to use to create the web cam feed from WebRTC
  114787. * @param audioConstaints Define the audio constraints to use to create the web cam feed from WebRTC
  114788. */
  114789. static CreateFromWebCam(scene: Scene, onReady: (videoTexture: VideoTexture) => void, constraints: {
  114790. minWidth: number;
  114791. maxWidth: number;
  114792. minHeight: number;
  114793. maxHeight: number;
  114794. deviceId: string;
  114795. } & MediaTrackConstraints, audioConstaints?: boolean | MediaTrackConstraints): void;
  114796. }
  114797. }
  114798. declare module BABYLON {
  114799. /**
  114800. * Defines the interface used by objects working like Scene
  114801. * @hidden
  114802. */
  114803. export interface ISceneLike {
  114804. _addPendingData(data: any): void;
  114805. _removePendingData(data: any): void;
  114806. offlineProvider: IOfflineProvider;
  114807. }
  114808. /**
  114809. * Information about the current host
  114810. */
  114811. export interface HostInformation {
  114812. /**
  114813. * Defines if the current host is a mobile
  114814. */
  114815. isMobile: boolean;
  114816. }
  114817. /** Interface defining initialization parameters for Engine class */
  114818. export interface EngineOptions extends WebGLContextAttributes {
  114819. /**
  114820. * Defines if the engine should no exceed a specified device ratio
  114821. * @see https://developer.mozilla.org/en-US/docs/Web/API/Window/devicePixelRatio
  114822. */
  114823. limitDeviceRatio?: number;
  114824. /**
  114825. * Defines if webvr should be enabled automatically
  114826. * @see https://doc.babylonjs.com/how_to/webvr_camera
  114827. */
  114828. autoEnableWebVR?: boolean;
  114829. /**
  114830. * Defines if webgl2 should be turned off even if supported
  114831. * @see https://doc.babylonjs.com/features/webgl2
  114832. */
  114833. disableWebGL2Support?: boolean;
  114834. /**
  114835. * Defines if webaudio should be initialized as well
  114836. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music
  114837. */
  114838. audioEngine?: boolean;
  114839. /**
  114840. * Defines if animations should run using a deterministic lock step
  114841. * @see https://doc.babylonjs.com/babylon101/animations#deterministic-lockstep
  114842. */
  114843. deterministicLockstep?: boolean;
  114844. /** Defines the maximum steps to use with deterministic lock step mode */
  114845. lockstepMaxSteps?: number;
  114846. /** Defines the seconds between each deterministic lock step */
  114847. timeStep?: number;
  114848. /**
  114849. * Defines that engine should ignore context lost events
  114850. * If this event happens when this parameter is true, you will have to reload the page to restore rendering
  114851. */
  114852. doNotHandleContextLost?: boolean;
  114853. /**
  114854. * Defines that engine should ignore modifying touch action attribute and style
  114855. * If not handle, you might need to set it up on your side for expected touch devices behavior.
  114856. */
  114857. doNotHandleTouchAction?: boolean;
  114858. /**
  114859. * Defines that engine should compile shaders with high precision floats (if supported). True by default
  114860. */
  114861. useHighPrecisionFloats?: boolean;
  114862. /**
  114863. * Make the canvas XR Compatible for XR sessions
  114864. */
  114865. xrCompatible?: boolean;
  114866. /**
  114867. * Make the matrix computations to be performed in 64 bits instead of 32 bits. False by default
  114868. */
  114869. useHighPrecisionMatrix?: boolean;
  114870. }
  114871. /**
  114872. * The base engine class (root of all engines)
  114873. */
  114874. export class ThinEngine {
  114875. /** Use this array to turn off some WebGL2 features on known buggy browsers version */
  114876. static ExceptionList: ({
  114877. key: string;
  114878. capture: string;
  114879. captureConstraint: number;
  114880. targets: string[];
  114881. } | {
  114882. key: string;
  114883. capture: null;
  114884. captureConstraint: null;
  114885. targets: string[];
  114886. })[];
  114887. /** @hidden */
  114888. static _TextureLoaders: IInternalTextureLoader[];
  114889. /**
  114890. * Returns the current npm package of the sdk
  114891. */
  114892. static get NpmPackage(): string;
  114893. /**
  114894. * Returns the current version of the framework
  114895. */
  114896. static get Version(): string;
  114897. /**
  114898. * Returns a string describing the current engine
  114899. */
  114900. get description(): string;
  114901. /**
  114902. * Gets or sets the epsilon value used by collision engine
  114903. */
  114904. static CollisionsEpsilon: number;
  114905. /**
  114906. * Gets or sets the relative url used to load shaders if using the engine in non-minified mode
  114907. */
  114908. static get ShadersRepository(): string;
  114909. static set ShadersRepository(value: string);
  114910. /** @hidden */
  114911. _shaderProcessor: IShaderProcessor;
  114912. /**
  114913. * Gets or sets a boolean that indicates if textures must be forced to power of 2 size even if not required
  114914. */
  114915. forcePOTTextures: boolean;
  114916. /**
  114917. * Gets a boolean indicating if the engine is currently rendering in fullscreen mode
  114918. */
  114919. isFullscreen: boolean;
  114920. /**
  114921. * Gets or sets a boolean indicating if back faces must be culled (true by default)
  114922. */
  114923. cullBackFaces: boolean;
  114924. /**
  114925. * Gets or sets a boolean indicating if the engine must keep rendering even if the window is not in foregroun
  114926. */
  114927. renderEvenInBackground: boolean;
  114928. /**
  114929. * Gets or sets a boolean indicating that cache can be kept between frames
  114930. */
  114931. preventCacheWipeBetweenFrames: boolean;
  114932. /** Gets or sets a boolean indicating if the engine should validate programs after compilation */
  114933. validateShaderPrograms: boolean;
  114934. /**
  114935. * Gets or sets a boolean indicating if depth buffer should be reverse, going from far to near.
  114936. * This can provide greater z depth for distant objects.
  114937. */
  114938. useReverseDepthBuffer: boolean;
  114939. /**
  114940. * Gets or sets a boolean indicating that uniform buffers must be disabled even if they are supported
  114941. */
  114942. disableUniformBuffers: boolean;
  114943. /** @hidden */
  114944. _uniformBuffers: UniformBuffer[];
  114945. /**
  114946. * Gets a boolean indicating that the engine supports uniform buffers
  114947. * @see https://doc.babylonjs.com/features/webgl2#uniform-buffer-objets
  114948. */
  114949. get supportsUniformBuffers(): boolean;
  114950. /** @hidden */
  114951. _gl: WebGLRenderingContext;
  114952. /** @hidden */
  114953. _webGLVersion: number;
  114954. protected _renderingCanvas: Nullable<HTMLCanvasElement>;
  114955. protected _windowIsBackground: boolean;
  114956. protected _creationOptions: EngineOptions;
  114957. protected _highPrecisionShadersAllowed: boolean;
  114958. /** @hidden */
  114959. get _shouldUseHighPrecisionShader(): boolean;
  114960. /**
  114961. * Gets a boolean indicating that only power of 2 textures are supported
  114962. * Please note that you can still use non power of 2 textures but in this case the engine will forcefully convert them
  114963. */
  114964. get needPOTTextures(): boolean;
  114965. /** @hidden */
  114966. _badOS: boolean;
  114967. /** @hidden */
  114968. _badDesktopOS: boolean;
  114969. private _hardwareScalingLevel;
  114970. /** @hidden */
  114971. _caps: EngineCapabilities;
  114972. private _isStencilEnable;
  114973. private _glVersion;
  114974. private _glRenderer;
  114975. private _glVendor;
  114976. /** @hidden */
  114977. _videoTextureSupported: boolean;
  114978. protected _renderingQueueLaunched: boolean;
  114979. protected _activeRenderLoops: (() => void)[];
  114980. /**
  114981. * Observable signaled when a context lost event is raised
  114982. */
  114983. onContextLostObservable: Observable<ThinEngine>;
  114984. /**
  114985. * Observable signaled when a context restored event is raised
  114986. */
  114987. onContextRestoredObservable: Observable<ThinEngine>;
  114988. private _onContextLost;
  114989. private _onContextRestored;
  114990. protected _contextWasLost: boolean;
  114991. /** @hidden */
  114992. _doNotHandleContextLost: boolean;
  114993. /**
  114994. * Gets or sets a boolean indicating if resources should be retained to be able to handle context lost events
  114995. * @see https://doc.babylonjs.com/how_to/optimizing_your_scene#handling-webgl-context-lost
  114996. */
  114997. get doNotHandleContextLost(): boolean;
  114998. set doNotHandleContextLost(value: boolean);
  114999. /**
  115000. * Gets or sets a boolean indicating that vertex array object must be disabled even if they are supported
  115001. */
  115002. disableVertexArrayObjects: boolean;
  115003. /** @hidden */
  115004. protected _colorWrite: boolean;
  115005. /** @hidden */
  115006. protected _colorWriteChanged: boolean;
  115007. /** @hidden */
  115008. protected _depthCullingState: DepthCullingState;
  115009. /** @hidden */
  115010. protected _stencilState: StencilState;
  115011. /** @hidden */
  115012. _alphaState: AlphaState;
  115013. /** @hidden */
  115014. _alphaMode: number;
  115015. /** @hidden */
  115016. _alphaEquation: number;
  115017. /** @hidden */
  115018. _internalTexturesCache: InternalTexture[];
  115019. /** @hidden */
  115020. protected _activeChannel: number;
  115021. private _currentTextureChannel;
  115022. /** @hidden */
  115023. protected _boundTexturesCache: {
  115024. [key: string]: Nullable<InternalTexture>;
  115025. };
  115026. /** @hidden */
  115027. protected _currentEffect: Nullable<Effect>;
  115028. /** @hidden */
  115029. protected _currentProgram: Nullable<WebGLProgram>;
  115030. private _compiledEffects;
  115031. private _vertexAttribArraysEnabled;
  115032. /** @hidden */
  115033. protected _cachedViewport: Nullable<IViewportLike>;
  115034. private _cachedVertexArrayObject;
  115035. /** @hidden */
  115036. protected _cachedVertexBuffers: any;
  115037. /** @hidden */
  115038. protected _cachedIndexBuffer: Nullable<DataBuffer>;
  115039. /** @hidden */
  115040. protected _cachedEffectForVertexBuffers: Nullable<Effect>;
  115041. /** @hidden */
  115042. _currentRenderTarget: Nullable<InternalTexture>;
  115043. private _uintIndicesCurrentlySet;
  115044. protected _currentBoundBuffer: Nullable<WebGLBuffer>[];
  115045. /** @hidden */
  115046. _currentFramebuffer: Nullable<WebGLFramebuffer>;
  115047. /** @hidden */
  115048. _dummyFramebuffer: Nullable<WebGLFramebuffer>;
  115049. private _currentBufferPointers;
  115050. private _currentInstanceLocations;
  115051. private _currentInstanceBuffers;
  115052. private _textureUnits;
  115053. /** @hidden */
  115054. _workingCanvas: Nullable<HTMLCanvasElement | OffscreenCanvas>;
  115055. /** @hidden */
  115056. _workingContext: Nullable<CanvasRenderingContext2D | OffscreenCanvasRenderingContext2D>;
  115057. /** @hidden */
  115058. _boundRenderFunction: any;
  115059. private _vaoRecordInProgress;
  115060. private _mustWipeVertexAttributes;
  115061. private _emptyTexture;
  115062. private _emptyCubeTexture;
  115063. private _emptyTexture3D;
  115064. private _emptyTexture2DArray;
  115065. /** @hidden */
  115066. _frameHandler: number;
  115067. private _nextFreeTextureSlots;
  115068. private _maxSimultaneousTextures;
  115069. private _activeRequests;
  115070. /** @hidden */
  115071. _transformTextureUrl: Nullable<(url: string) => string>;
  115072. /**
  115073. * Gets information about the current host
  115074. */
  115075. hostInformation: HostInformation;
  115076. protected get _supportsHardwareTextureRescaling(): boolean;
  115077. private _framebufferDimensionsObject;
  115078. /**
  115079. * sets the object from which width and height will be taken from when getting render width and height
  115080. * Will fallback to the gl object
  115081. * @param dimensions the framebuffer width and height that will be used.
  115082. */
  115083. set framebufferDimensionsObject(dimensions: Nullable<{
  115084. framebufferWidth: number;
  115085. framebufferHeight: number;
  115086. }>);
  115087. /**
  115088. * Gets the current viewport
  115089. */
  115090. get currentViewport(): Nullable<IViewportLike>;
  115091. /**
  115092. * Gets the default empty texture
  115093. */
  115094. get emptyTexture(): InternalTexture;
  115095. /**
  115096. * Gets the default empty 3D texture
  115097. */
  115098. get emptyTexture3D(): InternalTexture;
  115099. /**
  115100. * Gets the default empty 2D array texture
  115101. */
  115102. get emptyTexture2DArray(): InternalTexture;
  115103. /**
  115104. * Gets the default empty cube texture
  115105. */
  115106. get emptyCubeTexture(): InternalTexture;
  115107. /**
  115108. * Defines whether the engine has been created with the premultipliedAlpha option on or not.
  115109. */
  115110. readonly premultipliedAlpha: boolean;
  115111. /**
  115112. * Observable event triggered before each texture is initialized
  115113. */
  115114. onBeforeTextureInitObservable: Observable<Texture>;
  115115. /**
  115116. * Creates a new engine
  115117. * @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
  115118. * @param antialias defines enable antialiasing (default: false)
  115119. * @param options defines further options to be sent to the getContext() function
  115120. * @param adaptToDeviceRatio defines whether to adapt to the device's viewport characteristics (default: false)
  115121. */
  115122. constructor(canvasOrContext: Nullable<HTMLCanvasElement | WebGLRenderingContext | WebGL2RenderingContext>, antialias?: boolean, options?: EngineOptions, adaptToDeviceRatio?: boolean);
  115123. private _rebuildInternalTextures;
  115124. private _rebuildEffects;
  115125. /**
  115126. * Gets a boolean indicating if all created effects are ready
  115127. * @returns true if all effects are ready
  115128. */
  115129. areAllEffectsReady(): boolean;
  115130. protected _rebuildBuffers(): void;
  115131. protected _initGLContext(): void;
  115132. /**
  115133. * Gets version of the current webGL context
  115134. */
  115135. get webGLVersion(): number;
  115136. /**
  115137. * Gets a string identifying the name of the class
  115138. * @returns "Engine" string
  115139. */
  115140. getClassName(): string;
  115141. /**
  115142. * Returns true if the stencil buffer has been enabled through the creation option of the context.
  115143. */
  115144. get isStencilEnable(): boolean;
  115145. /** @hidden */
  115146. _prepareWorkingCanvas(): void;
  115147. /**
  115148. * Reset the texture cache to empty state
  115149. */
  115150. resetTextureCache(): void;
  115151. /**
  115152. * Gets an object containing information about the current webGL context
  115153. * @returns an object containing the vender, the renderer and the version of the current webGL context
  115154. */
  115155. getGlInfo(): {
  115156. vendor: string;
  115157. renderer: string;
  115158. version: string;
  115159. };
  115160. /**
  115161. * Defines the hardware scaling level.
  115162. * By default the hardware scaling level is computed from the window device ratio.
  115163. * 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.
  115164. * @param level defines the level to use
  115165. */
  115166. setHardwareScalingLevel(level: number): void;
  115167. /**
  115168. * Gets the current hardware scaling level.
  115169. * By default the hardware scaling level is computed from the window device ratio.
  115170. * 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.
  115171. * @returns a number indicating the current hardware scaling level
  115172. */
  115173. getHardwareScalingLevel(): number;
  115174. /**
  115175. * Gets the list of loaded textures
  115176. * @returns an array containing all loaded textures
  115177. */
  115178. getLoadedTexturesCache(): InternalTexture[];
  115179. /**
  115180. * Gets the object containing all engine capabilities
  115181. * @returns the EngineCapabilities object
  115182. */
  115183. getCaps(): EngineCapabilities;
  115184. /**
  115185. * stop executing a render loop function and remove it from the execution array
  115186. * @param renderFunction defines the function to be removed. If not provided all functions will be removed.
  115187. */
  115188. stopRenderLoop(renderFunction?: () => void): void;
  115189. /** @hidden */
  115190. _renderLoop(): void;
  115191. /**
  115192. * Gets the HTML canvas attached with the current webGL context
  115193. * @returns a HTML canvas
  115194. */
  115195. getRenderingCanvas(): Nullable<HTMLCanvasElement>;
  115196. /**
  115197. * Gets host window
  115198. * @returns the host window object
  115199. */
  115200. getHostWindow(): Nullable<Window>;
  115201. /**
  115202. * Gets the current render width
  115203. * @param useScreen defines if screen size must be used (or the current render target if any)
  115204. * @returns a number defining the current render width
  115205. */
  115206. getRenderWidth(useScreen?: boolean): number;
  115207. /**
  115208. * Gets the current render height
  115209. * @param useScreen defines if screen size must be used (or the current render target if any)
  115210. * @returns a number defining the current render height
  115211. */
  115212. getRenderHeight(useScreen?: boolean): number;
  115213. /**
  115214. * Can be used to override the current requestAnimationFrame requester.
  115215. * @hidden
  115216. */
  115217. protected _queueNewFrame(bindedRenderFunction: any, requester?: any): number;
  115218. /**
  115219. * Register and execute a render loop. The engine can have more than one render function
  115220. * @param renderFunction defines the function to continuously execute
  115221. */
  115222. runRenderLoop(renderFunction: () => void): void;
  115223. /**
  115224. * Clear the current render buffer or the current render target (if any is set up)
  115225. * @param color defines the color to use
  115226. * @param backBuffer defines if the back buffer must be cleared
  115227. * @param depth defines if the depth buffer must be cleared
  115228. * @param stencil defines if the stencil buffer must be cleared
  115229. */
  115230. clear(color: Nullable<IColor4Like>, backBuffer: boolean, depth: boolean, stencil?: boolean): void;
  115231. private _viewportCached;
  115232. /** @hidden */
  115233. _viewport(x: number, y: number, width: number, height: number): void;
  115234. /**
  115235. * Set the WebGL's viewport
  115236. * @param viewport defines the viewport element to be used
  115237. * @param requiredWidth defines the width required for rendering. If not provided the rendering canvas' width is used
  115238. * @param requiredHeight defines the height required for rendering. If not provided the rendering canvas' height is used
  115239. */
  115240. setViewport(viewport: IViewportLike, requiredWidth?: number, requiredHeight?: number): void;
  115241. /**
  115242. * Begin a new frame
  115243. */
  115244. beginFrame(): void;
  115245. /**
  115246. * Enf the current frame
  115247. */
  115248. endFrame(): void;
  115249. /**
  115250. * Resize the view according to the canvas' size
  115251. */
  115252. resize(): void;
  115253. /**
  115254. * Force a specific size of the canvas
  115255. * @param width defines the new canvas' width
  115256. * @param height defines the new canvas' height
  115257. * @returns true if the size was changed
  115258. */
  115259. setSize(width: number, height: number): boolean;
  115260. /**
  115261. * Binds the frame buffer to the specified texture.
  115262. * @param texture The texture to render to or null for the default canvas
  115263. * @param faceIndex The face of the texture to render to in case of cube texture
  115264. * @param requiredWidth The width of the target to render to
  115265. * @param requiredHeight The height of the target to render to
  115266. * @param forceFullscreenViewport Forces the viewport to be the entire texture/screen if true
  115267. * @param lodLevel defines the lod level to bind to the frame buffer
  115268. * @param layer defines the 2d array index to bind to frame buffer to
  115269. */
  115270. bindFramebuffer(texture: InternalTexture, faceIndex?: number, requiredWidth?: number, requiredHeight?: number, forceFullscreenViewport?: boolean, lodLevel?: number, layer?: number): void;
  115271. /** @hidden */
  115272. _bindUnboundFramebuffer(framebuffer: Nullable<WebGLFramebuffer>): void;
  115273. /**
  115274. * Unbind the current render target texture from the webGL context
  115275. * @param texture defines the render target texture to unbind
  115276. * @param disableGenerateMipMaps defines a boolean indicating that mipmaps must not be generated
  115277. * @param onBeforeUnbind defines a function which will be called before the effective unbind
  115278. */
  115279. unBindFramebuffer(texture: InternalTexture, disableGenerateMipMaps?: boolean, onBeforeUnbind?: () => void): void;
  115280. /**
  115281. * Force a webGL flush (ie. a flush of all waiting webGL commands)
  115282. */
  115283. flushFramebuffer(): void;
  115284. /**
  115285. * Unbind the current render target and bind the default framebuffer
  115286. */
  115287. restoreDefaultFramebuffer(): void;
  115288. /** @hidden */
  115289. protected _resetVertexBufferBinding(): void;
  115290. /**
  115291. * Creates a vertex buffer
  115292. * @param data the data for the vertex buffer
  115293. * @returns the new WebGL static buffer
  115294. */
  115295. createVertexBuffer(data: DataArray): DataBuffer;
  115296. private _createVertexBuffer;
  115297. /**
  115298. * Creates a dynamic vertex buffer
  115299. * @param data the data for the dynamic vertex buffer
  115300. * @returns the new WebGL dynamic buffer
  115301. */
  115302. createDynamicVertexBuffer(data: DataArray): DataBuffer;
  115303. protected _resetIndexBufferBinding(): void;
  115304. /**
  115305. * Creates a new index buffer
  115306. * @param indices defines the content of the index buffer
  115307. * @param updatable defines if the index buffer must be updatable
  115308. * @returns a new webGL buffer
  115309. */
  115310. createIndexBuffer(indices: IndicesArray, updatable?: boolean): DataBuffer;
  115311. protected _normalizeIndexData(indices: IndicesArray): Uint16Array | Uint32Array;
  115312. /**
  115313. * Bind a webGL buffer to the webGL context
  115314. * @param buffer defines the buffer to bind
  115315. */
  115316. bindArrayBuffer(buffer: Nullable<DataBuffer>): void;
  115317. protected bindIndexBuffer(buffer: Nullable<DataBuffer>): void;
  115318. private bindBuffer;
  115319. /**
  115320. * update the bound buffer with the given data
  115321. * @param data defines the data to update
  115322. */
  115323. updateArrayBuffer(data: Float32Array): void;
  115324. private _vertexAttribPointer;
  115325. /** @hidden */
  115326. _bindIndexBufferWithCache(indexBuffer: Nullable<DataBuffer>): void;
  115327. private _bindVertexBuffersAttributes;
  115328. /**
  115329. * Records a vertex array object
  115330. * @see https://doc.babylonjs.com/features/webgl2#vertex-array-objects
  115331. * @param vertexBuffers defines the list of vertex buffers to store
  115332. * @param indexBuffer defines the index buffer to store
  115333. * @param effect defines the effect to store
  115334. * @returns the new vertex array object
  115335. */
  115336. recordVertexArrayObject(vertexBuffers: {
  115337. [key: string]: VertexBuffer;
  115338. }, indexBuffer: Nullable<DataBuffer>, effect: Effect): WebGLVertexArrayObject;
  115339. /**
  115340. * Bind a specific vertex array object
  115341. * @see https://doc.babylonjs.com/features/webgl2#vertex-array-objects
  115342. * @param vertexArrayObject defines the vertex array object to bind
  115343. * @param indexBuffer defines the index buffer to bind
  115344. */
  115345. bindVertexArrayObject(vertexArrayObject: WebGLVertexArrayObject, indexBuffer: Nullable<DataBuffer>): void;
  115346. /**
  115347. * Bind webGl buffers directly to the webGL context
  115348. * @param vertexBuffer defines the vertex buffer to bind
  115349. * @param indexBuffer defines the index buffer to bind
  115350. * @param vertexDeclaration defines the vertex declaration to use with the vertex buffer
  115351. * @param vertexStrideSize defines the vertex stride of the vertex buffer
  115352. * @param effect defines the effect associated with the vertex buffer
  115353. */
  115354. bindBuffersDirectly(vertexBuffer: DataBuffer, indexBuffer: DataBuffer, vertexDeclaration: number[], vertexStrideSize: number, effect: Effect): void;
  115355. private _unbindVertexArrayObject;
  115356. /**
  115357. * Bind a list of vertex buffers to the webGL context
  115358. * @param vertexBuffers defines the list of vertex buffers to bind
  115359. * @param indexBuffer defines the index buffer to bind
  115360. * @param effect defines the effect associated with the vertex buffers
  115361. */
  115362. bindBuffers(vertexBuffers: {
  115363. [key: string]: Nullable<VertexBuffer>;
  115364. }, indexBuffer: Nullable<DataBuffer>, effect: Effect): void;
  115365. /**
  115366. * Unbind all instance attributes
  115367. */
  115368. unbindInstanceAttributes(): void;
  115369. /**
  115370. * Release and free the memory of a vertex array object
  115371. * @param vao defines the vertex array object to delete
  115372. */
  115373. releaseVertexArrayObject(vao: WebGLVertexArrayObject): void;
  115374. /** @hidden */
  115375. _releaseBuffer(buffer: DataBuffer): boolean;
  115376. protected _deleteBuffer(buffer: DataBuffer): void;
  115377. /**
  115378. * Update the content of a webGL buffer used with instanciation and bind it to the webGL context
  115379. * @param instancesBuffer defines the webGL buffer to update and bind
  115380. * @param data defines the data to store in the buffer
  115381. * @param offsetLocations defines the offsets or attributes information used to determine where data must be stored in the buffer
  115382. */
  115383. updateAndBindInstancesBuffer(instancesBuffer: DataBuffer, data: Float32Array, offsetLocations: number[] | InstancingAttributeInfo[]): void;
  115384. /**
  115385. * Bind the content of a webGL buffer used with instantiation
  115386. * @param instancesBuffer defines the webGL buffer to bind
  115387. * @param attributesInfo defines the offsets or attributes information used to determine where data must be stored in the buffer
  115388. * @param computeStride defines Whether to compute the strides from the info or use the default 0
  115389. */
  115390. bindInstancesBuffer(instancesBuffer: DataBuffer, attributesInfo: InstancingAttributeInfo[], computeStride?: boolean): void;
  115391. /**
  115392. * Disable the instance attribute corresponding to the name in parameter
  115393. * @param name defines the name of the attribute to disable
  115394. */
  115395. disableInstanceAttributeByName(name: string): void;
  115396. /**
  115397. * Disable the instance attribute corresponding to the location in parameter
  115398. * @param attributeLocation defines the attribute location of the attribute to disable
  115399. */
  115400. disableInstanceAttribute(attributeLocation: number): void;
  115401. /**
  115402. * Disable the attribute corresponding to the location in parameter
  115403. * @param attributeLocation defines the attribute location of the attribute to disable
  115404. */
  115405. disableAttributeByIndex(attributeLocation: number): void;
  115406. /**
  115407. * Send a draw order
  115408. * @param useTriangles defines if triangles must be used to draw (else wireframe will be used)
  115409. * @param indexStart defines the starting index
  115410. * @param indexCount defines the number of index to draw
  115411. * @param instancesCount defines the number of instances to draw (if instanciation is enabled)
  115412. */
  115413. draw(useTriangles: boolean, indexStart: number, indexCount: number, instancesCount?: number): void;
  115414. /**
  115415. * Draw a list of points
  115416. * @param verticesStart defines the index of first vertex to draw
  115417. * @param verticesCount defines the count of vertices to draw
  115418. * @param instancesCount defines the number of instances to draw (if instanciation is enabled)
  115419. */
  115420. drawPointClouds(verticesStart: number, verticesCount: number, instancesCount?: number): void;
  115421. /**
  115422. * Draw a list of unindexed primitives
  115423. * @param useTriangles defines if triangles must be used to draw (else wireframe will be used)
  115424. * @param verticesStart defines the index of first vertex to draw
  115425. * @param verticesCount defines the count of vertices to draw
  115426. * @param instancesCount defines the number of instances to draw (if instanciation is enabled)
  115427. */
  115428. drawUnIndexed(useTriangles: boolean, verticesStart: number, verticesCount: number, instancesCount?: number): void;
  115429. /**
  115430. * Draw a list of indexed primitives
  115431. * @param fillMode defines the primitive to use
  115432. * @param indexStart defines the starting index
  115433. * @param indexCount defines the number of index to draw
  115434. * @param instancesCount defines the number of instances to draw (if instanciation is enabled)
  115435. */
  115436. drawElementsType(fillMode: number, indexStart: number, indexCount: number, instancesCount?: number): void;
  115437. /**
  115438. * Draw a list of unindexed primitives
  115439. * @param fillMode defines the primitive to use
  115440. * @param verticesStart defines the index of first vertex to draw
  115441. * @param verticesCount defines the count of vertices to draw
  115442. * @param instancesCount defines the number of instances to draw (if instanciation is enabled)
  115443. */
  115444. drawArraysType(fillMode: number, verticesStart: number, verticesCount: number, instancesCount?: number): void;
  115445. private _drawMode;
  115446. /** @hidden */
  115447. protected _reportDrawCall(): void;
  115448. /** @hidden */
  115449. _releaseEffect(effect: Effect): void;
  115450. /** @hidden */
  115451. _deletePipelineContext(pipelineContext: IPipelineContext): void;
  115452. /**
  115453. * Create a new effect (used to store vertex/fragment shaders)
  115454. * @param baseName defines the base name of the effect (The name of file without .fragment.fx or .vertex.fx)
  115455. * @param attributesNamesOrOptions defines either a list of attribute names or an IEffectCreationOptions object
  115456. * @param uniformsNamesOrEngine defines either a list of uniform names or the engine to use
  115457. * @param samplers defines an array of string used to represent textures
  115458. * @param defines defines the string containing the defines to use to compile the shaders
  115459. * @param fallbacks defines the list of potential fallbacks to use if shader conmpilation fails
  115460. * @param onCompiled defines a function to call when the effect creation is successful
  115461. * @param onError defines a function to call when the effect creation has failed
  115462. * @param indexParameters defines an object containing the index values to use to compile shaders (like the maximum number of simultaneous lights)
  115463. * @returns the new Effect
  115464. */
  115465. 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;
  115466. protected static _ConcatenateShader(source: string, defines: Nullable<string>, shaderVersion?: string): string;
  115467. private _compileShader;
  115468. private _compileRawShader;
  115469. /** @hidden */
  115470. _getShaderSource(shader: WebGLShader): Nullable<string>;
  115471. /**
  115472. * Directly creates a webGL program
  115473. * @param pipelineContext defines the pipeline context to attach to
  115474. * @param vertexCode defines the vertex shader code to use
  115475. * @param fragmentCode defines the fragment shader code to use
  115476. * @param context defines the webGL context to use (if not set, the current one will be used)
  115477. * @param transformFeedbackVaryings defines the list of transform feedback varyings to use
  115478. * @returns the new webGL program
  115479. */
  115480. createRawShaderProgram(pipelineContext: IPipelineContext, vertexCode: string, fragmentCode: string, context?: WebGLRenderingContext, transformFeedbackVaryings?: Nullable<string[]>): WebGLProgram;
  115481. /**
  115482. * Creates a webGL program
  115483. * @param pipelineContext defines the pipeline context to attach to
  115484. * @param vertexCode defines the vertex shader code to use
  115485. * @param fragmentCode defines the fragment shader code to use
  115486. * @param defines defines the string containing the defines to use to compile the shaders
  115487. * @param context defines the webGL context to use (if not set, the current one will be used)
  115488. * @param transformFeedbackVaryings defines the list of transform feedback varyings to use
  115489. * @returns the new webGL program
  115490. */
  115491. createShaderProgram(pipelineContext: IPipelineContext, vertexCode: string, fragmentCode: string, defines: Nullable<string>, context?: WebGLRenderingContext, transformFeedbackVaryings?: Nullable<string[]>): WebGLProgram;
  115492. /**
  115493. * Creates a new pipeline context
  115494. * @returns the new pipeline
  115495. */
  115496. createPipelineContext(): IPipelineContext;
  115497. protected _createShaderProgram(pipelineContext: WebGLPipelineContext, vertexShader: WebGLShader, fragmentShader: WebGLShader, context: WebGLRenderingContext, transformFeedbackVaryings?: Nullable<string[]>): WebGLProgram;
  115498. protected _finalizePipelineContext(pipelineContext: WebGLPipelineContext): void;
  115499. /** @hidden */
  115500. _preparePipelineContext(pipelineContext: IPipelineContext, vertexSourceCode: string, fragmentSourceCode: string, createAsRaw: boolean, rebuildRebind: any, defines: Nullable<string>, transformFeedbackVaryings: Nullable<string[]>): void;
  115501. /** @hidden */
  115502. _isRenderingStateCompiled(pipelineContext: IPipelineContext): boolean;
  115503. /** @hidden */
  115504. _executeWhenRenderingStateIsCompiled(pipelineContext: IPipelineContext, action: () => void): void;
  115505. /**
  115506. * Gets the list of webGL uniform locations associated with a specific program based on a list of uniform names
  115507. * @param pipelineContext defines the pipeline context to use
  115508. * @param uniformsNames defines the list of uniform names
  115509. * @returns an array of webGL uniform locations
  115510. */
  115511. getUniforms(pipelineContext: IPipelineContext, uniformsNames: string[]): Nullable<WebGLUniformLocation>[];
  115512. /**
  115513. * Gets the lsit of active attributes for a given webGL program
  115514. * @param pipelineContext defines the pipeline context to use
  115515. * @param attributesNames defines the list of attribute names to get
  115516. * @returns an array of indices indicating the offset of each attribute
  115517. */
  115518. getAttributes(pipelineContext: IPipelineContext, attributesNames: string[]): number[];
  115519. /**
  115520. * Activates an effect, mkaing it the current one (ie. the one used for rendering)
  115521. * @param effect defines the effect to activate
  115522. */
  115523. enableEffect(effect: Nullable<Effect>): void;
  115524. /**
  115525. * Set the value of an uniform to a number (int)
  115526. * @param uniform defines the webGL uniform location where to store the value
  115527. * @param value defines the int number to store
  115528. */
  115529. setInt(uniform: Nullable<WebGLUniformLocation>, value: number): void;
  115530. /**
  115531. * Set the value of an uniform to an array of int32
  115532. * @param uniform defines the webGL uniform location where to store the value
  115533. * @param array defines the array of int32 to store
  115534. */
  115535. setIntArray(uniform: Nullable<WebGLUniformLocation>, array: Int32Array): void;
  115536. /**
  115537. * Set the value of an uniform to an array of int32 (stored as vec2)
  115538. * @param uniform defines the webGL uniform location where to store the value
  115539. * @param array defines the array of int32 to store
  115540. */
  115541. setIntArray2(uniform: Nullable<WebGLUniformLocation>, array: Int32Array): void;
  115542. /**
  115543. * Set the value of an uniform to an array of int32 (stored as vec3)
  115544. * @param uniform defines the webGL uniform location where to store the value
  115545. * @param array defines the array of int32 to store
  115546. */
  115547. setIntArray3(uniform: Nullable<WebGLUniformLocation>, array: Int32Array): void;
  115548. /**
  115549. * Set the value of an uniform to an array of int32 (stored as vec4)
  115550. * @param uniform defines the webGL uniform location where to store the value
  115551. * @param array defines the array of int32 to store
  115552. */
  115553. setIntArray4(uniform: Nullable<WebGLUniformLocation>, array: Int32Array): void;
  115554. /**
  115555. * Set the value of an uniform to an array of number
  115556. * @param uniform defines the webGL uniform location where to store the value
  115557. * @param array defines the array of number to store
  115558. */
  115559. setArray(uniform: Nullable<WebGLUniformLocation>, array: number[] | Float32Array): void;
  115560. /**
  115561. * Set the value of an uniform to an array of number (stored as vec2)
  115562. * @param uniform defines the webGL uniform location where to store the value
  115563. * @param array defines the array of number to store
  115564. */
  115565. setArray2(uniform: Nullable<WebGLUniformLocation>, array: number[] | Float32Array): void;
  115566. /**
  115567. * Set the value of an uniform to an array of number (stored as vec3)
  115568. * @param uniform defines the webGL uniform location where to store the value
  115569. * @param array defines the array of number to store
  115570. */
  115571. setArray3(uniform: Nullable<WebGLUniformLocation>, array: number[] | Float32Array): void;
  115572. /**
  115573. * Set the value of an uniform to an array of number (stored as vec4)
  115574. * @param uniform defines the webGL uniform location where to store the value
  115575. * @param array defines the array of number to store
  115576. */
  115577. setArray4(uniform: Nullable<WebGLUniformLocation>, array: number[] | Float32Array): void;
  115578. /**
  115579. * Set the value of an uniform to an array of float32 (stored as matrices)
  115580. * @param uniform defines the webGL uniform location where to store the value
  115581. * @param matrices defines the array of float32 to store
  115582. */
  115583. setMatrices(uniform: Nullable<WebGLUniformLocation>, matrices: Float32Array): void;
  115584. /**
  115585. * Set the value of an uniform to a matrix (3x3)
  115586. * @param uniform defines the webGL uniform location where to store the value
  115587. * @param matrix defines the Float32Array representing the 3x3 matrix to store
  115588. */
  115589. setMatrix3x3(uniform: Nullable<WebGLUniformLocation>, matrix: Float32Array): void;
  115590. /**
  115591. * Set the value of an uniform to a matrix (2x2)
  115592. * @param uniform defines the webGL uniform location where to store the value
  115593. * @param matrix defines the Float32Array representing the 2x2 matrix to store
  115594. */
  115595. setMatrix2x2(uniform: Nullable<WebGLUniformLocation>, matrix: Float32Array): void;
  115596. /**
  115597. * Set the value of an uniform to a number (float)
  115598. * @param uniform defines the webGL uniform location where to store the value
  115599. * @param value defines the float number to store
  115600. */
  115601. setFloat(uniform: Nullable<WebGLUniformLocation>, value: number): void;
  115602. /**
  115603. * Set the value of an uniform to a vec2
  115604. * @param uniform defines the webGL uniform location where to store the value
  115605. * @param x defines the 1st component of the value
  115606. * @param y defines the 2nd component of the value
  115607. */
  115608. setFloat2(uniform: Nullable<WebGLUniformLocation>, x: number, y: number): void;
  115609. /**
  115610. * Set the value of an uniform to a vec3
  115611. * @param uniform defines the webGL uniform location where to store the value
  115612. * @param x defines the 1st component of the value
  115613. * @param y defines the 2nd component of the value
  115614. * @param z defines the 3rd component of the value
  115615. */
  115616. setFloat3(uniform: Nullable<WebGLUniformLocation>, x: number, y: number, z: number): void;
  115617. /**
  115618. * Set the value of an uniform to a vec4
  115619. * @param uniform defines the webGL uniform location where to store the value
  115620. * @param x defines the 1st component of the value
  115621. * @param y defines the 2nd component of the value
  115622. * @param z defines the 3rd component of the value
  115623. * @param w defines the 4th component of the value
  115624. */
  115625. setFloat4(uniform: Nullable<WebGLUniformLocation>, x: number, y: number, z: number, w: number): void;
  115626. /**
  115627. * Apply all cached states (depth, culling, stencil and alpha)
  115628. */
  115629. applyStates(): void;
  115630. /**
  115631. * Enable or disable color writing
  115632. * @param enable defines the state to set
  115633. */
  115634. setColorWrite(enable: boolean): void;
  115635. /**
  115636. * Gets a boolean indicating if color writing is enabled
  115637. * @returns the current color writing state
  115638. */
  115639. getColorWrite(): boolean;
  115640. /**
  115641. * Gets the depth culling state manager
  115642. */
  115643. get depthCullingState(): DepthCullingState;
  115644. /**
  115645. * Gets the alpha state manager
  115646. */
  115647. get alphaState(): AlphaState;
  115648. /**
  115649. * Gets the stencil state manager
  115650. */
  115651. get stencilState(): StencilState;
  115652. /**
  115653. * Clears the list of texture accessible through engine.
  115654. * This can help preventing texture load conflict due to name collision.
  115655. */
  115656. clearInternalTexturesCache(): void;
  115657. /**
  115658. * Force the entire cache to be cleared
  115659. * You should not have to use this function unless your engine needs to share the webGL context with another engine
  115660. * @param bruteForce defines a boolean to force clearing ALL caches (including stencil, detoh and alpha states)
  115661. */
  115662. wipeCaches(bruteForce?: boolean): void;
  115663. /** @hidden */
  115664. _getSamplingParameters(samplingMode: number, generateMipMaps: boolean): {
  115665. min: number;
  115666. mag: number;
  115667. };
  115668. /** @hidden */
  115669. _createTexture(): WebGLTexture;
  115670. /**
  115671. * Usually called from Texture.ts.
  115672. * Passed information to create a WebGLTexture
  115673. * @param url defines a value which contains one of the following:
  115674. * * A conventional http URL, e.g. 'http://...' or 'file://...'
  115675. * * A base64 string of in-line texture data, e.g. 'data:image/jpg;base64,/...'
  115676. * * An indicator that data being passed using the buffer parameter, e.g. 'data:mytexture.jpg'
  115677. * @param noMipmap defines a boolean indicating that no mipmaps shall be generated. Ignored for compressed textures. They must be in the file
  115678. * @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)
  115679. * @param scene needed for loading to the correct scene
  115680. * @param samplingMode mode with should be used sample / access the texture (Default: Texture.TRILINEAR_SAMPLINGMODE)
  115681. * @param onLoad optional callback to be called upon successful completion
  115682. * @param onError optional callback to be called upon failure
  115683. * @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
  115684. * @param fallback an internal argument in case the function must be called again, due to etc1 not having alpha capabilities
  115685. * @param format internal format. Default: RGB when extension is '.jpg' else RGBA. Ignored for compressed textures
  115686. * @param forcedExtension defines the extension to use to pick the right loader
  115687. * @param mimeType defines an optional mime type
  115688. * @returns a InternalTexture for assignment back into BABYLON.Texture
  115689. */
  115690. 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;
  115691. /**
  115692. * Loads an image as an HTMLImageElement.
  115693. * @param input url string, ArrayBuffer, or Blob to load
  115694. * @param onLoad callback called when the image successfully loads
  115695. * @param onError callback called when the image fails to load
  115696. * @param offlineProvider offline provider for caching
  115697. * @param mimeType optional mime type
  115698. * @returns the HTMLImageElement of the loaded image
  115699. * @hidden
  115700. */
  115701. 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>;
  115702. /**
  115703. * @hidden
  115704. */
  115705. _rescaleTexture(source: InternalTexture, destination: InternalTexture, scene: Nullable<any>, internalFormat: number, onComplete: () => void): void;
  115706. private _unpackFlipYCached;
  115707. /**
  115708. * In case you are sharing the context with other applications, it might
  115709. * be interested to not cache the unpack flip y state to ensure a consistent
  115710. * value would be set.
  115711. */
  115712. enableUnpackFlipYCached: boolean;
  115713. /** @hidden */
  115714. _unpackFlipY(value: boolean): void;
  115715. /** @hidden */
  115716. _getUnpackAlignement(): number;
  115717. private _getTextureTarget;
  115718. /**
  115719. * Update the sampling mode of a given texture
  115720. * @param samplingMode defines the required sampling mode
  115721. * @param texture defines the texture to update
  115722. * @param generateMipMaps defines whether to generate mipmaps for the texture
  115723. */
  115724. updateTextureSamplingMode(samplingMode: number, texture: InternalTexture, generateMipMaps?: boolean): void;
  115725. /**
  115726. * Update the sampling mode of a given texture
  115727. * @param texture defines the texture to update
  115728. * @param wrapU defines the texture wrap mode of the u coordinates
  115729. * @param wrapV defines the texture wrap mode of the v coordinates
  115730. * @param wrapR defines the texture wrap mode of the r coordinates
  115731. */
  115732. updateTextureWrappingMode(texture: InternalTexture, wrapU: Nullable<number>, wrapV?: Nullable<number>, wrapR?: Nullable<number>): void;
  115733. /** @hidden */
  115734. _setupDepthStencilTexture(internalTexture: InternalTexture, size: number | {
  115735. width: number;
  115736. height: number;
  115737. layers?: number;
  115738. }, generateStencil: boolean, bilinearFiltering: boolean, comparisonFunction: number): void;
  115739. /** @hidden */
  115740. _uploadCompressedDataToTextureDirectly(texture: InternalTexture, internalFormat: number, width: number, height: number, data: ArrayBufferView, faceIndex?: number, lod?: number): void;
  115741. /** @hidden */
  115742. _uploadDataToTextureDirectly(texture: InternalTexture, imageData: ArrayBufferView, faceIndex?: number, lod?: number, babylonInternalFormat?: number, useTextureWidthAndHeight?: boolean): void;
  115743. /**
  115744. * Update a portion of an internal texture
  115745. * @param texture defines the texture to update
  115746. * @param imageData defines the data to store into the texture
  115747. * @param xOffset defines the x coordinates of the update rectangle
  115748. * @param yOffset defines the y coordinates of the update rectangle
  115749. * @param width defines the width of the update rectangle
  115750. * @param height defines the height of the update rectangle
  115751. * @param faceIndex defines the face index if texture is a cube (0 by default)
  115752. * @param lod defines the lod level to update (0 by default)
  115753. */
  115754. updateTextureData(texture: InternalTexture, imageData: ArrayBufferView, xOffset: number, yOffset: number, width: number, height: number, faceIndex?: number, lod?: number): void;
  115755. /** @hidden */
  115756. _uploadArrayBufferViewToTexture(texture: InternalTexture, imageData: ArrayBufferView, faceIndex?: number, lod?: number): void;
  115757. protected _prepareWebGLTextureContinuation(texture: InternalTexture, scene: Nullable<ISceneLike>, noMipmap: boolean, isCompressed: boolean, samplingMode: number): void;
  115758. private _prepareWebGLTexture;
  115759. /** @hidden */
  115760. _setupFramebufferDepthAttachments(generateStencilBuffer: boolean, generateDepthBuffer: boolean, width: number, height: number, samples?: number): Nullable<WebGLRenderbuffer>;
  115761. private _getDepthStencilBuffer;
  115762. /** @hidden */
  115763. _releaseFramebufferObjects(texture: InternalTexture): void;
  115764. /** @hidden */
  115765. _releaseTexture(texture: InternalTexture): void;
  115766. protected _deleteTexture(texture: Nullable<WebGLTexture>): void;
  115767. protected _setProgram(program: WebGLProgram): void;
  115768. protected _boundUniforms: {
  115769. [key: number]: WebGLUniformLocation;
  115770. };
  115771. /**
  115772. * Binds an effect to the webGL context
  115773. * @param effect defines the effect to bind
  115774. */
  115775. bindSamplers(effect: Effect): void;
  115776. private _activateCurrentTexture;
  115777. /** @hidden */
  115778. _bindTextureDirectly(target: number, texture: Nullable<InternalTexture>, forTextureDataUpdate?: boolean, force?: boolean): boolean;
  115779. /** @hidden */
  115780. _bindTexture(channel: number, texture: Nullable<InternalTexture>): void;
  115781. /**
  115782. * Unbind all textures from the webGL context
  115783. */
  115784. unbindAllTextures(): void;
  115785. /**
  115786. * Sets a texture to the according uniform.
  115787. * @param channel The texture channel
  115788. * @param uniform The uniform to set
  115789. * @param texture The texture to apply
  115790. */
  115791. setTexture(channel: number, uniform: Nullable<WebGLUniformLocation>, texture: Nullable<BaseTexture>): void;
  115792. private _bindSamplerUniformToChannel;
  115793. private _getTextureWrapMode;
  115794. protected _setTexture(channel: number, texture: Nullable<BaseTexture>, isPartOfTextureArray?: boolean, depthStencilTexture?: boolean): boolean;
  115795. /**
  115796. * Sets an array of texture to the webGL context
  115797. * @param channel defines the channel where the texture array must be set
  115798. * @param uniform defines the associated uniform location
  115799. * @param textures defines the array of textures to bind
  115800. */
  115801. setTextureArray(channel: number, uniform: Nullable<WebGLUniformLocation>, textures: BaseTexture[]): void;
  115802. /** @hidden */
  115803. _setAnisotropicLevel(target: number, internalTexture: InternalTexture, anisotropicFilteringLevel: number): void;
  115804. private _setTextureParameterFloat;
  115805. private _setTextureParameterInteger;
  115806. /**
  115807. * Unbind all vertex attributes from the webGL context
  115808. */
  115809. unbindAllAttributes(): void;
  115810. /**
  115811. * 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
  115812. */
  115813. releaseEffects(): void;
  115814. /**
  115815. * Dispose and release all associated resources
  115816. */
  115817. dispose(): void;
  115818. /**
  115819. * Attach a new callback raised when context lost event is fired
  115820. * @param callback defines the callback to call
  115821. */
  115822. attachContextLostEvent(callback: ((event: WebGLContextEvent) => void)): void;
  115823. /**
  115824. * Attach a new callback raised when context restored event is fired
  115825. * @param callback defines the callback to call
  115826. */
  115827. attachContextRestoredEvent(callback: ((event: WebGLContextEvent) => void)): void;
  115828. /**
  115829. * Get the current error code of the webGL context
  115830. * @returns the error code
  115831. * @see https://developer.mozilla.org/en-US/docs/Web/API/WebGLRenderingContext/getError
  115832. */
  115833. getError(): number;
  115834. private _canRenderToFloatFramebuffer;
  115835. private _canRenderToHalfFloatFramebuffer;
  115836. private _canRenderToFramebuffer;
  115837. /** @hidden */
  115838. _getWebGLTextureType(type: number): number;
  115839. /** @hidden */
  115840. _getInternalFormat(format: number): number;
  115841. /** @hidden */
  115842. _getRGBABufferInternalSizedFormat(type: number, format?: number): number;
  115843. /** @hidden */
  115844. _getRGBAMultiSampleBufferFormat(type: number): number;
  115845. /** @hidden */
  115846. _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;
  115847. /**
  115848. * Loads a file from a url
  115849. * @param url url to load
  115850. * @param onSuccess callback called when the file successfully loads
  115851. * @param onProgress callback called while file is loading (if the server supports this mode)
  115852. * @param offlineProvider defines the offline provider for caching
  115853. * @param useArrayBuffer defines a boolean indicating that date must be returned as ArrayBuffer
  115854. * @param onError callback called when the file fails to load
  115855. * @returns a file request object
  115856. * @hidden
  115857. */
  115858. 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;
  115859. /**
  115860. * Reads pixels from the current frame buffer. Please note that this function can be slow
  115861. * @param x defines the x coordinate of the rectangle where pixels must be read
  115862. * @param y defines the y coordinate of the rectangle where pixels must be read
  115863. * @param width defines the width of the rectangle where pixels must be read
  115864. * @param height defines the height of the rectangle where pixels must be read
  115865. * @param hasAlpha defines whether the output should have alpha or not (defaults to true)
  115866. * @returns a Uint8Array containing RGBA colors
  115867. */
  115868. readPixels(x: number, y: number, width: number, height: number, hasAlpha?: boolean): Uint8Array;
  115869. private static _isSupported;
  115870. /**
  115871. * Gets a boolean indicating if the engine can be instanciated (ie. if a webGL context can be found)
  115872. * @returns true if the engine can be created
  115873. * @ignorenaming
  115874. */
  115875. static isSupported(): boolean;
  115876. /**
  115877. * Find the next highest power of two.
  115878. * @param x Number to start search from.
  115879. * @return Next highest power of two.
  115880. */
  115881. static CeilingPOT(x: number): number;
  115882. /**
  115883. * Find the next lowest power of two.
  115884. * @param x Number to start search from.
  115885. * @return Next lowest power of two.
  115886. */
  115887. static FloorPOT(x: number): number;
  115888. /**
  115889. * Find the nearest power of two.
  115890. * @param x Number to start search from.
  115891. * @return Next nearest power of two.
  115892. */
  115893. static NearestPOT(x: number): number;
  115894. /**
  115895. * Get the closest exponent of two
  115896. * @param value defines the value to approximate
  115897. * @param max defines the maximum value to return
  115898. * @param mode defines how to define the closest value
  115899. * @returns closest exponent of two of the given value
  115900. */
  115901. static GetExponentOfTwo(value: number, max: number, mode?: number): number;
  115902. /**
  115903. * Queue a new function into the requested animation frame pool (ie. this function will be executed byt the browser for the next frame)
  115904. * @param func - the function to be called
  115905. * @param requester - the object that will request the next frame. Falls back to window.
  115906. * @returns frame number
  115907. */
  115908. static QueueNewFrame(func: () => void, requester?: any): number;
  115909. /**
  115910. * Gets host document
  115911. * @returns the host document object
  115912. */
  115913. getHostDocument(): Nullable<Document>;
  115914. }
  115915. }
  115916. declare module BABYLON {
  115917. /**
  115918. * Class representing spherical harmonics coefficients to the 3rd degree
  115919. */
  115920. export class SphericalHarmonics {
  115921. /**
  115922. * Defines whether or not the harmonics have been prescaled for rendering.
  115923. */
  115924. preScaled: boolean;
  115925. /**
  115926. * The l0,0 coefficients of the spherical harmonics
  115927. */
  115928. l00: Vector3;
  115929. /**
  115930. * The l1,-1 coefficients of the spherical harmonics
  115931. */
  115932. l1_1: Vector3;
  115933. /**
  115934. * The l1,0 coefficients of the spherical harmonics
  115935. */
  115936. l10: Vector3;
  115937. /**
  115938. * The l1,1 coefficients of the spherical harmonics
  115939. */
  115940. l11: Vector3;
  115941. /**
  115942. * The l2,-2 coefficients of the spherical harmonics
  115943. */
  115944. l2_2: Vector3;
  115945. /**
  115946. * The l2,-1 coefficients of the spherical harmonics
  115947. */
  115948. l2_1: Vector3;
  115949. /**
  115950. * The l2,0 coefficients of the spherical harmonics
  115951. */
  115952. l20: Vector3;
  115953. /**
  115954. * The l2,1 coefficients of the spherical harmonics
  115955. */
  115956. l21: Vector3;
  115957. /**
  115958. * The l2,2 coefficients of the spherical harmonics
  115959. */
  115960. l22: Vector3;
  115961. /**
  115962. * Adds a light to the spherical harmonics
  115963. * @param direction the direction of the light
  115964. * @param color the color of the light
  115965. * @param deltaSolidAngle the delta solid angle of the light
  115966. */
  115967. addLight(direction: Vector3, color: Color3, deltaSolidAngle: number): void;
  115968. /**
  115969. * Scales the spherical harmonics by the given amount
  115970. * @param scale the amount to scale
  115971. */
  115972. scaleInPlace(scale: number): void;
  115973. /**
  115974. * Convert from incident radiance (Li) to irradiance (E) by applying convolution with the cosine-weighted hemisphere.
  115975. *
  115976. * ```
  115977. * E_lm = A_l * L_lm
  115978. * ```
  115979. *
  115980. * In spherical harmonics this convolution amounts to scaling factors for each frequency band.
  115981. * This corresponds to equation 5 in "An Efficient Representation for Irradiance Environment Maps", where
  115982. * the scaling factors are given in equation 9.
  115983. */
  115984. convertIncidentRadianceToIrradiance(): void;
  115985. /**
  115986. * Convert from irradiance to outgoing radiance for Lambertian BDRF, suitable for efficient shader evaluation.
  115987. *
  115988. * ```
  115989. * L = (1/pi) * E * rho
  115990. * ```
  115991. *
  115992. * This is done by an additional scale by 1/pi, so is a fairly trivial operation but important conceptually.
  115993. */
  115994. convertIrradianceToLambertianRadiance(): void;
  115995. /**
  115996. * Integrates the reconstruction coefficients directly in to the SH preventing further
  115997. * required operations at run time.
  115998. *
  115999. * This is simply done by scaling back the SH with Ylm constants parameter.
  116000. * The trigonometric part being applied by the shader at run time.
  116001. */
  116002. preScaleForRendering(): void;
  116003. /**
  116004. * Constructs a spherical harmonics from an array.
  116005. * @param data defines the 9x3 coefficients (l00, l1-1, l10, l11, l2-2, l2-1, l20, l21, l22)
  116006. * @returns the spherical harmonics
  116007. */
  116008. static FromArray(data: ArrayLike<ArrayLike<number>>): SphericalHarmonics;
  116009. /**
  116010. * Gets the spherical harmonics from polynomial
  116011. * @param polynomial the spherical polynomial
  116012. * @returns the spherical harmonics
  116013. */
  116014. static FromPolynomial(polynomial: SphericalPolynomial): SphericalHarmonics;
  116015. }
  116016. /**
  116017. * Class representing spherical polynomial coefficients to the 3rd degree
  116018. */
  116019. export class SphericalPolynomial {
  116020. private _harmonics;
  116021. /**
  116022. * The spherical harmonics used to create the polynomials.
  116023. */
  116024. get preScaledHarmonics(): SphericalHarmonics;
  116025. /**
  116026. * The x coefficients of the spherical polynomial
  116027. */
  116028. x: Vector3;
  116029. /**
  116030. * The y coefficients of the spherical polynomial
  116031. */
  116032. y: Vector3;
  116033. /**
  116034. * The z coefficients of the spherical polynomial
  116035. */
  116036. z: Vector3;
  116037. /**
  116038. * The xx coefficients of the spherical polynomial
  116039. */
  116040. xx: Vector3;
  116041. /**
  116042. * The yy coefficients of the spherical polynomial
  116043. */
  116044. yy: Vector3;
  116045. /**
  116046. * The zz coefficients of the spherical polynomial
  116047. */
  116048. zz: Vector3;
  116049. /**
  116050. * The xy coefficients of the spherical polynomial
  116051. */
  116052. xy: Vector3;
  116053. /**
  116054. * The yz coefficients of the spherical polynomial
  116055. */
  116056. yz: Vector3;
  116057. /**
  116058. * The zx coefficients of the spherical polynomial
  116059. */
  116060. zx: Vector3;
  116061. /**
  116062. * Adds an ambient color to the spherical polynomial
  116063. * @param color the color to add
  116064. */
  116065. addAmbient(color: Color3): void;
  116066. /**
  116067. * Scales the spherical polynomial by the given amount
  116068. * @param scale the amount to scale
  116069. */
  116070. scaleInPlace(scale: number): void;
  116071. /**
  116072. * Gets the spherical polynomial from harmonics
  116073. * @param harmonics the spherical harmonics
  116074. * @returns the spherical polynomial
  116075. */
  116076. static FromHarmonics(harmonics: SphericalHarmonics): SphericalPolynomial;
  116077. /**
  116078. * Constructs a spherical polynomial from an array.
  116079. * @param data defines the 9x3 coefficients (x, y, z, xx, yy, zz, yz, zx, xy)
  116080. * @returns the spherical polynomial
  116081. */
  116082. static FromArray(data: ArrayLike<ArrayLike<number>>): SphericalPolynomial;
  116083. }
  116084. }
  116085. declare module BABYLON {
  116086. /**
  116087. * Defines the source of the internal texture
  116088. */
  116089. export enum InternalTextureSource {
  116090. /**
  116091. * The source of the texture data is unknown
  116092. */
  116093. Unknown = 0,
  116094. /**
  116095. * Texture data comes from an URL
  116096. */
  116097. Url = 1,
  116098. /**
  116099. * Texture data is only used for temporary storage
  116100. */
  116101. Temp = 2,
  116102. /**
  116103. * Texture data comes from raw data (ArrayBuffer)
  116104. */
  116105. Raw = 3,
  116106. /**
  116107. * Texture content is dynamic (video or dynamic texture)
  116108. */
  116109. Dynamic = 4,
  116110. /**
  116111. * Texture content is generated by rendering to it
  116112. */
  116113. RenderTarget = 5,
  116114. /**
  116115. * Texture content is part of a multi render target process
  116116. */
  116117. MultiRenderTarget = 6,
  116118. /**
  116119. * Texture data comes from a cube data file
  116120. */
  116121. Cube = 7,
  116122. /**
  116123. * Texture data comes from a raw cube data
  116124. */
  116125. CubeRaw = 8,
  116126. /**
  116127. * Texture data come from a prefiltered cube data file
  116128. */
  116129. CubePrefiltered = 9,
  116130. /**
  116131. * Texture content is raw 3D data
  116132. */
  116133. Raw3D = 10,
  116134. /**
  116135. * Texture content is raw 2D array data
  116136. */
  116137. Raw2DArray = 11,
  116138. /**
  116139. * Texture content is a depth texture
  116140. */
  116141. Depth = 12,
  116142. /**
  116143. * Texture data comes from a raw cube data encoded with RGBD
  116144. */
  116145. CubeRawRGBD = 13
  116146. }
  116147. /**
  116148. * Class used to store data associated with WebGL texture data for the engine
  116149. * This class should not be used directly
  116150. */
  116151. export class InternalTexture {
  116152. /** @hidden */
  116153. static _UpdateRGBDAsync: (internalTexture: InternalTexture, data: ArrayBufferView[][], sphericalPolynomial: Nullable<SphericalPolynomial>, lodScale: number, lodOffset: number) => Promise<void>;
  116154. /**
  116155. * Defines if the texture is ready
  116156. */
  116157. isReady: boolean;
  116158. /**
  116159. * Defines if the texture is a cube texture
  116160. */
  116161. isCube: boolean;
  116162. /**
  116163. * Defines if the texture contains 3D data
  116164. */
  116165. is3D: boolean;
  116166. /**
  116167. * Defines if the texture contains 2D array data
  116168. */
  116169. is2DArray: boolean;
  116170. /**
  116171. * Defines if the texture contains multiview data
  116172. */
  116173. isMultiview: boolean;
  116174. /**
  116175. * Gets the URL used to load this texture
  116176. */
  116177. url: string;
  116178. /**
  116179. * Gets the sampling mode of the texture
  116180. */
  116181. samplingMode: number;
  116182. /**
  116183. * Gets a boolean indicating if the texture needs mipmaps generation
  116184. */
  116185. generateMipMaps: boolean;
  116186. /**
  116187. * Gets the number of samples used by the texture (WebGL2+ only)
  116188. */
  116189. samples: number;
  116190. /**
  116191. * Gets the type of the texture (int, float...)
  116192. */
  116193. type: number;
  116194. /**
  116195. * Gets the format of the texture (RGB, RGBA...)
  116196. */
  116197. format: number;
  116198. /**
  116199. * Observable called when the texture is loaded
  116200. */
  116201. onLoadedObservable: Observable<InternalTexture>;
  116202. /**
  116203. * Gets the width of the texture
  116204. */
  116205. width: number;
  116206. /**
  116207. * Gets the height of the texture
  116208. */
  116209. height: number;
  116210. /**
  116211. * Gets the depth of the texture
  116212. */
  116213. depth: number;
  116214. /**
  116215. * Gets the initial width of the texture (It could be rescaled if the current system does not support non power of two textures)
  116216. */
  116217. baseWidth: number;
  116218. /**
  116219. * Gets the initial height of the texture (It could be rescaled if the current system does not support non power of two textures)
  116220. */
  116221. baseHeight: number;
  116222. /**
  116223. * Gets the initial depth of the texture (It could be rescaled if the current system does not support non power of two textures)
  116224. */
  116225. baseDepth: number;
  116226. /**
  116227. * Gets a boolean indicating if the texture is inverted on Y axis
  116228. */
  116229. invertY: boolean;
  116230. /** @hidden */
  116231. _invertVScale: boolean;
  116232. /** @hidden */
  116233. _associatedChannel: number;
  116234. /** @hidden */
  116235. _source: InternalTextureSource;
  116236. /** @hidden */
  116237. _buffer: Nullable<string | ArrayBuffer | ArrayBufferView | HTMLImageElement | Blob | ImageBitmap>;
  116238. /** @hidden */
  116239. _bufferView: Nullable<ArrayBufferView>;
  116240. /** @hidden */
  116241. _bufferViewArray: Nullable<ArrayBufferView[]>;
  116242. /** @hidden */
  116243. _bufferViewArrayArray: Nullable<ArrayBufferView[][]>;
  116244. /** @hidden */
  116245. _size: number;
  116246. /** @hidden */
  116247. _extension: string;
  116248. /** @hidden */
  116249. _files: Nullable<string[]>;
  116250. /** @hidden */
  116251. _workingCanvas: Nullable<HTMLCanvasElement | OffscreenCanvas>;
  116252. /** @hidden */
  116253. _workingContext: Nullable<CanvasRenderingContext2D | OffscreenCanvasRenderingContext2D>;
  116254. /** @hidden */
  116255. _framebuffer: Nullable<WebGLFramebuffer>;
  116256. /** @hidden */
  116257. _depthStencilBuffer: Nullable<WebGLRenderbuffer>;
  116258. /** @hidden */
  116259. _MSAAFramebuffer: Nullable<WebGLFramebuffer>;
  116260. /** @hidden */
  116261. _MSAARenderBuffer: Nullable<WebGLRenderbuffer>;
  116262. /** @hidden */
  116263. _attachments: Nullable<number[]>;
  116264. /** @hidden */
  116265. _textureArray: Nullable<InternalTexture[]>;
  116266. /** @hidden */
  116267. _cachedCoordinatesMode: Nullable<number>;
  116268. /** @hidden */
  116269. _cachedWrapU: Nullable<number>;
  116270. /** @hidden */
  116271. _cachedWrapV: Nullable<number>;
  116272. /** @hidden */
  116273. _cachedWrapR: Nullable<number>;
  116274. /** @hidden */
  116275. _cachedAnisotropicFilteringLevel: Nullable<number>;
  116276. /** @hidden */
  116277. _isDisabled: boolean;
  116278. /** @hidden */
  116279. _compression: Nullable<string>;
  116280. /** @hidden */
  116281. _generateStencilBuffer: boolean;
  116282. /** @hidden */
  116283. _generateDepthBuffer: boolean;
  116284. /** @hidden */
  116285. _comparisonFunction: number;
  116286. /** @hidden */
  116287. _sphericalPolynomial: Nullable<SphericalPolynomial>;
  116288. /** @hidden */
  116289. _lodGenerationScale: number;
  116290. /** @hidden */
  116291. _lodGenerationOffset: number;
  116292. /** @hidden */
  116293. _depthStencilTexture: Nullable<InternalTexture>;
  116294. /** @hidden */
  116295. _colorTextureArray: Nullable<WebGLTexture>;
  116296. /** @hidden */
  116297. _depthStencilTextureArray: Nullable<WebGLTexture>;
  116298. /** @hidden */
  116299. _lodTextureHigh: Nullable<BaseTexture>;
  116300. /** @hidden */
  116301. _lodTextureMid: Nullable<BaseTexture>;
  116302. /** @hidden */
  116303. _lodTextureLow: Nullable<BaseTexture>;
  116304. /** @hidden */
  116305. _isRGBD: boolean;
  116306. /** @hidden */
  116307. _linearSpecularLOD: boolean;
  116308. /** @hidden */
  116309. _irradianceTexture: Nullable<BaseTexture>;
  116310. /** @hidden */
  116311. _webGLTexture: Nullable<WebGLTexture>;
  116312. /** @hidden */
  116313. _references: number;
  116314. private _engine;
  116315. /**
  116316. * Gets the Engine the texture belongs to.
  116317. * @returns The babylon engine
  116318. */
  116319. getEngine(): ThinEngine;
  116320. /**
  116321. * Gets the data source type of the texture
  116322. */
  116323. get source(): InternalTextureSource;
  116324. /**
  116325. * Creates a new InternalTexture
  116326. * @param engine defines the engine to use
  116327. * @param source defines the type of data that will be used
  116328. * @param delayAllocation if the texture allocation should be delayed (default: false)
  116329. */
  116330. constructor(engine: ThinEngine, source: InternalTextureSource, delayAllocation?: boolean);
  116331. /**
  116332. * Increments the number of references (ie. the number of Texture that point to it)
  116333. */
  116334. incrementReferences(): void;
  116335. /**
  116336. * Change the size of the texture (not the size of the content)
  116337. * @param width defines the new width
  116338. * @param height defines the new height
  116339. * @param depth defines the new depth (1 by default)
  116340. */
  116341. updateSize(width: int, height: int, depth?: int): void;
  116342. /** @hidden */
  116343. _rebuild(): void;
  116344. /** @hidden */
  116345. _swapAndDie(target: InternalTexture): void;
  116346. /**
  116347. * Dispose the current allocated resources
  116348. */
  116349. dispose(): void;
  116350. }
  116351. }
  116352. declare module BABYLON {
  116353. /**
  116354. * Class used to work with sound analyzer using fast fourier transform (FFT)
  116355. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music
  116356. */
  116357. export class Analyser {
  116358. /**
  116359. * Gets or sets the smoothing
  116360. * @ignorenaming
  116361. */
  116362. SMOOTHING: number;
  116363. /**
  116364. * Gets or sets the FFT table size
  116365. * @ignorenaming
  116366. */
  116367. FFT_SIZE: number;
  116368. /**
  116369. * Gets or sets the bar graph amplitude
  116370. * @ignorenaming
  116371. */
  116372. BARGRAPHAMPLITUDE: number;
  116373. /**
  116374. * Gets or sets the position of the debug canvas
  116375. * @ignorenaming
  116376. */
  116377. DEBUGCANVASPOS: {
  116378. x: number;
  116379. y: number;
  116380. };
  116381. /**
  116382. * Gets or sets the debug canvas size
  116383. * @ignorenaming
  116384. */
  116385. DEBUGCANVASSIZE: {
  116386. width: number;
  116387. height: number;
  116388. };
  116389. private _byteFreqs;
  116390. private _byteTime;
  116391. private _floatFreqs;
  116392. private _webAudioAnalyser;
  116393. private _debugCanvas;
  116394. private _debugCanvasContext;
  116395. private _scene;
  116396. private _registerFunc;
  116397. private _audioEngine;
  116398. /**
  116399. * Creates a new analyser
  116400. * @param scene defines hosting scene
  116401. */
  116402. constructor(scene: Scene);
  116403. /**
  116404. * Get the number of data values you will have to play with for the visualization
  116405. * @see https://developer.mozilla.org/en-US/docs/Web/API/AnalyserNode/frequencyBinCount
  116406. * @returns a number
  116407. */
  116408. getFrequencyBinCount(): number;
  116409. /**
  116410. * Gets the current frequency data as a byte array
  116411. * @see https://developer.mozilla.org/en-US/docs/Web/API/AnalyserNode/getByteFrequencyData
  116412. * @returns a Uint8Array
  116413. */
  116414. getByteFrequencyData(): Uint8Array;
  116415. /**
  116416. * Gets the current waveform as a byte array
  116417. * @see https://developer.mozilla.org/en-US/docs/Web/API/AnalyserNode/getByteTimeDomainData
  116418. * @returns a Uint8Array
  116419. */
  116420. getByteTimeDomainData(): Uint8Array;
  116421. /**
  116422. * Gets the current frequency data as a float array
  116423. * @see https://developer.mozilla.org/en-US/docs/Web/API/AnalyserNode/getByteFrequencyData
  116424. * @returns a Float32Array
  116425. */
  116426. getFloatFrequencyData(): Float32Array;
  116427. /**
  116428. * Renders the debug canvas
  116429. */
  116430. drawDebugCanvas(): void;
  116431. /**
  116432. * Stops rendering the debug canvas and removes it
  116433. */
  116434. stopDebugCanvas(): void;
  116435. /**
  116436. * Connects two audio nodes
  116437. * @param inputAudioNode defines first node to connect
  116438. * @param outputAudioNode defines second node to connect
  116439. */
  116440. connectAudioNodes(inputAudioNode: AudioNode, outputAudioNode: AudioNode): void;
  116441. /**
  116442. * Releases all associated resources
  116443. */
  116444. dispose(): void;
  116445. }
  116446. }
  116447. declare module BABYLON {
  116448. /**
  116449. * This represents an audio engine and it is responsible
  116450. * to play, synchronize and analyse sounds throughout the application.
  116451. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music
  116452. */
  116453. export interface IAudioEngine extends IDisposable {
  116454. /**
  116455. * Gets whether the current host supports Web Audio and thus could create AudioContexts.
  116456. */
  116457. readonly canUseWebAudio: boolean;
  116458. /**
  116459. * Gets the current AudioContext if available.
  116460. */
  116461. readonly audioContext: Nullable<AudioContext>;
  116462. /**
  116463. * The master gain node defines the global audio volume of your audio engine.
  116464. */
  116465. readonly masterGain: GainNode;
  116466. /**
  116467. * Gets whether or not mp3 are supported by your browser.
  116468. */
  116469. readonly isMP3supported: boolean;
  116470. /**
  116471. * Gets whether or not ogg are supported by your browser.
  116472. */
  116473. readonly isOGGsupported: boolean;
  116474. /**
  116475. * Defines if Babylon should emit a warning if WebAudio is not supported.
  116476. * @ignoreNaming
  116477. */
  116478. WarnedWebAudioUnsupported: boolean;
  116479. /**
  116480. * Defines if the audio engine relies on a custom unlocked button.
  116481. * In this case, the embedded button will not be displayed.
  116482. */
  116483. useCustomUnlockedButton: boolean;
  116484. /**
  116485. * Gets whether or not the audio engine is unlocked (require first a user gesture on some browser).
  116486. */
  116487. readonly unlocked: boolean;
  116488. /**
  116489. * Event raised when audio has been unlocked on the browser.
  116490. */
  116491. onAudioUnlockedObservable: Observable<AudioEngine>;
  116492. /**
  116493. * Event raised when audio has been locked on the browser.
  116494. */
  116495. onAudioLockedObservable: Observable<AudioEngine>;
  116496. /**
  116497. * Flags the audio engine in Locked state.
  116498. * This happens due to new browser policies preventing audio to autoplay.
  116499. */
  116500. lock(): void;
  116501. /**
  116502. * Unlocks the audio engine once a user action has been done on the dom.
  116503. * This is helpful to resume play once browser policies have been satisfied.
  116504. */
  116505. unlock(): void;
  116506. /**
  116507. * Gets the global volume sets on the master gain.
  116508. * @returns the global volume if set or -1 otherwise
  116509. */
  116510. getGlobalVolume(): number;
  116511. /**
  116512. * Sets the global volume of your experience (sets on the master gain).
  116513. * @param newVolume Defines the new global volume of the application
  116514. */
  116515. setGlobalVolume(newVolume: number): void;
  116516. /**
  116517. * Connect the audio engine to an audio analyser allowing some amazing
  116518. * synchornization between the sounds/music and your visualization (VuMeter for instance).
  116519. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music#using-the-analyser
  116520. * @param analyser The analyser to connect to the engine
  116521. */
  116522. connectToAnalyser(analyser: Analyser): void;
  116523. }
  116524. /**
  116525. * This represents the default audio engine used in babylon.
  116526. * It is responsible to play, synchronize and analyse sounds throughout the application.
  116527. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music
  116528. */
  116529. export class AudioEngine implements IAudioEngine {
  116530. private _audioContext;
  116531. private _audioContextInitialized;
  116532. private _muteButton;
  116533. private _hostElement;
  116534. /**
  116535. * Gets whether the current host supports Web Audio and thus could create AudioContexts.
  116536. */
  116537. canUseWebAudio: boolean;
  116538. /**
  116539. * The master gain node defines the global audio volume of your audio engine.
  116540. */
  116541. masterGain: GainNode;
  116542. /**
  116543. * Defines if Babylon should emit a warning if WebAudio is not supported.
  116544. * @ignoreNaming
  116545. */
  116546. WarnedWebAudioUnsupported: boolean;
  116547. /**
  116548. * Gets whether or not mp3 are supported by your browser.
  116549. */
  116550. isMP3supported: boolean;
  116551. /**
  116552. * Gets whether or not ogg are supported by your browser.
  116553. */
  116554. isOGGsupported: boolean;
  116555. /**
  116556. * Gets whether audio has been unlocked on the device.
  116557. * Some Browsers have strong restrictions about Audio and won t autoplay unless
  116558. * a user interaction has happened.
  116559. */
  116560. unlocked: boolean;
  116561. /**
  116562. * Defines if the audio engine relies on a custom unlocked button.
  116563. * In this case, the embedded button will not be displayed.
  116564. */
  116565. useCustomUnlockedButton: boolean;
  116566. /**
  116567. * Event raised when audio has been unlocked on the browser.
  116568. */
  116569. onAudioUnlockedObservable: Observable<AudioEngine>;
  116570. /**
  116571. * Event raised when audio has been locked on the browser.
  116572. */
  116573. onAudioLockedObservable: Observable<AudioEngine>;
  116574. /**
  116575. * Gets the current AudioContext if available.
  116576. */
  116577. get audioContext(): Nullable<AudioContext>;
  116578. private _connectedAnalyser;
  116579. /**
  116580. * Instantiates a new audio engine.
  116581. *
  116582. * There should be only one per page as some browsers restrict the number
  116583. * of audio contexts you can create.
  116584. * @param hostElement defines the host element where to display the mute icon if necessary
  116585. */
  116586. constructor(hostElement?: Nullable<HTMLElement>);
  116587. /**
  116588. * Flags the audio engine in Locked state.
  116589. * This happens due to new browser policies preventing audio to autoplay.
  116590. */
  116591. lock(): void;
  116592. /**
  116593. * Unlocks the audio engine once a user action has been done on the dom.
  116594. * This is helpful to resume play once browser policies have been satisfied.
  116595. */
  116596. unlock(): void;
  116597. private _resumeAudioContext;
  116598. private _initializeAudioContext;
  116599. private _tryToRun;
  116600. private _triggerRunningState;
  116601. private _triggerSuspendedState;
  116602. private _displayMuteButton;
  116603. private _moveButtonToTopLeft;
  116604. private _onResize;
  116605. private _hideMuteButton;
  116606. /**
  116607. * Destroy and release the resources associated with the audio ccontext.
  116608. */
  116609. dispose(): void;
  116610. /**
  116611. * Gets the global volume sets on the master gain.
  116612. * @returns the global volume if set or -1 otherwise
  116613. */
  116614. getGlobalVolume(): number;
  116615. /**
  116616. * Sets the global volume of your experience (sets on the master gain).
  116617. * @param newVolume Defines the new global volume of the application
  116618. */
  116619. setGlobalVolume(newVolume: number): void;
  116620. /**
  116621. * Connect the audio engine to an audio analyser allowing some amazing
  116622. * synchornization between the sounds/music and your visualization (VuMeter for instance).
  116623. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music#using-the-analyser
  116624. * @param analyser The analyser to connect to the engine
  116625. */
  116626. connectToAnalyser(analyser: Analyser): void;
  116627. }
  116628. }
  116629. declare module BABYLON {
  116630. /**
  116631. * Interface used to present a loading screen while loading a scene
  116632. * @see https://doc.babylonjs.com/how_to/creating_a_custom_loading_screen
  116633. */
  116634. export interface ILoadingScreen {
  116635. /**
  116636. * Function called to display the loading screen
  116637. */
  116638. displayLoadingUI: () => void;
  116639. /**
  116640. * Function called to hide the loading screen
  116641. */
  116642. hideLoadingUI: () => void;
  116643. /**
  116644. * Gets or sets the color to use for the background
  116645. */
  116646. loadingUIBackgroundColor: string;
  116647. /**
  116648. * Gets or sets the text to display while loading
  116649. */
  116650. loadingUIText: string;
  116651. }
  116652. /**
  116653. * Class used for the default loading screen
  116654. * @see https://doc.babylonjs.com/how_to/creating_a_custom_loading_screen
  116655. */
  116656. export class DefaultLoadingScreen implements ILoadingScreen {
  116657. private _renderingCanvas;
  116658. private _loadingText;
  116659. private _loadingDivBackgroundColor;
  116660. private _loadingDiv;
  116661. private _loadingTextDiv;
  116662. /** Gets or sets the logo url to use for the default loading screen */
  116663. static DefaultLogoUrl: string;
  116664. /** Gets or sets the spinner url to use for the default loading screen */
  116665. static DefaultSpinnerUrl: string;
  116666. /**
  116667. * Creates a new default loading screen
  116668. * @param _renderingCanvas defines the canvas used to render the scene
  116669. * @param _loadingText defines the default text to display
  116670. * @param _loadingDivBackgroundColor defines the default background color
  116671. */
  116672. constructor(_renderingCanvas: HTMLCanvasElement, _loadingText?: string, _loadingDivBackgroundColor?: string);
  116673. /**
  116674. * Function called to display the loading screen
  116675. */
  116676. displayLoadingUI(): void;
  116677. /**
  116678. * Function called to hide the loading screen
  116679. */
  116680. hideLoadingUI(): void;
  116681. /**
  116682. * Gets or sets the text to display while loading
  116683. */
  116684. set loadingUIText(text: string);
  116685. get loadingUIText(): string;
  116686. /**
  116687. * Gets or sets the color to use for the background
  116688. */
  116689. get loadingUIBackgroundColor(): string;
  116690. set loadingUIBackgroundColor(color: string);
  116691. private _resizeLoadingUI;
  116692. }
  116693. }
  116694. declare module BABYLON {
  116695. /**
  116696. * Interface for any object that can request an animation frame
  116697. */
  116698. export interface ICustomAnimationFrameRequester {
  116699. /**
  116700. * This function will be called when the render loop is ready. If this is not populated, the engine's renderloop function will be called
  116701. */
  116702. renderFunction?: Function;
  116703. /**
  116704. * Called to request the next frame to render to
  116705. * @see https://developer.mozilla.org/en-US/docs/Web/API/window/requestAnimationFrame
  116706. */
  116707. requestAnimationFrame: Function;
  116708. /**
  116709. * You can pass this value to cancelAnimationFrame() to cancel the refresh callback request
  116710. * @see https://developer.mozilla.org/en-US/docs/Web/API/window/requestAnimationFrame#Return_value
  116711. */
  116712. requestID?: number;
  116713. }
  116714. }
  116715. declare module BABYLON {
  116716. /**
  116717. * Performance monitor tracks rolling average frame-time and frame-time variance over a user defined sliding-window
  116718. */
  116719. export class PerformanceMonitor {
  116720. private _enabled;
  116721. private _rollingFrameTime;
  116722. private _lastFrameTimeMs;
  116723. /**
  116724. * constructor
  116725. * @param frameSampleSize The number of samples required to saturate the sliding window
  116726. */
  116727. constructor(frameSampleSize?: number);
  116728. /**
  116729. * Samples current frame
  116730. * @param timeMs A timestamp in milliseconds of the current frame to compare with other frames
  116731. */
  116732. sampleFrame(timeMs?: number): void;
  116733. /**
  116734. * Returns the average frame time in milliseconds over the sliding window (or the subset of frames sampled so far)
  116735. */
  116736. get averageFrameTime(): number;
  116737. /**
  116738. * Returns the variance frame time in milliseconds over the sliding window (or the subset of frames sampled so far)
  116739. */
  116740. get averageFrameTimeVariance(): number;
  116741. /**
  116742. * Returns the frame time of the most recent frame
  116743. */
  116744. get instantaneousFrameTime(): number;
  116745. /**
  116746. * Returns the average framerate in frames per second over the sliding window (or the subset of frames sampled so far)
  116747. */
  116748. get averageFPS(): number;
  116749. /**
  116750. * Returns the average framerate in frames per second using the most recent frame time
  116751. */
  116752. get instantaneousFPS(): number;
  116753. /**
  116754. * Returns true if enough samples have been taken to completely fill the sliding window
  116755. */
  116756. get isSaturated(): boolean;
  116757. /**
  116758. * Enables contributions to the sliding window sample set
  116759. */
  116760. enable(): void;
  116761. /**
  116762. * Disables contributions to the sliding window sample set
  116763. * Samples will not be interpolated over the disabled period
  116764. */
  116765. disable(): void;
  116766. /**
  116767. * Returns true if sampling is enabled
  116768. */
  116769. get isEnabled(): boolean;
  116770. /**
  116771. * Resets performance monitor
  116772. */
  116773. reset(): void;
  116774. }
  116775. /**
  116776. * RollingAverage
  116777. *
  116778. * Utility to efficiently compute the rolling average and variance over a sliding window of samples
  116779. */
  116780. export class RollingAverage {
  116781. /**
  116782. * Current average
  116783. */
  116784. average: number;
  116785. /**
  116786. * Current variance
  116787. */
  116788. variance: number;
  116789. protected _samples: Array<number>;
  116790. protected _sampleCount: number;
  116791. protected _pos: number;
  116792. protected _m2: number;
  116793. /**
  116794. * constructor
  116795. * @param length The number of samples required to saturate the sliding window
  116796. */
  116797. constructor(length: number);
  116798. /**
  116799. * Adds a sample to the sample set
  116800. * @param v The sample value
  116801. */
  116802. add(v: number): void;
  116803. /**
  116804. * Returns previously added values or null if outside of history or outside the sliding window domain
  116805. * @param i Index in history. For example, pass 0 for the most recent value and 1 for the value before that
  116806. * @return Value previously recorded with add() or null if outside of range
  116807. */
  116808. history(i: number): number;
  116809. /**
  116810. * Returns true if enough samples have been taken to completely fill the sliding window
  116811. * @return true if sample-set saturated
  116812. */
  116813. isSaturated(): boolean;
  116814. /**
  116815. * Resets the rolling average (equivalent to 0 samples taken so far)
  116816. */
  116817. reset(): void;
  116818. /**
  116819. * Wraps a value around the sample range boundaries
  116820. * @param i Position in sample range, for example if the sample length is 5, and i is -3, then 2 will be returned.
  116821. * @return Wrapped position in sample range
  116822. */
  116823. protected _wrapPosition(i: number): number;
  116824. }
  116825. }
  116826. declare module BABYLON {
  116827. /**
  116828. * This class is used to track a performance counter which is number based.
  116829. * The user has access to many properties which give statistics of different nature.
  116830. *
  116831. * The implementer can track two kinds of Performance Counter: time and count.
  116832. * 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.
  116833. * 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.
  116834. */
  116835. export class PerfCounter {
  116836. /**
  116837. * Gets or sets a global boolean to turn on and off all the counters
  116838. */
  116839. static Enabled: boolean;
  116840. /**
  116841. * Returns the smallest value ever
  116842. */
  116843. get min(): number;
  116844. /**
  116845. * Returns the biggest value ever
  116846. */
  116847. get max(): number;
  116848. /**
  116849. * Returns the average value since the performance counter is running
  116850. */
  116851. get average(): number;
  116852. /**
  116853. * Returns the average value of the last second the counter was monitored
  116854. */
  116855. get lastSecAverage(): number;
  116856. /**
  116857. * Returns the current value
  116858. */
  116859. get current(): number;
  116860. /**
  116861. * Gets the accumulated total
  116862. */
  116863. get total(): number;
  116864. /**
  116865. * Gets the total value count
  116866. */
  116867. get count(): number;
  116868. /**
  116869. * Creates a new counter
  116870. */
  116871. constructor();
  116872. /**
  116873. * Call this method to start monitoring a new frame.
  116874. * 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.
  116875. */
  116876. fetchNewFrame(): void;
  116877. /**
  116878. * Call this method to monitor a count of something (e.g. mesh drawn in viewport count)
  116879. * @param newCount the count value to add to the monitored count
  116880. * @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.
  116881. */
  116882. addCount(newCount: number, fetchResult: boolean): void;
  116883. /**
  116884. * Start monitoring this performance counter
  116885. */
  116886. beginMonitoring(): void;
  116887. /**
  116888. * Compute the time lapsed since the previous beginMonitoring() call.
  116889. * @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
  116890. */
  116891. endMonitoring(newFrame?: boolean): void;
  116892. private _fetchResult;
  116893. private _startMonitoringTime;
  116894. private _min;
  116895. private _max;
  116896. private _average;
  116897. private _current;
  116898. private _totalValueCount;
  116899. private _totalAccumulated;
  116900. private _lastSecAverage;
  116901. private _lastSecAccumulated;
  116902. private _lastSecTime;
  116903. private _lastSecValueCount;
  116904. }
  116905. }
  116906. declare module BABYLON {
  116907. interface ThinEngine {
  116908. /** @hidden */
  116909. _readTexturePixels(texture: InternalTexture, width: number, height: number, faceIndex?: number, level?: number, buffer?: Nullable<ArrayBufferView>): ArrayBufferView;
  116910. }
  116911. }
  116912. declare module BABYLON {
  116913. /**
  116914. * Defines the interface used by display changed events
  116915. */
  116916. export interface IDisplayChangedEventArgs {
  116917. /** Gets the vrDisplay object (if any) */
  116918. vrDisplay: Nullable<any>;
  116919. /** Gets a boolean indicating if webVR is supported */
  116920. vrSupported: boolean;
  116921. }
  116922. /**
  116923. * Defines the interface used by objects containing a viewport (like a camera)
  116924. */
  116925. interface IViewportOwnerLike {
  116926. /**
  116927. * Gets or sets the viewport
  116928. */
  116929. viewport: IViewportLike;
  116930. }
  116931. /**
  116932. * The engine class is responsible for interfacing with all lower-level APIs such as WebGL and Audio
  116933. */
  116934. export class Engine extends ThinEngine {
  116935. /** Defines that alpha blending is disabled */
  116936. static readonly ALPHA_DISABLE: number;
  116937. /** Defines that alpha blending to SRC ALPHA * SRC + DEST */
  116938. static readonly ALPHA_ADD: number;
  116939. /** Defines that alpha blending to SRC ALPHA * SRC + (1 - SRC ALPHA) * DEST */
  116940. static readonly ALPHA_COMBINE: number;
  116941. /** Defines that alpha blending to DEST - SRC * DEST */
  116942. static readonly ALPHA_SUBTRACT: number;
  116943. /** Defines that alpha blending to SRC * DEST */
  116944. static readonly ALPHA_MULTIPLY: number;
  116945. /** Defines that alpha blending to SRC ALPHA * SRC + (1 - SRC) * DEST */
  116946. static readonly ALPHA_MAXIMIZED: number;
  116947. /** Defines that alpha blending to SRC + DEST */
  116948. static readonly ALPHA_ONEONE: number;
  116949. /** Defines that alpha blending to SRC + (1 - SRC ALPHA) * DEST */
  116950. static readonly ALPHA_PREMULTIPLIED: number;
  116951. /**
  116952. * Defines that alpha blending to SRC + (1 - SRC ALPHA) * DEST
  116953. * Alpha will be set to (1 - SRC ALPHA) * DEST ALPHA
  116954. */
  116955. static readonly ALPHA_PREMULTIPLIED_PORTERDUFF: number;
  116956. /** Defines that alpha blending to CST * SRC + (1 - CST) * DEST */
  116957. static readonly ALPHA_INTERPOLATE: number;
  116958. /**
  116959. * Defines that alpha blending to SRC + (1 - SRC) * DEST
  116960. * Alpha will be set to SRC ALPHA + (1 - SRC ALPHA) * DEST ALPHA
  116961. */
  116962. static readonly ALPHA_SCREENMODE: number;
  116963. /** Defines that the ressource is not delayed*/
  116964. static readonly DELAYLOADSTATE_NONE: number;
  116965. /** Defines that the ressource was successfully delay loaded */
  116966. static readonly DELAYLOADSTATE_LOADED: number;
  116967. /** Defines that the ressource is currently delay loading */
  116968. static readonly DELAYLOADSTATE_LOADING: number;
  116969. /** Defines that the ressource is delayed and has not started loading */
  116970. static readonly DELAYLOADSTATE_NOTLOADED: number;
  116971. /** Passed to depthFunction or stencilFunction to specify depth or stencil tests will never pass. i.e. Nothing will be drawn */
  116972. static readonly NEVER: number;
  116973. /** 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 */
  116974. static readonly ALWAYS: number;
  116975. /** Passed to depthFunction or stencilFunction to specify depth or stencil tests will pass if the new depth value is less than the stored value */
  116976. static readonly LESS: number;
  116977. /** Passed to depthFunction or stencilFunction to specify depth or stencil tests will pass if the new depth value is equals to the stored value */
  116978. static readonly EQUAL: number;
  116979. /** 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 */
  116980. static readonly LEQUAL: number;
  116981. /** Passed to depthFunction or stencilFunction to specify depth or stencil tests will pass if the new depth value is greater than the stored value */
  116982. static readonly GREATER: number;
  116983. /** 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 */
  116984. static readonly GEQUAL: number;
  116985. /** 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 */
  116986. static readonly NOTEQUAL: number;
  116987. /** Passed to stencilOperation to specify that stencil value must be kept */
  116988. static readonly KEEP: number;
  116989. /** Passed to stencilOperation to specify that stencil value must be replaced */
  116990. static readonly REPLACE: number;
  116991. /** Passed to stencilOperation to specify that stencil value must be incremented */
  116992. static readonly INCR: number;
  116993. /** Passed to stencilOperation to specify that stencil value must be decremented */
  116994. static readonly DECR: number;
  116995. /** Passed to stencilOperation to specify that stencil value must be inverted */
  116996. static readonly INVERT: number;
  116997. /** Passed to stencilOperation to specify that stencil value must be incremented with wrapping */
  116998. static readonly INCR_WRAP: number;
  116999. /** Passed to stencilOperation to specify that stencil value must be decremented with wrapping */
  117000. static readonly DECR_WRAP: number;
  117001. /** Texture is not repeating outside of 0..1 UVs */
  117002. static readonly TEXTURE_CLAMP_ADDRESSMODE: number;
  117003. /** Texture is repeating outside of 0..1 UVs */
  117004. static readonly TEXTURE_WRAP_ADDRESSMODE: number;
  117005. /** Texture is repeating and mirrored */
  117006. static readonly TEXTURE_MIRROR_ADDRESSMODE: number;
  117007. /** ALPHA */
  117008. static readonly TEXTUREFORMAT_ALPHA: number;
  117009. /** LUMINANCE */
  117010. static readonly TEXTUREFORMAT_LUMINANCE: number;
  117011. /** LUMINANCE_ALPHA */
  117012. static readonly TEXTUREFORMAT_LUMINANCE_ALPHA: number;
  117013. /** RGB */
  117014. static readonly TEXTUREFORMAT_RGB: number;
  117015. /** RGBA */
  117016. static readonly TEXTUREFORMAT_RGBA: number;
  117017. /** RED */
  117018. static readonly TEXTUREFORMAT_RED: number;
  117019. /** RED (2nd reference) */
  117020. static readonly TEXTUREFORMAT_R: number;
  117021. /** RG */
  117022. static readonly TEXTUREFORMAT_RG: number;
  117023. /** RED_INTEGER */
  117024. static readonly TEXTUREFORMAT_RED_INTEGER: number;
  117025. /** RED_INTEGER (2nd reference) */
  117026. static readonly TEXTUREFORMAT_R_INTEGER: number;
  117027. /** RG_INTEGER */
  117028. static readonly TEXTUREFORMAT_RG_INTEGER: number;
  117029. /** RGB_INTEGER */
  117030. static readonly TEXTUREFORMAT_RGB_INTEGER: number;
  117031. /** RGBA_INTEGER */
  117032. static readonly TEXTUREFORMAT_RGBA_INTEGER: number;
  117033. /** UNSIGNED_BYTE */
  117034. static readonly TEXTURETYPE_UNSIGNED_BYTE: number;
  117035. /** UNSIGNED_BYTE (2nd reference) */
  117036. static readonly TEXTURETYPE_UNSIGNED_INT: number;
  117037. /** FLOAT */
  117038. static readonly TEXTURETYPE_FLOAT: number;
  117039. /** HALF_FLOAT */
  117040. static readonly TEXTURETYPE_HALF_FLOAT: number;
  117041. /** BYTE */
  117042. static readonly TEXTURETYPE_BYTE: number;
  117043. /** SHORT */
  117044. static readonly TEXTURETYPE_SHORT: number;
  117045. /** UNSIGNED_SHORT */
  117046. static readonly TEXTURETYPE_UNSIGNED_SHORT: number;
  117047. /** INT */
  117048. static readonly TEXTURETYPE_INT: number;
  117049. /** UNSIGNED_INT */
  117050. static readonly TEXTURETYPE_UNSIGNED_INTEGER: number;
  117051. /** UNSIGNED_SHORT_4_4_4_4 */
  117052. static readonly TEXTURETYPE_UNSIGNED_SHORT_4_4_4_4: number;
  117053. /** UNSIGNED_SHORT_5_5_5_1 */
  117054. static readonly TEXTURETYPE_UNSIGNED_SHORT_5_5_5_1: number;
  117055. /** UNSIGNED_SHORT_5_6_5 */
  117056. static readonly TEXTURETYPE_UNSIGNED_SHORT_5_6_5: number;
  117057. /** UNSIGNED_INT_2_10_10_10_REV */
  117058. static readonly TEXTURETYPE_UNSIGNED_INT_2_10_10_10_REV: number;
  117059. /** UNSIGNED_INT_24_8 */
  117060. static readonly TEXTURETYPE_UNSIGNED_INT_24_8: number;
  117061. /** UNSIGNED_INT_10F_11F_11F_REV */
  117062. static readonly TEXTURETYPE_UNSIGNED_INT_10F_11F_11F_REV: number;
  117063. /** UNSIGNED_INT_5_9_9_9_REV */
  117064. static readonly TEXTURETYPE_UNSIGNED_INT_5_9_9_9_REV: number;
  117065. /** FLOAT_32_UNSIGNED_INT_24_8_REV */
  117066. static readonly TEXTURETYPE_FLOAT_32_UNSIGNED_INT_24_8_REV: number;
  117067. /** nearest is mag = nearest and min = nearest and mip = linear */
  117068. static readonly TEXTURE_NEAREST_SAMPLINGMODE: number;
  117069. /** Bilinear is mag = linear and min = linear and mip = nearest */
  117070. static readonly TEXTURE_BILINEAR_SAMPLINGMODE: number;
  117071. /** Trilinear is mag = linear and min = linear and mip = linear */
  117072. static readonly TEXTURE_TRILINEAR_SAMPLINGMODE: number;
  117073. /** nearest is mag = nearest and min = nearest and mip = linear */
  117074. static readonly TEXTURE_NEAREST_NEAREST_MIPLINEAR: number;
  117075. /** Bilinear is mag = linear and min = linear and mip = nearest */
  117076. static readonly TEXTURE_LINEAR_LINEAR_MIPNEAREST: number;
  117077. /** Trilinear is mag = linear and min = linear and mip = linear */
  117078. static readonly TEXTURE_LINEAR_LINEAR_MIPLINEAR: number;
  117079. /** mag = nearest and min = nearest and mip = nearest */
  117080. static readonly TEXTURE_NEAREST_NEAREST_MIPNEAREST: number;
  117081. /** mag = nearest and min = linear and mip = nearest */
  117082. static readonly TEXTURE_NEAREST_LINEAR_MIPNEAREST: number;
  117083. /** mag = nearest and min = linear and mip = linear */
  117084. static readonly TEXTURE_NEAREST_LINEAR_MIPLINEAR: number;
  117085. /** mag = nearest and min = linear and mip = none */
  117086. static readonly TEXTURE_NEAREST_LINEAR: number;
  117087. /** mag = nearest and min = nearest and mip = none */
  117088. static readonly TEXTURE_NEAREST_NEAREST: number;
  117089. /** mag = linear and min = nearest and mip = nearest */
  117090. static readonly TEXTURE_LINEAR_NEAREST_MIPNEAREST: number;
  117091. /** mag = linear and min = nearest and mip = linear */
  117092. static readonly TEXTURE_LINEAR_NEAREST_MIPLINEAR: number;
  117093. /** mag = linear and min = linear and mip = none */
  117094. static readonly TEXTURE_LINEAR_LINEAR: number;
  117095. /** mag = linear and min = nearest and mip = none */
  117096. static readonly TEXTURE_LINEAR_NEAREST: number;
  117097. /** Explicit coordinates mode */
  117098. static readonly TEXTURE_EXPLICIT_MODE: number;
  117099. /** Spherical coordinates mode */
  117100. static readonly TEXTURE_SPHERICAL_MODE: number;
  117101. /** Planar coordinates mode */
  117102. static readonly TEXTURE_PLANAR_MODE: number;
  117103. /** Cubic coordinates mode */
  117104. static readonly TEXTURE_CUBIC_MODE: number;
  117105. /** Projection coordinates mode */
  117106. static readonly TEXTURE_PROJECTION_MODE: number;
  117107. /** Skybox coordinates mode */
  117108. static readonly TEXTURE_SKYBOX_MODE: number;
  117109. /** Inverse Cubic coordinates mode */
  117110. static readonly TEXTURE_INVCUBIC_MODE: number;
  117111. /** Equirectangular coordinates mode */
  117112. static readonly TEXTURE_EQUIRECTANGULAR_MODE: number;
  117113. /** Equirectangular Fixed coordinates mode */
  117114. static readonly TEXTURE_FIXED_EQUIRECTANGULAR_MODE: number;
  117115. /** Equirectangular Fixed Mirrored coordinates mode */
  117116. static readonly TEXTURE_FIXED_EQUIRECTANGULAR_MIRRORED_MODE: number;
  117117. /** Defines that texture rescaling will use a floor to find the closer power of 2 size */
  117118. static readonly SCALEMODE_FLOOR: number;
  117119. /** Defines that texture rescaling will look for the nearest power of 2 size */
  117120. static readonly SCALEMODE_NEAREST: number;
  117121. /** Defines that texture rescaling will use a ceil to find the closer power of 2 size */
  117122. static readonly SCALEMODE_CEILING: number;
  117123. /**
  117124. * Returns the current npm package of the sdk
  117125. */
  117126. static get NpmPackage(): string;
  117127. /**
  117128. * Returns the current version of the framework
  117129. */
  117130. static get Version(): string;
  117131. /** Gets the list of created engines */
  117132. static get Instances(): Engine[];
  117133. /**
  117134. * Gets the latest created engine
  117135. */
  117136. static get LastCreatedEngine(): Nullable<Engine>;
  117137. /**
  117138. * Gets the latest created scene
  117139. */
  117140. static get LastCreatedScene(): Nullable<Scene>;
  117141. /**
  117142. * Will flag all materials in all scenes in all engines as dirty to trigger new shader compilation
  117143. * @param flag defines which part of the materials must be marked as dirty
  117144. * @param predicate defines a predicate used to filter which materials should be affected
  117145. */
  117146. static MarkAllMaterialsAsDirty(flag: number, predicate?: (mat: Material) => boolean): void;
  117147. /**
  117148. * Method called to create the default loading screen.
  117149. * This can be overriden in your own app.
  117150. * @param canvas The rendering canvas element
  117151. * @returns The loading screen
  117152. */
  117153. static DefaultLoadingScreenFactory(canvas: HTMLCanvasElement): ILoadingScreen;
  117154. /**
  117155. * Method called to create the default rescale post process on each engine.
  117156. */
  117157. static _RescalePostProcessFactory: Nullable<(engine: Engine) => PostProcess>;
  117158. /**
  117159. * Gets or sets a boolean to enable/disable IndexedDB support and avoid XHR on .manifest
  117160. **/
  117161. enableOfflineSupport: boolean;
  117162. /**
  117163. * 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)
  117164. **/
  117165. disableManifestCheck: boolean;
  117166. /**
  117167. * Gets the list of created scenes
  117168. */
  117169. scenes: Scene[];
  117170. /**
  117171. * Event raised when a new scene is created
  117172. */
  117173. onNewSceneAddedObservable: Observable<Scene>;
  117174. /**
  117175. * Gets the list of created postprocesses
  117176. */
  117177. postProcesses: PostProcess[];
  117178. /**
  117179. * Gets a boolean indicating if the pointer is currently locked
  117180. */
  117181. isPointerLock: boolean;
  117182. /**
  117183. * Observable event triggered each time the rendering canvas is resized
  117184. */
  117185. onResizeObservable: Observable<Engine>;
  117186. /**
  117187. * Observable event triggered each time the canvas loses focus
  117188. */
  117189. onCanvasBlurObservable: Observable<Engine>;
  117190. /**
  117191. * Observable event triggered each time the canvas gains focus
  117192. */
  117193. onCanvasFocusObservable: Observable<Engine>;
  117194. /**
  117195. * Observable event triggered each time the canvas receives pointerout event
  117196. */
  117197. onCanvasPointerOutObservable: Observable<PointerEvent>;
  117198. /**
  117199. * Observable raised when the engine begins a new frame
  117200. */
  117201. onBeginFrameObservable: Observable<Engine>;
  117202. /**
  117203. * If set, will be used to request the next animation frame for the render loop
  117204. */
  117205. customAnimationFrameRequester: Nullable<ICustomAnimationFrameRequester>;
  117206. /**
  117207. * Observable raised when the engine ends the current frame
  117208. */
  117209. onEndFrameObservable: Observable<Engine>;
  117210. /**
  117211. * Observable raised when the engine is about to compile a shader
  117212. */
  117213. onBeforeShaderCompilationObservable: Observable<Engine>;
  117214. /**
  117215. * Observable raised when the engine has jsut compiled a shader
  117216. */
  117217. onAfterShaderCompilationObservable: Observable<Engine>;
  117218. /**
  117219. * Gets the audio engine
  117220. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music
  117221. * @ignorenaming
  117222. */
  117223. static audioEngine: IAudioEngine;
  117224. /**
  117225. * Default AudioEngine factory responsible of creating the Audio Engine.
  117226. * By default, this will create a BabylonJS Audio Engine if the workload has been embedded.
  117227. */
  117228. static AudioEngineFactory: (hostElement: Nullable<HTMLElement>) => IAudioEngine;
  117229. /**
  117230. * Default offline support factory responsible of creating a tool used to store data locally.
  117231. * By default, this will create a Database object if the workload has been embedded.
  117232. */
  117233. static OfflineProviderFactory: (urlToScene: string, callbackManifestChecked: (checked: boolean) => any, disableManifestCheck: boolean) => IOfflineProvider;
  117234. private _loadingScreen;
  117235. private _pointerLockRequested;
  117236. private _rescalePostProcess;
  117237. private _deterministicLockstep;
  117238. private _lockstepMaxSteps;
  117239. private _timeStep;
  117240. protected get _supportsHardwareTextureRescaling(): boolean;
  117241. private _fps;
  117242. private _deltaTime;
  117243. /** @hidden */
  117244. _drawCalls: PerfCounter;
  117245. /** 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 */
  117246. canvasTabIndex: number;
  117247. /**
  117248. * Turn this value on if you want to pause FPS computation when in background
  117249. */
  117250. disablePerformanceMonitorInBackground: boolean;
  117251. private _performanceMonitor;
  117252. /**
  117253. * Gets the performance monitor attached to this engine
  117254. * @see https://doc.babylonjs.com/how_to/optimizing_your_scene#engineinstrumentation
  117255. */
  117256. get performanceMonitor(): PerformanceMonitor;
  117257. private _onFocus;
  117258. private _onBlur;
  117259. private _onCanvasPointerOut;
  117260. private _onCanvasBlur;
  117261. private _onCanvasFocus;
  117262. private _onFullscreenChange;
  117263. private _onPointerLockChange;
  117264. /**
  117265. * Gets the HTML element used to attach event listeners
  117266. * @returns a HTML element
  117267. */
  117268. getInputElement(): Nullable<HTMLElement>;
  117269. /**
  117270. * Creates a new engine
  117271. * @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
  117272. * @param antialias defines enable antialiasing (default: false)
  117273. * @param options defines further options to be sent to the getContext() function
  117274. * @param adaptToDeviceRatio defines whether to adapt to the device's viewport characteristics (default: false)
  117275. */
  117276. constructor(canvasOrContext: Nullable<HTMLCanvasElement | WebGLRenderingContext>, antialias?: boolean, options?: EngineOptions, adaptToDeviceRatio?: boolean);
  117277. /**
  117278. * Gets current aspect ratio
  117279. * @param viewportOwner defines the camera to use to get the aspect ratio
  117280. * @param useScreen defines if screen size must be used (or the current render target if any)
  117281. * @returns a number defining the aspect ratio
  117282. */
  117283. getAspectRatio(viewportOwner: IViewportOwnerLike, useScreen?: boolean): number;
  117284. /**
  117285. * Gets current screen aspect ratio
  117286. * @returns a number defining the aspect ratio
  117287. */
  117288. getScreenAspectRatio(): number;
  117289. /**
  117290. * Gets the client rect of the HTML canvas attached with the current webGL context
  117291. * @returns a client rectanglee
  117292. */
  117293. getRenderingCanvasClientRect(): Nullable<ClientRect>;
  117294. /**
  117295. * Gets the client rect of the HTML element used for events
  117296. * @returns a client rectanglee
  117297. */
  117298. getInputElementClientRect(): Nullable<ClientRect>;
  117299. /**
  117300. * Gets a boolean indicating that the engine is running in deterministic lock step mode
  117301. * @see https://doc.babylonjs.com/babylon101/animations#deterministic-lockstep
  117302. * @returns true if engine is in deterministic lock step mode
  117303. */
  117304. isDeterministicLockStep(): boolean;
  117305. /**
  117306. * Gets the max steps when engine is running in deterministic lock step
  117307. * @see https://doc.babylonjs.com/babylon101/animations#deterministic-lockstep
  117308. * @returns the max steps
  117309. */
  117310. getLockstepMaxSteps(): number;
  117311. /**
  117312. * Returns the time in ms between steps when using deterministic lock step.
  117313. * @returns time step in (ms)
  117314. */
  117315. getTimeStep(): number;
  117316. /**
  117317. * Force the mipmap generation for the given render target texture
  117318. * @param texture defines the render target texture to use
  117319. * @param unbind defines whether or not to unbind the texture after generation. Defaults to true.
  117320. */
  117321. generateMipMapsForCubemap(texture: InternalTexture, unbind?: boolean): void;
  117322. /** States */
  117323. /**
  117324. * Set various states to the webGL context
  117325. * @param culling defines backface culling state
  117326. * @param zOffset defines the value to apply to zOffset (0 by default)
  117327. * @param force defines if states must be applied even if cache is up to date
  117328. * @param reverseSide defines if culling must be reversed (CCW instead of CW and CW instead of CCW)
  117329. */
  117330. setState(culling: boolean, zOffset?: number, force?: boolean, reverseSide?: boolean): void;
  117331. /**
  117332. * Set the z offset to apply to current rendering
  117333. * @param value defines the offset to apply
  117334. */
  117335. setZOffset(value: number): void;
  117336. /**
  117337. * Gets the current value of the zOffset
  117338. * @returns the current zOffset state
  117339. */
  117340. getZOffset(): number;
  117341. /**
  117342. * Enable or disable depth buffering
  117343. * @param enable defines the state to set
  117344. */
  117345. setDepthBuffer(enable: boolean): void;
  117346. /**
  117347. * Gets a boolean indicating if depth writing is enabled
  117348. * @returns the current depth writing state
  117349. */
  117350. getDepthWrite(): boolean;
  117351. /**
  117352. * Enable or disable depth writing
  117353. * @param enable defines the state to set
  117354. */
  117355. setDepthWrite(enable: boolean): void;
  117356. /**
  117357. * Gets a boolean indicating if stencil buffer is enabled
  117358. * @returns the current stencil buffer state
  117359. */
  117360. getStencilBuffer(): boolean;
  117361. /**
  117362. * Enable or disable the stencil buffer
  117363. * @param enable defines if the stencil buffer must be enabled or disabled
  117364. */
  117365. setStencilBuffer(enable: boolean): void;
  117366. /**
  117367. * Gets the current stencil mask
  117368. * @returns a number defining the new stencil mask to use
  117369. */
  117370. getStencilMask(): number;
  117371. /**
  117372. * Sets the current stencil mask
  117373. * @param mask defines the new stencil mask to use
  117374. */
  117375. setStencilMask(mask: number): void;
  117376. /**
  117377. * Gets the current stencil function
  117378. * @returns a number defining the stencil function to use
  117379. */
  117380. getStencilFunction(): number;
  117381. /**
  117382. * Gets the current stencil reference value
  117383. * @returns a number defining the stencil reference value to use
  117384. */
  117385. getStencilFunctionReference(): number;
  117386. /**
  117387. * Gets the current stencil mask
  117388. * @returns a number defining the stencil mask to use
  117389. */
  117390. getStencilFunctionMask(): number;
  117391. /**
  117392. * Sets the current stencil function
  117393. * @param stencilFunc defines the new stencil function to use
  117394. */
  117395. setStencilFunction(stencilFunc: number): void;
  117396. /**
  117397. * Sets the current stencil reference
  117398. * @param reference defines the new stencil reference to use
  117399. */
  117400. setStencilFunctionReference(reference: number): void;
  117401. /**
  117402. * Sets the current stencil mask
  117403. * @param mask defines the new stencil mask to use
  117404. */
  117405. setStencilFunctionMask(mask: number): void;
  117406. /**
  117407. * Gets the current stencil operation when stencil fails
  117408. * @returns a number defining stencil operation to use when stencil fails
  117409. */
  117410. getStencilOperationFail(): number;
  117411. /**
  117412. * Gets the current stencil operation when depth fails
  117413. * @returns a number defining stencil operation to use when depth fails
  117414. */
  117415. getStencilOperationDepthFail(): number;
  117416. /**
  117417. * Gets the current stencil operation when stencil passes
  117418. * @returns a number defining stencil operation to use when stencil passes
  117419. */
  117420. getStencilOperationPass(): number;
  117421. /**
  117422. * Sets the stencil operation to use when stencil fails
  117423. * @param operation defines the stencil operation to use when stencil fails
  117424. */
  117425. setStencilOperationFail(operation: number): void;
  117426. /**
  117427. * Sets the stencil operation to use when depth fails
  117428. * @param operation defines the stencil operation to use when depth fails
  117429. */
  117430. setStencilOperationDepthFail(operation: number): void;
  117431. /**
  117432. * Sets the stencil operation to use when stencil passes
  117433. * @param operation defines the stencil operation to use when stencil passes
  117434. */
  117435. setStencilOperationPass(operation: number): void;
  117436. /**
  117437. * Sets a boolean indicating if the dithering state is enabled or disabled
  117438. * @param value defines the dithering state
  117439. */
  117440. setDitheringState(value: boolean): void;
  117441. /**
  117442. * Sets a boolean indicating if the rasterizer state is enabled or disabled
  117443. * @param value defines the rasterizer state
  117444. */
  117445. setRasterizerState(value: boolean): void;
  117446. /**
  117447. * Gets the current depth function
  117448. * @returns a number defining the depth function
  117449. */
  117450. getDepthFunction(): Nullable<number>;
  117451. /**
  117452. * Sets the current depth function
  117453. * @param depthFunc defines the function to use
  117454. */
  117455. setDepthFunction(depthFunc: number): void;
  117456. /**
  117457. * Sets the current depth function to GREATER
  117458. */
  117459. setDepthFunctionToGreater(): void;
  117460. /**
  117461. * Sets the current depth function to GEQUAL
  117462. */
  117463. setDepthFunctionToGreaterOrEqual(): void;
  117464. /**
  117465. * Sets the current depth function to LESS
  117466. */
  117467. setDepthFunctionToLess(): void;
  117468. /**
  117469. * Sets the current depth function to LEQUAL
  117470. */
  117471. setDepthFunctionToLessOrEqual(): void;
  117472. private _cachedStencilBuffer;
  117473. private _cachedStencilFunction;
  117474. private _cachedStencilMask;
  117475. private _cachedStencilOperationPass;
  117476. private _cachedStencilOperationFail;
  117477. private _cachedStencilOperationDepthFail;
  117478. private _cachedStencilReference;
  117479. /**
  117480. * Caches the the state of the stencil buffer
  117481. */
  117482. cacheStencilState(): void;
  117483. /**
  117484. * Restores the state of the stencil buffer
  117485. */
  117486. restoreStencilState(): void;
  117487. /**
  117488. * Directly set the WebGL Viewport
  117489. * @param x defines the x coordinate of the viewport (in screen space)
  117490. * @param y defines the y coordinate of the viewport (in screen space)
  117491. * @param width defines the width of the viewport (in screen space)
  117492. * @param height defines the height of the viewport (in screen space)
  117493. * @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
  117494. */
  117495. setDirectViewport(x: number, y: number, width: number, height: number): Nullable<IViewportLike>;
  117496. /**
  117497. * Executes a scissor clear (ie. a clear on a specific portion of the screen)
  117498. * @param x defines the x-coordinate of the top left corner of the clear rectangle
  117499. * @param y defines the y-coordinate of the corner of the clear rectangle
  117500. * @param width defines the width of the clear rectangle
  117501. * @param height defines the height of the clear rectangle
  117502. * @param clearColor defines the clear color
  117503. */
  117504. scissorClear(x: number, y: number, width: number, height: number, clearColor: IColor4Like): void;
  117505. /**
  117506. * Enable scissor test on a specific rectangle (ie. render will only be executed on a specific portion of the screen)
  117507. * @param x defines the x-coordinate of the top left corner of the clear rectangle
  117508. * @param y defines the y-coordinate of the corner of the clear rectangle
  117509. * @param width defines the width of the clear rectangle
  117510. * @param height defines the height of the clear rectangle
  117511. */
  117512. enableScissor(x: number, y: number, width: number, height: number): void;
  117513. /**
  117514. * Disable previously set scissor test rectangle
  117515. */
  117516. disableScissor(): void;
  117517. protected _reportDrawCall(): void;
  117518. /**
  117519. * Initializes a webVR display and starts listening to display change events
  117520. * The onVRDisplayChangedObservable will be notified upon these changes
  117521. * @returns The onVRDisplayChangedObservable
  117522. */
  117523. initWebVR(): Observable<IDisplayChangedEventArgs>;
  117524. /** @hidden */
  117525. _prepareVRComponent(): void;
  117526. /** @hidden */
  117527. _connectVREvents(canvas?: HTMLCanvasElement, document?: any): void;
  117528. /** @hidden */
  117529. _submitVRFrame(): void;
  117530. /**
  117531. * Call this function to leave webVR mode
  117532. * Will do nothing if webVR is not supported or if there is no webVR device
  117533. * @see https://doc.babylonjs.com/how_to/webvr_camera
  117534. */
  117535. disableVR(): void;
  117536. /**
  117537. * Gets a boolean indicating that the system is in VR mode and is presenting
  117538. * @returns true if VR mode is engaged
  117539. */
  117540. isVRPresenting(): boolean;
  117541. /** @hidden */
  117542. _requestVRFrame(): void;
  117543. /** @hidden */
  117544. _loadFileAsync(url: string, offlineProvider?: IOfflineProvider, useArrayBuffer?: boolean): Promise<string | ArrayBuffer>;
  117545. /**
  117546. * Gets the source code of the vertex shader associated with a specific webGL program
  117547. * @param program defines the program to use
  117548. * @returns a string containing the source code of the vertex shader associated with the program
  117549. */
  117550. getVertexShaderSource(program: WebGLProgram): Nullable<string>;
  117551. /**
  117552. * Gets the source code of the fragment shader associated with a specific webGL program
  117553. * @param program defines the program to use
  117554. * @returns a string containing the source code of the fragment shader associated with the program
  117555. */
  117556. getFragmentShaderSource(program: WebGLProgram): Nullable<string>;
  117557. /**
  117558. * Sets a depth stencil texture from a render target to the according uniform.
  117559. * @param channel The texture channel
  117560. * @param uniform The uniform to set
  117561. * @param texture The render target texture containing the depth stencil texture to apply
  117562. */
  117563. setDepthStencilTexture(channel: number, uniform: Nullable<WebGLUniformLocation>, texture: Nullable<RenderTargetTexture>): void;
  117564. /**
  117565. * Sets a texture to the webGL context from a postprocess
  117566. * @param channel defines the channel to use
  117567. * @param postProcess defines the source postprocess
  117568. */
  117569. setTextureFromPostProcess(channel: number, postProcess: Nullable<PostProcess>): void;
  117570. /**
  117571. * Binds the output of the passed in post process to the texture channel specified
  117572. * @param channel The channel the texture should be bound to
  117573. * @param postProcess The post process which's output should be bound
  117574. */
  117575. setTextureFromPostProcessOutput(channel: number, postProcess: Nullable<PostProcess>): void;
  117576. protected _rebuildBuffers(): void;
  117577. /** @hidden */
  117578. _renderFrame(): void;
  117579. _renderLoop(): void;
  117580. /** @hidden */
  117581. _renderViews(): boolean;
  117582. /**
  117583. * Toggle full screen mode
  117584. * @param requestPointerLock defines if a pointer lock should be requested from the user
  117585. */
  117586. switchFullscreen(requestPointerLock: boolean): void;
  117587. /**
  117588. * Enters full screen mode
  117589. * @param requestPointerLock defines if a pointer lock should be requested from the user
  117590. */
  117591. enterFullscreen(requestPointerLock: boolean): void;
  117592. /**
  117593. * Exits full screen mode
  117594. */
  117595. exitFullscreen(): void;
  117596. /**
  117597. * Enters Pointerlock mode
  117598. */
  117599. enterPointerlock(): void;
  117600. /**
  117601. * Exits Pointerlock mode
  117602. */
  117603. exitPointerlock(): void;
  117604. /**
  117605. * Begin a new frame
  117606. */
  117607. beginFrame(): void;
  117608. /**
  117609. * Enf the current frame
  117610. */
  117611. endFrame(): void;
  117612. resize(): void;
  117613. /**
  117614. * Force a specific size of the canvas
  117615. * @param width defines the new canvas' width
  117616. * @param height defines the new canvas' height
  117617. * @returns true if the size was changed
  117618. */
  117619. setSize(width: number, height: number): boolean;
  117620. _deletePipelineContext(pipelineContext: IPipelineContext): void;
  117621. createShaderProgram(pipelineContext: IPipelineContext, vertexCode: string, fragmentCode: string, defines: Nullable<string>, context?: WebGLRenderingContext, transformFeedbackVaryings?: Nullable<string[]>): WebGLProgram;
  117622. protected _createShaderProgram(pipelineContext: WebGLPipelineContext, vertexShader: WebGLShader, fragmentShader: WebGLShader, context: WebGLRenderingContext, transformFeedbackVaryings?: Nullable<string[]>): WebGLProgram;
  117623. _releaseTexture(texture: InternalTexture): void;
  117624. /**
  117625. * @hidden
  117626. * Rescales a texture
  117627. * @param source input texutre
  117628. * @param destination destination texture
  117629. * @param scene scene to use to render the resize
  117630. * @param internalFormat format to use when resizing
  117631. * @param onComplete callback to be called when resize has completed
  117632. */
  117633. _rescaleTexture(source: InternalTexture, destination: InternalTexture, scene: Nullable<any>, internalFormat: number, onComplete: () => void): void;
  117634. /**
  117635. * Gets the current framerate
  117636. * @returns a number representing the framerate
  117637. */
  117638. getFps(): number;
  117639. /**
  117640. * Gets the time spent between current and previous frame
  117641. * @returns a number representing the delta time in ms
  117642. */
  117643. getDeltaTime(): number;
  117644. private _measureFps;
  117645. /** @hidden */
  117646. _uploadImageToTexture(texture: InternalTexture, image: HTMLImageElement | ImageBitmap, faceIndex?: number, lod?: number): void;
  117647. /**
  117648. * Updates the sample count of a render target texture
  117649. * @see https://doc.babylonjs.com/features/webgl2#multisample-render-targets
  117650. * @param texture defines the texture to update
  117651. * @param samples defines the sample count to set
  117652. * @returns the effective sample count (could be 0 if multisample render targets are not supported)
  117653. */
  117654. updateRenderTargetTextureSampleCount(texture: Nullable<InternalTexture>, samples: number): number;
  117655. /**
  117656. * Updates a depth texture Comparison Mode and Function.
  117657. * If the comparison Function is equal to 0, the mode will be set to none.
  117658. * Otherwise, this only works in webgl 2 and requires a shadow sampler in the shader.
  117659. * @param texture The texture to set the comparison function for
  117660. * @param comparisonFunction The comparison function to set, 0 if no comparison required
  117661. */
  117662. updateTextureComparisonFunction(texture: InternalTexture, comparisonFunction: number): void;
  117663. /**
  117664. * Creates a webGL buffer to use with instanciation
  117665. * @param capacity defines the size of the buffer
  117666. * @returns the webGL buffer
  117667. */
  117668. createInstancesBuffer(capacity: number): DataBuffer;
  117669. /**
  117670. * Delete a webGL buffer used with instanciation
  117671. * @param buffer defines the webGL buffer to delete
  117672. */
  117673. deleteInstancesBuffer(buffer: WebGLBuffer): void;
  117674. private _clientWaitAsync;
  117675. /** @hidden */
  117676. _readPixelsAsync(x: number, y: number, w: number, h: number, format: number, type: number, outputBuffer: ArrayBufferView): Promise<ArrayBufferView> | null;
  117677. dispose(): void;
  117678. private _disableTouchAction;
  117679. /**
  117680. * Display the loading screen
  117681. * @see https://doc.babylonjs.com/how_to/creating_a_custom_loading_screen
  117682. */
  117683. displayLoadingUI(): void;
  117684. /**
  117685. * Hide the loading screen
  117686. * @see https://doc.babylonjs.com/how_to/creating_a_custom_loading_screen
  117687. */
  117688. hideLoadingUI(): void;
  117689. /**
  117690. * Gets the current loading screen object
  117691. * @see https://doc.babylonjs.com/how_to/creating_a_custom_loading_screen
  117692. */
  117693. get loadingScreen(): ILoadingScreen;
  117694. /**
  117695. * Sets the current loading screen object
  117696. * @see https://doc.babylonjs.com/how_to/creating_a_custom_loading_screen
  117697. */
  117698. set loadingScreen(loadingScreen: ILoadingScreen);
  117699. /**
  117700. * Sets the current loading screen text
  117701. * @see https://doc.babylonjs.com/how_to/creating_a_custom_loading_screen
  117702. */
  117703. set loadingUIText(text: string);
  117704. /**
  117705. * Sets the current loading screen background color
  117706. * @see https://doc.babylonjs.com/how_to/creating_a_custom_loading_screen
  117707. */
  117708. set loadingUIBackgroundColor(color: string);
  117709. /** Pointerlock and fullscreen */
  117710. /**
  117711. * Ask the browser to promote the current element to pointerlock mode
  117712. * @param element defines the DOM element to promote
  117713. */
  117714. static _RequestPointerlock(element: HTMLElement): void;
  117715. /**
  117716. * Asks the browser to exit pointerlock mode
  117717. */
  117718. static _ExitPointerlock(): void;
  117719. /**
  117720. * Ask the browser to promote the current element to fullscreen rendering mode
  117721. * @param element defines the DOM element to promote
  117722. */
  117723. static _RequestFullscreen(element: HTMLElement): void;
  117724. /**
  117725. * Asks the browser to exit fullscreen mode
  117726. */
  117727. static _ExitFullscreen(): void;
  117728. }
  117729. }
  117730. declare module BABYLON {
  117731. /**
  117732. * The engine store class is responsible to hold all the instances of Engine and Scene created
  117733. * during the life time of the application.
  117734. */
  117735. export class EngineStore {
  117736. /** Gets the list of created engines */
  117737. static Instances: Engine[];
  117738. /** @hidden */
  117739. static _LastCreatedScene: Nullable<Scene>;
  117740. /**
  117741. * Gets the latest created engine
  117742. */
  117743. static get LastCreatedEngine(): Nullable<Engine>;
  117744. /**
  117745. * Gets the latest created scene
  117746. */
  117747. static get LastCreatedScene(): Nullable<Scene>;
  117748. /**
  117749. * Gets or sets a global variable indicating if fallback texture must be used when a texture cannot be loaded
  117750. * @ignorenaming
  117751. */
  117752. static UseFallbackTexture: boolean;
  117753. /**
  117754. * Texture content used if a texture cannot loaded
  117755. * @ignorenaming
  117756. */
  117757. static FallbackTexture: string;
  117758. }
  117759. }
  117760. declare module BABYLON {
  117761. /**
  117762. * Helper class that provides a small promise polyfill
  117763. */
  117764. export class PromisePolyfill {
  117765. /**
  117766. * Static function used to check if the polyfill is required
  117767. * If this is the case then the function will inject the polyfill to window.Promise
  117768. * @param force defines a boolean used to force the injection (mostly for testing purposes)
  117769. */
  117770. static Apply(force?: boolean): void;
  117771. }
  117772. }
  117773. declare module BABYLON {
  117774. /**
  117775. * Interface for screenshot methods with describe argument called `size` as object with options
  117776. * @link https://doc.babylonjs.com/api/classes/babylon.screenshottools
  117777. */
  117778. export interface IScreenshotSize {
  117779. /**
  117780. * number in pixels for canvas height
  117781. */
  117782. height?: number;
  117783. /**
  117784. * multiplier allowing render at a higher or lower resolution
  117785. * If value is defined then height and width will be ignored and taken from camera
  117786. */
  117787. precision?: number;
  117788. /**
  117789. * number in pixels for canvas width
  117790. */
  117791. width?: number;
  117792. }
  117793. }
  117794. declare module BABYLON {
  117795. interface IColor4Like {
  117796. r: float;
  117797. g: float;
  117798. b: float;
  117799. a: float;
  117800. }
  117801. /**
  117802. * Class containing a set of static utilities functions
  117803. */
  117804. export class Tools {
  117805. /**
  117806. * Gets or sets the base URL to use to load assets
  117807. */
  117808. static get BaseUrl(): string;
  117809. static set BaseUrl(value: string);
  117810. /**
  117811. * Enable/Disable Custom HTTP Request Headers globally.
  117812. * default = false
  117813. * @see CustomRequestHeaders
  117814. */
  117815. static UseCustomRequestHeaders: boolean;
  117816. /**
  117817. * Custom HTTP Request Headers to be sent with XMLHttpRequests
  117818. * i.e. when loading files, where the server/service expects an Authorization header
  117819. */
  117820. static CustomRequestHeaders: {
  117821. [key: string]: string;
  117822. };
  117823. /**
  117824. * Gets or sets the retry strategy to apply when an error happens while loading an asset
  117825. */
  117826. static get DefaultRetryStrategy(): (url: string, request: WebRequest, retryIndex: number) => number;
  117827. static set DefaultRetryStrategy(strategy: (url: string, request: WebRequest, retryIndex: number) => number);
  117828. /**
  117829. * Default behaviour for cors in the application.
  117830. * It can be a string if the expected behavior is identical in the entire app.
  117831. * Or a callback to be able to set it per url or on a group of them (in case of Video source for instance)
  117832. */
  117833. static get CorsBehavior(): string | ((url: string | string[]) => string);
  117834. static set CorsBehavior(value: string | ((url: string | string[]) => string));
  117835. /**
  117836. * Gets or sets a global variable indicating if fallback texture must be used when a texture cannot be loaded
  117837. * @ignorenaming
  117838. */
  117839. static get UseFallbackTexture(): boolean;
  117840. static set UseFallbackTexture(value: boolean);
  117841. /**
  117842. * Use this object to register external classes like custom textures or material
  117843. * to allow the laoders to instantiate them
  117844. */
  117845. static get RegisteredExternalClasses(): {
  117846. [key: string]: Object;
  117847. };
  117848. static set RegisteredExternalClasses(classes: {
  117849. [key: string]: Object;
  117850. });
  117851. /**
  117852. * Texture content used if a texture cannot loaded
  117853. * @ignorenaming
  117854. */
  117855. static get fallbackTexture(): string;
  117856. static set fallbackTexture(value: string);
  117857. /**
  117858. * Read the content of a byte array at a specified coordinates (taking in account wrapping)
  117859. * @param u defines the coordinate on X axis
  117860. * @param v defines the coordinate on Y axis
  117861. * @param width defines the width of the source data
  117862. * @param height defines the height of the source data
  117863. * @param pixels defines the source byte array
  117864. * @param color defines the output color
  117865. */
  117866. static FetchToRef(u: number, v: number, width: number, height: number, pixels: Uint8Array, color: IColor4Like): void;
  117867. /**
  117868. * Interpolates between a and b via alpha
  117869. * @param a The lower value (returned when alpha = 0)
  117870. * @param b The upper value (returned when alpha = 1)
  117871. * @param alpha The interpolation-factor
  117872. * @return The mixed value
  117873. */
  117874. static Mix(a: number, b: number, alpha: number): number;
  117875. /**
  117876. * Tries to instantiate a new object from a given class name
  117877. * @param className defines the class name to instantiate
  117878. * @returns the new object or null if the system was not able to do the instantiation
  117879. */
  117880. static Instantiate(className: string): any;
  117881. /**
  117882. * Provides a slice function that will work even on IE
  117883. * @param data defines the array to slice
  117884. * @param start defines the start of the data (optional)
  117885. * @param end defines the end of the data (optional)
  117886. * @returns the new sliced array
  117887. */
  117888. static Slice<T>(data: T, start?: number, end?: number): T;
  117889. /**
  117890. * Polyfill for setImmediate
  117891. * @param action defines the action to execute after the current execution block
  117892. */
  117893. static SetImmediate(action: () => void): void;
  117894. /**
  117895. * Function indicating if a number is an exponent of 2
  117896. * @param value defines the value to test
  117897. * @returns true if the value is an exponent of 2
  117898. */
  117899. static IsExponentOfTwo(value: number): boolean;
  117900. private static _tmpFloatArray;
  117901. /**
  117902. * Returns the nearest 32-bit single precision float representation of a Number
  117903. * @param value A Number. If the parameter is of a different type, it will get converted
  117904. * to a number or to NaN if it cannot be converted
  117905. * @returns number
  117906. */
  117907. static FloatRound(value: number): number;
  117908. /**
  117909. * Extracts the filename from a path
  117910. * @param path defines the path to use
  117911. * @returns the filename
  117912. */
  117913. static GetFilename(path: string): string;
  117914. /**
  117915. * Extracts the "folder" part of a path (everything before the filename).
  117916. * @param uri The URI to extract the info from
  117917. * @param returnUnchangedIfNoSlash Do not touch the URI if no slashes are present
  117918. * @returns The "folder" part of the path
  117919. */
  117920. static GetFolderPath(uri: string, returnUnchangedIfNoSlash?: boolean): string;
  117921. /**
  117922. * Extracts text content from a DOM element hierarchy
  117923. * Back Compat only, please use DomManagement.GetDOMTextContent instead.
  117924. */
  117925. static GetDOMTextContent: typeof DomManagement.GetDOMTextContent;
  117926. /**
  117927. * Convert an angle in radians to degrees
  117928. * @param angle defines the angle to convert
  117929. * @returns the angle in degrees
  117930. */
  117931. static ToDegrees(angle: number): number;
  117932. /**
  117933. * Convert an angle in degrees to radians
  117934. * @param angle defines the angle to convert
  117935. * @returns the angle in radians
  117936. */
  117937. static ToRadians(angle: number): number;
  117938. /**
  117939. * Returns an array if obj is not an array
  117940. * @param obj defines the object to evaluate as an array
  117941. * @param allowsNullUndefined defines a boolean indicating if obj is allowed to be null or undefined
  117942. * @returns either obj directly if obj is an array or a new array containing obj
  117943. */
  117944. static MakeArray(obj: any, allowsNullUndefined?: boolean): Nullable<Array<any>>;
  117945. /**
  117946. * Gets the pointer prefix to use
  117947. * @param engine defines the engine we are finding the prefix for
  117948. * @returns "pointer" if touch is enabled. Else returns "mouse"
  117949. */
  117950. static GetPointerPrefix(engine: Engine): string;
  117951. /**
  117952. * Sets the cors behavior on a dom element. This will add the required Tools.CorsBehavior to the element.
  117953. * @param url define the url we are trying
  117954. * @param element define the dom element where to configure the cors policy
  117955. */
  117956. static SetCorsBehavior(url: string | string[], element: {
  117957. crossOrigin: string | null;
  117958. }): void;
  117959. /**
  117960. * Removes unwanted characters from an url
  117961. * @param url defines the url to clean
  117962. * @returns the cleaned url
  117963. */
  117964. static CleanUrl(url: string): string;
  117965. /**
  117966. * Gets or sets a function used to pre-process url before using them to load assets
  117967. */
  117968. static get PreprocessUrl(): (url: string) => string;
  117969. static set PreprocessUrl(processor: (url: string) => string);
  117970. /**
  117971. * Loads an image as an HTMLImageElement.
  117972. * @param input url string, ArrayBuffer, or Blob to load
  117973. * @param onLoad callback called when the image successfully loads
  117974. * @param onError callback called when the image fails to load
  117975. * @param offlineProvider offline provider for caching
  117976. * @param mimeType optional mime type
  117977. * @returns the HTMLImageElement of the loaded image
  117978. */
  117979. static LoadImage(input: string | ArrayBuffer | Blob, onLoad: (img: HTMLImageElement | ImageBitmap) => void, onError: (message?: string, exception?: any) => void, offlineProvider: Nullable<IOfflineProvider>, mimeType?: string): Nullable<HTMLImageElement>;
  117980. /**
  117981. * Loads a file from a url
  117982. * @param url url string, ArrayBuffer, or Blob to load
  117983. * @param onSuccess callback called when the file successfully loads
  117984. * @param onProgress callback called while file is loading (if the server supports this mode)
  117985. * @param offlineProvider defines the offline provider for caching
  117986. * @param useArrayBuffer defines a boolean indicating that date must be returned as ArrayBuffer
  117987. * @param onError callback called when the file fails to load
  117988. * @returns a file request object
  117989. */
  117990. 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;
  117991. /**
  117992. * Loads a file from a url
  117993. * @param url the file url to load
  117994. * @param useArrayBuffer defines a boolean indicating that date must be returned as ArrayBuffer
  117995. * @returns a promise containing an ArrayBuffer corresponding to the loaded file
  117996. */
  117997. static LoadFileAsync(url: string, useArrayBuffer?: boolean): Promise<ArrayBuffer | string>;
  117998. /**
  117999. * Load a script (identified by an url). When the url returns, the
  118000. * content of this file is added into a new script element, attached to the DOM (body element)
  118001. * @param scriptUrl defines the url of the script to laod
  118002. * @param onSuccess defines the callback called when the script is loaded
  118003. * @param onError defines the callback to call if an error occurs
  118004. * @param scriptId defines the id of the script element
  118005. */
  118006. static LoadScript(scriptUrl: string, onSuccess: () => void, onError?: (message?: string, exception?: any) => void, scriptId?: string): void;
  118007. /**
  118008. * Load an asynchronous script (identified by an url). When the url returns, the
  118009. * content of this file is added into a new script element, attached to the DOM (body element)
  118010. * @param scriptUrl defines the url of the script to laod
  118011. * @param scriptId defines the id of the script element
  118012. * @returns a promise request object
  118013. */
  118014. static LoadScriptAsync(scriptUrl: string, scriptId?: string): Promise<void>;
  118015. /**
  118016. * Loads a file from a blob
  118017. * @param fileToLoad defines the blob to use
  118018. * @param callback defines the callback to call when data is loaded
  118019. * @param progressCallback defines the callback to call during loading process
  118020. * @returns a file request object
  118021. */
  118022. static ReadFileAsDataURL(fileToLoad: Blob, callback: (data: any) => void, progressCallback: (ev: ProgressEvent) => any): IFileRequest;
  118023. /**
  118024. * Reads a file from a File object
  118025. * @param file defines the file to load
  118026. * @param onSuccess defines the callback to call when data is loaded
  118027. * @param onProgress defines the callback to call during loading process
  118028. * @param useArrayBuffer defines a boolean indicating that data must be returned as an ArrayBuffer
  118029. * @param onError defines the callback to call when an error occurs
  118030. * @returns a file request object
  118031. */
  118032. static ReadFile(file: File, onSuccess: (data: any) => void, onProgress?: (ev: ProgressEvent) => any, useArrayBuffer?: boolean, onError?: (error: ReadFileError) => void): IFileRequest;
  118033. /**
  118034. * Creates a data url from a given string content
  118035. * @param content defines the content to convert
  118036. * @returns the new data url link
  118037. */
  118038. static FileAsURL(content: string): string;
  118039. /**
  118040. * Format the given number to a specific decimal format
  118041. * @param value defines the number to format
  118042. * @param decimals defines the number of decimals to use
  118043. * @returns the formatted string
  118044. */
  118045. static Format(value: number, decimals?: number): string;
  118046. /**
  118047. * Tries to copy an object by duplicating every property
  118048. * @param source defines the source object
  118049. * @param destination defines the target object
  118050. * @param doNotCopyList defines a list of properties to avoid
  118051. * @param mustCopyList defines a list of properties to copy (even if they start with _)
  118052. */
  118053. static DeepCopy(source: any, destination: any, doNotCopyList?: string[], mustCopyList?: string[]): void;
  118054. /**
  118055. * Gets a boolean indicating if the given object has no own property
  118056. * @param obj defines the object to test
  118057. * @returns true if object has no own property
  118058. */
  118059. static IsEmpty(obj: any): boolean;
  118060. /**
  118061. * Function used to register events at window level
  118062. * @param windowElement defines the Window object to use
  118063. * @param events defines the events to register
  118064. */
  118065. static RegisterTopRootEvents(windowElement: Window, events: {
  118066. name: string;
  118067. handler: Nullable<(e: FocusEvent) => any>;
  118068. }[]): void;
  118069. /**
  118070. * Function used to unregister events from window level
  118071. * @param windowElement defines the Window object to use
  118072. * @param events defines the events to unregister
  118073. */
  118074. static UnregisterTopRootEvents(windowElement: Window, events: {
  118075. name: string;
  118076. handler: Nullable<(e: FocusEvent) => any>;
  118077. }[]): void;
  118078. /**
  118079. * @ignore
  118080. */
  118081. static _ScreenshotCanvas: HTMLCanvasElement;
  118082. /**
  118083. * Dumps the current bound framebuffer
  118084. * @param width defines the rendering width
  118085. * @param height defines the rendering height
  118086. * @param engine defines the hosting engine
  118087. * @param successCallback defines the callback triggered once the data are available
  118088. * @param mimeType defines the mime type of the result
  118089. * @param fileName defines the filename to download. If present, the result will automatically be downloaded
  118090. */
  118091. static DumpFramebuffer(width: number, height: number, engine: Engine, successCallback?: (data: string) => void, mimeType?: string, fileName?: string): void;
  118092. /**
  118093. * Converts the canvas data to blob.
  118094. * This acts as a polyfill for browsers not supporting the to blob function.
  118095. * @param canvas Defines the canvas to extract the data from
  118096. * @param successCallback Defines the callback triggered once the data are available
  118097. * @param mimeType Defines the mime type of the result
  118098. */
  118099. static ToBlob(canvas: HTMLCanvasElement, successCallback: (blob: Nullable<Blob>) => void, mimeType?: string): void;
  118100. /**
  118101. * Encodes the canvas data to base 64 or automatically download the result if filename is defined
  118102. * @param successCallback defines the callback triggered once the data are available
  118103. * @param mimeType defines the mime type of the result
  118104. * @param fileName defines he filename to download. If present, the result will automatically be downloaded
  118105. */
  118106. static EncodeScreenshotCanvasData(successCallback?: (data: string) => void, mimeType?: string, fileName?: string): void;
  118107. /**
  118108. * Downloads a blob in the browser
  118109. * @param blob defines the blob to download
  118110. * @param fileName defines the name of the downloaded file
  118111. */
  118112. static Download(blob: Blob, fileName: string): void;
  118113. /**
  118114. * Captures a screenshot of the current rendering
  118115. * @see https://doc.babylonjs.com/how_to/render_scene_on_a_png
  118116. * @param engine defines the rendering engine
  118117. * @param camera defines the source camera
  118118. * @param size This parameter can be set to a single number or to an object with the
  118119. * following (optional) properties: precision, width, height. If a single number is passed,
  118120. * it will be used for both width and height. If an object is passed, the screenshot size
  118121. * will be derived from the parameters. The precision property is a multiplier allowing
  118122. * rendering at a higher or lower resolution
  118123. * @param successCallback defines the callback receives a single parameter which contains the
  118124. * screenshot as a string of base64-encoded characters. This string can be assigned to the
  118125. * src parameter of an <img> to display it
  118126. * @param mimeType defines the MIME type of the screenshot image (default: image/png).
  118127. * Check your browser for supported MIME types
  118128. */
  118129. static CreateScreenshot(engine: Engine, camera: Camera, size: IScreenshotSize | number, successCallback?: (data: string) => void, mimeType?: string): void;
  118130. /**
  118131. * Captures a screenshot of the current rendering
  118132. * @see https://doc.babylonjs.com/how_to/render_scene_on_a_png
  118133. * @param engine defines the rendering engine
  118134. * @param camera defines the source camera
  118135. * @param size This parameter can be set to a single number or to an object with the
  118136. * following (optional) properties: precision, width, height. If a single number is passed,
  118137. * it will be used for both width and height. If an object is passed, the screenshot size
  118138. * will be derived from the parameters. The precision property is a multiplier allowing
  118139. * rendering at a higher or lower resolution
  118140. * @param mimeType defines the MIME type of the screenshot image (default: image/png).
  118141. * Check your browser for supported MIME types
  118142. * @returns screenshot as a string of base64-encoded characters. This string can be assigned
  118143. * to the src parameter of an <img> to display it
  118144. */
  118145. static CreateScreenshotAsync(engine: Engine, camera: Camera, size: IScreenshotSize | number, mimeType?: string): Promise<string>;
  118146. /**
  118147. * Generates an image screenshot from the specified camera.
  118148. * @see https://doc.babylonjs.com/how_to/render_scene_on_a_png
  118149. * @param engine The engine to use for rendering
  118150. * @param camera The camera to use for rendering
  118151. * @param size This parameter can be set to a single number or to an object with the
  118152. * following (optional) properties: precision, width, height. If a single number is passed,
  118153. * it will be used for both width and height. If an object is passed, the screenshot size
  118154. * will be derived from the parameters. The precision property is a multiplier allowing
  118155. * rendering at a higher or lower resolution
  118156. * @param successCallback The callback receives a single parameter which contains the
  118157. * screenshot as a string of base64-encoded characters. This string can be assigned to the
  118158. * src parameter of an <img> to display it
  118159. * @param mimeType The MIME type of the screenshot image (default: image/png).
  118160. * Check your browser for supported MIME types
  118161. * @param samples Texture samples (default: 1)
  118162. * @param antialiasing Whether antialiasing should be turned on or not (default: false)
  118163. * @param fileName A name for for the downloaded file.
  118164. */
  118165. static CreateScreenshotUsingRenderTarget(engine: Engine, camera: Camera, size: IScreenshotSize | number, successCallback?: (data: string) => void, mimeType?: string, samples?: number, antialiasing?: boolean, fileName?: string): void;
  118166. /**
  118167. * Generates an image screenshot from the specified camera.
  118168. * @see https://doc.babylonjs.com/how_to/render_scene_on_a_png
  118169. * @param engine The engine to use for rendering
  118170. * @param camera The camera to use for rendering
  118171. * @param size This parameter can be set to a single number or to an object with the
  118172. * following (optional) properties: precision, width, height. If a single number is passed,
  118173. * it will be used for both width and height. If an object is passed, the screenshot size
  118174. * will be derived from the parameters. The precision property is a multiplier allowing
  118175. * rendering at a higher or lower resolution
  118176. * @param mimeType The MIME type of the screenshot image (default: image/png).
  118177. * Check your browser for supported MIME types
  118178. * @param samples Texture samples (default: 1)
  118179. * @param antialiasing Whether antialiasing should be turned on or not (default: false)
  118180. * @param fileName A name for for the downloaded file.
  118181. * @returns screenshot as a string of base64-encoded characters. This string can be assigned
  118182. * to the src parameter of an <img> to display it
  118183. */
  118184. static CreateScreenshotUsingRenderTargetAsync(engine: Engine, camera: Camera, size: IScreenshotSize | number, mimeType?: string, samples?: number, antialiasing?: boolean, fileName?: string): Promise<string>;
  118185. /**
  118186. * Implementation from http://stackoverflow.com/questions/105034/how-to-create-a-guid-uuid-in-javascript/2117523#answer-2117523
  118187. * Be aware Math.random() could cause collisions, but:
  118188. * "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"
  118189. * @returns a pseudo random id
  118190. */
  118191. static RandomId(): string;
  118192. /**
  118193. * Test if the given uri is a base64 string
  118194. * @param uri The uri to test
  118195. * @return True if the uri is a base64 string or false otherwise
  118196. */
  118197. static IsBase64(uri: string): boolean;
  118198. /**
  118199. * Decode the given base64 uri.
  118200. * @param uri The uri to decode
  118201. * @return The decoded base64 data.
  118202. */
  118203. static DecodeBase64(uri: string): ArrayBuffer;
  118204. /**
  118205. * Gets the absolute url.
  118206. * @param url the input url
  118207. * @return the absolute url
  118208. */
  118209. static GetAbsoluteUrl(url: string): string;
  118210. /**
  118211. * No log
  118212. */
  118213. static readonly NoneLogLevel: number;
  118214. /**
  118215. * Only message logs
  118216. */
  118217. static readonly MessageLogLevel: number;
  118218. /**
  118219. * Only warning logs
  118220. */
  118221. static readonly WarningLogLevel: number;
  118222. /**
  118223. * Only error logs
  118224. */
  118225. static readonly ErrorLogLevel: number;
  118226. /**
  118227. * All logs
  118228. */
  118229. static readonly AllLogLevel: number;
  118230. /**
  118231. * Gets a value indicating the number of loading errors
  118232. * @ignorenaming
  118233. */
  118234. static get errorsCount(): number;
  118235. /**
  118236. * Callback called when a new log is added
  118237. */
  118238. static OnNewCacheEntry: (entry: string) => void;
  118239. /**
  118240. * Log a message to the console
  118241. * @param message defines the message to log
  118242. */
  118243. static Log(message: string): void;
  118244. /**
  118245. * Write a warning message to the console
  118246. * @param message defines the message to log
  118247. */
  118248. static Warn(message: string): void;
  118249. /**
  118250. * Write an error message to the console
  118251. * @param message defines the message to log
  118252. */
  118253. static Error(message: string): void;
  118254. /**
  118255. * Gets current log cache (list of logs)
  118256. */
  118257. static get LogCache(): string;
  118258. /**
  118259. * Clears the log cache
  118260. */
  118261. static ClearLogCache(): void;
  118262. /**
  118263. * Sets the current log level (MessageLogLevel / WarningLogLevel / ErrorLogLevel)
  118264. */
  118265. static set LogLevels(level: number);
  118266. /**
  118267. * Checks if the window object exists
  118268. * Back Compat only, please use DomManagement.IsWindowObjectExist instead.
  118269. */
  118270. static IsWindowObjectExist: typeof DomManagement.IsWindowObjectExist;
  118271. /**
  118272. * No performance log
  118273. */
  118274. static readonly PerformanceNoneLogLevel: number;
  118275. /**
  118276. * Use user marks to log performance
  118277. */
  118278. static readonly PerformanceUserMarkLogLevel: number;
  118279. /**
  118280. * Log performance to the console
  118281. */
  118282. static readonly PerformanceConsoleLogLevel: number;
  118283. private static _performance;
  118284. /**
  118285. * Sets the current performance log level
  118286. */
  118287. static set PerformanceLogLevel(level: number);
  118288. private static _StartPerformanceCounterDisabled;
  118289. private static _EndPerformanceCounterDisabled;
  118290. private static _StartUserMark;
  118291. private static _EndUserMark;
  118292. private static _StartPerformanceConsole;
  118293. private static _EndPerformanceConsole;
  118294. /**
  118295. * Starts a performance counter
  118296. */
  118297. static StartPerformanceCounter: (counterName: string, condition?: boolean) => void;
  118298. /**
  118299. * Ends a specific performance coutner
  118300. */
  118301. static EndPerformanceCounter: (counterName: string, condition?: boolean) => void;
  118302. /**
  118303. * Gets either window.performance.now() if supported or Date.now() else
  118304. */
  118305. static get Now(): number;
  118306. /**
  118307. * This method will return the name of the class used to create the instance of the given object.
  118308. * It will works only on Javascript basic data types (number, string, ...) and instance of class declared with the @className decorator.
  118309. * @param object the object to get the class name from
  118310. * @param isType defines if the object is actually a type
  118311. * @returns the name of the class, will be "object" for a custom data type not using the @className decorator
  118312. */
  118313. static GetClassName(object: any, isType?: boolean): string;
  118314. /**
  118315. * Gets the first element of an array satisfying a given predicate
  118316. * @param array defines the array to browse
  118317. * @param predicate defines the predicate to use
  118318. * @returns null if not found or the element
  118319. */
  118320. static First<T>(array: Array<T>, predicate: (item: T) => boolean): Nullable<T>;
  118321. /**
  118322. * This method will return the name of the full name of the class, including its owning module (if any).
  118323. * 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).
  118324. * @param object the object to get the class name from
  118325. * @param isType defines if the object is actually a type
  118326. * @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.
  118327. * @ignorenaming
  118328. */
  118329. static getFullClassName(object: any, isType?: boolean): Nullable<string>;
  118330. /**
  118331. * Returns a promise that resolves after the given amount of time.
  118332. * @param delay Number of milliseconds to delay
  118333. * @returns Promise that resolves after the given amount of time
  118334. */
  118335. static DelayAsync(delay: number): Promise<void>;
  118336. /**
  118337. * Utility function to detect if the current user agent is Safari
  118338. * @returns whether or not the current user agent is safari
  118339. */
  118340. static IsSafari(): boolean;
  118341. }
  118342. /**
  118343. * Use this className as a decorator on a given class definition to add it a name and optionally its module.
  118344. * You can then use the Tools.getClassName(obj) on an instance to retrieve its class name.
  118345. * This method is the only way to get it done in all cases, even if the .js file declaring the class is minified
  118346. * @param name The name of the class, case should be preserved
  118347. * @param module The name of the Module hosting the class, optional, but strongly recommended to specify if possible. Case should be preserved.
  118348. */
  118349. export function className(name: string, module?: string): (target: Object) => void;
  118350. /**
  118351. * An implementation of a loop for asynchronous functions.
  118352. */
  118353. export class AsyncLoop {
  118354. /**
  118355. * Defines the number of iterations for the loop
  118356. */
  118357. iterations: number;
  118358. /**
  118359. * Defines the current index of the loop.
  118360. */
  118361. index: number;
  118362. private _done;
  118363. private _fn;
  118364. private _successCallback;
  118365. /**
  118366. * Constructor.
  118367. * @param iterations the number of iterations.
  118368. * @param func the function to run each iteration
  118369. * @param successCallback the callback that will be called upon succesful execution
  118370. * @param offset starting offset.
  118371. */
  118372. constructor(
  118373. /**
  118374. * Defines the number of iterations for the loop
  118375. */
  118376. iterations: number, func: (asyncLoop: AsyncLoop) => void, successCallback: () => void, offset?: number);
  118377. /**
  118378. * Execute the next iteration. Must be called after the last iteration was finished.
  118379. */
  118380. executeNext(): void;
  118381. /**
  118382. * Break the loop and run the success callback.
  118383. */
  118384. breakLoop(): void;
  118385. /**
  118386. * Create and run an async loop.
  118387. * @param iterations the number of iterations.
  118388. * @param fn the function to run each iteration
  118389. * @param successCallback the callback that will be called upon succesful execution
  118390. * @param offset starting offset.
  118391. * @returns the created async loop object
  118392. */
  118393. static Run(iterations: number, fn: (asyncLoop: AsyncLoop) => void, successCallback: () => void, offset?: number): AsyncLoop;
  118394. /**
  118395. * A for-loop that will run a given number of iterations synchronous and the rest async.
  118396. * @param iterations total number of iterations
  118397. * @param syncedIterations number of synchronous iterations in each async iteration.
  118398. * @param fn the function to call each iteration.
  118399. * @param callback a success call back that will be called when iterating stops.
  118400. * @param breakFunction a break condition (optional)
  118401. * @param timeout timeout settings for the setTimeout function. default - 0.
  118402. * @returns the created async loop object
  118403. */
  118404. static SyncAsyncForLoop(iterations: number, syncedIterations: number, fn: (iteration: number) => void, callback: () => void, breakFunction?: () => boolean, timeout?: number): AsyncLoop;
  118405. }
  118406. }
  118407. declare module BABYLON {
  118408. /**
  118409. * This class implement a typical dictionary using a string as key and the generic type T as value.
  118410. * The underlying implementation relies on an associative array to ensure the best performances.
  118411. * The value can be anything including 'null' but except 'undefined'
  118412. */
  118413. export class StringDictionary<T> {
  118414. /**
  118415. * This will clear this dictionary and copy the content from the 'source' one.
  118416. * If the T value is a custom object, it won't be copied/cloned, the same object will be used
  118417. * @param source the dictionary to take the content from and copy to this dictionary
  118418. */
  118419. copyFrom(source: StringDictionary<T>): void;
  118420. /**
  118421. * Get a value based from its key
  118422. * @param key the given key to get the matching value from
  118423. * @return the value if found, otherwise undefined is returned
  118424. */
  118425. get(key: string): T | undefined;
  118426. /**
  118427. * Get a value from its key or add it if it doesn't exist.
  118428. * This method will ensure you that a given key/data will be present in the dictionary.
  118429. * @param key the given key to get the matching value from
  118430. * @param factory the factory that will create the value if the key is not present in the dictionary.
  118431. * The factory will only be invoked if there's no data for the given key.
  118432. * @return the value corresponding to the key.
  118433. */
  118434. getOrAddWithFactory(key: string, factory: (key: string) => T): T;
  118435. /**
  118436. * Get a value from its key if present in the dictionary otherwise add it
  118437. * @param key the key to get the value from
  118438. * @param val if there's no such key/value pair in the dictionary add it with this value
  118439. * @return the value corresponding to the key
  118440. */
  118441. getOrAdd(key: string, val: T): T;
  118442. /**
  118443. * Check if there's a given key in the dictionary
  118444. * @param key the key to check for
  118445. * @return true if the key is present, false otherwise
  118446. */
  118447. contains(key: string): boolean;
  118448. /**
  118449. * Add a new key and its corresponding value
  118450. * @param key the key to add
  118451. * @param value the value corresponding to the key
  118452. * @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
  118453. */
  118454. add(key: string, value: T): boolean;
  118455. /**
  118456. * Update a specific value associated to a key
  118457. * @param key defines the key to use
  118458. * @param value defines the value to store
  118459. * @returns true if the value was updated (or false if the key was not found)
  118460. */
  118461. set(key: string, value: T): boolean;
  118462. /**
  118463. * Get the element of the given key and remove it from the dictionary
  118464. * @param key defines the key to search
  118465. * @returns the value associated with the key or null if not found
  118466. */
  118467. getAndRemove(key: string): Nullable<T>;
  118468. /**
  118469. * Remove a key/value from the dictionary.
  118470. * @param key the key to remove
  118471. * @return true if the item was successfully deleted, false if no item with such key exist in the dictionary
  118472. */
  118473. remove(key: string): boolean;
  118474. /**
  118475. * Clear the whole content of the dictionary
  118476. */
  118477. clear(): void;
  118478. /**
  118479. * Gets the current count
  118480. */
  118481. get count(): number;
  118482. /**
  118483. * Execute a callback on each key/val of the dictionary.
  118484. * Note that you can remove any element in this dictionary in the callback implementation
  118485. * @param callback the callback to execute on a given key/value pair
  118486. */
  118487. forEach(callback: (key: string, val: T) => void): void;
  118488. /**
  118489. * Execute a callback on every occurrence of the dictionary until it returns a valid TRes object.
  118490. * If the callback returns null or undefined the method will iterate to the next key/value pair
  118491. * Note that you can remove any element in this dictionary in the callback implementation
  118492. * @param callback the callback to execute, if it return a valid T instanced object the enumeration will stop and the object will be returned
  118493. * @returns the first item
  118494. */
  118495. first<TRes>(callback: (key: string, val: T) => TRes): TRes | null;
  118496. private _count;
  118497. private _data;
  118498. }
  118499. }
  118500. declare module BABYLON {
  118501. /** @hidden */
  118502. export interface ICollisionCoordinator {
  118503. createCollider(): Collider;
  118504. getNewPosition(position: Vector3, displacement: Vector3, collider: Collider, maximumRetry: number, excludedMesh: Nullable<AbstractMesh>, onNewPosition: (collisionIndex: number, newPosition: Vector3, collidedMesh: Nullable<AbstractMesh>) => void, collisionIndex: number): void;
  118505. init(scene: Scene): void;
  118506. }
  118507. /** @hidden */
  118508. export class DefaultCollisionCoordinator implements ICollisionCoordinator {
  118509. private _scene;
  118510. private _scaledPosition;
  118511. private _scaledVelocity;
  118512. private _finalPosition;
  118513. getNewPosition(position: Vector3, displacement: Vector3, collider: Collider, maximumRetry: number, excludedMesh: AbstractMesh, onNewPosition: (collisionIndex: number, newPosition: Vector3, collidedMesh: Nullable<AbstractMesh>) => void, collisionIndex: number): void;
  118514. createCollider(): Collider;
  118515. init(scene: Scene): void;
  118516. private _collideWithWorld;
  118517. }
  118518. }
  118519. declare module BABYLON {
  118520. /**
  118521. * Class used to manage all inputs for the scene.
  118522. */
  118523. export class InputManager {
  118524. /** The distance in pixel that you have to move to prevent some events */
  118525. static DragMovementThreshold: number;
  118526. /** Time in milliseconds to wait to raise long press events if button is still pressed */
  118527. static LongPressDelay: number;
  118528. /** Time in milliseconds with two consecutive clicks will be considered as a double click */
  118529. static DoubleClickDelay: number;
  118530. /** If you need to check double click without raising a single click at first click, enable this flag */
  118531. static ExclusiveDoubleClickMode: boolean;
  118532. /** 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. */
  118533. private _alreadyAttached;
  118534. private _wheelEventName;
  118535. private _onPointerMove;
  118536. private _onPointerDown;
  118537. private _onPointerUp;
  118538. private _initClickEvent;
  118539. private _initActionManager;
  118540. private _delayedSimpleClick;
  118541. private _delayedSimpleClickTimeout;
  118542. private _previousDelayedSimpleClickTimeout;
  118543. private _meshPickProceed;
  118544. private _previousButtonPressed;
  118545. private _currentPickResult;
  118546. private _previousPickResult;
  118547. private _totalPointersPressed;
  118548. private _doubleClickOccured;
  118549. private _pointerOverMesh;
  118550. private _pickedDownMesh;
  118551. private _pickedUpMesh;
  118552. private _pointerX;
  118553. private _pointerY;
  118554. private _unTranslatedPointerX;
  118555. private _unTranslatedPointerY;
  118556. private _startingPointerPosition;
  118557. private _previousStartingPointerPosition;
  118558. private _startingPointerTime;
  118559. private _previousStartingPointerTime;
  118560. private _pointerCaptures;
  118561. private _onKeyDown;
  118562. private _onKeyUp;
  118563. private _onCanvasFocusObserver;
  118564. private _onCanvasBlurObserver;
  118565. private _scene;
  118566. /**
  118567. * Creates a new InputManager
  118568. * @param scene defines the hosting scene
  118569. */
  118570. constructor(scene: Scene);
  118571. /**
  118572. * Gets the mesh that is currently under the pointer
  118573. */
  118574. get meshUnderPointer(): Nullable<AbstractMesh>;
  118575. /**
  118576. * Gets the pointer coordinates in 2D without any translation (ie. straight out of the pointer event)
  118577. */
  118578. get unTranslatedPointer(): Vector2;
  118579. /**
  118580. * Gets or sets the current on-screen X position of the pointer
  118581. */
  118582. get pointerX(): number;
  118583. set pointerX(value: number);
  118584. /**
  118585. * Gets or sets the current on-screen Y position of the pointer
  118586. */
  118587. get pointerY(): number;
  118588. set pointerY(value: number);
  118589. private _updatePointerPosition;
  118590. private _processPointerMove;
  118591. private _setRayOnPointerInfo;
  118592. private _checkPrePointerObservable;
  118593. /**
  118594. * Use this method to simulate a pointer move on a mesh
  118595. * The pickResult parameter can be obtained from a scene.pick or scene.pickWithRay
  118596. * @param pickResult pickingInfo of the object wished to simulate pointer event on
  118597. * @param pointerEventInit pointer event state to be used when simulating the pointer event (eg. pointer id for multitouch)
  118598. */
  118599. simulatePointerMove(pickResult: PickingInfo, pointerEventInit?: PointerEventInit): void;
  118600. /**
  118601. * Use this method to simulate a pointer down on a mesh
  118602. * The pickResult parameter can be obtained from a scene.pick or scene.pickWithRay
  118603. * @param pickResult pickingInfo of the object wished to simulate pointer event on
  118604. * @param pointerEventInit pointer event state to be used when simulating the pointer event (eg. pointer id for multitouch)
  118605. */
  118606. simulatePointerDown(pickResult: PickingInfo, pointerEventInit?: PointerEventInit): void;
  118607. private _processPointerDown;
  118608. /** @hidden */
  118609. _isPointerSwiping(): boolean;
  118610. /**
  118611. * Use this method to simulate a pointer up on a mesh
  118612. * The pickResult parameter can be obtained from a scene.pick or scene.pickWithRay
  118613. * @param pickResult pickingInfo of the object wished to simulate pointer event on
  118614. * @param pointerEventInit pointer event state to be used when simulating the pointer event (eg. pointer id for multitouch)
  118615. * @param doubleTap indicates that the pointer up event should be considered as part of a double click (false by default)
  118616. */
  118617. simulatePointerUp(pickResult: PickingInfo, pointerEventInit?: PointerEventInit, doubleTap?: boolean): void;
  118618. private _processPointerUp;
  118619. /**
  118620. * Gets a boolean indicating if the current pointer event is captured (meaning that the scene has already handled the pointer down)
  118621. * @param pointerId defines the pointer id to use in a multi-touch scenario (0 by default)
  118622. * @returns true if the pointer was captured
  118623. */
  118624. isPointerCaptured(pointerId?: number): boolean;
  118625. /**
  118626. * Attach events to the canvas (To handle actionManagers triggers and raise onPointerMove, onPointerDown and onPointerUp
  118627. * @param attachUp defines if you want to attach events to pointerup
  118628. * @param attachDown defines if you want to attach events to pointerdown
  118629. * @param attachMove defines if you want to attach events to pointermove
  118630. * @param elementToAttachTo defines the target DOM element to attach to (will use the canvas by default)
  118631. */
  118632. attachControl(attachUp?: boolean, attachDown?: boolean, attachMove?: boolean, elementToAttachTo?: Nullable<HTMLElement>): void;
  118633. /**
  118634. * Detaches all event handlers
  118635. */
  118636. detachControl(): void;
  118637. /**
  118638. * Force the value of meshUnderPointer
  118639. * @param mesh defines the mesh to use
  118640. */
  118641. setPointerOverMesh(mesh: Nullable<AbstractMesh>): void;
  118642. /**
  118643. * Gets the mesh under the pointer
  118644. * @returns a Mesh or null if no mesh is under the pointer
  118645. */
  118646. getPointerOverMesh(): Nullable<AbstractMesh>;
  118647. }
  118648. }
  118649. declare module BABYLON {
  118650. /**
  118651. * This class defines the direct association between an animation and a target
  118652. */
  118653. export class TargetedAnimation {
  118654. /**
  118655. * Animation to perform
  118656. */
  118657. animation: Animation;
  118658. /**
  118659. * Target to animate
  118660. */
  118661. target: any;
  118662. /**
  118663. * Returns the string "TargetedAnimation"
  118664. * @returns "TargetedAnimation"
  118665. */
  118666. getClassName(): string;
  118667. /**
  118668. * Serialize the object
  118669. * @returns the JSON object representing the current entity
  118670. */
  118671. serialize(): any;
  118672. }
  118673. /**
  118674. * Use this class to create coordinated animations on multiple targets
  118675. */
  118676. export class AnimationGroup implements IDisposable {
  118677. /** The name of the animation group */
  118678. name: string;
  118679. private _scene;
  118680. private _targetedAnimations;
  118681. private _animatables;
  118682. private _from;
  118683. private _to;
  118684. private _isStarted;
  118685. private _isPaused;
  118686. private _speedRatio;
  118687. private _loopAnimation;
  118688. private _isAdditive;
  118689. /**
  118690. * Gets or sets the unique id of the node
  118691. */
  118692. uniqueId: number;
  118693. /**
  118694. * This observable will notify when one animation have ended
  118695. */
  118696. onAnimationEndObservable: Observable<TargetedAnimation>;
  118697. /**
  118698. * Observer raised when one animation loops
  118699. */
  118700. onAnimationLoopObservable: Observable<TargetedAnimation>;
  118701. /**
  118702. * Observer raised when all animations have looped
  118703. */
  118704. onAnimationGroupLoopObservable: Observable<AnimationGroup>;
  118705. /**
  118706. * This observable will notify when all animations have ended.
  118707. */
  118708. onAnimationGroupEndObservable: Observable<AnimationGroup>;
  118709. /**
  118710. * This observable will notify when all animations have paused.
  118711. */
  118712. onAnimationGroupPauseObservable: Observable<AnimationGroup>;
  118713. /**
  118714. * This observable will notify when all animations are playing.
  118715. */
  118716. onAnimationGroupPlayObservable: Observable<AnimationGroup>;
  118717. /**
  118718. * Gets the first frame
  118719. */
  118720. get from(): number;
  118721. /**
  118722. * Gets the last frame
  118723. */
  118724. get to(): number;
  118725. /**
  118726. * Define if the animations are started
  118727. */
  118728. get isStarted(): boolean;
  118729. /**
  118730. * Gets a value indicating that the current group is playing
  118731. */
  118732. get isPlaying(): boolean;
  118733. /**
  118734. * Gets or sets the speed ratio to use for all animations
  118735. */
  118736. get speedRatio(): number;
  118737. /**
  118738. * Gets or sets the speed ratio to use for all animations
  118739. */
  118740. set speedRatio(value: number);
  118741. /**
  118742. * Gets or sets if all animations should loop or not
  118743. */
  118744. get loopAnimation(): boolean;
  118745. set loopAnimation(value: boolean);
  118746. /**
  118747. * Gets or sets if all animations should be evaluated additively
  118748. */
  118749. get isAdditive(): boolean;
  118750. set isAdditive(value: boolean);
  118751. /**
  118752. * Gets the targeted animations for this animation group
  118753. */
  118754. get targetedAnimations(): Array<TargetedAnimation>;
  118755. /**
  118756. * returning the list of animatables controlled by this animation group.
  118757. */
  118758. get animatables(): Array<Animatable>;
  118759. /**
  118760. * Gets the list of target animations
  118761. */
  118762. get children(): TargetedAnimation[];
  118763. /**
  118764. * Instantiates a new Animation Group.
  118765. * This helps managing several animations at once.
  118766. * @see https://doc.babylonjs.com/how_to/group
  118767. * @param name Defines the name of the group
  118768. * @param scene Defines the scene the group belongs to
  118769. */
  118770. constructor(
  118771. /** The name of the animation group */
  118772. name: string, scene?: Nullable<Scene>);
  118773. /**
  118774. * Add an animation (with its target) in the group
  118775. * @param animation defines the animation we want to add
  118776. * @param target defines the target of the animation
  118777. * @returns the TargetedAnimation object
  118778. */
  118779. addTargetedAnimation(animation: Animation, target: any): TargetedAnimation;
  118780. /**
  118781. * This function will normalize every animation in the group to make sure they all go from beginFrame to endFrame
  118782. * It can add constant keys at begin or end
  118783. * @param beginFrame defines the new begin frame for all animations or the smallest begin frame of all animations if null (defaults to null)
  118784. * @param endFrame defines the new end frame for all animations or the largest end frame of all animations if null (defaults to null)
  118785. * @returns the animation group
  118786. */
  118787. normalize(beginFrame?: Nullable<number>, endFrame?: Nullable<number>): AnimationGroup;
  118788. private _animationLoopCount;
  118789. private _animationLoopFlags;
  118790. private _processLoop;
  118791. /**
  118792. * Start all animations on given targets
  118793. * @param loop defines if animations must loop
  118794. * @param speedRatio defines the ratio to apply to animation speed (1 by default)
  118795. * @param from defines the from key (optional)
  118796. * @param to defines the to key (optional)
  118797. * @param isAdditive defines the additive state for the resulting animatables (optional)
  118798. * @returns the current animation group
  118799. */
  118800. start(loop?: boolean, speedRatio?: number, from?: number, to?: number, isAdditive?: boolean): AnimationGroup;
  118801. /**
  118802. * Pause all animations
  118803. * @returns the animation group
  118804. */
  118805. pause(): AnimationGroup;
  118806. /**
  118807. * Play all animations to initial state
  118808. * This function will start() the animations if they were not started or will restart() them if they were paused
  118809. * @param loop defines if animations must loop
  118810. * @returns the animation group
  118811. */
  118812. play(loop?: boolean): AnimationGroup;
  118813. /**
  118814. * Reset all animations to initial state
  118815. * @returns the animation group
  118816. */
  118817. reset(): AnimationGroup;
  118818. /**
  118819. * Restart animations from key 0
  118820. * @returns the animation group
  118821. */
  118822. restart(): AnimationGroup;
  118823. /**
  118824. * Stop all animations
  118825. * @returns the animation group
  118826. */
  118827. stop(): AnimationGroup;
  118828. /**
  118829. * Set animation weight for all animatables
  118830. * @param weight defines the weight to use
  118831. * @return the animationGroup
  118832. * @see https://doc.babylonjs.com/babylon101/animations#animation-weights
  118833. */
  118834. setWeightForAllAnimatables(weight: number): AnimationGroup;
  118835. /**
  118836. * Synchronize and normalize all animatables with a source animatable
  118837. * @param root defines the root animatable to synchronize with
  118838. * @return the animationGroup
  118839. * @see https://doc.babylonjs.com/babylon101/animations#animation-weights
  118840. */
  118841. syncAllAnimationsWith(root: Animatable): AnimationGroup;
  118842. /**
  118843. * Goes to a specific frame in this animation group
  118844. * @param frame the frame number to go to
  118845. * @return the animationGroup
  118846. */
  118847. goToFrame(frame: number): AnimationGroup;
  118848. /**
  118849. * Dispose all associated resources
  118850. */
  118851. dispose(): void;
  118852. private _checkAnimationGroupEnded;
  118853. /**
  118854. * Clone the current animation group and returns a copy
  118855. * @param newName defines the name of the new group
  118856. * @param targetConverter defines an optional function used to convert current animation targets to new ones
  118857. * @returns the new aniamtion group
  118858. */
  118859. clone(newName: string, targetConverter?: (oldTarget: any) => any): AnimationGroup;
  118860. /**
  118861. * Serializes the animationGroup to an object
  118862. * @returns Serialized object
  118863. */
  118864. serialize(): any;
  118865. /**
  118866. * Returns a new AnimationGroup object parsed from the source provided.
  118867. * @param parsedAnimationGroup defines the source
  118868. * @param scene defines the scene that will receive the animationGroup
  118869. * @returns a new AnimationGroup
  118870. */
  118871. static Parse(parsedAnimationGroup: any, scene: Scene): AnimationGroup;
  118872. /**
  118873. * Convert the keyframes for all animations belonging to the group to be relative to a given reference frame.
  118874. * @param sourceAnimationGroup defines the AnimationGroup containing animations to convert
  118875. * @param referenceFrame defines the frame that keyframes in the range will be relative to
  118876. * @param range defines the name of the AnimationRange belonging to the animations in the group to convert
  118877. * @param cloneOriginal defines whether or not to clone the group and convert the clone or convert the original group (default is false)
  118878. * @param clonedName defines the name of the resulting cloned AnimationGroup if cloneOriginal is true
  118879. * @returns a new AnimationGroup if cloneOriginal is true or the original AnimationGroup if cloneOriginal is false
  118880. */
  118881. static MakeAnimationAdditive(sourceAnimationGroup: AnimationGroup, referenceFrame?: number, range?: string, cloneOriginal?: boolean, clonedName?: string): AnimationGroup;
  118882. /**
  118883. * Returns the string "AnimationGroup"
  118884. * @returns "AnimationGroup"
  118885. */
  118886. getClassName(): string;
  118887. /**
  118888. * Creates a detailled string about the object
  118889. * @param fullDetails defines if the output string will support multiple levels of logging within scene loading
  118890. * @returns a string representing the object
  118891. */
  118892. toString(fullDetails?: boolean): string;
  118893. }
  118894. }
  118895. declare module BABYLON {
  118896. /**
  118897. * Define an interface for all classes that will hold resources
  118898. */
  118899. export interface IDisposable {
  118900. /**
  118901. * Releases all held resources
  118902. */
  118903. dispose(): void;
  118904. }
  118905. /** Interface defining initialization parameters for Scene class */
  118906. export interface SceneOptions {
  118907. /**
  118908. * Defines that scene should keep up-to-date a map of geometry to enable fast look-up by uniqueId
  118909. * It will improve performance when the number of geometries becomes important.
  118910. */
  118911. useGeometryUniqueIdsMap?: boolean;
  118912. /**
  118913. * Defines that each material of the scene should keep up-to-date a map of referencing meshes for fast diposing
  118914. * It will improve performance when the number of mesh becomes important, but might consume a bit more memory
  118915. */
  118916. useMaterialMeshMap?: boolean;
  118917. /**
  118918. * Defines that each mesh of the scene should keep up-to-date a map of referencing cloned meshes for fast diposing
  118919. * It will improve performance when the number of mesh becomes important, but might consume a bit more memory
  118920. */
  118921. useClonedMeshMap?: boolean;
  118922. /** Defines if the creation of the scene should impact the engine (Eg. UtilityLayer's scene) */
  118923. virtual?: boolean;
  118924. }
  118925. /**
  118926. * Represents a scene to be rendered by the engine.
  118927. * @see https://doc.babylonjs.com/features/scene
  118928. */
  118929. export class Scene extends AbstractScene implements IAnimatable, IClipPlanesHolder {
  118930. /** The fog is deactivated */
  118931. static readonly FOGMODE_NONE: number;
  118932. /** The fog density is following an exponential function */
  118933. static readonly FOGMODE_EXP: number;
  118934. /** The fog density is following an exponential function faster than FOGMODE_EXP */
  118935. static readonly FOGMODE_EXP2: number;
  118936. /** The fog density is following a linear function. */
  118937. static readonly FOGMODE_LINEAR: number;
  118938. /**
  118939. * Gets or sets the minimum deltatime when deterministic lock step is enabled
  118940. * @see https://doc.babylonjs.com/babylon101/animations#deterministic-lockstep
  118941. */
  118942. static MinDeltaTime: number;
  118943. /**
  118944. * Gets or sets the maximum deltatime when deterministic lock step is enabled
  118945. * @see https://doc.babylonjs.com/babylon101/animations#deterministic-lockstep
  118946. */
  118947. static MaxDeltaTime: number;
  118948. /**
  118949. * Factory used to create the default material.
  118950. * @param name The name of the material to create
  118951. * @param scene The scene to create the material for
  118952. * @returns The default material
  118953. */
  118954. static DefaultMaterialFactory(scene: Scene): Material;
  118955. /**
  118956. * Factory used to create the a collision coordinator.
  118957. * @returns The collision coordinator
  118958. */
  118959. static CollisionCoordinatorFactory(): ICollisionCoordinator;
  118960. /** @hidden */
  118961. _inputManager: InputManager;
  118962. /** Define this parameter if you are using multiple cameras and you want to specify which one should be used for pointer position */
  118963. cameraToUseForPointers: Nullable<Camera>;
  118964. /** @hidden */
  118965. readonly _isScene: boolean;
  118966. /** @hidden */
  118967. _blockEntityCollection: boolean;
  118968. /**
  118969. * Gets or sets a boolean that indicates if the scene must clear the render buffer before rendering a frame
  118970. */
  118971. autoClear: boolean;
  118972. /**
  118973. * Gets or sets a boolean that indicates if the scene must clear the depth and stencil buffers before rendering a frame
  118974. */
  118975. autoClearDepthAndStencil: boolean;
  118976. /**
  118977. * Defines the color used to clear the render buffer (Default is (0.2, 0.2, 0.3, 1.0))
  118978. */
  118979. clearColor: Color4;
  118980. /**
  118981. * Defines the color used to simulate the ambient color (Default is (0, 0, 0))
  118982. */
  118983. ambientColor: Color3;
  118984. /**
  118985. * This is use to store the default BRDF lookup for PBR materials in your scene.
  118986. * It should only be one of the following (if not the default embedded one):
  118987. * * For uncorrelated BRDF (pbr.brdf.useEnergyConservation = false and pbr.brdf.useSmithVisibilityHeightCorrelated = false) : https://assets.babylonjs.com/environments/uncorrelatedBRDF.dds
  118988. * * For correlated BRDF (pbr.brdf.useEnergyConservation = false and pbr.brdf.useSmithVisibilityHeightCorrelated = true) : https://assets.babylonjs.com/environments/correlatedBRDF.dds
  118989. * * For correlated multi scattering BRDF (pbr.brdf.useEnergyConservation = true and pbr.brdf.useSmithVisibilityHeightCorrelated = true) : https://assets.babylonjs.com/environments/correlatedMSBRDF.dds
  118990. * The material properties need to be setup according to the type of texture in use.
  118991. */
  118992. environmentBRDFTexture: BaseTexture;
  118993. /**
  118994. * Texture used in all pbr material as the reflection texture.
  118995. * As in the majority of the scene they are the same (exception for multi room and so on),
  118996. * this is easier to reference from here than from all the materials.
  118997. */
  118998. get environmentTexture(): Nullable<BaseTexture>;
  118999. /**
  119000. * Texture used in all pbr material as the reflection texture.
  119001. * As in the majority of the scene they are the same (exception for multi room and so on),
  119002. * this is easier to set here than in all the materials.
  119003. */
  119004. set environmentTexture(value: Nullable<BaseTexture>);
  119005. /** @hidden */
  119006. protected _environmentIntensity: number;
  119007. /**
  119008. * Intensity of the environment in all pbr material.
  119009. * This dims or reinforces the IBL lighting overall (reflection and diffuse).
  119010. * As in the majority of the scene they are the same (exception for multi room and so on),
  119011. * this is easier to reference from here than from all the materials.
  119012. */
  119013. get environmentIntensity(): number;
  119014. /**
  119015. * Intensity of the environment in all pbr material.
  119016. * This dims or reinforces the IBL lighting overall (reflection and diffuse).
  119017. * As in the majority of the scene they are the same (exception for multi room and so on),
  119018. * this is easier to set here than in all the materials.
  119019. */
  119020. set environmentIntensity(value: number);
  119021. /** @hidden */
  119022. protected _imageProcessingConfiguration: ImageProcessingConfiguration;
  119023. /**
  119024. * Default image processing configuration used either in the rendering
  119025. * Forward main pass or through the imageProcessingPostProcess if present.
  119026. * As in the majority of the scene they are the same (exception for multi camera),
  119027. * this is easier to reference from here than from all the materials and post process.
  119028. *
  119029. * No setter as we it is a shared configuration, you can set the values instead.
  119030. */
  119031. get imageProcessingConfiguration(): ImageProcessingConfiguration;
  119032. private _forceWireframe;
  119033. /**
  119034. * Gets or sets a boolean indicating if all rendering must be done in wireframe
  119035. */
  119036. set forceWireframe(value: boolean);
  119037. get forceWireframe(): boolean;
  119038. private _skipFrustumClipping;
  119039. /**
  119040. * Gets or sets a boolean indicating if we should skip the frustum clipping part of the active meshes selection
  119041. */
  119042. set skipFrustumClipping(value: boolean);
  119043. get skipFrustumClipping(): boolean;
  119044. private _forcePointsCloud;
  119045. /**
  119046. * Gets or sets a boolean indicating if all rendering must be done in point cloud
  119047. */
  119048. set forcePointsCloud(value: boolean);
  119049. get forcePointsCloud(): boolean;
  119050. /**
  119051. * Gets or sets the active clipplane 1
  119052. */
  119053. clipPlane: Nullable<Plane>;
  119054. /**
  119055. * Gets or sets the active clipplane 2
  119056. */
  119057. clipPlane2: Nullable<Plane>;
  119058. /**
  119059. * Gets or sets the active clipplane 3
  119060. */
  119061. clipPlane3: Nullable<Plane>;
  119062. /**
  119063. * Gets or sets the active clipplane 4
  119064. */
  119065. clipPlane4: Nullable<Plane>;
  119066. /**
  119067. * Gets or sets the active clipplane 5
  119068. */
  119069. clipPlane5: Nullable<Plane>;
  119070. /**
  119071. * Gets or sets the active clipplane 6
  119072. */
  119073. clipPlane6: Nullable<Plane>;
  119074. /**
  119075. * Gets or sets a boolean indicating if animations are enabled
  119076. */
  119077. animationsEnabled: boolean;
  119078. private _animationPropertiesOverride;
  119079. /**
  119080. * Gets or sets the animation properties override
  119081. */
  119082. get animationPropertiesOverride(): Nullable<AnimationPropertiesOverride>;
  119083. set animationPropertiesOverride(value: Nullable<AnimationPropertiesOverride>);
  119084. /**
  119085. * Gets or sets a boolean indicating if a constant deltatime has to be used
  119086. * This is mostly useful for testing purposes when you do not want the animations to scale with the framerate
  119087. */
  119088. useConstantAnimationDeltaTime: boolean;
  119089. /**
  119090. * Gets or sets a boolean indicating if the scene must keep the meshUnderPointer property updated
  119091. * Please note that it requires to run a ray cast through the scene on every frame
  119092. */
  119093. constantlyUpdateMeshUnderPointer: boolean;
  119094. /**
  119095. * Defines the HTML cursor to use when hovering over interactive elements
  119096. */
  119097. hoverCursor: string;
  119098. /**
  119099. * Defines the HTML default cursor to use (empty by default)
  119100. */
  119101. defaultCursor: string;
  119102. /**
  119103. * Defines whether cursors are handled by the scene.
  119104. */
  119105. doNotHandleCursors: boolean;
  119106. /**
  119107. * This is used to call preventDefault() on pointer down
  119108. * in order to block unwanted artifacts like system double clicks
  119109. */
  119110. preventDefaultOnPointerDown: boolean;
  119111. /**
  119112. * This is used to call preventDefault() on pointer up
  119113. * in order to block unwanted artifacts like system double clicks
  119114. */
  119115. preventDefaultOnPointerUp: boolean;
  119116. /**
  119117. * Gets or sets user defined metadata
  119118. */
  119119. metadata: any;
  119120. /**
  119121. * For internal use only. Please do not use.
  119122. */
  119123. reservedDataStore: any;
  119124. /**
  119125. * Gets the name of the plugin used to load this scene (null by default)
  119126. */
  119127. loadingPluginName: string;
  119128. /**
  119129. * Use this array to add regular expressions used to disable offline support for specific urls
  119130. */
  119131. disableOfflineSupportExceptionRules: RegExp[];
  119132. /**
  119133. * An event triggered when the scene is disposed.
  119134. */
  119135. onDisposeObservable: Observable<Scene>;
  119136. private _onDisposeObserver;
  119137. /** Sets a function to be executed when this scene is disposed. */
  119138. set onDispose(callback: () => void);
  119139. /**
  119140. * An event triggered before rendering the scene (right after animations and physics)
  119141. */
  119142. onBeforeRenderObservable: Observable<Scene>;
  119143. private _onBeforeRenderObserver;
  119144. /** Sets a function to be executed before rendering this scene */
  119145. set beforeRender(callback: Nullable<() => void>);
  119146. /**
  119147. * An event triggered after rendering the scene
  119148. */
  119149. onAfterRenderObservable: Observable<Scene>;
  119150. /**
  119151. * An event triggered after rendering the scene for an active camera (When scene.render is called this will be called after each camera)
  119152. */
  119153. onAfterRenderCameraObservable: Observable<Camera>;
  119154. private _onAfterRenderObserver;
  119155. /** Sets a function to be executed after rendering this scene */
  119156. set afterRender(callback: Nullable<() => void>);
  119157. /**
  119158. * An event triggered before animating the scene
  119159. */
  119160. onBeforeAnimationsObservable: Observable<Scene>;
  119161. /**
  119162. * An event triggered after animations processing
  119163. */
  119164. onAfterAnimationsObservable: Observable<Scene>;
  119165. /**
  119166. * An event triggered before draw calls are ready to be sent
  119167. */
  119168. onBeforeDrawPhaseObservable: Observable<Scene>;
  119169. /**
  119170. * An event triggered after draw calls have been sent
  119171. */
  119172. onAfterDrawPhaseObservable: Observable<Scene>;
  119173. /**
  119174. * An event triggered when the scene is ready
  119175. */
  119176. onReadyObservable: Observable<Scene>;
  119177. /**
  119178. * An event triggered before rendering a camera
  119179. */
  119180. onBeforeCameraRenderObservable: Observable<Camera>;
  119181. private _onBeforeCameraRenderObserver;
  119182. /** Sets a function to be executed before rendering a camera*/
  119183. set beforeCameraRender(callback: () => void);
  119184. /**
  119185. * An event triggered after rendering a camera
  119186. */
  119187. onAfterCameraRenderObservable: Observable<Camera>;
  119188. private _onAfterCameraRenderObserver;
  119189. /** Sets a function to be executed after rendering a camera*/
  119190. set afterCameraRender(callback: () => void);
  119191. /**
  119192. * An event triggered when active meshes evaluation is about to start
  119193. */
  119194. onBeforeActiveMeshesEvaluationObservable: Observable<Scene>;
  119195. /**
  119196. * An event triggered when active meshes evaluation is done
  119197. */
  119198. onAfterActiveMeshesEvaluationObservable: Observable<Scene>;
  119199. /**
  119200. * An event triggered when particles rendering is about to start
  119201. * Note: This event can be trigger more than once per frame (because particles can be rendered by render target textures as well)
  119202. */
  119203. onBeforeParticlesRenderingObservable: Observable<Scene>;
  119204. /**
  119205. * An event triggered when particles rendering is done
  119206. * Note: This event can be trigger more than once per frame (because particles can be rendered by render target textures as well)
  119207. */
  119208. onAfterParticlesRenderingObservable: Observable<Scene>;
  119209. /**
  119210. * An event triggered when SceneLoader.Append or SceneLoader.Load or SceneLoader.ImportMesh were successfully executed
  119211. */
  119212. onDataLoadedObservable: Observable<Scene>;
  119213. /**
  119214. * An event triggered when a camera is created
  119215. */
  119216. onNewCameraAddedObservable: Observable<Camera>;
  119217. /**
  119218. * An event triggered when a camera is removed
  119219. */
  119220. onCameraRemovedObservable: Observable<Camera>;
  119221. /**
  119222. * An event triggered when a light is created
  119223. */
  119224. onNewLightAddedObservable: Observable<Light>;
  119225. /**
  119226. * An event triggered when a light is removed
  119227. */
  119228. onLightRemovedObservable: Observable<Light>;
  119229. /**
  119230. * An event triggered when a geometry is created
  119231. */
  119232. onNewGeometryAddedObservable: Observable<Geometry>;
  119233. /**
  119234. * An event triggered when a geometry is removed
  119235. */
  119236. onGeometryRemovedObservable: Observable<Geometry>;
  119237. /**
  119238. * An event triggered when a transform node is created
  119239. */
  119240. onNewTransformNodeAddedObservable: Observable<TransformNode>;
  119241. /**
  119242. * An event triggered when a transform node is removed
  119243. */
  119244. onTransformNodeRemovedObservable: Observable<TransformNode>;
  119245. /**
  119246. * An event triggered when a mesh is created
  119247. */
  119248. onNewMeshAddedObservable: Observable<AbstractMesh>;
  119249. /**
  119250. * An event triggered when a mesh is removed
  119251. */
  119252. onMeshRemovedObservable: Observable<AbstractMesh>;
  119253. /**
  119254. * An event triggered when a skeleton is created
  119255. */
  119256. onNewSkeletonAddedObservable: Observable<Skeleton>;
  119257. /**
  119258. * An event triggered when a skeleton is removed
  119259. */
  119260. onSkeletonRemovedObservable: Observable<Skeleton>;
  119261. /**
  119262. * An event triggered when a material is created
  119263. */
  119264. onNewMaterialAddedObservable: Observable<Material>;
  119265. /**
  119266. * An event triggered when a material is removed
  119267. */
  119268. onMaterialRemovedObservable: Observable<Material>;
  119269. /**
  119270. * An event triggered when a texture is created
  119271. */
  119272. onNewTextureAddedObservable: Observable<BaseTexture>;
  119273. /**
  119274. * An event triggered when a texture is removed
  119275. */
  119276. onTextureRemovedObservable: Observable<BaseTexture>;
  119277. /**
  119278. * An event triggered when render targets are about to be rendered
  119279. * Can happen multiple times per frame.
  119280. */
  119281. onBeforeRenderTargetsRenderObservable: Observable<Scene>;
  119282. /**
  119283. * An event triggered when render targets were rendered.
  119284. * Can happen multiple times per frame.
  119285. */
  119286. onAfterRenderTargetsRenderObservable: Observable<Scene>;
  119287. /**
  119288. * An event triggered before calculating deterministic simulation step
  119289. */
  119290. onBeforeStepObservable: Observable<Scene>;
  119291. /**
  119292. * An event triggered after calculating deterministic simulation step
  119293. */
  119294. onAfterStepObservable: Observable<Scene>;
  119295. /**
  119296. * An event triggered when the activeCamera property is updated
  119297. */
  119298. onActiveCameraChanged: Observable<Scene>;
  119299. /**
  119300. * This Observable will be triggered before rendering each renderingGroup of each rendered camera.
  119301. * The RenderinGroupInfo class contains all the information about the context in which the observable is called
  119302. * 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)
  119303. */
  119304. onBeforeRenderingGroupObservable: Observable<RenderingGroupInfo>;
  119305. /**
  119306. * This Observable will be triggered after rendering each renderingGroup of each rendered camera.
  119307. * The RenderinGroupInfo class contains all the information about the context in which the observable is called
  119308. * 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)
  119309. */
  119310. onAfterRenderingGroupObservable: Observable<RenderingGroupInfo>;
  119311. /**
  119312. * This Observable will when a mesh has been imported into the scene.
  119313. */
  119314. onMeshImportedObservable: Observable<AbstractMesh>;
  119315. /**
  119316. * This Observable will when an animation file has been imported into the scene.
  119317. */
  119318. onAnimationFileImportedObservable: Observable<Scene>;
  119319. /**
  119320. * Gets or sets a user defined funtion to select LOD from a mesh and a camera.
  119321. * By default this function is undefined and Babylon.js will select LOD based on distance to camera
  119322. */
  119323. customLODSelector: (mesh: AbstractMesh, camera: Camera) => Nullable<AbstractMesh>;
  119324. /** @hidden */
  119325. _registeredForLateAnimationBindings: SmartArrayNoDuplicate<any>;
  119326. /**
  119327. * Gets or sets a predicate used to select candidate meshes for a pointer down event
  119328. */
  119329. pointerDownPredicate: (Mesh: AbstractMesh) => boolean;
  119330. /**
  119331. * Gets or sets a predicate used to select candidate meshes for a pointer up event
  119332. */
  119333. pointerUpPredicate: (Mesh: AbstractMesh) => boolean;
  119334. /**
  119335. * Gets or sets a predicate used to select candidate meshes for a pointer move event
  119336. */
  119337. pointerMovePredicate: (Mesh: AbstractMesh) => boolean;
  119338. /** Callback called when a pointer move is detected */
  119339. onPointerMove: (evt: PointerEvent, pickInfo: PickingInfo, type: PointerEventTypes) => void;
  119340. /** Callback called when a pointer down is detected */
  119341. onPointerDown: (evt: PointerEvent, pickInfo: PickingInfo, type: PointerEventTypes) => void;
  119342. /** Callback called when a pointer up is detected */
  119343. onPointerUp: (evt: PointerEvent, pickInfo: Nullable<PickingInfo>, type: PointerEventTypes) => void;
  119344. /** Callback called when a pointer pick is detected */
  119345. onPointerPick: (evt: PointerEvent, pickInfo: PickingInfo) => void;
  119346. /**
  119347. * 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).
  119348. * You have the possibility to skip the process and the call to onPointerObservable by setting PointerInfoPre.skipOnPointerObservable to true
  119349. */
  119350. onPrePointerObservable: Observable<PointerInfoPre>;
  119351. /**
  119352. * Observable event triggered each time an input event is received from the rendering canvas
  119353. */
  119354. onPointerObservable: Observable<PointerInfo>;
  119355. /**
  119356. * Gets the pointer coordinates without any translation (ie. straight out of the pointer event)
  119357. */
  119358. get unTranslatedPointer(): Vector2;
  119359. /**
  119360. * Gets or sets the distance in pixel that you have to move to prevent some events. Default is 10 pixels
  119361. */
  119362. static get DragMovementThreshold(): number;
  119363. static set DragMovementThreshold(value: number);
  119364. /**
  119365. * Time in milliseconds to wait to raise long press events if button is still pressed. Default is 500 ms
  119366. */
  119367. static get LongPressDelay(): number;
  119368. static set LongPressDelay(value: number);
  119369. /**
  119370. * Time in milliseconds to wait to raise long press events if button is still pressed. Default is 300 ms
  119371. */
  119372. static get DoubleClickDelay(): number;
  119373. static set DoubleClickDelay(value: number);
  119374. /** If you need to check double click without raising a single click at first click, enable this flag */
  119375. static get ExclusiveDoubleClickMode(): boolean;
  119376. static set ExclusiveDoubleClickMode(value: boolean);
  119377. /** @hidden */
  119378. _mirroredCameraPosition: Nullable<Vector3>;
  119379. /**
  119380. * This observable event is triggered when any keyboard event si raised and registered during Scene.attachControl()
  119381. * You have the possibility to skip the process and the call to onKeyboardObservable by setting KeyboardInfoPre.skipOnPointerObservable to true
  119382. */
  119383. onPreKeyboardObservable: Observable<KeyboardInfoPre>;
  119384. /**
  119385. * Observable event triggered each time an keyboard event is received from the hosting window
  119386. */
  119387. onKeyboardObservable: Observable<KeyboardInfo>;
  119388. private _useRightHandedSystem;
  119389. /**
  119390. * Gets or sets a boolean indicating if the scene must use right-handed coordinates system
  119391. */
  119392. set useRightHandedSystem(value: boolean);
  119393. get useRightHandedSystem(): boolean;
  119394. private _timeAccumulator;
  119395. private _currentStepId;
  119396. private _currentInternalStep;
  119397. /**
  119398. * Sets the step Id used by deterministic lock step
  119399. * @see https://doc.babylonjs.com/babylon101/animations#deterministic-lockstep
  119400. * @param newStepId defines the step Id
  119401. */
  119402. setStepId(newStepId: number): void;
  119403. /**
  119404. * Gets the step Id used by deterministic lock step
  119405. * @see https://doc.babylonjs.com/babylon101/animations#deterministic-lockstep
  119406. * @returns the step Id
  119407. */
  119408. getStepId(): number;
  119409. /**
  119410. * Gets the internal step used by deterministic lock step
  119411. * @see https://doc.babylonjs.com/babylon101/animations#deterministic-lockstep
  119412. * @returns the internal step
  119413. */
  119414. getInternalStep(): number;
  119415. private _fogEnabled;
  119416. /**
  119417. * Gets or sets a boolean indicating if fog is enabled on this scene
  119418. * @see https://doc.babylonjs.com/babylon101/environment#fog
  119419. * (Default is true)
  119420. */
  119421. set fogEnabled(value: boolean);
  119422. get fogEnabled(): boolean;
  119423. private _fogMode;
  119424. /**
  119425. * Gets or sets the fog mode to use
  119426. * @see https://doc.babylonjs.com/babylon101/environment#fog
  119427. * | mode | value |
  119428. * | --- | --- |
  119429. * | FOGMODE_NONE | 0 |
  119430. * | FOGMODE_EXP | 1 |
  119431. * | FOGMODE_EXP2 | 2 |
  119432. * | FOGMODE_LINEAR | 3 |
  119433. */
  119434. set fogMode(value: number);
  119435. get fogMode(): number;
  119436. /**
  119437. * Gets or sets the fog color to use
  119438. * @see https://doc.babylonjs.com/babylon101/environment#fog
  119439. * (Default is Color3(0.2, 0.2, 0.3))
  119440. */
  119441. fogColor: Color3;
  119442. /**
  119443. * Gets or sets the fog density to use
  119444. * @see https://doc.babylonjs.com/babylon101/environment#fog
  119445. * (Default is 0.1)
  119446. */
  119447. fogDensity: number;
  119448. /**
  119449. * Gets or sets the fog start distance to use
  119450. * @see https://doc.babylonjs.com/babylon101/environment#fog
  119451. * (Default is 0)
  119452. */
  119453. fogStart: number;
  119454. /**
  119455. * Gets or sets the fog end distance to use
  119456. * @see https://doc.babylonjs.com/babylon101/environment#fog
  119457. * (Default is 1000)
  119458. */
  119459. fogEnd: number;
  119460. /**
  119461. * Flag indicating that the frame buffer binding is handled by another component
  119462. */
  119463. prePass: boolean;
  119464. private _shadowsEnabled;
  119465. /**
  119466. * Gets or sets a boolean indicating if shadows are enabled on this scene
  119467. */
  119468. set shadowsEnabled(value: boolean);
  119469. get shadowsEnabled(): boolean;
  119470. private _lightsEnabled;
  119471. /**
  119472. * Gets or sets a boolean indicating if lights are enabled on this scene
  119473. */
  119474. set lightsEnabled(value: boolean);
  119475. get lightsEnabled(): boolean;
  119476. /** All of the active cameras added to this scene. */
  119477. activeCameras: Camera[];
  119478. /** @hidden */
  119479. _activeCamera: Nullable<Camera>;
  119480. /** Gets or sets the current active camera */
  119481. get activeCamera(): Nullable<Camera>;
  119482. set activeCamera(value: Nullable<Camera>);
  119483. private _defaultMaterial;
  119484. /** The default material used on meshes when no material is affected */
  119485. get defaultMaterial(): Material;
  119486. /** The default material used on meshes when no material is affected */
  119487. set defaultMaterial(value: Material);
  119488. private _texturesEnabled;
  119489. /**
  119490. * Gets or sets a boolean indicating if textures are enabled on this scene
  119491. */
  119492. set texturesEnabled(value: boolean);
  119493. get texturesEnabled(): boolean;
  119494. /**
  119495. * Gets or sets a boolean indicating if physic engines are enabled on this scene
  119496. */
  119497. physicsEnabled: boolean;
  119498. /**
  119499. * Gets or sets a boolean indicating if particles are enabled on this scene
  119500. */
  119501. particlesEnabled: boolean;
  119502. /**
  119503. * Gets or sets a boolean indicating if sprites are enabled on this scene
  119504. */
  119505. spritesEnabled: boolean;
  119506. private _skeletonsEnabled;
  119507. /**
  119508. * Gets or sets a boolean indicating if skeletons are enabled on this scene
  119509. */
  119510. set skeletonsEnabled(value: boolean);
  119511. get skeletonsEnabled(): boolean;
  119512. /**
  119513. * Gets or sets a boolean indicating if lens flares are enabled on this scene
  119514. */
  119515. lensFlaresEnabled: boolean;
  119516. /**
  119517. * Gets or sets a boolean indicating if collisions are enabled on this scene
  119518. * @see https://doc.babylonjs.com/babylon101/cameras,_mesh_collisions_and_gravity
  119519. */
  119520. collisionsEnabled: boolean;
  119521. private _collisionCoordinator;
  119522. /** @hidden */
  119523. get collisionCoordinator(): ICollisionCoordinator;
  119524. /**
  119525. * Defines the gravity applied to this scene (used only for collisions)
  119526. * @see https://doc.babylonjs.com/babylon101/cameras,_mesh_collisions_and_gravity
  119527. */
  119528. gravity: Vector3;
  119529. /**
  119530. * Gets or sets a boolean indicating if postprocesses are enabled on this scene
  119531. */
  119532. postProcessesEnabled: boolean;
  119533. /**
  119534. * Gets the current postprocess manager
  119535. */
  119536. postProcessManager: PostProcessManager;
  119537. /**
  119538. * Gets or sets a boolean indicating if render targets are enabled on this scene
  119539. */
  119540. renderTargetsEnabled: boolean;
  119541. /**
  119542. * Gets or sets a boolean indicating if next render targets must be dumped as image for debugging purposes
  119543. * We recommend not using it and instead rely on Spector.js: http://spector.babylonjs.com
  119544. */
  119545. dumpNextRenderTargets: boolean;
  119546. /**
  119547. * The list of user defined render targets added to the scene
  119548. */
  119549. customRenderTargets: RenderTargetTexture[];
  119550. /**
  119551. * Defines if texture loading must be delayed
  119552. * If true, textures will only be loaded when they need to be rendered
  119553. */
  119554. useDelayedTextureLoading: boolean;
  119555. /**
  119556. * Gets the list of meshes imported to the scene through SceneLoader
  119557. */
  119558. importedMeshesFiles: String[];
  119559. /**
  119560. * Gets or sets a boolean indicating if probes are enabled on this scene
  119561. */
  119562. probesEnabled: boolean;
  119563. /**
  119564. * Gets or sets the current offline provider to use to store scene data
  119565. * @see https://doc.babylonjs.com/how_to/caching_resources_in_indexeddb
  119566. */
  119567. offlineProvider: IOfflineProvider;
  119568. /**
  119569. * Gets or sets the action manager associated with the scene
  119570. * @see https://doc.babylonjs.com/how_to/how_to_use_actions
  119571. */
  119572. actionManager: AbstractActionManager;
  119573. private _meshesForIntersections;
  119574. /**
  119575. * Gets or sets a boolean indicating if procedural textures are enabled on this scene
  119576. */
  119577. proceduralTexturesEnabled: boolean;
  119578. private _engine;
  119579. private _totalVertices;
  119580. /** @hidden */
  119581. _activeIndices: PerfCounter;
  119582. /** @hidden */
  119583. _activeParticles: PerfCounter;
  119584. /** @hidden */
  119585. _activeBones: PerfCounter;
  119586. private _animationRatio;
  119587. /** @hidden */
  119588. _animationTimeLast: number;
  119589. /** @hidden */
  119590. _animationTime: number;
  119591. /**
  119592. * Gets or sets a general scale for animation speed
  119593. * @see https://www.babylonjs-playground.com/#IBU2W7#3
  119594. */
  119595. animationTimeScale: number;
  119596. /** @hidden */
  119597. _cachedMaterial: Nullable<Material>;
  119598. /** @hidden */
  119599. _cachedEffect: Nullable<Effect>;
  119600. /** @hidden */
  119601. _cachedVisibility: Nullable<number>;
  119602. private _renderId;
  119603. private _frameId;
  119604. private _executeWhenReadyTimeoutId;
  119605. private _intermediateRendering;
  119606. private _viewUpdateFlag;
  119607. private _projectionUpdateFlag;
  119608. /** @hidden */
  119609. _toBeDisposed: Nullable<IDisposable>[];
  119610. private _activeRequests;
  119611. /** @hidden */
  119612. _pendingData: any[];
  119613. private _isDisposed;
  119614. /**
  119615. * Gets or sets a boolean indicating that all submeshes of active meshes must be rendered
  119616. * Use this boolean to avoid computing frustum clipping on submeshes (This could help when you are CPU bound)
  119617. */
  119618. dispatchAllSubMeshesOfActiveMeshes: boolean;
  119619. private _activeMeshes;
  119620. private _processedMaterials;
  119621. private _renderTargets;
  119622. /** @hidden */
  119623. _activeParticleSystems: SmartArray<IParticleSystem>;
  119624. private _activeSkeletons;
  119625. private _softwareSkinnedMeshes;
  119626. private _renderingManager;
  119627. /** @hidden */
  119628. _activeAnimatables: Animatable[];
  119629. private _transformMatrix;
  119630. private _sceneUbo;
  119631. /** @hidden */
  119632. _viewMatrix: Matrix;
  119633. private _projectionMatrix;
  119634. /** @hidden */
  119635. _forcedViewPosition: Nullable<Vector3>;
  119636. /** @hidden */
  119637. _frustumPlanes: Plane[];
  119638. /**
  119639. * Gets the list of frustum planes (built from the active camera)
  119640. */
  119641. get frustumPlanes(): Plane[];
  119642. /**
  119643. * Gets or sets a boolean indicating if lights must be sorted by priority (off by default)
  119644. * This is useful if there are more lights that the maximum simulteanous authorized
  119645. */
  119646. requireLightSorting: boolean;
  119647. /** @hidden */
  119648. readonly useMaterialMeshMap: boolean;
  119649. /** @hidden */
  119650. readonly useClonedMeshMap: boolean;
  119651. private _externalData;
  119652. private _uid;
  119653. /**
  119654. * @hidden
  119655. * Backing store of defined scene components.
  119656. */
  119657. _components: ISceneComponent[];
  119658. /**
  119659. * @hidden
  119660. * Backing store of defined scene components.
  119661. */
  119662. _serializableComponents: ISceneSerializableComponent[];
  119663. /**
  119664. * List of components to register on the next registration step.
  119665. */
  119666. private _transientComponents;
  119667. /**
  119668. * Registers the transient components if needed.
  119669. */
  119670. private _registerTransientComponents;
  119671. /**
  119672. * @hidden
  119673. * Add a component to the scene.
  119674. * Note that the ccomponent could be registered on th next frame if this is called after
  119675. * the register component stage.
  119676. * @param component Defines the component to add to the scene
  119677. */
  119678. _addComponent(component: ISceneComponent): void;
  119679. /**
  119680. * @hidden
  119681. * Gets a component from the scene.
  119682. * @param name defines the name of the component to retrieve
  119683. * @returns the component or null if not present
  119684. */
  119685. _getComponent(name: string): Nullable<ISceneComponent>;
  119686. /**
  119687. * @hidden
  119688. * Defines the actions happening before camera updates.
  119689. */
  119690. _beforeCameraUpdateStage: Stage<SimpleStageAction>;
  119691. /**
  119692. * @hidden
  119693. * Defines the actions happening before clear the canvas.
  119694. */
  119695. _beforeClearStage: Stage<SimpleStageAction>;
  119696. /**
  119697. * @hidden
  119698. * Defines the actions when collecting render targets for the frame.
  119699. */
  119700. _gatherRenderTargetsStage: Stage<RenderTargetsStageAction>;
  119701. /**
  119702. * @hidden
  119703. * Defines the actions happening for one camera in the frame.
  119704. */
  119705. _gatherActiveCameraRenderTargetsStage: Stage<RenderTargetsStageAction>;
  119706. /**
  119707. * @hidden
  119708. * Defines the actions happening during the per mesh ready checks.
  119709. */
  119710. _isReadyForMeshStage: Stage<MeshStageAction>;
  119711. /**
  119712. * @hidden
  119713. * Defines the actions happening before evaluate active mesh checks.
  119714. */
  119715. _beforeEvaluateActiveMeshStage: Stage<SimpleStageAction>;
  119716. /**
  119717. * @hidden
  119718. * Defines the actions happening during the evaluate sub mesh checks.
  119719. */
  119720. _evaluateSubMeshStage: Stage<EvaluateSubMeshStageAction>;
  119721. /**
  119722. * @hidden
  119723. * Defines the actions happening during the active mesh stage.
  119724. */
  119725. _activeMeshStage: Stage<ActiveMeshStageAction>;
  119726. /**
  119727. * @hidden
  119728. * Defines the actions happening during the per camera render target step.
  119729. */
  119730. _cameraDrawRenderTargetStage: Stage<CameraStageFrameBufferAction>;
  119731. /**
  119732. * @hidden
  119733. * Defines the actions happening just before the active camera is drawing.
  119734. */
  119735. _beforeCameraDrawStage: Stage<CameraStageAction>;
  119736. /**
  119737. * @hidden
  119738. * Defines the actions happening just before a render target is drawing.
  119739. */
  119740. _beforeRenderTargetDrawStage: Stage<RenderTargetStageAction>;
  119741. /**
  119742. * @hidden
  119743. * Defines the actions happening just before a rendering group is drawing.
  119744. */
  119745. _beforeRenderingGroupDrawStage: Stage<RenderingGroupStageAction>;
  119746. /**
  119747. * @hidden
  119748. * Defines the actions happening just before a mesh is drawing.
  119749. */
  119750. _beforeRenderingMeshStage: Stage<RenderingMeshStageAction>;
  119751. /**
  119752. * @hidden
  119753. * Defines the actions happening just after a mesh has been drawn.
  119754. */
  119755. _afterRenderingMeshStage: Stage<RenderingMeshStageAction>;
  119756. /**
  119757. * @hidden
  119758. * Defines the actions happening just after a rendering group has been drawn.
  119759. */
  119760. _afterRenderingGroupDrawStage: Stage<RenderingGroupStageAction>;
  119761. /**
  119762. * @hidden
  119763. * Defines the actions happening just after the active camera has been drawn.
  119764. */
  119765. _afterCameraDrawStage: Stage<CameraStageAction>;
  119766. /**
  119767. * @hidden
  119768. * Defines the actions happening just after a render target has been drawn.
  119769. */
  119770. _afterRenderTargetDrawStage: Stage<RenderTargetStageAction>;
  119771. /**
  119772. * @hidden
  119773. * Defines the actions happening just after rendering all cameras and computing intersections.
  119774. */
  119775. _afterRenderStage: Stage<SimpleStageAction>;
  119776. /**
  119777. * @hidden
  119778. * Defines the actions happening when a pointer move event happens.
  119779. */
  119780. _pointerMoveStage: Stage<PointerMoveStageAction>;
  119781. /**
  119782. * @hidden
  119783. * Defines the actions happening when a pointer down event happens.
  119784. */
  119785. _pointerDownStage: Stage<PointerUpDownStageAction>;
  119786. /**
  119787. * @hidden
  119788. * Defines the actions happening when a pointer up event happens.
  119789. */
  119790. _pointerUpStage: Stage<PointerUpDownStageAction>;
  119791. /**
  119792. * an optional map from Geometry Id to Geometry index in the 'geometries' array
  119793. */
  119794. private geometriesByUniqueId;
  119795. /**
  119796. * Creates a new Scene
  119797. * @param engine defines the engine to use to render this scene
  119798. * @param options defines the scene options
  119799. */
  119800. constructor(engine: Engine, options?: SceneOptions);
  119801. /**
  119802. * Gets a string identifying the name of the class
  119803. * @returns "Scene" string
  119804. */
  119805. getClassName(): string;
  119806. private _defaultMeshCandidates;
  119807. /**
  119808. * @hidden
  119809. */
  119810. _getDefaultMeshCandidates(): ISmartArrayLike<AbstractMesh>;
  119811. private _defaultSubMeshCandidates;
  119812. /**
  119813. * @hidden
  119814. */
  119815. _getDefaultSubMeshCandidates(mesh: AbstractMesh): ISmartArrayLike<SubMesh>;
  119816. /**
  119817. * Sets the default candidate providers for the scene.
  119818. * This sets the getActiveMeshCandidates, getActiveSubMeshCandidates, getIntersectingSubMeshCandidates
  119819. * and getCollidingSubMeshCandidates to their default function
  119820. */
  119821. setDefaultCandidateProviders(): void;
  119822. /**
  119823. * Gets the mesh that is currently under the pointer
  119824. */
  119825. get meshUnderPointer(): Nullable<AbstractMesh>;
  119826. /**
  119827. * Gets or sets the current on-screen X position of the pointer
  119828. */
  119829. get pointerX(): number;
  119830. set pointerX(value: number);
  119831. /**
  119832. * Gets or sets the current on-screen Y position of the pointer
  119833. */
  119834. get pointerY(): number;
  119835. set pointerY(value: number);
  119836. /**
  119837. * Gets the cached material (ie. the latest rendered one)
  119838. * @returns the cached material
  119839. */
  119840. getCachedMaterial(): Nullable<Material>;
  119841. /**
  119842. * Gets the cached effect (ie. the latest rendered one)
  119843. * @returns the cached effect
  119844. */
  119845. getCachedEffect(): Nullable<Effect>;
  119846. /**
  119847. * Gets the cached visibility state (ie. the latest rendered one)
  119848. * @returns the cached visibility state
  119849. */
  119850. getCachedVisibility(): Nullable<number>;
  119851. /**
  119852. * Gets a boolean indicating if the current material / effect / visibility must be bind again
  119853. * @param material defines the current material
  119854. * @param effect defines the current effect
  119855. * @param visibility defines the current visibility state
  119856. * @returns true if one parameter is not cached
  119857. */
  119858. isCachedMaterialInvalid(material: Material, effect: Effect, visibility?: number): boolean;
  119859. /**
  119860. * Gets the engine associated with the scene
  119861. * @returns an Engine
  119862. */
  119863. getEngine(): Engine;
  119864. /**
  119865. * Gets the total number of vertices rendered per frame
  119866. * @returns the total number of vertices rendered per frame
  119867. */
  119868. getTotalVertices(): number;
  119869. /**
  119870. * Gets the performance counter for total vertices
  119871. * @see https://doc.babylonjs.com/how_to/optimizing_your_scene#instrumentation
  119872. */
  119873. get totalVerticesPerfCounter(): PerfCounter;
  119874. /**
  119875. * Gets the total number of active indices rendered per frame (You can deduce the number of rendered triangles by dividing this number by 3)
  119876. * @returns the total number of active indices rendered per frame
  119877. */
  119878. getActiveIndices(): number;
  119879. /**
  119880. * Gets the performance counter for active indices
  119881. * @see https://doc.babylonjs.com/how_to/optimizing_your_scene#instrumentation
  119882. */
  119883. get totalActiveIndicesPerfCounter(): PerfCounter;
  119884. /**
  119885. * Gets the total number of active particles rendered per frame
  119886. * @returns the total number of active particles rendered per frame
  119887. */
  119888. getActiveParticles(): number;
  119889. /**
  119890. * Gets the performance counter for active particles
  119891. * @see https://doc.babylonjs.com/how_to/optimizing_your_scene#instrumentation
  119892. */
  119893. get activeParticlesPerfCounter(): PerfCounter;
  119894. /**
  119895. * Gets the total number of active bones rendered per frame
  119896. * @returns the total number of active bones rendered per frame
  119897. */
  119898. getActiveBones(): number;
  119899. /**
  119900. * Gets the performance counter for active bones
  119901. * @see https://doc.babylonjs.com/how_to/optimizing_your_scene#instrumentation
  119902. */
  119903. get activeBonesPerfCounter(): PerfCounter;
  119904. /**
  119905. * Gets the array of active meshes
  119906. * @returns an array of AbstractMesh
  119907. */
  119908. getActiveMeshes(): SmartArray<AbstractMesh>;
  119909. /**
  119910. * Gets the animation ratio (which is 1.0 is the scene renders at 60fps and 2 if the scene renders at 30fps, etc.)
  119911. * @returns a number
  119912. */
  119913. getAnimationRatio(): number;
  119914. /**
  119915. * Gets an unique Id for the current render phase
  119916. * @returns a number
  119917. */
  119918. getRenderId(): number;
  119919. /**
  119920. * Gets an unique Id for the current frame
  119921. * @returns a number
  119922. */
  119923. getFrameId(): number;
  119924. /** Call this function if you want to manually increment the render Id*/
  119925. incrementRenderId(): void;
  119926. private _createUbo;
  119927. /**
  119928. * Use this method to simulate a pointer move on a mesh
  119929. * The pickResult parameter can be obtained from a scene.pick or scene.pickWithRay
  119930. * @param pickResult pickingInfo of the object wished to simulate pointer event on
  119931. * @param pointerEventInit pointer event state to be used when simulating the pointer event (eg. pointer id for multitouch)
  119932. * @returns the current scene
  119933. */
  119934. simulatePointerMove(pickResult: PickingInfo, pointerEventInit?: PointerEventInit): Scene;
  119935. /**
  119936. * Use this method to simulate a pointer down on a mesh
  119937. * The pickResult parameter can be obtained from a scene.pick or scene.pickWithRay
  119938. * @param pickResult pickingInfo of the object wished to simulate pointer event on
  119939. * @param pointerEventInit pointer event state to be used when simulating the pointer event (eg. pointer id for multitouch)
  119940. * @returns the current scene
  119941. */
  119942. simulatePointerDown(pickResult: PickingInfo, pointerEventInit?: PointerEventInit): Scene;
  119943. /**
  119944. * Use this method to simulate a pointer up on a mesh
  119945. * The pickResult parameter can be obtained from a scene.pick or scene.pickWithRay
  119946. * @param pickResult pickingInfo of the object wished to simulate pointer event on
  119947. * @param pointerEventInit pointer event state to be used when simulating the pointer event (eg. pointer id for multitouch)
  119948. * @param doubleTap indicates that the pointer up event should be considered as part of a double click (false by default)
  119949. * @returns the current scene
  119950. */
  119951. simulatePointerUp(pickResult: PickingInfo, pointerEventInit?: PointerEventInit, doubleTap?: boolean): Scene;
  119952. /**
  119953. * Gets a boolean indicating if the current pointer event is captured (meaning that the scene has already handled the pointer down)
  119954. * @param pointerId defines the pointer id to use in a multi-touch scenario (0 by default)
  119955. * @returns true if the pointer was captured
  119956. */
  119957. isPointerCaptured(pointerId?: number): boolean;
  119958. /**
  119959. * Attach events to the canvas (To handle actionManagers triggers and raise onPointerMove, onPointerDown and onPointerUp
  119960. * @param attachUp defines if you want to attach events to pointerup
  119961. * @param attachDown defines if you want to attach events to pointerdown
  119962. * @param attachMove defines if you want to attach events to pointermove
  119963. */
  119964. attachControl(attachUp?: boolean, attachDown?: boolean, attachMove?: boolean): void;
  119965. /** Detaches all event handlers*/
  119966. detachControl(): void;
  119967. /**
  119968. * This function will check if the scene can be rendered (textures are loaded, shaders are compiled)
  119969. * Delay loaded resources are not taking in account
  119970. * @return true if all required resources are ready
  119971. */
  119972. isReady(): boolean;
  119973. /** Resets all cached information relative to material (including effect and visibility) */
  119974. resetCachedMaterial(): void;
  119975. /**
  119976. * Registers a function to be called before every frame render
  119977. * @param func defines the function to register
  119978. */
  119979. registerBeforeRender(func: () => void): void;
  119980. /**
  119981. * Unregisters a function called before every frame render
  119982. * @param func defines the function to unregister
  119983. */
  119984. unregisterBeforeRender(func: () => void): void;
  119985. /**
  119986. * Registers a function to be called after every frame render
  119987. * @param func defines the function to register
  119988. */
  119989. registerAfterRender(func: () => void): void;
  119990. /**
  119991. * Unregisters a function called after every frame render
  119992. * @param func defines the function to unregister
  119993. */
  119994. unregisterAfterRender(func: () => void): void;
  119995. private _executeOnceBeforeRender;
  119996. /**
  119997. * The provided function will run before render once and will be disposed afterwards.
  119998. * A timeout delay can be provided so that the function will be executed in N ms.
  119999. * The timeout is using the browser's native setTimeout so time percision cannot be guaranteed.
  120000. * @param func The function to be executed.
  120001. * @param timeout optional delay in ms
  120002. */
  120003. executeOnceBeforeRender(func: () => void, timeout?: number): void;
  120004. /** @hidden */
  120005. _addPendingData(data: any): void;
  120006. /** @hidden */
  120007. _removePendingData(data: any): void;
  120008. /**
  120009. * Returns the number of items waiting to be loaded
  120010. * @returns the number of items waiting to be loaded
  120011. */
  120012. getWaitingItemsCount(): number;
  120013. /**
  120014. * Returns a boolean indicating if the scene is still loading data
  120015. */
  120016. get isLoading(): boolean;
  120017. /**
  120018. * Registers a function to be executed when the scene is ready
  120019. * @param {Function} func - the function to be executed
  120020. */
  120021. executeWhenReady(func: () => void): void;
  120022. /**
  120023. * Returns a promise that resolves when the scene is ready
  120024. * @returns A promise that resolves when the scene is ready
  120025. */
  120026. whenReadyAsync(): Promise<void>;
  120027. /** @hidden */
  120028. _checkIsReady(): void;
  120029. /**
  120030. * Gets all animatable attached to the scene
  120031. */
  120032. get animatables(): Animatable[];
  120033. /**
  120034. * Resets the last animation time frame.
  120035. * Useful to override when animations start running when loading a scene for the first time.
  120036. */
  120037. resetLastAnimationTimeFrame(): void;
  120038. /**
  120039. * Gets the current view matrix
  120040. * @returns a Matrix
  120041. */
  120042. getViewMatrix(): Matrix;
  120043. /**
  120044. * Gets the current projection matrix
  120045. * @returns a Matrix
  120046. */
  120047. getProjectionMatrix(): Matrix;
  120048. /**
  120049. * Gets the current transform matrix
  120050. * @returns a Matrix made of View * Projection
  120051. */
  120052. getTransformMatrix(): Matrix;
  120053. /**
  120054. * Sets the current transform matrix
  120055. * @param viewL defines the View matrix to use
  120056. * @param projectionL defines the Projection matrix to use
  120057. * @param viewR defines the right View matrix to use (if provided)
  120058. * @param projectionR defines the right Projection matrix to use (if provided)
  120059. */
  120060. setTransformMatrix(viewL: Matrix, projectionL: Matrix, viewR?: Matrix, projectionR?: Matrix): void;
  120061. /**
  120062. * Gets the uniform buffer used to store scene data
  120063. * @returns a UniformBuffer
  120064. */
  120065. getSceneUniformBuffer(): UniformBuffer;
  120066. /**
  120067. * Gets an unique (relatively to the current scene) Id
  120068. * @returns an unique number for the scene
  120069. */
  120070. getUniqueId(): number;
  120071. /**
  120072. * Add a mesh to the list of scene's meshes
  120073. * @param newMesh defines the mesh to add
  120074. * @param recursive if all child meshes should also be added to the scene
  120075. */
  120076. addMesh(newMesh: AbstractMesh, recursive?: boolean): void;
  120077. /**
  120078. * Remove a mesh for the list of scene's meshes
  120079. * @param toRemove defines the mesh to remove
  120080. * @param recursive if all child meshes should also be removed from the scene
  120081. * @returns the index where the mesh was in the mesh list
  120082. */
  120083. removeMesh(toRemove: AbstractMesh, recursive?: boolean): number;
  120084. /**
  120085. * Add a transform node to the list of scene's transform nodes
  120086. * @param newTransformNode defines the transform node to add
  120087. */
  120088. addTransformNode(newTransformNode: TransformNode): void;
  120089. /**
  120090. * Remove a transform node for the list of scene's transform nodes
  120091. * @param toRemove defines the transform node to remove
  120092. * @returns the index where the transform node was in the transform node list
  120093. */
  120094. removeTransformNode(toRemove: TransformNode): number;
  120095. /**
  120096. * Remove a skeleton for the list of scene's skeletons
  120097. * @param toRemove defines the skeleton to remove
  120098. * @returns the index where the skeleton was in the skeleton list
  120099. */
  120100. removeSkeleton(toRemove: Skeleton): number;
  120101. /**
  120102. * Remove a morph target for the list of scene's morph targets
  120103. * @param toRemove defines the morph target to remove
  120104. * @returns the index where the morph target was in the morph target list
  120105. */
  120106. removeMorphTargetManager(toRemove: MorphTargetManager): number;
  120107. /**
  120108. * Remove a light for the list of scene's lights
  120109. * @param toRemove defines the light to remove
  120110. * @returns the index where the light was in the light list
  120111. */
  120112. removeLight(toRemove: Light): number;
  120113. /**
  120114. * Remove a camera for the list of scene's cameras
  120115. * @param toRemove defines the camera to remove
  120116. * @returns the index where the camera was in the camera list
  120117. */
  120118. removeCamera(toRemove: Camera): number;
  120119. /**
  120120. * Remove a particle system for the list of scene's particle systems
  120121. * @param toRemove defines the particle system to remove
  120122. * @returns the index where the particle system was in the particle system list
  120123. */
  120124. removeParticleSystem(toRemove: IParticleSystem): number;
  120125. /**
  120126. * Remove a animation for the list of scene's animations
  120127. * @param toRemove defines the animation to remove
  120128. * @returns the index where the animation was in the animation list
  120129. */
  120130. removeAnimation(toRemove: Animation): number;
  120131. /**
  120132. * Will stop the animation of the given target
  120133. * @param target - the target
  120134. * @param animationName - the name of the animation to stop (all animations will be stopped if both this and targetMask are empty)
  120135. * @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)
  120136. */
  120137. stopAnimation(target: any, animationName?: string, targetMask?: (target: any) => boolean): void;
  120138. /**
  120139. * Removes the given animation group from this scene.
  120140. * @param toRemove The animation group to remove
  120141. * @returns The index of the removed animation group
  120142. */
  120143. removeAnimationGroup(toRemove: AnimationGroup): number;
  120144. /**
  120145. * Removes the given multi-material from this scene.
  120146. * @param toRemove The multi-material to remove
  120147. * @returns The index of the removed multi-material
  120148. */
  120149. removeMultiMaterial(toRemove: MultiMaterial): number;
  120150. /**
  120151. * Removes the given material from this scene.
  120152. * @param toRemove The material to remove
  120153. * @returns The index of the removed material
  120154. */
  120155. removeMaterial(toRemove: Material): number;
  120156. /**
  120157. * Removes the given action manager from this scene.
  120158. * @param toRemove The action manager to remove
  120159. * @returns The index of the removed action manager
  120160. */
  120161. removeActionManager(toRemove: AbstractActionManager): number;
  120162. /**
  120163. * Removes the given texture from this scene.
  120164. * @param toRemove The texture to remove
  120165. * @returns The index of the removed texture
  120166. */
  120167. removeTexture(toRemove: BaseTexture): number;
  120168. /**
  120169. * Adds the given light to this scene
  120170. * @param newLight The light to add
  120171. */
  120172. addLight(newLight: Light): void;
  120173. /**
  120174. * Sorts the list list based on light priorities
  120175. */
  120176. sortLightsByPriority(): void;
  120177. /**
  120178. * Adds the given camera to this scene
  120179. * @param newCamera The camera to add
  120180. */
  120181. addCamera(newCamera: Camera): void;
  120182. /**
  120183. * Adds the given skeleton to this scene
  120184. * @param newSkeleton The skeleton to add
  120185. */
  120186. addSkeleton(newSkeleton: Skeleton): void;
  120187. /**
  120188. * Adds the given particle system to this scene
  120189. * @param newParticleSystem The particle system to add
  120190. */
  120191. addParticleSystem(newParticleSystem: IParticleSystem): void;
  120192. /**
  120193. * Adds the given animation to this scene
  120194. * @param newAnimation The animation to add
  120195. */
  120196. addAnimation(newAnimation: Animation): void;
  120197. /**
  120198. * Adds the given animation group to this scene.
  120199. * @param newAnimationGroup The animation group to add
  120200. */
  120201. addAnimationGroup(newAnimationGroup: AnimationGroup): void;
  120202. /**
  120203. * Adds the given multi-material to this scene
  120204. * @param newMultiMaterial The multi-material to add
  120205. */
  120206. addMultiMaterial(newMultiMaterial: MultiMaterial): void;
  120207. /**
  120208. * Adds the given material to this scene
  120209. * @param newMaterial The material to add
  120210. */
  120211. addMaterial(newMaterial: Material): void;
  120212. /**
  120213. * Adds the given morph target to this scene
  120214. * @param newMorphTargetManager The morph target to add
  120215. */
  120216. addMorphTargetManager(newMorphTargetManager: MorphTargetManager): void;
  120217. /**
  120218. * Adds the given geometry to this scene
  120219. * @param newGeometry The geometry to add
  120220. */
  120221. addGeometry(newGeometry: Geometry): void;
  120222. /**
  120223. * Adds the given action manager to this scene
  120224. * @param newActionManager The action manager to add
  120225. */
  120226. addActionManager(newActionManager: AbstractActionManager): void;
  120227. /**
  120228. * Adds the given texture to this scene.
  120229. * @param newTexture The texture to add
  120230. */
  120231. addTexture(newTexture: BaseTexture): void;
  120232. /**
  120233. * Switch active camera
  120234. * @param newCamera defines the new active camera
  120235. * @param attachControl defines if attachControl must be called for the new active camera (default: true)
  120236. */
  120237. switchActiveCamera(newCamera: Camera, attachControl?: boolean): void;
  120238. /**
  120239. * sets the active camera of the scene using its ID
  120240. * @param id defines the camera's ID
  120241. * @return the new active camera or null if none found.
  120242. */
  120243. setActiveCameraByID(id: string): Nullable<Camera>;
  120244. /**
  120245. * sets the active camera of the scene using its name
  120246. * @param name defines the camera's name
  120247. * @returns the new active camera or null if none found.
  120248. */
  120249. setActiveCameraByName(name: string): Nullable<Camera>;
  120250. /**
  120251. * get an animation group using its name
  120252. * @param name defines the material's name
  120253. * @return the animation group or null if none found.
  120254. */
  120255. getAnimationGroupByName(name: string): Nullable<AnimationGroup>;
  120256. /**
  120257. * Get a material using its unique id
  120258. * @param uniqueId defines the material's unique id
  120259. * @return the material or null if none found.
  120260. */
  120261. getMaterialByUniqueID(uniqueId: number): Nullable<Material>;
  120262. /**
  120263. * get a material using its id
  120264. * @param id defines the material's ID
  120265. * @return the material or null if none found.
  120266. */
  120267. getMaterialByID(id: string): Nullable<Material>;
  120268. /**
  120269. * Gets a the last added material using a given id
  120270. * @param id defines the material's ID
  120271. * @return the last material with the given id or null if none found.
  120272. */
  120273. getLastMaterialByID(id: string): Nullable<Material>;
  120274. /**
  120275. * Gets a material using its name
  120276. * @param name defines the material's name
  120277. * @return the material or null if none found.
  120278. */
  120279. getMaterialByName(name: string): Nullable<Material>;
  120280. /**
  120281. * Get a texture using its unique id
  120282. * @param uniqueId defines the texture's unique id
  120283. * @return the texture or null if none found.
  120284. */
  120285. getTextureByUniqueID(uniqueId: number): Nullable<BaseTexture>;
  120286. /**
  120287. * Gets a camera using its id
  120288. * @param id defines the id to look for
  120289. * @returns the camera or null if not found
  120290. */
  120291. getCameraByID(id: string): Nullable<Camera>;
  120292. /**
  120293. * Gets a camera using its unique id
  120294. * @param uniqueId defines the unique id to look for
  120295. * @returns the camera or null if not found
  120296. */
  120297. getCameraByUniqueID(uniqueId: number): Nullable<Camera>;
  120298. /**
  120299. * Gets a camera using its name
  120300. * @param name defines the camera's name
  120301. * @return the camera or null if none found.
  120302. */
  120303. getCameraByName(name: string): Nullable<Camera>;
  120304. /**
  120305. * Gets a bone using its id
  120306. * @param id defines the bone's id
  120307. * @return the bone or null if not found
  120308. */
  120309. getBoneByID(id: string): Nullable<Bone>;
  120310. /**
  120311. * Gets a bone using its id
  120312. * @param name defines the bone's name
  120313. * @return the bone or null if not found
  120314. */
  120315. getBoneByName(name: string): Nullable<Bone>;
  120316. /**
  120317. * Gets a light node using its name
  120318. * @param name defines the the light's name
  120319. * @return the light or null if none found.
  120320. */
  120321. getLightByName(name: string): Nullable<Light>;
  120322. /**
  120323. * Gets a light node using its id
  120324. * @param id defines the light's id
  120325. * @return the light or null if none found.
  120326. */
  120327. getLightByID(id: string): Nullable<Light>;
  120328. /**
  120329. * Gets a light node using its scene-generated unique ID
  120330. * @param uniqueId defines the light's unique id
  120331. * @return the light or null if none found.
  120332. */
  120333. getLightByUniqueID(uniqueId: number): Nullable<Light>;
  120334. /**
  120335. * Gets a particle system by id
  120336. * @param id defines the particle system id
  120337. * @return the corresponding system or null if none found
  120338. */
  120339. getParticleSystemByID(id: string): Nullable<IParticleSystem>;
  120340. /**
  120341. * Gets a geometry using its ID
  120342. * @param id defines the geometry's id
  120343. * @return the geometry or null if none found.
  120344. */
  120345. getGeometryByID(id: string): Nullable<Geometry>;
  120346. private _getGeometryByUniqueID;
  120347. /**
  120348. * Add a new geometry to this scene
  120349. * @param geometry defines the geometry to be added to the scene.
  120350. * @param force defines if the geometry must be pushed even if a geometry with this id already exists
  120351. * @return a boolean defining if the geometry was added or not
  120352. */
  120353. pushGeometry(geometry: Geometry, force?: boolean): boolean;
  120354. /**
  120355. * Removes an existing geometry
  120356. * @param geometry defines the geometry to be removed from the scene
  120357. * @return a boolean defining if the geometry was removed or not
  120358. */
  120359. removeGeometry(geometry: Geometry): boolean;
  120360. /**
  120361. * Gets the list of geometries attached to the scene
  120362. * @returns an array of Geometry
  120363. */
  120364. getGeometries(): Geometry[];
  120365. /**
  120366. * Gets the first added mesh found of a given ID
  120367. * @param id defines the id to search for
  120368. * @return the mesh found or null if not found at all
  120369. */
  120370. getMeshByID(id: string): Nullable<AbstractMesh>;
  120371. /**
  120372. * Gets a list of meshes using their id
  120373. * @param id defines the id to search for
  120374. * @returns a list of meshes
  120375. */
  120376. getMeshesByID(id: string): Array<AbstractMesh>;
  120377. /**
  120378. * Gets the first added transform node found of a given ID
  120379. * @param id defines the id to search for
  120380. * @return the found transform node or null if not found at all.
  120381. */
  120382. getTransformNodeByID(id: string): Nullable<TransformNode>;
  120383. /**
  120384. * Gets a transform node with its auto-generated unique id
  120385. * @param uniqueId efines the unique id to search for
  120386. * @return the found transform node or null if not found at all.
  120387. */
  120388. getTransformNodeByUniqueID(uniqueId: number): Nullable<TransformNode>;
  120389. /**
  120390. * Gets a list of transform nodes using their id
  120391. * @param id defines the id to search for
  120392. * @returns a list of transform nodes
  120393. */
  120394. getTransformNodesByID(id: string): Array<TransformNode>;
  120395. /**
  120396. * Gets a mesh with its auto-generated unique id
  120397. * @param uniqueId defines the unique id to search for
  120398. * @return the found mesh or null if not found at all.
  120399. */
  120400. getMeshByUniqueID(uniqueId: number): Nullable<AbstractMesh>;
  120401. /**
  120402. * Gets a the last added mesh using a given id
  120403. * @param id defines the id to search for
  120404. * @return the found mesh or null if not found at all.
  120405. */
  120406. getLastMeshByID(id: string): Nullable<AbstractMesh>;
  120407. /**
  120408. * Gets a the last added node (Mesh, Camera, Light) using a given id
  120409. * @param id defines the id to search for
  120410. * @return the found node or null if not found at all
  120411. */
  120412. getLastEntryByID(id: string): Nullable<Node>;
  120413. /**
  120414. * Gets a node (Mesh, Camera, Light) using a given id
  120415. * @param id defines the id to search for
  120416. * @return the found node or null if not found at all
  120417. */
  120418. getNodeByID(id: string): Nullable<Node>;
  120419. /**
  120420. * Gets a node (Mesh, Camera, Light) using a given name
  120421. * @param name defines the name to search for
  120422. * @return the found node or null if not found at all.
  120423. */
  120424. getNodeByName(name: string): Nullable<Node>;
  120425. /**
  120426. * Gets a mesh using a given name
  120427. * @param name defines the name to search for
  120428. * @return the found mesh or null if not found at all.
  120429. */
  120430. getMeshByName(name: string): Nullable<AbstractMesh>;
  120431. /**
  120432. * Gets a transform node using a given name
  120433. * @param name defines the name to search for
  120434. * @return the found transform node or null if not found at all.
  120435. */
  120436. getTransformNodeByName(name: string): Nullable<TransformNode>;
  120437. /**
  120438. * Gets a skeleton using a given id (if many are found, this function will pick the last one)
  120439. * @param id defines the id to search for
  120440. * @return the found skeleton or null if not found at all.
  120441. */
  120442. getLastSkeletonByID(id: string): Nullable<Skeleton>;
  120443. /**
  120444. * Gets a skeleton using a given auto generated unique id
  120445. * @param uniqueId defines the unique id to search for
  120446. * @return the found skeleton or null if not found at all.
  120447. */
  120448. getSkeletonByUniqueId(uniqueId: number): Nullable<Skeleton>;
  120449. /**
  120450. * Gets a skeleton using a given id (if many are found, this function will pick the first one)
  120451. * @param id defines the id to search for
  120452. * @return the found skeleton or null if not found at all.
  120453. */
  120454. getSkeletonById(id: string): Nullable<Skeleton>;
  120455. /**
  120456. * Gets a skeleton using a given name
  120457. * @param name defines the name to search for
  120458. * @return the found skeleton or null if not found at all.
  120459. */
  120460. getSkeletonByName(name: string): Nullable<Skeleton>;
  120461. /**
  120462. * Gets a morph target manager using a given id (if many are found, this function will pick the last one)
  120463. * @param id defines the id to search for
  120464. * @return the found morph target manager or null if not found at all.
  120465. */
  120466. getMorphTargetManagerById(id: number): Nullable<MorphTargetManager>;
  120467. /**
  120468. * Gets a morph target using a given id (if many are found, this function will pick the first one)
  120469. * @param id defines the id to search for
  120470. * @return the found morph target or null if not found at all.
  120471. */
  120472. getMorphTargetById(id: string): Nullable<MorphTarget>;
  120473. /**
  120474. * Gets a morph target using a given name (if many are found, this function will pick the first one)
  120475. * @param name defines the name to search for
  120476. * @return the found morph target or null if not found at all.
  120477. */
  120478. getMorphTargetByName(name: string): Nullable<MorphTarget>;
  120479. /**
  120480. * Gets a post process using a given name (if many are found, this function will pick the first one)
  120481. * @param name defines the name to search for
  120482. * @return the found post process or null if not found at all.
  120483. */
  120484. getPostProcessByName(name: string): Nullable<PostProcess>;
  120485. /**
  120486. * Gets a boolean indicating if the given mesh is active
  120487. * @param mesh defines the mesh to look for
  120488. * @returns true if the mesh is in the active list
  120489. */
  120490. isActiveMesh(mesh: AbstractMesh): boolean;
  120491. /**
  120492. * Return a unique id as a string which can serve as an identifier for the scene
  120493. */
  120494. get uid(): string;
  120495. /**
  120496. * Add an externaly attached data from its key.
  120497. * This method call will fail and return false, if such key already exists.
  120498. * If you don't care and just want to get the data no matter what, use the more convenient getOrAddExternalDataWithFactory() method.
  120499. * @param key the unique key that identifies the data
  120500. * @param data the data object to associate to the key for this Engine instance
  120501. * @return true if no such key were already present and the data was added successfully, false otherwise
  120502. */
  120503. addExternalData<T>(key: string, data: T): boolean;
  120504. /**
  120505. * Get an externaly attached data from its key
  120506. * @param key the unique key that identifies the data
  120507. * @return the associated data, if present (can be null), or undefined if not present
  120508. */
  120509. getExternalData<T>(key: string): Nullable<T>;
  120510. /**
  120511. * Get an externaly attached data from its key, create it using a factory if it's not already present
  120512. * @param key the unique key that identifies the data
  120513. * @param factory the factory that will be called to create the instance if and only if it doesn't exists
  120514. * @return the associated data, can be null if the factory returned null.
  120515. */
  120516. getOrAddExternalDataWithFactory<T>(key: string, factory: (k: string) => T): T;
  120517. /**
  120518. * Remove an externaly attached data from the Engine instance
  120519. * @param key the unique key that identifies the data
  120520. * @return true if the data was successfully removed, false if it doesn't exist
  120521. */
  120522. removeExternalData(key: string): boolean;
  120523. private _evaluateSubMesh;
  120524. /**
  120525. * Clear the processed materials smart array preventing retention point in material dispose.
  120526. */
  120527. freeProcessedMaterials(): void;
  120528. private _preventFreeActiveMeshesAndRenderingGroups;
  120529. /** Gets or sets a boolean blocking all the calls to freeActiveMeshes and freeRenderingGroups
  120530. * It can be used in order to prevent going through methods freeRenderingGroups and freeActiveMeshes several times to improve performance
  120531. * when disposing several meshes in a row or a hierarchy of meshes.
  120532. * When used, it is the responsability of the user to blockfreeActiveMeshesAndRenderingGroups back to false.
  120533. */
  120534. get blockfreeActiveMeshesAndRenderingGroups(): boolean;
  120535. set blockfreeActiveMeshesAndRenderingGroups(value: boolean);
  120536. /**
  120537. * Clear the active meshes smart array preventing retention point in mesh dispose.
  120538. */
  120539. freeActiveMeshes(): void;
  120540. /**
  120541. * Clear the info related to rendering groups preventing retention points during dispose.
  120542. */
  120543. freeRenderingGroups(): void;
  120544. /** @hidden */
  120545. _isInIntermediateRendering(): boolean;
  120546. /**
  120547. * Lambda returning the list of potentially active meshes.
  120548. */
  120549. getActiveMeshCandidates: () => ISmartArrayLike<AbstractMesh>;
  120550. /**
  120551. * Lambda returning the list of potentially active sub meshes.
  120552. */
  120553. getActiveSubMeshCandidates: (mesh: AbstractMesh) => ISmartArrayLike<SubMesh>;
  120554. /**
  120555. * Lambda returning the list of potentially intersecting sub meshes.
  120556. */
  120557. getIntersectingSubMeshCandidates: (mesh: AbstractMesh, localRay: Ray) => ISmartArrayLike<SubMesh>;
  120558. /**
  120559. * Lambda returning the list of potentially colliding sub meshes.
  120560. */
  120561. getCollidingSubMeshCandidates: (mesh: AbstractMesh, collider: Collider) => ISmartArrayLike<SubMesh>;
  120562. private _activeMeshesFrozen;
  120563. private _skipEvaluateActiveMeshesCompletely;
  120564. /**
  120565. * Use this function to stop evaluating active meshes. The current list will be keep alive between frames
  120566. * @param skipEvaluateActiveMeshes defines an optional boolean indicating that the evaluate active meshes step must be completely skipped
  120567. * @returns the current scene
  120568. */
  120569. freezeActiveMeshes(skipEvaluateActiveMeshes?: boolean): Scene;
  120570. /**
  120571. * Use this function to restart evaluating active meshes on every frame
  120572. * @returns the current scene
  120573. */
  120574. unfreezeActiveMeshes(): Scene;
  120575. private _evaluateActiveMeshes;
  120576. private _activeMesh;
  120577. /**
  120578. * Update the transform matrix to update from the current active camera
  120579. * @param force defines a boolean used to force the update even if cache is up to date
  120580. */
  120581. updateTransformMatrix(force?: boolean): void;
  120582. private _bindFrameBuffer;
  120583. /** @hidden */
  120584. _allowPostProcessClearColor: boolean;
  120585. /** @hidden */
  120586. _renderForCamera(camera: Camera, rigParent?: Camera): void;
  120587. private _processSubCameras;
  120588. private _checkIntersections;
  120589. /** @hidden */
  120590. _advancePhysicsEngineStep(step: number): void;
  120591. /**
  120592. * User updatable function that will return a deterministic frame time when engine is in deterministic lock step mode
  120593. */
  120594. getDeterministicFrameTime: () => number;
  120595. /** @hidden */
  120596. _animate(): void;
  120597. /** Execute all animations (for a frame) */
  120598. animate(): void;
  120599. /**
  120600. * Render the scene
  120601. * @param updateCameras defines a boolean indicating if cameras must update according to their inputs (true by default)
  120602. * @param ignoreAnimations defines a boolean indicating if animations should not be executed (false by default)
  120603. */
  120604. render(updateCameras?: boolean, ignoreAnimations?: boolean): void;
  120605. /**
  120606. * Freeze all materials
  120607. * A frozen material will not be updatable but should be faster to render
  120608. */
  120609. freezeMaterials(): void;
  120610. /**
  120611. * Unfreeze all materials
  120612. * A frozen material will not be updatable but should be faster to render
  120613. */
  120614. unfreezeMaterials(): void;
  120615. /**
  120616. * Releases all held ressources
  120617. */
  120618. dispose(): void;
  120619. /**
  120620. * Gets if the scene is already disposed
  120621. */
  120622. get isDisposed(): boolean;
  120623. /**
  120624. * Call this function to reduce memory footprint of the scene.
  120625. * Vertex buffers will not store CPU data anymore (this will prevent picking, collisions or physics to work correctly)
  120626. */
  120627. clearCachedVertexData(): void;
  120628. /**
  120629. * This function will remove the local cached buffer data from texture.
  120630. * It will save memory but will prevent the texture from being rebuilt
  120631. */
  120632. cleanCachedTextureBuffer(): void;
  120633. /**
  120634. * Get the world extend vectors with an optional filter
  120635. *
  120636. * @param filterPredicate the predicate - which meshes should be included when calculating the world size
  120637. * @returns {{ min: Vector3; max: Vector3 }} min and max vectors
  120638. */
  120639. getWorldExtends(filterPredicate?: (mesh: AbstractMesh) => boolean): {
  120640. min: Vector3;
  120641. max: Vector3;
  120642. };
  120643. /**
  120644. * Creates a ray that can be used to pick in the scene
  120645. * @param x defines the x coordinate of the origin (on-screen)
  120646. * @param y defines the y coordinate of the origin (on-screen)
  120647. * @param world defines the world matrix to use if you want to pick in object space (instead of world space)
  120648. * @param camera defines the camera to use for the picking
  120649. * @param cameraViewSpace defines if picking will be done in view space (false by default)
  120650. * @returns a Ray
  120651. */
  120652. createPickingRay(x: number, y: number, world: Matrix, camera: Nullable<Camera>, cameraViewSpace?: boolean): Ray;
  120653. /**
  120654. * Creates a ray that can be used to pick in the scene
  120655. * @param x defines the x coordinate of the origin (on-screen)
  120656. * @param y defines the y coordinate of the origin (on-screen)
  120657. * @param world defines the world matrix to use if you want to pick in object space (instead of world space)
  120658. * @param result defines the ray where to store the picking ray
  120659. * @param camera defines the camera to use for the picking
  120660. * @param cameraViewSpace defines if picking will be done in view space (false by default)
  120661. * @returns the current scene
  120662. */
  120663. createPickingRayToRef(x: number, y: number, world: Matrix, result: Ray, camera: Nullable<Camera>, cameraViewSpace?: boolean): Scene;
  120664. /**
  120665. * Creates a ray that can be used to pick in the scene
  120666. * @param x defines the x coordinate of the origin (on-screen)
  120667. * @param y defines the y coordinate of the origin (on-screen)
  120668. * @param camera defines the camera to use for the picking
  120669. * @returns a Ray
  120670. */
  120671. createPickingRayInCameraSpace(x: number, y: number, camera?: Camera): Ray;
  120672. /**
  120673. * Creates a ray that can be used to pick in the scene
  120674. * @param x defines the x coordinate of the origin (on-screen)
  120675. * @param y defines the y coordinate of the origin (on-screen)
  120676. * @param result defines the ray where to store the picking ray
  120677. * @param camera defines the camera to use for the picking
  120678. * @returns the current scene
  120679. */
  120680. createPickingRayInCameraSpaceToRef(x: number, y: number, result: Ray, camera?: Camera): Scene;
  120681. /** Launch a ray to try to pick a mesh in the scene
  120682. * @param x position on screen
  120683. * @param y position on screen
  120684. * @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
  120685. * @param fastCheck defines if the first intersection will be used (and not the closest)
  120686. * @param camera to use for computing the picking ray. Can be set to null. In this case, the scene.activeCamera will be used
  120687. * @param trianglePredicate defines an optional predicate used to select faces when a mesh intersection is detected
  120688. * @returns a PickingInfo
  120689. */
  120690. pick(x: number, y: number, predicate?: (mesh: AbstractMesh) => boolean, fastCheck?: boolean, camera?: Nullable<Camera>, trianglePredicate?: TrianglePickingPredicate): Nullable<PickingInfo>;
  120691. /** Launch a ray to try to pick a mesh in the scene using only bounding information of the main mesh (not using submeshes)
  120692. * @param x position on screen
  120693. * @param y position on screen
  120694. * @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
  120695. * @param fastCheck defines if the first intersection will be used (and not the closest)
  120696. * @param camera to use for computing the picking ray. Can be set to null. In this case, the scene.activeCamera will be used
  120697. * @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)
  120698. */
  120699. pickWithBoundingInfo(x: number, y: number, predicate?: (mesh: AbstractMesh) => boolean, fastCheck?: boolean, camera?: Nullable<Camera>): Nullable<PickingInfo>;
  120700. /** Use the given ray to pick a mesh in the scene
  120701. * @param ray The ray to use to pick meshes
  120702. * @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
  120703. * @param fastCheck defines if the first intersection will be used (and not the closest)
  120704. * @param trianglePredicate defines an optional predicate used to select faces when a mesh intersection is detected
  120705. * @returns a PickingInfo
  120706. */
  120707. pickWithRay(ray: Ray, predicate?: (mesh: AbstractMesh) => boolean, fastCheck?: boolean, trianglePredicate?: TrianglePickingPredicate): Nullable<PickingInfo>;
  120708. /**
  120709. * Launch a ray to try to pick a mesh in the scene
  120710. * @param x X position on screen
  120711. * @param y Y position on screen
  120712. * @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
  120713. * @param camera camera to use for computing the picking ray. Can be set to null. In this case, the scene.activeCamera will be used
  120714. * @param trianglePredicate defines an optional predicate used to select faces when a mesh intersection is detected
  120715. * @returns an array of PickingInfo
  120716. */
  120717. multiPick(x: number, y: number, predicate?: (mesh: AbstractMesh) => boolean, camera?: Camera, trianglePredicate?: TrianglePickingPredicate): Nullable<PickingInfo[]>;
  120718. /**
  120719. * Launch a ray to try to pick a mesh in the scene
  120720. * @param ray Ray to use
  120721. * @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
  120722. * @param trianglePredicate defines an optional predicate used to select faces when a mesh intersection is detected
  120723. * @returns an array of PickingInfo
  120724. */
  120725. multiPickWithRay(ray: Ray, predicate: (mesh: AbstractMesh) => boolean, trianglePredicate?: TrianglePickingPredicate): Nullable<PickingInfo[]>;
  120726. /**
  120727. * Force the value of meshUnderPointer
  120728. * @param mesh defines the mesh to use
  120729. */
  120730. setPointerOverMesh(mesh: Nullable<AbstractMesh>): void;
  120731. /**
  120732. * Gets the mesh under the pointer
  120733. * @returns a Mesh or null if no mesh is under the pointer
  120734. */
  120735. getPointerOverMesh(): Nullable<AbstractMesh>;
  120736. /** @hidden */
  120737. _rebuildGeometries(): void;
  120738. /** @hidden */
  120739. _rebuildTextures(): void;
  120740. private _getByTags;
  120741. /**
  120742. * Get a list of meshes by tags
  120743. * @param tagsQuery defines the tags query to use
  120744. * @param forEach defines a predicate used to filter results
  120745. * @returns an array of Mesh
  120746. */
  120747. getMeshesByTags(tagsQuery: string, forEach?: (mesh: AbstractMesh) => void): Mesh[];
  120748. /**
  120749. * Get a list of cameras by tags
  120750. * @param tagsQuery defines the tags query to use
  120751. * @param forEach defines a predicate used to filter results
  120752. * @returns an array of Camera
  120753. */
  120754. getCamerasByTags(tagsQuery: string, forEach?: (camera: Camera) => void): Camera[];
  120755. /**
  120756. * Get a list of lights by tags
  120757. * @param tagsQuery defines the tags query to use
  120758. * @param forEach defines a predicate used to filter results
  120759. * @returns an array of Light
  120760. */
  120761. getLightsByTags(tagsQuery: string, forEach?: (light: Light) => void): Light[];
  120762. /**
  120763. * Get a list of materials by tags
  120764. * @param tagsQuery defines the tags query to use
  120765. * @param forEach defines a predicate used to filter results
  120766. * @returns an array of Material
  120767. */
  120768. getMaterialByTags(tagsQuery: string, forEach?: (material: Material) => void): Material[];
  120769. /**
  120770. * Get a list of transform nodes by tags
  120771. * @param tagsQuery defines the tags query to use
  120772. * @param forEach defines a predicate used to filter results
  120773. * @returns an array of TransformNode
  120774. */
  120775. getTransformNodesByTags(tagsQuery: string, forEach?: (transform: TransformNode) => void): TransformNode[];
  120776. /**
  120777. * Overrides the default sort function applied in the renderging group to prepare the meshes.
  120778. * This allowed control for front to back rendering or reversly depending of the special needs.
  120779. *
  120780. * @param renderingGroupId The rendering group id corresponding to its index
  120781. * @param opaqueSortCompareFn The opaque queue comparison function use to sort.
  120782. * @param alphaTestSortCompareFn The alpha test queue comparison function use to sort.
  120783. * @param transparentSortCompareFn The transparent queue comparison function use to sort.
  120784. */
  120785. 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;
  120786. /**
  120787. * Specifies whether or not the stencil and depth buffer are cleared between two rendering groups.
  120788. *
  120789. * @param renderingGroupId The rendering group id corresponding to its index
  120790. * @param autoClearDepthStencil Automatically clears depth and stencil between groups if true.
  120791. * @param depth Automatically clears depth between groups if true and autoClear is true.
  120792. * @param stencil Automatically clears stencil between groups if true and autoClear is true.
  120793. */
  120794. setRenderingAutoClearDepthStencil(renderingGroupId: number, autoClearDepthStencil: boolean, depth?: boolean, stencil?: boolean): void;
  120795. /**
  120796. * Gets the current auto clear configuration for one rendering group of the rendering
  120797. * manager.
  120798. * @param index the rendering group index to get the information for
  120799. * @returns The auto clear setup for the requested rendering group
  120800. */
  120801. getAutoClearDepthStencilSetup(index: number): IRenderingManagerAutoClearSetup;
  120802. private _blockMaterialDirtyMechanism;
  120803. /** Gets or sets a boolean blocking all the calls to markAllMaterialsAsDirty (ie. the materials won't be updated if they are out of sync) */
  120804. get blockMaterialDirtyMechanism(): boolean;
  120805. set blockMaterialDirtyMechanism(value: boolean);
  120806. /**
  120807. * Will flag all materials as dirty to trigger new shader compilation
  120808. * @param flag defines the flag used to specify which material part must be marked as dirty
  120809. * @param predicate If not null, it will be used to specifiy if a material has to be marked as dirty
  120810. */
  120811. markAllMaterialsAsDirty(flag: number, predicate?: (mat: Material) => boolean): void;
  120812. /** @hidden */
  120813. _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;
  120814. /** @hidden */
  120815. _loadFileAsync(url: string, onProgress?: (data: any) => void, useOfflineSupport?: boolean, useArrayBuffer?: boolean): Promise<string | ArrayBuffer>;
  120816. /** @hidden */
  120817. _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;
  120818. /** @hidden */
  120819. _requestFileAsync(url: string, onProgress?: (ev: ProgressEvent) => void, useOfflineSupport?: boolean, useArrayBuffer?: boolean, onOpened?: (request: WebRequest) => void): Promise<string | ArrayBuffer>;
  120820. /** @hidden */
  120821. _readFile(file: File, onSuccess: (data: string | ArrayBuffer) => void, onProgress?: (ev: ProgressEvent) => any, useArrayBuffer?: boolean, onError?: (error: ReadFileError) => void): IFileRequest;
  120822. /** @hidden */
  120823. _readFileAsync(file: File, onProgress?: (ev: ProgressEvent) => any, useArrayBuffer?: boolean): Promise<string | ArrayBuffer>;
  120824. }
  120825. }
  120826. declare module BABYLON {
  120827. /**
  120828. * Set of assets to keep when moving a scene into an asset container.
  120829. */
  120830. export class KeepAssets extends AbstractScene {
  120831. }
  120832. /**
  120833. * Class used to store the output of the AssetContainer.instantiateAllMeshesToScene function
  120834. */
  120835. export class InstantiatedEntries {
  120836. /**
  120837. * List of new root nodes (eg. nodes with no parent)
  120838. */
  120839. rootNodes: TransformNode[];
  120840. /**
  120841. * List of new skeletons
  120842. */
  120843. skeletons: Skeleton[];
  120844. /**
  120845. * List of new animation groups
  120846. */
  120847. animationGroups: AnimationGroup[];
  120848. }
  120849. /**
  120850. * Container with a set of assets that can be added or removed from a scene.
  120851. */
  120852. export class AssetContainer extends AbstractScene {
  120853. private _wasAddedToScene;
  120854. /**
  120855. * The scene the AssetContainer belongs to.
  120856. */
  120857. scene: Scene;
  120858. /**
  120859. * Instantiates an AssetContainer.
  120860. * @param scene The scene the AssetContainer belongs to.
  120861. */
  120862. constructor(scene: Scene);
  120863. /**
  120864. * Instantiate or clone all meshes and add the new ones to the scene.
  120865. * Skeletons and animation groups will all be cloned
  120866. * @param nameFunction defines an optional function used to get new names for clones
  120867. * @param cloneMaterials defines an optional boolean that defines if materials must be cloned as well (false by default)
  120868. * @returns a list of rootNodes, skeletons and aniamtion groups that were duplicated
  120869. */
  120870. instantiateModelsToScene(nameFunction?: (sourceName: string) => string, cloneMaterials?: boolean): InstantiatedEntries;
  120871. /**
  120872. * Adds all the assets from the container to the scene.
  120873. */
  120874. addAllToScene(): void;
  120875. /**
  120876. * Removes all the assets in the container from the scene
  120877. */
  120878. removeAllFromScene(): void;
  120879. /**
  120880. * Disposes all the assets in the container
  120881. */
  120882. dispose(): void;
  120883. private _moveAssets;
  120884. /**
  120885. * Removes all the assets contained in the scene and adds them to the container.
  120886. * @param keepAssets Set of assets to keep in the scene. (default: empty)
  120887. */
  120888. moveAllFromScene(keepAssets?: KeepAssets): void;
  120889. /**
  120890. * 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.
  120891. * @returns the root mesh
  120892. */
  120893. createRootMesh(): Mesh;
  120894. /**
  120895. * Merge animations (direct and animation groups) from this asset container into a scene
  120896. * @param scene is the instance of BABYLON.Scene to append to (default: last created scene)
  120897. * @param animatables set of animatables to retarget to a node from the scene
  120898. * @param targetConverter defines a function used to convert animation targets from the asset container to the scene (default: search node by name)
  120899. * @returns an array of the new AnimationGroup added to the scene (empty array if none)
  120900. */
  120901. mergeAnimationsTo(scene: Scene | null | undefined, animatables: Animatable[], targetConverter?: Nullable<(target: any) => Nullable<Node>>): AnimationGroup[];
  120902. }
  120903. }
  120904. declare module BABYLON {
  120905. /**
  120906. * Defines how the parser contract is defined.
  120907. * These parsers are used to parse a list of specific assets (like particle systems, etc..)
  120908. */
  120909. export type BabylonFileParser = (parsedData: any, scene: Scene, container: AssetContainer, rootUrl: string) => void;
  120910. /**
  120911. * Defines how the individual parser contract is defined.
  120912. * These parser can parse an individual asset
  120913. */
  120914. export type IndividualBabylonFileParser = (parsedData: any, scene: Scene, rootUrl: string) => any;
  120915. /**
  120916. * Base class of the scene acting as a container for the different elements composing a scene.
  120917. * This class is dynamically extended by the different components of the scene increasing
  120918. * flexibility and reducing coupling
  120919. */
  120920. export abstract class AbstractScene {
  120921. /**
  120922. * Stores the list of available parsers in the application.
  120923. */
  120924. private static _BabylonFileParsers;
  120925. /**
  120926. * Stores the list of available individual parsers in the application.
  120927. */
  120928. private static _IndividualBabylonFileParsers;
  120929. /**
  120930. * Adds a parser in the list of available ones
  120931. * @param name Defines the name of the parser
  120932. * @param parser Defines the parser to add
  120933. */
  120934. static AddParser(name: string, parser: BabylonFileParser): void;
  120935. /**
  120936. * Gets a general parser from the list of avaialble ones
  120937. * @param name Defines the name of the parser
  120938. * @returns the requested parser or null
  120939. */
  120940. static GetParser(name: string): Nullable<BabylonFileParser>;
  120941. /**
  120942. * Adds n individual parser in the list of available ones
  120943. * @param name Defines the name of the parser
  120944. * @param parser Defines the parser to add
  120945. */
  120946. static AddIndividualParser(name: string, parser: IndividualBabylonFileParser): void;
  120947. /**
  120948. * Gets an individual parser from the list of avaialble ones
  120949. * @param name Defines the name of the parser
  120950. * @returns the requested parser or null
  120951. */
  120952. static GetIndividualParser(name: string): Nullable<IndividualBabylonFileParser>;
  120953. /**
  120954. * Parser json data and populate both a scene and its associated container object
  120955. * @param jsonData Defines the data to parse
  120956. * @param scene Defines the scene to parse the data for
  120957. * @param container Defines the container attached to the parsing sequence
  120958. * @param rootUrl Defines the root url of the data
  120959. */
  120960. static Parse(jsonData: any, scene: Scene, container: AssetContainer, rootUrl: string): void;
  120961. /**
  120962. * Gets the list of root nodes (ie. nodes with no parent)
  120963. */
  120964. rootNodes: Node[];
  120965. /** All of the cameras added to this scene
  120966. * @see https://doc.babylonjs.com/babylon101/cameras
  120967. */
  120968. cameras: Camera[];
  120969. /**
  120970. * All of the lights added to this scene
  120971. * @see https://doc.babylonjs.com/babylon101/lights
  120972. */
  120973. lights: Light[];
  120974. /**
  120975. * All of the (abstract) meshes added to this scene
  120976. */
  120977. meshes: AbstractMesh[];
  120978. /**
  120979. * The list of skeletons added to the scene
  120980. * @see https://doc.babylonjs.com/how_to/how_to_use_bones_and_skeletons
  120981. */
  120982. skeletons: Skeleton[];
  120983. /**
  120984. * All of the particle systems added to this scene
  120985. * @see https://doc.babylonjs.com/babylon101/particles
  120986. */
  120987. particleSystems: IParticleSystem[];
  120988. /**
  120989. * Gets a list of Animations associated with the scene
  120990. */
  120991. animations: Animation[];
  120992. /**
  120993. * All of the animation groups added to this scene
  120994. * @see https://doc.babylonjs.com/how_to/group
  120995. */
  120996. animationGroups: AnimationGroup[];
  120997. /**
  120998. * All of the multi-materials added to this scene
  120999. * @see https://doc.babylonjs.com/how_to/multi_materials
  121000. */
  121001. multiMaterials: MultiMaterial[];
  121002. /**
  121003. * All of the materials added to this scene
  121004. * In the context of a Scene, it is not supposed to be modified manually.
  121005. * Any addition or removal should be done using the addMaterial and removeMaterial Scene methods.
  121006. * Note also that the order of the Material within the array is not significant and might change.
  121007. * @see https://doc.babylonjs.com/babylon101/materials
  121008. */
  121009. materials: Material[];
  121010. /**
  121011. * The list of morph target managers added to the scene
  121012. * @see https://doc.babylonjs.com/how_to/how_to_dynamically_morph_a_mesh
  121013. */
  121014. morphTargetManagers: MorphTargetManager[];
  121015. /**
  121016. * The list of geometries used in the scene.
  121017. */
  121018. geometries: Geometry[];
  121019. /**
  121020. * All of the tranform nodes added to this scene
  121021. * In the context of a Scene, it is not supposed to be modified manually.
  121022. * Any addition or removal should be done using the addTransformNode and removeTransformNode Scene methods.
  121023. * Note also that the order of the TransformNode wihin the array is not significant and might change.
  121024. * @see https://doc.babylonjs.com/how_to/transformnode
  121025. */
  121026. transformNodes: TransformNode[];
  121027. /**
  121028. * ActionManagers available on the scene.
  121029. */
  121030. actionManagers: AbstractActionManager[];
  121031. /**
  121032. * Textures to keep.
  121033. */
  121034. textures: BaseTexture[];
  121035. /** @hidden */
  121036. protected _environmentTexture: Nullable<BaseTexture>;
  121037. /**
  121038. * Texture used in all pbr material as the reflection texture.
  121039. * As in the majority of the scene they are the same (exception for multi room and so on),
  121040. * this is easier to reference from here than from all the materials.
  121041. */
  121042. get environmentTexture(): Nullable<BaseTexture>;
  121043. set environmentTexture(value: Nullable<BaseTexture>);
  121044. /**
  121045. * The list of postprocesses added to the scene
  121046. */
  121047. postProcesses: PostProcess[];
  121048. /**
  121049. * @returns all meshes, lights, cameras, transformNodes and bones
  121050. */
  121051. getNodes(): Array<Node>;
  121052. }
  121053. }
  121054. declare module BABYLON {
  121055. /**
  121056. * Interface used to define options for Sound class
  121057. */
  121058. export interface ISoundOptions {
  121059. /**
  121060. * Does the sound autoplay once loaded.
  121061. */
  121062. autoplay?: boolean;
  121063. /**
  121064. * Does the sound loop after it finishes playing once.
  121065. */
  121066. loop?: boolean;
  121067. /**
  121068. * Sound's volume
  121069. */
  121070. volume?: number;
  121071. /**
  121072. * Is it a spatial sound?
  121073. */
  121074. spatialSound?: boolean;
  121075. /**
  121076. * Maximum distance to hear that sound
  121077. */
  121078. maxDistance?: number;
  121079. /**
  121080. * Uses user defined attenuation function
  121081. */
  121082. useCustomAttenuation?: boolean;
  121083. /**
  121084. * Define the roll off factor of spatial sounds.
  121085. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music#creating-a-spatial-3d-sound
  121086. */
  121087. rolloffFactor?: number;
  121088. /**
  121089. * Define the reference distance the sound should be heard perfectly.
  121090. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music#creating-a-spatial-3d-sound
  121091. */
  121092. refDistance?: number;
  121093. /**
  121094. * Define the distance attenuation model the sound will follow.
  121095. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music#creating-a-spatial-3d-sound
  121096. */
  121097. distanceModel?: string;
  121098. /**
  121099. * Defines the playback speed (1 by default)
  121100. */
  121101. playbackRate?: number;
  121102. /**
  121103. * Defines if the sound is from a streaming source
  121104. */
  121105. streaming?: boolean;
  121106. /**
  121107. * Defines an optional length (in seconds) inside the sound file
  121108. */
  121109. length?: number;
  121110. /**
  121111. * Defines an optional offset (in seconds) inside the sound file
  121112. */
  121113. offset?: number;
  121114. /**
  121115. * If true, URLs will not be required to state the audio file codec to use.
  121116. */
  121117. skipCodecCheck?: boolean;
  121118. }
  121119. /**
  121120. * Defines a sound that can be played in the application.
  121121. * The sound can either be an ambient track or a simple sound played in reaction to a user action.
  121122. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music
  121123. */
  121124. export class Sound {
  121125. /**
  121126. * The name of the sound in the scene.
  121127. */
  121128. name: string;
  121129. /**
  121130. * Does the sound autoplay once loaded.
  121131. */
  121132. autoplay: boolean;
  121133. /**
  121134. * Does the sound loop after it finishes playing once.
  121135. */
  121136. loop: boolean;
  121137. /**
  121138. * Does the sound use a custom attenuation curve to simulate the falloff
  121139. * happening when the source gets further away from the camera.
  121140. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music#creating-your-own-custom-attenuation-function
  121141. */
  121142. useCustomAttenuation: boolean;
  121143. /**
  121144. * The sound track id this sound belongs to.
  121145. */
  121146. soundTrackId: number;
  121147. /**
  121148. * Is this sound currently played.
  121149. */
  121150. isPlaying: boolean;
  121151. /**
  121152. * Is this sound currently paused.
  121153. */
  121154. isPaused: boolean;
  121155. /**
  121156. * Does this sound enables spatial sound.
  121157. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music#creating-a-spatial-3d-sound
  121158. */
  121159. spatialSound: boolean;
  121160. /**
  121161. * Define the reference distance the sound should be heard perfectly.
  121162. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music#creating-a-spatial-3d-sound
  121163. */
  121164. refDistance: number;
  121165. /**
  121166. * Define the roll off factor of spatial sounds.
  121167. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music#creating-a-spatial-3d-sound
  121168. */
  121169. rolloffFactor: number;
  121170. /**
  121171. * Define the max distance the sound should be heard (intensity just became 0 at this point).
  121172. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music#creating-a-spatial-3d-sound
  121173. */
  121174. maxDistance: number;
  121175. /**
  121176. * Define the distance attenuation model the sound will follow.
  121177. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music#creating-a-spatial-3d-sound
  121178. */
  121179. distanceModel: string;
  121180. /**
  121181. * @hidden
  121182. * Back Compat
  121183. **/
  121184. onended: () => any;
  121185. /**
  121186. * Gets or sets an object used to store user defined information for the sound.
  121187. */
  121188. metadata: any;
  121189. /**
  121190. * Observable event when the current playing sound finishes.
  121191. */
  121192. onEndedObservable: Observable<Sound>;
  121193. private _panningModel;
  121194. private _playbackRate;
  121195. private _streaming;
  121196. private _startTime;
  121197. private _startOffset;
  121198. private _position;
  121199. /** @hidden */
  121200. _positionInEmitterSpace: boolean;
  121201. private _localDirection;
  121202. private _volume;
  121203. private _isReadyToPlay;
  121204. private _isDirectional;
  121205. private _readyToPlayCallback;
  121206. private _audioBuffer;
  121207. private _soundSource;
  121208. private _streamingSource;
  121209. private _soundPanner;
  121210. private _soundGain;
  121211. private _inputAudioNode;
  121212. private _outputAudioNode;
  121213. private _coneInnerAngle;
  121214. private _coneOuterAngle;
  121215. private _coneOuterGain;
  121216. private _scene;
  121217. private _connectedTransformNode;
  121218. private _customAttenuationFunction;
  121219. private _registerFunc;
  121220. private _isOutputConnected;
  121221. private _htmlAudioElement;
  121222. private _urlType;
  121223. private _length?;
  121224. private _offset?;
  121225. /** @hidden */
  121226. static _SceneComponentInitialization: (scene: Scene) => void;
  121227. /**
  121228. * Create a sound and attach it to a scene
  121229. * @param name Name of your sound
  121230. * @param urlOrArrayBuffer Url to the sound to load async or ArrayBuffer, it also works with MediaStreams
  121231. * @param scene defines the scene the sound belongs to
  121232. * @param readyToPlayCallback Provide a callback function if you'd like to load your code once the sound is ready to be played
  121233. * @param options Objects to provide with the current available options: autoplay, loop, volume, spatialSound, maxDistance, rolloffFactor, refDistance, distanceModel, panningModel, streaming
  121234. */
  121235. constructor(name: string, urlOrArrayBuffer: any, scene: Scene, readyToPlayCallback?: Nullable<() => void>, options?: ISoundOptions);
  121236. /**
  121237. * Release the sound and its associated resources
  121238. */
  121239. dispose(): void;
  121240. /**
  121241. * Gets if the sounds is ready to be played or not.
  121242. * @returns true if ready, otherwise false
  121243. */
  121244. isReady(): boolean;
  121245. private _soundLoaded;
  121246. /**
  121247. * Sets the data of the sound from an audiobuffer
  121248. * @param audioBuffer The audioBuffer containing the data
  121249. */
  121250. setAudioBuffer(audioBuffer: AudioBuffer): void;
  121251. /**
  121252. * Updates the current sounds options such as maxdistance, loop...
  121253. * @param options A JSON object containing values named as the object properties
  121254. */
  121255. updateOptions(options: ISoundOptions): void;
  121256. private _createSpatialParameters;
  121257. private _updateSpatialParameters;
  121258. /**
  121259. * Switch the panning model to HRTF:
  121260. * Renders a stereo output of higher quality than equalpower — it uses a convolution with measured impulse responses from human subjects.
  121261. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music#creating-a-spatial-3d-sound
  121262. */
  121263. switchPanningModelToHRTF(): void;
  121264. /**
  121265. * Switch the panning model to Equal Power:
  121266. * Represents the equal-power panning algorithm, generally regarded as simple and efficient. equalpower is the default value.
  121267. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music#creating-a-spatial-3d-sound
  121268. */
  121269. switchPanningModelToEqualPower(): void;
  121270. private _switchPanningModel;
  121271. /**
  121272. * Connect this sound to a sound track audio node like gain...
  121273. * @param soundTrackAudioNode the sound track audio node to connect to
  121274. */
  121275. connectToSoundTrackAudioNode(soundTrackAudioNode: AudioNode): void;
  121276. /**
  121277. * Transform this sound into a directional source
  121278. * @param coneInnerAngle Size of the inner cone in degree
  121279. * @param coneOuterAngle Size of the outer cone in degree
  121280. * @param coneOuterGain Volume of the sound outside the outer cone (between 0.0 and 1.0)
  121281. */
  121282. setDirectionalCone(coneInnerAngle: number, coneOuterAngle: number, coneOuterGain: number): void;
  121283. /**
  121284. * Gets or sets the inner angle for the directional cone.
  121285. */
  121286. get directionalConeInnerAngle(): number;
  121287. /**
  121288. * Gets or sets the inner angle for the directional cone.
  121289. */
  121290. set directionalConeInnerAngle(value: number);
  121291. /**
  121292. * Gets or sets the outer angle for the directional cone.
  121293. */
  121294. get directionalConeOuterAngle(): number;
  121295. /**
  121296. * Gets or sets the outer angle for the directional cone.
  121297. */
  121298. set directionalConeOuterAngle(value: number);
  121299. /**
  121300. * Sets the position of the emitter if spatial sound is enabled
  121301. * @param newPosition Defines the new posisiton
  121302. */
  121303. setPosition(newPosition: Vector3): void;
  121304. /**
  121305. * Sets the local direction of the emitter if spatial sound is enabled
  121306. * @param newLocalDirection Defines the new local direction
  121307. */
  121308. setLocalDirectionToMesh(newLocalDirection: Vector3): void;
  121309. private _updateDirection;
  121310. /** @hidden */
  121311. updateDistanceFromListener(): void;
  121312. /**
  121313. * Sets a new custom attenuation function for the sound.
  121314. * @param callback Defines the function used for the attenuation
  121315. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music#creating-your-own-custom-attenuation-function
  121316. */
  121317. setAttenuationFunction(callback: (currentVolume: number, currentDistance: number, maxDistance: number, refDistance: number, rolloffFactor: number) => number): void;
  121318. /**
  121319. * Play the sound
  121320. * @param time (optional) Start the sound after X seconds. Start immediately (0) by default.
  121321. * @param offset (optional) Start the sound at a specific time in seconds
  121322. * @param length (optional) Sound duration (in seconds)
  121323. */
  121324. play(time?: number, offset?: number, length?: number): void;
  121325. private _onended;
  121326. /**
  121327. * Stop the sound
  121328. * @param time (optional) Stop the sound after X seconds. Stop immediately (0) by default.
  121329. */
  121330. stop(time?: number): void;
  121331. /**
  121332. * Put the sound in pause
  121333. */
  121334. pause(): void;
  121335. /**
  121336. * Sets a dedicated volume for this sounds
  121337. * @param newVolume Define the new volume of the sound
  121338. * @param time Define time for gradual change to new volume
  121339. */
  121340. setVolume(newVolume: number, time?: number): void;
  121341. /**
  121342. * Set the sound play back rate
  121343. * @param newPlaybackRate Define the playback rate the sound should be played at
  121344. */
  121345. setPlaybackRate(newPlaybackRate: number): void;
  121346. /**
  121347. * Gets the volume of the sound.
  121348. * @returns the volume of the sound
  121349. */
  121350. getVolume(): number;
  121351. /**
  121352. * Attach the sound to a dedicated mesh
  121353. * @param transformNode The transform node to connect the sound with
  121354. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music#attaching-a-sound-to-a-mesh
  121355. */
  121356. attachToMesh(transformNode: TransformNode): void;
  121357. /**
  121358. * Detach the sound from the previously attached mesh
  121359. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music#attaching-a-sound-to-a-mesh
  121360. */
  121361. detachFromMesh(): void;
  121362. private _onRegisterAfterWorldMatrixUpdate;
  121363. /**
  121364. * Clone the current sound in the scene.
  121365. * @returns the new sound clone
  121366. */
  121367. clone(): Nullable<Sound>;
  121368. /**
  121369. * Gets the current underlying audio buffer containing the data
  121370. * @returns the audio buffer
  121371. */
  121372. getAudioBuffer(): Nullable<AudioBuffer>;
  121373. /**
  121374. * Gets the WebAudio AudioBufferSourceNode, lets you keep track of and stop instances of this Sound.
  121375. * @returns the source node
  121376. */
  121377. getSoundSource(): Nullable<AudioBufferSourceNode>;
  121378. /**
  121379. * Gets the WebAudio GainNode, gives you precise control over the gain of instances of this Sound.
  121380. * @returns the gain node
  121381. */
  121382. getSoundGain(): Nullable<GainNode>;
  121383. /**
  121384. * Serializes the Sound in a JSON representation
  121385. * @returns the JSON representation of the sound
  121386. */
  121387. serialize(): any;
  121388. /**
  121389. * Parse a JSON representation of a sound to innstantiate in a given scene
  121390. * @param parsedSound Define the JSON representation of the sound (usually coming from the serialize method)
  121391. * @param scene Define the scene the new parsed sound should be created in
  121392. * @param rootUrl Define the rooturl of the load in case we need to fetch relative dependencies
  121393. * @param sourceSound Define a cound place holder if do not need to instantiate a new one
  121394. * @returns the newly parsed sound
  121395. */
  121396. static Parse(parsedSound: any, scene: Scene, rootUrl: string, sourceSound?: Sound): Sound;
  121397. }
  121398. }
  121399. declare module BABYLON {
  121400. /**
  121401. * This defines an action helpful to play a defined sound on a triggered action.
  121402. */
  121403. export class PlaySoundAction extends Action {
  121404. private _sound;
  121405. /**
  121406. * Instantiate the action
  121407. * @param triggerOptions defines the trigger options
  121408. * @param sound defines the sound to play
  121409. * @param condition defines the trigger related conditions
  121410. */
  121411. constructor(triggerOptions: any, sound: Sound, condition?: Condition);
  121412. /** @hidden */
  121413. _prepare(): void;
  121414. /**
  121415. * Execute the action and play the sound.
  121416. */
  121417. execute(): void;
  121418. /**
  121419. * Serializes the actions and its related information.
  121420. * @param parent defines the object to serialize in
  121421. * @returns the serialized object
  121422. */
  121423. serialize(parent: any): any;
  121424. }
  121425. /**
  121426. * This defines an action helpful to stop a defined sound on a triggered action.
  121427. */
  121428. export class StopSoundAction extends Action {
  121429. private _sound;
  121430. /**
  121431. * Instantiate the action
  121432. * @param triggerOptions defines the trigger options
  121433. * @param sound defines the sound to stop
  121434. * @param condition defines the trigger related conditions
  121435. */
  121436. constructor(triggerOptions: any, sound: Sound, condition?: Condition);
  121437. /** @hidden */
  121438. _prepare(): void;
  121439. /**
  121440. * Execute the action and stop the sound.
  121441. */
  121442. execute(): void;
  121443. /**
  121444. * Serializes the actions and its related information.
  121445. * @param parent defines the object to serialize in
  121446. * @returns the serialized object
  121447. */
  121448. serialize(parent: any): any;
  121449. }
  121450. }
  121451. declare module BABYLON {
  121452. /**
  121453. * This defines an action responsible to change the value of a property
  121454. * by interpolating between its current value and the newly set one once triggered.
  121455. * @see https://doc.babylonjs.com/how_to/how_to_use_actions
  121456. */
  121457. export class InterpolateValueAction extends Action {
  121458. /**
  121459. * Defines the path of the property where the value should be interpolated
  121460. */
  121461. propertyPath: string;
  121462. /**
  121463. * Defines the target value at the end of the interpolation.
  121464. */
  121465. value: any;
  121466. /**
  121467. * Defines the time it will take for the property to interpolate to the value.
  121468. */
  121469. duration: number;
  121470. /**
  121471. * Defines if the other scene animations should be stopped when the action has been triggered
  121472. */
  121473. stopOtherAnimations?: boolean;
  121474. /**
  121475. * Defines a callback raised once the interpolation animation has been done.
  121476. */
  121477. onInterpolationDone?: () => void;
  121478. /**
  121479. * Observable triggered once the interpolation animation has been done.
  121480. */
  121481. onInterpolationDoneObservable: Observable<InterpolateValueAction>;
  121482. private _target;
  121483. private _effectiveTarget;
  121484. private _property;
  121485. /**
  121486. * Instantiate the action
  121487. * @param triggerOptions defines the trigger options
  121488. * @param target defines the object containing the value to interpolate
  121489. * @param propertyPath defines the path to the property in the target object
  121490. * @param value defines the target value at the end of the interpolation
  121491. * @param duration deines the time it will take for the property to interpolate to the value.
  121492. * @param condition defines the trigger related conditions
  121493. * @param stopOtherAnimations defines if the other scene animations should be stopped when the action has been triggered
  121494. * @param onInterpolationDone defines a callback raised once the interpolation animation has been done
  121495. */
  121496. constructor(triggerOptions: any, target: any, propertyPath: string, value: any, duration?: number, condition?: Condition, stopOtherAnimations?: boolean, onInterpolationDone?: () => void);
  121497. /** @hidden */
  121498. _prepare(): void;
  121499. /**
  121500. * Execute the action starts the value interpolation.
  121501. */
  121502. execute(): void;
  121503. /**
  121504. * Serializes the actions and its related information.
  121505. * @param parent defines the object to serialize in
  121506. * @returns the serialized object
  121507. */
  121508. serialize(parent: any): any;
  121509. }
  121510. }
  121511. declare module BABYLON {
  121512. /**
  121513. * Options allowed during the creation of a sound track.
  121514. */
  121515. export interface ISoundTrackOptions {
  121516. /**
  121517. * The volume the sound track should take during creation
  121518. */
  121519. volume?: number;
  121520. /**
  121521. * Define if the sound track is the main sound track of the scene
  121522. */
  121523. mainTrack?: boolean;
  121524. }
  121525. /**
  121526. * It could be useful to isolate your music & sounds on several tracks to better manage volume on a grouped instance of sounds.
  121527. * It will be also used in a future release to apply effects on a specific track.
  121528. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music#using-sound-tracks
  121529. */
  121530. export class SoundTrack {
  121531. /**
  121532. * The unique identifier of the sound track in the scene.
  121533. */
  121534. id: number;
  121535. /**
  121536. * The list of sounds included in the sound track.
  121537. */
  121538. soundCollection: Array<Sound>;
  121539. private _outputAudioNode;
  121540. private _scene;
  121541. private _connectedAnalyser;
  121542. private _options;
  121543. private _isInitialized;
  121544. /**
  121545. * Creates a new sound track.
  121546. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music#using-sound-tracks
  121547. * @param scene Define the scene the sound track belongs to
  121548. * @param options
  121549. */
  121550. constructor(scene: Scene, options?: ISoundTrackOptions);
  121551. private _initializeSoundTrackAudioGraph;
  121552. /**
  121553. * Release the sound track and its associated resources
  121554. */
  121555. dispose(): void;
  121556. /**
  121557. * Adds a sound to this sound track
  121558. * @param sound define the cound to add
  121559. * @ignoreNaming
  121560. */
  121561. AddSound(sound: Sound): void;
  121562. /**
  121563. * Removes a sound to this sound track
  121564. * @param sound define the cound to remove
  121565. * @ignoreNaming
  121566. */
  121567. RemoveSound(sound: Sound): void;
  121568. /**
  121569. * Set a global volume for the full sound track.
  121570. * @param newVolume Define the new volume of the sound track
  121571. */
  121572. setVolume(newVolume: number): void;
  121573. /**
  121574. * Switch the panning model to HRTF:
  121575. * Renders a stereo output of higher quality than equalpower — it uses a convolution with measured impulse responses from human subjects.
  121576. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music#creating-a-spatial-3d-sound
  121577. */
  121578. switchPanningModelToHRTF(): void;
  121579. /**
  121580. * Switch the panning model to Equal Power:
  121581. * Represents the equal-power panning algorithm, generally regarded as simple and efficient. equalpower is the default value.
  121582. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music#creating-a-spatial-3d-sound
  121583. */
  121584. switchPanningModelToEqualPower(): void;
  121585. /**
  121586. * Connect the sound track to an audio analyser allowing some amazing
  121587. * synchornization between the sounds/music and your visualization (VuMeter for instance).
  121588. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music#using-the-analyser
  121589. * @param analyser The analyser to connect to the engine
  121590. */
  121591. connectToAnalyser(analyser: Analyser): void;
  121592. }
  121593. }
  121594. declare module BABYLON {
  121595. interface AbstractScene {
  121596. /**
  121597. * The list of sounds used in the scene.
  121598. */
  121599. sounds: Nullable<Array<Sound>>;
  121600. }
  121601. interface Scene {
  121602. /**
  121603. * @hidden
  121604. * Backing field
  121605. */
  121606. _mainSoundTrack: SoundTrack;
  121607. /**
  121608. * The main sound track played by the scene.
  121609. * It cotains your primary collection of sounds.
  121610. */
  121611. mainSoundTrack: SoundTrack;
  121612. /**
  121613. * The list of sound tracks added to the scene
  121614. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music
  121615. */
  121616. soundTracks: Nullable<Array<SoundTrack>>;
  121617. /**
  121618. * Gets a sound using a given name
  121619. * @param name defines the name to search for
  121620. * @return the found sound or null if not found at all.
  121621. */
  121622. getSoundByName(name: string): Nullable<Sound>;
  121623. /**
  121624. * Gets or sets if audio support is enabled
  121625. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music
  121626. */
  121627. audioEnabled: boolean;
  121628. /**
  121629. * Gets or sets if audio will be output to headphones
  121630. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music
  121631. */
  121632. headphone: boolean;
  121633. /**
  121634. * Gets or sets custom audio listener position provider
  121635. * @see https://doc.babylonjs.com/how_to/playing_sounds_and_music
  121636. */
  121637. audioListenerPositionProvider: Nullable<() => Vector3>;
  121638. /**
  121639. * Gets or sets a refresh rate when using 3D audio positioning
  121640. */
  121641. audioPositioningRefreshRate: number;
  121642. }
  121643. /**
  121644. * Defines the sound scene component responsible to manage any sounds
  121645. * in a given scene.
  121646. */
  121647. export class AudioSceneComponent implements ISceneSerializableComponent {
  121648. /**
  121649. * The component name helpfull to identify the component in the list of scene components.
  121650. */
  121651. readonly name: string;
  121652. /**
  121653. * The scene the component belongs to.
  121654. */
  121655. scene: Scene;
  121656. private _audioEnabled;
  121657. /**
  121658. * Gets whether audio is enabled or not.
  121659. * Please use related enable/disable method to switch state.
  121660. */
  121661. get audioEnabled(): boolean;
  121662. private _headphone;
  121663. /**
  121664. * Gets whether audio is outputing to headphone or not.
  121665. * Please use the according Switch methods to change output.
  121666. */
  121667. get headphone(): boolean;
  121668. /**
  121669. * Gets or sets a refresh rate when using 3D audio positioning
  121670. */
  121671. audioPositioningRefreshRate: number;
  121672. private _audioListenerPositionProvider;
  121673. /**
  121674. * Gets the current audio listener position provider
  121675. */
  121676. get audioListenerPositionProvider(): Nullable<() => Vector3>;
  121677. /**
  121678. * Sets a custom listener position for all sounds in the scene
  121679. * By default, this is the position of the first active camera
  121680. */
  121681. set audioListenerPositionProvider(value: Nullable<() => Vector3>);
  121682. /**
  121683. * Creates a new instance of the component for the given scene
  121684. * @param scene Defines the scene to register the component in
  121685. */
  121686. constructor(scene: Scene);
  121687. /**
  121688. * Registers the component in a given scene
  121689. */
  121690. register(): void;
  121691. /**
  121692. * Rebuilds the elements related to this component in case of
  121693. * context lost for instance.
  121694. */
  121695. rebuild(): void;
  121696. /**
  121697. * Serializes the component data to the specified json object
  121698. * @param serializationObject The object to serialize to
  121699. */
  121700. serialize(serializationObject: any): void;
  121701. /**
  121702. * Adds all the elements from the container to the scene
  121703. * @param container the container holding the elements
  121704. */
  121705. addFromContainer(container: AbstractScene): void;
  121706. /**
  121707. * Removes all the elements in the container from the scene
  121708. * @param container contains the elements to remove
  121709. * @param dispose if the removed element should be disposed (default: false)
  121710. */
  121711. removeFromContainer(container: AbstractScene, dispose?: boolean): void;
  121712. /**
  121713. * Disposes the component and the associated ressources.
  121714. */
  121715. dispose(): void;
  121716. /**
  121717. * Disables audio in the associated scene.
  121718. */
  121719. disableAudio(): void;
  121720. /**
  121721. * Enables audio in the associated scene.
  121722. */
  121723. enableAudio(): void;
  121724. /**
  121725. * Switch audio to headphone output.
  121726. */
  121727. switchAudioModeForHeadphones(): void;
  121728. /**
  121729. * Switch audio to normal speakers.
  121730. */
  121731. switchAudioModeForNormalSpeakers(): void;
  121732. private _cachedCameraDirection;
  121733. private _cachedCameraPosition;
  121734. private _lastCheck;
  121735. private _afterRender;
  121736. }
  121737. }
  121738. declare module BABYLON {
  121739. /**
  121740. * Wraps one or more Sound objects and selects one with random weight for playback.
  121741. */
  121742. export class WeightedSound {
  121743. /** When true a Sound will be selected and played when the current playing Sound completes. */
  121744. loop: boolean;
  121745. private _coneInnerAngle;
  121746. private _coneOuterAngle;
  121747. private _volume;
  121748. /** A Sound is currently playing. */
  121749. isPlaying: boolean;
  121750. /** A Sound is currently paused. */
  121751. isPaused: boolean;
  121752. private _sounds;
  121753. private _weights;
  121754. private _currentIndex?;
  121755. /**
  121756. * Creates a new WeightedSound from the list of sounds given.
  121757. * @param loop When true a Sound will be selected and played when the current playing Sound completes.
  121758. * @param sounds Array of Sounds that will be selected from.
  121759. * @param weights Array of number values for selection weights; length must equal sounds, values will be normalized to 1
  121760. */
  121761. constructor(loop: boolean, sounds: Sound[], weights: number[]);
  121762. /**
  121763. * The size of cone in degrees for a directional sound in which there will be no attenuation.
  121764. */
  121765. get directionalConeInnerAngle(): number;
  121766. /**
  121767. * The size of cone in degress for a directional sound in which there will be no attenuation.
  121768. */
  121769. set directionalConeInnerAngle(value: number);
  121770. /**
  121771. * Size of cone in degrees for a directional sound outside of which there will be no sound.
  121772. * Listener angles between innerAngle and outerAngle will falloff linearly.
  121773. */
  121774. get directionalConeOuterAngle(): number;
  121775. /**
  121776. * Size of cone in degrees for a directional sound outside of which there will be no sound.
  121777. * Listener angles between innerAngle and outerAngle will falloff linearly.
  121778. */
  121779. set directionalConeOuterAngle(value: number);
  121780. /**
  121781. * Playback volume.
  121782. */
  121783. get volume(): number;
  121784. /**
  121785. * Playback volume.
  121786. */
  121787. set volume(value: number);
  121788. private _onended;
  121789. /**
  121790. * Suspend playback
  121791. */
  121792. pause(): void;
  121793. /**
  121794. * Stop playback
  121795. */
  121796. stop(): void;
  121797. /**
  121798. * Start playback.
  121799. * @param startOffset Position the clip head at a specific time in seconds.
  121800. */
  121801. play(startOffset?: number): void;
  121802. }
  121803. }
  121804. declare module BABYLON {
  121805. /**
  121806. * Add a bouncing effect to an ArcRotateCamera when reaching a specified minimum and maximum radius
  121807. * @see https://doc.babylonjs.com/how_to/camera_behaviors#bouncing-behavior
  121808. */
  121809. export class BouncingBehavior implements Behavior<ArcRotateCamera> {
  121810. /**
  121811. * Gets the name of the behavior.
  121812. */
  121813. get name(): string;
  121814. /**
  121815. * The easing function used by animations
  121816. */
  121817. static EasingFunction: BackEase;
  121818. /**
  121819. * The easing mode used by animations
  121820. */
  121821. static EasingMode: number;
  121822. /**
  121823. * The duration of the animation, in milliseconds
  121824. */
  121825. transitionDuration: number;
  121826. /**
  121827. * Length of the distance animated by the transition when lower radius is reached
  121828. */
  121829. lowerRadiusTransitionRange: number;
  121830. /**
  121831. * Length of the distance animated by the transition when upper radius is reached
  121832. */
  121833. upperRadiusTransitionRange: number;
  121834. private _autoTransitionRange;
  121835. /**
  121836. * Gets a value indicating if the lowerRadiusTransitionRange and upperRadiusTransitionRange are defined automatically
  121837. */
  121838. get autoTransitionRange(): boolean;
  121839. /**
  121840. * Sets a value indicating if the lowerRadiusTransitionRange and upperRadiusTransitionRange are defined automatically
  121841. * Transition ranges will be set to 5% of the bounding box diagonal in world space
  121842. */
  121843. set autoTransitionRange(value: boolean);
  121844. private _attachedCamera;
  121845. private _onAfterCheckInputsObserver;
  121846. private _onMeshTargetChangedObserver;
  121847. /**
  121848. * Initializes the behavior.
  121849. */
  121850. init(): void;
  121851. /**
  121852. * Attaches the behavior to its arc rotate camera.
  121853. * @param camera Defines the camera to attach the behavior to
  121854. */
  121855. attach(camera: ArcRotateCamera): void;
  121856. /**
  121857. * Detaches the behavior from its current arc rotate camera.
  121858. */
  121859. detach(): void;
  121860. private _radiusIsAnimating;
  121861. private _radiusBounceTransition;
  121862. private _animatables;
  121863. private _cachedWheelPrecision;
  121864. /**
  121865. * Checks if the camera radius is at the specified limit. Takes into account animation locks.
  121866. * @param radiusLimit The limit to check against.
  121867. * @return Bool to indicate if at limit.
  121868. */
  121869. private _isRadiusAtLimit;
  121870. /**
  121871. * Applies an animation to the radius of the camera, extending by the radiusDelta.
  121872. * @param radiusDelta The delta by which to animate to. Can be negative.
  121873. */
  121874. private _applyBoundRadiusAnimation;
  121875. /**
  121876. * Removes all animation locks. Allows new animations to be added to any of the camera properties.
  121877. */
  121878. protected _clearAnimationLocks(): void;
  121879. /**
  121880. * Stops and removes all animations that have been applied to the camera
  121881. */
  121882. stopAllAnimations(): void;
  121883. }
  121884. }
  121885. declare module BABYLON {
  121886. /**
  121887. * 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.
  121888. * @see https://doc.babylonjs.com/how_to/camera_behaviors#framing-behavior
  121889. */
  121890. export class FramingBehavior implements Behavior<ArcRotateCamera> {
  121891. /**
  121892. * Gets the name of the behavior.
  121893. */
  121894. get name(): string;
  121895. private _mode;
  121896. private _radiusScale;
  121897. private _positionScale;
  121898. private _defaultElevation;
  121899. private _elevationReturnTime;
  121900. private _elevationReturnWaitTime;
  121901. private _zoomStopsAnimation;
  121902. private _framingTime;
  121903. /**
  121904. * The easing function used by animations
  121905. */
  121906. static EasingFunction: ExponentialEase;
  121907. /**
  121908. * The easing mode used by animations
  121909. */
  121910. static EasingMode: number;
  121911. /**
  121912. * Sets the current mode used by the behavior
  121913. */
  121914. set mode(mode: number);
  121915. /**
  121916. * Gets current mode used by the behavior.
  121917. */
  121918. get mode(): number;
  121919. /**
  121920. * Sets the scale applied to the radius (1 by default)
  121921. */
  121922. set radiusScale(radius: number);
  121923. /**
  121924. * Gets the scale applied to the radius
  121925. */
  121926. get radiusScale(): number;
  121927. /**
  121928. * Sets the scale to apply on Y axis to position camera focus. 0.5 by default which means the center of the bounding box.
  121929. */
  121930. set positionScale(scale: number);
  121931. /**
  121932. * Gets the scale to apply on Y axis to position camera focus. 0.5 by default which means the center of the bounding box.
  121933. */
  121934. get positionScale(): number;
  121935. /**
  121936. * Sets the angle above/below the horizontal plane to return to when the return to default elevation idle
  121937. * behaviour is triggered, in radians.
  121938. */
  121939. set defaultElevation(elevation: number);
  121940. /**
  121941. * Gets the angle above/below the horizontal plane to return to when the return to default elevation idle
  121942. * behaviour is triggered, in radians.
  121943. */
  121944. get defaultElevation(): number;
  121945. /**
  121946. * Sets the time (in milliseconds) taken to return to the default beta position.
  121947. * Negative value indicates camera should not return to default.
  121948. */
  121949. set elevationReturnTime(speed: number);
  121950. /**
  121951. * Gets the time (in milliseconds) taken to return to the default beta position.
  121952. * Negative value indicates camera should not return to default.
  121953. */
  121954. get elevationReturnTime(): number;
  121955. /**
  121956. * Sets the delay (in milliseconds) taken before the camera returns to the default beta position.
  121957. */
  121958. set elevationReturnWaitTime(time: number);
  121959. /**
  121960. * Gets the delay (in milliseconds) taken before the camera returns to the default beta position.
  121961. */
  121962. get elevationReturnWaitTime(): number;
  121963. /**
  121964. * Sets the flag that indicates if user zooming should stop animation.
  121965. */
  121966. set zoomStopsAnimation(flag: boolean);
  121967. /**
  121968. * Gets the flag that indicates if user zooming should stop animation.
  121969. */
  121970. get zoomStopsAnimation(): boolean;
  121971. /**
  121972. * Sets the transition time when framing the mesh, in milliseconds
  121973. */
  121974. set framingTime(time: number);
  121975. /**
  121976. * Gets the transition time when framing the mesh, in milliseconds
  121977. */
  121978. get framingTime(): number;
  121979. /**
  121980. * Define if the behavior should automatically change the configured
  121981. * camera limits and sensibilities.
  121982. */
  121983. autoCorrectCameraLimitsAndSensibility: boolean;
  121984. private _onPrePointerObservableObserver;
  121985. private _onAfterCheckInputsObserver;
  121986. private _onMeshTargetChangedObserver;
  121987. private _attachedCamera;
  121988. private _isPointerDown;
  121989. private _lastInteractionTime;
  121990. /**
  121991. * Initializes the behavior.
  121992. */
  121993. init(): void;
  121994. /**
  121995. * Attaches the behavior to its arc rotate camera.
  121996. * @param camera Defines the camera to attach the behavior to
  121997. */
  121998. attach(camera: ArcRotateCamera): void;
  121999. /**
  122000. * Detaches the behavior from its current arc rotate camera.
  122001. */
  122002. detach(): void;
  122003. private _animatables;
  122004. private _betaIsAnimating;
  122005. private _betaTransition;
  122006. private _radiusTransition;
  122007. private _vectorTransition;
  122008. /**
  122009. * Targets the given mesh and updates zoom level accordingly.
  122010. * @param mesh The mesh to target.
  122011. * @param focusOnOriginXZ Determines if the camera should focus on 0 in the X and Z axis instead of the mesh
  122012. * @param onAnimationEnd Callback triggered at the end of the framing animation
  122013. */
  122014. zoomOnMesh(mesh: AbstractMesh, focusOnOriginXZ?: boolean, onAnimationEnd?: Nullable<() => void>): void;
  122015. /**
  122016. * Targets the given mesh with its children and updates zoom level accordingly.
  122017. * @param mesh The mesh to target.
  122018. * @param focusOnOriginXZ Determines if the camera should focus on 0 in the X and Z axis instead of the mesh
  122019. * @param onAnimationEnd Callback triggered at the end of the framing animation
  122020. */
  122021. zoomOnMeshHierarchy(mesh: AbstractMesh, focusOnOriginXZ?: boolean, onAnimationEnd?: Nullable<() => void>): void;
  122022. /**
  122023. * Targets the given meshes with their children and updates zoom level accordingly.
  122024. * @param meshes The mesh to target.
  122025. * @param focusOnOriginXZ Determines if the camera should focus on 0 in the X and Z axis instead of the mesh
  122026. * @param onAnimationEnd Callback triggered at the end of the framing animation
  122027. */
  122028. zoomOnMeshesHierarchy(meshes: AbstractMesh[], focusOnOriginXZ?: boolean, onAnimationEnd?: Nullable<() => void>): void;
  122029. /**
  122030. * Targets the bounding box info defined by its extends and updates zoom level accordingly.
  122031. * @param minimumWorld Determines the smaller position of the bounding box extend
  122032. * @param maximumWorld Determines the bigger position of the bounding box extend
  122033. * @param focusOnOriginXZ Determines if the camera should focus on 0 in the X and Z axis instead of the mesh
  122034. * @param onAnimationEnd Callback triggered at the end of the framing animation
  122035. */
  122036. zoomOnBoundingInfo(minimumWorld: Vector3, maximumWorld: Vector3, focusOnOriginXZ?: boolean, onAnimationEnd?: Nullable<() => void>): void;
  122037. /**
  122038. * Calculates the lowest radius for the camera based on the bounding box of the mesh.
  122039. * @param mesh The mesh on which to base the calculation. mesh boundingInfo used to estimate necessary
  122040. * frustum width.
  122041. * @return The minimum distance from the primary mesh's center point at which the camera must be kept in order
  122042. * to fully enclose the mesh in the viewing frustum.
  122043. */
  122044. protected _calculateLowerRadiusFromModelBoundingSphere(minimumWorld: Vector3, maximumWorld: Vector3): number;
  122045. /**
  122046. * Keeps the camera above the ground plane. If the user pulls the camera below the ground plane, the camera
  122047. * is automatically returned to its default position (expected to be above ground plane).
  122048. */
  122049. private _maintainCameraAboveGround;
  122050. /**
  122051. * Returns the frustum slope based on the canvas ratio and camera FOV
  122052. * @returns The frustum slope represented as a Vector2 with X and Y slopes
  122053. */
  122054. private _getFrustumSlope;
  122055. /**
  122056. * Removes all animation locks. Allows new animations to be added to any of the arcCamera properties.
  122057. */
  122058. private _clearAnimationLocks;
  122059. /**
  122060. * Applies any current user interaction to the camera. Takes into account maximum alpha rotation.
  122061. */
  122062. private _applyUserInteraction;
  122063. /**
  122064. * Stops and removes all animations that have been applied to the camera
  122065. */
  122066. stopAllAnimations(): void;
  122067. /**
  122068. * Gets a value indicating if the user is moving the camera
  122069. */
  122070. get isUserIsMoving(): boolean;
  122071. /**
  122072. * The camera can move all the way towards the mesh.
  122073. */
  122074. static IgnoreBoundsSizeMode: number;
  122075. /**
  122076. * The camera is not allowed to zoom closer to the mesh than the point at which the adjusted bounding sphere touches the frustum sides
  122077. */
  122078. static FitFrustumSidesMode: number;
  122079. }
  122080. }
  122081. declare module BABYLON {
  122082. /**
  122083. * Base class for Camera Pointer Inputs.
  122084. * See FollowCameraPointersInput in src/Cameras/Inputs/followCameraPointersInput.ts
  122085. * for example usage.
  122086. */
  122087. export abstract class BaseCameraPointersInput implements ICameraInput<Camera> {
  122088. /**
  122089. * Defines the camera the input is attached to.
  122090. */
  122091. abstract camera: Camera;
  122092. /**
  122093. * Whether keyboard modifier keys are pressed at time of last mouse event.
  122094. */
  122095. protected _altKey: boolean;
  122096. protected _ctrlKey: boolean;
  122097. protected _metaKey: boolean;
  122098. protected _shiftKey: boolean;
  122099. /**
  122100. * Which mouse buttons were pressed at time of last mouse event.
  122101. * https://developer.mozilla.org/en-US/docs/Web/API/MouseEvent/buttons
  122102. */
  122103. protected _buttonsPressed: number;
  122104. /**
  122105. * Defines the buttons associated with the input to handle camera move.
  122106. */
  122107. buttons: number[];
  122108. /**
  122109. * Attach the input controls to a specific dom element to get the input from.
  122110. * @param element Defines the element the controls should be listened from
  122111. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  122112. */
  122113. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  122114. /**
  122115. * Detach the current controls from the specified dom element.
  122116. * @param element Defines the element to stop listening the inputs from
  122117. */
  122118. detachControl(element: Nullable<HTMLElement>): void;
  122119. /**
  122120. * Gets the class name of the current input.
  122121. * @returns the class name
  122122. */
  122123. getClassName(): string;
  122124. /**
  122125. * Get the friendly name associated with the input class.
  122126. * @returns the input friendly name
  122127. */
  122128. getSimpleName(): string;
  122129. /**
  122130. * Called on pointer POINTERDOUBLETAP event.
  122131. * Override this method to provide functionality on POINTERDOUBLETAP event.
  122132. */
  122133. protected onDoubleTap(type: string): void;
  122134. /**
  122135. * Called on pointer POINTERMOVE event if only a single touch is active.
  122136. * Override this method to provide functionality.
  122137. */
  122138. protected onTouch(point: Nullable<PointerTouch>, offsetX: number, offsetY: number): void;
  122139. /**
  122140. * Called on pointer POINTERMOVE event if multiple touches are active.
  122141. * Override this method to provide functionality.
  122142. */
  122143. protected onMultiTouch(pointA: Nullable<PointerTouch>, pointB: Nullable<PointerTouch>, previousPinchSquaredDistance: number, pinchSquaredDistance: number, previousMultiTouchPanPosition: Nullable<PointerTouch>, multiTouchPanPosition: Nullable<PointerTouch>): void;
  122144. /**
  122145. * Called on JS contextmenu event.
  122146. * Override this method to provide functionality.
  122147. */
  122148. protected onContextMenu(evt: PointerEvent): void;
  122149. /**
  122150. * Called each time a new POINTERDOWN event occurs. Ie, for each button
  122151. * press.
  122152. * Override this method to provide functionality.
  122153. */
  122154. protected onButtonDown(evt: PointerEvent): void;
  122155. /**
  122156. * Called each time a new POINTERUP event occurs. Ie, for each button
  122157. * release.
  122158. * Override this method to provide functionality.
  122159. */
  122160. protected onButtonUp(evt: PointerEvent): void;
  122161. /**
  122162. * Called when window becomes inactive.
  122163. * Override this method to provide functionality.
  122164. */
  122165. protected onLostFocus(): void;
  122166. private _pointerInput;
  122167. private _observer;
  122168. private _onLostFocus;
  122169. private pointA;
  122170. private pointB;
  122171. }
  122172. }
  122173. declare module BABYLON {
  122174. /**
  122175. * Manage the pointers inputs to control an arc rotate camera.
  122176. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  122177. */
  122178. export class ArcRotateCameraPointersInput extends BaseCameraPointersInput {
  122179. /**
  122180. * Defines the camera the input is attached to.
  122181. */
  122182. camera: ArcRotateCamera;
  122183. /**
  122184. * Gets the class name of the current input.
  122185. * @returns the class name
  122186. */
  122187. getClassName(): string;
  122188. /**
  122189. * Defines the buttons associated with the input to handle camera move.
  122190. */
  122191. buttons: number[];
  122192. /**
  122193. * Defines the pointer angular sensibility along the X axis or how fast is
  122194. * the camera rotating.
  122195. */
  122196. angularSensibilityX: number;
  122197. /**
  122198. * Defines the pointer angular sensibility along the Y axis or how fast is
  122199. * the camera rotating.
  122200. */
  122201. angularSensibilityY: number;
  122202. /**
  122203. * Defines the pointer pinch precision or how fast is the camera zooming.
  122204. */
  122205. pinchPrecision: number;
  122206. /**
  122207. * pinchDeltaPercentage will be used instead of pinchPrecision if different
  122208. * from 0.
  122209. * It defines the percentage of current camera.radius to use as delta when
  122210. * pinch zoom is used.
  122211. */
  122212. pinchDeltaPercentage: number;
  122213. /**
  122214. * When useNaturalPinchZoom is true, multi touch zoom will zoom in such
  122215. * that any object in the plane at the camera's target point will scale
  122216. * perfectly with finger motion.
  122217. * Overrides pinchDeltaPercentage and pinchPrecision.
  122218. */
  122219. useNaturalPinchZoom: boolean;
  122220. /**
  122221. * Defines the pointer panning sensibility or how fast is the camera moving.
  122222. */
  122223. panningSensibility: number;
  122224. /**
  122225. * Defines whether panning (2 fingers swipe) is enabled through multitouch.
  122226. */
  122227. multiTouchPanning: boolean;
  122228. /**
  122229. * Defines whether panning is enabled for both pan (2 fingers swipe) and
  122230. * zoom (pinch) through multitouch.
  122231. */
  122232. multiTouchPanAndZoom: boolean;
  122233. /**
  122234. * Revers pinch action direction.
  122235. */
  122236. pinchInwards: boolean;
  122237. private _isPanClick;
  122238. private _twoFingerActivityCount;
  122239. private _isPinching;
  122240. /**
  122241. * Called on pointer POINTERMOVE event if only a single touch is active.
  122242. */
  122243. protected onTouch(point: Nullable<PointerTouch>, offsetX: number, offsetY: number): void;
  122244. /**
  122245. * Called on pointer POINTERDOUBLETAP event.
  122246. */
  122247. protected onDoubleTap(type: string): void;
  122248. /**
  122249. * Called on pointer POINTERMOVE event if multiple touches are active.
  122250. */
  122251. protected onMultiTouch(pointA: Nullable<PointerTouch>, pointB: Nullable<PointerTouch>, previousPinchSquaredDistance: number, pinchSquaredDistance: number, previousMultiTouchPanPosition: Nullable<PointerTouch>, multiTouchPanPosition: Nullable<PointerTouch>): void;
  122252. /**
  122253. * Called each time a new POINTERDOWN event occurs. Ie, for each button
  122254. * press.
  122255. */
  122256. protected onButtonDown(evt: PointerEvent): void;
  122257. /**
  122258. * Called each time a new POINTERUP event occurs. Ie, for each button
  122259. * release.
  122260. */
  122261. protected onButtonUp(evt: PointerEvent): void;
  122262. /**
  122263. * Called when window becomes inactive.
  122264. */
  122265. protected onLostFocus(): void;
  122266. }
  122267. }
  122268. declare module BABYLON {
  122269. /**
  122270. * Manage the keyboard inputs to control the movement of an arc rotate camera.
  122271. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  122272. */
  122273. export class ArcRotateCameraKeyboardMoveInput implements ICameraInput<ArcRotateCamera> {
  122274. /**
  122275. * Defines the camera the input is attached to.
  122276. */
  122277. camera: ArcRotateCamera;
  122278. /**
  122279. * Defines the list of key codes associated with the up action (increase alpha)
  122280. */
  122281. keysUp: number[];
  122282. /**
  122283. * Defines the list of key codes associated with the down action (decrease alpha)
  122284. */
  122285. keysDown: number[];
  122286. /**
  122287. * Defines the list of key codes associated with the left action (increase beta)
  122288. */
  122289. keysLeft: number[];
  122290. /**
  122291. * Defines the list of key codes associated with the right action (decrease beta)
  122292. */
  122293. keysRight: number[];
  122294. /**
  122295. * Defines the list of key codes associated with the reset action.
  122296. * Those keys reset the camera to its last stored state (with the method camera.storeState())
  122297. */
  122298. keysReset: number[];
  122299. /**
  122300. * Defines the panning sensibility of the inputs.
  122301. * (How fast is the camera panning)
  122302. */
  122303. panningSensibility: number;
  122304. /**
  122305. * Defines the zooming sensibility of the inputs.
  122306. * (How fast is the camera zooming)
  122307. */
  122308. zoomingSensibility: number;
  122309. /**
  122310. * Defines whether maintaining the alt key down switch the movement mode from
  122311. * orientation to zoom.
  122312. */
  122313. useAltToZoom: boolean;
  122314. /**
  122315. * Rotation speed of the camera
  122316. */
  122317. angularSpeed: number;
  122318. private _keys;
  122319. private _ctrlPressed;
  122320. private _altPressed;
  122321. private _onCanvasBlurObserver;
  122322. private _onKeyboardObserver;
  122323. private _engine;
  122324. private _scene;
  122325. /**
  122326. * Attach the input controls to a specific dom element to get the input from.
  122327. * @param element Defines the element the controls should be listened from
  122328. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  122329. */
  122330. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  122331. /**
  122332. * Detach the current controls from the specified dom element.
  122333. * @param element Defines the element to stop listening the inputs from
  122334. */
  122335. detachControl(element: Nullable<HTMLElement>): void;
  122336. /**
  122337. * Update the current camera state depending on the inputs that have been used this frame.
  122338. * This is a dynamically created lambda to avoid the performance penalty of looping for inputs in the render loop.
  122339. */
  122340. checkInputs(): void;
  122341. /**
  122342. * Gets the class name of the current intput.
  122343. * @returns the class name
  122344. */
  122345. getClassName(): string;
  122346. /**
  122347. * Get the friendly name associated with the input class.
  122348. * @returns the input friendly name
  122349. */
  122350. getSimpleName(): string;
  122351. }
  122352. }
  122353. declare module BABYLON {
  122354. /**
  122355. * Manage the mouse wheel inputs to control an arc rotate camera.
  122356. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  122357. */
  122358. export class ArcRotateCameraMouseWheelInput implements ICameraInput<ArcRotateCamera> {
  122359. /**
  122360. * Defines the camera the input is attached to.
  122361. */
  122362. camera: ArcRotateCamera;
  122363. /**
  122364. * Gets or Set the mouse wheel precision or how fast is the camera zooming.
  122365. */
  122366. wheelPrecision: number;
  122367. /**
  122368. * wheelDeltaPercentage will be used instead of wheelPrecision if different from 0.
  122369. * It defines the percentage of current camera.radius to use as delta when wheel is used.
  122370. */
  122371. wheelDeltaPercentage: number;
  122372. private _wheel;
  122373. private _observer;
  122374. private computeDeltaFromMouseWheelLegacyEvent;
  122375. /**
  122376. * Attach the input controls to a specific dom element to get the input from.
  122377. * @param element Defines the element the controls should be listened from
  122378. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  122379. */
  122380. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  122381. /**
  122382. * Detach the current controls from the specified dom element.
  122383. * @param element Defines the element to stop listening the inputs from
  122384. */
  122385. detachControl(element: Nullable<HTMLElement>): void;
  122386. /**
  122387. * Gets the class name of the current intput.
  122388. * @returns the class name
  122389. */
  122390. getClassName(): string;
  122391. /**
  122392. * Get the friendly name associated with the input class.
  122393. * @returns the input friendly name
  122394. */
  122395. getSimpleName(): string;
  122396. }
  122397. }
  122398. declare module BABYLON {
  122399. /**
  122400. * Default Inputs manager for the ArcRotateCamera.
  122401. * It groups all the default supported inputs for ease of use.
  122402. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  122403. */
  122404. export class ArcRotateCameraInputsManager extends CameraInputsManager<ArcRotateCamera> {
  122405. /**
  122406. * Instantiates a new ArcRotateCameraInputsManager.
  122407. * @param camera Defines the camera the inputs belong to
  122408. */
  122409. constructor(camera: ArcRotateCamera);
  122410. /**
  122411. * Add mouse wheel input support to the input manager.
  122412. * @returns the current input manager
  122413. */
  122414. addMouseWheel(): ArcRotateCameraInputsManager;
  122415. /**
  122416. * Add pointers input support to the input manager.
  122417. * @returns the current input manager
  122418. */
  122419. addPointers(): ArcRotateCameraInputsManager;
  122420. /**
  122421. * Add keyboard input support to the input manager.
  122422. * @returns the current input manager
  122423. */
  122424. addKeyboard(): ArcRotateCameraInputsManager;
  122425. }
  122426. }
  122427. declare module BABYLON {
  122428. /**
  122429. * This represents an orbital type of camera.
  122430. *
  122431. * 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.
  122432. * 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.
  122433. * @see https://doc.babylonjs.com/babylon101/cameras#arc-rotate-camera
  122434. */
  122435. export class ArcRotateCamera extends TargetCamera {
  122436. /**
  122437. * Defines the rotation angle of the camera along the longitudinal axis.
  122438. */
  122439. alpha: number;
  122440. /**
  122441. * Defines the rotation angle of the camera along the latitudinal axis.
  122442. */
  122443. beta: number;
  122444. /**
  122445. * Defines the radius of the camera from it s target point.
  122446. */
  122447. radius: number;
  122448. protected _target: Vector3;
  122449. protected _targetHost: Nullable<AbstractMesh>;
  122450. /**
  122451. * Defines the target point of the camera.
  122452. * The camera looks towards it form the radius distance.
  122453. * Please note that you can set the target to a mesh and thus the target will be copied from mesh.position
  122454. */
  122455. get target(): Vector3;
  122456. set target(value: Vector3);
  122457. /**
  122458. * Define the current local position of the camera in the scene
  122459. */
  122460. get position(): Vector3;
  122461. set position(newPosition: Vector3);
  122462. protected _upToYMatrix: Matrix;
  122463. protected _YToUpMatrix: Matrix;
  122464. /**
  122465. * The vector the camera should consider as up. (default is Vector3(0, 1, 0) as returned by Vector3.Up())
  122466. * Setting this will copy the given vector to the camera's upVector, and set rotation matrices to and from Y up.
  122467. * DO NOT set the up vector using copyFrom or copyFromFloats, as this bypasses setting the above matrices.
  122468. */
  122469. set upVector(vec: Vector3);
  122470. get upVector(): Vector3;
  122471. /**
  122472. * Sets the Y-up to camera up-vector rotation matrix, and the up-vector to Y-up rotation matrix.
  122473. */
  122474. setMatUp(): void;
  122475. /**
  122476. * Current inertia value on the longitudinal axis.
  122477. * The bigger this number the longer it will take for the camera to stop.
  122478. */
  122479. inertialAlphaOffset: number;
  122480. /**
  122481. * Current inertia value on the latitudinal axis.
  122482. * The bigger this number the longer it will take for the camera to stop.
  122483. */
  122484. inertialBetaOffset: number;
  122485. /**
  122486. * Current inertia value on the radius axis.
  122487. * The bigger this number the longer it will take for the camera to stop.
  122488. */
  122489. inertialRadiusOffset: number;
  122490. /**
  122491. * Minimum allowed angle on the longitudinal axis.
  122492. * This can help limiting how the Camera is able to move in the scene.
  122493. */
  122494. lowerAlphaLimit: Nullable<number>;
  122495. /**
  122496. * Maximum allowed angle on the longitudinal axis.
  122497. * This can help limiting how the Camera is able to move in the scene.
  122498. */
  122499. upperAlphaLimit: Nullable<number>;
  122500. /**
  122501. * Minimum allowed angle on the latitudinal axis.
  122502. * This can help limiting how the Camera is able to move in the scene.
  122503. */
  122504. lowerBetaLimit: number;
  122505. /**
  122506. * Maximum allowed angle on the latitudinal axis.
  122507. * This can help limiting how the Camera is able to move in the scene.
  122508. */
  122509. upperBetaLimit: number;
  122510. /**
  122511. * Minimum allowed distance of the camera to the target (The camera can not get closer).
  122512. * This can help limiting how the Camera is able to move in the scene.
  122513. */
  122514. lowerRadiusLimit: Nullable<number>;
  122515. /**
  122516. * Maximum allowed distance of the camera to the target (The camera can not get further).
  122517. * This can help limiting how the Camera is able to move in the scene.
  122518. */
  122519. upperRadiusLimit: Nullable<number>;
  122520. /**
  122521. * Defines the current inertia value used during panning of the camera along the X axis.
  122522. */
  122523. inertialPanningX: number;
  122524. /**
  122525. * Defines the current inertia value used during panning of the camera along the Y axis.
  122526. */
  122527. inertialPanningY: number;
  122528. /**
  122529. * Defines the distance used to consider the camera in pan mode vs pinch/zoom.
  122530. * Basically if your fingers moves away from more than this distance you will be considered
  122531. * in pinch mode.
  122532. */
  122533. pinchToPanMaxDistance: number;
  122534. /**
  122535. * Defines the maximum distance the camera can pan.
  122536. * This could help keeping the cammera always in your scene.
  122537. */
  122538. panningDistanceLimit: Nullable<number>;
  122539. /**
  122540. * Defines the target of the camera before paning.
  122541. */
  122542. panningOriginTarget: Vector3;
  122543. /**
  122544. * Defines the value of the inertia used during panning.
  122545. * 0 would mean stop inertia and one would mean no decelleration at all.
  122546. */
  122547. panningInertia: number;
  122548. /**
  122549. * Gets or Set the pointer angular sensibility along the X axis or how fast is the camera rotating.
  122550. */
  122551. get angularSensibilityX(): number;
  122552. set angularSensibilityX(value: number);
  122553. /**
  122554. * Gets or Set the pointer angular sensibility along the Y axis or how fast is the camera rotating.
  122555. */
  122556. get angularSensibilityY(): number;
  122557. set angularSensibilityY(value: number);
  122558. /**
  122559. * Gets or Set the pointer pinch precision or how fast is the camera zooming.
  122560. */
  122561. get pinchPrecision(): number;
  122562. set pinchPrecision(value: number);
  122563. /**
  122564. * Gets or Set the pointer pinch delta percentage or how fast is the camera zooming.
  122565. * It will be used instead of pinchDeltaPrecision if different from 0.
  122566. * It defines the percentage of current camera.radius to use as delta when pinch zoom is used.
  122567. */
  122568. get pinchDeltaPercentage(): number;
  122569. set pinchDeltaPercentage(value: number);
  122570. /**
  122571. * Gets or Set the pointer use natural pinch zoom to override the pinch precision
  122572. * and pinch delta percentage.
  122573. * When useNaturalPinchZoom is true, multi touch zoom will zoom in such
  122574. * that any object in the plane at the camera's target point will scale
  122575. * perfectly with finger motion.
  122576. */
  122577. get useNaturalPinchZoom(): boolean;
  122578. set useNaturalPinchZoom(value: boolean);
  122579. /**
  122580. * Gets or Set the pointer panning sensibility or how fast is the camera moving.
  122581. */
  122582. get panningSensibility(): number;
  122583. set panningSensibility(value: number);
  122584. /**
  122585. * Gets or Set the list of keyboard keys used to control beta angle in a positive direction.
  122586. */
  122587. get keysUp(): number[];
  122588. set keysUp(value: number[]);
  122589. /**
  122590. * Gets or Set the list of keyboard keys used to control beta angle in a negative direction.
  122591. */
  122592. get keysDown(): number[];
  122593. set keysDown(value: number[]);
  122594. /**
  122595. * Gets or Set the list of keyboard keys used to control alpha angle in a negative direction.
  122596. */
  122597. get keysLeft(): number[];
  122598. set keysLeft(value: number[]);
  122599. /**
  122600. * Gets or Set the list of keyboard keys used to control alpha angle in a positive direction.
  122601. */
  122602. get keysRight(): number[];
  122603. set keysRight(value: number[]);
  122604. /**
  122605. * Gets or Set the mouse wheel precision or how fast is the camera zooming.
  122606. */
  122607. get wheelPrecision(): number;
  122608. set wheelPrecision(value: number);
  122609. /**
  122610. * Gets or Set the mouse wheel delta percentage or how fast is the camera zooming.
  122611. * It will be used instead of pinchDeltaPrecision if different from 0.
  122612. * It defines the percentage of current camera.radius to use as delta when pinch zoom is used.
  122613. */
  122614. get wheelDeltaPercentage(): number;
  122615. set wheelDeltaPercentage(value: number);
  122616. /**
  122617. * Defines how much the radius should be scaled while zomming on a particular mesh (through the zoomOn function)
  122618. */
  122619. zoomOnFactor: number;
  122620. /**
  122621. * Defines a screen offset for the camera position.
  122622. */
  122623. targetScreenOffset: Vector2;
  122624. /**
  122625. * Allows the camera to be completely reversed.
  122626. * If false the camera can not arrive upside down.
  122627. */
  122628. allowUpsideDown: boolean;
  122629. /**
  122630. * Define if double tap/click is used to restore the previously saved state of the camera.
  122631. */
  122632. useInputToRestoreState: boolean;
  122633. /** @hidden */
  122634. _viewMatrix: Matrix;
  122635. /** @hidden */
  122636. _useCtrlForPanning: boolean;
  122637. /** @hidden */
  122638. _panningMouseButton: number;
  122639. /**
  122640. * Defines the input associated to the camera.
  122641. */
  122642. inputs: ArcRotateCameraInputsManager;
  122643. /** @hidden */
  122644. _reset: () => void;
  122645. /**
  122646. * Defines the allowed panning axis.
  122647. */
  122648. panningAxis: Vector3;
  122649. protected _localDirection: Vector3;
  122650. protected _transformedDirection: Vector3;
  122651. private _bouncingBehavior;
  122652. /**
  122653. * Gets the bouncing behavior of the camera if it has been enabled.
  122654. * @see https://doc.babylonjs.com/how_to/camera_behaviors#bouncing-behavior
  122655. */
  122656. get bouncingBehavior(): Nullable<BouncingBehavior>;
  122657. /**
  122658. * Defines if the bouncing behavior of the camera is enabled on the camera.
  122659. * @see https://doc.babylonjs.com/how_to/camera_behaviors#bouncing-behavior
  122660. */
  122661. get useBouncingBehavior(): boolean;
  122662. set useBouncingBehavior(value: boolean);
  122663. private _framingBehavior;
  122664. /**
  122665. * Gets the framing behavior of the camera if it has been enabled.
  122666. * @see https://doc.babylonjs.com/how_to/camera_behaviors#framing-behavior
  122667. */
  122668. get framingBehavior(): Nullable<FramingBehavior>;
  122669. /**
  122670. * Defines if the framing behavior of the camera is enabled on the camera.
  122671. * @see https://doc.babylonjs.com/how_to/camera_behaviors#framing-behavior
  122672. */
  122673. get useFramingBehavior(): boolean;
  122674. set useFramingBehavior(value: boolean);
  122675. private _autoRotationBehavior;
  122676. /**
  122677. * Gets the auto rotation behavior of the camera if it has been enabled.
  122678. * @see https://doc.babylonjs.com/how_to/camera_behaviors#autorotation-behavior
  122679. */
  122680. get autoRotationBehavior(): Nullable<AutoRotationBehavior>;
  122681. /**
  122682. * Defines if the auto rotation behavior of the camera is enabled on the camera.
  122683. * @see https://doc.babylonjs.com/how_to/camera_behaviors#autorotation-behavior
  122684. */
  122685. get useAutoRotationBehavior(): boolean;
  122686. set useAutoRotationBehavior(value: boolean);
  122687. /**
  122688. * Observable triggered when the mesh target has been changed on the camera.
  122689. */
  122690. onMeshTargetChangedObservable: Observable<Nullable<AbstractMesh>>;
  122691. /**
  122692. * Event raised when the camera is colliding with a mesh.
  122693. */
  122694. onCollide: (collidedMesh: AbstractMesh) => void;
  122695. /**
  122696. * Defines whether the camera should check collision with the objects oh the scene.
  122697. * @see https://doc.babylonjs.com/babylon101/cameras,_mesh_collisions_and_gravity#how-can-i-do-this
  122698. */
  122699. checkCollisions: boolean;
  122700. /**
  122701. * Defines the collision radius of the camera.
  122702. * This simulates a sphere around the camera.
  122703. * @see https://doc.babylonjs.com/babylon101/cameras,_mesh_collisions_and_gravity#arcrotatecamera
  122704. */
  122705. collisionRadius: Vector3;
  122706. protected _collider: Collider;
  122707. protected _previousPosition: Vector3;
  122708. protected _collisionVelocity: Vector3;
  122709. protected _newPosition: Vector3;
  122710. protected _previousAlpha: number;
  122711. protected _previousBeta: number;
  122712. protected _previousRadius: number;
  122713. protected _collisionTriggered: boolean;
  122714. protected _targetBoundingCenter: Nullable<Vector3>;
  122715. private _computationVector;
  122716. /**
  122717. * Instantiates a new ArcRotateCamera in a given scene
  122718. * @param name Defines the name of the camera
  122719. * @param alpha Defines the camera rotation along the logitudinal axis
  122720. * @param beta Defines the camera rotation along the latitudinal axis
  122721. * @param radius Defines the camera distance from its target
  122722. * @param target Defines the camera target
  122723. * @param scene Defines the scene the camera belongs to
  122724. * @param setActiveOnSceneIfNoneActive Defines wheter the camera should be marked as active if not other active cameras have been defined
  122725. */
  122726. constructor(name: string, alpha: number, beta: number, radius: number, target: Vector3, scene: Scene, setActiveOnSceneIfNoneActive?: boolean);
  122727. /** @hidden */
  122728. _initCache(): void;
  122729. /** @hidden */
  122730. _updateCache(ignoreParentClass?: boolean): void;
  122731. protected _getTargetPosition(): Vector3;
  122732. private _storedAlpha;
  122733. private _storedBeta;
  122734. private _storedRadius;
  122735. private _storedTarget;
  122736. private _storedTargetScreenOffset;
  122737. /**
  122738. * Stores the current state of the camera (alpha, beta, radius and target)
  122739. * @returns the camera itself
  122740. */
  122741. storeState(): Camera;
  122742. /**
  122743. * @hidden
  122744. * Restored camera state. You must call storeState() first
  122745. */
  122746. _restoreStateValues(): boolean;
  122747. /** @hidden */
  122748. _isSynchronizedViewMatrix(): boolean;
  122749. /**
  122750. * Attached controls to the current camera.
  122751. * @param element Defines the element the controls should be listened from
  122752. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  122753. * @param useCtrlForPanning Defines whether ctrl is used for paning within the controls
  122754. * @param panningMouseButton Defines whether panning is allowed through mouse click button
  122755. */
  122756. attachControl(element: HTMLElement, noPreventDefault?: boolean, useCtrlForPanning?: boolean, panningMouseButton?: number): void;
  122757. /**
  122758. * Detach the current controls from the camera.
  122759. * The camera will stop reacting to inputs.
  122760. * @param element Defines the element to stop listening the inputs from
  122761. */
  122762. detachControl(element: HTMLElement): void;
  122763. /** @hidden */
  122764. _checkInputs(): void;
  122765. protected _checkLimits(): void;
  122766. /**
  122767. * Rebuilds angles (alpha, beta) and radius from the give position and target
  122768. */
  122769. rebuildAnglesAndRadius(): void;
  122770. /**
  122771. * Use a position to define the current camera related information like alpha, beta and radius
  122772. * @param position Defines the position to set the camera at
  122773. */
  122774. setPosition(position: Vector3): void;
  122775. /**
  122776. * Defines the target the camera should look at.
  122777. * This will automatically adapt alpha beta and radius to fit within the new target.
  122778. * @param target Defines the new target as a Vector or a mesh
  122779. * @param toBoundingCenter In case of a mesh target, defines whether to target the mesh position or its bounding information center
  122780. * @param allowSamePosition If false, prevents reapplying the new computed position if it is identical to the current one (optim)
  122781. */
  122782. setTarget(target: AbstractMesh | Vector3, toBoundingCenter?: boolean, allowSamePosition?: boolean): void;
  122783. /** @hidden */
  122784. _getViewMatrix(): Matrix;
  122785. protected _onCollisionPositionChange: (collisionId: number, newPosition: Vector3, collidedMesh?: Nullable<AbstractMesh>) => void;
  122786. /**
  122787. * Zooms on a mesh to be at the min distance where we could see it fully in the current viewport.
  122788. * @param meshes Defines the mesh to zoom on
  122789. * @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)
  122790. */
  122791. zoomOn(meshes?: AbstractMesh[], doNotUpdateMaxZ?: boolean): void;
  122792. /**
  122793. * Focus on a mesh or a bounding box. This adapts the target and maxRadius if necessary but does not update the current radius.
  122794. * The target will be changed but the radius
  122795. * @param meshesOrMinMaxVectorAndDistance Defines the mesh or bounding info to focus on
  122796. * @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)
  122797. */
  122798. focusOn(meshesOrMinMaxVectorAndDistance: AbstractMesh[] | {
  122799. min: Vector3;
  122800. max: Vector3;
  122801. distance: number;
  122802. }, doNotUpdateMaxZ?: boolean): void;
  122803. /**
  122804. * @override
  122805. * Override Camera.createRigCamera
  122806. */
  122807. createRigCamera(name: string, cameraIndex: number): Camera;
  122808. /**
  122809. * @hidden
  122810. * @override
  122811. * Override Camera._updateRigCameras
  122812. */
  122813. _updateRigCameras(): void;
  122814. /**
  122815. * Destroy the camera and release the current resources hold by it.
  122816. */
  122817. dispose(): void;
  122818. /**
  122819. * Gets the current object class name.
  122820. * @return the class name
  122821. */
  122822. getClassName(): string;
  122823. }
  122824. }
  122825. declare module BABYLON {
  122826. /**
  122827. * The autoRotation behavior (AutoRotationBehavior) is designed to create a smooth rotation of an ArcRotateCamera when there is no user interaction.
  122828. * @see https://doc.babylonjs.com/how_to/camera_behaviors#autorotation-behavior
  122829. */
  122830. export class AutoRotationBehavior implements Behavior<ArcRotateCamera> {
  122831. /**
  122832. * Gets the name of the behavior.
  122833. */
  122834. get name(): string;
  122835. private _zoomStopsAnimation;
  122836. private _idleRotationSpeed;
  122837. private _idleRotationWaitTime;
  122838. private _idleRotationSpinupTime;
  122839. /**
  122840. * Sets the flag that indicates if user zooming should stop animation.
  122841. */
  122842. set zoomStopsAnimation(flag: boolean);
  122843. /**
  122844. * Gets the flag that indicates if user zooming should stop animation.
  122845. */
  122846. get zoomStopsAnimation(): boolean;
  122847. /**
  122848. * Sets the default speed at which the camera rotates around the model.
  122849. */
  122850. set idleRotationSpeed(speed: number);
  122851. /**
  122852. * Gets the default speed at which the camera rotates around the model.
  122853. */
  122854. get idleRotationSpeed(): number;
  122855. /**
  122856. * Sets the time (in milliseconds) to wait after user interaction before the camera starts rotating.
  122857. */
  122858. set idleRotationWaitTime(time: number);
  122859. /**
  122860. * Gets the time (milliseconds) to wait after user interaction before the camera starts rotating.
  122861. */
  122862. get idleRotationWaitTime(): number;
  122863. /**
  122864. * Sets the time (milliseconds) to take to spin up to the full idle rotation speed.
  122865. */
  122866. set idleRotationSpinupTime(time: number);
  122867. /**
  122868. * Gets the time (milliseconds) to take to spin up to the full idle rotation speed.
  122869. */
  122870. get idleRotationSpinupTime(): number;
  122871. /**
  122872. * Gets a value indicating if the camera is currently rotating because of this behavior
  122873. */
  122874. get rotationInProgress(): boolean;
  122875. private _onPrePointerObservableObserver;
  122876. private _onAfterCheckInputsObserver;
  122877. private _attachedCamera;
  122878. private _isPointerDown;
  122879. private _lastFrameTime;
  122880. private _lastInteractionTime;
  122881. private _cameraRotationSpeed;
  122882. /**
  122883. * Initializes the behavior.
  122884. */
  122885. init(): void;
  122886. /**
  122887. * Attaches the behavior to its arc rotate camera.
  122888. * @param camera Defines the camera to attach the behavior to
  122889. */
  122890. attach(camera: ArcRotateCamera): void;
  122891. /**
  122892. * Detaches the behavior from its current arc rotate camera.
  122893. */
  122894. detach(): void;
  122895. /**
  122896. * Returns true if user is scrolling.
  122897. * @return true if user is scrolling.
  122898. */
  122899. private _userIsZooming;
  122900. private _lastFrameRadius;
  122901. private _shouldAnimationStopForInteraction;
  122902. /**
  122903. * Applies any current user interaction to the camera. Takes into account maximum alpha rotation.
  122904. */
  122905. private _applyUserInteraction;
  122906. private _userIsMoving;
  122907. }
  122908. }
  122909. declare module BABYLON {
  122910. /**
  122911. * A behavior that when attached to a mesh will will place a specified node on the meshes face pointing towards the camera
  122912. */
  122913. export class AttachToBoxBehavior implements Behavior<Mesh> {
  122914. private ui;
  122915. /**
  122916. * The name of the behavior
  122917. */
  122918. name: string;
  122919. /**
  122920. * The distance away from the face of the mesh that the UI should be attached to (default: 0.15)
  122921. */
  122922. distanceAwayFromFace: number;
  122923. /**
  122924. * The distance from the bottom of the face that the UI should be attached to (default: 0.15)
  122925. */
  122926. distanceAwayFromBottomOfFace: number;
  122927. private _faceVectors;
  122928. private _target;
  122929. private _scene;
  122930. private _onRenderObserver;
  122931. private _tmpMatrix;
  122932. private _tmpVector;
  122933. /**
  122934. * Creates the AttachToBoxBehavior, used to attach UI to the closest face of the box to a camera
  122935. * @param ui The transform node that should be attched to the mesh
  122936. */
  122937. constructor(ui: TransformNode);
  122938. /**
  122939. * Initializes the behavior
  122940. */
  122941. init(): void;
  122942. private _closestFace;
  122943. private _zeroVector;
  122944. private _lookAtTmpMatrix;
  122945. private _lookAtToRef;
  122946. /**
  122947. * Attaches the AttachToBoxBehavior to the passed in mesh
  122948. * @param target The mesh that the specified node will be attached to
  122949. */
  122950. attach(target: Mesh): void;
  122951. /**
  122952. * Detaches the behavior from the mesh
  122953. */
  122954. detach(): void;
  122955. }
  122956. }
  122957. declare module BABYLON {
  122958. /**
  122959. * A behavior that when attached to a mesh will allow the mesh to fade in and out
  122960. */
  122961. export class FadeInOutBehavior implements Behavior<Mesh> {
  122962. /**
  122963. * Time in milliseconds to delay before fading in (Default: 0)
  122964. */
  122965. delay: number;
  122966. /**
  122967. * Time in milliseconds for the mesh to fade in (Default: 300)
  122968. */
  122969. fadeInTime: number;
  122970. private _millisecondsPerFrame;
  122971. private _hovered;
  122972. private _hoverValue;
  122973. private _ownerNode;
  122974. /**
  122975. * Instatiates the FadeInOutBehavior
  122976. */
  122977. constructor();
  122978. /**
  122979. * The name of the behavior
  122980. */
  122981. get name(): string;
  122982. /**
  122983. * Initializes the behavior
  122984. */
  122985. init(): void;
  122986. /**
  122987. * Attaches the fade behavior on the passed in mesh
  122988. * @param ownerNode The mesh that will be faded in/out once attached
  122989. */
  122990. attach(ownerNode: Mesh): void;
  122991. /**
  122992. * Detaches the behavior from the mesh
  122993. */
  122994. detach(): void;
  122995. /**
  122996. * Triggers the mesh to begin fading in or out
  122997. * @param value if the object should fade in or out (true to fade in)
  122998. */
  122999. fadeIn(value: boolean): void;
  123000. private _update;
  123001. private _setAllVisibility;
  123002. }
  123003. }
  123004. declare module BABYLON {
  123005. /**
  123006. * Class containing a set of static utilities functions for managing Pivots
  123007. * @hidden
  123008. */
  123009. export class PivotTools {
  123010. private static _PivotCached;
  123011. private static _OldPivotPoint;
  123012. private static _PivotTranslation;
  123013. private static _PivotTmpVector;
  123014. /** @hidden */
  123015. static _RemoveAndStorePivotPoint(mesh: AbstractMesh): void;
  123016. /** @hidden */
  123017. static _RestorePivotPoint(mesh: AbstractMesh): void;
  123018. }
  123019. }
  123020. declare module BABYLON {
  123021. /**
  123022. * Class containing static functions to help procedurally build meshes
  123023. */
  123024. export class PlaneBuilder {
  123025. /**
  123026. * Creates a plane mesh
  123027. * * The parameter `size` sets the size (float) of both sides of the plane at once (default 1)
  123028. * * You can set some different plane dimensions by using the parameters `width` and `height` (both by default have the same value of `size`)
  123029. * * The parameter `sourcePlane` is a Plane instance. It builds a mesh plane from a Math plane
  123030. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  123031. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  123032. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  123033. * @param name defines the name of the mesh
  123034. * @param options defines the options used to create the mesh
  123035. * @param scene defines the hosting scene
  123036. * @returns the plane mesh
  123037. * @see https://doc.babylonjs.com/how_to/set_shapes#plane
  123038. */
  123039. static CreatePlane(name: string, options: {
  123040. size?: number;
  123041. width?: number;
  123042. height?: number;
  123043. sideOrientation?: number;
  123044. frontUVs?: Vector4;
  123045. backUVs?: Vector4;
  123046. updatable?: boolean;
  123047. sourcePlane?: Plane;
  123048. }, scene?: Nullable<Scene>): Mesh;
  123049. }
  123050. }
  123051. declare module BABYLON {
  123052. /**
  123053. * A behavior that when attached to a mesh will allow the mesh to be dragged around the screen based on pointer events
  123054. */
  123055. export class PointerDragBehavior implements Behavior<AbstractMesh> {
  123056. private static _AnyMouseID;
  123057. /**
  123058. * Abstract mesh the behavior is set on
  123059. */
  123060. attachedNode: AbstractMesh;
  123061. private _dragPlane;
  123062. private _scene;
  123063. private _pointerObserver;
  123064. private _beforeRenderObserver;
  123065. private static _planeScene;
  123066. private _useAlternatePickedPointAboveMaxDragAngleDragSpeed;
  123067. /**
  123068. * 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)
  123069. */
  123070. maxDragAngle: number;
  123071. /**
  123072. * @hidden
  123073. */
  123074. _useAlternatePickedPointAboveMaxDragAngle: boolean;
  123075. /**
  123076. * The id of the pointer that is currently interacting with the behavior (-1 when no pointer is active)
  123077. */
  123078. currentDraggingPointerID: number;
  123079. /**
  123080. * The last position where the pointer hit the drag plane in world space
  123081. */
  123082. lastDragPosition: Vector3;
  123083. /**
  123084. * If the behavior is currently in a dragging state
  123085. */
  123086. dragging: boolean;
  123087. /**
  123088. * 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)
  123089. */
  123090. dragDeltaRatio: number;
  123091. /**
  123092. * If the drag plane orientation should be updated during the dragging (Default: true)
  123093. */
  123094. updateDragPlane: boolean;
  123095. private _debugMode;
  123096. private _moving;
  123097. /**
  123098. * Fires each time the attached mesh is dragged with the pointer
  123099. * * delta between last drag position and current drag position in world space
  123100. * * dragDistance along the drag axis
  123101. * * dragPlaneNormal normal of the current drag plane used during the drag
  123102. * * dragPlanePoint in world space where the drag intersects the drag plane
  123103. */
  123104. onDragObservable: Observable<{
  123105. delta: Vector3;
  123106. dragPlanePoint: Vector3;
  123107. dragPlaneNormal: Vector3;
  123108. dragDistance: number;
  123109. pointerId: number;
  123110. }>;
  123111. /**
  123112. * Fires each time a drag begins (eg. mouse down on mesh)
  123113. */
  123114. onDragStartObservable: Observable<{
  123115. dragPlanePoint: Vector3;
  123116. pointerId: number;
  123117. }>;
  123118. /**
  123119. * Fires each time a drag ends (eg. mouse release after drag)
  123120. */
  123121. onDragEndObservable: Observable<{
  123122. dragPlanePoint: Vector3;
  123123. pointerId: number;
  123124. }>;
  123125. /**
  123126. * If the attached mesh should be moved when dragged
  123127. */
  123128. moveAttached: boolean;
  123129. /**
  123130. * If the drag behavior will react to drag events (Default: true)
  123131. */
  123132. enabled: boolean;
  123133. /**
  123134. * If pointer events should start and release the drag (Default: true)
  123135. */
  123136. startAndReleaseDragOnPointerEvents: boolean;
  123137. /**
  123138. * If camera controls should be detached during the drag
  123139. */
  123140. detachCameraControls: boolean;
  123141. /**
  123142. * If set, the drag plane/axis will be rotated based on the attached mesh's world rotation (Default: true)
  123143. */
  123144. useObjectOrientationForDragging: boolean;
  123145. private _options;
  123146. /**
  123147. * Gets the options used by the behavior
  123148. */
  123149. get options(): {
  123150. dragAxis?: Vector3;
  123151. dragPlaneNormal?: Vector3;
  123152. };
  123153. /**
  123154. * Sets the options used by the behavior
  123155. */
  123156. set options(options: {
  123157. dragAxis?: Vector3;
  123158. dragPlaneNormal?: Vector3;
  123159. });
  123160. /**
  123161. * Creates a pointer drag behavior that can be attached to a mesh
  123162. * @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)
  123163. */
  123164. constructor(options?: {
  123165. dragAxis?: Vector3;
  123166. dragPlaneNormal?: Vector3;
  123167. });
  123168. /**
  123169. * Predicate to determine if it is valid to move the object to a new position when it is moved
  123170. */
  123171. validateDrag: (targetPosition: Vector3) => boolean;
  123172. /**
  123173. * The name of the behavior
  123174. */
  123175. get name(): string;
  123176. /**
  123177. * Initializes the behavior
  123178. */
  123179. init(): void;
  123180. private _tmpVector;
  123181. private _alternatePickedPoint;
  123182. private _worldDragAxis;
  123183. private _targetPosition;
  123184. private _attachedElement;
  123185. /**
  123186. * Attaches the drag behavior the passed in mesh
  123187. * @param ownerNode The mesh that will be dragged around once attached
  123188. * @param predicate Predicate to use for pick filtering
  123189. */
  123190. attach(ownerNode: AbstractMesh, predicate?: (m: AbstractMesh) => boolean): void;
  123191. /**
  123192. * Force relase the drag action by code.
  123193. */
  123194. releaseDrag(): void;
  123195. private _startDragRay;
  123196. private _lastPointerRay;
  123197. /**
  123198. * Simulates the start of a pointer drag event on the behavior
  123199. * @param pointerId pointerID of the pointer that should be simulated (Default: Any mouse pointer ID)
  123200. * @param fromRay initial ray of the pointer to be simulated (Default: Ray from camera to attached mesh)
  123201. * @param startPickedPoint picked point of the pointer to be simulated (Default: attached mesh position)
  123202. */
  123203. startDrag(pointerId?: number, fromRay?: Ray, startPickedPoint?: Vector3): void;
  123204. private _startDrag;
  123205. private _dragDelta;
  123206. private _moveDrag;
  123207. private _pickWithRayOnDragPlane;
  123208. private _pointA;
  123209. private _pointC;
  123210. private _localAxis;
  123211. private _lookAt;
  123212. private _updateDragPlanePosition;
  123213. /**
  123214. * Detaches the behavior from the mesh
  123215. */
  123216. detach(): void;
  123217. }
  123218. }
  123219. declare module BABYLON {
  123220. /**
  123221. * A behavior that when attached to a mesh will allow the mesh to be scaled
  123222. */
  123223. export class MultiPointerScaleBehavior implements Behavior<Mesh> {
  123224. private _dragBehaviorA;
  123225. private _dragBehaviorB;
  123226. private _startDistance;
  123227. private _initialScale;
  123228. private _targetScale;
  123229. private _ownerNode;
  123230. private _sceneRenderObserver;
  123231. /**
  123232. * Instantiate a new behavior that when attached to a mesh will allow the mesh to be scaled
  123233. */
  123234. constructor();
  123235. /**
  123236. * The name of the behavior
  123237. */
  123238. get name(): string;
  123239. /**
  123240. * Initializes the behavior
  123241. */
  123242. init(): void;
  123243. private _getCurrentDistance;
  123244. /**
  123245. * Attaches the scale behavior the passed in mesh
  123246. * @param ownerNode The mesh that will be scaled around once attached
  123247. */
  123248. attach(ownerNode: Mesh): void;
  123249. /**
  123250. * Detaches the behavior from the mesh
  123251. */
  123252. detach(): void;
  123253. }
  123254. }
  123255. declare module BABYLON {
  123256. /**
  123257. * 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
  123258. */
  123259. export class SixDofDragBehavior implements Behavior<Mesh> {
  123260. private static _virtualScene;
  123261. private _ownerNode;
  123262. private _sceneRenderObserver;
  123263. private _scene;
  123264. private _targetPosition;
  123265. private _virtualOriginMesh;
  123266. private _virtualDragMesh;
  123267. private _pointerObserver;
  123268. private _moving;
  123269. private _startingOrientation;
  123270. private _attachedElement;
  123271. /**
  123272. * 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)
  123273. */
  123274. private zDragFactor;
  123275. /**
  123276. * If the object should rotate to face the drag origin
  123277. */
  123278. rotateDraggedObject: boolean;
  123279. /**
  123280. * If the behavior is currently in a dragging state
  123281. */
  123282. dragging: boolean;
  123283. /**
  123284. * 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)
  123285. */
  123286. dragDeltaRatio: number;
  123287. /**
  123288. * The id of the pointer that is currently interacting with the behavior (-1 when no pointer is active)
  123289. */
  123290. currentDraggingPointerID: number;
  123291. /**
  123292. * If camera controls should be detached during the drag
  123293. */
  123294. detachCameraControls: boolean;
  123295. /**
  123296. * Fires each time a drag starts
  123297. */
  123298. onDragStartObservable: Observable<{}>;
  123299. /**
  123300. * Fires each time a drag ends (eg. mouse release after drag)
  123301. */
  123302. onDragEndObservable: Observable<{}>;
  123303. /**
  123304. * 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
  123305. */
  123306. constructor();
  123307. /**
  123308. * The name of the behavior
  123309. */
  123310. get name(): string;
  123311. /**
  123312. * Initializes the behavior
  123313. */
  123314. init(): void;
  123315. /**
  123316. * In the case of multiplea active cameras, the cameraToUseForPointers should be used if set instead of active camera
  123317. */
  123318. private get _pointerCamera();
  123319. /**
  123320. * Attaches the scale behavior the passed in mesh
  123321. * @param ownerNode The mesh that will be scaled around once attached
  123322. */
  123323. attach(ownerNode: Mesh): void;
  123324. /**
  123325. * Detaches the behavior from the mesh
  123326. */
  123327. detach(): void;
  123328. }
  123329. }
  123330. declare module BABYLON {
  123331. /**
  123332. * Class used to apply inverse kinematics to bones
  123333. * @see https://doc.babylonjs.com/how_to/how_to_use_bones_and_skeletons#boneikcontroller
  123334. */
  123335. export class BoneIKController {
  123336. private static _tmpVecs;
  123337. private static _tmpQuat;
  123338. private static _tmpMats;
  123339. /**
  123340. * Gets or sets the target mesh
  123341. */
  123342. targetMesh: AbstractMesh;
  123343. /** Gets or sets the mesh used as pole */
  123344. poleTargetMesh: AbstractMesh;
  123345. /**
  123346. * Gets or sets the bone used as pole
  123347. */
  123348. poleTargetBone: Nullable<Bone>;
  123349. /**
  123350. * Gets or sets the target position
  123351. */
  123352. targetPosition: Vector3;
  123353. /**
  123354. * Gets or sets the pole target position
  123355. */
  123356. poleTargetPosition: Vector3;
  123357. /**
  123358. * Gets or sets the pole target local offset
  123359. */
  123360. poleTargetLocalOffset: Vector3;
  123361. /**
  123362. * Gets or sets the pole angle
  123363. */
  123364. poleAngle: number;
  123365. /**
  123366. * Gets or sets the mesh associated with the controller
  123367. */
  123368. mesh: AbstractMesh;
  123369. /**
  123370. * 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)
  123371. */
  123372. slerpAmount: number;
  123373. private _bone1Quat;
  123374. private _bone1Mat;
  123375. private _bone2Ang;
  123376. private _bone1;
  123377. private _bone2;
  123378. private _bone1Length;
  123379. private _bone2Length;
  123380. private _maxAngle;
  123381. private _maxReach;
  123382. private _rightHandedSystem;
  123383. private _bendAxis;
  123384. private _slerping;
  123385. private _adjustRoll;
  123386. /**
  123387. * Gets or sets maximum allowed angle
  123388. */
  123389. get maxAngle(): number;
  123390. set maxAngle(value: number);
  123391. /**
  123392. * Creates a new BoneIKController
  123393. * @param mesh defines the mesh to control
  123394. * @param bone defines the bone to control
  123395. * @param options defines options to set up the controller
  123396. */
  123397. constructor(mesh: AbstractMesh, bone: Bone, options?: {
  123398. targetMesh?: AbstractMesh;
  123399. poleTargetMesh?: AbstractMesh;
  123400. poleTargetBone?: Bone;
  123401. poleTargetLocalOffset?: Vector3;
  123402. poleAngle?: number;
  123403. bendAxis?: Vector3;
  123404. maxAngle?: number;
  123405. slerpAmount?: number;
  123406. });
  123407. private _setMaxAngle;
  123408. /**
  123409. * Force the controller to update the bones
  123410. */
  123411. update(): void;
  123412. }
  123413. }
  123414. declare module BABYLON {
  123415. /**
  123416. * Class used to make a bone look toward a point in space
  123417. * @see https://doc.babylonjs.com/how_to/how_to_use_bones_and_skeletons#bonelookcontroller
  123418. */
  123419. export class BoneLookController {
  123420. private static _tmpVecs;
  123421. private static _tmpQuat;
  123422. private static _tmpMats;
  123423. /**
  123424. * The target Vector3 that the bone will look at
  123425. */
  123426. target: Vector3;
  123427. /**
  123428. * The mesh that the bone is attached to
  123429. */
  123430. mesh: AbstractMesh;
  123431. /**
  123432. * The bone that will be looking to the target
  123433. */
  123434. bone: Bone;
  123435. /**
  123436. * The up axis of the coordinate system that is used when the bone is rotated
  123437. */
  123438. upAxis: Vector3;
  123439. /**
  123440. * The space that the up axis is in - Space.BONE, Space.LOCAL (default), or Space.WORLD
  123441. */
  123442. upAxisSpace: Space;
  123443. /**
  123444. * Used to make an adjustment to the yaw of the bone
  123445. */
  123446. adjustYaw: number;
  123447. /**
  123448. * Used to make an adjustment to the pitch of the bone
  123449. */
  123450. adjustPitch: number;
  123451. /**
  123452. * Used to make an adjustment to the roll of the bone
  123453. */
  123454. adjustRoll: number;
  123455. /**
  123456. * 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)
  123457. */
  123458. slerpAmount: number;
  123459. private _minYaw;
  123460. private _maxYaw;
  123461. private _minPitch;
  123462. private _maxPitch;
  123463. private _minYawSin;
  123464. private _minYawCos;
  123465. private _maxYawSin;
  123466. private _maxYawCos;
  123467. private _midYawConstraint;
  123468. private _minPitchTan;
  123469. private _maxPitchTan;
  123470. private _boneQuat;
  123471. private _slerping;
  123472. private _transformYawPitch;
  123473. private _transformYawPitchInv;
  123474. private _firstFrameSkipped;
  123475. private _yawRange;
  123476. private _fowardAxis;
  123477. /**
  123478. * Gets or sets the minimum yaw angle that the bone can look to
  123479. */
  123480. get minYaw(): number;
  123481. set minYaw(value: number);
  123482. /**
  123483. * Gets or sets the maximum yaw angle that the bone can look to
  123484. */
  123485. get maxYaw(): number;
  123486. set maxYaw(value: number);
  123487. /**
  123488. * Gets or sets the minimum pitch angle that the bone can look to
  123489. */
  123490. get minPitch(): number;
  123491. set minPitch(value: number);
  123492. /**
  123493. * Gets or sets the maximum pitch angle that the bone can look to
  123494. */
  123495. get maxPitch(): number;
  123496. set maxPitch(value: number);
  123497. /**
  123498. * Create a BoneLookController
  123499. * @param mesh the mesh that the bone belongs to
  123500. * @param bone the bone that will be looking to the target
  123501. * @param target the target Vector3 to look at
  123502. * @param options optional settings:
  123503. * * maxYaw: the maximum angle the bone will yaw to
  123504. * * minYaw: the minimum angle the bone will yaw to
  123505. * * maxPitch: the maximum angle the bone will pitch to
  123506. * * minPitch: the minimum angle the bone will yaw to
  123507. * * slerpAmount: set the between 0 and 1 to make the bone slerp to the target.
  123508. * * upAxis: the up axis of the coordinate system
  123509. * * upAxisSpace: the space that the up axis is in - Space.BONE, Space.LOCAL (default), or Space.WORLD.
  123510. * * yawAxis: set yawAxis if the bone does not yaw on the y axis
  123511. * * pitchAxis: set pitchAxis if the bone does not pitch on the x axis
  123512. * * adjustYaw: used to make an adjustment to the yaw of the bone
  123513. * * adjustPitch: used to make an adjustment to the pitch of the bone
  123514. * * adjustRoll: used to make an adjustment to the roll of the bone
  123515. **/
  123516. constructor(mesh: AbstractMesh, bone: Bone, target: Vector3, options?: {
  123517. maxYaw?: number;
  123518. minYaw?: number;
  123519. maxPitch?: number;
  123520. minPitch?: number;
  123521. slerpAmount?: number;
  123522. upAxis?: Vector3;
  123523. upAxisSpace?: Space;
  123524. yawAxis?: Vector3;
  123525. pitchAxis?: Vector3;
  123526. adjustYaw?: number;
  123527. adjustPitch?: number;
  123528. adjustRoll?: number;
  123529. });
  123530. /**
  123531. * Update the bone to look at the target. This should be called before the scene is rendered (use scene.registerBeforeRender())
  123532. */
  123533. update(): void;
  123534. private _getAngleDiff;
  123535. private _getAngleBetween;
  123536. private _isAngleBetween;
  123537. }
  123538. }
  123539. declare module BABYLON {
  123540. /**
  123541. * Manage the gamepad inputs to control an arc rotate camera.
  123542. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  123543. */
  123544. export class ArcRotateCameraGamepadInput implements ICameraInput<ArcRotateCamera> {
  123545. /**
  123546. * Defines the camera the input is attached to.
  123547. */
  123548. camera: ArcRotateCamera;
  123549. /**
  123550. * Defines the gamepad the input is gathering event from.
  123551. */
  123552. gamepad: Nullable<Gamepad>;
  123553. /**
  123554. * Defines the gamepad rotation sensiblity.
  123555. * This is the threshold from when rotation starts to be accounted for to prevent jittering.
  123556. */
  123557. gamepadRotationSensibility: number;
  123558. /**
  123559. * Defines the gamepad move sensiblity.
  123560. * This is the threshold from when moving starts to be accounted for for to prevent jittering.
  123561. */
  123562. gamepadMoveSensibility: number;
  123563. private _yAxisScale;
  123564. /**
  123565. * Gets or sets a boolean indicating that Yaxis (for right stick) should be inverted
  123566. */
  123567. get invertYAxis(): boolean;
  123568. set invertYAxis(value: boolean);
  123569. private _onGamepadConnectedObserver;
  123570. private _onGamepadDisconnectedObserver;
  123571. /**
  123572. * Attach the input controls to a specific dom element to get the input from.
  123573. * @param element Defines the element the controls should be listened from
  123574. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  123575. */
  123576. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  123577. /**
  123578. * Detach the current controls from the specified dom element.
  123579. * @param element Defines the element to stop listening the inputs from
  123580. */
  123581. detachControl(element: Nullable<HTMLElement>): void;
  123582. /**
  123583. * Update the current camera state depending on the inputs that have been used this frame.
  123584. * This is a dynamically created lambda to avoid the performance penalty of looping for inputs in the render loop.
  123585. */
  123586. checkInputs(): void;
  123587. /**
  123588. * Gets the class name of the current intput.
  123589. * @returns the class name
  123590. */
  123591. getClassName(): string;
  123592. /**
  123593. * Get the friendly name associated with the input class.
  123594. * @returns the input friendly name
  123595. */
  123596. getSimpleName(): string;
  123597. }
  123598. }
  123599. declare module BABYLON {
  123600. interface ArcRotateCameraInputsManager {
  123601. /**
  123602. * Add orientation input support to the input manager.
  123603. * @returns the current input manager
  123604. */
  123605. addVRDeviceOrientation(): ArcRotateCameraInputsManager;
  123606. }
  123607. /**
  123608. * Manage the device orientation inputs (gyroscope) to control an arc rotate camera.
  123609. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  123610. */
  123611. export class ArcRotateCameraVRDeviceOrientationInput implements ICameraInput<ArcRotateCamera> {
  123612. /**
  123613. * Defines the camera the input is attached to.
  123614. */
  123615. camera: ArcRotateCamera;
  123616. /**
  123617. * Defines a correction factor applied on the alpha value retrieved from the orientation events.
  123618. */
  123619. alphaCorrection: number;
  123620. /**
  123621. * Defines a correction factor applied on the gamma value retrieved from the orientation events.
  123622. */
  123623. gammaCorrection: number;
  123624. private _alpha;
  123625. private _gamma;
  123626. private _dirty;
  123627. private _deviceOrientationHandler;
  123628. /**
  123629. * Instantiate a new ArcRotateCameraVRDeviceOrientationInput.
  123630. */
  123631. constructor();
  123632. /**
  123633. * Attach the input controls to a specific dom element to get the input from.
  123634. * @param element Defines the element the controls should be listened from
  123635. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  123636. */
  123637. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  123638. /** @hidden */
  123639. _onOrientationEvent(evt: DeviceOrientationEvent): void;
  123640. /**
  123641. * Update the current camera state depending on the inputs that have been used this frame.
  123642. * This is a dynamically created lambda to avoid the performance penalty of looping for inputs in the render loop.
  123643. */
  123644. checkInputs(): void;
  123645. /**
  123646. * Detach the current controls from the specified dom element.
  123647. * @param element Defines the element to stop listening the inputs from
  123648. */
  123649. detachControl(element: Nullable<HTMLElement>): void;
  123650. /**
  123651. * Gets the class name of the current intput.
  123652. * @returns the class name
  123653. */
  123654. getClassName(): string;
  123655. /**
  123656. * Get the friendly name associated with the input class.
  123657. * @returns the input friendly name
  123658. */
  123659. getSimpleName(): string;
  123660. }
  123661. }
  123662. declare module BABYLON {
  123663. /**
  123664. * Listen to mouse events to control the camera.
  123665. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  123666. */
  123667. export class FlyCameraMouseInput implements ICameraInput<FlyCamera> {
  123668. /**
  123669. * Defines the camera the input is attached to.
  123670. */
  123671. camera: FlyCamera;
  123672. /**
  123673. * Defines if touch is enabled. (Default is true.)
  123674. */
  123675. touchEnabled: boolean;
  123676. /**
  123677. * Defines the buttons associated with the input to handle camera rotation.
  123678. */
  123679. buttons: number[];
  123680. /**
  123681. * Assign buttons for Yaw control.
  123682. */
  123683. buttonsYaw: number[];
  123684. /**
  123685. * Assign buttons for Pitch control.
  123686. */
  123687. buttonsPitch: number[];
  123688. /**
  123689. * Assign buttons for Roll control.
  123690. */
  123691. buttonsRoll: number[];
  123692. /**
  123693. * Detect if any button is being pressed while mouse is moved.
  123694. * -1 = Mouse locked.
  123695. * 0 = Left button.
  123696. * 1 = Middle Button.
  123697. * 2 = Right Button.
  123698. */
  123699. activeButton: number;
  123700. /**
  123701. * Defines the pointer's angular sensibility, to control the camera rotation speed.
  123702. * Higher values reduce its sensitivity.
  123703. */
  123704. angularSensibility: number;
  123705. private _mousemoveCallback;
  123706. private _observer;
  123707. private _rollObserver;
  123708. private previousPosition;
  123709. private noPreventDefault;
  123710. private element;
  123711. /**
  123712. * Listen to mouse events to control the camera.
  123713. * @param touchEnabled Define if touch is enabled. (Default is true.)
  123714. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  123715. */
  123716. constructor(touchEnabled?: boolean);
  123717. /**
  123718. * Attach the mouse control to the HTML DOM element.
  123719. * @param element Defines the element that listens to the input events.
  123720. * @param noPreventDefault Defines whether events caught by the controls should call preventdefault().
  123721. */
  123722. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  123723. /**
  123724. * Detach the current controls from the specified dom element.
  123725. * @param element Defines the element to stop listening the inputs from
  123726. */
  123727. detachControl(element: Nullable<HTMLElement>): void;
  123728. /**
  123729. * Gets the class name of the current input.
  123730. * @returns the class name.
  123731. */
  123732. getClassName(): string;
  123733. /**
  123734. * Get the friendly name associated with the input class.
  123735. * @returns the input's friendly name.
  123736. */
  123737. getSimpleName(): string;
  123738. private _pointerInput;
  123739. private _onMouseMove;
  123740. /**
  123741. * Rotate camera by mouse offset.
  123742. */
  123743. private rotateCamera;
  123744. }
  123745. }
  123746. declare module BABYLON {
  123747. /**
  123748. * Default Inputs manager for the FlyCamera.
  123749. * It groups all the default supported inputs for ease of use.
  123750. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  123751. */
  123752. export class FlyCameraInputsManager extends CameraInputsManager<FlyCamera> {
  123753. /**
  123754. * Instantiates a new FlyCameraInputsManager.
  123755. * @param camera Defines the camera the inputs belong to.
  123756. */
  123757. constructor(camera: FlyCamera);
  123758. /**
  123759. * Add keyboard input support to the input manager.
  123760. * @returns the new FlyCameraKeyboardMoveInput().
  123761. */
  123762. addKeyboard(): FlyCameraInputsManager;
  123763. /**
  123764. * Add mouse input support to the input manager.
  123765. * @param touchEnabled Enable touch screen support.
  123766. * @returns the new FlyCameraMouseInput().
  123767. */
  123768. addMouse(touchEnabled?: boolean): FlyCameraInputsManager;
  123769. }
  123770. }
  123771. declare module BABYLON {
  123772. /**
  123773. * This is a flying camera, designed for 3D movement and rotation in all directions,
  123774. * such as in a 3D Space Shooter or a Flight Simulator.
  123775. */
  123776. export class FlyCamera extends TargetCamera {
  123777. /**
  123778. * Define the collision ellipsoid of the camera.
  123779. * This is helpful for simulating a camera body, like a player's body.
  123780. * @see https://doc.babylonjs.com/babylon101/cameras,_mesh_collisions_and_gravity#arcrotatecamera
  123781. */
  123782. ellipsoid: Vector3;
  123783. /**
  123784. * Define an offset for the position of the ellipsoid around the camera.
  123785. * This can be helpful if the camera is attached away from the player's body center,
  123786. * such as at its head.
  123787. */
  123788. ellipsoidOffset: Vector3;
  123789. /**
  123790. * Enable or disable collisions of the camera with the rest of the scene objects.
  123791. */
  123792. checkCollisions: boolean;
  123793. /**
  123794. * Enable or disable gravity on the camera.
  123795. */
  123796. applyGravity: boolean;
  123797. /**
  123798. * Define the current direction the camera is moving to.
  123799. */
  123800. cameraDirection: Vector3;
  123801. /**
  123802. * Define the current local rotation of the camera as a quaternion to prevent Gimbal lock.
  123803. * This overrides and empties cameraRotation.
  123804. */
  123805. rotationQuaternion: Quaternion;
  123806. /**
  123807. * Track Roll to maintain the wanted Rolling when looking around.
  123808. */
  123809. _trackRoll: number;
  123810. /**
  123811. * Slowly correct the Roll to its original value after a Pitch+Yaw rotation.
  123812. */
  123813. rollCorrect: number;
  123814. /**
  123815. * Mimic a banked turn, Rolling the camera when Yawing.
  123816. * It's recommended to use rollCorrect = 10 for faster banking correction.
  123817. */
  123818. bankedTurn: boolean;
  123819. /**
  123820. * Limit in radians for how much Roll banking will add. (Default: 90°)
  123821. */
  123822. bankedTurnLimit: number;
  123823. /**
  123824. * Value of 0 disables the banked Roll.
  123825. * Value of 1 is equal to the Yaw angle in radians.
  123826. */
  123827. bankedTurnMultiplier: number;
  123828. /**
  123829. * The inputs manager loads all the input sources, such as keyboard and mouse.
  123830. */
  123831. inputs: FlyCameraInputsManager;
  123832. /**
  123833. * Gets the input sensibility for mouse input.
  123834. * Higher values reduce sensitivity.
  123835. */
  123836. get angularSensibility(): number;
  123837. /**
  123838. * Sets the input sensibility for a mouse input.
  123839. * Higher values reduce sensitivity.
  123840. */
  123841. set angularSensibility(value: number);
  123842. /**
  123843. * Get the keys for camera movement forward.
  123844. */
  123845. get keysForward(): number[];
  123846. /**
  123847. * Set the keys for camera movement forward.
  123848. */
  123849. set keysForward(value: number[]);
  123850. /**
  123851. * Get the keys for camera movement backward.
  123852. */
  123853. get keysBackward(): number[];
  123854. set keysBackward(value: number[]);
  123855. /**
  123856. * Get the keys for camera movement up.
  123857. */
  123858. get keysUp(): number[];
  123859. /**
  123860. * Set the keys for camera movement up.
  123861. */
  123862. set keysUp(value: number[]);
  123863. /**
  123864. * Get the keys for camera movement down.
  123865. */
  123866. get keysDown(): number[];
  123867. /**
  123868. * Set the keys for camera movement down.
  123869. */
  123870. set keysDown(value: number[]);
  123871. /**
  123872. * Get the keys for camera movement left.
  123873. */
  123874. get keysLeft(): number[];
  123875. /**
  123876. * Set the keys for camera movement left.
  123877. */
  123878. set keysLeft(value: number[]);
  123879. /**
  123880. * Set the keys for camera movement right.
  123881. */
  123882. get keysRight(): number[];
  123883. /**
  123884. * Set the keys for camera movement right.
  123885. */
  123886. set keysRight(value: number[]);
  123887. /**
  123888. * Event raised when the camera collides with a mesh in the scene.
  123889. */
  123890. onCollide: (collidedMesh: AbstractMesh) => void;
  123891. private _collider;
  123892. private _needMoveForGravity;
  123893. private _oldPosition;
  123894. private _diffPosition;
  123895. private _newPosition;
  123896. /** @hidden */
  123897. _localDirection: Vector3;
  123898. /** @hidden */
  123899. _transformedDirection: Vector3;
  123900. /**
  123901. * Instantiates a FlyCamera.
  123902. * This is a flying camera, designed for 3D movement and rotation in all directions,
  123903. * such as in a 3D Space Shooter or a Flight Simulator.
  123904. * @param name Define the name of the camera in the scene.
  123905. * @param position Define the starting position of the camera in the scene.
  123906. * @param scene Define the scene the camera belongs to.
  123907. * @param setActiveOnSceneIfNoneActive Defines wheter the camera should be marked as active, if no other camera has been defined as active.
  123908. */
  123909. constructor(name: string, position: Vector3, scene: Scene, setActiveOnSceneIfNoneActive?: boolean);
  123910. /**
  123911. * Attach a control to the HTML DOM element.
  123912. * @param element Defines the element that listens to the input events.
  123913. * @param noPreventDefault Defines whether events caught by the controls should call preventdefault(). https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault
  123914. */
  123915. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  123916. /**
  123917. * Detach a control from the HTML DOM element.
  123918. * The camera will stop reacting to that input.
  123919. * @param element Defines the element that listens to the input events.
  123920. */
  123921. detachControl(element: HTMLElement): void;
  123922. private _collisionMask;
  123923. /**
  123924. * Get the mask that the camera ignores in collision events.
  123925. */
  123926. get collisionMask(): number;
  123927. /**
  123928. * Set the mask that the camera ignores in collision events.
  123929. */
  123930. set collisionMask(mask: number);
  123931. /** @hidden */
  123932. _collideWithWorld(displacement: Vector3): void;
  123933. /** @hidden */
  123934. private _onCollisionPositionChange;
  123935. /** @hidden */
  123936. _checkInputs(): void;
  123937. /** @hidden */
  123938. _decideIfNeedsToMove(): boolean;
  123939. /** @hidden */
  123940. _updatePosition(): void;
  123941. /**
  123942. * Restore the Roll to its target value at the rate specified.
  123943. * @param rate - Higher means slower restoring.
  123944. * @hidden
  123945. */
  123946. restoreRoll(rate: number): void;
  123947. /**
  123948. * Destroy the camera and release the current resources held by it.
  123949. */
  123950. dispose(): void;
  123951. /**
  123952. * Get the current object class name.
  123953. * @returns the class name.
  123954. */
  123955. getClassName(): string;
  123956. }
  123957. }
  123958. declare module BABYLON {
  123959. /**
  123960. * Listen to keyboard events to control the camera.
  123961. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  123962. */
  123963. export class FlyCameraKeyboardInput implements ICameraInput<FlyCamera> {
  123964. /**
  123965. * Defines the camera the input is attached to.
  123966. */
  123967. camera: FlyCamera;
  123968. /**
  123969. * The list of keyboard keys used to control the forward move of the camera.
  123970. */
  123971. keysForward: number[];
  123972. /**
  123973. * The list of keyboard keys used to control the backward move of the camera.
  123974. */
  123975. keysBackward: number[];
  123976. /**
  123977. * The list of keyboard keys used to control the forward move of the camera.
  123978. */
  123979. keysUp: number[];
  123980. /**
  123981. * The list of keyboard keys used to control the backward move of the camera.
  123982. */
  123983. keysDown: number[];
  123984. /**
  123985. * The list of keyboard keys used to control the right strafe move of the camera.
  123986. */
  123987. keysRight: number[];
  123988. /**
  123989. * The list of keyboard keys used to control the left strafe move of the camera.
  123990. */
  123991. keysLeft: number[];
  123992. private _keys;
  123993. private _onCanvasBlurObserver;
  123994. private _onKeyboardObserver;
  123995. private _engine;
  123996. private _scene;
  123997. /**
  123998. * Attach the input controls to a specific dom element to get the input from.
  123999. * @param element Defines the element the controls should be listened from
  124000. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  124001. */
  124002. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  124003. /**
  124004. * Detach the current controls from the specified dom element.
  124005. * @param element Defines the element to stop listening the inputs from
  124006. */
  124007. detachControl(element: Nullable<HTMLElement>): void;
  124008. /**
  124009. * Gets the class name of the current intput.
  124010. * @returns the class name
  124011. */
  124012. getClassName(): string;
  124013. /** @hidden */
  124014. _onLostFocus(e: FocusEvent): void;
  124015. /**
  124016. * Get the friendly name associated with the input class.
  124017. * @returns the input friendly name
  124018. */
  124019. getSimpleName(): string;
  124020. /**
  124021. * Update the current camera state depending on the inputs that have been used this frame.
  124022. * This is a dynamically created lambda to avoid the performance penalty of looping for inputs in the render loop.
  124023. */
  124024. checkInputs(): void;
  124025. }
  124026. }
  124027. declare module BABYLON {
  124028. /**
  124029. * Manage the mouse wheel inputs to control a follow camera.
  124030. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  124031. */
  124032. export class FollowCameraMouseWheelInput implements ICameraInput<FollowCamera> {
  124033. /**
  124034. * Defines the camera the input is attached to.
  124035. */
  124036. camera: FollowCamera;
  124037. /**
  124038. * Moue wheel controls zoom. (Mouse wheel modifies camera.radius value.)
  124039. */
  124040. axisControlRadius: boolean;
  124041. /**
  124042. * Moue wheel controls height. (Mouse wheel modifies camera.heightOffset value.)
  124043. */
  124044. axisControlHeight: boolean;
  124045. /**
  124046. * Moue wheel controls angle. (Mouse wheel modifies camera.rotationOffset value.)
  124047. */
  124048. axisControlRotation: boolean;
  124049. /**
  124050. * Gets or Set the mouse wheel precision or how fast is the camera moves in
  124051. * relation to mouseWheel events.
  124052. */
  124053. wheelPrecision: number;
  124054. /**
  124055. * wheelDeltaPercentage will be used instead of wheelPrecision if different from 0.
  124056. * It defines the percentage of current camera.radius to use as delta when wheel is used.
  124057. */
  124058. wheelDeltaPercentage: number;
  124059. private _wheel;
  124060. private _observer;
  124061. /**
  124062. * Attach the input controls to a specific dom element to get the input from.
  124063. * @param element Defines the element the controls should be listened from
  124064. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  124065. */
  124066. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  124067. /**
  124068. * Detach the current controls from the specified dom element.
  124069. * @param element Defines the element to stop listening the inputs from
  124070. */
  124071. detachControl(element: Nullable<HTMLElement>): void;
  124072. /**
  124073. * Gets the class name of the current intput.
  124074. * @returns the class name
  124075. */
  124076. getClassName(): string;
  124077. /**
  124078. * Get the friendly name associated with the input class.
  124079. * @returns the input friendly name
  124080. */
  124081. getSimpleName(): string;
  124082. }
  124083. }
  124084. declare module BABYLON {
  124085. /**
  124086. * Manage the pointers inputs to control an follow camera.
  124087. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  124088. */
  124089. export class FollowCameraPointersInput extends BaseCameraPointersInput {
  124090. /**
  124091. * Defines the camera the input is attached to.
  124092. */
  124093. camera: FollowCamera;
  124094. /**
  124095. * Gets the class name of the current input.
  124096. * @returns the class name
  124097. */
  124098. getClassName(): string;
  124099. /**
  124100. * Defines the pointer angular sensibility along the X axis or how fast is
  124101. * the camera rotating.
  124102. * A negative number will reverse the axis direction.
  124103. */
  124104. angularSensibilityX: number;
  124105. /**
  124106. * Defines the pointer angular sensibility along the Y axis or how fast is
  124107. * the camera rotating.
  124108. * A negative number will reverse the axis direction.
  124109. */
  124110. angularSensibilityY: number;
  124111. /**
  124112. * Defines the pointer pinch precision or how fast is the camera zooming.
  124113. * A negative number will reverse the axis direction.
  124114. */
  124115. pinchPrecision: number;
  124116. /**
  124117. * pinchDeltaPercentage will be used instead of pinchPrecision if different
  124118. * from 0.
  124119. * It defines the percentage of current camera.radius to use as delta when
  124120. * pinch zoom is used.
  124121. */
  124122. pinchDeltaPercentage: number;
  124123. /**
  124124. * Pointer X axis controls zoom. (X axis modifies camera.radius value.)
  124125. */
  124126. axisXControlRadius: boolean;
  124127. /**
  124128. * Pointer X axis controls height. (X axis modifies camera.heightOffset value.)
  124129. */
  124130. axisXControlHeight: boolean;
  124131. /**
  124132. * Pointer X axis controls angle. (X axis modifies camera.rotationOffset value.)
  124133. */
  124134. axisXControlRotation: boolean;
  124135. /**
  124136. * Pointer Y axis controls zoom. (Y axis modifies camera.radius value.)
  124137. */
  124138. axisYControlRadius: boolean;
  124139. /**
  124140. * Pointer Y axis controls height. (Y axis modifies camera.heightOffset value.)
  124141. */
  124142. axisYControlHeight: boolean;
  124143. /**
  124144. * Pointer Y axis controls angle. (Y axis modifies camera.rotationOffset value.)
  124145. */
  124146. axisYControlRotation: boolean;
  124147. /**
  124148. * Pinch controls zoom. (Pinch modifies camera.radius value.)
  124149. */
  124150. axisPinchControlRadius: boolean;
  124151. /**
  124152. * Pinch controls height. (Pinch modifies camera.heightOffset value.)
  124153. */
  124154. axisPinchControlHeight: boolean;
  124155. /**
  124156. * Pinch controls angle. (Pinch modifies camera.rotationOffset value.)
  124157. */
  124158. axisPinchControlRotation: boolean;
  124159. /**
  124160. * Log error messages if basic misconfiguration has occurred.
  124161. */
  124162. warningEnable: boolean;
  124163. protected onTouch(pointA: Nullable<PointerTouch>, offsetX: number, offsetY: number): void;
  124164. protected onMultiTouch(pointA: Nullable<PointerTouch>, pointB: Nullable<PointerTouch>, previousPinchSquaredDistance: number, pinchSquaredDistance: number, previousMultiTouchPanPosition: Nullable<PointerTouch>, multiTouchPanPosition: Nullable<PointerTouch>): void;
  124165. private _warningCounter;
  124166. private _warning;
  124167. }
  124168. }
  124169. declare module BABYLON {
  124170. /**
  124171. * Default Inputs manager for the FollowCamera.
  124172. * It groups all the default supported inputs for ease of use.
  124173. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  124174. */
  124175. export class FollowCameraInputsManager extends CameraInputsManager<FollowCamera> {
  124176. /**
  124177. * Instantiates a new FollowCameraInputsManager.
  124178. * @param camera Defines the camera the inputs belong to
  124179. */
  124180. constructor(camera: FollowCamera);
  124181. /**
  124182. * Add keyboard input support to the input manager.
  124183. * @returns the current input manager
  124184. */
  124185. addKeyboard(): FollowCameraInputsManager;
  124186. /**
  124187. * Add mouse wheel input support to the input manager.
  124188. * @returns the current input manager
  124189. */
  124190. addMouseWheel(): FollowCameraInputsManager;
  124191. /**
  124192. * Add pointers input support to the input manager.
  124193. * @returns the current input manager
  124194. */
  124195. addPointers(): FollowCameraInputsManager;
  124196. /**
  124197. * Add orientation input support to the input manager.
  124198. * @returns the current input manager
  124199. */
  124200. addVRDeviceOrientation(): FollowCameraInputsManager;
  124201. }
  124202. }
  124203. declare module BABYLON {
  124204. /**
  124205. * A follow camera takes a mesh as a target and follows it as it moves. Both a free camera version followCamera and
  124206. * an arc rotate version arcFollowCamera are available.
  124207. * @see https://doc.babylonjs.com/features/cameras#follow-camera
  124208. */
  124209. export class FollowCamera extends TargetCamera {
  124210. /**
  124211. * Distance the follow camera should follow an object at
  124212. */
  124213. radius: number;
  124214. /**
  124215. * Minimum allowed distance of the camera to the axis of rotation
  124216. * (The camera can not get closer).
  124217. * This can help limiting how the Camera is able to move in the scene.
  124218. */
  124219. lowerRadiusLimit: Nullable<number>;
  124220. /**
  124221. * Maximum allowed distance of the camera to the axis of rotation
  124222. * (The camera can not get further).
  124223. * This can help limiting how the Camera is able to move in the scene.
  124224. */
  124225. upperRadiusLimit: Nullable<number>;
  124226. /**
  124227. * Define a rotation offset between the camera and the object it follows
  124228. */
  124229. rotationOffset: number;
  124230. /**
  124231. * Minimum allowed angle to camera position relative to target object.
  124232. * This can help limiting how the Camera is able to move in the scene.
  124233. */
  124234. lowerRotationOffsetLimit: Nullable<number>;
  124235. /**
  124236. * Maximum allowed angle to camera position relative to target object.
  124237. * This can help limiting how the Camera is able to move in the scene.
  124238. */
  124239. upperRotationOffsetLimit: Nullable<number>;
  124240. /**
  124241. * Define a height offset between the camera and the object it follows.
  124242. * It can help following an object from the top (like a car chaing a plane)
  124243. */
  124244. heightOffset: number;
  124245. /**
  124246. * Minimum allowed height of camera position relative to target object.
  124247. * This can help limiting how the Camera is able to move in the scene.
  124248. */
  124249. lowerHeightOffsetLimit: Nullable<number>;
  124250. /**
  124251. * Maximum allowed height of camera position relative to target object.
  124252. * This can help limiting how the Camera is able to move in the scene.
  124253. */
  124254. upperHeightOffsetLimit: Nullable<number>;
  124255. /**
  124256. * Define how fast the camera can accelerate to follow it s target.
  124257. */
  124258. cameraAcceleration: number;
  124259. /**
  124260. * Define the speed limit of the camera following an object.
  124261. */
  124262. maxCameraSpeed: number;
  124263. /**
  124264. * Define the target of the camera.
  124265. */
  124266. lockedTarget: Nullable<AbstractMesh>;
  124267. /**
  124268. * Defines the input associated with the camera.
  124269. */
  124270. inputs: FollowCameraInputsManager;
  124271. /**
  124272. * Instantiates the follow camera.
  124273. * @see https://doc.babylonjs.com/features/cameras#follow-camera
  124274. * @param name Define the name of the camera in the scene
  124275. * @param position Define the position of the camera
  124276. * @param scene Define the scene the camera belong to
  124277. * @param lockedTarget Define the target of the camera
  124278. */
  124279. constructor(name: string, position: Vector3, scene: Scene, lockedTarget?: Nullable<AbstractMesh>);
  124280. private _follow;
  124281. /**
  124282. * Attached controls to the current camera.
  124283. * @param element Defines the element the controls should be listened from
  124284. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  124285. */
  124286. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  124287. /**
  124288. * Detach the current controls from the camera.
  124289. * The camera will stop reacting to inputs.
  124290. * @param element Defines the element to stop listening the inputs from
  124291. */
  124292. detachControl(element: HTMLElement): void;
  124293. /** @hidden */
  124294. _checkInputs(): void;
  124295. private _checkLimits;
  124296. /**
  124297. * Gets the camera class name.
  124298. * @returns the class name
  124299. */
  124300. getClassName(): string;
  124301. }
  124302. /**
  124303. * Arc Rotate version of the follow camera.
  124304. * It still follows a Defined mesh but in an Arc Rotate Camera fashion.
  124305. * @see https://doc.babylonjs.com/features/cameras#follow-camera
  124306. */
  124307. export class ArcFollowCamera extends TargetCamera {
  124308. /** The longitudinal angle of the camera */
  124309. alpha: number;
  124310. /** The latitudinal angle of the camera */
  124311. beta: number;
  124312. /** The radius of the camera from its target */
  124313. radius: number;
  124314. private _cartesianCoordinates;
  124315. /** Define the camera target (the mesh it should follow) */
  124316. private _meshTarget;
  124317. /**
  124318. * Instantiates a new ArcFollowCamera
  124319. * @see https://doc.babylonjs.com/features/cameras#follow-camera
  124320. * @param name Define the name of the camera
  124321. * @param alpha Define the rotation angle of the camera around the logitudinal axis
  124322. * @param beta Define the rotation angle of the camera around the elevation axis
  124323. * @param radius Define the radius of the camera from its target point
  124324. * @param target Define the target of the camera
  124325. * @param scene Define the scene the camera belongs to
  124326. */
  124327. constructor(name: string,
  124328. /** The longitudinal angle of the camera */
  124329. alpha: number,
  124330. /** The latitudinal angle of the camera */
  124331. beta: number,
  124332. /** The radius of the camera from its target */
  124333. radius: number,
  124334. /** Define the camera target (the mesh it should follow) */
  124335. target: Nullable<AbstractMesh>, scene: Scene);
  124336. private _follow;
  124337. /** @hidden */
  124338. _checkInputs(): void;
  124339. /**
  124340. * Returns the class name of the object.
  124341. * It is mostly used internally for serialization purposes.
  124342. */
  124343. getClassName(): string;
  124344. }
  124345. }
  124346. declare module BABYLON {
  124347. /**
  124348. * Manage the keyboard inputs to control the movement of a follow camera.
  124349. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  124350. */
  124351. export class FollowCameraKeyboardMoveInput implements ICameraInput<FollowCamera> {
  124352. /**
  124353. * Defines the camera the input is attached to.
  124354. */
  124355. camera: FollowCamera;
  124356. /**
  124357. * Defines the list of key codes associated with the up action (increase heightOffset)
  124358. */
  124359. keysHeightOffsetIncr: number[];
  124360. /**
  124361. * Defines the list of key codes associated with the down action (decrease heightOffset)
  124362. */
  124363. keysHeightOffsetDecr: number[];
  124364. /**
  124365. * Defines whether the Alt modifier key is required to move up/down (alter heightOffset)
  124366. */
  124367. keysHeightOffsetModifierAlt: boolean;
  124368. /**
  124369. * Defines whether the Ctrl modifier key is required to move up/down (alter heightOffset)
  124370. */
  124371. keysHeightOffsetModifierCtrl: boolean;
  124372. /**
  124373. * Defines whether the Shift modifier key is required to move up/down (alter heightOffset)
  124374. */
  124375. keysHeightOffsetModifierShift: boolean;
  124376. /**
  124377. * Defines the list of key codes associated with the left action (increase rotationOffset)
  124378. */
  124379. keysRotationOffsetIncr: number[];
  124380. /**
  124381. * Defines the list of key codes associated with the right action (decrease rotationOffset)
  124382. */
  124383. keysRotationOffsetDecr: number[];
  124384. /**
  124385. * Defines whether the Alt modifier key is required to move left/right (alter rotationOffset)
  124386. */
  124387. keysRotationOffsetModifierAlt: boolean;
  124388. /**
  124389. * Defines whether the Ctrl modifier key is required to move left/right (alter rotationOffset)
  124390. */
  124391. keysRotationOffsetModifierCtrl: boolean;
  124392. /**
  124393. * Defines whether the Shift modifier key is required to move left/right (alter rotationOffset)
  124394. */
  124395. keysRotationOffsetModifierShift: boolean;
  124396. /**
  124397. * Defines the list of key codes associated with the zoom-in action (decrease radius)
  124398. */
  124399. keysRadiusIncr: number[];
  124400. /**
  124401. * Defines the list of key codes associated with the zoom-out action (increase radius)
  124402. */
  124403. keysRadiusDecr: number[];
  124404. /**
  124405. * Defines whether the Alt modifier key is required to zoom in/out (alter radius value)
  124406. */
  124407. keysRadiusModifierAlt: boolean;
  124408. /**
  124409. * Defines whether the Ctrl modifier key is required to zoom in/out (alter radius value)
  124410. */
  124411. keysRadiusModifierCtrl: boolean;
  124412. /**
  124413. * Defines whether the Shift modifier key is required to zoom in/out (alter radius value)
  124414. */
  124415. keysRadiusModifierShift: boolean;
  124416. /**
  124417. * Defines the rate of change of heightOffset.
  124418. */
  124419. heightSensibility: number;
  124420. /**
  124421. * Defines the rate of change of rotationOffset.
  124422. */
  124423. rotationSensibility: number;
  124424. /**
  124425. * Defines the rate of change of radius.
  124426. */
  124427. radiusSensibility: number;
  124428. private _keys;
  124429. private _ctrlPressed;
  124430. private _altPressed;
  124431. private _shiftPressed;
  124432. private _onCanvasBlurObserver;
  124433. private _onKeyboardObserver;
  124434. private _engine;
  124435. private _scene;
  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. /**
  124443. * Detach the current controls from the specified dom element.
  124444. * @param element Defines the element to stop listening the inputs from
  124445. */
  124446. detachControl(element: Nullable<HTMLElement>): void;
  124447. /**
  124448. * Update the current camera state depending on the inputs that have been used this frame.
  124449. * This is a dynamically created lambda to avoid the performance penalty of looping for inputs in the render loop.
  124450. */
  124451. checkInputs(): void;
  124452. /**
  124453. * Gets the class name of the current input.
  124454. * @returns the class name
  124455. */
  124456. getClassName(): string;
  124457. /**
  124458. * Get the friendly name associated with the input class.
  124459. * @returns the input friendly name
  124460. */
  124461. getSimpleName(): string;
  124462. /**
  124463. * Check if the pressed modifier keys (Alt/Ctrl/Shift) match those configured to
  124464. * allow modification of the heightOffset value.
  124465. */
  124466. private _modifierHeightOffset;
  124467. /**
  124468. * Check if the pressed modifier keys (Alt/Ctrl/Shift) match those configured to
  124469. * allow modification of the rotationOffset value.
  124470. */
  124471. private _modifierRotationOffset;
  124472. /**
  124473. * Check if the pressed modifier keys (Alt/Ctrl/Shift) match those configured to
  124474. * allow modification of the radius value.
  124475. */
  124476. private _modifierRadius;
  124477. }
  124478. }
  124479. declare module BABYLON {
  124480. interface FreeCameraInputsManager {
  124481. /**
  124482. * @hidden
  124483. */
  124484. _deviceOrientationInput: Nullable<FreeCameraDeviceOrientationInput>;
  124485. /**
  124486. * Add orientation input support to the input manager.
  124487. * @returns the current input manager
  124488. */
  124489. addDeviceOrientation(): FreeCameraInputsManager;
  124490. }
  124491. /**
  124492. * Takes information about the orientation of the device as reported by the deviceorientation event to orient the camera.
  124493. * Screen rotation is taken into account.
  124494. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  124495. */
  124496. export class FreeCameraDeviceOrientationInput implements ICameraInput<FreeCamera> {
  124497. private _camera;
  124498. private _screenOrientationAngle;
  124499. private _constantTranform;
  124500. private _screenQuaternion;
  124501. private _alpha;
  124502. private _beta;
  124503. private _gamma;
  124504. /**
  124505. * Can be used to detect if a device orientation sensor is available on a device
  124506. * @param timeout amount of time in milliseconds to wait for a response from the sensor (default: infinite)
  124507. * @returns a promise that will resolve on orientation change
  124508. */
  124509. static WaitForOrientationChangeAsync(timeout?: number): Promise<unknown>;
  124510. /**
  124511. * @hidden
  124512. */
  124513. _onDeviceOrientationChangedObservable: Observable<void>;
  124514. /**
  124515. * Instantiates a new input
  124516. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  124517. */
  124518. constructor();
  124519. /**
  124520. * Define the camera controlled by the input.
  124521. */
  124522. get camera(): FreeCamera;
  124523. set camera(camera: FreeCamera);
  124524. /**
  124525. * Attach the input controls to a specific dom element to get the input from.
  124526. * @param element Defines the element the controls should be listened from
  124527. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  124528. */
  124529. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  124530. private _orientationChanged;
  124531. private _deviceOrientation;
  124532. /**
  124533. * Detach the current controls from the specified dom element.
  124534. * @param element Defines the element to stop listening the inputs from
  124535. */
  124536. detachControl(element: Nullable<HTMLElement>): void;
  124537. /**
  124538. * Update the current camera state depending on the inputs that have been used this frame.
  124539. * This is a dynamically created lambda to avoid the performance penalty of looping for inputs in the render loop.
  124540. */
  124541. checkInputs(): void;
  124542. /**
  124543. * Gets the class name of the current intput.
  124544. * @returns the class name
  124545. */
  124546. getClassName(): string;
  124547. /**
  124548. * Get the friendly name associated with the input class.
  124549. * @returns the input friendly name
  124550. */
  124551. getSimpleName(): string;
  124552. }
  124553. }
  124554. declare module BABYLON {
  124555. /**
  124556. * Manage the gamepad inputs to control a free camera.
  124557. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  124558. */
  124559. export class FreeCameraGamepadInput implements ICameraInput<FreeCamera> {
  124560. /**
  124561. * Define the camera the input is attached to.
  124562. */
  124563. camera: FreeCamera;
  124564. /**
  124565. * Define the Gamepad controlling the input
  124566. */
  124567. gamepad: Nullable<Gamepad>;
  124568. /**
  124569. * Defines the gamepad rotation sensiblity.
  124570. * This is the threshold from when rotation starts to be accounted for to prevent jittering.
  124571. */
  124572. gamepadAngularSensibility: number;
  124573. /**
  124574. * Defines the gamepad move sensiblity.
  124575. * This is the threshold from when moving starts to be accounted for for to prevent jittering.
  124576. */
  124577. gamepadMoveSensibility: number;
  124578. private _yAxisScale;
  124579. /**
  124580. * Gets or sets a boolean indicating that Yaxis (for right stick) should be inverted
  124581. */
  124582. get invertYAxis(): boolean;
  124583. set invertYAxis(value: boolean);
  124584. private _onGamepadConnectedObserver;
  124585. private _onGamepadDisconnectedObserver;
  124586. private _cameraTransform;
  124587. private _deltaTransform;
  124588. private _vector3;
  124589. private _vector2;
  124590. /**
  124591. * Attach the input controls to a specific dom element to get the input from.
  124592. * @param element Defines the element the controls should be listened from
  124593. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  124594. */
  124595. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  124596. /**
  124597. * Detach the current controls from the specified dom element.
  124598. * @param element Defines the element to stop listening the inputs from
  124599. */
  124600. detachControl(element: Nullable<HTMLElement>): void;
  124601. /**
  124602. * Update the current camera state depending on the inputs that have been used this frame.
  124603. * This is a dynamically created lambda to avoid the performance penalty of looping for inputs in the render loop.
  124604. */
  124605. checkInputs(): void;
  124606. /**
  124607. * Gets the class name of the current intput.
  124608. * @returns the class name
  124609. */
  124610. getClassName(): string;
  124611. /**
  124612. * Get the friendly name associated with the input class.
  124613. * @returns the input friendly name
  124614. */
  124615. getSimpleName(): string;
  124616. }
  124617. }
  124618. declare module BABYLON {
  124619. /**
  124620. * Defines the potential axis of a Joystick
  124621. */
  124622. export enum JoystickAxis {
  124623. /** X axis */
  124624. X = 0,
  124625. /** Y axis */
  124626. Y = 1,
  124627. /** Z axis */
  124628. Z = 2
  124629. }
  124630. /**
  124631. * Represents the different customization options available
  124632. * for VirtualJoystick
  124633. */
  124634. interface VirtualJoystickCustomizations {
  124635. /**
  124636. * Size of the joystick's puck
  124637. */
  124638. puckSize: number;
  124639. /**
  124640. * Size of the joystick's container
  124641. */
  124642. containerSize: number;
  124643. /**
  124644. * Color of the joystick && puck
  124645. */
  124646. color: string;
  124647. /**
  124648. * Image URL for the joystick's puck
  124649. */
  124650. puckImage?: string;
  124651. /**
  124652. * Image URL for the joystick's container
  124653. */
  124654. containerImage?: string;
  124655. /**
  124656. * Defines the unmoving position of the joystick container
  124657. */
  124658. position?: {
  124659. x: number;
  124660. y: number;
  124661. };
  124662. /**
  124663. * Defines whether or not the joystick container is always visible
  124664. */
  124665. alwaysVisible: boolean;
  124666. /**
  124667. * Defines whether or not to limit the movement of the puck to the joystick's container
  124668. */
  124669. limitToContainer: boolean;
  124670. }
  124671. /**
  124672. * Class used to define virtual joystick (used in touch mode)
  124673. */
  124674. export class VirtualJoystick {
  124675. /**
  124676. * Gets or sets a boolean indicating that left and right values must be inverted
  124677. */
  124678. reverseLeftRight: boolean;
  124679. /**
  124680. * Gets or sets a boolean indicating that up and down values must be inverted
  124681. */
  124682. reverseUpDown: boolean;
  124683. /**
  124684. * Gets the offset value for the position (ie. the change of the position value)
  124685. */
  124686. deltaPosition: Vector3;
  124687. /**
  124688. * Gets a boolean indicating if the virtual joystick was pressed
  124689. */
  124690. pressed: boolean;
  124691. /**
  124692. * Canvas the virtual joystick will render onto, default z-index of this is 5
  124693. */
  124694. static Canvas: Nullable<HTMLCanvasElement>;
  124695. /**
  124696. * boolean indicating whether or not the joystick's puck's movement should be limited to the joystick's container area
  124697. */
  124698. limitToContainer: boolean;
  124699. private static _globalJoystickIndex;
  124700. private static _alwaysVisibleSticks;
  124701. private static vjCanvasContext;
  124702. private static vjCanvasWidth;
  124703. private static vjCanvasHeight;
  124704. private static halfWidth;
  124705. private static _GetDefaultOptions;
  124706. private _action;
  124707. private _axisTargetedByLeftAndRight;
  124708. private _axisTargetedByUpAndDown;
  124709. private _joystickSensibility;
  124710. private _inversedSensibility;
  124711. private _joystickPointerID;
  124712. private _joystickColor;
  124713. private _joystickPointerPos;
  124714. private _joystickPreviousPointerPos;
  124715. private _joystickPointerStartPos;
  124716. private _deltaJoystickVector;
  124717. private _leftJoystick;
  124718. private _touches;
  124719. private _joystickPosition;
  124720. private _alwaysVisible;
  124721. private _puckImage;
  124722. private _containerImage;
  124723. private _joystickPuckSize;
  124724. private _joystickContainerSize;
  124725. private _clearPuckSize;
  124726. private _clearContainerSize;
  124727. private _clearPuckSizeOffset;
  124728. private _clearContainerSizeOffset;
  124729. private _onPointerDownHandlerRef;
  124730. private _onPointerMoveHandlerRef;
  124731. private _onPointerUpHandlerRef;
  124732. private _onResize;
  124733. /**
  124734. * Creates a new virtual joystick
  124735. * @param leftJoystick defines that the joystick is for left hand (false by default)
  124736. * @param customizations Defines the options we want to customize the VirtualJoystick
  124737. */
  124738. constructor(leftJoystick?: boolean, customizations?: Partial<VirtualJoystickCustomizations>);
  124739. /**
  124740. * Defines joystick sensibility (ie. the ratio beteen a physical move and virtual joystick position change)
  124741. * @param newJoystickSensibility defines the new sensibility
  124742. */
  124743. setJoystickSensibility(newJoystickSensibility: number): void;
  124744. private _onPointerDown;
  124745. private _onPointerMove;
  124746. private _onPointerUp;
  124747. /**
  124748. * Change the color of the virtual joystick
  124749. * @param newColor a string that must be a CSS color value (like "red") or the hexa value (like "#FF0000")
  124750. */
  124751. setJoystickColor(newColor: string): void;
  124752. /**
  124753. * Size of the joystick's container
  124754. */
  124755. set containerSize(newSize: number);
  124756. get containerSize(): number;
  124757. /**
  124758. * Size of the joystick's puck
  124759. */
  124760. set puckSize(newSize: number);
  124761. get puckSize(): number;
  124762. /**
  124763. * Clears the set position of the joystick
  124764. */
  124765. clearPosition(): void;
  124766. /**
  124767. * Defines whether or not the joystick container is always visible
  124768. */
  124769. set alwaysVisible(value: boolean);
  124770. get alwaysVisible(): boolean;
  124771. /**
  124772. * Sets the constant position of the Joystick container
  124773. * @param x X axis coordinate
  124774. * @param y Y axis coordinate
  124775. */
  124776. setPosition(x: number, y: number): void;
  124777. /**
  124778. * Defines a callback to call when the joystick is touched
  124779. * @param action defines the callback
  124780. */
  124781. setActionOnTouch(action: () => any): void;
  124782. /**
  124783. * Defines which axis you'd like to control for left & right
  124784. * @param axis defines the axis to use
  124785. */
  124786. setAxisForLeftRight(axis: JoystickAxis): void;
  124787. /**
  124788. * Defines which axis you'd like to control for up & down
  124789. * @param axis defines the axis to use
  124790. */
  124791. setAxisForUpDown(axis: JoystickAxis): void;
  124792. /**
  124793. * Clears the canvas from the previous puck / container draw
  124794. */
  124795. private _clearPreviousDraw;
  124796. /**
  124797. * Loads `urlPath` to be used for the container's image
  124798. * @param urlPath defines the urlPath of an image to use
  124799. */
  124800. setContainerImage(urlPath: string): void;
  124801. /**
  124802. * Loads `urlPath` to be used for the puck's image
  124803. * @param urlPath defines the urlPath of an image to use
  124804. */
  124805. setPuckImage(urlPath: string): void;
  124806. /**
  124807. * Draws the Virtual Joystick's container
  124808. */
  124809. private _drawContainer;
  124810. /**
  124811. * Draws the Virtual Joystick's puck
  124812. */
  124813. private _drawPuck;
  124814. private _drawVirtualJoystick;
  124815. /**
  124816. * Release internal HTML canvas
  124817. */
  124818. releaseCanvas(): void;
  124819. }
  124820. }
  124821. declare module BABYLON {
  124822. interface FreeCameraInputsManager {
  124823. /**
  124824. * Add virtual joystick input support to the input manager.
  124825. * @returns the current input manager
  124826. */
  124827. addVirtualJoystick(): FreeCameraInputsManager;
  124828. }
  124829. /**
  124830. * Manage the Virtual Joystick inputs to control the movement of a free camera.
  124831. * @see https://doc.babylonjs.com/how_to/customizing_camera_inputs
  124832. */
  124833. export class FreeCameraVirtualJoystickInput implements ICameraInput<FreeCamera> {
  124834. /**
  124835. * Defines the camera the input is attached to.
  124836. */
  124837. camera: FreeCamera;
  124838. private _leftjoystick;
  124839. private _rightjoystick;
  124840. /**
  124841. * Gets the left stick of the virtual joystick.
  124842. * @returns The virtual Joystick
  124843. */
  124844. getLeftJoystick(): VirtualJoystick;
  124845. /**
  124846. * Gets the right stick of the virtual joystick.
  124847. * @returns The virtual Joystick
  124848. */
  124849. getRightJoystick(): VirtualJoystick;
  124850. /**
  124851. * Update the current camera state depending on the inputs that have been used this frame.
  124852. * This is a dynamically created lambda to avoid the performance penalty of looping for inputs in the render loop.
  124853. */
  124854. checkInputs(): void;
  124855. /**
  124856. * Attach the input controls to a specific dom element to get the input from.
  124857. * @param element Defines the element the controls should be listened from
  124858. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  124859. */
  124860. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  124861. /**
  124862. * Detach the current controls from the specified dom element.
  124863. * @param element Defines the element to stop listening the inputs from
  124864. */
  124865. detachControl(element: Nullable<HTMLElement>): void;
  124866. /**
  124867. * Gets the class name of the current intput.
  124868. * @returns the class name
  124869. */
  124870. getClassName(): string;
  124871. /**
  124872. * Get the friendly name associated with the input class.
  124873. * @returns the input friendly name
  124874. */
  124875. getSimpleName(): string;
  124876. }
  124877. }
  124878. declare module BABYLON {
  124879. /**
  124880. * This represents a FPS type of camera controlled by touch.
  124881. * This is like a universal camera minus the Gamepad controls.
  124882. * @see https://doc.babylonjs.com/features/cameras#universal-camera
  124883. */
  124884. export class TouchCamera extends FreeCamera {
  124885. /**
  124886. * Defines the touch sensibility for rotation.
  124887. * The higher the faster.
  124888. */
  124889. get touchAngularSensibility(): number;
  124890. set touchAngularSensibility(value: number);
  124891. /**
  124892. * Defines the touch sensibility for move.
  124893. * The higher the faster.
  124894. */
  124895. get touchMoveSensibility(): number;
  124896. set touchMoveSensibility(value: number);
  124897. /**
  124898. * Instantiates a new touch camera.
  124899. * This represents a FPS type of camera controlled by touch.
  124900. * This is like a universal camera minus the Gamepad controls.
  124901. * @see https://doc.babylonjs.com/features/cameras#universal-camera
  124902. * @param name Define the name of the camera in the scene
  124903. * @param position Define the start position of the camera in the scene
  124904. * @param scene Define the scene the camera belongs to
  124905. */
  124906. constructor(name: string, position: Vector3, scene: Scene);
  124907. /**
  124908. * Gets the current object class name.
  124909. * @return the class name
  124910. */
  124911. getClassName(): string;
  124912. /** @hidden */
  124913. _setupInputs(): void;
  124914. }
  124915. }
  124916. declare module BABYLON {
  124917. /**
  124918. * This is a camera specifically designed to react to device orientation events such as a modern mobile device
  124919. * being tilted forward or back and left or right.
  124920. */
  124921. export class DeviceOrientationCamera extends FreeCamera {
  124922. private _initialQuaternion;
  124923. private _quaternionCache;
  124924. private _tmpDragQuaternion;
  124925. private _disablePointerInputWhenUsingDeviceOrientation;
  124926. /**
  124927. * Creates a new device orientation camera
  124928. * @param name The name of the camera
  124929. * @param position The start position camera
  124930. * @param scene The scene the camera belongs to
  124931. */
  124932. constructor(name: string, position: Vector3, scene: Scene);
  124933. /**
  124934. * Gets or sets a boolean indicating that pointer input must be disabled on first orientation sensor update (Default: true)
  124935. */
  124936. get disablePointerInputWhenUsingDeviceOrientation(): boolean;
  124937. set disablePointerInputWhenUsingDeviceOrientation(value: boolean);
  124938. private _dragFactor;
  124939. /**
  124940. * Enabled turning on the y axis when the orientation sensor is active
  124941. * @param dragFactor the factor that controls the turn speed (default: 1/300)
  124942. */
  124943. enableHorizontalDragging(dragFactor?: number): void;
  124944. /**
  124945. * Gets the current instance class name ("DeviceOrientationCamera").
  124946. * This helps avoiding instanceof at run time.
  124947. * @returns the class name
  124948. */
  124949. getClassName(): string;
  124950. /**
  124951. * @hidden
  124952. * Checks and applies the current values of the inputs to the camera. (Internal use only)
  124953. */
  124954. _checkInputs(): void;
  124955. /**
  124956. * Reset the camera to its default orientation on the specified axis only.
  124957. * @param axis The axis to reset
  124958. */
  124959. resetToCurrentRotation(axis?: Axis): void;
  124960. }
  124961. }
  124962. declare module BABYLON {
  124963. /**
  124964. * Defines supported buttons for XBox360 compatible gamepads
  124965. */
  124966. export enum Xbox360Button {
  124967. /** A */
  124968. A = 0,
  124969. /** B */
  124970. B = 1,
  124971. /** X */
  124972. X = 2,
  124973. /** Y */
  124974. Y = 3,
  124975. /** Left button */
  124976. LB = 4,
  124977. /** Right button */
  124978. RB = 5,
  124979. /** Back */
  124980. Back = 8,
  124981. /** Start */
  124982. Start = 9,
  124983. /** Left stick */
  124984. LeftStick = 10,
  124985. /** Right stick */
  124986. RightStick = 11
  124987. }
  124988. /** Defines values for XBox360 DPad */
  124989. export enum Xbox360Dpad {
  124990. /** Up */
  124991. Up = 12,
  124992. /** Down */
  124993. Down = 13,
  124994. /** Left */
  124995. Left = 14,
  124996. /** Right */
  124997. Right = 15
  124998. }
  124999. /**
  125000. * Defines a XBox360 gamepad
  125001. */
  125002. export class Xbox360Pad extends Gamepad {
  125003. private _leftTrigger;
  125004. private _rightTrigger;
  125005. private _onlefttriggerchanged;
  125006. private _onrighttriggerchanged;
  125007. private _onbuttondown;
  125008. private _onbuttonup;
  125009. private _ondpaddown;
  125010. private _ondpadup;
  125011. /** Observable raised when a button is pressed */
  125012. onButtonDownObservable: Observable<Xbox360Button>;
  125013. /** Observable raised when a button is released */
  125014. onButtonUpObservable: Observable<Xbox360Button>;
  125015. /** Observable raised when a pad is pressed */
  125016. onPadDownObservable: Observable<Xbox360Dpad>;
  125017. /** Observable raised when a pad is released */
  125018. onPadUpObservable: Observable<Xbox360Dpad>;
  125019. private _buttonA;
  125020. private _buttonB;
  125021. private _buttonX;
  125022. private _buttonY;
  125023. private _buttonBack;
  125024. private _buttonStart;
  125025. private _buttonLB;
  125026. private _buttonRB;
  125027. private _buttonLeftStick;
  125028. private _buttonRightStick;
  125029. private _dPadUp;
  125030. private _dPadDown;
  125031. private _dPadLeft;
  125032. private _dPadRight;
  125033. private _isXboxOnePad;
  125034. /**
  125035. * Creates a new XBox360 gamepad object
  125036. * @param id defines the id of this gamepad
  125037. * @param index defines its index
  125038. * @param gamepad defines the internal HTML gamepad object
  125039. * @param xboxOne defines if it is a XBox One gamepad
  125040. */
  125041. constructor(id: string, index: number, gamepad: any, xboxOne?: boolean);
  125042. /**
  125043. * Defines the callback to call when left trigger is pressed
  125044. * @param callback defines the callback to use
  125045. */
  125046. onlefttriggerchanged(callback: (value: number) => void): void;
  125047. /**
  125048. * Defines the callback to call when right trigger is pressed
  125049. * @param callback defines the callback to use
  125050. */
  125051. onrighttriggerchanged(callback: (value: number) => void): void;
  125052. /**
  125053. * Gets the left trigger value
  125054. */
  125055. get leftTrigger(): number;
  125056. /**
  125057. * Sets the left trigger value
  125058. */
  125059. set leftTrigger(newValue: number);
  125060. /**
  125061. * Gets the right trigger value
  125062. */
  125063. get rightTrigger(): number;
  125064. /**
  125065. * Sets the right trigger value
  125066. */
  125067. set rightTrigger(newValue: number);
  125068. /**
  125069. * Defines the callback to call when a button is pressed
  125070. * @param callback defines the callback to use
  125071. */
  125072. onbuttondown(callback: (buttonPressed: Xbox360Button) => void): void;
  125073. /**
  125074. * Defines the callback to call when a button is released
  125075. * @param callback defines the callback to use
  125076. */
  125077. onbuttonup(callback: (buttonReleased: Xbox360Button) => void): void;
  125078. /**
  125079. * Defines the callback to call when a pad is pressed
  125080. * @param callback defines the callback to use
  125081. */
  125082. ondpaddown(callback: (dPadPressed: Xbox360Dpad) => void): void;
  125083. /**
  125084. * Defines the callback to call when a pad is released
  125085. * @param callback defines the callback to use
  125086. */
  125087. ondpadup(callback: (dPadReleased: Xbox360Dpad) => void): void;
  125088. private _setButtonValue;
  125089. private _setDPadValue;
  125090. /**
  125091. * Gets the value of the `A` button
  125092. */
  125093. get buttonA(): number;
  125094. /**
  125095. * Sets the value of the `A` button
  125096. */
  125097. set buttonA(value: number);
  125098. /**
  125099. * Gets the value of the `B` button
  125100. */
  125101. get buttonB(): number;
  125102. /**
  125103. * Sets the value of the `B` button
  125104. */
  125105. set buttonB(value: number);
  125106. /**
  125107. * Gets the value of the `X` button
  125108. */
  125109. get buttonX(): number;
  125110. /**
  125111. * Sets the value of the `X` button
  125112. */
  125113. set buttonX(value: number);
  125114. /**
  125115. * Gets the value of the `Y` button
  125116. */
  125117. get buttonY(): number;
  125118. /**
  125119. * Sets the value of the `Y` button
  125120. */
  125121. set buttonY(value: number);
  125122. /**
  125123. * Gets the value of the `Start` button
  125124. */
  125125. get buttonStart(): number;
  125126. /**
  125127. * Sets the value of the `Start` button
  125128. */
  125129. set buttonStart(value: number);
  125130. /**
  125131. * Gets the value of the `Back` button
  125132. */
  125133. get buttonBack(): number;
  125134. /**
  125135. * Sets the value of the `Back` button
  125136. */
  125137. set buttonBack(value: number);
  125138. /**
  125139. * Gets the value of the `Left` button
  125140. */
  125141. get buttonLB(): number;
  125142. /**
  125143. * Sets the value of the `Left` button
  125144. */
  125145. set buttonLB(value: number);
  125146. /**
  125147. * Gets the value of the `Right` button
  125148. */
  125149. get buttonRB(): number;
  125150. /**
  125151. * Sets the value of the `Right` button
  125152. */
  125153. set buttonRB(value: number);
  125154. /**
  125155. * Gets the value of the Left joystick
  125156. */
  125157. get buttonLeftStick(): number;
  125158. /**
  125159. * Sets the value of the Left joystick
  125160. */
  125161. set buttonLeftStick(value: number);
  125162. /**
  125163. * Gets the value of the Right joystick
  125164. */
  125165. get buttonRightStick(): number;
  125166. /**
  125167. * Sets the value of the Right joystick
  125168. */
  125169. set buttonRightStick(value: number);
  125170. /**
  125171. * Gets the value of D-pad up
  125172. */
  125173. get dPadUp(): number;
  125174. /**
  125175. * Sets the value of D-pad up
  125176. */
  125177. set dPadUp(value: number);
  125178. /**
  125179. * Gets the value of D-pad down
  125180. */
  125181. get dPadDown(): number;
  125182. /**
  125183. * Sets the value of D-pad down
  125184. */
  125185. set dPadDown(value: number);
  125186. /**
  125187. * Gets the value of D-pad left
  125188. */
  125189. get dPadLeft(): number;
  125190. /**
  125191. * Sets the value of D-pad left
  125192. */
  125193. set dPadLeft(value: number);
  125194. /**
  125195. * Gets the value of D-pad right
  125196. */
  125197. get dPadRight(): number;
  125198. /**
  125199. * Sets the value of D-pad right
  125200. */
  125201. set dPadRight(value: number);
  125202. /**
  125203. * Force the gamepad to synchronize with device values
  125204. */
  125205. update(): void;
  125206. /**
  125207. * Disposes the gamepad
  125208. */
  125209. dispose(): void;
  125210. }
  125211. }
  125212. declare module BABYLON {
  125213. /**
  125214. * Defines supported buttons for DualShock compatible gamepads
  125215. */
  125216. export enum DualShockButton {
  125217. /** Cross */
  125218. Cross = 0,
  125219. /** Circle */
  125220. Circle = 1,
  125221. /** Square */
  125222. Square = 2,
  125223. /** Triangle */
  125224. Triangle = 3,
  125225. /** L1 */
  125226. L1 = 4,
  125227. /** R1 */
  125228. R1 = 5,
  125229. /** Share */
  125230. Share = 8,
  125231. /** Options */
  125232. Options = 9,
  125233. /** Left stick */
  125234. LeftStick = 10,
  125235. /** Right stick */
  125236. RightStick = 11
  125237. }
  125238. /** Defines values for DualShock DPad */
  125239. export enum DualShockDpad {
  125240. /** Up */
  125241. Up = 12,
  125242. /** Down */
  125243. Down = 13,
  125244. /** Left */
  125245. Left = 14,
  125246. /** Right */
  125247. Right = 15
  125248. }
  125249. /**
  125250. * Defines a DualShock gamepad
  125251. */
  125252. export class DualShockPad extends Gamepad {
  125253. private _leftTrigger;
  125254. private _rightTrigger;
  125255. private _onlefttriggerchanged;
  125256. private _onrighttriggerchanged;
  125257. private _onbuttondown;
  125258. private _onbuttonup;
  125259. private _ondpaddown;
  125260. private _ondpadup;
  125261. /** Observable raised when a button is pressed */
  125262. onButtonDownObservable: Observable<DualShockButton>;
  125263. /** Observable raised when a button is released */
  125264. onButtonUpObservable: Observable<DualShockButton>;
  125265. /** Observable raised when a pad is pressed */
  125266. onPadDownObservable: Observable<DualShockDpad>;
  125267. /** Observable raised when a pad is released */
  125268. onPadUpObservable: Observable<DualShockDpad>;
  125269. private _buttonCross;
  125270. private _buttonCircle;
  125271. private _buttonSquare;
  125272. private _buttonTriangle;
  125273. private _buttonShare;
  125274. private _buttonOptions;
  125275. private _buttonL1;
  125276. private _buttonR1;
  125277. private _buttonLeftStick;
  125278. private _buttonRightStick;
  125279. private _dPadUp;
  125280. private _dPadDown;
  125281. private _dPadLeft;
  125282. private _dPadRight;
  125283. /**
  125284. * Creates a new DualShock gamepad object
  125285. * @param id defines the id of this gamepad
  125286. * @param index defines its index
  125287. * @param gamepad defines the internal HTML gamepad object
  125288. */
  125289. constructor(id: string, index: number, gamepad: any);
  125290. /**
  125291. * Defines the callback to call when left trigger is pressed
  125292. * @param callback defines the callback to use
  125293. */
  125294. onlefttriggerchanged(callback: (value: number) => void): void;
  125295. /**
  125296. * Defines the callback to call when right trigger is pressed
  125297. * @param callback defines the callback to use
  125298. */
  125299. onrighttriggerchanged(callback: (value: number) => void): void;
  125300. /**
  125301. * Gets the left trigger value
  125302. */
  125303. get leftTrigger(): number;
  125304. /**
  125305. * Sets the left trigger value
  125306. */
  125307. set leftTrigger(newValue: number);
  125308. /**
  125309. * Gets the right trigger value
  125310. */
  125311. get rightTrigger(): number;
  125312. /**
  125313. * Sets the right trigger value
  125314. */
  125315. set rightTrigger(newValue: number);
  125316. /**
  125317. * Defines the callback to call when a button is pressed
  125318. * @param callback defines the callback to use
  125319. */
  125320. onbuttondown(callback: (buttonPressed: DualShockButton) => void): void;
  125321. /**
  125322. * Defines the callback to call when a button is released
  125323. * @param callback defines the callback to use
  125324. */
  125325. onbuttonup(callback: (buttonReleased: DualShockButton) => void): void;
  125326. /**
  125327. * Defines the callback to call when a pad is pressed
  125328. * @param callback defines the callback to use
  125329. */
  125330. ondpaddown(callback: (dPadPressed: DualShockDpad) => void): void;
  125331. /**
  125332. * Defines the callback to call when a pad is released
  125333. * @param callback defines the callback to use
  125334. */
  125335. ondpadup(callback: (dPadReleased: DualShockDpad) => void): void;
  125336. private _setButtonValue;
  125337. private _setDPadValue;
  125338. /**
  125339. * Gets the value of the `Cross` button
  125340. */
  125341. get buttonCross(): number;
  125342. /**
  125343. * Sets the value of the `Cross` button
  125344. */
  125345. set buttonCross(value: number);
  125346. /**
  125347. * Gets the value of the `Circle` button
  125348. */
  125349. get buttonCircle(): number;
  125350. /**
  125351. * Sets the value of the `Circle` button
  125352. */
  125353. set buttonCircle(value: number);
  125354. /**
  125355. * Gets the value of the `Square` button
  125356. */
  125357. get buttonSquare(): number;
  125358. /**
  125359. * Sets the value of the `Square` button
  125360. */
  125361. set buttonSquare(value: number);
  125362. /**
  125363. * Gets the value of the `Triangle` button
  125364. */
  125365. get buttonTriangle(): number;
  125366. /**
  125367. * Sets the value of the `Triangle` button
  125368. */
  125369. set buttonTriangle(value: number);
  125370. /**
  125371. * Gets the value of the `Options` button
  125372. */
  125373. get buttonOptions(): number;
  125374. /**
  125375. * Sets the value of the `Options` button
  125376. */
  125377. set buttonOptions(value: number);
  125378. /**
  125379. * Gets the value of the `Share` button
  125380. */
  125381. get buttonShare(): number;
  125382. /**
  125383. * Sets the value of the `Share` button
  125384. */
  125385. set buttonShare(value: number);
  125386. /**
  125387. * Gets the value of the `L1` button
  125388. */
  125389. get buttonL1(): number;
  125390. /**
  125391. * Sets the value of the `L1` button
  125392. */
  125393. set buttonL1(value: number);
  125394. /**
  125395. * Gets the value of the `R1` button
  125396. */
  125397. get buttonR1(): number;
  125398. /**
  125399. * Sets the value of the `R1` button
  125400. */
  125401. set buttonR1(value: number);
  125402. /**
  125403. * Gets the value of the Left joystick
  125404. */
  125405. get buttonLeftStick(): number;
  125406. /**
  125407. * Sets the value of the Left joystick
  125408. */
  125409. set buttonLeftStick(value: number);
  125410. /**
  125411. * Gets the value of the Right joystick
  125412. */
  125413. get buttonRightStick(): number;
  125414. /**
  125415. * Sets the value of the Right joystick
  125416. */
  125417. set buttonRightStick(value: number);
  125418. /**
  125419. * Gets the value of D-pad up
  125420. */
  125421. get dPadUp(): number;
  125422. /**
  125423. * Sets the value of D-pad up
  125424. */
  125425. set dPadUp(value: number);
  125426. /**
  125427. * Gets the value of D-pad down
  125428. */
  125429. get dPadDown(): number;
  125430. /**
  125431. * Sets the value of D-pad down
  125432. */
  125433. set dPadDown(value: number);
  125434. /**
  125435. * Gets the value of D-pad left
  125436. */
  125437. get dPadLeft(): number;
  125438. /**
  125439. * Sets the value of D-pad left
  125440. */
  125441. set dPadLeft(value: number);
  125442. /**
  125443. * Gets the value of D-pad right
  125444. */
  125445. get dPadRight(): number;
  125446. /**
  125447. * Sets the value of D-pad right
  125448. */
  125449. set dPadRight(value: number);
  125450. /**
  125451. * Force the gamepad to synchronize with device values
  125452. */
  125453. update(): void;
  125454. /**
  125455. * Disposes the gamepad
  125456. */
  125457. dispose(): void;
  125458. }
  125459. }
  125460. declare module BABYLON {
  125461. /**
  125462. * Manager for handling gamepads
  125463. */
  125464. export class GamepadManager {
  125465. private _scene?;
  125466. private _babylonGamepads;
  125467. private _oneGamepadConnected;
  125468. /** @hidden */
  125469. _isMonitoring: boolean;
  125470. private _gamepadEventSupported;
  125471. private _gamepadSupport?;
  125472. /**
  125473. * observable to be triggered when the gamepad controller has been connected
  125474. */
  125475. onGamepadConnectedObservable: Observable<Gamepad>;
  125476. /**
  125477. * observable to be triggered when the gamepad controller has been disconnected
  125478. */
  125479. onGamepadDisconnectedObservable: Observable<Gamepad>;
  125480. private _onGamepadConnectedEvent;
  125481. private _onGamepadDisconnectedEvent;
  125482. /**
  125483. * Initializes the gamepad manager
  125484. * @param _scene BabylonJS scene
  125485. */
  125486. constructor(_scene?: Scene | undefined);
  125487. /**
  125488. * The gamepads in the game pad manager
  125489. */
  125490. get gamepads(): Gamepad[];
  125491. /**
  125492. * Get the gamepad controllers based on type
  125493. * @param type The type of gamepad controller
  125494. * @returns Nullable gamepad
  125495. */
  125496. getGamepadByType(type?: number): Nullable<Gamepad>;
  125497. /**
  125498. * Disposes the gamepad manager
  125499. */
  125500. dispose(): void;
  125501. private _addNewGamepad;
  125502. private _startMonitoringGamepads;
  125503. private _stopMonitoringGamepads;
  125504. /** @hidden */
  125505. _checkGamepadsStatus(): void;
  125506. private _updateGamepadObjects;
  125507. }
  125508. }
  125509. declare module BABYLON {
  125510. interface Scene {
  125511. /** @hidden */
  125512. _gamepadManager: Nullable<GamepadManager>;
  125513. /**
  125514. * Gets the gamepad manager associated with the scene
  125515. * @see https://doc.babylonjs.com/how_to/how_to_use_gamepads
  125516. */
  125517. gamepadManager: GamepadManager;
  125518. }
  125519. /**
  125520. * Interface representing a free camera inputs manager
  125521. */
  125522. interface FreeCameraInputsManager {
  125523. /**
  125524. * Adds gamepad input support to the FreeCameraInputsManager.
  125525. * @returns the FreeCameraInputsManager
  125526. */
  125527. addGamepad(): FreeCameraInputsManager;
  125528. }
  125529. /**
  125530. * Interface representing an arc rotate camera inputs manager
  125531. */
  125532. interface ArcRotateCameraInputsManager {
  125533. /**
  125534. * Adds gamepad input support to the ArcRotateCamera InputManager.
  125535. * @returns the camera inputs manager
  125536. */
  125537. addGamepad(): ArcRotateCameraInputsManager;
  125538. }
  125539. /**
  125540. * Defines the gamepad scene component responsible to manage gamepads in a given scene
  125541. */
  125542. export class GamepadSystemSceneComponent implements ISceneComponent {
  125543. /**
  125544. * The component name helpfull to identify the component in the list of scene components.
  125545. */
  125546. readonly name: string;
  125547. /**
  125548. * The scene the component belongs to.
  125549. */
  125550. scene: Scene;
  125551. /**
  125552. * Creates a new instance of the component for the given scene
  125553. * @param scene Defines the scene to register the component in
  125554. */
  125555. constructor(scene: Scene);
  125556. /**
  125557. * Registers the component in a given scene
  125558. */
  125559. register(): void;
  125560. /**
  125561. * Rebuilds the elements related to this component in case of
  125562. * context lost for instance.
  125563. */
  125564. rebuild(): void;
  125565. /**
  125566. * Disposes the component and the associated ressources
  125567. */
  125568. dispose(): void;
  125569. private _beforeCameraUpdate;
  125570. }
  125571. }
  125572. declare module BABYLON {
  125573. /**
  125574. * 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,
  125575. * which still works and will still be found in many Playgrounds.
  125576. * @see https://doc.babylonjs.com/features/cameras#universal-camera
  125577. */
  125578. export class UniversalCamera extends TouchCamera {
  125579. /**
  125580. * Defines the gamepad rotation sensiblity.
  125581. * This is the threshold from when rotation starts to be accounted for to prevent jittering.
  125582. */
  125583. get gamepadAngularSensibility(): number;
  125584. set gamepadAngularSensibility(value: number);
  125585. /**
  125586. * Defines the gamepad move sensiblity.
  125587. * This is the threshold from when moving starts to be accounted for for to prevent jittering.
  125588. */
  125589. get gamepadMoveSensibility(): number;
  125590. set gamepadMoveSensibility(value: number);
  125591. /**
  125592. * 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,
  125593. * which still works and will still be found in many Playgrounds.
  125594. * @see https://doc.babylonjs.com/features/cameras#universal-camera
  125595. * @param name Define the name of the camera in the scene
  125596. * @param position Define the start position of the camera in the scene
  125597. * @param scene Define the scene the camera belongs to
  125598. */
  125599. constructor(name: string, position: Vector3, scene: Scene);
  125600. /**
  125601. * Gets the current object class name.
  125602. * @return the class name
  125603. */
  125604. getClassName(): string;
  125605. }
  125606. }
  125607. declare module BABYLON {
  125608. /**
  125609. * This represents a FPS type of camera. This is only here for back compat purpose.
  125610. * Please use the UniversalCamera instead as both are identical.
  125611. * @see https://doc.babylonjs.com/features/cameras#universal-camera
  125612. */
  125613. export class GamepadCamera extends UniversalCamera {
  125614. /**
  125615. * Instantiates a new Gamepad Camera
  125616. * This represents a FPS type of camera. This is only here for back compat purpose.
  125617. * Please use the UniversalCamera instead as both are identical.
  125618. * @see https://doc.babylonjs.com/features/cameras#universal-camera
  125619. * @param name Define the name of the camera in the scene
  125620. * @param position Define the start position of the camera in the scene
  125621. * @param scene Define the scene the camera belongs to
  125622. */
  125623. constructor(name: string, position: Vector3, scene: Scene);
  125624. /**
  125625. * Gets the current object class name.
  125626. * @return the class name
  125627. */
  125628. getClassName(): string;
  125629. }
  125630. }
  125631. declare module BABYLON {
  125632. /** @hidden */
  125633. export var passPixelShader: {
  125634. name: string;
  125635. shader: string;
  125636. };
  125637. }
  125638. declare module BABYLON {
  125639. /** @hidden */
  125640. export var passCubePixelShader: {
  125641. name: string;
  125642. shader: string;
  125643. };
  125644. }
  125645. declare module BABYLON {
  125646. /**
  125647. * PassPostProcess which produces an output the same as it's input
  125648. */
  125649. export class PassPostProcess extends PostProcess {
  125650. /**
  125651. * Gets a string identifying the name of the class
  125652. * @returns "PassPostProcess" string
  125653. */
  125654. getClassName(): string;
  125655. /**
  125656. * Creates the PassPostProcess
  125657. * @param name The name of the effect.
  125658. * @param options The required width/height ratio to downsize to before computing the render pass.
  125659. * @param camera The camera to apply the render pass to.
  125660. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  125661. * @param engine The engine which the post process will be applied. (default: current engine)
  125662. * @param reusable If the post process can be reused on the same frame. (default: false)
  125663. * @param textureType The type of texture to be used when performing the post processing.
  125664. * @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)
  125665. */
  125666. constructor(name: string, options: number | PostProcessOptions, camera?: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number, blockCompilation?: boolean);
  125667. /** @hidden */
  125668. static _Parse(parsedPostProcess: any, targetCamera: Camera, scene: Scene, rootUrl: string): PassPostProcess;
  125669. }
  125670. /**
  125671. * PassCubePostProcess which produces an output the same as it's input (which must be a cube texture)
  125672. */
  125673. export class PassCubePostProcess extends PostProcess {
  125674. private _face;
  125675. /**
  125676. * Gets or sets the cube face to display.
  125677. * * 0 is +X
  125678. * * 1 is -X
  125679. * * 2 is +Y
  125680. * * 3 is -Y
  125681. * * 4 is +Z
  125682. * * 5 is -Z
  125683. */
  125684. get face(): number;
  125685. set face(value: number);
  125686. /**
  125687. * Gets a string identifying the name of the class
  125688. * @returns "PassCubePostProcess" string
  125689. */
  125690. getClassName(): string;
  125691. /**
  125692. * Creates the PassCubePostProcess
  125693. * @param name The name of the effect.
  125694. * @param options The required width/height ratio to downsize to before computing the render pass.
  125695. * @param camera The camera to apply the render pass to.
  125696. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  125697. * @param engine The engine which the post process will be applied. (default: current engine)
  125698. * @param reusable If the post process can be reused on the same frame. (default: false)
  125699. * @param textureType The type of texture to be used when performing the post processing.
  125700. * @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)
  125701. */
  125702. constructor(name: string, options: number | PostProcessOptions, camera?: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number, blockCompilation?: boolean);
  125703. /** @hidden */
  125704. static _Parse(parsedPostProcess: any, targetCamera: Camera, scene: Scene, rootUrl: string): PassCubePostProcess;
  125705. }
  125706. }
  125707. declare module BABYLON {
  125708. /** @hidden */
  125709. export var anaglyphPixelShader: {
  125710. name: string;
  125711. shader: string;
  125712. };
  125713. }
  125714. declare module BABYLON {
  125715. /**
  125716. * Postprocess used to generate anaglyphic rendering
  125717. */
  125718. export class AnaglyphPostProcess extends PostProcess {
  125719. private _passedProcess;
  125720. /**
  125721. * Gets a string identifying the name of the class
  125722. * @returns "AnaglyphPostProcess" string
  125723. */
  125724. getClassName(): string;
  125725. /**
  125726. * Creates a new AnaglyphPostProcess
  125727. * @param name defines postprocess name
  125728. * @param options defines creation options or target ratio scale
  125729. * @param rigCameras defines cameras using this postprocess
  125730. * @param samplingMode defines required sampling mode (BABYLON.Texture.NEAREST_SAMPLINGMODE by default)
  125731. * @param engine defines hosting engine
  125732. * @param reusable defines if the postprocess will be reused multiple times per frame
  125733. */
  125734. constructor(name: string, options: number | PostProcessOptions, rigCameras: Camera[], samplingMode?: number, engine?: Engine, reusable?: boolean);
  125735. }
  125736. }
  125737. declare module BABYLON {
  125738. /**
  125739. * Camera used to simulate anaglyphic rendering (based on ArcRotateCamera)
  125740. * @see https://doc.babylonjs.com/features/cameras#anaglyph-cameras
  125741. */
  125742. export class AnaglyphArcRotateCamera extends ArcRotateCamera {
  125743. /**
  125744. * Creates a new AnaglyphArcRotateCamera
  125745. * @param name defines camera name
  125746. * @param alpha defines alpha angle (in radians)
  125747. * @param beta defines beta angle (in radians)
  125748. * @param radius defines radius
  125749. * @param target defines camera target
  125750. * @param interaxialDistance defines distance between each color axis
  125751. * @param scene defines the hosting scene
  125752. */
  125753. constructor(name: string, alpha: number, beta: number, radius: number, target: Vector3, interaxialDistance: number, scene: Scene);
  125754. /**
  125755. * Gets camera class name
  125756. * @returns AnaglyphArcRotateCamera
  125757. */
  125758. getClassName(): string;
  125759. }
  125760. }
  125761. declare module BABYLON {
  125762. /**
  125763. * Camera used to simulate anaglyphic rendering (based on FreeCamera)
  125764. * @see https://doc.babylonjs.com/features/cameras#anaglyph-cameras
  125765. */
  125766. export class AnaglyphFreeCamera extends FreeCamera {
  125767. /**
  125768. * Creates a new AnaglyphFreeCamera
  125769. * @param name defines camera name
  125770. * @param position defines initial position
  125771. * @param interaxialDistance defines distance between each color axis
  125772. * @param scene defines the hosting scene
  125773. */
  125774. constructor(name: string, position: Vector3, interaxialDistance: number, scene: Scene);
  125775. /**
  125776. * Gets camera class name
  125777. * @returns AnaglyphFreeCamera
  125778. */
  125779. getClassName(): string;
  125780. }
  125781. }
  125782. declare module BABYLON {
  125783. /**
  125784. * Camera used to simulate anaglyphic rendering (based on GamepadCamera)
  125785. * @see https://doc.babylonjs.com/features/cameras#anaglyph-cameras
  125786. */
  125787. export class AnaglyphGamepadCamera extends GamepadCamera {
  125788. /**
  125789. * Creates a new AnaglyphGamepadCamera
  125790. * @param name defines camera name
  125791. * @param position defines initial position
  125792. * @param interaxialDistance defines distance between each color axis
  125793. * @param scene defines the hosting scene
  125794. */
  125795. constructor(name: string, position: Vector3, interaxialDistance: number, scene: Scene);
  125796. /**
  125797. * Gets camera class name
  125798. * @returns AnaglyphGamepadCamera
  125799. */
  125800. getClassName(): string;
  125801. }
  125802. }
  125803. declare module BABYLON {
  125804. /**
  125805. * Camera used to simulate anaglyphic rendering (based on UniversalCamera)
  125806. * @see https://doc.babylonjs.com/features/cameras#anaglyph-cameras
  125807. */
  125808. export class AnaglyphUniversalCamera extends UniversalCamera {
  125809. /**
  125810. * Creates a new AnaglyphUniversalCamera
  125811. * @param name defines camera name
  125812. * @param position defines initial position
  125813. * @param interaxialDistance defines distance between each color axis
  125814. * @param scene defines the hosting scene
  125815. */
  125816. constructor(name: string, position: Vector3, interaxialDistance: number, scene: Scene);
  125817. /**
  125818. * Gets camera class name
  125819. * @returns AnaglyphUniversalCamera
  125820. */
  125821. getClassName(): string;
  125822. }
  125823. }
  125824. declare module BABYLON {
  125825. /**
  125826. * Camera used to simulate stereoscopic rendering (based on ArcRotateCamera)
  125827. * @see https://doc.babylonjs.com/features/cameras
  125828. */
  125829. export class StereoscopicArcRotateCamera extends ArcRotateCamera {
  125830. /**
  125831. * Creates a new StereoscopicArcRotateCamera
  125832. * @param name defines camera name
  125833. * @param alpha defines alpha angle (in radians)
  125834. * @param beta defines beta angle (in radians)
  125835. * @param radius defines radius
  125836. * @param target defines camera target
  125837. * @param interaxialDistance defines distance between each color axis
  125838. * @param isStereoscopicSideBySide defines is stereoscopic is done side by side or over under
  125839. * @param scene defines the hosting scene
  125840. */
  125841. constructor(name: string, alpha: number, beta: number, radius: number, target: Vector3, interaxialDistance: number, isStereoscopicSideBySide: boolean, scene: Scene);
  125842. /**
  125843. * Gets camera class name
  125844. * @returns StereoscopicArcRotateCamera
  125845. */
  125846. getClassName(): string;
  125847. }
  125848. }
  125849. declare module BABYLON {
  125850. /**
  125851. * Camera used to simulate stereoscopic rendering (based on FreeCamera)
  125852. * @see https://doc.babylonjs.com/features/cameras
  125853. */
  125854. export class StereoscopicFreeCamera extends FreeCamera {
  125855. /**
  125856. * Creates a new StereoscopicFreeCamera
  125857. * @param name defines camera name
  125858. * @param position defines initial position
  125859. * @param interaxialDistance defines distance between each color axis
  125860. * @param isStereoscopicSideBySide defines is stereoscopic is done side by side or over under
  125861. * @param scene defines the hosting scene
  125862. */
  125863. constructor(name: string, position: Vector3, interaxialDistance: number, isStereoscopicSideBySide: boolean, scene: Scene);
  125864. /**
  125865. * Gets camera class name
  125866. * @returns StereoscopicFreeCamera
  125867. */
  125868. getClassName(): string;
  125869. }
  125870. }
  125871. declare module BABYLON {
  125872. /**
  125873. * Camera used to simulate stereoscopic rendering (based on GamepadCamera)
  125874. * @see https://doc.babylonjs.com/features/cameras
  125875. */
  125876. export class StereoscopicGamepadCamera extends GamepadCamera {
  125877. /**
  125878. * Creates a new StereoscopicGamepadCamera
  125879. * @param name defines camera name
  125880. * @param position defines initial position
  125881. * @param interaxialDistance defines distance between each color axis
  125882. * @param isStereoscopicSideBySide defines is stereoscopic is done side by side or over under
  125883. * @param scene defines the hosting scene
  125884. */
  125885. constructor(name: string, position: Vector3, interaxialDistance: number, isStereoscopicSideBySide: boolean, scene: Scene);
  125886. /**
  125887. * Gets camera class name
  125888. * @returns StereoscopicGamepadCamera
  125889. */
  125890. getClassName(): string;
  125891. }
  125892. }
  125893. declare module BABYLON {
  125894. /**
  125895. * Camera used to simulate stereoscopic rendering (based on UniversalCamera)
  125896. * @see https://doc.babylonjs.com/features/cameras
  125897. */
  125898. export class StereoscopicUniversalCamera extends UniversalCamera {
  125899. /**
  125900. * Creates a new StereoscopicUniversalCamera
  125901. * @param name defines camera name
  125902. * @param position defines initial position
  125903. * @param interaxialDistance defines distance between each color axis
  125904. * @param isStereoscopicSideBySide defines is stereoscopic is done side by side or over under
  125905. * @param scene defines the hosting scene
  125906. */
  125907. constructor(name: string, position: Vector3, interaxialDistance: number, isStereoscopicSideBySide: boolean, scene: Scene);
  125908. /**
  125909. * Gets camera class name
  125910. * @returns StereoscopicUniversalCamera
  125911. */
  125912. getClassName(): string;
  125913. }
  125914. }
  125915. declare module BABYLON {
  125916. /**
  125917. * This represents a free type of camera. It can be useful in First Person Shooter game for instance.
  125918. * It is identical to the Free Camera and simply adds by default a virtual joystick.
  125919. * Virtual Joysticks are on-screen 2D graphics that are used to control the camera or other scene items.
  125920. * @see https://doc.babylonjs.com/features/cameras#virtual-joysticks-camera
  125921. */
  125922. export class VirtualJoysticksCamera extends FreeCamera {
  125923. /**
  125924. * Intantiates a VirtualJoysticksCamera. It can be useful in First Person Shooter game for instance.
  125925. * It is identical to the Free Camera and simply adds by default a virtual joystick.
  125926. * Virtual Joysticks are on-screen 2D graphics that are used to control the camera or other scene items.
  125927. * @see https://doc.babylonjs.com/features/cameras#virtual-joysticks-camera
  125928. * @param name Define the name of the camera in the scene
  125929. * @param position Define the start position of the camera in the scene
  125930. * @param scene Define the scene the camera belongs to
  125931. */
  125932. constructor(name: string, position: Vector3, scene: Scene);
  125933. /**
  125934. * Gets the current object class name.
  125935. * @return the class name
  125936. */
  125937. getClassName(): string;
  125938. }
  125939. }
  125940. declare module BABYLON {
  125941. /**
  125942. * This represents all the required metrics to create a VR camera.
  125943. * @see https://doc.babylonjs.com/babylon101/cameras#device-orientation-camera
  125944. */
  125945. export class VRCameraMetrics {
  125946. /**
  125947. * Define the horizontal resolution off the screen.
  125948. */
  125949. hResolution: number;
  125950. /**
  125951. * Define the vertical resolution off the screen.
  125952. */
  125953. vResolution: number;
  125954. /**
  125955. * Define the horizontal screen size.
  125956. */
  125957. hScreenSize: number;
  125958. /**
  125959. * Define the vertical screen size.
  125960. */
  125961. vScreenSize: number;
  125962. /**
  125963. * Define the vertical screen center position.
  125964. */
  125965. vScreenCenter: number;
  125966. /**
  125967. * Define the distance of the eyes to the screen.
  125968. */
  125969. eyeToScreenDistance: number;
  125970. /**
  125971. * Define the distance between both lenses
  125972. */
  125973. lensSeparationDistance: number;
  125974. /**
  125975. * Define the distance between both viewer's eyes.
  125976. */
  125977. interpupillaryDistance: number;
  125978. /**
  125979. * Define the distortion factor of the VR postprocess.
  125980. * Please, touch with care.
  125981. */
  125982. distortionK: number[];
  125983. /**
  125984. * Define the chromatic aberration correction factors for the VR post process.
  125985. */
  125986. chromaAbCorrection: number[];
  125987. /**
  125988. * Define the scale factor of the post process.
  125989. * The smaller the better but the slower.
  125990. */
  125991. postProcessScaleFactor: number;
  125992. /**
  125993. * Define an offset for the lens center.
  125994. */
  125995. lensCenterOffset: number;
  125996. /**
  125997. * Define if the current vr camera should compensate the distortion of the lense or not.
  125998. */
  125999. compensateDistortion: boolean;
  126000. /**
  126001. * Defines if multiview should be enabled when rendering (Default: false)
  126002. */
  126003. multiviewEnabled: boolean;
  126004. /**
  126005. * Gets the rendering aspect ratio based on the provided resolutions.
  126006. */
  126007. get aspectRatio(): number;
  126008. /**
  126009. * Gets the aspect ratio based on the FOV, scale factors, and real screen sizes.
  126010. */
  126011. get aspectRatioFov(): number;
  126012. /**
  126013. * @hidden
  126014. */
  126015. get leftHMatrix(): Matrix;
  126016. /**
  126017. * @hidden
  126018. */
  126019. get rightHMatrix(): Matrix;
  126020. /**
  126021. * @hidden
  126022. */
  126023. get leftPreViewMatrix(): Matrix;
  126024. /**
  126025. * @hidden
  126026. */
  126027. get rightPreViewMatrix(): Matrix;
  126028. /**
  126029. * Get the default VRMetrics based on the most generic setup.
  126030. * @returns the default vr metrics
  126031. */
  126032. static GetDefault(): VRCameraMetrics;
  126033. }
  126034. }
  126035. declare module BABYLON {
  126036. /** @hidden */
  126037. export var vrDistortionCorrectionPixelShader: {
  126038. name: string;
  126039. shader: string;
  126040. };
  126041. }
  126042. declare module BABYLON {
  126043. /**
  126044. * VRDistortionCorrectionPostProcess used for mobile VR
  126045. */
  126046. export class VRDistortionCorrectionPostProcess extends PostProcess {
  126047. private _isRightEye;
  126048. private _distortionFactors;
  126049. private _postProcessScaleFactor;
  126050. private _lensCenterOffset;
  126051. private _scaleIn;
  126052. private _scaleFactor;
  126053. private _lensCenter;
  126054. /**
  126055. * Gets a string identifying the name of the class
  126056. * @returns "VRDistortionCorrectionPostProcess" string
  126057. */
  126058. getClassName(): string;
  126059. /**
  126060. * Initializes the VRDistortionCorrectionPostProcess
  126061. * @param name The name of the effect.
  126062. * @param camera The camera to apply the render pass to.
  126063. * @param isRightEye If this is for the right eye distortion
  126064. * @param vrMetrics All the required metrics for the VR camera
  126065. */
  126066. constructor(name: string, camera: Camera, isRightEye: boolean, vrMetrics: VRCameraMetrics);
  126067. }
  126068. }
  126069. declare module BABYLON {
  126070. /**
  126071. * Camera used to simulate VR rendering (based on ArcRotateCamera)
  126072. * @see https://doc.babylonjs.com/babylon101/cameras#vr-device-orientation-cameras
  126073. */
  126074. export class VRDeviceOrientationArcRotateCamera extends ArcRotateCamera {
  126075. /**
  126076. * Creates a new VRDeviceOrientationArcRotateCamera
  126077. * @param name defines camera name
  126078. * @param alpha defines the camera rotation along the logitudinal axis
  126079. * @param beta defines the camera rotation along the latitudinal axis
  126080. * @param radius defines the camera distance from its target
  126081. * @param target defines the camera target
  126082. * @param scene defines the scene the camera belongs to
  126083. * @param compensateDistortion defines if the camera needs to compensate the lens distorsion
  126084. * @param vrCameraMetrics defines the vr metrics associated to the camera
  126085. */
  126086. constructor(name: string, alpha: number, beta: number, radius: number, target: Vector3, scene: Scene, compensateDistortion?: boolean, vrCameraMetrics?: VRCameraMetrics);
  126087. /**
  126088. * Gets camera class name
  126089. * @returns VRDeviceOrientationArcRotateCamera
  126090. */
  126091. getClassName(): string;
  126092. }
  126093. }
  126094. declare module BABYLON {
  126095. /**
  126096. * Camera used to simulate VR rendering (based on FreeCamera)
  126097. * @see https://doc.babylonjs.com/babylon101/cameras#vr-device-orientation-cameras
  126098. */
  126099. export class VRDeviceOrientationFreeCamera extends DeviceOrientationCamera {
  126100. /**
  126101. * Creates a new VRDeviceOrientationFreeCamera
  126102. * @param name defines camera name
  126103. * @param position defines the start position of the camera
  126104. * @param scene defines the scene the camera belongs to
  126105. * @param compensateDistortion defines if the camera needs to compensate the lens distorsion
  126106. * @param vrCameraMetrics defines the vr metrics associated to the camera
  126107. */
  126108. constructor(name: string, position: Vector3, scene: Scene, compensateDistortion?: boolean, vrCameraMetrics?: VRCameraMetrics);
  126109. /**
  126110. * Gets camera class name
  126111. * @returns VRDeviceOrientationFreeCamera
  126112. */
  126113. getClassName(): string;
  126114. }
  126115. }
  126116. declare module BABYLON {
  126117. /**
  126118. * Camera used to simulate VR rendering (based on VRDeviceOrientationFreeCamera)
  126119. * @see https://doc.babylonjs.com/babylon101/cameras#vr-device-orientation-cameras
  126120. */
  126121. export class VRDeviceOrientationGamepadCamera extends VRDeviceOrientationFreeCamera {
  126122. /**
  126123. * Creates a new VRDeviceOrientationGamepadCamera
  126124. * @param name defines camera name
  126125. * @param position defines the start position of the camera
  126126. * @param scene defines the scene the camera belongs to
  126127. * @param compensateDistortion defines if the camera needs to compensate the lens distorsion
  126128. * @param vrCameraMetrics defines the vr metrics associated to the camera
  126129. */
  126130. constructor(name: string, position: Vector3, scene: Scene, compensateDistortion?: boolean, vrCameraMetrics?: VRCameraMetrics);
  126131. /**
  126132. * Gets camera class name
  126133. * @returns VRDeviceOrientationGamepadCamera
  126134. */
  126135. getClassName(): string;
  126136. }
  126137. }
  126138. declare module BABYLON {
  126139. /**
  126140. * A class extending Texture allowing drawing on a texture
  126141. * @see https://doc.babylonjs.com/how_to/dynamictexture
  126142. */
  126143. export class DynamicTexture extends Texture {
  126144. private _generateMipMaps;
  126145. private _canvas;
  126146. private _context;
  126147. /**
  126148. * Creates a DynamicTexture
  126149. * @param name defines the name of the texture
  126150. * @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
  126151. * @param scene defines the scene where you want the texture
  126152. * @param generateMipMaps defines the use of MinMaps or not (default is false)
  126153. * @param samplingMode defines the sampling mode to use (default is Texture.TRILINEAR_SAMPLINGMODE)
  126154. * @param format defines the texture format to use (default is Engine.TEXTUREFORMAT_RGBA)
  126155. */
  126156. constructor(name: string, options: any, scene: Scene | null | undefined, generateMipMaps: boolean, samplingMode?: number, format?: number);
  126157. /**
  126158. * Get the current class name of the texture useful for serialization or dynamic coding.
  126159. * @returns "DynamicTexture"
  126160. */
  126161. getClassName(): string;
  126162. /**
  126163. * Gets the current state of canRescale
  126164. */
  126165. get canRescale(): boolean;
  126166. private _recreate;
  126167. /**
  126168. * Scales the texture
  126169. * @param ratio the scale factor to apply to both width and height
  126170. */
  126171. scale(ratio: number): void;
  126172. /**
  126173. * Resizes the texture
  126174. * @param width the new width
  126175. * @param height the new height
  126176. */
  126177. scaleTo(width: number, height: number): void;
  126178. /**
  126179. * Gets the context of the canvas used by the texture
  126180. * @returns the canvas context of the dynamic texture
  126181. */
  126182. getContext(): CanvasRenderingContext2D;
  126183. /**
  126184. * Clears the texture
  126185. */
  126186. clear(): void;
  126187. /**
  126188. * Updates the texture
  126189. * @param invertY defines the direction for the Y axis (default is true - y increases downwards)
  126190. * @param premulAlpha defines if alpha is stored as premultiplied (default is false)
  126191. */
  126192. update(invertY?: boolean, premulAlpha?: boolean): void;
  126193. /**
  126194. * Draws text onto the texture
  126195. * @param text defines the text to be drawn
  126196. * @param x defines the placement of the text from the left
  126197. * @param y defines the placement of the text from the top when invertY is true and from the bottom when false
  126198. * @param font defines the font to be used with font-style, font-size, font-name
  126199. * @param color defines the color used for the text
  126200. * @param clearColor defines the color for the canvas, use null to not overwrite canvas
  126201. * @param invertY defines the direction for the Y axis (default is true - y increases downwards)
  126202. * @param update defines whether texture is immediately update (default is true)
  126203. */
  126204. drawText(text: string, x: number | null | undefined, y: number | null | undefined, font: string, color: string | null, clearColor: string, invertY?: boolean, update?: boolean): void;
  126205. /**
  126206. * Clones the texture
  126207. * @returns the clone of the texture.
  126208. */
  126209. clone(): DynamicTexture;
  126210. /**
  126211. * Serializes the dynamic texture. The scene should be ready before the dynamic texture is serialized
  126212. * @returns a serialized dynamic texture object
  126213. */
  126214. serialize(): any;
  126215. private _IsCanvasElement;
  126216. /** @hidden */
  126217. _rebuild(): void;
  126218. }
  126219. }
  126220. declare module BABYLON {
  126221. /**
  126222. * Class containing static functions to help procedurally build meshes
  126223. */
  126224. export class GroundBuilder {
  126225. /**
  126226. * Creates a ground mesh
  126227. * * The parameters `width` and `height` (floats, default 1) set the width and height sizes of the ground
  126228. * * The parameter `subdivisions` (positive integer) sets the number of subdivisions per side
  126229. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  126230. * @param name defines the name of the mesh
  126231. * @param options defines the options used to create the mesh
  126232. * @param scene defines the hosting scene
  126233. * @returns the ground mesh
  126234. * @see https://doc.babylonjs.com/how_to/set_shapes#ground
  126235. */
  126236. static CreateGround(name: string, options: {
  126237. width?: number;
  126238. height?: number;
  126239. subdivisions?: number;
  126240. subdivisionsX?: number;
  126241. subdivisionsY?: number;
  126242. updatable?: boolean;
  126243. }, scene: any): Mesh;
  126244. /**
  126245. * Creates a tiled ground mesh
  126246. * * The parameters `xmin` and `xmax` (floats, default -1 and 1) set the ground minimum and maximum X coordinates
  126247. * * The parameters `zmin` and `zmax` (floats, default -1 and 1) set the ground minimum and maximum Z coordinates
  126248. * * 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
  126249. * * 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
  126250. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created.
  126251. * @param name defines the name of the mesh
  126252. * @param options defines the options used to create the mesh
  126253. * @param scene defines the hosting scene
  126254. * @returns the tiled ground mesh
  126255. * @see https://doc.babylonjs.com/how_to/set_shapes#tiled-ground
  126256. */
  126257. static CreateTiledGround(name: string, options: {
  126258. xmin: number;
  126259. zmin: number;
  126260. xmax: number;
  126261. zmax: number;
  126262. subdivisions?: {
  126263. w: number;
  126264. h: number;
  126265. };
  126266. precision?: {
  126267. w: number;
  126268. h: number;
  126269. };
  126270. updatable?: boolean;
  126271. }, scene?: Nullable<Scene>): Mesh;
  126272. /**
  126273. * Creates a ground mesh from a height map
  126274. * * The parameter `url` sets the URL of the height map image resource.
  126275. * * The parameters `width` and `height` (positive floats, default 10) set the ground width and height sizes.
  126276. * * The parameter `subdivisions` (positive integer, default 1) sets the number of subdivision per side.
  126277. * * The parameter `minHeight` (float, default 0) is the minimum altitude on the ground.
  126278. * * The parameter `maxHeight` (float, default 1) is the maximum altitude on the ground.
  126279. * * 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.
  126280. * * 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).
  126281. * * The parameter `alphaFilter` will filter any data where the alpha channel is below this value, defaults 0 (all data visible)
  126282. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created.
  126283. * @param name defines the name of the mesh
  126284. * @param url defines the url to the height map
  126285. * @param options defines the options used to create the mesh
  126286. * @param scene defines the hosting scene
  126287. * @returns the ground mesh
  126288. * @see https://doc.babylonjs.com/babylon101/height_map
  126289. * @see https://doc.babylonjs.com/how_to/set_shapes#ground-from-a-height-map
  126290. */
  126291. static CreateGroundFromHeightMap(name: string, url: string, options: {
  126292. width?: number;
  126293. height?: number;
  126294. subdivisions?: number;
  126295. minHeight?: number;
  126296. maxHeight?: number;
  126297. colorFilter?: Color3;
  126298. alphaFilter?: number;
  126299. updatable?: boolean;
  126300. onReady?: (mesh: GroundMesh) => void;
  126301. }, scene?: Nullable<Scene>): GroundMesh;
  126302. }
  126303. }
  126304. declare module BABYLON {
  126305. /**
  126306. * Class containing static functions to help procedurally build meshes
  126307. */
  126308. export class TorusBuilder {
  126309. /**
  126310. * Creates a torus mesh
  126311. * * The parameter `diameter` sets the diameter size (float) of the torus (default 1)
  126312. * * The parameter `thickness` sets the diameter size of the tube of the torus (float, default 0.5)
  126313. * * The parameter `tessellation` sets the number of torus sides (postive integer, default 16)
  126314. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  126315. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  126316. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created.
  126317. * @param name defines the name of the mesh
  126318. * @param options defines the options used to create the mesh
  126319. * @param scene defines the hosting scene
  126320. * @returns the torus mesh
  126321. * @see https://doc.babylonjs.com/how_to/set_shapes#torus
  126322. */
  126323. static CreateTorus(name: string, options: {
  126324. diameter?: number;
  126325. thickness?: number;
  126326. tessellation?: number;
  126327. updatable?: boolean;
  126328. sideOrientation?: number;
  126329. frontUVs?: Vector4;
  126330. backUVs?: Vector4;
  126331. }, scene: any): Mesh;
  126332. }
  126333. }
  126334. declare module BABYLON {
  126335. /**
  126336. * Class containing static functions to help procedurally build meshes
  126337. */
  126338. export class CylinderBuilder {
  126339. /**
  126340. * Creates a cylinder or a cone mesh
  126341. * * The parameter `height` sets the height size (float) of the cylinder/cone (float, default 2).
  126342. * * The parameter `diameter` sets the diameter of the top and bottom cap at once (float, default 1).
  126343. * * 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.
  126344. * * The parameter `tessellation` sets the number of cylinder sides (positive integer, default 24). Set it to 3 to get a prism for instance.
  126345. * * The parameter `subdivisions` sets the number of rings along the cylinder height (positive integer, default 1).
  126346. * * The parameter `hasRings` (boolean, default false) makes the subdivisions independent from each other, so they become different faces.
  126347. * * The parameter `enclose` (boolean, default false) adds two extra faces per subdivision to a sliced cylinder to close it around its height axis.
  126348. * * 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).
  126349. * * The parameter `arc` (float, default 1) is the ratio (max 1) to apply to the circumference to slice the cylinder.
  126350. * * 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).
  126351. * * 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
  126352. * * Now, if the cylinder has 5 independent subdivisions (hasRings = true), n equals : top face + 5 stripe surfaces + bottom face = 2 + 5 = 7
  126353. * * 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
  126354. * * 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.
  126355. * * If `enclose` is false, a ring surface is one element.
  126356. * * If `enclose` is true, a ring surface is 3 successive elements in the array : the tubular surface, then the two closing faces.
  126357. * * 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
  126358. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  126359. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  126360. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created.
  126361. * @param name defines the name of the mesh
  126362. * @param options defines the options used to create the mesh
  126363. * @param scene defines the hosting scene
  126364. * @returns the cylinder mesh
  126365. * @see https://doc.babylonjs.com/how_to/set_shapes#cylinder-or-cone
  126366. */
  126367. static CreateCylinder(name: string, options: {
  126368. height?: number;
  126369. diameterTop?: number;
  126370. diameterBottom?: number;
  126371. diameter?: number;
  126372. tessellation?: number;
  126373. subdivisions?: number;
  126374. arc?: number;
  126375. faceColors?: Color4[];
  126376. faceUV?: Vector4[];
  126377. updatable?: boolean;
  126378. hasRings?: boolean;
  126379. enclose?: boolean;
  126380. cap?: number;
  126381. sideOrientation?: number;
  126382. frontUVs?: Vector4;
  126383. backUVs?: Vector4;
  126384. }, scene: any): Mesh;
  126385. }
  126386. }
  126387. declare module BABYLON {
  126388. /**
  126389. * States of the webXR experience
  126390. */
  126391. export enum WebXRState {
  126392. /**
  126393. * Transitioning to being in XR mode
  126394. */
  126395. ENTERING_XR = 0,
  126396. /**
  126397. * Transitioning to non XR mode
  126398. */
  126399. EXITING_XR = 1,
  126400. /**
  126401. * In XR mode and presenting
  126402. */
  126403. IN_XR = 2,
  126404. /**
  126405. * Not entered XR mode
  126406. */
  126407. NOT_IN_XR = 3
  126408. }
  126409. /**
  126410. * Abstraction of the XR render target
  126411. */
  126412. export interface WebXRRenderTarget extends IDisposable {
  126413. /**
  126414. * xrpresent context of the canvas which can be used to display/mirror xr content
  126415. */
  126416. canvasContext: WebGLRenderingContext;
  126417. /**
  126418. * xr layer for the canvas
  126419. */
  126420. xrLayer: Nullable<XRWebGLLayer>;
  126421. /**
  126422. * Initializes the xr layer for the session
  126423. * @param xrSession xr session
  126424. * @returns a promise that will resolve once the XR Layer has been created
  126425. */
  126426. initializeXRLayerAsync(xrSession: XRSession): Promise<XRWebGLLayer>;
  126427. }
  126428. }
  126429. declare module BABYLON {
  126430. /**
  126431. * COnfiguration object for WebXR output canvas
  126432. */
  126433. export class WebXRManagedOutputCanvasOptions {
  126434. /**
  126435. * An optional canvas in case you wish to create it yourself and provide it here.
  126436. * If not provided, a new canvas will be created
  126437. */
  126438. canvasElement?: HTMLCanvasElement;
  126439. /**
  126440. * Options for this XR Layer output
  126441. */
  126442. canvasOptions?: XRWebGLLayerOptions;
  126443. /**
  126444. * CSS styling for a newly created canvas (if not provided)
  126445. */
  126446. newCanvasCssStyle?: string;
  126447. /**
  126448. * Get the default values of the configuration object
  126449. * @param engine defines the engine to use (can be null)
  126450. * @returns default values of this configuration object
  126451. */
  126452. static GetDefaults(engine?: ThinEngine): WebXRManagedOutputCanvasOptions;
  126453. }
  126454. /**
  126455. * Creates a canvas that is added/removed from the webpage when entering/exiting XR
  126456. */
  126457. export class WebXRManagedOutputCanvas implements WebXRRenderTarget {
  126458. private _options;
  126459. private _canvas;
  126460. private _engine;
  126461. private _originalCanvasSize;
  126462. /**
  126463. * Rendering context of the canvas which can be used to display/mirror xr content
  126464. */
  126465. canvasContext: WebGLRenderingContext;
  126466. /**
  126467. * xr layer for the canvas
  126468. */
  126469. xrLayer: Nullable<XRWebGLLayer>;
  126470. /**
  126471. * Obseervers registered here will be triggered when the xr layer was initialized
  126472. */
  126473. onXRLayerInitObservable: Observable<XRWebGLLayer>;
  126474. /**
  126475. * Initializes the canvas to be added/removed upon entering/exiting xr
  126476. * @param _xrSessionManager The XR Session manager
  126477. * @param _options optional configuration for this canvas output. defaults will be used if not provided
  126478. */
  126479. constructor(_xrSessionManager: WebXRSessionManager, _options?: WebXRManagedOutputCanvasOptions);
  126480. /**
  126481. * Disposes of the object
  126482. */
  126483. dispose(): void;
  126484. /**
  126485. * Initializes the xr layer for the session
  126486. * @param xrSession xr session
  126487. * @returns a promise that will resolve once the XR Layer has been created
  126488. */
  126489. initializeXRLayerAsync(xrSession: XRSession): Promise<XRWebGLLayer>;
  126490. private _addCanvas;
  126491. private _removeCanvas;
  126492. private _setCanvasSize;
  126493. private _setManagedOutputCanvas;
  126494. }
  126495. }
  126496. declare module BABYLON {
  126497. /**
  126498. * Manages an XRSession to work with Babylon's engine
  126499. * @see https://doc.babylonjs.com/how_to/webxr_session_manager
  126500. */
  126501. export class WebXRSessionManager implements IDisposable {
  126502. /** The scene which the session should be created for */
  126503. scene: Scene;
  126504. private _referenceSpace;
  126505. private _rttProvider;
  126506. private _sessionEnded;
  126507. private _xrNavigator;
  126508. private baseLayer;
  126509. /**
  126510. * The base reference space from which the session started. good if you want to reset your
  126511. * reference space
  126512. */
  126513. baseReferenceSpace: XRReferenceSpace;
  126514. /**
  126515. * Current XR frame
  126516. */
  126517. currentFrame: Nullable<XRFrame>;
  126518. /** WebXR timestamp updated every frame */
  126519. currentTimestamp: number;
  126520. /**
  126521. * Used just in case of a failure to initialize an immersive session.
  126522. * The viewer reference space is compensated using this height, creating a kind of "viewer-floor" reference space
  126523. */
  126524. defaultHeightCompensation: number;
  126525. /**
  126526. * Fires every time a new xrFrame arrives which can be used to update the camera
  126527. */
  126528. onXRFrameObservable: Observable<XRFrame>;
  126529. /**
  126530. * Fires when the reference space changed
  126531. */
  126532. onXRReferenceSpaceChanged: Observable<XRReferenceSpace>;
  126533. /**
  126534. * Fires when the xr session is ended either by the device or manually done
  126535. */
  126536. onXRSessionEnded: Observable<any>;
  126537. /**
  126538. * Fires when the xr session is ended either by the device or manually done
  126539. */
  126540. onXRSessionInit: Observable<XRSession>;
  126541. /**
  126542. * Underlying xr session
  126543. */
  126544. session: XRSession;
  126545. /**
  126546. * The viewer (head position) reference space. This can be used to get the XR world coordinates
  126547. * or get the offset the player is currently at.
  126548. */
  126549. viewerReferenceSpace: XRReferenceSpace;
  126550. /**
  126551. * Constructs a WebXRSessionManager, this must be initialized within a user action before usage
  126552. * @param scene The scene which the session should be created for
  126553. */
  126554. constructor(
  126555. /** The scene which the session should be created for */
  126556. scene: Scene);
  126557. /**
  126558. * The current reference space used in this session. This reference space can constantly change!
  126559. * It is mainly used to offset the camera's position.
  126560. */
  126561. get referenceSpace(): XRReferenceSpace;
  126562. /**
  126563. * Set a new reference space and triggers the observable
  126564. */
  126565. set referenceSpace(newReferenceSpace: XRReferenceSpace);
  126566. /**
  126567. * Disposes of the session manager
  126568. */
  126569. dispose(): void;
  126570. /**
  126571. * Stops the xrSession and restores the render loop
  126572. * @returns Promise which resolves after it exits XR
  126573. */
  126574. exitXRAsync(): Promise<void>;
  126575. /**
  126576. * Gets the correct render target texture to be rendered this frame for this eye
  126577. * @param eye the eye for which to get the render target
  126578. * @returns the render target for the specified eye
  126579. */
  126580. getRenderTargetTextureForEye(eye: XREye): RenderTargetTexture;
  126581. /**
  126582. * Creates a WebXRRenderTarget object for the XR session
  126583. * @param onStateChangedObservable optional, mechanism for enabling/disabling XR rendering canvas, used only on Web
  126584. * @param options optional options to provide when creating a new render target
  126585. * @returns a WebXR render target to which the session can render
  126586. */
  126587. getWebXRRenderTarget(options?: WebXRManagedOutputCanvasOptions): WebXRRenderTarget;
  126588. /**
  126589. * Initializes the manager
  126590. * After initialization enterXR can be called to start an XR session
  126591. * @returns Promise which resolves after it is initialized
  126592. */
  126593. initializeAsync(): Promise<void>;
  126594. /**
  126595. * Initializes an xr session
  126596. * @param xrSessionMode mode to initialize
  126597. * @param xrSessionInit defines optional and required values to pass to the session builder
  126598. * @returns a promise which will resolve once the session has been initialized
  126599. */
  126600. initializeSessionAsync(xrSessionMode?: XRSessionMode, xrSessionInit?: XRSessionInit): Promise<XRSession>;
  126601. /**
  126602. * Checks if a session would be supported for the creation options specified
  126603. * @param sessionMode session mode to check if supported eg. immersive-vr
  126604. * @returns A Promise that resolves to true if supported and false if not
  126605. */
  126606. isSessionSupportedAsync(sessionMode: XRSessionMode): Promise<boolean>;
  126607. /**
  126608. * Resets the reference space to the one started the session
  126609. */
  126610. resetReferenceSpace(): void;
  126611. /**
  126612. * Starts rendering to the xr layer
  126613. */
  126614. runXRRenderLoop(): void;
  126615. /**
  126616. * Sets the reference space on the xr session
  126617. * @param referenceSpaceType space to set
  126618. * @returns a promise that will resolve once the reference space has been set
  126619. */
  126620. setReferenceSpaceTypeAsync(referenceSpaceType?: XRReferenceSpaceType): Promise<XRReferenceSpace>;
  126621. /**
  126622. * Updates the render state of the session
  126623. * @param state state to set
  126624. * @returns a promise that resolves once the render state has been updated
  126625. */
  126626. updateRenderStateAsync(state: XRRenderState): Promise<void>;
  126627. /**
  126628. * Returns a promise that resolves with a boolean indicating if the provided session mode is supported by this browser
  126629. * @param sessionMode defines the session to test
  126630. * @returns a promise with boolean as final value
  126631. */
  126632. static IsSessionSupportedAsync(sessionMode: XRSessionMode): Promise<boolean>;
  126633. private _createRenderTargetTexture;
  126634. }
  126635. }
  126636. declare module BABYLON {
  126637. /**
  126638. * WebXR Camera which holds the views for the xrSession
  126639. * @see https://doc.babylonjs.com/how_to/webxr_camera
  126640. */
  126641. export class WebXRCamera extends FreeCamera {
  126642. private _xrSessionManager;
  126643. private _firstFrame;
  126644. private _referenceQuaternion;
  126645. private _referencedPosition;
  126646. private _xrInvPositionCache;
  126647. private _xrInvQuaternionCache;
  126648. /**
  126649. * Observable raised before camera teleportation
  126650. */
  126651. onBeforeCameraTeleport: Observable<Vector3>;
  126652. /**
  126653. * Observable raised after camera teleportation
  126654. */
  126655. onAfterCameraTeleport: Observable<Vector3>;
  126656. /**
  126657. * Should position compensation execute on first frame.
  126658. * This is used when copying the position from a native (non XR) camera
  126659. */
  126660. compensateOnFirstFrame: boolean;
  126661. /**
  126662. * Creates a new webXRCamera, this should only be set at the camera after it has been updated by the xrSessionManager
  126663. * @param name the name of the camera
  126664. * @param scene the scene to add the camera to
  126665. * @param _xrSessionManager a constructed xr session manager
  126666. */
  126667. constructor(name: string, scene: Scene, _xrSessionManager: WebXRSessionManager);
  126668. /**
  126669. * Return the user's height, unrelated to the current ground.
  126670. * This will be the y position of this camera, when ground level is 0.
  126671. */
  126672. get realWorldHeight(): number;
  126673. /** @hidden */
  126674. _updateForDualEyeDebugging(): void;
  126675. /**
  126676. * Sets this camera's transformation based on a non-vr camera
  126677. * @param otherCamera the non-vr camera to copy the transformation from
  126678. * @param resetToBaseReferenceSpace should XR reset to the base reference space
  126679. */
  126680. setTransformationFromNonVRCamera(otherCamera?: Camera, resetToBaseReferenceSpace?: boolean): void;
  126681. /**
  126682. * Gets the current instance class name ("WebXRCamera").
  126683. * @returns the class name
  126684. */
  126685. getClassName(): string;
  126686. private _rotate180;
  126687. private _updateFromXRSession;
  126688. private _updateNumberOfRigCameras;
  126689. private _updateReferenceSpace;
  126690. private _updateReferenceSpaceOffset;
  126691. }
  126692. }
  126693. declare module BABYLON {
  126694. /**
  126695. * Defining the interface required for a (webxr) feature
  126696. */
  126697. export interface IWebXRFeature extends IDisposable {
  126698. /**
  126699. * Is this feature attached
  126700. */
  126701. attached: boolean;
  126702. /**
  126703. * Should auto-attach be disabled?
  126704. */
  126705. disableAutoAttach: boolean;
  126706. /**
  126707. * Attach the feature to the session
  126708. * Will usually be called by the features manager
  126709. *
  126710. * @param force should attachment be forced (even when already attached)
  126711. * @returns true if successful.
  126712. */
  126713. attach(force?: boolean): boolean;
  126714. /**
  126715. * Detach the feature from the session
  126716. * Will usually be called by the features manager
  126717. *
  126718. * @returns true if successful.
  126719. */
  126720. detach(): boolean;
  126721. /**
  126722. * This function will be executed during before enabling the feature and can be used to not-allow enabling it.
  126723. * Note that at this point the session has NOT started, so this is purely checking if the browser supports it
  126724. *
  126725. * @returns whether or not the feature is compatible in this environment
  126726. */
  126727. isCompatible(): boolean;
  126728. /**
  126729. * The name of the native xr feature name, if applicable (like anchor, hit-test, or hand-tracking)
  126730. */
  126731. xrNativeFeatureName?: string;
  126732. /**
  126733. * A list of (Babylon WebXR) features this feature depends on
  126734. */
  126735. dependsOn?: string[];
  126736. }
  126737. /**
  126738. * A list of the currently available features without referencing them
  126739. */
  126740. export class WebXRFeatureName {
  126741. /**
  126742. * The name of the anchor system feature
  126743. */
  126744. static readonly ANCHOR_SYSTEM: string;
  126745. /**
  126746. * The name of the background remover feature
  126747. */
  126748. static readonly BACKGROUND_REMOVER: string;
  126749. /**
  126750. * The name of the hit test feature
  126751. */
  126752. static readonly HIT_TEST: string;
  126753. /**
  126754. * physics impostors for xr controllers feature
  126755. */
  126756. static readonly PHYSICS_CONTROLLERS: string;
  126757. /**
  126758. * The name of the plane detection feature
  126759. */
  126760. static readonly PLANE_DETECTION: string;
  126761. /**
  126762. * The name of the pointer selection feature
  126763. */
  126764. static readonly POINTER_SELECTION: string;
  126765. /**
  126766. * The name of the teleportation feature
  126767. */
  126768. static readonly TELEPORTATION: string;
  126769. /**
  126770. * The name of the feature points feature.
  126771. */
  126772. static readonly FEATURE_POINTS: string;
  126773. /**
  126774. * The name of the hand tracking feature.
  126775. */
  126776. static readonly HAND_TRACKING: string;
  126777. }
  126778. /**
  126779. * Defining the constructor of a feature. Used to register the modules.
  126780. */
  126781. export type WebXRFeatureConstructor = (xrSessionManager: WebXRSessionManager, options?: any) => () => IWebXRFeature;
  126782. /**
  126783. * The WebXR features manager is responsible of enabling or disabling features required for the current XR session.
  126784. * It is mainly used in AR sessions.
  126785. *
  126786. * A feature can have a version that is defined by Babylon (and does not correspond with the webxr version).
  126787. */
  126788. export class WebXRFeaturesManager implements IDisposable {
  126789. private _xrSessionManager;
  126790. private static readonly _AvailableFeatures;
  126791. private _features;
  126792. /**
  126793. * constructs a new features manages.
  126794. *
  126795. * @param _xrSessionManager an instance of WebXRSessionManager
  126796. */
  126797. constructor(_xrSessionManager: WebXRSessionManager);
  126798. /**
  126799. * Used to register a module. After calling this function a developer can use this feature in the scene.
  126800. * Mainly used internally.
  126801. *
  126802. * @param featureName the name of the feature to register
  126803. * @param constructorFunction the function used to construct the module
  126804. * @param version the (babylon) version of the module
  126805. * @param stable is that a stable version of this module
  126806. */
  126807. static AddWebXRFeature(featureName: string, constructorFunction: WebXRFeatureConstructor, version?: number, stable?: boolean): void;
  126808. /**
  126809. * Returns a constructor of a specific feature.
  126810. *
  126811. * @param featureName the name of the feature to construct
  126812. * @param version the version of the feature to load
  126813. * @param xrSessionManager the xrSessionManager. Used to construct the module
  126814. * @param options optional options provided to the module.
  126815. * @returns a function that, when called, will return a new instance of this feature
  126816. */
  126817. static ConstructFeature(featureName: string, version: number | undefined, xrSessionManager: WebXRSessionManager, options?: any): () => IWebXRFeature;
  126818. /**
  126819. * Can be used to return the list of features currently registered
  126820. *
  126821. * @returns an Array of available features
  126822. */
  126823. static GetAvailableFeatures(): string[];
  126824. /**
  126825. * Gets the versions available for a specific feature
  126826. * @param featureName the name of the feature
  126827. * @returns an array with the available versions
  126828. */
  126829. static GetAvailableVersions(featureName: string): string[];
  126830. /**
  126831. * Return the latest unstable version of this feature
  126832. * @param featureName the name of the feature to search
  126833. * @returns the version number. if not found will return -1
  126834. */
  126835. static GetLatestVersionOfFeature(featureName: string): number;
  126836. /**
  126837. * Return the latest stable version of this feature
  126838. * @param featureName the name of the feature to search
  126839. * @returns the version number. if not found will return -1
  126840. */
  126841. static GetStableVersionOfFeature(featureName: string): number;
  126842. /**
  126843. * Attach a feature to the current session. Mainly used when session started to start the feature effect.
  126844. * Can be used during a session to start a feature
  126845. * @param featureName the name of feature to attach
  126846. */
  126847. attachFeature(featureName: string): void;
  126848. /**
  126849. * Can be used inside a session or when the session ends to detach a specific feature
  126850. * @param featureName the name of the feature to detach
  126851. */
  126852. detachFeature(featureName: string): void;
  126853. /**
  126854. * Used to disable an already-enabled feature
  126855. * The feature will be disposed and will be recreated once enabled.
  126856. * @param featureName the feature to disable
  126857. * @returns true if disable was successful
  126858. */
  126859. disableFeature(featureName: string | {
  126860. Name: string;
  126861. }): boolean;
  126862. /**
  126863. * dispose this features manager
  126864. */
  126865. dispose(): void;
  126866. /**
  126867. * 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.
  126868. * 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.
  126869. *
  126870. * @param featureName the name of the feature to load or the class of the feature
  126871. * @param version optional version to load. if not provided the latest version will be enabled
  126872. * @param moduleOptions options provided to the module. Ses the module documentation / constructor
  126873. * @param attachIfPossible if set to true (default) the feature will be automatically attached, if it is currently possible
  126874. * @param required is this feature required to the app. If set to true the session init will fail if the feature is not available.
  126875. * @returns a new constructed feature or throws an error if feature not found.
  126876. */
  126877. enableFeature(featureName: string | {
  126878. Name: string;
  126879. }, version?: number | string, moduleOptions?: any, attachIfPossible?: boolean, required?: boolean): IWebXRFeature;
  126880. /**
  126881. * get the implementation of an enabled feature.
  126882. * @param featureName the name of the feature to load
  126883. * @returns the feature class, if found
  126884. */
  126885. getEnabledFeature(featureName: string): IWebXRFeature;
  126886. /**
  126887. * Get the list of enabled features
  126888. * @returns an array of enabled features
  126889. */
  126890. getEnabledFeatures(): string[];
  126891. /**
  126892. * This function will exten the session creation configuration object with enabled features.
  126893. * If, for example, the anchors feature is enabled, it will be automatically added to the optional or required features list,
  126894. * according to the defined "required" variable, provided during enableFeature call
  126895. * @param xrSessionInit the xr Session init object to extend
  126896. *
  126897. * @returns an extended XRSessionInit object
  126898. */
  126899. extendXRSessionInitObject(xrSessionInit: XRSessionInit): XRSessionInit;
  126900. }
  126901. }
  126902. declare module BABYLON {
  126903. /**
  126904. * Base set of functionality needed to create an XR experience (WebXRSessionManager, Camera, StateManagement, etc.)
  126905. * @see https://doc.babylonjs.com/how_to/webxr_experience_helpers
  126906. */
  126907. export class WebXRExperienceHelper implements IDisposable {
  126908. private scene;
  126909. private _nonVRCamera;
  126910. private _originalSceneAutoClear;
  126911. private _supported;
  126912. /**
  126913. * Camera used to render xr content
  126914. */
  126915. camera: WebXRCamera;
  126916. /** A features manager for this xr session */
  126917. featuresManager: WebXRFeaturesManager;
  126918. /**
  126919. * Observers registered here will be triggered after the camera's initial transformation is set
  126920. * This can be used to set a different ground level or an extra rotation.
  126921. *
  126922. * Note that ground level is considered to be at 0. The height defined by the XR camera will be added
  126923. * to the position set after this observable is done executing.
  126924. */
  126925. onInitialXRPoseSetObservable: Observable<WebXRCamera>;
  126926. /**
  126927. * Fires when the state of the experience helper has changed
  126928. */
  126929. onStateChangedObservable: Observable<WebXRState>;
  126930. /** Session manager used to keep track of xr session */
  126931. sessionManager: WebXRSessionManager;
  126932. /**
  126933. * The current state of the XR experience (eg. transitioning, in XR or not in XR)
  126934. */
  126935. state: WebXRState;
  126936. /**
  126937. * Creates a WebXRExperienceHelper
  126938. * @param scene The scene the helper should be created in
  126939. */
  126940. private constructor();
  126941. /**
  126942. * Creates the experience helper
  126943. * @param scene the scene to attach the experience helper to
  126944. * @returns a promise for the experience helper
  126945. */
  126946. static CreateAsync(scene: Scene): Promise<WebXRExperienceHelper>;
  126947. /**
  126948. * Disposes of the experience helper
  126949. */
  126950. dispose(): void;
  126951. /**
  126952. * Enters XR mode (This must be done within a user interaction in most browsers eg. button click)
  126953. * @param sessionMode options for the XR session
  126954. * @param referenceSpaceType frame of reference of the XR session
  126955. * @param renderTarget the output canvas that will be used to enter XR mode
  126956. * @param sessionCreationOptions optional XRSessionInit object to init the session with
  126957. * @returns promise that resolves after xr mode has entered
  126958. */
  126959. enterXRAsync(sessionMode: XRSessionMode, referenceSpaceType: XRReferenceSpaceType, renderTarget?: WebXRRenderTarget, sessionCreationOptions?: XRSessionInit): Promise<WebXRSessionManager>;
  126960. /**
  126961. * Exits XR mode and returns the scene to its original state
  126962. * @returns promise that resolves after xr mode has exited
  126963. */
  126964. exitXRAsync(): Promise<void>;
  126965. private _nonXRToXRCamera;
  126966. private _setState;
  126967. }
  126968. }
  126969. declare module BABYLON {
  126970. /**
  126971. * X-Y values for axes in WebXR
  126972. */
  126973. export interface IWebXRMotionControllerAxesValue {
  126974. /**
  126975. * The value of the x axis
  126976. */
  126977. x: number;
  126978. /**
  126979. * The value of the y-axis
  126980. */
  126981. y: number;
  126982. }
  126983. /**
  126984. * changed / previous values for the values of this component
  126985. */
  126986. export interface IWebXRMotionControllerComponentChangesValues<T> {
  126987. /**
  126988. * current (this frame) value
  126989. */
  126990. current: T;
  126991. /**
  126992. * previous (last change) value
  126993. */
  126994. previous: T;
  126995. }
  126996. /**
  126997. * Represents changes in the component between current frame and last values recorded
  126998. */
  126999. export interface IWebXRMotionControllerComponentChanges {
  127000. /**
  127001. * will be populated with previous and current values if axes changed
  127002. */
  127003. axes?: IWebXRMotionControllerComponentChangesValues<IWebXRMotionControllerAxesValue>;
  127004. /**
  127005. * will be populated with previous and current values if pressed changed
  127006. */
  127007. pressed?: IWebXRMotionControllerComponentChangesValues<boolean>;
  127008. /**
  127009. * will be populated with previous and current values if touched changed
  127010. */
  127011. touched?: IWebXRMotionControllerComponentChangesValues<boolean>;
  127012. /**
  127013. * will be populated with previous and current values if value changed
  127014. */
  127015. value?: IWebXRMotionControllerComponentChangesValues<number>;
  127016. }
  127017. /**
  127018. * This class represents a single component (for example button or thumbstick) of a motion controller
  127019. */
  127020. export class WebXRControllerComponent implements IDisposable {
  127021. /**
  127022. * the id of this component
  127023. */
  127024. id: string;
  127025. /**
  127026. * the type of the component
  127027. */
  127028. type: MotionControllerComponentType;
  127029. private _buttonIndex;
  127030. private _axesIndices;
  127031. private _axes;
  127032. private _changes;
  127033. private _currentValue;
  127034. private _hasChanges;
  127035. private _pressed;
  127036. private _touched;
  127037. /**
  127038. * button component type
  127039. */
  127040. static BUTTON_TYPE: MotionControllerComponentType;
  127041. /**
  127042. * squeeze component type
  127043. */
  127044. static SQUEEZE_TYPE: MotionControllerComponentType;
  127045. /**
  127046. * Thumbstick component type
  127047. */
  127048. static THUMBSTICK_TYPE: MotionControllerComponentType;
  127049. /**
  127050. * Touchpad component type
  127051. */
  127052. static TOUCHPAD_TYPE: MotionControllerComponentType;
  127053. /**
  127054. * trigger component type
  127055. */
  127056. static TRIGGER_TYPE: MotionControllerComponentType;
  127057. /**
  127058. * If axes are available for this component (like a touchpad or thumbstick) the observers will be notified when
  127059. * the axes data changes
  127060. */
  127061. onAxisValueChangedObservable: Observable<{
  127062. x: number;
  127063. y: number;
  127064. }>;
  127065. /**
  127066. * Observers registered here will be triggered when the state of a button changes
  127067. * State change is either pressed / touched / value
  127068. */
  127069. onButtonStateChangedObservable: Observable<WebXRControllerComponent>;
  127070. /**
  127071. * Creates a new component for a motion controller.
  127072. * It is created by the motion controller itself
  127073. *
  127074. * @param id the id of this component
  127075. * @param type the type of the component
  127076. * @param _buttonIndex index in the buttons array of the gamepad
  127077. * @param _axesIndices indices of the values in the axes array of the gamepad
  127078. */
  127079. constructor(
  127080. /**
  127081. * the id of this component
  127082. */
  127083. id: string,
  127084. /**
  127085. * the type of the component
  127086. */
  127087. type: MotionControllerComponentType, _buttonIndex?: number, _axesIndices?: number[]);
  127088. /**
  127089. * The current axes data. If this component has no axes it will still return an object { x: 0, y: 0 }
  127090. */
  127091. get axes(): IWebXRMotionControllerAxesValue;
  127092. /**
  127093. * Get the changes. Elements will be populated only if they changed with their previous and current value
  127094. */
  127095. get changes(): IWebXRMotionControllerComponentChanges;
  127096. /**
  127097. * Return whether or not the component changed the last frame
  127098. */
  127099. get hasChanges(): boolean;
  127100. /**
  127101. * is the button currently pressed
  127102. */
  127103. get pressed(): boolean;
  127104. /**
  127105. * is the button currently touched
  127106. */
  127107. get touched(): boolean;
  127108. /**
  127109. * Get the current value of this component
  127110. */
  127111. get value(): number;
  127112. /**
  127113. * Dispose this component
  127114. */
  127115. dispose(): void;
  127116. /**
  127117. * Are there axes correlating to this component
  127118. * @return true is axes data is available
  127119. */
  127120. isAxes(): boolean;
  127121. /**
  127122. * Is this component a button (hence - pressable)
  127123. * @returns true if can be pressed
  127124. */
  127125. isButton(): boolean;
  127126. /**
  127127. * update this component using the gamepad object it is in. Called on every frame
  127128. * @param nativeController the native gamepad controller object
  127129. */
  127130. update(nativeController: IMinimalMotionControllerObject): void;
  127131. }
  127132. }
  127133. declare module BABYLON {
  127134. /**
  127135. * Interface used to represent data loading progression
  127136. */
  127137. export interface ISceneLoaderProgressEvent {
  127138. /**
  127139. * Defines if data length to load can be evaluated
  127140. */
  127141. readonly lengthComputable: boolean;
  127142. /**
  127143. * Defines the loaded data length
  127144. */
  127145. readonly loaded: number;
  127146. /**
  127147. * Defines the data length to load
  127148. */
  127149. readonly total: number;
  127150. }
  127151. /**
  127152. * Interface used by SceneLoader plugins to define supported file extensions
  127153. */
  127154. export interface ISceneLoaderPluginExtensions {
  127155. /**
  127156. * Defines the list of supported extensions
  127157. */
  127158. [extension: string]: {
  127159. isBinary: boolean;
  127160. };
  127161. }
  127162. /**
  127163. * Interface used by SceneLoader plugin factory
  127164. */
  127165. export interface ISceneLoaderPluginFactory {
  127166. /**
  127167. * Defines the name of the factory
  127168. */
  127169. name: string;
  127170. /**
  127171. * Function called to create a new plugin
  127172. * @return the new plugin
  127173. */
  127174. createPlugin(): ISceneLoaderPlugin | ISceneLoaderPluginAsync;
  127175. /**
  127176. * The callback that returns true if the data can be directly loaded.
  127177. * @param data string containing the file data
  127178. * @returns if the data can be loaded directly
  127179. */
  127180. canDirectLoad?(data: string): boolean;
  127181. }
  127182. /**
  127183. * Interface used to define the base of ISceneLoaderPlugin and ISceneLoaderPluginAsync
  127184. */
  127185. export interface ISceneLoaderPluginBase {
  127186. /**
  127187. * The friendly name of this plugin.
  127188. */
  127189. name: string;
  127190. /**
  127191. * The file extensions supported by this plugin.
  127192. */
  127193. extensions: string | ISceneLoaderPluginExtensions;
  127194. /**
  127195. * The callback called when loading from a url.
  127196. * @param scene scene loading this url
  127197. * @param url url to load
  127198. * @param onSuccess callback called when the file successfully loads
  127199. * @param onProgress callback called while file is loading (if the server supports this mode)
  127200. * @param useArrayBuffer defines a boolean indicating that date must be returned as ArrayBuffer
  127201. * @param onError callback called when the file fails to load
  127202. * @returns a file request object
  127203. */
  127204. requestFile?(scene: Scene, url: string, onSuccess: (data: any, request?: WebRequest) => void, onProgress?: (ev: ISceneLoaderProgressEvent) => void, useArrayBuffer?: boolean, onError?: (error: any) => void): IFileRequest;
  127205. /**
  127206. * The callback called when loading from a file object.
  127207. * @param scene scene loading this file
  127208. * @param file defines the file to load
  127209. * @param onSuccess defines the callback to call when data is loaded
  127210. * @param onProgress defines the callback to call during loading process
  127211. * @param useArrayBuffer defines a boolean indicating that data must be returned as an ArrayBuffer
  127212. * @param onError defines the callback to call when an error occurs
  127213. * @returns a file request object
  127214. */
  127215. readFile?(scene: Scene, file: File, onSuccess: (data: any) => void, onProgress?: (ev: ISceneLoaderProgressEvent) => any, useArrayBuffer?: boolean, onError?: (error: any) => void): IFileRequest;
  127216. /**
  127217. * The callback that returns true if the data can be directly loaded.
  127218. * @param data string containing the file data
  127219. * @returns if the data can be loaded directly
  127220. */
  127221. canDirectLoad?(data: string): boolean;
  127222. /**
  127223. * The callback that returns the data to pass to the plugin if the data can be directly loaded.
  127224. * @param scene scene loading this data
  127225. * @param data string containing the data
  127226. * @returns data to pass to the plugin
  127227. */
  127228. directLoad?(scene: Scene, data: string): any;
  127229. /**
  127230. * The callback that allows custom handling of the root url based on the response url.
  127231. * @param rootUrl the original root url
  127232. * @param responseURL the response url if available
  127233. * @returns the new root url
  127234. */
  127235. rewriteRootURL?(rootUrl: string, responseURL?: string): string;
  127236. }
  127237. /**
  127238. * Interface used to define a SceneLoader plugin
  127239. */
  127240. export interface ISceneLoaderPlugin extends ISceneLoaderPluginBase {
  127241. /**
  127242. * Import meshes into a scene.
  127243. * @param meshesNames An array of mesh names, a single mesh name, or empty string for all meshes that filter what meshes are imported
  127244. * @param scene The scene to import into
  127245. * @param data The data to import
  127246. * @param rootUrl The root url for scene and resources
  127247. * @param meshes The meshes array to import into
  127248. * @param particleSystems The particle systems array to import into
  127249. * @param skeletons The skeletons array to import into
  127250. * @param onError The callback when import fails
  127251. * @returns True if successful or false otherwise
  127252. */
  127253. importMesh(meshesNames: any, scene: Scene, data: any, rootUrl: string, meshes: AbstractMesh[], particleSystems: IParticleSystem[], skeletons: Skeleton[], onError?: (message: string, exception?: any) => void): boolean;
  127254. /**
  127255. * Load into a scene.
  127256. * @param scene The scene to load into
  127257. * @param data The data to import
  127258. * @param rootUrl The root url for scene and resources
  127259. * @param onError The callback when import fails
  127260. * @returns True if successful or false otherwise
  127261. */
  127262. load(scene: Scene, data: any, rootUrl: string, onError?: (message: string, exception?: any) => void): boolean;
  127263. /**
  127264. * Load into an asset container.
  127265. * @param scene The scene to load into
  127266. * @param data The data to import
  127267. * @param rootUrl The root url for scene and resources
  127268. * @param onError The callback when import fails
  127269. * @returns The loaded asset container
  127270. */
  127271. loadAssetContainer(scene: Scene, data: any, rootUrl: string, onError?: (message: string, exception?: any) => void): AssetContainer;
  127272. }
  127273. /**
  127274. * Interface used to define an async SceneLoader plugin
  127275. */
  127276. export interface ISceneLoaderPluginAsync extends ISceneLoaderPluginBase {
  127277. /**
  127278. * Import meshes into a scene.
  127279. * @param meshesNames An array of mesh names, a single mesh name, or empty string for all meshes that filter what meshes are imported
  127280. * @param scene The scene to import into
  127281. * @param data The data to import
  127282. * @param rootUrl The root url for scene and resources
  127283. * @param onProgress The callback when the load progresses
  127284. * @param fileName Defines the name of the file to load
  127285. * @returns The loaded meshes, particle systems, skeletons, and animation groups
  127286. */
  127287. importMeshAsync(meshesNames: any, scene: Scene, data: any, rootUrl: string, onProgress?: (event: ISceneLoaderProgressEvent) => void, fileName?: string): Promise<{
  127288. meshes: AbstractMesh[];
  127289. particleSystems: IParticleSystem[];
  127290. skeletons: Skeleton[];
  127291. animationGroups: AnimationGroup[];
  127292. }>;
  127293. /**
  127294. * Load into a scene.
  127295. * @param scene The scene to load into
  127296. * @param data The data to import
  127297. * @param rootUrl The root url for scene and resources
  127298. * @param onProgress The callback when the load progresses
  127299. * @param fileName Defines the name of the file to load
  127300. * @returns Nothing
  127301. */
  127302. loadAsync(scene: Scene, data: any, rootUrl: string, onProgress?: (event: ISceneLoaderProgressEvent) => void, fileName?: string): Promise<void>;
  127303. /**
  127304. * Load into an asset container.
  127305. * @param scene The scene to load into
  127306. * @param data The data to import
  127307. * @param rootUrl The root url for scene and resources
  127308. * @param onProgress The callback when the load progresses
  127309. * @param fileName Defines the name of the file to load
  127310. * @returns The loaded asset container
  127311. */
  127312. loadAssetContainerAsync(scene: Scene, data: any, rootUrl: string, onProgress?: (event: ISceneLoaderProgressEvent) => void, fileName?: string): Promise<AssetContainer>;
  127313. }
  127314. /**
  127315. * Mode that determines how to handle old animation groups before loading new ones.
  127316. */
  127317. export enum SceneLoaderAnimationGroupLoadingMode {
  127318. /**
  127319. * Reset all old animations to initial state then dispose them.
  127320. */
  127321. Clean = 0,
  127322. /**
  127323. * Stop all old animations.
  127324. */
  127325. Stop = 1,
  127326. /**
  127327. * Restart old animations from first frame.
  127328. */
  127329. Sync = 2,
  127330. /**
  127331. * Old animations remains untouched.
  127332. */
  127333. NoSync = 3
  127334. }
  127335. /**
  127336. * Defines a plugin registered by the SceneLoader
  127337. */
  127338. interface IRegisteredPlugin {
  127339. /**
  127340. * Defines the plugin to use
  127341. */
  127342. plugin: ISceneLoaderPlugin | ISceneLoaderPluginAsync | ISceneLoaderPluginFactory;
  127343. /**
  127344. * Defines if the plugin supports binary data
  127345. */
  127346. isBinary: boolean;
  127347. }
  127348. /**
  127349. * Class used to load scene from various file formats using registered plugins
  127350. * @see https://doc.babylonjs.com/how_to/load_from_any_file_type
  127351. */
  127352. export class SceneLoader {
  127353. /**
  127354. * No logging while loading
  127355. */
  127356. static readonly NO_LOGGING: number;
  127357. /**
  127358. * Minimal logging while loading
  127359. */
  127360. static readonly MINIMAL_LOGGING: number;
  127361. /**
  127362. * Summary logging while loading
  127363. */
  127364. static readonly SUMMARY_LOGGING: number;
  127365. /**
  127366. * Detailled logging while loading
  127367. */
  127368. static readonly DETAILED_LOGGING: number;
  127369. /**
  127370. * Gets or sets a boolean indicating if entire scene must be loaded even if scene contains incremental data
  127371. */
  127372. static get ForceFullSceneLoadingForIncremental(): boolean;
  127373. static set ForceFullSceneLoadingForIncremental(value: boolean);
  127374. /**
  127375. * Gets or sets a boolean indicating if loading screen must be displayed while loading a scene
  127376. */
  127377. static get ShowLoadingScreen(): boolean;
  127378. static set ShowLoadingScreen(value: boolean);
  127379. /**
  127380. * Defines the current logging level (while loading the scene)
  127381. * @ignorenaming
  127382. */
  127383. static get loggingLevel(): number;
  127384. static set loggingLevel(value: number);
  127385. /**
  127386. * Gets or set a boolean indicating if matrix weights must be cleaned upon loading
  127387. */
  127388. static get CleanBoneMatrixWeights(): boolean;
  127389. static set CleanBoneMatrixWeights(value: boolean);
  127390. /**
  127391. * Event raised when a plugin is used to load a scene
  127392. */
  127393. static OnPluginActivatedObservable: Observable<ISceneLoaderPlugin | ISceneLoaderPluginAsync>;
  127394. private static _registeredPlugins;
  127395. private static _showingLoadingScreen;
  127396. /**
  127397. * Gets the default plugin (used to load Babylon files)
  127398. * @returns the .babylon plugin
  127399. */
  127400. static GetDefaultPlugin(): IRegisteredPlugin;
  127401. private static _GetPluginForExtension;
  127402. private static _GetPluginForDirectLoad;
  127403. private static _GetPluginForFilename;
  127404. private static _GetDirectLoad;
  127405. private static _LoadData;
  127406. private static _GetFileInfo;
  127407. /**
  127408. * Gets a plugin that can load the given extension
  127409. * @param extension defines the extension to load
  127410. * @returns a plugin or null if none works
  127411. */
  127412. static GetPluginForExtension(extension: string): ISceneLoaderPlugin | ISceneLoaderPluginAsync | ISceneLoaderPluginFactory;
  127413. /**
  127414. * Gets a boolean indicating that the given extension can be loaded
  127415. * @param extension defines the extension to load
  127416. * @returns true if the extension is supported
  127417. */
  127418. static IsPluginForExtensionAvailable(extension: string): boolean;
  127419. /**
  127420. * Adds a new plugin to the list of registered plugins
  127421. * @param plugin defines the plugin to add
  127422. */
  127423. static RegisterPlugin(plugin: ISceneLoaderPlugin | ISceneLoaderPluginAsync): void;
  127424. /**
  127425. * Import meshes into a scene
  127426. * @param meshNames an array of mesh names, a single mesh name, or empty string for all meshes that filter what meshes are imported
  127427. * @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)
  127428. * @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)
  127429. * @param scene the instance of BABYLON.Scene to append to
  127430. * @param onSuccess a callback with a list of imported meshes, particleSystems, and skeletons when import succeeds
  127431. * @param onProgress a callback with a progress event for each file being loaded
  127432. * @param onError a callback with the scene, a message, and possibly an exception when import fails
  127433. * @param pluginExtension the extension used to determine the plugin
  127434. * @returns The loaded plugin
  127435. */
  127436. 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>;
  127437. /**
  127438. * Import meshes into a scene
  127439. * @param meshNames an array of mesh names, a single mesh name, or empty string for all meshes that filter what meshes are imported
  127440. * @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)
  127441. * @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)
  127442. * @param scene the instance of BABYLON.Scene to append to
  127443. * @param onProgress a callback with a progress event for each file being loaded
  127444. * @param pluginExtension the extension used to determine the plugin
  127445. * @returns The loaded list of imported meshes, particle systems, skeletons, and animation groups
  127446. */
  127447. static ImportMeshAsync(meshNames: any, rootUrl: string, sceneFilename?: string | File, scene?: Nullable<Scene>, onProgress?: Nullable<(event: ISceneLoaderProgressEvent) => void>, pluginExtension?: Nullable<string>): Promise<{
  127448. meshes: AbstractMesh[];
  127449. particleSystems: IParticleSystem[];
  127450. skeletons: Skeleton[];
  127451. animationGroups: AnimationGroup[];
  127452. }>;
  127453. /**
  127454. * Load a scene
  127455. * @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)
  127456. * @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)
  127457. * @param engine is the instance of BABYLON.Engine to use to create the scene
  127458. * @param onSuccess a callback with the scene when import succeeds
  127459. * @param onProgress a callback with a progress event for each file being loaded
  127460. * @param onError a callback with the scene, a message, and possibly an exception when import fails
  127461. * @param pluginExtension the extension used to determine the plugin
  127462. * @returns The loaded plugin
  127463. */
  127464. 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>;
  127465. /**
  127466. * Load a scene
  127467. * @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)
  127468. * @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)
  127469. * @param engine is the instance of BABYLON.Engine to use to create the scene
  127470. * @param onProgress a callback with a progress event for each file being loaded
  127471. * @param pluginExtension the extension used to determine the plugin
  127472. * @returns The loaded scene
  127473. */
  127474. static LoadAsync(rootUrl: string, sceneFilename?: string | File, engine?: Nullable<Engine>, onProgress?: Nullable<(event: ISceneLoaderProgressEvent) => void>, pluginExtension?: Nullable<string>): Promise<Scene>;
  127475. /**
  127476. * Append a scene
  127477. * @param rootUrl a string that defines the root url for the scene and resources or the concatenation of rootURL and filename (e.g. http://example.com/test.glb)
  127478. * @param sceneFilename a string that defines the name of the scene file or starts with "data:" following by the stringified version of the scene or a File object (default: empty string)
  127479. * @param scene is the instance of BABYLON.Scene to append to
  127480. * @param onSuccess a callback with the scene when import succeeds
  127481. * @param onProgress a callback with a progress event for each file being loaded
  127482. * @param onError a callback with the scene, a message, and possibly an exception when import fails
  127483. * @param pluginExtension the extension used to determine the plugin
  127484. * @returns The loaded plugin
  127485. */
  127486. static 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>;
  127487. /**
  127488. * Append a scene
  127489. * @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)
  127490. * @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)
  127491. * @param scene is the instance of BABYLON.Scene to append to
  127492. * @param onProgress a callback with a progress event for each file being loaded
  127493. * @param pluginExtension the extension used to determine the plugin
  127494. * @returns The given scene
  127495. */
  127496. static AppendAsync(rootUrl: string, sceneFilename?: string | File, scene?: Nullable<Scene>, onProgress?: Nullable<(event: ISceneLoaderProgressEvent) => void>, pluginExtension?: Nullable<string>): Promise<Scene>;
  127497. /**
  127498. * Load a scene into an asset container
  127499. * @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)
  127500. * @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)
  127501. * @param scene is the instance of BABYLON.Scene to append to (default: last created scene)
  127502. * @param onSuccess a callback with the scene when import succeeds
  127503. * @param onProgress a callback with a progress event for each file being loaded
  127504. * @param onError a callback with the scene, a message, and possibly an exception when import fails
  127505. * @param pluginExtension the extension used to determine the plugin
  127506. * @returns The loaded plugin
  127507. */
  127508. 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>;
  127509. /**
  127510. * Load a scene into an asset container
  127511. * @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)
  127512. * @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)
  127513. * @param scene is the instance of Scene to append to
  127514. * @param onProgress a callback with a progress event for each file being loaded
  127515. * @param pluginExtension the extension used to determine the plugin
  127516. * @returns The loaded asset container
  127517. */
  127518. static LoadAssetContainerAsync(rootUrl: string, sceneFilename?: string, scene?: Nullable<Scene>, onProgress?: Nullable<(event: ISceneLoaderProgressEvent) => void>, pluginExtension?: Nullable<string>): Promise<AssetContainer>;
  127519. /**
  127520. * Import animations from a file into a scene
  127521. * @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)
  127522. * @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)
  127523. * @param scene is the instance of BABYLON.Scene to append to (default: last created scene)
  127524. * @param overwriteAnimations when true, animations are cleaned before importing new ones. Animations are appended otherwise
  127525. * @param animationGroupLoadingMode defines how to handle old animations groups before importing new ones
  127526. * @param targetConverter defines a function used to convert animation targets from loaded scene to current scene (default: search node by name)
  127527. * @param onSuccess a callback with the scene when import succeeds
  127528. * @param onProgress a callback with a progress event for each file being loaded
  127529. * @param onError a callback with the scene, a message, and possibly an exception when import fails
  127530. * @param pluginExtension the extension used to determine the plugin
  127531. */
  127532. 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;
  127533. /**
  127534. * Import animations from a file into a scene
  127535. * @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)
  127536. * @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)
  127537. * @param scene is the instance of BABYLON.Scene to append to (default: last created scene)
  127538. * @param overwriteAnimations when true, animations are cleaned before importing new ones. Animations are appended otherwise
  127539. * @param animationGroupLoadingMode defines how to handle old animations groups before importing new ones
  127540. * @param targetConverter defines a function used to convert animation targets from loaded scene to current scene (default: search node by name)
  127541. * @param onSuccess a callback with the scene when import succeeds
  127542. * @param onProgress a callback with a progress event for each file being loaded
  127543. * @param onError a callback with the scene, a message, and possibly an exception when import fails
  127544. * @param pluginExtension the extension used to determine the plugin
  127545. * @returns the updated scene with imported animations
  127546. */
  127547. 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>;
  127548. }
  127549. }
  127550. declare module BABYLON {
  127551. /**
  127552. * Handedness type in xrInput profiles. These can be used to define layouts in the Layout Map.
  127553. */
  127554. export type MotionControllerHandedness = "none" | "left" | "right";
  127555. /**
  127556. * The type of components available in motion controllers.
  127557. * This is not the name of the component.
  127558. */
  127559. export type MotionControllerComponentType = "trigger" | "squeeze" | "touchpad" | "thumbstick" | "button";
  127560. /**
  127561. * The state of a controller component
  127562. */
  127563. export type MotionControllerComponentStateType = "default" | "touched" | "pressed";
  127564. /**
  127565. * The schema of motion controller layout.
  127566. * No object will be initialized using this interface
  127567. * This is used just to define the profile.
  127568. */
  127569. export interface IMotionControllerLayout {
  127570. /**
  127571. * Path to load the assets. Usually relative to the base path
  127572. */
  127573. assetPath: string;
  127574. /**
  127575. * Available components (unsorted)
  127576. */
  127577. components: {
  127578. /**
  127579. * A map of component Ids
  127580. */
  127581. [componentId: string]: {
  127582. /**
  127583. * The type of input the component outputs
  127584. */
  127585. type: MotionControllerComponentType;
  127586. /**
  127587. * The indices of this component in the gamepad object
  127588. */
  127589. gamepadIndices: {
  127590. /**
  127591. * Index of button
  127592. */
  127593. button?: number;
  127594. /**
  127595. * If available, index of x-axis
  127596. */
  127597. xAxis?: number;
  127598. /**
  127599. * If available, index of y-axis
  127600. */
  127601. yAxis?: number;
  127602. };
  127603. /**
  127604. * The mesh's root node name
  127605. */
  127606. rootNodeName: string;
  127607. /**
  127608. * Animation definitions for this model
  127609. */
  127610. visualResponses: {
  127611. [stateKey: string]: {
  127612. /**
  127613. * What property will be animated
  127614. */
  127615. componentProperty: "xAxis" | "yAxis" | "button" | "state";
  127616. /**
  127617. * What states influence this visual response
  127618. */
  127619. states: MotionControllerComponentStateType[];
  127620. /**
  127621. * Type of animation - movement or visibility
  127622. */
  127623. valueNodeProperty: "transform" | "visibility";
  127624. /**
  127625. * Base node name to move. Its position will be calculated according to the min and max nodes
  127626. */
  127627. valueNodeName?: string;
  127628. /**
  127629. * Minimum movement node
  127630. */
  127631. minNodeName?: string;
  127632. /**
  127633. * Max movement node
  127634. */
  127635. maxNodeName?: string;
  127636. };
  127637. };
  127638. /**
  127639. * If touch enabled, what is the name of node to display user feedback
  127640. */
  127641. touchPointNodeName?: string;
  127642. };
  127643. };
  127644. /**
  127645. * Is it xr standard mapping or not
  127646. */
  127647. gamepadMapping: "" | "xr-standard";
  127648. /**
  127649. * Base root node of this entire model
  127650. */
  127651. rootNodeName: string;
  127652. /**
  127653. * Defines the main button component id
  127654. */
  127655. selectComponentId: string;
  127656. }
  127657. /**
  127658. * A definition for the layout map in the input profile
  127659. */
  127660. export interface IMotionControllerLayoutMap {
  127661. /**
  127662. * Layouts with handedness type as a key
  127663. */
  127664. [handedness: string]: IMotionControllerLayout;
  127665. }
  127666. /**
  127667. * The XR Input profile schema
  127668. * Profiles can be found here:
  127669. * https://github.com/immersive-web/webxr-input-profiles/tree/master/packages/registry/profiles
  127670. */
  127671. export interface IMotionControllerProfile {
  127672. /**
  127673. * fallback profiles for this profileId
  127674. */
  127675. fallbackProfileIds: string[];
  127676. /**
  127677. * The layout map, with handedness as key
  127678. */
  127679. layouts: IMotionControllerLayoutMap;
  127680. /**
  127681. * The id of this profile
  127682. * correlates to the profile(s) in the xrInput.profiles array
  127683. */
  127684. profileId: string;
  127685. }
  127686. /**
  127687. * A helper-interface for the 3 meshes needed for controller button animation
  127688. * The meshes are provided to the _lerpButtonTransform function to calculate the current position of the value mesh
  127689. */
  127690. export interface IMotionControllerButtonMeshMap {
  127691. /**
  127692. * the mesh that defines the pressed value mesh position.
  127693. * This is used to find the max-position of this button
  127694. */
  127695. pressedMesh: AbstractMesh;
  127696. /**
  127697. * the mesh that defines the unpressed value mesh position.
  127698. * This is used to find the min (or initial) position of this button
  127699. */
  127700. unpressedMesh: AbstractMesh;
  127701. /**
  127702. * The mesh that will be changed when value changes
  127703. */
  127704. valueMesh: AbstractMesh;
  127705. }
  127706. /**
  127707. * A helper-interface for the 3 meshes needed for controller axis animation.
  127708. * This will be expanded when touchpad animations are fully supported
  127709. * The meshes are provided to the _lerpAxisTransform function to calculate the current position of the value mesh
  127710. */
  127711. export interface IMotionControllerMeshMap {
  127712. /**
  127713. * the mesh that defines the maximum value mesh position.
  127714. */
  127715. maxMesh?: AbstractMesh;
  127716. /**
  127717. * the mesh that defines the minimum value mesh position.
  127718. */
  127719. minMesh?: AbstractMesh;
  127720. /**
  127721. * The mesh that will be changed when axis value changes
  127722. */
  127723. valueMesh?: AbstractMesh;
  127724. }
  127725. /**
  127726. * The elements needed for change-detection of the gamepad objects in motion controllers
  127727. */
  127728. export interface IMinimalMotionControllerObject {
  127729. /**
  127730. * Available axes of this controller
  127731. */
  127732. axes: number[];
  127733. /**
  127734. * An array of available buttons
  127735. */
  127736. buttons: Array<{
  127737. /**
  127738. * Value of the button/trigger
  127739. */
  127740. value: number;
  127741. /**
  127742. * If the button/trigger is currently touched
  127743. */
  127744. touched: boolean;
  127745. /**
  127746. * If the button/trigger is currently pressed
  127747. */
  127748. pressed: boolean;
  127749. }>;
  127750. /**
  127751. * EXPERIMENTAL haptic support.
  127752. */
  127753. hapticActuators?: Array<{
  127754. pulse: (value: number, duration: number) => Promise<boolean>;
  127755. }>;
  127756. }
  127757. /**
  127758. * An Abstract Motion controller
  127759. * This class receives an xrInput and a profile layout and uses those to initialize the components
  127760. * Each component has an observable to check for changes in value and state
  127761. */
  127762. export abstract class WebXRAbstractMotionController implements IDisposable {
  127763. protected scene: Scene;
  127764. protected layout: IMotionControllerLayout;
  127765. /**
  127766. * The gamepad object correlating to this controller
  127767. */
  127768. gamepadObject: IMinimalMotionControllerObject;
  127769. /**
  127770. * handedness (left/right/none) of this controller
  127771. */
  127772. handedness: MotionControllerHandedness;
  127773. private _initComponent;
  127774. private _modelReady;
  127775. /**
  127776. * A map of components (WebXRControllerComponent) in this motion controller
  127777. * Components have a ComponentType and can also have both button and axis definitions
  127778. */
  127779. readonly components: {
  127780. [id: string]: WebXRControllerComponent;
  127781. };
  127782. /**
  127783. * Disable the model's animation. Can be set at any time.
  127784. */
  127785. disableAnimation: boolean;
  127786. /**
  127787. * Observers registered here will be triggered when the model of this controller is done loading
  127788. */
  127789. onModelLoadedObservable: Observable<WebXRAbstractMotionController>;
  127790. /**
  127791. * The profile id of this motion controller
  127792. */
  127793. abstract profileId: string;
  127794. /**
  127795. * The root mesh of the model. It is null if the model was not yet initialized
  127796. */
  127797. rootMesh: Nullable<AbstractMesh>;
  127798. /**
  127799. * constructs a new abstract motion controller
  127800. * @param scene the scene to which the model of the controller will be added
  127801. * @param layout The profile layout to load
  127802. * @param gamepadObject The gamepad object correlating to this controller
  127803. * @param handedness handedness (left/right/none) of this controller
  127804. * @param _doNotLoadControllerMesh set this flag to ignore the mesh loading
  127805. */
  127806. constructor(scene: Scene, layout: IMotionControllerLayout,
  127807. /**
  127808. * The gamepad object correlating to this controller
  127809. */
  127810. gamepadObject: IMinimalMotionControllerObject,
  127811. /**
  127812. * handedness (left/right/none) of this controller
  127813. */
  127814. handedness: MotionControllerHandedness, _doNotLoadControllerMesh?: boolean);
  127815. /**
  127816. * Dispose this controller, the model mesh and all its components
  127817. */
  127818. dispose(): void;
  127819. /**
  127820. * Returns all components of specific type
  127821. * @param type the type to search for
  127822. * @return an array of components with this type
  127823. */
  127824. getAllComponentsOfType(type: MotionControllerComponentType): WebXRControllerComponent[];
  127825. /**
  127826. * get a component based an its component id as defined in layout.components
  127827. * @param id the id of the component
  127828. * @returns the component correlates to the id or undefined if not found
  127829. */
  127830. getComponent(id: string): WebXRControllerComponent;
  127831. /**
  127832. * Get the list of components available in this motion controller
  127833. * @returns an array of strings correlating to available components
  127834. */
  127835. getComponentIds(): string[];
  127836. /**
  127837. * Get the first component of specific type
  127838. * @param type type of component to find
  127839. * @return a controller component or null if not found
  127840. */
  127841. getComponentOfType(type: MotionControllerComponentType): Nullable<WebXRControllerComponent>;
  127842. /**
  127843. * Get the main (Select) component of this controller as defined in the layout
  127844. * @returns the main component of this controller
  127845. */
  127846. getMainComponent(): WebXRControllerComponent;
  127847. /**
  127848. * Loads the model correlating to this controller
  127849. * When the mesh is loaded, the onModelLoadedObservable will be triggered
  127850. * @returns A promise fulfilled with the result of the model loading
  127851. */
  127852. loadModel(): Promise<boolean>;
  127853. /**
  127854. * Update this model using the current XRFrame
  127855. * @param xrFrame the current xr frame to use and update the model
  127856. */
  127857. updateFromXRFrame(xrFrame: XRFrame): void;
  127858. /**
  127859. * Backwards compatibility due to a deeply-integrated typo
  127860. */
  127861. get handness(): XREye;
  127862. /**
  127863. * Pulse (vibrate) this controller
  127864. * If the controller does not support pulses, this function will fail silently and return Promise<false> directly after called
  127865. * Consecutive calls to this function will cancel the last pulse call
  127866. *
  127867. * @param value the strength of the pulse in 0.0...1.0 range
  127868. * @param duration Duration of the pulse in milliseconds
  127869. * @param hapticActuatorIndex optional index of actuator (will usually be 0)
  127870. * @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
  127871. */
  127872. pulse(value: number, duration: number, hapticActuatorIndex?: number): Promise<boolean>;
  127873. protected _getChildByName(node: AbstractMesh, name: string): AbstractMesh | undefined;
  127874. protected _getImmediateChildByName(node: AbstractMesh, name: string): AbstractMesh | undefined;
  127875. /**
  127876. * Moves the axis on the controller mesh based on its current state
  127877. * @param axis the index of the axis
  127878. * @param axisValue the value of the axis which determines the meshes new position
  127879. * @hidden
  127880. */
  127881. protected _lerpTransform(axisMap: IMotionControllerMeshMap, axisValue: number, fixValueCoordinates?: boolean): void;
  127882. /**
  127883. * Update the model itself with the current frame data
  127884. * @param xrFrame the frame to use for updating the model mesh
  127885. */
  127886. protected updateModel(xrFrame: XRFrame): void;
  127887. /**
  127888. * Get the filename and path for this controller's model
  127889. * @returns a map of filename and path
  127890. */
  127891. protected abstract _getFilenameAndPath(): {
  127892. filename: string;
  127893. path: string;
  127894. };
  127895. /**
  127896. * This function is called before the mesh is loaded. It checks for loading constraints.
  127897. * For example, this function can check if the GLB loader is available
  127898. * If this function returns false, the generic controller will be loaded instead
  127899. * @returns Is the client ready to load the mesh
  127900. */
  127901. protected abstract _getModelLoadingConstraints(): boolean;
  127902. /**
  127903. * This function will be called after the model was successfully loaded and can be used
  127904. * for mesh transformations before it is available for the user
  127905. * @param meshes the loaded meshes
  127906. */
  127907. protected abstract _processLoadedModel(meshes: AbstractMesh[]): void;
  127908. /**
  127909. * Set the root mesh for this controller. Important for the WebXR controller class
  127910. * @param meshes the loaded meshes
  127911. */
  127912. protected abstract _setRootMesh(meshes: AbstractMesh[]): void;
  127913. /**
  127914. * A function executed each frame that updates the mesh (if needed)
  127915. * @param xrFrame the current xrFrame
  127916. */
  127917. protected abstract _updateModel(xrFrame: XRFrame): void;
  127918. private _getGenericFilenameAndPath;
  127919. private _getGenericParentMesh;
  127920. }
  127921. }
  127922. declare module BABYLON {
  127923. /**
  127924. * A generic trigger-only motion controller for WebXR
  127925. */
  127926. export class WebXRGenericTriggerMotionController extends WebXRAbstractMotionController {
  127927. /**
  127928. * Static version of the profile id of this controller
  127929. */
  127930. static ProfileId: string;
  127931. profileId: string;
  127932. constructor(scene: Scene, gamepadObject: IMinimalMotionControllerObject, handedness: MotionControllerHandedness);
  127933. protected _getFilenameAndPath(): {
  127934. filename: string;
  127935. path: string;
  127936. };
  127937. protected _getModelLoadingConstraints(): boolean;
  127938. protected _processLoadedModel(meshes: AbstractMesh[]): void;
  127939. protected _setRootMesh(meshes: AbstractMesh[]): void;
  127940. protected _updateModel(): void;
  127941. }
  127942. }
  127943. declare module BABYLON {
  127944. /**
  127945. * Class containing static functions to help procedurally build meshes
  127946. */
  127947. export class SphereBuilder {
  127948. /**
  127949. * Creates a sphere mesh
  127950. * * The parameter `diameter` sets the diameter size (float) of the sphere (default 1)
  127951. * * 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`)
  127952. * * The parameter `segments` sets the sphere number of horizontal stripes (positive integer, default 32)
  127953. * * 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
  127954. * * 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)
  127955. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  127956. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  127957. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  127958. * @param name defines the name of the mesh
  127959. * @param options defines the options used to create the mesh
  127960. * @param scene defines the hosting scene
  127961. * @returns the sphere mesh
  127962. * @see https://doc.babylonjs.com/how_to/set_shapes#sphere
  127963. */
  127964. static CreateSphere(name: string, options: {
  127965. segments?: number;
  127966. diameter?: number;
  127967. diameterX?: number;
  127968. diameterY?: number;
  127969. diameterZ?: number;
  127970. arc?: number;
  127971. slice?: number;
  127972. sideOrientation?: number;
  127973. frontUVs?: Vector4;
  127974. backUVs?: Vector4;
  127975. updatable?: boolean;
  127976. }, scene?: Nullable<Scene>): Mesh;
  127977. }
  127978. }
  127979. declare module BABYLON {
  127980. /**
  127981. * A profiled motion controller has its profile loaded from an online repository.
  127982. * The class is responsible of loading the model, mapping the keys and enabling model-animations
  127983. */
  127984. export class WebXRProfiledMotionController extends WebXRAbstractMotionController {
  127985. private _repositoryUrl;
  127986. private _buttonMeshMapping;
  127987. private _touchDots;
  127988. /**
  127989. * The profile ID of this controller. Will be populated when the controller initializes.
  127990. */
  127991. profileId: string;
  127992. constructor(scene: Scene, xrInput: XRInputSource, _profile: IMotionControllerProfile, _repositoryUrl: string);
  127993. dispose(): void;
  127994. protected _getFilenameAndPath(): {
  127995. filename: string;
  127996. path: string;
  127997. };
  127998. protected _getModelLoadingConstraints(): boolean;
  127999. protected _processLoadedModel(_meshes: AbstractMesh[]): void;
  128000. protected _setRootMesh(meshes: AbstractMesh[]): void;
  128001. protected _updateModel(_xrFrame: XRFrame): void;
  128002. }
  128003. }
  128004. declare module BABYLON {
  128005. /**
  128006. * A construction function type to create a new controller based on an xrInput object
  128007. */
  128008. export type MotionControllerConstructor = (xrInput: XRInputSource, scene: Scene) => WebXRAbstractMotionController;
  128009. /**
  128010. * The MotionController Manager manages all registered motion controllers and loads the right one when needed.
  128011. *
  128012. * When this repository is complete: https://github.com/immersive-web/webxr-input-profiles/tree/master/packages/assets
  128013. * it should be replaced with auto-loaded controllers.
  128014. *
  128015. * When using a model try to stay as generic as possible. Eventually there will be no need in any of the controller classes
  128016. */
  128017. export class WebXRMotionControllerManager {
  128018. private static _AvailableControllers;
  128019. private static _Fallbacks;
  128020. private static _ProfileLoadingPromises;
  128021. private static _ProfilesList;
  128022. /**
  128023. * The base URL of the online controller repository. Can be changed at any time.
  128024. */
  128025. static BaseRepositoryUrl: string;
  128026. /**
  128027. * Which repository gets priority - local or online
  128028. */
  128029. static PrioritizeOnlineRepository: boolean;
  128030. /**
  128031. * Use the online repository, or use only locally-defined controllers
  128032. */
  128033. static UseOnlineRepository: boolean;
  128034. /**
  128035. * Clear the cache used for profile loading and reload when requested again
  128036. */
  128037. static ClearProfilesCache(): void;
  128038. /**
  128039. * Register the default fallbacks.
  128040. * This function is called automatically when this file is imported.
  128041. */
  128042. static DefaultFallbacks(): void;
  128043. /**
  128044. * Find a fallback profile if the profile was not found. There are a few predefined generic profiles.
  128045. * @param profileId the profile to which a fallback needs to be found
  128046. * @return an array with corresponding fallback profiles
  128047. */
  128048. static FindFallbackWithProfileId(profileId: string): string[];
  128049. /**
  128050. * When acquiring a new xrInput object (usually by the WebXRInput class), match it with the correct profile.
  128051. * The order of search:
  128052. *
  128053. * 1) Iterate the profiles array of the xr input and try finding a corresponding motion controller
  128054. * 2) (If not found) search in the gamepad id and try using it (legacy versions only)
  128055. * 3) search for registered fallbacks (should be redundant, nonetheless it makes sense to check)
  128056. * 4) return the generic trigger controller if none were found
  128057. *
  128058. * @param xrInput the xrInput to which a new controller is initialized
  128059. * @param scene the scene to which the model will be added
  128060. * @param forceProfile force a certain profile for this controller
  128061. * @return A promise that fulfils with the motion controller class for this profile id or the generic standard class if none was found
  128062. */
  128063. static GetMotionControllerWithXRInput(xrInput: XRInputSource, scene: Scene, forceProfile?: string): Promise<WebXRAbstractMotionController>;
  128064. /**
  128065. * Register a new controller based on its profile. This function will be called by the controller classes themselves.
  128066. *
  128067. * If you are missing a profile, make sure it is imported in your source, otherwise it will not register.
  128068. *
  128069. * @param type the profile type to register
  128070. * @param constructFunction the function to be called when loading this profile
  128071. */
  128072. static RegisterController(type: string, constructFunction: MotionControllerConstructor): void;
  128073. /**
  128074. * Register a fallback to a specific profile.
  128075. * @param profileId the profileId that will receive the fallbacks
  128076. * @param fallbacks A list of fallback profiles
  128077. */
  128078. static RegisterFallbacksForProfileId(profileId: string, fallbacks: string[]): void;
  128079. /**
  128080. * Will update the list of profiles available in the repository
  128081. * @return a promise that resolves to a map of profiles available online
  128082. */
  128083. static UpdateProfilesList(): Promise<{
  128084. [profile: string]: string;
  128085. }>;
  128086. private static _LoadProfileFromRepository;
  128087. private static _LoadProfilesFromAvailableControllers;
  128088. }
  128089. }
  128090. declare module BABYLON {
  128091. /**
  128092. * Configuration options for the WebXR controller creation
  128093. */
  128094. export interface IWebXRControllerOptions {
  128095. /**
  128096. * Should the controller mesh be animated when a user interacts with it
  128097. * The pressed buttons / thumbstick and touchpad animations will be disabled
  128098. */
  128099. disableMotionControllerAnimation?: boolean;
  128100. /**
  128101. * Do not load the controller mesh, in case a different mesh needs to be loaded.
  128102. */
  128103. doNotLoadControllerMesh?: boolean;
  128104. /**
  128105. * Force a specific controller type for this controller.
  128106. * This can be used when creating your own profile or when testing different controllers
  128107. */
  128108. forceControllerProfile?: string;
  128109. /**
  128110. * Defines a rendering group ID for meshes that will be loaded.
  128111. * This is for the default controllers only.
  128112. */
  128113. renderingGroupId?: number;
  128114. }
  128115. /**
  128116. * Represents an XR controller
  128117. */
  128118. export class WebXRInputSource {
  128119. private _scene;
  128120. /** The underlying input source for the controller */
  128121. inputSource: XRInputSource;
  128122. private _options;
  128123. private _tmpVector;
  128124. private _uniqueId;
  128125. private _disposed;
  128126. /**
  128127. * 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
  128128. */
  128129. grip?: AbstractMesh;
  128130. /**
  128131. * If available, this is the gamepad object related to this controller.
  128132. * Using this object it is possible to get click events and trackpad changes of the
  128133. * webxr controller that is currently being used.
  128134. */
  128135. motionController?: WebXRAbstractMotionController;
  128136. /**
  128137. * Event that fires when the controller is removed/disposed.
  128138. * The object provided as event data is this controller, after associated assets were disposed.
  128139. * uniqueId is still available.
  128140. */
  128141. onDisposeObservable: Observable<WebXRInputSource>;
  128142. /**
  128143. * Will be triggered when the mesh associated with the motion controller is done loading.
  128144. * It is also possible that this will never trigger (!) if no mesh was loaded, or if the developer decides to load a different mesh
  128145. * A shortened version of controller -> motion controller -> on mesh loaded.
  128146. */
  128147. onMeshLoadedObservable: Observable<AbstractMesh>;
  128148. /**
  128149. * Observers registered here will trigger when a motion controller profile was assigned to this xr controller
  128150. */
  128151. onMotionControllerInitObservable: Observable<WebXRAbstractMotionController>;
  128152. /**
  128153. * Pointer which can be used to select objects or attach a visible laser to
  128154. */
  128155. pointer: AbstractMesh;
  128156. /**
  128157. * Creates the input source object
  128158. * @see https://doc.babylonjs.com/how_to/webxr_controllers_support
  128159. * @param _scene the scene which the controller should be associated to
  128160. * @param inputSource the underlying input source for the controller
  128161. * @param _options options for this controller creation
  128162. */
  128163. constructor(_scene: Scene,
  128164. /** The underlying input source for the controller */
  128165. inputSource: XRInputSource, _options?: IWebXRControllerOptions);
  128166. /**
  128167. * Get this controllers unique id
  128168. */
  128169. get uniqueId(): string;
  128170. /**
  128171. * Disposes of the object
  128172. */
  128173. dispose(): void;
  128174. /**
  128175. * Gets a world space ray coming from the pointer or grip
  128176. * @param result the resulting ray
  128177. * @param gripIfAvailable use the grip mesh instead of the pointer, if available
  128178. */
  128179. getWorldPointerRayToRef(result: Ray, gripIfAvailable?: boolean): void;
  128180. /**
  128181. * Updates the controller pose based on the given XRFrame
  128182. * @param xrFrame xr frame to update the pose with
  128183. * @param referenceSpace reference space to use
  128184. */
  128185. updateFromXRFrame(xrFrame: XRFrame, referenceSpace: XRReferenceSpace): void;
  128186. }
  128187. }
  128188. declare module BABYLON {
  128189. /**
  128190. * The schema for initialization options of the XR Input class
  128191. */
  128192. export interface IWebXRInputOptions {
  128193. /**
  128194. * If set to true no model will be automatically loaded
  128195. */
  128196. doNotLoadControllerMeshes?: boolean;
  128197. /**
  128198. * If set, this profile will be used for all controllers loaded (for example "microsoft-mixed-reality")
  128199. * If not found, the xr input profile data will be used.
  128200. * Profiles are defined here - https://github.com/immersive-web/webxr-input-profiles/
  128201. */
  128202. forceInputProfile?: string;
  128203. /**
  128204. * Do not send a request to the controller repository to load the profile.
  128205. *
  128206. * Instead, use the controllers available in babylon itself.
  128207. */
  128208. disableOnlineControllerRepository?: boolean;
  128209. /**
  128210. * A custom URL for the controllers repository
  128211. */
  128212. customControllersRepositoryURL?: string;
  128213. /**
  128214. * Should the controller model's components not move according to the user input
  128215. */
  128216. disableControllerAnimation?: boolean;
  128217. /**
  128218. * Optional options to pass to the controller. Will be overridden by the Input options where applicable
  128219. */
  128220. controllerOptions?: IWebXRControllerOptions;
  128221. }
  128222. /**
  128223. * XR input used to track XR inputs such as controllers/rays
  128224. */
  128225. export class WebXRInput implements IDisposable {
  128226. /**
  128227. * the xr session manager for this session
  128228. */
  128229. xrSessionManager: WebXRSessionManager;
  128230. /**
  128231. * the WebXR camera for this session. Mainly used for teleportation
  128232. */
  128233. xrCamera: WebXRCamera;
  128234. private readonly options;
  128235. /**
  128236. * XR controllers being tracked
  128237. */
  128238. controllers: Array<WebXRInputSource>;
  128239. private _frameObserver;
  128240. private _sessionEndedObserver;
  128241. private _sessionInitObserver;
  128242. /**
  128243. * Event when a controller has been connected/added
  128244. */
  128245. onControllerAddedObservable: Observable<WebXRInputSource>;
  128246. /**
  128247. * Event when a controller has been removed/disconnected
  128248. */
  128249. onControllerRemovedObservable: Observable<WebXRInputSource>;
  128250. /**
  128251. * Initializes the WebXRInput
  128252. * @param xrSessionManager the xr session manager for this session
  128253. * @param xrCamera the WebXR camera for this session. Mainly used for teleportation
  128254. * @param options = initialization options for this xr input
  128255. */
  128256. constructor(
  128257. /**
  128258. * the xr session manager for this session
  128259. */
  128260. xrSessionManager: WebXRSessionManager,
  128261. /**
  128262. * the WebXR camera for this session. Mainly used for teleportation
  128263. */
  128264. xrCamera: WebXRCamera, options?: IWebXRInputOptions);
  128265. private _onInputSourcesChange;
  128266. private _addAndRemoveControllers;
  128267. /**
  128268. * Disposes of the object
  128269. */
  128270. dispose(): void;
  128271. }
  128272. }
  128273. declare module BABYLON {
  128274. /**
  128275. * This is the base class for all WebXR features.
  128276. * Since most features require almost the same resources and callbacks, this class can be used to simplify the development
  128277. * Note that since the features manager is using the `IWebXRFeature` you are in no way obligated to use this class
  128278. */
  128279. export abstract class WebXRAbstractFeature implements IWebXRFeature {
  128280. protected _xrSessionManager: WebXRSessionManager;
  128281. private _attached;
  128282. private _removeOnDetach;
  128283. /**
  128284. * Should auto-attach be disabled?
  128285. */
  128286. disableAutoAttach: boolean;
  128287. /**
  128288. * The name of the native xr feature name (like anchor, hit-test, or hand-tracking)
  128289. */
  128290. xrNativeFeatureName: string;
  128291. /**
  128292. * Construct a new (abstract) WebXR feature
  128293. * @param _xrSessionManager the xr session manager for this feature
  128294. */
  128295. constructor(_xrSessionManager: WebXRSessionManager);
  128296. /**
  128297. * Is this feature attached
  128298. */
  128299. get attached(): boolean;
  128300. /**
  128301. * attach this feature
  128302. *
  128303. * @param force should attachment be forced (even when already attached)
  128304. * @returns true if successful, false is failed or already attached
  128305. */
  128306. attach(force?: boolean): boolean;
  128307. /**
  128308. * detach this feature.
  128309. *
  128310. * @returns true if successful, false if failed or already detached
  128311. */
  128312. detach(): boolean;
  128313. /**
  128314. * Dispose this feature and all of the resources attached
  128315. */
  128316. dispose(): void;
  128317. /**
  128318. * This function will be executed during before enabling the feature and can be used to not-allow enabling it.
  128319. * Note that at this point the session has NOT started, so this is purely checking if the browser supports it
  128320. *
  128321. * @returns whether or not the feature is compatible in this environment
  128322. */
  128323. isCompatible(): boolean;
  128324. /**
  128325. * This is used to register callbacks that will automatically be removed when detach is called.
  128326. * @param observable the observable to which the observer will be attached
  128327. * @param callback the callback to register
  128328. */
  128329. protected _addNewAttachObserver<T>(observable: Observable<T>, callback: (eventData: T, eventState: EventState) => void): void;
  128330. /**
  128331. * Code in this function will be executed on each xrFrame received from the browser.
  128332. * This function will not execute after the feature is detached.
  128333. * @param _xrFrame the current frame
  128334. */
  128335. protected abstract _onXRFrame(_xrFrame: XRFrame): void;
  128336. }
  128337. }
  128338. declare module BABYLON {
  128339. /**
  128340. * Renders a layer on top of an existing scene
  128341. */
  128342. export class UtilityLayerRenderer implements IDisposable {
  128343. /** the original scene that will be rendered on top of */
  128344. originalScene: Scene;
  128345. private _pointerCaptures;
  128346. private _lastPointerEvents;
  128347. private static _DefaultUtilityLayer;
  128348. private static _DefaultKeepDepthUtilityLayer;
  128349. private _sharedGizmoLight;
  128350. private _renderCamera;
  128351. /**
  128352. * Gets the camera that is used to render the utility layer (when not set, this will be the last active camera)
  128353. * @param getRigParentIfPossible if the current active camera is a rig camera, should its parent camera be returned
  128354. * @returns the camera that is used when rendering the utility layer
  128355. */
  128356. getRenderCamera(getRigParentIfPossible?: boolean): Camera;
  128357. /**
  128358. * Sets the camera that should be used when rendering the utility layer (If set to null the last active camera will be used)
  128359. * @param cam the camera that should be used when rendering the utility layer
  128360. */
  128361. setRenderCamera(cam: Nullable<Camera>): void;
  128362. /**
  128363. * @hidden
  128364. * Light which used by gizmos to get light shading
  128365. */
  128366. _getSharedGizmoLight(): HemisphericLight;
  128367. /**
  128368. * If the picking should be done on the utility layer prior to the actual scene (Default: true)
  128369. */
  128370. pickUtilitySceneFirst: boolean;
  128371. /**
  128372. * 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)
  128373. */
  128374. static get DefaultUtilityLayer(): UtilityLayerRenderer;
  128375. /**
  128376. * 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)
  128377. */
  128378. static get DefaultKeepDepthUtilityLayer(): UtilityLayerRenderer;
  128379. /**
  128380. * The scene that is rendered on top of the original scene
  128381. */
  128382. utilityLayerScene: Scene;
  128383. /**
  128384. * If the utility layer should automatically be rendered on top of existing scene
  128385. */
  128386. shouldRender: boolean;
  128387. /**
  128388. * If set to true, only pointer down onPointerObservable events will be blocked when picking is occluded by original scene
  128389. */
  128390. onlyCheckPointerDownEvents: boolean;
  128391. /**
  128392. * If set to false, only pointerUp, pointerDown and pointerMove will be sent to the utilityLayerScene (false by default)
  128393. */
  128394. processAllEvents: boolean;
  128395. /**
  128396. * Observable raised when the pointer move from the utility layer scene to the main scene
  128397. */
  128398. onPointerOutObservable: Observable<number>;
  128399. /** Gets or sets a predicate that will be used to indicate utility meshes present in the main scene */
  128400. mainSceneTrackerPredicate: (mesh: Nullable<AbstractMesh>) => boolean;
  128401. private _afterRenderObserver;
  128402. private _sceneDisposeObserver;
  128403. private _originalPointerObserver;
  128404. /**
  128405. * Instantiates a UtilityLayerRenderer
  128406. * @param originalScene the original scene that will be rendered on top of
  128407. * @param handleEvents boolean indicating if the utility layer should handle events
  128408. */
  128409. constructor(
  128410. /** the original scene that will be rendered on top of */
  128411. originalScene: Scene, handleEvents?: boolean);
  128412. private _notifyObservers;
  128413. /**
  128414. * Renders the utility layers scene on top of the original scene
  128415. */
  128416. render(): void;
  128417. /**
  128418. * Disposes of the renderer
  128419. */
  128420. dispose(): void;
  128421. private _updateCamera;
  128422. }
  128423. }
  128424. declare module BABYLON {
  128425. /**
  128426. * Options interface for the pointer selection module
  128427. */
  128428. export interface IWebXRControllerPointerSelectionOptions {
  128429. /**
  128430. * if provided, this scene will be used to render meshes.
  128431. */
  128432. customUtilityLayerScene?: Scene;
  128433. /**
  128434. * 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)
  128435. * If not disabled, the last picked point will be used to execute a pointer up event
  128436. * If disabled, pointer up event will be triggered right after the pointer down event.
  128437. * Used in screen and gaze target ray mode only
  128438. */
  128439. disablePointerUpOnTouchOut: boolean;
  128440. /**
  128441. * For gaze mode for tracked-pointer / controllers (time to select instead of button press)
  128442. */
  128443. forceGazeMode: boolean;
  128444. /**
  128445. * 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
  128446. * to start a new countdown to the pointer down event.
  128447. * Defaults to 1.
  128448. */
  128449. gazeModePointerMovedFactor?: number;
  128450. /**
  128451. * Different button type to use instead of the main component
  128452. */
  128453. overrideButtonId?: string;
  128454. /**
  128455. * use this rendering group id for the meshes (optional)
  128456. */
  128457. renderingGroupId?: number;
  128458. /**
  128459. * The amount of time in milliseconds it takes between pick found something to a pointer down event.
  128460. * Used in gaze modes. Tracked pointer uses the trigger, screen uses touch events
  128461. * 3000 means 3 seconds between pointing at something and selecting it
  128462. */
  128463. timeToSelect?: number;
  128464. /**
  128465. * Should meshes created here be added to a utility layer or the main scene
  128466. */
  128467. useUtilityLayer?: boolean;
  128468. /**
  128469. * Optional WebXR camera to be used for gaze selection
  128470. */
  128471. gazeCamera?: WebXRCamera;
  128472. /**
  128473. * the xr input to use with this pointer selection
  128474. */
  128475. xrInput: WebXRInput;
  128476. }
  128477. /**
  128478. * A module that will enable pointer selection for motion controllers of XR Input Sources
  128479. */
  128480. export class WebXRControllerPointerSelection extends WebXRAbstractFeature {
  128481. private readonly _options;
  128482. private static _idCounter;
  128483. private _attachController;
  128484. private _controllers;
  128485. private _scene;
  128486. private _tmpVectorForPickCompare;
  128487. /**
  128488. * The module's name
  128489. */
  128490. static readonly Name: string;
  128491. /**
  128492. * The (Babylon) version of this module.
  128493. * This is an integer representing the implementation version.
  128494. * This number does not correspond to the WebXR specs version
  128495. */
  128496. static readonly Version: number;
  128497. /**
  128498. * Disable lighting on the laser pointer (so it will always be visible)
  128499. */
  128500. disablePointerLighting: boolean;
  128501. /**
  128502. * Disable lighting on the selection mesh (so it will always be visible)
  128503. */
  128504. disableSelectionMeshLighting: boolean;
  128505. /**
  128506. * Should the laser pointer be displayed
  128507. */
  128508. displayLaserPointer: boolean;
  128509. /**
  128510. * Should the selection mesh be displayed (The ring at the end of the laser pointer)
  128511. */
  128512. displaySelectionMesh: boolean;
  128513. /**
  128514. * This color will be set to the laser pointer when selection is triggered
  128515. */
  128516. laserPointerPickedColor: Color3;
  128517. /**
  128518. * Default color of the laser pointer
  128519. */
  128520. laserPointerDefaultColor: Color3;
  128521. /**
  128522. * default color of the selection ring
  128523. */
  128524. selectionMeshDefaultColor: Color3;
  128525. /**
  128526. * This color will be applied to the selection ring when selection is triggered
  128527. */
  128528. selectionMeshPickedColor: Color3;
  128529. /**
  128530. * Optional filter to be used for ray selection. This predicate shares behavior with
  128531. * scene.pointerMovePredicate which takes priority if it is also assigned.
  128532. */
  128533. raySelectionPredicate: (mesh: AbstractMesh) => boolean;
  128534. /**
  128535. * constructs a new background remover module
  128536. * @param _xrSessionManager the session manager for this module
  128537. * @param _options read-only options to be used in this module
  128538. */
  128539. constructor(_xrSessionManager: WebXRSessionManager, _options: IWebXRControllerPointerSelectionOptions);
  128540. /**
  128541. * attach this feature
  128542. * Will usually be called by the features manager
  128543. *
  128544. * @returns true if successful.
  128545. */
  128546. attach(): boolean;
  128547. /**
  128548. * detach this feature.
  128549. * Will usually be called by the features manager
  128550. *
  128551. * @returns true if successful.
  128552. */
  128553. detach(): boolean;
  128554. /**
  128555. * Will get the mesh under a specific pointer.
  128556. * `scene.meshUnderPointer` will only return one mesh - either left or right.
  128557. * @param controllerId the controllerId to check
  128558. * @returns The mesh under pointer or null if no mesh is under the pointer
  128559. */
  128560. getMeshUnderPointer(controllerId: string): Nullable<AbstractMesh>;
  128561. /**
  128562. * Get the xr controller that correlates to the pointer id in the pointer event
  128563. *
  128564. * @param id the pointer id to search for
  128565. * @returns the controller that correlates to this id or null if not found
  128566. */
  128567. getXRControllerByPointerId(id: number): Nullable<WebXRInputSource>;
  128568. protected _onXRFrame(_xrFrame: XRFrame): void;
  128569. private _attachGazeMode;
  128570. private _attachScreenRayMode;
  128571. private _attachTrackedPointerRayMode;
  128572. private _convertNormalToDirectionOfRay;
  128573. private _detachController;
  128574. private _generateNewMeshPair;
  128575. private _pickingMoved;
  128576. private _updatePointerDistance;
  128577. /** @hidden */
  128578. get lasterPointerDefaultColor(): Color3;
  128579. }
  128580. }
  128581. declare module BABYLON {
  128582. /**
  128583. * Button which can be used to enter a different mode of XR
  128584. */
  128585. export class WebXREnterExitUIButton {
  128586. /** button element */
  128587. element: HTMLElement;
  128588. /** XR initialization options for the button */
  128589. sessionMode: XRSessionMode;
  128590. /** Reference space type */
  128591. referenceSpaceType: XRReferenceSpaceType;
  128592. /**
  128593. * Creates a WebXREnterExitUIButton
  128594. * @param element button element
  128595. * @param sessionMode XR initialization session mode
  128596. * @param referenceSpaceType the type of reference space to be used
  128597. */
  128598. constructor(
  128599. /** button element */
  128600. element: HTMLElement,
  128601. /** XR initialization options for the button */
  128602. sessionMode: XRSessionMode,
  128603. /** Reference space type */
  128604. referenceSpaceType: XRReferenceSpaceType);
  128605. /**
  128606. * Extendable function which can be used to update the button's visuals when the state changes
  128607. * @param activeButton the current active button in the UI
  128608. */
  128609. update(activeButton: Nullable<WebXREnterExitUIButton>): void;
  128610. }
  128611. /**
  128612. * Options to create the webXR UI
  128613. */
  128614. export class WebXREnterExitUIOptions {
  128615. /**
  128616. * User provided buttons to enable/disable WebXR. The system will provide default if not set
  128617. */
  128618. customButtons?: Array<WebXREnterExitUIButton>;
  128619. /**
  128620. * A reference space type to use when creating the default button.
  128621. * Default is local-floor
  128622. */
  128623. referenceSpaceType?: XRReferenceSpaceType;
  128624. /**
  128625. * Context to enter xr with
  128626. */
  128627. renderTarget?: Nullable<WebXRRenderTarget>;
  128628. /**
  128629. * A session mode to use when creating the default button.
  128630. * Default is immersive-vr
  128631. */
  128632. sessionMode?: XRSessionMode;
  128633. /**
  128634. * A list of optional features to init the session with
  128635. */
  128636. optionalFeatures?: string[];
  128637. /**
  128638. * A list of optional features to init the session with
  128639. */
  128640. requiredFeatures?: string[];
  128641. }
  128642. /**
  128643. * UI to allow the user to enter/exit XR mode
  128644. */
  128645. export class WebXREnterExitUI implements IDisposable {
  128646. private scene;
  128647. /** version of the options passed to this UI */
  128648. options: WebXREnterExitUIOptions;
  128649. private _activeButton;
  128650. private _buttons;
  128651. /**
  128652. * The HTML Div Element to which buttons are added.
  128653. */
  128654. readonly overlay: HTMLDivElement;
  128655. /**
  128656. * Fired every time the active button is changed.
  128657. *
  128658. * When xr is entered via a button that launches xr that button will be the callback parameter
  128659. *
  128660. * When exiting xr the callback parameter will be null)
  128661. */
  128662. activeButtonChangedObservable: Observable<Nullable<WebXREnterExitUIButton>>;
  128663. /**
  128664. *
  128665. * @param scene babylon scene object to use
  128666. * @param options (read-only) version of the options passed to this UI
  128667. */
  128668. private constructor();
  128669. /**
  128670. * Creates UI to allow the user to enter/exit XR mode
  128671. * @param scene the scene to add the ui to
  128672. * @param helper the xr experience helper to enter/exit xr with
  128673. * @param options options to configure the UI
  128674. * @returns the created ui
  128675. */
  128676. static CreateAsync(scene: Scene, helper: WebXRExperienceHelper, options: WebXREnterExitUIOptions): Promise<WebXREnterExitUI>;
  128677. /**
  128678. * Disposes of the XR UI component
  128679. */
  128680. dispose(): void;
  128681. private _updateButtons;
  128682. }
  128683. }
  128684. declare module BABYLON {
  128685. /**
  128686. * Class containing static functions to help procedurally build meshes
  128687. */
  128688. export class LinesBuilder {
  128689. /**
  128690. * Creates a line system mesh. A line system is a pool of many lines gathered in a single mesh
  128691. * * 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
  128692. * * Like every other parametric shape, it is dynamically updatable by passing an existing instance of LineSystem to this static function
  128693. * * The parameter `lines` is an array of lines, each line being an array of successive Vector3
  128694. * * The optional parameter `instance` is an instance of an existing LineSystem object to be updated with the passed `lines` parameter
  128695. * * The optional parameter `colors` is an array of line colors, each line colors being an array of successive Color4, one per line point
  128696. * * The optional parameter `useVertexAlpha` is to be set to `false` (default `true`) when you don't need the alpha blending (faster)
  128697. * * 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
  128698. * * When updating an instance, remember that only line point positions can change, not the number of points, neither the number of lines
  128699. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  128700. * @see https://doc.babylonjs.com/how_to/parametric_shapes#line-system
  128701. * @param name defines the name of the new line system
  128702. * @param options defines the options used to create the line system
  128703. * @param scene defines the hosting scene
  128704. * @returns a new line system mesh
  128705. */
  128706. static CreateLineSystem(name: string, options: {
  128707. lines: Vector3[][];
  128708. updatable?: boolean;
  128709. instance?: Nullable<LinesMesh>;
  128710. colors?: Nullable<Color4[][]>;
  128711. useVertexAlpha?: boolean;
  128712. }, scene: Nullable<Scene>): LinesMesh;
  128713. /**
  128714. * Creates a line mesh
  128715. * 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
  128716. * * Like every other parametric shape, it is dynamically updatable by passing an existing instance of LineMesh to this static function
  128717. * * The parameter `points` is an array successive Vector3
  128718. * * 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
  128719. * * The optional parameter `colors` is an array of successive Color4, one per line point
  128720. * * The optional parameter `useVertexAlpha` is to be set to `false` (default `true`) when you don't need alpha blending (faster)
  128721. * * When updating an instance, remember that only point positions can change, not the number of points
  128722. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  128723. * @see https://doc.babylonjs.com/how_to/parametric_shapes#lines
  128724. * @param name defines the name of the new line system
  128725. * @param options defines the options used to create the line system
  128726. * @param scene defines the hosting scene
  128727. * @returns a new line mesh
  128728. */
  128729. static CreateLines(name: string, options: {
  128730. points: Vector3[];
  128731. updatable?: boolean;
  128732. instance?: Nullable<LinesMesh>;
  128733. colors?: Color4[];
  128734. useVertexAlpha?: boolean;
  128735. }, scene?: Nullable<Scene>): LinesMesh;
  128736. /**
  128737. * Creates a dashed line mesh
  128738. * * 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
  128739. * * Like every other parametric shape, it is dynamically updatable by passing an existing instance of LineMesh to this static function
  128740. * * The parameter `points` is an array successive Vector3
  128741. * * The parameter `dashNb` is the intended total number of dashes (positive integer, default 200)
  128742. * * The parameter `dashSize` is the size of the dashes relatively the dash number (positive float, default 3)
  128743. * * The parameter `gapSize` is the size of the gap between two successive dashes relatively the dash number (positive float, default 1)
  128744. * * 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
  128745. * * The optional parameter `useVertexAlpha` is to be set to `false` (default `true`) when you don't need the alpha blending (faster)
  128746. * * When updating an instance, remember that only point positions can change, not the number of points
  128747. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  128748. * @param name defines the name of the mesh
  128749. * @param options defines the options used to create the mesh
  128750. * @param scene defines the hosting scene
  128751. * @returns the dashed line mesh
  128752. * @see https://doc.babylonjs.com/how_to/parametric_shapes#dashed-lines
  128753. */
  128754. static CreateDashedLines(name: string, options: {
  128755. points: Vector3[];
  128756. dashSize?: number;
  128757. gapSize?: number;
  128758. dashNb?: number;
  128759. updatable?: boolean;
  128760. instance?: LinesMesh;
  128761. useVertexAlpha?: boolean;
  128762. }, scene?: Nullable<Scene>): LinesMesh;
  128763. }
  128764. }
  128765. declare module BABYLON {
  128766. /**
  128767. * Construction options for a timer
  128768. */
  128769. export interface ITimerOptions<T> {
  128770. /**
  128771. * Time-to-end
  128772. */
  128773. timeout: number;
  128774. /**
  128775. * The context observable is used to calculate time deltas and provides the context of the timer's callbacks. Will usually be OnBeforeRenderObservable.
  128776. * Countdown calculation is done ONLY when the observable is notifying its observers, meaning that if
  128777. * you choose an observable that doesn't trigger too often, the wait time might extend further than the requested max time
  128778. */
  128779. contextObservable: Observable<T>;
  128780. /**
  128781. * Optional parameters when adding an observer to the observable
  128782. */
  128783. observableParameters?: {
  128784. mask?: number;
  128785. insertFirst?: boolean;
  128786. scope?: any;
  128787. };
  128788. /**
  128789. * An optional break condition that will stop the times prematurely. In this case onEnded will not be triggered!
  128790. */
  128791. breakCondition?: (data?: ITimerData<T>) => boolean;
  128792. /**
  128793. * Will be triggered when the time condition has met
  128794. */
  128795. onEnded?: (data: ITimerData<any>) => void;
  128796. /**
  128797. * Will be triggered when the break condition has met (prematurely ended)
  128798. */
  128799. onAborted?: (data: ITimerData<any>) => void;
  128800. /**
  128801. * Optional function to execute on each tick (or count)
  128802. */
  128803. onTick?: (data: ITimerData<any>) => void;
  128804. }
  128805. /**
  128806. * An interface defining the data sent by the timer
  128807. */
  128808. export interface ITimerData<T> {
  128809. /**
  128810. * When did it start
  128811. */
  128812. startTime: number;
  128813. /**
  128814. * Time now
  128815. */
  128816. currentTime: number;
  128817. /**
  128818. * Time passed since started
  128819. */
  128820. deltaTime: number;
  128821. /**
  128822. * How much is completed, in [0.0...1.0].
  128823. * Note that this CAN be higher than 1 due to the fact that we don't actually measure time but delta between observable calls
  128824. */
  128825. completeRate: number;
  128826. /**
  128827. * What the registered observable sent in the last count
  128828. */
  128829. payload: T;
  128830. }
  128831. /**
  128832. * The current state of the timer
  128833. */
  128834. export enum TimerState {
  128835. /**
  128836. * Timer initialized, not yet started
  128837. */
  128838. INIT = 0,
  128839. /**
  128840. * Timer started and counting
  128841. */
  128842. STARTED = 1,
  128843. /**
  128844. * Timer ended (whether aborted or time reached)
  128845. */
  128846. ENDED = 2
  128847. }
  128848. /**
  128849. * A simple version of the timer. Will take options and start the timer immediately after calling it
  128850. *
  128851. * @param options options with which to initialize this timer
  128852. */
  128853. export function setAndStartTimer(options: ITimerOptions<any>): Nullable<Observer<any>>;
  128854. /**
  128855. * An advanced implementation of a timer class
  128856. */
  128857. export class AdvancedTimer<T = any> implements IDisposable {
  128858. /**
  128859. * Will notify each time the timer calculates the remaining time
  128860. */
  128861. onEachCountObservable: Observable<ITimerData<T>>;
  128862. /**
  128863. * Will trigger when the timer was aborted due to the break condition
  128864. */
  128865. onTimerAbortedObservable: Observable<ITimerData<T>>;
  128866. /**
  128867. * Will trigger when the timer ended successfully
  128868. */
  128869. onTimerEndedObservable: Observable<ITimerData<T>>;
  128870. /**
  128871. * Will trigger when the timer state has changed
  128872. */
  128873. onStateChangedObservable: Observable<TimerState>;
  128874. private _observer;
  128875. private _contextObservable;
  128876. private _observableParameters;
  128877. private _startTime;
  128878. private _timer;
  128879. private _state;
  128880. private _breakCondition;
  128881. private _timeToEnd;
  128882. private _breakOnNextTick;
  128883. /**
  128884. * Will construct a new advanced timer based on the options provided. Timer will not start until start() is called.
  128885. * @param options construction options for this advanced timer
  128886. */
  128887. constructor(options: ITimerOptions<T>);
  128888. /**
  128889. * set a breaking condition for this timer. Default is to never break during count
  128890. * @param predicate the new break condition. Returns true to break, false otherwise
  128891. */
  128892. set breakCondition(predicate: (data: ITimerData<T>) => boolean);
  128893. /**
  128894. * Reset ALL associated observables in this advanced timer
  128895. */
  128896. clearObservables(): void;
  128897. /**
  128898. * Will start a new iteration of this timer. Only one instance of this timer can run at a time.
  128899. *
  128900. * @param timeToEnd how much time to measure until timer ended
  128901. */
  128902. start(timeToEnd?: number): void;
  128903. /**
  128904. * Will force a stop on the next tick.
  128905. */
  128906. stop(): void;
  128907. /**
  128908. * Dispose this timer, clearing all resources
  128909. */
  128910. dispose(): void;
  128911. private _setState;
  128912. private _tick;
  128913. private _stop;
  128914. }
  128915. }
  128916. declare module BABYLON {
  128917. /**
  128918. * The options container for the teleportation module
  128919. */
  128920. export interface IWebXRTeleportationOptions {
  128921. /**
  128922. * if provided, this scene will be used to render meshes.
  128923. */
  128924. customUtilityLayerScene?: Scene;
  128925. /**
  128926. * Values to configure the default target mesh
  128927. */
  128928. defaultTargetMeshOptions?: {
  128929. /**
  128930. * Fill color of the teleportation area
  128931. */
  128932. teleportationFillColor?: string;
  128933. /**
  128934. * Border color for the teleportation area
  128935. */
  128936. teleportationBorderColor?: string;
  128937. /**
  128938. * Disable the mesh's animation sequence
  128939. */
  128940. disableAnimation?: boolean;
  128941. /**
  128942. * Disable lighting on the material or the ring and arrow
  128943. */
  128944. disableLighting?: boolean;
  128945. /**
  128946. * Override the default material of the torus and arrow
  128947. */
  128948. torusArrowMaterial?: Material;
  128949. };
  128950. /**
  128951. * A list of meshes to use as floor meshes.
  128952. * Meshes can be added and removed after initializing the feature using the
  128953. * addFloorMesh and removeFloorMesh functions
  128954. * If empty, rotation will still work
  128955. */
  128956. floorMeshes?: AbstractMesh[];
  128957. /**
  128958. * use this rendering group id for the meshes (optional)
  128959. */
  128960. renderingGroupId?: number;
  128961. /**
  128962. * Should teleportation move only to snap points
  128963. */
  128964. snapPointsOnly?: boolean;
  128965. /**
  128966. * An array of points to which the teleportation will snap to.
  128967. * If the teleportation ray is in the proximity of one of those points, it will be corrected to this point.
  128968. */
  128969. snapPositions?: Vector3[];
  128970. /**
  128971. * How close should the teleportation ray be in order to snap to position.
  128972. * Default to 0.8 units (meters)
  128973. */
  128974. snapToPositionRadius?: number;
  128975. /**
  128976. * Provide your own teleportation mesh instead of babylon's wonderful doughnut.
  128977. * If you want to support rotation, make sure your mesh has a direction indicator.
  128978. *
  128979. * When left untouched, the default mesh will be initialized.
  128980. */
  128981. teleportationTargetMesh?: AbstractMesh;
  128982. /**
  128983. * If main component is used (no thumbstick), how long should the "long press" take before teleport
  128984. */
  128985. timeToTeleport?: number;
  128986. /**
  128987. * Disable using the thumbstick and use the main component (usually trigger) on long press.
  128988. * This will be automatically true if the controller doesn't have a thumbstick or touchpad.
  128989. */
  128990. useMainComponentOnly?: boolean;
  128991. /**
  128992. * Should meshes created here be added to a utility layer or the main scene
  128993. */
  128994. useUtilityLayer?: boolean;
  128995. /**
  128996. * Babylon XR Input class for controller
  128997. */
  128998. xrInput: WebXRInput;
  128999. }
  129000. /**
  129001. * This is a teleportation feature to be used with WebXR-enabled motion controllers.
  129002. * When enabled and attached, the feature will allow a user to move around and rotate in the scene using
  129003. * the input of the attached controllers.
  129004. */
  129005. export class WebXRMotionControllerTeleportation extends WebXRAbstractFeature {
  129006. private _options;
  129007. private _controllers;
  129008. private _currentTeleportationControllerId;
  129009. private _floorMeshes;
  129010. private _quadraticBezierCurve;
  129011. private _selectionFeature;
  129012. private _snapToPositions;
  129013. private _snappedToPoint;
  129014. private _teleportationRingMaterial?;
  129015. private _tmpRay;
  129016. private _tmpVector;
  129017. /**
  129018. * The module's name
  129019. */
  129020. static readonly Name: string;
  129021. /**
  129022. * The (Babylon) version of this module.
  129023. * This is an integer representing the implementation version.
  129024. * This number does not correspond to the webxr specs version
  129025. */
  129026. static readonly Version: number;
  129027. /**
  129028. * Is movement backwards enabled
  129029. */
  129030. backwardsMovementEnabled: boolean;
  129031. /**
  129032. * Distance to travel when moving backwards
  129033. */
  129034. backwardsTeleportationDistance: number;
  129035. /**
  129036. * The distance from the user to the inspection point in the direction of the controller
  129037. * A higher number will allow the user to move further
  129038. * defaults to 5 (meters, in xr units)
  129039. */
  129040. parabolicCheckRadius: number;
  129041. /**
  129042. * Should the module support parabolic ray on top of direct ray
  129043. * If enabled, the user will be able to point "at the sky" and move according to predefined radius distance
  129044. * Very helpful when moving between floors / different heights
  129045. */
  129046. parabolicRayEnabled: boolean;
  129047. /**
  129048. * How much rotation should be applied when rotating right and left
  129049. */
  129050. rotationAngle: number;
  129051. /**
  129052. * Is rotation enabled when moving forward?
  129053. * Disabling this feature will prevent the user from deciding the direction when teleporting
  129054. */
  129055. rotationEnabled: boolean;
  129056. /**
  129057. * constructs a new anchor system
  129058. * @param _xrSessionManager an instance of WebXRSessionManager
  129059. * @param _options configuration object for this feature
  129060. */
  129061. constructor(_xrSessionManager: WebXRSessionManager, _options: IWebXRTeleportationOptions);
  129062. /**
  129063. * Get the snapPointsOnly flag
  129064. */
  129065. get snapPointsOnly(): boolean;
  129066. /**
  129067. * Sets the snapPointsOnly flag
  129068. * @param snapToPoints should teleportation be exclusively to snap points
  129069. */
  129070. set snapPointsOnly(snapToPoints: boolean);
  129071. /**
  129072. * Add a new mesh to the floor meshes array
  129073. * @param mesh the mesh to use as floor mesh
  129074. */
  129075. addFloorMesh(mesh: AbstractMesh): void;
  129076. /**
  129077. * Add a new snap-to point to fix teleportation to this position
  129078. * @param newSnapPoint The new Snap-To point
  129079. */
  129080. addSnapPoint(newSnapPoint: Vector3): void;
  129081. attach(): boolean;
  129082. detach(): boolean;
  129083. dispose(): void;
  129084. /**
  129085. * Remove a mesh from the floor meshes array
  129086. * @param mesh the mesh to remove
  129087. */
  129088. removeFloorMesh(mesh: AbstractMesh): void;
  129089. /**
  129090. * Remove a mesh from the floor meshes array using its name
  129091. * @param name the mesh name to remove
  129092. */
  129093. removeFloorMeshByName(name: string): void;
  129094. /**
  129095. * 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
  129096. * @param snapPointToRemove the point (or a clone of it) to be removed from the array
  129097. * @returns was the point found and removed or not
  129098. */
  129099. removeSnapPoint(snapPointToRemove: Vector3): boolean;
  129100. /**
  129101. * This function sets a selection feature that will be disabled when
  129102. * the forward ray is shown and will be reattached when hidden.
  129103. * This is used to remove the selection rays when moving.
  129104. * @param selectionFeature the feature to disable when forward movement is enabled
  129105. */
  129106. setSelectionFeature(selectionFeature: IWebXRFeature): void;
  129107. protected _onXRFrame(_xrFrame: XRFrame): void;
  129108. private _attachController;
  129109. private _createDefaultTargetMesh;
  129110. private _detachController;
  129111. private _findClosestSnapPointWithRadius;
  129112. private _setTargetMeshPosition;
  129113. private _setTargetMeshVisibility;
  129114. private _showParabolicPath;
  129115. private _teleportForward;
  129116. }
  129117. }
  129118. declare module BABYLON {
  129119. /**
  129120. * Options for the default xr helper
  129121. */
  129122. export class WebXRDefaultExperienceOptions {
  129123. /**
  129124. * Enable or disable default UI to enter XR
  129125. */
  129126. disableDefaultUI?: boolean;
  129127. /**
  129128. * Should teleportation not initialize. defaults to false.
  129129. */
  129130. disableTeleportation?: boolean;
  129131. /**
  129132. * Floor meshes that will be used for teleport
  129133. */
  129134. floorMeshes?: Array<AbstractMesh>;
  129135. /**
  129136. * If set to true, the first frame will not be used to reset position
  129137. * The first frame is mainly used when copying transformation from the old camera
  129138. * Mainly used in AR
  129139. */
  129140. ignoreNativeCameraTransformation?: boolean;
  129141. /**
  129142. * Disable the controller mesh-loading. Can be used if you want to load your own meshes
  129143. */
  129144. inputOptions?: IWebXRInputOptions;
  129145. /**
  129146. * optional configuration for the output canvas
  129147. */
  129148. outputCanvasOptions?: WebXRManagedOutputCanvasOptions;
  129149. /**
  129150. * optional UI options. This can be used among other to change session mode and reference space type
  129151. */
  129152. uiOptions?: WebXREnterExitUIOptions;
  129153. /**
  129154. * When loading teleportation and pointer select, use stable versions instead of latest.
  129155. */
  129156. useStablePlugins?: boolean;
  129157. /**
  129158. * An optional rendering group id that will be set globally for teleportation, pointer selection and default controller meshes
  129159. */
  129160. renderingGroupId?: number;
  129161. /**
  129162. * A list of optional features to init the session with
  129163. * If set to true, all features we support will be added
  129164. */
  129165. optionalFeatures?: boolean | string[];
  129166. }
  129167. /**
  129168. * Default experience which provides a similar setup to the previous webVRExperience
  129169. */
  129170. export class WebXRDefaultExperience {
  129171. /**
  129172. * Base experience
  129173. */
  129174. baseExperience: WebXRExperienceHelper;
  129175. /**
  129176. * Enables ui for entering/exiting xr
  129177. */
  129178. enterExitUI: WebXREnterExitUI;
  129179. /**
  129180. * Input experience extension
  129181. */
  129182. input: WebXRInput;
  129183. /**
  129184. * Enables laser pointer and selection
  129185. */
  129186. pointerSelection: WebXRControllerPointerSelection;
  129187. /**
  129188. * Default target xr should render to
  129189. */
  129190. renderTarget: WebXRRenderTarget;
  129191. /**
  129192. * Enables teleportation
  129193. */
  129194. teleportation: WebXRMotionControllerTeleportation;
  129195. private constructor();
  129196. /**
  129197. * Creates the default xr experience
  129198. * @param scene scene
  129199. * @param options options for basic configuration
  129200. * @returns resulting WebXRDefaultExperience
  129201. */
  129202. static CreateAsync(scene: Scene, options?: WebXRDefaultExperienceOptions): Promise<WebXRDefaultExperience>;
  129203. /**
  129204. * DIsposes of the experience helper
  129205. */
  129206. dispose(): void;
  129207. }
  129208. }
  129209. declare module BABYLON {
  129210. /**
  129211. * Options to modify the vr teleportation behavior.
  129212. */
  129213. export interface VRTeleportationOptions {
  129214. /**
  129215. * The name of the mesh which should be used as the teleportation floor. (default: null)
  129216. */
  129217. floorMeshName?: string;
  129218. /**
  129219. * A list of meshes to be used as the teleportation floor. (default: empty)
  129220. */
  129221. floorMeshes?: Mesh[];
  129222. /**
  129223. * The teleportation mode. (default: TELEPORTATIONMODE_CONSTANTTIME)
  129224. */
  129225. teleportationMode?: number;
  129226. /**
  129227. * The duration of the animation in ms, apply when animationMode is TELEPORTATIONMODE_CONSTANTTIME. (default 122ms)
  129228. */
  129229. teleportationTime?: number;
  129230. /**
  129231. * The speed of the animation in distance/sec, apply when animationMode is TELEPORTATIONMODE_CONSTANTSPEED. (default 20 units / sec)
  129232. */
  129233. teleportationSpeed?: number;
  129234. /**
  129235. * The easing function used in the animation or null for Linear. (default CircleEase)
  129236. */
  129237. easingFunction?: EasingFunction;
  129238. }
  129239. /**
  129240. * Options to modify the vr experience helper's behavior.
  129241. */
  129242. export interface VRExperienceHelperOptions extends WebVROptions {
  129243. /**
  129244. * Create a DeviceOrientationCamera to be used as your out of vr camera. (default: true)
  129245. */
  129246. createDeviceOrientationCamera?: boolean;
  129247. /**
  129248. * Create a VRDeviceOrientationFreeCamera to be used for VR when no external HMD is found. (default: true)
  129249. */
  129250. createFallbackVRDeviceOrientationFreeCamera?: boolean;
  129251. /**
  129252. * Uses the main button on the controller to toggle the laser casted. (default: true)
  129253. */
  129254. laserToggle?: boolean;
  129255. /**
  129256. * A list of meshes to be used as the teleportation floor. If specified, teleportation will be enabled (default: undefined)
  129257. */
  129258. floorMeshes?: Mesh[];
  129259. /**
  129260. * Distortion metrics for the fallback vrDeviceOrientationCamera (default: VRCameraMetrics.Default)
  129261. */
  129262. vrDeviceOrientationCameraMetrics?: VRCameraMetrics;
  129263. /**
  129264. * Defines if WebXR should be used instead of WebVR (if available)
  129265. */
  129266. useXR?: boolean;
  129267. }
  129268. /**
  129269. * Event containing information after VR has been entered
  129270. */
  129271. export class OnAfterEnteringVRObservableEvent {
  129272. /**
  129273. * If entering vr was successful
  129274. */
  129275. success: boolean;
  129276. }
  129277. /**
  129278. * Helps to quickly add VR support to an existing scene.
  129279. * See https://doc.babylonjs.com/how_to/webvr_helper
  129280. */
  129281. export class VRExperienceHelper {
  129282. /** Options to modify the vr experience helper's behavior. */
  129283. webVROptions: VRExperienceHelperOptions;
  129284. private _scene;
  129285. private _position;
  129286. private _btnVR;
  129287. private _btnVRDisplayed;
  129288. private _webVRsupported;
  129289. private _webVRready;
  129290. private _webVRrequesting;
  129291. private _webVRpresenting;
  129292. private _hasEnteredVR;
  129293. private _fullscreenVRpresenting;
  129294. private _inputElement;
  129295. private _webVRCamera;
  129296. private _vrDeviceOrientationCamera;
  129297. private _deviceOrientationCamera;
  129298. private _existingCamera;
  129299. private _onKeyDown;
  129300. private _onVrDisplayPresentChange;
  129301. private _onVRDisplayChanged;
  129302. private _onVRRequestPresentStart;
  129303. private _onVRRequestPresentComplete;
  129304. /**
  129305. * 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)
  129306. */
  129307. enableGazeEvenWhenNoPointerLock: boolean;
  129308. /**
  129309. * Gets or sets a boolean indicating that the VREXperienceHelper will exit VR if double tap is detected
  129310. */
  129311. exitVROnDoubleTap: boolean;
  129312. /**
  129313. * Observable raised right before entering VR.
  129314. */
  129315. onEnteringVRObservable: Observable<VRExperienceHelper>;
  129316. /**
  129317. * Observable raised when entering VR has completed.
  129318. */
  129319. onAfterEnteringVRObservable: Observable<OnAfterEnteringVRObservableEvent>;
  129320. /**
  129321. * Observable raised when exiting VR.
  129322. */
  129323. onExitingVRObservable: Observable<VRExperienceHelper>;
  129324. /**
  129325. * Observable raised when controller mesh is loaded.
  129326. */
  129327. onControllerMeshLoadedObservable: Observable<WebVRController>;
  129328. /** Return this.onEnteringVRObservable
  129329. * Note: This one is for backward compatibility. Please use onEnteringVRObservable directly
  129330. */
  129331. get onEnteringVR(): Observable<VRExperienceHelper>;
  129332. /** Return this.onExitingVRObservable
  129333. * Note: This one is for backward compatibility. Please use onExitingVRObservable directly
  129334. */
  129335. get onExitingVR(): Observable<VRExperienceHelper>;
  129336. /** Return this.onControllerMeshLoadedObservable
  129337. * Note: This one is for backward compatibility. Please use onControllerMeshLoadedObservable directly
  129338. */
  129339. get onControllerMeshLoaded(): Observable<WebVRController>;
  129340. private _rayLength;
  129341. private _useCustomVRButton;
  129342. private _teleportationRequested;
  129343. private _teleportActive;
  129344. private _floorMeshName;
  129345. private _floorMeshesCollection;
  129346. private _teleportationMode;
  129347. private _teleportationTime;
  129348. private _teleportationSpeed;
  129349. private _teleportationEasing;
  129350. private _rotationAllowed;
  129351. private _teleportBackwardsVector;
  129352. private _teleportationTarget;
  129353. private _isDefaultTeleportationTarget;
  129354. private _postProcessMove;
  129355. private _teleportationFillColor;
  129356. private _teleportationBorderColor;
  129357. private _rotationAngle;
  129358. private _haloCenter;
  129359. private _cameraGazer;
  129360. private _padSensibilityUp;
  129361. private _padSensibilityDown;
  129362. private _leftController;
  129363. private _rightController;
  129364. private _gazeColor;
  129365. private _laserColor;
  129366. private _pickedLaserColor;
  129367. private _pickedGazeColor;
  129368. /**
  129369. * Observable raised when a new mesh is selected based on meshSelectionPredicate
  129370. */
  129371. onNewMeshSelected: Observable<AbstractMesh>;
  129372. /**
  129373. * Observable raised when a new mesh is selected based on meshSelectionPredicate.
  129374. * This observable will provide the mesh and the controller used to select the mesh
  129375. */
  129376. onMeshSelectedWithController: Observable<{
  129377. mesh: AbstractMesh;
  129378. controller: WebVRController;
  129379. }>;
  129380. /**
  129381. * Observable raised when a new mesh is picked based on meshSelectionPredicate
  129382. */
  129383. onNewMeshPicked: Observable<PickingInfo>;
  129384. private _circleEase;
  129385. /**
  129386. * Observable raised before camera teleportation
  129387. */
  129388. onBeforeCameraTeleport: Observable<Vector3>;
  129389. /**
  129390. * Observable raised after camera teleportation
  129391. */
  129392. onAfterCameraTeleport: Observable<Vector3>;
  129393. /**
  129394. * Observable raised when current selected mesh gets unselected
  129395. */
  129396. onSelectedMeshUnselected: Observable<AbstractMesh>;
  129397. private _raySelectionPredicate;
  129398. /**
  129399. * To be optionaly changed by user to define custom ray selection
  129400. */
  129401. raySelectionPredicate: (mesh: AbstractMesh) => boolean;
  129402. /**
  129403. * To be optionaly changed by user to define custom selection logic (after ray selection)
  129404. */
  129405. meshSelectionPredicate: (mesh: AbstractMesh) => boolean;
  129406. /**
  129407. * Set teleportation enabled. If set to false camera teleportation will be disabled but camera rotation will be kept.
  129408. */
  129409. teleportationEnabled: boolean;
  129410. private _defaultHeight;
  129411. private _teleportationInitialized;
  129412. private _interactionsEnabled;
  129413. private _interactionsRequested;
  129414. private _displayGaze;
  129415. private _displayLaserPointer;
  129416. /**
  129417. * The mesh used to display where the user is going to teleport.
  129418. */
  129419. get teleportationTarget(): Mesh;
  129420. /**
  129421. * Sets the mesh to be used to display where the user is going to teleport.
  129422. */
  129423. set teleportationTarget(value: Mesh);
  129424. /**
  129425. * 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
  129426. * when set bakeCurrentTransformIntoVertices will be called on the mesh.
  129427. * See https://doc.babylonjs.com/resources/baking_transformations
  129428. */
  129429. get gazeTrackerMesh(): Mesh;
  129430. set gazeTrackerMesh(value: Mesh);
  129431. /**
  129432. * If the gaze trackers scale should be updated to be constant size when pointing at near/far meshes
  129433. */
  129434. updateGazeTrackerScale: boolean;
  129435. /**
  129436. * If the gaze trackers color should be updated when selecting meshes
  129437. */
  129438. updateGazeTrackerColor: boolean;
  129439. /**
  129440. * If the controller laser color should be updated when selecting meshes
  129441. */
  129442. updateControllerLaserColor: boolean;
  129443. /**
  129444. * The gaze tracking mesh corresponding to the left controller
  129445. */
  129446. get leftControllerGazeTrackerMesh(): Nullable<Mesh>;
  129447. /**
  129448. * The gaze tracking mesh corresponding to the right controller
  129449. */
  129450. get rightControllerGazeTrackerMesh(): Nullable<Mesh>;
  129451. /**
  129452. * If the ray of the gaze should be displayed.
  129453. */
  129454. get displayGaze(): boolean;
  129455. /**
  129456. * Sets if the ray of the gaze should be displayed.
  129457. */
  129458. set displayGaze(value: boolean);
  129459. /**
  129460. * If the ray of the LaserPointer should be displayed.
  129461. */
  129462. get displayLaserPointer(): boolean;
  129463. /**
  129464. * Sets if the ray of the LaserPointer should be displayed.
  129465. */
  129466. set displayLaserPointer(value: boolean);
  129467. /**
  129468. * The deviceOrientationCamera used as the camera when not in VR.
  129469. */
  129470. get deviceOrientationCamera(): Nullable<DeviceOrientationCamera>;
  129471. /**
  129472. * Based on the current WebVR support, returns the current VR camera used.
  129473. */
  129474. get currentVRCamera(): Nullable<Camera>;
  129475. /**
  129476. * The webVRCamera which is used when in VR.
  129477. */
  129478. get webVRCamera(): WebVRFreeCamera;
  129479. /**
  129480. * The deviceOrientationCamera that is used as a fallback when vr device is not connected.
  129481. */
  129482. get vrDeviceOrientationCamera(): Nullable<VRDeviceOrientationFreeCamera>;
  129483. /**
  129484. * The html button that is used to trigger entering into VR.
  129485. */
  129486. get vrButton(): Nullable<HTMLButtonElement>;
  129487. private get _teleportationRequestInitiated();
  129488. /**
  129489. * Defines whether or not Pointer lock should be requested when switching to
  129490. * full screen.
  129491. */
  129492. requestPointerLockOnFullScreen: boolean;
  129493. /**
  129494. * If asking to force XR, this will be populated with the default xr experience
  129495. */
  129496. xr: WebXRDefaultExperience;
  129497. /**
  129498. * Was the XR test done already. If this is true AND this.xr exists, xr is initialized.
  129499. * If this is true and no this.xr, xr exists but is not supported, using WebVR.
  129500. */
  129501. xrTestDone: boolean;
  129502. /**
  129503. * Instantiates a VRExperienceHelper.
  129504. * Helps to quickly add VR support to an existing scene.
  129505. * @param scene The scene the VRExperienceHelper belongs to.
  129506. * @param webVROptions Options to modify the vr experience helper's behavior.
  129507. */
  129508. constructor(scene: Scene,
  129509. /** Options to modify the vr experience helper's behavior. */
  129510. webVROptions?: VRExperienceHelperOptions);
  129511. private completeVRInit;
  129512. private _onDefaultMeshLoaded;
  129513. private _onResize;
  129514. private _onFullscreenChange;
  129515. /**
  129516. * Gets a value indicating if we are currently in VR mode.
  129517. */
  129518. get isInVRMode(): boolean;
  129519. private onVrDisplayPresentChange;
  129520. private onVRDisplayChanged;
  129521. private moveButtonToBottomRight;
  129522. private displayVRButton;
  129523. private updateButtonVisibility;
  129524. private _cachedAngularSensibility;
  129525. /**
  129526. * Attempt to enter VR. If a headset is connected and ready, will request present on that.
  129527. * Otherwise, will use the fullscreen API.
  129528. */
  129529. enterVR(): void;
  129530. /**
  129531. * Attempt to exit VR, or fullscreen.
  129532. */
  129533. exitVR(): void;
  129534. /**
  129535. * The position of the vr experience helper.
  129536. */
  129537. get position(): Vector3;
  129538. /**
  129539. * Sets the position of the vr experience helper.
  129540. */
  129541. set position(value: Vector3);
  129542. /**
  129543. * Enables controllers and user interactions such as selecting and object or clicking on an object.
  129544. */
  129545. enableInteractions(): void;
  129546. private get _noControllerIsActive();
  129547. private beforeRender;
  129548. private _isTeleportationFloor;
  129549. /**
  129550. * Adds a floor mesh to be used for teleportation.
  129551. * @param floorMesh the mesh to be used for teleportation.
  129552. */
  129553. addFloorMesh(floorMesh: Mesh): void;
  129554. /**
  129555. * Removes a floor mesh from being used for teleportation.
  129556. * @param floorMesh the mesh to be removed.
  129557. */
  129558. removeFloorMesh(floorMesh: Mesh): void;
  129559. /**
  129560. * Enables interactions and teleportation using the VR controllers and gaze.
  129561. * @param vrTeleportationOptions options to modify teleportation behavior.
  129562. */
  129563. enableTeleportation(vrTeleportationOptions?: VRTeleportationOptions): void;
  129564. private _onNewGamepadConnected;
  129565. private _tryEnableInteractionOnController;
  129566. private _onNewGamepadDisconnected;
  129567. private _enableInteractionOnController;
  129568. private _checkTeleportWithRay;
  129569. private _checkRotate;
  129570. private _checkTeleportBackwards;
  129571. private _enableTeleportationOnController;
  129572. private _createTeleportationCircles;
  129573. private _displayTeleportationTarget;
  129574. private _hideTeleportationTarget;
  129575. private _rotateCamera;
  129576. private _moveTeleportationSelectorTo;
  129577. private _workingVector;
  129578. private _workingQuaternion;
  129579. private _workingMatrix;
  129580. /**
  129581. * Time Constant Teleportation Mode
  129582. */
  129583. static readonly TELEPORTATIONMODE_CONSTANTTIME: number;
  129584. /**
  129585. * Speed Constant Teleportation Mode
  129586. */
  129587. static readonly TELEPORTATIONMODE_CONSTANTSPEED: number;
  129588. /**
  129589. * Teleports the users feet to the desired location
  129590. * @param location The location where the user's feet should be placed
  129591. */
  129592. teleportCamera(location: Vector3): void;
  129593. private _convertNormalToDirectionOfRay;
  129594. private _castRayAndSelectObject;
  129595. private _notifySelectedMeshUnselected;
  129596. /**
  129597. * Permanently set new colors for the laser pointer
  129598. * @param color the new laser color
  129599. * @param pickedColor the new laser color when picked mesh detected
  129600. */
  129601. setLaserColor(color: Color3, pickedColor?: Color3): void;
  129602. /**
  129603. * Set lighting enabled / disabled on the laser pointer of both controllers
  129604. * @param enabled should the lighting be enabled on the laser pointer
  129605. */
  129606. setLaserLightingState(enabled?: boolean): void;
  129607. /**
  129608. * Permanently set new colors for the gaze pointer
  129609. * @param color the new gaze color
  129610. * @param pickedColor the new gaze color when picked mesh detected
  129611. */
  129612. setGazeColor(color: Color3, pickedColor?: Color3): void;
  129613. /**
  129614. * Sets the color of the laser ray from the vr controllers.
  129615. * @param color new color for the ray.
  129616. */
  129617. changeLaserColor(color: Color3): void;
  129618. /**
  129619. * Sets the color of the ray from the vr headsets gaze.
  129620. * @param color new color for the ray.
  129621. */
  129622. changeGazeColor(color: Color3): void;
  129623. /**
  129624. * Exits VR and disposes of the vr experience helper
  129625. */
  129626. dispose(): void;
  129627. /**
  129628. * Gets the name of the VRExperienceHelper class
  129629. * @returns "VRExperienceHelper"
  129630. */
  129631. getClassName(): string;
  129632. }
  129633. }
  129634. declare module BABYLON {
  129635. /**
  129636. * Contains an array of blocks representing the octree
  129637. */
  129638. export interface IOctreeContainer<T> {
  129639. /**
  129640. * Blocks within the octree
  129641. */
  129642. blocks: Array<OctreeBlock<T>>;
  129643. }
  129644. /**
  129645. * Class used to store a cell in an octree
  129646. * @see https://doc.babylonjs.com/how_to/optimizing_your_scene_with_octrees
  129647. */
  129648. export class OctreeBlock<T> {
  129649. /**
  129650. * Gets the content of the current block
  129651. */
  129652. entries: T[];
  129653. /**
  129654. * Gets the list of block children
  129655. */
  129656. blocks: Array<OctreeBlock<T>>;
  129657. private _depth;
  129658. private _maxDepth;
  129659. private _capacity;
  129660. private _minPoint;
  129661. private _maxPoint;
  129662. private _boundingVectors;
  129663. private _creationFunc;
  129664. /**
  129665. * Creates a new block
  129666. * @param minPoint defines the minimum vector (in world space) of the block's bounding box
  129667. * @param maxPoint defines the maximum vector (in world space) of the block's bounding box
  129668. * @param capacity defines the maximum capacity of this block (if capacity is reached the block will be split into sub blocks)
  129669. * @param depth defines the current depth of this block in the octree
  129670. * @param maxDepth defines the maximal depth allowed (beyond this value, the capacity is ignored)
  129671. * @param creationFunc defines a callback to call when an element is added to the block
  129672. */
  129673. constructor(minPoint: Vector3, maxPoint: Vector3, capacity: number, depth: number, maxDepth: number, creationFunc: (entry: T, block: OctreeBlock<T>) => void);
  129674. /**
  129675. * Gets the maximum capacity of this block (if capacity is reached the block will be split into sub blocks)
  129676. */
  129677. get capacity(): number;
  129678. /**
  129679. * Gets the minimum vector (in world space) of the block's bounding box
  129680. */
  129681. get minPoint(): Vector3;
  129682. /**
  129683. * Gets the maximum vector (in world space) of the block's bounding box
  129684. */
  129685. get maxPoint(): Vector3;
  129686. /**
  129687. * Add a new element to this block
  129688. * @param entry defines the element to add
  129689. */
  129690. addEntry(entry: T): void;
  129691. /**
  129692. * Remove an element from this block
  129693. * @param entry defines the element to remove
  129694. */
  129695. removeEntry(entry: T): void;
  129696. /**
  129697. * Add an array of elements to this block
  129698. * @param entries defines the array of elements to add
  129699. */
  129700. addEntries(entries: T[]): void;
  129701. /**
  129702. * Test if the current block intersects the furstum planes and if yes, then add its content to the selection array
  129703. * @param frustumPlanes defines the frustum planes to test
  129704. * @param selection defines the array to store current content if selection is positive
  129705. * @param allowDuplicate defines if the selection array can contains duplicated entries
  129706. */
  129707. select(frustumPlanes: Plane[], selection: SmartArrayNoDuplicate<T>, allowDuplicate?: boolean): void;
  129708. /**
  129709. * Test if the current block intersect with the given bounding sphere and if yes, then add its content to the selection array
  129710. * @param sphereCenter defines the bounding sphere center
  129711. * @param sphereRadius defines the bounding sphere radius
  129712. * @param selection defines the array to store current content if selection is positive
  129713. * @param allowDuplicate defines if the selection array can contains duplicated entries
  129714. */
  129715. intersects(sphereCenter: Vector3, sphereRadius: number, selection: SmartArrayNoDuplicate<T>, allowDuplicate?: boolean): void;
  129716. /**
  129717. * Test if the current block intersect with the given ray and if yes, then add its content to the selection array
  129718. * @param ray defines the ray to test with
  129719. * @param selection defines the array to store current content if selection is positive
  129720. */
  129721. intersectsRay(ray: Ray, selection: SmartArrayNoDuplicate<T>): void;
  129722. /**
  129723. * Subdivide the content into child blocks (this block will then be empty)
  129724. */
  129725. createInnerBlocks(): void;
  129726. /**
  129727. * @hidden
  129728. */
  129729. 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;
  129730. }
  129731. }
  129732. declare module BABYLON {
  129733. /**
  129734. * Octrees are a really powerful data structure that can quickly select entities based on space coordinates.
  129735. * @see https://doc.babylonjs.com/how_to/optimizing_your_scene_with_octrees
  129736. */
  129737. export class Octree<T> {
  129738. /** 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.) */
  129739. maxDepth: number;
  129740. /**
  129741. * Blocks within the octree containing objects
  129742. */
  129743. blocks: Array<OctreeBlock<T>>;
  129744. /**
  129745. * Content stored in the octree
  129746. */
  129747. dynamicContent: T[];
  129748. private _maxBlockCapacity;
  129749. private _selectionContent;
  129750. private _creationFunc;
  129751. /**
  129752. * Creates a octree
  129753. * @see https://doc.babylonjs.com/how_to/optimizing_your_scene_with_octrees
  129754. * @param creationFunc function to be used to instatiate the octree
  129755. * @param maxBlockCapacity defines the maximum number of meshes you want on your octree's leaves (default: 64)
  129756. * @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.)
  129757. */
  129758. constructor(creationFunc: (entry: T, block: OctreeBlock<T>) => void, maxBlockCapacity?: number,
  129759. /** 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.) */
  129760. maxDepth?: number);
  129761. /**
  129762. * Updates the octree by adding blocks for the passed in meshes within the min and max world parameters
  129763. * @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);
  129764. * @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);
  129765. * @param entries meshes to be added to the octree blocks
  129766. */
  129767. update(worldMin: Vector3, worldMax: Vector3, entries: T[]): void;
  129768. /**
  129769. * Adds a mesh to the octree
  129770. * @param entry Mesh to add to the octree
  129771. */
  129772. addMesh(entry: T): void;
  129773. /**
  129774. * Remove an element from the octree
  129775. * @param entry defines the element to remove
  129776. */
  129777. removeMesh(entry: T): void;
  129778. /**
  129779. * Selects an array of meshes within the frustum
  129780. * @param frustumPlanes The frustum planes to use which will select all meshes within it
  129781. * @param allowDuplicate If duplicate objects are allowed in the resulting object array
  129782. * @returns array of meshes within the frustum
  129783. */
  129784. select(frustumPlanes: Plane[], allowDuplicate?: boolean): SmartArray<T>;
  129785. /**
  129786. * Test if the octree intersect with the given bounding sphere and if yes, then add its content to the selection array
  129787. * @param sphereCenter defines the bounding sphere center
  129788. * @param sphereRadius defines the bounding sphere radius
  129789. * @param allowDuplicate defines if the selection array can contains duplicated entries
  129790. * @returns an array of objects that intersect the sphere
  129791. */
  129792. intersects(sphereCenter: Vector3, sphereRadius: number, allowDuplicate?: boolean): SmartArray<T>;
  129793. /**
  129794. * Test if the octree intersect with the given ray and if yes, then add its content to resulting array
  129795. * @param ray defines the ray to test with
  129796. * @returns array of intersected objects
  129797. */
  129798. intersectsRay(ray: Ray): SmartArray<T>;
  129799. /**
  129800. * Adds a mesh into the octree block if it intersects the block
  129801. */
  129802. static CreationFuncForMeshes: (entry: AbstractMesh, block: OctreeBlock<AbstractMesh>) => void;
  129803. /**
  129804. * Adds a submesh into the octree block if it intersects the block
  129805. */
  129806. static CreationFuncForSubMeshes: (entry: SubMesh, block: OctreeBlock<SubMesh>) => void;
  129807. }
  129808. }
  129809. declare module BABYLON {
  129810. interface Scene {
  129811. /**
  129812. * @hidden
  129813. * Backing Filed
  129814. */
  129815. _selectionOctree: Octree<AbstractMesh>;
  129816. /**
  129817. * Gets the octree used to boost mesh selection (picking)
  129818. * @see https://doc.babylonjs.com/how_to/optimizing_your_scene_with_octrees
  129819. */
  129820. selectionOctree: Octree<AbstractMesh>;
  129821. /**
  129822. * Creates or updates the octree used to boost selection (picking)
  129823. * @see https://doc.babylonjs.com/how_to/optimizing_your_scene_with_octrees
  129824. * @param maxCapacity defines the maximum capacity per leaf
  129825. * @param maxDepth defines the maximum depth of the octree
  129826. * @returns an octree of AbstractMesh
  129827. */
  129828. createOrUpdateSelectionOctree(maxCapacity?: number, maxDepth?: number): Octree<AbstractMesh>;
  129829. }
  129830. interface AbstractMesh {
  129831. /**
  129832. * @hidden
  129833. * Backing Field
  129834. */
  129835. _submeshesOctree: Octree<SubMesh>;
  129836. /**
  129837. * This function will create an octree to help to select the right submeshes for rendering, picking and collision computations.
  129838. * Please note that you must have a decent number of submeshes to get performance improvements when using an octree
  129839. * @param maxCapacity defines the maximum size of each block (64 by default)
  129840. * @param maxDepth defines the maximum depth to use (no more than 2 levels by default)
  129841. * @returns the new octree
  129842. * @see https://www.babylonjs-playground.com/#NA4OQ#12
  129843. * @see https://doc.babylonjs.com/how_to/optimizing_your_scene_with_octrees
  129844. */
  129845. createOrUpdateSubmeshesOctree(maxCapacity?: number, maxDepth?: number): Octree<SubMesh>;
  129846. }
  129847. /**
  129848. * Defines the octree scene component responsible to manage any octrees
  129849. * in a given scene.
  129850. */
  129851. export class OctreeSceneComponent {
  129852. /**
  129853. * The component name help to identify the component in the list of scene components.
  129854. */
  129855. readonly name: string;
  129856. /**
  129857. * The scene the component belongs to.
  129858. */
  129859. scene: Scene;
  129860. /**
  129861. * Indicates if the meshes have been checked to make sure they are isEnabled()
  129862. */
  129863. readonly checksIsEnabled: boolean;
  129864. /**
  129865. * Creates a new instance of the component for the given scene
  129866. * @param scene Defines the scene to register the component in
  129867. */
  129868. constructor(scene: Scene);
  129869. /**
  129870. * Registers the component in a given scene
  129871. */
  129872. register(): void;
  129873. /**
  129874. * Return the list of active meshes
  129875. * @returns the list of active meshes
  129876. */
  129877. getActiveMeshCandidates(): ISmartArrayLike<AbstractMesh>;
  129878. /**
  129879. * Return the list of active sub meshes
  129880. * @param mesh The mesh to get the candidates sub meshes from
  129881. * @returns the list of active sub meshes
  129882. */
  129883. getActiveSubMeshCandidates(mesh: AbstractMesh): ISmartArrayLike<SubMesh>;
  129884. private _tempRay;
  129885. /**
  129886. * Return the list of sub meshes intersecting with a given local ray
  129887. * @param mesh defines the mesh to find the submesh for
  129888. * @param localRay defines the ray in local space
  129889. * @returns the list of intersecting sub meshes
  129890. */
  129891. getIntersectingSubMeshCandidates(mesh: AbstractMesh, localRay: Ray): ISmartArrayLike<SubMesh>;
  129892. /**
  129893. * Return the list of sub meshes colliding with a collider
  129894. * @param mesh defines the mesh to find the submesh for
  129895. * @param collider defines the collider to evaluate the collision against
  129896. * @returns the list of colliding sub meshes
  129897. */
  129898. getCollidingSubMeshCandidates(mesh: AbstractMesh, collider: Collider): ISmartArrayLike<SubMesh>;
  129899. /**
  129900. * Rebuilds the elements related to this component in case of
  129901. * context lost for instance.
  129902. */
  129903. rebuild(): void;
  129904. /**
  129905. * Disposes the component and the associated ressources.
  129906. */
  129907. dispose(): void;
  129908. }
  129909. }
  129910. declare module BABYLON {
  129911. /**
  129912. * Renders gizmos on top of an existing scene which provide controls for position, rotation, etc.
  129913. */
  129914. export class Gizmo implements IDisposable {
  129915. /** The utility layer the gizmo will be added to */
  129916. gizmoLayer: UtilityLayerRenderer;
  129917. /**
  129918. * The root mesh of the gizmo
  129919. */
  129920. _rootMesh: Mesh;
  129921. private _attachedMesh;
  129922. private _attachedNode;
  129923. /**
  129924. * Ratio for the scale of the gizmo (Default: 1)
  129925. */
  129926. protected _scaleRatio: number;
  129927. /**
  129928. * Ratio for the scale of the gizmo (Default: 1)
  129929. */
  129930. set scaleRatio(value: number);
  129931. get scaleRatio(): number;
  129932. /**
  129933. * If a custom mesh has been set (Default: false)
  129934. */
  129935. protected _customMeshSet: boolean;
  129936. /**
  129937. * Mesh that the gizmo will be attached to. (eg. on a drag gizmo the mesh that will be dragged)
  129938. * * When set, interactions will be enabled
  129939. */
  129940. get attachedMesh(): Nullable<AbstractMesh>;
  129941. set attachedMesh(value: Nullable<AbstractMesh>);
  129942. /**
  129943. * Node that the gizmo will be attached to. (eg. on a drag gizmo the mesh, bone or NodeTransform that will be dragged)
  129944. * * When set, interactions will be enabled
  129945. */
  129946. get attachedNode(): Nullable<Node>;
  129947. set attachedNode(value: Nullable<Node>);
  129948. /**
  129949. * Disposes and replaces the current meshes in the gizmo with the specified mesh
  129950. * @param mesh The mesh to replace the default mesh of the gizmo
  129951. */
  129952. setCustomMesh(mesh: Mesh): void;
  129953. protected _updateGizmoRotationToMatchAttachedMesh: boolean;
  129954. /**
  129955. * If set the gizmo's rotation will be updated to match the attached mesh each frame (Default: true)
  129956. */
  129957. set updateGizmoRotationToMatchAttachedMesh(value: boolean);
  129958. get updateGizmoRotationToMatchAttachedMesh(): boolean;
  129959. /**
  129960. * If set the gizmo's position will be updated to match the attached mesh each frame (Default: true)
  129961. */
  129962. updateGizmoPositionToMatchAttachedMesh: boolean;
  129963. /**
  129964. * When set, the gizmo will always appear the same size no matter where the camera is (default: true)
  129965. */
  129966. updateScale: boolean;
  129967. protected _interactionsEnabled: boolean;
  129968. protected _attachedNodeChanged(value: Nullable<Node>): void;
  129969. private _beforeRenderObserver;
  129970. private _tempQuaternion;
  129971. private _tempVector;
  129972. private _tempVector2;
  129973. /**
  129974. * Creates a gizmo
  129975. * @param gizmoLayer The utility layer the gizmo will be added to
  129976. */
  129977. constructor(
  129978. /** The utility layer the gizmo will be added to */
  129979. gizmoLayer?: UtilityLayerRenderer);
  129980. /**
  129981. * Updates the gizmo to match the attached mesh's position/rotation
  129982. */
  129983. protected _update(): void;
  129984. /**
  129985. * computes the rotation/scaling/position of the transform once the Node world matrix has changed.
  129986. * @param value Node, TransformNode or mesh
  129987. */
  129988. protected _matrixChanged(): void;
  129989. /**
  129990. * Disposes of the gizmo
  129991. */
  129992. dispose(): void;
  129993. }
  129994. }
  129995. declare module BABYLON {
  129996. /**
  129997. * Single plane drag gizmo
  129998. */
  129999. export class PlaneDragGizmo extends Gizmo {
  130000. /**
  130001. * Drag behavior responsible for the gizmos dragging interactions
  130002. */
  130003. dragBehavior: PointerDragBehavior;
  130004. private _pointerObserver;
  130005. /**
  130006. * Drag distance in babylon units that the gizmo will snap to when dragged (Default: 0)
  130007. */
  130008. snapDistance: number;
  130009. /**
  130010. * Event that fires each time the gizmo snaps to a new location.
  130011. * * snapDistance is the the change in distance
  130012. */
  130013. onSnapObservable: Observable<{
  130014. snapDistance: number;
  130015. }>;
  130016. private _plane;
  130017. private _coloredMaterial;
  130018. private _hoverMaterial;
  130019. private _isEnabled;
  130020. private _parent;
  130021. /** @hidden */
  130022. static _CreatePlane(scene: Scene, material: StandardMaterial): TransformNode;
  130023. /** @hidden */
  130024. static _CreateArrowInstance(scene: Scene, arrow: TransformNode): TransformNode;
  130025. /**
  130026. * Creates a PlaneDragGizmo
  130027. * @param gizmoLayer The utility layer the gizmo will be added to
  130028. * @param dragPlaneNormal The axis normal to which the gizmo will be able to drag on
  130029. * @param color The color of the gizmo
  130030. */
  130031. constructor(dragPlaneNormal: Vector3, color?: Color3, gizmoLayer?: UtilityLayerRenderer, parent?: Nullable<PositionGizmo>);
  130032. protected _attachedNodeChanged(value: Nullable<Node>): void;
  130033. /**
  130034. * If the gizmo is enabled
  130035. */
  130036. set isEnabled(value: boolean);
  130037. get isEnabled(): boolean;
  130038. /**
  130039. * Disposes of the gizmo
  130040. */
  130041. dispose(): void;
  130042. }
  130043. }
  130044. declare module BABYLON {
  130045. /**
  130046. * Gizmo that enables dragging a mesh along 3 axis
  130047. */
  130048. export class PositionGizmo extends Gizmo {
  130049. /**
  130050. * Internal gizmo used for interactions on the x axis
  130051. */
  130052. xGizmo: AxisDragGizmo;
  130053. /**
  130054. * Internal gizmo used for interactions on the y axis
  130055. */
  130056. yGizmo: AxisDragGizmo;
  130057. /**
  130058. * Internal gizmo used for interactions on the z axis
  130059. */
  130060. zGizmo: AxisDragGizmo;
  130061. /**
  130062. * Internal gizmo used for interactions on the yz plane
  130063. */
  130064. xPlaneGizmo: PlaneDragGizmo;
  130065. /**
  130066. * Internal gizmo used for interactions on the xz plane
  130067. */
  130068. yPlaneGizmo: PlaneDragGizmo;
  130069. /**
  130070. * Internal gizmo used for interactions on the xy plane
  130071. */
  130072. zPlaneGizmo: PlaneDragGizmo;
  130073. /**
  130074. * private variables
  130075. */
  130076. private _meshAttached;
  130077. private _nodeAttached;
  130078. private _snapDistance;
  130079. /** Fires an event when any of it's sub gizmos are dragged */
  130080. onDragStartObservable: Observable<unknown>;
  130081. /** Fires an event when any of it's sub gizmos are released from dragging */
  130082. onDragEndObservable: Observable<unknown>;
  130083. /**
  130084. * If set to true, planar drag is enabled
  130085. */
  130086. private _planarGizmoEnabled;
  130087. get attachedMesh(): Nullable<AbstractMesh>;
  130088. set attachedMesh(mesh: Nullable<AbstractMesh>);
  130089. get attachedNode(): Nullable<Node>;
  130090. set attachedNode(node: Nullable<Node>);
  130091. /**
  130092. * Creates a PositionGizmo
  130093. * @param gizmoLayer The utility layer the gizmo will be added to
  130094. @param thickness display gizmo axis thickness
  130095. */
  130096. constructor(gizmoLayer?: UtilityLayerRenderer, thickness?: number);
  130097. /**
  130098. * If the planar drag gizmo is enabled
  130099. * setting this will enable/disable XY, XZ and YZ planes regardless of individual gizmo settings.
  130100. */
  130101. set planarGizmoEnabled(value: boolean);
  130102. get planarGizmoEnabled(): boolean;
  130103. set updateGizmoRotationToMatchAttachedMesh(value: boolean);
  130104. get updateGizmoRotationToMatchAttachedMesh(): boolean;
  130105. /**
  130106. * Drag distance in babylon units that the gizmo will snap to when dragged (Default: 0)
  130107. */
  130108. set snapDistance(value: number);
  130109. get snapDistance(): number;
  130110. /**
  130111. * Ratio for the scale of the gizmo (Default: 1)
  130112. */
  130113. set scaleRatio(value: number);
  130114. get scaleRatio(): number;
  130115. /**
  130116. * Disposes of the gizmo
  130117. */
  130118. dispose(): void;
  130119. /**
  130120. * CustomMeshes are not supported by this gizmo
  130121. * @param mesh The mesh to replace the default mesh of the gizmo
  130122. */
  130123. setCustomMesh(mesh: Mesh): void;
  130124. }
  130125. }
  130126. declare module BABYLON {
  130127. /**
  130128. * Single axis drag gizmo
  130129. */
  130130. export class AxisDragGizmo extends Gizmo {
  130131. /**
  130132. * Drag behavior responsible for the gizmos dragging interactions
  130133. */
  130134. dragBehavior: PointerDragBehavior;
  130135. private _pointerObserver;
  130136. /**
  130137. * Drag distance in babylon units that the gizmo will snap to when dragged (Default: 0)
  130138. */
  130139. snapDistance: number;
  130140. /**
  130141. * Event that fires each time the gizmo snaps to a new location.
  130142. * * snapDistance is the the change in distance
  130143. */
  130144. onSnapObservable: Observable<{
  130145. snapDistance: number;
  130146. }>;
  130147. private _isEnabled;
  130148. private _parent;
  130149. private _arrow;
  130150. private _coloredMaterial;
  130151. private _hoverMaterial;
  130152. /** @hidden */
  130153. static _CreateArrow(scene: Scene, material: StandardMaterial, thickness?: number): TransformNode;
  130154. /** @hidden */
  130155. static _CreateArrowInstance(scene: Scene, arrow: TransformNode): TransformNode;
  130156. /**
  130157. * Creates an AxisDragGizmo
  130158. * @param gizmoLayer The utility layer the gizmo will be added to
  130159. * @param dragAxis The axis which the gizmo will be able to drag on
  130160. * @param color The color of the gizmo
  130161. * @param thickness display gizmo axis thickness
  130162. */
  130163. constructor(dragAxis: Vector3, color?: Color3, gizmoLayer?: UtilityLayerRenderer, parent?: Nullable<PositionGizmo>, thickness?: number);
  130164. protected _attachedNodeChanged(value: Nullable<Node>): void;
  130165. /**
  130166. * If the gizmo is enabled
  130167. */
  130168. set isEnabled(value: boolean);
  130169. get isEnabled(): boolean;
  130170. /**
  130171. * Disposes of the gizmo
  130172. */
  130173. dispose(): void;
  130174. }
  130175. }
  130176. declare module BABYLON.Debug {
  130177. /**
  130178. * The Axes viewer will show 3 axes in a specific point in space
  130179. */
  130180. export class AxesViewer {
  130181. private _xAxis;
  130182. private _yAxis;
  130183. private _zAxis;
  130184. private _scaleLinesFactor;
  130185. private _instanced;
  130186. /**
  130187. * Gets the hosting scene
  130188. */
  130189. scene: Nullable<Scene>;
  130190. /**
  130191. * Gets or sets a number used to scale line length
  130192. */
  130193. scaleLines: number;
  130194. /** Gets the node hierarchy used to render x-axis */
  130195. get xAxis(): TransformNode;
  130196. /** Gets the node hierarchy used to render y-axis */
  130197. get yAxis(): TransformNode;
  130198. /** Gets the node hierarchy used to render z-axis */
  130199. get zAxis(): TransformNode;
  130200. /**
  130201. * Creates a new AxesViewer
  130202. * @param scene defines the hosting scene
  130203. * @param scaleLines defines a number used to scale line length (1 by default)
  130204. * @param renderingGroupId defines a number used to set the renderingGroupId of the meshes (2 by default)
  130205. * @param xAxis defines the node hierarchy used to render the x-axis
  130206. * @param yAxis defines the node hierarchy used to render the y-axis
  130207. * @param zAxis defines the node hierarchy used to render the z-axis
  130208. */
  130209. constructor(scene: Scene, scaleLines?: number, renderingGroupId?: Nullable<number>, xAxis?: TransformNode, yAxis?: TransformNode, zAxis?: TransformNode);
  130210. /**
  130211. * Force the viewer to update
  130212. * @param position defines the position of the viewer
  130213. * @param xaxis defines the x axis of the viewer
  130214. * @param yaxis defines the y axis of the viewer
  130215. * @param zaxis defines the z axis of the viewer
  130216. */
  130217. update(position: Vector3, xaxis: Vector3, yaxis: Vector3, zaxis: Vector3): void;
  130218. /**
  130219. * Creates an instance of this axes viewer.
  130220. * @returns a new axes viewer with instanced meshes
  130221. */
  130222. createInstance(): AxesViewer;
  130223. /** Releases resources */
  130224. dispose(): void;
  130225. private static _SetRenderingGroupId;
  130226. }
  130227. }
  130228. declare module BABYLON.Debug {
  130229. /**
  130230. * The BoneAxesViewer will attach 3 axes to a specific bone of a specific mesh
  130231. * @see demo here: https://www.babylonjs-playground.com/#0DE8F4#8
  130232. */
  130233. export class BoneAxesViewer extends AxesViewer {
  130234. /**
  130235. * Gets or sets the target mesh where to display the axes viewer
  130236. */
  130237. mesh: Nullable<Mesh>;
  130238. /**
  130239. * Gets or sets the target bone where to display the axes viewer
  130240. */
  130241. bone: Nullable<Bone>;
  130242. /** Gets current position */
  130243. pos: Vector3;
  130244. /** Gets direction of X axis */
  130245. xaxis: Vector3;
  130246. /** Gets direction of Y axis */
  130247. yaxis: Vector3;
  130248. /** Gets direction of Z axis */
  130249. zaxis: Vector3;
  130250. /**
  130251. * Creates a new BoneAxesViewer
  130252. * @param scene defines the hosting scene
  130253. * @param bone defines the target bone
  130254. * @param mesh defines the target mesh
  130255. * @param scaleLines defines a scaling factor for line length (1 by default)
  130256. */
  130257. constructor(scene: Scene, bone: Bone, mesh: Mesh, scaleLines?: number);
  130258. /**
  130259. * Force the viewer to update
  130260. */
  130261. update(): void;
  130262. /** Releases resources */
  130263. dispose(): void;
  130264. }
  130265. }
  130266. declare module BABYLON {
  130267. /**
  130268. * Interface used to define scene explorer extensibility option
  130269. */
  130270. export interface IExplorerExtensibilityOption {
  130271. /**
  130272. * Define the option label
  130273. */
  130274. label: string;
  130275. /**
  130276. * Defines the action to execute on click
  130277. */
  130278. action: (entity: any) => void;
  130279. }
  130280. /**
  130281. * Defines a group of actions associated with a predicate to use when extending the Inspector scene explorer
  130282. */
  130283. export interface IExplorerExtensibilityGroup {
  130284. /**
  130285. * Defines a predicate to test if a given type mut be extended
  130286. */
  130287. predicate: (entity: any) => boolean;
  130288. /**
  130289. * Gets the list of options added to a type
  130290. */
  130291. entries: IExplorerExtensibilityOption[];
  130292. }
  130293. /**
  130294. * Interface used to define the options to use to create the Inspector
  130295. */
  130296. export interface IInspectorOptions {
  130297. /**
  130298. * Display in overlay mode (default: false)
  130299. */
  130300. overlay?: boolean;
  130301. /**
  130302. * HTML element to use as root (the parent of the rendering canvas will be used as default value)
  130303. */
  130304. globalRoot?: HTMLElement;
  130305. /**
  130306. * Display the Scene explorer
  130307. */
  130308. showExplorer?: boolean;
  130309. /**
  130310. * Display the property inspector
  130311. */
  130312. showInspector?: boolean;
  130313. /**
  130314. * Display in embed mode (both panes on the right)
  130315. */
  130316. embedMode?: boolean;
  130317. /**
  130318. * let the Inspector handles resize of the canvas when panes are resized (default to true)
  130319. */
  130320. handleResize?: boolean;
  130321. /**
  130322. * Allow the panes to popup (default: true)
  130323. */
  130324. enablePopup?: boolean;
  130325. /**
  130326. * Allow the panes to be closed by users (default: true)
  130327. */
  130328. enableClose?: boolean;
  130329. /**
  130330. * Optional list of extensibility entries
  130331. */
  130332. explorerExtensibility?: IExplorerExtensibilityGroup[];
  130333. /**
  130334. * Optional URL to get the inspector script from (by default it uses the babylonjs CDN).
  130335. */
  130336. inspectorURL?: string;
  130337. /**
  130338. * Optional initial tab (default to DebugLayerTab.Properties)
  130339. */
  130340. initialTab?: DebugLayerTab;
  130341. }
  130342. interface Scene {
  130343. /**
  130344. * @hidden
  130345. * Backing field
  130346. */
  130347. _debugLayer: DebugLayer;
  130348. /**
  130349. * Gets the debug layer (aka Inspector) associated with the scene
  130350. * @see https://doc.babylonjs.com/features/playground_debuglayer
  130351. */
  130352. debugLayer: DebugLayer;
  130353. }
  130354. /**
  130355. * Enum of inspector action tab
  130356. */
  130357. export enum DebugLayerTab {
  130358. /**
  130359. * Properties tag (default)
  130360. */
  130361. Properties = 0,
  130362. /**
  130363. * Debug tab
  130364. */
  130365. Debug = 1,
  130366. /**
  130367. * Statistics tab
  130368. */
  130369. Statistics = 2,
  130370. /**
  130371. * Tools tab
  130372. */
  130373. Tools = 3,
  130374. /**
  130375. * Settings tab
  130376. */
  130377. Settings = 4
  130378. }
  130379. /**
  130380. * The debug layer (aka Inspector) is the go to tool in order to better understand
  130381. * what is happening in your scene
  130382. * @see https://doc.babylonjs.com/features/playground_debuglayer
  130383. */
  130384. export class DebugLayer {
  130385. /**
  130386. * Define the url to get the inspector script from.
  130387. * By default it uses the babylonjs CDN.
  130388. * @ignoreNaming
  130389. */
  130390. static InspectorURL: string;
  130391. private _scene;
  130392. private BJSINSPECTOR;
  130393. private _onPropertyChangedObservable?;
  130394. /**
  130395. * Observable triggered when a property is changed through the inspector.
  130396. */
  130397. get onPropertyChangedObservable(): any;
  130398. /**
  130399. * Instantiates a new debug layer.
  130400. * The debug layer (aka Inspector) is the go to tool in order to better understand
  130401. * what is happening in your scene
  130402. * @see https://doc.babylonjs.com/features/playground_debuglayer
  130403. * @param scene Defines the scene to inspect
  130404. */
  130405. constructor(scene: Scene);
  130406. /** Creates the inspector window. */
  130407. private _createInspector;
  130408. /**
  130409. * Select a specific entity in the scene explorer and highlight a specific block in that entity property grid
  130410. * @param entity defines the entity to select
  130411. * @param lineContainerTitles defines the specific blocks to highlight (could be a string or an array of strings)
  130412. */
  130413. select(entity: any, lineContainerTitles?: string | string[]): void;
  130414. /** Get the inspector from bundle or global */
  130415. private _getGlobalInspector;
  130416. /**
  130417. * Get if the inspector is visible or not.
  130418. * @returns true if visible otherwise, false
  130419. */
  130420. isVisible(): boolean;
  130421. /**
  130422. * Hide the inspector and close its window.
  130423. */
  130424. hide(): void;
  130425. /**
  130426. * Update the scene in the inspector
  130427. */
  130428. setAsActiveScene(): void;
  130429. /**
  130430. * Launch the debugLayer.
  130431. * @param config Define the configuration of the inspector
  130432. * @return a promise fulfilled when the debug layer is visible
  130433. */
  130434. show(config?: IInspectorOptions): Promise<DebugLayer>;
  130435. }
  130436. }
  130437. declare module BABYLON {
  130438. /**
  130439. * Class containing static functions to help procedurally build meshes
  130440. */
  130441. export class BoxBuilder {
  130442. /**
  130443. * Creates a box mesh
  130444. * * The parameter `size` sets the size (float) of each box side (default 1)
  130445. * * You can set some different box dimensions by using the parameters `width`, `height` and `depth` (all by default have the same value of `size`)
  130446. * * 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)
  130447. * * Please read this tutorial : https://doc.babylonjs.com/how_to/createbox_per_face_textures_and_colors
  130448. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  130449. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  130450. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  130451. * @see https://doc.babylonjs.com/how_to/set_shapes#box
  130452. * @param name defines the name of the mesh
  130453. * @param options defines the options used to create the mesh
  130454. * @param scene defines the hosting scene
  130455. * @returns the box mesh
  130456. */
  130457. static CreateBox(name: string, options: {
  130458. size?: number;
  130459. width?: number;
  130460. height?: number;
  130461. depth?: number;
  130462. faceUV?: Vector4[];
  130463. faceColors?: Color4[];
  130464. sideOrientation?: number;
  130465. frontUVs?: Vector4;
  130466. backUVs?: Vector4;
  130467. wrap?: boolean;
  130468. topBaseAt?: number;
  130469. bottomBaseAt?: number;
  130470. updatable?: boolean;
  130471. }, scene?: Nullable<Scene>): Mesh;
  130472. }
  130473. }
  130474. declare module BABYLON.Debug {
  130475. /**
  130476. * Used to show the physics impostor around the specific mesh
  130477. */
  130478. export class PhysicsViewer {
  130479. /** @hidden */
  130480. protected _impostors: Array<Nullable<PhysicsImpostor>>;
  130481. /** @hidden */
  130482. protected _meshes: Array<Nullable<AbstractMesh>>;
  130483. /** @hidden */
  130484. protected _scene: Nullable<Scene>;
  130485. /** @hidden */
  130486. protected _numMeshes: number;
  130487. /** @hidden */
  130488. protected _physicsEnginePlugin: Nullable<IPhysicsEnginePlugin>;
  130489. private _renderFunction;
  130490. private _utilityLayer;
  130491. private _debugBoxMesh;
  130492. private _debugSphereMesh;
  130493. private _debugCylinderMesh;
  130494. private _debugMaterial;
  130495. private _debugMeshMeshes;
  130496. /**
  130497. * Creates a new PhysicsViewer
  130498. * @param scene defines the hosting scene
  130499. */
  130500. constructor(scene: Scene);
  130501. /** @hidden */
  130502. protected _updateDebugMeshes(): void;
  130503. /**
  130504. * Renders a specified physic impostor
  130505. * @param impostor defines the impostor to render
  130506. * @param targetMesh defines the mesh represented by the impostor
  130507. * @returns the new debug mesh used to render the impostor
  130508. */
  130509. showImpostor(impostor: PhysicsImpostor, targetMesh?: Mesh): Nullable<AbstractMesh>;
  130510. /**
  130511. * Hides a specified physic impostor
  130512. * @param impostor defines the impostor to hide
  130513. */
  130514. hideImpostor(impostor: Nullable<PhysicsImpostor>): void;
  130515. private _getDebugMaterial;
  130516. private _getDebugBoxMesh;
  130517. private _getDebugSphereMesh;
  130518. private _getDebugCylinderMesh;
  130519. private _getDebugMeshMesh;
  130520. private _getDebugMesh;
  130521. /** Releases all resources */
  130522. dispose(): void;
  130523. }
  130524. }
  130525. declare module BABYLON {
  130526. /**
  130527. * As raycast might be hard to debug, the RayHelper can help rendering the different rays
  130528. * in order to better appreciate the issue one might have.
  130529. * @see https://doc.babylonjs.com/babylon101/raycasts#debugging
  130530. */
  130531. export class RayHelper {
  130532. /**
  130533. * Defines the ray we are currently tryin to visualize.
  130534. */
  130535. ray: Nullable<Ray>;
  130536. private _renderPoints;
  130537. private _renderLine;
  130538. private _renderFunction;
  130539. private _scene;
  130540. private _onAfterRenderObserver;
  130541. private _onAfterStepObserver;
  130542. private _attachedToMesh;
  130543. private _meshSpaceDirection;
  130544. private _meshSpaceOrigin;
  130545. /**
  130546. * Helper function to create a colored helper in a scene in one line.
  130547. * @param ray Defines the ray we are currently tryin to visualize
  130548. * @param scene Defines the scene the ray is used in
  130549. * @param color Defines the color we want to see the ray in
  130550. * @returns The newly created ray helper.
  130551. */
  130552. static CreateAndShow(ray: Ray, scene: Scene, color: Color3): RayHelper;
  130553. /**
  130554. * Instantiate a new ray helper.
  130555. * As raycast might be hard to debug, the RayHelper can help rendering the different rays
  130556. * in order to better appreciate the issue one might have.
  130557. * @see https://doc.babylonjs.com/babylon101/raycasts#debugging
  130558. * @param ray Defines the ray we are currently tryin to visualize
  130559. */
  130560. constructor(ray: Ray);
  130561. /**
  130562. * Shows the ray we are willing to debug.
  130563. * @param scene Defines the scene the ray needs to be rendered in
  130564. * @param color Defines the color the ray needs to be rendered in
  130565. */
  130566. show(scene: Scene, color?: Color3): void;
  130567. /**
  130568. * Hides the ray we are debugging.
  130569. */
  130570. hide(): void;
  130571. private _render;
  130572. /**
  130573. * Attach a ray helper to a mesh so that we can easily see its orientation for instance or information like its normals.
  130574. * @param mesh Defines the mesh we want the helper attached to
  130575. * @param meshSpaceDirection Defines the direction of the Ray in mesh space (local space of the mesh node)
  130576. * @param meshSpaceOrigin Defines the origin of the Ray in mesh space (local space of the mesh node)
  130577. * @param length Defines the length of the ray
  130578. */
  130579. attachToMesh(mesh: AbstractMesh, meshSpaceDirection?: Vector3, meshSpaceOrigin?: Vector3, length?: number): void;
  130580. /**
  130581. * Detach the ray helper from the mesh it has previously been attached to.
  130582. */
  130583. detachFromMesh(): void;
  130584. private _updateToMesh;
  130585. /**
  130586. * Dispose the helper and release its associated resources.
  130587. */
  130588. dispose(): void;
  130589. }
  130590. }
  130591. declare module BABYLON {
  130592. /**
  130593. * Defines the options associated with the creation of a SkeletonViewer.
  130594. */
  130595. export interface ISkeletonViewerOptions {
  130596. /** Should the system pause animations before building the Viewer? */
  130597. pauseAnimations: boolean;
  130598. /** Should the system return the skeleton to rest before building? */
  130599. returnToRest: boolean;
  130600. /** public Display Mode of the Viewer */
  130601. displayMode: number;
  130602. /** Flag to toggle if the Viewer should use the CPU for animations or not? */
  130603. displayOptions: ISkeletonViewerDisplayOptions;
  130604. /** Flag to toggle if the Viewer should use the CPU for animations or not? */
  130605. computeBonesUsingShaders: boolean;
  130606. }
  130607. /**
  130608. * Defines how to display the various bone meshes for the viewer.
  130609. */
  130610. export interface ISkeletonViewerDisplayOptions {
  130611. /** How far down to start tapering the bone spurs */
  130612. midStep?: number;
  130613. /** How big is the midStep? */
  130614. midStepFactor?: number;
  130615. /** Base for the Sphere Size */
  130616. sphereBaseSize?: number;
  130617. /** The ratio of the sphere to the longest bone in units */
  130618. sphereScaleUnit?: number;
  130619. /** Ratio for the Sphere Size */
  130620. sphereFactor?: number;
  130621. }
  130622. }
  130623. declare module BABYLON {
  130624. /**
  130625. * Class containing static functions to help procedurally build meshes
  130626. */
  130627. export class RibbonBuilder {
  130628. /**
  130629. * Creates a ribbon mesh. The ribbon is a parametric shape. It has no predefined shape. Its final shape will depend on the input parameters
  130630. * * The parameter `pathArray` is a required array of paths, what are each an array of successive Vector3. The pathArray parameter depicts the ribbon geometry
  130631. * * The parameter `closeArray` (boolean, default false) creates a seam between the first and the last paths of the path array
  130632. * * The parameter `closePath` (boolean, default false) creates a seam between the first and the last points of each path of the path array
  130633. * * 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
  130634. * * 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
  130635. * * 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
  130636. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  130637. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  130638. * * The optional parameter `invertUV` (boolean, default false) swaps in the geometry the U and V coordinates to apply a texture
  130639. * * 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
  130640. * * The parameters `colors` is an optional flat array of `Color4` to set/update each ribbon vertex with its own custom color values
  130641. * * 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
  130642. * * Moreover, you can use the parameter `color` with `instance` (to update the ribbon), only if you previously used it at creation time
  130643. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  130644. * @param name defines the name of the mesh
  130645. * @param options defines the options used to create the mesh
  130646. * @param scene defines the hosting scene
  130647. * @returns the ribbon mesh
  130648. * @see https://doc.babylonjs.com/how_to/ribbon_tutorial
  130649. * @see https://doc.babylonjs.com/how_to/parametric_shapes
  130650. */
  130651. static CreateRibbon(name: string, options: {
  130652. pathArray: Vector3[][];
  130653. closeArray?: boolean;
  130654. closePath?: boolean;
  130655. offset?: number;
  130656. updatable?: boolean;
  130657. sideOrientation?: number;
  130658. frontUVs?: Vector4;
  130659. backUVs?: Vector4;
  130660. instance?: Mesh;
  130661. invertUV?: boolean;
  130662. uvs?: Vector2[];
  130663. colors?: Color4[];
  130664. }, scene?: Nullable<Scene>): Mesh;
  130665. }
  130666. }
  130667. declare module BABYLON {
  130668. /**
  130669. * Class containing static functions to help procedurally build meshes
  130670. */
  130671. export class ShapeBuilder {
  130672. /**
  130673. * 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.
  130674. * * 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.
  130675. * * The parameter `path` is a required array of successive Vector3. This is the axis curve the shape is extruded along.
  130676. * * 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.
  130677. * * The parameter `scale` (float, default 1) is the value to scale the shape.
  130678. * * 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
  130679. * * 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
  130680. * * Remember you can only change the shape or path point positions, not their number when updating an extruded shape.
  130681. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  130682. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  130683. * * The optional parameter `invertUV` (boolean, default false) swaps in the geometry the U and V coordinates to apply a texture.
  130684. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created.
  130685. * @param name defines the name of the mesh
  130686. * @param options defines the options used to create the mesh
  130687. * @param scene defines the hosting scene
  130688. * @returns the extruded shape mesh
  130689. * @see https://doc.babylonjs.com/how_to/parametric_shapes
  130690. * @see https://doc.babylonjs.com/how_to/parametric_shapes#extruded-shapes
  130691. */
  130692. static ExtrudeShape(name: string, options: {
  130693. shape: Vector3[];
  130694. path: Vector3[];
  130695. scale?: number;
  130696. rotation?: number;
  130697. cap?: number;
  130698. updatable?: boolean;
  130699. sideOrientation?: number;
  130700. frontUVs?: Vector4;
  130701. backUVs?: Vector4;
  130702. instance?: Mesh;
  130703. invertUV?: boolean;
  130704. }, scene?: Nullable<Scene>): Mesh;
  130705. /**
  130706. * Creates an custom extruded shape mesh.
  130707. * The custom extrusion is a parametric shape. It has no predefined shape. Its final shape will depend on the input parameters.
  130708. * * 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.
  130709. * * The parameter `path` is a required array of successive Vector3. This is the axis curve the shape is extruded along.
  130710. * * 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
  130711. * * It must returns a float value that will be the rotation in radians applied to the shape on each path point.
  130712. * * 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
  130713. * * It must returns a float value that will be the scale value applied to the shape on each path point
  130714. * * The parameter `ribbonClosePath` (boolean, default false) forces the extrusion underlying ribbon to close all the paths in its `pathArray`
  130715. * * The parameter `ribbonCloseArray` (boolean, default false) forces the extrusion underlying ribbon to close its `pathArray`
  130716. * * 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
  130717. * * 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
  130718. * * Remember you can only change the shape or path point positions, not their number when updating an extruded shape
  130719. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  130720. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  130721. * * The optional parameter `invertUV` (boolean, default false) swaps in the geometry the U and V coordinates to apply a texture
  130722. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  130723. * @param name defines the name of the mesh
  130724. * @param options defines the options used to create the mesh
  130725. * @param scene defines the hosting scene
  130726. * @returns the custom extruded shape mesh
  130727. * @see https://doc.babylonjs.com/how_to/parametric_shapes#custom-extruded-shapes
  130728. * @see https://doc.babylonjs.com/how_to/parametric_shapes
  130729. * @see https://doc.babylonjs.com/how_to/parametric_shapes#extruded-shapes
  130730. */
  130731. static ExtrudeShapeCustom(name: string, options: {
  130732. shape: Vector3[];
  130733. path: Vector3[];
  130734. scaleFunction?: any;
  130735. rotationFunction?: any;
  130736. ribbonCloseArray?: boolean;
  130737. ribbonClosePath?: boolean;
  130738. cap?: number;
  130739. updatable?: boolean;
  130740. sideOrientation?: number;
  130741. frontUVs?: Vector4;
  130742. backUVs?: Vector4;
  130743. instance?: Mesh;
  130744. invertUV?: boolean;
  130745. }, scene?: Nullable<Scene>): Mesh;
  130746. private static _ExtrudeShapeGeneric;
  130747. }
  130748. }
  130749. declare module BABYLON.Debug {
  130750. /**
  130751. * Class used to render a debug view of a given skeleton
  130752. * @see http://www.babylonjs-playground.com/#1BZJVJ#8
  130753. */
  130754. export class SkeletonViewer {
  130755. /** defines the skeleton to render */
  130756. skeleton: Skeleton;
  130757. /** defines the mesh attached to the skeleton */
  130758. mesh: AbstractMesh;
  130759. /** defines a boolean indicating if bones matrices must be forced to update before rendering (true by default) */
  130760. autoUpdateBonesMatrices: boolean;
  130761. /** defines the rendering group id to use with the viewer */
  130762. renderingGroupId: number;
  130763. /** is the options for the viewer */
  130764. options: Partial<ISkeletonViewerOptions>;
  130765. /** public Display constants BABYLON.SkeletonViewer.DISPLAY_LINES */
  130766. static readonly DISPLAY_LINES: number;
  130767. /** public Display constants BABYLON.SkeletonViewer.DISPLAY_SPHERES */
  130768. static readonly DISPLAY_SPHERES: number;
  130769. /** public Display constants BABYLON.SkeletonViewer.DISPLAY_SPHERE_AND_SPURS */
  130770. static readonly DISPLAY_SPHERE_AND_SPURS: number;
  130771. /** If SkeletonViewer scene scope. */
  130772. private _scene;
  130773. /** Gets or sets the color used to render the skeleton */
  130774. color: Color3;
  130775. /** Array of the points of the skeleton fo the line view. */
  130776. private _debugLines;
  130777. /** The SkeletonViewers Mesh. */
  130778. private _debugMesh;
  130779. /** If SkeletonViewer is enabled. */
  130780. private _isEnabled;
  130781. /** If SkeletonViewer is ready. */
  130782. private _ready;
  130783. /** SkeletonViewer render observable. */
  130784. private _obs;
  130785. /** The Utility Layer to render the gizmos in. */
  130786. private _utilityLayer;
  130787. private _boneIndices;
  130788. /** Gets the Scene. */
  130789. get scene(): Scene;
  130790. /** Gets the utilityLayer. */
  130791. get utilityLayer(): Nullable<UtilityLayerRenderer>;
  130792. /** Checks Ready Status. */
  130793. get isReady(): Boolean;
  130794. /** Sets Ready Status. */
  130795. set ready(value: boolean);
  130796. /** Gets the debugMesh */
  130797. get debugMesh(): Nullable<AbstractMesh> | Nullable<LinesMesh>;
  130798. /** Sets the debugMesh */
  130799. set debugMesh(value: Nullable<AbstractMesh> | Nullable<LinesMesh>);
  130800. /** Gets the material */
  130801. get material(): StandardMaterial;
  130802. /** Sets the material */
  130803. set material(value: StandardMaterial);
  130804. /** Gets the material */
  130805. get displayMode(): number;
  130806. /** Sets the material */
  130807. set displayMode(value: number);
  130808. /**
  130809. * Creates a new SkeletonViewer
  130810. * @param skeleton defines the skeleton to render
  130811. * @param mesh defines the mesh attached to the skeleton
  130812. * @param scene defines the hosting scene
  130813. * @param autoUpdateBonesMatrices defines a boolean indicating if bones matrices must be forced to update before rendering (true by default)
  130814. * @param renderingGroupId defines the rendering group id to use with the viewer
  130815. * @param options All of the extra constructor options for the SkeletonViewer
  130816. */
  130817. constructor(
  130818. /** defines the skeleton to render */
  130819. skeleton: Skeleton,
  130820. /** defines the mesh attached to the skeleton */
  130821. mesh: AbstractMesh,
  130822. /** The Scene scope*/
  130823. scene: Scene,
  130824. /** defines a boolean indicating if bones matrices must be forced to update before rendering (true by default) */
  130825. autoUpdateBonesMatrices?: boolean,
  130826. /** defines the rendering group id to use with the viewer */
  130827. renderingGroupId?: number,
  130828. /** is the options for the viewer */
  130829. options?: Partial<ISkeletonViewerOptions>);
  130830. /** The Dynamic bindings for the update functions */
  130831. private _bindObs;
  130832. /** Update the viewer to sync with current skeleton state, only used to manually update. */
  130833. update(): void;
  130834. /** Gets or sets a boolean indicating if the viewer is enabled */
  130835. set isEnabled(value: boolean);
  130836. get isEnabled(): boolean;
  130837. private _getBonePosition;
  130838. private _getLinesForBonesWithLength;
  130839. private _getLinesForBonesNoLength;
  130840. /** function to revert the mesh and scene back to the initial state. */
  130841. private _revert;
  130842. /** function to build and bind sphere joint points and spur bone representations. */
  130843. private _buildSpheresAndSpurs;
  130844. /** Update the viewer to sync with current skeleton state, only used for the line display. */
  130845. private _displayLinesUpdate;
  130846. /** Changes the displayMode of the skeleton viewer
  130847. * @param mode The displayMode numerical value
  130848. */
  130849. changeDisplayMode(mode: number): void;
  130850. /** Changes the displayMode of the skeleton viewer
  130851. * @param option String of the option name
  130852. * @param value The numerical option value
  130853. */
  130854. changeDisplayOptions(option: string, value: number): void;
  130855. /** Release associated resources */
  130856. dispose(): void;
  130857. }
  130858. }
  130859. declare module BABYLON {
  130860. /**
  130861. * Enum for Device Types
  130862. */
  130863. export enum DeviceType {
  130864. /** Generic */
  130865. Generic = 0,
  130866. /** Keyboard */
  130867. Keyboard = 1,
  130868. /** Mouse */
  130869. Mouse = 2,
  130870. /** Touch Pointers */
  130871. Touch = 3,
  130872. /** PS4 Dual Shock */
  130873. DualShock = 4,
  130874. /** Xbox */
  130875. Xbox = 5,
  130876. /** Switch Controller */
  130877. Switch = 6
  130878. }
  130879. /**
  130880. * Enum for All Pointers (Touch/Mouse)
  130881. */
  130882. export enum PointerInput {
  130883. /** Horizontal Axis */
  130884. Horizontal = 0,
  130885. /** Vertical Axis */
  130886. Vertical = 1,
  130887. /** Left Click or Touch */
  130888. LeftClick = 2,
  130889. /** Middle Click */
  130890. MiddleClick = 3,
  130891. /** Right Click */
  130892. RightClick = 4,
  130893. /** Browser Back */
  130894. BrowserBack = 5,
  130895. /** Browser Forward */
  130896. BrowserForward = 6
  130897. }
  130898. /**
  130899. * Enum for Dual Shock Gamepad
  130900. */
  130901. export enum DualShockInput {
  130902. /** Cross */
  130903. Cross = 0,
  130904. /** Circle */
  130905. Circle = 1,
  130906. /** Square */
  130907. Square = 2,
  130908. /** Triangle */
  130909. Triangle = 3,
  130910. /** L1 */
  130911. L1 = 4,
  130912. /** R1 */
  130913. R1 = 5,
  130914. /** L2 */
  130915. L2 = 6,
  130916. /** R2 */
  130917. R2 = 7,
  130918. /** Share */
  130919. Share = 8,
  130920. /** Options */
  130921. Options = 9,
  130922. /** L3 */
  130923. L3 = 10,
  130924. /** R3 */
  130925. R3 = 11,
  130926. /** DPadUp */
  130927. DPadUp = 12,
  130928. /** DPadDown */
  130929. DPadDown = 13,
  130930. /** DPadLeft */
  130931. DPadLeft = 14,
  130932. /** DRight */
  130933. DPadRight = 15,
  130934. /** Home */
  130935. Home = 16,
  130936. /** TouchPad */
  130937. TouchPad = 17,
  130938. /** LStickXAxis */
  130939. LStickXAxis = 18,
  130940. /** LStickYAxis */
  130941. LStickYAxis = 19,
  130942. /** RStickXAxis */
  130943. RStickXAxis = 20,
  130944. /** RStickYAxis */
  130945. RStickYAxis = 21
  130946. }
  130947. /**
  130948. * Enum for Xbox Gamepad
  130949. */
  130950. export enum XboxInput {
  130951. /** A */
  130952. A = 0,
  130953. /** B */
  130954. B = 1,
  130955. /** X */
  130956. X = 2,
  130957. /** Y */
  130958. Y = 3,
  130959. /** LB */
  130960. LB = 4,
  130961. /** RB */
  130962. RB = 5,
  130963. /** LT */
  130964. LT = 6,
  130965. /** RT */
  130966. RT = 7,
  130967. /** Back */
  130968. Back = 8,
  130969. /** Start */
  130970. Start = 9,
  130971. /** LS */
  130972. LS = 10,
  130973. /** RS */
  130974. RS = 11,
  130975. /** DPadUp */
  130976. DPadUp = 12,
  130977. /** DPadDown */
  130978. DPadDown = 13,
  130979. /** DPadLeft */
  130980. DPadLeft = 14,
  130981. /** DRight */
  130982. DPadRight = 15,
  130983. /** Home */
  130984. Home = 16,
  130985. /** LStickXAxis */
  130986. LStickXAxis = 17,
  130987. /** LStickYAxis */
  130988. LStickYAxis = 18,
  130989. /** RStickXAxis */
  130990. RStickXAxis = 19,
  130991. /** RStickYAxis */
  130992. RStickYAxis = 20
  130993. }
  130994. /**
  130995. * Enum for Switch (Pro/JoyCon L+R) Gamepad
  130996. */
  130997. export enum SwitchInput {
  130998. /** B */
  130999. B = 0,
  131000. /** A */
  131001. A = 1,
  131002. /** Y */
  131003. Y = 2,
  131004. /** X */
  131005. X = 3,
  131006. /** L */
  131007. L = 4,
  131008. /** R */
  131009. R = 5,
  131010. /** ZL */
  131011. ZL = 6,
  131012. /** ZR */
  131013. ZR = 7,
  131014. /** Minus */
  131015. Minus = 8,
  131016. /** Plus */
  131017. Plus = 9,
  131018. /** LS */
  131019. LS = 10,
  131020. /** RS */
  131021. RS = 11,
  131022. /** DPadUp */
  131023. DPadUp = 12,
  131024. /** DPadDown */
  131025. DPadDown = 13,
  131026. /** DPadLeft */
  131027. DPadLeft = 14,
  131028. /** DRight */
  131029. DPadRight = 15,
  131030. /** Home */
  131031. Home = 16,
  131032. /** Capture */
  131033. Capture = 17,
  131034. /** LStickXAxis */
  131035. LStickXAxis = 18,
  131036. /** LStickYAxis */
  131037. LStickYAxis = 19,
  131038. /** RStickXAxis */
  131039. RStickXAxis = 20,
  131040. /** RStickYAxis */
  131041. RStickYAxis = 21
  131042. }
  131043. }
  131044. declare module BABYLON {
  131045. /**
  131046. * This class will take all inputs from Keyboard, Pointer, and
  131047. * any Gamepads and provide a polling system that all devices
  131048. * will use. This class assumes that there will only be one
  131049. * pointer device and one keyboard.
  131050. */
  131051. export class DeviceInputSystem implements IDisposable {
  131052. /**
  131053. * Callback to be triggered when a device is connected
  131054. */
  131055. onDeviceConnected: (deviceType: DeviceType, deviceSlot: number) => void;
  131056. /**
  131057. * Callback to be triggered when a device is disconnected
  131058. */
  131059. onDeviceDisconnected: (deviceType: DeviceType, deviceSlot: number) => void;
  131060. /**
  131061. * Callback to be triggered when event driven input is updated
  131062. */
  131063. onInputChanged: (deviceType: DeviceType, deviceSlot: number, inputIndex: number, previousState: Nullable<number>, currentState: Nullable<number>) => void;
  131064. private _inputs;
  131065. private _gamepads;
  131066. private _keyboardActive;
  131067. private _pointerActive;
  131068. private _elementToAttachTo;
  131069. private _keyboardDownEvent;
  131070. private _keyboardUpEvent;
  131071. private _pointerMoveEvent;
  131072. private _pointerDownEvent;
  131073. private _pointerUpEvent;
  131074. private _gamepadConnectedEvent;
  131075. private _gamepadDisconnectedEvent;
  131076. private static _MAX_KEYCODES;
  131077. private static _MAX_POINTER_INPUTS;
  131078. private constructor();
  131079. /**
  131080. * Creates a new DeviceInputSystem instance
  131081. * @param engine Engine to pull input element from
  131082. * @returns The new instance
  131083. */
  131084. static Create(engine: Engine): DeviceInputSystem;
  131085. /**
  131086. * Checks for current device input value, given an id and input index
  131087. * @param deviceName Id of connected device
  131088. * @param inputIndex Index of device input
  131089. * @returns Current value of input
  131090. */
  131091. /**
  131092. * Checks for current device input value, given an id and input index. Throws exception if requested device not initialized.
  131093. * @param deviceType Enum specifiying device type
  131094. * @param deviceSlot "Slot" or index that device is referenced in
  131095. * @param inputIndex Id of input to be checked
  131096. * @returns Current value of input
  131097. */
  131098. pollInput(deviceType: DeviceType, deviceSlot: number, inputIndex: number): number;
  131099. /**
  131100. * Dispose of all the eventlisteners
  131101. */
  131102. dispose(): void;
  131103. /**
  131104. * Add device and inputs to device array
  131105. * @param deviceType Enum specifiying device type
  131106. * @param deviceSlot "Slot" or index that device is referenced in
  131107. * @param numberOfInputs Number of input entries to create for given device
  131108. */
  131109. private _registerDevice;
  131110. /**
  131111. * Given a specific device name, remove that device from the device map
  131112. * @param deviceType Enum specifiying device type
  131113. * @param deviceSlot "Slot" or index that device is referenced in
  131114. */
  131115. private _unregisterDevice;
  131116. /**
  131117. * Handle all actions that come from keyboard interaction
  131118. */
  131119. private _handleKeyActions;
  131120. /**
  131121. * Handle all actions that come from pointer interaction
  131122. */
  131123. private _handlePointerActions;
  131124. /**
  131125. * Handle all actions that come from gamepad interaction
  131126. */
  131127. private _handleGamepadActions;
  131128. /**
  131129. * Update all non-event based devices with each frame
  131130. * @param deviceType Enum specifiying device type
  131131. * @param deviceSlot "Slot" or index that device is referenced in
  131132. * @param inputIndex Id of input to be checked
  131133. */
  131134. private _updateDevice;
  131135. /**
  131136. * Gets DeviceType from the device name
  131137. * @param deviceName Name of Device from DeviceInputSystem
  131138. * @returns DeviceType enum value
  131139. */
  131140. private _getGamepadDeviceType;
  131141. }
  131142. }
  131143. declare module BABYLON {
  131144. /**
  131145. * Type to handle enforcement of inputs
  131146. */
  131147. 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;
  131148. }
  131149. declare module BABYLON {
  131150. /**
  131151. * Class that handles all input for a specific device
  131152. */
  131153. export class DeviceSource<T extends DeviceType> {
  131154. /** Type of device */
  131155. readonly deviceType: DeviceType;
  131156. /** "Slot" or index that device is referenced in */
  131157. readonly deviceSlot: number;
  131158. /**
  131159. * Observable to handle device input changes per device
  131160. */
  131161. readonly onInputChangedObservable: Observable<{
  131162. inputIndex: DeviceInput<T>;
  131163. previousState: Nullable<number>;
  131164. currentState: Nullable<number>;
  131165. }>;
  131166. private readonly _deviceInputSystem;
  131167. /**
  131168. * Default Constructor
  131169. * @param deviceInputSystem Reference to DeviceInputSystem
  131170. * @param deviceType Type of device
  131171. * @param deviceSlot "Slot" or index that device is referenced in
  131172. */
  131173. constructor(deviceInputSystem: DeviceInputSystem,
  131174. /** Type of device */
  131175. deviceType: DeviceType,
  131176. /** "Slot" or index that device is referenced in */
  131177. deviceSlot?: number);
  131178. /**
  131179. * Get input for specific input
  131180. * @param inputIndex index of specific input on device
  131181. * @returns Input value from DeviceInputSystem
  131182. */
  131183. getInput(inputIndex: DeviceInput<T>): Nullable<number>;
  131184. }
  131185. /**
  131186. * Class to keep track of devices
  131187. */
  131188. export class DeviceSourceManager implements IDisposable {
  131189. /**
  131190. * Observable to be triggered when before a device is connected
  131191. */
  131192. readonly onBeforeDeviceConnectedObservable: Observable<{
  131193. deviceType: DeviceType;
  131194. deviceSlot: number;
  131195. }>;
  131196. /**
  131197. * Observable to be triggered when before a device is disconnected
  131198. */
  131199. readonly onBeforeDeviceDisconnectedObservable: Observable<{
  131200. deviceType: DeviceType;
  131201. deviceSlot: number;
  131202. }>;
  131203. /**
  131204. * Observable to be triggered when after a device is connected
  131205. */
  131206. readonly onAfterDeviceConnectedObservable: Observable<{
  131207. deviceType: DeviceType;
  131208. deviceSlot: number;
  131209. }>;
  131210. /**
  131211. * Observable to be triggered when after a device is disconnected
  131212. */
  131213. readonly onAfterDeviceDisconnectedObservable: Observable<{
  131214. deviceType: DeviceType;
  131215. deviceSlot: number;
  131216. }>;
  131217. private readonly _devices;
  131218. private readonly _firstDevice;
  131219. private readonly _deviceInputSystem;
  131220. /**
  131221. * Default Constructor
  131222. * @param engine engine to pull input element from
  131223. */
  131224. constructor(engine: Engine);
  131225. /**
  131226. * Gets a DeviceSource, given a type and slot
  131227. * @param deviceType Enum specifying device type
  131228. * @param deviceSlot "Slot" or index that device is referenced in
  131229. * @returns DeviceSource object
  131230. */
  131231. getDeviceSource<T extends DeviceType>(deviceType: T, deviceSlot?: number): Nullable<DeviceSource<T>>;
  131232. /**
  131233. * Gets an array of DeviceSource objects for a given device type
  131234. * @param deviceType Enum specifying device type
  131235. * @returns Array of DeviceSource objects
  131236. */
  131237. getDeviceSources<T extends DeviceType>(deviceType: T): ReadonlyArray<DeviceSource<T>>;
  131238. /**
  131239. * Dispose of DeviceInputSystem and other parts
  131240. */
  131241. dispose(): void;
  131242. /**
  131243. * Function to add device name to device list
  131244. * @param deviceType Enum specifying device type
  131245. * @param deviceSlot "Slot" or index that device is referenced in
  131246. */
  131247. private _addDevice;
  131248. /**
  131249. * Function to remove device name to device list
  131250. * @param deviceType Enum specifying device type
  131251. * @param deviceSlot "Slot" or index that device is referenced in
  131252. */
  131253. private _removeDevice;
  131254. /**
  131255. * Updates array storing first connected device of each type
  131256. * @param type Type of Device
  131257. */
  131258. private _updateFirstDevices;
  131259. }
  131260. }
  131261. declare module BABYLON {
  131262. /**
  131263. * Options to create the null engine
  131264. */
  131265. export class NullEngineOptions {
  131266. /**
  131267. * Render width (Default: 512)
  131268. */
  131269. renderWidth: number;
  131270. /**
  131271. * Render height (Default: 256)
  131272. */
  131273. renderHeight: number;
  131274. /**
  131275. * Texture size (Default: 512)
  131276. */
  131277. textureSize: number;
  131278. /**
  131279. * If delta time between frames should be constant
  131280. * @see https://doc.babylonjs.com/babylon101/animations#deterministic-lockstep
  131281. */
  131282. deterministicLockstep: boolean;
  131283. /**
  131284. * Maximum about of steps between frames (Default: 4)
  131285. * @see https://doc.babylonjs.com/babylon101/animations#deterministic-lockstep
  131286. */
  131287. lockstepMaxSteps: number;
  131288. /**
  131289. * Make the matrix computations to be performed in 64 bits instead of 32 bits. False by default
  131290. */
  131291. useHighPrecisionMatrix?: boolean;
  131292. }
  131293. /**
  131294. * The null engine class provides support for headless version of babylon.js.
  131295. * This can be used in server side scenario or for testing purposes
  131296. */
  131297. export class NullEngine extends Engine {
  131298. private _options;
  131299. /**
  131300. * Gets a boolean indicating that the engine is running in deterministic lock step mode
  131301. * @see https://doc.babylonjs.com/babylon101/animations#deterministic-lockstep
  131302. * @returns true if engine is in deterministic lock step mode
  131303. */
  131304. isDeterministicLockStep(): boolean;
  131305. /**
  131306. * Gets the max steps when engine is running in deterministic lock step
  131307. * @see https://doc.babylonjs.com/babylon101/animations#deterministic-lockstep
  131308. * @returns the max steps
  131309. */
  131310. getLockstepMaxSteps(): number;
  131311. /**
  131312. * Gets the current hardware scaling level.
  131313. * By default the hardware scaling level is computed from the window device ratio.
  131314. * 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.
  131315. * @returns a number indicating the current hardware scaling level
  131316. */
  131317. getHardwareScalingLevel(): number;
  131318. constructor(options?: NullEngineOptions);
  131319. /**
  131320. * Creates a vertex buffer
  131321. * @param vertices the data for the vertex buffer
  131322. * @returns the new WebGL static buffer
  131323. */
  131324. createVertexBuffer(vertices: FloatArray): DataBuffer;
  131325. /**
  131326. * Creates a new index buffer
  131327. * @param indices defines the content of the index buffer
  131328. * @param updatable defines if the index buffer must be updatable
  131329. * @returns a new webGL buffer
  131330. */
  131331. createIndexBuffer(indices: IndicesArray): DataBuffer;
  131332. /**
  131333. * Clear the current render buffer or the current render target (if any is set up)
  131334. * @param color defines the color to use
  131335. * @param backBuffer defines if the back buffer must be cleared
  131336. * @param depth defines if the depth buffer must be cleared
  131337. * @param stencil defines if the stencil buffer must be cleared
  131338. */
  131339. clear(color: IColor4Like, backBuffer: boolean, depth: boolean, stencil?: boolean): void;
  131340. /**
  131341. * Gets the current render width
  131342. * @param useScreen defines if screen size must be used (or the current render target if any)
  131343. * @returns a number defining the current render width
  131344. */
  131345. getRenderWidth(useScreen?: boolean): number;
  131346. /**
  131347. * Gets the current render height
  131348. * @param useScreen defines if screen size must be used (or the current render target if any)
  131349. * @returns a number defining the current render height
  131350. */
  131351. getRenderHeight(useScreen?: boolean): number;
  131352. /**
  131353. * Set the WebGL's viewport
  131354. * @param viewport defines the viewport element to be used
  131355. * @param requiredWidth defines the width required for rendering. If not provided the rendering canvas' width is used
  131356. * @param requiredHeight defines the height required for rendering. If not provided the rendering canvas' height is used
  131357. */
  131358. setViewport(viewport: IViewportLike, requiredWidth?: number, requiredHeight?: number): void;
  131359. createShaderProgram(pipelineContext: IPipelineContext, vertexCode: string, fragmentCode: string, defines: string, context?: WebGLRenderingContext): WebGLProgram;
  131360. /**
  131361. * Gets the list of webGL uniform locations associated with a specific program based on a list of uniform names
  131362. * @param pipelineContext defines the pipeline context to use
  131363. * @param uniformsNames defines the list of uniform names
  131364. * @returns an array of webGL uniform locations
  131365. */
  131366. getUniforms(pipelineContext: IPipelineContext, uniformsNames: string[]): Nullable<WebGLUniformLocation>[];
  131367. /**
  131368. * Gets the lsit of active attributes for a given webGL program
  131369. * @param pipelineContext defines the pipeline context to use
  131370. * @param attributesNames defines the list of attribute names to get
  131371. * @returns an array of indices indicating the offset of each attribute
  131372. */
  131373. getAttributes(pipelineContext: IPipelineContext, attributesNames: string[]): number[];
  131374. /**
  131375. * Binds an effect to the webGL context
  131376. * @param effect defines the effect to bind
  131377. */
  131378. bindSamplers(effect: Effect): void;
  131379. /**
  131380. * Activates an effect, mkaing it the current one (ie. the one used for rendering)
  131381. * @param effect defines the effect to activate
  131382. */
  131383. enableEffect(effect: Effect): void;
  131384. /**
  131385. * Set various states to the webGL context
  131386. * @param culling defines backface culling state
  131387. * @param zOffset defines the value to apply to zOffset (0 by default)
  131388. * @param force defines if states must be applied even if cache is up to date
  131389. * @param reverseSide defines if culling must be reversed (CCW instead of CW and CW instead of CCW)
  131390. */
  131391. setState(culling: boolean, zOffset?: number, force?: boolean, reverseSide?: boolean): void;
  131392. /**
  131393. * Set the value of an uniform to an array of int32
  131394. * @param uniform defines the webGL uniform location where to store the value
  131395. * @param array defines the array of int32 to store
  131396. */
  131397. setIntArray(uniform: WebGLUniformLocation, array: Int32Array): void;
  131398. /**
  131399. * Set the value of an uniform to an array of int32 (stored as vec2)
  131400. * @param uniform defines the webGL uniform location where to store the value
  131401. * @param array defines the array of int32 to store
  131402. */
  131403. setIntArray2(uniform: WebGLUniformLocation, array: Int32Array): void;
  131404. /**
  131405. * Set the value of an uniform to an array of int32 (stored as vec3)
  131406. * @param uniform defines the webGL uniform location where to store the value
  131407. * @param array defines the array of int32 to store
  131408. */
  131409. setIntArray3(uniform: WebGLUniformLocation, array: Int32Array): void;
  131410. /**
  131411. * Set the value of an uniform to an array of int32 (stored as vec4)
  131412. * @param uniform defines the webGL uniform location where to store the value
  131413. * @param array defines the array of int32 to store
  131414. */
  131415. setIntArray4(uniform: WebGLUniformLocation, array: Int32Array): void;
  131416. /**
  131417. * Set the value of an uniform to an array of float32
  131418. * @param uniform defines the webGL uniform location where to store the value
  131419. * @param array defines the array of float32 to store
  131420. */
  131421. setFloatArray(uniform: WebGLUniformLocation, array: Float32Array): void;
  131422. /**
  131423. * Set the value of an uniform to an array of float32 (stored as vec2)
  131424. * @param uniform defines the webGL uniform location where to store the value
  131425. * @param array defines the array of float32 to store
  131426. */
  131427. setFloatArray2(uniform: WebGLUniformLocation, array: Float32Array): void;
  131428. /**
  131429. * Set the value of an uniform to an array of float32 (stored as vec3)
  131430. * @param uniform defines the webGL uniform location where to store the value
  131431. * @param array defines the array of float32 to store
  131432. */
  131433. setFloatArray3(uniform: WebGLUniformLocation, array: Float32Array): void;
  131434. /**
  131435. * Set the value of an uniform to an array of float32 (stored as vec4)
  131436. * @param uniform defines the webGL uniform location where to store the value
  131437. * @param array defines the array of float32 to store
  131438. */
  131439. setFloatArray4(uniform: WebGLUniformLocation, array: Float32Array): void;
  131440. /**
  131441. * Set the value of an uniform to an array of number
  131442. * @param uniform defines the webGL uniform location where to store the value
  131443. * @param array defines the array of number to store
  131444. */
  131445. setArray(uniform: WebGLUniformLocation, array: number[]): void;
  131446. /**
  131447. * Set the value of an uniform to an array of number (stored as vec2)
  131448. * @param uniform defines the webGL uniform location where to store the value
  131449. * @param array defines the array of number to store
  131450. */
  131451. setArray2(uniform: WebGLUniformLocation, array: number[]): void;
  131452. /**
  131453. * Set the value of an uniform to an array of number (stored as vec3)
  131454. * @param uniform defines the webGL uniform location where to store the value
  131455. * @param array defines the array of number to store
  131456. */
  131457. setArray3(uniform: WebGLUniformLocation, array: number[]): void;
  131458. /**
  131459. * Set the value of an uniform to an array of number (stored as vec4)
  131460. * @param uniform defines the webGL uniform location where to store the value
  131461. * @param array defines the array of number to store
  131462. */
  131463. setArray4(uniform: WebGLUniformLocation, array: number[]): void;
  131464. /**
  131465. * Set the value of an uniform to an array of float32 (stored as matrices)
  131466. * @param uniform defines the webGL uniform location where to store the value
  131467. * @param matrices defines the array of float32 to store
  131468. */
  131469. setMatrices(uniform: WebGLUniformLocation, matrices: Float32Array): void;
  131470. /**
  131471. * Set the value of an uniform to a matrix (3x3)
  131472. * @param uniform defines the webGL uniform location where to store the value
  131473. * @param matrix defines the Float32Array representing the 3x3 matrix to store
  131474. */
  131475. setMatrix3x3(uniform: WebGLUniformLocation, matrix: Float32Array): void;
  131476. /**
  131477. * Set the value of an uniform to a matrix (2x2)
  131478. * @param uniform defines the webGL uniform location where to store the value
  131479. * @param matrix defines the Float32Array representing the 2x2 matrix to store
  131480. */
  131481. setMatrix2x2(uniform: WebGLUniformLocation, matrix: Float32Array): void;
  131482. /**
  131483. * Set the value of an uniform to a number (float)
  131484. * @param uniform defines the webGL uniform location where to store the value
  131485. * @param value defines the float number to store
  131486. */
  131487. setFloat(uniform: WebGLUniformLocation, value: number): void;
  131488. /**
  131489. * Set the value of an uniform to a vec2
  131490. * @param uniform defines the webGL uniform location where to store the value
  131491. * @param x defines the 1st component of the value
  131492. * @param y defines the 2nd component of the value
  131493. */
  131494. setFloat2(uniform: WebGLUniformLocation, x: number, y: number): void;
  131495. /**
  131496. * Set the value of an uniform to a vec3
  131497. * @param uniform defines the webGL uniform location where to store the value
  131498. * @param x defines the 1st component of the value
  131499. * @param y defines the 2nd component of the value
  131500. * @param z defines the 3rd component of the value
  131501. */
  131502. setFloat3(uniform: WebGLUniformLocation, x: number, y: number, z: number): void;
  131503. /**
  131504. * Set the value of an uniform to a boolean
  131505. * @param uniform defines the webGL uniform location where to store the value
  131506. * @param bool defines the boolean to store
  131507. */
  131508. setBool(uniform: WebGLUniformLocation, bool: number): void;
  131509. /**
  131510. * Set the value of an uniform to a vec4
  131511. * @param uniform defines the webGL uniform location where to store the value
  131512. * @param x defines the 1st component of the value
  131513. * @param y defines the 2nd component of the value
  131514. * @param z defines the 3rd component of the value
  131515. * @param w defines the 4th component of the value
  131516. */
  131517. setFloat4(uniform: WebGLUniformLocation, x: number, y: number, z: number, w: number): void;
  131518. /**
  131519. * Sets the current alpha mode
  131520. * @param mode defines the mode to use (one of the Engine.ALPHA_XXX)
  131521. * @param noDepthWriteChange defines if depth writing state should remains unchanged (false by default)
  131522. * @see https://doc.babylonjs.com/resources/transparency_and_how_meshes_are_rendered
  131523. */
  131524. setAlphaMode(mode: number, noDepthWriteChange?: boolean): void;
  131525. /**
  131526. * Bind webGl buffers directly to the webGL context
  131527. * @param vertexBuffers defines the vertex buffer to bind
  131528. * @param indexBuffer defines the index buffer to bind
  131529. * @param vertexDeclaration defines the vertex declaration to use with the vertex buffer
  131530. * @param vertexStrideSize defines the vertex stride of the vertex buffer
  131531. * @param effect defines the effect associated with the vertex buffer
  131532. */
  131533. bindBuffers(vertexBuffers: {
  131534. [key: string]: VertexBuffer;
  131535. }, indexBuffer: DataBuffer, effect: Effect): void;
  131536. /**
  131537. * Force the entire cache to be cleared
  131538. * You should not have to use this function unless your engine needs to share the webGL context with another engine
  131539. * @param bruteForce defines a boolean to force clearing ALL caches (including stencil, detoh and alpha states)
  131540. */
  131541. wipeCaches(bruteForce?: boolean): void;
  131542. /**
  131543. * Send a draw order
  131544. * @param useTriangles defines if triangles must be used to draw (else wireframe will be used)
  131545. * @param indexStart defines the starting index
  131546. * @param indexCount defines the number of index to draw
  131547. * @param instancesCount defines the number of instances to draw (if instanciation is enabled)
  131548. */
  131549. draw(useTriangles: boolean, indexStart: number, indexCount: number, instancesCount?: number): void;
  131550. /**
  131551. * Draw a list of indexed primitives
  131552. * @param fillMode defines the primitive to use
  131553. * @param indexStart defines the starting index
  131554. * @param indexCount defines the number of index to draw
  131555. * @param instancesCount defines the number of instances to draw (if instanciation is enabled)
  131556. */
  131557. drawElementsType(fillMode: number, indexStart: number, indexCount: number, instancesCount?: number): void;
  131558. /**
  131559. * Draw a list of unindexed primitives
  131560. * @param fillMode defines the primitive to use
  131561. * @param verticesStart defines the index of first vertex to draw
  131562. * @param verticesCount defines the count of vertices to draw
  131563. * @param instancesCount defines the number of instances to draw (if instanciation is enabled)
  131564. */
  131565. drawArraysType(fillMode: number, verticesStart: number, verticesCount: number, instancesCount?: number): void;
  131566. /** @hidden */
  131567. _createTexture(): WebGLTexture;
  131568. /** @hidden */
  131569. _releaseTexture(texture: InternalTexture): void;
  131570. /**
  131571. * Usually called from Texture.ts.
  131572. * Passed information to create a WebGLTexture
  131573. * @param urlArg defines a value which contains one of the following:
  131574. * * A conventional http URL, e.g. 'http://...' or 'file://...'
  131575. * * A base64 string of in-line texture data, e.g. 'data:image/jpg;base64,/...'
  131576. * * An indicator that data being passed using the buffer parameter, e.g. 'data:mytexture.jpg'
  131577. * @param noMipmap defines a boolean indicating that no mipmaps shall be generated. Ignored for compressed textures. They must be in the file
  131578. * @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)
  131579. * @param scene needed for loading to the correct scene
  131580. * @param samplingMode mode with should be used sample / access the texture (Default: Texture.TRILINEAR_SAMPLINGMODE)
  131581. * @param onLoad optional callback to be called upon successful completion
  131582. * @param onError optional callback to be called upon failure
  131583. * @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
  131584. * @param fallback an internal argument in case the function must be called again, due to etc1 not having alpha capabilities
  131585. * @param format internal format. Default: RGB when extension is '.jpg' else RGBA. Ignored for compressed textures
  131586. * @param forcedExtension defines the extension to use to pick the right loader
  131587. * @param mimeType defines an optional mime type
  131588. * @returns a InternalTexture for assignment back into BABYLON.Texture
  131589. */
  131590. 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;
  131591. /**
  131592. * Creates a new render target texture
  131593. * @param size defines the size of the texture
  131594. * @param options defines the options used to create the texture
  131595. * @returns a new render target texture stored in an InternalTexture
  131596. */
  131597. createRenderTargetTexture(size: any, options: boolean | RenderTargetCreationOptions): InternalTexture;
  131598. /**
  131599. * Update the sampling mode of a given texture
  131600. * @param samplingMode defines the required sampling mode
  131601. * @param texture defines the texture to update
  131602. */
  131603. updateTextureSamplingMode(samplingMode: number, texture: InternalTexture): void;
  131604. /**
  131605. * Binds the frame buffer to the specified texture.
  131606. * @param texture The texture to render to or null for the default canvas
  131607. * @param faceIndex The face of the texture to render to in case of cube texture
  131608. * @param requiredWidth The width of the target to render to
  131609. * @param requiredHeight The height of the target to render to
  131610. * @param forceFullscreenViewport Forces the viewport to be the entire texture/screen if true
  131611. * @param lodLevel defines le lod level to bind to the frame buffer
  131612. */
  131613. bindFramebuffer(texture: InternalTexture, faceIndex?: number, requiredWidth?: number, requiredHeight?: number, forceFullscreenViewport?: boolean): void;
  131614. /**
  131615. * Unbind the current render target texture from the webGL context
  131616. * @param texture defines the render target texture to unbind
  131617. * @param disableGenerateMipMaps defines a boolean indicating that mipmaps must not be generated
  131618. * @param onBeforeUnbind defines a function which will be called before the effective unbind
  131619. */
  131620. unBindFramebuffer(texture: InternalTexture, disableGenerateMipMaps?: boolean, onBeforeUnbind?: () => void): void;
  131621. /**
  131622. * Creates a dynamic vertex buffer
  131623. * @param vertices the data for the dynamic vertex buffer
  131624. * @returns the new WebGL dynamic buffer
  131625. */
  131626. createDynamicVertexBuffer(vertices: FloatArray): DataBuffer;
  131627. /**
  131628. * Update the content of a dynamic texture
  131629. * @param texture defines the texture to update
  131630. * @param canvas defines the canvas containing the source
  131631. * @param invertY defines if data must be stored with Y axis inverted
  131632. * @param premulAlpha defines if alpha is stored as premultiplied
  131633. * @param format defines the format of the data
  131634. * @param forceBindTexture if the texture should be forced to be bound eg. after a graphics context loss (Default: false)
  131635. */
  131636. updateDynamicTexture(texture: Nullable<InternalTexture>, canvas: HTMLCanvasElement, invertY: boolean, premulAlpha?: boolean, format?: number): void;
  131637. /**
  131638. * Gets a boolean indicating if all created effects are ready
  131639. * @returns true if all effects are ready
  131640. */
  131641. areAllEffectsReady(): boolean;
  131642. /**
  131643. * @hidden
  131644. * Get the current error code of the webGL context
  131645. * @returns the error code
  131646. * @see https://developer.mozilla.org/en-US/docs/Web/API/WebGLRenderingContext/getError
  131647. */
  131648. getError(): number;
  131649. /** @hidden */
  131650. _getUnpackAlignement(): number;
  131651. /** @hidden */
  131652. _unpackFlipY(value: boolean): void;
  131653. /**
  131654. * Update a dynamic index buffer
  131655. * @param indexBuffer defines the target index buffer
  131656. * @param indices defines the data to update
  131657. * @param offset defines the offset in the target index buffer where update should start
  131658. */
  131659. updateDynamicIndexBuffer(indexBuffer: WebGLBuffer, indices: IndicesArray, offset?: number): void;
  131660. /**
  131661. * Updates a dynamic vertex buffer.
  131662. * @param vertexBuffer the vertex buffer to update
  131663. * @param vertices the data used to update the vertex buffer
  131664. * @param byteOffset the byte offset of the data (optional)
  131665. * @param byteLength the byte length of the data (optional)
  131666. */
  131667. updateDynamicVertexBuffer(vertexBuffer: WebGLBuffer, vertices: FloatArray, byteOffset?: number, byteLength?: number): void;
  131668. /** @hidden */
  131669. _bindTextureDirectly(target: number, texture: InternalTexture): boolean;
  131670. /** @hidden */
  131671. _bindTexture(channel: number, texture: InternalTexture): void;
  131672. protected _deleteBuffer(buffer: WebGLBuffer): void;
  131673. /**
  131674. * 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
  131675. */
  131676. releaseEffects(): void;
  131677. displayLoadingUI(): void;
  131678. hideLoadingUI(): void;
  131679. /** @hidden */
  131680. _uploadCompressedDataToTextureDirectly(texture: InternalTexture, internalFormat: number, width: number, height: number, data: ArrayBufferView, faceIndex?: number, lod?: number): void;
  131681. /** @hidden */
  131682. _uploadDataToTextureDirectly(texture: InternalTexture, imageData: ArrayBufferView, faceIndex?: number, lod?: number): void;
  131683. /** @hidden */
  131684. _uploadArrayBufferViewToTexture(texture: InternalTexture, imageData: ArrayBufferView, faceIndex?: number, lod?: number): void;
  131685. /** @hidden */
  131686. _uploadImageToTexture(texture: InternalTexture, image: HTMLImageElement, faceIndex?: number, lod?: number): void;
  131687. }
  131688. }
  131689. declare module BABYLON {
  131690. /**
  131691. * @hidden
  131692. **/
  131693. export class _TimeToken {
  131694. _startTimeQuery: Nullable<WebGLQuery>;
  131695. _endTimeQuery: Nullable<WebGLQuery>;
  131696. _timeElapsedQuery: Nullable<WebGLQuery>;
  131697. _timeElapsedQueryEnded: boolean;
  131698. }
  131699. }
  131700. declare module BABYLON {
  131701. /** @hidden */
  131702. export class _OcclusionDataStorage {
  131703. /** @hidden */
  131704. occlusionInternalRetryCounter: number;
  131705. /** @hidden */
  131706. isOcclusionQueryInProgress: boolean;
  131707. /** @hidden */
  131708. isOccluded: boolean;
  131709. /** @hidden */
  131710. occlusionRetryCount: number;
  131711. /** @hidden */
  131712. occlusionType: number;
  131713. /** @hidden */
  131714. occlusionQueryAlgorithmType: number;
  131715. }
  131716. interface Engine {
  131717. /**
  131718. * Create a new webGL query (you must be sure that queries are supported by checking getCaps() function)
  131719. * @return the new query
  131720. */
  131721. createQuery(): WebGLQuery;
  131722. /**
  131723. * Delete and release a webGL query
  131724. * @param query defines the query to delete
  131725. * @return the current engine
  131726. */
  131727. deleteQuery(query: WebGLQuery): Engine;
  131728. /**
  131729. * Check if a given query has resolved and got its value
  131730. * @param query defines the query to check
  131731. * @returns true if the query got its value
  131732. */
  131733. isQueryResultAvailable(query: WebGLQuery): boolean;
  131734. /**
  131735. * Gets the value of a given query
  131736. * @param query defines the query to check
  131737. * @returns the value of the query
  131738. */
  131739. getQueryResult(query: WebGLQuery): number;
  131740. /**
  131741. * Initiates an occlusion query
  131742. * @param algorithmType defines the algorithm to use
  131743. * @param query defines the query to use
  131744. * @returns the current engine
  131745. * @see https://doc.babylonjs.com/features/occlusionquery
  131746. */
  131747. beginOcclusionQuery(algorithmType: number, query: WebGLQuery): Engine;
  131748. /**
  131749. * Ends an occlusion query
  131750. * @see https://doc.babylonjs.com/features/occlusionquery
  131751. * @param algorithmType defines the algorithm to use
  131752. * @returns the current engine
  131753. */
  131754. endOcclusionQuery(algorithmType: number): Engine;
  131755. /**
  131756. * Starts a time query (used to measure time spent by the GPU on a specific frame)
  131757. * Please note that only one query can be issued at a time
  131758. * @returns a time token used to track the time span
  131759. */
  131760. startTimeQuery(): Nullable<_TimeToken>;
  131761. /**
  131762. * Ends a time query
  131763. * @param token defines the token used to measure the time span
  131764. * @returns the time spent (in ns)
  131765. */
  131766. endTimeQuery(token: _TimeToken): int;
  131767. /** @hidden */
  131768. _currentNonTimestampToken: Nullable<_TimeToken>;
  131769. /** @hidden */
  131770. _createTimeQuery(): WebGLQuery;
  131771. /** @hidden */
  131772. _deleteTimeQuery(query: WebGLQuery): void;
  131773. /** @hidden */
  131774. _getGlAlgorithmType(algorithmType: number): number;
  131775. /** @hidden */
  131776. _getTimeQueryResult(query: WebGLQuery): any;
  131777. /** @hidden */
  131778. _getTimeQueryAvailability(query: WebGLQuery): any;
  131779. }
  131780. interface AbstractMesh {
  131781. /**
  131782. * Backing filed
  131783. * @hidden
  131784. */
  131785. __occlusionDataStorage: _OcclusionDataStorage;
  131786. /**
  131787. * Access property
  131788. * @hidden
  131789. */
  131790. _occlusionDataStorage: _OcclusionDataStorage;
  131791. /**
  131792. * 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.
  131793. * The default value is -1 which means don't break the query and wait till the result
  131794. * @see https://doc.babylonjs.com/features/occlusionquery
  131795. */
  131796. occlusionRetryCount: number;
  131797. /**
  131798. * 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:
  131799. * * OCCLUSION_TYPE_NONE (Default Value): this option means no occlusion query whith the Mesh.
  131800. * * OCCLUSION_TYPE_OPTIMISTIC: this option is means use occlusion query and if occlusionRetryCount is reached and the query is broken show the mesh.
  131801. * * 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.
  131802. * @see https://doc.babylonjs.com/features/occlusionquery
  131803. */
  131804. occlusionType: number;
  131805. /**
  131806. * This property determines the type of occlusion query algorithm to run in WebGl, you can use:
  131807. * * AbstractMesh.OCCLUSION_ALGORITHM_TYPE_ACCURATE which is mapped to GL_ANY_SAMPLES_PASSED.
  131808. * * 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.
  131809. * @see https://doc.babylonjs.com/features/occlusionquery
  131810. */
  131811. occlusionQueryAlgorithmType: number;
  131812. /**
  131813. * 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
  131814. * @see https://doc.babylonjs.com/features/occlusionquery
  131815. */
  131816. isOccluded: boolean;
  131817. /**
  131818. * Flag to check the progress status of the query
  131819. * @see https://doc.babylonjs.com/features/occlusionquery
  131820. */
  131821. isOcclusionQueryInProgress: boolean;
  131822. }
  131823. }
  131824. declare module BABYLON {
  131825. /** @hidden */
  131826. export var _forceTransformFeedbackToBundle: boolean;
  131827. interface Engine {
  131828. /**
  131829. * Creates a webGL transform feedback object
  131830. * Please makes sure to check webGLVersion property to check if you are running webGL 2+
  131831. * @returns the webGL transform feedback object
  131832. */
  131833. createTransformFeedback(): WebGLTransformFeedback;
  131834. /**
  131835. * Delete a webGL transform feedback object
  131836. * @param value defines the webGL transform feedback object to delete
  131837. */
  131838. deleteTransformFeedback(value: WebGLTransformFeedback): void;
  131839. /**
  131840. * Bind a webGL transform feedback object to the webgl context
  131841. * @param value defines the webGL transform feedback object to bind
  131842. */
  131843. bindTransformFeedback(value: Nullable<WebGLTransformFeedback>): void;
  131844. /**
  131845. * Begins a transform feedback operation
  131846. * @param usePoints defines if points or triangles must be used
  131847. */
  131848. beginTransformFeedback(usePoints: boolean): void;
  131849. /**
  131850. * Ends a transform feedback operation
  131851. */
  131852. endTransformFeedback(): void;
  131853. /**
  131854. * Specify the varyings to use with transform feedback
  131855. * @param program defines the associated webGL program
  131856. * @param value defines the list of strings representing the varying names
  131857. */
  131858. setTranformFeedbackVaryings(program: WebGLProgram, value: string[]): void;
  131859. /**
  131860. * Bind a webGL buffer for a transform feedback operation
  131861. * @param value defines the webGL buffer to bind
  131862. */
  131863. bindTransformFeedbackBuffer(value: Nullable<DataBuffer>): void;
  131864. }
  131865. }
  131866. declare module BABYLON {
  131867. /**
  131868. * Class used to define an additional view for the engine
  131869. * @see https://doc.babylonjs.com/how_to/multi_canvases
  131870. */
  131871. export class EngineView {
  131872. /** Defines the canvas where to render the view */
  131873. target: HTMLCanvasElement;
  131874. /** Defines an optional camera used to render the view (will use active camera else) */
  131875. camera?: Camera;
  131876. }
  131877. interface Engine {
  131878. /**
  131879. * Gets or sets the HTML element to use for attaching events
  131880. */
  131881. inputElement: Nullable<HTMLElement>;
  131882. /**
  131883. * Gets the current engine view
  131884. * @see https://doc.babylonjs.com/how_to/multi_canvases
  131885. */
  131886. activeView: Nullable<EngineView>;
  131887. /** Gets or sets the list of views */
  131888. views: EngineView[];
  131889. /**
  131890. * Register a new child canvas
  131891. * @param canvas defines the canvas to register
  131892. * @param camera defines an optional camera to use with this canvas (it will overwrite the scene.camera for this view)
  131893. * @returns the associated view
  131894. */
  131895. registerView(canvas: HTMLCanvasElement, camera?: Camera): EngineView;
  131896. /**
  131897. * Remove a registered child canvas
  131898. * @param canvas defines the canvas to remove
  131899. * @returns the current engine
  131900. */
  131901. unRegisterView(canvas: HTMLCanvasElement): Engine;
  131902. }
  131903. }
  131904. declare module BABYLON {
  131905. interface Engine {
  131906. /** @hidden */
  131907. _excludedCompressedTextures: string[];
  131908. /** @hidden */
  131909. _textureFormatInUse: string;
  131910. /**
  131911. * Gets the list of texture formats supported
  131912. */
  131913. readonly texturesSupported: Array<string>;
  131914. /**
  131915. * Gets the texture format in use
  131916. */
  131917. readonly textureFormatInUse: Nullable<string>;
  131918. /**
  131919. * Set the compressed texture extensions or file names to skip.
  131920. *
  131921. * @param skippedFiles defines the list of those texture files you want to skip
  131922. * Example: [".dds", ".env", "myfile.png"]
  131923. */
  131924. setCompressedTextureExclusions(skippedFiles: Array<string>): void;
  131925. /**
  131926. * Set the compressed texture format to use, based on the formats you have, and the formats
  131927. * supported by the hardware / browser.
  131928. *
  131929. * Khronos Texture Container (.ktx) files are used to support this. This format has the
  131930. * advantage of being specifically designed for OpenGL. Header elements directly correspond
  131931. * to API arguments needed to compressed textures. This puts the burden on the container
  131932. * generator to house the arcane code for determining these for current & future formats.
  131933. *
  131934. * for description see https://www.khronos.org/opengles/sdk/tools/KTX/
  131935. * for file layout see https://www.khronos.org/opengles/sdk/tools/KTX/file_format_spec/
  131936. *
  131937. * Note: The result of this call is not taken into account when a texture is base64.
  131938. *
  131939. * @param formatsAvailable defines the list of those format families you have created
  131940. * on your server. Syntax: '-' + format family + '.ktx'. (Case and order do not matter.)
  131941. *
  131942. * Current families are astc, dxt, pvrtc, etc2, & etc1.
  131943. * @returns The extension selected.
  131944. */
  131945. setTextureFormatToUse(formatsAvailable: Array<string>): Nullable<string>;
  131946. }
  131947. }
  131948. declare module BABYLON {
  131949. /**
  131950. * CubeMap information grouping all the data for each faces as well as the cubemap size.
  131951. */
  131952. export interface CubeMapInfo {
  131953. /**
  131954. * The pixel array for the front face.
  131955. * This is stored in format, left to right, up to down format.
  131956. */
  131957. front: Nullable<ArrayBufferView>;
  131958. /**
  131959. * The pixel array for the back face.
  131960. * This is stored in format, left to right, up to down format.
  131961. */
  131962. back: Nullable<ArrayBufferView>;
  131963. /**
  131964. * The pixel array for the left face.
  131965. * This is stored in format, left to right, up to down format.
  131966. */
  131967. left: Nullable<ArrayBufferView>;
  131968. /**
  131969. * The pixel array for the right face.
  131970. * This is stored in format, left to right, up to down format.
  131971. */
  131972. right: Nullable<ArrayBufferView>;
  131973. /**
  131974. * The pixel array for the up face.
  131975. * This is stored in format, left to right, up to down format.
  131976. */
  131977. up: Nullable<ArrayBufferView>;
  131978. /**
  131979. * The pixel array for the down face.
  131980. * This is stored in format, left to right, up to down format.
  131981. */
  131982. down: Nullable<ArrayBufferView>;
  131983. /**
  131984. * The size of the cubemap stored.
  131985. *
  131986. * Each faces will be size * size pixels.
  131987. */
  131988. size: number;
  131989. /**
  131990. * The format of the texture.
  131991. *
  131992. * RGBA, RGB.
  131993. */
  131994. format: number;
  131995. /**
  131996. * The type of the texture data.
  131997. *
  131998. * UNSIGNED_INT, FLOAT.
  131999. */
  132000. type: number;
  132001. /**
  132002. * Specifies whether the texture is in gamma space.
  132003. */
  132004. gammaSpace: boolean;
  132005. }
  132006. /**
  132007. * Helper class useful to convert panorama picture to their cubemap representation in 6 faces.
  132008. */
  132009. export class PanoramaToCubeMapTools {
  132010. private static FACE_LEFT;
  132011. private static FACE_RIGHT;
  132012. private static FACE_FRONT;
  132013. private static FACE_BACK;
  132014. private static FACE_DOWN;
  132015. private static FACE_UP;
  132016. /**
  132017. * Converts a panorma stored in RGB right to left up to down format into a cubemap (6 faces).
  132018. *
  132019. * @param float32Array The source data.
  132020. * @param inputWidth The width of the input panorama.
  132021. * @param inputHeight The height of the input panorama.
  132022. * @param size The willing size of the generated cubemap (each faces will be size * size pixels)
  132023. * @return The cubemap data
  132024. */
  132025. static ConvertPanoramaToCubemap(float32Array: Float32Array, inputWidth: number, inputHeight: number, size: number): CubeMapInfo;
  132026. private static CreateCubemapTexture;
  132027. private static CalcProjectionSpherical;
  132028. }
  132029. }
  132030. declare module BABYLON {
  132031. /**
  132032. * Helper class dealing with the extraction of spherical polynomial dataArray
  132033. * from a cube map.
  132034. */
  132035. export class CubeMapToSphericalPolynomialTools {
  132036. private static FileFaces;
  132037. /**
  132038. * Converts a texture to the according Spherical Polynomial data.
  132039. * This extracts the first 3 orders only as they are the only one used in the lighting.
  132040. *
  132041. * @param texture The texture to extract the information from.
  132042. * @return The Spherical Polynomial data.
  132043. */
  132044. static ConvertCubeMapTextureToSphericalPolynomial(texture: BaseTexture): Nullable<SphericalPolynomial>;
  132045. /**
  132046. * Converts a cubemap to the according Spherical Polynomial data.
  132047. * This extracts the first 3 orders only as they are the only one used in the lighting.
  132048. *
  132049. * @param cubeInfo The Cube map to extract the information from.
  132050. * @return The Spherical Polynomial data.
  132051. */
  132052. static ConvertCubeMapToSphericalPolynomial(cubeInfo: CubeMapInfo): SphericalPolynomial;
  132053. }
  132054. }
  132055. declare module BABYLON {
  132056. interface BaseTexture {
  132057. /**
  132058. * Get the polynomial representation of the texture data.
  132059. * This is mainly use as a fast way to recover IBL Diffuse irradiance data.
  132060. * @see https://learnopengl.com/PBR/IBL/Diffuse-irradiance
  132061. */
  132062. sphericalPolynomial: Nullable<SphericalPolynomial>;
  132063. }
  132064. }
  132065. declare module BABYLON {
  132066. /** @hidden */
  132067. export var rgbdEncodePixelShader: {
  132068. name: string;
  132069. shader: string;
  132070. };
  132071. }
  132072. declare module BABYLON {
  132073. /** @hidden */
  132074. export var rgbdDecodePixelShader: {
  132075. name: string;
  132076. shader: string;
  132077. };
  132078. }
  132079. declare module BABYLON {
  132080. /**
  132081. * Raw texture data and descriptor sufficient for WebGL texture upload
  132082. */
  132083. export interface EnvironmentTextureInfo {
  132084. /**
  132085. * Version of the environment map
  132086. */
  132087. version: number;
  132088. /**
  132089. * Width of image
  132090. */
  132091. width: number;
  132092. /**
  132093. * Irradiance information stored in the file.
  132094. */
  132095. irradiance: any;
  132096. /**
  132097. * Specular information stored in the file.
  132098. */
  132099. specular: any;
  132100. }
  132101. /**
  132102. * Defines One Image in the file. It requires only the position in the file
  132103. * as well as the length.
  132104. */
  132105. interface BufferImageData {
  132106. /**
  132107. * Length of the image data.
  132108. */
  132109. length: number;
  132110. /**
  132111. * Position of the data from the null terminator delimiting the end of the JSON.
  132112. */
  132113. position: number;
  132114. }
  132115. /**
  132116. * Defines the specular data enclosed in the file.
  132117. * This corresponds to the version 1 of the data.
  132118. */
  132119. export interface EnvironmentTextureSpecularInfoV1 {
  132120. /**
  132121. * Defines where the specular Payload is located. It is a runtime value only not stored in the file.
  132122. */
  132123. specularDataPosition?: number;
  132124. /**
  132125. * This contains all the images data needed to reconstruct the cubemap.
  132126. */
  132127. mipmaps: Array<BufferImageData>;
  132128. /**
  132129. * Defines the scale applied to environment texture. This manages the range of LOD level used for IBL according to the roughness.
  132130. */
  132131. lodGenerationScale: number;
  132132. }
  132133. /**
  132134. * Sets of helpers addressing the serialization and deserialization of environment texture
  132135. * stored in a BabylonJS env file.
  132136. * Those files are usually stored as .env files.
  132137. */
  132138. export class EnvironmentTextureTools {
  132139. /**
  132140. * Magic number identifying the env file.
  132141. */
  132142. private static _MagicBytes;
  132143. /**
  132144. * Gets the environment info from an env file.
  132145. * @param data The array buffer containing the .env bytes.
  132146. * @returns the environment file info (the json header) if successfully parsed.
  132147. */
  132148. static GetEnvInfo(data: ArrayBufferView): Nullable<EnvironmentTextureInfo>;
  132149. /**
  132150. * Creates an environment texture from a loaded cube texture.
  132151. * @param texture defines the cube texture to convert in env file
  132152. * @return a promise containing the environment data if succesfull.
  132153. */
  132154. static CreateEnvTextureAsync(texture: BaseTexture): Promise<ArrayBuffer>;
  132155. /**
  132156. * Creates a JSON representation of the spherical data.
  132157. * @param texture defines the texture containing the polynomials
  132158. * @return the JSON representation of the spherical info
  132159. */
  132160. private static _CreateEnvTextureIrradiance;
  132161. /**
  132162. * Creates the ArrayBufferViews used for initializing environment texture image data.
  132163. * @param data the image data
  132164. * @param info parameters that determine what views will be created for accessing the underlying buffer
  132165. * @return the views described by info providing access to the underlying buffer
  132166. */
  132167. static CreateImageDataArrayBufferViews(data: ArrayBufferView, info: EnvironmentTextureInfo): Array<Array<ArrayBufferView>>;
  132168. /**
  132169. * Uploads the texture info contained in the env file to the GPU.
  132170. * @param texture defines the internal texture to upload to
  132171. * @param data defines the data to load
  132172. * @param info defines the texture info retrieved through the GetEnvInfo method
  132173. * @returns a promise
  132174. */
  132175. static UploadEnvLevelsAsync(texture: InternalTexture, data: ArrayBufferView, info: EnvironmentTextureInfo): Promise<void>;
  132176. private static _OnImageReadyAsync;
  132177. /**
  132178. * Uploads the levels of image data to the GPU.
  132179. * @param texture defines the internal texture to upload to
  132180. * @param imageData defines the array buffer views of image data [mipmap][face]
  132181. * @returns a promise
  132182. */
  132183. static UploadLevelsAsync(texture: InternalTexture, imageData: ArrayBufferView[][]): Promise<void>;
  132184. /**
  132185. * Uploads spherical polynomials information to the texture.
  132186. * @param texture defines the texture we are trying to upload the information to
  132187. * @param info defines the environment texture info retrieved through the GetEnvInfo method
  132188. */
  132189. static UploadEnvSpherical(texture: InternalTexture, info: EnvironmentTextureInfo): void;
  132190. /** @hidden */
  132191. static _UpdateRGBDAsync(internalTexture: InternalTexture, data: ArrayBufferView[][], sphericalPolynomial: Nullable<SphericalPolynomial>, lodScale: number, lodOffset: number): Promise<void>;
  132192. }
  132193. }
  132194. declare module BABYLON {
  132195. /**
  132196. * Class used to inline functions in shader code
  132197. */
  132198. export class ShaderCodeInliner {
  132199. private static readonly _RegexpFindFunctionNameAndType;
  132200. private _sourceCode;
  132201. private _functionDescr;
  132202. private _numMaxIterations;
  132203. /** Gets or sets the token used to mark the functions to inline */
  132204. inlineToken: string;
  132205. /** Gets or sets the debug mode */
  132206. debug: boolean;
  132207. /** Gets the code after the inlining process */
  132208. get code(): string;
  132209. /**
  132210. * Initializes the inliner
  132211. * @param sourceCode shader code source to inline
  132212. * @param numMaxIterations maximum number of iterations (used to detect recursive calls)
  132213. */
  132214. constructor(sourceCode: string, numMaxIterations?: number);
  132215. /**
  132216. * Start the processing of the shader code
  132217. */
  132218. processCode(): void;
  132219. private _collectFunctions;
  132220. private _processInlining;
  132221. private _extractBetweenMarkers;
  132222. private _skipWhitespaces;
  132223. private _removeComments;
  132224. private _replaceFunctionCallsByCode;
  132225. private _findBackward;
  132226. private _escapeRegExp;
  132227. private _replaceNames;
  132228. }
  132229. }
  132230. declare module BABYLON {
  132231. /**
  132232. * Container for accessors for natively-stored mesh data buffers.
  132233. */
  132234. class NativeDataBuffer extends DataBuffer {
  132235. /**
  132236. * Accessor value used to identify/retrieve a natively-stored index buffer.
  132237. */
  132238. nativeIndexBuffer?: any;
  132239. /**
  132240. * Accessor value used to identify/retrieve a natively-stored vertex buffer.
  132241. */
  132242. nativeVertexBuffer?: any;
  132243. }
  132244. /** @hidden */
  132245. class NativeTexture extends InternalTexture {
  132246. getInternalTexture(): InternalTexture;
  132247. getViewCount(): number;
  132248. }
  132249. /** @hidden */
  132250. export class NativeEngine extends Engine {
  132251. private readonly _native;
  132252. /** Defines the invalid handle returned by bgfx when resource creation goes wrong */
  132253. private readonly INVALID_HANDLE;
  132254. private _boundBuffersVertexArray;
  132255. getHardwareScalingLevel(): number;
  132256. constructor();
  132257. dispose(): void;
  132258. /**
  132259. * Can be used to override the current requestAnimationFrame requester.
  132260. * @hidden
  132261. */
  132262. protected _queueNewFrame(bindedRenderFunction: any, requester?: any): number;
  132263. /**
  132264. * Override default engine behavior.
  132265. * @param color
  132266. * @param backBuffer
  132267. * @param depth
  132268. * @param stencil
  132269. */
  132270. _bindUnboundFramebuffer(framebuffer: Nullable<WebGLFramebuffer>): void;
  132271. /**
  132272. * Gets host document
  132273. * @returns the host document object
  132274. */
  132275. getHostDocument(): Nullable<Document>;
  132276. clear(color: Nullable<IColor4Like>, backBuffer: boolean, depth: boolean, stencil?: boolean): void;
  132277. createIndexBuffer(indices: IndicesArray, updateable?: boolean): NativeDataBuffer;
  132278. createVertexBuffer(data: DataArray, updateable?: boolean): NativeDataBuffer;
  132279. protected _recordVertexArrayObject(vertexArray: any, vertexBuffers: {
  132280. [key: string]: VertexBuffer;
  132281. }, indexBuffer: Nullable<NativeDataBuffer>, effect: Effect): void;
  132282. bindBuffers(vertexBuffers: {
  132283. [key: string]: VertexBuffer;
  132284. }, indexBuffer: Nullable<NativeDataBuffer>, effect: Effect): void;
  132285. recordVertexArrayObject(vertexBuffers: {
  132286. [key: string]: VertexBuffer;
  132287. }, indexBuffer: Nullable<NativeDataBuffer>, effect: Effect): WebGLVertexArrayObject;
  132288. bindVertexArrayObject(vertexArray: WebGLVertexArrayObject): void;
  132289. releaseVertexArrayObject(vertexArray: WebGLVertexArrayObject): void;
  132290. getAttributes(pipelineContext: IPipelineContext, attributesNames: string[]): number[];
  132291. /**
  132292. * Draw a list of indexed primitives
  132293. * @param fillMode defines the primitive to use
  132294. * @param indexStart defines the starting index
  132295. * @param indexCount defines the number of index to draw
  132296. * @param instancesCount defines the number of instances to draw (if instanciation is enabled)
  132297. */
  132298. drawElementsType(fillMode: number, indexStart: number, indexCount: number, instancesCount?: number): void;
  132299. /**
  132300. * Draw a list of unindexed primitives
  132301. * @param fillMode defines the primitive to use
  132302. * @param verticesStart defines the index of first vertex to draw
  132303. * @param verticesCount defines the count of vertices to draw
  132304. * @param instancesCount defines the number of instances to draw (if instanciation is enabled)
  132305. */
  132306. drawArraysType(fillMode: number, verticesStart: number, verticesCount: number, instancesCount?: number): void;
  132307. createPipelineContext(): IPipelineContext;
  132308. _preparePipelineContext(pipelineContext: IPipelineContext, vertexSourceCode: string, fragmentSourceCode: string, createAsRaw: boolean, rebuildRebind: any, defines: Nullable<string>, transformFeedbackVaryings: Nullable<string[]>): void;
  132309. /** @hidden */
  132310. _isRenderingStateCompiled(pipelineContext: IPipelineContext): boolean;
  132311. /** @hidden */
  132312. _executeWhenRenderingStateIsCompiled(pipelineContext: IPipelineContext, action: () => void): void;
  132313. createRawShaderProgram(pipelineContext: IPipelineContext, vertexCode: string, fragmentCode: string, context?: WebGLRenderingContext, transformFeedbackVaryings?: Nullable<string[]>): any;
  132314. createShaderProgram(pipelineContext: IPipelineContext, vertexCode: string, fragmentCode: string, defines: Nullable<string>, context?: WebGLRenderingContext, transformFeedbackVaryings?: Nullable<string[]>): any;
  132315. protected _setProgram(program: WebGLProgram): void;
  132316. _releaseEffect(effect: Effect): void;
  132317. _deletePipelineContext(pipelineContext: IPipelineContext): void;
  132318. getUniforms(pipelineContext: IPipelineContext, uniformsNames: string[]): WebGLUniformLocation[];
  132319. bindUniformBlock(pipelineContext: IPipelineContext, blockName: string, index: number): void;
  132320. bindSamplers(effect: Effect): void;
  132321. setMatrix(uniform: WebGLUniformLocation, matrix: Matrix): void;
  132322. getRenderWidth(useScreen?: boolean): number;
  132323. getRenderHeight(useScreen?: boolean): number;
  132324. setViewport(viewport: Viewport, requiredWidth?: number, requiredHeight?: number): void;
  132325. setState(culling: boolean, zOffset?: number, force?: boolean, reverseSide?: boolean): void;
  132326. /**
  132327. * Set the z offset to apply to current rendering
  132328. * @param value defines the offset to apply
  132329. */
  132330. setZOffset(value: number): void;
  132331. /**
  132332. * Gets the current value of the zOffset
  132333. * @returns the current zOffset state
  132334. */
  132335. getZOffset(): number;
  132336. /**
  132337. * Enable or disable depth buffering
  132338. * @param enable defines the state to set
  132339. */
  132340. setDepthBuffer(enable: boolean): void;
  132341. /**
  132342. * Gets a boolean indicating if depth writing is enabled
  132343. * @returns the current depth writing state
  132344. */
  132345. getDepthWrite(): boolean;
  132346. /**
  132347. * Enable or disable depth writing
  132348. * @param enable defines the state to set
  132349. */
  132350. setDepthWrite(enable: boolean): void;
  132351. /**
  132352. * Enable or disable color writing
  132353. * @param enable defines the state to set
  132354. */
  132355. setColorWrite(enable: boolean): void;
  132356. /**
  132357. * Gets a boolean indicating if color writing is enabled
  132358. * @returns the current color writing state
  132359. */
  132360. getColorWrite(): boolean;
  132361. /**
  132362. * Sets alpha constants used by some alpha blending modes
  132363. * @param r defines the red component
  132364. * @param g defines the green component
  132365. * @param b defines the blue component
  132366. * @param a defines the alpha component
  132367. */
  132368. setAlphaConstants(r: number, g: number, b: number, a: number): void;
  132369. /**
  132370. * Sets the current alpha mode
  132371. * @param mode defines the mode to use (one of the BABYLON.Constants.ALPHA_XXX)
  132372. * @param noDepthWriteChange defines if depth writing state should remains unchanged (false by default)
  132373. * @see https://doc.babylonjs.com/resources/transparency_and_how_meshes_are_rendered
  132374. */
  132375. setAlphaMode(mode: number, noDepthWriteChange?: boolean): void;
  132376. /**
  132377. * Gets the current alpha mode
  132378. * @see https://doc.babylonjs.com/resources/transparency_and_how_meshes_are_rendered
  132379. * @returns the current alpha mode
  132380. */
  132381. getAlphaMode(): number;
  132382. setInt(uniform: WebGLUniformLocation, int: number): void;
  132383. setIntArray(uniform: WebGLUniformLocation, array: Int32Array): void;
  132384. setIntArray2(uniform: WebGLUniformLocation, array: Int32Array): void;
  132385. setIntArray3(uniform: WebGLUniformLocation, array: Int32Array): void;
  132386. setIntArray4(uniform: WebGLUniformLocation, array: Int32Array): void;
  132387. setFloatArray(uniform: WebGLUniformLocation, array: Float32Array): void;
  132388. setFloatArray2(uniform: WebGLUniformLocation, array: Float32Array): void;
  132389. setFloatArray3(uniform: WebGLUniformLocation, array: Float32Array): void;
  132390. setFloatArray4(uniform: WebGLUniformLocation, array: Float32Array): void;
  132391. setArray(uniform: WebGLUniformLocation, array: number[]): void;
  132392. setArray2(uniform: WebGLUniformLocation, array: number[]): void;
  132393. setArray3(uniform: WebGLUniformLocation, array: number[]): void;
  132394. setArray4(uniform: WebGLUniformLocation, array: number[]): void;
  132395. setMatrices(uniform: WebGLUniformLocation, matrices: Float32Array): void;
  132396. setMatrix3x3(uniform: WebGLUniformLocation, matrix: Float32Array): void;
  132397. setMatrix2x2(uniform: WebGLUniformLocation, matrix: Float32Array): void;
  132398. setFloat(uniform: WebGLUniformLocation, value: number): void;
  132399. setFloat2(uniform: WebGLUniformLocation, x: number, y: number): void;
  132400. setFloat3(uniform: WebGLUniformLocation, x: number, y: number, z: number): void;
  132401. setFloat4(uniform: WebGLUniformLocation, x: number, y: number, z: number, w: number): void;
  132402. setColor3(uniform: WebGLUniformLocation, color3: Color3): void;
  132403. setColor4(uniform: WebGLUniformLocation, color3: Color3, alpha: number): void;
  132404. wipeCaches(bruteForce?: boolean): void;
  132405. _createTexture(): WebGLTexture;
  132406. protected _deleteTexture(texture: Nullable<WebGLTexture>): void;
  132407. /**
  132408. * Usually called from Texture.ts.
  132409. * Passed information to create a WebGLTexture
  132410. * @param url defines a value which contains one of the following:
  132411. * * A conventional http URL, e.g. 'http://...' or 'file://...'
  132412. * * A base64 string of in-line texture data, e.g. 'data:image/jpg;base64,/...'
  132413. * * An indicator that data being passed using the buffer parameter, e.g. 'data:mytexture.jpg'
  132414. * @param noMipmap defines a boolean indicating that no mipmaps shall be generated. Ignored for compressed textures. They must be in the file
  132415. * @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)
  132416. * @param scene needed for loading to the correct scene
  132417. * @param samplingMode mode with should be used sample / access the texture (Default: Texture.TRILINEAR_SAMPLINGMODE)
  132418. * @param onLoad optional callback to be called upon successful completion
  132419. * @param onError optional callback to be called upon failure
  132420. * @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
  132421. * @param fallback an internal argument in case the function must be called again, due to etc1 not having alpha capabilities
  132422. * @param format internal format. Default: RGB when extension is '.jpg' else RGBA. Ignored for compressed textures
  132423. * @param forcedExtension defines the extension to use to pick the right loader
  132424. * @param mimeType defines an optional mime type
  132425. * @returns a InternalTexture for assignment back into BABYLON.Texture
  132426. */
  132427. 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;
  132428. /**
  132429. * Creates a cube texture
  132430. * @param rootUrl defines the url where the files to load is located
  132431. * @param scene defines the current scene
  132432. * @param files defines the list of files to load (1 per face)
  132433. * @param noMipmap defines a boolean indicating that no mipmaps shall be generated (false by default)
  132434. * @param onLoad defines an optional callback raised when the texture is loaded
  132435. * @param onError defines an optional callback raised if there is an issue to load the texture
  132436. * @param format defines the format of the data
  132437. * @param forcedExtension defines the extension to use to pick the right loader
  132438. * @param createPolynomials if a polynomial sphere should be created for the cube texture
  132439. * @param lodScale defines the scale applied to environment texture. This manages the range of LOD level used for IBL according to the roughness
  132440. * @param lodOffset defines the offset applied to environment texture. This manages first LOD level used for IBL according to the roughness
  132441. * @param fallback defines texture to use while falling back when (compressed) texture file not found.
  132442. * @returns the cube texture as an InternalTexture
  132443. */
  132444. 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;
  132445. private _getSamplingFilter;
  132446. private static _GetNativeTextureFormat;
  132447. createRenderTargetTexture(size: number | {
  132448. width: number;
  132449. height: number;
  132450. }, options: boolean | RenderTargetCreationOptions): NativeTexture;
  132451. updateTextureSamplingMode(samplingMode: number, texture: InternalTexture): void;
  132452. bindFramebuffer(texture: InternalTexture, faceIndex?: number, requiredWidth?: number, requiredHeight?: number, forceFullscreenViewport?: boolean): void;
  132453. unBindFramebuffer(texture: InternalTexture, disableGenerateMipMaps?: boolean, onBeforeUnbind?: () => void): void;
  132454. createDynamicVertexBuffer(data: DataArray): DataBuffer;
  132455. updateDynamicIndexBuffer(indexBuffer: DataBuffer, indices: IndicesArray, offset?: number): void;
  132456. /**
  132457. * Updates a dynamic vertex buffer.
  132458. * @param vertexBuffer the vertex buffer to update
  132459. * @param data the data used to update the vertex buffer
  132460. * @param byteOffset the byte offset of the data (optional)
  132461. * @param byteLength the byte length of the data (optional)
  132462. */
  132463. updateDynamicVertexBuffer(vertexBuffer: DataBuffer, data: DataArray, byteOffset?: number, byteLength?: number): void;
  132464. protected _setTexture(channel: number, texture: Nullable<BaseTexture>, isPartOfTextureArray?: boolean, depthStencilTexture?: boolean): boolean;
  132465. private _updateAnisotropicLevel;
  132466. private _getAddressMode;
  132467. /** @hidden */
  132468. _bindTexture(channel: number, texture: InternalTexture): void;
  132469. protected _deleteBuffer(buffer: NativeDataBuffer): void;
  132470. releaseEffects(): void;
  132471. /** @hidden */
  132472. _uploadCompressedDataToTextureDirectly(texture: InternalTexture, internalFormat: number, width: number, height: number, data: ArrayBufferView, faceIndex?: number, lod?: number): void;
  132473. /** @hidden */
  132474. _uploadDataToTextureDirectly(texture: InternalTexture, imageData: ArrayBufferView, faceIndex?: number, lod?: number): void;
  132475. /** @hidden */
  132476. _uploadArrayBufferViewToTexture(texture: InternalTexture, imageData: ArrayBufferView, faceIndex?: number, lod?: number): void;
  132477. /** @hidden */
  132478. _uploadImageToTexture(texture: InternalTexture, image: HTMLImageElement, faceIndex?: number, lod?: number): void;
  132479. }
  132480. }
  132481. declare module BABYLON {
  132482. /**
  132483. * Gather the list of clipboard event types as constants.
  132484. */
  132485. export class ClipboardEventTypes {
  132486. /**
  132487. * The clipboard event is fired when a copy command is active (pressed).
  132488. */
  132489. static readonly COPY: number;
  132490. /**
  132491. * The clipboard event is fired when a cut command is active (pressed).
  132492. */
  132493. static readonly CUT: number;
  132494. /**
  132495. * The clipboard event is fired when a paste command is active (pressed).
  132496. */
  132497. static readonly PASTE: number;
  132498. }
  132499. /**
  132500. * This class is used to store clipboard related info for the onClipboardObservable event.
  132501. */
  132502. export class ClipboardInfo {
  132503. /**
  132504. * Defines the type of event (BABYLON.ClipboardEventTypes)
  132505. */
  132506. type: number;
  132507. /**
  132508. * Defines the related dom event
  132509. */
  132510. event: ClipboardEvent;
  132511. /**
  132512. *Creates an instance of ClipboardInfo.
  132513. * @param type Defines the type of event (BABYLON.ClipboardEventTypes)
  132514. * @param event Defines the related dom event
  132515. */
  132516. constructor(
  132517. /**
  132518. * Defines the type of event (BABYLON.ClipboardEventTypes)
  132519. */
  132520. type: number,
  132521. /**
  132522. * Defines the related dom event
  132523. */
  132524. event: ClipboardEvent);
  132525. /**
  132526. * Get the clipboard event's type from the keycode.
  132527. * @param keyCode Defines the keyCode for the current keyboard event.
  132528. * @return {number}
  132529. */
  132530. static GetTypeFromCharacter(keyCode: number): number;
  132531. }
  132532. }
  132533. declare module BABYLON {
  132534. /**
  132535. * Google Daydream controller
  132536. */
  132537. export class DaydreamController extends WebVRController {
  132538. /**
  132539. * Base Url for the controller model.
  132540. */
  132541. static MODEL_BASE_URL: string;
  132542. /**
  132543. * File name for the controller model.
  132544. */
  132545. static MODEL_FILENAME: string;
  132546. /**
  132547. * Gamepad Id prefix used to identify Daydream Controller.
  132548. */
  132549. static readonly GAMEPAD_ID_PREFIX: string;
  132550. /**
  132551. * Creates a new DaydreamController from a gamepad
  132552. * @param vrGamepad the gamepad that the controller should be created from
  132553. */
  132554. constructor(vrGamepad: any);
  132555. /**
  132556. * Implements abstract method on WebVRController class, loading controller meshes and calling this.attachToMesh if successful.
  132557. * @param scene scene in which to add meshes
  132558. * @param meshLoaded optional callback function that will be called if the mesh loads successfully.
  132559. */
  132560. initControllerMesh(scene: Scene, meshLoaded?: (mesh: AbstractMesh) => void): void;
  132561. /**
  132562. * Called once for each button that changed state since the last frame
  132563. * @param buttonIdx Which button index changed
  132564. * @param state New state of the button
  132565. * @param changes Which properties on the state changed since last frame
  132566. */
  132567. protected _handleButtonChange(buttonIdx: number, state: ExtendedGamepadButton, changes: GamepadButtonChanges): void;
  132568. }
  132569. }
  132570. declare module BABYLON {
  132571. /**
  132572. * Gear VR Controller
  132573. */
  132574. export class GearVRController extends WebVRController {
  132575. /**
  132576. * Base Url for the controller model.
  132577. */
  132578. static MODEL_BASE_URL: string;
  132579. /**
  132580. * File name for the controller model.
  132581. */
  132582. static MODEL_FILENAME: string;
  132583. /**
  132584. * Gamepad Id prefix used to identify this controller.
  132585. */
  132586. static readonly GAMEPAD_ID_PREFIX: string;
  132587. private readonly _buttonIndexToObservableNameMap;
  132588. /**
  132589. * Creates a new GearVRController from a gamepad
  132590. * @param vrGamepad the gamepad that the controller should be created from
  132591. */
  132592. constructor(vrGamepad: any);
  132593. /**
  132594. * Implements abstract method on WebVRController class, loading controller meshes and calling this.attachToMesh if successful.
  132595. * @param scene scene in which to add meshes
  132596. * @param meshLoaded optional callback function that will be called if the mesh loads successfully.
  132597. */
  132598. initControllerMesh(scene: Scene, meshLoaded?: (mesh: AbstractMesh) => void): void;
  132599. /**
  132600. * Called once for each button that changed state since the last frame
  132601. * @param buttonIdx Which button index changed
  132602. * @param state New state of the button
  132603. * @param changes Which properties on the state changed since last frame
  132604. */
  132605. protected _handleButtonChange(buttonIdx: number, state: ExtendedGamepadButton, changes: GamepadButtonChanges): void;
  132606. }
  132607. }
  132608. declare module BABYLON {
  132609. /**
  132610. * Generic Controller
  132611. */
  132612. export class GenericController extends WebVRController {
  132613. /**
  132614. * Base Url for the controller model.
  132615. */
  132616. static readonly MODEL_BASE_URL: string;
  132617. /**
  132618. * File name for the controller model.
  132619. */
  132620. static readonly MODEL_FILENAME: string;
  132621. /**
  132622. * Creates a new GenericController from a gamepad
  132623. * @param vrGamepad the gamepad that the controller should be created from
  132624. */
  132625. constructor(vrGamepad: any);
  132626. /**
  132627. * Implements abstract method on WebVRController class, loading controller meshes and calling this.attachToMesh if successful.
  132628. * @param scene scene in which to add meshes
  132629. * @param meshLoaded optional callback function that will be called if the mesh loads successfully.
  132630. */
  132631. initControllerMesh(scene: Scene, meshLoaded?: (mesh: AbstractMesh) => void): void;
  132632. /**
  132633. * Called once for each button that changed state since the last frame
  132634. * @param buttonIdx Which button index changed
  132635. * @param state New state of the button
  132636. * @param changes Which properties on the state changed since last frame
  132637. */
  132638. protected _handleButtonChange(buttonIdx: number, state: ExtendedGamepadButton, changes: GamepadButtonChanges): void;
  132639. }
  132640. }
  132641. declare module BABYLON {
  132642. /**
  132643. * Oculus Touch Controller
  132644. */
  132645. export class OculusTouchController extends WebVRController {
  132646. /**
  132647. * Base Url for the controller model.
  132648. */
  132649. static MODEL_BASE_URL: string;
  132650. /**
  132651. * File name for the left controller model.
  132652. */
  132653. static MODEL_LEFT_FILENAME: string;
  132654. /**
  132655. * File name for the right controller model.
  132656. */
  132657. static MODEL_RIGHT_FILENAME: string;
  132658. /**
  132659. * Base Url for the Quest controller model.
  132660. */
  132661. static QUEST_MODEL_BASE_URL: string;
  132662. /**
  132663. * @hidden
  132664. * If the controllers are running on a device that needs the updated Quest controller models
  132665. */
  132666. static _IsQuest: boolean;
  132667. /**
  132668. * Fired when the secondary trigger on this controller is modified
  132669. */
  132670. onSecondaryTriggerStateChangedObservable: Observable<ExtendedGamepadButton>;
  132671. /**
  132672. * Fired when the thumb rest on this controller is modified
  132673. */
  132674. onThumbRestChangedObservable: Observable<ExtendedGamepadButton>;
  132675. /**
  132676. * Creates a new OculusTouchController from a gamepad
  132677. * @param vrGamepad the gamepad that the controller should be created from
  132678. */
  132679. constructor(vrGamepad: any);
  132680. /**
  132681. * Implements abstract method on WebVRController class, loading controller meshes and calling this.attachToMesh if successful.
  132682. * @param scene scene in which to add meshes
  132683. * @param meshLoaded optional callback function that will be called if the mesh loads successfully.
  132684. */
  132685. initControllerMesh(scene: Scene, meshLoaded?: (mesh: AbstractMesh) => void): void;
  132686. /**
  132687. * Fired when the A button on this controller is modified
  132688. */
  132689. get onAButtonStateChangedObservable(): Observable<ExtendedGamepadButton>;
  132690. /**
  132691. * Fired when the B button on this controller is modified
  132692. */
  132693. get onBButtonStateChangedObservable(): Observable<ExtendedGamepadButton>;
  132694. /**
  132695. * Fired when the X button on this controller is modified
  132696. */
  132697. get onXButtonStateChangedObservable(): Observable<ExtendedGamepadButton>;
  132698. /**
  132699. * Fired when the Y button on this controller is modified
  132700. */
  132701. get onYButtonStateChangedObservable(): Observable<ExtendedGamepadButton>;
  132702. /**
  132703. * Called once for each button that changed state since the last frame
  132704. * 0) thumb stick (touch, press, value = pressed (0,1)). value is in this.leftStick
  132705. * 1) index trigger (touch (?), press (only when value > 0.1), value 0 to 1)
  132706. * 2) secondary trigger (same)
  132707. * 3) A (right) X (left), touch, pressed = value
  132708. * 4) B / Y
  132709. * 5) thumb rest
  132710. * @param buttonIdx Which button index changed
  132711. * @param state New state of the button
  132712. * @param changes Which properties on the state changed since last frame
  132713. */
  132714. protected _handleButtonChange(buttonIdx: number, state: ExtendedGamepadButton, changes: GamepadButtonChanges): void;
  132715. }
  132716. }
  132717. declare module BABYLON {
  132718. /**
  132719. * Vive Controller
  132720. */
  132721. export class ViveController extends WebVRController {
  132722. /**
  132723. * Base Url for the controller model.
  132724. */
  132725. static MODEL_BASE_URL: string;
  132726. /**
  132727. * File name for the controller model.
  132728. */
  132729. static MODEL_FILENAME: string;
  132730. /**
  132731. * Creates a new ViveController from a gamepad
  132732. * @param vrGamepad the gamepad that the controller should be created from
  132733. */
  132734. constructor(vrGamepad: any);
  132735. /**
  132736. * Implements abstract method on WebVRController class, loading controller meshes and calling this.attachToMesh if successful.
  132737. * @param scene scene in which to add meshes
  132738. * @param meshLoaded optional callback function that will be called if the mesh loads successfully.
  132739. */
  132740. initControllerMesh(scene: Scene, meshLoaded?: (mesh: AbstractMesh) => void): void;
  132741. /**
  132742. * Fired when the left button on this controller is modified
  132743. */
  132744. get onLeftButtonStateChangedObservable(): Observable<ExtendedGamepadButton>;
  132745. /**
  132746. * Fired when the right button on this controller is modified
  132747. */
  132748. get onRightButtonStateChangedObservable(): Observable<ExtendedGamepadButton>;
  132749. /**
  132750. * Fired when the menu button on this controller is modified
  132751. */
  132752. get onMenuButtonStateChangedObservable(): Observable<ExtendedGamepadButton>;
  132753. /**
  132754. * Called once for each button that changed state since the last frame
  132755. * Vive mapping:
  132756. * 0: touchpad
  132757. * 1: trigger
  132758. * 2: left AND right buttons
  132759. * 3: menu button
  132760. * @param buttonIdx Which button index changed
  132761. * @param state New state of the button
  132762. * @param changes Which properties on the state changed since last frame
  132763. */
  132764. protected _handleButtonChange(buttonIdx: number, state: ExtendedGamepadButton, changes: GamepadButtonChanges): void;
  132765. }
  132766. }
  132767. declare module BABYLON {
  132768. /**
  132769. * Defines the WindowsMotionController object that the state of the windows motion controller
  132770. */
  132771. export class WindowsMotionController extends WebVRController {
  132772. /**
  132773. * The base url used to load the left and right controller models
  132774. */
  132775. static MODEL_BASE_URL: string;
  132776. /**
  132777. * The name of the left controller model file
  132778. */
  132779. static MODEL_LEFT_FILENAME: string;
  132780. /**
  132781. * The name of the right controller model file
  132782. */
  132783. static MODEL_RIGHT_FILENAME: string;
  132784. /**
  132785. * The controller name prefix for this controller type
  132786. */
  132787. static readonly GAMEPAD_ID_PREFIX: string;
  132788. /**
  132789. * The controller id pattern for this controller type
  132790. */
  132791. private static readonly GAMEPAD_ID_PATTERN;
  132792. private _loadedMeshInfo;
  132793. protected readonly _mapping: {
  132794. buttons: string[];
  132795. buttonMeshNames: {
  132796. trigger: string;
  132797. menu: string;
  132798. grip: string;
  132799. thumbstick: string;
  132800. trackpad: string;
  132801. };
  132802. buttonObservableNames: {
  132803. trigger: string;
  132804. menu: string;
  132805. grip: string;
  132806. thumbstick: string;
  132807. trackpad: string;
  132808. };
  132809. axisMeshNames: string[];
  132810. pointingPoseMeshName: string;
  132811. };
  132812. /**
  132813. * Fired when the trackpad on this controller is clicked
  132814. */
  132815. onTrackpadChangedObservable: Observable<ExtendedGamepadButton>;
  132816. /**
  132817. * Fired when the trackpad on this controller is modified
  132818. */
  132819. onTrackpadValuesChangedObservable: Observable<StickValues>;
  132820. /**
  132821. * The current x and y values of this controller's trackpad
  132822. */
  132823. trackpad: StickValues;
  132824. /**
  132825. * Creates a new WindowsMotionController from a gamepad
  132826. * @param vrGamepad the gamepad that the controller should be created from
  132827. */
  132828. constructor(vrGamepad: any);
  132829. /**
  132830. * Fired when the trigger on this controller is modified
  132831. */
  132832. get onTriggerButtonStateChangedObservable(): Observable<ExtendedGamepadButton>;
  132833. /**
  132834. * Fired when the menu button on this controller is modified
  132835. */
  132836. get onMenuButtonStateChangedObservable(): Observable<ExtendedGamepadButton>;
  132837. /**
  132838. * Fired when the grip button on this controller is modified
  132839. */
  132840. get onGripButtonStateChangedObservable(): Observable<ExtendedGamepadButton>;
  132841. /**
  132842. * Fired when the thumbstick button on this controller is modified
  132843. */
  132844. get onThumbstickButtonStateChangedObservable(): Observable<ExtendedGamepadButton>;
  132845. /**
  132846. * Fired when the touchpad button on this controller is modified
  132847. */
  132848. get onTouchpadButtonStateChangedObservable(): Observable<ExtendedGamepadButton>;
  132849. /**
  132850. * Fired when the touchpad values on this controller are modified
  132851. */
  132852. get onTouchpadValuesChangedObservable(): Observable<StickValues>;
  132853. protected _updateTrackpad(): void;
  132854. /**
  132855. * Called once per frame by the engine.
  132856. */
  132857. update(): void;
  132858. /**
  132859. * Called once for each button that changed state since the last frame
  132860. * @param buttonIdx Which button index changed
  132861. * @param state New state of the button
  132862. * @param changes Which properties on the state changed since last frame
  132863. */
  132864. protected _handleButtonChange(buttonIdx: number, state: ExtendedGamepadButton, changes: GamepadButtonChanges): void;
  132865. /**
  132866. * Moves the buttons on the controller mesh based on their current state
  132867. * @param buttonName the name of the button to move
  132868. * @param buttonValue the value of the button which determines the buttons new position
  132869. */
  132870. protected _lerpButtonTransform(buttonName: string, buttonValue: number): void;
  132871. /**
  132872. * Moves the axis on the controller mesh based on its current state
  132873. * @param axis the index of the axis
  132874. * @param axisValue the value of the axis which determines the meshes new position
  132875. * @hidden
  132876. */
  132877. protected _lerpAxisTransform(axis: number, axisValue: number): void;
  132878. /**
  132879. * Implements abstract method on WebVRController class, loading controller meshes and calling this.attachToMesh if successful.
  132880. * @param scene scene in which to add meshes
  132881. * @param meshLoaded optional callback function that will be called if the mesh loads successfully.
  132882. */
  132883. initControllerMesh(scene: Scene, meshLoaded?: (mesh: AbstractMesh) => void, forceDefault?: boolean): void;
  132884. /**
  132885. * Takes a list of meshes (as loaded from the glTF file) and finds the root node, as well as nodes that
  132886. * can be transformed by button presses and axes values, based on this._mapping.
  132887. *
  132888. * @param scene scene in which the meshes exist
  132889. * @param meshes list of meshes that make up the controller model to process
  132890. * @return structured view of the given meshes, with mapping of buttons and axes to meshes that can be transformed.
  132891. */
  132892. private processModel;
  132893. private createMeshInfo;
  132894. /**
  132895. * Gets the ray of the controller in the direction the controller is pointing
  132896. * @param length the length the resulting ray should be
  132897. * @returns a ray in the direction the controller is pointing
  132898. */
  132899. getForwardRay(length?: number): Ray;
  132900. /**
  132901. * Disposes of the controller
  132902. */
  132903. dispose(): void;
  132904. }
  132905. /**
  132906. * This class represents a new windows motion controller in XR.
  132907. */
  132908. export class XRWindowsMotionController extends WindowsMotionController {
  132909. /**
  132910. * Changing the original WIndowsMotionController mapping to fir the new mapping
  132911. */
  132912. protected readonly _mapping: {
  132913. buttons: string[];
  132914. buttonMeshNames: {
  132915. trigger: string;
  132916. menu: string;
  132917. grip: string;
  132918. thumbstick: string;
  132919. trackpad: string;
  132920. };
  132921. buttonObservableNames: {
  132922. trigger: string;
  132923. menu: string;
  132924. grip: string;
  132925. thumbstick: string;
  132926. trackpad: string;
  132927. };
  132928. axisMeshNames: string[];
  132929. pointingPoseMeshName: string;
  132930. };
  132931. /**
  132932. * Construct a new XR-Based windows motion controller
  132933. *
  132934. * @param gamepadInfo the gamepad object from the browser
  132935. */
  132936. constructor(gamepadInfo: any);
  132937. /**
  132938. * holds the thumbstick values (X,Y)
  132939. */
  132940. thumbstickValues: StickValues;
  132941. /**
  132942. * Fired when the thumbstick on this controller is clicked
  132943. */
  132944. onThumbstickStateChangedObservable: Observable<ExtendedGamepadButton>;
  132945. /**
  132946. * Fired when the thumbstick on this controller is modified
  132947. */
  132948. onThumbstickValuesChangedObservable: Observable<StickValues>;
  132949. /**
  132950. * Fired when the touchpad button on this controller is modified
  132951. */
  132952. onTrackpadChangedObservable: Observable<ExtendedGamepadButton>;
  132953. /**
  132954. * Fired when the touchpad values on this controller are modified
  132955. */
  132956. onTrackpadValuesChangedObservable: Observable<StickValues>;
  132957. /**
  132958. * Fired when the thumbstick button on this controller is modified
  132959. * here to prevent breaking changes
  132960. */
  132961. get onThumbstickButtonStateChangedObservable(): Observable<ExtendedGamepadButton>;
  132962. /**
  132963. * updating the thumbstick(!) and not the trackpad.
  132964. * This is named this way due to the difference between WebVR and XR and to avoid
  132965. * changing the parent class.
  132966. */
  132967. protected _updateTrackpad(): void;
  132968. /**
  132969. * Disposes the class with joy
  132970. */
  132971. dispose(): void;
  132972. }
  132973. }
  132974. declare module BABYLON {
  132975. /**
  132976. * Class containing static functions to help procedurally build meshes
  132977. */
  132978. export class PolyhedronBuilder {
  132979. /**
  132980. * Creates a polyhedron mesh
  132981. * * 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
  132982. * * The parameter `size` (positive float, default 1) sets the polygon size
  132983. * * You can overwrite the `size` on each dimension bu using the parameters `sizeX`, `sizeY` or `sizeZ` (positive floats, default to `size` value)
  132984. * * 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`
  132985. * * 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
  132986. * * 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)`)
  132987. * * 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
  132988. * * 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
  132989. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  132990. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  132991. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  132992. * @param name defines the name of the mesh
  132993. * @param options defines the options used to create the mesh
  132994. * @param scene defines the hosting scene
  132995. * @returns the polyhedron mesh
  132996. * @see https://doc.babylonjs.com/how_to/polyhedra_shapes
  132997. */
  132998. static CreatePolyhedron(name: string, options: {
  132999. type?: number;
  133000. size?: number;
  133001. sizeX?: number;
  133002. sizeY?: number;
  133003. sizeZ?: number;
  133004. custom?: any;
  133005. faceUV?: Vector4[];
  133006. faceColors?: Color4[];
  133007. flat?: boolean;
  133008. updatable?: boolean;
  133009. sideOrientation?: number;
  133010. frontUVs?: Vector4;
  133011. backUVs?: Vector4;
  133012. }, scene?: Nullable<Scene>): Mesh;
  133013. }
  133014. }
  133015. declare module BABYLON {
  133016. /**
  133017. * Gizmo that enables scaling a mesh along 3 axis
  133018. */
  133019. export class ScaleGizmo extends Gizmo {
  133020. /**
  133021. * Internal gizmo used for interactions on the x axis
  133022. */
  133023. xGizmo: AxisScaleGizmo;
  133024. /**
  133025. * Internal gizmo used for interactions on the y axis
  133026. */
  133027. yGizmo: AxisScaleGizmo;
  133028. /**
  133029. * Internal gizmo used for interactions on the z axis
  133030. */
  133031. zGizmo: AxisScaleGizmo;
  133032. /**
  133033. * Internal gizmo used to scale all axis equally
  133034. */
  133035. uniformScaleGizmo: AxisScaleGizmo;
  133036. private _meshAttached;
  133037. private _nodeAttached;
  133038. private _snapDistance;
  133039. private _uniformScalingMesh;
  133040. private _octahedron;
  133041. private _sensitivity;
  133042. /** Fires an event when any of it's sub gizmos are dragged */
  133043. onDragStartObservable: Observable<unknown>;
  133044. /** Fires an event when any of it's sub gizmos are released from dragging */
  133045. onDragEndObservable: Observable<unknown>;
  133046. get attachedMesh(): Nullable<AbstractMesh>;
  133047. set attachedMesh(mesh: Nullable<AbstractMesh>);
  133048. get attachedNode(): Nullable<Node>;
  133049. set attachedNode(node: Nullable<Node>);
  133050. /**
  133051. * Creates a ScaleGizmo
  133052. * @param gizmoLayer The utility layer the gizmo will be added to
  133053. * @param thickness display gizmo axis thickness
  133054. */
  133055. constructor(gizmoLayer?: UtilityLayerRenderer, thickness?: number);
  133056. set updateGizmoRotationToMatchAttachedMesh(value: boolean);
  133057. get updateGizmoRotationToMatchAttachedMesh(): boolean;
  133058. /**
  133059. * Drag distance in babylon units that the gizmo will snap to when dragged (Default: 0)
  133060. */
  133061. set snapDistance(value: number);
  133062. get snapDistance(): number;
  133063. /**
  133064. * Ratio for the scale of the gizmo (Default: 1)
  133065. */
  133066. set scaleRatio(value: number);
  133067. get scaleRatio(): number;
  133068. /**
  133069. * Sensitivity factor for dragging (Default: 1)
  133070. */
  133071. set sensitivity(value: number);
  133072. get sensitivity(): number;
  133073. /**
  133074. * Disposes of the gizmo
  133075. */
  133076. dispose(): void;
  133077. }
  133078. }
  133079. declare module BABYLON {
  133080. /**
  133081. * Single axis scale gizmo
  133082. */
  133083. export class AxisScaleGizmo extends Gizmo {
  133084. /**
  133085. * Drag behavior responsible for the gizmos dragging interactions
  133086. */
  133087. dragBehavior: PointerDragBehavior;
  133088. private _pointerObserver;
  133089. /**
  133090. * Scale distance in babylon units that the gizmo will snap to when dragged (Default: 0)
  133091. */
  133092. snapDistance: number;
  133093. /**
  133094. * Event that fires each time the gizmo snaps to a new location.
  133095. * * snapDistance is the the change in distance
  133096. */
  133097. onSnapObservable: Observable<{
  133098. snapDistance: number;
  133099. }>;
  133100. /**
  133101. * If the scaling operation should be done on all axis (default: false)
  133102. */
  133103. uniformScaling: boolean;
  133104. /**
  133105. * Custom sensitivity value for the drag strength
  133106. */
  133107. sensitivity: number;
  133108. private _isEnabled;
  133109. private _parent;
  133110. private _arrow;
  133111. private _coloredMaterial;
  133112. private _hoverMaterial;
  133113. /**
  133114. * Creates an AxisScaleGizmo
  133115. * @param gizmoLayer The utility layer the gizmo will be added to
  133116. * @param dragAxis The axis which the gizmo will be able to scale on
  133117. * @param color The color of the gizmo
  133118. * @param thickness display gizmo axis thickness
  133119. */
  133120. constructor(dragAxis: Vector3, color?: Color3, gizmoLayer?: UtilityLayerRenderer, parent?: Nullable<ScaleGizmo>, thickness?: number);
  133121. protected _attachedNodeChanged(value: Nullable<Node>): void;
  133122. /**
  133123. * If the gizmo is enabled
  133124. */
  133125. set isEnabled(value: boolean);
  133126. get isEnabled(): boolean;
  133127. /**
  133128. * Disposes of the gizmo
  133129. */
  133130. dispose(): void;
  133131. /**
  133132. * Disposes and replaces the current meshes in the gizmo with the specified mesh
  133133. * @param mesh The mesh to replace the default mesh of the gizmo
  133134. * @param useGizmoMaterial If the gizmo's default material should be used (default: false)
  133135. */
  133136. setCustomMesh(mesh: Mesh, useGizmoMaterial?: boolean): void;
  133137. }
  133138. }
  133139. declare module BABYLON {
  133140. /**
  133141. * Bounding box gizmo
  133142. */
  133143. export class BoundingBoxGizmo extends Gizmo {
  133144. private _lineBoundingBox;
  133145. private _rotateSpheresParent;
  133146. private _scaleBoxesParent;
  133147. private _boundingDimensions;
  133148. private _renderObserver;
  133149. private _pointerObserver;
  133150. private _scaleDragSpeed;
  133151. private _tmpQuaternion;
  133152. private _tmpVector;
  133153. private _tmpRotationMatrix;
  133154. /**
  133155. * 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)
  133156. */
  133157. ignoreChildren: boolean;
  133158. /**
  133159. * 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)
  133160. */
  133161. includeChildPredicate: Nullable<(abstractMesh: AbstractMesh) => boolean>;
  133162. /**
  133163. * The size of the rotation spheres attached to the bounding box (Default: 0.1)
  133164. */
  133165. rotationSphereSize: number;
  133166. /**
  133167. * The size of the scale boxes attached to the bounding box (Default: 0.1)
  133168. */
  133169. scaleBoxSize: number;
  133170. /**
  133171. * 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)
  133172. */
  133173. fixedDragMeshScreenSize: boolean;
  133174. /**
  133175. * The distance away from the object which the draggable meshes should appear world sized when fixedDragMeshScreenSize is set to true (default: 10)
  133176. */
  133177. fixedDragMeshScreenSizeDistanceFactor: number;
  133178. /**
  133179. * Fired when a rotation sphere or scale box is dragged
  133180. */
  133181. onDragStartObservable: Observable<{}>;
  133182. /**
  133183. * Fired when a scale box is dragged
  133184. */
  133185. onScaleBoxDragObservable: Observable<{}>;
  133186. /**
  133187. * Fired when a scale box drag is ended
  133188. */
  133189. onScaleBoxDragEndObservable: Observable<{}>;
  133190. /**
  133191. * Fired when a rotation sphere is dragged
  133192. */
  133193. onRotationSphereDragObservable: Observable<{}>;
  133194. /**
  133195. * Fired when a rotation sphere drag is ended
  133196. */
  133197. onRotationSphereDragEndObservable: Observable<{}>;
  133198. /**
  133199. * 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)
  133200. */
  133201. scalePivot: Nullable<Vector3>;
  133202. /**
  133203. * Mesh used as a pivot to rotate the attached node
  133204. */
  133205. private _anchorMesh;
  133206. private _existingMeshScale;
  133207. private _dragMesh;
  133208. private pointerDragBehavior;
  133209. private coloredMaterial;
  133210. private hoverColoredMaterial;
  133211. /**
  133212. * Sets the color of the bounding box gizmo
  133213. * @param color the color to set
  133214. */
  133215. setColor(color: Color3): void;
  133216. /**
  133217. * Creates an BoundingBoxGizmo
  133218. * @param gizmoLayer The utility layer the gizmo will be added to
  133219. * @param color The color of the gizmo
  133220. */
  133221. constructor(color?: Color3, gizmoLayer?: UtilityLayerRenderer);
  133222. protected _attachedNodeChanged(value: Nullable<AbstractMesh>): void;
  133223. private _selectNode;
  133224. /**
  133225. * Updates the bounding box information for the Gizmo
  133226. */
  133227. updateBoundingBox(): void;
  133228. private _updateRotationSpheres;
  133229. private _updateScaleBoxes;
  133230. /**
  133231. * Enables rotation on the specified axis and disables rotation on the others
  133232. * @param axis The list of axis that should be enabled (eg. "xy" or "xyz")
  133233. */
  133234. setEnabledRotationAxis(axis: string): void;
  133235. /**
  133236. * Enables/disables scaling
  133237. * @param enable if scaling should be enabled
  133238. * @param homogeneousScaling defines if scaling should only be homogeneous
  133239. */
  133240. setEnabledScaling(enable: boolean, homogeneousScaling?: boolean): void;
  133241. private _updateDummy;
  133242. /**
  133243. * Enables a pointer drag behavior on the bounding box of the gizmo
  133244. */
  133245. enableDragBehavior(): void;
  133246. /**
  133247. * Disposes of the gizmo
  133248. */
  133249. dispose(): void;
  133250. /**
  133251. * 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)
  133252. * @param mesh the mesh to wrap in the bounding box mesh and make not pickable
  133253. * @returns the bounding box mesh with the passed in mesh as a child
  133254. */
  133255. static MakeNotPickableAndWrapInBoundingBox(mesh: Mesh): Mesh;
  133256. /**
  133257. * CustomMeshes are not supported by this gizmo
  133258. * @param mesh The mesh to replace the default mesh of the gizmo
  133259. */
  133260. setCustomMesh(mesh: Mesh): void;
  133261. }
  133262. }
  133263. declare module BABYLON {
  133264. /**
  133265. * Single plane rotation gizmo
  133266. */
  133267. export class PlaneRotationGizmo extends Gizmo {
  133268. /**
  133269. * Drag behavior responsible for the gizmos dragging interactions
  133270. */
  133271. dragBehavior: PointerDragBehavior;
  133272. private _pointerObserver;
  133273. /**
  133274. * Rotation distance in radians that the gizmo will snap to (Default: 0)
  133275. */
  133276. snapDistance: number;
  133277. /**
  133278. * Event that fires each time the gizmo snaps to a new location.
  133279. * * snapDistance is the the change in distance
  133280. */
  133281. onSnapObservable: Observable<{
  133282. snapDistance: number;
  133283. }>;
  133284. private _isEnabled;
  133285. private _parent;
  133286. /**
  133287. * Creates a PlaneRotationGizmo
  133288. * @param gizmoLayer The utility layer the gizmo will be added to
  133289. * @param planeNormal The normal of the plane which the gizmo will be able to rotate on
  133290. * @param color The color of the gizmo
  133291. * @param tessellation Amount of tessellation to be used when creating rotation circles
  133292. * @param useEulerRotation Use and update Euler angle instead of quaternion
  133293. * @param thickness display gizmo axis thickness
  133294. */
  133295. constructor(planeNormal: Vector3, color?: Color3, gizmoLayer?: UtilityLayerRenderer, tessellation?: number, parent?: Nullable<RotationGizmo>, useEulerRotation?: boolean, thickness?: number);
  133296. protected _attachedNodeChanged(value: Nullable<Node>): void;
  133297. /**
  133298. * If the gizmo is enabled
  133299. */
  133300. set isEnabled(value: boolean);
  133301. get isEnabled(): boolean;
  133302. /**
  133303. * Disposes of the gizmo
  133304. */
  133305. dispose(): void;
  133306. }
  133307. }
  133308. declare module BABYLON {
  133309. /**
  133310. * Gizmo that enables rotating a mesh along 3 axis
  133311. */
  133312. export class RotationGizmo extends Gizmo {
  133313. /**
  133314. * Internal gizmo used for interactions on the x axis
  133315. */
  133316. xGizmo: PlaneRotationGizmo;
  133317. /**
  133318. * Internal gizmo used for interactions on the y axis
  133319. */
  133320. yGizmo: PlaneRotationGizmo;
  133321. /**
  133322. * Internal gizmo used for interactions on the z axis
  133323. */
  133324. zGizmo: PlaneRotationGizmo;
  133325. /** Fires an event when any of it's sub gizmos are dragged */
  133326. onDragStartObservable: Observable<unknown>;
  133327. /** Fires an event when any of it's sub gizmos are released from dragging */
  133328. onDragEndObservable: Observable<unknown>;
  133329. private _meshAttached;
  133330. private _nodeAttached;
  133331. get attachedMesh(): Nullable<AbstractMesh>;
  133332. set attachedMesh(mesh: Nullable<AbstractMesh>);
  133333. get attachedNode(): Nullable<Node>;
  133334. set attachedNode(node: Nullable<Node>);
  133335. /**
  133336. * Creates a RotationGizmo
  133337. * @param gizmoLayer The utility layer the gizmo will be added to
  133338. * @param tessellation Amount of tessellation to be used when creating rotation circles
  133339. * @param useEulerRotation Use and update Euler angle instead of quaternion
  133340. * @param thickness display gizmo axis thickness
  133341. */
  133342. constructor(gizmoLayer?: UtilityLayerRenderer, tessellation?: number, useEulerRotation?: boolean, thickness?: number);
  133343. set updateGizmoRotationToMatchAttachedMesh(value: boolean);
  133344. get updateGizmoRotationToMatchAttachedMesh(): boolean;
  133345. /**
  133346. * Drag distance in babylon units that the gizmo will snap to when dragged (Default: 0)
  133347. */
  133348. set snapDistance(value: number);
  133349. get snapDistance(): number;
  133350. /**
  133351. * Ratio for the scale of the gizmo (Default: 1)
  133352. */
  133353. set scaleRatio(value: number);
  133354. get scaleRatio(): number;
  133355. /**
  133356. * Disposes of the gizmo
  133357. */
  133358. dispose(): void;
  133359. /**
  133360. * CustomMeshes are not supported by this gizmo
  133361. * @param mesh The mesh to replace the default mesh of the gizmo
  133362. */
  133363. setCustomMesh(mesh: Mesh): void;
  133364. }
  133365. }
  133366. declare module BABYLON {
  133367. /**
  133368. * Helps setup gizmo's in the scene to rotate/scale/position nodes
  133369. */
  133370. export class GizmoManager implements IDisposable {
  133371. private scene;
  133372. /**
  133373. * Gizmo's created by the gizmo manager, gizmo will be null until gizmo has been enabled for the first time
  133374. */
  133375. gizmos: {
  133376. positionGizmo: Nullable<PositionGizmo>;
  133377. rotationGizmo: Nullable<RotationGizmo>;
  133378. scaleGizmo: Nullable<ScaleGizmo>;
  133379. boundingBoxGizmo: Nullable<BoundingBoxGizmo>;
  133380. };
  133381. /** When true, the gizmo will be detached from the current object when a pointer down occurs with an empty picked mesh */
  133382. clearGizmoOnEmptyPointerEvent: boolean;
  133383. /** Fires an event when the manager is attached to a mesh */
  133384. onAttachedToMeshObservable: Observable<Nullable<AbstractMesh>>;
  133385. /** Fires an event when the manager is attached to a node */
  133386. onAttachedToNodeObservable: Observable<Nullable<Node>>;
  133387. private _gizmosEnabled;
  133388. private _pointerObserver;
  133389. private _attachedMesh;
  133390. private _attachedNode;
  133391. private _boundingBoxColor;
  133392. private _defaultUtilityLayer;
  133393. private _defaultKeepDepthUtilityLayer;
  133394. private _thickness;
  133395. /**
  133396. * When bounding box gizmo is enabled, this can be used to track drag/end events
  133397. */
  133398. boundingBoxDragBehavior: SixDofDragBehavior;
  133399. /**
  133400. * Array of meshes which will have the gizmo attached when a pointer selected them. If null, all meshes are attachable. (Default: null)
  133401. */
  133402. attachableMeshes: Nullable<Array<AbstractMesh>>;
  133403. /**
  133404. * Array of nodes which will have the gizmo attached when a pointer selected them. If null, all nodes are attachable. (Default: null)
  133405. */
  133406. attachableNodes: Nullable<Array<Node>>;
  133407. /**
  133408. * If pointer events should perform attaching/detaching a gizmo, if false this can be done manually via attachToMesh/attachToNode. (Default: true)
  133409. */
  133410. usePointerToAttachGizmos: boolean;
  133411. /**
  133412. * Utility layer that the bounding box gizmo belongs to
  133413. */
  133414. get keepDepthUtilityLayer(): UtilityLayerRenderer;
  133415. /**
  133416. * Utility layer that all gizmos besides bounding box belong to
  133417. */
  133418. get utilityLayer(): UtilityLayerRenderer;
  133419. /**
  133420. * Instatiates a gizmo manager
  133421. * @param scene the scene to overlay the gizmos on top of
  133422. * @param thickness display gizmo axis thickness
  133423. */
  133424. constructor(scene: Scene, thickness?: number);
  133425. /**
  133426. * Attaches a set of gizmos to the specified mesh
  133427. * @param mesh The mesh the gizmo's should be attached to
  133428. */
  133429. attachToMesh(mesh: Nullable<AbstractMesh>): void;
  133430. /**
  133431. * Attaches a set of gizmos to the specified node
  133432. * @param node The node the gizmo's should be attached to
  133433. */
  133434. attachToNode(node: Nullable<Node>): void;
  133435. /**
  133436. * If the position gizmo is enabled
  133437. */
  133438. set positionGizmoEnabled(value: boolean);
  133439. get positionGizmoEnabled(): boolean;
  133440. /**
  133441. * If the rotation gizmo is enabled
  133442. */
  133443. set rotationGizmoEnabled(value: boolean);
  133444. get rotationGizmoEnabled(): boolean;
  133445. /**
  133446. * If the scale gizmo is enabled
  133447. */
  133448. set scaleGizmoEnabled(value: boolean);
  133449. get scaleGizmoEnabled(): boolean;
  133450. /**
  133451. * If the boundingBox gizmo is enabled
  133452. */
  133453. set boundingBoxGizmoEnabled(value: boolean);
  133454. get boundingBoxGizmoEnabled(): boolean;
  133455. /**
  133456. * Disposes of the gizmo manager
  133457. */
  133458. dispose(): void;
  133459. }
  133460. }
  133461. declare module BABYLON {
  133462. /**
  133463. * A directional light is defined by a direction (what a surprise!).
  133464. * The light is emitted from everywhere in the specified direction, and has an infinite range.
  133465. * 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.
  133466. * Documentation: https://doc.babylonjs.com/babylon101/lights
  133467. */
  133468. export class DirectionalLight extends ShadowLight {
  133469. private _shadowFrustumSize;
  133470. /**
  133471. * Fix frustum size for the shadow generation. This is disabled if the value is 0.
  133472. */
  133473. get shadowFrustumSize(): number;
  133474. /**
  133475. * Specifies a fix frustum size for the shadow generation.
  133476. */
  133477. set shadowFrustumSize(value: number);
  133478. private _shadowOrthoScale;
  133479. /**
  133480. * Gets the shadow projection scale against the optimal computed one.
  133481. * 0.1 by default which means that the projection window is increase by 10% from the optimal size.
  133482. * This does not impact in fixed frustum size (shadowFrustumSize being set)
  133483. */
  133484. get shadowOrthoScale(): number;
  133485. /**
  133486. * Sets the shadow projection scale against the optimal computed one.
  133487. * 0.1 by default which means that the projection window is increase by 10% from the optimal size.
  133488. * This does not impact in fixed frustum size (shadowFrustumSize being set)
  133489. */
  133490. set shadowOrthoScale(value: number);
  133491. /**
  133492. * Automatically compute the projection matrix to best fit (including all the casters)
  133493. * on each frame.
  133494. */
  133495. autoUpdateExtends: boolean;
  133496. /**
  133497. * Automatically compute the shadowMinZ and shadowMaxZ for the projection matrix to best fit (including all the casters)
  133498. * on each frame. autoUpdateExtends must be set to true for this to work
  133499. */
  133500. autoCalcShadowZBounds: boolean;
  133501. private _orthoLeft;
  133502. private _orthoRight;
  133503. private _orthoTop;
  133504. private _orthoBottom;
  133505. /**
  133506. * Creates a DirectionalLight object in the scene, oriented towards the passed direction (Vector3).
  133507. * The directional light is emitted from everywhere in the given direction.
  133508. * It can cast shadows.
  133509. * Documentation : https://doc.babylonjs.com/babylon101/lights
  133510. * @param name The friendly name of the light
  133511. * @param direction The direction of the light
  133512. * @param scene The scene the light belongs to
  133513. */
  133514. constructor(name: string, direction: Vector3, scene: Scene);
  133515. /**
  133516. * Returns the string "DirectionalLight".
  133517. * @return The class name
  133518. */
  133519. getClassName(): string;
  133520. /**
  133521. * Returns the integer 1.
  133522. * @return The light Type id as a constant defines in Light.LIGHTTYPEID_x
  133523. */
  133524. getTypeID(): number;
  133525. /**
  133526. * Sets the passed matrix "matrix" as projection matrix for the shadows cast by the light according to the passed view matrix.
  133527. * Returns the DirectionalLight Shadow projection matrix.
  133528. */
  133529. protected _setDefaultShadowProjectionMatrix(matrix: Matrix, viewMatrix: Matrix, renderList: Array<AbstractMesh>): void;
  133530. /**
  133531. * Sets the passed matrix "matrix" as fixed frustum projection matrix for the shadows cast by the light according to the passed view matrix.
  133532. * Returns the DirectionalLight Shadow projection matrix.
  133533. */
  133534. protected _setDefaultFixedFrustumShadowProjectionMatrix(matrix: Matrix): void;
  133535. /**
  133536. * Sets the passed matrix "matrix" as auto extend projection matrix for the shadows cast by the light according to the passed view matrix.
  133537. * Returns the DirectionalLight Shadow projection matrix.
  133538. */
  133539. protected _setDefaultAutoExtendShadowProjectionMatrix(matrix: Matrix, viewMatrix: Matrix, renderList: Array<AbstractMesh>): void;
  133540. protected _buildUniformLayout(): void;
  133541. /**
  133542. * Sets the passed Effect object with the DirectionalLight transformed position (or position if not parented) and the passed name.
  133543. * @param effect The effect to update
  133544. * @param lightIndex The index of the light in the effect to update
  133545. * @returns The directional light
  133546. */
  133547. transferToEffect(effect: Effect, lightIndex: string): DirectionalLight;
  133548. transferToNodeMaterialEffect(effect: Effect, lightDataUniformName: string): Light;
  133549. /**
  133550. * Gets the minZ used for shadow according to both the scene and the light.
  133551. *
  133552. * Values are fixed on directional lights as it relies on an ortho projection hence the need to convert being
  133553. * -1 and 1 to 0 and 1 doing (depth + min) / (min + max) -> (depth + 1) / (1 + 1) -> (depth * 0.5) + 0.5.
  133554. * @param activeCamera The camera we are returning the min for
  133555. * @returns the depth min z
  133556. */
  133557. getDepthMinZ(activeCamera: Camera): number;
  133558. /**
  133559. * Gets the maxZ used for shadow according to both the scene and the light.
  133560. *
  133561. * Values are fixed on directional lights as it relies on an ortho projection hence the need to convert being
  133562. * -1 and 1 to 0 and 1 doing (depth + min) / (min + max) -> (depth + 1) / (1 + 1) -> (depth * 0.5) + 0.5.
  133563. * @param activeCamera The camera we are returning the max for
  133564. * @returns the depth max z
  133565. */
  133566. getDepthMaxZ(activeCamera: Camera): number;
  133567. /**
  133568. * Prepares the list of defines specific to the light type.
  133569. * @param defines the list of defines
  133570. * @param lightIndex defines the index of the light for the effect
  133571. */
  133572. prepareLightSpecificDefines(defines: any, lightIndex: number): void;
  133573. }
  133574. }
  133575. declare module BABYLON {
  133576. /**
  133577. * Class containing static functions to help procedurally build meshes
  133578. */
  133579. export class HemisphereBuilder {
  133580. /**
  133581. * Creates a hemisphere mesh
  133582. * @param name defines the name of the mesh
  133583. * @param options defines the options used to create the mesh
  133584. * @param scene defines the hosting scene
  133585. * @returns the hemisphere mesh
  133586. */
  133587. static CreateHemisphere(name: string, options: {
  133588. segments?: number;
  133589. diameter?: number;
  133590. sideOrientation?: number;
  133591. }, scene: any): Mesh;
  133592. }
  133593. }
  133594. declare module BABYLON {
  133595. /**
  133596. * A spot light is defined by a position, a direction, an angle, and an exponent.
  133597. * These values define a cone of light starting from the position, emitting toward the direction.
  133598. * The angle, in radians, defines the size (field of illumination) of the spotlight's conical beam,
  133599. * and the exponent defines the speed of the decay of the light with distance (reach).
  133600. * Documentation: https://doc.babylonjs.com/babylon101/lights
  133601. */
  133602. export class SpotLight extends ShadowLight {
  133603. private _angle;
  133604. private _innerAngle;
  133605. private _cosHalfAngle;
  133606. private _lightAngleScale;
  133607. private _lightAngleOffset;
  133608. /**
  133609. * Gets the cone angle of the spot light in Radians.
  133610. */
  133611. get angle(): number;
  133612. /**
  133613. * Sets the cone angle of the spot light in Radians.
  133614. */
  133615. set angle(value: number);
  133616. /**
  133617. * Only used in gltf falloff mode, this defines the angle where
  133618. * the directional falloff will start before cutting at angle which could be seen
  133619. * as outer angle.
  133620. */
  133621. get innerAngle(): number;
  133622. /**
  133623. * Only used in gltf falloff mode, this defines the angle where
  133624. * the directional falloff will start before cutting at angle which could be seen
  133625. * as outer angle.
  133626. */
  133627. set innerAngle(value: number);
  133628. private _shadowAngleScale;
  133629. /**
  133630. * Allows scaling the angle of the light for shadow generation only.
  133631. */
  133632. get shadowAngleScale(): number;
  133633. /**
  133634. * Allows scaling the angle of the light for shadow generation only.
  133635. */
  133636. set shadowAngleScale(value: number);
  133637. /**
  133638. * The light decay speed with the distance from the emission spot.
  133639. */
  133640. exponent: number;
  133641. private _projectionTextureMatrix;
  133642. /**
  133643. * Allows reading the projecton texture
  133644. */
  133645. get projectionTextureMatrix(): Matrix;
  133646. protected _projectionTextureLightNear: number;
  133647. /**
  133648. * Gets the near clip of the Spotlight for texture projection.
  133649. */
  133650. get projectionTextureLightNear(): number;
  133651. /**
  133652. * Sets the near clip of the Spotlight for texture projection.
  133653. */
  133654. set projectionTextureLightNear(value: number);
  133655. protected _projectionTextureLightFar: number;
  133656. /**
  133657. * Gets the far clip of the Spotlight for texture projection.
  133658. */
  133659. get projectionTextureLightFar(): number;
  133660. /**
  133661. * Sets the far clip of the Spotlight for texture projection.
  133662. */
  133663. set projectionTextureLightFar(value: number);
  133664. protected _projectionTextureUpDirection: Vector3;
  133665. /**
  133666. * Gets the Up vector of the Spotlight for texture projection.
  133667. */
  133668. get projectionTextureUpDirection(): Vector3;
  133669. /**
  133670. * Sets the Up vector of the Spotlight for texture projection.
  133671. */
  133672. set projectionTextureUpDirection(value: Vector3);
  133673. private _projectionTexture;
  133674. /**
  133675. * Gets the projection texture of the light.
  133676. */
  133677. get projectionTexture(): Nullable<BaseTexture>;
  133678. /**
  133679. * Sets the projection texture of the light.
  133680. */
  133681. set projectionTexture(value: Nullable<BaseTexture>);
  133682. private _projectionTextureViewLightDirty;
  133683. private _projectionTextureProjectionLightDirty;
  133684. private _projectionTextureDirty;
  133685. private _projectionTextureViewTargetVector;
  133686. private _projectionTextureViewLightMatrix;
  133687. private _projectionTextureProjectionLightMatrix;
  133688. private _projectionTextureScalingMatrix;
  133689. /**
  133690. * Creates a SpotLight object in the scene. A spot light is a simply light oriented cone.
  133691. * It can cast shadows.
  133692. * Documentation : https://doc.babylonjs.com/babylon101/lights
  133693. * @param name The light friendly name
  133694. * @param position The position of the spot light in the scene
  133695. * @param direction The direction of the light in the scene
  133696. * @param angle The cone angle of the light in Radians
  133697. * @param exponent The light decay speed with the distance from the emission spot
  133698. * @param scene The scene the lights belongs to
  133699. */
  133700. constructor(name: string, position: Vector3, direction: Vector3, angle: number, exponent: number, scene: Scene);
  133701. /**
  133702. * Returns the string "SpotLight".
  133703. * @returns the class name
  133704. */
  133705. getClassName(): string;
  133706. /**
  133707. * Returns the integer 2.
  133708. * @returns The light Type id as a constant defines in Light.LIGHTTYPEID_x
  133709. */
  133710. getTypeID(): number;
  133711. /**
  133712. * Overrides the direction setter to recompute the projection texture view light Matrix.
  133713. */
  133714. protected _setDirection(value: Vector3): void;
  133715. /**
  133716. * Overrides the position setter to recompute the projection texture view light Matrix.
  133717. */
  133718. protected _setPosition(value: Vector3): void;
  133719. /**
  133720. * 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.
  133721. * Returns the SpotLight.
  133722. */
  133723. protected _setDefaultShadowProjectionMatrix(matrix: Matrix, viewMatrix: Matrix, renderList: Array<AbstractMesh>): void;
  133724. protected _computeProjectionTextureViewLightMatrix(): void;
  133725. protected _computeProjectionTextureProjectionLightMatrix(): void;
  133726. /**
  133727. * Main function for light texture projection matrix computing.
  133728. */
  133729. protected _computeProjectionTextureMatrix(): void;
  133730. protected _buildUniformLayout(): void;
  133731. private _computeAngleValues;
  133732. /**
  133733. * Sets the passed Effect "effect" with the Light textures.
  133734. * @param effect The effect to update
  133735. * @param lightIndex The index of the light in the effect to update
  133736. * @returns The light
  133737. */
  133738. transferTexturesToEffect(effect: Effect, lightIndex: string): Light;
  133739. /**
  133740. * Sets the passed Effect object with the SpotLight transfomed position (or position if not parented) and normalized direction.
  133741. * @param effect The effect to update
  133742. * @param lightIndex The index of the light in the effect to update
  133743. * @returns The spot light
  133744. */
  133745. transferToEffect(effect: Effect, lightIndex: string): SpotLight;
  133746. transferToNodeMaterialEffect(effect: Effect, lightDataUniformName: string): this;
  133747. /**
  133748. * Disposes the light and the associated resources.
  133749. */
  133750. dispose(): void;
  133751. /**
  133752. * Prepares the list of defines specific to the light type.
  133753. * @param defines the list of defines
  133754. * @param lightIndex defines the index of the light for the effect
  133755. */
  133756. prepareLightSpecificDefines(defines: any, lightIndex: number): void;
  133757. }
  133758. }
  133759. declare module BABYLON {
  133760. /**
  133761. * Gizmo that enables viewing a light
  133762. */
  133763. export class LightGizmo extends Gizmo {
  133764. private _lightMesh;
  133765. private _material;
  133766. private _cachedPosition;
  133767. private _cachedForward;
  133768. private _attachedMeshParent;
  133769. /**
  133770. * Creates a LightGizmo
  133771. * @param gizmoLayer The utility layer the gizmo will be added to
  133772. */
  133773. constructor(gizmoLayer?: UtilityLayerRenderer);
  133774. private _light;
  133775. /**
  133776. * The light that the gizmo is attached to
  133777. */
  133778. set light(light: Nullable<Light>);
  133779. get light(): Nullable<Light>;
  133780. /**
  133781. * Gets the material used to render the light gizmo
  133782. */
  133783. get material(): StandardMaterial;
  133784. /**
  133785. * @hidden
  133786. * Updates the gizmo to match the attached mesh's position/rotation
  133787. */
  133788. protected _update(): void;
  133789. private static _Scale;
  133790. /**
  133791. * Creates the lines for a light mesh
  133792. */
  133793. private static _CreateLightLines;
  133794. /**
  133795. * Disposes of the light gizmo
  133796. */
  133797. dispose(): void;
  133798. private static _CreateHemisphericLightMesh;
  133799. private static _CreatePointLightMesh;
  133800. private static _CreateSpotLightMesh;
  133801. private static _CreateDirectionalLightMesh;
  133802. }
  133803. }
  133804. declare module BABYLON {
  133805. /**
  133806. * Gizmo that enables viewing a camera
  133807. */
  133808. export class CameraGizmo extends Gizmo {
  133809. private _cameraMesh;
  133810. private _cameraLinesMesh;
  133811. private _material;
  133812. /**
  133813. * Creates a CameraGizmo
  133814. * @param gizmoLayer The utility layer the gizmo will be added to
  133815. */
  133816. constructor(gizmoLayer?: UtilityLayerRenderer);
  133817. private _camera;
  133818. /** Gets or sets a boolean indicating if frustum lines must be rendered (true by default)) */
  133819. get displayFrustum(): boolean;
  133820. set displayFrustum(value: boolean);
  133821. /**
  133822. * The camera that the gizmo is attached to
  133823. */
  133824. set camera(camera: Nullable<Camera>);
  133825. get camera(): Nullable<Camera>;
  133826. /**
  133827. * Gets the material used to render the camera gizmo
  133828. */
  133829. get material(): StandardMaterial;
  133830. /**
  133831. * @hidden
  133832. * Updates the gizmo to match the attached mesh's position/rotation
  133833. */
  133834. protected _update(): void;
  133835. private static _Scale;
  133836. private _invProjection;
  133837. /**
  133838. * Disposes of the camera gizmo
  133839. */
  133840. dispose(): void;
  133841. private static _CreateCameraMesh;
  133842. private static _CreateCameraFrustum;
  133843. }
  133844. }
  133845. declare module BABYLON {
  133846. /** @hidden */
  133847. export var backgroundFragmentDeclaration: {
  133848. name: string;
  133849. shader: string;
  133850. };
  133851. }
  133852. declare module BABYLON {
  133853. /** @hidden */
  133854. export var backgroundUboDeclaration: {
  133855. name: string;
  133856. shader: string;
  133857. };
  133858. }
  133859. declare module BABYLON {
  133860. /** @hidden */
  133861. export var backgroundPixelShader: {
  133862. name: string;
  133863. shader: string;
  133864. };
  133865. }
  133866. declare module BABYLON {
  133867. /** @hidden */
  133868. export var backgroundVertexDeclaration: {
  133869. name: string;
  133870. shader: string;
  133871. };
  133872. }
  133873. declare module BABYLON {
  133874. /** @hidden */
  133875. export var backgroundVertexShader: {
  133876. name: string;
  133877. shader: string;
  133878. };
  133879. }
  133880. declare module BABYLON {
  133881. /**
  133882. * Background material used to create an efficient environement around your scene.
  133883. */
  133884. export class BackgroundMaterial extends PushMaterial {
  133885. /**
  133886. * Standard reflectance value at parallel view angle.
  133887. */
  133888. static StandardReflectance0: number;
  133889. /**
  133890. * Standard reflectance value at grazing angle.
  133891. */
  133892. static StandardReflectance90: number;
  133893. protected _primaryColor: Color3;
  133894. /**
  133895. * Key light Color (multiply against the environement texture)
  133896. */
  133897. primaryColor: Color3;
  133898. protected __perceptualColor: Nullable<Color3>;
  133899. /**
  133900. * Experimental Internal Use Only.
  133901. *
  133902. * Key light Color in "perceptual value" meaning the color you would like to see on screen.
  133903. * This acts as a helper to set the primary color to a more "human friendly" value.
  133904. * Conversion to linear space as well as exposure and tone mapping correction will be applied to keep the
  133905. * output color as close as possible from the chosen value.
  133906. * (This does not account for contrast color grading and color curves as they are considered post effect and not directly
  133907. * part of lighting setup.)
  133908. */
  133909. get _perceptualColor(): Nullable<Color3>;
  133910. set _perceptualColor(value: Nullable<Color3>);
  133911. protected _primaryColorShadowLevel: float;
  133912. /**
  133913. * Defines the level of the shadows (dark area of the reflection map) in order to help scaling the colors.
  133914. * The color opposite to the primary color is used at the level chosen to define what the black area would look.
  133915. */
  133916. get primaryColorShadowLevel(): float;
  133917. set primaryColorShadowLevel(value: float);
  133918. protected _primaryColorHighlightLevel: float;
  133919. /**
  133920. * Defines the level of the highliights (highlight area of the reflection map) in order to help scaling the colors.
  133921. * The primary color is used at the level chosen to define what the white area would look.
  133922. */
  133923. get primaryColorHighlightLevel(): float;
  133924. set primaryColorHighlightLevel(value: float);
  133925. protected _reflectionTexture: Nullable<BaseTexture>;
  133926. /**
  133927. * Reflection Texture used in the material.
  133928. * Should be author in a specific way for the best result (refer to the documentation).
  133929. */
  133930. reflectionTexture: Nullable<BaseTexture>;
  133931. protected _reflectionBlur: float;
  133932. /**
  133933. * Reflection Texture level of blur.
  133934. *
  133935. * Can be use to reuse an existing HDR Texture and target a specific LOD to prevent authoring the
  133936. * texture twice.
  133937. */
  133938. reflectionBlur: float;
  133939. protected _diffuseTexture: Nullable<BaseTexture>;
  133940. /**
  133941. * Diffuse Texture used in the material.
  133942. * Should be author in a specific way for the best result (refer to the documentation).
  133943. */
  133944. diffuseTexture: Nullable<BaseTexture>;
  133945. protected _shadowLights: Nullable<IShadowLight[]>;
  133946. /**
  133947. * Specify the list of lights casting shadow on the material.
  133948. * All scene shadow lights will be included if null.
  133949. */
  133950. shadowLights: Nullable<IShadowLight[]>;
  133951. protected _shadowLevel: float;
  133952. /**
  133953. * Helps adjusting the shadow to a softer level if required.
  133954. * 0 means black shadows and 1 means no shadows.
  133955. */
  133956. shadowLevel: float;
  133957. protected _sceneCenter: Vector3;
  133958. /**
  133959. * In case of opacity Fresnel or reflection falloff, this is use as a scene center.
  133960. * It is usually zero but might be interesting to modify according to your setup.
  133961. */
  133962. sceneCenter: Vector3;
  133963. protected _opacityFresnel: boolean;
  133964. /**
  133965. * This helps specifying that the material is falling off to the sky box at grazing angle.
  133966. * This helps ensuring a nice transition when the camera goes under the ground.
  133967. */
  133968. opacityFresnel: boolean;
  133969. protected _reflectionFresnel: boolean;
  133970. /**
  133971. * This helps specifying that the material is falling off from diffuse to the reflection texture at grazing angle.
  133972. * This helps adding a mirror texture on the ground.
  133973. */
  133974. reflectionFresnel: boolean;
  133975. protected _reflectionFalloffDistance: number;
  133976. /**
  133977. * This helps specifying the falloff radius off the reflection texture from the sceneCenter.
  133978. * This helps adding a nice falloff effect to the reflection if used as a mirror for instance.
  133979. */
  133980. reflectionFalloffDistance: number;
  133981. protected _reflectionAmount: number;
  133982. /**
  133983. * This specifies the weight of the reflection against the background in case of reflection Fresnel.
  133984. */
  133985. reflectionAmount: number;
  133986. protected _reflectionReflectance0: number;
  133987. /**
  133988. * This specifies the weight of the reflection at grazing angle.
  133989. */
  133990. reflectionReflectance0: number;
  133991. protected _reflectionReflectance90: number;
  133992. /**
  133993. * This specifies the weight of the reflection at a perpendicular point of view.
  133994. */
  133995. reflectionReflectance90: number;
  133996. /**
  133997. * Sets the reflection reflectance fresnel values according to the default standard
  133998. * empirically know to work well :-)
  133999. */
  134000. set reflectionStandardFresnelWeight(value: number);
  134001. protected _useRGBColor: boolean;
  134002. /**
  134003. * Helps to directly use the maps channels instead of their level.
  134004. */
  134005. useRGBColor: boolean;
  134006. protected _enableNoise: boolean;
  134007. /**
  134008. * This helps reducing the banding effect that could occur on the background.
  134009. */
  134010. enableNoise: boolean;
  134011. /**
  134012. * The current fov(field of view) multiplier, 0.0 - 2.0. Defaults to 1.0. Lower values "zoom in" and higher values "zoom out".
  134013. * Best used when trying to implement visual zoom effects like fish-eye or binoculars while not adjusting camera fov.
  134014. * Recommended to be keep at 1.0 except for special cases.
  134015. */
  134016. get fovMultiplier(): number;
  134017. set fovMultiplier(value: number);
  134018. private _fovMultiplier;
  134019. /**
  134020. * Enable the FOV adjustment feature controlled by fovMultiplier.
  134021. */
  134022. useEquirectangularFOV: boolean;
  134023. private _maxSimultaneousLights;
  134024. /**
  134025. * Number of Simultaneous lights allowed on the material.
  134026. */
  134027. maxSimultaneousLights: int;
  134028. private _shadowOnly;
  134029. /**
  134030. * Make the material only render shadows
  134031. */
  134032. shadowOnly: boolean;
  134033. /**
  134034. * Default configuration related to image processing available in the Background Material.
  134035. */
  134036. protected _imageProcessingConfiguration: ImageProcessingConfiguration;
  134037. /**
  134038. * Keep track of the image processing observer to allow dispose and replace.
  134039. */
  134040. private _imageProcessingObserver;
  134041. /**
  134042. * Attaches a new image processing configuration to the PBR Material.
  134043. * @param configuration (if null the scene configuration will be use)
  134044. */
  134045. protected _attachImageProcessingConfiguration(configuration: Nullable<ImageProcessingConfiguration>): void;
  134046. /**
  134047. * Gets the image processing configuration used either in this material.
  134048. */
  134049. get imageProcessingConfiguration(): Nullable<ImageProcessingConfiguration>;
  134050. /**
  134051. * Sets the Default image processing configuration used either in the this material.
  134052. *
  134053. * If sets to null, the scene one is in use.
  134054. */
  134055. set imageProcessingConfiguration(value: Nullable<ImageProcessingConfiguration>);
  134056. /**
  134057. * Gets wether the color curves effect is enabled.
  134058. */
  134059. get cameraColorCurvesEnabled(): boolean;
  134060. /**
  134061. * Sets wether the color curves effect is enabled.
  134062. */
  134063. set cameraColorCurvesEnabled(value: boolean);
  134064. /**
  134065. * Gets wether the color grading effect is enabled.
  134066. */
  134067. get cameraColorGradingEnabled(): boolean;
  134068. /**
  134069. * Gets wether the color grading effect is enabled.
  134070. */
  134071. set cameraColorGradingEnabled(value: boolean);
  134072. /**
  134073. * Gets wether tonemapping is enabled or not.
  134074. */
  134075. get cameraToneMappingEnabled(): boolean;
  134076. /**
  134077. * Sets wether tonemapping is enabled or not
  134078. */
  134079. set cameraToneMappingEnabled(value: boolean);
  134080. /**
  134081. * The camera exposure used on this material.
  134082. * This property is here and not in the camera to allow controlling exposure without full screen post process.
  134083. * This corresponds to a photographic exposure.
  134084. */
  134085. get cameraExposure(): float;
  134086. /**
  134087. * The camera exposure used on this material.
  134088. * This property is here and not in the camera to allow controlling exposure without full screen post process.
  134089. * This corresponds to a photographic exposure.
  134090. */
  134091. set cameraExposure(value: float);
  134092. /**
  134093. * Gets The camera contrast used on this material.
  134094. */
  134095. get cameraContrast(): float;
  134096. /**
  134097. * Sets The camera contrast used on this material.
  134098. */
  134099. set cameraContrast(value: float);
  134100. /**
  134101. * Gets the Color Grading 2D Lookup Texture.
  134102. */
  134103. get cameraColorGradingTexture(): Nullable<BaseTexture>;
  134104. /**
  134105. * Sets the Color Grading 2D Lookup Texture.
  134106. */
  134107. set cameraColorGradingTexture(value: Nullable<BaseTexture>);
  134108. /**
  134109. * The color grading curves provide additional color adjustmnent that is applied after any color grading transform (3D LUT).
  134110. * They allow basic adjustment of saturation and small exposure adjustments, along with color filter tinting to provide white balance adjustment or more stylistic effects.
  134111. * 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;
  134112. * corresponding to low luminance, medium luminance, and high luminance areas respectively.
  134113. */
  134114. get cameraColorCurves(): Nullable<ColorCurves>;
  134115. /**
  134116. * The color grading curves provide additional color adjustmnent that is applied after any color grading transform (3D LUT).
  134117. * They allow basic adjustment of saturation and small exposure adjustments, along with color filter tinting to provide white balance adjustment or more stylistic effects.
  134118. * 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;
  134119. * corresponding to low luminance, medium luminance, and high luminance areas respectively.
  134120. */
  134121. set cameraColorCurves(value: Nullable<ColorCurves>);
  134122. /**
  134123. * Due to a bug in iOS10, video tags (which are using the background material) are in BGR and not RGB.
  134124. * Setting this flag to true (not done automatically!) will convert it back to RGB.
  134125. */
  134126. switchToBGR: boolean;
  134127. private _renderTargets;
  134128. private _reflectionControls;
  134129. private _white;
  134130. private _primaryShadowColor;
  134131. private _primaryHighlightColor;
  134132. /**
  134133. * Instantiates a Background Material in the given scene
  134134. * @param name The friendly name of the material
  134135. * @param scene The scene to add the material to
  134136. */
  134137. constructor(name: string, scene: Scene);
  134138. /**
  134139. * Gets a boolean indicating that current material needs to register RTT
  134140. */
  134141. get hasRenderTargetTextures(): boolean;
  134142. /**
  134143. * The entire material has been created in order to prevent overdraw.
  134144. * @returns false
  134145. */
  134146. needAlphaTesting(): boolean;
  134147. /**
  134148. * The entire material has been created in order to prevent overdraw.
  134149. * @returns true if blending is enable
  134150. */
  134151. needAlphaBlending(): boolean;
  134152. /**
  134153. * Checks wether the material is ready to be rendered for a given mesh.
  134154. * @param mesh The mesh to render
  134155. * @param subMesh The submesh to check against
  134156. * @param useInstances Specify wether or not the material is used with instances
  134157. * @returns true if all the dependencies are ready (Textures, Effects...)
  134158. */
  134159. isReadyForSubMesh(mesh: AbstractMesh, subMesh: SubMesh, useInstances?: boolean): boolean;
  134160. /**
  134161. * Compute the primary color according to the chosen perceptual color.
  134162. */
  134163. private _computePrimaryColorFromPerceptualColor;
  134164. /**
  134165. * Compute the highlights and shadow colors according to their chosen levels.
  134166. */
  134167. private _computePrimaryColors;
  134168. /**
  134169. * Build the uniform buffer used in the material.
  134170. */
  134171. buildUniformLayout(): void;
  134172. /**
  134173. * Unbind the material.
  134174. */
  134175. unbind(): void;
  134176. /**
  134177. * Bind only the world matrix to the material.
  134178. * @param world The world matrix to bind.
  134179. */
  134180. bindOnlyWorldMatrix(world: Matrix): void;
  134181. /**
  134182. * Bind the material for a dedicated submeh (every used meshes will be considered opaque).
  134183. * @param world The world matrix to bind.
  134184. * @param subMesh The submesh to bind for.
  134185. */
  134186. bindForSubMesh(world: Matrix, mesh: Mesh, subMesh: SubMesh): void;
  134187. /**
  134188. * Checks to see if a texture is used in the material.
  134189. * @param texture - Base texture to use.
  134190. * @returns - Boolean specifying if a texture is used in the material.
  134191. */
  134192. hasTexture(texture: BaseTexture): boolean;
  134193. /**
  134194. * Dispose the material.
  134195. * @param forceDisposeEffect Force disposal of the associated effect.
  134196. * @param forceDisposeTextures Force disposal of the associated textures.
  134197. */
  134198. dispose(forceDisposeEffect?: boolean, forceDisposeTextures?: boolean): void;
  134199. /**
  134200. * Clones the material.
  134201. * @param name The cloned name.
  134202. * @returns The cloned material.
  134203. */
  134204. clone(name: string): BackgroundMaterial;
  134205. /**
  134206. * Serializes the current material to its JSON representation.
  134207. * @returns The JSON representation.
  134208. */
  134209. serialize(): any;
  134210. /**
  134211. * Gets the class name of the material
  134212. * @returns "BackgroundMaterial"
  134213. */
  134214. getClassName(): string;
  134215. /**
  134216. * Parse a JSON input to create back a background material.
  134217. * @param source The JSON data to parse
  134218. * @param scene The scene to create the parsed material in
  134219. * @param rootUrl The root url of the assets the material depends upon
  134220. * @returns the instantiated BackgroundMaterial.
  134221. */
  134222. static Parse(source: any, scene: Scene, rootUrl: string): BackgroundMaterial;
  134223. }
  134224. }
  134225. declare module BABYLON {
  134226. /**
  134227. * Represents the different options available during the creation of
  134228. * a Environment helper.
  134229. *
  134230. * This can control the default ground, skybox and image processing setup of your scene.
  134231. */
  134232. export interface IEnvironmentHelperOptions {
  134233. /**
  134234. * Specifies whether or not to create a ground.
  134235. * True by default.
  134236. */
  134237. createGround: boolean;
  134238. /**
  134239. * Specifies the ground size.
  134240. * 15 by default.
  134241. */
  134242. groundSize: number;
  134243. /**
  134244. * The texture used on the ground for the main color.
  134245. * Comes from the BabylonJS CDN by default.
  134246. *
  134247. * Remarks: Can be either a texture or a url.
  134248. */
  134249. groundTexture: string | BaseTexture;
  134250. /**
  134251. * The color mixed in the ground texture by default.
  134252. * BabylonJS clearColor by default.
  134253. */
  134254. groundColor: Color3;
  134255. /**
  134256. * Specifies the ground opacity.
  134257. * 1 by default.
  134258. */
  134259. groundOpacity: number;
  134260. /**
  134261. * Enables the ground to receive shadows.
  134262. * True by default.
  134263. */
  134264. enableGroundShadow: boolean;
  134265. /**
  134266. * Helps preventing the shadow to be fully black on the ground.
  134267. * 0.5 by default.
  134268. */
  134269. groundShadowLevel: number;
  134270. /**
  134271. * Creates a mirror texture attach to the ground.
  134272. * false by default.
  134273. */
  134274. enableGroundMirror: boolean;
  134275. /**
  134276. * Specifies the ground mirror size ratio.
  134277. * 0.3 by default as the default kernel is 64.
  134278. */
  134279. groundMirrorSizeRatio: number;
  134280. /**
  134281. * Specifies the ground mirror blur kernel size.
  134282. * 64 by default.
  134283. */
  134284. groundMirrorBlurKernel: number;
  134285. /**
  134286. * Specifies the ground mirror visibility amount.
  134287. * 1 by default
  134288. */
  134289. groundMirrorAmount: number;
  134290. /**
  134291. * Specifies the ground mirror reflectance weight.
  134292. * This uses the standard weight of the background material to setup the fresnel effect
  134293. * of the mirror.
  134294. * 1 by default.
  134295. */
  134296. groundMirrorFresnelWeight: number;
  134297. /**
  134298. * Specifies the ground mirror Falloff distance.
  134299. * This can helps reducing the size of the reflection.
  134300. * 0 by Default.
  134301. */
  134302. groundMirrorFallOffDistance: number;
  134303. /**
  134304. * Specifies the ground mirror texture type.
  134305. * Unsigned Int by Default.
  134306. */
  134307. groundMirrorTextureType: number;
  134308. /**
  134309. * Specifies a bias applied to the ground vertical position to prevent z-fighting with
  134310. * the shown objects.
  134311. */
  134312. groundYBias: number;
  134313. /**
  134314. * Specifies whether or not to create a skybox.
  134315. * True by default.
  134316. */
  134317. createSkybox: boolean;
  134318. /**
  134319. * Specifies the skybox size.
  134320. * 20 by default.
  134321. */
  134322. skyboxSize: number;
  134323. /**
  134324. * The texture used on the skybox for the main color.
  134325. * Comes from the BabylonJS CDN by default.
  134326. *
  134327. * Remarks: Can be either a texture or a url.
  134328. */
  134329. skyboxTexture: string | BaseTexture;
  134330. /**
  134331. * The color mixed in the skybox texture by default.
  134332. * BabylonJS clearColor by default.
  134333. */
  134334. skyboxColor: Color3;
  134335. /**
  134336. * The background rotation around the Y axis of the scene.
  134337. * This helps aligning the key lights of your scene with the background.
  134338. * 0 by default.
  134339. */
  134340. backgroundYRotation: number;
  134341. /**
  134342. * Compute automatically the size of the elements to best fit with the scene.
  134343. */
  134344. sizeAuto: boolean;
  134345. /**
  134346. * Default position of the rootMesh if autoSize is not true.
  134347. */
  134348. rootPosition: Vector3;
  134349. /**
  134350. * Sets up the image processing in the scene.
  134351. * true by default.
  134352. */
  134353. setupImageProcessing: boolean;
  134354. /**
  134355. * The texture used as your environment texture in the scene.
  134356. * Comes from the BabylonJS CDN by default and in use if setupImageProcessing is true.
  134357. *
  134358. * Remarks: Can be either a texture or a url.
  134359. */
  134360. environmentTexture: string | BaseTexture;
  134361. /**
  134362. * The value of the exposure to apply to the scene.
  134363. * 0.6 by default if setupImageProcessing is true.
  134364. */
  134365. cameraExposure: number;
  134366. /**
  134367. * The value of the contrast to apply to the scene.
  134368. * 1.6 by default if setupImageProcessing is true.
  134369. */
  134370. cameraContrast: number;
  134371. /**
  134372. * Specifies whether or not tonemapping should be enabled in the scene.
  134373. * true by default if setupImageProcessing is true.
  134374. */
  134375. toneMappingEnabled: boolean;
  134376. }
  134377. /**
  134378. * The Environment helper class can be used to add a fully featuread none expensive background to your scene.
  134379. * It includes by default a skybox and a ground relying on the BackgroundMaterial.
  134380. * It also helps with the default setup of your imageProcessing configuration.
  134381. */
  134382. export class EnvironmentHelper {
  134383. /**
  134384. * Default ground texture URL.
  134385. */
  134386. private static _groundTextureCDNUrl;
  134387. /**
  134388. * Default skybox texture URL.
  134389. */
  134390. private static _skyboxTextureCDNUrl;
  134391. /**
  134392. * Default environment texture URL.
  134393. */
  134394. private static _environmentTextureCDNUrl;
  134395. /**
  134396. * Creates the default options for the helper.
  134397. */
  134398. private static _getDefaultOptions;
  134399. private _rootMesh;
  134400. /**
  134401. * Gets the root mesh created by the helper.
  134402. */
  134403. get rootMesh(): Mesh;
  134404. private _skybox;
  134405. /**
  134406. * Gets the skybox created by the helper.
  134407. */
  134408. get skybox(): Nullable<Mesh>;
  134409. private _skyboxTexture;
  134410. /**
  134411. * Gets the skybox texture created by the helper.
  134412. */
  134413. get skyboxTexture(): Nullable<BaseTexture>;
  134414. private _skyboxMaterial;
  134415. /**
  134416. * Gets the skybox material created by the helper.
  134417. */
  134418. get skyboxMaterial(): Nullable<BackgroundMaterial>;
  134419. private _ground;
  134420. /**
  134421. * Gets the ground mesh created by the helper.
  134422. */
  134423. get ground(): Nullable<Mesh>;
  134424. private _groundTexture;
  134425. /**
  134426. * Gets the ground texture created by the helper.
  134427. */
  134428. get groundTexture(): Nullable<BaseTexture>;
  134429. private _groundMirror;
  134430. /**
  134431. * Gets the ground mirror created by the helper.
  134432. */
  134433. get groundMirror(): Nullable<MirrorTexture>;
  134434. /**
  134435. * Gets the ground mirror render list to helps pushing the meshes
  134436. * you wish in the ground reflection.
  134437. */
  134438. get groundMirrorRenderList(): Nullable<AbstractMesh[]>;
  134439. private _groundMaterial;
  134440. /**
  134441. * Gets the ground material created by the helper.
  134442. */
  134443. get groundMaterial(): Nullable<BackgroundMaterial>;
  134444. /**
  134445. * Stores the creation options.
  134446. */
  134447. private readonly _scene;
  134448. private _options;
  134449. /**
  134450. * This observable will be notified with any error during the creation of the environment,
  134451. * mainly texture creation errors.
  134452. */
  134453. onErrorObservable: Observable<{
  134454. message?: string;
  134455. exception?: any;
  134456. }>;
  134457. /**
  134458. * constructor
  134459. * @param options Defines the options we want to customize the helper
  134460. * @param scene The scene to add the material to
  134461. */
  134462. constructor(options: Partial<IEnvironmentHelperOptions>, scene: Scene);
  134463. /**
  134464. * Updates the background according to the new options
  134465. * @param options
  134466. */
  134467. updateOptions(options: Partial<IEnvironmentHelperOptions>): void;
  134468. /**
  134469. * Sets the primary color of all the available elements.
  134470. * @param color the main color to affect to the ground and the background
  134471. */
  134472. setMainColor(color: Color3): void;
  134473. /**
  134474. * Setup the image processing according to the specified options.
  134475. */
  134476. private _setupImageProcessing;
  134477. /**
  134478. * Setup the environment texture according to the specified options.
  134479. */
  134480. private _setupEnvironmentTexture;
  134481. /**
  134482. * Setup the background according to the specified options.
  134483. */
  134484. private _setupBackground;
  134485. /**
  134486. * Get the scene sizes according to the setup.
  134487. */
  134488. private _getSceneSize;
  134489. /**
  134490. * Setup the ground according to the specified options.
  134491. */
  134492. private _setupGround;
  134493. /**
  134494. * Setup the ground material according to the specified options.
  134495. */
  134496. private _setupGroundMaterial;
  134497. /**
  134498. * Setup the ground diffuse texture according to the specified options.
  134499. */
  134500. private _setupGroundDiffuseTexture;
  134501. /**
  134502. * Setup the ground mirror texture according to the specified options.
  134503. */
  134504. private _setupGroundMirrorTexture;
  134505. /**
  134506. * Setup the ground to receive the mirror texture.
  134507. */
  134508. private _setupMirrorInGroundMaterial;
  134509. /**
  134510. * Setup the skybox according to the specified options.
  134511. */
  134512. private _setupSkybox;
  134513. /**
  134514. * Setup the skybox material according to the specified options.
  134515. */
  134516. private _setupSkyboxMaterial;
  134517. /**
  134518. * Setup the skybox reflection texture according to the specified options.
  134519. */
  134520. private _setupSkyboxReflectionTexture;
  134521. private _errorHandler;
  134522. /**
  134523. * Dispose all the elements created by the Helper.
  134524. */
  134525. dispose(): void;
  134526. }
  134527. }
  134528. declare module BABYLON {
  134529. /**
  134530. * Display a 360/180 degree texture on an approximately spherical surface, useful for VR applications or skyboxes.
  134531. * As a subclass of TransformNode, this allow parenting to the camera or multiple textures with different locations in the scene.
  134532. * This class achieves its effect with a Texture and a correctly configured BackgroundMaterial on an inverted sphere.
  134533. * Potential additions to this helper include zoom and and non-infinite distance rendering effects.
  134534. */
  134535. export abstract class TextureDome<T extends Texture> extends TransformNode {
  134536. protected onError: Nullable<(message?: string, exception?: any) => void>;
  134537. /**
  134538. * Define the source as a Monoscopic panoramic 360/180.
  134539. */
  134540. static readonly MODE_MONOSCOPIC: number;
  134541. /**
  134542. * Define the source as a Stereoscopic TopBottom/OverUnder panoramic 360/180.
  134543. */
  134544. static readonly MODE_TOPBOTTOM: number;
  134545. /**
  134546. * Define the source as a Stereoscopic Side by Side panoramic 360/180.
  134547. */
  134548. static readonly MODE_SIDEBYSIDE: number;
  134549. private _halfDome;
  134550. protected _useDirectMapping: boolean;
  134551. /**
  134552. * The texture being displayed on the sphere
  134553. */
  134554. protected _texture: T;
  134555. /**
  134556. * Gets the texture being displayed on the sphere
  134557. */
  134558. get texture(): T;
  134559. /**
  134560. * Sets the texture being displayed on the sphere
  134561. */
  134562. set texture(newTexture: T);
  134563. /**
  134564. * The skybox material
  134565. */
  134566. protected _material: BackgroundMaterial;
  134567. /**
  134568. * The surface used for the dome
  134569. */
  134570. protected _mesh: Mesh;
  134571. /**
  134572. * Gets the mesh used for the dome.
  134573. */
  134574. get mesh(): Mesh;
  134575. /**
  134576. * A mesh that will be used to mask the back of the dome in case it is a 180 degree movie.
  134577. */
  134578. private _halfDomeMask;
  134579. /**
  134580. * The current fov(field of view) multiplier, 0.0 - 2.0. Defaults to 1.0. Lower values "zoom in" and higher values "zoom out".
  134581. * Also see the options.resolution property.
  134582. */
  134583. get fovMultiplier(): number;
  134584. set fovMultiplier(value: number);
  134585. protected _textureMode: number;
  134586. /**
  134587. * Gets or set the current texture mode for the texture. It can be:
  134588. * * TextureDome.MODE_MONOSCOPIC : Define the texture source as a Monoscopic panoramic 360.
  134589. * * TextureDome.MODE_TOPBOTTOM : Define the texture source as a Stereoscopic TopBottom/OverUnder panoramic 360.
  134590. * * TextureDome.MODE_SIDEBYSIDE : Define the texture source as a Stereoscopic Side by Side panoramic 360.
  134591. */
  134592. get textureMode(): number;
  134593. /**
  134594. * Sets the current texture mode for the texture. It can be:
  134595. * * TextureDome.MODE_MONOSCOPIC : Define the texture source as a Monoscopic panoramic 360.
  134596. * * TextureDome.MODE_TOPBOTTOM : Define the texture source as a Stereoscopic TopBottom/OverUnder panoramic 360.
  134597. * * TextureDome.MODE_SIDEBYSIDE : Define the texture source as a Stereoscopic Side by Side panoramic 360.
  134598. */
  134599. set textureMode(value: number);
  134600. /**
  134601. * Is it a 180 degrees dome (half dome) or 360 texture (full dome)
  134602. */
  134603. get halfDome(): boolean;
  134604. /**
  134605. * Set the halfDome mode. If set, only the front (180 degrees) will be displayed and the back will be blacked out.
  134606. */
  134607. set halfDome(enabled: boolean);
  134608. /**
  134609. * Oberserver used in Stereoscopic VR Mode.
  134610. */
  134611. private _onBeforeCameraRenderObserver;
  134612. /**
  134613. * Observable raised when an error occured while loading the 360 image
  134614. */
  134615. onLoadErrorObservable: Observable<string>;
  134616. /**
  134617. * Create an instance of this class and pass through the parameters to the relevant classes- Texture, StandardMaterial, and Mesh.
  134618. * @param name Element's name, child elements will append suffixes for their own names.
  134619. * @param textureUrlOrElement defines the url(s) or the (video) HTML element to use
  134620. * @param options An object containing optional or exposed sub element properties
  134621. */
  134622. constructor(name: string, textureUrlOrElement: string | string[] | HTMLVideoElement, options: {
  134623. resolution?: number;
  134624. clickToPlay?: boolean;
  134625. autoPlay?: boolean;
  134626. loop?: boolean;
  134627. size?: number;
  134628. poster?: string;
  134629. faceForward?: boolean;
  134630. useDirectMapping?: boolean;
  134631. halfDomeMode?: boolean;
  134632. }, scene: Scene, onError?: Nullable<(message?: string, exception?: any) => void>);
  134633. protected abstract _initTexture(urlsOrElement: string | string[] | HTMLElement, scene: Scene, options: any): T;
  134634. protected _changeTextureMode(value: number): void;
  134635. /**
  134636. * Releases resources associated with this node.
  134637. * @param doNotRecurse Set to true to not recurse into each children (recurse into each children by default)
  134638. * @param disposeMaterialAndTextures Set to true to also dispose referenced materials and textures (false by default)
  134639. */
  134640. dispose(doNotRecurse?: boolean, disposeMaterialAndTextures?: boolean): void;
  134641. }
  134642. }
  134643. declare module BABYLON {
  134644. /**
  134645. * Display a 360 degree photo on an approximately spherical surface, useful for VR applications or skyboxes.
  134646. * As a subclass of TransformNode, this allow parenting to the camera with different locations in the scene.
  134647. * This class achieves its effect with a Texture and a correctly configured BackgroundMaterial on an inverted sphere.
  134648. * Potential additions to this helper include zoom and and non-infinite distance rendering effects.
  134649. */
  134650. export class PhotoDome extends TextureDome<Texture> {
  134651. /**
  134652. * Define the image as a Monoscopic panoramic 360 image.
  134653. */
  134654. static readonly MODE_MONOSCOPIC: number;
  134655. /**
  134656. * Define the image as a Stereoscopic TopBottom/OverUnder panoramic 360 image.
  134657. */
  134658. static readonly MODE_TOPBOTTOM: number;
  134659. /**
  134660. * Define the image as a Stereoscopic Side by Side panoramic 360 image.
  134661. */
  134662. static readonly MODE_SIDEBYSIDE: number;
  134663. /**
  134664. * Gets or sets the texture being displayed on the sphere
  134665. */
  134666. get photoTexture(): Texture;
  134667. /**
  134668. * sets the texture being displayed on the sphere
  134669. */
  134670. set photoTexture(value: Texture);
  134671. /**
  134672. * Gets the current video mode for the video. It can be:
  134673. * * TextureDome.MODE_MONOSCOPIC : Define the texture source as a Monoscopic panoramic 360.
  134674. * * TextureDome.MODE_TOPBOTTOM : Define the texture source as a Stereoscopic TopBottom/OverUnder panoramic 360.
  134675. * * TextureDome.MODE_SIDEBYSIDE : Define the texture source as a Stereoscopic Side by Side panoramic 360.
  134676. */
  134677. get imageMode(): number;
  134678. /**
  134679. * Sets the current video mode for the video. It can be:
  134680. * * TextureDome.MODE_MONOSCOPIC : Define the texture source as a Monoscopic panoramic 360.
  134681. * * TextureDome.MODE_TOPBOTTOM : Define the texture source as a Stereoscopic TopBottom/OverUnder panoramic 360.
  134682. * * TextureDome.MODE_SIDEBYSIDE : Define the texture source as a Stereoscopic Side by Side panoramic 360.
  134683. */
  134684. set imageMode(value: number);
  134685. protected _initTexture(urlsOrElement: string, scene: Scene, options: any): Texture;
  134686. }
  134687. }
  134688. declare module BABYLON {
  134689. /**
  134690. * Class used to host RGBD texture specific utilities
  134691. */
  134692. export class RGBDTextureTools {
  134693. /**
  134694. * Expand the RGBD Texture from RGBD to Half Float if possible.
  134695. * @param texture the texture to expand.
  134696. */
  134697. static ExpandRGBDTexture(texture: Texture): void;
  134698. }
  134699. }
  134700. declare module BABYLON {
  134701. /**
  134702. * Class used to host texture specific utilities
  134703. */
  134704. export class BRDFTextureTools {
  134705. /**
  134706. * Prevents texture cache collision
  134707. */
  134708. private static _instanceNumber;
  134709. /**
  134710. * Gets a default environment BRDF for MS-BRDF Height Correlated BRDF
  134711. * @param scene defines the hosting scene
  134712. * @returns the environment BRDF texture
  134713. */
  134714. static GetEnvironmentBRDFTexture(scene: Scene): BaseTexture;
  134715. private static _environmentBRDFBase64Texture;
  134716. }
  134717. }
  134718. declare module BABYLON {
  134719. /**
  134720. * @hidden
  134721. */
  134722. export interface IMaterialClearCoatDefines {
  134723. CLEARCOAT: boolean;
  134724. CLEARCOAT_DEFAULTIOR: boolean;
  134725. CLEARCOAT_TEXTURE: boolean;
  134726. CLEARCOAT_TEXTUREDIRECTUV: number;
  134727. CLEARCOAT_BUMP: boolean;
  134728. CLEARCOAT_BUMPDIRECTUV: number;
  134729. CLEARCOAT_TINT: boolean;
  134730. CLEARCOAT_TINT_TEXTURE: boolean;
  134731. CLEARCOAT_TINT_TEXTUREDIRECTUV: number;
  134732. /** @hidden */
  134733. _areTexturesDirty: boolean;
  134734. }
  134735. /**
  134736. * Define the code related to the clear coat parameters of the pbr material.
  134737. */
  134738. export class PBRClearCoatConfiguration {
  134739. /**
  134740. * This defaults to 1.5 corresponding to a 0.04 f0 or a 4% reflectance at normal incidence
  134741. * The default fits with a polyurethane material.
  134742. */
  134743. private static readonly _DefaultIndexOfRefraction;
  134744. private _isEnabled;
  134745. /**
  134746. * Defines if the clear coat is enabled in the material.
  134747. */
  134748. isEnabled: boolean;
  134749. /**
  134750. * Defines the clear coat layer strength (between 0 and 1) it defaults to 1.
  134751. */
  134752. intensity: number;
  134753. /**
  134754. * Defines the clear coat layer roughness.
  134755. */
  134756. roughness: number;
  134757. private _indexOfRefraction;
  134758. /**
  134759. * Defines the index of refraction of the clear coat.
  134760. * This defaults to 1.5 corresponding to a 0.04 f0 or a 4% reflectance at normal incidence
  134761. * The default fits with a polyurethane material.
  134762. * Changing the default value is more performance intensive.
  134763. */
  134764. indexOfRefraction: number;
  134765. private _texture;
  134766. /**
  134767. * Stores the clear coat values in a texture.
  134768. */
  134769. texture: Nullable<BaseTexture>;
  134770. private _bumpTexture;
  134771. /**
  134772. * Define the clear coat specific bump texture.
  134773. */
  134774. bumpTexture: Nullable<BaseTexture>;
  134775. private _isTintEnabled;
  134776. /**
  134777. * Defines if the clear coat tint is enabled in the material.
  134778. */
  134779. isTintEnabled: boolean;
  134780. /**
  134781. * Defines the clear coat tint of the material.
  134782. * This is only use if tint is enabled
  134783. */
  134784. tintColor: Color3;
  134785. /**
  134786. * Defines the distance at which the tint color should be found in the
  134787. * clear coat media.
  134788. * This is only use if tint is enabled
  134789. */
  134790. tintColorAtDistance: number;
  134791. /**
  134792. * Defines the clear coat layer thickness.
  134793. * This is only use if tint is enabled
  134794. */
  134795. tintThickness: number;
  134796. private _tintTexture;
  134797. /**
  134798. * Stores the clear tint values in a texture.
  134799. * rgb is tint
  134800. * a is a thickness factor
  134801. */
  134802. tintTexture: Nullable<BaseTexture>;
  134803. /** @hidden */
  134804. private _internalMarkAllSubMeshesAsTexturesDirty;
  134805. /** @hidden */
  134806. _markAllSubMeshesAsTexturesDirty(): void;
  134807. /**
  134808. * Instantiate a new istance of clear coat configuration.
  134809. * @param markAllSubMeshesAsTexturesDirty Callback to flag the material to dirty
  134810. */
  134811. constructor(markAllSubMeshesAsTexturesDirty: () => void);
  134812. /**
  134813. * Gets wehter the submesh is ready to be used or not.
  134814. * @param defines the list of "defines" to update.
  134815. * @param scene defines the scene the material belongs to.
  134816. * @param engine defines the engine the material belongs to.
  134817. * @param disableBumpMap defines wether the material disables bump or not.
  134818. * @returns - boolean indicating that the submesh is ready or not.
  134819. */
  134820. isReadyForSubMesh(defines: IMaterialClearCoatDefines, scene: Scene, engine: Engine, disableBumpMap: boolean): boolean;
  134821. /**
  134822. * Checks to see if a texture is used in the material.
  134823. * @param defines the list of "defines" to update.
  134824. * @param scene defines the scene to the material belongs to.
  134825. */
  134826. prepareDefines(defines: IMaterialClearCoatDefines, scene: Scene): void;
  134827. /**
  134828. * Binds the material data.
  134829. * @param uniformBuffer defines the Uniform buffer to fill in.
  134830. * @param scene defines the scene the material belongs to.
  134831. * @param engine defines the engine the material belongs to.
  134832. * @param disableBumpMap defines wether the material disables bump or not.
  134833. * @param isFrozen defines wether the material is frozen or not.
  134834. * @param invertNormalMapX If sets to true, x component of normal map value will be inverted (x = 1.0 - x).
  134835. * @param invertNormalMapY If sets to true, y component of normal map value will be inverted (y = 1.0 - y).
  134836. */
  134837. bindForSubMesh(uniformBuffer: UniformBuffer, scene: Scene, engine: Engine, disableBumpMap: boolean, isFrozen: boolean, invertNormalMapX: boolean, invertNormalMapY: boolean): void;
  134838. /**
  134839. * Checks to see if a texture is used in the material.
  134840. * @param texture - Base texture to use.
  134841. * @returns - Boolean specifying if a texture is used in the material.
  134842. */
  134843. hasTexture(texture: BaseTexture): boolean;
  134844. /**
  134845. * Returns an array of the actively used textures.
  134846. * @param activeTextures Array of BaseTextures
  134847. */
  134848. getActiveTextures(activeTextures: BaseTexture[]): void;
  134849. /**
  134850. * Returns the animatable textures.
  134851. * @param animatables Array of animatable textures.
  134852. */
  134853. getAnimatables(animatables: IAnimatable[]): void;
  134854. /**
  134855. * Disposes the resources of the material.
  134856. * @param forceDisposeTextures - Forces the disposal of all textures.
  134857. */
  134858. dispose(forceDisposeTextures?: boolean): void;
  134859. /**
  134860. * Get the current class name of the texture useful for serialization or dynamic coding.
  134861. * @returns "PBRClearCoatConfiguration"
  134862. */
  134863. getClassName(): string;
  134864. /**
  134865. * Add fallbacks to the effect fallbacks list.
  134866. * @param defines defines the Base texture to use.
  134867. * @param fallbacks defines the current fallback list.
  134868. * @param currentRank defines the current fallback rank.
  134869. * @returns the new fallback rank.
  134870. */
  134871. static AddFallbacks(defines: IMaterialClearCoatDefines, fallbacks: EffectFallbacks, currentRank: number): number;
  134872. /**
  134873. * Add the required uniforms to the current list.
  134874. * @param uniforms defines the current uniform list.
  134875. */
  134876. static AddUniforms(uniforms: string[]): void;
  134877. /**
  134878. * Add the required samplers to the current list.
  134879. * @param samplers defines the current sampler list.
  134880. */
  134881. static AddSamplers(samplers: string[]): void;
  134882. /**
  134883. * Add the required uniforms to the current buffer.
  134884. * @param uniformBuffer defines the current uniform buffer.
  134885. */
  134886. static PrepareUniformBuffer(uniformBuffer: UniformBuffer): void;
  134887. /**
  134888. * Makes a duplicate of the current configuration into another one.
  134889. * @param clearCoatConfiguration define the config where to copy the info
  134890. */
  134891. copyTo(clearCoatConfiguration: PBRClearCoatConfiguration): void;
  134892. /**
  134893. * Serializes this clear coat configuration.
  134894. * @returns - An object with the serialized config.
  134895. */
  134896. serialize(): any;
  134897. /**
  134898. * Parses a anisotropy Configuration from a serialized object.
  134899. * @param source - Serialized object.
  134900. * @param scene Defines the scene we are parsing for
  134901. * @param rootUrl Defines the rootUrl to load from
  134902. */
  134903. parse(source: any, scene: Scene, rootUrl: string): void;
  134904. }
  134905. }
  134906. declare module BABYLON {
  134907. /**
  134908. * @hidden
  134909. */
  134910. export interface IMaterialAnisotropicDefines {
  134911. ANISOTROPIC: boolean;
  134912. ANISOTROPIC_TEXTURE: boolean;
  134913. ANISOTROPIC_TEXTUREDIRECTUV: number;
  134914. MAINUV1: boolean;
  134915. _areTexturesDirty: boolean;
  134916. _needUVs: boolean;
  134917. }
  134918. /**
  134919. * Define the code related to the anisotropic parameters of the pbr material.
  134920. */
  134921. export class PBRAnisotropicConfiguration {
  134922. private _isEnabled;
  134923. /**
  134924. * Defines if the anisotropy is enabled in the material.
  134925. */
  134926. isEnabled: boolean;
  134927. /**
  134928. * Defines the anisotropy strength (between 0 and 1) it defaults to 1.
  134929. */
  134930. intensity: number;
  134931. /**
  134932. * Defines if the effect is along the tangents, bitangents or in between.
  134933. * By default, the effect is "strectching" the highlights along the tangents.
  134934. */
  134935. direction: Vector2;
  134936. private _texture;
  134937. /**
  134938. * Stores the anisotropy values in a texture.
  134939. * rg is direction (like normal from -1 to 1)
  134940. * b is a intensity
  134941. */
  134942. texture: Nullable<BaseTexture>;
  134943. /** @hidden */
  134944. private _internalMarkAllSubMeshesAsTexturesDirty;
  134945. /** @hidden */
  134946. _markAllSubMeshesAsTexturesDirty(): void;
  134947. /**
  134948. * Instantiate a new istance of anisotropy configuration.
  134949. * @param markAllSubMeshesAsTexturesDirty Callback to flag the material to dirty
  134950. */
  134951. constructor(markAllSubMeshesAsTexturesDirty: () => void);
  134952. /**
  134953. * Specifies that the submesh is ready to be used.
  134954. * @param defines the list of "defines" to update.
  134955. * @param scene defines the scene the material belongs to.
  134956. * @returns - boolean indicating that the submesh is ready or not.
  134957. */
  134958. isReadyForSubMesh(defines: IMaterialAnisotropicDefines, scene: Scene): boolean;
  134959. /**
  134960. * Checks to see if a texture is used in the material.
  134961. * @param defines the list of "defines" to update.
  134962. * @param mesh the mesh we are preparing the defines for.
  134963. * @param scene defines the scene the material belongs to.
  134964. */
  134965. prepareDefines(defines: IMaterialAnisotropicDefines, mesh: AbstractMesh, scene: Scene): void;
  134966. /**
  134967. * Binds the material data.
  134968. * @param uniformBuffer defines the Uniform buffer to fill in.
  134969. * @param scene defines the scene the material belongs to.
  134970. * @param isFrozen defines wether the material is frozen or not.
  134971. */
  134972. bindForSubMesh(uniformBuffer: UniformBuffer, scene: Scene, isFrozen: boolean): void;
  134973. /**
  134974. * Checks to see if a texture is used in the material.
  134975. * @param texture - Base texture to use.
  134976. * @returns - Boolean specifying if a texture is used in the material.
  134977. */
  134978. hasTexture(texture: BaseTexture): boolean;
  134979. /**
  134980. * Returns an array of the actively used textures.
  134981. * @param activeTextures Array of BaseTextures
  134982. */
  134983. getActiveTextures(activeTextures: BaseTexture[]): void;
  134984. /**
  134985. * Returns the animatable textures.
  134986. * @param animatables Array of animatable textures.
  134987. */
  134988. getAnimatables(animatables: IAnimatable[]): void;
  134989. /**
  134990. * Disposes the resources of the material.
  134991. * @param forceDisposeTextures - Forces the disposal of all textures.
  134992. */
  134993. dispose(forceDisposeTextures?: boolean): void;
  134994. /**
  134995. * Get the current class name of the texture useful for serialization or dynamic coding.
  134996. * @returns "PBRAnisotropicConfiguration"
  134997. */
  134998. getClassName(): string;
  134999. /**
  135000. * Add fallbacks to the effect fallbacks list.
  135001. * @param defines defines the Base texture to use.
  135002. * @param fallbacks defines the current fallback list.
  135003. * @param currentRank defines the current fallback rank.
  135004. * @returns the new fallback rank.
  135005. */
  135006. static AddFallbacks(defines: IMaterialAnisotropicDefines, fallbacks: EffectFallbacks, currentRank: number): number;
  135007. /**
  135008. * Add the required uniforms to the current list.
  135009. * @param uniforms defines the current uniform list.
  135010. */
  135011. static AddUniforms(uniforms: string[]): void;
  135012. /**
  135013. * Add the required uniforms to the current buffer.
  135014. * @param uniformBuffer defines the current uniform buffer.
  135015. */
  135016. static PrepareUniformBuffer(uniformBuffer: UniformBuffer): void;
  135017. /**
  135018. * Add the required samplers to the current list.
  135019. * @param samplers defines the current sampler list.
  135020. */
  135021. static AddSamplers(samplers: string[]): void;
  135022. /**
  135023. * Makes a duplicate of the current configuration into another one.
  135024. * @param anisotropicConfiguration define the config where to copy the info
  135025. */
  135026. copyTo(anisotropicConfiguration: PBRAnisotropicConfiguration): void;
  135027. /**
  135028. * Serializes this anisotropy configuration.
  135029. * @returns - An object with the serialized config.
  135030. */
  135031. serialize(): any;
  135032. /**
  135033. * Parses a anisotropy Configuration from a serialized object.
  135034. * @param source - Serialized object.
  135035. * @param scene Defines the scene we are parsing for
  135036. * @param rootUrl Defines the rootUrl to load from
  135037. */
  135038. parse(source: any, scene: Scene, rootUrl: string): void;
  135039. }
  135040. }
  135041. declare module BABYLON {
  135042. /**
  135043. * @hidden
  135044. */
  135045. export interface IMaterialBRDFDefines {
  135046. BRDF_V_HEIGHT_CORRELATED: boolean;
  135047. MS_BRDF_ENERGY_CONSERVATION: boolean;
  135048. SPHERICAL_HARMONICS: boolean;
  135049. SPECULAR_GLOSSINESS_ENERGY_CONSERVATION: boolean;
  135050. /** @hidden */
  135051. _areMiscDirty: boolean;
  135052. }
  135053. /**
  135054. * Define the code related to the BRDF parameters of the pbr material.
  135055. */
  135056. export class PBRBRDFConfiguration {
  135057. /**
  135058. * Default value used for the energy conservation.
  135059. * This should only be changed to adapt to the type of texture in scene.environmentBRDFTexture.
  135060. */
  135061. static DEFAULT_USE_ENERGY_CONSERVATION: boolean;
  135062. /**
  135063. * Default value used for the Smith Visibility Height Correlated mode.
  135064. * This should only be changed to adapt to the type of texture in scene.environmentBRDFTexture.
  135065. */
  135066. static DEFAULT_USE_SMITH_VISIBILITY_HEIGHT_CORRELATED: boolean;
  135067. /**
  135068. * Default value used for the IBL diffuse part.
  135069. * This can help switching back to the polynomials mode globally which is a tiny bit
  135070. * less GPU intensive at the drawback of a lower quality.
  135071. */
  135072. static DEFAULT_USE_SPHERICAL_HARMONICS: boolean;
  135073. /**
  135074. * Default value used for activating energy conservation for the specular workflow.
  135075. * If activated, the albedo color is multiplied with (1. - maxChannel(specular color)).
  135076. * If deactivated, a material is only physically plausible, when (albedo color + specular color) < 1.
  135077. */
  135078. static DEFAULT_USE_SPECULAR_GLOSSINESS_INPUT_ENERGY_CONSERVATION: boolean;
  135079. private _useEnergyConservation;
  135080. /**
  135081. * Defines if the material uses energy conservation.
  135082. */
  135083. useEnergyConservation: boolean;
  135084. private _useSmithVisibilityHeightCorrelated;
  135085. /**
  135086. * LEGACY Mode set to false
  135087. * Defines if the material uses height smith correlated visibility term.
  135088. * If you intent to not use our default BRDF, you need to load a separate BRDF Texture for the PBR
  135089. * You can either load https://assets.babylonjs.com/environments/uncorrelatedBRDF.png
  135090. * or https://assets.babylonjs.com/environments/uncorrelatedBRDF.dds to have more precision
  135091. * Not relying on height correlated will also disable energy conservation.
  135092. */
  135093. useSmithVisibilityHeightCorrelated: boolean;
  135094. private _useSphericalHarmonics;
  135095. /**
  135096. * LEGACY Mode set to false
  135097. * Defines if the material uses spherical harmonics vs spherical polynomials for the
  135098. * diffuse part of the IBL.
  135099. * The harmonics despite a tiny bigger cost has been proven to provide closer results
  135100. * to the ground truth.
  135101. */
  135102. useSphericalHarmonics: boolean;
  135103. private _useSpecularGlossinessInputEnergyConservation;
  135104. /**
  135105. * Defines if the material uses energy conservation, when the specular workflow is active.
  135106. * If activated, the albedo color is multiplied with (1. - maxChannel(specular color)).
  135107. * If deactivated, a material is only physically plausible, when (albedo color + specular color) < 1.
  135108. * In the deactivated case, the material author has to ensure energy conservation, for a physically plausible rendering.
  135109. */
  135110. useSpecularGlossinessInputEnergyConservation: boolean;
  135111. /** @hidden */
  135112. private _internalMarkAllSubMeshesAsMiscDirty;
  135113. /** @hidden */
  135114. _markAllSubMeshesAsMiscDirty(): void;
  135115. /**
  135116. * Instantiate a new istance of clear coat configuration.
  135117. * @param markAllSubMeshesAsMiscDirty Callback to flag the material to dirty
  135118. */
  135119. constructor(markAllSubMeshesAsMiscDirty: () => void);
  135120. /**
  135121. * Checks to see if a texture is used in the material.
  135122. * @param defines the list of "defines" to update.
  135123. */
  135124. prepareDefines(defines: IMaterialBRDFDefines): void;
  135125. /**
  135126. * Get the current class name of the texture useful for serialization or dynamic coding.
  135127. * @returns "PBRClearCoatConfiguration"
  135128. */
  135129. getClassName(): string;
  135130. /**
  135131. * Makes a duplicate of the current configuration into another one.
  135132. * @param brdfConfiguration define the config where to copy the info
  135133. */
  135134. copyTo(brdfConfiguration: PBRBRDFConfiguration): void;
  135135. /**
  135136. * Serializes this BRDF configuration.
  135137. * @returns - An object with the serialized config.
  135138. */
  135139. serialize(): any;
  135140. /**
  135141. * Parses a anisotropy Configuration from a serialized object.
  135142. * @param source - Serialized object.
  135143. * @param scene Defines the scene we are parsing for
  135144. * @param rootUrl Defines the rootUrl to load from
  135145. */
  135146. parse(source: any, scene: Scene, rootUrl: string): void;
  135147. }
  135148. }
  135149. declare module BABYLON {
  135150. /**
  135151. * @hidden
  135152. */
  135153. export interface IMaterialSheenDefines {
  135154. SHEEN: boolean;
  135155. SHEEN_TEXTURE: boolean;
  135156. SHEEN_TEXTUREDIRECTUV: number;
  135157. SHEEN_LINKWITHALBEDO: boolean;
  135158. SHEEN_ROUGHNESS: boolean;
  135159. SHEEN_ALBEDOSCALING: boolean;
  135160. /** @hidden */
  135161. _areTexturesDirty: boolean;
  135162. }
  135163. /**
  135164. * Define the code related to the Sheen parameters of the pbr material.
  135165. */
  135166. export class PBRSheenConfiguration {
  135167. private _isEnabled;
  135168. /**
  135169. * Defines if the material uses sheen.
  135170. */
  135171. isEnabled: boolean;
  135172. private _linkSheenWithAlbedo;
  135173. /**
  135174. * Defines if the sheen is linked to the sheen color.
  135175. */
  135176. linkSheenWithAlbedo: boolean;
  135177. /**
  135178. * Defines the sheen intensity.
  135179. */
  135180. intensity: number;
  135181. /**
  135182. * Defines the sheen color.
  135183. */
  135184. color: Color3;
  135185. private _texture;
  135186. /**
  135187. * Stores the sheen tint values in a texture.
  135188. * rgb is tint
  135189. * a is a intensity or roughness if roughness has been defined
  135190. */
  135191. texture: Nullable<BaseTexture>;
  135192. private _roughness;
  135193. /**
  135194. * Defines the sheen roughness.
  135195. * It is not taken into account if linkSheenWithAlbedo is true.
  135196. * To stay backward compatible, material roughness is used instead if sheen roughness = null
  135197. */
  135198. roughness: Nullable<number>;
  135199. private _albedoScaling;
  135200. /**
  135201. * If true, the sheen effect is layered above the base BRDF with the albedo-scaling technique.
  135202. * It allows the strength of the sheen effect to not depend on the base color of the material,
  135203. * making it easier to setup and tweak the effect
  135204. */
  135205. albedoScaling: boolean;
  135206. /** @hidden */
  135207. private _internalMarkAllSubMeshesAsTexturesDirty;
  135208. /** @hidden */
  135209. _markAllSubMeshesAsTexturesDirty(): void;
  135210. /**
  135211. * Instantiate a new istance of clear coat configuration.
  135212. * @param markAllSubMeshesAsTexturesDirty Callback to flag the material to dirty
  135213. */
  135214. constructor(markAllSubMeshesAsTexturesDirty: () => void);
  135215. /**
  135216. * Specifies that the submesh is ready to be used.
  135217. * @param defines the list of "defines" to update.
  135218. * @param scene defines the scene the material belongs to.
  135219. * @returns - boolean indicating that the submesh is ready or not.
  135220. */
  135221. isReadyForSubMesh(defines: IMaterialSheenDefines, scene: Scene): boolean;
  135222. /**
  135223. * Checks to see if a texture is used in the material.
  135224. * @param defines the list of "defines" to update.
  135225. * @param scene defines the scene the material belongs to.
  135226. */
  135227. prepareDefines(defines: IMaterialSheenDefines, scene: Scene): void;
  135228. /**
  135229. * Binds the material data.
  135230. * @param uniformBuffer defines the Uniform buffer to fill in.
  135231. * @param scene defines the scene the material belongs to.
  135232. * @param isFrozen defines wether the material is frozen or not.
  135233. */
  135234. bindForSubMesh(uniformBuffer: UniformBuffer, scene: Scene, isFrozen: boolean): void;
  135235. /**
  135236. * Checks to see if a texture is used in the material.
  135237. * @param texture - Base texture to use.
  135238. * @returns - Boolean specifying if a texture is used in the material.
  135239. */
  135240. hasTexture(texture: BaseTexture): boolean;
  135241. /**
  135242. * Returns an array of the actively used textures.
  135243. * @param activeTextures Array of BaseTextures
  135244. */
  135245. getActiveTextures(activeTextures: BaseTexture[]): void;
  135246. /**
  135247. * Returns the animatable textures.
  135248. * @param animatables Array of animatable textures.
  135249. */
  135250. getAnimatables(animatables: IAnimatable[]): void;
  135251. /**
  135252. * Disposes the resources of the material.
  135253. * @param forceDisposeTextures - Forces the disposal of all textures.
  135254. */
  135255. dispose(forceDisposeTextures?: boolean): void;
  135256. /**
  135257. * Get the current class name of the texture useful for serialization or dynamic coding.
  135258. * @returns "PBRSheenConfiguration"
  135259. */
  135260. getClassName(): string;
  135261. /**
  135262. * Add fallbacks to the effect fallbacks list.
  135263. * @param defines defines the Base texture to use.
  135264. * @param fallbacks defines the current fallback list.
  135265. * @param currentRank defines the current fallback rank.
  135266. * @returns the new fallback rank.
  135267. */
  135268. static AddFallbacks(defines: IMaterialSheenDefines, fallbacks: EffectFallbacks, currentRank: number): number;
  135269. /**
  135270. * Add the required uniforms to the current list.
  135271. * @param uniforms defines the current uniform list.
  135272. */
  135273. static AddUniforms(uniforms: string[]): void;
  135274. /**
  135275. * Add the required uniforms to the current buffer.
  135276. * @param uniformBuffer defines the current uniform buffer.
  135277. */
  135278. static PrepareUniformBuffer(uniformBuffer: UniformBuffer): void;
  135279. /**
  135280. * Add the required samplers to the current list.
  135281. * @param samplers defines the current sampler list.
  135282. */
  135283. static AddSamplers(samplers: string[]): void;
  135284. /**
  135285. * Makes a duplicate of the current configuration into another one.
  135286. * @param sheenConfiguration define the config where to copy the info
  135287. */
  135288. copyTo(sheenConfiguration: PBRSheenConfiguration): void;
  135289. /**
  135290. * Serializes this BRDF configuration.
  135291. * @returns - An object with the serialized config.
  135292. */
  135293. serialize(): any;
  135294. /**
  135295. * Parses a anisotropy Configuration from a serialized object.
  135296. * @param source - Serialized object.
  135297. * @param scene Defines the scene we are parsing for
  135298. * @param rootUrl Defines the rootUrl to load from
  135299. */
  135300. parse(source: any, scene: Scene, rootUrl: string): void;
  135301. }
  135302. }
  135303. declare module BABYLON {
  135304. /**
  135305. * @hidden
  135306. */
  135307. export interface IMaterialSubSurfaceDefines {
  135308. SUBSURFACE: boolean;
  135309. SS_REFRACTION: boolean;
  135310. SS_TRANSLUCENCY: boolean;
  135311. SS_SCATTERING: boolean;
  135312. SS_THICKNESSANDMASK_TEXTURE: boolean;
  135313. SS_THICKNESSANDMASK_TEXTUREDIRECTUV: number;
  135314. SS_REFRACTIONMAP_3D: boolean;
  135315. SS_REFRACTIONMAP_OPPOSITEZ: boolean;
  135316. SS_LODINREFRACTIONALPHA: boolean;
  135317. SS_GAMMAREFRACTION: boolean;
  135318. SS_RGBDREFRACTION: boolean;
  135319. SS_LINEARSPECULARREFRACTION: boolean;
  135320. SS_LINKREFRACTIONTOTRANSPARENCY: boolean;
  135321. SS_ALBEDOFORREFRACTIONTINT: boolean;
  135322. SS_MASK_FROM_THICKNESS_TEXTURE: boolean;
  135323. /** @hidden */
  135324. _areTexturesDirty: boolean;
  135325. }
  135326. /**
  135327. * Define the code related to the sub surface parameters of the pbr material.
  135328. */
  135329. export class PBRSubSurfaceConfiguration {
  135330. private _isRefractionEnabled;
  135331. /**
  135332. * Defines if the refraction is enabled in the material.
  135333. */
  135334. isRefractionEnabled: boolean;
  135335. private _isTranslucencyEnabled;
  135336. /**
  135337. * Defines if the translucency is enabled in the material.
  135338. */
  135339. isTranslucencyEnabled: boolean;
  135340. private _isScatteringEnabled;
  135341. /**
  135342. * Defines if the sub surface scattering is enabled in the material.
  135343. */
  135344. isScatteringEnabled: boolean;
  135345. private _scatteringDiffusionProfileIndex;
  135346. /**
  135347. * Diffusion profile for subsurface scattering.
  135348. * Useful for better scattering in the skins or foliages.
  135349. */
  135350. get scatteringDiffusionProfile(): Nullable<Color3>;
  135351. set scatteringDiffusionProfile(c: Nullable<Color3>);
  135352. /**
  135353. * Defines the refraction intensity of the material.
  135354. * The refraction when enabled replaces the Diffuse part of the material.
  135355. * The intensity helps transitionning between diffuse and refraction.
  135356. */
  135357. refractionIntensity: number;
  135358. /**
  135359. * Defines the translucency intensity of the material.
  135360. * When translucency has been enabled, this defines how much of the "translucency"
  135361. * is addded to the diffuse part of the material.
  135362. */
  135363. translucencyIntensity: number;
  135364. /**
  135365. * When enabled, transparent surfaces will be tinted with the albedo colour (independent of thickness)
  135366. */
  135367. useAlbedoToTintRefraction: boolean;
  135368. private _thicknessTexture;
  135369. /**
  135370. * Stores the average thickness of a mesh in a texture (The texture is holding the values linearly).
  135371. * The red channel of the texture should contain the thickness remapped between 0 and 1.
  135372. * 0 would mean minimumThickness
  135373. * 1 would mean maximumThickness
  135374. * The other channels might be use as a mask to vary the different effects intensity.
  135375. */
  135376. thicknessTexture: Nullable<BaseTexture>;
  135377. private _refractionTexture;
  135378. /**
  135379. * Defines the texture to use for refraction.
  135380. */
  135381. refractionTexture: Nullable<BaseTexture>;
  135382. private _indexOfRefraction;
  135383. /**
  135384. * Index of refraction of the material base layer.
  135385. * https://en.wikipedia.org/wiki/List_of_refractive_indices
  135386. *
  135387. * This does not only impact refraction but also the Base F0 of Dielectric Materials.
  135388. *
  135389. * From dielectric fresnel rules: F0 = square((iorT - iorI) / (iorT + iorI))
  135390. */
  135391. indexOfRefraction: number;
  135392. private _volumeIndexOfRefraction;
  135393. /**
  135394. * Index of refraction of the material's volume.
  135395. * https://en.wikipedia.org/wiki/List_of_refractive_indices
  135396. *
  135397. * This ONLY impacts refraction. If not provided or given a non-valid value,
  135398. * the volume will use the same IOR as the surface.
  135399. */
  135400. get volumeIndexOfRefraction(): number;
  135401. set volumeIndexOfRefraction(value: number);
  135402. private _invertRefractionY;
  135403. /**
  135404. * Controls if refraction needs to be inverted on Y. This could be useful for procedural texture.
  135405. */
  135406. invertRefractionY: boolean;
  135407. private _linkRefractionWithTransparency;
  135408. /**
  135409. * This parameters will make the material used its opacity to control how much it is refracting aginst not.
  135410. * Materials half opaque for instance using refraction could benefit from this control.
  135411. */
  135412. linkRefractionWithTransparency: boolean;
  135413. /**
  135414. * Defines the minimum thickness stored in the thickness map.
  135415. * If no thickness map is defined, this value will be used to simulate thickness.
  135416. */
  135417. minimumThickness: number;
  135418. /**
  135419. * Defines the maximum thickness stored in the thickness map.
  135420. */
  135421. maximumThickness: number;
  135422. /**
  135423. * Defines the volume tint of the material.
  135424. * This is used for both translucency and scattering.
  135425. */
  135426. tintColor: Color3;
  135427. /**
  135428. * Defines the distance at which the tint color should be found in the media.
  135429. * This is used for refraction only.
  135430. */
  135431. tintColorAtDistance: number;
  135432. /**
  135433. * Defines how far each channel transmit through the media.
  135434. * It is defined as a color to simplify it selection.
  135435. */
  135436. diffusionDistance: Color3;
  135437. private _useMaskFromThicknessTexture;
  135438. /**
  135439. * Stores the intensity of the different subsurface effects in the thickness texture.
  135440. * * the green channel is the translucency intensity.
  135441. * * the blue channel is the scattering intensity.
  135442. * * the alpha channel is the refraction intensity.
  135443. */
  135444. useMaskFromThicknessTexture: boolean;
  135445. private _scene;
  135446. /** @hidden */
  135447. private _internalMarkAllSubMeshesAsTexturesDirty;
  135448. private _internalMarkScenePrePassDirty;
  135449. /** @hidden */
  135450. _markAllSubMeshesAsTexturesDirty(): void;
  135451. /** @hidden */
  135452. _markScenePrePassDirty(): void;
  135453. /**
  135454. * Instantiate a new istance of sub surface configuration.
  135455. * @param markAllSubMeshesAsTexturesDirty Callback to flag the material to dirty
  135456. * @param markScenePrePassDirty Callback to flag the scene as prepass dirty
  135457. * @param scene The scene
  135458. */
  135459. constructor(markAllSubMeshesAsTexturesDirty: () => void, markScenePrePassDirty: () => void, scene: Scene);
  135460. /**
  135461. * Gets wehter the submesh is ready to be used or not.
  135462. * @param defines the list of "defines" to update.
  135463. * @param scene defines the scene the material belongs to.
  135464. * @returns - boolean indicating that the submesh is ready or not.
  135465. */
  135466. isReadyForSubMesh(defines: IMaterialSubSurfaceDefines, scene: Scene): boolean;
  135467. /**
  135468. * Checks to see if a texture is used in the material.
  135469. * @param defines the list of "defines" to update.
  135470. * @param scene defines the scene to the material belongs to.
  135471. */
  135472. prepareDefines(defines: IMaterialSubSurfaceDefines, scene: Scene): void;
  135473. /**
  135474. * Binds the material data.
  135475. * @param uniformBuffer defines the Uniform buffer to fill in.
  135476. * @param scene defines the scene the material belongs to.
  135477. * @param engine defines the engine the material belongs to.
  135478. * @param isFrozen defines whether the material is frozen or not.
  135479. * @param lodBasedMicrosurface defines whether the material relies on lod based microsurface or not.
  135480. * @param realTimeFiltering defines whether the textures should be filtered on the fly.
  135481. */
  135482. bindForSubMesh(uniformBuffer: UniformBuffer, scene: Scene, engine: Engine, isFrozen: boolean, lodBasedMicrosurface: boolean, realTimeFiltering: boolean): void;
  135483. /**
  135484. * Unbinds the material from the mesh.
  135485. * @param activeEffect defines the effect that should be unbound from.
  135486. * @returns true if unbound, otherwise false
  135487. */
  135488. unbind(activeEffect: Effect): boolean;
  135489. /**
  135490. * Returns the texture used for refraction or null if none is used.
  135491. * @param scene defines the scene the material belongs to.
  135492. * @returns - Refraction texture if present. If no refraction texture and refraction
  135493. * is linked with transparency, returns environment texture. Otherwise, returns null.
  135494. */
  135495. private _getRefractionTexture;
  135496. /**
  135497. * Returns true if alpha blending should be disabled.
  135498. */
  135499. get disableAlphaBlending(): boolean;
  135500. /**
  135501. * Fills the list of render target textures.
  135502. * @param renderTargets the list of render targets to update
  135503. */
  135504. fillRenderTargetTextures(renderTargets: SmartArray<RenderTargetTexture>): void;
  135505. /**
  135506. * Checks to see if a texture is used in the material.
  135507. * @param texture - Base texture to use.
  135508. * @returns - Boolean specifying if a texture is used in the material.
  135509. */
  135510. hasTexture(texture: BaseTexture): boolean;
  135511. /**
  135512. * Gets a boolean indicating that current material needs to register RTT
  135513. * @returns true if this uses a render target otherwise false.
  135514. */
  135515. hasRenderTargetTextures(): boolean;
  135516. /**
  135517. * Returns an array of the actively used textures.
  135518. * @param activeTextures Array of BaseTextures
  135519. */
  135520. getActiveTextures(activeTextures: BaseTexture[]): void;
  135521. /**
  135522. * Returns the animatable textures.
  135523. * @param animatables Array of animatable textures.
  135524. */
  135525. getAnimatables(animatables: IAnimatable[]): void;
  135526. /**
  135527. * Disposes the resources of the material.
  135528. * @param forceDisposeTextures - Forces the disposal of all textures.
  135529. */
  135530. dispose(forceDisposeTextures?: boolean): void;
  135531. /**
  135532. * Get the current class name of the texture useful for serialization or dynamic coding.
  135533. * @returns "PBRSubSurfaceConfiguration"
  135534. */
  135535. getClassName(): string;
  135536. /**
  135537. * Add fallbacks to the effect fallbacks list.
  135538. * @param defines defines the Base texture to use.
  135539. * @param fallbacks defines the current fallback list.
  135540. * @param currentRank defines the current fallback rank.
  135541. * @returns the new fallback rank.
  135542. */
  135543. static AddFallbacks(defines: IMaterialSubSurfaceDefines, fallbacks: EffectFallbacks, currentRank: number): number;
  135544. /**
  135545. * Add the required uniforms to the current list.
  135546. * @param uniforms defines the current uniform list.
  135547. */
  135548. static AddUniforms(uniforms: string[]): void;
  135549. /**
  135550. * Add the required samplers to the current list.
  135551. * @param samplers defines the current sampler list.
  135552. */
  135553. static AddSamplers(samplers: string[]): void;
  135554. /**
  135555. * Add the required uniforms to the current buffer.
  135556. * @param uniformBuffer defines the current uniform buffer.
  135557. */
  135558. static PrepareUniformBuffer(uniformBuffer: UniformBuffer): void;
  135559. /**
  135560. * Makes a duplicate of the current configuration into another one.
  135561. * @param configuration define the config where to copy the info
  135562. */
  135563. copyTo(configuration: PBRSubSurfaceConfiguration): void;
  135564. /**
  135565. * Serializes this Sub Surface configuration.
  135566. * @returns - An object with the serialized config.
  135567. */
  135568. serialize(): any;
  135569. /**
  135570. * Parses a anisotropy Configuration from a serialized object.
  135571. * @param source - Serialized object.
  135572. * @param scene Defines the scene we are parsing for
  135573. * @param rootUrl Defines the rootUrl to load from
  135574. */
  135575. parse(source: any, scene: Scene, rootUrl: string): void;
  135576. }
  135577. }
  135578. declare module BABYLON {
  135579. /** @hidden */
  135580. export var pbrFragmentDeclaration: {
  135581. name: string;
  135582. shader: string;
  135583. };
  135584. }
  135585. declare module BABYLON {
  135586. /** @hidden */
  135587. export var pbrUboDeclaration: {
  135588. name: string;
  135589. shader: string;
  135590. };
  135591. }
  135592. declare module BABYLON {
  135593. /** @hidden */
  135594. export var pbrFragmentExtraDeclaration: {
  135595. name: string;
  135596. shader: string;
  135597. };
  135598. }
  135599. declare module BABYLON {
  135600. /** @hidden */
  135601. export var pbrFragmentSamplersDeclaration: {
  135602. name: string;
  135603. shader: string;
  135604. };
  135605. }
  135606. declare module BABYLON {
  135607. /** @hidden */
  135608. export var importanceSampling: {
  135609. name: string;
  135610. shader: string;
  135611. };
  135612. }
  135613. declare module BABYLON {
  135614. /** @hidden */
  135615. export var pbrHelperFunctions: {
  135616. name: string;
  135617. shader: string;
  135618. };
  135619. }
  135620. declare module BABYLON {
  135621. /** @hidden */
  135622. export var harmonicsFunctions: {
  135623. name: string;
  135624. shader: string;
  135625. };
  135626. }
  135627. declare module BABYLON {
  135628. /** @hidden */
  135629. export var pbrDirectLightingSetupFunctions: {
  135630. name: string;
  135631. shader: string;
  135632. };
  135633. }
  135634. declare module BABYLON {
  135635. /** @hidden */
  135636. export var pbrDirectLightingFalloffFunctions: {
  135637. name: string;
  135638. shader: string;
  135639. };
  135640. }
  135641. declare module BABYLON {
  135642. /** @hidden */
  135643. export var pbrBRDFFunctions: {
  135644. name: string;
  135645. shader: string;
  135646. };
  135647. }
  135648. declare module BABYLON {
  135649. /** @hidden */
  135650. export var hdrFilteringFunctions: {
  135651. name: string;
  135652. shader: string;
  135653. };
  135654. }
  135655. declare module BABYLON {
  135656. /** @hidden */
  135657. export var pbrDirectLightingFunctions: {
  135658. name: string;
  135659. shader: string;
  135660. };
  135661. }
  135662. declare module BABYLON {
  135663. /** @hidden */
  135664. export var pbrIBLFunctions: {
  135665. name: string;
  135666. shader: string;
  135667. };
  135668. }
  135669. declare module BABYLON {
  135670. /** @hidden */
  135671. export var pbrBlockAlbedoOpacity: {
  135672. name: string;
  135673. shader: string;
  135674. };
  135675. }
  135676. declare module BABYLON {
  135677. /** @hidden */
  135678. export var pbrBlockReflectivity: {
  135679. name: string;
  135680. shader: string;
  135681. };
  135682. }
  135683. declare module BABYLON {
  135684. /** @hidden */
  135685. export var pbrBlockAmbientOcclusion: {
  135686. name: string;
  135687. shader: string;
  135688. };
  135689. }
  135690. declare module BABYLON {
  135691. /** @hidden */
  135692. export var pbrBlockAlphaFresnel: {
  135693. name: string;
  135694. shader: string;
  135695. };
  135696. }
  135697. declare module BABYLON {
  135698. /** @hidden */
  135699. export var pbrBlockAnisotropic: {
  135700. name: string;
  135701. shader: string;
  135702. };
  135703. }
  135704. declare module BABYLON {
  135705. /** @hidden */
  135706. export var pbrBlockReflection: {
  135707. name: string;
  135708. shader: string;
  135709. };
  135710. }
  135711. declare module BABYLON {
  135712. /** @hidden */
  135713. export var pbrBlockSheen: {
  135714. name: string;
  135715. shader: string;
  135716. };
  135717. }
  135718. declare module BABYLON {
  135719. /** @hidden */
  135720. export var pbrBlockClearcoat: {
  135721. name: string;
  135722. shader: string;
  135723. };
  135724. }
  135725. declare module BABYLON {
  135726. /** @hidden */
  135727. export var pbrBlockSubSurface: {
  135728. name: string;
  135729. shader: string;
  135730. };
  135731. }
  135732. declare module BABYLON {
  135733. /** @hidden */
  135734. export var pbrBlockNormalGeometric: {
  135735. name: string;
  135736. shader: string;
  135737. };
  135738. }
  135739. declare module BABYLON {
  135740. /** @hidden */
  135741. export var pbrBlockNormalFinal: {
  135742. name: string;
  135743. shader: string;
  135744. };
  135745. }
  135746. declare module BABYLON {
  135747. /** @hidden */
  135748. export var pbrBlockLightmapInit: {
  135749. name: string;
  135750. shader: string;
  135751. };
  135752. }
  135753. declare module BABYLON {
  135754. /** @hidden */
  135755. export var pbrBlockGeometryInfo: {
  135756. name: string;
  135757. shader: string;
  135758. };
  135759. }
  135760. declare module BABYLON {
  135761. /** @hidden */
  135762. export var pbrBlockReflectance0: {
  135763. name: string;
  135764. shader: string;
  135765. };
  135766. }
  135767. declare module BABYLON {
  135768. /** @hidden */
  135769. export var pbrBlockReflectance: {
  135770. name: string;
  135771. shader: string;
  135772. };
  135773. }
  135774. declare module BABYLON {
  135775. /** @hidden */
  135776. export var pbrBlockDirectLighting: {
  135777. name: string;
  135778. shader: string;
  135779. };
  135780. }
  135781. declare module BABYLON {
  135782. /** @hidden */
  135783. export var pbrBlockFinalLitComponents: {
  135784. name: string;
  135785. shader: string;
  135786. };
  135787. }
  135788. declare module BABYLON {
  135789. /** @hidden */
  135790. export var pbrBlockFinalUnlitComponents: {
  135791. name: string;
  135792. shader: string;
  135793. };
  135794. }
  135795. declare module BABYLON {
  135796. /** @hidden */
  135797. export var pbrBlockFinalColorComposition: {
  135798. name: string;
  135799. shader: string;
  135800. };
  135801. }
  135802. declare module BABYLON {
  135803. /** @hidden */
  135804. export var pbrBlockImageProcessing: {
  135805. name: string;
  135806. shader: string;
  135807. };
  135808. }
  135809. declare module BABYLON {
  135810. /** @hidden */
  135811. export var pbrDebug: {
  135812. name: string;
  135813. shader: string;
  135814. };
  135815. }
  135816. declare module BABYLON {
  135817. /** @hidden */
  135818. export var pbrPixelShader: {
  135819. name: string;
  135820. shader: string;
  135821. };
  135822. }
  135823. declare module BABYLON {
  135824. /** @hidden */
  135825. export var pbrVertexDeclaration: {
  135826. name: string;
  135827. shader: string;
  135828. };
  135829. }
  135830. declare module BABYLON {
  135831. /** @hidden */
  135832. export var pbrVertexShader: {
  135833. name: string;
  135834. shader: string;
  135835. };
  135836. }
  135837. declare module BABYLON {
  135838. /**
  135839. * Manages the defines for the PBR Material.
  135840. * @hidden
  135841. */
  135842. export class PBRMaterialDefines extends MaterialDefines implements IImageProcessingConfigurationDefines, IMaterialClearCoatDefines, IMaterialAnisotropicDefines, IMaterialBRDFDefines, IMaterialSheenDefines, IMaterialSubSurfaceDefines, IMaterialDetailMapDefines {
  135843. PBR: boolean;
  135844. NUM_SAMPLES: string;
  135845. REALTIME_FILTERING: boolean;
  135846. MAINUV1: boolean;
  135847. MAINUV2: boolean;
  135848. UV1: boolean;
  135849. UV2: boolean;
  135850. ALBEDO: boolean;
  135851. GAMMAALBEDO: boolean;
  135852. ALBEDODIRECTUV: number;
  135853. VERTEXCOLOR: boolean;
  135854. DETAIL: boolean;
  135855. DETAILDIRECTUV: number;
  135856. DETAIL_NORMALBLENDMETHOD: number;
  135857. AMBIENT: boolean;
  135858. AMBIENTDIRECTUV: number;
  135859. AMBIENTINGRAYSCALE: boolean;
  135860. OPACITY: boolean;
  135861. VERTEXALPHA: boolean;
  135862. OPACITYDIRECTUV: number;
  135863. OPACITYRGB: boolean;
  135864. ALPHATEST: boolean;
  135865. DEPTHPREPASS: boolean;
  135866. ALPHABLEND: boolean;
  135867. ALPHAFROMALBEDO: boolean;
  135868. ALPHATESTVALUE: string;
  135869. SPECULAROVERALPHA: boolean;
  135870. RADIANCEOVERALPHA: boolean;
  135871. ALPHAFRESNEL: boolean;
  135872. LINEARALPHAFRESNEL: boolean;
  135873. PREMULTIPLYALPHA: boolean;
  135874. EMISSIVE: boolean;
  135875. EMISSIVEDIRECTUV: number;
  135876. REFLECTIVITY: boolean;
  135877. REFLECTIVITYDIRECTUV: number;
  135878. SPECULARTERM: boolean;
  135879. MICROSURFACEFROMREFLECTIVITYMAP: boolean;
  135880. MICROSURFACEAUTOMATIC: boolean;
  135881. LODBASEDMICROSFURACE: boolean;
  135882. MICROSURFACEMAP: boolean;
  135883. MICROSURFACEMAPDIRECTUV: number;
  135884. METALLICWORKFLOW: boolean;
  135885. ROUGHNESSSTOREINMETALMAPALPHA: boolean;
  135886. ROUGHNESSSTOREINMETALMAPGREEN: boolean;
  135887. METALLNESSSTOREINMETALMAPBLUE: boolean;
  135888. AOSTOREINMETALMAPRED: boolean;
  135889. METALLIC_REFLECTANCE: boolean;
  135890. METALLIC_REFLECTANCEDIRECTUV: number;
  135891. ENVIRONMENTBRDF: boolean;
  135892. ENVIRONMENTBRDF_RGBD: boolean;
  135893. NORMAL: boolean;
  135894. TANGENT: boolean;
  135895. BUMP: boolean;
  135896. BUMPDIRECTUV: number;
  135897. OBJECTSPACE_NORMALMAP: boolean;
  135898. PARALLAX: boolean;
  135899. PARALLAXOCCLUSION: boolean;
  135900. NORMALXYSCALE: boolean;
  135901. LIGHTMAP: boolean;
  135902. LIGHTMAPDIRECTUV: number;
  135903. USELIGHTMAPASSHADOWMAP: boolean;
  135904. GAMMALIGHTMAP: boolean;
  135905. RGBDLIGHTMAP: boolean;
  135906. REFLECTION: boolean;
  135907. REFLECTIONMAP_3D: boolean;
  135908. REFLECTIONMAP_SPHERICAL: boolean;
  135909. REFLECTIONMAP_PLANAR: boolean;
  135910. REFLECTIONMAP_CUBIC: boolean;
  135911. USE_LOCAL_REFLECTIONMAP_CUBIC: boolean;
  135912. REFLECTIONMAP_PROJECTION: boolean;
  135913. REFLECTIONMAP_SKYBOX: boolean;
  135914. REFLECTIONMAP_EXPLICIT: boolean;
  135915. REFLECTIONMAP_EQUIRECTANGULAR: boolean;
  135916. REFLECTIONMAP_EQUIRECTANGULAR_FIXED: boolean;
  135917. REFLECTIONMAP_MIRROREDEQUIRECTANGULAR_FIXED: boolean;
  135918. INVERTCUBICMAP: boolean;
  135919. USESPHERICALFROMREFLECTIONMAP: boolean;
  135920. USEIRRADIANCEMAP: boolean;
  135921. SPHERICAL_HARMONICS: boolean;
  135922. USESPHERICALINVERTEX: boolean;
  135923. REFLECTIONMAP_OPPOSITEZ: boolean;
  135924. LODINREFLECTIONALPHA: boolean;
  135925. GAMMAREFLECTION: boolean;
  135926. RGBDREFLECTION: boolean;
  135927. LINEARSPECULARREFLECTION: boolean;
  135928. RADIANCEOCCLUSION: boolean;
  135929. HORIZONOCCLUSION: boolean;
  135930. INSTANCES: boolean;
  135931. THIN_INSTANCES: boolean;
  135932. PREPASS: boolean;
  135933. SCENE_MRT_COUNT: number;
  135934. NUM_BONE_INFLUENCERS: number;
  135935. BonesPerMesh: number;
  135936. BONETEXTURE: boolean;
  135937. NONUNIFORMSCALING: boolean;
  135938. MORPHTARGETS: boolean;
  135939. MORPHTARGETS_NORMAL: boolean;
  135940. MORPHTARGETS_TANGENT: boolean;
  135941. MORPHTARGETS_UV: boolean;
  135942. NUM_MORPH_INFLUENCERS: number;
  135943. IMAGEPROCESSING: boolean;
  135944. VIGNETTE: boolean;
  135945. VIGNETTEBLENDMODEMULTIPLY: boolean;
  135946. VIGNETTEBLENDMODEOPAQUE: boolean;
  135947. TONEMAPPING: boolean;
  135948. TONEMAPPING_ACES: boolean;
  135949. CONTRAST: boolean;
  135950. COLORCURVES: boolean;
  135951. COLORGRADING: boolean;
  135952. COLORGRADING3D: boolean;
  135953. SAMPLER3DGREENDEPTH: boolean;
  135954. SAMPLER3DBGRMAP: boolean;
  135955. IMAGEPROCESSINGPOSTPROCESS: boolean;
  135956. EXPOSURE: boolean;
  135957. MULTIVIEW: boolean;
  135958. USEPHYSICALLIGHTFALLOFF: boolean;
  135959. USEGLTFLIGHTFALLOFF: boolean;
  135960. TWOSIDEDLIGHTING: boolean;
  135961. SHADOWFLOAT: boolean;
  135962. CLIPPLANE: boolean;
  135963. CLIPPLANE2: boolean;
  135964. CLIPPLANE3: boolean;
  135965. CLIPPLANE4: boolean;
  135966. CLIPPLANE5: boolean;
  135967. CLIPPLANE6: boolean;
  135968. POINTSIZE: boolean;
  135969. FOG: boolean;
  135970. LOGARITHMICDEPTH: boolean;
  135971. FORCENORMALFORWARD: boolean;
  135972. SPECULARAA: boolean;
  135973. CLEARCOAT: boolean;
  135974. CLEARCOAT_DEFAULTIOR: boolean;
  135975. CLEARCOAT_TEXTURE: boolean;
  135976. CLEARCOAT_TEXTUREDIRECTUV: number;
  135977. CLEARCOAT_BUMP: boolean;
  135978. CLEARCOAT_BUMPDIRECTUV: number;
  135979. CLEARCOAT_TINT: boolean;
  135980. CLEARCOAT_TINT_TEXTURE: boolean;
  135981. CLEARCOAT_TINT_TEXTUREDIRECTUV: number;
  135982. ANISOTROPIC: boolean;
  135983. ANISOTROPIC_TEXTURE: boolean;
  135984. ANISOTROPIC_TEXTUREDIRECTUV: number;
  135985. BRDF_V_HEIGHT_CORRELATED: boolean;
  135986. MS_BRDF_ENERGY_CONSERVATION: boolean;
  135987. SPECULAR_GLOSSINESS_ENERGY_CONSERVATION: boolean;
  135988. SHEEN: boolean;
  135989. SHEEN_TEXTURE: boolean;
  135990. SHEEN_TEXTUREDIRECTUV: number;
  135991. SHEEN_LINKWITHALBEDO: boolean;
  135992. SHEEN_ROUGHNESS: boolean;
  135993. SHEEN_ALBEDOSCALING: boolean;
  135994. SUBSURFACE: boolean;
  135995. SS_REFRACTION: boolean;
  135996. SS_TRANSLUCENCY: boolean;
  135997. SS_SCATTERING: boolean;
  135998. SS_THICKNESSANDMASK_TEXTURE: boolean;
  135999. SS_THICKNESSANDMASK_TEXTUREDIRECTUV: number;
  136000. SS_REFRACTIONMAP_3D: boolean;
  136001. SS_REFRACTIONMAP_OPPOSITEZ: boolean;
  136002. SS_LODINREFRACTIONALPHA: boolean;
  136003. SS_GAMMAREFRACTION: boolean;
  136004. SS_RGBDREFRACTION: boolean;
  136005. SS_LINEARSPECULARREFRACTION: boolean;
  136006. SS_LINKREFRACTIONTOTRANSPARENCY: boolean;
  136007. SS_ALBEDOFORREFRACTIONTINT: boolean;
  136008. SS_MASK_FROM_THICKNESS_TEXTURE: boolean;
  136009. UNLIT: boolean;
  136010. DEBUGMODE: number;
  136011. /**
  136012. * Initializes the PBR Material defines.
  136013. */
  136014. constructor();
  136015. /**
  136016. * Resets the PBR Material defines.
  136017. */
  136018. reset(): void;
  136019. }
  136020. /**
  136021. * The Physically based material base class of BJS.
  136022. *
  136023. * This offers the main features of a standard PBR material.
  136024. * For more information, please refer to the documentation :
  136025. * https://doc.babylonjs.com/how_to/physically_based_rendering
  136026. */
  136027. export abstract class PBRBaseMaterial extends PushMaterial {
  136028. /**
  136029. * PBRMaterialTransparencyMode: No transparency mode, Alpha channel is not use.
  136030. */
  136031. static readonly PBRMATERIAL_OPAQUE: number;
  136032. /**
  136033. * PBRMaterialTransparencyMode: Alpha Test mode, pixel are discarded below a certain threshold defined by the alpha cutoff value.
  136034. */
  136035. static readonly PBRMATERIAL_ALPHATEST: number;
  136036. /**
  136037. * PBRMaterialTransparencyMode: Pixels are blended (according to the alpha mode) with the already drawn pixels in the current frame buffer.
  136038. */
  136039. static readonly PBRMATERIAL_ALPHABLEND: number;
  136040. /**
  136041. * PBRMaterialTransparencyMode: Pixels are blended (according to the alpha mode) with the already drawn pixels in the current frame buffer.
  136042. * They are also discarded below the alpha cutoff threshold to improve performances.
  136043. */
  136044. static readonly PBRMATERIAL_ALPHATESTANDBLEND: number;
  136045. /**
  136046. * Defines the default value of how much AO map is occluding the analytical lights
  136047. * (point spot...).
  136048. */
  136049. static DEFAULT_AO_ON_ANALYTICAL_LIGHTS: number;
  136050. /**
  136051. * PBRMaterialLightFalloff Physical: light is falling off following the inverse squared distance law.
  136052. */
  136053. static readonly LIGHTFALLOFF_PHYSICAL: number;
  136054. /**
  136055. * PBRMaterialLightFalloff gltf: light is falling off as described in the gltf moving to PBR document
  136056. * to enhance interoperability with other engines.
  136057. */
  136058. static readonly LIGHTFALLOFF_GLTF: number;
  136059. /**
  136060. * PBRMaterialLightFalloff Standard: light is falling off like in the standard material
  136061. * to enhance interoperability with other materials.
  136062. */
  136063. static readonly LIGHTFALLOFF_STANDARD: number;
  136064. /**
  136065. * Intensity of the direct lights e.g. the four lights available in your scene.
  136066. * This impacts both the direct diffuse and specular highlights.
  136067. */
  136068. protected _directIntensity: number;
  136069. /**
  136070. * Intensity of the emissive part of the material.
  136071. * This helps controlling the emissive effect without modifying the emissive color.
  136072. */
  136073. protected _emissiveIntensity: number;
  136074. /**
  136075. * Intensity of the environment e.g. how much the environment will light the object
  136076. * either through harmonics for rough material or through the refelction for shiny ones.
  136077. */
  136078. protected _environmentIntensity: number;
  136079. /**
  136080. * This is a special control allowing the reduction of the specular highlights coming from the
  136081. * four lights of the scene. Those highlights may not be needed in full environment lighting.
  136082. */
  136083. protected _specularIntensity: number;
  136084. /**
  136085. * This stores the direct, emissive, environment, and specular light intensities into a Vector4.
  136086. */
  136087. private _lightingInfos;
  136088. /**
  136089. * Debug Control allowing disabling the bump map on this material.
  136090. */
  136091. protected _disableBumpMap: boolean;
  136092. /**
  136093. * AKA Diffuse Texture in standard nomenclature.
  136094. */
  136095. protected _albedoTexture: Nullable<BaseTexture>;
  136096. /**
  136097. * AKA Occlusion Texture in other nomenclature.
  136098. */
  136099. protected _ambientTexture: Nullable<BaseTexture>;
  136100. /**
  136101. * AKA Occlusion Texture Intensity in other nomenclature.
  136102. */
  136103. protected _ambientTextureStrength: number;
  136104. /**
  136105. * Defines how much the AO map is occluding the analytical lights (point spot...).
  136106. * 1 means it completely occludes it
  136107. * 0 mean it has no impact
  136108. */
  136109. protected _ambientTextureImpactOnAnalyticalLights: number;
  136110. /**
  136111. * Stores the alpha values in a texture.
  136112. */
  136113. protected _opacityTexture: Nullable<BaseTexture>;
  136114. /**
  136115. * Stores the reflection values in a texture.
  136116. */
  136117. protected _reflectionTexture: Nullable<BaseTexture>;
  136118. /**
  136119. * Stores the emissive values in a texture.
  136120. */
  136121. protected _emissiveTexture: Nullable<BaseTexture>;
  136122. /**
  136123. * AKA Specular texture in other nomenclature.
  136124. */
  136125. protected _reflectivityTexture: Nullable<BaseTexture>;
  136126. /**
  136127. * Used to switch from specular/glossiness to metallic/roughness workflow.
  136128. */
  136129. protected _metallicTexture: Nullable<BaseTexture>;
  136130. /**
  136131. * Specifies the metallic scalar of the metallic/roughness workflow.
  136132. * Can also be used to scale the metalness values of the metallic texture.
  136133. */
  136134. protected _metallic: Nullable<number>;
  136135. /**
  136136. * Specifies the roughness scalar of the metallic/roughness workflow.
  136137. * Can also be used to scale the roughness values of the metallic texture.
  136138. */
  136139. protected _roughness: Nullable<number>;
  136140. /**
  136141. * In metallic workflow, specifies an F0 factor to help configuring the material F0.
  136142. * By default the indexOfrefraction is used to compute F0;
  136143. *
  136144. * This is used as a factor against the default reflectance at normal incidence to tweak it.
  136145. *
  136146. * F0 = defaultF0 * metallicF0Factor * metallicReflectanceColor;
  136147. * F90 = metallicReflectanceColor;
  136148. */
  136149. protected _metallicF0Factor: number;
  136150. /**
  136151. * In metallic workflow, specifies an F90 color to help configuring the material F90.
  136152. * By default the F90 is always 1;
  136153. *
  136154. * Please note that this factor is also used as a factor against the default reflectance at normal incidence.
  136155. *
  136156. * F0 = defaultF0 * metallicF0Factor * metallicReflectanceColor
  136157. * F90 = metallicReflectanceColor;
  136158. */
  136159. protected _metallicReflectanceColor: Color3;
  136160. /**
  136161. * Defines to store metallicReflectanceColor in RGB and metallicF0Factor in A
  136162. * This is multiply against the scalar values defined in the material.
  136163. */
  136164. protected _metallicReflectanceTexture: Nullable<BaseTexture>;
  136165. /**
  136166. * Used to enable roughness/glossiness fetch from a separate channel depending on the current mode.
  136167. * Gray Scale represents roughness in metallic mode and glossiness in specular mode.
  136168. */
  136169. protected _microSurfaceTexture: Nullable<BaseTexture>;
  136170. /**
  136171. * Stores surface normal data used to displace a mesh in a texture.
  136172. */
  136173. protected _bumpTexture: Nullable<BaseTexture>;
  136174. /**
  136175. * Stores the pre-calculated light information of a mesh in a texture.
  136176. */
  136177. protected _lightmapTexture: Nullable<BaseTexture>;
  136178. /**
  136179. * The color of a material in ambient lighting.
  136180. */
  136181. protected _ambientColor: Color3;
  136182. /**
  136183. * AKA Diffuse Color in other nomenclature.
  136184. */
  136185. protected _albedoColor: Color3;
  136186. /**
  136187. * AKA Specular Color in other nomenclature.
  136188. */
  136189. protected _reflectivityColor: Color3;
  136190. /**
  136191. * The color applied when light is reflected from a material.
  136192. */
  136193. protected _reflectionColor: Color3;
  136194. /**
  136195. * The color applied when light is emitted from a material.
  136196. */
  136197. protected _emissiveColor: Color3;
  136198. /**
  136199. * AKA Glossiness in other nomenclature.
  136200. */
  136201. protected _microSurface: number;
  136202. /**
  136203. * Specifies that the material will use the light map as a show map.
  136204. */
  136205. protected _useLightmapAsShadowmap: boolean;
  136206. /**
  136207. * This parameters will enable/disable Horizon occlusion to prevent normal maps to look shiny when the normal
  136208. * makes the reflect vector face the model (under horizon).
  136209. */
  136210. protected _useHorizonOcclusion: boolean;
  136211. /**
  136212. * This parameters will enable/disable radiance occlusion by preventing the radiance to lit
  136213. * too much the area relying on ambient texture to define their ambient occlusion.
  136214. */
  136215. protected _useRadianceOcclusion: boolean;
  136216. /**
  136217. * Specifies that the alpha is coming form the albedo channel alpha channel for alpha blending.
  136218. */
  136219. protected _useAlphaFromAlbedoTexture: boolean;
  136220. /**
  136221. * Specifies that the material will keeps the specular highlights over a transparent surface (only the most limunous ones).
  136222. * A car glass is a good exemple of that. When sun reflects on it you can not see what is behind.
  136223. */
  136224. protected _useSpecularOverAlpha: boolean;
  136225. /**
  136226. * Specifies if the reflectivity texture contains the glossiness information in its alpha channel.
  136227. */
  136228. protected _useMicroSurfaceFromReflectivityMapAlpha: boolean;
  136229. /**
  136230. * Specifies if the metallic texture contains the roughness information in its alpha channel.
  136231. */
  136232. protected _useRoughnessFromMetallicTextureAlpha: boolean;
  136233. /**
  136234. * Specifies if the metallic texture contains the roughness information in its green channel.
  136235. */
  136236. protected _useRoughnessFromMetallicTextureGreen: boolean;
  136237. /**
  136238. * Specifies if the metallic texture contains the metallness information in its blue channel.
  136239. */
  136240. protected _useMetallnessFromMetallicTextureBlue: boolean;
  136241. /**
  136242. * Specifies if the metallic texture contains the ambient occlusion information in its red channel.
  136243. */
  136244. protected _useAmbientOcclusionFromMetallicTextureRed: boolean;
  136245. /**
  136246. * Specifies if the ambient texture contains the ambient occlusion information in its red channel only.
  136247. */
  136248. protected _useAmbientInGrayScale: boolean;
  136249. /**
  136250. * In case the reflectivity map does not contain the microsurface information in its alpha channel,
  136251. * The material will try to infer what glossiness each pixel should be.
  136252. */
  136253. protected _useAutoMicroSurfaceFromReflectivityMap: boolean;
  136254. /**
  136255. * Defines the falloff type used in this material.
  136256. * It by default is Physical.
  136257. */
  136258. protected _lightFalloff: number;
  136259. /**
  136260. * Specifies that the material will keeps the reflection highlights over a transparent surface (only the most limunous ones).
  136261. * A car glass is a good exemple of that. When the street lights reflects on it you can not see what is behind.
  136262. */
  136263. protected _useRadianceOverAlpha: boolean;
  136264. /**
  136265. * Allows using an object space normal map (instead of tangent space).
  136266. */
  136267. protected _useObjectSpaceNormalMap: boolean;
  136268. /**
  136269. * Allows using the bump map in parallax mode.
  136270. */
  136271. protected _useParallax: boolean;
  136272. /**
  136273. * Allows using the bump map in parallax occlusion mode.
  136274. */
  136275. protected _useParallaxOcclusion: boolean;
  136276. /**
  136277. * Controls the scale bias of the parallax mode.
  136278. */
  136279. protected _parallaxScaleBias: number;
  136280. /**
  136281. * If sets to true, disables all the lights affecting the material.
  136282. */
  136283. protected _disableLighting: boolean;
  136284. /**
  136285. * Number of Simultaneous lights allowed on the material.
  136286. */
  136287. protected _maxSimultaneousLights: number;
  136288. /**
  136289. * If sets to true, x component of normal map value will be inverted (x = 1.0 - x).
  136290. */
  136291. protected _invertNormalMapX: boolean;
  136292. /**
  136293. * If sets to true, y component of normal map value will be inverted (y = 1.0 - y).
  136294. */
  136295. protected _invertNormalMapY: boolean;
  136296. /**
  136297. * If sets to true and backfaceCulling is false, normals will be flipped on the backside.
  136298. */
  136299. protected _twoSidedLighting: boolean;
  136300. /**
  136301. * Defines the alpha limits in alpha test mode.
  136302. */
  136303. protected _alphaCutOff: number;
  136304. /**
  136305. * Enforces alpha test in opaque or blend mode in order to improve the performances of some situations.
  136306. */
  136307. protected _forceAlphaTest: boolean;
  136308. /**
  136309. * A fresnel is applied to the alpha of the model to ensure grazing angles edges are not alpha tested.
  136310. * And/Or occlude the blended part. (alpha is converted to gamma to compute the fresnel)
  136311. */
  136312. protected _useAlphaFresnel: boolean;
  136313. /**
  136314. * A fresnel is applied to the alpha of the model to ensure grazing angles edges are not alpha tested.
  136315. * And/Or occlude the blended part. (alpha stays linear to compute the fresnel)
  136316. */
  136317. protected _useLinearAlphaFresnel: boolean;
  136318. /**
  136319. * Specifies the environment BRDF texture used to comput the scale and offset roughness values
  136320. * from cos thetav and roughness:
  136321. * http://blog.selfshadow.com/publications/s2013-shading-course/karis/s2013_pbs_epic_notes_v2.pdf
  136322. */
  136323. protected _environmentBRDFTexture: Nullable<BaseTexture>;
  136324. /**
  136325. * Force the shader to compute irradiance in the fragment shader in order to take bump in account.
  136326. */
  136327. protected _forceIrradianceInFragment: boolean;
  136328. private _realTimeFiltering;
  136329. /**
  136330. * Enables realtime filtering on the texture.
  136331. */
  136332. get realTimeFiltering(): boolean;
  136333. set realTimeFiltering(b: boolean);
  136334. private _realTimeFilteringQuality;
  136335. /**
  136336. * Quality switch for realtime filtering
  136337. */
  136338. get realTimeFilteringQuality(): number;
  136339. set realTimeFilteringQuality(n: number);
  136340. /**
  136341. * Can this material render to several textures at once
  136342. */
  136343. get canRenderToMRT(): boolean;
  136344. /**
  136345. * Force normal to face away from face.
  136346. */
  136347. protected _forceNormalForward: boolean;
  136348. /**
  136349. * Enables specular anti aliasing in the PBR shader.
  136350. * It will both interacts on the Geometry for analytical and IBL lighting.
  136351. * It also prefilter the roughness map based on the bump values.
  136352. */
  136353. protected _enableSpecularAntiAliasing: boolean;
  136354. /**
  136355. * Default configuration related to image processing available in the PBR Material.
  136356. */
  136357. protected _imageProcessingConfiguration: ImageProcessingConfiguration;
  136358. /**
  136359. * Keep track of the image processing observer to allow dispose and replace.
  136360. */
  136361. private _imageProcessingObserver;
  136362. /**
  136363. * Attaches a new image processing configuration to the PBR Material.
  136364. * @param configuration
  136365. */
  136366. protected _attachImageProcessingConfiguration(configuration: Nullable<ImageProcessingConfiguration>): void;
  136367. /**
  136368. * Stores the available render targets.
  136369. */
  136370. private _renderTargets;
  136371. /**
  136372. * Sets the global ambient color for the material used in lighting calculations.
  136373. */
  136374. private _globalAmbientColor;
  136375. /**
  136376. * Enables the use of logarithmic depth buffers, which is good for wide depth buffers.
  136377. */
  136378. private _useLogarithmicDepth;
  136379. /**
  136380. * If set to true, no lighting calculations will be applied.
  136381. */
  136382. private _unlit;
  136383. private _debugMode;
  136384. /**
  136385. * @hidden
  136386. * This is reserved for the inspector.
  136387. * Defines the material debug mode.
  136388. * It helps seeing only some components of the material while troubleshooting.
  136389. */
  136390. debugMode: number;
  136391. /**
  136392. * @hidden
  136393. * This is reserved for the inspector.
  136394. * Specify from where on screen the debug mode should start.
  136395. * The value goes from -1 (full screen) to 1 (not visible)
  136396. * It helps with side by side comparison against the final render
  136397. * This defaults to -1
  136398. */
  136399. private debugLimit;
  136400. /**
  136401. * @hidden
  136402. * This is reserved for the inspector.
  136403. * As the default viewing range might not be enough (if the ambient is really small for instance)
  136404. * You can use the factor to better multiply the final value.
  136405. */
  136406. private debugFactor;
  136407. /**
  136408. * Defines the clear coat layer parameters for the material.
  136409. */
  136410. readonly clearCoat: PBRClearCoatConfiguration;
  136411. /**
  136412. * Defines the anisotropic parameters for the material.
  136413. */
  136414. readonly anisotropy: PBRAnisotropicConfiguration;
  136415. /**
  136416. * Defines the BRDF parameters for the material.
  136417. */
  136418. readonly brdf: PBRBRDFConfiguration;
  136419. /**
  136420. * Defines the Sheen parameters for the material.
  136421. */
  136422. readonly sheen: PBRSheenConfiguration;
  136423. /**
  136424. * Defines the SubSurface parameters for the material.
  136425. */
  136426. readonly subSurface: PBRSubSurfaceConfiguration;
  136427. /**
  136428. * Defines the detail map parameters for the material.
  136429. */
  136430. readonly detailMap: DetailMapConfiguration;
  136431. protected _rebuildInParallel: boolean;
  136432. /**
  136433. * Instantiates a new PBRMaterial instance.
  136434. *
  136435. * @param name The material name
  136436. * @param scene The scene the material will be use in.
  136437. */
  136438. constructor(name: string, scene: Scene);
  136439. /**
  136440. * Gets a boolean indicating that current material needs to register RTT
  136441. */
  136442. get hasRenderTargetTextures(): boolean;
  136443. /**
  136444. * Gets the name of the material class.
  136445. */
  136446. getClassName(): string;
  136447. /**
  136448. * Enabled the use of logarithmic depth buffers, which is good for wide depth buffers.
  136449. */
  136450. get useLogarithmicDepth(): boolean;
  136451. /**
  136452. * Enabled the use of logarithmic depth buffers, which is good for wide depth buffers.
  136453. */
  136454. set useLogarithmicDepth(value: boolean);
  136455. /**
  136456. * Returns true if alpha blending should be disabled.
  136457. */
  136458. protected get _disableAlphaBlending(): boolean;
  136459. /**
  136460. * Specifies whether or not this material should be rendered in alpha blend mode.
  136461. */
  136462. needAlphaBlending(): boolean;
  136463. /**
  136464. * Specifies whether or not this material should be rendered in alpha test mode.
  136465. */
  136466. needAlphaTesting(): boolean;
  136467. /**
  136468. * Specifies whether or not the alpha value of the albedo texture should be used for alpha blending.
  136469. */
  136470. protected _shouldUseAlphaFromAlbedoTexture(): boolean;
  136471. /**
  136472. * Gets the texture used for the alpha test.
  136473. */
  136474. getAlphaTestTexture(): Nullable<BaseTexture>;
  136475. /**
  136476. * Specifies that the submesh is ready to be used.
  136477. * @param mesh - BJS mesh.
  136478. * @param subMesh - A submesh of the BJS mesh. Used to check if it is ready.
  136479. * @param useInstances - Specifies that instances should be used.
  136480. * @returns - boolean indicating that the submesh is ready or not.
  136481. */
  136482. isReadyForSubMesh(mesh: AbstractMesh, subMesh: SubMesh, useInstances?: boolean): boolean;
  136483. /**
  136484. * Specifies if the material uses metallic roughness workflow.
  136485. * @returns boolean specifiying if the material uses metallic roughness workflow.
  136486. */
  136487. isMetallicWorkflow(): boolean;
  136488. private _prepareEffect;
  136489. private _prepareDefines;
  136490. /**
  136491. * Force shader compilation
  136492. */
  136493. forceCompilation(mesh: AbstractMesh, onCompiled?: (material: Material) => void, options?: Partial<IMaterialCompilationOptions>): void;
  136494. /**
  136495. * Initializes the uniform buffer layout for the shader.
  136496. */
  136497. buildUniformLayout(): void;
  136498. /**
  136499. * Unbinds the material from the mesh
  136500. */
  136501. unbind(): void;
  136502. /**
  136503. * Binds the submesh data.
  136504. * @param world - The world matrix.
  136505. * @param mesh - The BJS mesh.
  136506. * @param subMesh - A submesh of the BJS mesh.
  136507. */
  136508. bindForSubMesh(world: Matrix, mesh: Mesh, subMesh: SubMesh): void;
  136509. /**
  136510. * Returns the animatable textures.
  136511. * @returns - Array of animatable textures.
  136512. */
  136513. getAnimatables(): IAnimatable[];
  136514. /**
  136515. * Returns the texture used for reflections.
  136516. * @returns - Reflection texture if present. Otherwise, returns the environment texture.
  136517. */
  136518. private _getReflectionTexture;
  136519. /**
  136520. * Returns an array of the actively used textures.
  136521. * @returns - Array of BaseTextures
  136522. */
  136523. getActiveTextures(): BaseTexture[];
  136524. /**
  136525. * Checks to see if a texture is used in the material.
  136526. * @param texture - Base texture to use.
  136527. * @returns - Boolean specifying if a texture is used in the material.
  136528. */
  136529. hasTexture(texture: BaseTexture): boolean;
  136530. /**
  136531. * Sets the required values to the prepass renderer.
  136532. * @param prePassRenderer defines the prepass renderer to setup
  136533. */
  136534. setPrePassRenderer(prePassRenderer: PrePassRenderer): boolean;
  136535. /**
  136536. * Disposes the resources of the material.
  136537. * @param forceDisposeEffect - Forces the disposal of effects.
  136538. * @param forceDisposeTextures - Forces the disposal of all textures.
  136539. */
  136540. dispose(forceDisposeEffect?: boolean, forceDisposeTextures?: boolean): void;
  136541. }
  136542. }
  136543. declare module BABYLON {
  136544. /**
  136545. * The Physically based material of BJS.
  136546. *
  136547. * This offers the main features of a standard PBR material.
  136548. * For more information, please refer to the documentation :
  136549. * https://doc.babylonjs.com/how_to/physically_based_rendering
  136550. */
  136551. export class PBRMaterial extends PBRBaseMaterial {
  136552. /**
  136553. * PBRMaterialTransparencyMode: No transparency mode, Alpha channel is not use.
  136554. */
  136555. static readonly PBRMATERIAL_OPAQUE: number;
  136556. /**
  136557. * PBRMaterialTransparencyMode: Alpha Test mode, pixel are discarded below a certain threshold defined by the alpha cutoff value.
  136558. */
  136559. static readonly PBRMATERIAL_ALPHATEST: number;
  136560. /**
  136561. * PBRMaterialTransparencyMode: Pixels are blended (according to the alpha mode) with the already drawn pixels in the current frame buffer.
  136562. */
  136563. static readonly PBRMATERIAL_ALPHABLEND: number;
  136564. /**
  136565. * PBRMaterialTransparencyMode: Pixels are blended (according to the alpha mode) with the already drawn pixels in the current frame buffer.
  136566. * They are also discarded below the alpha cutoff threshold to improve performances.
  136567. */
  136568. static readonly PBRMATERIAL_ALPHATESTANDBLEND: number;
  136569. /**
  136570. * Defines the default value of how much AO map is occluding the analytical lights
  136571. * (point spot...).
  136572. */
  136573. static DEFAULT_AO_ON_ANALYTICAL_LIGHTS: number;
  136574. /**
  136575. * Intensity of the direct lights e.g. the four lights available in your scene.
  136576. * This impacts both the direct diffuse and specular highlights.
  136577. */
  136578. directIntensity: number;
  136579. /**
  136580. * Intensity of the emissive part of the material.
  136581. * This helps controlling the emissive effect without modifying the emissive color.
  136582. */
  136583. emissiveIntensity: number;
  136584. /**
  136585. * Intensity of the environment e.g. how much the environment will light the object
  136586. * either through harmonics for rough material or through the refelction for shiny ones.
  136587. */
  136588. environmentIntensity: number;
  136589. /**
  136590. * This is a special control allowing the reduction of the specular highlights coming from the
  136591. * four lights of the scene. Those highlights may not be needed in full environment lighting.
  136592. */
  136593. specularIntensity: number;
  136594. /**
  136595. * Debug Control allowing disabling the bump map on this material.
  136596. */
  136597. disableBumpMap: boolean;
  136598. /**
  136599. * AKA Diffuse Texture in standard nomenclature.
  136600. */
  136601. albedoTexture: BaseTexture;
  136602. /**
  136603. * AKA Occlusion Texture in other nomenclature.
  136604. */
  136605. ambientTexture: BaseTexture;
  136606. /**
  136607. * AKA Occlusion Texture Intensity in other nomenclature.
  136608. */
  136609. ambientTextureStrength: number;
  136610. /**
  136611. * Defines how much the AO map is occluding the analytical lights (point spot...).
  136612. * 1 means it completely occludes it
  136613. * 0 mean it has no impact
  136614. */
  136615. ambientTextureImpactOnAnalyticalLights: number;
  136616. /**
  136617. * Stores the alpha values in a texture. Use luminance if texture.getAlphaFromRGB is true.
  136618. */
  136619. opacityTexture: BaseTexture;
  136620. /**
  136621. * Stores the reflection values in a texture.
  136622. */
  136623. reflectionTexture: Nullable<BaseTexture>;
  136624. /**
  136625. * Stores the emissive values in a texture.
  136626. */
  136627. emissiveTexture: BaseTexture;
  136628. /**
  136629. * AKA Specular texture in other nomenclature.
  136630. */
  136631. reflectivityTexture: BaseTexture;
  136632. /**
  136633. * Used to switch from specular/glossiness to metallic/roughness workflow.
  136634. */
  136635. metallicTexture: BaseTexture;
  136636. /**
  136637. * Specifies the metallic scalar of the metallic/roughness workflow.
  136638. * Can also be used to scale the metalness values of the metallic texture.
  136639. */
  136640. metallic: Nullable<number>;
  136641. /**
  136642. * Specifies the roughness scalar of the metallic/roughness workflow.
  136643. * Can also be used to scale the roughness values of the metallic texture.
  136644. */
  136645. roughness: Nullable<number>;
  136646. /**
  136647. * In metallic workflow, specifies an F0 factor to help configuring the material F0.
  136648. * By default the indexOfrefraction is used to compute F0;
  136649. *
  136650. * This is used as a factor against the default reflectance at normal incidence to tweak it.
  136651. *
  136652. * F0 = defaultF0 * metallicF0Factor * metallicReflectanceColor;
  136653. * F90 = metallicReflectanceColor;
  136654. */
  136655. metallicF0Factor: number;
  136656. /**
  136657. * In metallic workflow, specifies an F90 color to help configuring the material F90.
  136658. * By default the F90 is always 1;
  136659. *
  136660. * Please note that this factor is also used as a factor against the default reflectance at normal incidence.
  136661. *
  136662. * F0 = defaultF0 * metallicF0Factor * metallicReflectanceColor
  136663. * F90 = metallicReflectanceColor;
  136664. */
  136665. metallicReflectanceColor: Color3;
  136666. /**
  136667. * Defines to store metallicReflectanceColor in RGB and metallicF0Factor in A
  136668. * This is multiply against the scalar values defined in the material.
  136669. */
  136670. metallicReflectanceTexture: Nullable<BaseTexture>;
  136671. /**
  136672. * Used to enable roughness/glossiness fetch from a separate channel depending on the current mode.
  136673. * Gray Scale represents roughness in metallic mode and glossiness in specular mode.
  136674. */
  136675. microSurfaceTexture: BaseTexture;
  136676. /**
  136677. * Stores surface normal data used to displace a mesh in a texture.
  136678. */
  136679. bumpTexture: BaseTexture;
  136680. /**
  136681. * Stores the pre-calculated light information of a mesh in a texture.
  136682. */
  136683. lightmapTexture: BaseTexture;
  136684. /**
  136685. * Stores the refracted light information in a texture.
  136686. */
  136687. get refractionTexture(): Nullable<BaseTexture>;
  136688. set refractionTexture(value: Nullable<BaseTexture>);
  136689. /**
  136690. * The color of a material in ambient lighting.
  136691. */
  136692. ambientColor: Color3;
  136693. /**
  136694. * AKA Diffuse Color in other nomenclature.
  136695. */
  136696. albedoColor: Color3;
  136697. /**
  136698. * AKA Specular Color in other nomenclature.
  136699. */
  136700. reflectivityColor: Color3;
  136701. /**
  136702. * The color reflected from the material.
  136703. */
  136704. reflectionColor: Color3;
  136705. /**
  136706. * The color emitted from the material.
  136707. */
  136708. emissiveColor: Color3;
  136709. /**
  136710. * AKA Glossiness in other nomenclature.
  136711. */
  136712. microSurface: number;
  136713. /**
  136714. * Index of refraction of the material base layer.
  136715. * https://en.wikipedia.org/wiki/List_of_refractive_indices
  136716. *
  136717. * This does not only impact refraction but also the Base F0 of Dielectric Materials.
  136718. *
  136719. * From dielectric fresnel rules: F0 = square((iorT - iorI) / (iorT + iorI))
  136720. */
  136721. get indexOfRefraction(): number;
  136722. set indexOfRefraction(value: number);
  136723. /**
  136724. * Controls if refraction needs to be inverted on Y. This could be useful for procedural texture.
  136725. */
  136726. get invertRefractionY(): boolean;
  136727. set invertRefractionY(value: boolean);
  136728. /**
  136729. * This parameters will make the material used its opacity to control how much it is refracting aginst not.
  136730. * Materials half opaque for instance using refraction could benefit from this control.
  136731. */
  136732. get linkRefractionWithTransparency(): boolean;
  136733. set linkRefractionWithTransparency(value: boolean);
  136734. /**
  136735. * If true, the light map contains occlusion information instead of lighting info.
  136736. */
  136737. useLightmapAsShadowmap: boolean;
  136738. /**
  136739. * Specifies that the alpha is coming form the albedo channel alpha channel for alpha blending.
  136740. */
  136741. useAlphaFromAlbedoTexture: boolean;
  136742. /**
  136743. * Enforces alpha test in opaque or blend mode in order to improve the performances of some situations.
  136744. */
  136745. forceAlphaTest: boolean;
  136746. /**
  136747. * Defines the alpha limits in alpha test mode.
  136748. */
  136749. alphaCutOff: number;
  136750. /**
  136751. * Specifies that the material will keep the specular highlights over a transparent surface (only the most limunous ones).
  136752. * A car glass is a good exemple of that. When sun reflects on it you can not see what is behind.
  136753. */
  136754. useSpecularOverAlpha: boolean;
  136755. /**
  136756. * Specifies if the reflectivity texture contains the glossiness information in its alpha channel.
  136757. */
  136758. useMicroSurfaceFromReflectivityMapAlpha: boolean;
  136759. /**
  136760. * Specifies if the metallic texture contains the roughness information in its alpha channel.
  136761. */
  136762. useRoughnessFromMetallicTextureAlpha: boolean;
  136763. /**
  136764. * Specifies if the metallic texture contains the roughness information in its green channel.
  136765. */
  136766. useRoughnessFromMetallicTextureGreen: boolean;
  136767. /**
  136768. * Specifies if the metallic texture contains the metallness information in its blue channel.
  136769. */
  136770. useMetallnessFromMetallicTextureBlue: boolean;
  136771. /**
  136772. * Specifies if the metallic texture contains the ambient occlusion information in its red channel.
  136773. */
  136774. useAmbientOcclusionFromMetallicTextureRed: boolean;
  136775. /**
  136776. * Specifies if the ambient texture contains the ambient occlusion information in its red channel only.
  136777. */
  136778. useAmbientInGrayScale: boolean;
  136779. /**
  136780. * In case the reflectivity map does not contain the microsurface information in its alpha channel,
  136781. * The material will try to infer what glossiness each pixel should be.
  136782. */
  136783. useAutoMicroSurfaceFromReflectivityMap: boolean;
  136784. /**
  136785. * BJS is using an harcoded light falloff based on a manually sets up range.
  136786. * In PBR, one way to represents the fallof is to use the inverse squared root algorythm.
  136787. * This parameter can help you switch back to the BJS mode in order to create scenes using both materials.
  136788. */
  136789. get usePhysicalLightFalloff(): boolean;
  136790. /**
  136791. * BJS is using an harcoded light falloff based on a manually sets up range.
  136792. * In PBR, one way to represents the fallof is to use the inverse squared root algorythm.
  136793. * This parameter can help you switch back to the BJS mode in order to create scenes using both materials.
  136794. */
  136795. set usePhysicalLightFalloff(value: boolean);
  136796. /**
  136797. * In order to support the falloff compatibility with gltf, a special mode has been added
  136798. * to reproduce the gltf light falloff.
  136799. */
  136800. get useGLTFLightFalloff(): boolean;
  136801. /**
  136802. * In order to support the falloff compatibility with gltf, a special mode has been added
  136803. * to reproduce the gltf light falloff.
  136804. */
  136805. set useGLTFLightFalloff(value: boolean);
  136806. /**
  136807. * Specifies that the material will keeps the reflection highlights over a transparent surface (only the most limunous ones).
  136808. * A car glass is a good exemple of that. When the street lights reflects on it you can not see what is behind.
  136809. */
  136810. useRadianceOverAlpha: boolean;
  136811. /**
  136812. * Allows using an object space normal map (instead of tangent space).
  136813. */
  136814. useObjectSpaceNormalMap: boolean;
  136815. /**
  136816. * Allows using the bump map in parallax mode.
  136817. */
  136818. useParallax: boolean;
  136819. /**
  136820. * Allows using the bump map in parallax occlusion mode.
  136821. */
  136822. useParallaxOcclusion: boolean;
  136823. /**
  136824. * Controls the scale bias of the parallax mode.
  136825. */
  136826. parallaxScaleBias: number;
  136827. /**
  136828. * If sets to true, disables all the lights affecting the material.
  136829. */
  136830. disableLighting: boolean;
  136831. /**
  136832. * Force the shader to compute irradiance in the fragment shader in order to take bump in account.
  136833. */
  136834. forceIrradianceInFragment: boolean;
  136835. /**
  136836. * Number of Simultaneous lights allowed on the material.
  136837. */
  136838. maxSimultaneousLights: number;
  136839. /**
  136840. * If sets to true, x component of normal map value will invert (x = 1.0 - x).
  136841. */
  136842. invertNormalMapX: boolean;
  136843. /**
  136844. * If sets to true, y component of normal map value will invert (y = 1.0 - y).
  136845. */
  136846. invertNormalMapY: boolean;
  136847. /**
  136848. * If sets to true and backfaceCulling is false, normals will be flipped on the backside.
  136849. */
  136850. twoSidedLighting: boolean;
  136851. /**
  136852. * A fresnel is applied to the alpha of the model to ensure grazing angles edges are not alpha tested.
  136853. * And/Or occlude the blended part. (alpha is converted to gamma to compute the fresnel)
  136854. */
  136855. useAlphaFresnel: boolean;
  136856. /**
  136857. * A fresnel is applied to the alpha of the model to ensure grazing angles edges are not alpha tested.
  136858. * And/Or occlude the blended part. (alpha stays linear to compute the fresnel)
  136859. */
  136860. useLinearAlphaFresnel: boolean;
  136861. /**
  136862. * Let user defines the brdf lookup texture used for IBL.
  136863. * A default 8bit version is embedded but you could point at :
  136864. * * Default texture: https://assets.babylonjs.com/environments/correlatedMSBRDF_RGBD.png
  136865. * * Default 16bit pixel depth texture: https://assets.babylonjs.com/environments/correlatedMSBRDF.dds
  136866. * * LEGACY Default None correlated https://assets.babylonjs.com/environments/uncorrelatedBRDF_RGBD.png
  136867. * * LEGACY Default None correlated 16bit pixel depth https://assets.babylonjs.com/environments/uncorrelatedBRDF.dds
  136868. */
  136869. environmentBRDFTexture: Nullable<BaseTexture>;
  136870. /**
  136871. * Force normal to face away from face.
  136872. */
  136873. forceNormalForward: boolean;
  136874. /**
  136875. * Enables specular anti aliasing in the PBR shader.
  136876. * It will both interacts on the Geometry for analytical and IBL lighting.
  136877. * It also prefilter the roughness map based on the bump values.
  136878. */
  136879. enableSpecularAntiAliasing: boolean;
  136880. /**
  136881. * This parameters will enable/disable Horizon occlusion to prevent normal maps to look shiny when the normal
  136882. * makes the reflect vector face the model (under horizon).
  136883. */
  136884. useHorizonOcclusion: boolean;
  136885. /**
  136886. * This parameters will enable/disable radiance occlusion by preventing the radiance to lit
  136887. * too much the area relying on ambient texture to define their ambient occlusion.
  136888. */
  136889. useRadianceOcclusion: boolean;
  136890. /**
  136891. * If set to true, no lighting calculations will be applied.
  136892. */
  136893. unlit: boolean;
  136894. /**
  136895. * Gets the image processing configuration used either in this material.
  136896. */
  136897. get imageProcessingConfiguration(): ImageProcessingConfiguration;
  136898. /**
  136899. * Sets the Default image processing configuration used either in the this material.
  136900. *
  136901. * If sets to null, the scene one is in use.
  136902. */
  136903. set imageProcessingConfiguration(value: ImageProcessingConfiguration);
  136904. /**
  136905. * Gets wether the color curves effect is enabled.
  136906. */
  136907. get cameraColorCurvesEnabled(): boolean;
  136908. /**
  136909. * Sets wether the color curves effect is enabled.
  136910. */
  136911. set cameraColorCurvesEnabled(value: boolean);
  136912. /**
  136913. * Gets wether the color grading effect is enabled.
  136914. */
  136915. get cameraColorGradingEnabled(): boolean;
  136916. /**
  136917. * Gets wether the color grading effect is enabled.
  136918. */
  136919. set cameraColorGradingEnabled(value: boolean);
  136920. /**
  136921. * Gets wether tonemapping is enabled or not.
  136922. */
  136923. get cameraToneMappingEnabled(): boolean;
  136924. /**
  136925. * Sets wether tonemapping is enabled or not
  136926. */
  136927. set cameraToneMappingEnabled(value: boolean);
  136928. /**
  136929. * The camera exposure used on this material.
  136930. * This property is here and not in the camera to allow controlling exposure without full screen post process.
  136931. * This corresponds to a photographic exposure.
  136932. */
  136933. get cameraExposure(): number;
  136934. /**
  136935. * The camera exposure used on this material.
  136936. * This property is here and not in the camera to allow controlling exposure without full screen post process.
  136937. * This corresponds to a photographic exposure.
  136938. */
  136939. set cameraExposure(value: number);
  136940. /**
  136941. * Gets The camera contrast used on this material.
  136942. */
  136943. get cameraContrast(): number;
  136944. /**
  136945. * Sets The camera contrast used on this material.
  136946. */
  136947. set cameraContrast(value: number);
  136948. /**
  136949. * Gets the Color Grading 2D Lookup Texture.
  136950. */
  136951. get cameraColorGradingTexture(): Nullable<BaseTexture>;
  136952. /**
  136953. * Sets the Color Grading 2D Lookup Texture.
  136954. */
  136955. set cameraColorGradingTexture(value: Nullable<BaseTexture>);
  136956. /**
  136957. * The color grading curves provide additional color adjustmnent that is applied after any color grading transform (3D LUT).
  136958. * They allow basic adjustment of saturation and small exposure adjustments, along with color filter tinting to provide white balance adjustment or more stylistic effects.
  136959. * 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;
  136960. * corresponding to low luminance, medium luminance, and high luminance areas respectively.
  136961. */
  136962. get cameraColorCurves(): Nullable<ColorCurves>;
  136963. /**
  136964. * The color grading curves provide additional color adjustmnent that is applied after any color grading transform (3D LUT).
  136965. * They allow basic adjustment of saturation and small exposure adjustments, along with color filter tinting to provide white balance adjustment or more stylistic effects.
  136966. * 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;
  136967. * corresponding to low luminance, medium luminance, and high luminance areas respectively.
  136968. */
  136969. set cameraColorCurves(value: Nullable<ColorCurves>);
  136970. /**
  136971. * Instantiates a new PBRMaterial instance.
  136972. *
  136973. * @param name The material name
  136974. * @param scene The scene the material will be use in.
  136975. */
  136976. constructor(name: string, scene: Scene);
  136977. /**
  136978. * Returns the name of this material class.
  136979. */
  136980. getClassName(): string;
  136981. /**
  136982. * Makes a duplicate of the current material.
  136983. * @param name - name to use for the new material.
  136984. */
  136985. clone(name: string): PBRMaterial;
  136986. /**
  136987. * Serializes this PBR Material.
  136988. * @returns - An object with the serialized material.
  136989. */
  136990. serialize(): any;
  136991. /**
  136992. * Parses a PBR Material from a serialized object.
  136993. * @param source - Serialized object.
  136994. * @param scene - BJS scene instance.
  136995. * @param rootUrl - url for the scene object
  136996. * @returns - PBRMaterial
  136997. */
  136998. static Parse(source: any, scene: Scene, rootUrl: string): PBRMaterial;
  136999. }
  137000. }
  137001. declare module BABYLON {
  137002. /**
  137003. * Direct draw surface info
  137004. * @see https://docs.microsoft.com/en-us/windows/desktop/direct3ddds/dx-graphics-dds-pguide
  137005. */
  137006. export interface DDSInfo {
  137007. /**
  137008. * Width of the texture
  137009. */
  137010. width: number;
  137011. /**
  137012. * Width of the texture
  137013. */
  137014. height: number;
  137015. /**
  137016. * Number of Mipmaps for the texture
  137017. * @see https://en.wikipedia.org/wiki/Mipmap
  137018. */
  137019. mipmapCount: number;
  137020. /**
  137021. * If the textures format is a known fourCC format
  137022. * @see https://www.fourcc.org/
  137023. */
  137024. isFourCC: boolean;
  137025. /**
  137026. * If the texture is an RGB format eg. DXGI_FORMAT_B8G8R8X8_UNORM format
  137027. */
  137028. isRGB: boolean;
  137029. /**
  137030. * If the texture is a lumincance format
  137031. */
  137032. isLuminance: boolean;
  137033. /**
  137034. * If this is a cube texture
  137035. * @see https://docs.microsoft.com/en-us/windows/desktop/direct3ddds/dds-file-layout-for-cubic-environment-maps
  137036. */
  137037. isCube: boolean;
  137038. /**
  137039. * If the texture is a compressed format eg. FOURCC_DXT1
  137040. */
  137041. isCompressed: boolean;
  137042. /**
  137043. * The dxgiFormat of the texture
  137044. * @see https://docs.microsoft.com/en-us/windows/desktop/api/dxgiformat/ne-dxgiformat-dxgi_format
  137045. */
  137046. dxgiFormat: number;
  137047. /**
  137048. * Texture type eg. Engine.TEXTURETYPE_UNSIGNED_INT, Engine.TEXTURETYPE_FLOAT
  137049. */
  137050. textureType: number;
  137051. /**
  137052. * Sphericle polynomial created for the dds texture
  137053. */
  137054. sphericalPolynomial?: SphericalPolynomial;
  137055. }
  137056. /**
  137057. * Class used to provide DDS decompression tools
  137058. */
  137059. export class DDSTools {
  137060. /**
  137061. * Gets or sets a boolean indicating that LOD info is stored in alpha channel (false by default)
  137062. */
  137063. static StoreLODInAlphaChannel: boolean;
  137064. /**
  137065. * Gets DDS information from an array buffer
  137066. * @param data defines the array buffer view to read data from
  137067. * @returns the DDS information
  137068. */
  137069. static GetDDSInfo(data: ArrayBufferView): DDSInfo;
  137070. private static _FloatView;
  137071. private static _Int32View;
  137072. private static _ToHalfFloat;
  137073. private static _FromHalfFloat;
  137074. private static _GetHalfFloatAsFloatRGBAArrayBuffer;
  137075. private static _GetHalfFloatRGBAArrayBuffer;
  137076. private static _GetFloatRGBAArrayBuffer;
  137077. private static _GetFloatAsUIntRGBAArrayBuffer;
  137078. private static _GetHalfFloatAsUIntRGBAArrayBuffer;
  137079. private static _GetRGBAArrayBuffer;
  137080. private static _ExtractLongWordOrder;
  137081. private static _GetRGBArrayBuffer;
  137082. private static _GetLuminanceArrayBuffer;
  137083. /**
  137084. * Uploads DDS Levels to a Babylon Texture
  137085. * @hidden
  137086. */
  137087. static UploadDDSLevels(engine: ThinEngine, texture: InternalTexture, data: ArrayBufferView, info: DDSInfo, loadMipmaps: boolean, faces: number, lodIndex?: number, currentFace?: number): void;
  137088. }
  137089. interface ThinEngine {
  137090. /**
  137091. * Create a cube texture from prefiltered data (ie. the mipmaps contain ready to use data for PBR reflection)
  137092. * @param rootUrl defines the url where the file to load is located
  137093. * @param scene defines the current scene
  137094. * @param lodScale defines scale to apply to the mip map selection
  137095. * @param lodOffset defines offset to apply to the mip map selection
  137096. * @param onLoad defines an optional callback raised when the texture is loaded
  137097. * @param onError defines an optional callback raised if there is an issue to load the texture
  137098. * @param format defines the format of the data
  137099. * @param forcedExtension defines the extension to use to pick the right loader
  137100. * @param createPolynomials defines wheter or not to create polynomails harmonics for the texture
  137101. * @returns the cube texture as an InternalTexture
  137102. */
  137103. 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;
  137104. }
  137105. }
  137106. declare module BABYLON {
  137107. /**
  137108. * Implementation of the DDS Texture Loader.
  137109. * @hidden
  137110. */
  137111. export class _DDSTextureLoader implements IInternalTextureLoader {
  137112. /**
  137113. * Defines wether the loader supports cascade loading the different faces.
  137114. */
  137115. readonly supportCascades: boolean;
  137116. /**
  137117. * This returns if the loader support the current file information.
  137118. * @param extension defines the file extension of the file being loaded
  137119. * @returns true if the loader can load the specified file
  137120. */
  137121. canLoad(extension: string): boolean;
  137122. /**
  137123. * Uploads the cube texture data to the WebGL texture. It has already been bound.
  137124. * @param data contains the texture data
  137125. * @param texture defines the BabylonJS internal texture
  137126. * @param createPolynomials will be true if polynomials have been requested
  137127. * @param onLoad defines the callback to trigger once the texture is ready
  137128. * @param onError defines the callback to trigger in case of error
  137129. */
  137130. loadCubeData(imgs: ArrayBufferView | ArrayBufferView[], texture: InternalTexture, createPolynomials: boolean, onLoad: Nullable<(data?: any) => void>, onError: Nullable<(message?: string, exception?: any) => void>): void;
  137131. /**
  137132. * Uploads the 2D texture data to the WebGL texture. It has already been bound once in the callback.
  137133. * @param data contains the texture data
  137134. * @param texture defines the BabylonJS internal texture
  137135. * @param callback defines the method to call once ready to upload
  137136. */
  137137. loadData(data: ArrayBufferView, texture: InternalTexture, callback: (width: number, height: number, loadMipmap: boolean, isCompressed: boolean, done: () => void) => void): void;
  137138. }
  137139. }
  137140. declare module BABYLON {
  137141. /**
  137142. * Implementation of the ENV Texture Loader.
  137143. * @hidden
  137144. */
  137145. export class _ENVTextureLoader implements IInternalTextureLoader {
  137146. /**
  137147. * Defines wether the loader supports cascade loading the different faces.
  137148. */
  137149. readonly supportCascades: boolean;
  137150. /**
  137151. * This returns if the loader support the current file information.
  137152. * @param extension defines the file extension of the file being loaded
  137153. * @returns true if the loader can load the specified file
  137154. */
  137155. canLoad(extension: string): boolean;
  137156. /**
  137157. * Uploads the cube texture data to the WebGL texture. It has already been bound.
  137158. * @param data contains the texture data
  137159. * @param texture defines the BabylonJS internal texture
  137160. * @param createPolynomials will be true if polynomials have been requested
  137161. * @param onLoad defines the callback to trigger once the texture is ready
  137162. * @param onError defines the callback to trigger in case of error
  137163. */
  137164. loadCubeData(data: ArrayBufferView | ArrayBufferView[], texture: InternalTexture, createPolynomials: boolean, onLoad: Nullable<(data?: any) => void>, onError: Nullable<(message?: string, exception?: any) => void>): void;
  137165. /**
  137166. * Uploads the 2D texture data to the WebGL texture. It has already been bound once in the callback.
  137167. * @param data contains the texture data
  137168. * @param texture defines the BabylonJS internal texture
  137169. * @param callback defines the method to call once ready to upload
  137170. */
  137171. loadData(data: ArrayBufferView, texture: InternalTexture, callback: (width: number, height: number, loadMipmap: boolean, isCompressed: boolean, done: () => void) => void): void;
  137172. }
  137173. }
  137174. declare module BABYLON {
  137175. /**
  137176. * for description see https://www.khronos.org/opengles/sdk/tools/KTX/
  137177. * for file layout see https://www.khronos.org/opengles/sdk/tools/KTX/file_format_spec/
  137178. */
  137179. export class KhronosTextureContainer {
  137180. /** contents of the KTX container file */
  137181. data: ArrayBufferView;
  137182. private static HEADER_LEN;
  137183. private static COMPRESSED_2D;
  137184. private static COMPRESSED_3D;
  137185. private static TEX_2D;
  137186. private static TEX_3D;
  137187. /**
  137188. * Gets the openGL type
  137189. */
  137190. glType: number;
  137191. /**
  137192. * Gets the openGL type size
  137193. */
  137194. glTypeSize: number;
  137195. /**
  137196. * Gets the openGL format
  137197. */
  137198. glFormat: number;
  137199. /**
  137200. * Gets the openGL internal format
  137201. */
  137202. glInternalFormat: number;
  137203. /**
  137204. * Gets the base internal format
  137205. */
  137206. glBaseInternalFormat: number;
  137207. /**
  137208. * Gets image width in pixel
  137209. */
  137210. pixelWidth: number;
  137211. /**
  137212. * Gets image height in pixel
  137213. */
  137214. pixelHeight: number;
  137215. /**
  137216. * Gets image depth in pixels
  137217. */
  137218. pixelDepth: number;
  137219. /**
  137220. * Gets the number of array elements
  137221. */
  137222. numberOfArrayElements: number;
  137223. /**
  137224. * Gets the number of faces
  137225. */
  137226. numberOfFaces: number;
  137227. /**
  137228. * Gets the number of mipmap levels
  137229. */
  137230. numberOfMipmapLevels: number;
  137231. /**
  137232. * Gets the bytes of key value data
  137233. */
  137234. bytesOfKeyValueData: number;
  137235. /**
  137236. * Gets the load type
  137237. */
  137238. loadType: number;
  137239. /**
  137240. * If the container has been made invalid (eg. constructor failed to correctly load array buffer)
  137241. */
  137242. isInvalid: boolean;
  137243. /**
  137244. * Creates a new KhronosTextureContainer
  137245. * @param data contents of the KTX container file
  137246. * @param facesExpected should be either 1 or 6, based whether a cube texture or or
  137247. * @param threeDExpected provision for indicating that data should be a 3D texture, not implemented
  137248. * @param textureArrayExpected provision for indicating that data should be a texture array, not implemented
  137249. */
  137250. constructor(
  137251. /** contents of the KTX container file */
  137252. data: ArrayBufferView, facesExpected: number, threeDExpected?: boolean, textureArrayExpected?: boolean);
  137253. /**
  137254. * Uploads KTX content to a Babylon Texture.
  137255. * It is assumed that the texture has already been created & is currently bound
  137256. * @hidden
  137257. */
  137258. uploadLevels(texture: InternalTexture, loadMipmaps: boolean): void;
  137259. private _upload2DCompressedLevels;
  137260. /**
  137261. * Checks if the given data starts with a KTX file identifier.
  137262. * @param data the data to check
  137263. * @returns true if the data is a KTX file or false otherwise
  137264. */
  137265. static IsValid(data: ArrayBufferView): boolean;
  137266. }
  137267. }
  137268. declare module BABYLON {
  137269. /**
  137270. * Class for loading KTX2 files
  137271. * !!! Experimental Extension Subject to Changes !!!
  137272. * @hidden
  137273. */
  137274. export class KhronosTextureContainer2 {
  137275. private static _ModulePromise;
  137276. private static _TranscodeFormat;
  137277. constructor(engine: ThinEngine);
  137278. uploadAsync(data: ArrayBufferView, internalTexture: InternalTexture): Promise<void>;
  137279. private _determineTranscodeFormat;
  137280. /**
  137281. * Checks if the given data starts with a KTX2 file identifier.
  137282. * @param data the data to check
  137283. * @returns true if the data is a KTX2 file or false otherwise
  137284. */
  137285. static IsValid(data: ArrayBufferView): boolean;
  137286. }
  137287. }
  137288. declare module BABYLON {
  137289. /**
  137290. * Implementation of the KTX Texture Loader.
  137291. * @hidden
  137292. */
  137293. export class _KTXTextureLoader implements IInternalTextureLoader {
  137294. /**
  137295. * Defines wether the loader supports cascade loading the different faces.
  137296. */
  137297. readonly supportCascades: boolean;
  137298. /**
  137299. * This returns if the loader support the current file information.
  137300. * @param extension defines the file extension of the file being loaded
  137301. * @param mimeType defines the optional mime type of the file being loaded
  137302. * @returns true if the loader can load the specified file
  137303. */
  137304. canLoad(extension: string, mimeType?: string): boolean;
  137305. /**
  137306. * Uploads the cube texture data to the WebGL texture. It has already been bound.
  137307. * @param data contains the texture data
  137308. * @param texture defines the BabylonJS internal texture
  137309. * @param createPolynomials will be true if polynomials have been requested
  137310. * @param onLoad defines the callback to trigger once the texture is ready
  137311. * @param onError defines the callback to trigger in case of error
  137312. */
  137313. loadCubeData(data: ArrayBufferView | ArrayBufferView[], texture: InternalTexture, createPolynomials: boolean, onLoad: Nullable<(data?: any) => void>, onError: Nullable<(message?: string, exception?: any) => void>): void;
  137314. /**
  137315. * Uploads the 2D texture data to the WebGL texture. It has already been bound once in the callback.
  137316. * @param data contains the texture data
  137317. * @param texture defines the BabylonJS internal texture
  137318. * @param callback defines the method to call once ready to upload
  137319. */
  137320. loadData(data: ArrayBufferView, texture: InternalTexture, callback: (width: number, height: number, loadMipmap: boolean, isCompressed: boolean, done: () => void, loadFailed: boolean) => void): void;
  137321. }
  137322. }
  137323. declare module BABYLON {
  137324. /** @hidden */
  137325. export var _forceSceneHelpersToBundle: boolean;
  137326. interface Scene {
  137327. /**
  137328. * Creates a default light for the scene.
  137329. * @see https://doc.babylonjs.com/How_To/Fast_Build#create-default-light
  137330. * @param replace has the default false, when true replaces the existing lights in the scene with a hemispheric light
  137331. */
  137332. createDefaultLight(replace?: boolean): void;
  137333. /**
  137334. * Creates a default camera for the scene.
  137335. * @see https://doc.babylonjs.com/How_To/Fast_Build#create-default-camera
  137336. * @param createArcRotateCamera has the default false which creates a free camera, when true creates an arc rotate camera
  137337. * @param replace has default false, when true replaces the active camera in the scene
  137338. * @param attachCameraControls has default false, when true attaches camera controls to the canvas.
  137339. */
  137340. createDefaultCamera(createArcRotateCamera?: boolean, replace?: boolean, attachCameraControls?: boolean): void;
  137341. /**
  137342. * Creates a default camera and a default light.
  137343. * @see https://doc.babylonjs.com/how_to/Fast_Build#create-default-camera-or-light
  137344. * @param createArcRotateCamera has the default false which creates a free camera, when true creates an arc rotate camera
  137345. * @param replace has the default false, when true replaces the active camera/light in the scene
  137346. * @param attachCameraControls has the default false, when true attaches camera controls to the canvas.
  137347. */
  137348. createDefaultCameraOrLight(createArcRotateCamera?: boolean, replace?: boolean, attachCameraControls?: boolean): void;
  137349. /**
  137350. * Creates a new sky box
  137351. * @see https://doc.babylonjs.com/how_to/Fast_Build#create-default-skybox
  137352. * @param environmentTexture defines the texture to use as environment texture
  137353. * @param pbr has default false which requires the StandardMaterial to be used, when true PBRMaterial must be used
  137354. * @param scale defines the overall scale of the skybox
  137355. * @param blur is only available when pbr is true, default is 0, no blur, maximum value is 1
  137356. * @param setGlobalEnvTexture has default true indicating that scene.environmentTexture must match the current skybox texture
  137357. * @returns a new mesh holding the sky box
  137358. */
  137359. createDefaultSkybox(environmentTexture?: BaseTexture, pbr?: boolean, scale?: number, blur?: number, setGlobalEnvTexture?: boolean): Nullable<Mesh>;
  137360. /**
  137361. * Creates a new environment
  137362. * @see https://doc.babylonjs.com/How_To/Fast_Build#create-default-environment
  137363. * @param options defines the options you can use to configure the environment
  137364. * @returns the new EnvironmentHelper
  137365. */
  137366. createDefaultEnvironment(options?: Partial<IEnvironmentHelperOptions>): Nullable<EnvironmentHelper>;
  137367. /**
  137368. * Creates a new VREXperienceHelper
  137369. * @see https://doc.babylonjs.com/how_to/webvr_helper
  137370. * @param webVROptions defines the options used to create the new VREXperienceHelper
  137371. * @returns a new VREXperienceHelper
  137372. */
  137373. createDefaultVRExperience(webVROptions?: VRExperienceHelperOptions): VRExperienceHelper;
  137374. /**
  137375. * Creates a new WebXRDefaultExperience
  137376. * @see https://doc.babylonjs.com/how_to/introduction_to_webxr
  137377. * @param options experience options
  137378. * @returns a promise for a new WebXRDefaultExperience
  137379. */
  137380. createDefaultXRExperienceAsync(options: WebXRDefaultExperienceOptions): Promise<WebXRDefaultExperience>;
  137381. }
  137382. }
  137383. declare module BABYLON {
  137384. /**
  137385. * Display a 360/180 degree video on an approximately spherical surface, useful for VR applications or skyboxes.
  137386. * As a subclass of TransformNode, this allow parenting to the camera or multiple videos with different locations in the scene.
  137387. * This class achieves its effect with a VideoTexture and a correctly configured BackgroundMaterial on an inverted sphere.
  137388. * Potential additions to this helper include zoom and and non-infinite distance rendering effects.
  137389. */
  137390. export class VideoDome extends TextureDome<VideoTexture> {
  137391. /**
  137392. * Define the video source as a Monoscopic panoramic 360 video.
  137393. */
  137394. static readonly MODE_MONOSCOPIC: number;
  137395. /**
  137396. * Define the video source as a Stereoscopic TopBottom/OverUnder panoramic 360 video.
  137397. */
  137398. static readonly MODE_TOPBOTTOM: number;
  137399. /**
  137400. * Define the video source as a Stereoscopic Side by Side panoramic 360 video.
  137401. */
  137402. static readonly MODE_SIDEBYSIDE: number;
  137403. /**
  137404. * Get the video texture associated with this video dome
  137405. */
  137406. get videoTexture(): VideoTexture;
  137407. /**
  137408. * Get the video mode of this dome
  137409. */
  137410. get videoMode(): number;
  137411. /**
  137412. * Set the video mode of this dome.
  137413. * @see textureMode
  137414. */
  137415. set videoMode(value: number);
  137416. protected _initTexture(urlsOrElement: string | string[] | HTMLVideoElement, scene: Scene, options: any): VideoTexture;
  137417. }
  137418. }
  137419. declare module BABYLON {
  137420. /**
  137421. * This class can be used to get instrumentation data from a Babylon engine
  137422. * @see https://doc.babylonjs.com/how_to/optimizing_your_scene#engineinstrumentation
  137423. */
  137424. export class EngineInstrumentation implements IDisposable {
  137425. /**
  137426. * Define the instrumented engine.
  137427. */
  137428. engine: Engine;
  137429. private _captureGPUFrameTime;
  137430. private _gpuFrameTimeToken;
  137431. private _gpuFrameTime;
  137432. private _captureShaderCompilationTime;
  137433. private _shaderCompilationTime;
  137434. private _onBeginFrameObserver;
  137435. private _onEndFrameObserver;
  137436. private _onBeforeShaderCompilationObserver;
  137437. private _onAfterShaderCompilationObserver;
  137438. /**
  137439. * Gets the perf counter used for GPU frame time
  137440. */
  137441. get gpuFrameTimeCounter(): PerfCounter;
  137442. /**
  137443. * Gets the GPU frame time capture status
  137444. */
  137445. get captureGPUFrameTime(): boolean;
  137446. /**
  137447. * Enable or disable the GPU frame time capture
  137448. */
  137449. set captureGPUFrameTime(value: boolean);
  137450. /**
  137451. * Gets the perf counter used for shader compilation time
  137452. */
  137453. get shaderCompilationTimeCounter(): PerfCounter;
  137454. /**
  137455. * Gets the shader compilation time capture status
  137456. */
  137457. get captureShaderCompilationTime(): boolean;
  137458. /**
  137459. * Enable or disable the shader compilation time capture
  137460. */
  137461. set captureShaderCompilationTime(value: boolean);
  137462. /**
  137463. * Instantiates a new engine instrumentation.
  137464. * This class can be used to get instrumentation data from a Babylon engine
  137465. * @see https://doc.babylonjs.com/how_to/optimizing_your_scene#engineinstrumentation
  137466. * @param engine Defines the engine to instrument
  137467. */
  137468. constructor(
  137469. /**
  137470. * Define the instrumented engine.
  137471. */
  137472. engine: Engine);
  137473. /**
  137474. * Dispose and release associated resources.
  137475. */
  137476. dispose(): void;
  137477. }
  137478. }
  137479. declare module BABYLON {
  137480. /**
  137481. * This class can be used to get instrumentation data from a Babylon engine
  137482. * @see https://doc.babylonjs.com/how_to/optimizing_your_scene#sceneinstrumentation
  137483. */
  137484. export class SceneInstrumentation implements IDisposable {
  137485. /**
  137486. * Defines the scene to instrument
  137487. */
  137488. scene: Scene;
  137489. private _captureActiveMeshesEvaluationTime;
  137490. private _activeMeshesEvaluationTime;
  137491. private _captureRenderTargetsRenderTime;
  137492. private _renderTargetsRenderTime;
  137493. private _captureFrameTime;
  137494. private _frameTime;
  137495. private _captureRenderTime;
  137496. private _renderTime;
  137497. private _captureInterFrameTime;
  137498. private _interFrameTime;
  137499. private _captureParticlesRenderTime;
  137500. private _particlesRenderTime;
  137501. private _captureSpritesRenderTime;
  137502. private _spritesRenderTime;
  137503. private _capturePhysicsTime;
  137504. private _physicsTime;
  137505. private _captureAnimationsTime;
  137506. private _animationsTime;
  137507. private _captureCameraRenderTime;
  137508. private _cameraRenderTime;
  137509. private _onBeforeActiveMeshesEvaluationObserver;
  137510. private _onAfterActiveMeshesEvaluationObserver;
  137511. private _onBeforeRenderTargetsRenderObserver;
  137512. private _onAfterRenderTargetsRenderObserver;
  137513. private _onAfterRenderObserver;
  137514. private _onBeforeDrawPhaseObserver;
  137515. private _onAfterDrawPhaseObserver;
  137516. private _onBeforeAnimationsObserver;
  137517. private _onBeforeParticlesRenderingObserver;
  137518. private _onAfterParticlesRenderingObserver;
  137519. private _onBeforeSpritesRenderingObserver;
  137520. private _onAfterSpritesRenderingObserver;
  137521. private _onBeforePhysicsObserver;
  137522. private _onAfterPhysicsObserver;
  137523. private _onAfterAnimationsObserver;
  137524. private _onBeforeCameraRenderObserver;
  137525. private _onAfterCameraRenderObserver;
  137526. /**
  137527. * Gets the perf counter used for active meshes evaluation time
  137528. */
  137529. get activeMeshesEvaluationTimeCounter(): PerfCounter;
  137530. /**
  137531. * Gets the active meshes evaluation time capture status
  137532. */
  137533. get captureActiveMeshesEvaluationTime(): boolean;
  137534. /**
  137535. * Enable or disable the active meshes evaluation time capture
  137536. */
  137537. set captureActiveMeshesEvaluationTime(value: boolean);
  137538. /**
  137539. * Gets the perf counter used for render targets render time
  137540. */
  137541. get renderTargetsRenderTimeCounter(): PerfCounter;
  137542. /**
  137543. * Gets the render targets render time capture status
  137544. */
  137545. get captureRenderTargetsRenderTime(): boolean;
  137546. /**
  137547. * Enable or disable the render targets render time capture
  137548. */
  137549. set captureRenderTargetsRenderTime(value: boolean);
  137550. /**
  137551. * Gets the perf counter used for particles render time
  137552. */
  137553. get particlesRenderTimeCounter(): PerfCounter;
  137554. /**
  137555. * Gets the particles render time capture status
  137556. */
  137557. get captureParticlesRenderTime(): boolean;
  137558. /**
  137559. * Enable or disable the particles render time capture
  137560. */
  137561. set captureParticlesRenderTime(value: boolean);
  137562. /**
  137563. * Gets the perf counter used for sprites render time
  137564. */
  137565. get spritesRenderTimeCounter(): PerfCounter;
  137566. /**
  137567. * Gets the sprites render time capture status
  137568. */
  137569. get captureSpritesRenderTime(): boolean;
  137570. /**
  137571. * Enable or disable the sprites render time capture
  137572. */
  137573. set captureSpritesRenderTime(value: boolean);
  137574. /**
  137575. * Gets the perf counter used for physics time
  137576. */
  137577. get physicsTimeCounter(): PerfCounter;
  137578. /**
  137579. * Gets the physics time capture status
  137580. */
  137581. get capturePhysicsTime(): boolean;
  137582. /**
  137583. * Enable or disable the physics time capture
  137584. */
  137585. set capturePhysicsTime(value: boolean);
  137586. /**
  137587. * Gets the perf counter used for animations time
  137588. */
  137589. get animationsTimeCounter(): PerfCounter;
  137590. /**
  137591. * Gets the animations time capture status
  137592. */
  137593. get captureAnimationsTime(): boolean;
  137594. /**
  137595. * Enable or disable the animations time capture
  137596. */
  137597. set captureAnimationsTime(value: boolean);
  137598. /**
  137599. * Gets the perf counter used for frame time capture
  137600. */
  137601. get frameTimeCounter(): PerfCounter;
  137602. /**
  137603. * Gets the frame time capture status
  137604. */
  137605. get captureFrameTime(): boolean;
  137606. /**
  137607. * Enable or disable the frame time capture
  137608. */
  137609. set captureFrameTime(value: boolean);
  137610. /**
  137611. * Gets the perf counter used for inter-frames time capture
  137612. */
  137613. get interFrameTimeCounter(): PerfCounter;
  137614. /**
  137615. * Gets the inter-frames time capture status
  137616. */
  137617. get captureInterFrameTime(): boolean;
  137618. /**
  137619. * Enable or disable the inter-frames time capture
  137620. */
  137621. set captureInterFrameTime(value: boolean);
  137622. /**
  137623. * Gets the perf counter used for render time capture
  137624. */
  137625. get renderTimeCounter(): PerfCounter;
  137626. /**
  137627. * Gets the render time capture status
  137628. */
  137629. get captureRenderTime(): boolean;
  137630. /**
  137631. * Enable or disable the render time capture
  137632. */
  137633. set captureRenderTime(value: boolean);
  137634. /**
  137635. * Gets the perf counter used for camera render time capture
  137636. */
  137637. get cameraRenderTimeCounter(): PerfCounter;
  137638. /**
  137639. * Gets the camera render time capture status
  137640. */
  137641. get captureCameraRenderTime(): boolean;
  137642. /**
  137643. * Enable or disable the camera render time capture
  137644. */
  137645. set captureCameraRenderTime(value: boolean);
  137646. /**
  137647. * Gets the perf counter used for draw calls
  137648. */
  137649. get drawCallsCounter(): PerfCounter;
  137650. /**
  137651. * Instantiates a new scene instrumentation.
  137652. * This class can be used to get instrumentation data from a Babylon engine
  137653. * @see https://doc.babylonjs.com/how_to/optimizing_your_scene#sceneinstrumentation
  137654. * @param scene Defines the scene to instrument
  137655. */
  137656. constructor(
  137657. /**
  137658. * Defines the scene to instrument
  137659. */
  137660. scene: Scene);
  137661. /**
  137662. * Dispose and release associated resources.
  137663. */
  137664. dispose(): void;
  137665. }
  137666. }
  137667. declare module BABYLON {
  137668. /** @hidden */
  137669. export var glowMapGenerationPixelShader: {
  137670. name: string;
  137671. shader: string;
  137672. };
  137673. }
  137674. declare module BABYLON {
  137675. /** @hidden */
  137676. export var glowMapGenerationVertexShader: {
  137677. name: string;
  137678. shader: string;
  137679. };
  137680. }
  137681. declare module BABYLON {
  137682. /**
  137683. * Effect layer options. This helps customizing the behaviour
  137684. * of the effect layer.
  137685. */
  137686. export interface IEffectLayerOptions {
  137687. /**
  137688. * Multiplication factor apply to the canvas size to compute the render target size
  137689. * used to generated the objects (the smaller the faster).
  137690. */
  137691. mainTextureRatio: number;
  137692. /**
  137693. * Enforces a fixed size texture to ensure effect stability across devices.
  137694. */
  137695. mainTextureFixedSize?: number;
  137696. /**
  137697. * Alpha blending mode used to apply the blur. Default depends of the implementation.
  137698. */
  137699. alphaBlendingMode: number;
  137700. /**
  137701. * The camera attached to the layer.
  137702. */
  137703. camera: Nullable<Camera>;
  137704. /**
  137705. * The rendering group to draw the layer in.
  137706. */
  137707. renderingGroupId: number;
  137708. }
  137709. /**
  137710. * The effect layer Helps adding post process effect blended with the main pass.
  137711. *
  137712. * This can be for instance use to generate glow or higlight effects on the scene.
  137713. *
  137714. * The effect layer class can not be used directly and is intented to inherited from to be
  137715. * customized per effects.
  137716. */
  137717. export abstract class EffectLayer {
  137718. private _vertexBuffers;
  137719. private _indexBuffer;
  137720. private _cachedDefines;
  137721. private _effectLayerMapGenerationEffect;
  137722. private _effectLayerOptions;
  137723. private _mergeEffect;
  137724. protected _scene: Scene;
  137725. protected _engine: Engine;
  137726. protected _maxSize: number;
  137727. protected _mainTextureDesiredSize: ISize;
  137728. protected _mainTexture: RenderTargetTexture;
  137729. protected _shouldRender: boolean;
  137730. protected _postProcesses: PostProcess[];
  137731. protected _textures: BaseTexture[];
  137732. protected _emissiveTextureAndColor: {
  137733. texture: Nullable<BaseTexture>;
  137734. color: Color4;
  137735. };
  137736. /**
  137737. * The name of the layer
  137738. */
  137739. name: string;
  137740. /**
  137741. * The clear color of the texture used to generate the glow map.
  137742. */
  137743. neutralColor: Color4;
  137744. /**
  137745. * Specifies whether the highlight layer is enabled or not.
  137746. */
  137747. isEnabled: boolean;
  137748. /**
  137749. * Gets the camera attached to the layer.
  137750. */
  137751. get camera(): Nullable<Camera>;
  137752. /**
  137753. * Gets the rendering group id the layer should render in.
  137754. */
  137755. get renderingGroupId(): number;
  137756. set renderingGroupId(renderingGroupId: number);
  137757. /**
  137758. * An event triggered when the effect layer has been disposed.
  137759. */
  137760. onDisposeObservable: Observable<EffectLayer>;
  137761. /**
  137762. * An event triggered when the effect layer is about rendering the main texture with the glowy parts.
  137763. */
  137764. onBeforeRenderMainTextureObservable: Observable<EffectLayer>;
  137765. /**
  137766. * An event triggered when the generated texture is being merged in the scene.
  137767. */
  137768. onBeforeComposeObservable: Observable<EffectLayer>;
  137769. /**
  137770. * An event triggered when the mesh is rendered into the effect render target.
  137771. */
  137772. onBeforeRenderMeshToEffect: Observable<AbstractMesh>;
  137773. /**
  137774. * An event triggered after the mesh has been rendered into the effect render target.
  137775. */
  137776. onAfterRenderMeshToEffect: Observable<AbstractMesh>;
  137777. /**
  137778. * An event triggered when the generated texture has been merged in the scene.
  137779. */
  137780. onAfterComposeObservable: Observable<EffectLayer>;
  137781. /**
  137782. * An event triggered when the efffect layer changes its size.
  137783. */
  137784. onSizeChangedObservable: Observable<EffectLayer>;
  137785. /** @hidden */
  137786. static _SceneComponentInitialization: (scene: Scene) => void;
  137787. /**
  137788. * Instantiates a new effect Layer and references it in the scene.
  137789. * @param name The name of the layer
  137790. * @param scene The scene to use the layer in
  137791. */
  137792. constructor(
  137793. /** The Friendly of the effect in the scene */
  137794. name: string, scene: Scene);
  137795. /**
  137796. * Get the effect name of the layer.
  137797. * @return The effect name
  137798. */
  137799. abstract getEffectName(): string;
  137800. /**
  137801. * Checks for the readiness of the element composing the layer.
  137802. * @param subMesh the mesh to check for
  137803. * @param useInstances specify whether or not to use instances to render the mesh
  137804. * @return true if ready otherwise, false
  137805. */
  137806. abstract isReady(subMesh: SubMesh, useInstances: boolean): boolean;
  137807. /**
  137808. * Returns whether or nood the layer needs stencil enabled during the mesh rendering.
  137809. * @returns true if the effect requires stencil during the main canvas render pass.
  137810. */
  137811. abstract needStencil(): boolean;
  137812. /**
  137813. * Create the merge effect. This is the shader use to blit the information back
  137814. * to the main canvas at the end of the scene rendering.
  137815. * @returns The effect containing the shader used to merge the effect on the main canvas
  137816. */
  137817. protected abstract _createMergeEffect(): Effect;
  137818. /**
  137819. * Creates the render target textures and post processes used in the effect layer.
  137820. */
  137821. protected abstract _createTextureAndPostProcesses(): void;
  137822. /**
  137823. * Implementation specific of rendering the generating effect on the main canvas.
  137824. * @param effect The effect used to render through
  137825. */
  137826. protected abstract _internalRender(effect: Effect): void;
  137827. /**
  137828. * Sets the required values for both the emissive texture and and the main color.
  137829. */
  137830. protected abstract _setEmissiveTextureAndColor(mesh: Mesh, subMesh: SubMesh, material: Material): void;
  137831. /**
  137832. * Free any resources and references associated to a mesh.
  137833. * Internal use
  137834. * @param mesh The mesh to free.
  137835. */
  137836. abstract _disposeMesh(mesh: Mesh): void;
  137837. /**
  137838. * Serializes this layer (Glow or Highlight for example)
  137839. * @returns a serialized layer object
  137840. */
  137841. abstract serialize?(): any;
  137842. /**
  137843. * Initializes the effect layer with the required options.
  137844. * @param options Sets of none mandatory options to use with the layer (see IEffectLayerOptions for more information)
  137845. */
  137846. protected _init(options: Partial<IEffectLayerOptions>): void;
  137847. /**
  137848. * Generates the index buffer of the full screen quad blending to the main canvas.
  137849. */
  137850. private _generateIndexBuffer;
  137851. /**
  137852. * Generates the vertex buffer of the full screen quad blending to the main canvas.
  137853. */
  137854. private _generateVertexBuffer;
  137855. /**
  137856. * Sets the main texture desired size which is the closest power of two
  137857. * of the engine canvas size.
  137858. */
  137859. private _setMainTextureSize;
  137860. /**
  137861. * Creates the main texture for the effect layer.
  137862. */
  137863. protected _createMainTexture(): void;
  137864. /**
  137865. * Adds specific effects defines.
  137866. * @param defines The defines to add specifics to.
  137867. */
  137868. protected _addCustomEffectDefines(defines: string[]): void;
  137869. /**
  137870. * Checks for the readiness of the element composing the layer.
  137871. * @param subMesh the mesh to check for
  137872. * @param useInstances specify whether or not to use instances to render the mesh
  137873. * @param emissiveTexture the associated emissive texture used to generate the glow
  137874. * @return true if ready otherwise, false
  137875. */
  137876. protected _isReady(subMesh: SubMesh, useInstances: boolean, emissiveTexture: Nullable<BaseTexture>): boolean;
  137877. /**
  137878. * Renders the glowing part of the scene by blending the blurred glowing meshes on top of the rendered scene.
  137879. */
  137880. render(): void;
  137881. /**
  137882. * Determine if a given mesh will be used in the current effect.
  137883. * @param mesh mesh to test
  137884. * @returns true if the mesh will be used
  137885. */
  137886. hasMesh(mesh: AbstractMesh): boolean;
  137887. /**
  137888. * Returns true if the layer contains information to display, otherwise false.
  137889. * @returns true if the glow layer should be rendered
  137890. */
  137891. shouldRender(): boolean;
  137892. /**
  137893. * Returns true if the mesh should render, otherwise false.
  137894. * @param mesh The mesh to render
  137895. * @returns true if it should render otherwise false
  137896. */
  137897. protected _shouldRenderMesh(mesh: AbstractMesh): boolean;
  137898. /**
  137899. * Returns true if the mesh can be rendered, otherwise false.
  137900. * @param mesh The mesh to render
  137901. * @param material The material used on the mesh
  137902. * @returns true if it can be rendered otherwise false
  137903. */
  137904. protected _canRenderMesh(mesh: AbstractMesh, material: Material): boolean;
  137905. /**
  137906. * Returns true if the mesh should render, otherwise false.
  137907. * @param mesh The mesh to render
  137908. * @returns true if it should render otherwise false
  137909. */
  137910. protected _shouldRenderEmissiveTextureForMesh(): boolean;
  137911. /**
  137912. * Renders the submesh passed in parameter to the generation map.
  137913. */
  137914. protected _renderSubMesh(subMesh: SubMesh, enableAlphaMode?: boolean): void;
  137915. /**
  137916. * Defines whether the current material of the mesh should be use to render the effect.
  137917. * @param mesh defines the current mesh to render
  137918. */
  137919. protected _useMeshMaterial(mesh: AbstractMesh): boolean;
  137920. /**
  137921. * Rebuild the required buffers.
  137922. * @hidden Internal use only.
  137923. */
  137924. _rebuild(): void;
  137925. /**
  137926. * Dispose only the render target textures and post process.
  137927. */
  137928. private _disposeTextureAndPostProcesses;
  137929. /**
  137930. * Dispose the highlight layer and free resources.
  137931. */
  137932. dispose(): void;
  137933. /**
  137934. * Gets the class name of the effect layer
  137935. * @returns the string with the class name of the effect layer
  137936. */
  137937. getClassName(): string;
  137938. /**
  137939. * Creates an effect layer from parsed effect layer data
  137940. * @param parsedEffectLayer defines effect layer data
  137941. * @param scene defines the current scene
  137942. * @param rootUrl defines the root URL containing the effect layer information
  137943. * @returns a parsed effect Layer
  137944. */
  137945. static Parse(parsedEffectLayer: any, scene: Scene, rootUrl: string): EffectLayer;
  137946. }
  137947. }
  137948. declare module BABYLON {
  137949. interface AbstractScene {
  137950. /**
  137951. * The list of effect layers (highlights/glow) added to the scene
  137952. * @see https://doc.babylonjs.com/how_to/highlight_layer
  137953. * @see https://doc.babylonjs.com/how_to/glow_layer
  137954. */
  137955. effectLayers: Array<EffectLayer>;
  137956. /**
  137957. * Removes the given effect layer from this scene.
  137958. * @param toRemove defines the effect layer to remove
  137959. * @returns the index of the removed effect layer
  137960. */
  137961. removeEffectLayer(toRemove: EffectLayer): number;
  137962. /**
  137963. * Adds the given effect layer to this scene
  137964. * @param newEffectLayer defines the effect layer to add
  137965. */
  137966. addEffectLayer(newEffectLayer: EffectLayer): void;
  137967. }
  137968. /**
  137969. * Defines the layer scene component responsible to manage any effect layers
  137970. * in a given scene.
  137971. */
  137972. export class EffectLayerSceneComponent implements ISceneSerializableComponent {
  137973. /**
  137974. * The component name helpfull to identify the component in the list of scene components.
  137975. */
  137976. readonly name: string;
  137977. /**
  137978. * The scene the component belongs to.
  137979. */
  137980. scene: Scene;
  137981. private _engine;
  137982. private _renderEffects;
  137983. private _needStencil;
  137984. private _previousStencilState;
  137985. /**
  137986. * Creates a new instance of the component for the given scene
  137987. * @param scene Defines the scene to register the component in
  137988. */
  137989. constructor(scene: Scene);
  137990. /**
  137991. * Registers the component in a given scene
  137992. */
  137993. register(): void;
  137994. /**
  137995. * Rebuilds the elements related to this component in case of
  137996. * context lost for instance.
  137997. */
  137998. rebuild(): void;
  137999. /**
  138000. * Serializes the component data to the specified json object
  138001. * @param serializationObject The object to serialize to
  138002. */
  138003. serialize(serializationObject: any): void;
  138004. /**
  138005. * Adds all the elements from the container to the scene
  138006. * @param container the container holding the elements
  138007. */
  138008. addFromContainer(container: AbstractScene): void;
  138009. /**
  138010. * Removes all the elements in the container from the scene
  138011. * @param container contains the elements to remove
  138012. * @param dispose if the removed element should be disposed (default: false)
  138013. */
  138014. removeFromContainer(container: AbstractScene, dispose?: boolean): void;
  138015. /**
  138016. * Disposes the component and the associated ressources.
  138017. */
  138018. dispose(): void;
  138019. private _isReadyForMesh;
  138020. private _renderMainTexture;
  138021. private _setStencil;
  138022. private _setStencilBack;
  138023. private _draw;
  138024. private _drawCamera;
  138025. private _drawRenderingGroup;
  138026. }
  138027. }
  138028. declare module BABYLON {
  138029. /** @hidden */
  138030. export var glowMapMergePixelShader: {
  138031. name: string;
  138032. shader: string;
  138033. };
  138034. }
  138035. declare module BABYLON {
  138036. /** @hidden */
  138037. export var glowMapMergeVertexShader: {
  138038. name: string;
  138039. shader: string;
  138040. };
  138041. }
  138042. declare module BABYLON {
  138043. interface AbstractScene {
  138044. /**
  138045. * Return a the first highlight layer of the scene with a given name.
  138046. * @param name The name of the highlight layer to look for.
  138047. * @return The highlight layer if found otherwise null.
  138048. */
  138049. getGlowLayerByName(name: string): Nullable<GlowLayer>;
  138050. }
  138051. /**
  138052. * Glow layer options. This helps customizing the behaviour
  138053. * of the glow layer.
  138054. */
  138055. export interface IGlowLayerOptions {
  138056. /**
  138057. * Multiplication factor apply to the canvas size to compute the render target size
  138058. * used to generated the glowing objects (the smaller the faster).
  138059. */
  138060. mainTextureRatio: number;
  138061. /**
  138062. * Enforces a fixed size texture to ensure resize independant blur.
  138063. */
  138064. mainTextureFixedSize?: number;
  138065. /**
  138066. * How big is the kernel of the blur texture.
  138067. */
  138068. blurKernelSize: number;
  138069. /**
  138070. * The camera attached to the layer.
  138071. */
  138072. camera: Nullable<Camera>;
  138073. /**
  138074. * Enable MSAA by chosing the number of samples.
  138075. */
  138076. mainTextureSamples?: number;
  138077. /**
  138078. * The rendering group to draw the layer in.
  138079. */
  138080. renderingGroupId: number;
  138081. }
  138082. /**
  138083. * The glow layer Helps adding a glow effect around the emissive parts of a mesh.
  138084. *
  138085. * Once instantiated in a scene, by default, all the emissive meshes will glow.
  138086. *
  138087. * Documentation: https://doc.babylonjs.com/how_to/glow_layer
  138088. */
  138089. export class GlowLayer extends EffectLayer {
  138090. /**
  138091. * Effect Name of the layer.
  138092. */
  138093. static readonly EffectName: string;
  138094. /**
  138095. * The default blur kernel size used for the glow.
  138096. */
  138097. static DefaultBlurKernelSize: number;
  138098. /**
  138099. * The default texture size ratio used for the glow.
  138100. */
  138101. static DefaultTextureRatio: number;
  138102. /**
  138103. * Sets the kernel size of the blur.
  138104. */
  138105. set blurKernelSize(value: number);
  138106. /**
  138107. * Gets the kernel size of the blur.
  138108. */
  138109. get blurKernelSize(): number;
  138110. /**
  138111. * Sets the glow intensity.
  138112. */
  138113. set intensity(value: number);
  138114. /**
  138115. * Gets the glow intensity.
  138116. */
  138117. get intensity(): number;
  138118. private _options;
  138119. private _intensity;
  138120. private _horizontalBlurPostprocess1;
  138121. private _verticalBlurPostprocess1;
  138122. private _horizontalBlurPostprocess2;
  138123. private _verticalBlurPostprocess2;
  138124. private _blurTexture1;
  138125. private _blurTexture2;
  138126. private _postProcesses1;
  138127. private _postProcesses2;
  138128. private _includedOnlyMeshes;
  138129. private _excludedMeshes;
  138130. private _meshesUsingTheirOwnMaterials;
  138131. /**
  138132. * Callback used to let the user override the color selection on a per mesh basis
  138133. */
  138134. customEmissiveColorSelector: (mesh: Mesh, subMesh: SubMesh, material: Material, result: Color4) => void;
  138135. /**
  138136. * Callback used to let the user override the texture selection on a per mesh basis
  138137. */
  138138. customEmissiveTextureSelector: (mesh: Mesh, subMesh: SubMesh, material: Material) => Texture;
  138139. /**
  138140. * Instantiates a new glow Layer and references it to the scene.
  138141. * @param name The name of the layer
  138142. * @param scene The scene to use the layer in
  138143. * @param options Sets of none mandatory options to use with the layer (see IGlowLayerOptions for more information)
  138144. */
  138145. constructor(name: string, scene: Scene, options?: Partial<IGlowLayerOptions>);
  138146. /**
  138147. * Get the effect name of the layer.
  138148. * @return The effect name
  138149. */
  138150. getEffectName(): string;
  138151. /**
  138152. * Create the merge effect. This is the shader use to blit the information back
  138153. * to the main canvas at the end of the scene rendering.
  138154. */
  138155. protected _createMergeEffect(): Effect;
  138156. /**
  138157. * Creates the render target textures and post processes used in the glow layer.
  138158. */
  138159. protected _createTextureAndPostProcesses(): void;
  138160. /**
  138161. * Checks for the readiness of the element composing the layer.
  138162. * @param subMesh the mesh to check for
  138163. * @param useInstances specify wether or not to use instances to render the mesh
  138164. * @param emissiveTexture the associated emissive texture used to generate the glow
  138165. * @return true if ready otherwise, false
  138166. */
  138167. isReady(subMesh: SubMesh, useInstances: boolean): boolean;
  138168. /**
  138169. * Returns whether or nood the layer needs stencil enabled during the mesh rendering.
  138170. */
  138171. needStencil(): boolean;
  138172. /**
  138173. * Returns true if the mesh can be rendered, otherwise false.
  138174. * @param mesh The mesh to render
  138175. * @param material The material used on the mesh
  138176. * @returns true if it can be rendered otherwise false
  138177. */
  138178. protected _canRenderMesh(mesh: AbstractMesh, material: Material): boolean;
  138179. /**
  138180. * Implementation specific of rendering the generating effect on the main canvas.
  138181. * @param effect The effect used to render through
  138182. */
  138183. protected _internalRender(effect: Effect): void;
  138184. /**
  138185. * Sets the required values for both the emissive texture and and the main color.
  138186. */
  138187. protected _setEmissiveTextureAndColor(mesh: Mesh, subMesh: SubMesh, material: Material): void;
  138188. /**
  138189. * Returns true if the mesh should render, otherwise false.
  138190. * @param mesh The mesh to render
  138191. * @returns true if it should render otherwise false
  138192. */
  138193. protected _shouldRenderMesh(mesh: Mesh): boolean;
  138194. /**
  138195. * Adds specific effects defines.
  138196. * @param defines The defines to add specifics to.
  138197. */
  138198. protected _addCustomEffectDefines(defines: string[]): void;
  138199. /**
  138200. * Add a mesh in the exclusion list to prevent it to impact or being impacted by the glow layer.
  138201. * @param mesh The mesh to exclude from the glow layer
  138202. */
  138203. addExcludedMesh(mesh: Mesh): void;
  138204. /**
  138205. * Remove a mesh from the exclusion list to let it impact or being impacted by the glow layer.
  138206. * @param mesh The mesh to remove
  138207. */
  138208. removeExcludedMesh(mesh: Mesh): void;
  138209. /**
  138210. * Add a mesh in the inclusion list to impact or being impacted by the glow layer.
  138211. * @param mesh The mesh to include in the glow layer
  138212. */
  138213. addIncludedOnlyMesh(mesh: Mesh): void;
  138214. /**
  138215. * Remove a mesh from the Inclusion list to prevent it to impact or being impacted by the glow layer.
  138216. * @param mesh The mesh to remove
  138217. */
  138218. removeIncludedOnlyMesh(mesh: Mesh): void;
  138219. /**
  138220. * Determine if a given mesh will be used in the glow layer
  138221. * @param mesh The mesh to test
  138222. * @returns true if the mesh will be highlighted by the current glow layer
  138223. */
  138224. hasMesh(mesh: AbstractMesh): boolean;
  138225. /**
  138226. * Defines whether the current material of the mesh should be use to render the effect.
  138227. * @param mesh defines the current mesh to render
  138228. */
  138229. protected _useMeshMaterial(mesh: AbstractMesh): boolean;
  138230. /**
  138231. * Add a mesh to be rendered through its own material and not with emissive only.
  138232. * @param mesh The mesh for which we need to use its material
  138233. */
  138234. referenceMeshToUseItsOwnMaterial(mesh: AbstractMesh): void;
  138235. /**
  138236. * Remove a mesh from being rendered through its own material and not with emissive only.
  138237. * @param mesh The mesh for which we need to not use its material
  138238. */
  138239. unReferenceMeshFromUsingItsOwnMaterial(mesh: AbstractMesh): void;
  138240. /**
  138241. * Free any resources and references associated to a mesh.
  138242. * Internal use
  138243. * @param mesh The mesh to free.
  138244. * @hidden
  138245. */
  138246. _disposeMesh(mesh: Mesh): void;
  138247. /**
  138248. * Gets the class name of the effect layer
  138249. * @returns the string with the class name of the effect layer
  138250. */
  138251. getClassName(): string;
  138252. /**
  138253. * Serializes this glow layer
  138254. * @returns a serialized glow layer object
  138255. */
  138256. serialize(): any;
  138257. /**
  138258. * Creates a Glow Layer from parsed glow layer data
  138259. * @param parsedGlowLayer defines glow layer data
  138260. * @param scene defines the current scene
  138261. * @param rootUrl defines the root URL containing the glow layer information
  138262. * @returns a parsed Glow Layer
  138263. */
  138264. static Parse(parsedGlowLayer: any, scene: Scene, rootUrl: string): GlowLayer;
  138265. }
  138266. }
  138267. declare module BABYLON {
  138268. /** @hidden */
  138269. export var glowBlurPostProcessPixelShader: {
  138270. name: string;
  138271. shader: string;
  138272. };
  138273. }
  138274. declare module BABYLON {
  138275. interface AbstractScene {
  138276. /**
  138277. * Return a the first highlight layer of the scene with a given name.
  138278. * @param name The name of the highlight layer to look for.
  138279. * @return The highlight layer if found otherwise null.
  138280. */
  138281. getHighlightLayerByName(name: string): Nullable<HighlightLayer>;
  138282. }
  138283. /**
  138284. * Highlight layer options. This helps customizing the behaviour
  138285. * of the highlight layer.
  138286. */
  138287. export interface IHighlightLayerOptions {
  138288. /**
  138289. * Multiplication factor apply to the canvas size to compute the render target size
  138290. * used to generated the glowing objects (the smaller the faster).
  138291. */
  138292. mainTextureRatio: number;
  138293. /**
  138294. * Enforces a fixed size texture to ensure resize independant blur.
  138295. */
  138296. mainTextureFixedSize?: number;
  138297. /**
  138298. * Multiplication factor apply to the main texture size in the first step of the blur to reduce the size
  138299. * of the picture to blur (the smaller the faster).
  138300. */
  138301. blurTextureSizeRatio: number;
  138302. /**
  138303. * How big in texel of the blur texture is the vertical blur.
  138304. */
  138305. blurVerticalSize: number;
  138306. /**
  138307. * How big in texel of the blur texture is the horizontal blur.
  138308. */
  138309. blurHorizontalSize: number;
  138310. /**
  138311. * Alpha blending mode used to apply the blur. Default is combine.
  138312. */
  138313. alphaBlendingMode: number;
  138314. /**
  138315. * The camera attached to the layer.
  138316. */
  138317. camera: Nullable<Camera>;
  138318. /**
  138319. * Should we display highlight as a solid stroke?
  138320. */
  138321. isStroke?: boolean;
  138322. /**
  138323. * The rendering group to draw the layer in.
  138324. */
  138325. renderingGroupId: number;
  138326. }
  138327. /**
  138328. * The highlight layer Helps adding a glow effect around a mesh.
  138329. *
  138330. * Once instantiated in a scene, simply use the addMesh or removeMesh method to add or remove
  138331. * glowy meshes to your scene.
  138332. *
  138333. * !!! THIS REQUIRES AN ACTIVE STENCIL BUFFER ON THE CANVAS !!!
  138334. */
  138335. export class HighlightLayer extends EffectLayer {
  138336. name: string;
  138337. /**
  138338. * Effect Name of the highlight layer.
  138339. */
  138340. static readonly EffectName: string;
  138341. /**
  138342. * The neutral color used during the preparation of the glow effect.
  138343. * This is black by default as the blend operation is a blend operation.
  138344. */
  138345. static NeutralColor: Color4;
  138346. /**
  138347. * Stencil value used for glowing meshes.
  138348. */
  138349. static GlowingMeshStencilReference: number;
  138350. /**
  138351. * Stencil value used for the other meshes in the scene.
  138352. */
  138353. static NormalMeshStencilReference: number;
  138354. /**
  138355. * Specifies whether or not the inner glow is ACTIVE in the layer.
  138356. */
  138357. innerGlow: boolean;
  138358. /**
  138359. * Specifies whether or not the outer glow is ACTIVE in the layer.
  138360. */
  138361. outerGlow: boolean;
  138362. /**
  138363. * Specifies the horizontal size of the blur.
  138364. */
  138365. set blurHorizontalSize(value: number);
  138366. /**
  138367. * Specifies the vertical size of the blur.
  138368. */
  138369. set blurVerticalSize(value: number);
  138370. /**
  138371. * Gets the horizontal size of the blur.
  138372. */
  138373. get blurHorizontalSize(): number;
  138374. /**
  138375. * Gets the vertical size of the blur.
  138376. */
  138377. get blurVerticalSize(): number;
  138378. /**
  138379. * An event triggered when the highlight layer is being blurred.
  138380. */
  138381. onBeforeBlurObservable: Observable<HighlightLayer>;
  138382. /**
  138383. * An event triggered when the highlight layer has been blurred.
  138384. */
  138385. onAfterBlurObservable: Observable<HighlightLayer>;
  138386. private _instanceGlowingMeshStencilReference;
  138387. private _options;
  138388. private _downSamplePostprocess;
  138389. private _horizontalBlurPostprocess;
  138390. private _verticalBlurPostprocess;
  138391. private _blurTexture;
  138392. private _meshes;
  138393. private _excludedMeshes;
  138394. /**
  138395. * Instantiates a new highlight Layer and references it to the scene..
  138396. * @param name The name of the layer
  138397. * @param scene The scene to use the layer in
  138398. * @param options Sets of none mandatory options to use with the layer (see IHighlightLayerOptions for more information)
  138399. */
  138400. constructor(name: string, scene: Scene, options?: Partial<IHighlightLayerOptions>);
  138401. /**
  138402. * Get the effect name of the layer.
  138403. * @return The effect name
  138404. */
  138405. getEffectName(): string;
  138406. /**
  138407. * Create the merge effect. This is the shader use to blit the information back
  138408. * to the main canvas at the end of the scene rendering.
  138409. */
  138410. protected _createMergeEffect(): Effect;
  138411. /**
  138412. * Creates the render target textures and post processes used in the highlight layer.
  138413. */
  138414. protected _createTextureAndPostProcesses(): void;
  138415. /**
  138416. * Returns wether or nood the layer needs stencil enabled during the mesh rendering.
  138417. */
  138418. needStencil(): boolean;
  138419. /**
  138420. * Checks for the readiness of the element composing the layer.
  138421. * @param subMesh the mesh to check for
  138422. * @param useInstances specify wether or not to use instances to render the mesh
  138423. * @param emissiveTexture the associated emissive texture used to generate the glow
  138424. * @return true if ready otherwise, false
  138425. */
  138426. isReady(subMesh: SubMesh, useInstances: boolean): boolean;
  138427. /**
  138428. * Implementation specific of rendering the generating effect on the main canvas.
  138429. * @param effect The effect used to render through
  138430. */
  138431. protected _internalRender(effect: Effect): void;
  138432. /**
  138433. * Returns true if the layer contains information to display, otherwise false.
  138434. */
  138435. shouldRender(): boolean;
  138436. /**
  138437. * Returns true if the mesh should render, otherwise false.
  138438. * @param mesh The mesh to render
  138439. * @returns true if it should render otherwise false
  138440. */
  138441. protected _shouldRenderMesh(mesh: Mesh): boolean;
  138442. /**
  138443. * Returns true if the mesh can be rendered, otherwise false.
  138444. * @param mesh The mesh to render
  138445. * @param material The material used on the mesh
  138446. * @returns true if it can be rendered otherwise false
  138447. */
  138448. protected _canRenderMesh(mesh: AbstractMesh, material: Material): boolean;
  138449. /**
  138450. * Adds specific effects defines.
  138451. * @param defines The defines to add specifics to.
  138452. */
  138453. protected _addCustomEffectDefines(defines: string[]): void;
  138454. /**
  138455. * Sets the required values for both the emissive texture and and the main color.
  138456. */
  138457. protected _setEmissiveTextureAndColor(mesh: Mesh, subMesh: SubMesh, material: Material): void;
  138458. /**
  138459. * Add a mesh in the exclusion list to prevent it to impact or being impacted by the highlight layer.
  138460. * @param mesh The mesh to exclude from the highlight layer
  138461. */
  138462. addExcludedMesh(mesh: Mesh): void;
  138463. /**
  138464. * Remove a mesh from the exclusion list to let it impact or being impacted by the highlight layer.
  138465. * @param mesh The mesh to highlight
  138466. */
  138467. removeExcludedMesh(mesh: Mesh): void;
  138468. /**
  138469. * Determine if a given mesh will be highlighted by the current HighlightLayer
  138470. * @param mesh mesh to test
  138471. * @returns true if the mesh will be highlighted by the current HighlightLayer
  138472. */
  138473. hasMesh(mesh: AbstractMesh): boolean;
  138474. /**
  138475. * Add a mesh in the highlight layer in order to make it glow with the chosen color.
  138476. * @param mesh The mesh to highlight
  138477. * @param color The color of the highlight
  138478. * @param glowEmissiveOnly Extract the glow from the emissive texture
  138479. */
  138480. addMesh(mesh: Mesh, color: Color3, glowEmissiveOnly?: boolean): void;
  138481. /**
  138482. * Remove a mesh from the highlight layer in order to make it stop glowing.
  138483. * @param mesh The mesh to highlight
  138484. */
  138485. removeMesh(mesh: Mesh): void;
  138486. /**
  138487. * Remove all the meshes currently referenced in the highlight layer
  138488. */
  138489. removeAllMeshes(): void;
  138490. /**
  138491. * Force the stencil to the normal expected value for none glowing parts
  138492. */
  138493. private _defaultStencilReference;
  138494. /**
  138495. * Free any resources and references associated to a mesh.
  138496. * Internal use
  138497. * @param mesh The mesh to free.
  138498. * @hidden
  138499. */
  138500. _disposeMesh(mesh: Mesh): void;
  138501. /**
  138502. * Dispose the highlight layer and free resources.
  138503. */
  138504. dispose(): void;
  138505. /**
  138506. * Gets the class name of the effect layer
  138507. * @returns the string with the class name of the effect layer
  138508. */
  138509. getClassName(): string;
  138510. /**
  138511. * Serializes this Highlight layer
  138512. * @returns a serialized Highlight layer object
  138513. */
  138514. serialize(): any;
  138515. /**
  138516. * Creates a Highlight layer from parsed Highlight layer data
  138517. * @param parsedHightlightLayer defines the Highlight layer data
  138518. * @param scene defines the current scene
  138519. * @param rootUrl defines the root URL containing the Highlight layer information
  138520. * @returns a parsed Highlight layer
  138521. */
  138522. static Parse(parsedHightlightLayer: any, scene: Scene, rootUrl: string): HighlightLayer;
  138523. }
  138524. }
  138525. declare module BABYLON {
  138526. interface AbstractScene {
  138527. /**
  138528. * The list of layers (background and foreground) of the scene
  138529. */
  138530. layers: Array<Layer>;
  138531. }
  138532. /**
  138533. * Defines the layer scene component responsible to manage any layers
  138534. * in a given scene.
  138535. */
  138536. export class LayerSceneComponent implements ISceneComponent {
  138537. /**
  138538. * The component name helpfull to identify the component in the list of scene components.
  138539. */
  138540. readonly name: string;
  138541. /**
  138542. * The scene the component belongs to.
  138543. */
  138544. scene: Scene;
  138545. private _engine;
  138546. /**
  138547. * Creates a new instance of the component for the given scene
  138548. * @param scene Defines the scene to register the component in
  138549. */
  138550. constructor(scene: Scene);
  138551. /**
  138552. * Registers the component in a given scene
  138553. */
  138554. register(): void;
  138555. /**
  138556. * Rebuilds the elements related to this component in case of
  138557. * context lost for instance.
  138558. */
  138559. rebuild(): void;
  138560. /**
  138561. * Disposes the component and the associated ressources.
  138562. */
  138563. dispose(): void;
  138564. private _draw;
  138565. private _drawCameraPredicate;
  138566. private _drawCameraBackground;
  138567. private _drawCameraForeground;
  138568. private _drawRenderTargetPredicate;
  138569. private _drawRenderTargetBackground;
  138570. private _drawRenderTargetForeground;
  138571. /**
  138572. * Adds all the elements from the container to the scene
  138573. * @param container the container holding the elements
  138574. */
  138575. addFromContainer(container: AbstractScene): void;
  138576. /**
  138577. * Removes all the elements in the container from the scene
  138578. * @param container contains the elements to remove
  138579. * @param dispose if the removed element should be disposed (default: false)
  138580. */
  138581. removeFromContainer(container: AbstractScene, dispose?: boolean): void;
  138582. }
  138583. }
  138584. declare module BABYLON {
  138585. /** @hidden */
  138586. export var layerPixelShader: {
  138587. name: string;
  138588. shader: string;
  138589. };
  138590. }
  138591. declare module BABYLON {
  138592. /** @hidden */
  138593. export var layerVertexShader: {
  138594. name: string;
  138595. shader: string;
  138596. };
  138597. }
  138598. declare module BABYLON {
  138599. /**
  138600. * This represents a full screen 2d layer.
  138601. * This can be useful to display a picture in the background of your scene for instance.
  138602. * @see https://www.babylonjs-playground.com/#08A2BS#1
  138603. */
  138604. export class Layer {
  138605. /**
  138606. * Define the name of the layer.
  138607. */
  138608. name: string;
  138609. /**
  138610. * Define the texture the layer should display.
  138611. */
  138612. texture: Nullable<Texture>;
  138613. /**
  138614. * Is the layer in background or foreground.
  138615. */
  138616. isBackground: boolean;
  138617. /**
  138618. * Define the color of the layer (instead of texture).
  138619. */
  138620. color: Color4;
  138621. /**
  138622. * Define the scale of the layer in order to zoom in out of the texture.
  138623. */
  138624. scale: Vector2;
  138625. /**
  138626. * Define an offset for the layer in order to shift the texture.
  138627. */
  138628. offset: Vector2;
  138629. /**
  138630. * Define the alpha blending mode used in the layer in case the texture or color has an alpha.
  138631. */
  138632. alphaBlendingMode: number;
  138633. /**
  138634. * Define if the layer should alpha test or alpha blend with the rest of the scene.
  138635. * Alpha test will not mix with the background color in case of transparency.
  138636. * It will either use the texture color or the background depending on the alpha value of the current pixel.
  138637. */
  138638. alphaTest: boolean;
  138639. /**
  138640. * Define a mask to restrict the layer to only some of the scene cameras.
  138641. */
  138642. layerMask: number;
  138643. /**
  138644. * Define the list of render target the layer is visible into.
  138645. */
  138646. renderTargetTextures: RenderTargetTexture[];
  138647. /**
  138648. * Define if the layer is only used in renderTarget or if it also
  138649. * renders in the main frame buffer of the canvas.
  138650. */
  138651. renderOnlyInRenderTargetTextures: boolean;
  138652. private _scene;
  138653. private _vertexBuffers;
  138654. private _indexBuffer;
  138655. private _effect;
  138656. private _previousDefines;
  138657. /**
  138658. * An event triggered when the layer is disposed.
  138659. */
  138660. onDisposeObservable: Observable<Layer>;
  138661. private _onDisposeObserver;
  138662. /**
  138663. * Back compatibility with callback before the onDisposeObservable existed.
  138664. * The set callback will be triggered when the layer has been disposed.
  138665. */
  138666. set onDispose(callback: () => void);
  138667. /**
  138668. * An event triggered before rendering the scene
  138669. */
  138670. onBeforeRenderObservable: Observable<Layer>;
  138671. private _onBeforeRenderObserver;
  138672. /**
  138673. * Back compatibility with callback before the onBeforeRenderObservable existed.
  138674. * The set callback will be triggered just before rendering the layer.
  138675. */
  138676. set onBeforeRender(callback: () => void);
  138677. /**
  138678. * An event triggered after rendering the scene
  138679. */
  138680. onAfterRenderObservable: Observable<Layer>;
  138681. private _onAfterRenderObserver;
  138682. /**
  138683. * Back compatibility with callback before the onAfterRenderObservable existed.
  138684. * The set callback will be triggered just after rendering the layer.
  138685. */
  138686. set onAfterRender(callback: () => void);
  138687. /**
  138688. * Instantiates a new layer.
  138689. * This represents a full screen 2d layer.
  138690. * This can be useful to display a picture in the background of your scene for instance.
  138691. * @see https://www.babylonjs-playground.com/#08A2BS#1
  138692. * @param name Define the name of the layer in the scene
  138693. * @param imgUrl Define the url of the texture to display in the layer
  138694. * @param scene Define the scene the layer belongs to
  138695. * @param isBackground Defines whether the layer is displayed in front or behind the scene
  138696. * @param color Defines a color for the layer
  138697. */
  138698. constructor(
  138699. /**
  138700. * Define the name of the layer.
  138701. */
  138702. name: string, imgUrl: Nullable<string>, scene: Nullable<Scene>, isBackground?: boolean, color?: Color4);
  138703. private _createIndexBuffer;
  138704. /** @hidden */
  138705. _rebuild(): void;
  138706. /**
  138707. * Renders the layer in the scene.
  138708. */
  138709. render(): void;
  138710. /**
  138711. * Disposes and releases the associated ressources.
  138712. */
  138713. dispose(): void;
  138714. }
  138715. }
  138716. declare module BABYLON {
  138717. /** @hidden */
  138718. export var lensFlarePixelShader: {
  138719. name: string;
  138720. shader: string;
  138721. };
  138722. }
  138723. declare module BABYLON {
  138724. /** @hidden */
  138725. export var lensFlareVertexShader: {
  138726. name: string;
  138727. shader: string;
  138728. };
  138729. }
  138730. declare module BABYLON {
  138731. /**
  138732. * This represents a Lens Flare System or the shiny effect created by the light reflection on the camera lenses.
  138733. * It is usually composed of several `lensFlare`.
  138734. * @see https://doc.babylonjs.com/how_to/how_to_use_lens_flares
  138735. */
  138736. export class LensFlareSystem {
  138737. /**
  138738. * Define the name of the lens flare system
  138739. */
  138740. name: string;
  138741. /**
  138742. * List of lens flares used in this system.
  138743. */
  138744. lensFlares: LensFlare[];
  138745. /**
  138746. * Define a limit from the border the lens flare can be visible.
  138747. */
  138748. borderLimit: number;
  138749. /**
  138750. * Define a viewport border we do not want to see the lens flare in.
  138751. */
  138752. viewportBorder: number;
  138753. /**
  138754. * Define a predicate which could limit the list of meshes able to occlude the effect.
  138755. */
  138756. meshesSelectionPredicate: (mesh: AbstractMesh) => boolean;
  138757. /**
  138758. * Restricts the rendering of the effect to only the camera rendering this layer mask.
  138759. */
  138760. layerMask: number;
  138761. /**
  138762. * Define the id of the lens flare system in the scene.
  138763. * (equal to name by default)
  138764. */
  138765. id: string;
  138766. private _scene;
  138767. private _emitter;
  138768. private _vertexBuffers;
  138769. private _indexBuffer;
  138770. private _effect;
  138771. private _positionX;
  138772. private _positionY;
  138773. private _isEnabled;
  138774. /** @hidden */
  138775. static _SceneComponentInitialization: (scene: Scene) => void;
  138776. /**
  138777. * Instantiates a lens flare system.
  138778. * This represents a Lens Flare System or the shiny effect created by the light reflection on the camera lenses.
  138779. * It is usually composed of several `lensFlare`.
  138780. * @see https://doc.babylonjs.com/how_to/how_to_use_lens_flares
  138781. * @param name Define the name of the lens flare system in the scene
  138782. * @param emitter Define the source (the emitter) of the lens flares (it can be a camera, a light or a mesh).
  138783. * @param scene Define the scene the lens flare system belongs to
  138784. */
  138785. constructor(
  138786. /**
  138787. * Define the name of the lens flare system
  138788. */
  138789. name: string, emitter: any, scene: Scene);
  138790. /**
  138791. * Define if the lens flare system is enabled.
  138792. */
  138793. get isEnabled(): boolean;
  138794. set isEnabled(value: boolean);
  138795. /**
  138796. * Get the scene the effects belongs to.
  138797. * @returns the scene holding the lens flare system
  138798. */
  138799. getScene(): Scene;
  138800. /**
  138801. * Get the emitter of the lens flare system.
  138802. * It defines the source of the lens flares (it can be a camera, a light or a mesh).
  138803. * @returns the emitter of the lens flare system
  138804. */
  138805. getEmitter(): any;
  138806. /**
  138807. * Set the emitter of the lens flare system.
  138808. * It defines the source of the lens flares (it can be a camera, a light or a mesh).
  138809. * @param newEmitter Define the new emitter of the system
  138810. */
  138811. setEmitter(newEmitter: any): void;
  138812. /**
  138813. * Get the lens flare system emitter position.
  138814. * The emitter defines the source of the lens flares (it can be a camera, a light or a mesh).
  138815. * @returns the position
  138816. */
  138817. getEmitterPosition(): Vector3;
  138818. /**
  138819. * @hidden
  138820. */
  138821. computeEffectivePosition(globalViewport: Viewport): boolean;
  138822. /** @hidden */
  138823. _isVisible(): boolean;
  138824. /**
  138825. * @hidden
  138826. */
  138827. render(): boolean;
  138828. /**
  138829. * Dispose and release the lens flare with its associated resources.
  138830. */
  138831. dispose(): void;
  138832. /**
  138833. * Parse a lens flare system from a JSON repressentation
  138834. * @param parsedLensFlareSystem Define the JSON to parse
  138835. * @param scene Define the scene the parsed system should be instantiated in
  138836. * @param rootUrl Define the rootUrl of the load sequence to easily find a load relative dependencies such as textures
  138837. * @returns the parsed system
  138838. */
  138839. static Parse(parsedLensFlareSystem: any, scene: Scene, rootUrl: string): LensFlareSystem;
  138840. /**
  138841. * Serialize the current Lens Flare System into a JSON representation.
  138842. * @returns the serialized JSON
  138843. */
  138844. serialize(): any;
  138845. }
  138846. }
  138847. declare module BABYLON {
  138848. /**
  138849. * This represents one of the lens effect in a `lensFlareSystem`.
  138850. * It controls one of the indiviual texture used in the effect.
  138851. * @see https://doc.babylonjs.com/how_to/how_to_use_lens_flares
  138852. */
  138853. export class LensFlare {
  138854. /**
  138855. * Define the size of the lens flare in the system (a floating value between 0 and 1)
  138856. */
  138857. size: number;
  138858. /**
  138859. * 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.
  138860. */
  138861. position: number;
  138862. /**
  138863. * Define the lens color.
  138864. */
  138865. color: Color3;
  138866. /**
  138867. * Define the lens texture.
  138868. */
  138869. texture: Nullable<Texture>;
  138870. /**
  138871. * Define the alpha mode to render this particular lens.
  138872. */
  138873. alphaMode: number;
  138874. private _system;
  138875. /**
  138876. * Creates a new Lens Flare.
  138877. * This represents one of the lens effect in a `lensFlareSystem`.
  138878. * It controls one of the indiviual texture used in the effect.
  138879. * @see https://doc.babylonjs.com/how_to/how_to_use_lens_flares
  138880. * @param size Define the size of the lens flare (a floating value between 0 and 1)
  138881. * @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.
  138882. * @param color Define the lens color
  138883. * @param imgUrl Define the lens texture url
  138884. * @param system Define the `lensFlareSystem` this flare is part of
  138885. * @returns The newly created Lens Flare
  138886. */
  138887. static AddFlare(size: number, position: number, color: Color3, imgUrl: string, system: LensFlareSystem): LensFlare;
  138888. /**
  138889. * Instantiates a new Lens Flare.
  138890. * This represents one of the lens effect in a `lensFlareSystem`.
  138891. * It controls one of the indiviual texture used in the effect.
  138892. * @see https://doc.babylonjs.com/how_to/how_to_use_lens_flares
  138893. * @param size Define the size of the lens flare in the system (a floating value between 0 and 1)
  138894. * @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.
  138895. * @param color Define the lens color
  138896. * @param imgUrl Define the lens texture url
  138897. * @param system Define the `lensFlareSystem` this flare is part of
  138898. */
  138899. constructor(
  138900. /**
  138901. * Define the size of the lens flare in the system (a floating value between 0 and 1)
  138902. */
  138903. size: number,
  138904. /**
  138905. * 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.
  138906. */
  138907. position: number, color: Color3, imgUrl: string, system: LensFlareSystem);
  138908. /**
  138909. * Dispose and release the lens flare with its associated resources.
  138910. */
  138911. dispose(): void;
  138912. }
  138913. }
  138914. declare module BABYLON {
  138915. interface AbstractScene {
  138916. /**
  138917. * The list of lens flare system added to the scene
  138918. * @see https://doc.babylonjs.com/how_to/how_to_use_lens_flares
  138919. */
  138920. lensFlareSystems: Array<LensFlareSystem>;
  138921. /**
  138922. * Removes the given lens flare system from this scene.
  138923. * @param toRemove The lens flare system to remove
  138924. * @returns The index of the removed lens flare system
  138925. */
  138926. removeLensFlareSystem(toRemove: LensFlareSystem): number;
  138927. /**
  138928. * Adds the given lens flare system to this scene
  138929. * @param newLensFlareSystem The lens flare system to add
  138930. */
  138931. addLensFlareSystem(newLensFlareSystem: LensFlareSystem): void;
  138932. /**
  138933. * Gets a lens flare system using its name
  138934. * @param name defines the name to look for
  138935. * @returns the lens flare system or null if not found
  138936. */
  138937. getLensFlareSystemByName(name: string): Nullable<LensFlareSystem>;
  138938. /**
  138939. * Gets a lens flare system using its id
  138940. * @param id defines the id to look for
  138941. * @returns the lens flare system or null if not found
  138942. */
  138943. getLensFlareSystemByID(id: string): Nullable<LensFlareSystem>;
  138944. }
  138945. /**
  138946. * Defines the lens flare scene component responsible to manage any lens flares
  138947. * in a given scene.
  138948. */
  138949. export class LensFlareSystemSceneComponent implements ISceneSerializableComponent {
  138950. /**
  138951. * The component name helpfull to identify the component in the list of scene components.
  138952. */
  138953. readonly name: string;
  138954. /**
  138955. * The scene the component belongs to.
  138956. */
  138957. scene: Scene;
  138958. /**
  138959. * Creates a new instance of the component for the given scene
  138960. * @param scene Defines the scene to register the component in
  138961. */
  138962. constructor(scene: Scene);
  138963. /**
  138964. * Registers the component in a given scene
  138965. */
  138966. register(): void;
  138967. /**
  138968. * Rebuilds the elements related to this component in case of
  138969. * context lost for instance.
  138970. */
  138971. rebuild(): void;
  138972. /**
  138973. * Adds all the elements from the container to the scene
  138974. * @param container the container holding the elements
  138975. */
  138976. addFromContainer(container: AbstractScene): void;
  138977. /**
  138978. * Removes all the elements in the container from the scene
  138979. * @param container contains the elements to remove
  138980. * @param dispose if the removed element should be disposed (default: false)
  138981. */
  138982. removeFromContainer(container: AbstractScene, dispose?: boolean): void;
  138983. /**
  138984. * Serializes the component data to the specified json object
  138985. * @param serializationObject The object to serialize to
  138986. */
  138987. serialize(serializationObject: any): void;
  138988. /**
  138989. * Disposes the component and the associated ressources.
  138990. */
  138991. dispose(): void;
  138992. private _draw;
  138993. }
  138994. }
  138995. declare module BABYLON {
  138996. /** @hidden */
  138997. export var depthPixelShader: {
  138998. name: string;
  138999. shader: string;
  139000. };
  139001. }
  139002. declare module BABYLON {
  139003. /** @hidden */
  139004. export var depthVertexShader: {
  139005. name: string;
  139006. shader: string;
  139007. };
  139008. }
  139009. declare module BABYLON {
  139010. /**
  139011. * This represents a depth renderer in Babylon.
  139012. * A depth renderer will render to it's depth map every frame which can be displayed or used in post processing
  139013. */
  139014. export class DepthRenderer {
  139015. private _scene;
  139016. private _depthMap;
  139017. private _effect;
  139018. private readonly _storeNonLinearDepth;
  139019. private readonly _clearColor;
  139020. /** Get if the depth renderer is using packed depth or not */
  139021. readonly isPacked: boolean;
  139022. private _cachedDefines;
  139023. private _camera;
  139024. /** Enable or disable the depth renderer. When disabled, the depth texture is not updated */
  139025. enabled: boolean;
  139026. /**
  139027. * Specifiess that the depth renderer will only be used within
  139028. * the camera it is created for.
  139029. * This can help forcing its rendering during the camera processing.
  139030. */
  139031. useOnlyInActiveCamera: boolean;
  139032. /** @hidden */
  139033. static _SceneComponentInitialization: (scene: Scene) => void;
  139034. /**
  139035. * Instantiates a depth renderer
  139036. * @param scene The scene the renderer belongs to
  139037. * @param type The texture type of the depth map (default: Engine.TEXTURETYPE_FLOAT)
  139038. * @param camera The camera to be used to render the depth map (default: scene's active camera)
  139039. * @param storeNonLinearDepth Defines whether the depth is stored linearly like in Babylon Shadows or directly like glFragCoord.z
  139040. */
  139041. constructor(scene: Scene, type?: number, camera?: Nullable<Camera>, storeNonLinearDepth?: boolean);
  139042. /**
  139043. * Creates the depth rendering effect and checks if the effect is ready.
  139044. * @param subMesh The submesh to be used to render the depth map of
  139045. * @param useInstances If multiple world instances should be used
  139046. * @returns if the depth renderer is ready to render the depth map
  139047. */
  139048. isReady(subMesh: SubMesh, useInstances: boolean): boolean;
  139049. /**
  139050. * Gets the texture which the depth map will be written to.
  139051. * @returns The depth map texture
  139052. */
  139053. getDepthMap(): RenderTargetTexture;
  139054. /**
  139055. * Disposes of the depth renderer.
  139056. */
  139057. dispose(): void;
  139058. }
  139059. }
  139060. declare module BABYLON {
  139061. /** @hidden */
  139062. export var minmaxReduxPixelShader: {
  139063. name: string;
  139064. shader: string;
  139065. };
  139066. }
  139067. declare module BABYLON {
  139068. /**
  139069. * This class computes a min/max reduction from a texture: it means it computes the minimum
  139070. * and maximum values from all values of the texture.
  139071. * It is performed on the GPU for better performances, thanks to a succession of post processes.
  139072. * The source values are read from the red channel of the texture.
  139073. */
  139074. export class MinMaxReducer {
  139075. /**
  139076. * Observable triggered when the computation has been performed
  139077. */
  139078. onAfterReductionPerformed: Observable<{
  139079. min: number;
  139080. max: number;
  139081. }>;
  139082. protected _camera: Camera;
  139083. protected _sourceTexture: Nullable<RenderTargetTexture>;
  139084. protected _reductionSteps: Nullable<Array<PostProcess>>;
  139085. protected _postProcessManager: PostProcessManager;
  139086. protected _onAfterUnbindObserver: Nullable<Observer<RenderTargetTexture>>;
  139087. protected _forceFullscreenViewport: boolean;
  139088. /**
  139089. * Creates a min/max reducer
  139090. * @param camera The camera to use for the post processes
  139091. */
  139092. constructor(camera: Camera);
  139093. /**
  139094. * Gets the texture used to read the values from.
  139095. */
  139096. get sourceTexture(): Nullable<RenderTargetTexture>;
  139097. /**
  139098. * Sets the source texture to read the values from.
  139099. * One must indicate if the texture is a depth texture or not through the depthRedux parameter
  139100. * because in such textures '1' value must not be taken into account to compute the maximum
  139101. * as this value is used to clear the texture.
  139102. * Note that the computation is not activated by calling this function, you must call activate() for that!
  139103. * @param sourceTexture The texture to read the values from. The values should be in the red channel.
  139104. * @param depthRedux Indicates if the texture is a depth texture or not
  139105. * @param type The type of the textures created for the reduction (defaults to TEXTURETYPE_HALF_FLOAT)
  139106. * @param forceFullscreenViewport Forces the post processes used for the reduction to be applied without taking into account viewport (defaults to true)
  139107. */
  139108. setSourceTexture(sourceTexture: RenderTargetTexture, depthRedux: boolean, type?: number, forceFullscreenViewport?: boolean): void;
  139109. /**
  139110. * Defines the refresh rate of the computation.
  139111. * Use 0 to compute just once, 1 to compute on every frame, 2 to compute every two frames and so on...
  139112. */
  139113. get refreshRate(): number;
  139114. set refreshRate(value: number);
  139115. protected _activated: boolean;
  139116. /**
  139117. * Gets the activation status of the reducer
  139118. */
  139119. get activated(): boolean;
  139120. /**
  139121. * Activates the reduction computation.
  139122. * When activated, the observers registered in onAfterReductionPerformed are
  139123. * called after the compuation is performed
  139124. */
  139125. activate(): void;
  139126. /**
  139127. * Deactivates the reduction computation.
  139128. */
  139129. deactivate(): void;
  139130. /**
  139131. * Disposes the min/max reducer
  139132. * @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.
  139133. */
  139134. dispose(disposeAll?: boolean): void;
  139135. }
  139136. }
  139137. declare module BABYLON {
  139138. /**
  139139. * This class is a small wrapper around the MinMaxReducer class to compute the min/max values of a depth texture
  139140. */
  139141. export class DepthReducer extends MinMaxReducer {
  139142. private _depthRenderer;
  139143. private _depthRendererId;
  139144. /**
  139145. * Gets the depth renderer used for the computation.
  139146. * Note that the result is null if you provide your own renderer when calling setDepthRenderer.
  139147. */
  139148. get depthRenderer(): Nullable<DepthRenderer>;
  139149. /**
  139150. * Creates a depth reducer
  139151. * @param camera The camera used to render the depth texture
  139152. */
  139153. constructor(camera: Camera);
  139154. /**
  139155. * Sets the depth renderer to use to generate the depth map
  139156. * @param depthRenderer The depth renderer to use. If not provided, a new one will be created automatically
  139157. * @param type The texture type of the depth map (default: TEXTURETYPE_HALF_FLOAT)
  139158. * @param forceFullscreenViewport Forces the post processes used for the reduction to be applied without taking into account viewport (defaults to true)
  139159. */
  139160. setDepthRenderer(depthRenderer?: Nullable<DepthRenderer>, type?: number, forceFullscreenViewport?: boolean): void;
  139161. /** @hidden */
  139162. setSourceTexture(sourceTexture: RenderTargetTexture, depthRedux: boolean, type?: number, forceFullscreenViewport?: boolean): void;
  139163. /**
  139164. * Activates the reduction computation.
  139165. * When activated, the observers registered in onAfterReductionPerformed are
  139166. * called after the compuation is performed
  139167. */
  139168. activate(): void;
  139169. /**
  139170. * Deactivates the reduction computation.
  139171. */
  139172. deactivate(): void;
  139173. /**
  139174. * Disposes the depth reducer
  139175. * @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.
  139176. */
  139177. dispose(disposeAll?: boolean): void;
  139178. }
  139179. }
  139180. declare module BABYLON {
  139181. /**
  139182. * A CSM implementation allowing casting shadows on large scenes.
  139183. * Documentation : https://doc.babylonjs.com/babylon101/cascadedShadows
  139184. * Based on: https://github.com/TheRealMJP/Shadows and https://johanmedestrom.wordpress.com/2016/03/18/opengl-cascaded-shadow-maps/
  139185. */
  139186. export class CascadedShadowGenerator extends ShadowGenerator {
  139187. private static readonly frustumCornersNDCSpace;
  139188. /**
  139189. * Name of the CSM class
  139190. */
  139191. static CLASSNAME: string;
  139192. /**
  139193. * Defines the default number of cascades used by the CSM.
  139194. */
  139195. static readonly DEFAULT_CASCADES_COUNT: number;
  139196. /**
  139197. * Defines the minimum number of cascades used by the CSM.
  139198. */
  139199. static readonly MIN_CASCADES_COUNT: number;
  139200. /**
  139201. * Defines the maximum number of cascades used by the CSM.
  139202. */
  139203. static readonly MAX_CASCADES_COUNT: number;
  139204. protected _validateFilter(filter: number): number;
  139205. /**
  139206. * Gets or sets the actual darkness of the soft shadows while using PCSS filtering (value between 0. and 1.)
  139207. */
  139208. penumbraDarkness: number;
  139209. private _numCascades;
  139210. /**
  139211. * Gets or set the number of cascades used by the CSM.
  139212. */
  139213. get numCascades(): number;
  139214. set numCascades(value: number);
  139215. /**
  139216. * Sets this to true if you want that the edges of the shadows don't "swimm" / "shimmer" when rotating the camera.
  139217. * The trade off is that you lose some precision in the shadow rendering when enabling this setting.
  139218. */
  139219. stabilizeCascades: boolean;
  139220. private _freezeShadowCastersBoundingInfo;
  139221. private _freezeShadowCastersBoundingInfoObservable;
  139222. /**
  139223. * Enables or disables the shadow casters bounding info computation.
  139224. * If your shadow casters don't move, you can disable this feature.
  139225. * If it is enabled, the bounding box computation is done every frame.
  139226. */
  139227. get freezeShadowCastersBoundingInfo(): boolean;
  139228. set freezeShadowCastersBoundingInfo(freeze: boolean);
  139229. private _scbiMin;
  139230. private _scbiMax;
  139231. protected _computeShadowCastersBoundingInfo(): void;
  139232. protected _shadowCastersBoundingInfo: BoundingInfo;
  139233. /**
  139234. * Gets or sets the shadow casters bounding info.
  139235. * If you provide your own shadow casters bounding info, first enable freezeShadowCastersBoundingInfo
  139236. * so that the system won't overwrite the bounds you provide
  139237. */
  139238. get shadowCastersBoundingInfo(): BoundingInfo;
  139239. set shadowCastersBoundingInfo(boundingInfo: BoundingInfo);
  139240. protected _breaksAreDirty: boolean;
  139241. protected _minDistance: number;
  139242. protected _maxDistance: number;
  139243. /**
  139244. * Sets the minimal and maximal distances to use when computing the cascade breaks.
  139245. *
  139246. * The values of min / max are typically the depth zmin and zmax values of your scene, for a given frame.
  139247. * If you don't know these values, simply leave them to their defaults and don't call this function.
  139248. * @param min minimal distance for the breaks (default to 0.)
  139249. * @param max maximal distance for the breaks (default to 1.)
  139250. */
  139251. setMinMaxDistance(min: number, max: number): void;
  139252. /** Gets the minimal distance used in the cascade break computation */
  139253. get minDistance(): number;
  139254. /** Gets the maximal distance used in the cascade break computation */
  139255. get maxDistance(): number;
  139256. /**
  139257. * Gets the class name of that object
  139258. * @returns "CascadedShadowGenerator"
  139259. */
  139260. getClassName(): string;
  139261. private _cascadeMinExtents;
  139262. private _cascadeMaxExtents;
  139263. /**
  139264. * Gets a cascade minimum extents
  139265. * @param cascadeIndex index of the cascade
  139266. * @returns the minimum cascade extents
  139267. */
  139268. getCascadeMinExtents(cascadeIndex: number): Nullable<Vector3>;
  139269. /**
  139270. * Gets a cascade maximum extents
  139271. * @param cascadeIndex index of the cascade
  139272. * @returns the maximum cascade extents
  139273. */
  139274. getCascadeMaxExtents(cascadeIndex: number): Nullable<Vector3>;
  139275. private _cascades;
  139276. private _currentLayer;
  139277. private _viewSpaceFrustumsZ;
  139278. private _viewMatrices;
  139279. private _projectionMatrices;
  139280. private _transformMatrices;
  139281. private _transformMatricesAsArray;
  139282. private _frustumLengths;
  139283. private _lightSizeUVCorrection;
  139284. private _depthCorrection;
  139285. private _frustumCornersWorldSpace;
  139286. private _frustumCenter;
  139287. private _shadowCameraPos;
  139288. private _shadowMaxZ;
  139289. /**
  139290. * Gets the shadow max z distance. It's the limit beyond which shadows are not displayed.
  139291. * It defaults to camera.maxZ
  139292. */
  139293. get shadowMaxZ(): number;
  139294. /**
  139295. * Sets the shadow max z distance.
  139296. */
  139297. set shadowMaxZ(value: number);
  139298. protected _debug: boolean;
  139299. /**
  139300. * Gets or sets the debug flag.
  139301. * When enabled, the cascades are materialized by different colors on the screen.
  139302. */
  139303. get debug(): boolean;
  139304. set debug(dbg: boolean);
  139305. private _depthClamp;
  139306. /**
  139307. * Gets or sets the depth clamping value.
  139308. *
  139309. * When enabled, it improves the shadow quality because the near z plane of the light frustum don't need to be adjusted
  139310. * to account for the shadow casters far away.
  139311. *
  139312. * Note that this property is incompatible with PCSS filtering, so it won't be used in that case.
  139313. */
  139314. get depthClamp(): boolean;
  139315. set depthClamp(value: boolean);
  139316. private _cascadeBlendPercentage;
  139317. /**
  139318. * Gets or sets the percentage of blending between two cascades (value between 0. and 1.).
  139319. * It defaults to 0.1 (10% blending).
  139320. */
  139321. get cascadeBlendPercentage(): number;
  139322. set cascadeBlendPercentage(value: number);
  139323. private _lambda;
  139324. /**
  139325. * Gets or set the lambda parameter.
  139326. * This parameter is used to split the camera frustum and create the cascades.
  139327. * 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.
  139328. * For all values in-between, it's a linear combination of the uniform and logarithm split algorithm.
  139329. */
  139330. get lambda(): number;
  139331. set lambda(value: number);
  139332. /**
  139333. * Gets the view matrix corresponding to a given cascade
  139334. * @param cascadeNum cascade to retrieve the view matrix from
  139335. * @returns the cascade view matrix
  139336. */
  139337. getCascadeViewMatrix(cascadeNum: number): Nullable<Matrix>;
  139338. /**
  139339. * Gets the projection matrix corresponding to a given cascade
  139340. * @param cascadeNum cascade to retrieve the projection matrix from
  139341. * @returns the cascade projection matrix
  139342. */
  139343. getCascadeProjectionMatrix(cascadeNum: number): Nullable<Matrix>;
  139344. /**
  139345. * Gets the transformation matrix corresponding to a given cascade
  139346. * @param cascadeNum cascade to retrieve the transformation matrix from
  139347. * @returns the cascade transformation matrix
  139348. */
  139349. getCascadeTransformMatrix(cascadeNum: number): Nullable<Matrix>;
  139350. private _depthRenderer;
  139351. /**
  139352. * Sets the depth renderer to use when autoCalcDepthBounds is enabled.
  139353. *
  139354. * Note that if no depth renderer is set, a new one will be automatically created internally when necessary.
  139355. *
  139356. * You should call this function if you already have a depth renderer enabled in your scene, to avoid
  139357. * doing multiple depth rendering each frame. If you provide your own depth renderer, make sure it stores linear depth!
  139358. * @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
  139359. */
  139360. setDepthRenderer(depthRenderer: Nullable<DepthRenderer>): void;
  139361. private _depthReducer;
  139362. private _autoCalcDepthBounds;
  139363. /**
  139364. * Gets or sets the autoCalcDepthBounds property.
  139365. *
  139366. * When enabled, a depth rendering pass is first performed (with an internally created depth renderer or with the one
  139367. * you provide by calling setDepthRenderer). Then, a min/max reducing is applied on the depth map to compute the
  139368. * minimal and maximal depth of the map and those values are used as inputs for the setMinMaxDistance() function.
  139369. * It can greatly enhance the shadow quality, at the expense of more GPU works.
  139370. * When using this option, you should increase the value of the lambda parameter, and even set it to 1 for best results.
  139371. */
  139372. get autoCalcDepthBounds(): boolean;
  139373. set autoCalcDepthBounds(value: boolean);
  139374. /**
  139375. * Defines the refresh rate of the min/max computation used when autoCalcDepthBounds is set to true
  139376. * Use 0 to compute just once, 1 to compute on every frame, 2 to compute every two frames and so on...
  139377. * Note that if you provided your own depth renderer through a call to setDepthRenderer, you are responsible
  139378. * for setting the refresh rate on the renderer yourself!
  139379. */
  139380. get autoCalcDepthBoundsRefreshRate(): number;
  139381. set autoCalcDepthBoundsRefreshRate(value: number);
  139382. /**
  139383. * Create the cascade breaks according to the lambda, shadowMaxZ and min/max distance properties, as well as the camera near and far planes.
  139384. * This function is automatically called when updating lambda, shadowMaxZ and min/max distances, however you should call it yourself if
  139385. * you change the camera near/far planes!
  139386. */
  139387. splitFrustum(): void;
  139388. private _splitFrustum;
  139389. private _computeMatrices;
  139390. private _computeFrustumInWorldSpace;
  139391. private _computeCascadeFrustum;
  139392. /**
  139393. * Support test.
  139394. */
  139395. static get IsSupported(): boolean;
  139396. /** @hidden */
  139397. static _SceneComponentInitialization: (scene: Scene) => void;
  139398. /**
  139399. * Creates a Cascaded Shadow Generator object.
  139400. * A ShadowGenerator is the required tool to use the shadows.
  139401. * Each directional light casting shadows needs to use its own ShadowGenerator.
  139402. * Documentation : https://doc.babylonjs.com/babylon101/cascadedShadows
  139403. * @param mapSize The size of the texture what stores the shadows. Example : 1024.
  139404. * @param light The directional light object generating the shadows.
  139405. * @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.
  139406. */
  139407. constructor(mapSize: number, light: DirectionalLight, usefulFloatFirst?: boolean);
  139408. protected _initializeGenerator(): void;
  139409. protected _createTargetRenderTexture(): void;
  139410. protected _initializeShadowMap(): void;
  139411. protected _bindCustomEffectForRenderSubMeshForShadowMap(subMesh: SubMesh, effect: Effect, matriceNames: any, mesh: AbstractMesh): void;
  139412. protected _isReadyCustomDefines(defines: any, subMesh: SubMesh, useInstances: boolean): void;
  139413. /**
  139414. * Prepare all the defines in a material relying on a shadow map at the specified light index.
  139415. * @param defines Defines of the material we want to update
  139416. * @param lightIndex Index of the light in the enabled light list of the material
  139417. */
  139418. prepareDefines(defines: any, lightIndex: number): void;
  139419. /**
  139420. * Binds the shadow related information inside of an effect (information like near, far, darkness...
  139421. * defined in the generator but impacting the effect).
  139422. * @param lightIndex Index of the light in the enabled light list of the material owning the effect
  139423. * @param effect The effect we are binfing the information for
  139424. */
  139425. bindShadowLight(lightIndex: string, effect: Effect): void;
  139426. /**
  139427. * Gets the transformation matrix of the first cascade used to project the meshes into the map from the light point of view.
  139428. * (eq to view projection * shadow projection matrices)
  139429. * @returns The transform matrix used to create the shadow map
  139430. */
  139431. getTransformMatrix(): Matrix;
  139432. /**
  139433. * Disposes the ShadowGenerator.
  139434. * Returns nothing.
  139435. */
  139436. dispose(): void;
  139437. /**
  139438. * Serializes the shadow generator setup to a json object.
  139439. * @returns The serialized JSON object
  139440. */
  139441. serialize(): any;
  139442. /**
  139443. * Parses a serialized ShadowGenerator and returns a new ShadowGenerator.
  139444. * @param parsedShadowGenerator The JSON object to parse
  139445. * @param scene The scene to create the shadow map for
  139446. * @returns The parsed shadow generator
  139447. */
  139448. static Parse(parsedShadowGenerator: any, scene: Scene): ShadowGenerator;
  139449. }
  139450. }
  139451. declare module BABYLON {
  139452. /**
  139453. * Defines the shadow generator component responsible to manage any shadow generators
  139454. * in a given scene.
  139455. */
  139456. export class ShadowGeneratorSceneComponent implements ISceneSerializableComponent {
  139457. /**
  139458. * The component name helpfull to identify the component in the list of scene components.
  139459. */
  139460. readonly name: string;
  139461. /**
  139462. * The scene the component belongs to.
  139463. */
  139464. scene: Scene;
  139465. /**
  139466. * Creates a new instance of the component for the given scene
  139467. * @param scene Defines the scene to register the component in
  139468. */
  139469. constructor(scene: Scene);
  139470. /**
  139471. * Registers the component in a given scene
  139472. */
  139473. register(): void;
  139474. /**
  139475. * Rebuilds the elements related to this component in case of
  139476. * context lost for instance.
  139477. */
  139478. rebuild(): void;
  139479. /**
  139480. * Serializes the component data to the specified json object
  139481. * @param serializationObject The object to serialize to
  139482. */
  139483. serialize(serializationObject: any): void;
  139484. /**
  139485. * Adds all the elements from the container to the scene
  139486. * @param container the container holding the elements
  139487. */
  139488. addFromContainer(container: AbstractScene): void;
  139489. /**
  139490. * Removes all the elements in the container from the scene
  139491. * @param container contains the elements to remove
  139492. * @param dispose if the removed element should be disposed (default: false)
  139493. */
  139494. removeFromContainer(container: AbstractScene, dispose?: boolean): void;
  139495. /**
  139496. * Rebuilds the elements related to this component in case of
  139497. * context lost for instance.
  139498. */
  139499. dispose(): void;
  139500. private _gatherRenderTargets;
  139501. }
  139502. }
  139503. declare module BABYLON {
  139504. /**
  139505. * A point light is a light defined by an unique point in world space.
  139506. * The light is emitted in every direction from this point.
  139507. * A good example of a point light is a standard light bulb.
  139508. * Documentation: https://doc.babylonjs.com/babylon101/lights
  139509. */
  139510. export class PointLight extends ShadowLight {
  139511. private _shadowAngle;
  139512. /**
  139513. * Getter: In case of direction provided, the shadow will not use a cube texture but simulate a spot shadow as a fallback
  139514. * This specifies what angle the shadow will use to be created.
  139515. *
  139516. * It default to 90 degrees to work nicely with the cube texture generation for point lights shadow maps.
  139517. */
  139518. get shadowAngle(): number;
  139519. /**
  139520. * Setter: In case of direction provided, the shadow will not use a cube texture but simulate a spot shadow as a fallback
  139521. * This specifies what angle the shadow will use to be created.
  139522. *
  139523. * It default to 90 degrees to work nicely with the cube texture generation for point lights shadow maps.
  139524. */
  139525. set shadowAngle(value: number);
  139526. /**
  139527. * Gets the direction if it has been set.
  139528. * In case of direction provided, the shadow will not use a cube texture but simulate a spot shadow as a fallback
  139529. */
  139530. get direction(): Vector3;
  139531. /**
  139532. * In case of direction provided, the shadow will not use a cube texture but simulate a spot shadow as a fallback
  139533. */
  139534. set direction(value: Vector3);
  139535. /**
  139536. * Creates a PointLight object from the passed name and position (Vector3) and adds it in the scene.
  139537. * A PointLight emits the light in every direction.
  139538. * It can cast shadows.
  139539. * If the scene camera is already defined and you want to set your PointLight at the camera position, just set it :
  139540. * ```javascript
  139541. * var pointLight = new PointLight("pl", camera.position, scene);
  139542. * ```
  139543. * Documentation : https://doc.babylonjs.com/babylon101/lights
  139544. * @param name The light friendly name
  139545. * @param position The position of the point light in the scene
  139546. * @param scene The scene the lights belongs to
  139547. */
  139548. constructor(name: string, position: Vector3, scene: Scene);
  139549. /**
  139550. * Returns the string "PointLight"
  139551. * @returns the class name
  139552. */
  139553. getClassName(): string;
  139554. /**
  139555. * Returns the integer 0.
  139556. * @returns The light Type id as a constant defines in Light.LIGHTTYPEID_x
  139557. */
  139558. getTypeID(): number;
  139559. /**
  139560. * Specifies wether or not the shadowmap should be a cube texture.
  139561. * @returns true if the shadowmap needs to be a cube texture.
  139562. */
  139563. needCube(): boolean;
  139564. /**
  139565. * Returns a new Vector3 aligned with the PointLight cube system according to the passed cube face index (integer).
  139566. * @param faceIndex The index of the face we are computed the direction to generate shadow
  139567. * @returns The set direction in 2d mode otherwise the direction to the cubemap face if needCube() is true
  139568. */
  139569. getShadowDirection(faceIndex?: number): Vector3;
  139570. /**
  139571. * Sets the passed matrix "matrix" as a left-handed perspective projection matrix with the following settings :
  139572. * - fov = PI / 2
  139573. * - aspect ratio : 1.0
  139574. * - z-near and far equal to the active camera minZ and maxZ.
  139575. * Returns the PointLight.
  139576. */
  139577. protected _setDefaultShadowProjectionMatrix(matrix: Matrix, viewMatrix: Matrix, renderList: Array<AbstractMesh>): void;
  139578. protected _buildUniformLayout(): void;
  139579. /**
  139580. * Sets the passed Effect "effect" with the PointLight transformed position (or position, if none) and passed name (string).
  139581. * @param effect The effect to update
  139582. * @param lightIndex The index of the light in the effect to update
  139583. * @returns The point light
  139584. */
  139585. transferToEffect(effect: Effect, lightIndex: string): PointLight;
  139586. transferToNodeMaterialEffect(effect: Effect, lightDataUniformName: string): this;
  139587. /**
  139588. * Prepares the list of defines specific to the light type.
  139589. * @param defines the list of defines
  139590. * @param lightIndex defines the index of the light for the effect
  139591. */
  139592. prepareLightSpecificDefines(defines: any, lightIndex: number): void;
  139593. }
  139594. }
  139595. declare module BABYLON {
  139596. /**
  139597. * Header information of HDR texture files.
  139598. */
  139599. export interface HDRInfo {
  139600. /**
  139601. * The height of the texture in pixels.
  139602. */
  139603. height: number;
  139604. /**
  139605. * The width of the texture in pixels.
  139606. */
  139607. width: number;
  139608. /**
  139609. * The index of the beginning of the data in the binary file.
  139610. */
  139611. dataPosition: number;
  139612. }
  139613. /**
  139614. * This groups tools to convert HDR texture to native colors array.
  139615. */
  139616. export class HDRTools {
  139617. private static Ldexp;
  139618. private static Rgbe2float;
  139619. private static readStringLine;
  139620. /**
  139621. * Reads header information from an RGBE texture stored in a native array.
  139622. * More information on this format are available here:
  139623. * https://en.wikipedia.org/wiki/RGBE_image_format
  139624. *
  139625. * @param uint8array The binary file stored in native array.
  139626. * @return The header information.
  139627. */
  139628. static RGBE_ReadHeader(uint8array: Uint8Array): HDRInfo;
  139629. /**
  139630. * Returns the cubemap information (each faces texture data) extracted from an RGBE texture.
  139631. * This RGBE texture needs to store the information as a panorama.
  139632. *
  139633. * More information on this format are available here:
  139634. * https://en.wikipedia.org/wiki/RGBE_image_format
  139635. *
  139636. * @param buffer The binary file stored in an array buffer.
  139637. * @param size The expected size of the extracted cubemap.
  139638. * @return The Cube Map information.
  139639. */
  139640. static GetCubeMapTextureData(buffer: ArrayBuffer, size: number): CubeMapInfo;
  139641. /**
  139642. * Returns the pixels data extracted from an RGBE texture.
  139643. * This pixels will be stored left to right up to down in the R G B order in one array.
  139644. *
  139645. * More information on this format are available here:
  139646. * https://en.wikipedia.org/wiki/RGBE_image_format
  139647. *
  139648. * @param uint8array The binary file stored in an array buffer.
  139649. * @param hdrInfo The header information of the file.
  139650. * @return The pixels data in RGB right to left up to down order.
  139651. */
  139652. static RGBE_ReadPixels(uint8array: Uint8Array, hdrInfo: HDRInfo): Float32Array;
  139653. private static RGBE_ReadPixels_RLE;
  139654. private static RGBE_ReadPixels_NOT_RLE;
  139655. }
  139656. }
  139657. declare module BABYLON {
  139658. /**
  139659. * Effect Render Options
  139660. */
  139661. export interface IEffectRendererOptions {
  139662. /**
  139663. * Defines the vertices positions.
  139664. */
  139665. positions?: number[];
  139666. /**
  139667. * Defines the indices.
  139668. */
  139669. indices?: number[];
  139670. }
  139671. /**
  139672. * Helper class to render one or more effects.
  139673. * You can access the previous rendering in your shader by declaring a sampler named textureSampler
  139674. */
  139675. export class EffectRenderer {
  139676. private engine;
  139677. private static _DefaultOptions;
  139678. private _vertexBuffers;
  139679. private _indexBuffer;
  139680. private _fullscreenViewport;
  139681. /**
  139682. * Creates an effect renderer
  139683. * @param engine the engine to use for rendering
  139684. * @param options defines the options of the effect renderer
  139685. */
  139686. constructor(engine: ThinEngine, options?: IEffectRendererOptions);
  139687. /**
  139688. * Sets the current viewport in normalized coordinates 0-1
  139689. * @param viewport Defines the viewport to set (defaults to 0 0 1 1)
  139690. */
  139691. setViewport(viewport?: Viewport): void;
  139692. /**
  139693. * Binds the embedded attributes buffer to the effect.
  139694. * @param effect Defines the effect to bind the attributes for
  139695. */
  139696. bindBuffers(effect: Effect): void;
  139697. /**
  139698. * Sets the current effect wrapper to use during draw.
  139699. * The effect needs to be ready before calling this api.
  139700. * This also sets the default full screen position attribute.
  139701. * @param effectWrapper Defines the effect to draw with
  139702. */
  139703. applyEffectWrapper(effectWrapper: EffectWrapper): void;
  139704. /**
  139705. * Restores engine states
  139706. */
  139707. restoreStates(): void;
  139708. /**
  139709. * Draws a full screen quad.
  139710. */
  139711. draw(): void;
  139712. private isRenderTargetTexture;
  139713. /**
  139714. * renders one or more effects to a specified texture
  139715. * @param effectWrapper the effect to renderer
  139716. * @param outputTexture texture to draw to, if null it will render to the screen.
  139717. */
  139718. render(effectWrapper: EffectWrapper, outputTexture?: Nullable<InternalTexture | RenderTargetTexture>): void;
  139719. /**
  139720. * Disposes of the effect renderer
  139721. */
  139722. dispose(): void;
  139723. }
  139724. /**
  139725. * Options to create an EffectWrapper
  139726. */
  139727. interface EffectWrapperCreationOptions {
  139728. /**
  139729. * Engine to use to create the effect
  139730. */
  139731. engine: ThinEngine;
  139732. /**
  139733. * Fragment shader for the effect
  139734. */
  139735. fragmentShader: string;
  139736. /**
  139737. * Use the shader store instead of direct source code
  139738. */
  139739. useShaderStore?: boolean;
  139740. /**
  139741. * Vertex shader for the effect
  139742. */
  139743. vertexShader?: string;
  139744. /**
  139745. * Attributes to use in the shader
  139746. */
  139747. attributeNames?: Array<string>;
  139748. /**
  139749. * Uniforms to use in the shader
  139750. */
  139751. uniformNames?: Array<string>;
  139752. /**
  139753. * Texture sampler names to use in the shader
  139754. */
  139755. samplerNames?: Array<string>;
  139756. /**
  139757. * Defines to use in the shader
  139758. */
  139759. defines?: Array<string>;
  139760. /**
  139761. * Callback when effect is compiled
  139762. */
  139763. onCompiled?: Nullable<(effect: Effect) => void>;
  139764. /**
  139765. * The friendly name of the effect displayed in Spector.
  139766. */
  139767. name?: string;
  139768. }
  139769. /**
  139770. * Wraps an effect to be used for rendering
  139771. */
  139772. export class EffectWrapper {
  139773. /**
  139774. * Event that is fired right before the effect is drawn (should be used to update uniforms)
  139775. */
  139776. onApplyObservable: Observable<{}>;
  139777. /**
  139778. * The underlying effect
  139779. */
  139780. effect: Effect;
  139781. /**
  139782. * Creates an effect to be renderer
  139783. * @param creationOptions options to create the effect
  139784. */
  139785. constructor(creationOptions: EffectWrapperCreationOptions);
  139786. /**
  139787. * Disposes of the effect wrapper
  139788. */
  139789. dispose(): void;
  139790. }
  139791. }
  139792. declare module BABYLON {
  139793. /** @hidden */
  139794. export var hdrFilteringVertexShader: {
  139795. name: string;
  139796. shader: string;
  139797. };
  139798. }
  139799. declare module BABYLON {
  139800. /** @hidden */
  139801. export var hdrFilteringPixelShader: {
  139802. name: string;
  139803. shader: string;
  139804. };
  139805. }
  139806. declare module BABYLON {
  139807. /**
  139808. * Options for texture filtering
  139809. */
  139810. interface IHDRFilteringOptions {
  139811. /**
  139812. * Scales pixel intensity for the input HDR map.
  139813. */
  139814. hdrScale?: number;
  139815. /**
  139816. * Quality of the filter. Should be `Constants.TEXTURE_FILTERING_QUALITY_OFFLINE` for prefiltering
  139817. */
  139818. quality?: number;
  139819. }
  139820. /**
  139821. * Filters HDR maps to get correct renderings of PBR reflections
  139822. */
  139823. export class HDRFiltering {
  139824. private _engine;
  139825. private _effectRenderer;
  139826. private _effectWrapper;
  139827. private _lodGenerationOffset;
  139828. private _lodGenerationScale;
  139829. /**
  139830. * Quality switch for prefiltering. Should be set to `Constants.TEXTURE_FILTERING_QUALITY_OFFLINE` unless
  139831. * you care about baking speed.
  139832. */
  139833. quality: number;
  139834. /**
  139835. * Scales pixel intensity for the input HDR map.
  139836. */
  139837. hdrScale: number;
  139838. /**
  139839. * Instantiates HDR filter for reflection maps
  139840. *
  139841. * @param engine Thin engine
  139842. * @param options Options
  139843. */
  139844. constructor(engine: ThinEngine, options?: IHDRFilteringOptions);
  139845. private _createRenderTarget;
  139846. private _prefilterInternal;
  139847. private _createEffect;
  139848. /**
  139849. * Get a value indicating if the filter is ready to be used
  139850. * @param texture Texture to filter
  139851. * @returns true if the filter is ready
  139852. */
  139853. isReady(texture: BaseTexture): boolean;
  139854. /**
  139855. * Prefilters a cube texture to have mipmap levels representing roughness values.
  139856. * Prefiltering will be invoked at the end of next rendering pass.
  139857. * This has to be done once the map is loaded, and has not been prefiltered by a third party software.
  139858. * See http://blog.selfshadow.com/publications/s2013-shading-course/karis/s2013_pbs_epic_notes_v2.pdf for more information
  139859. * @param texture Texture to filter
  139860. * @param onFinished Callback when filtering is done
  139861. * @return Promise called when prefiltering is done
  139862. */
  139863. prefilter(texture: BaseTexture, onFinished?: Nullable<() => void>): Promise<unknown> | undefined;
  139864. }
  139865. }
  139866. declare module BABYLON {
  139867. /**
  139868. * This represents a texture coming from an HDR input.
  139869. *
  139870. * The only supported format is currently panorama picture stored in RGBE format.
  139871. * Example of such files can be found on HDRLib: http://hdrlib.com/
  139872. */
  139873. export class HDRCubeTexture extends BaseTexture {
  139874. private static _facesMapping;
  139875. private _generateHarmonics;
  139876. private _noMipmap;
  139877. private _prefilterOnLoad;
  139878. private _textureMatrix;
  139879. private _size;
  139880. private _onLoad;
  139881. private _onError;
  139882. /**
  139883. * The texture URL.
  139884. */
  139885. url: string;
  139886. protected _isBlocking: boolean;
  139887. /**
  139888. * Sets wether or not the texture is blocking during loading.
  139889. */
  139890. set isBlocking(value: boolean);
  139891. /**
  139892. * Gets wether or not the texture is blocking during loading.
  139893. */
  139894. get isBlocking(): boolean;
  139895. protected _rotationY: number;
  139896. /**
  139897. * Sets texture matrix rotation angle around Y axis in radians.
  139898. */
  139899. set rotationY(value: number);
  139900. /**
  139901. * Gets texture matrix rotation angle around Y axis radians.
  139902. */
  139903. get rotationY(): number;
  139904. /**
  139905. * Gets or sets the center of the bounding box associated with the cube texture
  139906. * It must define where the camera used to render the texture was set
  139907. */
  139908. boundingBoxPosition: Vector3;
  139909. private _boundingBoxSize;
  139910. /**
  139911. * Gets or sets the size of the bounding box associated with the cube texture
  139912. * When defined, the cubemap will switch to local mode
  139913. * @see https://community.arm.com/graphics/b/blog/posts/reflections-based-on-local-cubemaps-in-unity
  139914. * @example https://www.babylonjs-playground.com/#RNASML
  139915. */
  139916. set boundingBoxSize(value: Vector3);
  139917. get boundingBoxSize(): Vector3;
  139918. /**
  139919. * Instantiates an HDRTexture from the following parameters.
  139920. *
  139921. * @param url The location of the HDR raw data (Panorama stored in RGBE format)
  139922. * @param sceneOrEngine The scene or engine the texture will be used in
  139923. * @param size The cubemap desired size (the more it increases the longer the generation will be)
  139924. * @param noMipmap Forces to not generate the mipmap if true
  139925. * @param generateHarmonics Specifies whether you want to extract the polynomial harmonics during the generation process
  139926. * @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)
  139927. * @param prefilterOnLoad Prefilters HDR texture to allow use of this texture as a PBR reflection texture.
  139928. */
  139929. 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>);
  139930. /**
  139931. * Get the current class name of the texture useful for serialization or dynamic coding.
  139932. * @returns "HDRCubeTexture"
  139933. */
  139934. getClassName(): string;
  139935. /**
  139936. * Occurs when the file is raw .hdr file.
  139937. */
  139938. private loadTexture;
  139939. clone(): HDRCubeTexture;
  139940. delayLoad(): void;
  139941. /**
  139942. * Get the texture reflection matrix used to rotate/transform the reflection.
  139943. * @returns the reflection matrix
  139944. */
  139945. getReflectionTextureMatrix(): Matrix;
  139946. /**
  139947. * Set the texture reflection matrix used to rotate/transform the reflection.
  139948. * @param value Define the reflection matrix to set
  139949. */
  139950. setReflectionTextureMatrix(value: Matrix): void;
  139951. /**
  139952. * Parses a JSON representation of an HDR Texture in order to create the texture
  139953. * @param parsedTexture Define the JSON representation
  139954. * @param scene Define the scene the texture should be created in
  139955. * @param rootUrl Define the root url in case we need to load relative dependencies
  139956. * @returns the newly created texture after parsing
  139957. */
  139958. static Parse(parsedTexture: any, scene: Scene, rootUrl: string): Nullable<HDRCubeTexture>;
  139959. serialize(): any;
  139960. }
  139961. }
  139962. declare module BABYLON {
  139963. /**
  139964. * Class used to control physics engine
  139965. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  139966. */
  139967. export class PhysicsEngine implements IPhysicsEngine {
  139968. private _physicsPlugin;
  139969. /**
  139970. * Global value used to control the smallest number supported by the simulation
  139971. */
  139972. static Epsilon: number;
  139973. private _impostors;
  139974. private _joints;
  139975. private _subTimeStep;
  139976. /**
  139977. * Gets the gravity vector used by the simulation
  139978. */
  139979. gravity: Vector3;
  139980. /**
  139981. * Factory used to create the default physics plugin.
  139982. * @returns The default physics plugin
  139983. */
  139984. static DefaultPluginFactory(): IPhysicsEnginePlugin;
  139985. /**
  139986. * Creates a new Physics Engine
  139987. * @param gravity defines the gravity vector used by the simulation
  139988. * @param _physicsPlugin defines the plugin to use (CannonJS by default)
  139989. */
  139990. constructor(gravity: Nullable<Vector3>, _physicsPlugin?: IPhysicsEnginePlugin);
  139991. /**
  139992. * Sets the gravity vector used by the simulation
  139993. * @param gravity defines the gravity vector to use
  139994. */
  139995. setGravity(gravity: Vector3): void;
  139996. /**
  139997. * Set the time step of the physics engine.
  139998. * Default is 1/60.
  139999. * To slow it down, enter 1/600 for example.
  140000. * To speed it up, 1/30
  140001. * @param newTimeStep defines the new timestep to apply to this world.
  140002. */
  140003. setTimeStep(newTimeStep?: number): void;
  140004. /**
  140005. * Get the time step of the physics engine.
  140006. * @returns the current time step
  140007. */
  140008. getTimeStep(): number;
  140009. /**
  140010. * Set the sub time step of the physics engine.
  140011. * Default is 0 meaning there is no sub steps
  140012. * To increase physics resolution precision, set a small value (like 1 ms)
  140013. * @param subTimeStep defines the new sub timestep used for physics resolution.
  140014. */
  140015. setSubTimeStep(subTimeStep?: number): void;
  140016. /**
  140017. * Get the sub time step of the physics engine.
  140018. * @returns the current sub time step
  140019. */
  140020. getSubTimeStep(): number;
  140021. /**
  140022. * Release all resources
  140023. */
  140024. dispose(): void;
  140025. /**
  140026. * Gets the name of the current physics plugin
  140027. * @returns the name of the plugin
  140028. */
  140029. getPhysicsPluginName(): string;
  140030. /**
  140031. * Adding a new impostor for the impostor tracking.
  140032. * This will be done by the impostor itself.
  140033. * @param impostor the impostor to add
  140034. */
  140035. addImpostor(impostor: PhysicsImpostor): void;
  140036. /**
  140037. * Remove an impostor from the engine.
  140038. * This impostor and its mesh will not longer be updated by the physics engine.
  140039. * @param impostor the impostor to remove
  140040. */
  140041. removeImpostor(impostor: PhysicsImpostor): void;
  140042. /**
  140043. * Add a joint to the physics engine
  140044. * @param mainImpostor defines the main impostor to which the joint is added.
  140045. * @param connectedImpostor defines the impostor that is connected to the main impostor using this joint
  140046. * @param joint defines the joint that will connect both impostors.
  140047. */
  140048. addJoint(mainImpostor: PhysicsImpostor, connectedImpostor: PhysicsImpostor, joint: PhysicsJoint): void;
  140049. /**
  140050. * Removes a joint from the simulation
  140051. * @param mainImpostor defines the impostor used with the joint
  140052. * @param connectedImpostor defines the other impostor connected to the main one by the joint
  140053. * @param joint defines the joint to remove
  140054. */
  140055. removeJoint(mainImpostor: PhysicsImpostor, connectedImpostor: PhysicsImpostor, joint: PhysicsJoint): void;
  140056. /**
  140057. * Called by the scene. No need to call it.
  140058. * @param delta defines the timespam between frames
  140059. */
  140060. _step(delta: number): void;
  140061. /**
  140062. * Gets the current plugin used to run the simulation
  140063. * @returns current plugin
  140064. */
  140065. getPhysicsPlugin(): IPhysicsEnginePlugin;
  140066. /**
  140067. * Gets the list of physic impostors
  140068. * @returns an array of PhysicsImpostor
  140069. */
  140070. getImpostors(): Array<PhysicsImpostor>;
  140071. /**
  140072. * Gets the impostor for a physics enabled object
  140073. * @param object defines the object impersonated by the impostor
  140074. * @returns the PhysicsImpostor or null if not found
  140075. */
  140076. getImpostorForPhysicsObject(object: IPhysicsEnabledObject): Nullable<PhysicsImpostor>;
  140077. /**
  140078. * Gets the impostor for a physics body object
  140079. * @param body defines physics body used by the impostor
  140080. * @returns the PhysicsImpostor or null if not found
  140081. */
  140082. getImpostorWithPhysicsBody(body: any): Nullable<PhysicsImpostor>;
  140083. /**
  140084. * Does a raycast in the physics world
  140085. * @param from when should the ray start?
  140086. * @param to when should the ray end?
  140087. * @returns PhysicsRaycastResult
  140088. */
  140089. raycast(from: Vector3, to: Vector3): PhysicsRaycastResult;
  140090. }
  140091. }
  140092. declare module BABYLON {
  140093. /** @hidden */
  140094. export class CannonJSPlugin implements IPhysicsEnginePlugin {
  140095. private _useDeltaForWorldStep;
  140096. world: any;
  140097. name: string;
  140098. private _physicsMaterials;
  140099. private _fixedTimeStep;
  140100. private _cannonRaycastResult;
  140101. private _raycastResult;
  140102. private _physicsBodysToRemoveAfterStep;
  140103. private _firstFrame;
  140104. BJSCANNON: any;
  140105. constructor(_useDeltaForWorldStep?: boolean, iterations?: number, cannonInjection?: any);
  140106. setGravity(gravity: Vector3): void;
  140107. setTimeStep(timeStep: number): void;
  140108. getTimeStep(): number;
  140109. executeStep(delta: number, impostors: Array<PhysicsImpostor>): void;
  140110. private _removeMarkedPhysicsBodiesFromWorld;
  140111. applyImpulse(impostor: PhysicsImpostor, force: Vector3, contactPoint: Vector3): void;
  140112. applyForce(impostor: PhysicsImpostor, force: Vector3, contactPoint: Vector3): void;
  140113. generatePhysicsBody(impostor: PhysicsImpostor): void;
  140114. private _processChildMeshes;
  140115. removePhysicsBody(impostor: PhysicsImpostor): void;
  140116. generateJoint(impostorJoint: PhysicsImpostorJoint): void;
  140117. removeJoint(impostorJoint: PhysicsImpostorJoint): void;
  140118. private _addMaterial;
  140119. private _checkWithEpsilon;
  140120. private _createShape;
  140121. private _createHeightmap;
  140122. private _minus90X;
  140123. private _plus90X;
  140124. private _tmpPosition;
  140125. private _tmpDeltaPosition;
  140126. private _tmpUnityRotation;
  140127. private _updatePhysicsBodyTransformation;
  140128. setTransformationFromPhysicsBody(impostor: PhysicsImpostor): void;
  140129. setPhysicsBodyTransformation(impostor: PhysicsImpostor, newPosition: Vector3, newRotation: Quaternion): void;
  140130. isSupported(): boolean;
  140131. setLinearVelocity(impostor: PhysicsImpostor, velocity: Vector3): void;
  140132. setAngularVelocity(impostor: PhysicsImpostor, velocity: Vector3): void;
  140133. getLinearVelocity(impostor: PhysicsImpostor): Nullable<Vector3>;
  140134. getAngularVelocity(impostor: PhysicsImpostor): Nullable<Vector3>;
  140135. setBodyMass(impostor: PhysicsImpostor, mass: number): void;
  140136. getBodyMass(impostor: PhysicsImpostor): number;
  140137. getBodyFriction(impostor: PhysicsImpostor): number;
  140138. setBodyFriction(impostor: PhysicsImpostor, friction: number): void;
  140139. getBodyRestitution(impostor: PhysicsImpostor): number;
  140140. setBodyRestitution(impostor: PhysicsImpostor, restitution: number): void;
  140141. sleepBody(impostor: PhysicsImpostor): void;
  140142. wakeUpBody(impostor: PhysicsImpostor): void;
  140143. updateDistanceJoint(joint: PhysicsJoint, maxDistance: number): void;
  140144. setMotor(joint: IMotorEnabledJoint, speed?: number, maxForce?: number, motorIndex?: number): void;
  140145. setLimit(joint: IMotorEnabledJoint, upperLimit: number, lowerLimit?: number): void;
  140146. syncMeshWithImpostor(mesh: AbstractMesh, impostor: PhysicsImpostor): void;
  140147. getRadius(impostor: PhysicsImpostor): number;
  140148. getBoxSizeToRef(impostor: PhysicsImpostor, result: Vector3): void;
  140149. dispose(): void;
  140150. private _extendNamespace;
  140151. /**
  140152. * Does a raycast in the physics world
  140153. * @param from when should the ray start?
  140154. * @param to when should the ray end?
  140155. * @returns PhysicsRaycastResult
  140156. */
  140157. raycast(from: Vector3, to: Vector3): PhysicsRaycastResult;
  140158. }
  140159. }
  140160. declare module BABYLON {
  140161. /** @hidden */
  140162. export class OimoJSPlugin implements IPhysicsEnginePlugin {
  140163. private _useDeltaForWorldStep;
  140164. world: any;
  140165. name: string;
  140166. BJSOIMO: any;
  140167. private _raycastResult;
  140168. private _fixedTimeStep;
  140169. constructor(_useDeltaForWorldStep?: boolean, iterations?: number, oimoInjection?: any);
  140170. setGravity(gravity: Vector3): void;
  140171. setTimeStep(timeStep: number): void;
  140172. getTimeStep(): number;
  140173. private _tmpImpostorsArray;
  140174. executeStep(delta: number, impostors: Array<PhysicsImpostor>): void;
  140175. applyImpulse(impostor: PhysicsImpostor, force: Vector3, contactPoint: Vector3): void;
  140176. applyForce(impostor: PhysicsImpostor, force: Vector3, contactPoint: Vector3): void;
  140177. generatePhysicsBody(impostor: PhysicsImpostor): void;
  140178. private _tmpPositionVector;
  140179. removePhysicsBody(impostor: PhysicsImpostor): void;
  140180. generateJoint(impostorJoint: PhysicsImpostorJoint): void;
  140181. removeJoint(impostorJoint: PhysicsImpostorJoint): void;
  140182. isSupported(): boolean;
  140183. setTransformationFromPhysicsBody(impostor: PhysicsImpostor): void;
  140184. setPhysicsBodyTransformation(impostor: PhysicsImpostor, newPosition: Vector3, newRotation: Quaternion): void;
  140185. setLinearVelocity(impostor: PhysicsImpostor, velocity: Vector3): void;
  140186. setAngularVelocity(impostor: PhysicsImpostor, velocity: Vector3): void;
  140187. getLinearVelocity(impostor: PhysicsImpostor): Nullable<Vector3>;
  140188. getAngularVelocity(impostor: PhysicsImpostor): Nullable<Vector3>;
  140189. setBodyMass(impostor: PhysicsImpostor, mass: number): void;
  140190. getBodyMass(impostor: PhysicsImpostor): number;
  140191. getBodyFriction(impostor: PhysicsImpostor): number;
  140192. setBodyFriction(impostor: PhysicsImpostor, friction: number): void;
  140193. getBodyRestitution(impostor: PhysicsImpostor): number;
  140194. setBodyRestitution(impostor: PhysicsImpostor, restitution: number): void;
  140195. sleepBody(impostor: PhysicsImpostor): void;
  140196. wakeUpBody(impostor: PhysicsImpostor): void;
  140197. updateDistanceJoint(joint: PhysicsJoint, maxDistance: number, minDistance?: number): void;
  140198. setMotor(joint: IMotorEnabledJoint, speed: number, force?: number, motorIndex?: number): void;
  140199. setLimit(joint: IMotorEnabledJoint, upperLimit: number, lowerLimit?: number, motorIndex?: number): void;
  140200. syncMeshWithImpostor(mesh: AbstractMesh, impostor: PhysicsImpostor): void;
  140201. getRadius(impostor: PhysicsImpostor): number;
  140202. getBoxSizeToRef(impostor: PhysicsImpostor, result: Vector3): void;
  140203. dispose(): void;
  140204. /**
  140205. * Does a raycast in the physics world
  140206. * @param from when should the ray start?
  140207. * @param to when should the ray end?
  140208. * @returns PhysicsRaycastResult
  140209. */
  140210. raycast(from: Vector3, to: Vector3): PhysicsRaycastResult;
  140211. }
  140212. }
  140213. declare module BABYLON {
  140214. /**
  140215. * AmmoJS Physics plugin
  140216. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  140217. * @see https://github.com/kripken/ammo.js/
  140218. */
  140219. export class AmmoJSPlugin implements IPhysicsEnginePlugin {
  140220. private _useDeltaForWorldStep;
  140221. /**
  140222. * Reference to the Ammo library
  140223. */
  140224. bjsAMMO: any;
  140225. /**
  140226. * Created ammoJS world which physics bodies are added to
  140227. */
  140228. world: any;
  140229. /**
  140230. * Name of the plugin
  140231. */
  140232. name: string;
  140233. private _timeStep;
  140234. private _fixedTimeStep;
  140235. private _maxSteps;
  140236. private _tmpQuaternion;
  140237. private _tmpAmmoTransform;
  140238. private _tmpAmmoQuaternion;
  140239. private _tmpAmmoConcreteContactResultCallback;
  140240. private _collisionConfiguration;
  140241. private _dispatcher;
  140242. private _overlappingPairCache;
  140243. private _solver;
  140244. private _softBodySolver;
  140245. private _tmpAmmoVectorA;
  140246. private _tmpAmmoVectorB;
  140247. private _tmpAmmoVectorC;
  140248. private _tmpAmmoVectorD;
  140249. private _tmpContactCallbackResult;
  140250. private _tmpAmmoVectorRCA;
  140251. private _tmpAmmoVectorRCB;
  140252. private _raycastResult;
  140253. private static readonly DISABLE_COLLISION_FLAG;
  140254. private static readonly KINEMATIC_FLAG;
  140255. private static readonly DISABLE_DEACTIVATION_FLAG;
  140256. /**
  140257. * Initializes the ammoJS plugin
  140258. * @param _useDeltaForWorldStep if the time between frames should be used when calculating physics steps (Default: true)
  140259. * @param ammoInjection can be used to inject your own ammo reference
  140260. * @param overlappingPairCache can be used to specify your own overlapping pair cache
  140261. */
  140262. constructor(_useDeltaForWorldStep?: boolean, ammoInjection?: any, overlappingPairCache?: any);
  140263. /**
  140264. * Sets the gravity of the physics world (m/(s^2))
  140265. * @param gravity Gravity to set
  140266. */
  140267. setGravity(gravity: Vector3): void;
  140268. /**
  140269. * Amount of time to step forward on each frame (only used if useDeltaForWorldStep is false in the constructor)
  140270. * @param timeStep timestep to use in seconds
  140271. */
  140272. setTimeStep(timeStep: number): void;
  140273. /**
  140274. * 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)
  140275. * @param fixedTimeStep fixedTimeStep to use in seconds
  140276. */
  140277. setFixedTimeStep(fixedTimeStep: number): void;
  140278. /**
  140279. * Sets the maximum number of steps by the physics engine per frame (Default: 5)
  140280. * @param maxSteps the maximum number of steps by the physics engine per frame
  140281. */
  140282. setMaxSteps(maxSteps: number): void;
  140283. /**
  140284. * Gets the current timestep (only used if useDeltaForWorldStep is false in the constructor)
  140285. * @returns the current timestep in seconds
  140286. */
  140287. getTimeStep(): number;
  140288. /**
  140289. * The create custom shape handler function to be called when using BABYLON.PhysicsImposter.CustomImpostor
  140290. */
  140291. onCreateCustomShape: (impostor: PhysicsImpostor) => any;
  140292. private _isImpostorInContact;
  140293. private _isImpostorPairInContact;
  140294. private _stepSimulation;
  140295. /**
  140296. * Moves the physics simulation forward delta seconds and updates the given physics imposters
  140297. * Prior to the step the imposters physics location is set to the position of the babylon meshes
  140298. * After the step the babylon meshes are set to the position of the physics imposters
  140299. * @param delta amount of time to step forward
  140300. * @param impostors array of imposters to update before/after the step
  140301. */
  140302. executeStep(delta: number, impostors: Array<PhysicsImpostor>): void;
  140303. /**
  140304. * Update babylon mesh to match physics world object
  140305. * @param impostor imposter to match
  140306. */
  140307. private _afterSoftStep;
  140308. /**
  140309. * Update babylon mesh vertices vertices to match physics world softbody or cloth
  140310. * @param impostor imposter to match
  140311. */
  140312. private _ropeStep;
  140313. /**
  140314. * Update babylon mesh vertices vertices to match physics world softbody or cloth
  140315. * @param impostor imposter to match
  140316. */
  140317. private _softbodyOrClothStep;
  140318. private _tmpMatrix;
  140319. /**
  140320. * Applies an impulse on the imposter
  140321. * @param impostor imposter to apply impulse to
  140322. * @param force amount of force to be applied to the imposter
  140323. * @param contactPoint the location to apply the impulse on the imposter
  140324. */
  140325. applyImpulse(impostor: PhysicsImpostor, force: Vector3, contactPoint: Vector3): void;
  140326. /**
  140327. * Applies a force on the imposter
  140328. * @param impostor imposter to apply force
  140329. * @param force amount of force to be applied to the imposter
  140330. * @param contactPoint the location to apply the force on the imposter
  140331. */
  140332. applyForce(impostor: PhysicsImpostor, force: Vector3, contactPoint: Vector3): void;
  140333. /**
  140334. * Creates a physics body using the plugin
  140335. * @param impostor the imposter to create the physics body on
  140336. */
  140337. generatePhysicsBody(impostor: PhysicsImpostor): void;
  140338. /**
  140339. * Removes the physics body from the imposter and disposes of the body's memory
  140340. * @param impostor imposter to remove the physics body from
  140341. */
  140342. removePhysicsBody(impostor: PhysicsImpostor): void;
  140343. /**
  140344. * Generates a joint
  140345. * @param impostorJoint the imposter joint to create the joint with
  140346. */
  140347. generateJoint(impostorJoint: PhysicsImpostorJoint): void;
  140348. /**
  140349. * Removes a joint
  140350. * @param impostorJoint the imposter joint to remove the joint from
  140351. */
  140352. removeJoint(impostorJoint: PhysicsImpostorJoint): void;
  140353. private _addMeshVerts;
  140354. /**
  140355. * Initialise the soft body vertices to match its object's (mesh) vertices
  140356. * Softbody vertices (nodes) are in world space and to match this
  140357. * The object's position and rotation is set to zero and so its vertices are also then set in world space
  140358. * @param impostor to create the softbody for
  140359. */
  140360. private _softVertexData;
  140361. /**
  140362. * Create an impostor's soft body
  140363. * @param impostor to create the softbody for
  140364. */
  140365. private _createSoftbody;
  140366. /**
  140367. * Create cloth for an impostor
  140368. * @param impostor to create the softbody for
  140369. */
  140370. private _createCloth;
  140371. /**
  140372. * Create rope for an impostor
  140373. * @param impostor to create the softbody for
  140374. */
  140375. private _createRope;
  140376. /**
  140377. * Create a custom physics impostor shape using the plugin's onCreateCustomShape handler
  140378. * @param impostor to create the custom physics shape for
  140379. */
  140380. private _createCustom;
  140381. private _addHullVerts;
  140382. private _createShape;
  140383. /**
  140384. * Sets the physics body position/rotation from the babylon mesh's position/rotation
  140385. * @param impostor imposter containing the physics body and babylon object
  140386. */
  140387. setTransformationFromPhysicsBody(impostor: PhysicsImpostor): void;
  140388. /**
  140389. * Sets the babylon object's position/rotation from the physics body's position/rotation
  140390. * @param impostor imposter containing the physics body and babylon object
  140391. * @param newPosition new position
  140392. * @param newRotation new rotation
  140393. */
  140394. setPhysicsBodyTransformation(impostor: PhysicsImpostor, newPosition: Vector3, newRotation: Quaternion): void;
  140395. /**
  140396. * If this plugin is supported
  140397. * @returns true if its supported
  140398. */
  140399. isSupported(): boolean;
  140400. /**
  140401. * Sets the linear velocity of the physics body
  140402. * @param impostor imposter to set the velocity on
  140403. * @param velocity velocity to set
  140404. */
  140405. setLinearVelocity(impostor: PhysicsImpostor, velocity: Vector3): void;
  140406. /**
  140407. * Sets the angular velocity of the physics body
  140408. * @param impostor imposter to set the velocity on
  140409. * @param velocity velocity to set
  140410. */
  140411. setAngularVelocity(impostor: PhysicsImpostor, velocity: Vector3): void;
  140412. /**
  140413. * gets the linear velocity
  140414. * @param impostor imposter to get linear velocity from
  140415. * @returns linear velocity
  140416. */
  140417. getLinearVelocity(impostor: PhysicsImpostor): Nullable<Vector3>;
  140418. /**
  140419. * gets the angular velocity
  140420. * @param impostor imposter to get angular velocity from
  140421. * @returns angular velocity
  140422. */
  140423. getAngularVelocity(impostor: PhysicsImpostor): Nullable<Vector3>;
  140424. /**
  140425. * Sets the mass of physics body
  140426. * @param impostor imposter to set the mass on
  140427. * @param mass mass to set
  140428. */
  140429. setBodyMass(impostor: PhysicsImpostor, mass: number): void;
  140430. /**
  140431. * Gets the mass of the physics body
  140432. * @param impostor imposter to get the mass from
  140433. * @returns mass
  140434. */
  140435. getBodyMass(impostor: PhysicsImpostor): number;
  140436. /**
  140437. * Gets friction of the impostor
  140438. * @param impostor impostor to get friction from
  140439. * @returns friction value
  140440. */
  140441. getBodyFriction(impostor: PhysicsImpostor): number;
  140442. /**
  140443. * Sets friction of the impostor
  140444. * @param impostor impostor to set friction on
  140445. * @param friction friction value
  140446. */
  140447. setBodyFriction(impostor: PhysicsImpostor, friction: number): void;
  140448. /**
  140449. * Gets restitution of the impostor
  140450. * @param impostor impostor to get restitution from
  140451. * @returns restitution value
  140452. */
  140453. getBodyRestitution(impostor: PhysicsImpostor): number;
  140454. /**
  140455. * Sets resitution of the impostor
  140456. * @param impostor impostor to set resitution on
  140457. * @param restitution resitution value
  140458. */
  140459. setBodyRestitution(impostor: PhysicsImpostor, restitution: number): void;
  140460. /**
  140461. * Gets pressure inside the impostor
  140462. * @param impostor impostor to get pressure from
  140463. * @returns pressure value
  140464. */
  140465. getBodyPressure(impostor: PhysicsImpostor): number;
  140466. /**
  140467. * Sets pressure inside a soft body impostor
  140468. * Cloth and rope must remain 0 pressure
  140469. * @param impostor impostor to set pressure on
  140470. * @param pressure pressure value
  140471. */
  140472. setBodyPressure(impostor: PhysicsImpostor, pressure: number): void;
  140473. /**
  140474. * Gets stiffness of the impostor
  140475. * @param impostor impostor to get stiffness from
  140476. * @returns pressure value
  140477. */
  140478. getBodyStiffness(impostor: PhysicsImpostor): number;
  140479. /**
  140480. * Sets stiffness of the impostor
  140481. * @param impostor impostor to set stiffness on
  140482. * @param stiffness stiffness value from 0 to 1
  140483. */
  140484. setBodyStiffness(impostor: PhysicsImpostor, stiffness: number): void;
  140485. /**
  140486. * Gets velocityIterations of the impostor
  140487. * @param impostor impostor to get velocity iterations from
  140488. * @returns velocityIterations value
  140489. */
  140490. getBodyVelocityIterations(impostor: PhysicsImpostor): number;
  140491. /**
  140492. * Sets velocityIterations of the impostor
  140493. * @param impostor impostor to set velocity iterations on
  140494. * @param velocityIterations velocityIterations value
  140495. */
  140496. setBodyVelocityIterations(impostor: PhysicsImpostor, velocityIterations: number): void;
  140497. /**
  140498. * Gets positionIterations of the impostor
  140499. * @param impostor impostor to get position iterations from
  140500. * @returns positionIterations value
  140501. */
  140502. getBodyPositionIterations(impostor: PhysicsImpostor): number;
  140503. /**
  140504. * Sets positionIterations of the impostor
  140505. * @param impostor impostor to set position on
  140506. * @param positionIterations positionIterations value
  140507. */
  140508. setBodyPositionIterations(impostor: PhysicsImpostor, positionIterations: number): void;
  140509. /**
  140510. * Append an anchor to a cloth object
  140511. * @param impostor is the cloth impostor to add anchor to
  140512. * @param otherImpostor is the rigid impostor to anchor to
  140513. * @param width ratio across width from 0 to 1
  140514. * @param height ratio up height from 0 to 1
  140515. * @param influence the elasticity between cloth impostor and anchor from 0, very stretchy to 1, little strech
  140516. * @param noCollisionBetweenLinkedBodies when true collisions between soft impostor and anchor are ignored; default false
  140517. */
  140518. appendAnchor(impostor: PhysicsImpostor, otherImpostor: PhysicsImpostor, width: number, height: number, influence?: number, noCollisionBetweenLinkedBodies?: boolean): void;
  140519. /**
  140520. * Append an hook to a rope object
  140521. * @param impostor is the rope impostor to add hook to
  140522. * @param otherImpostor is the rigid impostor to hook to
  140523. * @param length ratio along the rope from 0 to 1
  140524. * @param influence the elasticity between soft impostor and anchor from 0, very stretchy to 1, little strech
  140525. * @param noCollisionBetweenLinkedBodies when true collisions between soft impostor and anchor are ignored; default false
  140526. */
  140527. appendHook(impostor: PhysicsImpostor, otherImpostor: PhysicsImpostor, length: number, influence?: number, noCollisionBetweenLinkedBodies?: boolean): void;
  140528. /**
  140529. * Sleeps the physics body and stops it from being active
  140530. * @param impostor impostor to sleep
  140531. */
  140532. sleepBody(impostor: PhysicsImpostor): void;
  140533. /**
  140534. * Activates the physics body
  140535. * @param impostor impostor to activate
  140536. */
  140537. wakeUpBody(impostor: PhysicsImpostor): void;
  140538. /**
  140539. * Updates the distance parameters of the joint
  140540. * @param joint joint to update
  140541. * @param maxDistance maximum distance of the joint
  140542. * @param minDistance minimum distance of the joint
  140543. */
  140544. updateDistanceJoint(joint: PhysicsJoint, maxDistance: number, minDistance?: number): void;
  140545. /**
  140546. * Sets a motor on the joint
  140547. * @param joint joint to set motor on
  140548. * @param speed speed of the motor
  140549. * @param maxForce maximum force of the motor
  140550. * @param motorIndex index of the motor
  140551. */
  140552. setMotor(joint: IMotorEnabledJoint, speed?: number, maxForce?: number, motorIndex?: number): void;
  140553. /**
  140554. * Sets the motors limit
  140555. * @param joint joint to set limit on
  140556. * @param upperLimit upper limit
  140557. * @param lowerLimit lower limit
  140558. */
  140559. setLimit(joint: IMotorEnabledJoint, upperLimit: number, lowerLimit?: number): void;
  140560. /**
  140561. * Syncs the position and rotation of a mesh with the impostor
  140562. * @param mesh mesh to sync
  140563. * @param impostor impostor to update the mesh with
  140564. */
  140565. syncMeshWithImpostor(mesh: AbstractMesh, impostor: PhysicsImpostor): void;
  140566. /**
  140567. * Gets the radius of the impostor
  140568. * @param impostor impostor to get radius from
  140569. * @returns the radius
  140570. */
  140571. getRadius(impostor: PhysicsImpostor): number;
  140572. /**
  140573. * Gets the box size of the impostor
  140574. * @param impostor impostor to get box size from
  140575. * @param result the resulting box size
  140576. */
  140577. getBoxSizeToRef(impostor: PhysicsImpostor, result: Vector3): void;
  140578. /**
  140579. * Disposes of the impostor
  140580. */
  140581. dispose(): void;
  140582. /**
  140583. * Does a raycast in the physics world
  140584. * @param from when should the ray start?
  140585. * @param to when should the ray end?
  140586. * @returns PhysicsRaycastResult
  140587. */
  140588. raycast(from: Vector3, to: Vector3): PhysicsRaycastResult;
  140589. }
  140590. }
  140591. declare module BABYLON {
  140592. interface AbstractScene {
  140593. /**
  140594. * The list of reflection probes added to the scene
  140595. * @see https://doc.babylonjs.com/how_to/how_to_use_reflection_probes
  140596. */
  140597. reflectionProbes: Array<ReflectionProbe>;
  140598. /**
  140599. * Removes the given reflection probe from this scene.
  140600. * @param toRemove The reflection probe to remove
  140601. * @returns The index of the removed reflection probe
  140602. */
  140603. removeReflectionProbe(toRemove: ReflectionProbe): number;
  140604. /**
  140605. * Adds the given reflection probe to this scene.
  140606. * @param newReflectionProbe The reflection probe to add
  140607. */
  140608. addReflectionProbe(newReflectionProbe: ReflectionProbe): void;
  140609. }
  140610. /**
  140611. * Class used to generate realtime reflection / refraction cube textures
  140612. * @see https://doc.babylonjs.com/how_to/how_to_use_reflection_probes
  140613. */
  140614. export class ReflectionProbe {
  140615. /** defines the name of the probe */
  140616. name: string;
  140617. private _scene;
  140618. private _renderTargetTexture;
  140619. private _projectionMatrix;
  140620. private _viewMatrix;
  140621. private _target;
  140622. private _add;
  140623. private _attachedMesh;
  140624. private _invertYAxis;
  140625. /** Gets or sets probe position (center of the cube map) */
  140626. position: Vector3;
  140627. /**
  140628. * Creates a new reflection probe
  140629. * @param name defines the name of the probe
  140630. * @param size defines the texture resolution (for each face)
  140631. * @param scene defines the hosting scene
  140632. * @param generateMipMaps defines if mip maps should be generated automatically (true by default)
  140633. * @param useFloat defines if HDR data (flaot data) should be used to store colors (false by default)
  140634. */
  140635. constructor(
  140636. /** defines the name of the probe */
  140637. name: string, size: number, scene: Scene, generateMipMaps?: boolean, useFloat?: boolean);
  140638. /** Gets or sets the number of samples to use for multi-sampling (0 by default). Required WebGL2 */
  140639. get samples(): number;
  140640. set samples(value: number);
  140641. /** Gets or sets the refresh rate to use (on every frame by default) */
  140642. get refreshRate(): number;
  140643. set refreshRate(value: number);
  140644. /**
  140645. * Gets the hosting scene
  140646. * @returns a Scene
  140647. */
  140648. getScene(): Scene;
  140649. /** Gets the internal CubeTexture used to render to */
  140650. get cubeTexture(): RenderTargetTexture;
  140651. /** Gets the list of meshes to render */
  140652. get renderList(): Nullable<AbstractMesh[]>;
  140653. /**
  140654. * Attach the probe to a specific mesh (Rendering will be done from attached mesh's position)
  140655. * @param mesh defines the mesh to attach to
  140656. */
  140657. attachToMesh(mesh: Nullable<AbstractMesh>): void;
  140658. /**
  140659. * Specifies whether or not the stencil and depth buffer are cleared between two rendering groups
  140660. * @param renderingGroupId The rendering group id corresponding to its index
  140661. * @param autoClearDepthStencil Automatically clears depth and stencil between groups if true.
  140662. */
  140663. setRenderingAutoClearDepthStencil(renderingGroupId: number, autoClearDepthStencil: boolean): void;
  140664. /**
  140665. * Clean all associated resources
  140666. */
  140667. dispose(): void;
  140668. /**
  140669. * Converts the reflection probe information to a readable string for debug purpose.
  140670. * @param fullDetails Supports for multiple levels of logging within scene loading
  140671. * @returns the human readable reflection probe info
  140672. */
  140673. toString(fullDetails?: boolean): string;
  140674. /**
  140675. * Get the class name of the relfection probe.
  140676. * @returns "ReflectionProbe"
  140677. */
  140678. getClassName(): string;
  140679. /**
  140680. * Serialize the reflection probe to a JSON representation we can easily use in the resepective Parse function.
  140681. * @returns The JSON representation of the texture
  140682. */
  140683. serialize(): any;
  140684. /**
  140685. * Parse the JSON representation of a reflection probe in order to recreate the reflection probe in the given scene.
  140686. * @param parsedReflectionProbe Define the JSON representation of the reflection probe
  140687. * @param scene Define the scene the parsed reflection probe should be instantiated in
  140688. * @param rootUrl Define the root url of the parsing sequence in the case of relative dependencies
  140689. * @returns The parsed reflection probe if successful
  140690. */
  140691. static Parse(parsedReflectionProbe: any, scene: Scene, rootUrl: string): Nullable<ReflectionProbe>;
  140692. }
  140693. }
  140694. declare module BABYLON {
  140695. /** @hidden */
  140696. export var _BabylonLoaderRegistered: boolean;
  140697. /**
  140698. * Helps setting up some configuration for the babylon file loader.
  140699. */
  140700. export class BabylonFileLoaderConfiguration {
  140701. /**
  140702. * The loader does not allow injecting custom physix engine into the plugins.
  140703. * Unfortunately in ES6, we need to manually inject them into the plugin.
  140704. * So you could set this variable to your engine import to make it work.
  140705. */
  140706. static LoaderInjectedPhysicsEngine: any;
  140707. }
  140708. }
  140709. declare module BABYLON {
  140710. /**
  140711. * The Physically based simple base material of BJS.
  140712. *
  140713. * This enables better naming and convention enforcements on top of the pbrMaterial.
  140714. * It is used as the base class for both the specGloss and metalRough conventions.
  140715. */
  140716. export abstract class PBRBaseSimpleMaterial extends PBRBaseMaterial {
  140717. /**
  140718. * Number of Simultaneous lights allowed on the material.
  140719. */
  140720. maxSimultaneousLights: number;
  140721. /**
  140722. * If sets to true, disables all the lights affecting the material.
  140723. */
  140724. disableLighting: boolean;
  140725. /**
  140726. * Environment Texture used in the material (this is use for both reflection and environment lighting).
  140727. */
  140728. environmentTexture: BaseTexture;
  140729. /**
  140730. * If sets to true, x component of normal map value will invert (x = 1.0 - x).
  140731. */
  140732. invertNormalMapX: boolean;
  140733. /**
  140734. * If sets to true, y component of normal map value will invert (y = 1.0 - y).
  140735. */
  140736. invertNormalMapY: boolean;
  140737. /**
  140738. * Normal map used in the model.
  140739. */
  140740. normalTexture: BaseTexture;
  140741. /**
  140742. * Emissivie color used to self-illuminate the model.
  140743. */
  140744. emissiveColor: Color3;
  140745. /**
  140746. * Emissivie texture used to self-illuminate the model.
  140747. */
  140748. emissiveTexture: BaseTexture;
  140749. /**
  140750. * Occlusion Channel Strenght.
  140751. */
  140752. occlusionStrength: number;
  140753. /**
  140754. * Occlusion Texture of the material (adding extra occlusion effects).
  140755. */
  140756. occlusionTexture: BaseTexture;
  140757. /**
  140758. * Defines the alpha limits in alpha test mode.
  140759. */
  140760. alphaCutOff: number;
  140761. /**
  140762. * Gets the current double sided mode.
  140763. */
  140764. get doubleSided(): boolean;
  140765. /**
  140766. * If sets to true and backfaceCulling is false, normals will be flipped on the backside.
  140767. */
  140768. set doubleSided(value: boolean);
  140769. /**
  140770. * Stores the pre-calculated light information of a mesh in a texture.
  140771. */
  140772. lightmapTexture: BaseTexture;
  140773. /**
  140774. * If true, the light map contains occlusion information instead of lighting info.
  140775. */
  140776. useLightmapAsShadowmap: boolean;
  140777. /**
  140778. * Instantiates a new PBRMaterial instance.
  140779. *
  140780. * @param name The material name
  140781. * @param scene The scene the material will be use in.
  140782. */
  140783. constructor(name: string, scene: Scene);
  140784. getClassName(): string;
  140785. }
  140786. }
  140787. declare module BABYLON {
  140788. /**
  140789. * The PBR material of BJS following the metal roughness convention.
  140790. *
  140791. * This fits to the PBR convention in the GLTF definition:
  140792. * https://github.com/KhronosGroup/glTF/tree/2.0/specification/2.0
  140793. */
  140794. export class PBRMetallicRoughnessMaterial extends PBRBaseSimpleMaterial {
  140795. /**
  140796. * The base color has two different interpretations depending on the value of metalness.
  140797. * When the material is a metal, the base color is the specific measured reflectance value
  140798. * at normal incidence (F0). For a non-metal the base color represents the reflected diffuse color
  140799. * of the material.
  140800. */
  140801. baseColor: Color3;
  140802. /**
  140803. * Base texture of the metallic workflow. It contains both the baseColor information in RGB as
  140804. * well as opacity information in the alpha channel.
  140805. */
  140806. baseTexture: BaseTexture;
  140807. /**
  140808. * Specifies the metallic scalar value of the material.
  140809. * Can also be used to scale the metalness values of the metallic texture.
  140810. */
  140811. metallic: number;
  140812. /**
  140813. * Specifies the roughness scalar value of the material.
  140814. * Can also be used to scale the roughness values of the metallic texture.
  140815. */
  140816. roughness: number;
  140817. /**
  140818. * Texture containing both the metallic value in the B channel and the
  140819. * roughness value in the G channel to keep better precision.
  140820. */
  140821. metallicRoughnessTexture: BaseTexture;
  140822. /**
  140823. * Instantiates a new PBRMetalRoughnessMaterial instance.
  140824. *
  140825. * @param name The material name
  140826. * @param scene The scene the material will be use in.
  140827. */
  140828. constructor(name: string, scene: Scene);
  140829. /**
  140830. * Return the currrent class name of the material.
  140831. */
  140832. getClassName(): string;
  140833. /**
  140834. * Makes a duplicate of the current material.
  140835. * @param name - name to use for the new material.
  140836. */
  140837. clone(name: string): PBRMetallicRoughnessMaterial;
  140838. /**
  140839. * Serialize the material to a parsable JSON object.
  140840. */
  140841. serialize(): any;
  140842. /**
  140843. * Parses a JSON object correponding to the serialize function.
  140844. */
  140845. static Parse(source: any, scene: Scene, rootUrl: string): PBRMetallicRoughnessMaterial;
  140846. }
  140847. }
  140848. declare module BABYLON {
  140849. /**
  140850. * The PBR material of BJS following the specular glossiness convention.
  140851. *
  140852. * This fits to the PBR convention in the GLTF definition:
  140853. * https://github.com/KhronosGroup/glTF/tree/2.0/extensions/Khronos/KHR_materials_pbrSpecularGlossiness
  140854. */
  140855. export class PBRSpecularGlossinessMaterial extends PBRBaseSimpleMaterial {
  140856. /**
  140857. * Specifies the diffuse color of the material.
  140858. */
  140859. diffuseColor: Color3;
  140860. /**
  140861. * Specifies the diffuse texture of the material. This can also contains the opcity value in its alpha
  140862. * channel.
  140863. */
  140864. diffuseTexture: BaseTexture;
  140865. /**
  140866. * Specifies the specular color of the material. This indicates how reflective is the material (none to mirror).
  140867. */
  140868. specularColor: Color3;
  140869. /**
  140870. * Specifies the glossiness of the material. This indicates "how sharp is the reflection".
  140871. */
  140872. glossiness: number;
  140873. /**
  140874. * Specifies both the specular color RGB and the glossiness A of the material per pixels.
  140875. */
  140876. specularGlossinessTexture: BaseTexture;
  140877. /**
  140878. * Instantiates a new PBRSpecularGlossinessMaterial instance.
  140879. *
  140880. * @param name The material name
  140881. * @param scene The scene the material will be use in.
  140882. */
  140883. constructor(name: string, scene: Scene);
  140884. /**
  140885. * Return the currrent class name of the material.
  140886. */
  140887. getClassName(): string;
  140888. /**
  140889. * Makes a duplicate of the current material.
  140890. * @param name - name to use for the new material.
  140891. */
  140892. clone(name: string): PBRSpecularGlossinessMaterial;
  140893. /**
  140894. * Serialize the material to a parsable JSON object.
  140895. */
  140896. serialize(): any;
  140897. /**
  140898. * Parses a JSON object correponding to the serialize function.
  140899. */
  140900. static Parse(source: any, scene: Scene, rootUrl: string): PBRSpecularGlossinessMaterial;
  140901. }
  140902. }
  140903. declare module BABYLON {
  140904. /**
  140905. * This represents a color grading texture. This acts as a lookup table LUT, useful during post process
  140906. * It can help converting any input color in a desired output one. This can then be used to create effects
  140907. * from sepia, black and white to sixties or futuristic rendering...
  140908. *
  140909. * The only supported format is currently 3dl.
  140910. * More information on LUT: https://en.wikipedia.org/wiki/3D_lookup_table
  140911. */
  140912. export class ColorGradingTexture extends BaseTexture {
  140913. /**
  140914. * The texture URL.
  140915. */
  140916. url: string;
  140917. /**
  140918. * Empty line regex stored for GC.
  140919. */
  140920. private static _noneEmptyLineRegex;
  140921. private _textureMatrix;
  140922. private _onLoad;
  140923. /**
  140924. * Instantiates a ColorGradingTexture from the following parameters.
  140925. *
  140926. * @param url The location of the color gradind data (currently only supporting 3dl)
  140927. * @param sceneOrEngine The scene or engine the texture will be used in
  140928. * @param onLoad defines a callback triggered when the texture has been loaded
  140929. */
  140930. constructor(url: string, sceneOrEngine: Scene | ThinEngine, onLoad?: Nullable<() => void>);
  140931. /**
  140932. * Fires the onload event from the constructor if requested.
  140933. */
  140934. private _triggerOnLoad;
  140935. /**
  140936. * Returns the texture matrix used in most of the material.
  140937. * This is not used in color grading but keep for troubleshooting purpose (easily swap diffuse by colorgrading to look in).
  140938. */
  140939. getTextureMatrix(): Matrix;
  140940. /**
  140941. * Occurs when the file being loaded is a .3dl LUT file.
  140942. */
  140943. private load3dlTexture;
  140944. /**
  140945. * Starts the loading process of the texture.
  140946. */
  140947. private loadTexture;
  140948. /**
  140949. * Clones the color gradind texture.
  140950. */
  140951. clone(): ColorGradingTexture;
  140952. /**
  140953. * Called during delayed load for textures.
  140954. */
  140955. delayLoad(): void;
  140956. /**
  140957. * Parses a color grading texture serialized by Babylon.
  140958. * @param parsedTexture The texture information being parsedTexture
  140959. * @param scene The scene to load the texture in
  140960. * @param rootUrl The root url of the data assets to load
  140961. * @return A color gradind texture
  140962. */
  140963. static Parse(parsedTexture: any, scene: Scene): Nullable<ColorGradingTexture>;
  140964. /**
  140965. * Serializes the LUT texture to json format.
  140966. */
  140967. serialize(): any;
  140968. }
  140969. }
  140970. declare module BABYLON {
  140971. /**
  140972. * This represents a texture coming from an equirectangular image supported by the web browser canvas.
  140973. */
  140974. export class EquiRectangularCubeTexture extends BaseTexture {
  140975. /** The six faces of the cube. */
  140976. private static _FacesMapping;
  140977. private _noMipmap;
  140978. private _onLoad;
  140979. private _onError;
  140980. /** The size of the cubemap. */
  140981. private _size;
  140982. /** The buffer of the image. */
  140983. private _buffer;
  140984. /** The width of the input image. */
  140985. private _width;
  140986. /** The height of the input image. */
  140987. private _height;
  140988. /** The URL to the image. */
  140989. url: string;
  140990. /**
  140991. * Instantiates an EquiRectangularCubeTexture from the following parameters.
  140992. * @param url The location of the image
  140993. * @param scene The scene the texture will be used in
  140994. * @param size The cubemap desired size (the more it increases the longer the generation will be)
  140995. * @param noMipmap Forces to not generate the mipmap if true
  140996. * @param gammaSpace Specifies if the texture will be used in gamma or linear space
  140997. * (the PBR material requires those textures in linear space, but the standard material would require them in Gamma space)
  140998. * @param onLoad — defines a callback called when texture is loaded
  140999. * @param onError — defines a callback called if there is an error
  141000. */
  141001. constructor(url: string, scene: Scene, size: number, noMipmap?: boolean, gammaSpace?: boolean, onLoad?: Nullable<() => void>, onError?: Nullable<(message?: string, exception?: any) => void>);
  141002. /**
  141003. * Load the image data, by putting the image on a canvas and extracting its buffer.
  141004. */
  141005. private loadImage;
  141006. /**
  141007. * Convert the image buffer into a cubemap and create a CubeTexture.
  141008. */
  141009. private loadTexture;
  141010. /**
  141011. * Convert the ArrayBuffer into a Float32Array and drop the transparency channel.
  141012. * @param buffer The ArrayBuffer that should be converted.
  141013. * @returns The buffer as Float32Array.
  141014. */
  141015. private getFloat32ArrayFromArrayBuffer;
  141016. /**
  141017. * Get the current class name of the texture useful for serialization or dynamic coding.
  141018. * @returns "EquiRectangularCubeTexture"
  141019. */
  141020. getClassName(): string;
  141021. /**
  141022. * Create a clone of the current EquiRectangularCubeTexture and return it.
  141023. * @returns A clone of the current EquiRectangularCubeTexture.
  141024. */
  141025. clone(): EquiRectangularCubeTexture;
  141026. }
  141027. }
  141028. declare module BABYLON {
  141029. /**
  141030. * Defines the options related to the creation of an HtmlElementTexture
  141031. */
  141032. export interface IHtmlElementTextureOptions {
  141033. /**
  141034. * Defines wether mip maps should be created or not.
  141035. */
  141036. generateMipMaps?: boolean;
  141037. /**
  141038. * Defines the sampling mode of the texture.
  141039. */
  141040. samplingMode?: number;
  141041. /**
  141042. * Defines the engine instance to use the texture with. It is not mandatory if you define a scene.
  141043. */
  141044. engine: Nullable<ThinEngine>;
  141045. /**
  141046. * Defines the scene the texture belongs to. It is not mandatory if you define an engine.
  141047. */
  141048. scene: Nullable<Scene>;
  141049. }
  141050. /**
  141051. * This represents the smallest workload to use an already existing element (Canvas or Video) as a texture.
  141052. * To be as efficient as possible depending on your constraints nothing aside the first upload
  141053. * is automatically managed.
  141054. * It is a cheap VideoTexture or DynamicTexture if you prefer to keep full control of the elements
  141055. * in your application.
  141056. *
  141057. * As the update is not automatic, you need to call them manually.
  141058. */
  141059. export class HtmlElementTexture extends BaseTexture {
  141060. /**
  141061. * The texture URL.
  141062. */
  141063. element: HTMLVideoElement | HTMLCanvasElement;
  141064. private static readonly DefaultOptions;
  141065. private _textureMatrix;
  141066. private _isVideo;
  141067. private _generateMipMaps;
  141068. private _samplingMode;
  141069. /**
  141070. * Instantiates a HtmlElementTexture from the following parameters.
  141071. *
  141072. * @param name Defines the name of the texture
  141073. * @param element Defines the video or canvas the texture is filled with
  141074. * @param options Defines the other none mandatory texture creation options
  141075. */
  141076. constructor(name: string, element: HTMLVideoElement | HTMLCanvasElement, options: IHtmlElementTextureOptions);
  141077. private _createInternalTexture;
  141078. /**
  141079. * Returns the texture matrix used in most of the material.
  141080. */
  141081. getTextureMatrix(): Matrix;
  141082. /**
  141083. * Updates the content of the texture.
  141084. * @param invertY Defines wether the texture should be inverted on Y (false by default on video and true on canvas)
  141085. */
  141086. update(invertY?: Nullable<boolean>): void;
  141087. }
  141088. }
  141089. declare module BABYLON {
  141090. /**
  141091. * Based on jsTGALoader - Javascript loader for TGA file
  141092. * By Vincent Thibault
  141093. * @see http://blog.robrowser.com/javascript-tga-loader.html
  141094. */
  141095. export class TGATools {
  141096. private static _TYPE_INDEXED;
  141097. private static _TYPE_RGB;
  141098. private static _TYPE_GREY;
  141099. private static _TYPE_RLE_INDEXED;
  141100. private static _TYPE_RLE_RGB;
  141101. private static _TYPE_RLE_GREY;
  141102. private static _ORIGIN_MASK;
  141103. private static _ORIGIN_SHIFT;
  141104. private static _ORIGIN_BL;
  141105. private static _ORIGIN_BR;
  141106. private static _ORIGIN_UL;
  141107. private static _ORIGIN_UR;
  141108. /**
  141109. * Gets the header of a TGA file
  141110. * @param data defines the TGA data
  141111. * @returns the header
  141112. */
  141113. static GetTGAHeader(data: Uint8Array): any;
  141114. /**
  141115. * Uploads TGA content to a Babylon Texture
  141116. * @hidden
  141117. */
  141118. static UploadContent(texture: InternalTexture, data: Uint8Array): void;
  141119. /** @hidden */
  141120. 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;
  141121. /** @hidden */
  141122. 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;
  141123. /** @hidden */
  141124. 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;
  141125. /** @hidden */
  141126. 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;
  141127. /** @hidden */
  141128. 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;
  141129. /** @hidden */
  141130. 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;
  141131. }
  141132. }
  141133. declare module BABYLON {
  141134. /**
  141135. * Implementation of the TGA Texture Loader.
  141136. * @hidden
  141137. */
  141138. export class _TGATextureLoader implements IInternalTextureLoader {
  141139. /**
  141140. * Defines wether the loader supports cascade loading the different faces.
  141141. */
  141142. readonly supportCascades: boolean;
  141143. /**
  141144. * This returns if the loader support the current file information.
  141145. * @param extension defines the file extension of the file being loaded
  141146. * @returns true if the loader can load the specified file
  141147. */
  141148. canLoad(extension: string): boolean;
  141149. /**
  141150. * Uploads the cube texture data to the WebGL texture. It has already been bound.
  141151. * @param data contains the texture data
  141152. * @param texture defines the BabylonJS internal texture
  141153. * @param createPolynomials will be true if polynomials have been requested
  141154. * @param onLoad defines the callback to trigger once the texture is ready
  141155. * @param onError defines the callback to trigger in case of error
  141156. */
  141157. loadCubeData(data: ArrayBufferView | ArrayBufferView[], texture: InternalTexture, createPolynomials: boolean, onLoad: Nullable<(data?: any) => void>, onError: Nullable<(message?: string, exception?: any) => void>): void;
  141158. /**
  141159. * Uploads the 2D texture data to the WebGL texture. It has already been bound once in the callback.
  141160. * @param data contains the texture data
  141161. * @param texture defines the BabylonJS internal texture
  141162. * @param callback defines the method to call once ready to upload
  141163. */
  141164. loadData(data: ArrayBufferView, texture: InternalTexture, callback: (width: number, height: number, loadMipmap: boolean, isCompressed: boolean, done: () => void) => void): void;
  141165. }
  141166. }
  141167. declare module BABYLON {
  141168. /**
  141169. * Info about the .basis files
  141170. */
  141171. class BasisFileInfo {
  141172. /**
  141173. * If the file has alpha
  141174. */
  141175. hasAlpha: boolean;
  141176. /**
  141177. * Info about each image of the basis file
  141178. */
  141179. images: Array<{
  141180. levels: Array<{
  141181. width: number;
  141182. height: number;
  141183. transcodedPixels: ArrayBufferView;
  141184. }>;
  141185. }>;
  141186. }
  141187. /**
  141188. * Result of transcoding a basis file
  141189. */
  141190. class TranscodeResult {
  141191. /**
  141192. * Info about the .basis file
  141193. */
  141194. fileInfo: BasisFileInfo;
  141195. /**
  141196. * Format to use when loading the file
  141197. */
  141198. format: number;
  141199. }
  141200. /**
  141201. * Configuration options for the Basis transcoder
  141202. */
  141203. export class BasisTranscodeConfiguration {
  141204. /**
  141205. * Supported compression formats used to determine the supported output format of the transcoder
  141206. */
  141207. supportedCompressionFormats?: {
  141208. /**
  141209. * etc1 compression format
  141210. */
  141211. etc1?: boolean;
  141212. /**
  141213. * s3tc compression format
  141214. */
  141215. s3tc?: boolean;
  141216. /**
  141217. * pvrtc compression format
  141218. */
  141219. pvrtc?: boolean;
  141220. /**
  141221. * etc2 compression format
  141222. */
  141223. etc2?: boolean;
  141224. };
  141225. /**
  141226. * If mipmap levels should be loaded for transcoded images (Default: true)
  141227. */
  141228. loadMipmapLevels?: boolean;
  141229. /**
  141230. * Index of a single image to load (Default: all images)
  141231. */
  141232. loadSingleImage?: number;
  141233. }
  141234. /**
  141235. * Used to load .Basis files
  141236. * See https://github.com/BinomialLLC/basis_universal/tree/master/webgl
  141237. */
  141238. export class BasisTools {
  141239. private static _IgnoreSupportedFormats;
  141240. /**
  141241. * URL to use when loading the basis transcoder
  141242. */
  141243. static JSModuleURL: string;
  141244. /**
  141245. * URL to use when loading the wasm module for the transcoder
  141246. */
  141247. static WasmModuleURL: string;
  141248. /**
  141249. * Get the internal format to be passed to texImage2D corresponding to the .basis format value
  141250. * @param basisFormat format chosen from GetSupportedTranscodeFormat
  141251. * @returns internal format corresponding to the Basis format
  141252. */
  141253. static GetInternalFormatFromBasisFormat(basisFormat: number): number;
  141254. private static _WorkerPromise;
  141255. private static _Worker;
  141256. private static _actionId;
  141257. private static _CreateWorkerAsync;
  141258. /**
  141259. * Transcodes a loaded image file to compressed pixel data
  141260. * @param data image data to transcode
  141261. * @param config configuration options for the transcoding
  141262. * @returns a promise resulting in the transcoded image
  141263. */
  141264. static TranscodeAsync(data: ArrayBuffer | ArrayBufferView, config: BasisTranscodeConfiguration): Promise<TranscodeResult>;
  141265. /**
  141266. * Loads a texture from the transcode result
  141267. * @param texture texture load to
  141268. * @param transcodeResult the result of transcoding the basis file to load from
  141269. */
  141270. static LoadTextureFromTranscodeResult(texture: InternalTexture, transcodeResult: TranscodeResult): void;
  141271. }
  141272. }
  141273. declare module BABYLON {
  141274. /**
  141275. * Loader for .basis file format
  141276. */
  141277. export class _BasisTextureLoader implements IInternalTextureLoader {
  141278. /**
  141279. * Defines whether the loader supports cascade loading the different faces.
  141280. */
  141281. readonly supportCascades: boolean;
  141282. /**
  141283. * This returns if the loader support the current file information.
  141284. * @param extension defines the file extension of the file being loaded
  141285. * @returns true if the loader can load the specified file
  141286. */
  141287. canLoad(extension: string): boolean;
  141288. /**
  141289. * Uploads the cube texture data to the WebGL texture. It has already been bound.
  141290. * @param data contains the texture data
  141291. * @param texture defines the BabylonJS internal texture
  141292. * @param createPolynomials will be true if polynomials have been requested
  141293. * @param onLoad defines the callback to trigger once the texture is ready
  141294. * @param onError defines the callback to trigger in case of error
  141295. */
  141296. loadCubeData(data: ArrayBufferView | ArrayBufferView[], texture: InternalTexture, createPolynomials: boolean, onLoad: Nullable<(data?: any) => void>, onError: Nullable<(message?: string, exception?: any) => void>): void;
  141297. /**
  141298. * Uploads the 2D texture data to the WebGL texture. It has already been bound once in the callback.
  141299. * @param data contains the texture data
  141300. * @param texture defines the BabylonJS internal texture
  141301. * @param callback defines the method to call once ready to upload
  141302. */
  141303. loadData(data: ArrayBufferView, texture: InternalTexture, callback: (width: number, height: number, loadMipmap: boolean, isCompressed: boolean, done: () => void) => void): void;
  141304. }
  141305. }
  141306. declare module BABYLON {
  141307. /**
  141308. * Defines the basic options interface of a TexturePacker Frame
  141309. */
  141310. export interface ITexturePackerFrame {
  141311. /**
  141312. * The frame ID
  141313. */
  141314. id: number;
  141315. /**
  141316. * The frames Scale
  141317. */
  141318. scale: Vector2;
  141319. /**
  141320. * The Frames offset
  141321. */
  141322. offset: Vector2;
  141323. }
  141324. /**
  141325. * This is a support class for frame Data on texture packer sets.
  141326. */
  141327. export class TexturePackerFrame implements ITexturePackerFrame {
  141328. /**
  141329. * The frame ID
  141330. */
  141331. id: number;
  141332. /**
  141333. * The frames Scale
  141334. */
  141335. scale: Vector2;
  141336. /**
  141337. * The Frames offset
  141338. */
  141339. offset: Vector2;
  141340. /**
  141341. * Initializes a texture package frame.
  141342. * @param id The numerical frame identifier
  141343. * @param scale Scalar Vector2 for UV frame
  141344. * @param offset Vector2 for the frame position in UV units.
  141345. * @returns TexturePackerFrame
  141346. */
  141347. constructor(id: number, scale: Vector2, offset: Vector2);
  141348. }
  141349. }
  141350. declare module BABYLON {
  141351. /**
  141352. * Defines the basic options interface of a TexturePacker
  141353. */
  141354. export interface ITexturePackerOptions {
  141355. /**
  141356. * Custom targets for the channels of a texture packer. Default is all the channels of the Standard Material
  141357. */
  141358. map?: string[];
  141359. /**
  141360. * the UV input targets, as a single value for all meshes. Defaults to VertexBuffer.UVKind
  141361. */
  141362. uvsIn?: string;
  141363. /**
  141364. * the UV output targets, as a single value for all meshes. Defaults to VertexBuffer.UVKind
  141365. */
  141366. uvsOut?: string;
  141367. /**
  141368. * number representing the layout style. Defaults to LAYOUT_STRIP
  141369. */
  141370. layout?: number;
  141371. /**
  141372. * number of columns if using custom column count layout(2). This defaults to 4.
  141373. */
  141374. colnum?: number;
  141375. /**
  141376. * flag to update the input meshes to the new packed texture after compilation. Defaults to true.
  141377. */
  141378. updateInputMeshes?: boolean;
  141379. /**
  141380. * boolean flag to dispose all the source textures. Defaults to true.
  141381. */
  141382. disposeSources?: boolean;
  141383. /**
  141384. * Fills the blank cells in a set to the customFillColor. Defaults to true.
  141385. */
  141386. fillBlanks?: boolean;
  141387. /**
  141388. * string value representing the context fill style color. Defaults to 'black'.
  141389. */
  141390. customFillColor?: string;
  141391. /**
  141392. * Width and Height Value of each Frame in the TexturePacker Sets
  141393. */
  141394. frameSize?: number;
  141395. /**
  141396. * Ratio of the value to add padding wise to each cell. Defaults to 0.0115
  141397. */
  141398. paddingRatio?: number;
  141399. /**
  141400. * Number that declares the fill method for the padding gutter.
  141401. */
  141402. paddingMode?: number;
  141403. /**
  141404. * If in SUBUV_COLOR padding mode what color to use.
  141405. */
  141406. paddingColor?: Color3 | Color4;
  141407. }
  141408. /**
  141409. * Defines the basic interface of a TexturePacker JSON File
  141410. */
  141411. export interface ITexturePackerJSON {
  141412. /**
  141413. * The frame ID
  141414. */
  141415. name: string;
  141416. /**
  141417. * The base64 channel data
  141418. */
  141419. sets: any;
  141420. /**
  141421. * The options of the Packer
  141422. */
  141423. options: ITexturePackerOptions;
  141424. /**
  141425. * The frame data of the Packer
  141426. */
  141427. frames: Array<number>;
  141428. }
  141429. /**
  141430. * This is a support class that generates a series of packed texture sets.
  141431. * @see https://doc.babylonjs.com/babylon101/materials
  141432. */
  141433. export class TexturePacker {
  141434. /** Packer Layout Constant 0 */
  141435. static readonly LAYOUT_STRIP: number;
  141436. /** Packer Layout Constant 1 */
  141437. static readonly LAYOUT_POWER2: number;
  141438. /** Packer Layout Constant 2 */
  141439. static readonly LAYOUT_COLNUM: number;
  141440. /** Packer Layout Constant 0 */
  141441. static readonly SUBUV_WRAP: number;
  141442. /** Packer Layout Constant 1 */
  141443. static readonly SUBUV_EXTEND: number;
  141444. /** Packer Layout Constant 2 */
  141445. static readonly SUBUV_COLOR: number;
  141446. /** The Name of the Texture Package */
  141447. name: string;
  141448. /** The scene scope of the TexturePacker */
  141449. scene: Scene;
  141450. /** The Meshes to target */
  141451. meshes: AbstractMesh[];
  141452. /** Arguments passed with the Constructor */
  141453. options: ITexturePackerOptions;
  141454. /** The promise that is started upon initialization */
  141455. promise: Nullable<Promise<TexturePacker | string>>;
  141456. /** The Container object for the channel sets that are generated */
  141457. sets: object;
  141458. /** The Container array for the frames that are generated */
  141459. frames: TexturePackerFrame[];
  141460. /** The expected number of textures the system is parsing. */
  141461. private _expecting;
  141462. /** The padding value from Math.ceil(frameSize * paddingRatio) */
  141463. private _paddingValue;
  141464. /**
  141465. * Initializes a texture package series from an array of meshes or a single mesh.
  141466. * @param name The name of the package
  141467. * @param meshes The target meshes to compose the package from
  141468. * @param options The arguments that texture packer should follow while building.
  141469. * @param scene The scene which the textures are scoped to.
  141470. * @returns TexturePacker
  141471. */
  141472. constructor(name: string, meshes: AbstractMesh[], options: ITexturePackerOptions, scene: Scene);
  141473. /**
  141474. * Starts the package process
  141475. * @param resolve The promises resolution function
  141476. * @returns TexturePacker
  141477. */
  141478. private _createFrames;
  141479. /**
  141480. * Calculates the Size of the Channel Sets
  141481. * @returns Vector2
  141482. */
  141483. private _calculateSize;
  141484. /**
  141485. * Calculates the UV data for the frames.
  141486. * @param baseSize the base frameSize
  141487. * @param padding the base frame padding
  141488. * @param dtSize size of the Dynamic Texture for that channel
  141489. * @param dtUnits is 1/dtSize
  141490. * @param update flag to update the input meshes
  141491. */
  141492. private _calculateMeshUVFrames;
  141493. /**
  141494. * Calculates the frames Offset.
  141495. * @param index of the frame
  141496. * @returns Vector2
  141497. */
  141498. private _getFrameOffset;
  141499. /**
  141500. * Updates a Mesh to the frame data
  141501. * @param mesh that is the target
  141502. * @param frameID or the frame index
  141503. */
  141504. private _updateMeshUV;
  141505. /**
  141506. * Updates a Meshes materials to use the texture packer channels
  141507. * @param m is the mesh to target
  141508. * @param force all channels on the packer to be set.
  141509. */
  141510. private _updateTextureReferences;
  141511. /**
  141512. * Public method to set a Mesh to a frame
  141513. * @param m that is the target
  141514. * @param frameID or the frame index
  141515. * @param updateMaterial trigger for if the Meshes attached Material be updated?
  141516. */
  141517. setMeshToFrame(m: AbstractMesh, frameID: number, updateMaterial?: boolean): void;
  141518. /**
  141519. * Starts the async promise to compile the texture packer.
  141520. * @returns Promise<void>
  141521. */
  141522. processAsync(): Promise<void>;
  141523. /**
  141524. * Disposes all textures associated with this packer
  141525. */
  141526. dispose(): void;
  141527. /**
  141528. * Starts the download process for all the channels converting them to base64 data and embedding it all in a JSON file.
  141529. * @param imageType is the image type to use.
  141530. * @param quality of the image if downloading as jpeg, Ranges from >0 to 1.
  141531. */
  141532. download(imageType?: string, quality?: number): void;
  141533. /**
  141534. * Public method to load a texturePacker JSON file.
  141535. * @param data of the JSON file in string format.
  141536. */
  141537. updateFromJSON(data: string): void;
  141538. }
  141539. }
  141540. declare module BABYLON {
  141541. /**
  141542. * 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.
  141543. * Custom Procedural textures are the easiest way to create your own procedural in your application.
  141544. * @see https://doc.babylonjs.com/how_to/how_to_use_procedural_textures#creating-custom-procedural-textures
  141545. */
  141546. export class CustomProceduralTexture extends ProceduralTexture {
  141547. private _animate;
  141548. private _time;
  141549. private _config;
  141550. private _texturePath;
  141551. /**
  141552. * Instantiates a new Custom Procedural Texture.
  141553. * 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.
  141554. * Custom Procedural textures are the easiest way to create your own procedural in your application.
  141555. * @see https://doc.babylonjs.com/how_to/how_to_use_procedural_textures#creating-custom-procedural-textures
  141556. * @param name Define the name of the texture
  141557. * @param texturePath Define the folder path containing all the cutom texture related files (config, shaders...)
  141558. * @param size Define the size of the texture to create
  141559. * @param scene Define the scene the texture belongs to
  141560. * @param fallbackTexture Define a fallback texture in case there were issues to create the custom texture
  141561. * @param generateMipMaps Define if the texture should creates mip maps or not
  141562. */
  141563. constructor(name: string, texturePath: string, size: number, scene: Scene, fallbackTexture?: Texture, generateMipMaps?: boolean);
  141564. private _loadJson;
  141565. /**
  141566. * Is the texture ready to be used ? (rendered at least once)
  141567. * @returns true if ready, otherwise, false.
  141568. */
  141569. isReady(): boolean;
  141570. /**
  141571. * Render the texture to its associated render target.
  141572. * @param useCameraPostProcess Define if camera post process should be applied to the texture
  141573. */
  141574. render(useCameraPostProcess?: boolean): void;
  141575. /**
  141576. * Update the list of dependant textures samplers in the shader.
  141577. */
  141578. updateTextures(): void;
  141579. /**
  141580. * Update the uniform values of the procedural texture in the shader.
  141581. */
  141582. updateShaderUniforms(): void;
  141583. /**
  141584. * Define if the texture animates or not.
  141585. */
  141586. get animate(): boolean;
  141587. set animate(value: boolean);
  141588. }
  141589. }
  141590. declare module BABYLON {
  141591. /** @hidden */
  141592. export var noisePixelShader: {
  141593. name: string;
  141594. shader: string;
  141595. };
  141596. }
  141597. declare module BABYLON {
  141598. /**
  141599. * Class used to generate noise procedural textures
  141600. */
  141601. export class NoiseProceduralTexture extends ProceduralTexture {
  141602. private _time;
  141603. /** Gets or sets a value between 0 and 1 indicating the overall brightness of the texture (default is 0.2) */
  141604. brightness: number;
  141605. /** Defines the number of octaves to process */
  141606. octaves: number;
  141607. /** Defines the level of persistence (0.8 by default) */
  141608. persistence: number;
  141609. /** Gets or sets animation speed factor (default is 1) */
  141610. animationSpeedFactor: number;
  141611. /**
  141612. * Creates a new NoiseProceduralTexture
  141613. * @param name defines the name fo the texture
  141614. * @param size defines the size of the texture (default is 256)
  141615. * @param scene defines the hosting scene
  141616. * @param fallbackTexture defines the texture to use if the NoiseProceduralTexture can't be created
  141617. * @param generateMipMaps defines if mipmaps must be generated (true by default)
  141618. */
  141619. constructor(name: string, size?: number, scene?: Nullable<Scene>, fallbackTexture?: Texture, generateMipMaps?: boolean);
  141620. private _updateShaderUniforms;
  141621. protected _getDefines(): string;
  141622. /** Generate the current state of the procedural texture */
  141623. render(useCameraPostProcess?: boolean): void;
  141624. /**
  141625. * Serializes this noise procedural texture
  141626. * @returns a serialized noise procedural texture object
  141627. */
  141628. serialize(): any;
  141629. /**
  141630. * Clone the texture.
  141631. * @returns the cloned texture
  141632. */
  141633. clone(): NoiseProceduralTexture;
  141634. /**
  141635. * Creates a NoiseProceduralTexture from parsed noise procedural texture data
  141636. * @param parsedTexture defines parsed texture data
  141637. * @param scene defines the current scene
  141638. * @param rootUrl defines the root URL containing noise procedural texture information
  141639. * @returns a parsed NoiseProceduralTexture
  141640. */
  141641. static Parse(parsedTexture: any, scene: Scene): NoiseProceduralTexture;
  141642. }
  141643. }
  141644. declare module BABYLON {
  141645. /**
  141646. * Raw cube texture where the raw buffers are passed in
  141647. */
  141648. export class RawCubeTexture extends CubeTexture {
  141649. /**
  141650. * Creates a cube texture where the raw buffers are passed in.
  141651. * @param scene defines the scene the texture is attached to
  141652. * @param data defines the array of data to use to create each face
  141653. * @param size defines the size of the textures
  141654. * @param format defines the format of the data
  141655. * @param type defines the type of the data (like Engine.TEXTURETYPE_UNSIGNED_INT)
  141656. * @param generateMipMaps defines if the engine should generate the mip levels
  141657. * @param invertY defines if data must be stored with Y axis inverted
  141658. * @param samplingMode defines the required sampling mode (like Texture.NEAREST_SAMPLINGMODE)
  141659. * @param compression defines the compression used (null by default)
  141660. */
  141661. constructor(scene: Scene, data: Nullable<ArrayBufferView[]>, size: number, format?: number, type?: number, generateMipMaps?: boolean, invertY?: boolean, samplingMode?: number, compression?: Nullable<string>);
  141662. /**
  141663. * Updates the raw cube texture.
  141664. * @param data defines the data to store
  141665. * @param format defines the data format
  141666. * @param type defines the type fo the data (Engine.TEXTURETYPE_UNSIGNED_INT by default)
  141667. * @param invertY defines if data must be stored with Y axis inverted
  141668. * @param compression defines the compression used (null by default)
  141669. * @param level defines which level of the texture to update
  141670. */
  141671. update(data: ArrayBufferView[], format: number, type: number, invertY: boolean, compression?: Nullable<string>): void;
  141672. /**
  141673. * Updates a raw cube texture with RGBD encoded data.
  141674. * @param data defines the array of data [mipmap][face] to use to create each face
  141675. * @param sphericalPolynomial defines the spherical polynomial for irradiance
  141676. * @param lodScale defines the scale applied to environment texture. This manages the range of LOD level used for IBL according to the roughness
  141677. * @param lodOffset defines the offset applied to environment texture. This manages first LOD level used for IBL according to the roughness
  141678. * @returns a promsie that resolves when the operation is complete
  141679. */
  141680. updateRGBDAsync(data: ArrayBufferView[][], sphericalPolynomial?: Nullable<SphericalPolynomial>, lodScale?: number, lodOffset?: number): Promise<void>;
  141681. /**
  141682. * Clones the raw cube texture.
  141683. * @return a new cube texture
  141684. */
  141685. clone(): CubeTexture;
  141686. /** @hidden */
  141687. static _UpdateRGBDAsync(internalTexture: InternalTexture, data: ArrayBufferView[][], sphericalPolynomial: Nullable<SphericalPolynomial>, lodScale: number, lodOffset: number): Promise<void>;
  141688. }
  141689. }
  141690. declare module BABYLON {
  141691. /**
  141692. * Class used to store 2D array textures containing user data
  141693. */
  141694. export class RawTexture2DArray extends Texture {
  141695. /** Gets or sets the texture format to use */
  141696. format: number;
  141697. /**
  141698. * Create a new RawTexture2DArray
  141699. * @param data defines the data of the texture
  141700. * @param width defines the width of the texture
  141701. * @param height defines the height of the texture
  141702. * @param depth defines the number of layers of the texture
  141703. * @param format defines the texture format to use
  141704. * @param scene defines the hosting scene
  141705. * @param generateMipMaps defines a boolean indicating if mip levels should be generated (true by default)
  141706. * @param invertY defines if texture must be stored with Y axis inverted
  141707. * @param samplingMode defines the sampling mode to use (Texture.TRILINEAR_SAMPLINGMODE by default)
  141708. * @param textureType defines the texture Type (Engine.TEXTURETYPE_UNSIGNED_INT, Engine.TEXTURETYPE_FLOAT...)
  141709. */
  141710. constructor(data: ArrayBufferView, width: number, height: number, depth: number,
  141711. /** Gets or sets the texture format to use */
  141712. format: number, scene: Scene, generateMipMaps?: boolean, invertY?: boolean, samplingMode?: number, textureType?: number);
  141713. /**
  141714. * Update the texture with new data
  141715. * @param data defines the data to store in the texture
  141716. */
  141717. update(data: ArrayBufferView): void;
  141718. }
  141719. }
  141720. declare module BABYLON {
  141721. /**
  141722. * Class used to store 3D textures containing user data
  141723. */
  141724. export class RawTexture3D extends Texture {
  141725. /** Gets or sets the texture format to use */
  141726. format: number;
  141727. /**
  141728. * Create a new RawTexture3D
  141729. * @param data defines the data of the texture
  141730. * @param width defines the width of the texture
  141731. * @param height defines the height of the texture
  141732. * @param depth defines the depth of the texture
  141733. * @param format defines the texture format to use
  141734. * @param scene defines the hosting scene
  141735. * @param generateMipMaps defines a boolean indicating if mip levels should be generated (true by default)
  141736. * @param invertY defines if texture must be stored with Y axis inverted
  141737. * @param samplingMode defines the sampling mode to use (Texture.TRILINEAR_SAMPLINGMODE by default)
  141738. * @param textureType defines the texture Type (Engine.TEXTURETYPE_UNSIGNED_INT, Engine.TEXTURETYPE_FLOAT...)
  141739. */
  141740. constructor(data: ArrayBufferView, width: number, height: number, depth: number,
  141741. /** Gets or sets the texture format to use */
  141742. format: number, scene: Scene, generateMipMaps?: boolean, invertY?: boolean, samplingMode?: number, textureType?: number);
  141743. /**
  141744. * Update the texture with new data
  141745. * @param data defines the data to store in the texture
  141746. */
  141747. update(data: ArrayBufferView): void;
  141748. }
  141749. }
  141750. declare module BABYLON {
  141751. /**
  141752. * Creates a refraction texture used by refraction channel of the standard material.
  141753. * It is like a mirror but to see through a material.
  141754. * @see https://doc.babylonjs.com/how_to/reflect#refraction
  141755. */
  141756. export class RefractionTexture extends RenderTargetTexture {
  141757. /**
  141758. * Define the reflection plane we want to use. The refractionPlane is usually set to the constructed refractor.
  141759. * 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.
  141760. * @see https://doc.babylonjs.com/how_to/reflect#refraction
  141761. */
  141762. refractionPlane: Plane;
  141763. /**
  141764. * Define how deep under the surface we should see.
  141765. */
  141766. depth: number;
  141767. /**
  141768. * Creates a refraction texture used by refraction channel of the standard material.
  141769. * It is like a mirror but to see through a material.
  141770. * @see https://doc.babylonjs.com/how_to/reflect#refraction
  141771. * @param name Define the texture name
  141772. * @param size Define the size of the underlying texture
  141773. * @param scene Define the scene the refraction belongs to
  141774. * @param generateMipMaps Define if we need to generate mips level for the refraction
  141775. */
  141776. constructor(name: string, size: number, scene: Scene, generateMipMaps?: boolean);
  141777. /**
  141778. * Clone the refraction texture.
  141779. * @returns the cloned texture
  141780. */
  141781. clone(): RefractionTexture;
  141782. /**
  141783. * Serialize the texture to a JSON representation you could use in Parse later on
  141784. * @returns the serialized JSON representation
  141785. */
  141786. serialize(): any;
  141787. }
  141788. }
  141789. declare module BABYLON {
  141790. /**
  141791. * Block used to add support for vertex skinning (bones)
  141792. */
  141793. export class BonesBlock extends NodeMaterialBlock {
  141794. /**
  141795. * Creates a new BonesBlock
  141796. * @param name defines the block name
  141797. */
  141798. constructor(name: string);
  141799. /**
  141800. * Initialize the block and prepare the context for build
  141801. * @param state defines the state that will be used for the build
  141802. */
  141803. initialize(state: NodeMaterialBuildState): void;
  141804. /**
  141805. * Gets the current class name
  141806. * @returns the class name
  141807. */
  141808. getClassName(): string;
  141809. /**
  141810. * Gets the matrix indices input component
  141811. */
  141812. get matricesIndices(): NodeMaterialConnectionPoint;
  141813. /**
  141814. * Gets the matrix weights input component
  141815. */
  141816. get matricesWeights(): NodeMaterialConnectionPoint;
  141817. /**
  141818. * Gets the extra matrix indices input component
  141819. */
  141820. get matricesIndicesExtra(): NodeMaterialConnectionPoint;
  141821. /**
  141822. * Gets the extra matrix weights input component
  141823. */
  141824. get matricesWeightsExtra(): NodeMaterialConnectionPoint;
  141825. /**
  141826. * Gets the world input component
  141827. */
  141828. get world(): NodeMaterialConnectionPoint;
  141829. /**
  141830. * Gets the output component
  141831. */
  141832. get output(): NodeMaterialConnectionPoint;
  141833. autoConfigure(material: NodeMaterial): void;
  141834. provideFallbacks(mesh: AbstractMesh, fallbacks: EffectFallbacks): void;
  141835. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh): void;
  141836. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  141837. protected _buildBlock(state: NodeMaterialBuildState): this;
  141838. }
  141839. }
  141840. declare module BABYLON {
  141841. /**
  141842. * Block used to add support for instances
  141843. * @see https://doc.babylonjs.com/how_to/how_to_use_instances
  141844. */
  141845. export class InstancesBlock extends NodeMaterialBlock {
  141846. /**
  141847. * Creates a new InstancesBlock
  141848. * @param name defines the block name
  141849. */
  141850. constructor(name: string);
  141851. /**
  141852. * Gets the current class name
  141853. * @returns the class name
  141854. */
  141855. getClassName(): string;
  141856. /**
  141857. * Gets the first world row input component
  141858. */
  141859. get world0(): NodeMaterialConnectionPoint;
  141860. /**
  141861. * Gets the second world row input component
  141862. */
  141863. get world1(): NodeMaterialConnectionPoint;
  141864. /**
  141865. * Gets the third world row input component
  141866. */
  141867. get world2(): NodeMaterialConnectionPoint;
  141868. /**
  141869. * Gets the forth world row input component
  141870. */
  141871. get world3(): NodeMaterialConnectionPoint;
  141872. /**
  141873. * Gets the world input component
  141874. */
  141875. get world(): NodeMaterialConnectionPoint;
  141876. /**
  141877. * Gets the output component
  141878. */
  141879. get output(): NodeMaterialConnectionPoint;
  141880. /**
  141881. * Gets the isntanceID component
  141882. */
  141883. get instanceID(): NodeMaterialConnectionPoint;
  141884. autoConfigure(material: NodeMaterial): void;
  141885. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines, useInstances?: boolean, subMesh?: SubMesh): void;
  141886. protected _buildBlock(state: NodeMaterialBuildState): this;
  141887. }
  141888. }
  141889. declare module BABYLON {
  141890. /**
  141891. * Block used to add morph targets support to vertex shader
  141892. */
  141893. export class MorphTargetsBlock extends NodeMaterialBlock {
  141894. private _repeatableContentAnchor;
  141895. /**
  141896. * Create a new MorphTargetsBlock
  141897. * @param name defines the block name
  141898. */
  141899. constructor(name: string);
  141900. /**
  141901. * Gets the current class name
  141902. * @returns the class name
  141903. */
  141904. getClassName(): string;
  141905. /**
  141906. * Gets the position input component
  141907. */
  141908. get position(): NodeMaterialConnectionPoint;
  141909. /**
  141910. * Gets the normal input component
  141911. */
  141912. get normal(): NodeMaterialConnectionPoint;
  141913. /**
  141914. * Gets the tangent input component
  141915. */
  141916. get tangent(): NodeMaterialConnectionPoint;
  141917. /**
  141918. * Gets the tangent input component
  141919. */
  141920. get uv(): NodeMaterialConnectionPoint;
  141921. /**
  141922. * Gets the position output component
  141923. */
  141924. get positionOutput(): NodeMaterialConnectionPoint;
  141925. /**
  141926. * Gets the normal output component
  141927. */
  141928. get normalOutput(): NodeMaterialConnectionPoint;
  141929. /**
  141930. * Gets the tangent output component
  141931. */
  141932. get tangentOutput(): NodeMaterialConnectionPoint;
  141933. /**
  141934. * Gets the tangent output component
  141935. */
  141936. get uvOutput(): NodeMaterialConnectionPoint;
  141937. initialize(state: NodeMaterialBuildState): void;
  141938. autoConfigure(material: NodeMaterial): void;
  141939. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  141940. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh): void;
  141941. replaceRepeatableContent(vertexShaderState: NodeMaterialBuildState, fragmentShaderState: NodeMaterialBuildState, mesh: AbstractMesh, defines: NodeMaterialDefines): void;
  141942. protected _buildBlock(state: NodeMaterialBuildState): this;
  141943. }
  141944. }
  141945. declare module BABYLON {
  141946. /**
  141947. * Block used to get data information from a light
  141948. */
  141949. export class LightInformationBlock extends NodeMaterialBlock {
  141950. private _lightDataUniformName;
  141951. private _lightColorUniformName;
  141952. private _lightTypeDefineName;
  141953. /**
  141954. * Gets or sets the light associated with this block
  141955. */
  141956. light: Nullable<Light>;
  141957. /**
  141958. * Creates a new LightInformationBlock
  141959. * @param name defines the block name
  141960. */
  141961. constructor(name: string);
  141962. /**
  141963. * Gets the current class name
  141964. * @returns the class name
  141965. */
  141966. getClassName(): string;
  141967. /**
  141968. * Gets the world position input component
  141969. */
  141970. get worldPosition(): NodeMaterialConnectionPoint;
  141971. /**
  141972. * Gets the direction output component
  141973. */
  141974. get direction(): NodeMaterialConnectionPoint;
  141975. /**
  141976. * Gets the direction output component
  141977. */
  141978. get color(): NodeMaterialConnectionPoint;
  141979. /**
  141980. * Gets the direction output component
  141981. */
  141982. get intensity(): NodeMaterialConnectionPoint;
  141983. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh): void;
  141984. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  141985. protected _buildBlock(state: NodeMaterialBuildState): this;
  141986. serialize(): any;
  141987. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  141988. }
  141989. }
  141990. declare module BABYLON {
  141991. /**
  141992. * Block used to add image processing support to fragment shader
  141993. */
  141994. export class ImageProcessingBlock extends NodeMaterialBlock {
  141995. /**
  141996. * Create a new ImageProcessingBlock
  141997. * @param name defines the block name
  141998. */
  141999. constructor(name: string);
  142000. /**
  142001. * Gets the current class name
  142002. * @returns the class name
  142003. */
  142004. getClassName(): string;
  142005. /**
  142006. * Gets the color input component
  142007. */
  142008. get color(): NodeMaterialConnectionPoint;
  142009. /**
  142010. * Gets the output component
  142011. */
  142012. get output(): NodeMaterialConnectionPoint;
  142013. /**
  142014. * Initialize the block and prepare the context for build
  142015. * @param state defines the state that will be used for the build
  142016. */
  142017. initialize(state: NodeMaterialBuildState): void;
  142018. isReady(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): boolean;
  142019. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  142020. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh): void;
  142021. protected _buildBlock(state: NodeMaterialBuildState): this;
  142022. }
  142023. }
  142024. declare module BABYLON {
  142025. /**
  142026. * Block used to pertub normals based on a normal map
  142027. */
  142028. export class PerturbNormalBlock extends NodeMaterialBlock {
  142029. private _tangentSpaceParameterName;
  142030. /** Gets or sets a boolean indicating that normal should be inverted on X axis */
  142031. invertX: boolean;
  142032. /** Gets or sets a boolean indicating that normal should be inverted on Y axis */
  142033. invertY: boolean;
  142034. /**
  142035. * Create a new PerturbNormalBlock
  142036. * @param name defines the block name
  142037. */
  142038. constructor(name: string);
  142039. /**
  142040. * Gets the current class name
  142041. * @returns the class name
  142042. */
  142043. getClassName(): string;
  142044. /**
  142045. * Gets the world position input component
  142046. */
  142047. get worldPosition(): NodeMaterialConnectionPoint;
  142048. /**
  142049. * Gets the world normal input component
  142050. */
  142051. get worldNormal(): NodeMaterialConnectionPoint;
  142052. /**
  142053. * Gets the world tangent input component
  142054. */
  142055. get worldTangent(): NodeMaterialConnectionPoint;
  142056. /**
  142057. * Gets the uv input component
  142058. */
  142059. get uv(): NodeMaterialConnectionPoint;
  142060. /**
  142061. * Gets the normal map color input component
  142062. */
  142063. get normalMapColor(): NodeMaterialConnectionPoint;
  142064. /**
  142065. * Gets the strength input component
  142066. */
  142067. get strength(): NodeMaterialConnectionPoint;
  142068. /**
  142069. * Gets the output component
  142070. */
  142071. get output(): NodeMaterialConnectionPoint;
  142072. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  142073. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh): void;
  142074. autoConfigure(material: NodeMaterial): void;
  142075. protected _buildBlock(state: NodeMaterialBuildState): this;
  142076. protected _dumpPropertiesCode(): string;
  142077. serialize(): any;
  142078. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  142079. }
  142080. }
  142081. declare module BABYLON {
  142082. /**
  142083. * Block used to discard a pixel if a value is smaller than a cutoff
  142084. */
  142085. export class DiscardBlock extends NodeMaterialBlock {
  142086. /**
  142087. * Create a new DiscardBlock
  142088. * @param name defines the block name
  142089. */
  142090. constructor(name: string);
  142091. /**
  142092. * Gets the current class name
  142093. * @returns the class name
  142094. */
  142095. getClassName(): string;
  142096. /**
  142097. * Gets the color input component
  142098. */
  142099. get value(): NodeMaterialConnectionPoint;
  142100. /**
  142101. * Gets the cutoff input component
  142102. */
  142103. get cutoff(): NodeMaterialConnectionPoint;
  142104. protected _buildBlock(state: NodeMaterialBuildState): this;
  142105. }
  142106. }
  142107. declare module BABYLON {
  142108. /**
  142109. * Block used to test if the fragment shader is front facing
  142110. */
  142111. export class FrontFacingBlock extends NodeMaterialBlock {
  142112. /**
  142113. * Creates a new FrontFacingBlock
  142114. * @param name defines the block name
  142115. */
  142116. constructor(name: string);
  142117. /**
  142118. * Gets the current class name
  142119. * @returns the class name
  142120. */
  142121. getClassName(): string;
  142122. /**
  142123. * Gets the output component
  142124. */
  142125. get output(): NodeMaterialConnectionPoint;
  142126. protected _buildBlock(state: NodeMaterialBuildState): this;
  142127. }
  142128. }
  142129. declare module BABYLON {
  142130. /**
  142131. * Block used to get the derivative value on x and y of a given input
  142132. */
  142133. export class DerivativeBlock extends NodeMaterialBlock {
  142134. /**
  142135. * Create a new DerivativeBlock
  142136. * @param name defines the block name
  142137. */
  142138. constructor(name: string);
  142139. /**
  142140. * Gets the current class name
  142141. * @returns the class name
  142142. */
  142143. getClassName(): string;
  142144. /**
  142145. * Gets the input component
  142146. */
  142147. get input(): NodeMaterialConnectionPoint;
  142148. /**
  142149. * Gets the derivative output on x
  142150. */
  142151. get dx(): NodeMaterialConnectionPoint;
  142152. /**
  142153. * Gets the derivative output on y
  142154. */
  142155. get dy(): NodeMaterialConnectionPoint;
  142156. protected _buildBlock(state: NodeMaterialBuildState): this;
  142157. }
  142158. }
  142159. declare module BABYLON {
  142160. /**
  142161. * Block used to make gl_FragCoord available
  142162. */
  142163. export class FragCoordBlock extends NodeMaterialBlock {
  142164. /**
  142165. * Creates a new FragCoordBlock
  142166. * @param name defines the block name
  142167. */
  142168. constructor(name: string);
  142169. /**
  142170. * Gets the current class name
  142171. * @returns the class name
  142172. */
  142173. getClassName(): string;
  142174. /**
  142175. * Gets the xy component
  142176. */
  142177. get xy(): NodeMaterialConnectionPoint;
  142178. /**
  142179. * Gets the xyz component
  142180. */
  142181. get xyz(): NodeMaterialConnectionPoint;
  142182. /**
  142183. * Gets the xyzw component
  142184. */
  142185. get xyzw(): NodeMaterialConnectionPoint;
  142186. /**
  142187. * Gets the x component
  142188. */
  142189. get x(): NodeMaterialConnectionPoint;
  142190. /**
  142191. * Gets the y component
  142192. */
  142193. get y(): NodeMaterialConnectionPoint;
  142194. /**
  142195. * Gets the z component
  142196. */
  142197. get z(): NodeMaterialConnectionPoint;
  142198. /**
  142199. * Gets the w component
  142200. */
  142201. get output(): NodeMaterialConnectionPoint;
  142202. protected writeOutputs(state: NodeMaterialBuildState): string;
  142203. protected _buildBlock(state: NodeMaterialBuildState): this;
  142204. }
  142205. }
  142206. declare module BABYLON {
  142207. /**
  142208. * Block used to get the screen sizes
  142209. */
  142210. export class ScreenSizeBlock extends NodeMaterialBlock {
  142211. private _varName;
  142212. private _scene;
  142213. /**
  142214. * Creates a new ScreenSizeBlock
  142215. * @param name defines the block name
  142216. */
  142217. constructor(name: string);
  142218. /**
  142219. * Gets the current class name
  142220. * @returns the class name
  142221. */
  142222. getClassName(): string;
  142223. /**
  142224. * Gets the xy component
  142225. */
  142226. get xy(): NodeMaterialConnectionPoint;
  142227. /**
  142228. * Gets the x component
  142229. */
  142230. get x(): NodeMaterialConnectionPoint;
  142231. /**
  142232. * Gets the y component
  142233. */
  142234. get y(): NodeMaterialConnectionPoint;
  142235. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh): void;
  142236. protected writeOutputs(state: NodeMaterialBuildState, varName: string): string;
  142237. protected _buildBlock(state: NodeMaterialBuildState): this;
  142238. }
  142239. }
  142240. declare module BABYLON {
  142241. /**
  142242. * Block used to add support for scene fog
  142243. */
  142244. export class FogBlock extends NodeMaterialBlock {
  142245. private _fogDistanceName;
  142246. private _fogParameters;
  142247. /**
  142248. * Create a new FogBlock
  142249. * @param name defines the block name
  142250. */
  142251. constructor(name: string);
  142252. /**
  142253. * Gets the current class name
  142254. * @returns the class name
  142255. */
  142256. getClassName(): string;
  142257. /**
  142258. * Gets the world position input component
  142259. */
  142260. get worldPosition(): NodeMaterialConnectionPoint;
  142261. /**
  142262. * Gets the view input component
  142263. */
  142264. get view(): NodeMaterialConnectionPoint;
  142265. /**
  142266. * Gets the color input component
  142267. */
  142268. get input(): NodeMaterialConnectionPoint;
  142269. /**
  142270. * Gets the fog color input component
  142271. */
  142272. get fogColor(): NodeMaterialConnectionPoint;
  142273. /**
  142274. * Gets the output component
  142275. */
  142276. get output(): NodeMaterialConnectionPoint;
  142277. autoConfigure(material: NodeMaterial): void;
  142278. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  142279. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh): void;
  142280. protected _buildBlock(state: NodeMaterialBuildState): this;
  142281. }
  142282. }
  142283. declare module BABYLON {
  142284. /**
  142285. * Block used to add light in the fragment shader
  142286. */
  142287. export class LightBlock extends NodeMaterialBlock {
  142288. private _lightId;
  142289. /**
  142290. * Gets or sets the light associated with this block
  142291. */
  142292. light: Nullable<Light>;
  142293. /**
  142294. * Create a new LightBlock
  142295. * @param name defines the block name
  142296. */
  142297. constructor(name: string);
  142298. /**
  142299. * Gets the current class name
  142300. * @returns the class name
  142301. */
  142302. getClassName(): string;
  142303. /**
  142304. * Gets the world position input component
  142305. */
  142306. get worldPosition(): NodeMaterialConnectionPoint;
  142307. /**
  142308. * Gets the world normal input component
  142309. */
  142310. get worldNormal(): NodeMaterialConnectionPoint;
  142311. /**
  142312. * Gets the camera (or eye) position component
  142313. */
  142314. get cameraPosition(): NodeMaterialConnectionPoint;
  142315. /**
  142316. * Gets the glossiness component
  142317. */
  142318. get glossiness(): NodeMaterialConnectionPoint;
  142319. /**
  142320. * Gets the glossinness power component
  142321. */
  142322. get glossPower(): NodeMaterialConnectionPoint;
  142323. /**
  142324. * Gets the diffuse color component
  142325. */
  142326. get diffuseColor(): NodeMaterialConnectionPoint;
  142327. /**
  142328. * Gets the specular color component
  142329. */
  142330. get specularColor(): NodeMaterialConnectionPoint;
  142331. /**
  142332. * Gets the diffuse output component
  142333. */
  142334. get diffuseOutput(): NodeMaterialConnectionPoint;
  142335. /**
  142336. * Gets the specular output component
  142337. */
  142338. get specularOutput(): NodeMaterialConnectionPoint;
  142339. /**
  142340. * Gets the shadow output component
  142341. */
  142342. get shadow(): NodeMaterialConnectionPoint;
  142343. autoConfigure(material: NodeMaterial): void;
  142344. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  142345. updateUniformsAndSamples(state: NodeMaterialBuildState, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines, uniformBuffers: string[]): void;
  142346. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh): void;
  142347. private _injectVertexCode;
  142348. protected _buildBlock(state: NodeMaterialBuildState): this | undefined;
  142349. serialize(): any;
  142350. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  142351. }
  142352. }
  142353. declare module BABYLON {
  142354. /**
  142355. * Block used to read a reflection texture from a sampler
  142356. */
  142357. export class ReflectionTextureBlock extends ReflectionTextureBaseBlock {
  142358. /**
  142359. * Create a new ReflectionTextureBlock
  142360. * @param name defines the block name
  142361. */
  142362. constructor(name: string);
  142363. /**
  142364. * Gets the current class name
  142365. * @returns the class name
  142366. */
  142367. getClassName(): string;
  142368. /**
  142369. * Gets the world position input component
  142370. */
  142371. get position(): NodeMaterialConnectionPoint;
  142372. /**
  142373. * Gets the world position input component
  142374. */
  142375. get worldPosition(): NodeMaterialConnectionPoint;
  142376. /**
  142377. * Gets the world normal input component
  142378. */
  142379. get worldNormal(): NodeMaterialConnectionPoint;
  142380. /**
  142381. * Gets the world input component
  142382. */
  142383. get world(): NodeMaterialConnectionPoint;
  142384. /**
  142385. * Gets the camera (or eye) position component
  142386. */
  142387. get cameraPosition(): NodeMaterialConnectionPoint;
  142388. /**
  142389. * Gets the view input component
  142390. */
  142391. get view(): NodeMaterialConnectionPoint;
  142392. /**
  142393. * Gets the rgb output component
  142394. */
  142395. get rgb(): NodeMaterialConnectionPoint;
  142396. /**
  142397. * Gets the rgba output component
  142398. */
  142399. get rgba(): NodeMaterialConnectionPoint;
  142400. /**
  142401. * Gets the r output component
  142402. */
  142403. get r(): NodeMaterialConnectionPoint;
  142404. /**
  142405. * Gets the g output component
  142406. */
  142407. get g(): NodeMaterialConnectionPoint;
  142408. /**
  142409. * Gets the b output component
  142410. */
  142411. get b(): NodeMaterialConnectionPoint;
  142412. /**
  142413. * Gets the a output component
  142414. */
  142415. get a(): NodeMaterialConnectionPoint;
  142416. autoConfigure(material: NodeMaterial): void;
  142417. protected _buildBlock(state: NodeMaterialBuildState): this;
  142418. }
  142419. }
  142420. declare module BABYLON {
  142421. /**
  142422. * Block used to add 2 vectors
  142423. */
  142424. export class AddBlock extends NodeMaterialBlock {
  142425. /**
  142426. * Creates a new AddBlock
  142427. * @param name defines the block name
  142428. */
  142429. constructor(name: string);
  142430. /**
  142431. * Gets the current class name
  142432. * @returns the class name
  142433. */
  142434. getClassName(): string;
  142435. /**
  142436. * Gets the left operand input component
  142437. */
  142438. get left(): NodeMaterialConnectionPoint;
  142439. /**
  142440. * Gets the right operand input component
  142441. */
  142442. get right(): NodeMaterialConnectionPoint;
  142443. /**
  142444. * Gets the output component
  142445. */
  142446. get output(): NodeMaterialConnectionPoint;
  142447. protected _buildBlock(state: NodeMaterialBuildState): this;
  142448. }
  142449. }
  142450. declare module BABYLON {
  142451. /**
  142452. * Block used to scale a vector by a float
  142453. */
  142454. export class ScaleBlock extends NodeMaterialBlock {
  142455. /**
  142456. * Creates a new ScaleBlock
  142457. * @param name defines the block name
  142458. */
  142459. constructor(name: string);
  142460. /**
  142461. * Gets the current class name
  142462. * @returns the class name
  142463. */
  142464. getClassName(): string;
  142465. /**
  142466. * Gets the input component
  142467. */
  142468. get input(): NodeMaterialConnectionPoint;
  142469. /**
  142470. * Gets the factor input component
  142471. */
  142472. get factor(): NodeMaterialConnectionPoint;
  142473. /**
  142474. * Gets the output component
  142475. */
  142476. get output(): NodeMaterialConnectionPoint;
  142477. protected _buildBlock(state: NodeMaterialBuildState): this;
  142478. }
  142479. }
  142480. declare module BABYLON {
  142481. /**
  142482. * Block used to clamp a float
  142483. */
  142484. export class ClampBlock extends NodeMaterialBlock {
  142485. /** Gets or sets the minimum range */
  142486. minimum: number;
  142487. /** Gets or sets the maximum range */
  142488. maximum: number;
  142489. /**
  142490. * Creates a new ClampBlock
  142491. * @param name defines the block name
  142492. */
  142493. constructor(name: string);
  142494. /**
  142495. * Gets the current class name
  142496. * @returns the class name
  142497. */
  142498. getClassName(): string;
  142499. /**
  142500. * Gets the value input component
  142501. */
  142502. get value(): NodeMaterialConnectionPoint;
  142503. /**
  142504. * Gets the output component
  142505. */
  142506. get output(): NodeMaterialConnectionPoint;
  142507. protected _buildBlock(state: NodeMaterialBuildState): this;
  142508. protected _dumpPropertiesCode(): string;
  142509. serialize(): any;
  142510. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  142511. }
  142512. }
  142513. declare module BABYLON {
  142514. /**
  142515. * Block used to apply a cross product between 2 vectors
  142516. */
  142517. export class CrossBlock extends NodeMaterialBlock {
  142518. /**
  142519. * Creates a new CrossBlock
  142520. * @param name defines the block name
  142521. */
  142522. constructor(name: string);
  142523. /**
  142524. * Gets the current class name
  142525. * @returns the class name
  142526. */
  142527. getClassName(): string;
  142528. /**
  142529. * Gets the left operand input component
  142530. */
  142531. get left(): NodeMaterialConnectionPoint;
  142532. /**
  142533. * Gets the right operand input component
  142534. */
  142535. get right(): NodeMaterialConnectionPoint;
  142536. /**
  142537. * Gets the output component
  142538. */
  142539. get output(): NodeMaterialConnectionPoint;
  142540. protected _buildBlock(state: NodeMaterialBuildState): this;
  142541. }
  142542. }
  142543. declare module BABYLON {
  142544. /**
  142545. * Block used to apply a dot product between 2 vectors
  142546. */
  142547. export class DotBlock extends NodeMaterialBlock {
  142548. /**
  142549. * Creates a new DotBlock
  142550. * @param name defines the block name
  142551. */
  142552. constructor(name: string);
  142553. /**
  142554. * Gets the current class name
  142555. * @returns the class name
  142556. */
  142557. getClassName(): string;
  142558. /**
  142559. * Gets the left operand input component
  142560. */
  142561. get left(): NodeMaterialConnectionPoint;
  142562. /**
  142563. * Gets the right operand input component
  142564. */
  142565. get right(): NodeMaterialConnectionPoint;
  142566. /**
  142567. * Gets the output component
  142568. */
  142569. get output(): NodeMaterialConnectionPoint;
  142570. protected _buildBlock(state: NodeMaterialBuildState): this;
  142571. }
  142572. }
  142573. declare module BABYLON {
  142574. /**
  142575. * Block used to normalize a vector
  142576. */
  142577. export class NormalizeBlock extends NodeMaterialBlock {
  142578. /**
  142579. * Creates a new NormalizeBlock
  142580. * @param name defines the block name
  142581. */
  142582. constructor(name: string);
  142583. /**
  142584. * Gets the current class name
  142585. * @returns the class name
  142586. */
  142587. getClassName(): string;
  142588. /**
  142589. * Gets the input component
  142590. */
  142591. get input(): NodeMaterialConnectionPoint;
  142592. /**
  142593. * Gets the output component
  142594. */
  142595. get output(): NodeMaterialConnectionPoint;
  142596. protected _buildBlock(state: NodeMaterialBuildState): this;
  142597. }
  142598. }
  142599. declare module BABYLON {
  142600. /**
  142601. * Operations supported by the Trigonometry block
  142602. */
  142603. export enum TrigonometryBlockOperations {
  142604. /** Cos */
  142605. Cos = 0,
  142606. /** Sin */
  142607. Sin = 1,
  142608. /** Abs */
  142609. Abs = 2,
  142610. /** Exp */
  142611. Exp = 3,
  142612. /** Exp2 */
  142613. Exp2 = 4,
  142614. /** Round */
  142615. Round = 5,
  142616. /** Floor */
  142617. Floor = 6,
  142618. /** Ceiling */
  142619. Ceiling = 7,
  142620. /** Square root */
  142621. Sqrt = 8,
  142622. /** Log */
  142623. Log = 9,
  142624. /** Tangent */
  142625. Tan = 10,
  142626. /** Arc tangent */
  142627. ArcTan = 11,
  142628. /** Arc cosinus */
  142629. ArcCos = 12,
  142630. /** Arc sinus */
  142631. ArcSin = 13,
  142632. /** Fraction */
  142633. Fract = 14,
  142634. /** Sign */
  142635. Sign = 15,
  142636. /** To radians (from degrees) */
  142637. Radians = 16,
  142638. /** To degrees (from radians) */
  142639. Degrees = 17
  142640. }
  142641. /**
  142642. * Block used to apply trigonometry operation to floats
  142643. */
  142644. export class TrigonometryBlock extends NodeMaterialBlock {
  142645. /**
  142646. * Gets or sets the operation applied by the block
  142647. */
  142648. operation: TrigonometryBlockOperations;
  142649. /**
  142650. * Creates a new TrigonometryBlock
  142651. * @param name defines the block name
  142652. */
  142653. constructor(name: string);
  142654. /**
  142655. * Gets the current class name
  142656. * @returns the class name
  142657. */
  142658. getClassName(): string;
  142659. /**
  142660. * Gets the input component
  142661. */
  142662. get input(): NodeMaterialConnectionPoint;
  142663. /**
  142664. * Gets the output component
  142665. */
  142666. get output(): NodeMaterialConnectionPoint;
  142667. protected _buildBlock(state: NodeMaterialBuildState): this;
  142668. serialize(): any;
  142669. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  142670. protected _dumpPropertiesCode(): string;
  142671. }
  142672. }
  142673. declare module BABYLON {
  142674. /**
  142675. * Block used to create a Color3/4 out of individual inputs (one for each component)
  142676. */
  142677. export class ColorMergerBlock extends NodeMaterialBlock {
  142678. /**
  142679. * Create a new ColorMergerBlock
  142680. * @param name defines the block name
  142681. */
  142682. constructor(name: string);
  142683. /**
  142684. * Gets the current class name
  142685. * @returns the class name
  142686. */
  142687. getClassName(): string;
  142688. /**
  142689. * Gets the rgb component (input)
  142690. */
  142691. get rgbIn(): NodeMaterialConnectionPoint;
  142692. /**
  142693. * Gets the r component (input)
  142694. */
  142695. get r(): NodeMaterialConnectionPoint;
  142696. /**
  142697. * Gets the g component (input)
  142698. */
  142699. get g(): NodeMaterialConnectionPoint;
  142700. /**
  142701. * Gets the b component (input)
  142702. */
  142703. get b(): NodeMaterialConnectionPoint;
  142704. /**
  142705. * Gets the a component (input)
  142706. */
  142707. get a(): NodeMaterialConnectionPoint;
  142708. /**
  142709. * Gets the rgba component (output)
  142710. */
  142711. get rgba(): NodeMaterialConnectionPoint;
  142712. /**
  142713. * Gets the rgb component (output)
  142714. */
  142715. get rgbOut(): NodeMaterialConnectionPoint;
  142716. /**
  142717. * Gets the rgb component (output)
  142718. * @deprecated Please use rgbOut instead.
  142719. */
  142720. get rgb(): NodeMaterialConnectionPoint;
  142721. protected _buildBlock(state: NodeMaterialBuildState): this;
  142722. }
  142723. }
  142724. declare module BABYLON {
  142725. /**
  142726. * Block used to expand a Vector3/4 into 4 outputs (one for each component)
  142727. */
  142728. export class VectorSplitterBlock extends NodeMaterialBlock {
  142729. /**
  142730. * Create a new VectorSplitterBlock
  142731. * @param name defines the block name
  142732. */
  142733. constructor(name: string);
  142734. /**
  142735. * Gets the current class name
  142736. * @returns the class name
  142737. */
  142738. getClassName(): string;
  142739. /**
  142740. * Gets the xyzw component (input)
  142741. */
  142742. get xyzw(): NodeMaterialConnectionPoint;
  142743. /**
  142744. * Gets the xyz component (input)
  142745. */
  142746. get xyzIn(): NodeMaterialConnectionPoint;
  142747. /**
  142748. * Gets the xy component (input)
  142749. */
  142750. get xyIn(): NodeMaterialConnectionPoint;
  142751. /**
  142752. * Gets the xyz component (output)
  142753. */
  142754. get xyzOut(): NodeMaterialConnectionPoint;
  142755. /**
  142756. * Gets the xy component (output)
  142757. */
  142758. get xyOut(): NodeMaterialConnectionPoint;
  142759. /**
  142760. * Gets the x component (output)
  142761. */
  142762. get x(): NodeMaterialConnectionPoint;
  142763. /**
  142764. * Gets the y component (output)
  142765. */
  142766. get y(): NodeMaterialConnectionPoint;
  142767. /**
  142768. * Gets the z component (output)
  142769. */
  142770. get z(): NodeMaterialConnectionPoint;
  142771. /**
  142772. * Gets the w component (output)
  142773. */
  142774. get w(): NodeMaterialConnectionPoint;
  142775. protected _inputRename(name: string): string;
  142776. protected _outputRename(name: string): string;
  142777. protected _buildBlock(state: NodeMaterialBuildState): this;
  142778. }
  142779. }
  142780. declare module BABYLON {
  142781. /**
  142782. * Block used to lerp between 2 values
  142783. */
  142784. export class LerpBlock extends NodeMaterialBlock {
  142785. /**
  142786. * Creates a new LerpBlock
  142787. * @param name defines the block name
  142788. */
  142789. constructor(name: string);
  142790. /**
  142791. * Gets the current class name
  142792. * @returns the class name
  142793. */
  142794. getClassName(): string;
  142795. /**
  142796. * Gets the left operand input component
  142797. */
  142798. get left(): NodeMaterialConnectionPoint;
  142799. /**
  142800. * Gets the right operand input component
  142801. */
  142802. get right(): NodeMaterialConnectionPoint;
  142803. /**
  142804. * Gets the gradient operand input component
  142805. */
  142806. get gradient(): NodeMaterialConnectionPoint;
  142807. /**
  142808. * Gets the output component
  142809. */
  142810. get output(): NodeMaterialConnectionPoint;
  142811. protected _buildBlock(state: NodeMaterialBuildState): this;
  142812. }
  142813. }
  142814. declare module BABYLON {
  142815. /**
  142816. * Block used to divide 2 vectors
  142817. */
  142818. export class DivideBlock extends NodeMaterialBlock {
  142819. /**
  142820. * Creates a new DivideBlock
  142821. * @param name defines the block name
  142822. */
  142823. constructor(name: string);
  142824. /**
  142825. * Gets the current class name
  142826. * @returns the class name
  142827. */
  142828. getClassName(): string;
  142829. /**
  142830. * Gets the left operand input component
  142831. */
  142832. get left(): NodeMaterialConnectionPoint;
  142833. /**
  142834. * Gets the right operand input component
  142835. */
  142836. get right(): NodeMaterialConnectionPoint;
  142837. /**
  142838. * Gets the output component
  142839. */
  142840. get output(): NodeMaterialConnectionPoint;
  142841. protected _buildBlock(state: NodeMaterialBuildState): this;
  142842. }
  142843. }
  142844. declare module BABYLON {
  142845. /**
  142846. * Block used to subtract 2 vectors
  142847. */
  142848. export class SubtractBlock extends NodeMaterialBlock {
  142849. /**
  142850. * Creates a new SubtractBlock
  142851. * @param name defines the block name
  142852. */
  142853. constructor(name: string);
  142854. /**
  142855. * Gets the current class name
  142856. * @returns the class name
  142857. */
  142858. getClassName(): string;
  142859. /**
  142860. * Gets the left operand input component
  142861. */
  142862. get left(): NodeMaterialConnectionPoint;
  142863. /**
  142864. * Gets the right operand input component
  142865. */
  142866. get right(): NodeMaterialConnectionPoint;
  142867. /**
  142868. * Gets the output component
  142869. */
  142870. get output(): NodeMaterialConnectionPoint;
  142871. protected _buildBlock(state: NodeMaterialBuildState): this;
  142872. }
  142873. }
  142874. declare module BABYLON {
  142875. /**
  142876. * Block used to step a value
  142877. */
  142878. export class StepBlock extends NodeMaterialBlock {
  142879. /**
  142880. * Creates a new StepBlock
  142881. * @param name defines the block name
  142882. */
  142883. constructor(name: string);
  142884. /**
  142885. * Gets the current class name
  142886. * @returns the class name
  142887. */
  142888. getClassName(): string;
  142889. /**
  142890. * Gets the value operand input component
  142891. */
  142892. get value(): NodeMaterialConnectionPoint;
  142893. /**
  142894. * Gets the edge operand input component
  142895. */
  142896. get edge(): NodeMaterialConnectionPoint;
  142897. /**
  142898. * Gets the output component
  142899. */
  142900. get output(): NodeMaterialConnectionPoint;
  142901. protected _buildBlock(state: NodeMaterialBuildState): this;
  142902. }
  142903. }
  142904. declare module BABYLON {
  142905. /**
  142906. * Block used to get the opposite (1 - x) of a value
  142907. */
  142908. export class OneMinusBlock extends NodeMaterialBlock {
  142909. /**
  142910. * Creates a new OneMinusBlock
  142911. * @param name defines the block name
  142912. */
  142913. constructor(name: string);
  142914. /**
  142915. * Gets the current class name
  142916. * @returns the class name
  142917. */
  142918. getClassName(): string;
  142919. /**
  142920. * Gets the input component
  142921. */
  142922. get input(): NodeMaterialConnectionPoint;
  142923. /**
  142924. * Gets the output component
  142925. */
  142926. get output(): NodeMaterialConnectionPoint;
  142927. protected _buildBlock(state: NodeMaterialBuildState): this;
  142928. }
  142929. }
  142930. declare module BABYLON {
  142931. /**
  142932. * Block used to get the view direction
  142933. */
  142934. export class ViewDirectionBlock extends NodeMaterialBlock {
  142935. /**
  142936. * Creates a new ViewDirectionBlock
  142937. * @param name defines the block name
  142938. */
  142939. constructor(name: string);
  142940. /**
  142941. * Gets the current class name
  142942. * @returns the class name
  142943. */
  142944. getClassName(): string;
  142945. /**
  142946. * Gets the world position component
  142947. */
  142948. get worldPosition(): NodeMaterialConnectionPoint;
  142949. /**
  142950. * Gets the camera position component
  142951. */
  142952. get cameraPosition(): NodeMaterialConnectionPoint;
  142953. /**
  142954. * Gets the output component
  142955. */
  142956. get output(): NodeMaterialConnectionPoint;
  142957. autoConfigure(material: NodeMaterial): void;
  142958. protected _buildBlock(state: NodeMaterialBuildState): this;
  142959. }
  142960. }
  142961. declare module BABYLON {
  142962. /**
  142963. * Block used to compute fresnel value
  142964. */
  142965. export class FresnelBlock extends NodeMaterialBlock {
  142966. /**
  142967. * Create a new FresnelBlock
  142968. * @param name defines the block name
  142969. */
  142970. constructor(name: string);
  142971. /**
  142972. * Gets the current class name
  142973. * @returns the class name
  142974. */
  142975. getClassName(): string;
  142976. /**
  142977. * Gets the world normal input component
  142978. */
  142979. get worldNormal(): NodeMaterialConnectionPoint;
  142980. /**
  142981. * Gets the view direction input component
  142982. */
  142983. get viewDirection(): NodeMaterialConnectionPoint;
  142984. /**
  142985. * Gets the bias input component
  142986. */
  142987. get bias(): NodeMaterialConnectionPoint;
  142988. /**
  142989. * Gets the camera (or eye) position component
  142990. */
  142991. get power(): NodeMaterialConnectionPoint;
  142992. /**
  142993. * Gets the fresnel output component
  142994. */
  142995. get fresnel(): NodeMaterialConnectionPoint;
  142996. autoConfigure(material: NodeMaterial): void;
  142997. protected _buildBlock(state: NodeMaterialBuildState): this;
  142998. }
  142999. }
  143000. declare module BABYLON {
  143001. /**
  143002. * Block used to get the max of 2 values
  143003. */
  143004. export class MaxBlock extends NodeMaterialBlock {
  143005. /**
  143006. * Creates a new MaxBlock
  143007. * @param name defines the block name
  143008. */
  143009. constructor(name: string);
  143010. /**
  143011. * Gets the current class name
  143012. * @returns the class name
  143013. */
  143014. getClassName(): string;
  143015. /**
  143016. * Gets the left operand input component
  143017. */
  143018. get left(): NodeMaterialConnectionPoint;
  143019. /**
  143020. * Gets the right operand input component
  143021. */
  143022. get right(): NodeMaterialConnectionPoint;
  143023. /**
  143024. * Gets the output component
  143025. */
  143026. get output(): NodeMaterialConnectionPoint;
  143027. protected _buildBlock(state: NodeMaterialBuildState): this;
  143028. }
  143029. }
  143030. declare module BABYLON {
  143031. /**
  143032. * Block used to get the min of 2 values
  143033. */
  143034. export class MinBlock extends NodeMaterialBlock {
  143035. /**
  143036. * Creates a new MinBlock
  143037. * @param name defines the block name
  143038. */
  143039. constructor(name: string);
  143040. /**
  143041. * Gets the current class name
  143042. * @returns the class name
  143043. */
  143044. getClassName(): string;
  143045. /**
  143046. * Gets the left operand input component
  143047. */
  143048. get left(): NodeMaterialConnectionPoint;
  143049. /**
  143050. * Gets the right operand input component
  143051. */
  143052. get right(): NodeMaterialConnectionPoint;
  143053. /**
  143054. * Gets the output component
  143055. */
  143056. get output(): NodeMaterialConnectionPoint;
  143057. protected _buildBlock(state: NodeMaterialBuildState): this;
  143058. }
  143059. }
  143060. declare module BABYLON {
  143061. /**
  143062. * Block used to get the distance between 2 values
  143063. */
  143064. export class DistanceBlock extends NodeMaterialBlock {
  143065. /**
  143066. * Creates a new DistanceBlock
  143067. * @param name defines the block name
  143068. */
  143069. constructor(name: string);
  143070. /**
  143071. * Gets the current class name
  143072. * @returns the class name
  143073. */
  143074. getClassName(): string;
  143075. /**
  143076. * Gets the left operand input component
  143077. */
  143078. get left(): NodeMaterialConnectionPoint;
  143079. /**
  143080. * Gets the right operand input component
  143081. */
  143082. get right(): NodeMaterialConnectionPoint;
  143083. /**
  143084. * Gets the output component
  143085. */
  143086. get output(): NodeMaterialConnectionPoint;
  143087. protected _buildBlock(state: NodeMaterialBuildState): this;
  143088. }
  143089. }
  143090. declare module BABYLON {
  143091. /**
  143092. * Block used to get the length of a vector
  143093. */
  143094. export class LengthBlock extends NodeMaterialBlock {
  143095. /**
  143096. * Creates a new LengthBlock
  143097. * @param name defines the block name
  143098. */
  143099. constructor(name: string);
  143100. /**
  143101. * Gets the current class name
  143102. * @returns the class name
  143103. */
  143104. getClassName(): string;
  143105. /**
  143106. * Gets the value input component
  143107. */
  143108. get value(): NodeMaterialConnectionPoint;
  143109. /**
  143110. * Gets the output component
  143111. */
  143112. get output(): NodeMaterialConnectionPoint;
  143113. protected _buildBlock(state: NodeMaterialBuildState): this;
  143114. }
  143115. }
  143116. declare module BABYLON {
  143117. /**
  143118. * Block used to get negative version of a value (i.e. x * -1)
  143119. */
  143120. export class NegateBlock extends NodeMaterialBlock {
  143121. /**
  143122. * Creates a new NegateBlock
  143123. * @param name defines the block name
  143124. */
  143125. constructor(name: string);
  143126. /**
  143127. * Gets the current class name
  143128. * @returns the class name
  143129. */
  143130. getClassName(): string;
  143131. /**
  143132. * Gets the value input component
  143133. */
  143134. get value(): NodeMaterialConnectionPoint;
  143135. /**
  143136. * Gets the output component
  143137. */
  143138. get output(): NodeMaterialConnectionPoint;
  143139. protected _buildBlock(state: NodeMaterialBuildState): this;
  143140. }
  143141. }
  143142. declare module BABYLON {
  143143. /**
  143144. * Block used to get the value of the first parameter raised to the power of the second
  143145. */
  143146. export class PowBlock extends NodeMaterialBlock {
  143147. /**
  143148. * Creates a new PowBlock
  143149. * @param name defines the block name
  143150. */
  143151. constructor(name: string);
  143152. /**
  143153. * Gets the current class name
  143154. * @returns the class name
  143155. */
  143156. getClassName(): string;
  143157. /**
  143158. * Gets the value operand input component
  143159. */
  143160. get value(): NodeMaterialConnectionPoint;
  143161. /**
  143162. * Gets the power operand input component
  143163. */
  143164. get power(): NodeMaterialConnectionPoint;
  143165. /**
  143166. * Gets the output component
  143167. */
  143168. get output(): NodeMaterialConnectionPoint;
  143169. protected _buildBlock(state: NodeMaterialBuildState): this;
  143170. }
  143171. }
  143172. declare module BABYLON {
  143173. /**
  143174. * Block used to get a random number
  143175. */
  143176. export class RandomNumberBlock extends NodeMaterialBlock {
  143177. /**
  143178. * Creates a new RandomNumberBlock
  143179. * @param name defines the block name
  143180. */
  143181. constructor(name: string);
  143182. /**
  143183. * Gets the current class name
  143184. * @returns the class name
  143185. */
  143186. getClassName(): string;
  143187. /**
  143188. * Gets the seed input component
  143189. */
  143190. get seed(): NodeMaterialConnectionPoint;
  143191. /**
  143192. * Gets the output component
  143193. */
  143194. get output(): NodeMaterialConnectionPoint;
  143195. protected _buildBlock(state: NodeMaterialBuildState): this;
  143196. }
  143197. }
  143198. declare module BABYLON {
  143199. /**
  143200. * Block used to compute arc tangent of 2 values
  143201. */
  143202. export class ArcTan2Block extends NodeMaterialBlock {
  143203. /**
  143204. * Creates a new ArcTan2Block
  143205. * @param name defines the block name
  143206. */
  143207. constructor(name: string);
  143208. /**
  143209. * Gets the current class name
  143210. * @returns the class name
  143211. */
  143212. getClassName(): string;
  143213. /**
  143214. * Gets the x operand input component
  143215. */
  143216. get x(): NodeMaterialConnectionPoint;
  143217. /**
  143218. * Gets the y operand input component
  143219. */
  143220. get y(): NodeMaterialConnectionPoint;
  143221. /**
  143222. * Gets the output component
  143223. */
  143224. get output(): NodeMaterialConnectionPoint;
  143225. protected _buildBlock(state: NodeMaterialBuildState): this;
  143226. }
  143227. }
  143228. declare module BABYLON {
  143229. /**
  143230. * Block used to smooth step a value
  143231. */
  143232. export class SmoothStepBlock extends NodeMaterialBlock {
  143233. /**
  143234. * Creates a new SmoothStepBlock
  143235. * @param name defines the block name
  143236. */
  143237. constructor(name: string);
  143238. /**
  143239. * Gets the current class name
  143240. * @returns the class name
  143241. */
  143242. getClassName(): string;
  143243. /**
  143244. * Gets the value operand input component
  143245. */
  143246. get value(): NodeMaterialConnectionPoint;
  143247. /**
  143248. * Gets the first edge operand input component
  143249. */
  143250. get edge0(): NodeMaterialConnectionPoint;
  143251. /**
  143252. * Gets the second edge operand input component
  143253. */
  143254. get edge1(): NodeMaterialConnectionPoint;
  143255. /**
  143256. * Gets the output component
  143257. */
  143258. get output(): NodeMaterialConnectionPoint;
  143259. protected _buildBlock(state: NodeMaterialBuildState): this;
  143260. }
  143261. }
  143262. declare module BABYLON {
  143263. /**
  143264. * Block used to get the reciprocal (1 / x) of a value
  143265. */
  143266. export class ReciprocalBlock extends NodeMaterialBlock {
  143267. /**
  143268. * Creates a new ReciprocalBlock
  143269. * @param name defines the block name
  143270. */
  143271. constructor(name: string);
  143272. /**
  143273. * Gets the current class name
  143274. * @returns the class name
  143275. */
  143276. getClassName(): string;
  143277. /**
  143278. * Gets the input component
  143279. */
  143280. get input(): NodeMaterialConnectionPoint;
  143281. /**
  143282. * Gets the output component
  143283. */
  143284. get output(): NodeMaterialConnectionPoint;
  143285. protected _buildBlock(state: NodeMaterialBuildState): this;
  143286. }
  143287. }
  143288. declare module BABYLON {
  143289. /**
  143290. * Block used to replace a color by another one
  143291. */
  143292. export class ReplaceColorBlock extends NodeMaterialBlock {
  143293. /**
  143294. * Creates a new ReplaceColorBlock
  143295. * @param name defines the block name
  143296. */
  143297. constructor(name: string);
  143298. /**
  143299. * Gets the current class name
  143300. * @returns the class name
  143301. */
  143302. getClassName(): string;
  143303. /**
  143304. * Gets the value input component
  143305. */
  143306. get value(): NodeMaterialConnectionPoint;
  143307. /**
  143308. * Gets the reference input component
  143309. */
  143310. get reference(): NodeMaterialConnectionPoint;
  143311. /**
  143312. * Gets the distance input component
  143313. */
  143314. get distance(): NodeMaterialConnectionPoint;
  143315. /**
  143316. * Gets the replacement input component
  143317. */
  143318. get replacement(): NodeMaterialConnectionPoint;
  143319. /**
  143320. * Gets the output component
  143321. */
  143322. get output(): NodeMaterialConnectionPoint;
  143323. protected _buildBlock(state: NodeMaterialBuildState): this;
  143324. }
  143325. }
  143326. declare module BABYLON {
  143327. /**
  143328. * Block used to posterize a value
  143329. * @see https://en.wikipedia.org/wiki/Posterization
  143330. */
  143331. export class PosterizeBlock extends NodeMaterialBlock {
  143332. /**
  143333. * Creates a new PosterizeBlock
  143334. * @param name defines the block name
  143335. */
  143336. constructor(name: string);
  143337. /**
  143338. * Gets the current class name
  143339. * @returns the class name
  143340. */
  143341. getClassName(): string;
  143342. /**
  143343. * Gets the value input component
  143344. */
  143345. get value(): NodeMaterialConnectionPoint;
  143346. /**
  143347. * Gets the steps input component
  143348. */
  143349. get steps(): NodeMaterialConnectionPoint;
  143350. /**
  143351. * Gets the output component
  143352. */
  143353. get output(): NodeMaterialConnectionPoint;
  143354. protected _buildBlock(state: NodeMaterialBuildState): this;
  143355. }
  143356. }
  143357. declare module BABYLON {
  143358. /**
  143359. * Operations supported by the Wave block
  143360. */
  143361. export enum WaveBlockKind {
  143362. /** SawTooth */
  143363. SawTooth = 0,
  143364. /** Square */
  143365. Square = 1,
  143366. /** Triangle */
  143367. Triangle = 2
  143368. }
  143369. /**
  143370. * Block used to apply wave operation to floats
  143371. */
  143372. export class WaveBlock extends NodeMaterialBlock {
  143373. /**
  143374. * Gets or sets the kibnd of wave to be applied by the block
  143375. */
  143376. kind: WaveBlockKind;
  143377. /**
  143378. * Creates a new WaveBlock
  143379. * @param name defines the block name
  143380. */
  143381. constructor(name: string);
  143382. /**
  143383. * Gets the current class name
  143384. * @returns the class name
  143385. */
  143386. getClassName(): string;
  143387. /**
  143388. * Gets the input component
  143389. */
  143390. get input(): NodeMaterialConnectionPoint;
  143391. /**
  143392. * Gets the output component
  143393. */
  143394. get output(): NodeMaterialConnectionPoint;
  143395. protected _buildBlock(state: NodeMaterialBuildState): this;
  143396. serialize(): any;
  143397. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  143398. }
  143399. }
  143400. declare module BABYLON {
  143401. /**
  143402. * Class used to store a color step for the GradientBlock
  143403. */
  143404. export class GradientBlockColorStep {
  143405. /**
  143406. * Gets or sets a value indicating which step this color is associated with (between 0 and 1)
  143407. */
  143408. step: number;
  143409. /**
  143410. * Gets or sets the color associated with this step
  143411. */
  143412. color: Color3;
  143413. /**
  143414. * Creates a new GradientBlockColorStep
  143415. * @param step defines a value indicating which step this color is associated with (between 0 and 1)
  143416. * @param color defines the color associated with this step
  143417. */
  143418. constructor(
  143419. /**
  143420. * Gets or sets a value indicating which step this color is associated with (between 0 and 1)
  143421. */
  143422. step: number,
  143423. /**
  143424. * Gets or sets the color associated with this step
  143425. */
  143426. color: Color3);
  143427. }
  143428. /**
  143429. * Block used to return a color from a gradient based on an input value between 0 and 1
  143430. */
  143431. export class GradientBlock extends NodeMaterialBlock {
  143432. /**
  143433. * Gets or sets the list of color steps
  143434. */
  143435. colorSteps: GradientBlockColorStep[];
  143436. /**
  143437. * Creates a new GradientBlock
  143438. * @param name defines the block name
  143439. */
  143440. constructor(name: string);
  143441. /**
  143442. * Gets the current class name
  143443. * @returns the class name
  143444. */
  143445. getClassName(): string;
  143446. /**
  143447. * Gets the gradient input component
  143448. */
  143449. get gradient(): NodeMaterialConnectionPoint;
  143450. /**
  143451. * Gets the output component
  143452. */
  143453. get output(): NodeMaterialConnectionPoint;
  143454. private _writeColorConstant;
  143455. protected _buildBlock(state: NodeMaterialBuildState): this | undefined;
  143456. serialize(): any;
  143457. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  143458. protected _dumpPropertiesCode(): string;
  143459. }
  143460. }
  143461. declare module BABYLON {
  143462. /**
  143463. * Block used to normalize lerp between 2 values
  143464. */
  143465. export class NLerpBlock extends NodeMaterialBlock {
  143466. /**
  143467. * Creates a new NLerpBlock
  143468. * @param name defines the block name
  143469. */
  143470. constructor(name: string);
  143471. /**
  143472. * Gets the current class name
  143473. * @returns the class name
  143474. */
  143475. getClassName(): string;
  143476. /**
  143477. * Gets the left operand input component
  143478. */
  143479. get left(): NodeMaterialConnectionPoint;
  143480. /**
  143481. * Gets the right operand input component
  143482. */
  143483. get right(): NodeMaterialConnectionPoint;
  143484. /**
  143485. * Gets the gradient operand input component
  143486. */
  143487. get gradient(): NodeMaterialConnectionPoint;
  143488. /**
  143489. * Gets the output component
  143490. */
  143491. get output(): NodeMaterialConnectionPoint;
  143492. protected _buildBlock(state: NodeMaterialBuildState): this;
  143493. }
  143494. }
  143495. declare module BABYLON {
  143496. /**
  143497. * block used to Generate a Worley Noise 3D Noise Pattern
  143498. */
  143499. export class WorleyNoise3DBlock extends NodeMaterialBlock {
  143500. /** Gets or sets a boolean indicating that normal should be inverted on X axis */
  143501. manhattanDistance: boolean;
  143502. /**
  143503. * Creates a new WorleyNoise3DBlock
  143504. * @param name defines the block name
  143505. */
  143506. constructor(name: string);
  143507. /**
  143508. * Gets the current class name
  143509. * @returns the class name
  143510. */
  143511. getClassName(): string;
  143512. /**
  143513. * Gets the seed input component
  143514. */
  143515. get seed(): NodeMaterialConnectionPoint;
  143516. /**
  143517. * Gets the jitter input component
  143518. */
  143519. get jitter(): NodeMaterialConnectionPoint;
  143520. /**
  143521. * Gets the output component
  143522. */
  143523. get output(): NodeMaterialConnectionPoint;
  143524. protected _buildBlock(state: NodeMaterialBuildState): this | undefined;
  143525. /**
  143526. * Exposes the properties to the UI?
  143527. */
  143528. protected _dumpPropertiesCode(): string;
  143529. /**
  143530. * Exposes the properties to the Seralize?
  143531. */
  143532. serialize(): any;
  143533. /**
  143534. * Exposes the properties to the deseralize?
  143535. */
  143536. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  143537. }
  143538. }
  143539. declare module BABYLON {
  143540. /**
  143541. * block used to Generate a Simplex Perlin 3d Noise Pattern
  143542. */
  143543. export class SimplexPerlin3DBlock extends NodeMaterialBlock {
  143544. /**
  143545. * Creates a new SimplexPerlin3DBlock
  143546. * @param name defines the block name
  143547. */
  143548. constructor(name: string);
  143549. /**
  143550. * Gets the current class name
  143551. * @returns the class name
  143552. */
  143553. getClassName(): string;
  143554. /**
  143555. * Gets the seed operand input component
  143556. */
  143557. get seed(): NodeMaterialConnectionPoint;
  143558. /**
  143559. * Gets the output component
  143560. */
  143561. get output(): NodeMaterialConnectionPoint;
  143562. protected _buildBlock(state: NodeMaterialBuildState): this | undefined;
  143563. }
  143564. }
  143565. declare module BABYLON {
  143566. /**
  143567. * Block used to blend normals
  143568. */
  143569. export class NormalBlendBlock extends NodeMaterialBlock {
  143570. /**
  143571. * Creates a new NormalBlendBlock
  143572. * @param name defines the block name
  143573. */
  143574. constructor(name: string);
  143575. /**
  143576. * Gets the current class name
  143577. * @returns the class name
  143578. */
  143579. getClassName(): string;
  143580. /**
  143581. * Gets the first input component
  143582. */
  143583. get normalMap0(): NodeMaterialConnectionPoint;
  143584. /**
  143585. * Gets the second input component
  143586. */
  143587. get normalMap1(): NodeMaterialConnectionPoint;
  143588. /**
  143589. * Gets the output component
  143590. */
  143591. get output(): NodeMaterialConnectionPoint;
  143592. protected _buildBlock(state: NodeMaterialBuildState): this;
  143593. }
  143594. }
  143595. declare module BABYLON {
  143596. /**
  143597. * Block used to rotate a 2d vector by a given angle
  143598. */
  143599. export class Rotate2dBlock extends NodeMaterialBlock {
  143600. /**
  143601. * Creates a new Rotate2dBlock
  143602. * @param name defines the block name
  143603. */
  143604. constructor(name: string);
  143605. /**
  143606. * Gets the current class name
  143607. * @returns the class name
  143608. */
  143609. getClassName(): string;
  143610. /**
  143611. * Gets the input vector
  143612. */
  143613. get input(): NodeMaterialConnectionPoint;
  143614. /**
  143615. * Gets the input angle
  143616. */
  143617. get angle(): NodeMaterialConnectionPoint;
  143618. /**
  143619. * Gets the output component
  143620. */
  143621. get output(): NodeMaterialConnectionPoint;
  143622. autoConfigure(material: NodeMaterial): void;
  143623. protected _buildBlock(state: NodeMaterialBuildState): this;
  143624. }
  143625. }
  143626. declare module BABYLON {
  143627. /**
  143628. * Block used to get the reflected vector from a direction and a normal
  143629. */
  143630. export class ReflectBlock extends NodeMaterialBlock {
  143631. /**
  143632. * Creates a new ReflectBlock
  143633. * @param name defines the block name
  143634. */
  143635. constructor(name: string);
  143636. /**
  143637. * Gets the current class name
  143638. * @returns the class name
  143639. */
  143640. getClassName(): string;
  143641. /**
  143642. * Gets the incident component
  143643. */
  143644. get incident(): NodeMaterialConnectionPoint;
  143645. /**
  143646. * Gets the normal component
  143647. */
  143648. get normal(): NodeMaterialConnectionPoint;
  143649. /**
  143650. * Gets the output component
  143651. */
  143652. get output(): NodeMaterialConnectionPoint;
  143653. protected _buildBlock(state: NodeMaterialBuildState): this;
  143654. }
  143655. }
  143656. declare module BABYLON {
  143657. /**
  143658. * Block used to get the refracted vector from a direction and a normal
  143659. */
  143660. export class RefractBlock extends NodeMaterialBlock {
  143661. /**
  143662. * Creates a new RefractBlock
  143663. * @param name defines the block name
  143664. */
  143665. constructor(name: string);
  143666. /**
  143667. * Gets the current class name
  143668. * @returns the class name
  143669. */
  143670. getClassName(): string;
  143671. /**
  143672. * Gets the incident component
  143673. */
  143674. get incident(): NodeMaterialConnectionPoint;
  143675. /**
  143676. * Gets the normal component
  143677. */
  143678. get normal(): NodeMaterialConnectionPoint;
  143679. /**
  143680. * Gets the index of refraction component
  143681. */
  143682. get ior(): NodeMaterialConnectionPoint;
  143683. /**
  143684. * Gets the output component
  143685. */
  143686. get output(): NodeMaterialConnectionPoint;
  143687. protected _buildBlock(state: NodeMaterialBuildState): this;
  143688. }
  143689. }
  143690. declare module BABYLON {
  143691. /**
  143692. * Block used to desaturate a color
  143693. */
  143694. export class DesaturateBlock extends NodeMaterialBlock {
  143695. /**
  143696. * Creates a new DesaturateBlock
  143697. * @param name defines the block name
  143698. */
  143699. constructor(name: string);
  143700. /**
  143701. * Gets the current class name
  143702. * @returns the class name
  143703. */
  143704. getClassName(): string;
  143705. /**
  143706. * Gets the color operand input component
  143707. */
  143708. get color(): NodeMaterialConnectionPoint;
  143709. /**
  143710. * Gets the level operand input component
  143711. */
  143712. get level(): NodeMaterialConnectionPoint;
  143713. /**
  143714. * Gets the output component
  143715. */
  143716. get output(): NodeMaterialConnectionPoint;
  143717. protected _buildBlock(state: NodeMaterialBuildState): this;
  143718. }
  143719. }
  143720. declare module BABYLON {
  143721. /**
  143722. * Block used to implement the ambient occlusion module of the PBR material
  143723. */
  143724. export class AmbientOcclusionBlock extends NodeMaterialBlock {
  143725. /**
  143726. * Create a new AmbientOcclusionBlock
  143727. * @param name defines the block name
  143728. */
  143729. constructor(name: string);
  143730. /**
  143731. * Specifies if the ambient texture contains the ambient occlusion information in its red channel only.
  143732. */
  143733. useAmbientInGrayScale: boolean;
  143734. /**
  143735. * Initialize the block and prepare the context for build
  143736. * @param state defines the state that will be used for the build
  143737. */
  143738. initialize(state: NodeMaterialBuildState): void;
  143739. /**
  143740. * Gets the current class name
  143741. * @returns the class name
  143742. */
  143743. getClassName(): string;
  143744. /**
  143745. * Gets the texture input component
  143746. */
  143747. get texture(): NodeMaterialConnectionPoint;
  143748. /**
  143749. * Gets the texture intensity component
  143750. */
  143751. get intensity(): NodeMaterialConnectionPoint;
  143752. /**
  143753. * Gets the direct light intensity input component
  143754. */
  143755. get directLightIntensity(): NodeMaterialConnectionPoint;
  143756. /**
  143757. * Gets the ambient occlusion object output component
  143758. */
  143759. get ambientOcclusion(): NodeMaterialConnectionPoint;
  143760. /**
  143761. * Gets the main code of the block (fragment side)
  143762. * @param block instance of an AmbientOcclusionBlock or null if the code must be generated without an active ambient occlusion module
  143763. * @returns the shader code
  143764. */
  143765. static GetCode(block: Nullable<AmbientOcclusionBlock>): string;
  143766. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  143767. protected _buildBlock(state: NodeMaterialBuildState): this;
  143768. protected _dumpPropertiesCode(): string;
  143769. serialize(): any;
  143770. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  143771. }
  143772. }
  143773. declare module BABYLON {
  143774. /**
  143775. * Block used to implement the reflection module of the PBR material
  143776. */
  143777. export class ReflectionBlock extends ReflectionTextureBaseBlock {
  143778. /** @hidden */
  143779. _defineLODReflectionAlpha: string;
  143780. /** @hidden */
  143781. _defineLinearSpecularReflection: string;
  143782. private _vEnvironmentIrradianceName;
  143783. /** @hidden */
  143784. _vReflectionMicrosurfaceInfosName: string;
  143785. /** @hidden */
  143786. _vReflectionInfosName: string;
  143787. /** @hidden */
  143788. _vReflectionFilteringInfoName: string;
  143789. private _scene;
  143790. /**
  143791. * The three properties below are set by the main PBR block prior to calling methods of this class.
  143792. * This is to avoid having to add them as inputs here whereas they are already inputs of the main block, so already known.
  143793. * It's less burden on the user side in the editor part.
  143794. */
  143795. /** @hidden */
  143796. worldPositionConnectionPoint: NodeMaterialConnectionPoint;
  143797. /** @hidden */
  143798. worldNormalConnectionPoint: NodeMaterialConnectionPoint;
  143799. /** @hidden */
  143800. cameraPositionConnectionPoint: NodeMaterialConnectionPoint;
  143801. /**
  143802. * Defines if the material uses spherical harmonics vs spherical polynomials for the
  143803. * diffuse part of the IBL.
  143804. */
  143805. useSphericalHarmonics: boolean;
  143806. /**
  143807. * Force the shader to compute irradiance in the fragment shader in order to take bump in account.
  143808. */
  143809. forceIrradianceInFragment: boolean;
  143810. /**
  143811. * Create a new ReflectionBlock
  143812. * @param name defines the block name
  143813. */
  143814. constructor(name: string);
  143815. /**
  143816. * Gets the current class name
  143817. * @returns the class name
  143818. */
  143819. getClassName(): string;
  143820. /**
  143821. * Gets the position input component
  143822. */
  143823. get position(): NodeMaterialConnectionPoint;
  143824. /**
  143825. * Gets the world position input component
  143826. */
  143827. get worldPosition(): NodeMaterialConnectionPoint;
  143828. /**
  143829. * Gets the world normal input component
  143830. */
  143831. get worldNormal(): NodeMaterialConnectionPoint;
  143832. /**
  143833. * Gets the world input component
  143834. */
  143835. get world(): NodeMaterialConnectionPoint;
  143836. /**
  143837. * Gets the camera (or eye) position component
  143838. */
  143839. get cameraPosition(): NodeMaterialConnectionPoint;
  143840. /**
  143841. * Gets the view input component
  143842. */
  143843. get view(): NodeMaterialConnectionPoint;
  143844. /**
  143845. * Gets the color input component
  143846. */
  143847. get color(): NodeMaterialConnectionPoint;
  143848. /**
  143849. * Gets the reflection object output component
  143850. */
  143851. get reflection(): NodeMaterialConnectionPoint;
  143852. /**
  143853. * Returns true if the block has a texture (either its own texture or the environment texture from the scene, if set)
  143854. */
  143855. get hasTexture(): boolean;
  143856. /**
  143857. * Gets the reflection color (either the name of the variable if the color input is connected, else a default value)
  143858. */
  143859. get reflectionColor(): string;
  143860. protected _getTexture(): Nullable<BaseTexture>;
  143861. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  143862. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh, subMesh?: SubMesh): void;
  143863. /**
  143864. * Gets the code to inject in the vertex shader
  143865. * @param state current state of the node material building
  143866. * @returns the shader code
  143867. */
  143868. handleVertexSide(state: NodeMaterialBuildState): string;
  143869. /**
  143870. * Gets the main code of the block (fragment side)
  143871. * @param state current state of the node material building
  143872. * @param normalVarName name of the existing variable corresponding to the normal
  143873. * @returns the shader code
  143874. */
  143875. getCode(state: NodeMaterialBuildState, normalVarName: string): string;
  143876. protected _buildBlock(state: NodeMaterialBuildState): this;
  143877. protected _dumpPropertiesCode(): string;
  143878. serialize(): any;
  143879. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  143880. }
  143881. }
  143882. declare module BABYLON {
  143883. /**
  143884. * Block used to implement the sheen module of the PBR material
  143885. */
  143886. export class SheenBlock extends NodeMaterialBlock {
  143887. /**
  143888. * Create a new SheenBlock
  143889. * @param name defines the block name
  143890. */
  143891. constructor(name: string);
  143892. /**
  143893. * If true, the sheen effect is layered above the base BRDF with the albedo-scaling technique.
  143894. * It allows the strength of the sheen effect to not depend on the base color of the material,
  143895. * making it easier to setup and tweak the effect
  143896. */
  143897. albedoScaling: boolean;
  143898. /**
  143899. * Defines if the sheen is linked to the sheen color.
  143900. */
  143901. linkSheenWithAlbedo: boolean;
  143902. /**
  143903. * Initialize the block and prepare the context for build
  143904. * @param state defines the state that will be used for the build
  143905. */
  143906. initialize(state: NodeMaterialBuildState): void;
  143907. /**
  143908. * Gets the current class name
  143909. * @returns the class name
  143910. */
  143911. getClassName(): string;
  143912. /**
  143913. * Gets the intensity input component
  143914. */
  143915. get intensity(): NodeMaterialConnectionPoint;
  143916. /**
  143917. * Gets the color input component
  143918. */
  143919. get color(): NodeMaterialConnectionPoint;
  143920. /**
  143921. * Gets the roughness input component
  143922. */
  143923. get roughness(): NodeMaterialConnectionPoint;
  143924. /**
  143925. * Gets the sheen object output component
  143926. */
  143927. get sheen(): NodeMaterialConnectionPoint;
  143928. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  143929. /**
  143930. * Gets the main code of the block (fragment side)
  143931. * @param reflectionBlock instance of a ReflectionBlock null if the code must be generated without an active reflection module
  143932. * @returns the shader code
  143933. */
  143934. getCode(reflectionBlock: Nullable<ReflectionBlock>): string;
  143935. protected _buildBlock(state: NodeMaterialBuildState): this;
  143936. protected _dumpPropertiesCode(): string;
  143937. serialize(): any;
  143938. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  143939. }
  143940. }
  143941. declare module BABYLON {
  143942. /**
  143943. * Block used to implement the reflectivity module of the PBR material
  143944. */
  143945. export class ReflectivityBlock extends NodeMaterialBlock {
  143946. private _metallicReflectanceColor;
  143947. private _metallicF0Factor;
  143948. /** @hidden */
  143949. _vMetallicReflectanceFactorsName: string;
  143950. /**
  143951. * The property below is set by the main PBR block prior to calling methods of this class.
  143952. */
  143953. /** @hidden */
  143954. indexOfRefractionConnectionPoint: Nullable<NodeMaterialConnectionPoint>;
  143955. /**
  143956. * Specifies if the metallic texture contains the ambient occlusion information in its red channel.
  143957. */
  143958. useAmbientOcclusionFromMetallicTextureRed: boolean;
  143959. /**
  143960. * Specifies if the metallic texture contains the metallness information in its blue channel.
  143961. */
  143962. useMetallnessFromMetallicTextureBlue: boolean;
  143963. /**
  143964. * Specifies if the metallic texture contains the roughness information in its alpha channel.
  143965. */
  143966. useRoughnessFromMetallicTextureAlpha: boolean;
  143967. /**
  143968. * Specifies if the metallic texture contains the roughness information in its green channel.
  143969. */
  143970. useRoughnessFromMetallicTextureGreen: boolean;
  143971. /**
  143972. * Create a new ReflectivityBlock
  143973. * @param name defines the block name
  143974. */
  143975. constructor(name: string);
  143976. /**
  143977. * Initialize the block and prepare the context for build
  143978. * @param state defines the state that will be used for the build
  143979. */
  143980. initialize(state: NodeMaterialBuildState): void;
  143981. /**
  143982. * Gets the current class name
  143983. * @returns the class name
  143984. */
  143985. getClassName(): string;
  143986. /**
  143987. * Gets the metallic input component
  143988. */
  143989. get metallic(): NodeMaterialConnectionPoint;
  143990. /**
  143991. * Gets the roughness input component
  143992. */
  143993. get roughness(): NodeMaterialConnectionPoint;
  143994. /**
  143995. * Gets the texture input component
  143996. */
  143997. get texture(): NodeMaterialConnectionPoint;
  143998. /**
  143999. * Gets the reflectivity object output component
  144000. */
  144001. get reflectivity(): NodeMaterialConnectionPoint;
  144002. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh, subMesh?: SubMesh): void;
  144003. /**
  144004. * Gets the main code of the block (fragment side)
  144005. * @param state current state of the node material building
  144006. * @param aoIntensityVarName name of the variable with the ambient occlusion intensity
  144007. * @returns the shader code
  144008. */
  144009. getCode(state: NodeMaterialBuildState, aoIntensityVarName: string): string;
  144010. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  144011. protected _buildBlock(state: NodeMaterialBuildState): this;
  144012. protected _dumpPropertiesCode(): string;
  144013. serialize(): any;
  144014. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  144015. }
  144016. }
  144017. declare module BABYLON {
  144018. /**
  144019. * Block used to implement the anisotropy module of the PBR material
  144020. */
  144021. export class AnisotropyBlock extends NodeMaterialBlock {
  144022. /**
  144023. * The two properties below are set by the main PBR block prior to calling methods of this class.
  144024. * This is to avoid having to add them as inputs here whereas they are already inputs of the main block, so already known.
  144025. * It's less burden on the user side in the editor part.
  144026. */
  144027. /** @hidden */
  144028. worldPositionConnectionPoint: NodeMaterialConnectionPoint;
  144029. /** @hidden */
  144030. worldNormalConnectionPoint: NodeMaterialConnectionPoint;
  144031. /**
  144032. * Create a new AnisotropyBlock
  144033. * @param name defines the block name
  144034. */
  144035. constructor(name: string);
  144036. /**
  144037. * Initialize the block and prepare the context for build
  144038. * @param state defines the state that will be used for the build
  144039. */
  144040. initialize(state: NodeMaterialBuildState): void;
  144041. /**
  144042. * Gets the current class name
  144043. * @returns the class name
  144044. */
  144045. getClassName(): string;
  144046. /**
  144047. * Gets the intensity input component
  144048. */
  144049. get intensity(): NodeMaterialConnectionPoint;
  144050. /**
  144051. * Gets the direction input component
  144052. */
  144053. get direction(): NodeMaterialConnectionPoint;
  144054. /**
  144055. * Gets the texture input component
  144056. */
  144057. get texture(): NodeMaterialConnectionPoint;
  144058. /**
  144059. * Gets the uv input component
  144060. */
  144061. get uv(): NodeMaterialConnectionPoint;
  144062. /**
  144063. * Gets the worldTangent input component
  144064. */
  144065. get worldTangent(): NodeMaterialConnectionPoint;
  144066. /**
  144067. * Gets the anisotropy object output component
  144068. */
  144069. get anisotropy(): NodeMaterialConnectionPoint;
  144070. private _generateTBNSpace;
  144071. /**
  144072. * Gets the main code of the block (fragment side)
  144073. * @param state current state of the node material building
  144074. * @param generateTBNSpace if true, the code needed to create the TBN coordinate space is generated
  144075. * @returns the shader code
  144076. */
  144077. getCode(state: NodeMaterialBuildState, generateTBNSpace?: boolean): string;
  144078. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  144079. protected _buildBlock(state: NodeMaterialBuildState): this;
  144080. }
  144081. }
  144082. declare module BABYLON {
  144083. /**
  144084. * Block used to implement the clear coat module of the PBR material
  144085. */
  144086. export class ClearCoatBlock extends NodeMaterialBlock {
  144087. private _scene;
  144088. /**
  144089. * Create a new ClearCoatBlock
  144090. * @param name defines the block name
  144091. */
  144092. constructor(name: string);
  144093. /**
  144094. * Initialize the block and prepare the context for build
  144095. * @param state defines the state that will be used for the build
  144096. */
  144097. initialize(state: NodeMaterialBuildState): void;
  144098. /**
  144099. * Gets the current class name
  144100. * @returns the class name
  144101. */
  144102. getClassName(): string;
  144103. /**
  144104. * Gets the intensity input component
  144105. */
  144106. get intensity(): NodeMaterialConnectionPoint;
  144107. /**
  144108. * Gets the roughness input component
  144109. */
  144110. get roughness(): NodeMaterialConnectionPoint;
  144111. /**
  144112. * Gets the ior input component
  144113. */
  144114. get ior(): NodeMaterialConnectionPoint;
  144115. /**
  144116. * Gets the texture input component
  144117. */
  144118. get texture(): NodeMaterialConnectionPoint;
  144119. /**
  144120. * Gets the bump texture input component
  144121. */
  144122. get bumpTexture(): NodeMaterialConnectionPoint;
  144123. /**
  144124. * Gets the uv input component
  144125. */
  144126. get uv(): NodeMaterialConnectionPoint;
  144127. /**
  144128. * Gets the tint color input component
  144129. */
  144130. get tintColor(): NodeMaterialConnectionPoint;
  144131. /**
  144132. * Gets the tint "at distance" input component
  144133. */
  144134. get tintAtDistance(): NodeMaterialConnectionPoint;
  144135. /**
  144136. * Gets the tint thickness input component
  144137. */
  144138. get tintThickness(): NodeMaterialConnectionPoint;
  144139. /**
  144140. * Gets the world tangent input component
  144141. */
  144142. get worldTangent(): NodeMaterialConnectionPoint;
  144143. /**
  144144. * Gets the clear coat object output component
  144145. */
  144146. get clearcoat(): NodeMaterialConnectionPoint;
  144147. autoConfigure(material: NodeMaterial): void;
  144148. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  144149. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh, subMesh?: SubMesh): void;
  144150. private _generateTBNSpace;
  144151. /**
  144152. * Gets the main code of the block (fragment side)
  144153. * @param state current state of the node material building
  144154. * @param ccBlock instance of a ClearCoatBlock or null if the code must be generated without an active clear coat module
  144155. * @param reflectionBlock instance of a ReflectionBlock null if the code must be generated without an active reflection module
  144156. * @param worldPosVarName name of the variable holding the world position
  144157. * @param generateTBNSpace if true, the code needed to create the TBN coordinate space is generated
  144158. * @param vTBNAvailable indicate that the vTBN variable is already existing because it has already been generated by another block (PerturbNormal or Anisotropy)
  144159. * @param worldNormalVarName name of the variable holding the world normal
  144160. * @returns the shader code
  144161. */
  144162. static GetCode(state: NodeMaterialBuildState, ccBlock: Nullable<ClearCoatBlock>, reflectionBlock: Nullable<ReflectionBlock>, worldPosVarName: string, generateTBNSpace: boolean, vTBNAvailable: boolean, worldNormalVarName: string): string;
  144163. protected _buildBlock(state: NodeMaterialBuildState): this;
  144164. }
  144165. }
  144166. declare module BABYLON {
  144167. /**
  144168. * Block used to implement the sub surface module of the PBR material
  144169. */
  144170. export class SubSurfaceBlock extends NodeMaterialBlock {
  144171. /**
  144172. * Create a new SubSurfaceBlock
  144173. * @param name defines the block name
  144174. */
  144175. constructor(name: string);
  144176. /**
  144177. * Stores the intensity of the different subsurface effects in the thickness texture.
  144178. * * the green channel is the translucency intensity.
  144179. * * the blue channel is the scattering intensity.
  144180. * * the alpha channel is the refraction intensity.
  144181. */
  144182. useMaskFromThicknessTexture: boolean;
  144183. /**
  144184. * Initialize the block and prepare the context for build
  144185. * @param state defines the state that will be used for the build
  144186. */
  144187. initialize(state: NodeMaterialBuildState): void;
  144188. /**
  144189. * Gets the current class name
  144190. * @returns the class name
  144191. */
  144192. getClassName(): string;
  144193. /**
  144194. * Gets the min thickness input component
  144195. */
  144196. get minThickness(): NodeMaterialConnectionPoint;
  144197. /**
  144198. * Gets the max thickness input component
  144199. */
  144200. get maxThickness(): NodeMaterialConnectionPoint;
  144201. /**
  144202. * Gets the thickness texture component
  144203. */
  144204. get thicknessTexture(): NodeMaterialConnectionPoint;
  144205. /**
  144206. * Gets the tint color input component
  144207. */
  144208. get tintColor(): NodeMaterialConnectionPoint;
  144209. /**
  144210. * Gets the translucency intensity input component
  144211. */
  144212. get translucencyIntensity(): NodeMaterialConnectionPoint;
  144213. /**
  144214. * Gets the translucency diffusion distance input component
  144215. */
  144216. get translucencyDiffusionDistance(): NodeMaterialConnectionPoint;
  144217. /**
  144218. * Gets the refraction object parameters
  144219. */
  144220. get refraction(): NodeMaterialConnectionPoint;
  144221. /**
  144222. * Gets the sub surface object output component
  144223. */
  144224. get subsurface(): NodeMaterialConnectionPoint;
  144225. autoConfigure(material: NodeMaterial): void;
  144226. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  144227. /**
  144228. * Gets the main code of the block (fragment side)
  144229. * @param state current state of the node material building
  144230. * @param ssBlock instance of a SubSurfaceBlock or null if the code must be generated without an active sub surface module
  144231. * @param reflectionBlock instance of a ReflectionBlock null if the code must be generated without an active reflection module
  144232. * @param worldPosVarName name of the variable holding the world position
  144233. * @returns the shader code
  144234. */
  144235. static GetCode(state: NodeMaterialBuildState, ssBlock: Nullable<SubSurfaceBlock>, reflectionBlock: Nullable<ReflectionBlock>, worldPosVarName: string): string;
  144236. protected _buildBlock(state: NodeMaterialBuildState): this;
  144237. }
  144238. }
  144239. declare module BABYLON {
  144240. /**
  144241. * Block used to implement the PBR metallic/roughness model
  144242. */
  144243. export class PBRMetallicRoughnessBlock extends NodeMaterialBlock {
  144244. /**
  144245. * Gets or sets the light associated with this block
  144246. */
  144247. light: Nullable<Light>;
  144248. private _lightId;
  144249. private _scene;
  144250. private _environmentBRDFTexture;
  144251. private _environmentBrdfSamplerName;
  144252. private _vNormalWName;
  144253. private _invertNormalName;
  144254. /**
  144255. * Create a new ReflectionBlock
  144256. * @param name defines the block name
  144257. */
  144258. constructor(name: string);
  144259. /**
  144260. * Intensity of the direct lights e.g. the four lights available in your scene.
  144261. * This impacts both the direct diffuse and specular highlights.
  144262. */
  144263. directIntensity: number;
  144264. /**
  144265. * Intensity of the environment e.g. how much the environment will light the object
  144266. * either through harmonics for rough material or through the refelction for shiny ones.
  144267. */
  144268. environmentIntensity: number;
  144269. /**
  144270. * This is a special control allowing the reduction of the specular highlights coming from the
  144271. * four lights of the scene. Those highlights may not be needed in full environment lighting.
  144272. */
  144273. specularIntensity: number;
  144274. /**
  144275. * Defines the falloff type used in this material.
  144276. * It by default is Physical.
  144277. */
  144278. lightFalloff: number;
  144279. /**
  144280. * Specifies that the alpha is coming form the albedo channel alpha channel for alpha blending.
  144281. */
  144282. useAlphaFromAlbedoTexture: boolean;
  144283. /**
  144284. * Specifies that alpha test should be used
  144285. */
  144286. useAlphaTest: boolean;
  144287. /**
  144288. * Defines the alpha limits in alpha test mode.
  144289. */
  144290. alphaTestCutoff: number;
  144291. /**
  144292. * Specifies that alpha blending should be used
  144293. */
  144294. useAlphaBlending: boolean;
  144295. /**
  144296. * Defines if the alpha value should be determined via the rgb values.
  144297. * If true the luminance of the pixel might be used to find the corresponding alpha value.
  144298. */
  144299. opacityRGB: boolean;
  144300. /**
  144301. * Specifies that the material will keeps the reflection highlights over a transparent surface (only the most luminous ones).
  144302. * A car glass is a good exemple of that. When the street lights reflects on it you can not see what is behind.
  144303. */
  144304. useRadianceOverAlpha: boolean;
  144305. /**
  144306. * Specifies that the material will keeps the specular highlights over a transparent surface (only the most luminous ones).
  144307. * A car glass is a good exemple of that. When sun reflects on it you can not see what is behind.
  144308. */
  144309. useSpecularOverAlpha: boolean;
  144310. /**
  144311. * Enables specular anti aliasing in the PBR shader.
  144312. * It will both interacts on the Geometry for analytical and IBL lighting.
  144313. * It also prefilter the roughness map based on the bump values.
  144314. */
  144315. enableSpecularAntiAliasing: boolean;
  144316. /**
  144317. * Enables realtime filtering on the texture.
  144318. */
  144319. realTimeFiltering: boolean;
  144320. /**
  144321. * Quality switch for realtime filtering
  144322. */
  144323. realTimeFilteringQuality: number;
  144324. /**
  144325. * Defines if the material uses energy conservation.
  144326. */
  144327. useEnergyConservation: boolean;
  144328. /**
  144329. * This parameters will enable/disable radiance occlusion by preventing the radiance to lit
  144330. * too much the area relying on ambient texture to define their ambient occlusion.
  144331. */
  144332. useRadianceOcclusion: boolean;
  144333. /**
  144334. * This parameters will enable/disable Horizon occlusion to prevent normal maps to look shiny when the normal
  144335. * makes the reflect vector face the model (under horizon).
  144336. */
  144337. useHorizonOcclusion: boolean;
  144338. /**
  144339. * If set to true, no lighting calculations will be applied.
  144340. */
  144341. unlit: boolean;
  144342. /**
  144343. * Force normal to face away from face.
  144344. */
  144345. forceNormalForward: boolean;
  144346. /**
  144347. * Defines the material debug mode.
  144348. * It helps seeing only some components of the material while troubleshooting.
  144349. */
  144350. debugMode: number;
  144351. /**
  144352. * Specify from where on screen the debug mode should start.
  144353. * The value goes from -1 (full screen) to 1 (not visible)
  144354. * It helps with side by side comparison against the final render
  144355. * This defaults to 0
  144356. */
  144357. debugLimit: number;
  144358. /**
  144359. * As the default viewing range might not be enough (if the ambient is really small for instance)
  144360. * You can use the factor to better multiply the final value.
  144361. */
  144362. debugFactor: number;
  144363. /**
  144364. * Initialize the block and prepare the context for build
  144365. * @param state defines the state that will be used for the build
  144366. */
  144367. initialize(state: NodeMaterialBuildState): void;
  144368. /**
  144369. * Gets the current class name
  144370. * @returns the class name
  144371. */
  144372. getClassName(): string;
  144373. /**
  144374. * Gets the world position input component
  144375. */
  144376. get worldPosition(): NodeMaterialConnectionPoint;
  144377. /**
  144378. * Gets the world normal input component
  144379. */
  144380. get worldNormal(): NodeMaterialConnectionPoint;
  144381. /**
  144382. * Gets the perturbed normal input component
  144383. */
  144384. get perturbedNormal(): NodeMaterialConnectionPoint;
  144385. /**
  144386. * Gets the camera position input component
  144387. */
  144388. get cameraPosition(): NodeMaterialConnectionPoint;
  144389. /**
  144390. * Gets the base color input component
  144391. */
  144392. get baseColor(): NodeMaterialConnectionPoint;
  144393. /**
  144394. * Gets the opacity texture input component
  144395. */
  144396. get opacityTexture(): NodeMaterialConnectionPoint;
  144397. /**
  144398. * Gets the ambient color input component
  144399. */
  144400. get ambientColor(): NodeMaterialConnectionPoint;
  144401. /**
  144402. * Gets the reflectivity object parameters
  144403. */
  144404. get reflectivity(): NodeMaterialConnectionPoint;
  144405. /**
  144406. * Gets the ambient occlusion object parameters
  144407. */
  144408. get ambientOcclusion(): NodeMaterialConnectionPoint;
  144409. /**
  144410. * Gets the reflection object parameters
  144411. */
  144412. get reflection(): NodeMaterialConnectionPoint;
  144413. /**
  144414. * Gets the sheen object parameters
  144415. */
  144416. get sheen(): NodeMaterialConnectionPoint;
  144417. /**
  144418. * Gets the clear coat object parameters
  144419. */
  144420. get clearcoat(): NodeMaterialConnectionPoint;
  144421. /**
  144422. * Gets the sub surface object parameters
  144423. */
  144424. get subsurface(): NodeMaterialConnectionPoint;
  144425. /**
  144426. * Gets the anisotropy object parameters
  144427. */
  144428. get anisotropy(): NodeMaterialConnectionPoint;
  144429. /**
  144430. * Gets the ambient output component
  144431. */
  144432. get ambient(): NodeMaterialConnectionPoint;
  144433. /**
  144434. * Gets the diffuse output component
  144435. */
  144436. get diffuse(): NodeMaterialConnectionPoint;
  144437. /**
  144438. * Gets the specular output component
  144439. */
  144440. get specular(): NodeMaterialConnectionPoint;
  144441. /**
  144442. * Gets the sheen output component
  144443. */
  144444. get sheenDir(): NodeMaterialConnectionPoint;
  144445. /**
  144446. * Gets the clear coat output component
  144447. */
  144448. get clearcoatDir(): NodeMaterialConnectionPoint;
  144449. /**
  144450. * Gets the indirect diffuse output component
  144451. */
  144452. get diffuseIndirect(): NodeMaterialConnectionPoint;
  144453. /**
  144454. * Gets the indirect specular output component
  144455. */
  144456. get specularIndirect(): NodeMaterialConnectionPoint;
  144457. /**
  144458. * Gets the indirect sheen output component
  144459. */
  144460. get sheenIndirect(): NodeMaterialConnectionPoint;
  144461. /**
  144462. * Gets the indirect clear coat output component
  144463. */
  144464. get clearcoatIndirect(): NodeMaterialConnectionPoint;
  144465. /**
  144466. * Gets the refraction output component
  144467. */
  144468. get refraction(): NodeMaterialConnectionPoint;
  144469. /**
  144470. * Gets the global lighting output component
  144471. */
  144472. get lighting(): NodeMaterialConnectionPoint;
  144473. /**
  144474. * Gets the shadow output component
  144475. */
  144476. get shadow(): NodeMaterialConnectionPoint;
  144477. /**
  144478. * Gets the alpha output component
  144479. */
  144480. get alpha(): NodeMaterialConnectionPoint;
  144481. autoConfigure(material: NodeMaterial): void;
  144482. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  144483. updateUniformsAndSamples(state: NodeMaterialBuildState, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines, uniformBuffers: string[]): void;
  144484. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh): void;
  144485. private _injectVertexCode;
  144486. /**
  144487. * Gets the code corresponding to the albedo/opacity module
  144488. * @returns the shader code
  144489. */
  144490. getAlbedoOpacityCode(): string;
  144491. protected _buildBlock(state: NodeMaterialBuildState): this;
  144492. protected _dumpPropertiesCode(): string;
  144493. serialize(): any;
  144494. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  144495. }
  144496. }
  144497. declare module BABYLON {
  144498. /**
  144499. * Block used to compute value of one parameter modulo another
  144500. */
  144501. export class ModBlock extends NodeMaterialBlock {
  144502. /**
  144503. * Creates a new ModBlock
  144504. * @param name defines the block name
  144505. */
  144506. constructor(name: string);
  144507. /**
  144508. * Gets the current class name
  144509. * @returns the class name
  144510. */
  144511. getClassName(): string;
  144512. /**
  144513. * Gets the left operand input component
  144514. */
  144515. get left(): NodeMaterialConnectionPoint;
  144516. /**
  144517. * Gets the right operand input component
  144518. */
  144519. get right(): NodeMaterialConnectionPoint;
  144520. /**
  144521. * Gets the output component
  144522. */
  144523. get output(): NodeMaterialConnectionPoint;
  144524. protected _buildBlock(state: NodeMaterialBuildState): this;
  144525. }
  144526. }
  144527. declare module BABYLON {
  144528. /**
  144529. * Helper class to push actions to a pool of workers.
  144530. */
  144531. export class WorkerPool implements IDisposable {
  144532. private _workerInfos;
  144533. private _pendingActions;
  144534. /**
  144535. * Constructor
  144536. * @param workers Array of workers to use for actions
  144537. */
  144538. constructor(workers: Array<Worker>);
  144539. /**
  144540. * Terminates all workers and clears any pending actions.
  144541. */
  144542. dispose(): void;
  144543. /**
  144544. * Pushes an action to the worker pool. If all the workers are active, the action will be
  144545. * pended until a worker has completed its action.
  144546. * @param action The action to perform. Call onComplete when the action is complete.
  144547. */
  144548. push(action: (worker: Worker, onComplete: () => void) => void): void;
  144549. private _execute;
  144550. }
  144551. }
  144552. declare module BABYLON {
  144553. /**
  144554. * Configuration for Draco compression
  144555. */
  144556. export interface IDracoCompressionConfiguration {
  144557. /**
  144558. * Configuration for the decoder.
  144559. */
  144560. decoder: {
  144561. /**
  144562. * The url to the WebAssembly module.
  144563. */
  144564. wasmUrl?: string;
  144565. /**
  144566. * The url to the WebAssembly binary.
  144567. */
  144568. wasmBinaryUrl?: string;
  144569. /**
  144570. * The url to the fallback JavaScript module.
  144571. */
  144572. fallbackUrl?: string;
  144573. };
  144574. }
  144575. /**
  144576. * Draco compression (https://google.github.io/draco/)
  144577. *
  144578. * This class wraps the Draco module.
  144579. *
  144580. * **Encoder**
  144581. *
  144582. * The encoder is not currently implemented.
  144583. *
  144584. * **Decoder**
  144585. *
  144586. * 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.
  144587. *
  144588. * To update the configuration, use the following code:
  144589. * ```javascript
  144590. * DracoCompression.Configuration = {
  144591. * decoder: {
  144592. * wasmUrl: "<url to the WebAssembly library>",
  144593. * wasmBinaryUrl: "<url to the WebAssembly binary>",
  144594. * fallbackUrl: "<url to the fallback JavaScript library>",
  144595. * }
  144596. * };
  144597. * ```
  144598. *
  144599. * 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.
  144600. * Decoding will automatically fallback to the JavaScript version if WebAssembly version is not configured or if WebAssembly is not supported by the browser.
  144601. * Use `DracoCompression.DecoderAvailable` to determine if the decoder configuration is available for the current context.
  144602. *
  144603. * To decode Draco compressed data, get the default DracoCompression object and call decodeMeshAsync:
  144604. * ```javascript
  144605. * var vertexData = await DracoCompression.Default.decodeMeshAsync(data);
  144606. * ```
  144607. *
  144608. * @see https://www.babylonjs-playground.com/#N3EK4B#0
  144609. */
  144610. export class DracoCompression implements IDisposable {
  144611. private _workerPoolPromise?;
  144612. private _decoderModulePromise?;
  144613. /**
  144614. * The configuration. Defaults to the following urls:
  144615. * - wasmUrl: "https://preview.babylonjs.com/draco_wasm_wrapper_gltf.js"
  144616. * - wasmBinaryUrl: "https://preview.babylonjs.com/draco_decoder_gltf.wasm"
  144617. * - fallbackUrl: "https://preview.babylonjs.com/draco_decoder_gltf.js"
  144618. */
  144619. static Configuration: IDracoCompressionConfiguration;
  144620. /**
  144621. * Returns true if the decoder configuration is available.
  144622. */
  144623. static get DecoderAvailable(): boolean;
  144624. /**
  144625. * Default number of workers to create when creating the draco compression object.
  144626. */
  144627. static DefaultNumWorkers: number;
  144628. private static GetDefaultNumWorkers;
  144629. private static _Default;
  144630. /**
  144631. * Default instance for the draco compression object.
  144632. */
  144633. static get Default(): DracoCompression;
  144634. /**
  144635. * Constructor
  144636. * @param numWorkers The number of workers for async operations. Specify `0` to disable web workers and run synchronously in the current context.
  144637. */
  144638. constructor(numWorkers?: number);
  144639. /**
  144640. * Stop all async operations and release resources.
  144641. */
  144642. dispose(): void;
  144643. /**
  144644. * Returns a promise that resolves when ready. Call this manually to ensure draco compression is ready before use.
  144645. * @returns a promise that resolves when ready
  144646. */
  144647. whenReadyAsync(): Promise<void>;
  144648. /**
  144649. * Decode Draco compressed mesh data to vertex data.
  144650. * @param data The ArrayBuffer or ArrayBufferView for the Draco compression data
  144651. * @param attributes A map of attributes from vertex buffer kinds to Draco unique ids
  144652. * @returns A promise that resolves with the decoded vertex data
  144653. */
  144654. decodeMeshAsync(data: ArrayBuffer | ArrayBufferView, attributes?: {
  144655. [kind: string]: number;
  144656. }): Promise<VertexData>;
  144657. }
  144658. }
  144659. declare module BABYLON {
  144660. /**
  144661. * Class for building Constructive Solid Geometry
  144662. */
  144663. export class CSG {
  144664. private polygons;
  144665. /**
  144666. * The world matrix
  144667. */
  144668. matrix: Matrix;
  144669. /**
  144670. * Stores the position
  144671. */
  144672. position: Vector3;
  144673. /**
  144674. * Stores the rotation
  144675. */
  144676. rotation: Vector3;
  144677. /**
  144678. * Stores the rotation quaternion
  144679. */
  144680. rotationQuaternion: Nullable<Quaternion>;
  144681. /**
  144682. * Stores the scaling vector
  144683. */
  144684. scaling: Vector3;
  144685. /**
  144686. * Convert the Mesh to CSG
  144687. * @param mesh The Mesh to convert to CSG
  144688. * @returns A new CSG from the Mesh
  144689. */
  144690. static FromMesh(mesh: Mesh): CSG;
  144691. /**
  144692. * Construct a CSG solid from a list of `CSG.Polygon` instances.
  144693. * @param polygons Polygons used to construct a CSG solid
  144694. */
  144695. private static FromPolygons;
  144696. /**
  144697. * Clones, or makes a deep copy, of the CSG
  144698. * @returns A new CSG
  144699. */
  144700. clone(): CSG;
  144701. /**
  144702. * Unions this CSG with another CSG
  144703. * @param csg The CSG to union against this CSG
  144704. * @returns The unioned CSG
  144705. */
  144706. union(csg: CSG): CSG;
  144707. /**
  144708. * Unions this CSG with another CSG in place
  144709. * @param csg The CSG to union against this CSG
  144710. */
  144711. unionInPlace(csg: CSG): void;
  144712. /**
  144713. * Subtracts this CSG with another CSG
  144714. * @param csg The CSG to subtract against this CSG
  144715. * @returns A new CSG
  144716. */
  144717. subtract(csg: CSG): CSG;
  144718. /**
  144719. * Subtracts this CSG with another CSG in place
  144720. * @param csg The CSG to subtact against this CSG
  144721. */
  144722. subtractInPlace(csg: CSG): void;
  144723. /**
  144724. * Intersect this CSG with another CSG
  144725. * @param csg The CSG to intersect against this CSG
  144726. * @returns A new CSG
  144727. */
  144728. intersect(csg: CSG): CSG;
  144729. /**
  144730. * Intersects this CSG with another CSG in place
  144731. * @param csg The CSG to intersect against this CSG
  144732. */
  144733. intersectInPlace(csg: CSG): void;
  144734. /**
  144735. * Return a new CSG solid with solid and empty space switched. This solid is
  144736. * not modified.
  144737. * @returns A new CSG solid with solid and empty space switched
  144738. */
  144739. inverse(): CSG;
  144740. /**
  144741. * Inverses the CSG in place
  144742. */
  144743. inverseInPlace(): void;
  144744. /**
  144745. * This is used to keep meshes transformations so they can be restored
  144746. * when we build back a Babylon Mesh
  144747. * NB : All CSG operations are performed in world coordinates
  144748. * @param csg The CSG to copy the transform attributes from
  144749. * @returns This CSG
  144750. */
  144751. copyTransformAttributes(csg: CSG): CSG;
  144752. /**
  144753. * Build Raw mesh from CSG
  144754. * Coordinates here are in world space
  144755. * @param name The name of the mesh geometry
  144756. * @param scene The Scene
  144757. * @param keepSubMeshes Specifies if the submeshes should be kept
  144758. * @returns A new Mesh
  144759. */
  144760. buildMeshGeometry(name: string, scene?: Scene, keepSubMeshes?: boolean): Mesh;
  144761. /**
  144762. * Build Mesh from CSG taking material and transforms into account
  144763. * @param name The name of the Mesh
  144764. * @param material The material of the Mesh
  144765. * @param scene The Scene
  144766. * @param keepSubMeshes Specifies if submeshes should be kept
  144767. * @returns The new Mesh
  144768. */
  144769. toMesh(name: string, material?: Nullable<Material>, scene?: Scene, keepSubMeshes?: boolean): Mesh;
  144770. }
  144771. }
  144772. declare module BABYLON {
  144773. /**
  144774. * Class used to create a trail following a mesh
  144775. */
  144776. export class TrailMesh extends Mesh {
  144777. private _generator;
  144778. private _autoStart;
  144779. private _running;
  144780. private _diameter;
  144781. private _length;
  144782. private _sectionPolygonPointsCount;
  144783. private _sectionVectors;
  144784. private _sectionNormalVectors;
  144785. private _beforeRenderObserver;
  144786. /**
  144787. * @constructor
  144788. * @param name The value used by scene.getMeshByName() to do a lookup.
  144789. * @param generator The mesh or transform node to generate a trail.
  144790. * @param scene The scene to add this mesh to.
  144791. * @param diameter Diameter of trailing mesh. Default is 1.
  144792. * @param length Length of trailing mesh. Default is 60.
  144793. * @param autoStart Automatically start trailing mesh. Default true.
  144794. */
  144795. constructor(name: string, generator: TransformNode, scene: Scene, diameter?: number, length?: number, autoStart?: boolean);
  144796. /**
  144797. * "TrailMesh"
  144798. * @returns "TrailMesh"
  144799. */
  144800. getClassName(): string;
  144801. private _createMesh;
  144802. /**
  144803. * Start trailing mesh.
  144804. */
  144805. start(): void;
  144806. /**
  144807. * Stop trailing mesh.
  144808. */
  144809. stop(): void;
  144810. /**
  144811. * Update trailing mesh geometry.
  144812. */
  144813. update(): void;
  144814. /**
  144815. * Returns a new TrailMesh object.
  144816. * @param name is a string, the name given to the new mesh
  144817. * @param newGenerator use new generator object for cloned trail mesh
  144818. * @returns a new mesh
  144819. */
  144820. clone(name: string | undefined, newGenerator: TransformNode): TrailMesh;
  144821. /**
  144822. * Serializes this trail mesh
  144823. * @param serializationObject object to write serialization to
  144824. */
  144825. serialize(serializationObject: any): void;
  144826. /**
  144827. * Parses a serialized trail mesh
  144828. * @param parsedMesh the serialized mesh
  144829. * @param scene the scene to create the trail mesh in
  144830. * @returns the created trail mesh
  144831. */
  144832. static Parse(parsedMesh: any, scene: Scene): TrailMesh;
  144833. }
  144834. }
  144835. declare module BABYLON {
  144836. /**
  144837. * Class containing static functions to help procedurally build meshes
  144838. */
  144839. export class TiledBoxBuilder {
  144840. /**
  144841. * Creates a box mesh
  144842. * 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)
  144843. * * Please read this tutorial : https://doc.babylonjs.com/how_to/createbox_per_face_textures_and_colors
  144844. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  144845. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  144846. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  144847. * @param name defines the name of the mesh
  144848. * @param options defines the options used to create the mesh
  144849. * @param scene defines the hosting scene
  144850. * @returns the box mesh
  144851. */
  144852. static CreateTiledBox(name: string, options: {
  144853. pattern?: number;
  144854. width?: number;
  144855. height?: number;
  144856. depth?: number;
  144857. tileSize?: number;
  144858. tileWidth?: number;
  144859. tileHeight?: number;
  144860. alignHorizontal?: number;
  144861. alignVertical?: number;
  144862. faceUV?: Vector4[];
  144863. faceColors?: Color4[];
  144864. sideOrientation?: number;
  144865. updatable?: boolean;
  144866. }, scene?: Nullable<Scene>): Mesh;
  144867. }
  144868. }
  144869. declare module BABYLON {
  144870. /**
  144871. * Class containing static functions to help procedurally build meshes
  144872. */
  144873. export class TorusKnotBuilder {
  144874. /**
  144875. * Creates a torus knot mesh
  144876. * * The parameter `radius` sets the global radius size (float) of the torus knot (default 2)
  144877. * * The parameter `radialSegments` sets the number of sides on each tube segments (positive integer, default 32)
  144878. * * The parameter `tubularSegments` sets the number of tubes to decompose the knot into (positive integer, default 32)
  144879. * * The parameters `p` and `q` are the number of windings on each axis (positive integers, default 2 and 3)
  144880. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  144881. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  144882. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created.
  144883. * @param name defines the name of the mesh
  144884. * @param options defines the options used to create the mesh
  144885. * @param scene defines the hosting scene
  144886. * @returns the torus knot mesh
  144887. * @see https://doc.babylonjs.com/how_to/set_shapes#torus-knot
  144888. */
  144889. static CreateTorusKnot(name: string, options: {
  144890. radius?: number;
  144891. tube?: number;
  144892. radialSegments?: number;
  144893. tubularSegments?: number;
  144894. p?: number;
  144895. q?: number;
  144896. updatable?: boolean;
  144897. sideOrientation?: number;
  144898. frontUVs?: Vector4;
  144899. backUVs?: Vector4;
  144900. }, scene: any): Mesh;
  144901. }
  144902. }
  144903. declare module BABYLON {
  144904. /**
  144905. * Polygon
  144906. * @see https://doc.babylonjs.com/how_to/parametric_shapes#non-regular-polygon
  144907. */
  144908. export class Polygon {
  144909. /**
  144910. * Creates a rectangle
  144911. * @param xmin bottom X coord
  144912. * @param ymin bottom Y coord
  144913. * @param xmax top X coord
  144914. * @param ymax top Y coord
  144915. * @returns points that make the resulting rectation
  144916. */
  144917. static Rectangle(xmin: number, ymin: number, xmax: number, ymax: number): Vector2[];
  144918. /**
  144919. * Creates a circle
  144920. * @param radius radius of circle
  144921. * @param cx scale in x
  144922. * @param cy scale in y
  144923. * @param numberOfSides number of sides that make up the circle
  144924. * @returns points that make the resulting circle
  144925. */
  144926. static Circle(radius: number, cx?: number, cy?: number, numberOfSides?: number): Vector2[];
  144927. /**
  144928. * Creates a polygon from input string
  144929. * @param input Input polygon data
  144930. * @returns the parsed points
  144931. */
  144932. static Parse(input: string): Vector2[];
  144933. /**
  144934. * Starts building a polygon from x and y coordinates
  144935. * @param x x coordinate
  144936. * @param y y coordinate
  144937. * @returns the started path2
  144938. */
  144939. static StartingAt(x: number, y: number): Path2;
  144940. }
  144941. /**
  144942. * Builds a polygon
  144943. * @see https://doc.babylonjs.com/how_to/polygonmeshbuilder
  144944. */
  144945. export class PolygonMeshBuilder {
  144946. private _points;
  144947. private _outlinepoints;
  144948. private _holes;
  144949. private _name;
  144950. private _scene;
  144951. private _epoints;
  144952. private _eholes;
  144953. private _addToepoint;
  144954. /**
  144955. * Babylon reference to the earcut plugin.
  144956. */
  144957. bjsEarcut: any;
  144958. /**
  144959. * Creates a PolygonMeshBuilder
  144960. * @param name name of the builder
  144961. * @param contours Path of the polygon
  144962. * @param scene scene to add to when creating the mesh
  144963. * @param earcutInjection can be used to inject your own earcut reference
  144964. */
  144965. constructor(name: string, contours: Path2 | Vector2[] | any, scene?: Scene, earcutInjection?: any);
  144966. /**
  144967. * Adds a whole within the polygon
  144968. * @param hole Array of points defining the hole
  144969. * @returns this
  144970. */
  144971. addHole(hole: Vector2[]): PolygonMeshBuilder;
  144972. /**
  144973. * Creates the polygon
  144974. * @param updatable If the mesh should be updatable
  144975. * @param depth The depth of the mesh created
  144976. * @returns the created mesh
  144977. */
  144978. build(updatable?: boolean, depth?: number): Mesh;
  144979. /**
  144980. * Creates the polygon
  144981. * @param depth The depth of the mesh created
  144982. * @returns the created VertexData
  144983. */
  144984. buildVertexData(depth?: number): VertexData;
  144985. /**
  144986. * Adds a side to the polygon
  144987. * @param positions points that make the polygon
  144988. * @param normals normals of the polygon
  144989. * @param uvs uvs of the polygon
  144990. * @param indices indices of the polygon
  144991. * @param bounds bounds of the polygon
  144992. * @param points points of the polygon
  144993. * @param depth depth of the polygon
  144994. * @param flip flip of the polygon
  144995. */
  144996. private addSide;
  144997. }
  144998. }
  144999. declare module BABYLON {
  145000. /**
  145001. * Class containing static functions to help procedurally build meshes
  145002. */
  145003. export class PolygonBuilder {
  145004. /**
  145005. * Creates a polygon mesh
  145006. * The polygon's shape will depend on the input parameters and is constructed parallel to a ground mesh
  145007. * * 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
  145008. * * You can set the mesh side orientation with the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  145009. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  145010. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4)
  145011. * * Remember you can only change the shape positions, not their number when updating a polygon
  145012. * @param name defines the name of the mesh
  145013. * @param options defines the options used to create the mesh
  145014. * @param scene defines the hosting scene
  145015. * @param earcutInjection can be used to inject your own earcut reference
  145016. * @returns the polygon mesh
  145017. */
  145018. static CreatePolygon(name: string, options: {
  145019. shape: Vector3[];
  145020. holes?: Vector3[][];
  145021. depth?: number;
  145022. faceUV?: Vector4[];
  145023. faceColors?: Color4[];
  145024. updatable?: boolean;
  145025. sideOrientation?: number;
  145026. frontUVs?: Vector4;
  145027. backUVs?: Vector4;
  145028. wrap?: boolean;
  145029. }, scene?: Nullable<Scene>, earcutInjection?: any): Mesh;
  145030. /**
  145031. * Creates an extruded polygon mesh, with depth in the Y direction.
  145032. * * 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)
  145033. * @see https://doc.babylonjs.com/how_to/createbox_per_face_textures_and_colors
  145034. * @param name defines the name of the mesh
  145035. * @param options defines the options used to create the mesh
  145036. * @param scene defines the hosting scene
  145037. * @param earcutInjection can be used to inject your own earcut reference
  145038. * @returns the polygon mesh
  145039. */
  145040. static ExtrudePolygon(name: string, options: {
  145041. shape: Vector3[];
  145042. holes?: Vector3[][];
  145043. depth?: number;
  145044. faceUV?: Vector4[];
  145045. faceColors?: Color4[];
  145046. updatable?: boolean;
  145047. sideOrientation?: number;
  145048. frontUVs?: Vector4;
  145049. backUVs?: Vector4;
  145050. wrap?: boolean;
  145051. }, scene?: Nullable<Scene>, earcutInjection?: any): Mesh;
  145052. }
  145053. }
  145054. declare module BABYLON {
  145055. /**
  145056. * Class containing static functions to help procedurally build meshes
  145057. */
  145058. export class LatheBuilder {
  145059. /**
  145060. * Creates lathe mesh.
  145061. * The lathe is a shape with a symetry axis : a 2D model shape is rotated around this axis to design the lathe
  145062. * * 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
  145063. * * The parameter `radius` (positive float, default 1) is the radius value of the lathe
  145064. * * The parameter `tessellation` (positive integer, default 64) is the side number of the lathe
  145065. * * The parameter `clip` (positive integer, default 0) is the number of sides to not create without effecting the general shape of the sides
  145066. * * 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
  145067. * * The parameter `closed` (boolean, default true) opens/closes the lathe circumference. This should be set to false when used with the parameter "arc"
  145068. * * 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
  145069. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  145070. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  145071. * * The optional parameter `invertUV` (boolean, default false) swaps in the geometry the U and V coordinates to apply a texture
  145072. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  145073. * @param name defines the name of the mesh
  145074. * @param options defines the options used to create the mesh
  145075. * @param scene defines the hosting scene
  145076. * @returns the lathe mesh
  145077. * @see https://doc.babylonjs.com/how_to/parametric_shapes#lathe
  145078. */
  145079. static CreateLathe(name: string, options: {
  145080. shape: Vector3[];
  145081. radius?: number;
  145082. tessellation?: number;
  145083. clip?: number;
  145084. arc?: number;
  145085. closed?: boolean;
  145086. updatable?: boolean;
  145087. sideOrientation?: number;
  145088. frontUVs?: Vector4;
  145089. backUVs?: Vector4;
  145090. cap?: number;
  145091. invertUV?: boolean;
  145092. }, scene?: Nullable<Scene>): Mesh;
  145093. }
  145094. }
  145095. declare module BABYLON {
  145096. /**
  145097. * Class containing static functions to help procedurally build meshes
  145098. */
  145099. export class TiledPlaneBuilder {
  145100. /**
  145101. * Creates a tiled plane mesh
  145102. * * The parameter `pattern` will, depending on value, do nothing or
  145103. * * * flip (reflect about central vertical) alternate tiles across and up
  145104. * * * flip every tile on alternate rows
  145105. * * * rotate (180 degs) alternate tiles across and up
  145106. * * * rotate every tile on alternate rows
  145107. * * * flip and rotate alternate tiles across and up
  145108. * * * flip and rotate every tile on alternate rows
  145109. * * The parameter `tileSize` sets the size (float) of each tile side (default 1)
  145110. * * You can set some different tile dimensions by using the parameters `tileWidth` and `tileHeight` (both by default have the same value of `tileSize`)
  145111. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  145112. * * sideOrientation optional and takes the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  145113. * * 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)
  145114. * * 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)
  145115. * @see https://doc.babylonjs.com/how_to/set_shapes#box
  145116. * @param name defines the name of the mesh
  145117. * @param options defines the options used to create the mesh
  145118. * @param scene defines the hosting scene
  145119. * @returns the box mesh
  145120. */
  145121. static CreateTiledPlane(name: string, options: {
  145122. pattern?: number;
  145123. tileSize?: number;
  145124. tileWidth?: number;
  145125. tileHeight?: number;
  145126. size?: number;
  145127. width?: number;
  145128. height?: number;
  145129. alignHorizontal?: number;
  145130. alignVertical?: number;
  145131. sideOrientation?: number;
  145132. frontUVs?: Vector4;
  145133. backUVs?: Vector4;
  145134. updatable?: boolean;
  145135. }, scene?: Nullable<Scene>): Mesh;
  145136. }
  145137. }
  145138. declare module BABYLON {
  145139. /**
  145140. * Class containing static functions to help procedurally build meshes
  145141. */
  145142. export class TubeBuilder {
  145143. /**
  145144. * Creates a tube mesh.
  145145. * The tube is a parametric shape. It has no predefined shape. Its final shape will depend on the input parameters
  145146. * * The parameter `path` is a required array of successive Vector3. It is the curve used as the axis of the tube
  145147. * * The parameter `radius` (positive float, default 1) sets the tube radius size
  145148. * * The parameter `tessellation` (positive float, default 64) is the number of sides on the tubular surface
  145149. * * The parameter `radiusFunction` (javascript function, default null) is a vanilla javascript function. If it is not null, it overwrittes the parameter `radius`
  145150. * * 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)
  145151. * * The parameter `arc` (positive float, maximum 1, default 1) is the ratio to apply to the tube circumference : 2 x PI x arc
  145152. * * 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
  145153. * * 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
  145154. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  145155. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  145156. * * The optional parameter `invertUV` (boolean, default false) swaps in the geometry the U and V coordinates to apply a texture
  145157. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  145158. * @param name defines the name of the mesh
  145159. * @param options defines the options used to create the mesh
  145160. * @param scene defines the hosting scene
  145161. * @returns the tube mesh
  145162. * @see https://doc.babylonjs.com/how_to/parametric_shapes
  145163. * @see https://doc.babylonjs.com/how_to/set_shapes#tube
  145164. */
  145165. static CreateTube(name: string, options: {
  145166. path: Vector3[];
  145167. radius?: number;
  145168. tessellation?: number;
  145169. radiusFunction?: {
  145170. (i: number, distance: number): number;
  145171. };
  145172. cap?: number;
  145173. arc?: number;
  145174. updatable?: boolean;
  145175. sideOrientation?: number;
  145176. frontUVs?: Vector4;
  145177. backUVs?: Vector4;
  145178. instance?: Mesh;
  145179. invertUV?: boolean;
  145180. }, scene?: Nullable<Scene>): Mesh;
  145181. }
  145182. }
  145183. declare module BABYLON {
  145184. /**
  145185. * Class containing static functions to help procedurally build meshes
  145186. */
  145187. export class IcoSphereBuilder {
  145188. /**
  145189. * Creates a sphere based upon an icosahedron with 20 triangular faces which can be subdivided
  145190. * * The parameter `radius` sets the radius size (float) of the icosphere (default 1)
  145191. * * 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`)
  145192. * * The parameter `subdivisions` sets the number of subdivisions (postive integer, default 4). The more subdivisions, the more faces on the icosphere whatever its size
  145193. * * 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
  145194. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  145195. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  145196. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  145197. * @param name defines the name of the mesh
  145198. * @param options defines the options used to create the mesh
  145199. * @param scene defines the hosting scene
  145200. * @returns the icosahedron mesh
  145201. * @see https://doc.babylonjs.com/how_to/polyhedra_shapes#icosphere
  145202. */
  145203. static CreateIcoSphere(name: string, options: {
  145204. radius?: number;
  145205. radiusX?: number;
  145206. radiusY?: number;
  145207. radiusZ?: number;
  145208. flat?: boolean;
  145209. subdivisions?: number;
  145210. sideOrientation?: number;
  145211. frontUVs?: Vector4;
  145212. backUVs?: Vector4;
  145213. updatable?: boolean;
  145214. }, scene?: Nullable<Scene>): Mesh;
  145215. }
  145216. }
  145217. declare module BABYLON {
  145218. /**
  145219. * Class containing static functions to help procedurally build meshes
  145220. */
  145221. export class DecalBuilder {
  145222. /**
  145223. * Creates a decal mesh.
  145224. * 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
  145225. * * The parameter `position` (Vector3, default `(0, 0, 0)`) sets the position of the decal in World coordinates
  145226. * * The parameter `normal` (Vector3, default `Vector3.Up`) sets the normal of the mesh where the decal is applied onto in World coordinates
  145227. * * The parameter `size` (Vector3, default `(1, 1, 1)`) sets the decal scaling
  145228. * * The parameter `angle` (float in radian, default 0) sets the angle to rotate the decal
  145229. * @param name defines the name of the mesh
  145230. * @param sourceMesh defines the mesh where the decal must be applied
  145231. * @param options defines the options used to create the mesh
  145232. * @param scene defines the hosting scene
  145233. * @returns the decal mesh
  145234. * @see https://doc.babylonjs.com/how_to/decals
  145235. */
  145236. static CreateDecal(name: string, sourceMesh: AbstractMesh, options: {
  145237. position?: Vector3;
  145238. normal?: Vector3;
  145239. size?: Vector3;
  145240. angle?: number;
  145241. }): Mesh;
  145242. }
  145243. }
  145244. declare module BABYLON {
  145245. /**
  145246. * Class containing static functions to help procedurally build meshes
  145247. */
  145248. export class MeshBuilder {
  145249. /**
  145250. * Creates a box mesh
  145251. * * The parameter `size` sets the size (float) of each box side (default 1)
  145252. * * You can set some different box dimensions by using the parameters `width`, `height` and `depth` (all by default have the same value of `size`)
  145253. * * 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)
  145254. * * Please read this tutorial : https://doc.babylonjs.com/how_to/createbox_per_face_textures_and_colors
  145255. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  145256. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  145257. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  145258. * @see https://doc.babylonjs.com/how_to/set_shapes#box
  145259. * @param name defines the name of the mesh
  145260. * @param options defines the options used to create the mesh
  145261. * @param scene defines the hosting scene
  145262. * @returns the box mesh
  145263. */
  145264. static CreateBox(name: string, options: {
  145265. size?: number;
  145266. width?: number;
  145267. height?: number;
  145268. depth?: number;
  145269. faceUV?: Vector4[];
  145270. faceColors?: Color4[];
  145271. sideOrientation?: number;
  145272. frontUVs?: Vector4;
  145273. backUVs?: Vector4;
  145274. wrap?: boolean;
  145275. topBaseAt?: number;
  145276. bottomBaseAt?: number;
  145277. updatable?: boolean;
  145278. }, scene?: Nullable<Scene>): Mesh;
  145279. /**
  145280. * Creates a tiled box mesh
  145281. * * faceTiles sets the pattern, tile size and number of tiles for a face
  145282. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  145283. * @param name defines the name of the mesh
  145284. * @param options defines the options used to create the mesh
  145285. * @param scene defines the hosting scene
  145286. * @returns the tiled box mesh
  145287. */
  145288. static CreateTiledBox(name: string, options: {
  145289. pattern?: number;
  145290. size?: number;
  145291. width?: number;
  145292. height?: number;
  145293. depth: number;
  145294. tileSize?: number;
  145295. tileWidth?: number;
  145296. tileHeight?: number;
  145297. faceUV?: Vector4[];
  145298. faceColors?: Color4[];
  145299. alignHorizontal?: number;
  145300. alignVertical?: number;
  145301. sideOrientation?: number;
  145302. updatable?: boolean;
  145303. }, scene?: Nullable<Scene>): Mesh;
  145304. /**
  145305. * Creates a sphere mesh
  145306. * * The parameter `diameter` sets the diameter size (float) of the sphere (default 1)
  145307. * * 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`)
  145308. * * The parameter `segments` sets the sphere number of horizontal stripes (positive integer, default 32)
  145309. * * 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
  145310. * * 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)
  145311. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  145312. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  145313. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  145314. * @param name defines the name of the mesh
  145315. * @param options defines the options used to create the mesh
  145316. * @param scene defines the hosting scene
  145317. * @returns the sphere mesh
  145318. * @see https://doc.babylonjs.com/how_to/set_shapes#sphere
  145319. */
  145320. static CreateSphere(name: string, options: {
  145321. segments?: number;
  145322. diameter?: number;
  145323. diameterX?: number;
  145324. diameterY?: number;
  145325. diameterZ?: number;
  145326. arc?: number;
  145327. slice?: number;
  145328. sideOrientation?: number;
  145329. frontUVs?: Vector4;
  145330. backUVs?: Vector4;
  145331. updatable?: boolean;
  145332. }, scene?: Nullable<Scene>): Mesh;
  145333. /**
  145334. * Creates a plane polygonal mesh. By default, this is a disc
  145335. * * The parameter `radius` sets the radius size (float) of the polygon (default 0.5)
  145336. * * 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
  145337. * * 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
  145338. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  145339. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  145340. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  145341. * @param name defines the name of the mesh
  145342. * @param options defines the options used to create the mesh
  145343. * @param scene defines the hosting scene
  145344. * @returns the plane polygonal mesh
  145345. * @see https://doc.babylonjs.com/how_to/set_shapes#disc-or-regular-polygon
  145346. */
  145347. static CreateDisc(name: string, options: {
  145348. radius?: number;
  145349. tessellation?: number;
  145350. arc?: number;
  145351. updatable?: boolean;
  145352. sideOrientation?: number;
  145353. frontUVs?: Vector4;
  145354. backUVs?: Vector4;
  145355. }, scene?: Nullable<Scene>): Mesh;
  145356. /**
  145357. * Creates a sphere based upon an icosahedron with 20 triangular faces which can be subdivided
  145358. * * The parameter `radius` sets the radius size (float) of the icosphere (default 1)
  145359. * * 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`)
  145360. * * The parameter `subdivisions` sets the number of subdivisions (postive integer, default 4). The more subdivisions, the more faces on the icosphere whatever its size
  145361. * * 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
  145362. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  145363. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  145364. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  145365. * @param name defines the name of the mesh
  145366. * @param options defines the options used to create the mesh
  145367. * @param scene defines the hosting scene
  145368. * @returns the icosahedron mesh
  145369. * @see https://doc.babylonjs.com/how_to/polyhedra_shapes#icosphere
  145370. */
  145371. static CreateIcoSphere(name: string, options: {
  145372. radius?: number;
  145373. radiusX?: number;
  145374. radiusY?: number;
  145375. radiusZ?: number;
  145376. flat?: boolean;
  145377. subdivisions?: number;
  145378. sideOrientation?: number;
  145379. frontUVs?: Vector4;
  145380. backUVs?: Vector4;
  145381. updatable?: boolean;
  145382. }, scene?: Nullable<Scene>): Mesh;
  145383. /**
  145384. * Creates a ribbon mesh. The ribbon is a parametric shape. It has no predefined shape. Its final shape will depend on the input parameters
  145385. * * The parameter `pathArray` is a required array of paths, what are each an array of successive Vector3. The pathArray parameter depicts the ribbon geometry
  145386. * * The parameter `closeArray` (boolean, default false) creates a seam between the first and the last paths of the path array
  145387. * * The parameter `closePath` (boolean, default false) creates a seam between the first and the last points of each path of the path array
  145388. * * 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
  145389. * * 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
  145390. * * 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
  145391. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  145392. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  145393. * * The optional parameter `invertUV` (boolean, default false) swaps in the geometry the U and V coordinates to apply a texture
  145394. * * 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
  145395. * * The parameters `colors` is an optional flat array of `Color4` to set/update each ribbon vertex with its own custom color values
  145396. * * 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
  145397. * * Moreover, you can use the parameter `color` with `instance` (to update the ribbon), only if you previously used it at creation time
  145398. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  145399. * @param name defines the name of the mesh
  145400. * @param options defines the options used to create the mesh
  145401. * @param scene defines the hosting scene
  145402. * @returns the ribbon mesh
  145403. * @see https://doc.babylonjs.com/how_to/ribbon_tutorial
  145404. * @see https://doc.babylonjs.com/how_to/parametric_shapes
  145405. */
  145406. static CreateRibbon(name: string, options: {
  145407. pathArray: Vector3[][];
  145408. closeArray?: boolean;
  145409. closePath?: boolean;
  145410. offset?: number;
  145411. updatable?: boolean;
  145412. sideOrientation?: number;
  145413. frontUVs?: Vector4;
  145414. backUVs?: Vector4;
  145415. instance?: Mesh;
  145416. invertUV?: boolean;
  145417. uvs?: Vector2[];
  145418. colors?: Color4[];
  145419. }, scene?: Nullable<Scene>): Mesh;
  145420. /**
  145421. * Creates a cylinder or a cone mesh
  145422. * * The parameter `height` sets the height size (float) of the cylinder/cone (float, default 2).
  145423. * * The parameter `diameter` sets the diameter of the top and bottom cap at once (float, default 1).
  145424. * * 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.
  145425. * * The parameter `tessellation` sets the number of cylinder sides (positive integer, default 24). Set it to 3 to get a prism for instance.
  145426. * * The parameter `subdivisions` sets the number of rings along the cylinder height (positive integer, default 1).
  145427. * * The parameter `hasRings` (boolean, default false) makes the subdivisions independent from each other, so they become different faces.
  145428. * * The parameter `enclose` (boolean, default false) adds two extra faces per subdivision to a sliced cylinder to close it around its height axis.
  145429. * * 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).
  145430. * * The parameter `arc` (float, default 1) is the ratio (max 1) to apply to the circumference to slice the cylinder.
  145431. * * 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).
  145432. * * 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
  145433. * * Now, if the cylinder has 5 independent subdivisions (hasRings = true), n equals : top face + 5 stripe surfaces + bottom face = 2 + 5 = 7
  145434. * * 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
  145435. * * 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.
  145436. * * If `enclose` is false, a ring surface is one element.
  145437. * * If `enclose` is true, a ring surface is 3 successive elements in the array : the tubular surface, then the two closing faces.
  145438. * * 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
  145439. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  145440. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  145441. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created.
  145442. * @param name defines the name of the mesh
  145443. * @param options defines the options used to create the mesh
  145444. * @param scene defines the hosting scene
  145445. * @returns the cylinder mesh
  145446. * @see https://doc.babylonjs.com/how_to/set_shapes#cylinder-or-cone
  145447. */
  145448. static CreateCylinder(name: string, options: {
  145449. height?: number;
  145450. diameterTop?: number;
  145451. diameterBottom?: number;
  145452. diameter?: number;
  145453. tessellation?: number;
  145454. subdivisions?: number;
  145455. arc?: number;
  145456. faceColors?: Color4[];
  145457. faceUV?: Vector4[];
  145458. updatable?: boolean;
  145459. hasRings?: boolean;
  145460. enclose?: boolean;
  145461. cap?: number;
  145462. sideOrientation?: number;
  145463. frontUVs?: Vector4;
  145464. backUVs?: Vector4;
  145465. }, scene?: Nullable<Scene>): Mesh;
  145466. /**
  145467. * Creates a torus mesh
  145468. * * The parameter `diameter` sets the diameter size (float) of the torus (default 1)
  145469. * * The parameter `thickness` sets the diameter size of the tube of the torus (float, default 0.5)
  145470. * * The parameter `tessellation` sets the number of torus sides (postive integer, default 16)
  145471. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  145472. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  145473. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created.
  145474. * @param name defines the name of the mesh
  145475. * @param options defines the options used to create the mesh
  145476. * @param scene defines the hosting scene
  145477. * @returns the torus mesh
  145478. * @see https://doc.babylonjs.com/how_to/set_shapes#torus
  145479. */
  145480. static CreateTorus(name: string, options: {
  145481. diameter?: number;
  145482. thickness?: number;
  145483. tessellation?: number;
  145484. updatable?: boolean;
  145485. sideOrientation?: number;
  145486. frontUVs?: Vector4;
  145487. backUVs?: Vector4;
  145488. }, scene?: Nullable<Scene>): Mesh;
  145489. /**
  145490. * Creates a torus knot mesh
  145491. * * The parameter `radius` sets the global radius size (float) of the torus knot (default 2)
  145492. * * The parameter `radialSegments` sets the number of sides on each tube segments (positive integer, default 32)
  145493. * * The parameter `tubularSegments` sets the number of tubes to decompose the knot into (positive integer, default 32)
  145494. * * The parameters `p` and `q` are the number of windings on each axis (positive integers, default 2 and 3)
  145495. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  145496. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  145497. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created.
  145498. * @param name defines the name of the mesh
  145499. * @param options defines the options used to create the mesh
  145500. * @param scene defines the hosting scene
  145501. * @returns the torus knot mesh
  145502. * @see https://doc.babylonjs.com/how_to/set_shapes#torus-knot
  145503. */
  145504. static CreateTorusKnot(name: string, options: {
  145505. radius?: number;
  145506. tube?: number;
  145507. radialSegments?: number;
  145508. tubularSegments?: number;
  145509. p?: number;
  145510. q?: number;
  145511. updatable?: boolean;
  145512. sideOrientation?: number;
  145513. frontUVs?: Vector4;
  145514. backUVs?: Vector4;
  145515. }, scene?: Nullable<Scene>): Mesh;
  145516. /**
  145517. * Creates a line system mesh. A line system is a pool of many lines gathered in a single mesh
  145518. * * 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
  145519. * * Like every other parametric shape, it is dynamically updatable by passing an existing instance of LineSystem to this static function
  145520. * * The parameter `lines` is an array of lines, each line being an array of successive Vector3
  145521. * * The optional parameter `instance` is an instance of an existing LineSystem object to be updated with the passed `lines` parameter
  145522. * * The optional parameter `colors` is an array of line colors, each line colors being an array of successive Color4, one per line point
  145523. * * The optional parameter `useVertexAlpha` is to be set to `false` (default `true`) when you don't need the alpha blending (faster)
  145524. * * 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
  145525. * * When updating an instance, remember that only line point positions can change, not the number of points, neither the number of lines
  145526. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  145527. * @see https://doc.babylonjs.com/how_to/parametric_shapes#line-system
  145528. * @param name defines the name of the new line system
  145529. * @param options defines the options used to create the line system
  145530. * @param scene defines the hosting scene
  145531. * @returns a new line system mesh
  145532. */
  145533. static CreateLineSystem(name: string, options: {
  145534. lines: Vector3[][];
  145535. updatable?: boolean;
  145536. instance?: Nullable<LinesMesh>;
  145537. colors?: Nullable<Color4[][]>;
  145538. useVertexAlpha?: boolean;
  145539. }, scene: Nullable<Scene>): LinesMesh;
  145540. /**
  145541. * Creates a line mesh
  145542. * 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
  145543. * * Like every other parametric shape, it is dynamically updatable by passing an existing instance of LineMesh to this static function
  145544. * * The parameter `points` is an array successive Vector3
  145545. * * 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
  145546. * * The optional parameter `colors` is an array of successive Color4, one per line point
  145547. * * The optional parameter `useVertexAlpha` is to be set to `false` (default `true`) when you don't need alpha blending (faster)
  145548. * * When updating an instance, remember that only point positions can change, not the number of points
  145549. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  145550. * @see https://doc.babylonjs.com/how_to/parametric_shapes#lines
  145551. * @param name defines the name of the new line system
  145552. * @param options defines the options used to create the line system
  145553. * @param scene defines the hosting scene
  145554. * @returns a new line mesh
  145555. */
  145556. static CreateLines(name: string, options: {
  145557. points: Vector3[];
  145558. updatable?: boolean;
  145559. instance?: Nullable<LinesMesh>;
  145560. colors?: Color4[];
  145561. useVertexAlpha?: boolean;
  145562. }, scene?: Nullable<Scene>): LinesMesh;
  145563. /**
  145564. * Creates a dashed line mesh
  145565. * * 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
  145566. * * Like every other parametric shape, it is dynamically updatable by passing an existing instance of LineMesh to this static function
  145567. * * The parameter `points` is an array successive Vector3
  145568. * * The parameter `dashNb` is the intended total number of dashes (positive integer, default 200)
  145569. * * The parameter `dashSize` is the size of the dashes relatively the dash number (positive float, default 3)
  145570. * * The parameter `gapSize` is the size of the gap between two successive dashes relatively the dash number (positive float, default 1)
  145571. * * 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
  145572. * * When updating an instance, remember that only point positions can change, not the number of points
  145573. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  145574. * @param name defines the name of the mesh
  145575. * @param options defines the options used to create the mesh
  145576. * @param scene defines the hosting scene
  145577. * @returns the dashed line mesh
  145578. * @see https://doc.babylonjs.com/how_to/parametric_shapes#dashed-lines
  145579. */
  145580. static CreateDashedLines(name: string, options: {
  145581. points: Vector3[];
  145582. dashSize?: number;
  145583. gapSize?: number;
  145584. dashNb?: number;
  145585. updatable?: boolean;
  145586. instance?: LinesMesh;
  145587. }, scene?: Nullable<Scene>): LinesMesh;
  145588. /**
  145589. * 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.
  145590. * * 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.
  145591. * * The parameter `path` is a required array of successive Vector3. This is the axis curve the shape is extruded along.
  145592. * * 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.
  145593. * * The parameter `scale` (float, default 1) is the value to scale the shape.
  145594. * * 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
  145595. * * 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
  145596. * * Remember you can only change the shape or path point positions, not their number when updating an extruded shape.
  145597. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  145598. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  145599. * * The optional parameter `invertUV` (boolean, default false) swaps in the geometry the U and V coordinates to apply a texture.
  145600. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created.
  145601. * @param name defines the name of the mesh
  145602. * @param options defines the options used to create the mesh
  145603. * @param scene defines the hosting scene
  145604. * @returns the extruded shape mesh
  145605. * @see https://doc.babylonjs.com/how_to/parametric_shapes
  145606. * @see https://doc.babylonjs.com/how_to/parametric_shapes#extruded-shapes
  145607. */
  145608. static ExtrudeShape(name: string, options: {
  145609. shape: Vector3[];
  145610. path: Vector3[];
  145611. scale?: number;
  145612. rotation?: number;
  145613. cap?: number;
  145614. updatable?: boolean;
  145615. sideOrientation?: number;
  145616. frontUVs?: Vector4;
  145617. backUVs?: Vector4;
  145618. instance?: Mesh;
  145619. invertUV?: boolean;
  145620. }, scene?: Nullable<Scene>): Mesh;
  145621. /**
  145622. * Creates an custom extruded shape mesh.
  145623. * The custom extrusion is a parametric shape. It has no predefined shape. Its final shape will depend on the input parameters.
  145624. * * 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.
  145625. * * The parameter `path` is a required array of successive Vector3. This is the axis curve the shape is extruded along.
  145626. * * 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
  145627. * * It must returns a float value that will be the rotation in radians applied to the shape on each path point.
  145628. * * 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
  145629. * * It must returns a float value that will be the scale value applied to the shape on each path point
  145630. * * The parameter `ribbonClosePath` (boolean, default false) forces the extrusion underlying ribbon to close all the paths in its `pathArray`
  145631. * * The parameter `ribbonCloseArray` (boolean, default false) forces the extrusion underlying ribbon to close its `pathArray`
  145632. * * 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
  145633. * * 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
  145634. * * Remember you can only change the shape or path point positions, not their number when updating an extruded shape
  145635. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  145636. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  145637. * * The optional parameter `invertUV` (boolean, default false) swaps in the geometry the U and V coordinates to apply a texture
  145638. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  145639. * @param name defines the name of the mesh
  145640. * @param options defines the options used to create the mesh
  145641. * @param scene defines the hosting scene
  145642. * @returns the custom extruded shape mesh
  145643. * @see https://doc.babylonjs.com/how_to/parametric_shapes#custom-extruded-shapes
  145644. * @see https://doc.babylonjs.com/how_to/parametric_shapes
  145645. * @see https://doc.babylonjs.com/how_to/parametric_shapes#extruded-shapes
  145646. */
  145647. static ExtrudeShapeCustom(name: string, options: {
  145648. shape: Vector3[];
  145649. path: Vector3[];
  145650. scaleFunction?: any;
  145651. rotationFunction?: any;
  145652. ribbonCloseArray?: boolean;
  145653. ribbonClosePath?: boolean;
  145654. cap?: number;
  145655. updatable?: boolean;
  145656. sideOrientation?: number;
  145657. frontUVs?: Vector4;
  145658. backUVs?: Vector4;
  145659. instance?: Mesh;
  145660. invertUV?: boolean;
  145661. }, scene?: Nullable<Scene>): Mesh;
  145662. /**
  145663. * Creates lathe mesh.
  145664. * The lathe is a shape with a symetry axis : a 2D model shape is rotated around this axis to design the lathe
  145665. * * 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
  145666. * * The parameter `radius` (positive float, default 1) is the radius value of the lathe
  145667. * * The parameter `tessellation` (positive integer, default 64) is the side number of the lathe
  145668. * * The parameter `clip` (positive integer, default 0) is the number of sides to not create without effecting the general shape of the sides
  145669. * * 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
  145670. * * The parameter `closed` (boolean, default true) opens/closes the lathe circumference. This should be set to false when used with the parameter "arc"
  145671. * * 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
  145672. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  145673. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  145674. * * The optional parameter `invertUV` (boolean, default false) swaps in the geometry the U and V coordinates to apply a texture
  145675. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  145676. * @param name defines the name of the mesh
  145677. * @param options defines the options used to create the mesh
  145678. * @param scene defines the hosting scene
  145679. * @returns the lathe mesh
  145680. * @see https://doc.babylonjs.com/how_to/parametric_shapes#lathe
  145681. */
  145682. static CreateLathe(name: string, options: {
  145683. shape: Vector3[];
  145684. radius?: number;
  145685. tessellation?: number;
  145686. clip?: number;
  145687. arc?: number;
  145688. closed?: boolean;
  145689. updatable?: boolean;
  145690. sideOrientation?: number;
  145691. frontUVs?: Vector4;
  145692. backUVs?: Vector4;
  145693. cap?: number;
  145694. invertUV?: boolean;
  145695. }, scene?: Nullable<Scene>): Mesh;
  145696. /**
  145697. * Creates a tiled plane mesh
  145698. * * You can set a limited pattern arrangement with the tiles
  145699. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  145700. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  145701. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  145702. * @param name defines the name of the mesh
  145703. * @param options defines the options used to create the mesh
  145704. * @param scene defines the hosting scene
  145705. * @returns the plane mesh
  145706. * @see https://doc.babylonjs.com/how_to/set_shapes#plane
  145707. */
  145708. static CreateTiledPlane(name: string, options: {
  145709. pattern?: number;
  145710. tileSize?: number;
  145711. tileWidth?: number;
  145712. tileHeight?: number;
  145713. size?: number;
  145714. width?: number;
  145715. height?: number;
  145716. alignHorizontal?: number;
  145717. alignVertical?: number;
  145718. sideOrientation?: number;
  145719. frontUVs?: Vector4;
  145720. backUVs?: Vector4;
  145721. updatable?: boolean;
  145722. }, scene?: Nullable<Scene>): Mesh;
  145723. /**
  145724. * Creates a plane mesh
  145725. * * The parameter `size` sets the size (float) of both sides of the plane at once (default 1)
  145726. * * You can set some different plane dimensions by using the parameters `width` and `height` (both by default have the same value of `size`)
  145727. * * The parameter `sourcePlane` is a Plane instance. It builds a mesh plane from a Math plane
  145728. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  145729. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  145730. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  145731. * @param name defines the name of the mesh
  145732. * @param options defines the options used to create the mesh
  145733. * @param scene defines the hosting scene
  145734. * @returns the plane mesh
  145735. * @see https://doc.babylonjs.com/how_to/set_shapes#plane
  145736. */
  145737. static CreatePlane(name: string, options: {
  145738. size?: number;
  145739. width?: number;
  145740. height?: number;
  145741. sideOrientation?: number;
  145742. frontUVs?: Vector4;
  145743. backUVs?: Vector4;
  145744. updatable?: boolean;
  145745. sourcePlane?: Plane;
  145746. }, scene?: Nullable<Scene>): Mesh;
  145747. /**
  145748. * Creates a ground mesh
  145749. * * The parameters `width` and `height` (floats, default 1) set the width and height sizes of the ground
  145750. * * The parameter `subdivisions` (positive integer) sets the number of subdivisions per side
  145751. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  145752. * @param name defines the name of the mesh
  145753. * @param options defines the options used to create the mesh
  145754. * @param scene defines the hosting scene
  145755. * @returns the ground mesh
  145756. * @see https://doc.babylonjs.com/how_to/set_shapes#ground
  145757. */
  145758. static CreateGround(name: string, options: {
  145759. width?: number;
  145760. height?: number;
  145761. subdivisions?: number;
  145762. subdivisionsX?: number;
  145763. subdivisionsY?: number;
  145764. updatable?: boolean;
  145765. }, scene?: Nullable<Scene>): Mesh;
  145766. /**
  145767. * Creates a tiled ground mesh
  145768. * * The parameters `xmin` and `xmax` (floats, default -1 and 1) set the ground minimum and maximum X coordinates
  145769. * * The parameters `zmin` and `zmax` (floats, default -1 and 1) set the ground minimum and maximum Z coordinates
  145770. * * 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
  145771. * * 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
  145772. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created.
  145773. * @param name defines the name of the mesh
  145774. * @param options defines the options used to create the mesh
  145775. * @param scene defines the hosting scene
  145776. * @returns the tiled ground mesh
  145777. * @see https://doc.babylonjs.com/how_to/set_shapes#tiled-ground
  145778. */
  145779. static CreateTiledGround(name: string, options: {
  145780. xmin: number;
  145781. zmin: number;
  145782. xmax: number;
  145783. zmax: number;
  145784. subdivisions?: {
  145785. w: number;
  145786. h: number;
  145787. };
  145788. precision?: {
  145789. w: number;
  145790. h: number;
  145791. };
  145792. updatable?: boolean;
  145793. }, scene?: Nullable<Scene>): Mesh;
  145794. /**
  145795. * Creates a ground mesh from a height map
  145796. * * The parameter `url` sets the URL of the height map image resource.
  145797. * * The parameters `width` and `height` (positive floats, default 10) set the ground width and height sizes.
  145798. * * The parameter `subdivisions` (positive integer, default 1) sets the number of subdivision per side.
  145799. * * The parameter `minHeight` (float, default 0) is the minimum altitude on the ground.
  145800. * * The parameter `maxHeight` (float, default 1) is the maximum altitude on the ground.
  145801. * * 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.
  145802. * * 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).
  145803. * * The parameter `alphaFilter` will filter any data where the alpha channel is below this value, defaults 0 (all data visible)
  145804. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created.
  145805. * @param name defines the name of the mesh
  145806. * @param url defines the url to the height map
  145807. * @param options defines the options used to create the mesh
  145808. * @param scene defines the hosting scene
  145809. * @returns the ground mesh
  145810. * @see https://doc.babylonjs.com/babylon101/height_map
  145811. * @see https://doc.babylonjs.com/how_to/set_shapes#ground-from-a-height-map
  145812. */
  145813. static CreateGroundFromHeightMap(name: string, url: string, options: {
  145814. width?: number;
  145815. height?: number;
  145816. subdivisions?: number;
  145817. minHeight?: number;
  145818. maxHeight?: number;
  145819. colorFilter?: Color3;
  145820. alphaFilter?: number;
  145821. updatable?: boolean;
  145822. onReady?: (mesh: GroundMesh) => void;
  145823. }, scene?: Nullable<Scene>): GroundMesh;
  145824. /**
  145825. * Creates a polygon mesh
  145826. * The polygon's shape will depend on the input parameters and is constructed parallel to a ground mesh
  145827. * * 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
  145828. * * You can set the mesh side orientation with the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  145829. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  145830. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4)
  145831. * * Remember you can only change the shape positions, not their number when updating a polygon
  145832. * @param name defines the name of the mesh
  145833. * @param options defines the options used to create the mesh
  145834. * @param scene defines the hosting scene
  145835. * @param earcutInjection can be used to inject your own earcut reference
  145836. * @returns the polygon mesh
  145837. */
  145838. static CreatePolygon(name: string, options: {
  145839. shape: Vector3[];
  145840. holes?: Vector3[][];
  145841. depth?: number;
  145842. faceUV?: Vector4[];
  145843. faceColors?: Color4[];
  145844. updatable?: boolean;
  145845. sideOrientation?: number;
  145846. frontUVs?: Vector4;
  145847. backUVs?: Vector4;
  145848. }, scene?: Nullable<Scene>, earcutInjection?: any): Mesh;
  145849. /**
  145850. * Creates an extruded polygon mesh, with depth in the Y direction.
  145851. * * 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)
  145852. * @see https://doc.babylonjs.com/how_to/createbox_per_face_textures_and_colors
  145853. * @param name defines the name of the mesh
  145854. * @param options defines the options used to create the mesh
  145855. * @param scene defines the hosting scene
  145856. * @param earcutInjection can be used to inject your own earcut reference
  145857. * @returns the polygon mesh
  145858. */
  145859. static ExtrudePolygon(name: string, options: {
  145860. shape: Vector3[];
  145861. holes?: Vector3[][];
  145862. depth?: number;
  145863. faceUV?: Vector4[];
  145864. faceColors?: Color4[];
  145865. updatable?: boolean;
  145866. sideOrientation?: number;
  145867. frontUVs?: Vector4;
  145868. backUVs?: Vector4;
  145869. }, scene?: Nullable<Scene>, earcutInjection?: any): Mesh;
  145870. /**
  145871. * Creates a tube mesh.
  145872. * The tube is a parametric shape. It has no predefined shape. Its final shape will depend on the input parameters
  145873. * * The parameter `path` is a required array of successive Vector3. It is the curve used as the axis of the tube
  145874. * * The parameter `radius` (positive float, default 1) sets the tube radius size
  145875. * * The parameter `tessellation` (positive float, default 64) is the number of sides on the tubular surface
  145876. * * The parameter `radiusFunction` (javascript function, default null) is a vanilla javascript function. If it is not null, it overwrittes the parameter `radius`
  145877. * * 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)
  145878. * * The parameter `arc` (positive float, maximum 1, default 1) is the ratio to apply to the tube circumference : 2 x PI x arc
  145879. * * 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
  145880. * * 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
  145881. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  145882. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  145883. * * The optional parameter `invertUV` (boolean, default false) swaps in the geometry the U and V coordinates to apply a texture
  145884. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  145885. * @param name defines the name of the mesh
  145886. * @param options defines the options used to create the mesh
  145887. * @param scene defines the hosting scene
  145888. * @returns the tube mesh
  145889. * @see https://doc.babylonjs.com/how_to/parametric_shapes
  145890. * @see https://doc.babylonjs.com/how_to/set_shapes#tube
  145891. */
  145892. static CreateTube(name: string, options: {
  145893. path: Vector3[];
  145894. radius?: number;
  145895. tessellation?: number;
  145896. radiusFunction?: {
  145897. (i: number, distance: number): number;
  145898. };
  145899. cap?: number;
  145900. arc?: number;
  145901. updatable?: boolean;
  145902. sideOrientation?: number;
  145903. frontUVs?: Vector4;
  145904. backUVs?: Vector4;
  145905. instance?: Mesh;
  145906. invertUV?: boolean;
  145907. }, scene?: Nullable<Scene>): Mesh;
  145908. /**
  145909. * Creates a polyhedron mesh
  145910. * * 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
  145911. * * The parameter `size` (positive float, default 1) sets the polygon size
  145912. * * You can overwrite the `size` on each dimension bu using the parameters `sizeX`, `sizeY` or `sizeZ` (positive floats, default to `size` value)
  145913. * * 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`
  145914. * * 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
  145915. * * 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)`)
  145916. * * 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
  145917. * * 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
  145918. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  145919. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  145920. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  145921. * @param name defines the name of the mesh
  145922. * @param options defines the options used to create the mesh
  145923. * @param scene defines the hosting scene
  145924. * @returns the polyhedron mesh
  145925. * @see https://doc.babylonjs.com/how_to/polyhedra_shapes
  145926. */
  145927. static CreatePolyhedron(name: string, options: {
  145928. type?: number;
  145929. size?: number;
  145930. sizeX?: number;
  145931. sizeY?: number;
  145932. sizeZ?: number;
  145933. custom?: any;
  145934. faceUV?: Vector4[];
  145935. faceColors?: Color4[];
  145936. flat?: boolean;
  145937. updatable?: boolean;
  145938. sideOrientation?: number;
  145939. frontUVs?: Vector4;
  145940. backUVs?: Vector4;
  145941. }, scene?: Nullable<Scene>): Mesh;
  145942. /**
  145943. * Creates a decal mesh.
  145944. * 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
  145945. * * The parameter `position` (Vector3, default `(0, 0, 0)`) sets the position of the decal in World coordinates
  145946. * * The parameter `normal` (Vector3, default `Vector3.Up`) sets the normal of the mesh where the decal is applied onto in World coordinates
  145947. * * The parameter `size` (Vector3, default `(1, 1, 1)`) sets the decal scaling
  145948. * * The parameter `angle` (float in radian, default 0) sets the angle to rotate the decal
  145949. * @param name defines the name of the mesh
  145950. * @param sourceMesh defines the mesh where the decal must be applied
  145951. * @param options defines the options used to create the mesh
  145952. * @param scene defines the hosting scene
  145953. * @returns the decal mesh
  145954. * @see https://doc.babylonjs.com/how_to/decals
  145955. */
  145956. static CreateDecal(name: string, sourceMesh: AbstractMesh, options: {
  145957. position?: Vector3;
  145958. normal?: Vector3;
  145959. size?: Vector3;
  145960. angle?: number;
  145961. }): Mesh;
  145962. }
  145963. }
  145964. declare module BABYLON {
  145965. /**
  145966. * A simplifier interface for future simplification implementations
  145967. * @see https://doc.babylonjs.com/how_to/in-browser_mesh_simplification
  145968. */
  145969. export interface ISimplifier {
  145970. /**
  145971. * Simplification of a given mesh according to the given settings.
  145972. * Since this requires computation, it is assumed that the function runs async.
  145973. * @param settings The settings of the simplification, including quality and distance
  145974. * @param successCallback A callback that will be called after the mesh was simplified.
  145975. * @param errorCallback in case of an error, this callback will be called. optional.
  145976. */
  145977. simplify(settings: ISimplificationSettings, successCallback: (simplifiedMeshes: Mesh) => void, errorCallback?: () => void): void;
  145978. }
  145979. /**
  145980. * Expected simplification settings.
  145981. * Quality should be between 0 and 1 (1 being 100%, 0 being 0%)
  145982. * @see https://doc.babylonjs.com/how_to/in-browser_mesh_simplification
  145983. */
  145984. export interface ISimplificationSettings {
  145985. /**
  145986. * Gets or sets the expected quality
  145987. */
  145988. quality: number;
  145989. /**
  145990. * Gets or sets the distance when this optimized version should be used
  145991. */
  145992. distance: number;
  145993. /**
  145994. * Gets an already optimized mesh
  145995. */
  145996. optimizeMesh?: boolean;
  145997. }
  145998. /**
  145999. * Class used to specify simplification options
  146000. * @see https://doc.babylonjs.com/how_to/in-browser_mesh_simplification
  146001. */
  146002. export class SimplificationSettings implements ISimplificationSettings {
  146003. /** expected quality */
  146004. quality: number;
  146005. /** distance when this optimized version should be used */
  146006. distance: number;
  146007. /** already optimized mesh */
  146008. optimizeMesh?: boolean | undefined;
  146009. /**
  146010. * Creates a SimplificationSettings
  146011. * @param quality expected quality
  146012. * @param distance distance when this optimized version should be used
  146013. * @param optimizeMesh already optimized mesh
  146014. */
  146015. constructor(
  146016. /** expected quality */
  146017. quality: number,
  146018. /** distance when this optimized version should be used */
  146019. distance: number,
  146020. /** already optimized mesh */
  146021. optimizeMesh?: boolean | undefined);
  146022. }
  146023. /**
  146024. * Interface used to define a simplification task
  146025. */
  146026. export interface ISimplificationTask {
  146027. /**
  146028. * Array of settings
  146029. */
  146030. settings: Array<ISimplificationSettings>;
  146031. /**
  146032. * Simplification type
  146033. */
  146034. simplificationType: SimplificationType;
  146035. /**
  146036. * Mesh to simplify
  146037. */
  146038. mesh: Mesh;
  146039. /**
  146040. * Callback called on success
  146041. */
  146042. successCallback?: () => void;
  146043. /**
  146044. * Defines if parallel processing can be used
  146045. */
  146046. parallelProcessing: boolean;
  146047. }
  146048. /**
  146049. * Queue used to order the simplification tasks
  146050. * @see https://doc.babylonjs.com/how_to/in-browser_mesh_simplification
  146051. */
  146052. export class SimplificationQueue {
  146053. private _simplificationArray;
  146054. /**
  146055. * Gets a boolean indicating that the process is still running
  146056. */
  146057. running: boolean;
  146058. /**
  146059. * Creates a new queue
  146060. */
  146061. constructor();
  146062. /**
  146063. * Adds a new simplification task
  146064. * @param task defines a task to add
  146065. */
  146066. addTask(task: ISimplificationTask): void;
  146067. /**
  146068. * Execute next task
  146069. */
  146070. executeNext(): void;
  146071. /**
  146072. * Execute a simplification task
  146073. * @param task defines the task to run
  146074. */
  146075. runSimplification(task: ISimplificationTask): void;
  146076. private getSimplifier;
  146077. }
  146078. /**
  146079. * The implemented types of simplification
  146080. * At the moment only Quadratic Error Decimation is implemented
  146081. * @see https://doc.babylonjs.com/how_to/in-browser_mesh_simplification
  146082. */
  146083. export enum SimplificationType {
  146084. /** Quadratic error decimation */
  146085. QUADRATIC = 0
  146086. }
  146087. /**
  146088. * An implementation of the Quadratic Error simplification algorithm.
  146089. * Original paper : http://www1.cs.columbia.edu/~cs4162/html05s/garland97.pdf
  146090. * Ported mostly from QSlim and http://voxels.blogspot.de/2014/05/quadric-mesh-simplification-with-source.html to babylon JS
  146091. * @author RaananW
  146092. * @see https://doc.babylonjs.com/how_to/in-browser_mesh_simplification
  146093. */
  146094. export class QuadraticErrorSimplification implements ISimplifier {
  146095. private _mesh;
  146096. private triangles;
  146097. private vertices;
  146098. private references;
  146099. private _reconstructedMesh;
  146100. /** Gets or sets the number pf sync interations */
  146101. syncIterations: number;
  146102. /** Gets or sets the aggressiveness of the simplifier */
  146103. aggressiveness: number;
  146104. /** Gets or sets the number of allowed iterations for decimation */
  146105. decimationIterations: number;
  146106. /** Gets or sets the espilon to use for bounding box computation */
  146107. boundingBoxEpsilon: number;
  146108. /**
  146109. * Creates a new QuadraticErrorSimplification
  146110. * @param _mesh defines the target mesh
  146111. */
  146112. constructor(_mesh: Mesh);
  146113. /**
  146114. * Simplification of a given mesh according to the given settings.
  146115. * Since this requires computation, it is assumed that the function runs async.
  146116. * @param settings The settings of the simplification, including quality and distance
  146117. * @param successCallback A callback that will be called after the mesh was simplified.
  146118. */
  146119. simplify(settings: ISimplificationSettings, successCallback: (simplifiedMesh: Mesh) => void): void;
  146120. private runDecimation;
  146121. private initWithMesh;
  146122. private init;
  146123. private reconstructMesh;
  146124. private initDecimatedMesh;
  146125. private isFlipped;
  146126. private updateTriangles;
  146127. private identifyBorder;
  146128. private updateMesh;
  146129. private vertexError;
  146130. private calculateError;
  146131. }
  146132. }
  146133. declare module BABYLON {
  146134. interface Scene {
  146135. /** @hidden (Backing field) */
  146136. _simplificationQueue: SimplificationQueue;
  146137. /**
  146138. * Gets or sets the simplification queue attached to the scene
  146139. * @see https://doc.babylonjs.com/how_to/in-browser_mesh_simplification
  146140. */
  146141. simplificationQueue: SimplificationQueue;
  146142. }
  146143. interface Mesh {
  146144. /**
  146145. * Simplify the mesh according to the given array of settings.
  146146. * Function will return immediately and will simplify async
  146147. * @param settings a collection of simplification settings
  146148. * @param parallelProcessing should all levels calculate parallel or one after the other
  146149. * @param simplificationType the type of simplification to run
  146150. * @param successCallback optional success callback to be called after the simplification finished processing all settings
  146151. * @returns the current mesh
  146152. */
  146153. simplify(settings: Array<ISimplificationSettings>, parallelProcessing?: boolean, simplificationType?: SimplificationType, successCallback?: (mesh?: Mesh, submeshIndex?: number) => void): Mesh;
  146154. }
  146155. /**
  146156. * Defines the simplification queue scene component responsible to help scheduling the various simplification task
  146157. * created in a scene
  146158. */
  146159. export class SimplicationQueueSceneComponent implements ISceneComponent {
  146160. /**
  146161. * The component name helpfull to identify the component in the list of scene components.
  146162. */
  146163. readonly name: string;
  146164. /**
  146165. * The scene the component belongs to.
  146166. */
  146167. scene: Scene;
  146168. /**
  146169. * Creates a new instance of the component for the given scene
  146170. * @param scene Defines the scene to register the component in
  146171. */
  146172. constructor(scene: Scene);
  146173. /**
  146174. * Registers the component in a given scene
  146175. */
  146176. register(): void;
  146177. /**
  146178. * Rebuilds the elements related to this component in case of
  146179. * context lost for instance.
  146180. */
  146181. rebuild(): void;
  146182. /**
  146183. * Disposes the component and the associated ressources
  146184. */
  146185. dispose(): void;
  146186. private _beforeCameraUpdate;
  146187. }
  146188. }
  146189. declare module BABYLON {
  146190. interface Mesh {
  146191. /**
  146192. * Gets or sets a boolean defining if we want picking to pick thin instances as well
  146193. */
  146194. thinInstanceEnablePicking: boolean;
  146195. /**
  146196. * Creates a new thin instance
  146197. * @param matrix the matrix or array of matrices (position, rotation, scale) of the thin instance(s) to create
  146198. * @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
  146199. * @returns the thin instance index number. If you pass an array of matrices, other instance indexes are index+1, index+2, etc
  146200. */
  146201. thinInstanceAdd(matrix: DeepImmutableObject<Matrix> | Array<DeepImmutableObject<Matrix>>, refresh: boolean): number;
  146202. /**
  146203. * Adds the transformation (matrix) of the current mesh as a thin instance
  146204. * @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
  146205. * @returns the thin instance index number
  146206. */
  146207. thinInstanceAddSelf(refresh: boolean): number;
  146208. /**
  146209. * Registers a custom attribute to be used with thin instances
  146210. * @param kind name of the attribute
  146211. * @param stride size in floats of the attribute
  146212. */
  146213. thinInstanceRegisterAttribute(kind: string, stride: number): void;
  146214. /**
  146215. * Sets the matrix of a thin instance
  146216. * @param index index of the thin instance
  146217. * @param matrix matrix to set
  146218. * @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
  146219. */
  146220. thinInstanceSetMatrixAt(index: number, matrix: DeepImmutableObject<Matrix>, refresh: boolean): void;
  146221. /**
  146222. * Sets the value of a custom attribute for a thin instance
  146223. * @param kind name of the attribute
  146224. * @param index index of the thin instance
  146225. * @param value value to set
  146226. * @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
  146227. */
  146228. thinInstanceSetAttributeAt(kind: string, index: number, value: Array<number>, refresh: boolean): void;
  146229. /**
  146230. * 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.
  146231. */
  146232. thinInstanceCount: number;
  146233. /**
  146234. * Sets a buffer to be used with thin instances. This method is a faster way to setup multiple instances than calling thinInstanceAdd repeatedly
  146235. * @param kind name of the attribute. Use "matrix" to setup the buffer of matrices
  146236. * @param buffer buffer to set
  146237. * @param stride size in floats of each value of the buffer
  146238. * @param staticBuffer indicates that the buffer is static, so that you won't change it after it is set (better performances - false by default)
  146239. */
  146240. thinInstanceSetBuffer(kind: string, buffer: Nullable<Float32Array>, stride: number, staticBuffer: boolean): void;
  146241. /**
  146242. * Gets the list of world matrices
  146243. * @return an array containing all the world matrices from the thin instances
  146244. */
  146245. thinInstanceGetWorldMatrices(): Matrix[];
  146246. /**
  146247. * Synchronize the gpu buffers with a thin instance buffer. Call this method if you update later on the buffers passed to thinInstanceSetBuffer
  146248. * @param kind name of the attribute to update. Use "matrix" to update the buffer of matrices
  146249. */
  146250. thinInstanceBufferUpdated(kind: string): void;
  146251. /**
  146252. * Refreshes the bounding info, taking into account all the thin instances defined
  146253. * @param forceRefreshParentInfo true to force recomputing the mesh bounding info and use it to compute the aggregated bounding info
  146254. */
  146255. thinInstanceRefreshBoundingInfo(forceRefreshParentInfo: boolean): void;
  146256. /** @hidden */
  146257. _thinInstanceInitializeUserStorage(): void;
  146258. /** @hidden */
  146259. _thinInstanceUpdateBufferSize(kind: string, numInstances: number): void;
  146260. /** @hidden */
  146261. _userThinInstanceBuffersStorage: {
  146262. data: {
  146263. [key: string]: Float32Array;
  146264. };
  146265. sizes: {
  146266. [key: string]: number;
  146267. };
  146268. vertexBuffers: {
  146269. [key: string]: Nullable<VertexBuffer>;
  146270. };
  146271. strides: {
  146272. [key: string]: number;
  146273. };
  146274. };
  146275. }
  146276. }
  146277. declare module BABYLON {
  146278. /**
  146279. * Navigation plugin interface to add navigation constrained by a navigation mesh
  146280. */
  146281. export interface INavigationEnginePlugin {
  146282. /**
  146283. * plugin name
  146284. */
  146285. name: string;
  146286. /**
  146287. * Creates a navigation mesh
  146288. * @param meshes array of all the geometry used to compute the navigatio mesh
  146289. * @param parameters bunch of parameters used to filter geometry
  146290. */
  146291. createNavMesh(meshes: Array<Mesh>, parameters: INavMeshParameters): void;
  146292. /**
  146293. * Create a navigation mesh debug mesh
  146294. * @param scene is where the mesh will be added
  146295. * @returns debug display mesh
  146296. */
  146297. createDebugNavMesh(scene: Scene): Mesh;
  146298. /**
  146299. * Get a navigation mesh constrained position, closest to the parameter position
  146300. * @param position world position
  146301. * @returns the closest point to position constrained by the navigation mesh
  146302. */
  146303. getClosestPoint(position: Vector3): Vector3;
  146304. /**
  146305. * Get a navigation mesh constrained position, closest to the parameter position
  146306. * @param position world position
  146307. * @param result output the closest point to position constrained by the navigation mesh
  146308. */
  146309. getClosestPointToRef(position: Vector3, result: Vector3): void;
  146310. /**
  146311. * Get a navigation mesh constrained position, within a particular radius
  146312. * @param position world position
  146313. * @param maxRadius the maximum distance to the constrained world position
  146314. * @returns the closest point to position constrained by the navigation mesh
  146315. */
  146316. getRandomPointAround(position: Vector3, maxRadius: number): Vector3;
  146317. /**
  146318. * Get a navigation mesh constrained position, within a particular radius
  146319. * @param position world position
  146320. * @param maxRadius the maximum distance to the constrained world position
  146321. * @param result output the closest point to position constrained by the navigation mesh
  146322. */
  146323. getRandomPointAroundToRef(position: Vector3, maxRadius: number, result: Vector3): void;
  146324. /**
  146325. * Compute the final position from a segment made of destination-position
  146326. * @param position world position
  146327. * @param destination world position
  146328. * @returns the resulting point along the navmesh
  146329. */
  146330. moveAlong(position: Vector3, destination: Vector3): Vector3;
  146331. /**
  146332. * Compute the final position from a segment made of destination-position
  146333. * @param position world position
  146334. * @param destination world position
  146335. * @param result output the resulting point along the navmesh
  146336. */
  146337. moveAlongToRef(position: Vector3, destination: Vector3, result: Vector3): void;
  146338. /**
  146339. * Compute a navigation path from start to end. Returns an empty array if no path can be computed
  146340. * @param start world position
  146341. * @param end world position
  146342. * @returns array containing world position composing the path
  146343. */
  146344. computePath(start: Vector3, end: Vector3): Vector3[];
  146345. /**
  146346. * If this plugin is supported
  146347. * @returns true if plugin is supported
  146348. */
  146349. isSupported(): boolean;
  146350. /**
  146351. * Create a new Crowd so you can add agents
  146352. * @param maxAgents the maximum agent count in the crowd
  146353. * @param maxAgentRadius the maximum radius an agent can have
  146354. * @param scene to attach the crowd to
  146355. * @returns the crowd you can add agents to
  146356. */
  146357. createCrowd(maxAgents: number, maxAgentRadius: number, scene: Scene): ICrowd;
  146358. /**
  146359. * Set the Bounding box extent for doing spatial queries (getClosestPoint, getRandomPointAround, ...)
  146360. * The queries will try to find a solution within those bounds
  146361. * default is (1,1,1)
  146362. * @param extent x,y,z value that define the extent around the queries point of reference
  146363. */
  146364. setDefaultQueryExtent(extent: Vector3): void;
  146365. /**
  146366. * Get the Bounding box extent specified by setDefaultQueryExtent
  146367. * @returns the box extent values
  146368. */
  146369. getDefaultQueryExtent(): Vector3;
  146370. /**
  146371. * build the navmesh from a previously saved state using getNavmeshData
  146372. * @param data the Uint8Array returned by getNavmeshData
  146373. */
  146374. buildFromNavmeshData(data: Uint8Array): void;
  146375. /**
  146376. * returns the navmesh data that can be used later. The navmesh must be built before retrieving the data
  146377. * @returns data the Uint8Array that can be saved and reused
  146378. */
  146379. getNavmeshData(): Uint8Array;
  146380. /**
  146381. * Get the Bounding box extent result specified by setDefaultQueryExtent
  146382. * @param result output the box extent values
  146383. */
  146384. getDefaultQueryExtentToRef(result: Vector3): void;
  146385. /**
  146386. * Release all resources
  146387. */
  146388. dispose(): void;
  146389. }
  146390. /**
  146391. * Crowd Interface. A Crowd is a collection of moving agents constrained by a navigation mesh
  146392. */
  146393. export interface ICrowd {
  146394. /**
  146395. * Add a new agent to the crowd with the specified parameter a corresponding transformNode.
  146396. * You can attach anything to that node. The node position is updated in the scene update tick.
  146397. * @param pos world position that will be constrained by the navigation mesh
  146398. * @param parameters agent parameters
  146399. * @param transform hooked to the agent that will be update by the scene
  146400. * @returns agent index
  146401. */
  146402. addAgent(pos: Vector3, parameters: IAgentParameters, transform: TransformNode): number;
  146403. /**
  146404. * Returns the agent position in world space
  146405. * @param index agent index returned by addAgent
  146406. * @returns world space position
  146407. */
  146408. getAgentPosition(index: number): Vector3;
  146409. /**
  146410. * Gets the agent position result in world space
  146411. * @param index agent index returned by addAgent
  146412. * @param result output world space position
  146413. */
  146414. getAgentPositionToRef(index: number, result: Vector3): void;
  146415. /**
  146416. * Gets the agent velocity in world space
  146417. * @param index agent index returned by addAgent
  146418. * @returns world space velocity
  146419. */
  146420. getAgentVelocity(index: number): Vector3;
  146421. /**
  146422. * Gets the agent velocity result in world space
  146423. * @param index agent index returned by addAgent
  146424. * @param result output world space velocity
  146425. */
  146426. getAgentVelocityToRef(index: number, result: Vector3): void;
  146427. /**
  146428. * remove a particular agent previously created
  146429. * @param index agent index returned by addAgent
  146430. */
  146431. removeAgent(index: number): void;
  146432. /**
  146433. * get the list of all agents attached to this crowd
  146434. * @returns list of agent indices
  146435. */
  146436. getAgents(): number[];
  146437. /**
  146438. * Tick update done by the Scene. Agent position/velocity/acceleration is updated by this function
  146439. * @param deltaTime in seconds
  146440. */
  146441. update(deltaTime: number): void;
  146442. /**
  146443. * Asks a particular agent to go to a destination. That destination is constrained by the navigation mesh
  146444. * @param index agent index returned by addAgent
  146445. * @param destination targeted world position
  146446. */
  146447. agentGoto(index: number, destination: Vector3): void;
  146448. /**
  146449. * Teleport the agent to a new position
  146450. * @param index agent index returned by addAgent
  146451. * @param destination targeted world position
  146452. */
  146453. agentTeleport(index: number, destination: Vector3): void;
  146454. /**
  146455. * Update agent parameters
  146456. * @param index agent index returned by addAgent
  146457. * @param parameters agent parameters
  146458. */
  146459. updateAgentParameters(index: number, parameters: IAgentParameters): void;
  146460. /**
  146461. * Set the Bounding box extent for doing spatial queries (getClosestPoint, getRandomPointAround, ...)
  146462. * The queries will try to find a solution within those bounds
  146463. * default is (1,1,1)
  146464. * @param extent x,y,z value that define the extent around the queries point of reference
  146465. */
  146466. setDefaultQueryExtent(extent: Vector3): void;
  146467. /**
  146468. * Get the Bounding box extent specified by setDefaultQueryExtent
  146469. * @returns the box extent values
  146470. */
  146471. getDefaultQueryExtent(): Vector3;
  146472. /**
  146473. * Get the Bounding box extent result specified by setDefaultQueryExtent
  146474. * @param result output the box extent values
  146475. */
  146476. getDefaultQueryExtentToRef(result: Vector3): void;
  146477. /**
  146478. * Release all resources
  146479. */
  146480. dispose(): void;
  146481. }
  146482. /**
  146483. * Configures an agent
  146484. */
  146485. export interface IAgentParameters {
  146486. /**
  146487. * Agent radius. [Limit: >= 0]
  146488. */
  146489. radius: number;
  146490. /**
  146491. * Agent height. [Limit: > 0]
  146492. */
  146493. height: number;
  146494. /**
  146495. * Maximum allowed acceleration. [Limit: >= 0]
  146496. */
  146497. maxAcceleration: number;
  146498. /**
  146499. * Maximum allowed speed. [Limit: >= 0]
  146500. */
  146501. maxSpeed: number;
  146502. /**
  146503. * Defines how close a collision element must be before it is considered for steering behaviors. [Limits: > 0]
  146504. */
  146505. collisionQueryRange: number;
  146506. /**
  146507. * The path visibility optimization range. [Limit: > 0]
  146508. */
  146509. pathOptimizationRange: number;
  146510. /**
  146511. * How aggresive the agent manager should be at avoiding collisions with this agent. [Limit: >= 0]
  146512. */
  146513. separationWeight: number;
  146514. }
  146515. /**
  146516. * Configures the navigation mesh creation
  146517. */
  146518. export interface INavMeshParameters {
  146519. /**
  146520. * The xz-plane cell size to use for fields. [Limit: > 0] [Units: wu]
  146521. */
  146522. cs: number;
  146523. /**
  146524. * The y-axis cell size to use for fields. [Limit: > 0] [Units: wu]
  146525. */
  146526. ch: number;
  146527. /**
  146528. * The maximum slope that is considered walkable. [Limits: 0 <= value < 90] [Units: Degrees]
  146529. */
  146530. walkableSlopeAngle: number;
  146531. /**
  146532. * Minimum floor to 'ceiling' height that will still allow the floor area to
  146533. * be considered walkable. [Limit: >= 3] [Units: vx]
  146534. */
  146535. walkableHeight: number;
  146536. /**
  146537. * Maximum ledge height that is considered to still be traversable. [Limit: >=0] [Units: vx]
  146538. */
  146539. walkableClimb: number;
  146540. /**
  146541. * The distance to erode/shrink the walkable area of the heightfield away from
  146542. * obstructions. [Limit: >=0] [Units: vx]
  146543. */
  146544. walkableRadius: number;
  146545. /**
  146546. * The maximum allowed length for contour edges along the border of the mesh. [Limit: >=0] [Units: vx]
  146547. */
  146548. maxEdgeLen: number;
  146549. /**
  146550. * The maximum distance a simplfied contour's border edges should deviate
  146551. * the original raw contour. [Limit: >=0] [Units: vx]
  146552. */
  146553. maxSimplificationError: number;
  146554. /**
  146555. * The minimum number of cells allowed to form isolated island areas. [Limit: >=0] [Units: vx]
  146556. */
  146557. minRegionArea: number;
  146558. /**
  146559. * Any regions with a span count smaller than this value will, if possible,
  146560. * be merged with larger regions. [Limit: >=0] [Units: vx]
  146561. */
  146562. mergeRegionArea: number;
  146563. /**
  146564. * The maximum number of vertices allowed for polygons generated during the
  146565. * contour to polygon conversion process. [Limit: >= 3]
  146566. */
  146567. maxVertsPerPoly: number;
  146568. /**
  146569. * Sets the sampling distance to use when generating the detail mesh.
  146570. * (For height detail only.) [Limits: 0 or >= 0.9] [Units: wu]
  146571. */
  146572. detailSampleDist: number;
  146573. /**
  146574. * The maximum distance the detail mesh surface should deviate from heightfield
  146575. * data. (For height detail only.) [Limit: >=0] [Units: wu]
  146576. */
  146577. detailSampleMaxError: number;
  146578. }
  146579. }
  146580. declare module BABYLON {
  146581. /**
  146582. * RecastJS navigation plugin
  146583. */
  146584. export class RecastJSPlugin implements INavigationEnginePlugin {
  146585. /**
  146586. * Reference to the Recast library
  146587. */
  146588. bjsRECAST: any;
  146589. /**
  146590. * plugin name
  146591. */
  146592. name: string;
  146593. /**
  146594. * the first navmesh created. We might extend this to support multiple navmeshes
  146595. */
  146596. navMesh: any;
  146597. /**
  146598. * Initializes the recastJS plugin
  146599. * @param recastInjection can be used to inject your own recast reference
  146600. */
  146601. constructor(recastInjection?: any);
  146602. /**
  146603. * Creates a navigation mesh
  146604. * @param meshes array of all the geometry used to compute the navigatio mesh
  146605. * @param parameters bunch of parameters used to filter geometry
  146606. */
  146607. createNavMesh(meshes: Array<Mesh>, parameters: INavMeshParameters): void;
  146608. /**
  146609. * Create a navigation mesh debug mesh
  146610. * @param scene is where the mesh will be added
  146611. * @returns debug display mesh
  146612. */
  146613. createDebugNavMesh(scene: Scene): Mesh;
  146614. /**
  146615. * Get a navigation mesh constrained position, closest to the parameter position
  146616. * @param position world position
  146617. * @returns the closest point to position constrained by the navigation mesh
  146618. */
  146619. getClosestPoint(position: Vector3): Vector3;
  146620. /**
  146621. * Get a navigation mesh constrained position, closest to the parameter position
  146622. * @param position world position
  146623. * @param result output the closest point to position constrained by the navigation mesh
  146624. */
  146625. getClosestPointToRef(position: Vector3, result: Vector3): void;
  146626. /**
  146627. * Get a navigation mesh constrained position, within a particular radius
  146628. * @param position world position
  146629. * @param maxRadius the maximum distance to the constrained world position
  146630. * @returns the closest point to position constrained by the navigation mesh
  146631. */
  146632. getRandomPointAround(position: Vector3, maxRadius: number): Vector3;
  146633. /**
  146634. * Get a navigation mesh constrained position, within a particular radius
  146635. * @param position world position
  146636. * @param maxRadius the maximum distance to the constrained world position
  146637. * @param result output the closest point to position constrained by the navigation mesh
  146638. */
  146639. getRandomPointAroundToRef(position: Vector3, maxRadius: number, result: Vector3): void;
  146640. /**
  146641. * Compute the final position from a segment made of destination-position
  146642. * @param position world position
  146643. * @param destination world position
  146644. * @returns the resulting point along the navmesh
  146645. */
  146646. moveAlong(position: Vector3, destination: Vector3): Vector3;
  146647. /**
  146648. * Compute the final position from a segment made of destination-position
  146649. * @param position world position
  146650. * @param destination world position
  146651. * @param result output the resulting point along the navmesh
  146652. */
  146653. moveAlongToRef(position: Vector3, destination: Vector3, result: Vector3): void;
  146654. /**
  146655. * Compute a navigation path from start to end. Returns an empty array if no path can be computed
  146656. * @param start world position
  146657. * @param end world position
  146658. * @returns array containing world position composing the path
  146659. */
  146660. computePath(start: Vector3, end: Vector3): Vector3[];
  146661. /**
  146662. * Create a new Crowd so you can add agents
  146663. * @param maxAgents the maximum agent count in the crowd
  146664. * @param maxAgentRadius the maximum radius an agent can have
  146665. * @param scene to attach the crowd to
  146666. * @returns the crowd you can add agents to
  146667. */
  146668. createCrowd(maxAgents: number, maxAgentRadius: number, scene: Scene): ICrowd;
  146669. /**
  146670. * Set the Bounding box extent for doing spatial queries (getClosestPoint, getRandomPointAround, ...)
  146671. * The queries will try to find a solution within those bounds
  146672. * default is (1,1,1)
  146673. * @param extent x,y,z value that define the extent around the queries point of reference
  146674. */
  146675. setDefaultQueryExtent(extent: Vector3): void;
  146676. /**
  146677. * Get the Bounding box extent specified by setDefaultQueryExtent
  146678. * @returns the box extent values
  146679. */
  146680. getDefaultQueryExtent(): Vector3;
  146681. /**
  146682. * build the navmesh from a previously saved state using getNavmeshData
  146683. * @param data the Uint8Array returned by getNavmeshData
  146684. */
  146685. buildFromNavmeshData(data: Uint8Array): void;
  146686. /**
  146687. * returns the navmesh data that can be used later. The navmesh must be built before retrieving the data
  146688. * @returns data the Uint8Array that can be saved and reused
  146689. */
  146690. getNavmeshData(): Uint8Array;
  146691. /**
  146692. * Get the Bounding box extent result specified by setDefaultQueryExtent
  146693. * @param result output the box extent values
  146694. */
  146695. getDefaultQueryExtentToRef(result: Vector3): void;
  146696. /**
  146697. * Disposes
  146698. */
  146699. dispose(): void;
  146700. /**
  146701. * If this plugin is supported
  146702. * @returns true if plugin is supported
  146703. */
  146704. isSupported(): boolean;
  146705. }
  146706. /**
  146707. * Recast detour crowd implementation
  146708. */
  146709. export class RecastJSCrowd implements ICrowd {
  146710. /**
  146711. * Recast/detour plugin
  146712. */
  146713. bjsRECASTPlugin: RecastJSPlugin;
  146714. /**
  146715. * Link to the detour crowd
  146716. */
  146717. recastCrowd: any;
  146718. /**
  146719. * One transform per agent
  146720. */
  146721. transforms: TransformNode[];
  146722. /**
  146723. * All agents created
  146724. */
  146725. agents: number[];
  146726. /**
  146727. * Link to the scene is kept to unregister the crowd from the scene
  146728. */
  146729. private _scene;
  146730. /**
  146731. * Observer for crowd updates
  146732. */
  146733. private _onBeforeAnimationsObserver;
  146734. /**
  146735. * Constructor
  146736. * @param plugin recastJS plugin
  146737. * @param maxAgents the maximum agent count in the crowd
  146738. * @param maxAgentRadius the maximum radius an agent can have
  146739. * @param scene to attach the crowd to
  146740. * @returns the crowd you can add agents to
  146741. */
  146742. constructor(plugin: RecastJSPlugin, maxAgents: number, maxAgentRadius: number, scene: Scene);
  146743. /**
  146744. * Add a new agent to the crowd with the specified parameter a corresponding transformNode.
  146745. * You can attach anything to that node. The node position is updated in the scene update tick.
  146746. * @param pos world position that will be constrained by the navigation mesh
  146747. * @param parameters agent parameters
  146748. * @param transform hooked to the agent that will be update by the scene
  146749. * @returns agent index
  146750. */
  146751. addAgent(pos: Vector3, parameters: IAgentParameters, transform: TransformNode): number;
  146752. /**
  146753. * Returns the agent position in world space
  146754. * @param index agent index returned by addAgent
  146755. * @returns world space position
  146756. */
  146757. getAgentPosition(index: number): Vector3;
  146758. /**
  146759. * Returns the agent position result in world space
  146760. * @param index agent index returned by addAgent
  146761. * @param result output world space position
  146762. */
  146763. getAgentPositionToRef(index: number, result: Vector3): void;
  146764. /**
  146765. * Returns the agent velocity in world space
  146766. * @param index agent index returned by addAgent
  146767. * @returns world space velocity
  146768. */
  146769. getAgentVelocity(index: number): Vector3;
  146770. /**
  146771. * Returns the agent velocity result in world space
  146772. * @param index agent index returned by addAgent
  146773. * @param result output world space velocity
  146774. */
  146775. getAgentVelocityToRef(index: number, result: Vector3): void;
  146776. /**
  146777. * Asks a particular agent to go to a destination. That destination is constrained by the navigation mesh
  146778. * @param index agent index returned by addAgent
  146779. * @param destination targeted world position
  146780. */
  146781. agentGoto(index: number, destination: Vector3): void;
  146782. /**
  146783. * Teleport the agent to a new position
  146784. * @param index agent index returned by addAgent
  146785. * @param destination targeted world position
  146786. */
  146787. agentTeleport(index: number, destination: Vector3): void;
  146788. /**
  146789. * Update agent parameters
  146790. * @param index agent index returned by addAgent
  146791. * @param parameters agent parameters
  146792. */
  146793. updateAgentParameters(index: number, parameters: IAgentParameters): void;
  146794. /**
  146795. * remove a particular agent previously created
  146796. * @param index agent index returned by addAgent
  146797. */
  146798. removeAgent(index: number): void;
  146799. /**
  146800. * get the list of all agents attached to this crowd
  146801. * @returns list of agent indices
  146802. */
  146803. getAgents(): number[];
  146804. /**
  146805. * Tick update done by the Scene. Agent position/velocity/acceleration is updated by this function
  146806. * @param deltaTime in seconds
  146807. */
  146808. update(deltaTime: number): void;
  146809. /**
  146810. * Set the Bounding box extent for doing spatial queries (getClosestPoint, getRandomPointAround, ...)
  146811. * The queries will try to find a solution within those bounds
  146812. * default is (1,1,1)
  146813. * @param extent x,y,z value that define the extent around the queries point of reference
  146814. */
  146815. setDefaultQueryExtent(extent: Vector3): void;
  146816. /**
  146817. * Get the Bounding box extent specified by setDefaultQueryExtent
  146818. * @returns the box extent values
  146819. */
  146820. getDefaultQueryExtent(): Vector3;
  146821. /**
  146822. * Get the Bounding box extent result specified by setDefaultQueryExtent
  146823. * @param result output the box extent values
  146824. */
  146825. getDefaultQueryExtentToRef(result: Vector3): void;
  146826. /**
  146827. * Release all resources
  146828. */
  146829. dispose(): void;
  146830. }
  146831. }
  146832. declare module BABYLON {
  146833. /**
  146834. * Class used to enable access to IndexedDB
  146835. * @see https://doc.babylonjs.com/how_to/caching_resources_in_indexeddb
  146836. */
  146837. export class Database implements IOfflineProvider {
  146838. private _callbackManifestChecked;
  146839. private _currentSceneUrl;
  146840. private _db;
  146841. private _enableSceneOffline;
  146842. private _enableTexturesOffline;
  146843. private _manifestVersionFound;
  146844. private _mustUpdateRessources;
  146845. private _hasReachedQuota;
  146846. private _isSupported;
  146847. private _idbFactory;
  146848. /** Gets a boolean indicating if the user agent supports blob storage (this value will be updated after creating the first Database object) */
  146849. private static IsUASupportingBlobStorage;
  146850. /**
  146851. * Gets a boolean indicating if Database storate is enabled (off by default)
  146852. */
  146853. static IDBStorageEnabled: boolean;
  146854. /**
  146855. * Gets a boolean indicating if scene must be saved in the database
  146856. */
  146857. get enableSceneOffline(): boolean;
  146858. /**
  146859. * Gets a boolean indicating if textures must be saved in the database
  146860. */
  146861. get enableTexturesOffline(): boolean;
  146862. /**
  146863. * Creates a new Database
  146864. * @param urlToScene defines the url to load the scene
  146865. * @param callbackManifestChecked defines the callback to use when manifest is checked
  146866. * @param disableManifestCheck defines a boolean indicating that we want to skip the manifest validation (it will be considered validated and up to date)
  146867. */
  146868. constructor(urlToScene: string, callbackManifestChecked: (checked: boolean) => any, disableManifestCheck?: boolean);
  146869. private static _ParseURL;
  146870. private static _ReturnFullUrlLocation;
  146871. private _checkManifestFile;
  146872. /**
  146873. * Open the database and make it available
  146874. * @param successCallback defines the callback to call on success
  146875. * @param errorCallback defines the callback to call on error
  146876. */
  146877. open(successCallback: () => void, errorCallback: () => void): void;
  146878. /**
  146879. * Loads an image from the database
  146880. * @param url defines the url to load from
  146881. * @param image defines the target DOM image
  146882. */
  146883. loadImage(url: string, image: HTMLImageElement): void;
  146884. private _loadImageFromDBAsync;
  146885. private _saveImageIntoDBAsync;
  146886. private _checkVersionFromDB;
  146887. private _loadVersionFromDBAsync;
  146888. private _saveVersionIntoDBAsync;
  146889. /**
  146890. * Loads a file from database
  146891. * @param url defines the URL to load from
  146892. * @param sceneLoaded defines a callback to call on success
  146893. * @param progressCallBack defines a callback to call when progress changed
  146894. * @param errorCallback defines a callback to call on error
  146895. * @param useArrayBuffer defines a boolean to use array buffer instead of text string
  146896. */
  146897. loadFile(url: string, sceneLoaded: (data: any) => void, progressCallBack?: (data: any) => void, errorCallback?: () => void, useArrayBuffer?: boolean): void;
  146898. private _loadFileAsync;
  146899. private _saveFileAsync;
  146900. /**
  146901. * Validates if xhr data is correct
  146902. * @param xhr defines the request to validate
  146903. * @param dataType defines the expected data type
  146904. * @returns true if data is correct
  146905. */
  146906. private static _ValidateXHRData;
  146907. }
  146908. }
  146909. declare module BABYLON {
  146910. /** @hidden */
  146911. export var gpuUpdateParticlesPixelShader: {
  146912. name: string;
  146913. shader: string;
  146914. };
  146915. }
  146916. declare module BABYLON {
  146917. /** @hidden */
  146918. export var gpuUpdateParticlesVertexShader: {
  146919. name: string;
  146920. shader: string;
  146921. };
  146922. }
  146923. declare module BABYLON {
  146924. /** @hidden */
  146925. export var clipPlaneFragmentDeclaration2: {
  146926. name: string;
  146927. shader: string;
  146928. };
  146929. }
  146930. declare module BABYLON {
  146931. /** @hidden */
  146932. export var gpuRenderParticlesPixelShader: {
  146933. name: string;
  146934. shader: string;
  146935. };
  146936. }
  146937. declare module BABYLON {
  146938. /** @hidden */
  146939. export var clipPlaneVertexDeclaration2: {
  146940. name: string;
  146941. shader: string;
  146942. };
  146943. }
  146944. declare module BABYLON {
  146945. /** @hidden */
  146946. export var gpuRenderParticlesVertexShader: {
  146947. name: string;
  146948. shader: string;
  146949. };
  146950. }
  146951. declare module BABYLON {
  146952. /**
  146953. * This represents a GPU particle system in Babylon
  146954. * This is the fastest particle system in Babylon as it uses the GPU to update the individual particle data
  146955. * @see https://www.babylonjs-playground.com/#PU4WYI#4
  146956. */
  146957. export class GPUParticleSystem extends BaseParticleSystem implements IDisposable, IParticleSystem, IAnimatable {
  146958. /**
  146959. * The layer mask we are rendering the particles through.
  146960. */
  146961. layerMask: number;
  146962. private _capacity;
  146963. private _activeCount;
  146964. private _currentActiveCount;
  146965. private _accumulatedCount;
  146966. private _renderEffect;
  146967. private _updateEffect;
  146968. private _buffer0;
  146969. private _buffer1;
  146970. private _spriteBuffer;
  146971. private _updateVAO;
  146972. private _renderVAO;
  146973. private _targetIndex;
  146974. private _sourceBuffer;
  146975. private _targetBuffer;
  146976. private _currentRenderId;
  146977. private _started;
  146978. private _stopped;
  146979. private _timeDelta;
  146980. private _randomTexture;
  146981. private _randomTexture2;
  146982. private _attributesStrideSize;
  146983. private _updateEffectOptions;
  146984. private _randomTextureSize;
  146985. private _actualFrame;
  146986. private _customEffect;
  146987. private readonly _rawTextureWidth;
  146988. /**
  146989. * Gets a boolean indicating if the GPU particles can be rendered on current browser
  146990. */
  146991. static get IsSupported(): boolean;
  146992. /**
  146993. * An event triggered when the system is disposed.
  146994. */
  146995. onDisposeObservable: Observable<IParticleSystem>;
  146996. /**
  146997. * Gets the maximum number of particles active at the same time.
  146998. * @returns The max number of active particles.
  146999. */
  147000. getCapacity(): number;
  147001. /**
  147002. * Forces the particle to write their depth information to the depth buffer. This can help preventing other draw calls
  147003. * to override the particles.
  147004. */
  147005. forceDepthWrite: boolean;
  147006. /**
  147007. * Gets or set the number of active particles
  147008. */
  147009. get activeParticleCount(): number;
  147010. set activeParticleCount(value: number);
  147011. private _preWarmDone;
  147012. /**
  147013. * Specifies if the particles are updated in emitter local space or world space.
  147014. */
  147015. isLocal: boolean;
  147016. /** Gets or sets a matrix to use to compute projection */
  147017. defaultProjectionMatrix: Matrix;
  147018. /**
  147019. * Is this system ready to be used/rendered
  147020. * @return true if the system is ready
  147021. */
  147022. isReady(): boolean;
  147023. /**
  147024. * Gets if the system has been started. (Note: this will still be true after stop is called)
  147025. * @returns True if it has been started, otherwise false.
  147026. */
  147027. isStarted(): boolean;
  147028. /**
  147029. * Gets if the system has been stopped. (Note: rendering is still happening but the system is frozen)
  147030. * @returns True if it has been stopped, otherwise false.
  147031. */
  147032. isStopped(): boolean;
  147033. /**
  147034. * Gets a boolean indicating that the system is stopping
  147035. * @returns true if the system is currently stopping
  147036. */
  147037. isStopping(): boolean;
  147038. /**
  147039. * Gets the number of particles active at the same time.
  147040. * @returns The number of active particles.
  147041. */
  147042. getActiveCount(): number;
  147043. /**
  147044. * Starts the particle system and begins to emit
  147045. * @param delay defines the delay in milliseconds before starting the system (this.startDelay by default)
  147046. */
  147047. start(delay?: number): void;
  147048. /**
  147049. * Stops the particle system.
  147050. */
  147051. stop(): void;
  147052. /**
  147053. * Remove all active particles
  147054. */
  147055. reset(): void;
  147056. /**
  147057. * Returns the string "GPUParticleSystem"
  147058. * @returns a string containing the class name
  147059. */
  147060. getClassName(): string;
  147061. /**
  147062. * Gets the custom effect used to render the particles
  147063. * @param blendMode Blend mode for which the effect should be retrieved
  147064. * @returns The effect
  147065. */
  147066. getCustomEffect(blendMode?: number): Nullable<Effect>;
  147067. /**
  147068. * Sets the custom effect used to render the particles
  147069. * @param effect The effect to set
  147070. * @param blendMode Blend mode for which the effect should be set
  147071. */
  147072. setCustomEffect(effect: Nullable<Effect>, blendMode?: number): void;
  147073. /** @hidden */
  147074. protected _onBeforeDrawParticlesObservable: Nullable<Observable<Nullable<Effect>>>;
  147075. /**
  147076. * Observable that will be called just before the particles are drawn
  147077. */
  147078. get onBeforeDrawParticlesObservable(): Observable<Nullable<Effect>>;
  147079. /**
  147080. * Gets the name of the particle vertex shader
  147081. */
  147082. get vertexShaderName(): string;
  147083. private _colorGradientsTexture;
  147084. protected _removeGradientAndTexture(gradient: number, gradients: Nullable<IValueGradient[]>, texture: RawTexture): BaseParticleSystem;
  147085. /**
  147086. * Adds a new color gradient
  147087. * @param gradient defines the gradient to use (between 0 and 1)
  147088. * @param color1 defines the color to affect to the specified gradient
  147089. * @param color2 defines an additional color used to define a range ([color, color2]) with main color to pick the final color from
  147090. * @returns the current particle system
  147091. */
  147092. addColorGradient(gradient: number, color1: Color4, color2?: Color4): GPUParticleSystem;
  147093. private _refreshColorGradient;
  147094. /** Force the system to rebuild all gradients that need to be resync */
  147095. forceRefreshGradients(): void;
  147096. /**
  147097. * Remove a specific color gradient
  147098. * @param gradient defines the gradient to remove
  147099. * @returns the current particle system
  147100. */
  147101. removeColorGradient(gradient: number): GPUParticleSystem;
  147102. private _angularSpeedGradientsTexture;
  147103. private _sizeGradientsTexture;
  147104. private _velocityGradientsTexture;
  147105. private _limitVelocityGradientsTexture;
  147106. private _dragGradientsTexture;
  147107. private _addFactorGradient;
  147108. /**
  147109. * Adds a new size gradient
  147110. * @param gradient defines the gradient to use (between 0 and 1)
  147111. * @param factor defines the size factor to affect to the specified gradient
  147112. * @returns the current particle system
  147113. */
  147114. addSizeGradient(gradient: number, factor: number): GPUParticleSystem;
  147115. /**
  147116. * Remove a specific size gradient
  147117. * @param gradient defines the gradient to remove
  147118. * @returns the current particle system
  147119. */
  147120. removeSizeGradient(gradient: number): GPUParticleSystem;
  147121. private _refreshFactorGradient;
  147122. /**
  147123. * Adds a new angular speed gradient
  147124. * @param gradient defines the gradient to use (between 0 and 1)
  147125. * @param factor defines the angular speed to affect to the specified gradient
  147126. * @returns the current particle system
  147127. */
  147128. addAngularSpeedGradient(gradient: number, factor: number): GPUParticleSystem;
  147129. /**
  147130. * Remove a specific angular speed gradient
  147131. * @param gradient defines the gradient to remove
  147132. * @returns the current particle system
  147133. */
  147134. removeAngularSpeedGradient(gradient: number): GPUParticleSystem;
  147135. /**
  147136. * Adds a new velocity gradient
  147137. * @param gradient defines the gradient to use (between 0 and 1)
  147138. * @param factor defines the velocity to affect to the specified gradient
  147139. * @returns the current particle system
  147140. */
  147141. addVelocityGradient(gradient: number, factor: number): GPUParticleSystem;
  147142. /**
  147143. * Remove a specific velocity gradient
  147144. * @param gradient defines the gradient to remove
  147145. * @returns the current particle system
  147146. */
  147147. removeVelocityGradient(gradient: number): GPUParticleSystem;
  147148. /**
  147149. * Adds a new limit velocity gradient
  147150. * @param gradient defines the gradient to use (between 0 and 1)
  147151. * @param factor defines the limit velocity value to affect to the specified gradient
  147152. * @returns the current particle system
  147153. */
  147154. addLimitVelocityGradient(gradient: number, factor: number): GPUParticleSystem;
  147155. /**
  147156. * Remove a specific limit velocity gradient
  147157. * @param gradient defines the gradient to remove
  147158. * @returns the current particle system
  147159. */
  147160. removeLimitVelocityGradient(gradient: number): GPUParticleSystem;
  147161. /**
  147162. * Adds a new drag gradient
  147163. * @param gradient defines the gradient to use (between 0 and 1)
  147164. * @param factor defines the drag value to affect to the specified gradient
  147165. * @returns the current particle system
  147166. */
  147167. addDragGradient(gradient: number, factor: number): GPUParticleSystem;
  147168. /**
  147169. * Remove a specific drag gradient
  147170. * @param gradient defines the gradient to remove
  147171. * @returns the current particle system
  147172. */
  147173. removeDragGradient(gradient: number): GPUParticleSystem;
  147174. /**
  147175. * Not supported by GPUParticleSystem
  147176. * @param gradient defines the gradient to use (between 0 and 1)
  147177. * @param factor defines the emit rate value to affect to the specified gradient
  147178. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  147179. * @returns the current particle system
  147180. */
  147181. addEmitRateGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  147182. /**
  147183. * Not supported by GPUParticleSystem
  147184. * @param gradient defines the gradient to remove
  147185. * @returns the current particle system
  147186. */
  147187. removeEmitRateGradient(gradient: number): IParticleSystem;
  147188. /**
  147189. * Not supported by GPUParticleSystem
  147190. * @param gradient defines the gradient to use (between 0 and 1)
  147191. * @param factor defines the start size value to affect to the specified gradient
  147192. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  147193. * @returns the current particle system
  147194. */
  147195. addStartSizeGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  147196. /**
  147197. * Not supported by GPUParticleSystem
  147198. * @param gradient defines the gradient to remove
  147199. * @returns the current particle system
  147200. */
  147201. removeStartSizeGradient(gradient: number): IParticleSystem;
  147202. /**
  147203. * Not supported by GPUParticleSystem
  147204. * @param gradient defines the gradient to use (between 0 and 1)
  147205. * @param min defines the color remap minimal range
  147206. * @param max defines the color remap maximal range
  147207. * @returns the current particle system
  147208. */
  147209. addColorRemapGradient(gradient: number, min: number, max: number): IParticleSystem;
  147210. /**
  147211. * Not supported by GPUParticleSystem
  147212. * @param gradient defines the gradient to remove
  147213. * @returns the current particle system
  147214. */
  147215. removeColorRemapGradient(): IParticleSystem;
  147216. /**
  147217. * Not supported by GPUParticleSystem
  147218. * @param gradient defines the gradient to use (between 0 and 1)
  147219. * @param min defines the alpha remap minimal range
  147220. * @param max defines the alpha remap maximal range
  147221. * @returns the current particle system
  147222. */
  147223. addAlphaRemapGradient(gradient: number, min: number, max: number): IParticleSystem;
  147224. /**
  147225. * Not supported by GPUParticleSystem
  147226. * @param gradient defines the gradient to remove
  147227. * @returns the current particle system
  147228. */
  147229. removeAlphaRemapGradient(): IParticleSystem;
  147230. /**
  147231. * Not supported by GPUParticleSystem
  147232. * @param gradient defines the gradient to use (between 0 and 1)
  147233. * @param color defines the color to affect to the specified gradient
  147234. * @returns the current particle system
  147235. */
  147236. addRampGradient(gradient: number, color: Color3): IParticleSystem;
  147237. /**
  147238. * Not supported by GPUParticleSystem
  147239. * @param gradient defines the gradient to remove
  147240. * @returns the current particle system
  147241. */
  147242. removeRampGradient(): IParticleSystem;
  147243. /**
  147244. * Not supported by GPUParticleSystem
  147245. * @returns the list of ramp gradients
  147246. */
  147247. getRampGradients(): Nullable<Array<Color3Gradient>>;
  147248. /**
  147249. * Not supported by GPUParticleSystem
  147250. * Gets or sets a boolean indicating that ramp gradients must be used
  147251. * @see https://doc.babylonjs.com/babylon101/particles#ramp-gradients
  147252. */
  147253. get useRampGradients(): boolean;
  147254. set useRampGradients(value: boolean);
  147255. /**
  147256. * Not supported by GPUParticleSystem
  147257. * @param gradient defines the gradient to use (between 0 and 1)
  147258. * @param factor defines the life time factor to affect to the specified gradient
  147259. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  147260. * @returns the current particle system
  147261. */
  147262. addLifeTimeGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  147263. /**
  147264. * Not supported by GPUParticleSystem
  147265. * @param gradient defines the gradient to remove
  147266. * @returns the current particle system
  147267. */
  147268. removeLifeTimeGradient(gradient: number): IParticleSystem;
  147269. /**
  147270. * Instantiates a GPU particle system.
  147271. * 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.
  147272. * @param name The name of the particle system
  147273. * @param options The options used to create the system
  147274. * @param sceneOrEngine The scene the particle system belongs to or the engine to use if no scene
  147275. * @param isAnimationSheetEnabled Must be true if using a spritesheet to animate the particles texture
  147276. * @param customEffect a custom effect used to change the way particles are rendered by default
  147277. */
  147278. constructor(name: string, options: Partial<{
  147279. capacity: number;
  147280. randomTextureSize: number;
  147281. }>, sceneOrEngine: Scene | ThinEngine, isAnimationSheetEnabled?: boolean, customEffect?: Nullable<Effect>);
  147282. protected _reset(): void;
  147283. private _createUpdateVAO;
  147284. private _createRenderVAO;
  147285. private _initialize;
  147286. /** @hidden */
  147287. _recreateUpdateEffect(): void;
  147288. private _getEffect;
  147289. /**
  147290. * Fill the defines array according to the current settings of the particle system
  147291. * @param defines Array to be updated
  147292. * @param blendMode blend mode to take into account when updating the array
  147293. */
  147294. fillDefines(defines: Array<string>, blendMode?: number): void;
  147295. /**
  147296. * Fill the uniforms, attributes and samplers arrays according to the current settings of the particle system
  147297. * @param uniforms Uniforms array to fill
  147298. * @param attributes Attributes array to fill
  147299. * @param samplers Samplers array to fill
  147300. */
  147301. fillUniformsAttributesAndSamplerNames(uniforms: Array<string>, attributes: Array<string>, samplers: Array<string>): void;
  147302. /** @hidden */
  147303. _recreateRenderEffect(): Effect;
  147304. /**
  147305. * Animates the particle system for the current frame by emitting new particles and or animating the living ones.
  147306. * @param preWarm defines if we are in the pre-warmimg phase
  147307. */
  147308. animate(preWarm?: boolean): void;
  147309. private _createFactorGradientTexture;
  147310. private _createSizeGradientTexture;
  147311. private _createAngularSpeedGradientTexture;
  147312. private _createVelocityGradientTexture;
  147313. private _createLimitVelocityGradientTexture;
  147314. private _createDragGradientTexture;
  147315. private _createColorGradientTexture;
  147316. /**
  147317. * Renders the particle system in its current state
  147318. * @param preWarm defines if the system should only update the particles but not render them
  147319. * @returns the current number of particles
  147320. */
  147321. render(preWarm?: boolean): number;
  147322. /**
  147323. * Rebuilds the particle system
  147324. */
  147325. rebuild(): void;
  147326. private _releaseBuffers;
  147327. private _releaseVAOs;
  147328. /**
  147329. * Disposes the particle system and free the associated resources
  147330. * @param disposeTexture defines if the particule texture must be disposed as well (true by default)
  147331. */
  147332. dispose(disposeTexture?: boolean): void;
  147333. /**
  147334. * Clones the particle system.
  147335. * @param name The name of the cloned object
  147336. * @param newEmitter The new emitter to use
  147337. * @returns the cloned particle system
  147338. */
  147339. clone(name: string, newEmitter: any): GPUParticleSystem;
  147340. /**
  147341. * Serializes the particle system to a JSON object
  147342. * @param serializeTexture defines if the texture must be serialized as well
  147343. * @returns the JSON object
  147344. */
  147345. serialize(serializeTexture?: boolean): any;
  147346. /**
  147347. * Parses a JSON object to create a GPU particle system.
  147348. * @param parsedParticleSystem The JSON object to parse
  147349. * @param sceneOrEngine The scene or the engine to create the particle system in
  147350. * @param rootUrl The root url to use to load external dependencies like texture
  147351. * @param doNotStart Ignore the preventAutoStart attribute and does not start
  147352. * @returns the parsed GPU particle system
  147353. */
  147354. static Parse(parsedParticleSystem: any, sceneOrEngine: Scene | ThinEngine, rootUrl: string, doNotStart?: boolean): GPUParticleSystem;
  147355. }
  147356. }
  147357. declare module BABYLON {
  147358. /**
  147359. * Represents a set of particle systems working together to create a specific effect
  147360. */
  147361. export class ParticleSystemSet implements IDisposable {
  147362. /**
  147363. * Gets or sets base Assets URL
  147364. */
  147365. static BaseAssetsUrl: string;
  147366. private _emitterCreationOptions;
  147367. private _emitterNode;
  147368. /**
  147369. * Gets the particle system list
  147370. */
  147371. systems: IParticleSystem[];
  147372. /**
  147373. * Gets the emitter node used with this set
  147374. */
  147375. get emitterNode(): Nullable<TransformNode>;
  147376. /**
  147377. * Creates a new emitter mesh as a sphere
  147378. * @param options defines the options used to create the sphere
  147379. * @param renderingGroupId defines the renderingGroupId to use for the sphere
  147380. * @param scene defines the hosting scene
  147381. */
  147382. setEmitterAsSphere(options: {
  147383. diameter: number;
  147384. segments: number;
  147385. color: Color3;
  147386. }, renderingGroupId: number, scene: Scene): void;
  147387. /**
  147388. * Starts all particle systems of the set
  147389. * @param emitter defines an optional mesh to use as emitter for the particle systems
  147390. */
  147391. start(emitter?: AbstractMesh): void;
  147392. /**
  147393. * Release all associated resources
  147394. */
  147395. dispose(): void;
  147396. /**
  147397. * Serialize the set into a JSON compatible object
  147398. * @param serializeTexture defines if the texture must be serialized as well
  147399. * @returns a JSON compatible representation of the set
  147400. */
  147401. serialize(serializeTexture?: boolean): any;
  147402. /**
  147403. * Parse a new ParticleSystemSet from a serialized source
  147404. * @param data defines a JSON compatible representation of the set
  147405. * @param scene defines the hosting scene
  147406. * @param gpu defines if we want GPU particles or CPU particles
  147407. * @returns a new ParticleSystemSet
  147408. */
  147409. static Parse(data: any, scene: Scene, gpu?: boolean): ParticleSystemSet;
  147410. }
  147411. }
  147412. declare module BABYLON {
  147413. /**
  147414. * This class is made for on one-liner static method to help creating particle system set.
  147415. */
  147416. export class ParticleHelper {
  147417. /**
  147418. * Gets or sets base Assets URL
  147419. */
  147420. static BaseAssetsUrl: string;
  147421. /** Define the Url to load snippets */
  147422. static SnippetUrl: string;
  147423. /**
  147424. * Create a default particle system that you can tweak
  147425. * @param emitter defines the emitter to use
  147426. * @param capacity defines the system capacity (default is 500 particles)
  147427. * @param scene defines the hosting scene
  147428. * @param useGPU defines if a GPUParticleSystem must be created (default is false)
  147429. * @returns the new Particle system
  147430. */
  147431. static CreateDefault(emitter: Nullable<AbstractMesh | Vector3>, capacity?: number, scene?: Scene, useGPU?: boolean): IParticleSystem;
  147432. /**
  147433. * This is the main static method (one-liner) of this helper to create different particle systems
  147434. * @param type This string represents the type to the particle system to create
  147435. * @param scene The scene where the particle system should live
  147436. * @param gpu If the system will use gpu
  147437. * @returns the ParticleSystemSet created
  147438. */
  147439. static CreateAsync(type: string, scene: Nullable<Scene>, gpu?: boolean): Promise<ParticleSystemSet>;
  147440. /**
  147441. * Static function used to export a particle system to a ParticleSystemSet variable.
  147442. * Please note that the emitter shape is not exported
  147443. * @param systems defines the particle systems to export
  147444. * @returns the created particle system set
  147445. */
  147446. static ExportSet(systems: IParticleSystem[]): ParticleSystemSet;
  147447. /**
  147448. * Creates a particle system from a snippet saved in a remote file
  147449. * @param name defines the name of the particle system to create (can be null or empty to use the one from the json data)
  147450. * @param url defines the url to load from
  147451. * @param scene defines the hosting scene
  147452. * @param gpu If the system will use gpu
  147453. * @param rootUrl defines the root URL to use to load textures and relative dependencies
  147454. * @returns a promise that will resolve to the new particle system
  147455. */
  147456. static ParseFromFileAsync(name: Nullable<string>, url: string, scene: Scene, gpu?: boolean, rootUrl?: string): Promise<IParticleSystem>;
  147457. /**
  147458. * Creates a particle system from a snippet saved by the particle system editor
  147459. * @param snippetId defines the snippet to load (can be set to _BLANK to create a default one)
  147460. * @param scene defines the hosting scene
  147461. * @param gpu If the system will use gpu
  147462. * @param rootUrl defines the root URL to use to load textures and relative dependencies
  147463. * @returns a promise that will resolve to the new particle system
  147464. */
  147465. static CreateFromSnippetAsync(snippetId: string, scene: Scene, gpu?: boolean, rootUrl?: string): Promise<IParticleSystem>;
  147466. }
  147467. }
  147468. declare module BABYLON {
  147469. interface Engine {
  147470. /**
  147471. * Create an effect to use with particle systems.
  147472. * Please note that some parameters like animation sheets or not being billboard are not supported in this configuration, except if you pass
  147473. * the particle system for which you want to create a custom effect in the last parameter
  147474. * @param fragmentName defines the base name of the effect (The name of file without .fragment.fx)
  147475. * @param uniformsNames defines a list of attribute names
  147476. * @param samplers defines an array of string used to represent textures
  147477. * @param defines defines the string containing the defines to use to compile the shaders
  147478. * @param fallbacks defines the list of potential fallbacks to use if shader conmpilation fails
  147479. * @param onCompiled defines a function to call when the effect creation is successful
  147480. * @param onError defines a function to call when the effect creation has failed
  147481. * @param particleSystem the particle system you want to create the effect for
  147482. * @returns the new Effect
  147483. */
  147484. createEffectForParticles(fragmentName: string, uniformsNames: string[], samplers: string[], defines: string, fallbacks?: EffectFallbacks, onCompiled?: (effect: Effect) => void, onError?: (effect: Effect, errors: string) => void, particleSystem?: IParticleSystem): Effect;
  147485. }
  147486. interface Mesh {
  147487. /**
  147488. * Returns an array populated with IParticleSystem objects whose the mesh is the emitter
  147489. * @returns an array of IParticleSystem
  147490. */
  147491. getEmittedParticleSystems(): IParticleSystem[];
  147492. /**
  147493. * Returns an array populated with IParticleSystem objects whose the mesh or its children are the emitter
  147494. * @returns an array of IParticleSystem
  147495. */
  147496. getHierarchyEmittedParticleSystems(): IParticleSystem[];
  147497. }
  147498. }
  147499. declare module BABYLON {
  147500. /** Defines the 4 color options */
  147501. export enum PointColor {
  147502. /** color value */
  147503. Color = 2,
  147504. /** uv value */
  147505. UV = 1,
  147506. /** random value */
  147507. Random = 0,
  147508. /** stated value */
  147509. Stated = 3
  147510. }
  147511. /**
  147512. * The PointCloudSystem (PCS) is a single updatable mesh. The points corresponding to the vertices of this big mesh.
  147513. * 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.
  147514. * The PointCloudSytem is also a particle system, with each point being a particle. It provides some methods to manage the particles.
  147515. * However it is behavior agnostic. This means it has no emitter, no particle physics, no particle recycler. You have to implement your own behavior.
  147516. *
  147517. * Full documentation here : TO BE ENTERED
  147518. */
  147519. export class PointsCloudSystem implements IDisposable {
  147520. /**
  147521. * The PCS array of cloud point objects. Just access each particle as with any classic array.
  147522. * Example : var p = SPS.particles[i];
  147523. */
  147524. particles: CloudPoint[];
  147525. /**
  147526. * The PCS total number of particles. Read only. Use PCS.counter instead if you need to set your own value.
  147527. */
  147528. nbParticles: number;
  147529. /**
  147530. * This a counter for your own usage. It's not set by any SPS functions.
  147531. */
  147532. counter: number;
  147533. /**
  147534. * The PCS name. This name is also given to the underlying mesh.
  147535. */
  147536. name: string;
  147537. /**
  147538. * The PCS mesh. It's a standard BJS Mesh, so all the methods from the Mesh class are avalaible.
  147539. */
  147540. mesh: Mesh;
  147541. /**
  147542. * This empty object is intended to store some PCS specific or temporary values in order to lower the Garbage Collector activity.
  147543. * Please read :
  147544. */
  147545. vars: any;
  147546. /**
  147547. * @hidden
  147548. */
  147549. _size: number;
  147550. private _scene;
  147551. private _promises;
  147552. private _positions;
  147553. private _indices;
  147554. private _normals;
  147555. private _colors;
  147556. private _uvs;
  147557. private _indices32;
  147558. private _positions32;
  147559. private _colors32;
  147560. private _uvs32;
  147561. private _updatable;
  147562. private _isVisibilityBoxLocked;
  147563. private _alwaysVisible;
  147564. private _groups;
  147565. private _groupCounter;
  147566. private _computeParticleColor;
  147567. private _computeParticleTexture;
  147568. private _computeParticleRotation;
  147569. private _computeBoundingBox;
  147570. private _isReady;
  147571. /**
  147572. * Creates a PCS (Points Cloud System) object
  147573. * @param name (String) is the PCS name, this will be the underlying mesh name
  147574. * @param pointSize (number) is the size for each point
  147575. * @param scene (Scene) is the scene in which the PCS is added
  147576. * @param options defines the options of the PCS e.g.
  147577. * * updatable (optional boolean, default true) : if the PCS must be updatable or immutable
  147578. */
  147579. constructor(name: string, pointSize: number, scene: Scene, options?: {
  147580. updatable?: boolean;
  147581. });
  147582. /**
  147583. * Builds the PCS underlying mesh. Returns a standard Mesh.
  147584. * If no points were added to the PCS, the returned mesh is just a single point.
  147585. * @returns a promise for the created mesh
  147586. */
  147587. buildMeshAsync(): Promise<Mesh>;
  147588. /**
  147589. * @hidden
  147590. */
  147591. private _buildMesh;
  147592. private _addParticle;
  147593. private _randomUnitVector;
  147594. private _getColorIndicesForCoord;
  147595. private _setPointsColorOrUV;
  147596. private _colorFromTexture;
  147597. private _calculateDensity;
  147598. /**
  147599. * Adds points to the PCS in random positions within a unit sphere
  147600. * @param nb (positive integer) the number of particles to be created from this model
  147601. * @param pointFunction is an optional javascript function to be called for each particle on PCS creation
  147602. * @returns the number of groups in the system
  147603. */
  147604. addPoints(nb: number, pointFunction?: any): number;
  147605. /**
  147606. * Adds points to the PCS from the surface of the model shape
  147607. * @param mesh is any Mesh object that will be used as a surface model for the points
  147608. * @param nb (positive integer) the number of particles to be created from this model
  147609. * @param colorWith determines whether a point is colored using color (default), uv, random, stated or none (invisible)
  147610. * @param color (color4) to be used when colorWith is stated or color (number) when used to specify texture position
  147611. * @param range (number from 0 to 1) to determine the variation in shape and tone for a stated color
  147612. * @returns the number of groups in the system
  147613. */
  147614. addSurfacePoints(mesh: Mesh, nb: number, colorWith?: number, color?: Color4 | number, range?: number): number;
  147615. /**
  147616. * Adds points to the PCS inside the model shape
  147617. * @param mesh is any Mesh object that will be used as a surface model for the points
  147618. * @param nb (positive integer) the number of particles to be created from this model
  147619. * @param colorWith determines whether a point is colored using color (default), uv, random, stated or none (invisible)
  147620. * @param color (color4) to be used when colorWith is stated or color (number) when used to specify texture position
  147621. * @param range (number from 0 to 1) to determine the variation in shape and tone for a stated color
  147622. * @returns the number of groups in the system
  147623. */
  147624. addVolumePoints(mesh: Mesh, nb: number, colorWith?: number, color?: Color4 | number, range?: number): number;
  147625. /**
  147626. * Sets all the particles : this method actually really updates the mesh according to the particle positions, rotations, colors, textures, etc.
  147627. * This method calls `updateParticle()` for each particle of the SPS.
  147628. * For an animated SPS, it is usually called within the render loop.
  147629. * @param start The particle index in the particle array where to start to compute the particle property values _(default 0)_
  147630. * @param end The particle index in the particle array where to stop to compute the particle property values _(default nbParticle - 1)_
  147631. * @param update If the mesh must be finally updated on this call after all the particle computations _(default true)_
  147632. * @returns the PCS.
  147633. */
  147634. setParticles(start?: number, end?: number, update?: boolean): PointsCloudSystem;
  147635. /**
  147636. * Disposes the PCS.
  147637. */
  147638. dispose(): void;
  147639. /**
  147640. * Visibilty helper : Recomputes the visible size according to the mesh bounding box
  147641. * doc :
  147642. * @returns the PCS.
  147643. */
  147644. refreshVisibleSize(): PointsCloudSystem;
  147645. /**
  147646. * Visibility helper : Sets the size of a visibility box, this sets the underlying mesh bounding box.
  147647. * @param size the size (float) of the visibility box
  147648. * note : this doesn't lock the PCS mesh bounding box.
  147649. * doc :
  147650. */
  147651. setVisibilityBox(size: number): void;
  147652. /**
  147653. * Gets whether the PCS is always visible or not
  147654. * doc :
  147655. */
  147656. get isAlwaysVisible(): boolean;
  147657. /**
  147658. * Sets the PCS as always visible or not
  147659. * doc :
  147660. */
  147661. set isAlwaysVisible(val: boolean);
  147662. /**
  147663. * Tells to `setParticles()` to compute the particle rotations or not
  147664. * Default value : false. The PCS is faster when it's set to false
  147665. * Note : particle rotations are only applied to parent particles
  147666. * Note : the particle rotations aren't stored values, so setting `computeParticleRotation` to false will prevents the particle to rotate
  147667. */
  147668. set computeParticleRotation(val: boolean);
  147669. /**
  147670. * Tells to `setParticles()` to compute the particle colors or not.
  147671. * Default value : true. The PCS is faster when it's set to false.
  147672. * Note : the particle colors are stored values, so setting `computeParticleColor` to false will keep yet the last colors set.
  147673. */
  147674. set computeParticleColor(val: boolean);
  147675. set computeParticleTexture(val: boolean);
  147676. /**
  147677. * Gets if `setParticles()` computes the particle colors or not.
  147678. * Default value : false. The PCS is faster when it's set to false.
  147679. * Note : the particle colors are stored values, so setting `computeParticleColor` to false will keep yet the last colors set.
  147680. */
  147681. get computeParticleColor(): boolean;
  147682. /**
  147683. * Gets if `setParticles()` computes the particle textures or not.
  147684. * Default value : false. The PCS is faster when it's set to false.
  147685. * Note : the particle textures are stored values, so setting `computeParticleTexture` to false will keep yet the last colors set.
  147686. */
  147687. get computeParticleTexture(): boolean;
  147688. /**
  147689. * Tells to `setParticles()` to compute or not the mesh bounding box when computing the particle positions.
  147690. */
  147691. set computeBoundingBox(val: boolean);
  147692. /**
  147693. * Gets if `setParticles()` computes or not the mesh bounding box when computing the particle positions.
  147694. */
  147695. get computeBoundingBox(): boolean;
  147696. /**
  147697. * This function does nothing. It may be overwritten to set all the particle first values.
  147698. * The PCS doesn't call this function, you may have to call it by your own.
  147699. * doc :
  147700. */
  147701. initParticles(): void;
  147702. /**
  147703. * This function does nothing. It may be overwritten to recycle a particle
  147704. * The PCS doesn't call this function, you can to call it
  147705. * doc :
  147706. * @param particle The particle to recycle
  147707. * @returns the recycled particle
  147708. */
  147709. recycleParticle(particle: CloudPoint): CloudPoint;
  147710. /**
  147711. * Updates a particle : this function should be overwritten by the user.
  147712. * It is called on each particle by `setParticles()`. This is the place to code each particle behavior.
  147713. * doc :
  147714. * @example : just set a particle position or velocity and recycle conditions
  147715. * @param particle The particle to update
  147716. * @returns the updated particle
  147717. */
  147718. updateParticle(particle: CloudPoint): CloudPoint;
  147719. /**
  147720. * This will be called before any other treatment by `setParticles()` and will be passed three parameters.
  147721. * This does nothing and may be overwritten by the user.
  147722. * @param start the particle index in the particle array where to start to iterate, same than the value passed to setParticle()
  147723. * @param stop the particle index in the particle array where to stop to iterate, same than the value passed to setParticle()
  147724. * @param update the boolean update value actually passed to setParticles()
  147725. */
  147726. beforeUpdateParticles(start?: number, stop?: number, update?: boolean): void;
  147727. /**
  147728. * This will be called by `setParticles()` after all the other treatments and just before the actual mesh update.
  147729. * This will be passed three parameters.
  147730. * This does nothing and may be overwritten by the user.
  147731. * @param start the particle index in the particle array where to start to iterate, same than the value passed to setParticle()
  147732. * @param stop the particle index in the particle array where to stop to iterate, same than the value passed to setParticle()
  147733. * @param update the boolean update value actually passed to setParticles()
  147734. */
  147735. afterUpdateParticles(start?: number, stop?: number, update?: boolean): void;
  147736. }
  147737. }
  147738. declare module BABYLON {
  147739. /**
  147740. * Represents one particle of a points cloud system.
  147741. */
  147742. export class CloudPoint {
  147743. /**
  147744. * particle global index
  147745. */
  147746. idx: number;
  147747. /**
  147748. * The color of the particle
  147749. */
  147750. color: Nullable<Color4>;
  147751. /**
  147752. * The world space position of the particle.
  147753. */
  147754. position: Vector3;
  147755. /**
  147756. * The world space rotation of the particle. (Not use if rotationQuaternion is set)
  147757. */
  147758. rotation: Vector3;
  147759. /**
  147760. * The world space rotation quaternion of the particle.
  147761. */
  147762. rotationQuaternion: Nullable<Quaternion>;
  147763. /**
  147764. * The uv of the particle.
  147765. */
  147766. uv: Nullable<Vector2>;
  147767. /**
  147768. * The current speed of the particle.
  147769. */
  147770. velocity: Vector3;
  147771. /**
  147772. * The pivot point in the particle local space.
  147773. */
  147774. pivot: Vector3;
  147775. /**
  147776. * Must the particle be translated from its pivot point in its local space ?
  147777. * In this case, the pivot point is set at the origin of the particle local space and the particle is translated.
  147778. * Default : false
  147779. */
  147780. translateFromPivot: boolean;
  147781. /**
  147782. * Index of this particle in the global "positions" array (Internal use)
  147783. * @hidden
  147784. */
  147785. _pos: number;
  147786. /**
  147787. * @hidden Index of this particle in the global "indices" array (Internal use)
  147788. */
  147789. _ind: number;
  147790. /**
  147791. * Group this particle belongs to
  147792. */
  147793. _group: PointsGroup;
  147794. /**
  147795. * Group id of this particle
  147796. */
  147797. groupId: number;
  147798. /**
  147799. * Index of the particle in its group id (Internal use)
  147800. */
  147801. idxInGroup: number;
  147802. /**
  147803. * @hidden Particle BoundingInfo object (Internal use)
  147804. */
  147805. _boundingInfo: BoundingInfo;
  147806. /**
  147807. * @hidden Reference to the PCS that the particle belongs to (Internal use)
  147808. */
  147809. _pcs: PointsCloudSystem;
  147810. /**
  147811. * @hidden Still set as invisible in order to skip useless computations (Internal use)
  147812. */
  147813. _stillInvisible: boolean;
  147814. /**
  147815. * @hidden Last computed particle rotation matrix
  147816. */
  147817. _rotationMatrix: number[];
  147818. /**
  147819. * Parent particle Id, if any.
  147820. * Default null.
  147821. */
  147822. parentId: Nullable<number>;
  147823. /**
  147824. * @hidden Internal global position in the PCS.
  147825. */
  147826. _globalPosition: Vector3;
  147827. /**
  147828. * Creates a Point Cloud object.
  147829. * Don't create particles manually, use instead the PCS internal tools like _addParticle()
  147830. * @param particleIndex (integer) is the particle index in the PCS pool. It's also the particle identifier.
  147831. * @param group (PointsGroup) is the group the particle belongs to
  147832. * @param groupId (integer) is the group identifier in the PCS.
  147833. * @param idxInGroup (integer) is the index of the particle in the current point group (ex: the 10th point of addPoints(30))
  147834. * @param pcs defines the PCS it is associated to
  147835. */
  147836. constructor(particleIndex: number, group: PointsGroup, groupId: number, idxInGroup: number, pcs: PointsCloudSystem);
  147837. /**
  147838. * get point size
  147839. */
  147840. get size(): Vector3;
  147841. /**
  147842. * Set point size
  147843. */
  147844. set size(scale: Vector3);
  147845. /**
  147846. * Legacy support, changed quaternion to rotationQuaternion
  147847. */
  147848. get quaternion(): Nullable<Quaternion>;
  147849. /**
  147850. * Legacy support, changed quaternion to rotationQuaternion
  147851. */
  147852. set quaternion(q: Nullable<Quaternion>);
  147853. /**
  147854. * Returns a boolean. True if the particle intersects a mesh, else false
  147855. * The intersection is computed on the particle position and Axis Aligned Bounding Box (AABB) or Sphere
  147856. * @param target is the object (point or mesh) what the intersection is computed against
  147857. * @param isSphere is boolean flag when false (default) bounding box of mesh is used, when true the bouding sphere is used
  147858. * @returns true if it intersects
  147859. */
  147860. intersectsMesh(target: Mesh, isSphere: boolean): boolean;
  147861. /**
  147862. * get the rotation matrix of the particle
  147863. * @hidden
  147864. */
  147865. getRotationMatrix(m: Matrix): void;
  147866. }
  147867. /**
  147868. * Represents a group of points in a points cloud system
  147869. * * PCS internal tool, don't use it manually.
  147870. */
  147871. export class PointsGroup {
  147872. /**
  147873. * The group id
  147874. * @hidden
  147875. */
  147876. groupID: number;
  147877. /**
  147878. * image data for group (internal use)
  147879. * @hidden
  147880. */
  147881. _groupImageData: Nullable<ArrayBufferView>;
  147882. /**
  147883. * Image Width (internal use)
  147884. * @hidden
  147885. */
  147886. _groupImgWidth: number;
  147887. /**
  147888. * Image Height (internal use)
  147889. * @hidden
  147890. */
  147891. _groupImgHeight: number;
  147892. /**
  147893. * Custom position function (internal use)
  147894. * @hidden
  147895. */
  147896. _positionFunction: Nullable<(particle: CloudPoint, i?: number, s?: number) => void>;
  147897. /**
  147898. * density per facet for surface points
  147899. * @hidden
  147900. */
  147901. _groupDensity: number[];
  147902. /**
  147903. * Only when points are colored by texture carries pointer to texture list array
  147904. * @hidden
  147905. */
  147906. _textureNb: number;
  147907. /**
  147908. * Creates a points group object. This is an internal reference to produce particles for the PCS.
  147909. * PCS internal tool, don't use it manually.
  147910. * @hidden
  147911. */
  147912. constructor(id: number, posFunction: Nullable<(particle: CloudPoint, i?: number, s?: number) => void>);
  147913. }
  147914. }
  147915. declare module BABYLON {
  147916. interface Scene {
  147917. /** @hidden (Backing field) */
  147918. _physicsEngine: Nullable<IPhysicsEngine>;
  147919. /** @hidden */
  147920. _physicsTimeAccumulator: number;
  147921. /**
  147922. * Gets the current physics engine
  147923. * @returns a IPhysicsEngine or null if none attached
  147924. */
  147925. getPhysicsEngine(): Nullable<IPhysicsEngine>;
  147926. /**
  147927. * Enables physics to the current scene
  147928. * @param gravity defines the scene's gravity for the physics engine
  147929. * @param plugin defines the physics engine to be used. defaults to OimoJS.
  147930. * @return a boolean indicating if the physics engine was initialized
  147931. */
  147932. enablePhysics(gravity: Nullable<Vector3>, plugin?: IPhysicsEnginePlugin): boolean;
  147933. /**
  147934. * Disables and disposes the physics engine associated with the scene
  147935. */
  147936. disablePhysicsEngine(): void;
  147937. /**
  147938. * Gets a boolean indicating if there is an active physics engine
  147939. * @returns a boolean indicating if there is an active physics engine
  147940. */
  147941. isPhysicsEnabled(): boolean;
  147942. /**
  147943. * Deletes a physics compound impostor
  147944. * @param compound defines the compound to delete
  147945. */
  147946. deleteCompoundImpostor(compound: any): void;
  147947. /**
  147948. * An event triggered when physic simulation is about to be run
  147949. */
  147950. onBeforePhysicsObservable: Observable<Scene>;
  147951. /**
  147952. * An event triggered when physic simulation has been done
  147953. */
  147954. onAfterPhysicsObservable: Observable<Scene>;
  147955. }
  147956. interface AbstractMesh {
  147957. /** @hidden */
  147958. _physicsImpostor: Nullable<PhysicsImpostor>;
  147959. /**
  147960. * Gets or sets impostor used for physic simulation
  147961. * @see https://doc.babylonjs.com/features/physics_engine
  147962. */
  147963. physicsImpostor: Nullable<PhysicsImpostor>;
  147964. /**
  147965. * Gets the current physics impostor
  147966. * @see https://doc.babylonjs.com/features/physics_engine
  147967. * @returns a physics impostor or null
  147968. */
  147969. getPhysicsImpostor(): Nullable<PhysicsImpostor>;
  147970. /** Apply a physic impulse to the mesh
  147971. * @param force defines the force to apply
  147972. * @param contactPoint defines where to apply the force
  147973. * @returns the current mesh
  147974. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  147975. */
  147976. applyImpulse(force: Vector3, contactPoint: Vector3): AbstractMesh;
  147977. /**
  147978. * Creates a physic joint between two meshes
  147979. * @param otherMesh defines the other mesh to use
  147980. * @param pivot1 defines the pivot to use on this mesh
  147981. * @param pivot2 defines the pivot to use on the other mesh
  147982. * @param options defines additional options (can be plugin dependent)
  147983. * @returns the current mesh
  147984. * @see https://www.babylonjs-playground.com/#0BS5U0#0
  147985. */
  147986. setPhysicsLinkWith(otherMesh: Mesh, pivot1: Vector3, pivot2: Vector3, options?: any): AbstractMesh;
  147987. /** @hidden */
  147988. _disposePhysicsObserver: Nullable<Observer<Node>>;
  147989. }
  147990. /**
  147991. * Defines the physics engine scene component responsible to manage a physics engine
  147992. */
  147993. export class PhysicsEngineSceneComponent implements ISceneComponent {
  147994. /**
  147995. * The component name helpful to identify the component in the list of scene components.
  147996. */
  147997. readonly name: string;
  147998. /**
  147999. * The scene the component belongs to.
  148000. */
  148001. scene: Scene;
  148002. /**
  148003. * Creates a new instance of the component for the given scene
  148004. * @param scene Defines the scene to register the component in
  148005. */
  148006. constructor(scene: Scene);
  148007. /**
  148008. * Registers the component in a given scene
  148009. */
  148010. register(): void;
  148011. /**
  148012. * Rebuilds the elements related to this component in case of
  148013. * context lost for instance.
  148014. */
  148015. rebuild(): void;
  148016. /**
  148017. * Disposes the component and the associated ressources
  148018. */
  148019. dispose(): void;
  148020. }
  148021. }
  148022. declare module BABYLON {
  148023. /**
  148024. * A helper for physics simulations
  148025. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine#further-functionality-of-the-impostor-class
  148026. */
  148027. export class PhysicsHelper {
  148028. private _scene;
  148029. private _physicsEngine;
  148030. /**
  148031. * Initializes the Physics helper
  148032. * @param scene Babylon.js scene
  148033. */
  148034. constructor(scene: Scene);
  148035. /**
  148036. * Applies a radial explosion impulse
  148037. * @param origin the origin of the explosion
  148038. * @param radiusOrEventOptions the radius or the options of radial explosion
  148039. * @param strength the explosion strength
  148040. * @param falloff possible options: Constant & Linear. Defaults to Constant
  148041. * @returns A physics radial explosion event, or null
  148042. */
  148043. applyRadialExplosionImpulse(origin: Vector3, radiusOrEventOptions: number | PhysicsRadialExplosionEventOptions, strength?: number, falloff?: PhysicsRadialImpulseFalloff): Nullable<PhysicsRadialExplosionEvent>;
  148044. /**
  148045. * Applies a radial explosion force
  148046. * @param origin the origin of the explosion
  148047. * @param radiusOrEventOptions the radius or the options of radial explosion
  148048. * @param strength the explosion strength
  148049. * @param falloff possible options: Constant & Linear. Defaults to Constant
  148050. * @returns A physics radial explosion event, or null
  148051. */
  148052. applyRadialExplosionForce(origin: Vector3, radiusOrEventOptions: number | PhysicsRadialExplosionEventOptions, strength?: number, falloff?: PhysicsRadialImpulseFalloff): Nullable<PhysicsRadialExplosionEvent>;
  148053. /**
  148054. * Creates a gravitational field
  148055. * @param origin the origin of the explosion
  148056. * @param radiusOrEventOptions the radius or the options of radial explosion
  148057. * @param strength the explosion strength
  148058. * @param falloff possible options: Constant & Linear. Defaults to Constant
  148059. * @returns A physics gravitational field event, or null
  148060. */
  148061. gravitationalField(origin: Vector3, radiusOrEventOptions: number | PhysicsRadialExplosionEventOptions, strength?: number, falloff?: PhysicsRadialImpulseFalloff): Nullable<PhysicsGravitationalFieldEvent>;
  148062. /**
  148063. * Creates a physics updraft event
  148064. * @param origin the origin of the updraft
  148065. * @param radiusOrEventOptions the radius or the options of the updraft
  148066. * @param strength the strength of the updraft
  148067. * @param height the height of the updraft
  148068. * @param updraftMode possible options: Center & Perpendicular. Defaults to Center
  148069. * @returns A physics updraft event, or null
  148070. */
  148071. updraft(origin: Vector3, radiusOrEventOptions: number | PhysicsUpdraftEventOptions, strength?: number, height?: number, updraftMode?: PhysicsUpdraftMode): Nullable<PhysicsUpdraftEvent>;
  148072. /**
  148073. * Creates a physics vortex event
  148074. * @param origin the of the vortex
  148075. * @param radiusOrEventOptions the radius or the options of the vortex
  148076. * @param strength the strength of the vortex
  148077. * @param height the height of the vortex
  148078. * @returns a Physics vortex event, or null
  148079. * A physics vortex event or null
  148080. */
  148081. vortex(origin: Vector3, radiusOrEventOptions: number | PhysicsVortexEventOptions, strength?: number, height?: number): Nullable<PhysicsVortexEvent>;
  148082. }
  148083. /**
  148084. * Represents a physics radial explosion event
  148085. */
  148086. class PhysicsRadialExplosionEvent {
  148087. private _scene;
  148088. private _options;
  148089. private _sphere;
  148090. private _dataFetched;
  148091. /**
  148092. * Initializes a radial explosioin event
  148093. * @param _scene BabylonJS scene
  148094. * @param _options The options for the vortex event
  148095. */
  148096. constructor(_scene: Scene, _options: PhysicsRadialExplosionEventOptions);
  148097. /**
  148098. * Returns the data related to the radial explosion event (sphere).
  148099. * @returns The radial explosion event data
  148100. */
  148101. getData(): PhysicsRadialExplosionEventData;
  148102. /**
  148103. * Returns the force and contact point of the impostor or false, if the impostor is not affected by the force/impulse.
  148104. * @param impostor A physics imposter
  148105. * @param origin the origin of the explosion
  148106. * @returns {Nullable<PhysicsHitData>} A physics force and contact point, or null
  148107. */
  148108. getImpostorHitData(impostor: PhysicsImpostor, origin: Vector3): Nullable<PhysicsHitData>;
  148109. /**
  148110. * Triggers affecterd impostors callbacks
  148111. * @param affectedImpostorsWithData defines the list of affected impostors (including associated data)
  148112. */
  148113. triggerAffectedImpostorsCallback(affectedImpostorsWithData: Array<PhysicsAffectedImpostorWithData>): void;
  148114. /**
  148115. * Disposes the sphere.
  148116. * @param force Specifies if the sphere should be disposed by force
  148117. */
  148118. dispose(force?: boolean): void;
  148119. /*** Helpers ***/
  148120. private _prepareSphere;
  148121. private _intersectsWithSphere;
  148122. }
  148123. /**
  148124. * Represents a gravitational field event
  148125. */
  148126. class PhysicsGravitationalFieldEvent {
  148127. private _physicsHelper;
  148128. private _scene;
  148129. private _origin;
  148130. private _options;
  148131. private _tickCallback;
  148132. private _sphere;
  148133. private _dataFetched;
  148134. /**
  148135. * Initializes the physics gravitational field event
  148136. * @param _physicsHelper A physics helper
  148137. * @param _scene BabylonJS scene
  148138. * @param _origin The origin position of the gravitational field event
  148139. * @param _options The options for the vortex event
  148140. */
  148141. constructor(_physicsHelper: PhysicsHelper, _scene: Scene, _origin: Vector3, _options: PhysicsRadialExplosionEventOptions);
  148142. /**
  148143. * Returns the data related to the gravitational field event (sphere).
  148144. * @returns A gravitational field event
  148145. */
  148146. getData(): PhysicsGravitationalFieldEventData;
  148147. /**
  148148. * Enables the gravitational field.
  148149. */
  148150. enable(): void;
  148151. /**
  148152. * Disables the gravitational field.
  148153. */
  148154. disable(): void;
  148155. /**
  148156. * Disposes the sphere.
  148157. * @param force The force to dispose from the gravitational field event
  148158. */
  148159. dispose(force?: boolean): void;
  148160. private _tick;
  148161. }
  148162. /**
  148163. * Represents a physics updraft event
  148164. */
  148165. class PhysicsUpdraftEvent {
  148166. private _scene;
  148167. private _origin;
  148168. private _options;
  148169. private _physicsEngine;
  148170. private _originTop;
  148171. private _originDirection;
  148172. private _tickCallback;
  148173. private _cylinder;
  148174. private _cylinderPosition;
  148175. private _dataFetched;
  148176. /**
  148177. * Initializes the physics updraft event
  148178. * @param _scene BabylonJS scene
  148179. * @param _origin The origin position of the updraft
  148180. * @param _options The options for the updraft event
  148181. */
  148182. constructor(_scene: Scene, _origin: Vector3, _options: PhysicsUpdraftEventOptions);
  148183. /**
  148184. * Returns the data related to the updraft event (cylinder).
  148185. * @returns A physics updraft event
  148186. */
  148187. getData(): PhysicsUpdraftEventData;
  148188. /**
  148189. * Enables the updraft.
  148190. */
  148191. enable(): void;
  148192. /**
  148193. * Disables the updraft.
  148194. */
  148195. disable(): void;
  148196. /**
  148197. * Disposes the cylinder.
  148198. * @param force Specifies if the updraft should be disposed by force
  148199. */
  148200. dispose(force?: boolean): void;
  148201. private getImpostorHitData;
  148202. private _tick;
  148203. /*** Helpers ***/
  148204. private _prepareCylinder;
  148205. private _intersectsWithCylinder;
  148206. }
  148207. /**
  148208. * Represents a physics vortex event
  148209. */
  148210. class PhysicsVortexEvent {
  148211. private _scene;
  148212. private _origin;
  148213. private _options;
  148214. private _physicsEngine;
  148215. private _originTop;
  148216. private _tickCallback;
  148217. private _cylinder;
  148218. private _cylinderPosition;
  148219. private _dataFetched;
  148220. /**
  148221. * Initializes the physics vortex event
  148222. * @param _scene The BabylonJS scene
  148223. * @param _origin The origin position of the vortex
  148224. * @param _options The options for the vortex event
  148225. */
  148226. constructor(_scene: Scene, _origin: Vector3, _options: PhysicsVortexEventOptions);
  148227. /**
  148228. * Returns the data related to the vortex event (cylinder).
  148229. * @returns The physics vortex event data
  148230. */
  148231. getData(): PhysicsVortexEventData;
  148232. /**
  148233. * Enables the vortex.
  148234. */
  148235. enable(): void;
  148236. /**
  148237. * Disables the cortex.
  148238. */
  148239. disable(): void;
  148240. /**
  148241. * Disposes the sphere.
  148242. * @param force
  148243. */
  148244. dispose(force?: boolean): void;
  148245. private getImpostorHitData;
  148246. private _tick;
  148247. /*** Helpers ***/
  148248. private _prepareCylinder;
  148249. private _intersectsWithCylinder;
  148250. }
  148251. /**
  148252. * Options fot the radial explosion event
  148253. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine#further-functionality-of-the-impostor-class
  148254. */
  148255. export class PhysicsRadialExplosionEventOptions {
  148256. /**
  148257. * The radius of the sphere for the radial explosion.
  148258. */
  148259. radius: number;
  148260. /**
  148261. * The strenth of the explosion.
  148262. */
  148263. strength: number;
  148264. /**
  148265. * The strenght of the force in correspondence to the distance of the affected object
  148266. */
  148267. falloff: PhysicsRadialImpulseFalloff;
  148268. /**
  148269. * Sphere options for the radial explosion.
  148270. */
  148271. sphere: {
  148272. segments: number;
  148273. diameter: number;
  148274. };
  148275. /**
  148276. * Sphere options for the radial explosion.
  148277. */
  148278. affectedImpostorsCallback: (affectedImpostorsWithData: Array<PhysicsAffectedImpostorWithData>) => void;
  148279. }
  148280. /**
  148281. * Options fot the updraft event
  148282. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine#further-functionality-of-the-impostor-class
  148283. */
  148284. export class PhysicsUpdraftEventOptions {
  148285. /**
  148286. * The radius of the cylinder for the vortex
  148287. */
  148288. radius: number;
  148289. /**
  148290. * The strenth of the updraft.
  148291. */
  148292. strength: number;
  148293. /**
  148294. * The height of the cylinder for the updraft.
  148295. */
  148296. height: number;
  148297. /**
  148298. * The mode for the the updraft.
  148299. */
  148300. updraftMode: PhysicsUpdraftMode;
  148301. }
  148302. /**
  148303. * Options fot the vortex event
  148304. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine#further-functionality-of-the-impostor-class
  148305. */
  148306. export class PhysicsVortexEventOptions {
  148307. /**
  148308. * The radius of the cylinder for the vortex
  148309. */
  148310. radius: number;
  148311. /**
  148312. * The strenth of the vortex.
  148313. */
  148314. strength: number;
  148315. /**
  148316. * The height of the cylinder for the vortex.
  148317. */
  148318. height: number;
  148319. /**
  148320. * At which distance, relative to the radius the centripetal forces should kick in? Range: 0-1
  148321. */
  148322. centripetalForceThreshold: number;
  148323. /**
  148324. * This multiplier determines with how much force the objects will be pushed sideways/around the vortex, when below the treshold.
  148325. */
  148326. centripetalForceMultiplier: number;
  148327. /**
  148328. * This multiplier determines with how much force the objects will be pushed sideways/around the vortex, when above the treshold.
  148329. */
  148330. centrifugalForceMultiplier: number;
  148331. /**
  148332. * This multiplier determines with how much force the objects will be pushed upwards, when in the vortex.
  148333. */
  148334. updraftForceMultiplier: number;
  148335. }
  148336. /**
  148337. * The strenght of the force in correspondence to the distance of the affected object
  148338. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine#further-functionality-of-the-impostor-class
  148339. */
  148340. export enum PhysicsRadialImpulseFalloff {
  148341. /** Defines that impulse is constant in strength across it's whole radius */
  148342. Constant = 0,
  148343. /** Defines that impulse gets weaker if it's further from the origin */
  148344. Linear = 1
  148345. }
  148346. /**
  148347. * The strength of the force in correspondence to the distance of the affected object
  148348. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine#further-functionality-of-the-impostor-class
  148349. */
  148350. export enum PhysicsUpdraftMode {
  148351. /** Defines that the upstream forces will pull towards the top center of the cylinder */
  148352. Center = 0,
  148353. /** Defines that once a impostor is inside the cylinder, it will shoot out perpendicular from the ground of the cylinder */
  148354. Perpendicular = 1
  148355. }
  148356. /**
  148357. * Interface for a physics hit data
  148358. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine#further-functionality-of-the-impostor-class
  148359. */
  148360. export interface PhysicsHitData {
  148361. /**
  148362. * The force applied at the contact point
  148363. */
  148364. force: Vector3;
  148365. /**
  148366. * The contact point
  148367. */
  148368. contactPoint: Vector3;
  148369. /**
  148370. * The distance from the origin to the contact point
  148371. */
  148372. distanceFromOrigin: number;
  148373. }
  148374. /**
  148375. * Interface for radial explosion event data
  148376. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine#further-functionality-of-the-impostor-class
  148377. */
  148378. export interface PhysicsRadialExplosionEventData {
  148379. /**
  148380. * A sphere used for the radial explosion event
  148381. */
  148382. sphere: Mesh;
  148383. }
  148384. /**
  148385. * Interface for gravitational field event data
  148386. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine#further-functionality-of-the-impostor-class
  148387. */
  148388. export interface PhysicsGravitationalFieldEventData {
  148389. /**
  148390. * A sphere mesh used for the gravitational field event
  148391. */
  148392. sphere: Mesh;
  148393. }
  148394. /**
  148395. * Interface for updraft event data
  148396. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine#further-functionality-of-the-impostor-class
  148397. */
  148398. export interface PhysicsUpdraftEventData {
  148399. /**
  148400. * A cylinder used for the updraft event
  148401. */
  148402. cylinder: Mesh;
  148403. }
  148404. /**
  148405. * Interface for vortex event data
  148406. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine#further-functionality-of-the-impostor-class
  148407. */
  148408. export interface PhysicsVortexEventData {
  148409. /**
  148410. * A cylinder used for the vortex event
  148411. */
  148412. cylinder: Mesh;
  148413. }
  148414. /**
  148415. * Interface for an affected physics impostor
  148416. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine#further-functionality-of-the-impostor-class
  148417. */
  148418. export interface PhysicsAffectedImpostorWithData {
  148419. /**
  148420. * The impostor affected by the effect
  148421. */
  148422. impostor: PhysicsImpostor;
  148423. /**
  148424. * The data about the hit/horce from the explosion
  148425. */
  148426. hitData: PhysicsHitData;
  148427. }
  148428. }
  148429. declare module BABYLON {
  148430. /** @hidden */
  148431. export var blackAndWhitePixelShader: {
  148432. name: string;
  148433. shader: string;
  148434. };
  148435. }
  148436. declare module BABYLON {
  148437. /**
  148438. * Post process used to render in black and white
  148439. */
  148440. export class BlackAndWhitePostProcess extends PostProcess {
  148441. /**
  148442. * Linear about to convert he result to black and white (default: 1)
  148443. */
  148444. degree: number;
  148445. /**
  148446. * Gets a string identifying the name of the class
  148447. * @returns "BlackAndWhitePostProcess" string
  148448. */
  148449. getClassName(): string;
  148450. /**
  148451. * Creates a black and white post process
  148452. * @see https://doc.babylonjs.com/how_to/how_to_use_postprocesses#black-and-white
  148453. * @param name The name of the effect.
  148454. * @param options The required width/height ratio to downsize to before computing the render pass.
  148455. * @param camera The camera to apply the render pass to.
  148456. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  148457. * @param engine The engine which the post process will be applied. (default: current engine)
  148458. * @param reusable If the post process can be reused on the same frame. (default: false)
  148459. */
  148460. constructor(name: string, options: number | PostProcessOptions, camera: Camera, samplingMode?: number, engine?: Engine, reusable?: boolean);
  148461. /** @hidden */
  148462. static _Parse(parsedPostProcess: any, targetCamera: Camera, scene: Scene, rootUrl: string): Nullable<BlackAndWhitePostProcess>;
  148463. }
  148464. }
  148465. declare module BABYLON {
  148466. /**
  148467. * This represents a set of one or more post processes in Babylon.
  148468. * A post process can be used to apply a shader to a texture after it is rendered.
  148469. * @example https://doc.babylonjs.com/how_to/how_to_use_postprocessrenderpipeline
  148470. */
  148471. export class PostProcessRenderEffect {
  148472. private _postProcesses;
  148473. private _getPostProcesses;
  148474. private _singleInstance;
  148475. private _cameras;
  148476. private _indicesForCamera;
  148477. /**
  148478. * Name of the effect
  148479. * @hidden
  148480. */
  148481. _name: string;
  148482. /**
  148483. * Instantiates a post process render effect.
  148484. * A post process can be used to apply a shader to a texture after it is rendered.
  148485. * @param engine The engine the effect is tied to
  148486. * @param name The name of the effect
  148487. * @param getPostProcesses A function that returns a set of post processes which the effect will run in order to be run.
  148488. * @param singleInstance False if this post process can be run on multiple cameras. (default: true)
  148489. */
  148490. constructor(engine: Engine, name: string, getPostProcesses: () => Nullable<PostProcess | Array<PostProcess>>, singleInstance?: boolean);
  148491. /**
  148492. * Checks if all the post processes in the effect are supported.
  148493. */
  148494. get isSupported(): boolean;
  148495. /**
  148496. * Updates the current state of the effect
  148497. * @hidden
  148498. */
  148499. _update(): void;
  148500. /**
  148501. * Attaches the effect on cameras
  148502. * @param cameras The camera to attach to.
  148503. * @hidden
  148504. */
  148505. _attachCameras(cameras: Camera): void;
  148506. /**
  148507. * Attaches the effect on cameras
  148508. * @param cameras The camera to attach to.
  148509. * @hidden
  148510. */
  148511. _attachCameras(cameras: Camera[]): void;
  148512. /**
  148513. * Detaches the effect on cameras
  148514. * @param cameras The camera to detatch from.
  148515. * @hidden
  148516. */
  148517. _detachCameras(cameras: Camera): void;
  148518. /**
  148519. * Detatches the effect on cameras
  148520. * @param cameras The camera to detatch from.
  148521. * @hidden
  148522. */
  148523. _detachCameras(cameras: Camera[]): void;
  148524. /**
  148525. * Enables the effect on given cameras
  148526. * @param cameras The camera to enable.
  148527. * @hidden
  148528. */
  148529. _enable(cameras: Camera): void;
  148530. /**
  148531. * Enables the effect on given cameras
  148532. * @param cameras The camera to enable.
  148533. * @hidden
  148534. */
  148535. _enable(cameras: Nullable<Camera[]>): void;
  148536. /**
  148537. * Disables the effect on the given cameras
  148538. * @param cameras The camera to disable.
  148539. * @hidden
  148540. */
  148541. _disable(cameras: Camera): void;
  148542. /**
  148543. * Disables the effect on the given cameras
  148544. * @param cameras The camera to disable.
  148545. * @hidden
  148546. */
  148547. _disable(cameras: Nullable<Camera[]>): void;
  148548. /**
  148549. * Gets a list of the post processes contained in the effect.
  148550. * @param camera The camera to get the post processes on.
  148551. * @returns The list of the post processes in the effect.
  148552. */
  148553. getPostProcesses(camera?: Camera): Nullable<Array<PostProcess>>;
  148554. }
  148555. }
  148556. declare module BABYLON {
  148557. /** @hidden */
  148558. export var extractHighlightsPixelShader: {
  148559. name: string;
  148560. shader: string;
  148561. };
  148562. }
  148563. declare module BABYLON {
  148564. /**
  148565. * 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.
  148566. */
  148567. export class ExtractHighlightsPostProcess extends PostProcess {
  148568. /**
  148569. * The luminance threshold, pixels below this value will be set to black.
  148570. */
  148571. threshold: number;
  148572. /** @hidden */
  148573. _exposure: number;
  148574. /**
  148575. * Post process which has the input texture to be used when performing highlight extraction
  148576. * @hidden
  148577. */
  148578. _inputPostProcess: Nullable<PostProcess>;
  148579. /**
  148580. * Gets a string identifying the name of the class
  148581. * @returns "ExtractHighlightsPostProcess" string
  148582. */
  148583. getClassName(): string;
  148584. constructor(name: string, options: number | PostProcessOptions, camera: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number, blockCompilation?: boolean);
  148585. }
  148586. }
  148587. declare module BABYLON {
  148588. /** @hidden */
  148589. export var bloomMergePixelShader: {
  148590. name: string;
  148591. shader: string;
  148592. };
  148593. }
  148594. declare module BABYLON {
  148595. /**
  148596. * The BloomMergePostProcess merges blurred images with the original based on the values of the circle of confusion.
  148597. */
  148598. export class BloomMergePostProcess extends PostProcess {
  148599. /** Weight of the bloom to be added to the original input. */
  148600. weight: number;
  148601. /**
  148602. * Gets a string identifying the name of the class
  148603. * @returns "BloomMergePostProcess" string
  148604. */
  148605. getClassName(): string;
  148606. /**
  148607. * Creates a new instance of @see BloomMergePostProcess
  148608. * @param name The name of the effect.
  148609. * @param originalFromInput Post process which's input will be used for the merge.
  148610. * @param blurred Blurred highlights post process which's output will be used.
  148611. * @param weight Weight of the bloom to be added to the original input.
  148612. * @param options The required width/height ratio to downsize to before computing the render pass.
  148613. * @param camera The camera to apply the render pass to.
  148614. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  148615. * @param engine The engine which the post process will be applied. (default: current engine)
  148616. * @param reusable If the post process can be reused on the same frame. (default: false)
  148617. * @param textureType Type of textures used when performing the post process. (default: 0)
  148618. * @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)
  148619. */
  148620. constructor(name: string, originalFromInput: PostProcess, blurred: PostProcess,
  148621. /** Weight of the bloom to be added to the original input. */
  148622. weight: number, options: number | PostProcessOptions, camera: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number, blockCompilation?: boolean);
  148623. }
  148624. }
  148625. declare module BABYLON {
  148626. /**
  148627. * The bloom effect spreads bright areas of an image to simulate artifacts seen in cameras
  148628. */
  148629. export class BloomEffect extends PostProcessRenderEffect {
  148630. private bloomScale;
  148631. /**
  148632. * @hidden Internal
  148633. */
  148634. _effects: Array<PostProcess>;
  148635. /**
  148636. * @hidden Internal
  148637. */
  148638. _downscale: ExtractHighlightsPostProcess;
  148639. private _blurX;
  148640. private _blurY;
  148641. private _merge;
  148642. /**
  148643. * The luminance threshold to find bright areas of the image to bloom.
  148644. */
  148645. get threshold(): number;
  148646. set threshold(value: number);
  148647. /**
  148648. * The strength of the bloom.
  148649. */
  148650. get weight(): number;
  148651. set weight(value: number);
  148652. /**
  148653. * Specifies the size of the bloom blur kernel, relative to the final output size
  148654. */
  148655. get kernel(): number;
  148656. set kernel(value: number);
  148657. /**
  148658. * Creates a new instance of @see BloomEffect
  148659. * @param scene The scene the effect belongs to.
  148660. * @param bloomScale The ratio of the blur texture to the input texture that should be used to compute the bloom.
  148661. * @param bloomKernel The size of the kernel to be used when applying the blur.
  148662. * @param bloomWeight The the strength of bloom.
  148663. * @param pipelineTextureType The type of texture to be used when performing the post processing.
  148664. * @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)
  148665. */
  148666. constructor(scene: Scene, bloomScale: number, bloomWeight: number, bloomKernel: number, pipelineTextureType?: number, blockCompilation?: boolean);
  148667. /**
  148668. * Disposes each of the internal effects for a given camera.
  148669. * @param camera The camera to dispose the effect on.
  148670. */
  148671. disposeEffects(camera: Camera): void;
  148672. /**
  148673. * @hidden Internal
  148674. */
  148675. _updateEffects(): void;
  148676. /**
  148677. * Internal
  148678. * @returns if all the contained post processes are ready.
  148679. * @hidden
  148680. */
  148681. _isReady(): boolean;
  148682. }
  148683. }
  148684. declare module BABYLON {
  148685. /** @hidden */
  148686. export var chromaticAberrationPixelShader: {
  148687. name: string;
  148688. shader: string;
  148689. };
  148690. }
  148691. declare module BABYLON {
  148692. /**
  148693. * The ChromaticAberrationPostProcess separates the rgb channels in an image to produce chromatic distortion around the edges of the screen
  148694. */
  148695. export class ChromaticAberrationPostProcess extends PostProcess {
  148696. /**
  148697. * The amount of seperation of rgb channels (default: 30)
  148698. */
  148699. aberrationAmount: number;
  148700. /**
  148701. * The amount the effect will increase for pixels closer to the edge of the screen. (default: 0)
  148702. */
  148703. radialIntensity: number;
  148704. /**
  148705. * 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))
  148706. */
  148707. direction: Vector2;
  148708. /**
  148709. * 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))
  148710. */
  148711. centerPosition: Vector2;
  148712. /** The width of the screen to apply the effect on */
  148713. screenWidth: number;
  148714. /** The height of the screen to apply the effect on */
  148715. screenHeight: number;
  148716. /**
  148717. * Gets a string identifying the name of the class
  148718. * @returns "ChromaticAberrationPostProcess" string
  148719. */
  148720. getClassName(): string;
  148721. /**
  148722. * Creates a new instance ChromaticAberrationPostProcess
  148723. * @param name The name of the effect.
  148724. * @param screenWidth The width of the screen to apply the effect on.
  148725. * @param screenHeight The height of the screen to apply the effect on.
  148726. * @param options The required width/height ratio to downsize to before computing the render pass.
  148727. * @param camera The camera to apply the render pass to.
  148728. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  148729. * @param engine The engine which the post process will be applied. (default: current engine)
  148730. * @param reusable If the post process can be reused on the same frame. (default: false)
  148731. * @param textureType Type of textures used when performing the post process. (default: 0)
  148732. * @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)
  148733. */
  148734. constructor(name: string, screenWidth: number, screenHeight: number, options: number | PostProcessOptions, camera: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number, blockCompilation?: boolean);
  148735. /** @hidden */
  148736. static _Parse(parsedPostProcess: any, targetCamera: Camera, scene: Scene, rootUrl: string): Nullable<ChromaticAberrationPostProcess>;
  148737. }
  148738. }
  148739. declare module BABYLON {
  148740. /** @hidden */
  148741. export var circleOfConfusionPixelShader: {
  148742. name: string;
  148743. shader: string;
  148744. };
  148745. }
  148746. declare module BABYLON {
  148747. /**
  148748. * The CircleOfConfusionPostProcess computes the circle of confusion value for each pixel given required lens parameters. See https://en.wikipedia.org/wiki/Circle_of_confusion
  148749. */
  148750. export class CircleOfConfusionPostProcess extends PostProcess {
  148751. /**
  148752. * 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.
  148753. */
  148754. lensSize: number;
  148755. /**
  148756. * F-Stop of the effect's camera. The diamater of the resulting aperture can be computed by lensSize/fStop. (default: 1.4)
  148757. */
  148758. fStop: number;
  148759. /**
  148760. * Distance away from the camera to focus on in scene units/1000 (eg. millimeter). (default: 2000)
  148761. */
  148762. focusDistance: number;
  148763. /**
  148764. * Focal length of the effect's camera in scene units/1000 (eg. millimeter). (default: 50)
  148765. */
  148766. focalLength: number;
  148767. /**
  148768. * Gets a string identifying the name of the class
  148769. * @returns "CircleOfConfusionPostProcess" string
  148770. */
  148771. getClassName(): string;
  148772. private _depthTexture;
  148773. /**
  148774. * Creates a new instance CircleOfConfusionPostProcess
  148775. * @param name The name of the effect.
  148776. * @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.
  148777. * @param options The required width/height ratio to downsize to before computing the render pass.
  148778. * @param camera The camera to apply the render pass to.
  148779. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  148780. * @param engine The engine which the post process will be applied. (default: current engine)
  148781. * @param reusable If the post process can be reused on the same frame. (default: false)
  148782. * @param textureType Type of textures used when performing the post process. (default: 0)
  148783. * @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)
  148784. */
  148785. constructor(name: string, depthTexture: Nullable<RenderTargetTexture>, options: number | PostProcessOptions, camera: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number, blockCompilation?: boolean);
  148786. /**
  148787. * 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.
  148788. */
  148789. set depthTexture(value: RenderTargetTexture);
  148790. }
  148791. }
  148792. declare module BABYLON {
  148793. /** @hidden */
  148794. export var colorCorrectionPixelShader: {
  148795. name: string;
  148796. shader: string;
  148797. };
  148798. }
  148799. declare module BABYLON {
  148800. /**
  148801. *
  148802. * This post-process allows the modification of rendered colors by using
  148803. * a 'look-up table' (LUT). This effect is also called Color Grading.
  148804. *
  148805. * The object needs to be provided an url to a texture containing the color
  148806. * look-up table: the texture must be 256 pixels wide and 16 pixels high.
  148807. * Use an image editing software to tweak the LUT to match your needs.
  148808. *
  148809. * For an example of a color LUT, see here:
  148810. * @see http://udn.epicgames.com/Three/rsrc/Three/ColorGrading/RGBTable16x1.png
  148811. * For explanations on color grading, see here:
  148812. * @see http://udn.epicgames.com/Three/ColorGrading.html
  148813. *
  148814. */
  148815. export class ColorCorrectionPostProcess extends PostProcess {
  148816. private _colorTableTexture;
  148817. /**
  148818. * Gets the color table url used to create the LUT texture
  148819. */
  148820. colorTableUrl: string;
  148821. /**
  148822. * Gets a string identifying the name of the class
  148823. * @returns "ColorCorrectionPostProcess" string
  148824. */
  148825. getClassName(): string;
  148826. constructor(name: string, colorTableUrl: string, options: number | PostProcessOptions, camera: Camera, samplingMode?: number, engine?: Engine, reusable?: boolean);
  148827. /** @hidden */
  148828. static _Parse(parsedPostProcess: any, targetCamera: Camera, scene: Scene, rootUrl: string): Nullable<ColorCorrectionPostProcess>;
  148829. }
  148830. }
  148831. declare module BABYLON {
  148832. /** @hidden */
  148833. export var convolutionPixelShader: {
  148834. name: string;
  148835. shader: string;
  148836. };
  148837. }
  148838. declare module BABYLON {
  148839. /**
  148840. * The ConvolutionPostProcess applies a 3x3 kernel to every pixel of the
  148841. * input texture to perform effects such as edge detection or sharpening
  148842. * See http://en.wikipedia.org/wiki/Kernel_(image_processing)
  148843. */
  148844. export class ConvolutionPostProcess extends PostProcess {
  148845. /** Array of 9 values corresponding to the 3x3 kernel to be applied */
  148846. kernel: number[];
  148847. /**
  148848. * Gets a string identifying the name of the class
  148849. * @returns "ConvolutionPostProcess" string
  148850. */
  148851. getClassName(): string;
  148852. /**
  148853. * Creates a new instance ConvolutionPostProcess
  148854. * @param name The name of the effect.
  148855. * @param kernel Array of 9 values corresponding to the 3x3 kernel to be applied
  148856. * @param options The required width/height ratio to downsize to before computing the render pass.
  148857. * @param camera The camera to apply the render pass to.
  148858. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  148859. * @param engine The engine which the post process will be applied. (default: current engine)
  148860. * @param reusable If the post process can be reused on the same frame. (default: false)
  148861. * @param textureType Type of textures used when performing the post process. (default: 0)
  148862. */
  148863. constructor(name: string, kernel: number[], options: number | PostProcessOptions, camera: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number);
  148864. /** @hidden */
  148865. static _Parse(parsedPostProcess: any, targetCamera: Camera, scene: Scene, rootUrl: string): Nullable<ConvolutionPostProcess>;
  148866. /**
  148867. * Edge detection 0 see https://en.wikipedia.org/wiki/Kernel_(image_processing)
  148868. */
  148869. static EdgeDetect0Kernel: number[];
  148870. /**
  148871. * Edge detection 1 see https://en.wikipedia.org/wiki/Kernel_(image_processing)
  148872. */
  148873. static EdgeDetect1Kernel: number[];
  148874. /**
  148875. * Edge detection 2 see https://en.wikipedia.org/wiki/Kernel_(image_processing)
  148876. */
  148877. static EdgeDetect2Kernel: number[];
  148878. /**
  148879. * Kernel to sharpen an image see https://en.wikipedia.org/wiki/Kernel_(image_processing)
  148880. */
  148881. static SharpenKernel: number[];
  148882. /**
  148883. * Kernel to emboss an image see https://en.wikipedia.org/wiki/Kernel_(image_processing)
  148884. */
  148885. static EmbossKernel: number[];
  148886. /**
  148887. * Kernel to blur an image see https://en.wikipedia.org/wiki/Kernel_(image_processing)
  148888. */
  148889. static GaussianKernel: number[];
  148890. }
  148891. }
  148892. declare module BABYLON {
  148893. /**
  148894. * The DepthOfFieldBlurPostProcess applied a blur in a give direction.
  148895. * This blur differs from the standard BlurPostProcess as it attempts to avoid blurring pixels
  148896. * based on samples that have a large difference in distance than the center pixel.
  148897. * See section 2.6.2 http://fileadmin.cs.lth.se/cs/education/edan35/lectures/12dof.pdf
  148898. */
  148899. export class DepthOfFieldBlurPostProcess extends BlurPostProcess {
  148900. /**
  148901. * The direction the blur should be applied
  148902. */
  148903. direction: Vector2;
  148904. /**
  148905. * Gets a string identifying the name of the class
  148906. * @returns "DepthOfFieldBlurPostProcess" string
  148907. */
  148908. getClassName(): string;
  148909. /**
  148910. * Creates a new instance CircleOfConfusionPostProcess
  148911. * @param name The name of the effect.
  148912. * @param scene The scene the effect belongs to.
  148913. * @param direction The direction the blur should be applied.
  148914. * @param kernel The size of the kernel used to blur.
  148915. * @param options The required width/height ratio to downsize to before computing the render pass.
  148916. * @param camera The camera to apply the render pass to.
  148917. * @param circleOfConfusion The circle of confusion + depth map to be used to avoid blurring accross edges
  148918. * @param imageToBlur The image to apply the blur to (default: Current rendered frame)
  148919. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  148920. * @param engine The engine which the post process will be applied. (default: current engine)
  148921. * @param reusable If the post process can be reused on the same frame. (default: false)
  148922. * @param textureType Type of textures used when performing the post process. (default: 0)
  148923. * @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)
  148924. */
  148925. 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);
  148926. }
  148927. }
  148928. declare module BABYLON {
  148929. /** @hidden */
  148930. export var depthOfFieldMergePixelShader: {
  148931. name: string;
  148932. shader: string;
  148933. };
  148934. }
  148935. declare module BABYLON {
  148936. /**
  148937. * Options to be set when merging outputs from the default pipeline.
  148938. */
  148939. export class DepthOfFieldMergePostProcessOptions {
  148940. /**
  148941. * The original image to merge on top of
  148942. */
  148943. originalFromInput: PostProcess;
  148944. /**
  148945. * Parameters to perform the merge of the depth of field effect
  148946. */
  148947. depthOfField?: {
  148948. circleOfConfusion: PostProcess;
  148949. blurSteps: Array<PostProcess>;
  148950. };
  148951. /**
  148952. * Parameters to perform the merge of bloom effect
  148953. */
  148954. bloom?: {
  148955. blurred: PostProcess;
  148956. weight: number;
  148957. };
  148958. }
  148959. /**
  148960. * The DepthOfFieldMergePostProcess merges blurred images with the original based on the values of the circle of confusion.
  148961. */
  148962. export class DepthOfFieldMergePostProcess extends PostProcess {
  148963. private blurSteps;
  148964. /**
  148965. * Gets a string identifying the name of the class
  148966. * @returns "DepthOfFieldMergePostProcess" string
  148967. */
  148968. getClassName(): string;
  148969. /**
  148970. * Creates a new instance of DepthOfFieldMergePostProcess
  148971. * @param name The name of the effect.
  148972. * @param originalFromInput Post process which's input will be used for the merge.
  148973. * @param circleOfConfusion Circle of confusion post process which's output will be used to blur each pixel.
  148974. * @param blurSteps Blur post processes from low to high which will be mixed with the original image.
  148975. * @param options The required width/height ratio to downsize to before computing the render pass.
  148976. * @param camera The camera to apply the render pass to.
  148977. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  148978. * @param engine The engine which the post process will be applied. (default: current engine)
  148979. * @param reusable If the post process can be reused on the same frame. (default: false)
  148980. * @param textureType Type of textures used when performing the post process. (default: 0)
  148981. * @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)
  148982. */
  148983. 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);
  148984. /**
  148985. * Updates the effect with the current post process compile time values and recompiles the shader.
  148986. * @param defines Define statements that should be added at the beginning of the shader. (default: null)
  148987. * @param uniforms Set of uniform variables that will be passed to the shader. (default: null)
  148988. * @param samplers Set of Texture2D variables that will be passed to the shader. (default: null)
  148989. * @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
  148990. * @param onCompiled Called when the shader has been compiled.
  148991. * @param onError Called if there is an error when compiling a shader.
  148992. */
  148993. updateEffect(defines?: Nullable<string>, uniforms?: Nullable<string[]>, samplers?: Nullable<string[]>, indexParameters?: any, onCompiled?: (effect: Effect) => void, onError?: (effect: Effect, errors: string) => void): void;
  148994. }
  148995. }
  148996. declare module BABYLON {
  148997. /**
  148998. * Specifies the level of max blur that should be applied when using the depth of field effect
  148999. */
  149000. export enum DepthOfFieldEffectBlurLevel {
  149001. /**
  149002. * Subtle blur
  149003. */
  149004. Low = 0,
  149005. /**
  149006. * Medium blur
  149007. */
  149008. Medium = 1,
  149009. /**
  149010. * Large blur
  149011. */
  149012. High = 2
  149013. }
  149014. /**
  149015. * The depth of field effect applies a blur to objects that are closer or further from where the camera is focusing.
  149016. */
  149017. export class DepthOfFieldEffect extends PostProcessRenderEffect {
  149018. private _circleOfConfusion;
  149019. /**
  149020. * @hidden Internal, blurs from high to low
  149021. */
  149022. _depthOfFieldBlurX: Array<DepthOfFieldBlurPostProcess>;
  149023. private _depthOfFieldBlurY;
  149024. private _dofMerge;
  149025. /**
  149026. * @hidden Internal post processes in depth of field effect
  149027. */
  149028. _effects: Array<PostProcess>;
  149029. /**
  149030. * The focal the length of the camera used in the effect in scene units/1000 (eg. millimeter)
  149031. */
  149032. set focalLength(value: number);
  149033. get focalLength(): number;
  149034. /**
  149035. * F-Stop of the effect's camera. The diameter of the resulting aperture can be computed by lensSize/fStop. (default: 1.4)
  149036. */
  149037. set fStop(value: number);
  149038. get fStop(): number;
  149039. /**
  149040. * Distance away from the camera to focus on in scene units/1000 (eg. millimeter). (default: 2000)
  149041. */
  149042. set focusDistance(value: number);
  149043. get focusDistance(): number;
  149044. /**
  149045. * 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.
  149046. */
  149047. set lensSize(value: number);
  149048. get lensSize(): number;
  149049. /**
  149050. * Creates a new instance DepthOfFieldEffect
  149051. * @param scene The scene the effect belongs to.
  149052. * @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.
  149053. * @param pipelineTextureType The type of texture to be used when performing the post processing.
  149054. * @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)
  149055. */
  149056. constructor(scene: Scene, depthTexture: Nullable<RenderTargetTexture>, blurLevel?: DepthOfFieldEffectBlurLevel, pipelineTextureType?: number, blockCompilation?: boolean);
  149057. /**
  149058. * Get the current class name of the current effet
  149059. * @returns "DepthOfFieldEffect"
  149060. */
  149061. getClassName(): string;
  149062. /**
  149063. * 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.
  149064. */
  149065. set depthTexture(value: RenderTargetTexture);
  149066. /**
  149067. * Disposes each of the internal effects for a given camera.
  149068. * @param camera The camera to dispose the effect on.
  149069. */
  149070. disposeEffects(camera: Camera): void;
  149071. /**
  149072. * @hidden Internal
  149073. */
  149074. _updateEffects(): void;
  149075. /**
  149076. * Internal
  149077. * @returns if all the contained post processes are ready.
  149078. * @hidden
  149079. */
  149080. _isReady(): boolean;
  149081. }
  149082. }
  149083. declare module BABYLON {
  149084. /** @hidden */
  149085. export var displayPassPixelShader: {
  149086. name: string;
  149087. shader: string;
  149088. };
  149089. }
  149090. declare module BABYLON {
  149091. /**
  149092. * DisplayPassPostProcess which produces an output the same as it's input
  149093. */
  149094. export class DisplayPassPostProcess extends PostProcess {
  149095. /**
  149096. * Gets a string identifying the name of the class
  149097. * @returns "DisplayPassPostProcess" string
  149098. */
  149099. getClassName(): string;
  149100. /**
  149101. * Creates the DisplayPassPostProcess
  149102. * @param name The name of the effect.
  149103. * @param options The required width/height ratio to downsize to before computing the render pass.
  149104. * @param camera The camera to apply the render pass to.
  149105. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  149106. * @param engine The engine which the post process will be applied. (default: current engine)
  149107. * @param reusable If the post process can be reused on the same frame. (default: false)
  149108. */
  149109. constructor(name: string, options: number | PostProcessOptions, camera: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean);
  149110. /** @hidden */
  149111. static _Parse(parsedPostProcess: any, targetCamera: Camera, scene: Scene, rootUrl: string): Nullable<DisplayPassPostProcess>;
  149112. }
  149113. }
  149114. declare module BABYLON {
  149115. /** @hidden */
  149116. export var filterPixelShader: {
  149117. name: string;
  149118. shader: string;
  149119. };
  149120. }
  149121. declare module BABYLON {
  149122. /**
  149123. * Applies a kernel filter to the image
  149124. */
  149125. export class FilterPostProcess extends PostProcess {
  149126. /** The matrix to be applied to the image */
  149127. kernelMatrix: Matrix;
  149128. /**
  149129. * Gets a string identifying the name of the class
  149130. * @returns "FilterPostProcess" string
  149131. */
  149132. getClassName(): string;
  149133. /**
  149134. *
  149135. * @param name The name of the effect.
  149136. * @param kernelMatrix The matrix to be applied to the image
  149137. * @param options The required width/height ratio to downsize to before computing the render pass.
  149138. * @param camera The camera to apply the render pass to.
  149139. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  149140. * @param engine The engine which the post process will be applied. (default: current engine)
  149141. * @param reusable If the post process can be reused on the same frame. (default: false)
  149142. */
  149143. constructor(name: string, kernelMatrix: Matrix, options: number | PostProcessOptions, camera: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean);
  149144. /** @hidden */
  149145. static _Parse(parsedPostProcess: any, targetCamera: Camera, scene: Scene, rootUrl: string): Nullable<FilterPostProcess>;
  149146. }
  149147. }
  149148. declare module BABYLON {
  149149. /** @hidden */
  149150. export var fxaaPixelShader: {
  149151. name: string;
  149152. shader: string;
  149153. };
  149154. }
  149155. declare module BABYLON {
  149156. /** @hidden */
  149157. export var fxaaVertexShader: {
  149158. name: string;
  149159. shader: string;
  149160. };
  149161. }
  149162. declare module BABYLON {
  149163. /**
  149164. * Fxaa post process
  149165. * @see https://doc.babylonjs.com/how_to/how_to_use_postprocesses#fxaa
  149166. */
  149167. export class FxaaPostProcess extends PostProcess {
  149168. /**
  149169. * Gets a string identifying the name of the class
  149170. * @returns "FxaaPostProcess" string
  149171. */
  149172. getClassName(): string;
  149173. constructor(name: string, options: number | PostProcessOptions, camera?: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number);
  149174. private _getDefines;
  149175. /** @hidden */
  149176. static _Parse(parsedPostProcess: any, targetCamera: Camera, scene: Scene, rootUrl: string): FxaaPostProcess;
  149177. }
  149178. }
  149179. declare module BABYLON {
  149180. /** @hidden */
  149181. export var grainPixelShader: {
  149182. name: string;
  149183. shader: string;
  149184. };
  149185. }
  149186. declare module BABYLON {
  149187. /**
  149188. * The GrainPostProcess adds noise to the image at mid luminance levels
  149189. */
  149190. export class GrainPostProcess extends PostProcess {
  149191. /**
  149192. * The intensity of the grain added (default: 30)
  149193. */
  149194. intensity: number;
  149195. /**
  149196. * If the grain should be randomized on every frame
  149197. */
  149198. animated: boolean;
  149199. /**
  149200. * Gets a string identifying the name of the class
  149201. * @returns "GrainPostProcess" string
  149202. */
  149203. getClassName(): string;
  149204. /**
  149205. * Creates a new instance of @see GrainPostProcess
  149206. * @param name The name of the effect.
  149207. * @param options The required width/height ratio to downsize to before computing the render pass.
  149208. * @param camera The camera to apply the render pass to.
  149209. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  149210. * @param engine The engine which the post process will be applied. (default: current engine)
  149211. * @param reusable If the post process can be reused on the same frame. (default: false)
  149212. * @param textureType Type of textures used when performing the post process. (default: 0)
  149213. * @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)
  149214. */
  149215. constructor(name: string, options: number | PostProcessOptions, camera: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number, blockCompilation?: boolean);
  149216. /** @hidden */
  149217. static _Parse(parsedPostProcess: any, targetCamera: Camera, scene: Scene, rootUrl: string): GrainPostProcess;
  149218. }
  149219. }
  149220. declare module BABYLON {
  149221. /** @hidden */
  149222. export var highlightsPixelShader: {
  149223. name: string;
  149224. shader: string;
  149225. };
  149226. }
  149227. declare module BABYLON {
  149228. /**
  149229. * Extracts highlights from the image
  149230. * @see https://doc.babylonjs.com/how_to/how_to_use_postprocesses
  149231. */
  149232. export class HighlightsPostProcess extends PostProcess {
  149233. /**
  149234. * Gets a string identifying the name of the class
  149235. * @returns "HighlightsPostProcess" string
  149236. */
  149237. getClassName(): string;
  149238. /**
  149239. * Extracts highlights from the image
  149240. * @see https://doc.babylonjs.com/how_to/how_to_use_postprocesses
  149241. * @param name The name of the effect.
  149242. * @param options The required width/height ratio to downsize to before computing the render pass.
  149243. * @param camera The camera to apply the render pass to.
  149244. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  149245. * @param engine The engine which the post process will be applied. (default: current engine)
  149246. * @param reusable If the post process can be reused on the same frame. (default: false)
  149247. * @param textureType Type of texture for the post process (default: Engine.TEXTURETYPE_UNSIGNED_INT)
  149248. */
  149249. constructor(name: string, options: number | PostProcessOptions, camera: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number);
  149250. }
  149251. }
  149252. declare module BABYLON {
  149253. /** @hidden */
  149254. export var mrtFragmentDeclaration: {
  149255. name: string;
  149256. shader: string;
  149257. };
  149258. }
  149259. declare module BABYLON {
  149260. /** @hidden */
  149261. export var geometryPixelShader: {
  149262. name: string;
  149263. shader: string;
  149264. };
  149265. }
  149266. declare module BABYLON {
  149267. /** @hidden */
  149268. export var geometryVertexShader: {
  149269. name: string;
  149270. shader: string;
  149271. };
  149272. }
  149273. declare module BABYLON {
  149274. /** @hidden */
  149275. interface ISavedTransformationMatrix {
  149276. world: Matrix;
  149277. viewProjection: Matrix;
  149278. }
  149279. /**
  149280. * This renderer is helpfull to fill one of the render target with a geometry buffer.
  149281. */
  149282. export class GeometryBufferRenderer {
  149283. /**
  149284. * Constant used to retrieve the position texture index in the G-Buffer textures array
  149285. * using getIndex(GeometryBufferRenderer.POSITION_TEXTURE_INDEX)
  149286. */
  149287. static readonly POSITION_TEXTURE_TYPE: number;
  149288. /**
  149289. * Constant used to retrieve the velocity texture index in the G-Buffer textures array
  149290. * using getIndex(GeometryBufferRenderer.VELOCITY_TEXTURE_INDEX)
  149291. */
  149292. static readonly VELOCITY_TEXTURE_TYPE: number;
  149293. /**
  149294. * Constant used to retrieve the reflectivity texture index in the G-Buffer textures array
  149295. * using the getIndex(GeometryBufferRenderer.REFLECTIVITY_TEXTURE_TYPE)
  149296. */
  149297. static readonly REFLECTIVITY_TEXTURE_TYPE: number;
  149298. /**
  149299. * Dictionary used to store the previous transformation matrices of each rendered mesh
  149300. * in order to compute objects velocities when enableVelocity is set to "true"
  149301. * @hidden
  149302. */
  149303. _previousTransformationMatrices: {
  149304. [index: number]: ISavedTransformationMatrix;
  149305. };
  149306. /**
  149307. * Dictionary used to store the previous bones transformation matrices of each rendered mesh
  149308. * in order to compute objects velocities when enableVelocity is set to "true"
  149309. * @hidden
  149310. */
  149311. _previousBonesTransformationMatrices: {
  149312. [index: number]: Float32Array;
  149313. };
  149314. /**
  149315. * Array used to store the ignored skinned meshes while computing velocity map (typically used by the motion blur post-process).
  149316. * Avoids computing bones velocities and computes only mesh's velocity itself (position, rotation, scaling).
  149317. */
  149318. excludedSkinnedMeshesFromVelocity: AbstractMesh[];
  149319. /** Gets or sets a boolean indicating if transparent meshes should be rendered */
  149320. renderTransparentMeshes: boolean;
  149321. private _scene;
  149322. private _resizeObserver;
  149323. private _multiRenderTarget;
  149324. private _ratio;
  149325. private _enablePosition;
  149326. private _enableVelocity;
  149327. private _enableReflectivity;
  149328. private _positionIndex;
  149329. private _velocityIndex;
  149330. private _reflectivityIndex;
  149331. protected _effect: Effect;
  149332. protected _cachedDefines: string;
  149333. /**
  149334. * Set the render list (meshes to be rendered) used in the G buffer.
  149335. */
  149336. set renderList(meshes: Mesh[]);
  149337. /**
  149338. * Gets wether or not G buffer are supported by the running hardware.
  149339. * This requires draw buffer supports
  149340. */
  149341. get isSupported(): boolean;
  149342. /**
  149343. * Returns the index of the given texture type in the G-Buffer textures array
  149344. * @param textureType The texture type constant. For example GeometryBufferRenderer.POSITION_TEXTURE_INDEX
  149345. * @returns the index of the given texture type in the G-Buffer textures array
  149346. */
  149347. getTextureIndex(textureType: number): number;
  149348. /**
  149349. * Gets a boolean indicating if objects positions are enabled for the G buffer.
  149350. */
  149351. get enablePosition(): boolean;
  149352. /**
  149353. * Sets whether or not objects positions are enabled for the G buffer.
  149354. */
  149355. set enablePosition(enable: boolean);
  149356. /**
  149357. * Gets a boolean indicating if objects velocities are enabled for the G buffer.
  149358. */
  149359. get enableVelocity(): boolean;
  149360. /**
  149361. * Sets wether or not objects velocities are enabled for the G buffer.
  149362. */
  149363. set enableVelocity(enable: boolean);
  149364. /**
  149365. * Gets a boolean indicating if objects roughness are enabled in the G buffer.
  149366. */
  149367. get enableReflectivity(): boolean;
  149368. /**
  149369. * Sets wether or not objects roughness are enabled for the G buffer.
  149370. */
  149371. set enableReflectivity(enable: boolean);
  149372. /**
  149373. * Gets the scene associated with the buffer.
  149374. */
  149375. get scene(): Scene;
  149376. /**
  149377. * Gets the ratio used by the buffer during its creation.
  149378. * How big is the buffer related to the main canvas.
  149379. */
  149380. get ratio(): number;
  149381. /** @hidden */
  149382. static _SceneComponentInitialization: (scene: Scene) => void;
  149383. /**
  149384. * Creates a new G Buffer for the scene
  149385. * @param scene The scene the buffer belongs to
  149386. * @param ratio How big is the buffer related to the main canvas.
  149387. */
  149388. constructor(scene: Scene, ratio?: number);
  149389. /**
  149390. * Checks wether everything is ready to render a submesh to the G buffer.
  149391. * @param subMesh the submesh to check readiness for
  149392. * @param useInstances is the mesh drawn using instance or not
  149393. * @returns true if ready otherwise false
  149394. */
  149395. isReady(subMesh: SubMesh, useInstances: boolean): boolean;
  149396. /**
  149397. * Gets the current underlying G Buffer.
  149398. * @returns the buffer
  149399. */
  149400. getGBuffer(): MultiRenderTarget;
  149401. /**
  149402. * Gets the number of samples used to render the buffer (anti aliasing).
  149403. */
  149404. get samples(): number;
  149405. /**
  149406. * Sets the number of samples used to render the buffer (anti aliasing).
  149407. */
  149408. set samples(value: number);
  149409. /**
  149410. * Disposes the renderer and frees up associated resources.
  149411. */
  149412. dispose(): void;
  149413. protected _createRenderTargets(): void;
  149414. private _copyBonesTransformationMatrices;
  149415. }
  149416. }
  149417. declare module BABYLON {
  149418. interface Scene {
  149419. /** @hidden (Backing field) */
  149420. _geometryBufferRenderer: Nullable<GeometryBufferRenderer>;
  149421. /**
  149422. * Gets or Sets the current geometry buffer associated to the scene.
  149423. */
  149424. geometryBufferRenderer: Nullable<GeometryBufferRenderer>;
  149425. /**
  149426. * Enables a GeometryBufferRender and associates it with the scene
  149427. * @param ratio defines the scaling ratio to apply to the renderer (1 by default which means same resolution)
  149428. * @returns the GeometryBufferRenderer
  149429. */
  149430. enableGeometryBufferRenderer(ratio?: number): Nullable<GeometryBufferRenderer>;
  149431. /**
  149432. * Disables the GeometryBufferRender associated with the scene
  149433. */
  149434. disableGeometryBufferRenderer(): void;
  149435. }
  149436. /**
  149437. * Defines the Geometry Buffer scene component responsible to manage a G-Buffer useful
  149438. * in several rendering techniques.
  149439. */
  149440. export class GeometryBufferRendererSceneComponent implements ISceneComponent {
  149441. /**
  149442. * The component name helpful to identify the component in the list of scene components.
  149443. */
  149444. readonly name: string;
  149445. /**
  149446. * The scene the component belongs to.
  149447. */
  149448. scene: Scene;
  149449. /**
  149450. * Creates a new instance of the component for the given scene
  149451. * @param scene Defines the scene to register the component in
  149452. */
  149453. constructor(scene: Scene);
  149454. /**
  149455. * Registers the component in a given scene
  149456. */
  149457. register(): void;
  149458. /**
  149459. * Rebuilds the elements related to this component in case of
  149460. * context lost for instance.
  149461. */
  149462. rebuild(): void;
  149463. /**
  149464. * Disposes the component and the associated ressources
  149465. */
  149466. dispose(): void;
  149467. private _gatherRenderTargets;
  149468. }
  149469. }
  149470. declare module BABYLON {
  149471. /** @hidden */
  149472. export var motionBlurPixelShader: {
  149473. name: string;
  149474. shader: string;
  149475. };
  149476. }
  149477. declare module BABYLON {
  149478. /**
  149479. * The Motion Blur Post Process which blurs an image based on the objects velocity in scene.
  149480. * Velocity can be affected by each object's rotation, position and scale depending on the transformation speed.
  149481. * As an example, all you have to do is to create the post-process:
  149482. * var mb = new BABYLON.MotionBlurPostProcess(
  149483. * 'mb', // The name of the effect.
  149484. * scene, // The scene containing the objects to blur according to their velocity.
  149485. * 1.0, // The required width/height ratio to downsize to before computing the render pass.
  149486. * camera // The camera to apply the render pass to.
  149487. * );
  149488. * Then, all objects moving, rotating and/or scaling will be blurred depending on the transformation speed.
  149489. */
  149490. export class MotionBlurPostProcess extends PostProcess {
  149491. /**
  149492. * Defines how much the image is blurred by the movement. Default value is equal to 1
  149493. */
  149494. motionStrength: number;
  149495. /**
  149496. * Gets the number of iterations are used for motion blur quality. Default value is equal to 32
  149497. */
  149498. get motionBlurSamples(): number;
  149499. /**
  149500. * Sets the number of iterations to be used for motion blur quality
  149501. */
  149502. set motionBlurSamples(samples: number);
  149503. private _motionBlurSamples;
  149504. private _geometryBufferRenderer;
  149505. /**
  149506. * Gets a string identifying the name of the class
  149507. * @returns "MotionBlurPostProcess" string
  149508. */
  149509. getClassName(): string;
  149510. /**
  149511. * Creates a new instance MotionBlurPostProcess
  149512. * @param name The name of the effect.
  149513. * @param scene The scene containing the objects to blur according to their velocity.
  149514. * @param options The required width/height ratio to downsize to before computing the render pass.
  149515. * @param camera The camera to apply the render pass to.
  149516. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  149517. * @param engine The engine which the post process will be applied. (default: current engine)
  149518. * @param reusable If the post process can be reused on the same frame. (default: false)
  149519. * @param textureType Type of textures used when performing the post process. (default: 0)
  149520. * @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)
  149521. */
  149522. constructor(name: string, scene: Scene, options: number | PostProcessOptions, camera: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number, blockCompilation?: boolean);
  149523. /**
  149524. * Excludes the given skinned mesh from computing bones velocities.
  149525. * 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.
  149526. * @param skinnedMesh The mesh containing the skeleton to ignore when computing the velocity map.
  149527. */
  149528. excludeSkinnedMesh(skinnedMesh: AbstractMesh): void;
  149529. /**
  149530. * Removes the given skinned mesh from the excluded meshes to integrate bones velocities while rendering the velocity map.
  149531. * @param skinnedMesh The mesh containing the skeleton that has been ignored previously.
  149532. * @see excludeSkinnedMesh to exclude a skinned mesh from bones velocity computation.
  149533. */
  149534. removeExcludedSkinnedMesh(skinnedMesh: AbstractMesh): void;
  149535. /**
  149536. * Disposes the post process.
  149537. * @param camera The camera to dispose the post process on.
  149538. */
  149539. dispose(camera?: Camera): void;
  149540. /** @hidden */
  149541. static _Parse(parsedPostProcess: any, targetCamera: Camera, scene: Scene, rootUrl: string): Nullable<MotionBlurPostProcess>;
  149542. }
  149543. }
  149544. declare module BABYLON {
  149545. /** @hidden */
  149546. export var refractionPixelShader: {
  149547. name: string;
  149548. shader: string;
  149549. };
  149550. }
  149551. declare module BABYLON {
  149552. /**
  149553. * Post process which applies a refractin texture
  149554. * @see https://doc.babylonjs.com/how_to/how_to_use_postprocesses#refraction
  149555. */
  149556. export class RefractionPostProcess extends PostProcess {
  149557. private _refTexture;
  149558. private _ownRefractionTexture;
  149559. /** the base color of the refraction (used to taint the rendering) */
  149560. color: Color3;
  149561. /** simulated refraction depth */
  149562. depth: number;
  149563. /** the coefficient of the base color (0 to remove base color tainting) */
  149564. colorLevel: number;
  149565. /** Gets the url used to load the refraction texture */
  149566. refractionTextureUrl: string;
  149567. /**
  149568. * Gets or sets the refraction texture
  149569. * Please note that you are responsible for disposing the texture if you set it manually
  149570. */
  149571. get refractionTexture(): Texture;
  149572. set refractionTexture(value: Texture);
  149573. /**
  149574. * Gets a string identifying the name of the class
  149575. * @returns "RefractionPostProcess" string
  149576. */
  149577. getClassName(): string;
  149578. /**
  149579. * Initializes the RefractionPostProcess
  149580. * @see https://doc.babylonjs.com/how_to/how_to_use_postprocesses#refraction
  149581. * @param name The name of the effect.
  149582. * @param refractionTextureUrl Url of the refraction texture to use
  149583. * @param color the base color of the refraction (used to taint the rendering)
  149584. * @param depth simulated refraction depth
  149585. * @param colorLevel the coefficient of the base color (0 to remove base color tainting)
  149586. * @param camera The camera to apply the render pass to.
  149587. * @param options The required width/height ratio to downsize to before computing the render pass.
  149588. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  149589. * @param engine The engine which the post process will be applied. (default: current engine)
  149590. * @param reusable If the post process can be reused on the same frame. (default: false)
  149591. */
  149592. constructor(name: string, refractionTextureUrl: string, color: Color3, depth: number, colorLevel: number, options: number | PostProcessOptions, camera: Camera, samplingMode?: number, engine?: Engine, reusable?: boolean);
  149593. /**
  149594. * Disposes of the post process
  149595. * @param camera Camera to dispose post process on
  149596. */
  149597. dispose(camera: Camera): void;
  149598. /** @hidden */
  149599. static _Parse(parsedPostProcess: any, targetCamera: Camera, scene: Scene, rootUrl: string): RefractionPostProcess;
  149600. }
  149601. }
  149602. declare module BABYLON {
  149603. /** @hidden */
  149604. export var sharpenPixelShader: {
  149605. name: string;
  149606. shader: string;
  149607. };
  149608. }
  149609. declare module BABYLON {
  149610. /**
  149611. * The SharpenPostProcess applies a sharpen kernel to every pixel
  149612. * See http://en.wikipedia.org/wiki/Kernel_(image_processing)
  149613. */
  149614. export class SharpenPostProcess extends PostProcess {
  149615. /**
  149616. * How much of the original color should be applied. Setting this to 0 will display edge detection. (default: 1)
  149617. */
  149618. colorAmount: number;
  149619. /**
  149620. * How much sharpness should be applied (default: 0.3)
  149621. */
  149622. edgeAmount: number;
  149623. /**
  149624. * Gets a string identifying the name of the class
  149625. * @returns "SharpenPostProcess" string
  149626. */
  149627. getClassName(): string;
  149628. /**
  149629. * Creates a new instance ConvolutionPostProcess
  149630. * @param name The name of the effect.
  149631. * @param options The required width/height ratio to downsize to before computing the render pass.
  149632. * @param camera The camera to apply the render pass to.
  149633. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  149634. * @param engine The engine which the post process will be applied. (default: current engine)
  149635. * @param reusable If the post process can be reused on the same frame. (default: false)
  149636. * @param textureType Type of textures used when performing the post process. (default: 0)
  149637. * @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)
  149638. */
  149639. constructor(name: string, options: number | PostProcessOptions, camera: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number, blockCompilation?: boolean);
  149640. /** @hidden */
  149641. static _Parse(parsedPostProcess: any, targetCamera: Camera, scene: Scene, rootUrl: string): SharpenPostProcess;
  149642. }
  149643. }
  149644. declare module BABYLON {
  149645. /**
  149646. * PostProcessRenderPipeline
  149647. * @see https://doc.babylonjs.com/how_to/how_to_use_postprocessrenderpipeline
  149648. */
  149649. export class PostProcessRenderPipeline {
  149650. private engine;
  149651. private _renderEffects;
  149652. private _renderEffectsForIsolatedPass;
  149653. /**
  149654. * List of inspectable custom properties (used by the Inspector)
  149655. * @see https://doc.babylonjs.com/how_to/debug_layer#extensibility
  149656. */
  149657. inspectableCustomProperties: IInspectable[];
  149658. /**
  149659. * @hidden
  149660. */
  149661. protected _cameras: Camera[];
  149662. /** @hidden */
  149663. _name: string;
  149664. /**
  149665. * Gets pipeline name
  149666. */
  149667. get name(): string;
  149668. /** Gets the list of attached cameras */
  149669. get cameras(): Camera[];
  149670. /**
  149671. * Initializes a PostProcessRenderPipeline
  149672. * @param engine engine to add the pipeline to
  149673. * @param name name of the pipeline
  149674. */
  149675. constructor(engine: Engine, name: string);
  149676. /**
  149677. * Gets the class name
  149678. * @returns "PostProcessRenderPipeline"
  149679. */
  149680. getClassName(): string;
  149681. /**
  149682. * If all the render effects in the pipeline are supported
  149683. */
  149684. get isSupported(): boolean;
  149685. /**
  149686. * Adds an effect to the pipeline
  149687. * @param renderEffect the effect to add
  149688. */
  149689. addEffect(renderEffect: PostProcessRenderEffect): void;
  149690. /** @hidden */
  149691. _rebuild(): void;
  149692. /** @hidden */
  149693. _enableEffect(renderEffectName: string, cameras: Camera): void;
  149694. /** @hidden */
  149695. _enableEffect(renderEffectName: string, cameras: Camera[]): void;
  149696. /** @hidden */
  149697. _disableEffect(renderEffectName: string, cameras: Nullable<Camera[]>): void;
  149698. /** @hidden */
  149699. _disableEffect(renderEffectName: string, cameras: Nullable<Camera[]>): void;
  149700. /** @hidden */
  149701. _attachCameras(cameras: Camera, unique: boolean): void;
  149702. /** @hidden */
  149703. _attachCameras(cameras: Camera[], unique: boolean): void;
  149704. /** @hidden */
  149705. _detachCameras(cameras: Camera): void;
  149706. /** @hidden */
  149707. _detachCameras(cameras: Nullable<Camera[]>): void;
  149708. /** @hidden */
  149709. _update(): void;
  149710. /** @hidden */
  149711. _reset(): void;
  149712. protected _enableMSAAOnFirstPostProcess(sampleCount: number): boolean;
  149713. /**
  149714. * Sets the required values to the prepass renderer.
  149715. * @param prePassRenderer defines the prepass renderer to setup.
  149716. * @returns true if the pre pass is needed.
  149717. */
  149718. setPrePassRenderer(prePassRenderer: PrePassRenderer): boolean;
  149719. /**
  149720. * Disposes of the pipeline
  149721. */
  149722. dispose(): void;
  149723. }
  149724. }
  149725. declare module BABYLON {
  149726. /**
  149727. * PostProcessRenderPipelineManager class
  149728. * @see https://doc.babylonjs.com/how_to/how_to_use_postprocessrenderpipeline
  149729. */
  149730. export class PostProcessRenderPipelineManager {
  149731. private _renderPipelines;
  149732. /**
  149733. * Initializes a PostProcessRenderPipelineManager
  149734. * @see https://doc.babylonjs.com/how_to/how_to_use_postprocessrenderpipeline
  149735. */
  149736. constructor();
  149737. /**
  149738. * Gets the list of supported render pipelines
  149739. */
  149740. get supportedPipelines(): PostProcessRenderPipeline[];
  149741. /**
  149742. * Adds a pipeline to the manager
  149743. * @param renderPipeline The pipeline to add
  149744. */
  149745. addPipeline(renderPipeline: PostProcessRenderPipeline): void;
  149746. /**
  149747. * Attaches a camera to the pipeline
  149748. * @param renderPipelineName The name of the pipeline to attach to
  149749. * @param cameras the camera to attach
  149750. * @param unique if the camera can be attached multiple times to the pipeline
  149751. */
  149752. attachCamerasToRenderPipeline(renderPipelineName: string, cameras: any | Camera[] | Camera, unique?: boolean): void;
  149753. /**
  149754. * Detaches a camera from the pipeline
  149755. * @param renderPipelineName The name of the pipeline to detach from
  149756. * @param cameras the camera to detach
  149757. */
  149758. detachCamerasFromRenderPipeline(renderPipelineName: string, cameras: any | Camera[] | Camera): void;
  149759. /**
  149760. * Enables an effect by name on a pipeline
  149761. * @param renderPipelineName the name of the pipeline to enable the effect in
  149762. * @param renderEffectName the name of the effect to enable
  149763. * @param cameras the cameras that the effect should be enabled on
  149764. */
  149765. enableEffectInPipeline(renderPipelineName: string, renderEffectName: string, cameras: any | Camera[] | Camera): void;
  149766. /**
  149767. * Disables an effect by name on a pipeline
  149768. * @param renderPipelineName the name of the pipeline to disable the effect in
  149769. * @param renderEffectName the name of the effect to disable
  149770. * @param cameras the cameras that the effect should be disabled on
  149771. */
  149772. disableEffectInPipeline(renderPipelineName: string, renderEffectName: string, cameras: any | Camera[] | Camera): void;
  149773. /**
  149774. * Updates the state of all contained render pipelines and disposes of any non supported pipelines
  149775. */
  149776. update(): void;
  149777. /** @hidden */
  149778. _rebuild(): void;
  149779. /**
  149780. * Disposes of the manager and pipelines
  149781. */
  149782. dispose(): void;
  149783. }
  149784. }
  149785. declare module BABYLON {
  149786. interface Scene {
  149787. /** @hidden (Backing field) */
  149788. _postProcessRenderPipelineManager: PostProcessRenderPipelineManager;
  149789. /**
  149790. * Gets the postprocess render pipeline manager
  149791. * @see https://doc.babylonjs.com/how_to/how_to_use_postprocessrenderpipeline
  149792. * @see https://doc.babylonjs.com/how_to/using_default_rendering_pipeline
  149793. */
  149794. readonly postProcessRenderPipelineManager: PostProcessRenderPipelineManager;
  149795. }
  149796. /**
  149797. * Defines the Render Pipeline scene component responsible to rendering pipelines
  149798. */
  149799. export class PostProcessRenderPipelineManagerSceneComponent implements ISceneComponent {
  149800. /**
  149801. * The component name helpfull to identify the component in the list of scene components.
  149802. */
  149803. readonly name: string;
  149804. /**
  149805. * The scene the component belongs to.
  149806. */
  149807. scene: Scene;
  149808. /**
  149809. * Creates a new instance of the component for the given scene
  149810. * @param scene Defines the scene to register the component in
  149811. */
  149812. constructor(scene: Scene);
  149813. /**
  149814. * Registers the component in a given scene
  149815. */
  149816. register(): void;
  149817. /**
  149818. * Rebuilds the elements related to this component in case of
  149819. * context lost for instance.
  149820. */
  149821. rebuild(): void;
  149822. /**
  149823. * Disposes the component and the associated ressources
  149824. */
  149825. dispose(): void;
  149826. private _gatherRenderTargets;
  149827. }
  149828. }
  149829. declare module BABYLON {
  149830. /**
  149831. * The default rendering pipeline can be added to a scene to apply common post processing effects such as anti-aliasing or depth of field.
  149832. * See https://doc.babylonjs.com/how_to/using_default_rendering_pipeline
  149833. */
  149834. export class DefaultRenderingPipeline extends PostProcessRenderPipeline implements IDisposable, IAnimatable {
  149835. private _scene;
  149836. private _camerasToBeAttached;
  149837. /**
  149838. * ID of the sharpen post process,
  149839. */
  149840. private readonly SharpenPostProcessId;
  149841. /**
  149842. * @ignore
  149843. * ID of the image processing post process;
  149844. */
  149845. readonly ImageProcessingPostProcessId: string;
  149846. /**
  149847. * @ignore
  149848. * ID of the Fast Approximate Anti-Aliasing post process;
  149849. */
  149850. readonly FxaaPostProcessId: string;
  149851. /**
  149852. * ID of the chromatic aberration post process,
  149853. */
  149854. private readonly ChromaticAberrationPostProcessId;
  149855. /**
  149856. * ID of the grain post process
  149857. */
  149858. private readonly GrainPostProcessId;
  149859. /**
  149860. * Sharpen post process which will apply a sharpen convolution to enhance edges
  149861. */
  149862. sharpen: SharpenPostProcess;
  149863. private _sharpenEffect;
  149864. private bloom;
  149865. /**
  149866. * Depth of field effect, applies a blur based on how far away objects are from the focus distance.
  149867. */
  149868. depthOfField: DepthOfFieldEffect;
  149869. /**
  149870. * The Fast Approximate Anti-Aliasing post process which attemps to remove aliasing from an image.
  149871. */
  149872. fxaa: FxaaPostProcess;
  149873. /**
  149874. * Image post processing pass used to perform operations such as tone mapping or color grading.
  149875. */
  149876. imageProcessing: ImageProcessingPostProcess;
  149877. /**
  149878. * Chromatic aberration post process which will shift rgb colors in the image
  149879. */
  149880. chromaticAberration: ChromaticAberrationPostProcess;
  149881. private _chromaticAberrationEffect;
  149882. /**
  149883. * Grain post process which add noise to the image
  149884. */
  149885. grain: GrainPostProcess;
  149886. private _grainEffect;
  149887. /**
  149888. * Glow post process which adds a glow to emissive areas of the image
  149889. */
  149890. private _glowLayer;
  149891. /**
  149892. * Animations which can be used to tweak settings over a period of time
  149893. */
  149894. animations: Animation[];
  149895. private _imageProcessingConfigurationObserver;
  149896. private _sharpenEnabled;
  149897. private _bloomEnabled;
  149898. private _depthOfFieldEnabled;
  149899. private _depthOfFieldBlurLevel;
  149900. private _fxaaEnabled;
  149901. private _imageProcessingEnabled;
  149902. private _defaultPipelineTextureType;
  149903. private _bloomScale;
  149904. private _chromaticAberrationEnabled;
  149905. private _grainEnabled;
  149906. private _buildAllowed;
  149907. /**
  149908. * Gets active scene
  149909. */
  149910. get scene(): Scene;
  149911. /**
  149912. * Enable or disable the sharpen process from the pipeline
  149913. */
  149914. set sharpenEnabled(enabled: boolean);
  149915. get sharpenEnabled(): boolean;
  149916. private _resizeObserver;
  149917. private _hardwareScaleLevel;
  149918. private _bloomKernel;
  149919. /**
  149920. * Specifies the size of the bloom blur kernel, relative to the final output size
  149921. */
  149922. get bloomKernel(): number;
  149923. set bloomKernel(value: number);
  149924. /**
  149925. * Specifies the weight of the bloom in the final rendering
  149926. */
  149927. private _bloomWeight;
  149928. /**
  149929. * Specifies the luma threshold for the area that will be blurred by the bloom
  149930. */
  149931. private _bloomThreshold;
  149932. private _hdr;
  149933. /**
  149934. * The strength of the bloom.
  149935. */
  149936. set bloomWeight(value: number);
  149937. get bloomWeight(): number;
  149938. /**
  149939. * The strength of the bloom.
  149940. */
  149941. set bloomThreshold(value: number);
  149942. get bloomThreshold(): number;
  149943. /**
  149944. * The scale of the bloom, lower value will provide better performance.
  149945. */
  149946. set bloomScale(value: number);
  149947. get bloomScale(): number;
  149948. /**
  149949. * Enable or disable the bloom from the pipeline
  149950. */
  149951. set bloomEnabled(enabled: boolean);
  149952. get bloomEnabled(): boolean;
  149953. private _rebuildBloom;
  149954. /**
  149955. * If the depth of field is enabled.
  149956. */
  149957. get depthOfFieldEnabled(): boolean;
  149958. set depthOfFieldEnabled(enabled: boolean);
  149959. /**
  149960. * Blur level of the depth of field effect. (Higher blur will effect performance)
  149961. */
  149962. get depthOfFieldBlurLevel(): DepthOfFieldEffectBlurLevel;
  149963. set depthOfFieldBlurLevel(value: DepthOfFieldEffectBlurLevel);
  149964. /**
  149965. * If the anti aliasing is enabled.
  149966. */
  149967. set fxaaEnabled(enabled: boolean);
  149968. get fxaaEnabled(): boolean;
  149969. private _samples;
  149970. /**
  149971. * MSAA sample count, setting this to 4 will provide 4x anti aliasing. (default: 1)
  149972. */
  149973. set samples(sampleCount: number);
  149974. get samples(): number;
  149975. /**
  149976. * If image processing is enabled.
  149977. */
  149978. set imageProcessingEnabled(enabled: boolean);
  149979. get imageProcessingEnabled(): boolean;
  149980. /**
  149981. * If glow layer is enabled. (Adds a glow effect to emmissive materials)
  149982. */
  149983. set glowLayerEnabled(enabled: boolean);
  149984. get glowLayerEnabled(): boolean;
  149985. /**
  149986. * Gets the glow layer (or null if not defined)
  149987. */
  149988. get glowLayer(): Nullable<GlowLayer>;
  149989. /**
  149990. * Enable or disable the chromaticAberration process from the pipeline
  149991. */
  149992. set chromaticAberrationEnabled(enabled: boolean);
  149993. get chromaticAberrationEnabled(): boolean;
  149994. /**
  149995. * Enable or disable the grain process from the pipeline
  149996. */
  149997. set grainEnabled(enabled: boolean);
  149998. get grainEnabled(): boolean;
  149999. /**
  150000. * @constructor
  150001. * @param name - The rendering pipeline name (default: "")
  150002. * @param hdr - If high dynamic range textures should be used (default: true)
  150003. * @param scene - The scene linked to this pipeline (default: the last created scene)
  150004. * @param cameras - The array of cameras that the rendering pipeline will be attached to (default: scene.cameras)
  150005. * @param automaticBuild - if false, you will have to manually call prepare() to update the pipeline (default: true)
  150006. */
  150007. constructor(name?: string, hdr?: boolean, scene?: Scene, cameras?: Camera[], automaticBuild?: boolean);
  150008. /**
  150009. * Get the class name
  150010. * @returns "DefaultRenderingPipeline"
  150011. */
  150012. getClassName(): string;
  150013. /**
  150014. * Force the compilation of the entire pipeline.
  150015. */
  150016. prepare(): void;
  150017. private _hasCleared;
  150018. private _prevPostProcess;
  150019. private _prevPrevPostProcess;
  150020. private _setAutoClearAndTextureSharing;
  150021. private _depthOfFieldSceneObserver;
  150022. private _buildPipeline;
  150023. private _disposePostProcesses;
  150024. /**
  150025. * Adds a camera to the pipeline
  150026. * @param camera the camera to be added
  150027. */
  150028. addCamera(camera: Camera): void;
  150029. /**
  150030. * Removes a camera from the pipeline
  150031. * @param camera the camera to remove
  150032. */
  150033. removeCamera(camera: Camera): void;
  150034. /**
  150035. * Dispose of the pipeline and stop all post processes
  150036. */
  150037. dispose(): void;
  150038. /**
  150039. * Serialize the rendering pipeline (Used when exporting)
  150040. * @returns the serialized object
  150041. */
  150042. serialize(): any;
  150043. /**
  150044. * Parse the serialized pipeline
  150045. * @param source Source pipeline.
  150046. * @param scene The scene to load the pipeline to.
  150047. * @param rootUrl The URL of the serialized pipeline.
  150048. * @returns An instantiated pipeline from the serialized object.
  150049. */
  150050. static Parse(source: any, scene: Scene, rootUrl: string): DefaultRenderingPipeline;
  150051. }
  150052. }
  150053. declare module BABYLON {
  150054. /** @hidden */
  150055. export var lensHighlightsPixelShader: {
  150056. name: string;
  150057. shader: string;
  150058. };
  150059. }
  150060. declare module BABYLON {
  150061. /** @hidden */
  150062. export var depthOfFieldPixelShader: {
  150063. name: string;
  150064. shader: string;
  150065. };
  150066. }
  150067. declare module BABYLON {
  150068. /**
  150069. * BABYLON.JS Chromatic Aberration GLSL Shader
  150070. * Author: Olivier Guyot
  150071. * Separates very slightly R, G and B colors on the edges of the screen
  150072. * Inspired by Francois Tarlier & Martins Upitis
  150073. */
  150074. export class LensRenderingPipeline extends PostProcessRenderPipeline {
  150075. /**
  150076. * @ignore
  150077. * The chromatic aberration PostProcess id in the pipeline
  150078. */
  150079. LensChromaticAberrationEffect: string;
  150080. /**
  150081. * @ignore
  150082. * The highlights enhancing PostProcess id in the pipeline
  150083. */
  150084. HighlightsEnhancingEffect: string;
  150085. /**
  150086. * @ignore
  150087. * The depth-of-field PostProcess id in the pipeline
  150088. */
  150089. LensDepthOfFieldEffect: string;
  150090. private _scene;
  150091. private _depthTexture;
  150092. private _grainTexture;
  150093. private _chromaticAberrationPostProcess;
  150094. private _highlightsPostProcess;
  150095. private _depthOfFieldPostProcess;
  150096. private _edgeBlur;
  150097. private _grainAmount;
  150098. private _chromaticAberration;
  150099. private _distortion;
  150100. private _highlightsGain;
  150101. private _highlightsThreshold;
  150102. private _dofDistance;
  150103. private _dofAperture;
  150104. private _dofDarken;
  150105. private _dofPentagon;
  150106. private _blurNoise;
  150107. /**
  150108. * @constructor
  150109. *
  150110. * Effect parameters are as follow:
  150111. * {
  150112. * chromatic_aberration: number; // from 0 to x (1 for realism)
  150113. * edge_blur: number; // from 0 to x (1 for realism)
  150114. * distortion: number; // from 0 to x (1 for realism)
  150115. * grain_amount: number; // from 0 to 1
  150116. * grain_texture: BABYLON.Texture; // texture to use for grain effect; if unset, use random B&W noise
  150117. * dof_focus_distance: number; // depth-of-field: focus distance; unset to disable (disabled by default)
  150118. * dof_aperture: number; // depth-of-field: focus blur bias (default: 1)
  150119. * dof_darken: number; // depth-of-field: darken that which is out of focus (from 0 to 1, disabled by default)
  150120. * dof_pentagon: boolean; // depth-of-field: makes a pentagon-like "bokeh" effect
  150121. * dof_gain: number; // depth-of-field: highlights gain; unset to disable (disabled by default)
  150122. * dof_threshold: number; // depth-of-field: highlights threshold (default: 1)
  150123. * blur_noise: boolean; // add a little bit of noise to the blur (default: true)
  150124. * }
  150125. * Note: if an effect parameter is unset, effect is disabled
  150126. *
  150127. * @param name The rendering pipeline name
  150128. * @param parameters - An object containing all parameters (see above)
  150129. * @param scene The scene linked to this pipeline
  150130. * @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)
  150131. * @param cameras The array of cameras that the rendering pipeline will be attached to
  150132. */
  150133. constructor(name: string, parameters: any, scene: Scene, ratio?: number, cameras?: Camera[]);
  150134. /**
  150135. * Get the class name
  150136. * @returns "LensRenderingPipeline"
  150137. */
  150138. getClassName(): string;
  150139. /**
  150140. * Gets associated scene
  150141. */
  150142. get scene(): Scene;
  150143. /**
  150144. * Gets or sets the edge blur
  150145. */
  150146. get edgeBlur(): number;
  150147. set edgeBlur(value: number);
  150148. /**
  150149. * Gets or sets the grain amount
  150150. */
  150151. get grainAmount(): number;
  150152. set grainAmount(value: number);
  150153. /**
  150154. * Gets or sets the chromatic aberration amount
  150155. */
  150156. get chromaticAberration(): number;
  150157. set chromaticAberration(value: number);
  150158. /**
  150159. * Gets or sets the depth of field aperture
  150160. */
  150161. get dofAperture(): number;
  150162. set dofAperture(value: number);
  150163. /**
  150164. * Gets or sets the edge distortion
  150165. */
  150166. get edgeDistortion(): number;
  150167. set edgeDistortion(value: number);
  150168. /**
  150169. * Gets or sets the depth of field distortion
  150170. */
  150171. get dofDistortion(): number;
  150172. set dofDistortion(value: number);
  150173. /**
  150174. * Gets or sets the darken out of focus amount
  150175. */
  150176. get darkenOutOfFocus(): number;
  150177. set darkenOutOfFocus(value: number);
  150178. /**
  150179. * Gets or sets a boolean indicating if blur noise is enabled
  150180. */
  150181. get blurNoise(): boolean;
  150182. set blurNoise(value: boolean);
  150183. /**
  150184. * Gets or sets a boolean indicating if pentagon bokeh is enabled
  150185. */
  150186. get pentagonBokeh(): boolean;
  150187. set pentagonBokeh(value: boolean);
  150188. /**
  150189. * Gets or sets the highlight grain amount
  150190. */
  150191. get highlightsGain(): number;
  150192. set highlightsGain(value: number);
  150193. /**
  150194. * Gets or sets the highlight threshold
  150195. */
  150196. get highlightsThreshold(): number;
  150197. set highlightsThreshold(value: number);
  150198. /**
  150199. * Sets the amount of blur at the edges
  150200. * @param amount blur amount
  150201. */
  150202. setEdgeBlur(amount: number): void;
  150203. /**
  150204. * Sets edge blur to 0
  150205. */
  150206. disableEdgeBlur(): void;
  150207. /**
  150208. * Sets the amout of grain
  150209. * @param amount Amount of grain
  150210. */
  150211. setGrainAmount(amount: number): void;
  150212. /**
  150213. * Set grain amount to 0
  150214. */
  150215. disableGrain(): void;
  150216. /**
  150217. * Sets the chromatic aberration amount
  150218. * @param amount amount of chromatic aberration
  150219. */
  150220. setChromaticAberration(amount: number): void;
  150221. /**
  150222. * Sets chromatic aberration amount to 0
  150223. */
  150224. disableChromaticAberration(): void;
  150225. /**
  150226. * Sets the EdgeDistortion amount
  150227. * @param amount amount of EdgeDistortion
  150228. */
  150229. setEdgeDistortion(amount: number): void;
  150230. /**
  150231. * Sets edge distortion to 0
  150232. */
  150233. disableEdgeDistortion(): void;
  150234. /**
  150235. * Sets the FocusDistance amount
  150236. * @param amount amount of FocusDistance
  150237. */
  150238. setFocusDistance(amount: number): void;
  150239. /**
  150240. * Disables depth of field
  150241. */
  150242. disableDepthOfField(): void;
  150243. /**
  150244. * Sets the Aperture amount
  150245. * @param amount amount of Aperture
  150246. */
  150247. setAperture(amount: number): void;
  150248. /**
  150249. * Sets the DarkenOutOfFocus amount
  150250. * @param amount amount of DarkenOutOfFocus
  150251. */
  150252. setDarkenOutOfFocus(amount: number): void;
  150253. private _pentagonBokehIsEnabled;
  150254. /**
  150255. * Creates a pentagon bokeh effect
  150256. */
  150257. enablePentagonBokeh(): void;
  150258. /**
  150259. * Disables the pentagon bokeh effect
  150260. */
  150261. disablePentagonBokeh(): void;
  150262. /**
  150263. * Enables noise blur
  150264. */
  150265. enableNoiseBlur(): void;
  150266. /**
  150267. * Disables noise blur
  150268. */
  150269. disableNoiseBlur(): void;
  150270. /**
  150271. * Sets the HighlightsGain amount
  150272. * @param amount amount of HighlightsGain
  150273. */
  150274. setHighlightsGain(amount: number): void;
  150275. /**
  150276. * Sets the HighlightsThreshold amount
  150277. * @param amount amount of HighlightsThreshold
  150278. */
  150279. setHighlightsThreshold(amount: number): void;
  150280. /**
  150281. * Disables highlights
  150282. */
  150283. disableHighlights(): void;
  150284. /**
  150285. * Removes the internal pipeline assets and detaches the pipeline from the scene cameras
  150286. * @param disableDepthRender If the scens depth rendering should be disabled (default: false)
  150287. */
  150288. dispose(disableDepthRender?: boolean): void;
  150289. private _createChromaticAberrationPostProcess;
  150290. private _createHighlightsPostProcess;
  150291. private _createDepthOfFieldPostProcess;
  150292. private _createGrainTexture;
  150293. }
  150294. }
  150295. declare module BABYLON {
  150296. /** @hidden */
  150297. export var ssao2PixelShader: {
  150298. name: string;
  150299. shader: string;
  150300. };
  150301. }
  150302. declare module BABYLON {
  150303. /** @hidden */
  150304. export var ssaoCombinePixelShader: {
  150305. name: string;
  150306. shader: string;
  150307. };
  150308. }
  150309. declare module BABYLON {
  150310. /**
  150311. * Render pipeline to produce ssao effect
  150312. */
  150313. export class SSAO2RenderingPipeline extends PostProcessRenderPipeline {
  150314. /**
  150315. * @ignore
  150316. * The PassPostProcess id in the pipeline that contains the original scene color
  150317. */
  150318. SSAOOriginalSceneColorEffect: string;
  150319. /**
  150320. * @ignore
  150321. * The SSAO PostProcess id in the pipeline
  150322. */
  150323. SSAORenderEffect: string;
  150324. /**
  150325. * @ignore
  150326. * The horizontal blur PostProcess id in the pipeline
  150327. */
  150328. SSAOBlurHRenderEffect: string;
  150329. /**
  150330. * @ignore
  150331. * The vertical blur PostProcess id in the pipeline
  150332. */
  150333. SSAOBlurVRenderEffect: string;
  150334. /**
  150335. * @ignore
  150336. * The PostProcess id in the pipeline that combines the SSAO-Blur output with the original scene color (SSAOOriginalSceneColorEffect)
  150337. */
  150338. SSAOCombineRenderEffect: string;
  150339. /**
  150340. * The output strength of the SSAO post-process. Default value is 1.0.
  150341. */
  150342. totalStrength: number;
  150343. /**
  150344. * Maximum depth value to still render AO. A smooth falloff makes the dimming more natural, so there will be no abrupt shading change.
  150345. */
  150346. maxZ: number;
  150347. /**
  150348. * In order to save performances, SSAO radius is clamped on close geometry. This ratio changes by how much
  150349. */
  150350. minZAspect: number;
  150351. private _samples;
  150352. /**
  150353. * Number of samples used for the SSAO calculations. Default value is 8
  150354. */
  150355. set samples(n: number);
  150356. get samples(): number;
  150357. private _textureSamples;
  150358. /**
  150359. * Number of samples to use for antialiasing
  150360. */
  150361. set textureSamples(n: number);
  150362. get textureSamples(): number;
  150363. /**
  150364. * Force rendering the geometry through geometry buffer
  150365. */
  150366. private _forceGeometryBuffer;
  150367. /**
  150368. * Ratio object used for SSAO ratio and blur ratio
  150369. */
  150370. private _ratio;
  150371. /**
  150372. * Dynamically generated sphere sampler.
  150373. */
  150374. private _sampleSphere;
  150375. /**
  150376. * Blur filter offsets
  150377. */
  150378. private _samplerOffsets;
  150379. private _expensiveBlur;
  150380. /**
  150381. * If bilateral blur should be used
  150382. */
  150383. set expensiveBlur(b: boolean);
  150384. get expensiveBlur(): boolean;
  150385. /**
  150386. * The radius around the analyzed pixel used by the SSAO post-process. Default value is 2.0
  150387. */
  150388. radius: number;
  150389. /**
  150390. * The base color of the SSAO post-process
  150391. * The final result is "base + ssao" between [0, 1]
  150392. */
  150393. base: number;
  150394. /**
  150395. * Support test.
  150396. */
  150397. static get IsSupported(): boolean;
  150398. private _scene;
  150399. private _randomTexture;
  150400. private _originalColorPostProcess;
  150401. private _ssaoPostProcess;
  150402. private _blurHPostProcess;
  150403. private _blurVPostProcess;
  150404. private _ssaoCombinePostProcess;
  150405. private _prePassRenderer;
  150406. /**
  150407. * Gets active scene
  150408. */
  150409. get scene(): Scene;
  150410. /**
  150411. * @constructor
  150412. * @param name The rendering pipeline name
  150413. * @param scene The scene linked to this pipeline
  150414. * @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 }
  150415. * @param cameras The array of cameras that the rendering pipeline will be attached to
  150416. * @param forceGeometryBuffer Set to true if you want to use the legacy geometry buffer renderer
  150417. */
  150418. constructor(name: string, scene: Scene, ratio: any, cameras?: Camera[], forceGeometryBuffer?: boolean);
  150419. /**
  150420. * Get the class name
  150421. * @returns "SSAO2RenderingPipeline"
  150422. */
  150423. getClassName(): string;
  150424. /**
  150425. * Removes the internal pipeline assets and detatches the pipeline from the scene cameras
  150426. */
  150427. dispose(disableGeometryBufferRenderer?: boolean): void;
  150428. private _createBlurPostProcess;
  150429. /** @hidden */
  150430. _rebuild(): void;
  150431. private _bits;
  150432. private _radicalInverse_VdC;
  150433. private _hammersley;
  150434. private _hemisphereSample_uniform;
  150435. private _generateHemisphere;
  150436. private _getDefinesForSSAO;
  150437. private _createSSAOPostProcess;
  150438. private _createSSAOCombinePostProcess;
  150439. private _createRandomTexture;
  150440. /**
  150441. * Serialize the rendering pipeline (Used when exporting)
  150442. * @returns the serialized object
  150443. */
  150444. serialize(): any;
  150445. /**
  150446. * Parse the serialized pipeline
  150447. * @param source Source pipeline.
  150448. * @param scene The scene to load the pipeline to.
  150449. * @param rootUrl The URL of the serialized pipeline.
  150450. * @returns An instantiated pipeline from the serialized object.
  150451. */
  150452. static Parse(source: any, scene: Scene, rootUrl: string): SSAO2RenderingPipeline;
  150453. /**
  150454. * Sets the required values to the prepass renderer.
  150455. * @param prePassRenderer defines the prepass renderer to setup
  150456. * @returns true if the pre pass is needed.
  150457. */
  150458. setPrePassRenderer(prePassRenderer: PrePassRenderer): boolean;
  150459. }
  150460. }
  150461. declare module BABYLON {
  150462. /** @hidden */
  150463. export var ssaoPixelShader: {
  150464. name: string;
  150465. shader: string;
  150466. };
  150467. }
  150468. declare module BABYLON {
  150469. /**
  150470. * Render pipeline to produce ssao effect
  150471. */
  150472. export class SSAORenderingPipeline extends PostProcessRenderPipeline {
  150473. /**
  150474. * @ignore
  150475. * The PassPostProcess id in the pipeline that contains the original scene color
  150476. */
  150477. SSAOOriginalSceneColorEffect: string;
  150478. /**
  150479. * @ignore
  150480. * The SSAO PostProcess id in the pipeline
  150481. */
  150482. SSAORenderEffect: string;
  150483. /**
  150484. * @ignore
  150485. * The horizontal blur PostProcess id in the pipeline
  150486. */
  150487. SSAOBlurHRenderEffect: string;
  150488. /**
  150489. * @ignore
  150490. * The vertical blur PostProcess id in the pipeline
  150491. */
  150492. SSAOBlurVRenderEffect: string;
  150493. /**
  150494. * @ignore
  150495. * The PostProcess id in the pipeline that combines the SSAO-Blur output with the original scene color (SSAOOriginalSceneColorEffect)
  150496. */
  150497. SSAOCombineRenderEffect: string;
  150498. /**
  150499. * The output strength of the SSAO post-process. Default value is 1.0.
  150500. */
  150501. totalStrength: number;
  150502. /**
  150503. * The radius around the analyzed pixel used by the SSAO post-process. Default value is 0.0006
  150504. */
  150505. radius: number;
  150506. /**
  150507. * Related to fallOff, used to interpolate SSAO samples (first interpolate function input) based on the occlusion difference of each pixel
  150508. * Must not be equal to fallOff and superior to fallOff.
  150509. * Default value is 0.0075
  150510. */
  150511. area: number;
  150512. /**
  150513. * Related to area, used to interpolate SSAO samples (second interpolate function input) based on the occlusion difference of each pixel
  150514. * Must not be equal to area and inferior to area.
  150515. * Default value is 0.000001
  150516. */
  150517. fallOff: number;
  150518. /**
  150519. * The base color of the SSAO post-process
  150520. * The final result is "base + ssao" between [0, 1]
  150521. */
  150522. base: number;
  150523. private _scene;
  150524. private _depthTexture;
  150525. private _randomTexture;
  150526. private _originalColorPostProcess;
  150527. private _ssaoPostProcess;
  150528. private _blurHPostProcess;
  150529. private _blurVPostProcess;
  150530. private _ssaoCombinePostProcess;
  150531. private _firstUpdate;
  150532. /**
  150533. * Gets active scene
  150534. */
  150535. get scene(): Scene;
  150536. /**
  150537. * @constructor
  150538. * @param name - The rendering pipeline name
  150539. * @param scene - The scene linked to this pipeline
  150540. * @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 }
  150541. * @param cameras - The array of cameras that the rendering pipeline will be attached to
  150542. */
  150543. constructor(name: string, scene: Scene, ratio: any, cameras?: Camera[]);
  150544. /**
  150545. * Get the class name
  150546. * @returns "SSAORenderingPipeline"
  150547. */
  150548. getClassName(): string;
  150549. /**
  150550. * Removes the internal pipeline assets and detatches the pipeline from the scene cameras
  150551. */
  150552. dispose(disableDepthRender?: boolean): void;
  150553. private _createBlurPostProcess;
  150554. /** @hidden */
  150555. _rebuild(): void;
  150556. private _createSSAOPostProcess;
  150557. private _createSSAOCombinePostProcess;
  150558. private _createRandomTexture;
  150559. }
  150560. }
  150561. declare module BABYLON {
  150562. /** @hidden */
  150563. export var screenSpaceReflectionPixelShader: {
  150564. name: string;
  150565. shader: string;
  150566. };
  150567. }
  150568. declare module BABYLON {
  150569. /**
  150570. * The ScreenSpaceReflectionPostProcess performs realtime reflections using only and only the available informations on the screen (positions and normals).
  150571. * Basically, the screen space reflection post-process will compute reflections according the material's reflectivity.
  150572. */
  150573. export class ScreenSpaceReflectionPostProcess extends PostProcess {
  150574. /**
  150575. * Gets or sets a reflection threshold mainly used to adjust the reflection's height.
  150576. */
  150577. threshold: number;
  150578. /**
  150579. * Gets or sets the current reflection strength. 1.0 is an ideal value but can be increased/decreased for particular results.
  150580. */
  150581. strength: number;
  150582. /**
  150583. * Gets or sets the falloff exponent used while computing fresnel. More the exponent is high, more the reflections will be discrete.
  150584. */
  150585. reflectionSpecularFalloffExponent: number;
  150586. /**
  150587. * 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]
  150588. */
  150589. step: number;
  150590. /**
  150591. * Gets or sets the factor applied when computing roughness. Default value is 0.2.
  150592. */
  150593. roughnessFactor: number;
  150594. private _geometryBufferRenderer;
  150595. private _enableSmoothReflections;
  150596. private _reflectionSamples;
  150597. private _smoothSteps;
  150598. /**
  150599. * Gets a string identifying the name of the class
  150600. * @returns "ScreenSpaceReflectionPostProcess" string
  150601. */
  150602. getClassName(): string;
  150603. /**
  150604. * Creates a new instance of ScreenSpaceReflectionPostProcess.
  150605. * @param name The name of the effect.
  150606. * @param scene The scene containing the objects to calculate reflections.
  150607. * @param options The required width/height ratio to downsize to before computing the render pass.
  150608. * @param camera The camera to apply the render pass to.
  150609. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  150610. * @param engine The engine which the post process will be applied. (default: current engine)
  150611. * @param reusable If the post process can be reused on the same frame. (default: false)
  150612. * @param textureType Type of textures used when performing the post process. (default: 0)
  150613. * @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)
  150614. */
  150615. constructor(name: string, scene: Scene, options: number | PostProcessOptions, camera: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number, blockCompilation?: boolean);
  150616. /**
  150617. * Gets wether or not smoothing reflections is enabled.
  150618. * Enabling smoothing will require more GPU power and can generate a drop in FPS.
  150619. */
  150620. get enableSmoothReflections(): boolean;
  150621. /**
  150622. * Sets wether or not smoothing reflections is enabled.
  150623. * Enabling smoothing will require more GPU power and can generate a drop in FPS.
  150624. */
  150625. set enableSmoothReflections(enabled: boolean);
  150626. /**
  150627. * Gets the number of samples taken while computing reflections. More samples count is high,
  150628. * more the post-process wil require GPU power and can generate a drop in FPS. Basically in interval [25, 100].
  150629. */
  150630. get reflectionSamples(): number;
  150631. /**
  150632. * Sets the number of samples taken while computing reflections. More samples count is high,
  150633. * more the post-process wil require GPU power and can generate a drop in FPS. Basically in interval [25, 100].
  150634. */
  150635. set reflectionSamples(samples: number);
  150636. /**
  150637. * Gets the number of samples taken while smoothing reflections. More samples count is high,
  150638. * more the post-process will require GPU power and can generate a drop in FPS.
  150639. * Default value (5.0) work pretty well in all cases but can be adjusted.
  150640. */
  150641. get smoothSteps(): number;
  150642. set smoothSteps(steps: number);
  150643. private _updateEffectDefines;
  150644. /** @hidden */
  150645. static _Parse(parsedPostProcess: any, targetCamera: Camera, scene: Scene, rootUrl: string): ScreenSpaceReflectionPostProcess;
  150646. }
  150647. }
  150648. declare module BABYLON {
  150649. /** @hidden */
  150650. export var standardPixelShader: {
  150651. name: string;
  150652. shader: string;
  150653. };
  150654. }
  150655. declare module BABYLON {
  150656. /**
  150657. * Standard rendering pipeline
  150658. * Default pipeline should be used going forward but the standard pipeline will be kept for backwards compatibility.
  150659. * @see https://doc.babylonjs.com/how_to/using_standard_rendering_pipeline
  150660. */
  150661. export class StandardRenderingPipeline extends PostProcessRenderPipeline implements IDisposable, IAnimatable {
  150662. /**
  150663. * Public members
  150664. */
  150665. /**
  150666. * Post-process which contains the original scene color before the pipeline applies all the effects
  150667. */
  150668. originalPostProcess: Nullable<PostProcess>;
  150669. /**
  150670. * Post-process used to down scale an image x4
  150671. */
  150672. downSampleX4PostProcess: Nullable<PostProcess>;
  150673. /**
  150674. * Post-process used to calculate the illuminated surfaces controlled by a threshold
  150675. */
  150676. brightPassPostProcess: Nullable<PostProcess>;
  150677. /**
  150678. * Post-process array storing all the horizontal blur post-processes used by the pipeline
  150679. */
  150680. blurHPostProcesses: PostProcess[];
  150681. /**
  150682. * Post-process array storing all the vertical blur post-processes used by the pipeline
  150683. */
  150684. blurVPostProcesses: PostProcess[];
  150685. /**
  150686. * Post-process used to add colors of 2 textures (typically brightness + real scene color)
  150687. */
  150688. textureAdderPostProcess: Nullable<PostProcess>;
  150689. /**
  150690. * Post-process used to create volumetric lighting effect
  150691. */
  150692. volumetricLightPostProcess: Nullable<PostProcess>;
  150693. /**
  150694. * Post-process used to smooth the previous volumetric light post-process on the X axis
  150695. */
  150696. volumetricLightSmoothXPostProcess: Nullable<BlurPostProcess>;
  150697. /**
  150698. * Post-process used to smooth the previous volumetric light post-process on the Y axis
  150699. */
  150700. volumetricLightSmoothYPostProcess: Nullable<BlurPostProcess>;
  150701. /**
  150702. * Post-process used to merge the volumetric light effect and the real scene color
  150703. */
  150704. volumetricLightMergePostProces: Nullable<PostProcess>;
  150705. /**
  150706. * Post-process used to store the final volumetric light post-process (attach/detach for debug purpose)
  150707. */
  150708. volumetricLightFinalPostProcess: Nullable<PostProcess>;
  150709. /**
  150710. * Base post-process used to calculate the average luminance of the final image for HDR
  150711. */
  150712. luminancePostProcess: Nullable<PostProcess>;
  150713. /**
  150714. * Post-processes used to create down sample post-processes in order to get
  150715. * the average luminance of the final image for HDR
  150716. * Array of length "StandardRenderingPipeline.LuminanceSteps"
  150717. */
  150718. luminanceDownSamplePostProcesses: PostProcess[];
  150719. /**
  150720. * Post-process used to create a HDR effect (light adaptation)
  150721. */
  150722. hdrPostProcess: Nullable<PostProcess>;
  150723. /**
  150724. * Post-process used to store the final texture adder post-process (attach/detach for debug purpose)
  150725. */
  150726. textureAdderFinalPostProcess: Nullable<PostProcess>;
  150727. /**
  150728. * Post-process used to store the final lens flare post-process (attach/detach for debug purpose)
  150729. */
  150730. lensFlareFinalPostProcess: Nullable<PostProcess>;
  150731. /**
  150732. * Post-process used to merge the final HDR post-process and the real scene color
  150733. */
  150734. hdrFinalPostProcess: Nullable<PostProcess>;
  150735. /**
  150736. * Post-process used to create a lens flare effect
  150737. */
  150738. lensFlarePostProcess: Nullable<PostProcess>;
  150739. /**
  150740. * Post-process that merges the result of the lens flare post-process and the real scene color
  150741. */
  150742. lensFlareComposePostProcess: Nullable<PostProcess>;
  150743. /**
  150744. * Post-process used to create a motion blur effect
  150745. */
  150746. motionBlurPostProcess: Nullable<PostProcess>;
  150747. /**
  150748. * Post-process used to create a depth of field effect
  150749. */
  150750. depthOfFieldPostProcess: Nullable<PostProcess>;
  150751. /**
  150752. * The Fast Approximate Anti-Aliasing post process which attemps to remove aliasing from an image.
  150753. */
  150754. fxaaPostProcess: Nullable<FxaaPostProcess>;
  150755. /**
  150756. * Post-process used to simulate realtime reflections using the screen space and geometry renderer.
  150757. */
  150758. screenSpaceReflectionPostProcess: Nullable<ScreenSpaceReflectionPostProcess>;
  150759. /**
  150760. * Represents the brightness threshold in order to configure the illuminated surfaces
  150761. */
  150762. brightThreshold: number;
  150763. /**
  150764. * Configures the blur intensity used for surexposed surfaces are highlighted surfaces (light halo)
  150765. */
  150766. blurWidth: number;
  150767. /**
  150768. * Sets if the blur for highlighted surfaces must be only horizontal
  150769. */
  150770. horizontalBlur: boolean;
  150771. /**
  150772. * Gets the overall exposure used by the pipeline
  150773. */
  150774. get exposure(): number;
  150775. /**
  150776. * Sets the overall exposure used by the pipeline
  150777. */
  150778. set exposure(value: number);
  150779. /**
  150780. * Texture used typically to simulate "dirty" on camera lens
  150781. */
  150782. lensTexture: Nullable<Texture>;
  150783. /**
  150784. * Represents the offset coefficient based on Rayleigh principle. Typically in interval [-0.2, 0.2]
  150785. */
  150786. volumetricLightCoefficient: number;
  150787. /**
  150788. * The overall power of volumetric lights, typically in interval [0, 10] maximum
  150789. */
  150790. volumetricLightPower: number;
  150791. /**
  150792. * Used the set the blur intensity to smooth the volumetric lights
  150793. */
  150794. volumetricLightBlurScale: number;
  150795. /**
  150796. * Light (spot or directional) used to generate the volumetric lights rays
  150797. * The source light must have a shadow generate so the pipeline can get its
  150798. * depth map
  150799. */
  150800. sourceLight: Nullable<SpotLight | DirectionalLight>;
  150801. /**
  150802. * For eye adaptation, represents the minimum luminance the eye can see
  150803. */
  150804. hdrMinimumLuminance: number;
  150805. /**
  150806. * For eye adaptation, represents the decrease luminance speed
  150807. */
  150808. hdrDecreaseRate: number;
  150809. /**
  150810. * For eye adaptation, represents the increase luminance speed
  150811. */
  150812. hdrIncreaseRate: number;
  150813. /**
  150814. * Gets wether or not the exposure of the overall pipeline should be automatically adjusted by the HDR post-process
  150815. */
  150816. get hdrAutoExposure(): boolean;
  150817. /**
  150818. * Sets wether or not the exposure of the overall pipeline should be automatically adjusted by the HDR post-process
  150819. */
  150820. set hdrAutoExposure(value: boolean);
  150821. /**
  150822. * Lens color texture used by the lens flare effect. Mandatory if lens flare effect enabled
  150823. */
  150824. lensColorTexture: Nullable<Texture>;
  150825. /**
  150826. * The overall strengh for the lens flare effect
  150827. */
  150828. lensFlareStrength: number;
  150829. /**
  150830. * Dispersion coefficient for lens flare ghosts
  150831. */
  150832. lensFlareGhostDispersal: number;
  150833. /**
  150834. * Main lens flare halo width
  150835. */
  150836. lensFlareHaloWidth: number;
  150837. /**
  150838. * Based on the lens distortion effect, defines how much the lens flare result
  150839. * is distorted
  150840. */
  150841. lensFlareDistortionStrength: number;
  150842. /**
  150843. * Configures the blur intensity used for for lens flare (halo)
  150844. */
  150845. lensFlareBlurWidth: number;
  150846. /**
  150847. * Lens star texture must be used to simulate rays on the flares and is available
  150848. * in the documentation
  150849. */
  150850. lensStarTexture: Nullable<Texture>;
  150851. /**
  150852. * As the "lensTexture" (can be the same texture or different), it is used to apply the lens
  150853. * flare effect by taking account of the dirt texture
  150854. */
  150855. lensFlareDirtTexture: Nullable<Texture>;
  150856. /**
  150857. * Represents the focal length for the depth of field effect
  150858. */
  150859. depthOfFieldDistance: number;
  150860. /**
  150861. * Represents the blur intensity for the blurred part of the depth of field effect
  150862. */
  150863. depthOfFieldBlurWidth: number;
  150864. /**
  150865. * Gets how much the image is blurred by the movement while using the motion blur post-process
  150866. */
  150867. get motionStrength(): number;
  150868. /**
  150869. * Sets how much the image is blurred by the movement while using the motion blur post-process
  150870. */
  150871. set motionStrength(strength: number);
  150872. /**
  150873. * Gets wether or not the motion blur post-process is object based or screen based.
  150874. */
  150875. get objectBasedMotionBlur(): boolean;
  150876. /**
  150877. * Sets wether or not the motion blur post-process should be object based or screen based
  150878. */
  150879. set objectBasedMotionBlur(value: boolean);
  150880. /**
  150881. * List of animations for the pipeline (IAnimatable implementation)
  150882. */
  150883. animations: Animation[];
  150884. /**
  150885. * Private members
  150886. */
  150887. private _scene;
  150888. private _currentDepthOfFieldSource;
  150889. private _basePostProcess;
  150890. private _fixedExposure;
  150891. private _currentExposure;
  150892. private _hdrAutoExposure;
  150893. private _hdrCurrentLuminance;
  150894. private _motionStrength;
  150895. private _isObjectBasedMotionBlur;
  150896. private _floatTextureType;
  150897. private _camerasToBeAttached;
  150898. private _ratio;
  150899. private _bloomEnabled;
  150900. private _depthOfFieldEnabled;
  150901. private _vlsEnabled;
  150902. private _lensFlareEnabled;
  150903. private _hdrEnabled;
  150904. private _motionBlurEnabled;
  150905. private _fxaaEnabled;
  150906. private _screenSpaceReflectionsEnabled;
  150907. private _motionBlurSamples;
  150908. private _volumetricLightStepsCount;
  150909. private _samples;
  150910. /**
  150911. * @ignore
  150912. * Specifies if the bloom pipeline is enabled
  150913. */
  150914. get BloomEnabled(): boolean;
  150915. set BloomEnabled(enabled: boolean);
  150916. /**
  150917. * @ignore
  150918. * Specifies if the depth of field pipeline is enabed
  150919. */
  150920. get DepthOfFieldEnabled(): boolean;
  150921. set DepthOfFieldEnabled(enabled: boolean);
  150922. /**
  150923. * @ignore
  150924. * Specifies if the lens flare pipeline is enabed
  150925. */
  150926. get LensFlareEnabled(): boolean;
  150927. set LensFlareEnabled(enabled: boolean);
  150928. /**
  150929. * @ignore
  150930. * Specifies if the HDR pipeline is enabled
  150931. */
  150932. get HDREnabled(): boolean;
  150933. set HDREnabled(enabled: boolean);
  150934. /**
  150935. * @ignore
  150936. * Specifies if the volumetric lights scattering effect is enabled
  150937. */
  150938. get VLSEnabled(): boolean;
  150939. set VLSEnabled(enabled: boolean);
  150940. /**
  150941. * @ignore
  150942. * Specifies if the motion blur effect is enabled
  150943. */
  150944. get MotionBlurEnabled(): boolean;
  150945. set MotionBlurEnabled(enabled: boolean);
  150946. /**
  150947. * Specifies if anti-aliasing is enabled
  150948. */
  150949. get fxaaEnabled(): boolean;
  150950. set fxaaEnabled(enabled: boolean);
  150951. /**
  150952. * Specifies if screen space reflections are enabled.
  150953. */
  150954. get screenSpaceReflectionsEnabled(): boolean;
  150955. set screenSpaceReflectionsEnabled(enabled: boolean);
  150956. /**
  150957. * Specifies the number of steps used to calculate the volumetric lights
  150958. * Typically in interval [50, 200]
  150959. */
  150960. get volumetricLightStepsCount(): number;
  150961. set volumetricLightStepsCount(count: number);
  150962. /**
  150963. * Specifies the number of samples used for the motion blur effect
  150964. * Typically in interval [16, 64]
  150965. */
  150966. get motionBlurSamples(): number;
  150967. set motionBlurSamples(samples: number);
  150968. /**
  150969. * Specifies MSAA sample count, setting this to 4 will provide 4x anti aliasing. (default: 1)
  150970. */
  150971. get samples(): number;
  150972. set samples(sampleCount: number);
  150973. /**
  150974. * Default pipeline should be used going forward but the standard pipeline will be kept for backwards compatibility.
  150975. * @constructor
  150976. * @param name The rendering pipeline name
  150977. * @param scene The scene linked to this pipeline
  150978. * @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)
  150979. * @param originalPostProcess the custom original color post-process. Must be "reusable". Can be null.
  150980. * @param cameras The array of cameras that the rendering pipeline will be attached to
  150981. */
  150982. constructor(name: string, scene: Scene, ratio: number, originalPostProcess?: Nullable<PostProcess>, cameras?: Camera[]);
  150983. private _buildPipeline;
  150984. private _createDownSampleX4PostProcess;
  150985. private _createBrightPassPostProcess;
  150986. private _createBlurPostProcesses;
  150987. private _createTextureAdderPostProcess;
  150988. private _createVolumetricLightPostProcess;
  150989. private _createLuminancePostProcesses;
  150990. private _createHdrPostProcess;
  150991. private _createLensFlarePostProcess;
  150992. private _createDepthOfFieldPostProcess;
  150993. private _createMotionBlurPostProcess;
  150994. private _getDepthTexture;
  150995. private _disposePostProcesses;
  150996. /**
  150997. * Dispose of the pipeline and stop all post processes
  150998. */
  150999. dispose(): void;
  151000. /**
  151001. * Serialize the rendering pipeline (Used when exporting)
  151002. * @returns the serialized object
  151003. */
  151004. serialize(): any;
  151005. /**
  151006. * Parse the serialized pipeline
  151007. * @param source Source pipeline.
  151008. * @param scene The scene to load the pipeline to.
  151009. * @param rootUrl The URL of the serialized pipeline.
  151010. * @returns An instantiated pipeline from the serialized object.
  151011. */
  151012. static Parse(source: any, scene: Scene, rootUrl: string): StandardRenderingPipeline;
  151013. /**
  151014. * Luminance steps
  151015. */
  151016. static LuminanceSteps: number;
  151017. }
  151018. }
  151019. declare module BABYLON {
  151020. /** @hidden */
  151021. export var stereoscopicInterlacePixelShader: {
  151022. name: string;
  151023. shader: string;
  151024. };
  151025. }
  151026. declare module BABYLON {
  151027. /**
  151028. * StereoscopicInterlacePostProcessI used to render stereo views from a rigged camera with support for alternate line interlacing
  151029. */
  151030. export class StereoscopicInterlacePostProcessI extends PostProcess {
  151031. private _stepSize;
  151032. private _passedProcess;
  151033. /**
  151034. * Gets a string identifying the name of the class
  151035. * @returns "StereoscopicInterlacePostProcessI" string
  151036. */
  151037. getClassName(): string;
  151038. /**
  151039. * Initializes a StereoscopicInterlacePostProcessI
  151040. * @param name The name of the effect.
  151041. * @param rigCameras The rig cameras to be appled to the post process
  151042. * @param isStereoscopicHoriz If the rendered results are horizontal or vertical
  151043. * @param isStereoscopicInterlaced If the rendered results are alternate line interlaced
  151044. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  151045. * @param engine The engine which the post process will be applied. (default: current engine)
  151046. * @param reusable If the post process can be reused on the same frame. (default: false)
  151047. */
  151048. constructor(name: string, rigCameras: Camera[], isStereoscopicHoriz: boolean, isStereoscopicInterlaced: boolean, samplingMode?: number, engine?: Engine, reusable?: boolean);
  151049. }
  151050. /**
  151051. * StereoscopicInterlacePostProcess used to render stereo views from a rigged camera
  151052. */
  151053. export class StereoscopicInterlacePostProcess extends PostProcess {
  151054. private _stepSize;
  151055. private _passedProcess;
  151056. /**
  151057. * Gets a string identifying the name of the class
  151058. * @returns "StereoscopicInterlacePostProcess" string
  151059. */
  151060. getClassName(): string;
  151061. /**
  151062. * Initializes a StereoscopicInterlacePostProcess
  151063. * @param name The name of the effect.
  151064. * @param rigCameras The rig cameras to be appled to the post process
  151065. * @param isStereoscopicHoriz If the rendered results are horizontal or verticle
  151066. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  151067. * @param engine The engine which the post process will be applied. (default: current engine)
  151068. * @param reusable If the post process can be reused on the same frame. (default: false)
  151069. */
  151070. constructor(name: string, rigCameras: Camera[], isStereoscopicHoriz: boolean, samplingMode?: number, engine?: Engine, reusable?: boolean);
  151071. }
  151072. }
  151073. declare module BABYLON {
  151074. /** @hidden */
  151075. export var tonemapPixelShader: {
  151076. name: string;
  151077. shader: string;
  151078. };
  151079. }
  151080. declare module BABYLON {
  151081. /** Defines operator used for tonemapping */
  151082. export enum TonemappingOperator {
  151083. /** Hable */
  151084. Hable = 0,
  151085. /** Reinhard */
  151086. Reinhard = 1,
  151087. /** HejiDawson */
  151088. HejiDawson = 2,
  151089. /** Photographic */
  151090. Photographic = 3
  151091. }
  151092. /**
  151093. * Defines a post process to apply tone mapping
  151094. */
  151095. export class TonemapPostProcess extends PostProcess {
  151096. private _operator;
  151097. /** Defines the required exposure adjustement */
  151098. exposureAdjustment: number;
  151099. /**
  151100. * Gets a string identifying the name of the class
  151101. * @returns "TonemapPostProcess" string
  151102. */
  151103. getClassName(): string;
  151104. /**
  151105. * Creates a new TonemapPostProcess
  151106. * @param name defines the name of the postprocess
  151107. * @param _operator defines the operator to use
  151108. * @param exposureAdjustment defines the required exposure adjustement
  151109. * @param camera defines the camera to use (can be null)
  151110. * @param samplingMode defines the required sampling mode (BABYLON.Texture.BILINEAR_SAMPLINGMODE by default)
  151111. * @param engine defines the hosting engine (can be ignore if camera is set)
  151112. * @param textureFormat defines the texture format to use (BABYLON.Engine.TEXTURETYPE_UNSIGNED_INT by default)
  151113. */
  151114. constructor(name: string, _operator: TonemappingOperator,
  151115. /** Defines the required exposure adjustement */
  151116. exposureAdjustment: number, camera: Camera, samplingMode?: number, engine?: Engine, textureFormat?: number);
  151117. }
  151118. }
  151119. declare module BABYLON {
  151120. /** @hidden */
  151121. export var volumetricLightScatteringPixelShader: {
  151122. name: string;
  151123. shader: string;
  151124. };
  151125. }
  151126. declare module BABYLON {
  151127. /** @hidden */
  151128. export var volumetricLightScatteringPassVertexShader: {
  151129. name: string;
  151130. shader: string;
  151131. };
  151132. }
  151133. declare module BABYLON {
  151134. /** @hidden */
  151135. export var volumetricLightScatteringPassPixelShader: {
  151136. name: string;
  151137. shader: string;
  151138. };
  151139. }
  151140. declare module BABYLON {
  151141. /**
  151142. * Inspired by http://http.developer.nvidia.com/GPUGems3/gpugems3_ch13.html
  151143. */
  151144. export class VolumetricLightScatteringPostProcess extends PostProcess {
  151145. private _volumetricLightScatteringPass;
  151146. private _volumetricLightScatteringRTT;
  151147. private _viewPort;
  151148. private _screenCoordinates;
  151149. private _cachedDefines;
  151150. /**
  151151. * If not undefined, the mesh position is computed from the attached node position
  151152. */
  151153. attachedNode: {
  151154. position: Vector3;
  151155. };
  151156. /**
  151157. * Custom position of the mesh. Used if "useCustomMeshPosition" is set to "true"
  151158. */
  151159. customMeshPosition: Vector3;
  151160. /**
  151161. * Set if the post-process should use a custom position for the light source (true) or the internal mesh position (false)
  151162. */
  151163. useCustomMeshPosition: boolean;
  151164. /**
  151165. * If the post-process should inverse the light scattering direction
  151166. */
  151167. invert: boolean;
  151168. /**
  151169. * The internal mesh used by the post-process
  151170. */
  151171. mesh: Mesh;
  151172. /**
  151173. * @hidden
  151174. * VolumetricLightScatteringPostProcess.useDiffuseColor is no longer used, use the mesh material directly instead
  151175. */
  151176. get useDiffuseColor(): boolean;
  151177. set useDiffuseColor(useDiffuseColor: boolean);
  151178. /**
  151179. * Array containing the excluded meshes not rendered in the internal pass
  151180. */
  151181. excludedMeshes: AbstractMesh[];
  151182. /**
  151183. * Controls the overall intensity of the post-process
  151184. */
  151185. exposure: number;
  151186. /**
  151187. * Dissipates each sample's contribution in range [0, 1]
  151188. */
  151189. decay: number;
  151190. /**
  151191. * Controls the overall intensity of each sample
  151192. */
  151193. weight: number;
  151194. /**
  151195. * Controls the density of each sample
  151196. */
  151197. density: number;
  151198. /**
  151199. * @constructor
  151200. * @param name The post-process name
  151201. * @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)
  151202. * @param camera The camera that the post-process will be attached to
  151203. * @param mesh The mesh used to create the light scattering
  151204. * @param samples The post-process quality, default 100
  151205. * @param samplingModeThe post-process filtering mode
  151206. * @param engine The babylon engine
  151207. * @param reusable If the post-process is reusable
  151208. * @param scene The constructor needs a scene reference to initialize internal components. If "camera" is null a "scene" must be provided
  151209. */
  151210. constructor(name: string, ratio: any, camera: Camera, mesh?: Mesh, samples?: number, samplingMode?: number, engine?: Engine, reusable?: boolean, scene?: Scene);
  151211. /**
  151212. * Returns the string "VolumetricLightScatteringPostProcess"
  151213. * @returns "VolumetricLightScatteringPostProcess"
  151214. */
  151215. getClassName(): string;
  151216. private _isReady;
  151217. /**
  151218. * Sets the new light position for light scattering effect
  151219. * @param position The new custom light position
  151220. */
  151221. setCustomMeshPosition(position: Vector3): void;
  151222. /**
  151223. * Returns the light position for light scattering effect
  151224. * @return Vector3 The custom light position
  151225. */
  151226. getCustomMeshPosition(): Vector3;
  151227. /**
  151228. * Disposes the internal assets and detaches the post-process from the camera
  151229. */
  151230. dispose(camera: Camera): void;
  151231. /**
  151232. * Returns the render target texture used by the post-process
  151233. * @return the render target texture used by the post-process
  151234. */
  151235. getPass(): RenderTargetTexture;
  151236. private _meshExcluded;
  151237. private _createPass;
  151238. private _updateMeshScreenCoordinates;
  151239. /**
  151240. * Creates a default mesh for the Volumeric Light Scattering post-process
  151241. * @param name The mesh name
  151242. * @param scene The scene where to create the mesh
  151243. * @return the default mesh
  151244. */
  151245. static CreateDefaultMesh(name: string, scene: Scene): Mesh;
  151246. }
  151247. }
  151248. declare module BABYLON {
  151249. /** @hidden */
  151250. export var screenSpaceCurvaturePixelShader: {
  151251. name: string;
  151252. shader: string;
  151253. };
  151254. }
  151255. declare module BABYLON {
  151256. /**
  151257. * The Screen Space curvature effect can help highlighting ridge and valley of a model.
  151258. */
  151259. export class ScreenSpaceCurvaturePostProcess extends PostProcess {
  151260. /**
  151261. * Defines how much ridge the curvature effect displays.
  151262. */
  151263. ridge: number;
  151264. /**
  151265. * Defines how much valley the curvature effect displays.
  151266. */
  151267. valley: number;
  151268. private _geometryBufferRenderer;
  151269. /**
  151270. * Gets a string identifying the name of the class
  151271. * @returns "ScreenSpaceCurvaturePostProcess" string
  151272. */
  151273. getClassName(): string;
  151274. /**
  151275. * Creates a new instance ScreenSpaceCurvaturePostProcess
  151276. * @param name The name of the effect.
  151277. * @param scene The scene containing the objects to blur according to their velocity.
  151278. * @param options The required width/height ratio to downsize to before computing the render pass.
  151279. * @param camera The camera to apply the render pass to.
  151280. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  151281. * @param engine The engine which the post process will be applied. (default: current engine)
  151282. * @param reusable If the post process can be reused on the same frame. (default: false)
  151283. * @param textureType Type of textures used when performing the post process. (default: 0)
  151284. * @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)
  151285. */
  151286. constructor(name: string, scene: Scene, options: number | PostProcessOptions, camera: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number, blockCompilation?: boolean);
  151287. /**
  151288. * Support test.
  151289. */
  151290. static get IsSupported(): boolean;
  151291. /** @hidden */
  151292. static _Parse(parsedPostProcess: any, targetCamera: Camera, scene: Scene, rootUrl: string): ScreenSpaceCurvaturePostProcess;
  151293. }
  151294. }
  151295. declare module BABYLON {
  151296. interface Scene {
  151297. /** @hidden (Backing field) */
  151298. _boundingBoxRenderer: BoundingBoxRenderer;
  151299. /** @hidden (Backing field) */
  151300. _forceShowBoundingBoxes: boolean;
  151301. /**
  151302. * Gets or sets a boolean indicating if all bounding boxes must be rendered
  151303. */
  151304. forceShowBoundingBoxes: boolean;
  151305. /**
  151306. * Gets the bounding box renderer associated with the scene
  151307. * @returns a BoundingBoxRenderer
  151308. */
  151309. getBoundingBoxRenderer(): BoundingBoxRenderer;
  151310. }
  151311. interface AbstractMesh {
  151312. /** @hidden (Backing field) */
  151313. _showBoundingBox: boolean;
  151314. /**
  151315. * Gets or sets a boolean indicating if the bounding box must be rendered as well (false by default)
  151316. */
  151317. showBoundingBox: boolean;
  151318. }
  151319. /**
  151320. * Component responsible of rendering the bounding box of the meshes in a scene.
  151321. * This is usually used through the mesh.showBoundingBox or the scene.forceShowBoundingBoxes properties
  151322. */
  151323. export class BoundingBoxRenderer implements ISceneComponent {
  151324. /**
  151325. * The component name helpfull to identify the component in the list of scene components.
  151326. */
  151327. readonly name: string;
  151328. /**
  151329. * The scene the component belongs to.
  151330. */
  151331. scene: Scene;
  151332. /**
  151333. * Color of the bounding box lines placed in front of an object
  151334. */
  151335. frontColor: Color3;
  151336. /**
  151337. * Color of the bounding box lines placed behind an object
  151338. */
  151339. backColor: Color3;
  151340. /**
  151341. * Defines if the renderer should show the back lines or not
  151342. */
  151343. showBackLines: boolean;
  151344. /**
  151345. * Observable raised before rendering a bounding box
  151346. */
  151347. onBeforeBoxRenderingObservable: Observable<BoundingBox>;
  151348. /**
  151349. * Observable raised after rendering a bounding box
  151350. */
  151351. onAfterBoxRenderingObservable: Observable<BoundingBox>;
  151352. /**
  151353. * @hidden
  151354. */
  151355. renderList: SmartArray<BoundingBox>;
  151356. private _colorShader;
  151357. private _vertexBuffers;
  151358. private _indexBuffer;
  151359. private _fillIndexBuffer;
  151360. private _fillIndexData;
  151361. /**
  151362. * Instantiates a new bounding box renderer in a scene.
  151363. * @param scene the scene the renderer renders in
  151364. */
  151365. constructor(scene: Scene);
  151366. /**
  151367. * Registers the component in a given scene
  151368. */
  151369. register(): void;
  151370. private _evaluateSubMesh;
  151371. private _activeMesh;
  151372. private _prepareRessources;
  151373. private _createIndexBuffer;
  151374. /**
  151375. * Rebuilds the elements related to this component in case of
  151376. * context lost for instance.
  151377. */
  151378. rebuild(): void;
  151379. /**
  151380. * @hidden
  151381. */
  151382. reset(): void;
  151383. /**
  151384. * Render the bounding boxes of a specific rendering group
  151385. * @param renderingGroupId defines the rendering group to render
  151386. */
  151387. render(renderingGroupId: number): void;
  151388. /**
  151389. * In case of occlusion queries, we can render the occlusion bounding box through this method
  151390. * @param mesh Define the mesh to render the occlusion bounding box for
  151391. */
  151392. renderOcclusionBoundingBox(mesh: AbstractMesh): void;
  151393. /**
  151394. * Dispose and release the resources attached to this renderer.
  151395. */
  151396. dispose(): void;
  151397. }
  151398. }
  151399. declare module BABYLON {
  151400. interface Scene {
  151401. /** @hidden (Backing field) */
  151402. _depthRenderer: {
  151403. [id: string]: DepthRenderer;
  151404. };
  151405. /**
  151406. * Creates a depth renderer a given camera which contains a depth map which can be used for post processing.
  151407. * @param camera The camera to create the depth renderer on (default: scene's active camera)
  151408. * @param storeNonLinearDepth Defines whether the depth is stored linearly like in Babylon Shadows or directly like glFragCoord.z
  151409. * @returns the created depth renderer
  151410. */
  151411. enableDepthRenderer(camera?: Nullable<Camera>, storeNonLinearDepth?: boolean): DepthRenderer;
  151412. /**
  151413. * Disables a depth renderer for a given camera
  151414. * @param camera The camera to disable the depth renderer on (default: scene's active camera)
  151415. */
  151416. disableDepthRenderer(camera?: Nullable<Camera>): void;
  151417. }
  151418. /**
  151419. * Defines the Depth Renderer scene component responsible to manage a depth buffer useful
  151420. * in several rendering techniques.
  151421. */
  151422. export class DepthRendererSceneComponent implements ISceneComponent {
  151423. /**
  151424. * The component name helpfull to identify the component in the list of scene components.
  151425. */
  151426. readonly name: string;
  151427. /**
  151428. * The scene the component belongs to.
  151429. */
  151430. scene: Scene;
  151431. /**
  151432. * Creates a new instance of the component for the given scene
  151433. * @param scene Defines the scene to register the component in
  151434. */
  151435. constructor(scene: Scene);
  151436. /**
  151437. * Registers the component in a given scene
  151438. */
  151439. register(): void;
  151440. /**
  151441. * Rebuilds the elements related to this component in case of
  151442. * context lost for instance.
  151443. */
  151444. rebuild(): void;
  151445. /**
  151446. * Disposes the component and the associated ressources
  151447. */
  151448. dispose(): void;
  151449. private _gatherRenderTargets;
  151450. private _gatherActiveCameraRenderTargets;
  151451. }
  151452. }
  151453. declare module BABYLON {
  151454. interface AbstractScene {
  151455. /** @hidden (Backing field) */
  151456. _prePassRenderer: Nullable<PrePassRenderer>;
  151457. /**
  151458. * Gets or Sets the current prepass renderer associated to the scene.
  151459. */
  151460. prePassRenderer: Nullable<PrePassRenderer>;
  151461. /**
  151462. * Enables the prepass and associates it with the scene
  151463. * @returns the PrePassRenderer
  151464. */
  151465. enablePrePassRenderer(): Nullable<PrePassRenderer>;
  151466. /**
  151467. * Disables the prepass associated with the scene
  151468. */
  151469. disablePrePassRenderer(): void;
  151470. }
  151471. /**
  151472. * Defines the Geometry Buffer scene component responsible to manage a G-Buffer useful
  151473. * in several rendering techniques.
  151474. */
  151475. export class PrePassRendererSceneComponent implements ISceneSerializableComponent {
  151476. /**
  151477. * The component name helpful to identify the component in the list of scene components.
  151478. */
  151479. readonly name: string;
  151480. /**
  151481. * The scene the component belongs to.
  151482. */
  151483. scene: Scene;
  151484. /**
  151485. * Creates a new instance of the component for the given scene
  151486. * @param scene Defines the scene to register the component in
  151487. */
  151488. constructor(scene: Scene);
  151489. /**
  151490. * Registers the component in a given scene
  151491. */
  151492. register(): void;
  151493. private _beforeCameraDraw;
  151494. private _afterCameraDraw;
  151495. private _beforeClearStage;
  151496. /**
  151497. * Serializes the component data to the specified json object
  151498. * @param serializationObject The object to serialize to
  151499. */
  151500. serialize(serializationObject: any): void;
  151501. /**
  151502. * Adds all the elements from the container to the scene
  151503. * @param container the container holding the elements
  151504. */
  151505. addFromContainer(container: AbstractScene): void;
  151506. /**
  151507. * Removes all the elements in the container from the scene
  151508. * @param container contains the elements to remove
  151509. * @param dispose if the removed element should be disposed (default: false)
  151510. */
  151511. removeFromContainer(container: AbstractScene, dispose?: boolean): void;
  151512. /**
  151513. * Rebuilds the elements related to this component in case of
  151514. * context lost for instance.
  151515. */
  151516. rebuild(): void;
  151517. /**
  151518. * Disposes the component and the associated ressources
  151519. */
  151520. dispose(): void;
  151521. }
  151522. }
  151523. declare module BABYLON {
  151524. /** @hidden */
  151525. export var outlinePixelShader: {
  151526. name: string;
  151527. shader: string;
  151528. };
  151529. }
  151530. declare module BABYLON {
  151531. /** @hidden */
  151532. export var outlineVertexShader: {
  151533. name: string;
  151534. shader: string;
  151535. };
  151536. }
  151537. declare module BABYLON {
  151538. interface Scene {
  151539. /** @hidden */
  151540. _outlineRenderer: OutlineRenderer;
  151541. /**
  151542. * Gets the outline renderer associated with the scene
  151543. * @returns a OutlineRenderer
  151544. */
  151545. getOutlineRenderer(): OutlineRenderer;
  151546. }
  151547. interface AbstractMesh {
  151548. /** @hidden (Backing field) */
  151549. _renderOutline: boolean;
  151550. /**
  151551. * Gets or sets a boolean indicating if the outline must be rendered as well
  151552. * @see https://www.babylonjs-playground.com/#10WJ5S#3
  151553. */
  151554. renderOutline: boolean;
  151555. /** @hidden (Backing field) */
  151556. _renderOverlay: boolean;
  151557. /**
  151558. * Gets or sets a boolean indicating if the overlay must be rendered as well
  151559. * @see https://www.babylonjs-playground.com/#10WJ5S#2
  151560. */
  151561. renderOverlay: boolean;
  151562. }
  151563. /**
  151564. * This class is responsible to draw bothe outline/overlay of meshes.
  151565. * It should not be used directly but through the available method on mesh.
  151566. */
  151567. export class OutlineRenderer implements ISceneComponent {
  151568. /**
  151569. * Stencil value used to avoid outline being seen within the mesh when the mesh is transparent
  151570. */
  151571. private static _StencilReference;
  151572. /**
  151573. * The name of the component. Each component must have a unique name.
  151574. */
  151575. name: string;
  151576. /**
  151577. * The scene the component belongs to.
  151578. */
  151579. scene: Scene;
  151580. /**
  151581. * Defines a zOffset to prevent zFighting between the overlay and the mesh.
  151582. */
  151583. zOffset: number;
  151584. private _engine;
  151585. private _effect;
  151586. private _cachedDefines;
  151587. private _savedDepthWrite;
  151588. /**
  151589. * Instantiates a new outline renderer. (There could be only one per scene).
  151590. * @param scene Defines the scene it belongs to
  151591. */
  151592. constructor(scene: Scene);
  151593. /**
  151594. * Register the component to one instance of a scene.
  151595. */
  151596. register(): void;
  151597. /**
  151598. * Rebuilds the elements related to this component in case of
  151599. * context lost for instance.
  151600. */
  151601. rebuild(): void;
  151602. /**
  151603. * Disposes the component and the associated ressources.
  151604. */
  151605. dispose(): void;
  151606. /**
  151607. * Renders the outline in the canvas.
  151608. * @param subMesh Defines the sumesh to render
  151609. * @param batch Defines the batch of meshes in case of instances
  151610. * @param useOverlay Defines if the rendering is for the overlay or the outline
  151611. */
  151612. render(subMesh: SubMesh, batch: _InstancesBatch, useOverlay?: boolean): void;
  151613. /**
  151614. * Returns whether or not the outline renderer is ready for a given submesh.
  151615. * All the dependencies e.g. submeshes, texture, effect... mus be ready
  151616. * @param subMesh Defines the submesh to check readyness for
  151617. * @param useInstances Defines wheter wee are trying to render instances or not
  151618. * @returns true if ready otherwise false
  151619. */
  151620. isReady(subMesh: SubMesh, useInstances: boolean): boolean;
  151621. private _beforeRenderingMesh;
  151622. private _afterRenderingMesh;
  151623. }
  151624. }
  151625. declare module BABYLON {
  151626. /**
  151627. * Defines the basic options interface of a Sprite Frame Source Size.
  151628. */
  151629. export interface ISpriteJSONSpriteSourceSize {
  151630. /**
  151631. * number of the original width of the Frame
  151632. */
  151633. w: number;
  151634. /**
  151635. * number of the original height of the Frame
  151636. */
  151637. h: number;
  151638. }
  151639. /**
  151640. * Defines the basic options interface of a Sprite Frame Data.
  151641. */
  151642. export interface ISpriteJSONSpriteFrameData {
  151643. /**
  151644. * number of the x offset of the Frame
  151645. */
  151646. x: number;
  151647. /**
  151648. * number of the y offset of the Frame
  151649. */
  151650. y: number;
  151651. /**
  151652. * number of the width of the Frame
  151653. */
  151654. w: number;
  151655. /**
  151656. * number of the height of the Frame
  151657. */
  151658. h: number;
  151659. }
  151660. /**
  151661. * Defines the basic options interface of a JSON Sprite.
  151662. */
  151663. export interface ISpriteJSONSprite {
  151664. /**
  151665. * string name of the Frame
  151666. */
  151667. filename: string;
  151668. /**
  151669. * ISpriteJSONSpriteFrame basic object of the frame data
  151670. */
  151671. frame: ISpriteJSONSpriteFrameData;
  151672. /**
  151673. * boolean to flag is the frame was rotated.
  151674. */
  151675. rotated: boolean;
  151676. /**
  151677. * boolean to flag is the frame was trimmed.
  151678. */
  151679. trimmed: boolean;
  151680. /**
  151681. * ISpriteJSONSpriteFrame basic object of the source data
  151682. */
  151683. spriteSourceSize: ISpriteJSONSpriteFrameData;
  151684. /**
  151685. * ISpriteJSONSpriteFrame basic object of the source data
  151686. */
  151687. sourceSize: ISpriteJSONSpriteSourceSize;
  151688. }
  151689. /**
  151690. * Defines the basic options interface of a JSON atlas.
  151691. */
  151692. export interface ISpriteJSONAtlas {
  151693. /**
  151694. * Array of objects that contain the frame data.
  151695. */
  151696. frames: Array<ISpriteJSONSprite>;
  151697. /**
  151698. * object basic object containing the sprite meta data.
  151699. */
  151700. meta?: object;
  151701. }
  151702. }
  151703. declare module BABYLON {
  151704. /** @hidden */
  151705. export var spriteMapPixelShader: {
  151706. name: string;
  151707. shader: string;
  151708. };
  151709. }
  151710. declare module BABYLON {
  151711. /** @hidden */
  151712. export var spriteMapVertexShader: {
  151713. name: string;
  151714. shader: string;
  151715. };
  151716. }
  151717. declare module BABYLON {
  151718. /**
  151719. * Defines the basic options interface of a SpriteMap
  151720. */
  151721. export interface ISpriteMapOptions {
  151722. /**
  151723. * Vector2 of the number of cells in the grid.
  151724. */
  151725. stageSize?: Vector2;
  151726. /**
  151727. * Vector2 of the size of the output plane in World Units.
  151728. */
  151729. outputSize?: Vector2;
  151730. /**
  151731. * Vector3 of the position of the output plane in World Units.
  151732. */
  151733. outputPosition?: Vector3;
  151734. /**
  151735. * Vector3 of the rotation of the output plane.
  151736. */
  151737. outputRotation?: Vector3;
  151738. /**
  151739. * number of layers that the system will reserve in resources.
  151740. */
  151741. layerCount?: number;
  151742. /**
  151743. * number of max animation frames a single cell will reserve in resources.
  151744. */
  151745. maxAnimationFrames?: number;
  151746. /**
  151747. * number cell index of the base tile when the system compiles.
  151748. */
  151749. baseTile?: number;
  151750. /**
  151751. * boolean flip the sprite after its been repositioned by the framing data.
  151752. */
  151753. flipU?: boolean;
  151754. /**
  151755. * Vector3 scalar of the global RGB values of the SpriteMap.
  151756. */
  151757. colorMultiply?: Vector3;
  151758. }
  151759. /**
  151760. * Defines the IDisposable interface in order to be cleanable from resources.
  151761. */
  151762. export interface ISpriteMap extends IDisposable {
  151763. /**
  151764. * String name of the SpriteMap.
  151765. */
  151766. name: string;
  151767. /**
  151768. * The JSON Array file from a https://www.codeandweb.com/texturepacker export. Or similar structure.
  151769. */
  151770. atlasJSON: ISpriteJSONAtlas;
  151771. /**
  151772. * Texture of the SpriteMap.
  151773. */
  151774. spriteSheet: Texture;
  151775. /**
  151776. * The parameters to initialize the SpriteMap with.
  151777. */
  151778. options: ISpriteMapOptions;
  151779. }
  151780. /**
  151781. * Class used to manage a grid restricted sprite deployment on an Output plane.
  151782. */
  151783. export class SpriteMap implements ISpriteMap {
  151784. /** The Name of the spriteMap */
  151785. name: string;
  151786. /** The JSON file with the frame and meta data */
  151787. atlasJSON: ISpriteJSONAtlas;
  151788. /** The systems Sprite Sheet Texture */
  151789. spriteSheet: Texture;
  151790. /** Arguments passed with the Constructor */
  151791. options: ISpriteMapOptions;
  151792. /** Public Sprite Storage array, parsed from atlasJSON */
  151793. sprites: Array<ISpriteJSONSprite>;
  151794. /** Returns the Number of Sprites in the System */
  151795. get spriteCount(): number;
  151796. /** Returns the Position of Output Plane*/
  151797. get position(): Vector3;
  151798. /** Returns the Position of Output Plane*/
  151799. set position(v: Vector3);
  151800. /** Returns the Rotation of Output Plane*/
  151801. get rotation(): Vector3;
  151802. /** Returns the Rotation of Output Plane*/
  151803. set rotation(v: Vector3);
  151804. /** Sets the AnimationMap*/
  151805. get animationMap(): RawTexture;
  151806. /** Sets the AnimationMap*/
  151807. set animationMap(v: RawTexture);
  151808. /** Scene that the SpriteMap was created in */
  151809. private _scene;
  151810. /** Texture Buffer of Float32 that holds tile frame data*/
  151811. private _frameMap;
  151812. /** Texture Buffers of Float32 that holds tileMap data*/
  151813. private _tileMaps;
  151814. /** Texture Buffer of Float32 that holds Animation Data*/
  151815. private _animationMap;
  151816. /** Custom ShaderMaterial Central to the System*/
  151817. private _material;
  151818. /** Custom ShaderMaterial Central to the System*/
  151819. private _output;
  151820. /** Systems Time Ticker*/
  151821. private _time;
  151822. /**
  151823. * Creates a new SpriteMap
  151824. * @param name defines the SpriteMaps Name
  151825. * @param atlasJSON is the JSON file that controls the Sprites Frames and Meta
  151826. * @param spriteSheet is the Texture that the Sprites are on.
  151827. * @param options a basic deployment configuration
  151828. * @param scene The Scene that the map is deployed on
  151829. */
  151830. constructor(name: string, atlasJSON: ISpriteJSONAtlas, spriteSheet: Texture, options: ISpriteMapOptions, scene: Scene);
  151831. /**
  151832. * Returns tileID location
  151833. * @returns Vector2 the cell position ID
  151834. */
  151835. getTileID(): Vector2;
  151836. /**
  151837. * Gets the UV location of the mouse over the SpriteMap.
  151838. * @returns Vector2 the UV position of the mouse interaction
  151839. */
  151840. getMousePosition(): Vector2;
  151841. /**
  151842. * Creates the "frame" texture Buffer
  151843. * -------------------------------------
  151844. * Structure of frames
  151845. * "filename": "Falling-Water-2.png",
  151846. * "frame": {"x":69,"y":103,"w":24,"h":32},
  151847. * "rotated": true,
  151848. * "trimmed": true,
  151849. * "spriteSourceSize": {"x":4,"y":0,"w":24,"h":32},
  151850. * "sourceSize": {"w":32,"h":32}
  151851. * @returns RawTexture of the frameMap
  151852. */
  151853. private _createFrameBuffer;
  151854. /**
  151855. * Creates the tileMap texture Buffer
  151856. * @param buffer normally and array of numbers, or a false to generate from scratch
  151857. * @param _layer indicates what layer for a logic trigger dealing with the baseTile. The system uses this
  151858. * @returns RawTexture of the tileMap
  151859. */
  151860. private _createTileBuffer;
  151861. /**
  151862. * Modifies the data of the tileMaps
  151863. * @param _layer is the ID of the layer you want to edit on the SpriteMap
  151864. * @param pos is the iVector2 Coordinates of the Tile
  151865. * @param tile The SpriteIndex of the new Tile
  151866. */
  151867. changeTiles(_layer: number | undefined, pos: Vector2 | Vector2[], tile?: number): void;
  151868. /**
  151869. * Creates the animationMap texture Buffer
  151870. * @param buffer normally and array of numbers, or a false to generate from scratch
  151871. * @returns RawTexture of the animationMap
  151872. */
  151873. private _createTileAnimationBuffer;
  151874. /**
  151875. * Modifies the data of the animationMap
  151876. * @param cellID is the Index of the Sprite
  151877. * @param _frame is the target Animation frame
  151878. * @param toCell is the Target Index of the next frame of the animation
  151879. * @param time is a value between 0-1 that is the trigger for when the frame should change tiles
  151880. * @param speed is a global scalar of the time variable on the map.
  151881. */
  151882. addAnimationToTile(cellID?: number, _frame?: number, toCell?: number, time?: number, speed?: number): void;
  151883. /**
  151884. * Exports the .tilemaps file
  151885. */
  151886. saveTileMaps(): void;
  151887. /**
  151888. * Imports the .tilemaps file
  151889. * @param url of the .tilemaps file
  151890. */
  151891. loadTileMaps(url: string): void;
  151892. /**
  151893. * Release associated resources
  151894. */
  151895. dispose(): void;
  151896. }
  151897. }
  151898. declare module BABYLON {
  151899. /**
  151900. * Class used to manage multiple sprites of different sizes on the same spritesheet
  151901. * @see https://doc.babylonjs.com/babylon101/sprites
  151902. */
  151903. export class SpritePackedManager extends SpriteManager {
  151904. /** defines the packed manager's name */
  151905. name: string;
  151906. /**
  151907. * Creates a new sprite manager from a packed sprite sheet
  151908. * @param name defines the manager's name
  151909. * @param imgUrl defines the sprite sheet url
  151910. * @param capacity defines the maximum allowed number of sprites
  151911. * @param scene defines the hosting scene
  151912. * @param spriteJSON null otherwise a JSON object defining sprite sheet data
  151913. * @param epsilon defines the epsilon value to align texture (0.01 by default)
  151914. * @param samplingMode defines the smapling mode to use with spritesheet
  151915. * @param fromPacked set to true; do not alter
  151916. */
  151917. constructor(
  151918. /** defines the packed manager's name */
  151919. name: string, imgUrl: string, capacity: number, scene: Scene, spriteJSON?: string | null, epsilon?: number, samplingMode?: number);
  151920. }
  151921. }
  151922. declare module BABYLON {
  151923. /**
  151924. * Defines the list of states available for a task inside a AssetsManager
  151925. */
  151926. export enum AssetTaskState {
  151927. /**
  151928. * Initialization
  151929. */
  151930. INIT = 0,
  151931. /**
  151932. * Running
  151933. */
  151934. RUNNING = 1,
  151935. /**
  151936. * Done
  151937. */
  151938. DONE = 2,
  151939. /**
  151940. * Error
  151941. */
  151942. ERROR = 3
  151943. }
  151944. /**
  151945. * Define an abstract asset task used with a AssetsManager class to load assets into a scene
  151946. */
  151947. export abstract class AbstractAssetTask {
  151948. /**
  151949. * Task name
  151950. */ name: string;
  151951. /**
  151952. * Callback called when the task is successful
  151953. */
  151954. onSuccess: (task: any) => void;
  151955. /**
  151956. * Callback called when the task is not successful
  151957. */
  151958. onError: (task: any, message?: string, exception?: any) => void;
  151959. /**
  151960. * Creates a new AssetsManager
  151961. * @param name defines the name of the task
  151962. */
  151963. constructor(
  151964. /**
  151965. * Task name
  151966. */ name: string);
  151967. private _isCompleted;
  151968. private _taskState;
  151969. private _errorObject;
  151970. /**
  151971. * Get if the task is completed
  151972. */
  151973. get isCompleted(): boolean;
  151974. /**
  151975. * Gets the current state of the task
  151976. */
  151977. get taskState(): AssetTaskState;
  151978. /**
  151979. * Gets the current error object (if task is in error)
  151980. */
  151981. get errorObject(): {
  151982. message?: string;
  151983. exception?: any;
  151984. };
  151985. /**
  151986. * Internal only
  151987. * @hidden
  151988. */
  151989. _setErrorObject(message?: string, exception?: any): void;
  151990. /**
  151991. * Execute the current task
  151992. * @param scene defines the scene where you want your assets to be loaded
  151993. * @param onSuccess is a callback called when the task is successfully executed
  151994. * @param onError is a callback called if an error occurs
  151995. */
  151996. run(scene: Scene, onSuccess: () => void, onError: (message?: string, exception?: any) => void): void;
  151997. /**
  151998. * Execute the current task
  151999. * @param scene defines the scene where you want your assets to be loaded
  152000. * @param onSuccess is a callback called when the task is successfully executed
  152001. * @param onError is a callback called if an error occurs
  152002. */
  152003. runTask(scene: Scene, onSuccess: () => void, onError: (message?: string, exception?: any) => void): void;
  152004. /**
  152005. * Reset will set the task state back to INIT, so the next load call of the assets manager will execute this task again.
  152006. * This can be used with failed tasks that have the reason for failure fixed.
  152007. */
  152008. reset(): void;
  152009. private onErrorCallback;
  152010. private onDoneCallback;
  152011. }
  152012. /**
  152013. * Define the interface used by progress events raised during assets loading
  152014. */
  152015. export interface IAssetsProgressEvent {
  152016. /**
  152017. * Defines the number of remaining tasks to process
  152018. */
  152019. remainingCount: number;
  152020. /**
  152021. * Defines the total number of tasks
  152022. */
  152023. totalCount: number;
  152024. /**
  152025. * Defines the task that was just processed
  152026. */
  152027. task: AbstractAssetTask;
  152028. }
  152029. /**
  152030. * Class used to share progress information about assets loading
  152031. */
  152032. export class AssetsProgressEvent implements IAssetsProgressEvent {
  152033. /**
  152034. * Defines the number of remaining tasks to process
  152035. */
  152036. remainingCount: number;
  152037. /**
  152038. * Defines the total number of tasks
  152039. */
  152040. totalCount: number;
  152041. /**
  152042. * Defines the task that was just processed
  152043. */
  152044. task: AbstractAssetTask;
  152045. /**
  152046. * Creates a AssetsProgressEvent
  152047. * @param remainingCount defines the number of remaining tasks to process
  152048. * @param totalCount defines the total number of tasks
  152049. * @param task defines the task that was just processed
  152050. */
  152051. constructor(remainingCount: number, totalCount: number, task: AbstractAssetTask);
  152052. }
  152053. /**
  152054. * Define a task used by AssetsManager to load assets into a container
  152055. */
  152056. export class ContainerAssetTask extends AbstractAssetTask {
  152057. /**
  152058. * Defines the name of the task
  152059. */
  152060. name: string;
  152061. /**
  152062. * Defines the list of mesh's names you want to load
  152063. */
  152064. meshesNames: any;
  152065. /**
  152066. * Defines the root url to use as a base to load your meshes and associated resources
  152067. */
  152068. rootUrl: string;
  152069. /**
  152070. * Defines the filename or File of the scene to load from
  152071. */
  152072. sceneFilename: string | File;
  152073. /**
  152074. * Get the loaded asset container
  152075. */
  152076. loadedContainer: AssetContainer;
  152077. /**
  152078. * Gets the list of loaded meshes
  152079. */
  152080. loadedMeshes: Array<AbstractMesh>;
  152081. /**
  152082. * Gets the list of loaded particle systems
  152083. */
  152084. loadedParticleSystems: Array<IParticleSystem>;
  152085. /**
  152086. * Gets the list of loaded skeletons
  152087. */
  152088. loadedSkeletons: Array<Skeleton>;
  152089. /**
  152090. * Gets the list of loaded animation groups
  152091. */
  152092. loadedAnimationGroups: Array<AnimationGroup>;
  152093. /**
  152094. * Callback called when the task is successful
  152095. */
  152096. onSuccess: (task: ContainerAssetTask) => void;
  152097. /**
  152098. * Callback called when the task is successful
  152099. */
  152100. onError: (task: ContainerAssetTask, message?: string, exception?: any) => void;
  152101. /**
  152102. * Creates a new ContainerAssetTask
  152103. * @param name defines the name of the task
  152104. * @param meshesNames defines the list of mesh's names you want to load
  152105. * @param rootUrl defines the root url to use as a base to load your meshes and associated resources
  152106. * @param sceneFilename defines the filename or File of the scene to load from
  152107. */
  152108. constructor(
  152109. /**
  152110. * Defines the name of the task
  152111. */
  152112. name: string,
  152113. /**
  152114. * Defines the list of mesh's names you want to load
  152115. */
  152116. meshesNames: any,
  152117. /**
  152118. * Defines the root url to use as a base to load your meshes and associated resources
  152119. */
  152120. rootUrl: string,
  152121. /**
  152122. * Defines the filename or File of the scene to load from
  152123. */
  152124. sceneFilename: string | File);
  152125. /**
  152126. * Execute the current task
  152127. * @param scene defines the scene where you want your assets to be loaded
  152128. * @param onSuccess is a callback called when the task is successfully executed
  152129. * @param onError is a callback called if an error occurs
  152130. */
  152131. runTask(scene: Scene, onSuccess: () => void, onError: (message?: string, exception?: any) => void): void;
  152132. }
  152133. /**
  152134. * Define a task used by AssetsManager to load meshes
  152135. */
  152136. export class MeshAssetTask extends AbstractAssetTask {
  152137. /**
  152138. * Defines the name of the task
  152139. */
  152140. name: string;
  152141. /**
  152142. * Defines the list of mesh's names you want to load
  152143. */
  152144. meshesNames: any;
  152145. /**
  152146. * Defines the root url to use as a base to load your meshes and associated resources
  152147. */
  152148. rootUrl: string;
  152149. /**
  152150. * Defines the filename or File of the scene to load from
  152151. */
  152152. sceneFilename: string | File;
  152153. /**
  152154. * Gets the list of loaded meshes
  152155. */
  152156. loadedMeshes: Array<AbstractMesh>;
  152157. /**
  152158. * Gets the list of loaded particle systems
  152159. */
  152160. loadedParticleSystems: Array<IParticleSystem>;
  152161. /**
  152162. * Gets the list of loaded skeletons
  152163. */
  152164. loadedSkeletons: Array<Skeleton>;
  152165. /**
  152166. * Gets the list of loaded animation groups
  152167. */
  152168. loadedAnimationGroups: Array<AnimationGroup>;
  152169. /**
  152170. * Callback called when the task is successful
  152171. */
  152172. onSuccess: (task: MeshAssetTask) => void;
  152173. /**
  152174. * Callback called when the task is successful
  152175. */
  152176. onError: (task: MeshAssetTask, message?: string, exception?: any) => void;
  152177. /**
  152178. * Creates a new MeshAssetTask
  152179. * @param name defines the name of the task
  152180. * @param meshesNames defines the list of mesh's names you want to load
  152181. * @param rootUrl defines the root url to use as a base to load your meshes and associated resources
  152182. * @param sceneFilename defines the filename or File of the scene to load from
  152183. */
  152184. constructor(
  152185. /**
  152186. * Defines the name of the task
  152187. */
  152188. name: string,
  152189. /**
  152190. * Defines the list of mesh's names you want to load
  152191. */
  152192. meshesNames: any,
  152193. /**
  152194. * Defines the root url to use as a base to load your meshes and associated resources
  152195. */
  152196. rootUrl: string,
  152197. /**
  152198. * Defines the filename or File of the scene to load from
  152199. */
  152200. sceneFilename: string | File);
  152201. /**
  152202. * Execute the current task
  152203. * @param scene defines the scene where you want your assets to be loaded
  152204. * @param onSuccess is a callback called when the task is successfully executed
  152205. * @param onError is a callback called if an error occurs
  152206. */
  152207. runTask(scene: Scene, onSuccess: () => void, onError: (message?: string, exception?: any) => void): void;
  152208. }
  152209. /**
  152210. * Define a task used by AssetsManager to load text content
  152211. */
  152212. export class TextFileAssetTask extends AbstractAssetTask {
  152213. /**
  152214. * Defines the name of the task
  152215. */
  152216. name: string;
  152217. /**
  152218. * Defines the location of the file to load
  152219. */
  152220. url: string;
  152221. /**
  152222. * Gets the loaded text string
  152223. */
  152224. text: string;
  152225. /**
  152226. * Callback called when the task is successful
  152227. */
  152228. onSuccess: (task: TextFileAssetTask) => void;
  152229. /**
  152230. * Callback called when the task is successful
  152231. */
  152232. onError: (task: TextFileAssetTask, message?: string, exception?: any) => void;
  152233. /**
  152234. * Creates a new TextFileAssetTask object
  152235. * @param name defines the name of the task
  152236. * @param url defines the location of the file to load
  152237. */
  152238. constructor(
  152239. /**
  152240. * Defines the name of the task
  152241. */
  152242. name: string,
  152243. /**
  152244. * Defines the location of the file to load
  152245. */
  152246. url: string);
  152247. /**
  152248. * Execute the current task
  152249. * @param scene defines the scene where you want your assets to be loaded
  152250. * @param onSuccess is a callback called when the task is successfully executed
  152251. * @param onError is a callback called if an error occurs
  152252. */
  152253. runTask(scene: Scene, onSuccess: () => void, onError: (message?: string, exception?: any) => void): void;
  152254. }
  152255. /**
  152256. * Define a task used by AssetsManager to load binary data
  152257. */
  152258. export class BinaryFileAssetTask extends AbstractAssetTask {
  152259. /**
  152260. * Defines the name of the task
  152261. */
  152262. name: string;
  152263. /**
  152264. * Defines the location of the file to load
  152265. */
  152266. url: string;
  152267. /**
  152268. * Gets the lodaded data (as an array buffer)
  152269. */
  152270. data: ArrayBuffer;
  152271. /**
  152272. * Callback called when the task is successful
  152273. */
  152274. onSuccess: (task: BinaryFileAssetTask) => void;
  152275. /**
  152276. * Callback called when the task is successful
  152277. */
  152278. onError: (task: BinaryFileAssetTask, message?: string, exception?: any) => void;
  152279. /**
  152280. * Creates a new BinaryFileAssetTask object
  152281. * @param name defines the name of the new task
  152282. * @param url defines the location of the file to load
  152283. */
  152284. constructor(
  152285. /**
  152286. * Defines the name of the task
  152287. */
  152288. name: string,
  152289. /**
  152290. * Defines the location of the file to load
  152291. */
  152292. url: string);
  152293. /**
  152294. * Execute the current task
  152295. * @param scene defines the scene where you want your assets to be loaded
  152296. * @param onSuccess is a callback called when the task is successfully executed
  152297. * @param onError is a callback called if an error occurs
  152298. */
  152299. runTask(scene: Scene, onSuccess: () => void, onError: (message?: string, exception?: any) => void): void;
  152300. }
  152301. /**
  152302. * Define a task used by AssetsManager to load images
  152303. */
  152304. export class ImageAssetTask extends AbstractAssetTask {
  152305. /**
  152306. * Defines the name of the task
  152307. */
  152308. name: string;
  152309. /**
  152310. * Defines the location of the image to load
  152311. */
  152312. url: string;
  152313. /**
  152314. * Gets the loaded images
  152315. */
  152316. image: HTMLImageElement;
  152317. /**
  152318. * Callback called when the task is successful
  152319. */
  152320. onSuccess: (task: ImageAssetTask) => void;
  152321. /**
  152322. * Callback called when the task is successful
  152323. */
  152324. onError: (task: ImageAssetTask, message?: string, exception?: any) => void;
  152325. /**
  152326. * Creates a new ImageAssetTask
  152327. * @param name defines the name of the task
  152328. * @param url defines the location of the image to load
  152329. */
  152330. constructor(
  152331. /**
  152332. * Defines the name of the task
  152333. */
  152334. name: string,
  152335. /**
  152336. * Defines the location of the image to load
  152337. */
  152338. url: string);
  152339. /**
  152340. * Execute the current task
  152341. * @param scene defines the scene where you want your assets to be loaded
  152342. * @param onSuccess is a callback called when the task is successfully executed
  152343. * @param onError is a callback called if an error occurs
  152344. */
  152345. runTask(scene: Scene, onSuccess: () => void, onError: (message?: string, exception?: any) => void): void;
  152346. }
  152347. /**
  152348. * Defines the interface used by texture loading tasks
  152349. */
  152350. export interface ITextureAssetTask<TEX extends BaseTexture> {
  152351. /**
  152352. * Gets the loaded texture
  152353. */
  152354. texture: TEX;
  152355. }
  152356. /**
  152357. * Define a task used by AssetsManager to load 2D textures
  152358. */
  152359. export class TextureAssetTask extends AbstractAssetTask implements ITextureAssetTask<Texture> {
  152360. /**
  152361. * Defines the name of the task
  152362. */
  152363. name: string;
  152364. /**
  152365. * Defines the location of the file to load
  152366. */
  152367. url: string;
  152368. /**
  152369. * Defines if mipmap should not be generated (default is false)
  152370. */
  152371. noMipmap?: boolean | undefined;
  152372. /**
  152373. * Defines if texture must be inverted on Y axis (default is true)
  152374. */
  152375. invertY: boolean;
  152376. /**
  152377. * Defines the sampling mode to use (default is Texture.TRILINEAR_SAMPLINGMODE)
  152378. */
  152379. samplingMode: number;
  152380. /**
  152381. * Gets the loaded texture
  152382. */
  152383. texture: Texture;
  152384. /**
  152385. * Callback called when the task is successful
  152386. */
  152387. onSuccess: (task: TextureAssetTask) => void;
  152388. /**
  152389. * Callback called when the task is successful
  152390. */
  152391. onError: (task: TextureAssetTask, message?: string, exception?: any) => void;
  152392. /**
  152393. * Creates a new TextureAssetTask object
  152394. * @param name defines the name of the task
  152395. * @param url defines the location of the file to load
  152396. * @param noMipmap defines if mipmap should not be generated (default is false)
  152397. * @param invertY defines if texture must be inverted on Y axis (default is true)
  152398. * @param samplingMode defines the sampling mode to use (default is Texture.TRILINEAR_SAMPLINGMODE)
  152399. */
  152400. constructor(
  152401. /**
  152402. * Defines the name of the task
  152403. */
  152404. name: string,
  152405. /**
  152406. * Defines the location of the file to load
  152407. */
  152408. url: string,
  152409. /**
  152410. * Defines if mipmap should not be generated (default is false)
  152411. */
  152412. noMipmap?: boolean | undefined,
  152413. /**
  152414. * Defines if texture must be inverted on Y axis (default is true)
  152415. */
  152416. invertY?: boolean,
  152417. /**
  152418. * Defines the sampling mode to use (default is Texture.TRILINEAR_SAMPLINGMODE)
  152419. */
  152420. samplingMode?: number);
  152421. /**
  152422. * Execute the current task
  152423. * @param scene defines the scene where you want your assets to be loaded
  152424. * @param onSuccess is a callback called when the task is successfully executed
  152425. * @param onError is a callback called if an error occurs
  152426. */
  152427. runTask(scene: Scene, onSuccess: () => void, onError: (message?: string, exception?: any) => void): void;
  152428. }
  152429. /**
  152430. * Define a task used by AssetsManager to load cube textures
  152431. */
  152432. export class CubeTextureAssetTask extends AbstractAssetTask implements ITextureAssetTask<CubeTexture> {
  152433. /**
  152434. * Defines the name of the task
  152435. */
  152436. name: string;
  152437. /**
  152438. * Defines the location of the files to load (You have to specify the folder where the files are + filename with no extension)
  152439. */
  152440. url: string;
  152441. /**
  152442. * Defines the extensions to use to load files (["_px", "_py", "_pz", "_nx", "_ny", "_nz"] by default)
  152443. */
  152444. extensions?: string[] | undefined;
  152445. /**
  152446. * Defines if mipmaps should not be generated (default is false)
  152447. */
  152448. noMipmap?: boolean | undefined;
  152449. /**
  152450. * Defines the explicit list of files (undefined by default)
  152451. */
  152452. files?: string[] | undefined;
  152453. /**
  152454. * Gets the loaded texture
  152455. */
  152456. texture: CubeTexture;
  152457. /**
  152458. * Callback called when the task is successful
  152459. */
  152460. onSuccess: (task: CubeTextureAssetTask) => void;
  152461. /**
  152462. * Callback called when the task is successful
  152463. */
  152464. onError: (task: CubeTextureAssetTask, message?: string, exception?: any) => void;
  152465. /**
  152466. * Creates a new CubeTextureAssetTask
  152467. * @param name defines the name of the task
  152468. * @param url defines the location of the files to load (You have to specify the folder where the files are + filename with no extension)
  152469. * @param extensions defines the extensions to use to load files (["_px", "_py", "_pz", "_nx", "_ny", "_nz"] by default)
  152470. * @param noMipmap defines if mipmaps should not be generated (default is false)
  152471. * @param files defines the explicit list of files (undefined by default)
  152472. */
  152473. constructor(
  152474. /**
  152475. * Defines the name of the task
  152476. */
  152477. name: string,
  152478. /**
  152479. * Defines the location of the files to load (You have to specify the folder where the files are + filename with no extension)
  152480. */
  152481. url: string,
  152482. /**
  152483. * Defines the extensions to use to load files (["_px", "_py", "_pz", "_nx", "_ny", "_nz"] by default)
  152484. */
  152485. extensions?: string[] | undefined,
  152486. /**
  152487. * Defines if mipmaps should not be generated (default is false)
  152488. */
  152489. noMipmap?: boolean | undefined,
  152490. /**
  152491. * Defines the explicit list of files (undefined by default)
  152492. */
  152493. files?: string[] | undefined);
  152494. /**
  152495. * Execute the current task
  152496. * @param scene defines the scene where you want your assets to be loaded
  152497. * @param onSuccess is a callback called when the task is successfully executed
  152498. * @param onError is a callback called if an error occurs
  152499. */
  152500. runTask(scene: Scene, onSuccess: () => void, onError: (message?: string, exception?: any) => void): void;
  152501. }
  152502. /**
  152503. * Define a task used by AssetsManager to load HDR cube textures
  152504. */
  152505. export class HDRCubeTextureAssetTask extends AbstractAssetTask implements ITextureAssetTask<HDRCubeTexture> {
  152506. /**
  152507. * Defines the name of the task
  152508. */
  152509. name: string;
  152510. /**
  152511. * Defines the location of the file to load
  152512. */
  152513. url: string;
  152514. /**
  152515. * Defines the desired size (the more it increases the longer the generation will be)
  152516. */
  152517. size: number;
  152518. /**
  152519. * Defines if mipmaps should not be generated (default is false)
  152520. */
  152521. noMipmap: boolean;
  152522. /**
  152523. * Specifies whether you want to extract the polynomial harmonics during the generation process (default is true)
  152524. */
  152525. generateHarmonics: boolean;
  152526. /**
  152527. * 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)
  152528. */
  152529. gammaSpace: boolean;
  152530. /**
  152531. * Internal Use Only
  152532. */
  152533. reserved: boolean;
  152534. /**
  152535. * Gets the loaded texture
  152536. */
  152537. texture: HDRCubeTexture;
  152538. /**
  152539. * Callback called when the task is successful
  152540. */
  152541. onSuccess: (task: HDRCubeTextureAssetTask) => void;
  152542. /**
  152543. * Callback called when the task is successful
  152544. */
  152545. onError: (task: HDRCubeTextureAssetTask, message?: string, exception?: any) => void;
  152546. /**
  152547. * Creates a new HDRCubeTextureAssetTask object
  152548. * @param name defines the name of the task
  152549. * @param url defines the location of the file to load
  152550. * @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.
  152551. * @param noMipmap defines if mipmaps should not be generated (default is false)
  152552. * @param generateHarmonics specifies whether you want to extract the polynomial harmonics during the generation process (default is true)
  152553. * @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)
  152554. * @param reserved Internal use only
  152555. */
  152556. constructor(
  152557. /**
  152558. * Defines the name of the task
  152559. */
  152560. name: string,
  152561. /**
  152562. * Defines the location of the file to load
  152563. */
  152564. url: string,
  152565. /**
  152566. * Defines the desired size (the more it increases the longer the generation will be)
  152567. */
  152568. size: number,
  152569. /**
  152570. * Defines if mipmaps should not be generated (default is false)
  152571. */
  152572. noMipmap?: boolean,
  152573. /**
  152574. * Specifies whether you want to extract the polynomial harmonics during the generation process (default is true)
  152575. */
  152576. generateHarmonics?: boolean,
  152577. /**
  152578. * 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)
  152579. */
  152580. gammaSpace?: boolean,
  152581. /**
  152582. * Internal Use Only
  152583. */
  152584. reserved?: boolean);
  152585. /**
  152586. * Execute the current task
  152587. * @param scene defines the scene where you want your assets to be loaded
  152588. * @param onSuccess is a callback called when the task is successfully executed
  152589. * @param onError is a callback called if an error occurs
  152590. */
  152591. runTask(scene: Scene, onSuccess: () => void, onError: (message?: string, exception?: any) => void): void;
  152592. }
  152593. /**
  152594. * Define a task used by AssetsManager to load Equirectangular cube textures
  152595. */
  152596. export class EquiRectangularCubeTextureAssetTask extends AbstractAssetTask implements ITextureAssetTask<EquiRectangularCubeTexture> {
  152597. /**
  152598. * Defines the name of the task
  152599. */
  152600. name: string;
  152601. /**
  152602. * Defines the location of the file to load
  152603. */
  152604. url: string;
  152605. /**
  152606. * Defines the desired size (the more it increases the longer the generation will be)
  152607. */
  152608. size: number;
  152609. /**
  152610. * Defines if mipmaps should not be generated (default is false)
  152611. */
  152612. noMipmap: boolean;
  152613. /**
  152614. * Specifies if the texture will be use in gamma or linear space (the PBR material requires those texture in linear space,
  152615. * but the standard material would require them in Gamma space) (default is true)
  152616. */
  152617. gammaSpace: boolean;
  152618. /**
  152619. * Gets the loaded texture
  152620. */
  152621. texture: EquiRectangularCubeTexture;
  152622. /**
  152623. * Callback called when the task is successful
  152624. */
  152625. onSuccess: (task: EquiRectangularCubeTextureAssetTask) => void;
  152626. /**
  152627. * Callback called when the task is successful
  152628. */
  152629. onError: (task: EquiRectangularCubeTextureAssetTask, message?: string, exception?: any) => void;
  152630. /**
  152631. * Creates a new EquiRectangularCubeTextureAssetTask object
  152632. * @param name defines the name of the task
  152633. * @param url defines the location of the file to load
  152634. * @param size defines the desired size (the more it increases the longer the generation will be)
  152635. * If the size is omitted this implies you are using a preprocessed cubemap.
  152636. * @param noMipmap defines if mipmaps should not be generated (default is false)
  152637. * @param gammaSpace specifies if the texture will be used in gamma or linear space
  152638. * (the PBR material requires those texture in linear space, but the standard material would require them in Gamma space)
  152639. * (default is true)
  152640. */
  152641. constructor(
  152642. /**
  152643. * Defines the name of the task
  152644. */
  152645. name: string,
  152646. /**
  152647. * Defines the location of the file to load
  152648. */
  152649. url: string,
  152650. /**
  152651. * Defines the desired size (the more it increases the longer the generation will be)
  152652. */
  152653. size: number,
  152654. /**
  152655. * Defines if mipmaps should not be generated (default is false)
  152656. */
  152657. noMipmap?: boolean,
  152658. /**
  152659. * Specifies if the texture will be use in gamma or linear space (the PBR material requires those texture in linear space,
  152660. * but the standard material would require them in Gamma space) (default is true)
  152661. */
  152662. gammaSpace?: boolean);
  152663. /**
  152664. * Execute the current task
  152665. * @param scene defines the scene where you want your assets to be loaded
  152666. * @param onSuccess is a callback called when the task is successfully executed
  152667. * @param onError is a callback called if an error occurs
  152668. */
  152669. runTask(scene: Scene, onSuccess: () => void, onError: (message?: string, exception?: any) => void): void;
  152670. }
  152671. /**
  152672. * This class can be used to easily import assets into a scene
  152673. * @see https://doc.babylonjs.com/how_to/how_to_use_assetsmanager
  152674. */
  152675. export class AssetsManager {
  152676. private _scene;
  152677. private _isLoading;
  152678. protected _tasks: AbstractAssetTask[];
  152679. protected _waitingTasksCount: number;
  152680. protected _totalTasksCount: number;
  152681. /**
  152682. * Callback called when all tasks are processed
  152683. */
  152684. onFinish: (tasks: AbstractAssetTask[]) => void;
  152685. /**
  152686. * Callback called when a task is successful
  152687. */
  152688. onTaskSuccess: (task: AbstractAssetTask) => void;
  152689. /**
  152690. * Callback called when a task had an error
  152691. */
  152692. onTaskError: (task: AbstractAssetTask) => void;
  152693. /**
  152694. * Callback called when a task is done (whatever the result is)
  152695. */
  152696. onProgress: (remainingCount: number, totalCount: number, task: AbstractAssetTask) => void;
  152697. /**
  152698. * Observable called when all tasks are processed
  152699. */
  152700. onTaskSuccessObservable: Observable<AbstractAssetTask>;
  152701. /**
  152702. * Observable called when a task had an error
  152703. */
  152704. onTaskErrorObservable: Observable<AbstractAssetTask>;
  152705. /**
  152706. * Observable called when all tasks were executed
  152707. */
  152708. onTasksDoneObservable: Observable<AbstractAssetTask[]>;
  152709. /**
  152710. * Observable called when a task is done (whatever the result is)
  152711. */
  152712. onProgressObservable: Observable<IAssetsProgressEvent>;
  152713. /**
  152714. * Gets or sets a boolean defining if the AssetsManager should use the default loading screen
  152715. * @see https://doc.babylonjs.com/how_to/creating_a_custom_loading_screen
  152716. */
  152717. useDefaultLoadingScreen: boolean;
  152718. /**
  152719. * Gets or sets a boolean defining if the AssetsManager should automatically hide the loading screen
  152720. * when all assets have been downloaded.
  152721. * If set to false, you need to manually call in hideLoadingUI() once your scene is ready.
  152722. */
  152723. autoHideLoadingUI: boolean;
  152724. /**
  152725. * Creates a new AssetsManager
  152726. * @param scene defines the scene to work on
  152727. */
  152728. constructor(scene: Scene);
  152729. /**
  152730. * Add a ContainerAssetTask to the list of active tasks
  152731. * @param taskName defines the name of the new task
  152732. * @param meshesNames defines the name of meshes to load
  152733. * @param rootUrl defines the root url to use to locate files
  152734. * @param sceneFilename defines the filename of the scene file
  152735. * @returns a new ContainerAssetTask object
  152736. */
  152737. addContainerTask(taskName: string, meshesNames: any, rootUrl: string, sceneFilename: string): ContainerAssetTask;
  152738. /**
  152739. * Add a MeshAssetTask to the list of active tasks
  152740. * @param taskName defines the name of the new task
  152741. * @param meshesNames defines the name of meshes to load
  152742. * @param rootUrl defines the root url to use to locate files
  152743. * @param sceneFilename defines the filename of the scene file
  152744. * @returns a new MeshAssetTask object
  152745. */
  152746. addMeshTask(taskName: string, meshesNames: any, rootUrl: string, sceneFilename: string): MeshAssetTask;
  152747. /**
  152748. * Add a TextFileAssetTask to the list of active tasks
  152749. * @param taskName defines the name of the new task
  152750. * @param url defines the url of the file to load
  152751. * @returns a new TextFileAssetTask object
  152752. */
  152753. addTextFileTask(taskName: string, url: string): TextFileAssetTask;
  152754. /**
  152755. * Add a BinaryFileAssetTask to the list of active tasks
  152756. * @param taskName defines the name of the new task
  152757. * @param url defines the url of the file to load
  152758. * @returns a new BinaryFileAssetTask object
  152759. */
  152760. addBinaryFileTask(taskName: string, url: string): BinaryFileAssetTask;
  152761. /**
  152762. * Add a ImageAssetTask to the list of active tasks
  152763. * @param taskName defines the name of the new task
  152764. * @param url defines the url of the file to load
  152765. * @returns a new ImageAssetTask object
  152766. */
  152767. addImageTask(taskName: string, url: string): ImageAssetTask;
  152768. /**
  152769. * Add a TextureAssetTask to the list of active tasks
  152770. * @param taskName defines the name of the new task
  152771. * @param url defines the url of the file to load
  152772. * @param noMipmap defines if the texture must not receive mipmaps (false by default)
  152773. * @param invertY defines if you want to invert Y axis of the loaded texture (false by default)
  152774. * @param samplingMode defines the sampling mode to use (Texture.TRILINEAR_SAMPLINGMODE by default)
  152775. * @returns a new TextureAssetTask object
  152776. */
  152777. addTextureTask(taskName: string, url: string, noMipmap?: boolean, invertY?: boolean, samplingMode?: number): TextureAssetTask;
  152778. /**
  152779. * Add a CubeTextureAssetTask to the list of active tasks
  152780. * @param taskName defines the name of the new task
  152781. * @param url defines the url of the file to load
  152782. * @param extensions defines the extension to use to load the cube map (can be null)
  152783. * @param noMipmap defines if the texture must not receive mipmaps (false by default)
  152784. * @param files defines the list of files to load (can be null)
  152785. * @returns a new CubeTextureAssetTask object
  152786. */
  152787. addCubeTextureTask(taskName: string, url: string, extensions?: string[], noMipmap?: boolean, files?: string[]): CubeTextureAssetTask;
  152788. /**
  152789. *
  152790. * Add a HDRCubeTextureAssetTask to the list of active tasks
  152791. * @param taskName defines the name of the new task
  152792. * @param url defines the url of the file to load
  152793. * @param size defines the size you want for the cubemap (can be null)
  152794. * @param noMipmap defines if the texture must not receive mipmaps (false by default)
  152795. * @param generateHarmonics defines if you want to automatically generate (true by default)
  152796. * @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)
  152797. * @param reserved Internal use only
  152798. * @returns a new HDRCubeTextureAssetTask object
  152799. */
  152800. addHDRCubeTextureTask(taskName: string, url: string, size: number, noMipmap?: boolean, generateHarmonics?: boolean, gammaSpace?: boolean, reserved?: boolean): HDRCubeTextureAssetTask;
  152801. /**
  152802. *
  152803. * Add a EquiRectangularCubeTextureAssetTask to the list of active tasks
  152804. * @param taskName defines the name of the new task
  152805. * @param url defines the url of the file to load
  152806. * @param size defines the size you want for the cubemap (can be null)
  152807. * @param noMipmap defines if the texture must not receive mipmaps (false by default)
  152808. * @param gammaSpace Specifies if the texture will be used in gamma or linear space
  152809. * (the PBR material requires those textures in linear space, but the standard material would require them in Gamma space)
  152810. * @returns a new EquiRectangularCubeTextureAssetTask object
  152811. */
  152812. addEquiRectangularCubeTextureAssetTask(taskName: string, url: string, size: number, noMipmap?: boolean, gammaSpace?: boolean): EquiRectangularCubeTextureAssetTask;
  152813. /**
  152814. * Remove a task from the assets manager.
  152815. * @param task the task to remove
  152816. */
  152817. removeTask(task: AbstractAssetTask): void;
  152818. private _decreaseWaitingTasksCount;
  152819. private _runTask;
  152820. /**
  152821. * Reset the AssetsManager and remove all tasks
  152822. * @return the current instance of the AssetsManager
  152823. */
  152824. reset(): AssetsManager;
  152825. /**
  152826. * Start the loading process
  152827. * @return the current instance of the AssetsManager
  152828. */
  152829. load(): AssetsManager;
  152830. /**
  152831. * Start the loading process as an async operation
  152832. * @return a promise returning the list of failed tasks
  152833. */
  152834. loadAsync(): Promise<void>;
  152835. }
  152836. }
  152837. declare module BABYLON {
  152838. /**
  152839. * Wrapper class for promise with external resolve and reject.
  152840. */
  152841. export class Deferred<T> {
  152842. /**
  152843. * The promise associated with this deferred object.
  152844. */
  152845. readonly promise: Promise<T>;
  152846. private _resolve;
  152847. private _reject;
  152848. /**
  152849. * The resolve method of the promise associated with this deferred object.
  152850. */
  152851. get resolve(): (value?: T | PromiseLike<T> | undefined) => void;
  152852. /**
  152853. * The reject method of the promise associated with this deferred object.
  152854. */
  152855. get reject(): (reason?: any) => void;
  152856. /**
  152857. * Constructor for this deferred object.
  152858. */
  152859. constructor();
  152860. }
  152861. }
  152862. declare module BABYLON {
  152863. /**
  152864. * Class used to explode meshes (ie. to have a center and move them away from that center to better see the overall organization)
  152865. */
  152866. export class MeshExploder {
  152867. private _centerMesh;
  152868. private _meshes;
  152869. private _meshesOrigins;
  152870. private _toCenterVectors;
  152871. private _scaledDirection;
  152872. private _newPosition;
  152873. private _centerPosition;
  152874. /**
  152875. * Explodes meshes from a center mesh.
  152876. * @param meshes The meshes to explode.
  152877. * @param centerMesh The mesh to be center of explosion.
  152878. */
  152879. constructor(meshes: Array<Mesh>, centerMesh?: Mesh);
  152880. private _setCenterMesh;
  152881. /**
  152882. * Get class name
  152883. * @returns "MeshExploder"
  152884. */
  152885. getClassName(): string;
  152886. /**
  152887. * "Exploded meshes"
  152888. * @returns Array of meshes with the centerMesh at index 0.
  152889. */
  152890. getMeshes(): Array<Mesh>;
  152891. /**
  152892. * Explodes meshes giving a specific direction
  152893. * @param direction Number to multiply distance of each mesh's origin from center. Use a negative number to implode, or zero to reset.
  152894. */
  152895. explode(direction?: number): void;
  152896. }
  152897. }
  152898. declare module BABYLON {
  152899. /**
  152900. * Class used to help managing file picking and drag'n'drop
  152901. */
  152902. export class FilesInput {
  152903. /**
  152904. * List of files ready to be loaded
  152905. */
  152906. static get FilesToLoad(): {
  152907. [key: string]: File;
  152908. };
  152909. /**
  152910. * Callback called when a file is processed
  152911. */
  152912. onProcessFileCallback: (file: File, name: string, extension: string) => boolean;
  152913. private _engine;
  152914. private _currentScene;
  152915. private _sceneLoadedCallback;
  152916. private _progressCallback;
  152917. private _additionalRenderLoopLogicCallback;
  152918. private _textureLoadingCallback;
  152919. private _startingProcessingFilesCallback;
  152920. private _onReloadCallback;
  152921. private _errorCallback;
  152922. private _elementToMonitor;
  152923. private _sceneFileToLoad;
  152924. private _filesToLoad;
  152925. /**
  152926. * Creates a new FilesInput
  152927. * @param engine defines the rendering engine
  152928. * @param scene defines the hosting scene
  152929. * @param sceneLoadedCallback callback called when scene is loaded
  152930. * @param progressCallback callback called to track progress
  152931. * @param additionalRenderLoopLogicCallback callback called to add user logic to the rendering loop
  152932. * @param textureLoadingCallback callback called when a texture is loading
  152933. * @param startingProcessingFilesCallback callback called when the system is about to process all files
  152934. * @param onReloadCallback callback called when a reload is requested
  152935. * @param errorCallback callback call if an error occurs
  152936. */
  152937. 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>);
  152938. private _dragEnterHandler;
  152939. private _dragOverHandler;
  152940. private _dropHandler;
  152941. /**
  152942. * Calls this function to listen to drag'n'drop events on a specific DOM element
  152943. * @param elementToMonitor defines the DOM element to track
  152944. */
  152945. monitorElementForDragNDrop(elementToMonitor: HTMLElement): void;
  152946. /** Gets the current list of files to load */
  152947. get filesToLoad(): File[];
  152948. /**
  152949. * Release all associated resources
  152950. */
  152951. dispose(): void;
  152952. private renderFunction;
  152953. private drag;
  152954. private drop;
  152955. private _traverseFolder;
  152956. private _processFiles;
  152957. /**
  152958. * Load files from a drop event
  152959. * @param event defines the drop event to use as source
  152960. */
  152961. loadFiles(event: any): void;
  152962. private _processReload;
  152963. /**
  152964. * Reload the current scene from the loaded files
  152965. */
  152966. reload(): void;
  152967. }
  152968. }
  152969. declare module BABYLON {
  152970. /**
  152971. * Defines the root class used to create scene optimization to use with SceneOptimizer
  152972. * @description More details at https://doc.babylonjs.com/how_to/how_to_use_sceneoptimizer
  152973. */
  152974. export class SceneOptimization {
  152975. /**
  152976. * Defines the priority of this optimization (0 by default which means first in the list)
  152977. */
  152978. priority: number;
  152979. /**
  152980. * Gets a string describing the action executed by the current optimization
  152981. * @returns description string
  152982. */
  152983. getDescription(): string;
  152984. /**
  152985. * This function will be called by the SceneOptimizer when its priority is reached in order to apply the change required by the current optimization
  152986. * @param scene defines the current scene where to apply this optimization
  152987. * @param optimizer defines the current optimizer
  152988. * @returns true if everything that can be done was applied
  152989. */
  152990. apply(scene: Scene, optimizer: SceneOptimizer): boolean;
  152991. /**
  152992. * Creates the SceneOptimization object
  152993. * @param priority defines the priority of this optimization (0 by default which means first in the list)
  152994. * @param desc defines the description associated with the optimization
  152995. */
  152996. constructor(
  152997. /**
  152998. * Defines the priority of this optimization (0 by default which means first in the list)
  152999. */
  153000. priority?: number);
  153001. }
  153002. /**
  153003. * Defines an optimization used to reduce the size of render target textures
  153004. * @description More details at https://doc.babylonjs.com/how_to/how_to_use_sceneoptimizer
  153005. */
  153006. export class TextureOptimization extends SceneOptimization {
  153007. /**
  153008. * Defines the priority of this optimization (0 by default which means first in the list)
  153009. */
  153010. priority: number;
  153011. /**
  153012. * 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
  153013. */
  153014. maximumSize: number;
  153015. /**
  153016. * Defines the factor (0.5 by default) used to scale down textures bigger than maximum sized allowed.
  153017. */
  153018. step: number;
  153019. /**
  153020. * Gets a string describing the action executed by the current optimization
  153021. * @returns description string
  153022. */
  153023. getDescription(): string;
  153024. /**
  153025. * Creates the TextureOptimization object
  153026. * @param priority defines the priority of this optimization (0 by default which means first in the list)
  153027. * @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
  153028. * @param step defines the factor (0.5 by default) used to scale down textures bigger than maximum sized allowed.
  153029. */
  153030. constructor(
  153031. /**
  153032. * Defines the priority of this optimization (0 by default which means first in the list)
  153033. */
  153034. priority?: number,
  153035. /**
  153036. * 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
  153037. */
  153038. maximumSize?: number,
  153039. /**
  153040. * Defines the factor (0.5 by default) used to scale down textures bigger than maximum sized allowed.
  153041. */
  153042. step?: number);
  153043. /**
  153044. * This function will be called by the SceneOptimizer when its priority is reached in order to apply the change required by the current optimization
  153045. * @param scene defines the current scene where to apply this optimization
  153046. * @param optimizer defines the current optimizer
  153047. * @returns true if everything that can be done was applied
  153048. */
  153049. apply(scene: Scene, optimizer: SceneOptimizer): boolean;
  153050. }
  153051. /**
  153052. * Defines an optimization used to increase or decrease the rendering resolution
  153053. * @description More details at https://doc.babylonjs.com/how_to/how_to_use_sceneoptimizer
  153054. */
  153055. export class HardwareScalingOptimization extends SceneOptimization {
  153056. /**
  153057. * Defines the priority of this optimization (0 by default which means first in the list)
  153058. */
  153059. priority: number;
  153060. /**
  153061. * Defines the maximum scale to use (2 by default)
  153062. */
  153063. maximumScale: number;
  153064. /**
  153065. * Defines the step to use between two passes (0.5 by default)
  153066. */
  153067. step: number;
  153068. private _currentScale;
  153069. private _directionOffset;
  153070. /**
  153071. * Gets a string describing the action executed by the current optimization
  153072. * @return description string
  153073. */
  153074. getDescription(): string;
  153075. /**
  153076. * Creates the HardwareScalingOptimization object
  153077. * @param priority defines the priority of this optimization (0 by default which means first in the list)
  153078. * @param maximumScale defines the maximum scale to use (2 by default)
  153079. * @param step defines the step to use between two passes (0.5 by default)
  153080. */
  153081. constructor(
  153082. /**
  153083. * Defines the priority of this optimization (0 by default which means first in the list)
  153084. */
  153085. priority?: number,
  153086. /**
  153087. * Defines the maximum scale to use (2 by default)
  153088. */
  153089. maximumScale?: number,
  153090. /**
  153091. * Defines the step to use between two passes (0.5 by default)
  153092. */
  153093. step?: number);
  153094. /**
  153095. * This function will be called by the SceneOptimizer when its priority is reached in order to apply the change required by the current optimization
  153096. * @param scene defines the current scene where to apply this optimization
  153097. * @param optimizer defines the current optimizer
  153098. * @returns true if everything that can be done was applied
  153099. */
  153100. apply(scene: Scene, optimizer: SceneOptimizer): boolean;
  153101. }
  153102. /**
  153103. * Defines an optimization used to remove shadows
  153104. * @description More details at https://doc.babylonjs.com/how_to/how_to_use_sceneoptimizer
  153105. */
  153106. export class ShadowsOptimization extends SceneOptimization {
  153107. /**
  153108. * Gets a string describing the action executed by the current optimization
  153109. * @return description string
  153110. */
  153111. getDescription(): string;
  153112. /**
  153113. * This function will be called by the SceneOptimizer when its priority is reached in order to apply the change required by the current optimization
  153114. * @param scene defines the current scene where to apply this optimization
  153115. * @param optimizer defines the current optimizer
  153116. * @returns true if everything that can be done was applied
  153117. */
  153118. apply(scene: Scene, optimizer: SceneOptimizer): boolean;
  153119. }
  153120. /**
  153121. * Defines an optimization used to turn post-processes off
  153122. * @description More details at https://doc.babylonjs.com/how_to/how_to_use_sceneoptimizer
  153123. */
  153124. export class PostProcessesOptimization extends SceneOptimization {
  153125. /**
  153126. * Gets a string describing the action executed by the current optimization
  153127. * @return description string
  153128. */
  153129. getDescription(): string;
  153130. /**
  153131. * This function will be called by the SceneOptimizer when its priority is reached in order to apply the change required by the current optimization
  153132. * @param scene defines the current scene where to apply this optimization
  153133. * @param optimizer defines the current optimizer
  153134. * @returns true if everything that can be done was applied
  153135. */
  153136. apply(scene: Scene, optimizer: SceneOptimizer): boolean;
  153137. }
  153138. /**
  153139. * Defines an optimization used to turn lens flares off
  153140. * @description More details at https://doc.babylonjs.com/how_to/how_to_use_sceneoptimizer
  153141. */
  153142. export class LensFlaresOptimization extends SceneOptimization {
  153143. /**
  153144. * Gets a string describing the action executed by the current optimization
  153145. * @return description string
  153146. */
  153147. getDescription(): string;
  153148. /**
  153149. * This function will be called by the SceneOptimizer when its priority is reached in order to apply the change required by the current optimization
  153150. * @param scene defines the current scene where to apply this optimization
  153151. * @param optimizer defines the current optimizer
  153152. * @returns true if everything that can be done was applied
  153153. */
  153154. apply(scene: Scene, optimizer: SceneOptimizer): boolean;
  153155. }
  153156. /**
  153157. * Defines an optimization based on user defined callback.
  153158. * @description More details at https://doc.babylonjs.com/how_to/how_to_use_sceneoptimizer
  153159. */
  153160. export class CustomOptimization extends SceneOptimization {
  153161. /**
  153162. * Callback called to apply the custom optimization.
  153163. */
  153164. onApply: (scene: Scene, optimizer: SceneOptimizer) => boolean;
  153165. /**
  153166. * Callback called to get custom description
  153167. */
  153168. onGetDescription: () => string;
  153169. /**
  153170. * Gets a string describing the action executed by the current optimization
  153171. * @returns description string
  153172. */
  153173. getDescription(): string;
  153174. /**
  153175. * This function will be called by the SceneOptimizer when its priority is reached in order to apply the change required by the current optimization
  153176. * @param scene defines the current scene where to apply this optimization
  153177. * @param optimizer defines the current optimizer
  153178. * @returns true if everything that can be done was applied
  153179. */
  153180. apply(scene: Scene, optimizer: SceneOptimizer): boolean;
  153181. }
  153182. /**
  153183. * Defines an optimization used to turn particles off
  153184. * @description More details at https://doc.babylonjs.com/how_to/how_to_use_sceneoptimizer
  153185. */
  153186. export class ParticlesOptimization extends SceneOptimization {
  153187. /**
  153188. * Gets a string describing the action executed by the current optimization
  153189. * @return description string
  153190. */
  153191. getDescription(): string;
  153192. /**
  153193. * This function will be called by the SceneOptimizer when its priority is reached in order to apply the change required by the current optimization
  153194. * @param scene defines the current scene where to apply this optimization
  153195. * @param optimizer defines the current optimizer
  153196. * @returns true if everything that can be done was applied
  153197. */
  153198. apply(scene: Scene, optimizer: SceneOptimizer): boolean;
  153199. }
  153200. /**
  153201. * Defines an optimization used to turn render targets off
  153202. * @description More details at https://doc.babylonjs.com/how_to/how_to_use_sceneoptimizer
  153203. */
  153204. export class RenderTargetsOptimization extends SceneOptimization {
  153205. /**
  153206. * Gets a string describing the action executed by the current optimization
  153207. * @return description string
  153208. */
  153209. getDescription(): string;
  153210. /**
  153211. * This function will be called by the SceneOptimizer when its priority is reached in order to apply the change required by the current optimization
  153212. * @param scene defines the current scene where to apply this optimization
  153213. * @param optimizer defines the current optimizer
  153214. * @returns true if everything that can be done was applied
  153215. */
  153216. apply(scene: Scene, optimizer: SceneOptimizer): boolean;
  153217. }
  153218. /**
  153219. * Defines an optimization used to merge meshes with compatible materials
  153220. * @description More details at https://doc.babylonjs.com/how_to/how_to_use_sceneoptimizer
  153221. */
  153222. export class MergeMeshesOptimization extends SceneOptimization {
  153223. private static _UpdateSelectionTree;
  153224. /**
  153225. * Gets or sets a boolean which defines if optimization octree has to be updated
  153226. */
  153227. static get UpdateSelectionTree(): boolean;
  153228. /**
  153229. * Gets or sets a boolean which defines if optimization octree has to be updated
  153230. */
  153231. static set UpdateSelectionTree(value: boolean);
  153232. /**
  153233. * Gets a string describing the action executed by the current optimization
  153234. * @return description string
  153235. */
  153236. getDescription(): string;
  153237. private _canBeMerged;
  153238. /**
  153239. * This function will be called by the SceneOptimizer when its priority is reached in order to apply the change required by the current optimization
  153240. * @param scene defines the current scene where to apply this optimization
  153241. * @param optimizer defines the current optimizer
  153242. * @param updateSelectionTree defines that the selection octree has to be updated (false by default)
  153243. * @returns true if everything that can be done was applied
  153244. */
  153245. apply(scene: Scene, optimizer: SceneOptimizer, updateSelectionTree?: boolean): boolean;
  153246. }
  153247. /**
  153248. * Defines a list of options used by SceneOptimizer
  153249. * @description More details at https://doc.babylonjs.com/how_to/how_to_use_sceneoptimizer
  153250. */
  153251. export class SceneOptimizerOptions {
  153252. /**
  153253. * Defines the target frame rate to reach (60 by default)
  153254. */
  153255. targetFrameRate: number;
  153256. /**
  153257. * Defines the interval between two checkes (2000ms by default)
  153258. */
  153259. trackerDuration: number;
  153260. /**
  153261. * Gets the list of optimizations to apply
  153262. */
  153263. optimizations: SceneOptimization[];
  153264. /**
  153265. * Creates a new list of options used by SceneOptimizer
  153266. * @param targetFrameRate defines the target frame rate to reach (60 by default)
  153267. * @param trackerDuration defines the interval between two checkes (2000ms by default)
  153268. */
  153269. constructor(
  153270. /**
  153271. * Defines the target frame rate to reach (60 by default)
  153272. */
  153273. targetFrameRate?: number,
  153274. /**
  153275. * Defines the interval between two checkes (2000ms by default)
  153276. */
  153277. trackerDuration?: number);
  153278. /**
  153279. * Add a new optimization
  153280. * @param optimization defines the SceneOptimization to add to the list of active optimizations
  153281. * @returns the current SceneOptimizerOptions
  153282. */
  153283. addOptimization(optimization: SceneOptimization): SceneOptimizerOptions;
  153284. /**
  153285. * Add a new custom optimization
  153286. * @param onApply defines the callback called to apply the custom optimization (true if everything that can be done was applied)
  153287. * @param onGetDescription defines the callback called to get the description attached with the optimization.
  153288. * @param priority defines the priority of this optimization (0 by default which means first in the list)
  153289. * @returns the current SceneOptimizerOptions
  153290. */
  153291. addCustomOptimization(onApply: (scene: Scene) => boolean, onGetDescription: () => string, priority?: number): SceneOptimizerOptions;
  153292. /**
  153293. * Creates a list of pre-defined optimizations aimed to reduce the visual impact on the scene
  153294. * @param targetFrameRate defines the target frame rate (60 by default)
  153295. * @returns a SceneOptimizerOptions object
  153296. */
  153297. static LowDegradationAllowed(targetFrameRate?: number): SceneOptimizerOptions;
  153298. /**
  153299. * Creates a list of pre-defined optimizations aimed to have a moderate impact on the scene visual
  153300. * @param targetFrameRate defines the target frame rate (60 by default)
  153301. * @returns a SceneOptimizerOptions object
  153302. */
  153303. static ModerateDegradationAllowed(targetFrameRate?: number): SceneOptimizerOptions;
  153304. /**
  153305. * Creates a list of pre-defined optimizations aimed to have a big impact on the scene visual
  153306. * @param targetFrameRate defines the target frame rate (60 by default)
  153307. * @returns a SceneOptimizerOptions object
  153308. */
  153309. static HighDegradationAllowed(targetFrameRate?: number): SceneOptimizerOptions;
  153310. }
  153311. /**
  153312. * Class used to run optimizations in order to reach a target frame rate
  153313. * @description More details at https://doc.babylonjs.com/how_to/how_to_use_sceneoptimizer
  153314. */
  153315. export class SceneOptimizer implements IDisposable {
  153316. private _isRunning;
  153317. private _options;
  153318. private _scene;
  153319. private _currentPriorityLevel;
  153320. private _targetFrameRate;
  153321. private _trackerDuration;
  153322. private _currentFrameRate;
  153323. private _sceneDisposeObserver;
  153324. private _improvementMode;
  153325. /**
  153326. * Defines an observable called when the optimizer reaches the target frame rate
  153327. */
  153328. onSuccessObservable: Observable<SceneOptimizer>;
  153329. /**
  153330. * Defines an observable called when the optimizer enables an optimization
  153331. */
  153332. onNewOptimizationAppliedObservable: Observable<SceneOptimization>;
  153333. /**
  153334. * Defines an observable called when the optimizer is not able to reach the target frame rate
  153335. */
  153336. onFailureObservable: Observable<SceneOptimizer>;
  153337. /**
  153338. * Gets a boolean indicating if the optimizer is in improvement mode
  153339. */
  153340. get isInImprovementMode(): boolean;
  153341. /**
  153342. * Gets the current priority level (0 at start)
  153343. */
  153344. get currentPriorityLevel(): number;
  153345. /**
  153346. * Gets the current frame rate checked by the SceneOptimizer
  153347. */
  153348. get currentFrameRate(): number;
  153349. /**
  153350. * Gets or sets the current target frame rate (60 by default)
  153351. */
  153352. get targetFrameRate(): number;
  153353. /**
  153354. * Gets or sets the current target frame rate (60 by default)
  153355. */
  153356. set targetFrameRate(value: number);
  153357. /**
  153358. * Gets or sets the current interval between two checks (every 2000ms by default)
  153359. */
  153360. get trackerDuration(): number;
  153361. /**
  153362. * Gets or sets the current interval between two checks (every 2000ms by default)
  153363. */
  153364. set trackerDuration(value: number);
  153365. /**
  153366. * Gets the list of active optimizations
  153367. */
  153368. get optimizations(): SceneOptimization[];
  153369. /**
  153370. * Creates a new SceneOptimizer
  153371. * @param scene defines the scene to work on
  153372. * @param options defines the options to use with the SceneOptimizer
  153373. * @param autoGeneratePriorities defines if priorities must be generated and not read from SceneOptimization property (true by default)
  153374. * @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)
  153375. */
  153376. constructor(scene: Scene, options?: SceneOptimizerOptions, autoGeneratePriorities?: boolean, improvementMode?: boolean);
  153377. /**
  153378. * Stops the current optimizer
  153379. */
  153380. stop(): void;
  153381. /**
  153382. * Reset the optimizer to initial step (current priority level = 0)
  153383. */
  153384. reset(): void;
  153385. /**
  153386. * Start the optimizer. By default it will try to reach a specific framerate
  153387. * but if the optimizer is set with improvementMode === true then it will run all optimiatiation while frame rate is above the target frame rate
  153388. */
  153389. start(): void;
  153390. private _checkCurrentState;
  153391. /**
  153392. * Release all resources
  153393. */
  153394. dispose(): void;
  153395. /**
  153396. * Helper function to create a SceneOptimizer with one single line of code
  153397. * @param scene defines the scene to work on
  153398. * @param options defines the options to use with the SceneOptimizer
  153399. * @param onSuccess defines a callback to call on success
  153400. * @param onFailure defines a callback to call on failure
  153401. * @returns the new SceneOptimizer object
  153402. */
  153403. static OptimizeAsync(scene: Scene, options?: SceneOptimizerOptions, onSuccess?: () => void, onFailure?: () => void): SceneOptimizer;
  153404. }
  153405. }
  153406. declare module BABYLON {
  153407. /**
  153408. * Class used to serialize a scene into a string
  153409. */
  153410. export class SceneSerializer {
  153411. /**
  153412. * Clear cache used by a previous serialization
  153413. */
  153414. static ClearCache(): void;
  153415. /**
  153416. * Serialize a scene into a JSON compatible object
  153417. * @param scene defines the scene to serialize
  153418. * @returns a JSON compatible object
  153419. */
  153420. static Serialize(scene: Scene): any;
  153421. /**
  153422. * Serialize a mesh into a JSON compatible object
  153423. * @param toSerialize defines the mesh to serialize
  153424. * @param withParents defines if parents must be serialized as well
  153425. * @param withChildren defines if children must be serialized as well
  153426. * @returns a JSON compatible object
  153427. */
  153428. static SerializeMesh(toSerialize: any, withParents?: boolean, withChildren?: boolean): any;
  153429. }
  153430. }
  153431. declare module BABYLON {
  153432. /**
  153433. * Class used to host texture specific utilities
  153434. */
  153435. export class TextureTools {
  153436. /**
  153437. * Uses the GPU to create a copy texture rescaled at a given size
  153438. * @param texture Texture to copy from
  153439. * @param width defines the desired width
  153440. * @param height defines the desired height
  153441. * @param useBilinearMode defines if bilinear mode has to be used
  153442. * @return the generated texture
  153443. */
  153444. static CreateResizedCopy(texture: Texture, width: number, height: number, useBilinearMode?: boolean): Texture;
  153445. }
  153446. }
  153447. declare module BABYLON {
  153448. /**
  153449. * This represents the different options available for the video capture.
  153450. */
  153451. export interface VideoRecorderOptions {
  153452. /** Defines the mime type of the video. */
  153453. mimeType: string;
  153454. /** Defines the FPS the video should be recorded at. */
  153455. fps: number;
  153456. /** Defines the chunk size for the recording data. */
  153457. recordChunckSize: number;
  153458. /** The audio tracks to attach to the recording. */
  153459. audioTracks?: MediaStreamTrack[];
  153460. }
  153461. /**
  153462. * This can help with recording videos from BabylonJS.
  153463. * This is based on the available WebRTC functionalities of the browser.
  153464. *
  153465. * @see https://doc.babylonjs.com/how_to/render_scene_on_a_video
  153466. */
  153467. export class VideoRecorder {
  153468. private static readonly _defaultOptions;
  153469. /**
  153470. * Returns whether or not the VideoRecorder is available in your browser.
  153471. * @param engine Defines the Babylon Engine.
  153472. * @returns true if supported otherwise false.
  153473. */
  153474. static IsSupported(engine: Engine): boolean;
  153475. private readonly _options;
  153476. private _canvas;
  153477. private _mediaRecorder;
  153478. private _recordedChunks;
  153479. private _fileName;
  153480. private _resolve;
  153481. private _reject;
  153482. /**
  153483. * True when a recording is already in progress.
  153484. */
  153485. get isRecording(): boolean;
  153486. /**
  153487. * Create a new VideoCapture object which can help converting what you see in Babylon to a video file.
  153488. * @param engine Defines the BabylonJS Engine you wish to record.
  153489. * @param options Defines options that can be used to customize the capture.
  153490. */
  153491. constructor(engine: Engine, options?: Nullable<VideoRecorderOptions>);
  153492. /**
  153493. * Stops the current recording before the default capture timeout passed in the startRecording function.
  153494. */
  153495. stopRecording(): void;
  153496. /**
  153497. * Starts recording the canvas for a max duration specified in parameters.
  153498. * @param fileName Defines the name of the file to be downloaded when the recording stop.
  153499. * If null no automatic download will start and you can rely on the promise to get the data back.
  153500. * @param maxDuration Defines the maximum recording time in seconds.
  153501. * It defaults to 7 seconds. A value of zero will not stop automatically, you would need to call stopRecording manually.
  153502. * @return A promise callback at the end of the recording with the video data in Blob.
  153503. */
  153504. startRecording(fileName?: Nullable<string>, maxDuration?: number): Promise<Blob>;
  153505. /**
  153506. * Releases internal resources used during the recording.
  153507. */
  153508. dispose(): void;
  153509. private _handleDataAvailable;
  153510. private _handleError;
  153511. private _handleStop;
  153512. }
  153513. }
  153514. declare module BABYLON {
  153515. /**
  153516. * Class containing a set of static utilities functions for screenshots
  153517. */
  153518. export class ScreenshotTools {
  153519. /**
  153520. * Captures a screenshot of the current rendering
  153521. * @see https://doc.babylonjs.com/how_to/render_scene_on_a_png
  153522. * @param engine defines the rendering engine
  153523. * @param camera defines the source camera
  153524. * @param size This parameter can be set to a single number or to an object with the
  153525. * following (optional) properties: precision, width, height. If a single number is passed,
  153526. * it will be used for both width and height. If an object is passed, the screenshot size
  153527. * will be derived from the parameters. The precision property is a multiplier allowing
  153528. * rendering at a higher or lower resolution
  153529. * @param successCallback defines the callback receives a single parameter which contains the
  153530. * screenshot as a string of base64-encoded characters. This string can be assigned to the
  153531. * src parameter of an <img> to display it
  153532. * @param mimeType defines the MIME type of the screenshot image (default: image/png).
  153533. * Check your browser for supported MIME types
  153534. */
  153535. static CreateScreenshot(engine: Engine, camera: Camera, size: IScreenshotSize | number, successCallback?: (data: string) => void, mimeType?: string): void;
  153536. /**
  153537. * Captures a screenshot of the current rendering
  153538. * @see https://doc.babylonjs.com/how_to/render_scene_on_a_png
  153539. * @param engine defines the rendering engine
  153540. * @param camera defines the source camera
  153541. * @param size This parameter can be set to a single number or to an object with the
  153542. * following (optional) properties: precision, width, height. If a single number is passed,
  153543. * it will be used for both width and height. If an object is passed, the screenshot size
  153544. * will be derived from the parameters. The precision property is a multiplier allowing
  153545. * rendering at a higher or lower resolution
  153546. * @param mimeType defines the MIME type of the screenshot image (default: image/png).
  153547. * Check your browser for supported MIME types
  153548. * @returns screenshot as a string of base64-encoded characters. This string can be assigned
  153549. * to the src parameter of an <img> to display it
  153550. */
  153551. static CreateScreenshotAsync(engine: Engine, camera: Camera, size: any, mimeType?: string): Promise<string>;
  153552. /**
  153553. * Generates an image screenshot from the specified camera.
  153554. * @see https://doc.babylonjs.com/how_to/render_scene_on_a_png
  153555. * @param engine The engine to use for rendering
  153556. * @param camera The camera to use for rendering
  153557. * @param size This parameter can be set to a single number or to an object with the
  153558. * following (optional) properties: precision, width, height. If a single number is passed,
  153559. * it will be used for both width and height. If an object is passed, the screenshot size
  153560. * will be derived from the parameters. The precision property is a multiplier allowing
  153561. * rendering at a higher or lower resolution
  153562. * @param successCallback The callback receives a single parameter which contains the
  153563. * screenshot as a string of base64-encoded characters. This string can be assigned to the
  153564. * src parameter of an <img> to display it
  153565. * @param mimeType The MIME type of the screenshot image (default: image/png).
  153566. * Check your browser for supported MIME types
  153567. * @param samples Texture samples (default: 1)
  153568. * @param antialiasing Whether antialiasing should be turned on or not (default: false)
  153569. * @param fileName A name for for the downloaded file.
  153570. * @param renderSprites Whether the sprites should be rendered or not (default: false)
  153571. * @param enableStencilBuffer Whether the stencil buffer should be enabled or not (default: false)
  153572. */
  153573. 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;
  153574. /**
  153575. * Generates an image screenshot from the specified camera.
  153576. * @see https://doc.babylonjs.com/how_to/render_scene_on_a_png
  153577. * @param engine The engine to use for rendering
  153578. * @param camera The camera to use for rendering
  153579. * @param size This parameter can be set to a single number or to an object with the
  153580. * following (optional) properties: precision, width, height. If a single number is passed,
  153581. * it will be used for both width and height. If an object is passed, the screenshot size
  153582. * will be derived from the parameters. The precision property is a multiplier allowing
  153583. * rendering at a higher or lower resolution
  153584. * @param mimeType The MIME type of the screenshot image (default: image/png).
  153585. * Check your browser for supported MIME types
  153586. * @param samples Texture samples (default: 1)
  153587. * @param antialiasing Whether antialiasing should be turned on or not (default: false)
  153588. * @param fileName A name for for the downloaded file.
  153589. * @param renderSprites Whether the sprites should be rendered or not (default: false)
  153590. * @returns screenshot as a string of base64-encoded characters. This string can be assigned
  153591. * to the src parameter of an <img> to display it
  153592. */
  153593. static CreateScreenshotUsingRenderTargetAsync(engine: Engine, camera: Camera, size: any, mimeType?: string, samples?: number, antialiasing?: boolean, fileName?: string, renderSprites?: boolean): Promise<string>;
  153594. /**
  153595. * Gets height and width for screenshot size
  153596. * @private
  153597. */
  153598. private static _getScreenshotSize;
  153599. }
  153600. }
  153601. declare module BABYLON {
  153602. /**
  153603. * Interface for a data buffer
  153604. */
  153605. export interface IDataBuffer {
  153606. /**
  153607. * Reads bytes from the data buffer.
  153608. * @param byteOffset The byte offset to read
  153609. * @param byteLength The byte length to read
  153610. * @returns A promise that resolves when the bytes are read
  153611. */
  153612. readAsync(byteOffset: number, byteLength: number): Promise<ArrayBufferView>;
  153613. /**
  153614. * The byte length of the buffer.
  153615. */
  153616. readonly byteLength: number;
  153617. }
  153618. /**
  153619. * Utility class for reading from a data buffer
  153620. */
  153621. export class DataReader {
  153622. /**
  153623. * The data buffer associated with this data reader.
  153624. */
  153625. readonly buffer: IDataBuffer;
  153626. /**
  153627. * The current byte offset from the beginning of the data buffer.
  153628. */
  153629. byteOffset: number;
  153630. private _dataView;
  153631. private _dataByteOffset;
  153632. /**
  153633. * Constructor
  153634. * @param buffer The buffer to read
  153635. */
  153636. constructor(buffer: IDataBuffer);
  153637. /**
  153638. * Loads the given byte length.
  153639. * @param byteLength The byte length to load
  153640. * @returns A promise that resolves when the load is complete
  153641. */
  153642. loadAsync(byteLength: number): Promise<void>;
  153643. /**
  153644. * Read a unsigned 32-bit integer from the currently loaded data range.
  153645. * @returns The 32-bit integer read
  153646. */
  153647. readUint32(): number;
  153648. /**
  153649. * Read a byte array from the currently loaded data range.
  153650. * @param byteLength The byte length to read
  153651. * @returns The byte array read
  153652. */
  153653. readUint8Array(byteLength: number): Uint8Array;
  153654. /**
  153655. * Read a string from the currently loaded data range.
  153656. * @param byteLength The byte length to read
  153657. * @returns The string read
  153658. */
  153659. readString(byteLength: number): string;
  153660. /**
  153661. * Skips the given byte length the currently loaded data range.
  153662. * @param byteLength The byte length to skip
  153663. */
  153664. skipBytes(byteLength: number): void;
  153665. }
  153666. }
  153667. declare module BABYLON {
  153668. /**
  153669. * Class for storing data to local storage if available or in-memory storage otherwise
  153670. */
  153671. export class DataStorage {
  153672. private static _Storage;
  153673. private static _GetStorage;
  153674. /**
  153675. * Reads a string from the data storage
  153676. * @param key The key to read
  153677. * @param defaultValue The value if the key doesn't exist
  153678. * @returns The string value
  153679. */
  153680. static ReadString(key: string, defaultValue: string): string;
  153681. /**
  153682. * Writes a string to the data storage
  153683. * @param key The key to write
  153684. * @param value The value to write
  153685. */
  153686. static WriteString(key: string, value: string): void;
  153687. /**
  153688. * Reads a boolean from the data storage
  153689. * @param key The key to read
  153690. * @param defaultValue The value if the key doesn't exist
  153691. * @returns The boolean value
  153692. */
  153693. static ReadBoolean(key: string, defaultValue: boolean): boolean;
  153694. /**
  153695. * Writes a boolean to the data storage
  153696. * @param key The key to write
  153697. * @param value The value to write
  153698. */
  153699. static WriteBoolean(key: string, value: boolean): void;
  153700. /**
  153701. * Reads a number from the data storage
  153702. * @param key The key to read
  153703. * @param defaultValue The value if the key doesn't exist
  153704. * @returns The number value
  153705. */
  153706. static ReadNumber(key: string, defaultValue: number): number;
  153707. /**
  153708. * Writes a number to the data storage
  153709. * @param key The key to write
  153710. * @param value The value to write
  153711. */
  153712. static WriteNumber(key: string, value: number): void;
  153713. }
  153714. }
  153715. declare module BABYLON {
  153716. /**
  153717. * Class used to record delta files between 2 scene states
  153718. */
  153719. export class SceneRecorder {
  153720. private _trackedScene;
  153721. private _savedJSON;
  153722. /**
  153723. * Track a given scene. This means the current scene state will be considered the original state
  153724. * @param scene defines the scene to track
  153725. */
  153726. track(scene: Scene): void;
  153727. /**
  153728. * Get the delta between current state and original state
  153729. * @returns a string containing the delta
  153730. */
  153731. getDelta(): any;
  153732. private _compareArray;
  153733. private _compareObjects;
  153734. private _compareCollections;
  153735. private static GetShadowGeneratorById;
  153736. /**
  153737. * Apply a given delta to a given scene
  153738. * @param deltaJSON defines the JSON containing the delta
  153739. * @param scene defines the scene to apply the delta to
  153740. */
  153741. static ApplyDelta(deltaJSON: any | string, scene: Scene): void;
  153742. private static _ApplyPropertiesToEntity;
  153743. private static _ApplyDeltaForEntity;
  153744. }
  153745. }
  153746. declare module BABYLON {
  153747. /**
  153748. * An interface for all Hit test features
  153749. */
  153750. export interface IWebXRHitTestFeature<T extends IWebXRLegacyHitResult> extends IWebXRFeature {
  153751. /**
  153752. * Triggered when new babylon (transformed) hit test results are available
  153753. */
  153754. onHitTestResultObservable: Observable<T[]>;
  153755. }
  153756. /**
  153757. * Options used for hit testing
  153758. */
  153759. export interface IWebXRLegacyHitTestOptions {
  153760. /**
  153761. * Only test when user interacted with the scene. Default - hit test every frame
  153762. */
  153763. testOnPointerDownOnly?: boolean;
  153764. /**
  153765. * The node to use to transform the local results to world coordinates
  153766. */
  153767. worldParentNode?: TransformNode;
  153768. }
  153769. /**
  153770. * Interface defining the babylon result of raycasting/hit-test
  153771. */
  153772. export interface IWebXRLegacyHitResult {
  153773. /**
  153774. * Transformation matrix that can be applied to a node that will put it in the hit point location
  153775. */
  153776. transformationMatrix: Matrix;
  153777. /**
  153778. * The native hit test result
  153779. */
  153780. xrHitResult: XRHitResult | XRHitTestResult;
  153781. }
  153782. /**
  153783. * The currently-working hit-test module.
  153784. * Hit test (or Ray-casting) is used to interact with the real world.
  153785. * For further information read here - https://github.com/immersive-web/hit-test
  153786. */
  153787. export class WebXRHitTestLegacy extends WebXRAbstractFeature implements IWebXRHitTestFeature<IWebXRLegacyHitResult> {
  153788. /**
  153789. * options to use when constructing this feature
  153790. */
  153791. readonly options: IWebXRLegacyHitTestOptions;
  153792. private _direction;
  153793. private _mat;
  153794. private _onSelectEnabled;
  153795. private _origin;
  153796. /**
  153797. * The module's name
  153798. */
  153799. static readonly Name: string;
  153800. /**
  153801. * The (Babylon) version of this module.
  153802. * This is an integer representing the implementation version.
  153803. * This number does not correspond to the WebXR specs version
  153804. */
  153805. static readonly Version: number;
  153806. /**
  153807. * Populated with the last native XR Hit Results
  153808. */
  153809. lastNativeXRHitResults: XRHitResult[];
  153810. /**
  153811. * Triggered when new babylon (transformed) hit test results are available
  153812. */
  153813. onHitTestResultObservable: Observable<IWebXRLegacyHitResult[]>;
  153814. /**
  153815. * Creates a new instance of the (legacy version) hit test feature
  153816. * @param _xrSessionManager an instance of WebXRSessionManager
  153817. * @param options options to use when constructing this feature
  153818. */
  153819. constructor(_xrSessionManager: WebXRSessionManager,
  153820. /**
  153821. * options to use when constructing this feature
  153822. */
  153823. options?: IWebXRLegacyHitTestOptions);
  153824. /**
  153825. * execute a hit test with an XR Ray
  153826. *
  153827. * @param xrSession a native xrSession that will execute this hit test
  153828. * @param xrRay the ray (position and direction) to use for ray-casting
  153829. * @param referenceSpace native XR reference space to use for the hit-test
  153830. * @param filter filter function that will filter the results
  153831. * @returns a promise that resolves with an array of native XR hit result in xr coordinates system
  153832. */
  153833. static XRHitTestWithRay(xrSession: XRSession, xrRay: XRRay, referenceSpace: XRReferenceSpace, filter?: (result: XRHitResult) => boolean): Promise<XRHitResult[]>;
  153834. /**
  153835. * Execute a hit test on the current running session using a select event returned from a transient input (such as touch)
  153836. * @param event the (select) event to use to select with
  153837. * @param referenceSpace the reference space to use for this hit test
  153838. * @returns a promise that resolves with an array of native XR hit result in xr coordinates system
  153839. */
  153840. static XRHitTestWithSelectEvent(event: XRInputSourceEvent, referenceSpace: XRReferenceSpace): Promise<XRHitResult[]>;
  153841. /**
  153842. * attach this feature
  153843. * Will usually be called by the features manager
  153844. *
  153845. * @returns true if successful.
  153846. */
  153847. attach(): boolean;
  153848. /**
  153849. * detach this feature.
  153850. * Will usually be called by the features manager
  153851. *
  153852. * @returns true if successful.
  153853. */
  153854. detach(): boolean;
  153855. /**
  153856. * Dispose this feature and all of the resources attached
  153857. */
  153858. dispose(): void;
  153859. protected _onXRFrame(frame: XRFrame): void;
  153860. private _onHitTestResults;
  153861. private _onSelect;
  153862. }
  153863. }
  153864. declare module BABYLON {
  153865. /**
  153866. * Options used for hit testing (version 2)
  153867. */
  153868. export interface IWebXRHitTestOptions extends IWebXRLegacyHitTestOptions {
  153869. /**
  153870. * Do not create a permanent hit test. Will usually be used when only
  153871. * transient inputs are needed.
  153872. */
  153873. disablePermanentHitTest?: boolean;
  153874. /**
  153875. * Enable transient (for example touch-based) hit test inspections
  153876. */
  153877. enableTransientHitTest?: boolean;
  153878. /**
  153879. * Offset ray for the permanent hit test
  153880. */
  153881. offsetRay?: Vector3;
  153882. /**
  153883. * Offset ray for the transient hit test
  153884. */
  153885. transientOffsetRay?: Vector3;
  153886. /**
  153887. * Instead of using viewer space for hit tests, use the reference space defined in the session manager
  153888. */
  153889. useReferenceSpace?: boolean;
  153890. /**
  153891. * Override the default entity type(s) of the hit-test result
  153892. */
  153893. entityTypes?: XRHitTestTrackableType[];
  153894. }
  153895. /**
  153896. * Interface defining the babylon result of hit-test
  153897. */
  153898. export interface IWebXRHitResult extends IWebXRLegacyHitResult {
  153899. /**
  153900. * The input source that generated this hit test (if transient)
  153901. */
  153902. inputSource?: XRInputSource;
  153903. /**
  153904. * Is this a transient hit test
  153905. */
  153906. isTransient?: boolean;
  153907. /**
  153908. * Position of the hit test result
  153909. */
  153910. position: Vector3;
  153911. /**
  153912. * Rotation of the hit test result
  153913. */
  153914. rotationQuaternion: Quaternion;
  153915. /**
  153916. * The native hit test result
  153917. */
  153918. xrHitResult: XRHitTestResult;
  153919. }
  153920. /**
  153921. * The currently-working hit-test module.
  153922. * Hit test (or Ray-casting) is used to interact with the real world.
  153923. * For further information read here - https://github.com/immersive-web/hit-test
  153924. *
  153925. * Tested on chrome (mobile) 80.
  153926. */
  153927. export class WebXRHitTest extends WebXRAbstractFeature implements IWebXRHitTestFeature<IWebXRHitResult> {
  153928. /**
  153929. * options to use when constructing this feature
  153930. */
  153931. readonly options: IWebXRHitTestOptions;
  153932. private _tmpMat;
  153933. private _tmpPos;
  153934. private _tmpQuat;
  153935. private _transientXrHitTestSource;
  153936. private _xrHitTestSource;
  153937. private initHitTestSource;
  153938. /**
  153939. * The module's name
  153940. */
  153941. static readonly Name: string;
  153942. /**
  153943. * The (Babylon) version of this module.
  153944. * This is an integer representing the implementation version.
  153945. * This number does not correspond to the WebXR specs version
  153946. */
  153947. static readonly Version: number;
  153948. /**
  153949. * When set to true, each hit test will have its own position/rotation objects
  153950. * When set to false, position and rotation objects will be reused for each hit test. It is expected that
  153951. * the developers will clone them or copy them as they see fit.
  153952. */
  153953. autoCloneTransformation: boolean;
  153954. /**
  153955. * Triggered when new babylon (transformed) hit test results are available
  153956. */
  153957. onHitTestResultObservable: Observable<IWebXRHitResult[]>;
  153958. /**
  153959. * Use this to temporarily pause hit test checks.
  153960. */
  153961. paused: boolean;
  153962. /**
  153963. * Creates a new instance of the hit test feature
  153964. * @param _xrSessionManager an instance of WebXRSessionManager
  153965. * @param options options to use when constructing this feature
  153966. */
  153967. constructor(_xrSessionManager: WebXRSessionManager,
  153968. /**
  153969. * options to use when constructing this feature
  153970. */
  153971. options?: IWebXRHitTestOptions);
  153972. /**
  153973. * attach this feature
  153974. * Will usually be called by the features manager
  153975. *
  153976. * @returns true if successful.
  153977. */
  153978. attach(): boolean;
  153979. /**
  153980. * detach this feature.
  153981. * Will usually be called by the features manager
  153982. *
  153983. * @returns true if successful.
  153984. */
  153985. detach(): boolean;
  153986. /**
  153987. * Dispose this feature and all of the resources attached
  153988. */
  153989. dispose(): void;
  153990. protected _onXRFrame(frame: XRFrame): void;
  153991. private _processWebXRHitTestResult;
  153992. }
  153993. }
  153994. declare module BABYLON {
  153995. /**
  153996. * Configuration options of the anchor system
  153997. */
  153998. export interface IWebXRAnchorSystemOptions {
  153999. /**
  154000. * a node that will be used to convert local to world coordinates
  154001. */
  154002. worldParentNode?: TransformNode;
  154003. /**
  154004. * If set to true a reference of the created anchors will be kept until the next session starts
  154005. * If not defined, anchors will be removed from the array when the feature is detached or the session ended.
  154006. */
  154007. doNotRemoveAnchorsOnSessionEnded?: boolean;
  154008. }
  154009. /**
  154010. * A babylon container for an XR Anchor
  154011. */
  154012. export interface IWebXRAnchor {
  154013. /**
  154014. * A babylon-assigned ID for this anchor
  154015. */
  154016. id: number;
  154017. /**
  154018. * Transformation matrix to apply to an object attached to this anchor
  154019. */
  154020. transformationMatrix: Matrix;
  154021. /**
  154022. * The native anchor object
  154023. */
  154024. xrAnchor: XRAnchor;
  154025. /**
  154026. * if defined, this object will be constantly updated by the anchor's position and rotation
  154027. */
  154028. attachedNode?: TransformNode;
  154029. }
  154030. /**
  154031. * An implementation of the anchor system for WebXR.
  154032. * For further information see https://github.com/immersive-web/anchors/
  154033. */
  154034. export class WebXRAnchorSystem extends WebXRAbstractFeature {
  154035. private _options;
  154036. private _lastFrameDetected;
  154037. private _trackedAnchors;
  154038. private _referenceSpaceForFrameAnchors;
  154039. private _futureAnchors;
  154040. /**
  154041. * The module's name
  154042. */
  154043. static readonly Name: string;
  154044. /**
  154045. * The (Babylon) version of this module.
  154046. * This is an integer representing the implementation version.
  154047. * This number does not correspond to the WebXR specs version
  154048. */
  154049. static readonly Version: number;
  154050. /**
  154051. * Observers registered here will be executed when a new anchor was added to the session
  154052. */
  154053. onAnchorAddedObservable: Observable<IWebXRAnchor>;
  154054. /**
  154055. * Observers registered here will be executed when an anchor was removed from the session
  154056. */
  154057. onAnchorRemovedObservable: Observable<IWebXRAnchor>;
  154058. /**
  154059. * Observers registered here will be executed when an existing anchor updates
  154060. * This can execute N times every frame
  154061. */
  154062. onAnchorUpdatedObservable: Observable<IWebXRAnchor>;
  154063. /**
  154064. * Set the reference space to use for anchor creation, when not using a hit test.
  154065. * Will default to the session's reference space if not defined
  154066. */
  154067. set referenceSpaceForFrameAnchors(referenceSpace: XRReferenceSpace);
  154068. /**
  154069. * constructs a new anchor system
  154070. * @param _xrSessionManager an instance of WebXRSessionManager
  154071. * @param _options configuration object for this feature
  154072. */
  154073. constructor(_xrSessionManager: WebXRSessionManager, _options?: IWebXRAnchorSystemOptions);
  154074. private _tmpVector;
  154075. private _tmpQuaternion;
  154076. private _populateTmpTransformation;
  154077. /**
  154078. * Create a new anchor point using a hit test result at a specific point in the scene
  154079. * An anchor is tracked only after it is added to the trackerAnchors in xrFrame. The promise returned here does not yet guaranty that.
  154080. * Use onAnchorAddedObservable to get newly added anchors if you require tracking guaranty.
  154081. *
  154082. * @param hitTestResult The hit test result to use for this anchor creation
  154083. * @param position an optional position offset for this anchor
  154084. * @param rotationQuaternion an optional rotation offset for this anchor
  154085. * @returns A promise that fulfills when the XR anchor was registered in the system (but not necessarily added to the tracked anchors)
  154086. */
  154087. addAnchorPointUsingHitTestResultAsync(hitTestResult: IWebXRHitResult, position?: Vector3, rotationQuaternion?: Quaternion): Promise<XRAnchor>;
  154088. /**
  154089. * Add a new anchor at a specific position and rotation
  154090. * This function will add a new anchor per default in the next available frame. Unless forced, the createAnchor function
  154091. * will be called in the next xrFrame loop to make sure that the anchor can be created correctly.
  154092. * An anchor is tracked only after it is added to the trackerAnchors in xrFrame. The promise returned here does not yet guaranty that.
  154093. * Use onAnchorAddedObservable to get newly added anchors if you require tracking guaranty.
  154094. *
  154095. * @param position the position in which to add an anchor
  154096. * @param rotationQuaternion an optional rotation for the anchor transformation
  154097. * @param forceCreateInCurrentFrame force the creation of this anchor in the current frame. Must be called inside xrFrame loop!
  154098. * @returns A promise that fulfills when the XR anchor was registered in the system (but not necessarily added to the tracked anchors)
  154099. */
  154100. addAnchorAtPositionAndRotationAsync(position: Vector3, rotationQuaternion?: Quaternion, forceCreateInCurrentFrame?: boolean): Promise<XRAnchor>;
  154101. /**
  154102. * detach this feature.
  154103. * Will usually be called by the features manager
  154104. *
  154105. * @returns true if successful.
  154106. */
  154107. detach(): boolean;
  154108. /**
  154109. * Dispose this feature and all of the resources attached
  154110. */
  154111. dispose(): void;
  154112. protected _onXRFrame(frame: XRFrame): void;
  154113. /**
  154114. * avoiding using Array.find for global support.
  154115. * @param xrAnchor the plane to find in the array
  154116. */
  154117. private _findIndexInAnchorArray;
  154118. private _updateAnchorWithXRFrame;
  154119. private _createAnchorAtTransformation;
  154120. }
  154121. }
  154122. declare module BABYLON {
  154123. /**
  154124. * Options used in the plane detector module
  154125. */
  154126. export interface IWebXRPlaneDetectorOptions {
  154127. /**
  154128. * The node to use to transform the local results to world coordinates
  154129. */
  154130. worldParentNode?: TransformNode;
  154131. /**
  154132. * If set to true a reference of the created planes will be kept until the next session starts
  154133. * If not defined, planes will be removed from the array when the feature is detached or the session ended.
  154134. */
  154135. doNotRemovePlanesOnSessionEnded?: boolean;
  154136. }
  154137. /**
  154138. * A babylon interface for a WebXR plane.
  154139. * A Plane is actually a polygon, built from N points in space
  154140. *
  154141. * Supported in chrome 79, not supported in canary 81 ATM
  154142. */
  154143. export interface IWebXRPlane {
  154144. /**
  154145. * a babylon-assigned ID for this polygon
  154146. */
  154147. id: number;
  154148. /**
  154149. * an array of vector3 points in babylon space. right/left hand system is taken into account.
  154150. */
  154151. polygonDefinition: Array<Vector3>;
  154152. /**
  154153. * A transformation matrix to apply on the mesh that will be built using the polygonDefinition
  154154. * Local vs. World are decided if worldParentNode was provided or not in the options when constructing the module
  154155. */
  154156. transformationMatrix: Matrix;
  154157. /**
  154158. * the native xr-plane object
  154159. */
  154160. xrPlane: XRPlane;
  154161. }
  154162. /**
  154163. * The plane detector is used to detect planes in the real world when in AR
  154164. * For more information see https://github.com/immersive-web/real-world-geometry/
  154165. */
  154166. export class WebXRPlaneDetector extends WebXRAbstractFeature {
  154167. private _options;
  154168. private _detectedPlanes;
  154169. private _enabled;
  154170. private _lastFrameDetected;
  154171. /**
  154172. * The module's name
  154173. */
  154174. static readonly Name: string;
  154175. /**
  154176. * The (Babylon) version of this module.
  154177. * This is an integer representing the implementation version.
  154178. * This number does not correspond to the WebXR specs version
  154179. */
  154180. static readonly Version: number;
  154181. /**
  154182. * Observers registered here will be executed when a new plane was added to the session
  154183. */
  154184. onPlaneAddedObservable: Observable<IWebXRPlane>;
  154185. /**
  154186. * Observers registered here will be executed when a plane is no longer detected in the session
  154187. */
  154188. onPlaneRemovedObservable: Observable<IWebXRPlane>;
  154189. /**
  154190. * Observers registered here will be executed when an existing plane updates (for example - expanded)
  154191. * This can execute N times every frame
  154192. */
  154193. onPlaneUpdatedObservable: Observable<IWebXRPlane>;
  154194. /**
  154195. * construct a new Plane Detector
  154196. * @param _xrSessionManager an instance of xr Session manager
  154197. * @param _options configuration to use when constructing this feature
  154198. */
  154199. constructor(_xrSessionManager: WebXRSessionManager, _options?: IWebXRPlaneDetectorOptions);
  154200. /**
  154201. * detach this feature.
  154202. * Will usually be called by the features manager
  154203. *
  154204. * @returns true if successful.
  154205. */
  154206. detach(): boolean;
  154207. /**
  154208. * Dispose this feature and all of the resources attached
  154209. */
  154210. dispose(): void;
  154211. protected _onXRFrame(frame: XRFrame): void;
  154212. private _init;
  154213. private _updatePlaneWithXRPlane;
  154214. /**
  154215. * avoiding using Array.find for global support.
  154216. * @param xrPlane the plane to find in the array
  154217. */
  154218. private findIndexInPlaneArray;
  154219. }
  154220. }
  154221. declare module BABYLON {
  154222. /**
  154223. * Options interface for the background remover plugin
  154224. */
  154225. export interface IWebXRBackgroundRemoverOptions {
  154226. /**
  154227. * Further background meshes to disable when entering AR
  154228. */
  154229. backgroundMeshes?: AbstractMesh[];
  154230. /**
  154231. * flags to configure the removal of the environment helper.
  154232. * If not set, the entire background will be removed. If set, flags should be set as well.
  154233. */
  154234. environmentHelperRemovalFlags?: {
  154235. /**
  154236. * Should the skybox be removed (default false)
  154237. */
  154238. skyBox?: boolean;
  154239. /**
  154240. * Should the ground be removed (default false)
  154241. */
  154242. ground?: boolean;
  154243. };
  154244. /**
  154245. * don't disable the environment helper
  154246. */
  154247. ignoreEnvironmentHelper?: boolean;
  154248. }
  154249. /**
  154250. * A module that will automatically disable background meshes when entering AR and will enable them when leaving AR.
  154251. */
  154252. export class WebXRBackgroundRemover extends WebXRAbstractFeature {
  154253. /**
  154254. * read-only options to be used in this module
  154255. */
  154256. readonly options: IWebXRBackgroundRemoverOptions;
  154257. /**
  154258. * The module's name
  154259. */
  154260. static readonly Name: string;
  154261. /**
  154262. * The (Babylon) version of this module.
  154263. * This is an integer representing the implementation version.
  154264. * This number does not correspond to the WebXR specs version
  154265. */
  154266. static readonly Version: number;
  154267. /**
  154268. * registered observers will be triggered when the background state changes
  154269. */
  154270. onBackgroundStateChangedObservable: Observable<boolean>;
  154271. /**
  154272. * constructs a new background remover module
  154273. * @param _xrSessionManager the session manager for this module
  154274. * @param options read-only options to be used in this module
  154275. */
  154276. constructor(_xrSessionManager: WebXRSessionManager,
  154277. /**
  154278. * read-only options to be used in this module
  154279. */
  154280. options?: IWebXRBackgroundRemoverOptions);
  154281. /**
  154282. * attach this feature
  154283. * Will usually be called by the features manager
  154284. *
  154285. * @returns true if successful.
  154286. */
  154287. attach(): boolean;
  154288. /**
  154289. * detach this feature.
  154290. * Will usually be called by the features manager
  154291. *
  154292. * @returns true if successful.
  154293. */
  154294. detach(): boolean;
  154295. /**
  154296. * Dispose this feature and all of the resources attached
  154297. */
  154298. dispose(): void;
  154299. protected _onXRFrame(_xrFrame: XRFrame): void;
  154300. private _setBackgroundState;
  154301. }
  154302. }
  154303. declare module BABYLON {
  154304. /**
  154305. * Options for the controller physics feature
  154306. */
  154307. export class IWebXRControllerPhysicsOptions {
  154308. /**
  154309. * Should the headset get its own impostor
  154310. */
  154311. enableHeadsetImpostor?: boolean;
  154312. /**
  154313. * Optional parameters for the headset impostor
  154314. */
  154315. headsetImpostorParams?: {
  154316. /**
  154317. * The type of impostor to create. Default is sphere
  154318. */
  154319. impostorType: number;
  154320. /**
  154321. * the size of the impostor. Defaults to 10cm
  154322. */
  154323. impostorSize?: number | {
  154324. width: number;
  154325. height: number;
  154326. depth: number;
  154327. };
  154328. /**
  154329. * Friction definitions
  154330. */
  154331. friction?: number;
  154332. /**
  154333. * Restitution
  154334. */
  154335. restitution?: number;
  154336. };
  154337. /**
  154338. * The physics properties of the future impostors
  154339. */
  154340. physicsProperties?: {
  154341. /**
  154342. * If set to true, a mesh impostor will be created when the controller mesh was loaded
  154343. * Note that this requires a physics engine that supports mesh impostors!
  154344. */
  154345. useControllerMesh?: boolean;
  154346. /**
  154347. * The type of impostor to create. Default is sphere
  154348. */
  154349. impostorType?: number;
  154350. /**
  154351. * the size of the impostor. Defaults to 10cm
  154352. */
  154353. impostorSize?: number | {
  154354. width: number;
  154355. height: number;
  154356. depth: number;
  154357. };
  154358. /**
  154359. * Friction definitions
  154360. */
  154361. friction?: number;
  154362. /**
  154363. * Restitution
  154364. */
  154365. restitution?: number;
  154366. };
  154367. /**
  154368. * the xr input to use with this pointer selection
  154369. */
  154370. xrInput: WebXRInput;
  154371. }
  154372. /**
  154373. * Add physics impostor to your webxr controllers,
  154374. * including naive calculation of their linear and angular velocity
  154375. */
  154376. export class WebXRControllerPhysics extends WebXRAbstractFeature {
  154377. private readonly _options;
  154378. private _attachController;
  154379. private _controllers;
  154380. private _debugMode;
  154381. private _delta;
  154382. private _headsetImpostor?;
  154383. private _headsetMesh?;
  154384. private _lastTimestamp;
  154385. private _tmpQuaternion;
  154386. private _tmpVector;
  154387. /**
  154388. * The module's name
  154389. */
  154390. static readonly Name: string;
  154391. /**
  154392. * The (Babylon) version of this module.
  154393. * This is an integer representing the implementation version.
  154394. * This number does not correspond to the webxr specs version
  154395. */
  154396. static readonly Version: number;
  154397. /**
  154398. * Construct a new Controller Physics Feature
  154399. * @param _xrSessionManager the corresponding xr session manager
  154400. * @param _options options to create this feature with
  154401. */
  154402. constructor(_xrSessionManager: WebXRSessionManager, _options: IWebXRControllerPhysicsOptions);
  154403. /**
  154404. * @hidden
  154405. * enable debugging - will show console outputs and the impostor mesh
  154406. */
  154407. _enablePhysicsDebug(): void;
  154408. /**
  154409. * Manually add a controller (if no xrInput was provided or physics engine was not enabled)
  154410. * @param xrController the controller to add
  154411. */
  154412. addController(xrController: WebXRInputSource): void;
  154413. /**
  154414. * attach this feature
  154415. * Will usually be called by the features manager
  154416. *
  154417. * @returns true if successful.
  154418. */
  154419. attach(): boolean;
  154420. /**
  154421. * detach this feature.
  154422. * Will usually be called by the features manager
  154423. *
  154424. * @returns true if successful.
  154425. */
  154426. detach(): boolean;
  154427. /**
  154428. * Get the headset impostor, if enabled
  154429. * @returns the impostor
  154430. */
  154431. getHeadsetImpostor(): PhysicsImpostor | undefined;
  154432. /**
  154433. * Get the physics impostor of a specific controller.
  154434. * The impostor is not attached to a mesh because a mesh for each controller is not obligatory
  154435. * @param controller the controller or the controller id of which to get the impostor
  154436. * @returns the impostor or null
  154437. */
  154438. getImpostorForController(controller: WebXRInputSource | string): Nullable<PhysicsImpostor>;
  154439. /**
  154440. * Update the physics properties provided in the constructor
  154441. * @param newProperties the new properties object
  154442. */
  154443. setPhysicsProperties(newProperties: {
  154444. impostorType?: number;
  154445. impostorSize?: number | {
  154446. width: number;
  154447. height: number;
  154448. depth: number;
  154449. };
  154450. friction?: number;
  154451. restitution?: number;
  154452. }): void;
  154453. protected _onXRFrame(_xrFrame: any): void;
  154454. private _detachController;
  154455. }
  154456. }
  154457. declare module BABYLON {
  154458. /**
  154459. * A babylon interface for a "WebXR" feature point.
  154460. * Represents the position and confidence value of a given feature point.
  154461. */
  154462. export interface IWebXRFeaturePoint {
  154463. /**
  154464. * Represents the position of the feature point in world space.
  154465. */
  154466. position: Vector3;
  154467. /**
  154468. * Represents the confidence value of the feature point in world space. 0 being least confident, and 1 being most confident.
  154469. */
  154470. confidenceValue: number;
  154471. }
  154472. /**
  154473. * The feature point system is used to detect feature points from real world geometry.
  154474. * This feature is currently experimental and only supported on BabylonNative, and should not be used in the browser.
  154475. * The newly introduced API can be seen in webxr.nativeextensions.d.ts and described in FeaturePoints.md.
  154476. */
  154477. export class WebXRFeaturePointSystem extends WebXRAbstractFeature {
  154478. private _enabled;
  154479. private _featurePointCloud;
  154480. /**
  154481. * The module's name
  154482. */
  154483. static readonly Name: string;
  154484. /**
  154485. * The (Babylon) version of this module.
  154486. * This is an integer representing the implementation version.
  154487. * This number does not correspond to the WebXR specs version
  154488. */
  154489. static readonly Version: number;
  154490. /**
  154491. * Observers registered here will be executed whenever new feature points are added (on XRFrame while the session is tracking).
  154492. * Will notify the observers about which feature points have been added.
  154493. */
  154494. readonly onFeaturePointsAddedObservable: Observable<number[]>;
  154495. /**
  154496. * Observers registered here will be executed whenever a feature point has been updated (on XRFrame while the session is tracking).
  154497. * Will notify the observers about which feature points have been updated.
  154498. */
  154499. readonly onFeaturePointsUpdatedObservable: Observable<number[]>;
  154500. /**
  154501. * The current feature point cloud maintained across frames.
  154502. */
  154503. get featurePointCloud(): Array<IWebXRFeaturePoint>;
  154504. /**
  154505. * construct the feature point system
  154506. * @param _xrSessionManager an instance of xr Session manager
  154507. */
  154508. constructor(_xrSessionManager: WebXRSessionManager);
  154509. /**
  154510. * Detach this feature.
  154511. * Will usually be called by the features manager
  154512. *
  154513. * @returns true if successful.
  154514. */
  154515. detach(): boolean;
  154516. /**
  154517. * Dispose this feature and all of the resources attached
  154518. */
  154519. dispose(): void;
  154520. /**
  154521. * On receiving a new XR frame if this feature is attached notify observers new feature point data is available.
  154522. */
  154523. protected _onXRFrame(frame: XRFrame): void;
  154524. /**
  154525. * Initializes the feature. If the feature point feature is not available for this environment do not mark the feature as enabled.
  154526. */
  154527. private _init;
  154528. }
  154529. }
  154530. declare module BABYLON {
  154531. /**
  154532. * Configuration interface for the hand tracking feature
  154533. */
  154534. export interface IWebXRHandTrackingOptions {
  154535. /**
  154536. * The xrInput that will be used as source for new hands
  154537. */
  154538. xrInput: WebXRInput;
  154539. /**
  154540. * Configuration object for the joint meshes
  154541. */
  154542. jointMeshes?: {
  154543. /**
  154544. * Should the meshes created be invisible (defaults to false)
  154545. */
  154546. invisible?: boolean;
  154547. /**
  154548. * A source mesh to be used to create instances. Defaults to a sphere.
  154549. * This mesh will be the source for all other (25) meshes.
  154550. * It should have the general size of a single unit, as the instances will be scaled according to the provided radius
  154551. */
  154552. sourceMesh?: Mesh;
  154553. /**
  154554. * Should the source mesh stay visible. Defaults to false
  154555. */
  154556. keepOriginalVisible?: boolean;
  154557. /**
  154558. * Scale factor for all instances (defaults to 2)
  154559. */
  154560. scaleFactor?: number;
  154561. /**
  154562. * Should each instance have its own physics impostor
  154563. */
  154564. enablePhysics?: boolean;
  154565. /**
  154566. * If enabled, override default physics properties
  154567. */
  154568. physicsProps?: {
  154569. friction?: number;
  154570. restitution?: number;
  154571. impostorType?: number;
  154572. };
  154573. /**
  154574. * For future use - a single hand-mesh that will be updated according to the XRHand data provided
  154575. */
  154576. handMesh?: AbstractMesh;
  154577. };
  154578. }
  154579. /**
  154580. * Parts of the hands divided to writs and finger names
  154581. */
  154582. export const enum HandPart {
  154583. /**
  154584. * HandPart - Wrist
  154585. */
  154586. WRIST = "wrist",
  154587. /**
  154588. * HandPart - The THumb
  154589. */
  154590. THUMB = "thumb",
  154591. /**
  154592. * HandPart - Index finger
  154593. */
  154594. INDEX = "index",
  154595. /**
  154596. * HandPart - Middle finger
  154597. */
  154598. MIDDLE = "middle",
  154599. /**
  154600. * HandPart - Ring finger
  154601. */
  154602. RING = "ring",
  154603. /**
  154604. * HandPart - Little finger
  154605. */
  154606. LITTLE = "little"
  154607. }
  154608. /**
  154609. * Representing a single hand (with its corresponding native XRHand object)
  154610. */
  154611. export class WebXRHand implements IDisposable {
  154612. /** the controller to which the hand correlates */
  154613. readonly xrController: WebXRInputSource;
  154614. /** the meshes to be used to track the hand joints */
  154615. readonly trackedMeshes: AbstractMesh[];
  154616. /**
  154617. * Hand-parts definition (key is HandPart)
  154618. */
  154619. static HandPartsDefinition: {
  154620. [key: string]: number[];
  154621. };
  154622. /**
  154623. * Populate the HandPartsDefinition object.
  154624. * This is called as a side effect since certain browsers don't have XRHand defined.
  154625. */
  154626. static _PopulateHandPartsDefinition(): void;
  154627. /**
  154628. * Construct a new hand object
  154629. * @param xrController the controller to which the hand correlates
  154630. * @param trackedMeshes the meshes to be used to track the hand joints
  154631. */
  154632. constructor(
  154633. /** the controller to which the hand correlates */
  154634. xrController: WebXRInputSource,
  154635. /** the meshes to be used to track the hand joints */
  154636. trackedMeshes: AbstractMesh[]);
  154637. /**
  154638. * Update this hand from the latest xr frame
  154639. * @param xrFrame xrFrame to update from
  154640. * @param referenceSpace The current viewer reference space
  154641. * @param scaleFactor optional scale factor for the meshes
  154642. */
  154643. updateFromXRFrame(xrFrame: XRFrame, referenceSpace: XRReferenceSpace, scaleFactor?: number): void;
  154644. /**
  154645. * Get meshes of part of the hand
  154646. * @param part the part of hand to get
  154647. * @returns An array of meshes that correlate to the hand part requested
  154648. */
  154649. getHandPartMeshes(part: HandPart): AbstractMesh[];
  154650. /**
  154651. * Dispose this Hand object
  154652. */
  154653. dispose(): void;
  154654. }
  154655. /**
  154656. * WebXR Hand Joint tracking feature, available for selected browsers and devices
  154657. */
  154658. export class WebXRHandTracking extends WebXRAbstractFeature {
  154659. /**
  154660. * options to use when constructing this feature
  154661. */
  154662. readonly options: IWebXRHandTrackingOptions;
  154663. private static _idCounter;
  154664. /**
  154665. * The module's name
  154666. */
  154667. static readonly Name: string;
  154668. /**
  154669. * The (Babylon) version of this module.
  154670. * This is an integer representing the implementation version.
  154671. * This number does not correspond to the WebXR specs version
  154672. */
  154673. static readonly Version: number;
  154674. /**
  154675. * This observable will notify registered observers when a new hand object was added and initialized
  154676. */
  154677. onHandAddedObservable: Observable<WebXRHand>;
  154678. /**
  154679. * This observable will notify its observers right before the hand object is disposed
  154680. */
  154681. onHandRemovedObservable: Observable<WebXRHand>;
  154682. private _hands;
  154683. /**
  154684. * Creates a new instance of the hit test feature
  154685. * @param _xrSessionManager an instance of WebXRSessionManager
  154686. * @param options options to use when constructing this feature
  154687. */
  154688. constructor(_xrSessionManager: WebXRSessionManager,
  154689. /**
  154690. * options to use when constructing this feature
  154691. */
  154692. options: IWebXRHandTrackingOptions);
  154693. /**
  154694. * Check if the needed objects are defined.
  154695. * This does not mean that the feature is enabled, but that the objects needed are well defined.
  154696. */
  154697. isCompatible(): boolean;
  154698. /**
  154699. * attach this feature
  154700. * Will usually be called by the features manager
  154701. *
  154702. * @returns true if successful.
  154703. */
  154704. attach(): boolean;
  154705. /**
  154706. * detach this feature.
  154707. * Will usually be called by the features manager
  154708. *
  154709. * @returns true if successful.
  154710. */
  154711. detach(): boolean;
  154712. /**
  154713. * Dispose this feature and all of the resources attached
  154714. */
  154715. dispose(): void;
  154716. /**
  154717. * Get the hand object according to the controller id
  154718. * @param controllerId the controller id to which we want to get the hand
  154719. * @returns null if not found or the WebXRHand object if found
  154720. */
  154721. getHandByControllerId(controllerId: string): Nullable<WebXRHand>;
  154722. /**
  154723. * Get a hand object according to the requested handedness
  154724. * @param handedness the handedness to request
  154725. * @returns null if not found or the WebXRHand object if found
  154726. */
  154727. getHandByHandedness(handedness: XRHandedness): Nullable<WebXRHand>;
  154728. protected _onXRFrame(_xrFrame: XRFrame): void;
  154729. private _attachHand;
  154730. private _detachHand;
  154731. }
  154732. }
  154733. declare module BABYLON {
  154734. /**
  154735. * The motion controller class for all microsoft mixed reality controllers
  154736. */
  154737. export class WebXRMicrosoftMixedRealityController extends WebXRAbstractMotionController {
  154738. protected readonly _mapping: {
  154739. defaultButton: {
  154740. valueNodeName: string;
  154741. unpressedNodeName: string;
  154742. pressedNodeName: string;
  154743. };
  154744. defaultAxis: {
  154745. valueNodeName: string;
  154746. minNodeName: string;
  154747. maxNodeName: string;
  154748. };
  154749. buttons: {
  154750. "xr-standard-trigger": {
  154751. rootNodeName: string;
  154752. componentProperty: string;
  154753. states: string[];
  154754. };
  154755. "xr-standard-squeeze": {
  154756. rootNodeName: string;
  154757. componentProperty: string;
  154758. states: string[];
  154759. };
  154760. "xr-standard-touchpad": {
  154761. rootNodeName: string;
  154762. labelAnchorNodeName: string;
  154763. touchPointNodeName: string;
  154764. };
  154765. "xr-standard-thumbstick": {
  154766. rootNodeName: string;
  154767. componentProperty: string;
  154768. states: string[];
  154769. };
  154770. };
  154771. axes: {
  154772. "xr-standard-touchpad": {
  154773. "x-axis": {
  154774. rootNodeName: string;
  154775. };
  154776. "y-axis": {
  154777. rootNodeName: string;
  154778. };
  154779. };
  154780. "xr-standard-thumbstick": {
  154781. "x-axis": {
  154782. rootNodeName: string;
  154783. };
  154784. "y-axis": {
  154785. rootNodeName: string;
  154786. };
  154787. };
  154788. };
  154789. };
  154790. /**
  154791. * The base url used to load the left and right controller models
  154792. */
  154793. static MODEL_BASE_URL: string;
  154794. /**
  154795. * The name of the left controller model file
  154796. */
  154797. static MODEL_LEFT_FILENAME: string;
  154798. /**
  154799. * The name of the right controller model file
  154800. */
  154801. static MODEL_RIGHT_FILENAME: string;
  154802. profileId: string;
  154803. constructor(scene: Scene, gamepadObject: IMinimalMotionControllerObject, handedness: MotionControllerHandedness);
  154804. protected _getFilenameAndPath(): {
  154805. filename: string;
  154806. path: string;
  154807. };
  154808. protected _getModelLoadingConstraints(): boolean;
  154809. protected _processLoadedModel(_meshes: AbstractMesh[]): void;
  154810. protected _setRootMesh(meshes: AbstractMesh[]): void;
  154811. protected _updateModel(): void;
  154812. }
  154813. }
  154814. declare module BABYLON {
  154815. /**
  154816. * The motion controller class for oculus touch (quest, rift).
  154817. * This class supports legacy mapping as well the standard xr mapping
  154818. */
  154819. export class WebXROculusTouchMotionController extends WebXRAbstractMotionController {
  154820. private _forceLegacyControllers;
  154821. private _modelRootNode;
  154822. /**
  154823. * The base url used to load the left and right controller models
  154824. */
  154825. static MODEL_BASE_URL: string;
  154826. /**
  154827. * The name of the left controller model file
  154828. */
  154829. static MODEL_LEFT_FILENAME: string;
  154830. /**
  154831. * The name of the right controller model file
  154832. */
  154833. static MODEL_RIGHT_FILENAME: string;
  154834. /**
  154835. * Base Url for the Quest controller model.
  154836. */
  154837. static QUEST_MODEL_BASE_URL: string;
  154838. profileId: string;
  154839. constructor(scene: Scene, gamepadObject: IMinimalMotionControllerObject, handedness: MotionControllerHandedness, legacyMapping?: boolean, _forceLegacyControllers?: boolean);
  154840. protected _getFilenameAndPath(): {
  154841. filename: string;
  154842. path: string;
  154843. };
  154844. protected _getModelLoadingConstraints(): boolean;
  154845. protected _processLoadedModel(_meshes: AbstractMesh[]): void;
  154846. protected _setRootMesh(meshes: AbstractMesh[]): void;
  154847. protected _updateModel(): void;
  154848. /**
  154849. * Is this the new type of oculus touch. At the moment both have the same profile and it is impossible to differentiate
  154850. * between the touch and touch 2.
  154851. */
  154852. private _isQuest;
  154853. }
  154854. }
  154855. declare module BABYLON {
  154856. /**
  154857. * The motion controller class for the standard HTC-Vive controllers
  154858. */
  154859. export class WebXRHTCViveMotionController extends WebXRAbstractMotionController {
  154860. private _modelRootNode;
  154861. /**
  154862. * The base url used to load the left and right controller models
  154863. */
  154864. static MODEL_BASE_URL: string;
  154865. /**
  154866. * File name for the controller model.
  154867. */
  154868. static MODEL_FILENAME: string;
  154869. profileId: string;
  154870. /**
  154871. * Create a new Vive motion controller object
  154872. * @param scene the scene to use to create this controller
  154873. * @param gamepadObject the corresponding gamepad object
  154874. * @param handedness the handedness of the controller
  154875. */
  154876. constructor(scene: Scene, gamepadObject: IMinimalMotionControllerObject, handedness: MotionControllerHandedness);
  154877. protected _getFilenameAndPath(): {
  154878. filename: string;
  154879. path: string;
  154880. };
  154881. protected _getModelLoadingConstraints(): boolean;
  154882. protected _processLoadedModel(_meshes: AbstractMesh[]): void;
  154883. protected _setRootMesh(meshes: AbstractMesh[]): void;
  154884. protected _updateModel(): void;
  154885. }
  154886. }
  154887. declare module BABYLON {
  154888. /**
  154889. * A cursor which tracks a point on a path
  154890. */
  154891. export class PathCursor {
  154892. private path;
  154893. /**
  154894. * Stores path cursor callbacks for when an onchange event is triggered
  154895. */
  154896. private _onchange;
  154897. /**
  154898. * The value of the path cursor
  154899. */
  154900. value: number;
  154901. /**
  154902. * The animation array of the path cursor
  154903. */
  154904. animations: Animation[];
  154905. /**
  154906. * Initializes the path cursor
  154907. * @param path The path to track
  154908. */
  154909. constructor(path: Path2);
  154910. /**
  154911. * Gets the cursor point on the path
  154912. * @returns A point on the path cursor at the cursor location
  154913. */
  154914. getPoint(): Vector3;
  154915. /**
  154916. * Moves the cursor ahead by the step amount
  154917. * @param step The amount to move the cursor forward
  154918. * @returns This path cursor
  154919. */
  154920. moveAhead(step?: number): PathCursor;
  154921. /**
  154922. * Moves the cursor behind by the step amount
  154923. * @param step The amount to move the cursor back
  154924. * @returns This path cursor
  154925. */
  154926. moveBack(step?: number): PathCursor;
  154927. /**
  154928. * Moves the cursor by the step amount
  154929. * If the step amount is greater than one, an exception is thrown
  154930. * @param step The amount to move the cursor
  154931. * @returns This path cursor
  154932. */
  154933. move(step: number): PathCursor;
  154934. /**
  154935. * Ensures that the value is limited between zero and one
  154936. * @returns This path cursor
  154937. */
  154938. private ensureLimits;
  154939. /**
  154940. * Runs onchange callbacks on change (used by the animation engine)
  154941. * @returns This path cursor
  154942. */
  154943. private raiseOnChange;
  154944. /**
  154945. * Executes a function on change
  154946. * @param f A path cursor onchange callback
  154947. * @returns This path cursor
  154948. */
  154949. onchange(f: (cursor: PathCursor) => void): PathCursor;
  154950. }
  154951. }
  154952. declare module BABYLON {
  154953. /** @hidden */
  154954. export var blurPixelShader: {
  154955. name: string;
  154956. shader: string;
  154957. };
  154958. }
  154959. declare module BABYLON {
  154960. /** @hidden */
  154961. export var pointCloudVertexDeclaration: {
  154962. name: string;
  154963. shader: string;
  154964. };
  154965. }
  154966. // Mixins
  154967. interface Window {
  154968. mozIndexedDB: IDBFactory;
  154969. webkitIndexedDB: IDBFactory;
  154970. msIndexedDB: IDBFactory;
  154971. webkitURL: typeof URL;
  154972. mozRequestAnimationFrame(callback: FrameRequestCallback): number;
  154973. oRequestAnimationFrame(callback: FrameRequestCallback): number;
  154974. WebGLRenderingContext: WebGLRenderingContext;
  154975. MSGesture: MSGesture;
  154976. CANNON: any;
  154977. AudioContext: AudioContext;
  154978. webkitAudioContext: AudioContext;
  154979. PointerEvent: any;
  154980. Math: Math;
  154981. Uint8Array: Uint8ArrayConstructor;
  154982. Float32Array: Float32ArrayConstructor;
  154983. mozURL: typeof URL;
  154984. msURL: typeof URL;
  154985. VRFrameData: any; // WebVR, from specs 1.1
  154986. DracoDecoderModule: any;
  154987. setImmediate(handler: (...args: any[]) => void): number;
  154988. }
  154989. interface HTMLCanvasElement {
  154990. requestPointerLock(): void;
  154991. msRequestPointerLock?(): void;
  154992. mozRequestPointerLock?(): void;
  154993. webkitRequestPointerLock?(): void;
  154994. /** Track wether a record is in progress */
  154995. isRecording: boolean;
  154996. /** Capture Stream method defined by some browsers */
  154997. captureStream(fps?: number): MediaStream;
  154998. }
  154999. interface CanvasRenderingContext2D {
  155000. msImageSmoothingEnabled: boolean;
  155001. }
  155002. interface MouseEvent {
  155003. mozMovementX: number;
  155004. mozMovementY: number;
  155005. webkitMovementX: number;
  155006. webkitMovementY: number;
  155007. msMovementX: number;
  155008. msMovementY: number;
  155009. }
  155010. interface Navigator {
  155011. mozGetVRDevices: (any: any) => any;
  155012. webkitGetUserMedia(constraints: MediaStreamConstraints, successCallback: NavigatorUserMediaSuccessCallback, errorCallback: NavigatorUserMediaErrorCallback): void;
  155013. mozGetUserMedia(constraints: MediaStreamConstraints, successCallback: NavigatorUserMediaSuccessCallback, errorCallback: NavigatorUserMediaErrorCallback): void;
  155014. msGetUserMedia(constraints: MediaStreamConstraints, successCallback: NavigatorUserMediaSuccessCallback, errorCallback: NavigatorUserMediaErrorCallback): void;
  155015. webkitGetGamepads(): Gamepad[];
  155016. msGetGamepads(): Gamepad[];
  155017. webkitGamepads(): Gamepad[];
  155018. }
  155019. interface HTMLVideoElement {
  155020. mozSrcObject: any;
  155021. }
  155022. interface Math {
  155023. fround(x: number): number;
  155024. imul(a: number, b: number): number;
  155025. }
  155026. interface WebGLRenderingContext {
  155027. drawArraysInstanced(mode: number, first: number, count: number, primcount: number): void;
  155028. drawElementsInstanced(mode: number, count: number, type: number, offset: number, primcount: number): void;
  155029. vertexAttribDivisor(index: number, divisor: number): void;
  155030. createVertexArray(): any;
  155031. bindVertexArray(vao?: WebGLVertexArrayObject | null): void;
  155032. deleteVertexArray(vao: WebGLVertexArrayObject): void;
  155033. blitFramebuffer(srcX0: number, srcY0: number, srcX1: number, srcY1: number, dstX0: number, dstY0: number, dstX1: number, dstY1: number, mask: number, filter: number): void;
  155034. renderbufferStorageMultisample?(target: number, samples: number, internalformat: number, width: number, height: number): void;
  155035. bindBufferBase(target: number, index: number, buffer: WebGLBuffer | null): void;
  155036. getUniformBlockIndex(program: WebGLProgram, uniformBlockName: string): number;
  155037. uniformBlockBinding(program: WebGLProgram, uniformBlockIndex: number, uniformBlockBinding: number): void;
  155038. // Queries
  155039. createQuery(): WebGLQuery;
  155040. deleteQuery(query: WebGLQuery): void;
  155041. beginQuery(target: number, query: WebGLQuery): void;
  155042. endQuery(target: number): void;
  155043. getQueryParameter(query: WebGLQuery, pname: number): any;
  155044. getQuery(target: number, pname: number): any;
  155045. MAX_SAMPLES: number;
  155046. RGBA8: number;
  155047. READ_FRAMEBUFFER: number;
  155048. DRAW_FRAMEBUFFER: number;
  155049. UNIFORM_BUFFER: number;
  155050. HALF_FLOAT_OES: number;
  155051. RGBA16F: number;
  155052. RGBA32F: number;
  155053. R32F: number;
  155054. RG32F: number;
  155055. RGB32F: number;
  155056. R16F: number;
  155057. RG16F: number;
  155058. RGB16F: number;
  155059. RED: number;
  155060. RG: number;
  155061. R8: number;
  155062. RG8: number;
  155063. UNSIGNED_INT_24_8: number;
  155064. DEPTH24_STENCIL8: number;
  155065. MIN: number;
  155066. MAX: number;
  155067. /* Multiple Render Targets */
  155068. drawBuffers(buffers: number[]): void;
  155069. readBuffer(src: number): void;
  155070. readonly COLOR_ATTACHMENT0: number; // 0x8CE1
  155071. readonly COLOR_ATTACHMENT1: number; // 0x8CE2
  155072. readonly COLOR_ATTACHMENT2: number; // 0x8CE3
  155073. readonly COLOR_ATTACHMENT3: number; // 0x8CE4
  155074. // Occlusion Query
  155075. ANY_SAMPLES_PASSED_CONSERVATIVE: number;
  155076. ANY_SAMPLES_PASSED: number;
  155077. QUERY_RESULT_AVAILABLE: number;
  155078. QUERY_RESULT: number;
  155079. }
  155080. interface WebGLProgram {
  155081. __SPECTOR_rebuildProgram?: ((vertexSourceCode: string, fragmentSourceCode: string, onCompiled: (program: WebGLProgram) => void, onError: (message: string) => void) => void) | null;
  155082. }
  155083. interface EXT_disjoint_timer_query {
  155084. QUERY_COUNTER_BITS_EXT: number;
  155085. TIME_ELAPSED_EXT: number;
  155086. TIMESTAMP_EXT: number;
  155087. GPU_DISJOINT_EXT: number;
  155088. QUERY_RESULT_EXT: number;
  155089. QUERY_RESULT_AVAILABLE_EXT: number;
  155090. queryCounterEXT(query: WebGLQuery, target: number): void;
  155091. createQueryEXT(): WebGLQuery;
  155092. beginQueryEXT(target: number, query: WebGLQuery): void;
  155093. endQueryEXT(target: number): void;
  155094. getQueryObjectEXT(query: WebGLQuery, target: number): any;
  155095. deleteQueryEXT(query: WebGLQuery): void;
  155096. }
  155097. interface WebGLUniformLocation {
  155098. _currentState: any;
  155099. }
  155100. // Type definitions for WebGL 2, Editor's Draft Fri Feb 24 16:10:18 2017 -0800
  155101. // Project: https://www.khronos.org/registry/webgl/specs/latest/2.0/
  155102. // Definitions by: Nico Kemnitz <https://github.com/nkemnitz/>
  155103. // Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped
  155104. interface WebGLRenderingContext {
  155105. readonly RASTERIZER_DISCARD: number;
  155106. readonly DEPTH_COMPONENT24: number;
  155107. readonly TEXTURE_3D: number;
  155108. readonly TEXTURE_2D_ARRAY: number;
  155109. readonly TEXTURE_COMPARE_FUNC: number;
  155110. readonly TEXTURE_COMPARE_MODE: number;
  155111. readonly COMPARE_REF_TO_TEXTURE: number;
  155112. readonly TEXTURE_WRAP_R: number;
  155113. readonly HALF_FLOAT: number;
  155114. readonly RGB8: number;
  155115. readonly RED_INTEGER: number;
  155116. readonly RG_INTEGER: number;
  155117. readonly RGB_INTEGER: number;
  155118. readonly RGBA_INTEGER: number;
  155119. readonly R8_SNORM: number;
  155120. readonly RG8_SNORM: number;
  155121. readonly RGB8_SNORM: number;
  155122. readonly RGBA8_SNORM: number;
  155123. readonly R8I: number;
  155124. readonly RG8I: number;
  155125. readonly RGB8I: number;
  155126. readonly RGBA8I: number;
  155127. readonly R8UI: number;
  155128. readonly RG8UI: number;
  155129. readonly RGB8UI: number;
  155130. readonly RGBA8UI: number;
  155131. readonly R16I: number;
  155132. readonly RG16I: number;
  155133. readonly RGB16I: number;
  155134. readonly RGBA16I: number;
  155135. readonly R16UI: number;
  155136. readonly RG16UI: number;
  155137. readonly RGB16UI: number;
  155138. readonly RGBA16UI: number;
  155139. readonly R32I: number;
  155140. readonly RG32I: number;
  155141. readonly RGB32I: number;
  155142. readonly RGBA32I: number;
  155143. readonly R32UI: number;
  155144. readonly RG32UI: number;
  155145. readonly RGB32UI: number;
  155146. readonly RGBA32UI: number;
  155147. readonly RGB10_A2UI: number;
  155148. readonly R11F_G11F_B10F: number;
  155149. readonly RGB9_E5: number;
  155150. readonly RGB10_A2: number;
  155151. readonly UNSIGNED_INT_2_10_10_10_REV: number;
  155152. readonly UNSIGNED_INT_10F_11F_11F_REV: number;
  155153. readonly UNSIGNED_INT_5_9_9_9_REV: number;
  155154. readonly FLOAT_32_UNSIGNED_INT_24_8_REV: number;
  155155. readonly DEPTH_COMPONENT32F: number;
  155156. texImage3D(target: number, level: number, internalformat: number, width: number, height: number, depth: number, border: number, format: number, type: number, pixels: ArrayBufferView | null): void;
  155157. texImage3D(target: number, level: number, internalformat: number, width: number, height: number, depth: number, border: number, format: number, type: number, pixels: ArrayBufferView, offset: number): void;
  155158. 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;
  155159. framebufferTextureLayer(target: number, attachment: number, texture: WebGLTexture | null, level: number, layer: number): void;
  155160. compressedTexImage3D(target: number, level: number, internalformat: number, width: number, height: number, depth: number, border: number, data: ArrayBufferView, offset?: number, length?: number): void;
  155161. readonly TRANSFORM_FEEDBACK: number;
  155162. readonly INTERLEAVED_ATTRIBS: number;
  155163. readonly TRANSFORM_FEEDBACK_BUFFER: number;
  155164. createTransformFeedback(): WebGLTransformFeedback;
  155165. deleteTransformFeedback(transformFeedbac: WebGLTransformFeedback): void;
  155166. bindTransformFeedback(target: number, transformFeedback: WebGLTransformFeedback | null): void;
  155167. beginTransformFeedback(primitiveMode: number): void;
  155168. endTransformFeedback(): void;
  155169. transformFeedbackVaryings(program: WebGLProgram, varyings: string[], bufferMode: number): void;
  155170. clearBufferfv(buffer: number, drawbuffer: number, values: ArrayBufferView, srcOffset: number | null): void;
  155171. clearBufferiv(buffer: number, drawbuffer: number, values: ArrayBufferView, srcOffset: number | null): void;
  155172. clearBufferuiv(buffer: number, drawbuffer: number, values: ArrayBufferView, srcOffset: number | null): void;
  155173. clearBufferfi(buffer: number, drawbuffer: number, depth: number, stencil: number): void;
  155174. }
  155175. interface ImageBitmap {
  155176. readonly width: number;
  155177. readonly height: number;
  155178. close(): void;
  155179. }
  155180. interface WebGLQuery extends WebGLObject {
  155181. }
  155182. declare var WebGLQuery: {
  155183. prototype: WebGLQuery;
  155184. new(): WebGLQuery;
  155185. };
  155186. interface WebGLSampler extends WebGLObject {
  155187. }
  155188. declare var WebGLSampler: {
  155189. prototype: WebGLSampler;
  155190. new(): WebGLSampler;
  155191. };
  155192. interface WebGLSync extends WebGLObject {
  155193. }
  155194. declare var WebGLSync: {
  155195. prototype: WebGLSync;
  155196. new(): WebGLSync;
  155197. };
  155198. interface WebGLTransformFeedback extends WebGLObject {
  155199. }
  155200. declare var WebGLTransformFeedback: {
  155201. prototype: WebGLTransformFeedback;
  155202. new(): WebGLTransformFeedback;
  155203. };
  155204. interface WebGLVertexArrayObject extends WebGLObject {
  155205. }
  155206. declare var WebGLVertexArrayObject: {
  155207. prototype: WebGLVertexArrayObject;
  155208. new(): WebGLVertexArrayObject;
  155209. };
  155210. // Type definitions for WebVR API
  155211. // Project: https://w3c.github.io/webvr/
  155212. // Definitions by: six a <https://github.com/lostfictions>
  155213. // Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped
  155214. interface VRDisplay extends EventTarget {
  155215. /**
  155216. * Dictionary of capabilities describing the VRDisplay.
  155217. */
  155218. readonly capabilities: VRDisplayCapabilities;
  155219. /**
  155220. * z-depth defining the far plane of the eye view frustum
  155221. * enables mapping of values in the render target depth
  155222. * attachment to scene coordinates. Initially set to 10000.0.
  155223. */
  155224. depthFar: number;
  155225. /**
  155226. * z-depth defining the near plane of the eye view frustum
  155227. * enables mapping of values in the render target depth
  155228. * attachment to scene coordinates. Initially set to 0.01.
  155229. */
  155230. depthNear: number;
  155231. /**
  155232. * An identifier for this distinct VRDisplay. Used as an
  155233. * association point in the Gamepad API.
  155234. */
  155235. readonly displayId: number;
  155236. /**
  155237. * A display name, a user-readable name identifying it.
  155238. */
  155239. readonly displayName: string;
  155240. readonly isConnected: boolean;
  155241. readonly isPresenting: boolean;
  155242. /**
  155243. * If this VRDisplay supports room-scale experiences, the optional
  155244. * stage attribute contains details on the room-scale parameters.
  155245. */
  155246. readonly stageParameters: VRStageParameters | null;
  155247. /**
  155248. * Passing the value returned by `requestAnimationFrame` to
  155249. * `cancelAnimationFrame` will unregister the callback.
  155250. * @param handle Define the hanle of the request to cancel
  155251. */
  155252. cancelAnimationFrame(handle: number): void;
  155253. /**
  155254. * Stops presenting to the VRDisplay.
  155255. * @returns a promise to know when it stopped
  155256. */
  155257. exitPresent(): Promise<void>;
  155258. /**
  155259. * Return the current VREyeParameters for the given eye.
  155260. * @param whichEye Define the eye we want the parameter for
  155261. * @returns the eye parameters
  155262. */
  155263. getEyeParameters(whichEye: string): VREyeParameters;
  155264. /**
  155265. * Populates the passed VRFrameData with the information required to render
  155266. * the current frame.
  155267. * @param frameData Define the data structure to populate
  155268. * @returns true if ok otherwise false
  155269. */
  155270. getFrameData(frameData: VRFrameData): boolean;
  155271. /**
  155272. * Get the layers currently being presented.
  155273. * @returns the list of VR layers
  155274. */
  155275. getLayers(): VRLayer[];
  155276. /**
  155277. * Return a VRPose containing the future predicted pose of the VRDisplay
  155278. * when the current frame will be presented. The value returned will not
  155279. * change until JavaScript has returned control to the browser.
  155280. *
  155281. * The VRPose will contain the position, orientation, velocity,
  155282. * and acceleration of each of these properties.
  155283. * @returns the pose object
  155284. */
  155285. getPose(): VRPose;
  155286. /**
  155287. * Return the current instantaneous pose of the VRDisplay, with no
  155288. * prediction applied.
  155289. * @returns the current instantaneous pose
  155290. */
  155291. getImmediatePose(): VRPose;
  155292. /**
  155293. * The callback passed to `requestAnimationFrame` will be called
  155294. * any time a new frame should be rendered. When the VRDisplay is
  155295. * presenting the callback will be called at the native refresh
  155296. * rate of the HMD. When not presenting this function acts
  155297. * identically to how window.requestAnimationFrame acts. Content should
  155298. * make no assumptions of frame rate or vsync behavior as the HMD runs
  155299. * asynchronously from other displays and at differing refresh rates.
  155300. * @param callback Define the eaction to run next frame
  155301. * @returns the request handle it
  155302. */
  155303. requestAnimationFrame(callback: FrameRequestCallback): number;
  155304. /**
  155305. * Begin presenting to the VRDisplay. Must be called in response to a user gesture.
  155306. * Repeat calls while already presenting will update the VRLayers being displayed.
  155307. * @param layers Define the list of layer to present
  155308. * @returns a promise to know when the request has been fulfilled
  155309. */
  155310. requestPresent(layers: VRLayer[]): Promise<void>;
  155311. /**
  155312. * Reset the pose for this display, treating its current position and
  155313. * orientation as the "origin/zero" values. VRPose.position,
  155314. * VRPose.orientation, and VRStageParameters.sittingToStandingTransform may be
  155315. * updated when calling resetPose(). This should be called in only
  155316. * sitting-space experiences.
  155317. */
  155318. resetPose(): void;
  155319. /**
  155320. * The VRLayer provided to the VRDisplay will be captured and presented
  155321. * in the HMD. Calling this function has the same effect on the source
  155322. * canvas as any other operation that uses its source image, and canvases
  155323. * created without preserveDrawingBuffer set to true will be cleared.
  155324. * @param pose Define the pose to submit
  155325. */
  155326. submitFrame(pose?: VRPose): void;
  155327. }
  155328. declare var VRDisplay: {
  155329. prototype: VRDisplay;
  155330. new(): VRDisplay;
  155331. };
  155332. interface VRLayer {
  155333. leftBounds?: number[] | Float32Array | null;
  155334. rightBounds?: number[] | Float32Array | null;
  155335. source?: HTMLCanvasElement | null;
  155336. }
  155337. interface VRDisplayCapabilities {
  155338. readonly canPresent: boolean;
  155339. readonly hasExternalDisplay: boolean;
  155340. readonly hasOrientation: boolean;
  155341. readonly hasPosition: boolean;
  155342. readonly maxLayers: number;
  155343. }
  155344. interface VREyeParameters {
  155345. /** @deprecated */
  155346. readonly fieldOfView: VRFieldOfView;
  155347. readonly offset: Float32Array;
  155348. readonly renderHeight: number;
  155349. readonly renderWidth: number;
  155350. }
  155351. interface VRFieldOfView {
  155352. readonly downDegrees: number;
  155353. readonly leftDegrees: number;
  155354. readonly rightDegrees: number;
  155355. readonly upDegrees: number;
  155356. }
  155357. interface VRFrameData {
  155358. readonly leftProjectionMatrix: Float32Array;
  155359. readonly leftViewMatrix: Float32Array;
  155360. readonly pose: VRPose;
  155361. readonly rightProjectionMatrix: Float32Array;
  155362. readonly rightViewMatrix: Float32Array;
  155363. readonly timestamp: number;
  155364. }
  155365. interface VRPose {
  155366. readonly angularAcceleration: Float32Array | null;
  155367. readonly angularVelocity: Float32Array | null;
  155368. readonly linearAcceleration: Float32Array | null;
  155369. readonly linearVelocity: Float32Array | null;
  155370. readonly orientation: Float32Array | null;
  155371. readonly position: Float32Array | null;
  155372. readonly timestamp: number;
  155373. }
  155374. interface VRStageParameters {
  155375. sittingToStandingTransform?: Float32Array;
  155376. sizeX?: number;
  155377. sizeY?: number;
  155378. }
  155379. interface Navigator {
  155380. getVRDisplays(): Promise<VRDisplay[]>;
  155381. readonly activeVRDisplays: ReadonlyArray<VRDisplay>;
  155382. }
  155383. interface Window {
  155384. onvrdisplayconnected: ((this: Window, ev: Event) => any) | null;
  155385. onvrdisplaydisconnected: ((this: Window, ev: Event) => any) | null;
  155386. onvrdisplaypresentchange: ((this: Window, ev: Event) => any) | null;
  155387. addEventListener(type: "vrdisplayconnected", listener: (ev: Event) => any, useCapture?: boolean): void;
  155388. addEventListener(type: "vrdisplaydisconnected", listener: (ev: Event) => any, useCapture?: boolean): void;
  155389. addEventListener(type: "vrdisplaypresentchange", listener: (ev: Event) => any, useCapture?: boolean): void;
  155390. }
  155391. interface Gamepad {
  155392. readonly displayId: number;
  155393. }
  155394. type XRSessionMode = "inline" | "immersive-vr" | "immersive-ar";
  155395. type XRReferenceSpaceType = "viewer" | "local" | "local-floor" | "bounded-floor" | "unbounded";
  155396. type XREnvironmentBlendMode = "opaque" | "additive" | "alpha-blend";
  155397. type XRVisibilityState = "visible" | "visible-blurred" | "hidden";
  155398. type XRHandedness = "none" | "left" | "right";
  155399. type XRTargetRayMode = "gaze" | "tracked-pointer" | "screen";
  155400. type XREye = "none" | "left" | "right";
  155401. type XREventType = "devicechange" | "visibilitychange" | "end" | "inputsourceschange" | "select" | "selectstart" | "selectend" | "squeeze" | "squeezestart" | "squeezeend" | "reset";
  155402. interface XRSpace extends EventTarget {}
  155403. interface XRRenderState {
  155404. depthNear?: number;
  155405. depthFar?: number;
  155406. inlineVerticalFieldOfView?: number;
  155407. baseLayer?: XRWebGLLayer;
  155408. }
  155409. interface XRInputSource {
  155410. handedness: XRHandedness;
  155411. targetRayMode: XRTargetRayMode;
  155412. targetRaySpace: XRSpace;
  155413. gripSpace: XRSpace | undefined;
  155414. gamepad: Gamepad | undefined;
  155415. profiles: Array<string>;
  155416. hand: XRHand | undefined;
  155417. }
  155418. interface XRSessionInit {
  155419. optionalFeatures?: string[];
  155420. requiredFeatures?: string[];
  155421. }
  155422. interface XRSession {
  155423. addEventListener: Function;
  155424. removeEventListener: Function;
  155425. requestReferenceSpace(type: XRReferenceSpaceType): Promise<XRReferenceSpace>;
  155426. updateRenderState(XRRenderStateInit: XRRenderState): Promise<void>;
  155427. requestAnimationFrame: Function;
  155428. end(): Promise<void>;
  155429. renderState: XRRenderState;
  155430. inputSources: Array<XRInputSource>;
  155431. // hit test
  155432. requestHitTestSource(options: XRHitTestOptionsInit): Promise<XRHitTestSource>;
  155433. requestHitTestSourceForTransientInput(options: XRTransientInputHitTestOptionsInit): Promise<XRTransientInputHitTestSource>;
  155434. // legacy AR hit test
  155435. requestHitTest(ray: XRRay, referenceSpace: XRReferenceSpace): Promise<XRHitResult[]>;
  155436. // legacy plane detection
  155437. updateWorldTrackingState(options: { planeDetectionState?: { enabled: boolean } }): void;
  155438. }
  155439. interface XRReferenceSpace extends XRSpace {
  155440. getOffsetReferenceSpace(originOffset: XRRigidTransform): XRReferenceSpace;
  155441. onreset: any;
  155442. }
  155443. type XRPlaneSet = Set<XRPlane>;
  155444. type XRAnchorSet = Set<XRAnchor>;
  155445. interface XRFrame {
  155446. session: XRSession;
  155447. getViewerPose(referenceSpace: XRReferenceSpace): XRViewerPose | undefined;
  155448. getPose(space: XRSpace, baseSpace: XRSpace): XRPose | undefined;
  155449. // AR
  155450. getHitTestResults(hitTestSource: XRHitTestSource): Array<XRHitTestResult>;
  155451. getHitTestResultsForTransientInput(hitTestSource: XRTransientInputHitTestSource): Array<XRTransientInputHitTestResult>;
  155452. // Anchors
  155453. trackedAnchors?: XRAnchorSet;
  155454. createAnchor(pose: XRRigidTransform, space: XRSpace): Promise<XRAnchor>;
  155455. // Planes
  155456. worldInformation: {
  155457. detectedPlanes?: XRPlaneSet;
  155458. };
  155459. // Hand tracking
  155460. getJointPose(joint: XRJointSpace, baseSpace: XRSpace): XRJointPose;
  155461. }
  155462. interface XRViewerPose extends XRPose {
  155463. views: Array<XRView>;
  155464. }
  155465. interface XRPose {
  155466. transform: XRRigidTransform;
  155467. emulatedPosition: boolean;
  155468. }
  155469. interface XRWebGLLayerOptions {
  155470. antialias?: boolean;
  155471. depth?: boolean;
  155472. stencil?: boolean;
  155473. alpha?: boolean;
  155474. multiview?: boolean;
  155475. framebufferScaleFactor?: number;
  155476. }
  155477. declare var XRWebGLLayer: {
  155478. prototype: XRWebGLLayer;
  155479. new (session: XRSession, context: WebGLRenderingContext | undefined, options?: XRWebGLLayerOptions): XRWebGLLayer;
  155480. };
  155481. interface XRWebGLLayer {
  155482. framebuffer: WebGLFramebuffer;
  155483. framebufferWidth: number;
  155484. framebufferHeight: number;
  155485. getViewport: Function;
  155486. }
  155487. declare class XRRigidTransform {
  155488. constructor(matrix: Float32Array | DOMPointInit, direction?: DOMPointInit);
  155489. position: DOMPointReadOnly;
  155490. orientation: DOMPointReadOnly;
  155491. matrix: Float32Array;
  155492. inverse: XRRigidTransform;
  155493. }
  155494. interface XRView {
  155495. eye: XREye;
  155496. projectionMatrix: Float32Array;
  155497. transform: XRRigidTransform;
  155498. }
  155499. interface XRInputSourceChangeEvent {
  155500. session: XRSession;
  155501. removed: Array<XRInputSource>;
  155502. added: Array<XRInputSource>;
  155503. }
  155504. interface XRInputSourceEvent extends Event {
  155505. readonly frame: XRFrame;
  155506. readonly inputSource: XRInputSource;
  155507. }
  155508. // Experimental(er) features
  155509. declare class XRRay {
  155510. constructor(transformOrOrigin: XRRigidTransform | DOMPointInit, direction?: DOMPointInit);
  155511. origin: DOMPointReadOnly;
  155512. direction: DOMPointReadOnly;
  155513. matrix: Float32Array;
  155514. }
  155515. declare enum XRHitTestTrackableType {
  155516. "point",
  155517. "plane",
  155518. "mesh",
  155519. }
  155520. interface XRHitResult {
  155521. hitMatrix: Float32Array;
  155522. }
  155523. interface XRTransientInputHitTestResult {
  155524. readonly inputSource: XRInputSource;
  155525. readonly results: Array<XRHitTestResult>;
  155526. }
  155527. interface XRHitTestResult {
  155528. getPose(baseSpace: XRSpace): XRPose | undefined;
  155529. // When anchor system is enabled
  155530. createAnchor?(pose: XRRigidTransform): Promise<XRAnchor>;
  155531. }
  155532. interface XRHitTestSource {
  155533. cancel(): void;
  155534. }
  155535. interface XRTransientInputHitTestSource {
  155536. cancel(): void;
  155537. }
  155538. interface XRHitTestOptionsInit {
  155539. space: XRSpace;
  155540. entityTypes?: Array<XRHitTestTrackableType>;
  155541. offsetRay?: XRRay;
  155542. }
  155543. interface XRTransientInputHitTestOptionsInit {
  155544. profile: string;
  155545. entityTypes?: Array<XRHitTestTrackableType>;
  155546. offsetRay?: XRRay;
  155547. }
  155548. interface XRAnchor {
  155549. anchorSpace: XRSpace;
  155550. delete(): void;
  155551. }
  155552. interface XRPlane {
  155553. orientation: "Horizontal" | "Vertical";
  155554. planeSpace: XRSpace;
  155555. polygon: Array<DOMPointReadOnly>;
  155556. lastChangedTime: number;
  155557. }
  155558. interface XRJointSpace extends XRSpace {}
  155559. interface XRJointPose extends XRPose {
  155560. radius: number | undefined;
  155561. }
  155562. declare class XRHand extends Array<XRJointSpace> {
  155563. readonly length: number;
  155564. static readonly WRIST = 0;
  155565. static readonly THUMB_METACARPAL = 1;
  155566. static readonly THUMB_PHALANX_PROXIMAL = 2;
  155567. static readonly THUMB_PHALANX_DISTAL = 3;
  155568. static readonly THUMB_PHALANX_TIP = 4;
  155569. static readonly INDEX_METACARPAL = 5;
  155570. static readonly INDEX_PHALANX_PROXIMAL = 6;
  155571. static readonly INDEX_PHALANX_INTERMEDIATE = 7;
  155572. static readonly INDEX_PHALANX_DISTAL = 8;
  155573. static readonly INDEX_PHALANX_TIP = 9;
  155574. static readonly MIDDLE_METACARPAL = 10;
  155575. static readonly MIDDLE_PHALANX_PROXIMAL = 11;
  155576. static readonly MIDDLE_PHALANX_INTERMEDIATE = 12;
  155577. static readonly MIDDLE_PHALANX_DISTAL = 13;
  155578. static readonly MIDDLE_PHALANX_TIP = 14;
  155579. static readonly RING_METACARPAL = 15;
  155580. static readonly RING_PHALANX_PROXIMAL = 16;
  155581. static readonly RING_PHALANX_INTERMEDIATE = 17;
  155582. static readonly RING_PHALANX_DISTAL = 18;
  155583. static readonly RING_PHALANX_TIP = 19;
  155584. static readonly LITTLE_METACARPAL = 20;
  155585. static readonly LITTLE_PHALANX_PROXIMAL = 21;
  155586. static readonly LITTLE_PHALANX_INTERMEDIATE = 22;
  155587. static readonly LITTLE_PHALANX_DISTAL = 23;
  155588. static readonly LITTLE_PHALANX_TIP = 24;
  155589. }
  155590. // This file contains native only extensions for WebXR These APIs are not supported in the browser yet.
  155591. // They are intended for use with either Babylon Native https://github.com/BabylonJS/BabylonNative or
  155592. // Babylon React Native: https://github.com/BabylonJS/BabylonReactNative
  155593. interface XRSession {
  155594. trySetFeaturePointCloudEnabled(enabled: boolean): boolean;
  155595. }
  155596. interface XRFrame {
  155597. featurePointCloud? : Array<number>;
  155598. }